pocket-core icon indicating copy to clipboard operation
pocket-core copied to clipboard

Consolidating terminology around RelayChain

Open andrewnguyen22 opened this issue 4 years ago • 3 comments

Describe the bug Consolidating terminology around non native chain/chains/blockchains/netid/network id/network identifier (In documentation and code)

andrewnguyen22 avatar May 05 '20 13:05 andrewnguyen22

terminology should be:

external chains - chains that are outside of pocket
chain id - represents the network running (testnet, mainnet, devnet)
network id - the subnetwork of the external chains(eth rink, BTC mainnet) 

jeremybeal11 avatar Jun 03 '20 22:06 jeremybeal11

Some examples are:

  1. when a user enters in pocket util generate-chains it asks them to Enter the ID of the network identifier:. When they go to the supported networks page to find ETH rinkeby for example, The Network ID shows 4 when in reality it should be 0025 which is under the chainID column.
  2. when a user want to stake their node using pocket nodes stake <fromAddr> <amount> <chains> <serviceURI> <chainID> <fees> they go back to the supported networks page and see's that the chainID is 0001 when it shuld be mainnet which is under the network ID column

jeremybeal11 avatar Oct 02 '20 15:10 jeremybeal11

I propose that the user facing part of this issue can and should be dealt with now. The documentation nomencalature is not directly tied to the code nomenclature or vice-versa. I propose this: search every page in the docs site., Identify every use of the word "chain" Determine if it is referring to a relay chain or a pocket blockchain. Add the appropriate word directly to the existing word. Therefore: < chain > would become either < relayChain > or < networkChain >

BenVanGithub avatar Oct 20 '20 19:10 BenVanGithub