diff --git a/docs/index.rst b/docs/index.rst index 3bf1c06adc..1dc8eb35f6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,13 +14,11 @@ Welcome to the Cosmos SDK! SDK --- -.. One maxdepth for now - .. toctree:: :maxdepth: 1 - sdk/overview.rst sdk/install.rst +.. sdk/overview.rst # needs to be updated .. old/glossary.rst # not completely up to date but has good content .. Basecoin @@ -31,8 +29,8 @@ SDK .. old/basecoin/basics.rst # has a decent getting-start tutorial that's relatively up to date, should be consolidated with the other getting started doc -Extensions ----------- +.. Extensions +.. ---------- .. old/basecoin/extensions.rst # probably not worth salvaging @@ -48,8 +46,8 @@ Staking .. toctree:: :maxdepth: 1 - staking/intro.rst staking/testnet.rst +.. staking/intro.rst .. staking/key-management.rst .. staking/local-testnet.rst .. staking/public-testnet.rst diff --git a/docs/sdk/install.rst b/docs/sdk/install.rst index 213c49a374..d0e90b838d 100644 --- a/docs/sdk/install.rst +++ b/docs/sdk/install.rst @@ -2,7 +2,7 @@ Install ======= Cosmos SDK can be installed to -`$GOPATH/src/github.com/cosmos/cosmos-sdk` like a normal Go program: +``$GOPATH/src/github.com/cosmos/cosmos-sdk`` like a normal Go program: :: diff --git a/docs/staking/testnet.rst b/docs/staking/testnet.rst index eabe18bb67..a04383690c 100644 --- a/docs/staking/testnet.rst +++ b/docs/staking/testnet.rst @@ -1,14 +1,8 @@ Testnet Setup ============= -Install -------- - See the `installation guide <../sdk/install.html>`__ for details on installation. - -### Local-Test Example - Here is a quick example to get you off your feet: First, generate a new key with a name, and save the address: @@ -24,6 +18,7 @@ First, generate a new key with a name, and save the address: Now initialize a gaia chain: :: + gaiad init --home=$HOME/.gaiad1 you should see seed phrase for genesis account in the output & config & data folder in the home directory. @@ -63,8 +58,7 @@ The genesis file should look like this: } } - -**Note:** We need to change the denomination of token from default to ``steak`` in genesis file. +**Note:** We need to change the denomination of token from default to ``steak`` in the genesis file. Then, recover the genesis account with ``basecli``: @@ -80,7 +74,7 @@ We can add a second node on our local machine by initiating a node in a new dire gaiad init --home=$HOME/.gaiad2 -and replace the ``genesis.json`` and ``config.toml`` file: +and replace the ``genesis.json`` and ``config.toml`` files: :: @@ -139,6 +133,7 @@ First, we need to create a new account: Check that we now have two accounts: :: + basecli keys list Then, we try to transfer some ``steak`` to another account: @@ -147,7 +142,7 @@ Then, we try to transfer some ``steak`` to another account: basecli send --amount=1000steak --to=$MYADDR2 --name=$NAME --chain-id= --node=tcp://localhost:46657 --sequence=0 -**Note** We need to be careful with the ``chain-id`` and ``sequence`` +**Note:** We need to be careful with the ``chain-id`` and ``sequence`` Check the balance & sequence with: @@ -163,7 +158,7 @@ Finally, let's bond the validator in ``$HOME/gaiad2``. Get the pubkey first: cat $HOME/.gaiad2/config/priv_validator.json | jq .pub_key.value -Go to [this website](http://tomeko.net/online_tools/base64.php?lang=en) to change pubkey from base64 to Hex. +Go to `this website `__ to change pubkey from base64 to Hex. Ok, now we can bond some coins to that pubkey: @@ -180,6 +175,7 @@ Nice. We can see there are now two validators: Check the balance of ``$MYADDR2`` to see the difference: it has 1 less ``steak``! :: + basecli account $MYADDR2 To confirm for certain the new validator is active, check tendermint: