From 3f4b041d0beaae6b2fcca456e8cfefc143c89ed0 Mon Sep 17 00:00:00 2001 From: Jeremiah Andrews Date: Mon, 4 Jun 2018 12:33:09 -0700 Subject: [PATCH 1/3] changed to new cli commands in docs --- docs/sdk/lcd-rest-api.yaml | 20 ++++++++++---------- docs/staking/intro.rst | 24 ++++++++++++------------ docs/staking/testnet.rst | 6 +++--- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/sdk/lcd-rest-api.yaml b/docs/sdk/lcd-rest-api.yaml index 34ccaa0ac8..408b2a792b 100644 --- a/docs/sdk/lcd-rest-api.yaml +++ b/docs/sdk/lcd-rest-api.yaml @@ -2,9 +2,9 @@ swagger: '2.0' info: version: '1.1.0' title: Light client daemon to interface with Cosmos baseserver via REST - description: Specification for the LCD provided by `gaiacli rest-server` + description: Specification for the LCD provided by `gaiacli advanced rest-server` + - securityDefinitions: kms: type: basic @@ -58,7 +58,7 @@ paths: responses: 200: description: '"true" or "false"' - + /keys: get: summary: List of accounts stored locally @@ -199,7 +199,7 @@ paths: # description: Tx was send and will probably be added to the next block # 400: # description: The Tx was malformated - + /accounts/{address}: parameters: - in: path @@ -545,7 +545,7 @@ paths: # description: Tx was send and will probably be added to the next block # 400: # description: The Tx was malformated - + definitions: Address: type: string @@ -630,7 +630,7 @@ definitions: Sig: type: string default: '' - Pubkey: + Pubkey: type: string default: '' TxSigned: @@ -704,17 +704,17 @@ definitions: properties: header: type: object - properties: + properties: chain_id: type: string example: gaia-2 - height: + height: type: number example: 1 - time: + time: type: string example: '2017-12-30T05:53:09.287+01:00' - num_txs: + num_txs: type: number example: 0 last_block_id: diff --git a/docs/staking/intro.rst b/docs/staking/intro.rst index 7b5acb9863..5f7cdd950e 100644 --- a/docs/staking/intro.rst +++ b/docs/staking/intro.rst @@ -203,7 +203,7 @@ where the ``--sequence`` flag is to be incremented for each transaction, the ``- :: - Please enter passphrase for alice: + Please enter passphrase for alice: { "check_tx": { "gas": 30 @@ -250,7 +250,7 @@ First, we need the pub_key data: :: - cat $HOME/.gaia2/priv_validator.json + cat $HOME/.gaia2/priv_validator.json the first part will look like: @@ -264,13 +264,13 @@ Now ``bob`` can declare candidacy to that pubkey: :: - gaiacli declare-candidacy --amount=10mycoin --name=bob --pubkey= --moniker=bobby + gaiacli stake create-validator --amount=10mycoin --name=bob --pubkey= --moniker=bobby with an output like: :: - Please enter passphrase for bob: + Please enter passphrase for bob: { "check_tx": { "gas": 30 @@ -285,7 +285,7 @@ We should see ``bob``'s account balance decrease by 10 mycoin: :: - gaiacli account 5D93A6059B6592833CBC8FA3DA90EE0382198985 + gaiacli account 5D93A6059B6592833CBC8FA3DA90EE0382198985 To confirm for certain the new validator is active, ask the tendermint node: @@ -306,19 +306,19 @@ First let's have ``alice`` send some coins to ``charlie``: :: - gaiacli tx --amount=1000mycoin --sequence=2 --name=alice --to=48F74F48281C89E5E4BE9092F735EA519768E8EF + gaiacli send --amount=1000mycoin --sequence=2 --name=alice --to=48F74F48281C89E5E4BE9092F735EA519768E8EF Then ``charlie`` will delegate some mycoin to ``bob``: :: - gaiacli tx delegate --amount=10mycoin --name=charlie --pubkey= + gaiacli advanced tendermint tx delegate --amount=10mycoin --name=charlie --pubkey= You'll see output like: :: - Please enter passphrase for charlie: + Please enter passphrase for charlie: { "check_tx": { "gas": 30 @@ -334,7 +334,7 @@ To get more information about the candidate, try: :: - gaiacli query candidate --pubkey= + gaiacli stake validator --pubkey= and you'll see output similar to: @@ -367,7 +367,7 @@ It's also possible the query the delegator's bond like so: :: - gaiacli query delegator-bond --delegator-address 48F74F48281C89E5E4BE9092F735EA519768E8EF --pubkey 52D6FCD8C92A97F7CCB01205ADF310A18411EA8FDCC10E65BF2FCDB05AD1689B + gaiacli stake delegation --delegator-address 48F74F48281C89E5E4BE9092F735EA519768E8EF --pubkey 52D6FCD8C92A97F7CCB01205ADF310A18411EA8FDCC10E65BF2FCDB05AD1689B with an output similar to: @@ -383,7 +383,7 @@ with an output similar to: "Shares": 20 } } - + where the ``--delegator-address`` is ``charlie``'s address and the ``-pubkey`` is the same as we've been using. @@ -396,7 +396,7 @@ your VotingPower reduce and your account balance increase. :: - gaiacli unbond --amount=5mycoin --name=charlie --pubkey= + gaiacli stake unbond --amount=5mycoin --name=charlie --pubkey= gaiacli account 48F74F48281C89E5E4BE9092F735EA519768E8EF See the bond decrease with ``gaiacli query delegator-bond`` like above. diff --git a/docs/staking/testnet.rst b/docs/staking/testnet.rst index 92aa93eb26..c5341fee66 100644 --- a/docs/staking/testnet.rst +++ b/docs/staking/testnet.rst @@ -16,7 +16,7 @@ First, generate a couple of genesis transactions to be incorparated into the gen gaiacli keys list **Note:** If you've already run these tests you may need to overwrite keys using the ``--OWK`` flag -When you list the keys you should see two addresses, we'll need these later so take note. +When you list the keys you should see two addresses, we'll need these later so take note. Now let's actually create the genesis files for both nodes: :: @@ -44,7 +44,7 @@ Nice. We can also lookup the validator set: :: - gaiacli validatorset + gaiacli advanced tendermint validatorset Then, we try to transfer some ``steak`` to another account: @@ -72,7 +72,7 @@ Finally, to relinquish all your power, unbond some coins. You should see your Vo :: - gaiacli unbond --chain-id= --name=test + gaiacli stake unbond --chain-id= --name=test That's it! From 5a831bd0f89c15ebe5d6a8d3f55d0779daf7308f Mon Sep 17 00:00:00 2001 From: Jeremiah Andrews Date: Mon, 4 Jun 2018 18:35:07 -0700 Subject: [PATCH 2/3] additional changes --- client/rpc/validators.go | 2 +- docs/staking/intro.rst | 16 ++++++++-------- docs/staking/testnet.rst | 2 +- x/slashing/client/cli/query.go | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/client/rpc/validators.go b/client/rpc/validators.go index 27b7fce99e..d1aa6c9c18 100644 --- a/client/rpc/validators.go +++ b/client/rpc/validators.go @@ -17,7 +17,7 @@ import ( //ValidatorCommand returns the validator set for a given height func ValidatorCommand() *cobra.Command { cmd := &cobra.Command{ - Use: "validatorset [height]", + Use: "validator-set [height]", Short: "Get the full tendermint validator set at given height", Args: cobra.MaximumNArgs(1), RunE: printValidators, diff --git a/docs/staking/intro.rst b/docs/staking/intro.rst index 5f7cdd950e..00a68811a8 100644 --- a/docs/staking/intro.rst +++ b/docs/staking/intro.rst @@ -260,11 +260,11 @@ the first part will look like: and you want the ``pub_key`` ``data`` that starts with ``96864CE``. -Now ``bob`` can declare candidacy to that pubkey: +Now ``bob`` can create a validator with that pubkey. :: - gaiacli stake create-validator --amount=10mycoin --name=bob --pubkey= --moniker=bobby + gaiacli stake create-validator --amount=10mycoin --name=bob --address-validator=
--pub-key= --moniker=bobby with an output like: @@ -312,7 +312,7 @@ Then ``charlie`` will delegate some mycoin to ``bob``: :: - gaiacli advanced tendermint tx delegate --amount=10mycoin --name=charlie --pubkey= + gaiacli stake delegate --amount=10mycoin --address-delegator= --address-validator= --name=charlie You'll see output like: @@ -334,7 +334,7 @@ To get more information about the candidate, try: :: - gaiacli stake validator --pubkey= + gaiacli stake validator
and you'll see output similar to: @@ -367,7 +367,7 @@ It's also possible the query the delegator's bond like so: :: - gaiacli stake delegation --delegator-address 48F74F48281C89E5E4BE9092F735EA519768E8EF --pubkey 52D6FCD8C92A97F7CCB01205ADF310A18411EA8FDCC10E65BF2FCDB05AD1689B + gaiacli stake delegation --address-delegator=
--address-validator=
with an output similar to: @@ -385,7 +385,7 @@ with an output similar to: } -where the ``--delegator-address`` is ``charlie``'s address and the ``-pubkey`` is the same as we've been using. +where the ``--address-delegator`` is ``charlie``'s address and the ``--address-validator`` is ``bob``'s address. Unbonding @@ -396,7 +396,7 @@ your VotingPower reduce and your account balance increase. :: - gaiacli stake unbond --amount=5mycoin --name=charlie --pubkey= + gaiacli stake unbond --amount=5mycoin --name=charlie --address-delegator=
--address-validator=
gaiacli account 48F74F48281C89E5E4BE9092F735EA519768E8EF -See the bond decrease with ``gaiacli query delegator-bond`` like above. +See the bond decrease with ``gaiacli stake delegation`` like above. diff --git a/docs/staking/testnet.rst b/docs/staking/testnet.rst index c5341fee66..4fca09c4ad 100644 --- a/docs/staking/testnet.rst +++ b/docs/staking/testnet.rst @@ -44,7 +44,7 @@ Nice. We can also lookup the validator set: :: - gaiacli advanced tendermint validatorset + gaiacli advanced tendermint validator-set Then, we try to transfer some ``steak`` to another account: diff --git a/x/slashing/client/cli/query.go b/x/slashing/client/cli/query.go index 35f99d2fa3..948e756675 100644 --- a/x/slashing/client/cli/query.go +++ b/x/slashing/client/cli/query.go @@ -16,7 +16,7 @@ import ( // get the command to query signing info func GetCmdQuerySigningInfo(storeName string, cdc *wire.Codec) *cobra.Command { cmd := &cobra.Command{ - Use: "signing_info [validator-pubkey]", + Use: "signing-info [validator-pubkey]", Short: "Query a validator's signing information", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { From 91c89627402897e77e3ff183afbcd46e6a03c76b Mon Sep 17 00:00:00 2001 From: Jeremiah Andrews Date: Mon, 4 Jun 2018 18:38:50 -0700 Subject: [PATCH 3/3] changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86a344654e..22969a4037 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ FIXES * [cli] fixed cli-bash tests * [ci] added cli-bash tests * [basecoin] updated basecoin for stake and slashing +* [docs] fixed references to old cli commands ## 0.18.1 @@ -32,7 +33,7 @@ BREAKING CHANGES * [x/auth] removed the FeeHandler function from the AnteHandler, Replaced with FeeKeeper * [x/auth] Removed GetSignatures() from Tx interface (as different Tx styles might use something different than StdSignature) * [store] Removed SubspaceIterator and ReverseSubspaceIterator from KVStore interface and replaced them with helper functions in /types -* Switch to bech32cosmos on all human readable inputs and outputs +* Switch to bech32cosmos on all human readable inputs and outputs BUG FIXES