pocket-core
pocket-core copied to clipboard
Consolidating terminology around RelayChain
Describe the bug Consolidating terminology around non native chain/chains/blockchains/netid/network id/network identifier (In documentation and code)
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)
Some examples are:
- when a user enters in
pocket util generate-chains
it asks them toEnter the ID of the network identifier:
. When they go to the supported networks page to find ETH rinkeby for example, The Network ID shows4
when in reality it should be0025
which is under the chainID column. - 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 is0001
when it shuld bemainnet
which is under thenetwork ID
column
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 >