From 080f5cfde61308451c806916bb8fdc9bc1f6bf8b Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 17:15:19 +0800 Subject: [PATCH] Refactor docs for stake query interface --- docs/cli-client/distribution/README.md | 4 +-- .../distribution/delegator-distr-info.md | 8 ++---- .../distribution/set-withdraw-address.md | 8 ++---- .../distribution/validator-distr-info.md | 9 ++----- .../distribution/withdraw-address.md | 8 +----- .../distribution/withdraw-rewards.md | 2 +- docs/cli-client/stake/README.md | 4 +-- docs/cli-client/stake/create-validator.md | 4 +-- docs/cli-client/stake/delegate.md | 4 +-- docs/cli-client/stake/delegation.md | 18 +++++-------- docs/cli-client/stake/delegations.md | 25 ++++++----------- docs/cli-client/stake/edit-validator.md | 4 +-- docs/cli-client/stake/parameters.md | 21 +++++---------- docs/cli-client/stake/pool.md | 21 +++++---------- docs/cli-client/stake/redelegate.md | 6 ++--- docs/cli-client/stake/redelegation.md | 18 +++++-------- docs/cli-client/stake/redelegations-from.md | 25 ++++++----------- docs/cli-client/stake/redelegations.md | 25 ++++++----------- docs/cli-client/stake/signing-info.md | 20 +++++--------- docs/cli-client/stake/unbond.md | 7 +++-- docs/cli-client/stake/unbonding-delegation.md | 18 +++++-------- .../stake/unbonding-delegations-from.md | 25 ++++++----------- .../cli-client/stake/unbonding-delegations.md | 25 ++++++----------- docs/cli-client/stake/unjail.md | 11 +++----- docs/cli-client/stake/validator.md | 25 ++++++----------- docs/cli-client/stake/validators.md | 21 +++++---------- docs/zh/cli-client/distribution/README.md | 4 +-- .../distribution/delegation-distr-info.md | 4 +-- .../distribution/delegator-distr-info.md | 12 +++------ .../distribution/set-withdraw-address.md | 9 ++----- .../distribution/validator-distr-info.md | 5 ---- .../distribution/withdraw-address.md | 9 ++----- docs/zh/cli-client/stake/delegation.md | 18 +++++-------- docs/zh/cli-client/stake/delegations.md | 24 ++++++----------- docs/zh/cli-client/stake/edit-validator.md | 4 +-- docs/zh/cli-client/stake/parameters.md | 23 +++++----------- docs/zh/cli-client/stake/pool.md | 23 +++++----------- docs/zh/cli-client/stake/redelegate.md | 2 +- docs/zh/cli-client/stake/redelegation.md | 20 ++++++-------- .../zh/cli-client/stake/redelegations-from.md | 27 +++++++------------ docs/zh/cli-client/stake/redelegations.md | 27 +++++++------------ docs/zh/cli-client/stake/signing-info.md | 25 ++++++----------- .../cli-client/stake/unbonding-delegation.md | 21 ++++++--------- .../stake/unbonding-delegations-from.md | 27 +++++++------------ .../cli-client/stake/unbonding-delegations.md | 27 +++++++------------ docs/zh/cli-client/stake/unjail.md | 4 +-- docs/zh/cli-client/stake/validator.md | 27 +++++++------------ docs/zh/cli-client/stake/validators.md | 23 +++++----------- docs/zh/features/distribution.md | 2 +- 49 files changed, 243 insertions(+), 490 deletions(-) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index 9aec53571..768e90fcb 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -6,13 +6,13 @@ This document describes how to use the the command line interfaces of distributi ## Usage -```shell +``` iriscli distribution [subcommand] [flags] ``` Print all supported subcommands and flags: -```shell +``` iriscli distribution --help ``` diff --git a/docs/cli-client/distribution/delegator-distr-info.md b/docs/cli-client/distribution/delegator-distr-info.md index cb4c501b1..223a6cdbf 100644 --- a/docs/cli-client/distribution/delegator-distr-info.md +++ b/docs/cli-client/distribution/delegator-distr-info.md @@ -7,7 +7,7 @@ Query a delegator distribution information ## Usage ``` -iriscli distribution delegator-distr-info [flags] +iriscli distribution delegator-distr-info [delegator address] [flags] ``` Print help messages: @@ -15,14 +15,10 @@ Print help messages: iriscli distribution delegator-distr-info --help ``` -## Unique Flags - -There is no unique flag. But it requires a argument: delegator address - ## Examples ``` -iriscli distribution delegator-distr-info +iriscli distribution delegator-distr-info [delegator address] ``` Example response: ```json diff --git a/docs/cli-client/distribution/set-withdraw-address.md b/docs/cli-client/distribution/set-withdraw-address.md index 6aa1140f2..6ed528b0b 100644 --- a/docs/cli-client/distribution/set-withdraw-address.md +++ b/docs/cli-client/distribution/set-withdraw-address.md @@ -7,7 +7,7 @@ Set withdraw address for delegator ## Usage ``` -iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +iriscli distribution set-withdraw-addr [withdraw-address] [flags] ``` Print help messages: @@ -15,13 +15,9 @@ Print help messages: iriscli distribution set-withdraw-addr --help ``` -## Unique Flags - -There is no unique flag. But it requires an argument: new withdraw address - ## Examples ``` -iriscli distribution set-withdraw-addr --from --fee=0.004iris --chain-id= +iriscli distribution set-withdraw-addr [withdraw address] --from --fee=0.004iris --chain-id= ``` diff --git a/docs/cli-client/distribution/validator-distr-info.md b/docs/cli-client/distribution/validator-distr-info.md index 840b6d776..3bf7cd2db 100644 --- a/docs/cli-client/distribution/validator-distr-info.md +++ b/docs/cli-client/distribution/validator-distr-info.md @@ -7,7 +7,7 @@ Query a validator distribution information ## Usage ``` -iriscli distribution validator-distr-info [flags] +iriscli distribution validator-distr-info [validator address] [flags] ``` Print help messages: @@ -15,15 +15,10 @@ Print help messages: iriscli distribution validator-distr-info --help ``` -## Unique Flags - -There is no unique flag. But it requires an argument: validator address - - ## Examples ``` -iriscli distribution validator-distr-info +iriscli distribution validator-distr-info [validator address] ``` Example response: ```json diff --git a/docs/cli-client/distribution/withdraw-address.md b/docs/cli-client/distribution/withdraw-address.md index f3ab8030c..e46a1314e 100644 --- a/docs/cli-client/distribution/withdraw-address.md +++ b/docs/cli-client/distribution/withdraw-address.md @@ -5,7 +5,6 @@ Query the withdraw address of a delegator ## Usage - ``` iriscli distribution withdraw-address [delegator address] [flags] ``` @@ -16,15 +15,10 @@ Print help messages: iriscli distribution withdraw-address --help ``` -## Unique Flags - -There is no unique option. But it requires a argument: delegator address - - ## Examples ``` -iriscli distribution withdraw-address +iriscli distribution withdraw-address [delegator address] ``` Example response: ```text diff --git a/docs/cli-client/distribution/withdraw-rewards.md b/docs/cli-client/distribution/withdraw-rewards.md index 3b949047f..09da2a1e7 100644 --- a/docs/cli-client/distribution/withdraw-rewards.md +++ b/docs/cli-client/distribution/withdraw-rewards.md @@ -12,7 +12,7 @@ iriscli distribution withdraw-rewards [flags] Print help messages: -```shell +``` iriscli distribution withdraw-rewards --help ``` diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index 1d0ada080..883278ae2 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -6,12 +6,12 @@ Stake module provides a set of subcommands to query staking state and send staki ## Usage -```shell +``` iriscli stake [subcommand] [flags] ``` Print all supported subcommands and flags: -```shell +``` iriscli stake --help ``` diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md index 22f6b9053..bf9b36209 100644 --- a/docs/cli-client/stake/create-validator.md +++ b/docs/cli-client/stake/create-validator.md @@ -11,7 +11,7 @@ iriscli stake create-validator [flags] ``` Print help messages: -```shell +``` iriscli stake create-validator --help ``` @@ -33,7 +33,7 @@ iriscli stake create-validator --help ## Examples -```shell +``` iriscli stake create-validator --chain-id= --from= --fee=0.004iris --pubkey= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker= ``` diff --git a/docs/cli-client/stake/delegate.md b/docs/cli-client/stake/delegate.md index c10e56f78..944692c31 100644 --- a/docs/cli-client/stake/delegate.md +++ b/docs/cli-client/stake/delegate.md @@ -11,7 +11,7 @@ iriscli stake delegate [flags] ``` Print help messages: -```shell +``` iriscli stake delegate --help ``` @@ -24,6 +24,6 @@ iriscli stake delegate --help ## Examples -```shell +``` iriscli stake delegate --chain-id= --from= --fee=0.004iris --amount=100iris --address-validator= ``` diff --git a/docs/cli-client/stake/delegation.md b/docs/cli-client/stake/delegation.md index 43d730d07..a15276594 100644 --- a/docs/cli-client/stake/delegation.md +++ b/docs/cli-client/stake/delegation.md @@ -9,26 +9,22 @@ Query a delegation based on address and validator address ``` iriscli stake delegation [flags] ``` +Print help messages: +``` +iriscli stake delegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator | | [string] Bech address of the validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for delegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a validator - -```shell +Query a validator +``` iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/cli-client/stake/delegations.md b/docs/cli-client/stake/delegations.md index 6fa58df30..d59b1215f 100644 --- a/docs/cli-client/stake/delegations.md +++ b/docs/cli-client/stake/delegations.md @@ -7,27 +7,18 @@ Query all delegations made from one delegator ## Usage ``` -iriscli stake delegations [delegator-addr] [flags] +iriscli stake delegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake delegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for delegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all delegations made from one delegator - -```shell -iriscli stake delegations DelegatorAddress +Query all delegations made from one delegator +``` +iriscli stake delegations [delegator-address] ``` After that, you will get all detailed info of delegations from the specified delegator address. diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md index 3b7c1812e..0494db6ef 100644 --- a/docs/cli-client/stake/edit-validator.md +++ b/docs/cli-client/stake/edit-validator.md @@ -10,7 +10,7 @@ Edit existing validator, such as commission rate, name and other description mes iriscli stake edit-validator [flags] ``` Print help messages: -```shell +``` iriscli stake edit-validator --help ``` @@ -27,6 +27,6 @@ iriscli stake edit-validator --help ## Examples -```shell +``` iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` diff --git a/docs/cli-client/stake/parameters.md b/docs/cli-client/stake/parameters.md index 8effa2e49..93a51c46a 100644 --- a/docs/cli-client/stake/parameters.md +++ b/docs/cli-client/stake/parameters.md @@ -9,24 +9,15 @@ Query the current staking parameters information ``` iriscli stake parameters [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for parameters | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake parameters --help +``` ## Examples -### Query the current staking parameters information - -```shell +Query the current staking parameters information +``` iriscli stake parameters ``` diff --git a/docs/cli-client/stake/pool.md b/docs/cli-client/stake/pool.md index ed06d79a0..6f89128ad 100644 --- a/docs/cli-client/stake/pool.md +++ b/docs/cli-client/stake/pool.md @@ -9,24 +9,15 @@ Query the current staking pool values ``` iriscli stake pool [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for pool | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake pool --help +``` ## Examples -### Query the current staking pool values - -```shell +Query the current staking pool values +``` iriscli stake pool ``` diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index c594e79c7..a1c756f08 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -10,9 +10,9 @@ Transfer delegation from one validator to another one. iriscli stake redelegate [flags] ``` -Print all help messages: +Print help messages: -```shell +``` iriscli stake redelegate --help ``` @@ -29,6 +29,6 @@ Users must specify the redeleagtion token amount. There two options can do this: ## Examples -```shell +``` iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.1 ``` diff --git a/docs/cli-client/stake/redelegation.md b/docs/cli-client/stake/redelegation.md index 0a20c45b4..dc2c59ee6 100644 --- a/docs/cli-client/stake/redelegation.md +++ b/docs/cli-client/stake/redelegation.md @@ -9,27 +9,23 @@ Query a redelegation record based on delegator and a source and destination vali ``` iriscli stake redelegation [flags] ``` +Print help messages: +``` +iriscli stake redelegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator-dest | | [string] Bech address of the destination validator | Yes | | --address-validator-source | | [string] Bech address of the source validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a redelegation record - -```shell +Query a redelegation record +``` iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/cli-client/stake/redelegations-from.md b/docs/cli-client/stake/redelegations-from.md index 5fcf5b8ab..bacdf391e 100644 --- a/docs/cli-client/stake/redelegations-from.md +++ b/docs/cli-client/stake/redelegations-from.md @@ -7,27 +7,18 @@ Query all outgoing redelegatations from a validator ## Usage ``` -iriscli stake redelegations-from [operator-addr] [flags] +iriscli stake redelegations-from [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake redelegations-from --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegations-from | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all outgoing redelegatations - -```shell -iriscli stake redelegations-from ValidatorAddress +Query all outgoing redelegatations +``` +iriscli stake redelegations-from [validator-address] ``` After that, you will get all outgoing redelegatations' from specified validator diff --git a/docs/cli-client/stake/redelegations.md b/docs/cli-client/stake/redelegations.md index e5945b41c..5ef565bb8 100644 --- a/docs/cli-client/stake/redelegations.md +++ b/docs/cli-client/stake/redelegations.md @@ -7,27 +7,18 @@ Query all redelegations records for one delegator ## Usage ``` -iriscli stake redelegations [delegator-addr] [flags] +iriscli stake redelegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake redelegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all redelegations records - -```shell -iriscli stake redelegations DelegatorAddress +Query all redelegations records +``` +iriscli stake redelegations [delegator-address] ``` After that, you will get all redelegations records' info for specified delegator diff --git a/docs/cli-client/stake/signing-info.md b/docs/cli-client/stake/signing-info.md index c9bce82d6..6747039d9 100644 --- a/docs/cli-client/stake/signing-info.md +++ b/docs/cli-client/stake/signing-info.md @@ -9,25 +9,17 @@ Query a validator's signing information ``` iriscli stake signing-info [validator-pubkey] [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for signing-info | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake signing-info --help +``` ## Examples ### Query specified validator's signing information -```shell -iriscli stake signing-info ValidatorPublicKey +``` +iriscli stake signing-info [validator-pubkey] ``` After that, you will get specified validator's signing information. diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md index 244973a94..a1f307de7 100644 --- a/docs/cli-client/stake/unbond.md +++ b/docs/cli-client/stake/unbond.md @@ -10,9 +10,8 @@ Unbond tokens from a validator iriscli stake unbond [flags] ``` -Print all help messages: - -```shell +Print help messages: +``` iriscli stake unbond --help ``` @@ -28,6 +27,6 @@ Users must specify the unbond amount. There two options can do this: `--shares-a ## Examples -```shell +``` iriscli stake unbond --address-validator= --shares-percent=0.1 --from= --chain-id= --fee=0.004iris ``` diff --git a/docs/cli-client/stake/unbonding-delegation.md b/docs/cli-client/stake/unbonding-delegation.md index a30824507..c5975b6f1 100644 --- a/docs/cli-client/stake/unbonding-delegation.md +++ b/docs/cli-client/stake/unbonding-delegation.md @@ -9,27 +9,23 @@ Query an unbonding-delegation record based on delegator and validator address ``` iriscli stake unbonding-delegation [flags] ``` +Print help messages: +``` +iriscli stake unbonding-delegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator | | [string] Bech address of the validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query an unbonding-delegation - -```shell +Query an unbonding-delegation +``` iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress ``` diff --git a/docs/cli-client/stake/unbonding-delegations-from.md b/docs/cli-client/stake/unbonding-delegations-from.md index 5723deb24..ebac8617a 100644 --- a/docs/cli-client/stake/unbonding-delegations-from.md +++ b/docs/cli-client/stake/unbonding-delegations-from.md @@ -7,27 +7,18 @@ Query all unbonding delegatations from a validator ## Usage ``` -iriscli stake unbonding-delegations-from [operator-addr] [flags] +iriscli stake unbonding-delegations-from [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake unbonding-delegations-from --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegations-from | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all unbonding delegatations from a validator - -```shell -iriscli stake unbonding-delegations ValidatorAddress +Query all unbonding delegatations from a validator +``` +iriscli stake unbonding-delegations [validator-address] ``` After that, you will get unbonding delegation's detailed info from specified validator. diff --git a/docs/cli-client/stake/unbonding-delegations.md b/docs/cli-client/stake/unbonding-delegations.md index 9dad2d577..6280ebdf3 100644 --- a/docs/cli-client/stake/unbonding-delegations.md +++ b/docs/cli-client/stake/unbonding-delegations.md @@ -7,27 +7,18 @@ Query all unbonding-delegations records for one delegator ## Usage ``` -iriscli stake unbonding-delegations [delegator-addr] [flags] +iriscli stake unbonding-delegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake unbonding-delegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query an unbonding-delegation - -```shell -iriscli stake unbonding-delegations DelegatorAddress +Query an unbonding-delegation +``` +iriscli stake unbonding-delegations [delegator-address] ``` After that, you will get unbonding delegation's detailed info from specified delegator. diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 7a29eaa57..ccbb2c881 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -10,20 +10,15 @@ Unjail validator which may be jailed previously for downtime iriscli stake unjail [flags] ``` -Print all help messages: - -```shell +Print help messages: +``` iriscli stake unjail --help ``` -## Unique Flags - -There is no unique flags. - ## Examples ### Unjail validator previously jailed for downtime -```shell +``` iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` diff --git a/docs/cli-client/stake/validator.md b/docs/cli-client/stake/validator.md index 102c3250f..5ebc3df79 100644 --- a/docs/cli-client/stake/validator.md +++ b/docs/cli-client/stake/validator.md @@ -7,27 +7,18 @@ Query a validator ## Usage ``` -iriscli stake validator [owner-addr] [flags] +iriscli stake validator [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake validator --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a validator - -```shell -iriscli stake validator YourValidatorOwnerAddress +Query a validator +``` +iriscli stake validator [validator-address] ``` After that, you will get the specified validator's info. diff --git a/docs/cli-client/stake/validators.md b/docs/cli-client/stake/validators.md index e9d2bee3c..7187e7e74 100644 --- a/docs/cli-client/stake/validators.md +++ b/docs/cli-client/stake/validators.md @@ -9,24 +9,15 @@ Query for all validators ``` iriscli stake validators [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake validators --help +``` ## Examples -### Query a validator - -```shell +Query a validator +``` iriscli stake validators ``` diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index 1b9fbc879..d158ef22d 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -6,13 +6,13 @@ ## 用法 -```shell +``` iriscli distribution [subcommand] ``` 打印所以子命令和参数 -```shell +``` iriscli distribution --help ``` diff --git a/docs/zh/cli-client/distribution/delegation-distr-info.md b/docs/zh/cli-client/distribution/delegation-distr-info.md index 1e7f3801b..be15ef4d1 100644 --- a/docs/zh/cli-client/distribution/delegation-distr-info.md +++ b/docs/zh/cli-client/distribution/delegation-distr-info.md @@ -12,7 +12,7 @@ iriscli distribution delegation-distr-info [flags] 打印帮助信息 -```shell +``` iriscli distribution delegation-distr-info --help ``` @@ -25,7 +25,7 @@ iriscli distribution delegation-distr-info --help ## 示例 -```shell +``` iriscli distribution delegation-distr-info --address-delegator= --address-validator= ``` 执行结果示例 diff --git a/docs/zh/cli-client/distribution/delegator-distr-info.md b/docs/zh/cli-client/distribution/delegator-distr-info.md index 45d2f9255..d82c9eadb 100644 --- a/docs/zh/cli-client/distribution/delegator-distr-info.md +++ b/docs/zh/cli-client/distribution/delegator-distr-info.md @@ -7,23 +7,19 @@ ## 用法 ``` -iriscli distribution delegator-distr-info [flags] +iriscli distribution delegator-distr-info [delegator address] [flags] ``` 打印帮助信息 -```shell +``` iriscli distribution delegator-distr-info --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：delegator的地址 - ## 示例 -```shell -iriscli distribution delegation-distr-info +``` +iriscli distribution delegation-distr-info [delegator address] ``` 执行结果示例 ```json diff --git a/docs/zh/cli-client/distribution/set-withdraw-address.md b/docs/zh/cli-client/distribution/set-withdraw-address.md index 17fe2204c..0848d5d68 100644 --- a/docs/zh/cli-client/distribution/set-withdraw-address.md +++ b/docs/zh/cli-client/distribution/set-withdraw-address.md @@ -7,7 +7,7 @@ ## 用法 ``` -iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +iriscli distribution set-withdraw-addr [withdraw-address] [flags] ``` 打印帮助信息: @@ -16,13 +16,8 @@ iriscli distribution set-withdraw-addr [withdraw-addr] [flags] iriscli distribution set-withdraw-addr --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：收款地址 - - ## 示例 ``` -iriscli distribution set-withdraw-addr
--from --fee=0.004iris --chain-id= +iriscli distribution set-withdraw-addr [withdraw-address] --from --fee=0.004iris --chain-id= ``` diff --git a/docs/zh/cli-client/distribution/validator-distr-info.md b/docs/zh/cli-client/distribution/validator-distr-info.md index 21205b0db..f36c9703b 100644 --- a/docs/zh/cli-client/distribution/validator-distr-info.md +++ b/docs/zh/cli-client/distribution/validator-distr-info.md @@ -16,11 +16,6 @@ iriscli distribution validator-distr-info [flags] iriscli distribution validator-distr-info --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：验证人地址 - - ## 示例 ``` diff --git a/docs/zh/cli-client/distribution/withdraw-address.md b/docs/zh/cli-client/distribution/withdraw-address.md index c7e6607b0..53abbd44a 100644 --- a/docs/zh/cli-client/distribution/withdraw-address.md +++ b/docs/zh/cli-client/distribution/withdraw-address.md @@ -7,7 +7,7 @@ ## 用法 ``` -iriscli distribution withdraw-address [delegator address] [flags] +iriscli distribution withdraw-address [delegator-address] [flags] ``` 打印帮助信息: @@ -16,15 +16,10 @@ iriscli distribution withdraw-address [delegator address] [flags] iriscli distribution withdraw-address --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：委托人地址 - - ## 示例 ``` -iriscli distribution withdraw-address +iriscli distribution withdraw-address [delegator-address] ``` 执行结果示例 ``` diff --git a/docs/zh/cli-client/stake/delegation.md b/docs/zh/cli-client/stake/delegation.md index 85cfc45a2..e4a6d1d07 100644 --- a/docs/zh/cli-client/stake/delegation.md +++ b/docs/zh/cli-client/stake/delegation.md @@ -9,26 +9,22 @@ ``` iriscli stake delegation [flags] ``` - -## 标志 +打印帮助信息 +``` +iriscli stake delegation --help +``` +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator | | [string] 验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | delegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | -## 例子 +## 示例 ### 查询验证者 -```shell +``` iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/zh/cli-client/stake/delegations.md b/docs/zh/cli-client/stake/delegations.md index e88807e63..f4cbbeaac 100644 --- a/docs/zh/cli-client/stake/delegations.md +++ b/docs/zh/cli-client/stake/delegations.md @@ -7,27 +7,19 @@ ## 用法 ``` -iriscli stake delegations [delegator-addr] [flags] +iriscli stake delegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake delegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | delegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## Examples +## 示例 ### 查询某个委托者发起的所有委托记录 -```shell -iriscli stake delegations DelegatorAddress +``` +iriscli stake delegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/edit-validator.md b/docs/zh/cli-client/stake/edit-validator.md index 76c171623..ec70763e4 100644 --- a/docs/zh/cli-client/stake/edit-validator.md +++ b/docs/zh/cli-client/stake/edit-validator.md @@ -10,7 +10,7 @@ iriscli stake edit-validator [flags] ``` 打印帮助信息 -```shell +``` iriscli stake edit-validator --help ``` @@ -27,6 +27,6 @@ iriscli stake edit-validator --help ## 示例 -```shell +``` iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` diff --git a/docs/zh/cli-client/stake/parameters.md b/docs/zh/cli-client/stake/parameters.md index e417a5fa2..027913019 100644 --- a/docs/zh/cli-client/stake/parameters.md +++ b/docs/zh/cli-client/stake/parameters.md @@ -9,24 +9,15 @@ ``` iriscli stake parameters [flags] ``` +打印帮助信息 +``` +iriscli stake parameters --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | parameters命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询最新的权益参数信息 +## 示例 -```shell +查询最新的权益参数信息 +``` iriscli stake parameters ``` diff --git a/docs/zh/cli-client/stake/pool.md b/docs/zh/cli-client/stake/pool.md index cfc034839..5788748b7 100644 --- a/docs/zh/cli-client/stake/pool.md +++ b/docs/zh/cli-client/stake/pool.md @@ -9,24 +9,15 @@ ``` iriscli stake pool [flags] ``` +打印帮助信息 +``` +iriscli stake pool --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | pool命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询最新的权益池 +## 示例 -```shell +查询最新的权益池 +``` iriscli stake pool ``` diff --git a/docs/zh/cli-client/stake/redelegate.md b/docs/zh/cli-client/stake/redelegate.md index b1e236181..385c17ab8 100644 --- a/docs/zh/cli-client/stake/redelegate.md +++ b/docs/zh/cli-client/stake/redelegate.md @@ -15,7 +15,7 @@ iriscli stake redelegate [flags] iriscli stake redelegate --help ``` -## 特有flags +## 特有的flags | 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | | -------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | diff --git a/docs/zh/cli-client/stake/redelegation.md b/docs/zh/cli-client/stake/redelegation.md index 4d5c07815..b78169e5f 100644 --- a/docs/zh/cli-client/stake/redelegation.md +++ b/docs/zh/cli-client/stake/redelegation.md @@ -9,27 +9,23 @@ ``` iriscli stake redelegation [flags] ``` +打印帮助信息 +``` +iriscli stake redelegation --help +``` -## 标志 +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator-dest | | [string] 目标验证者bech地址 | Yes | | --address-validator-source | | [string] 源验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | -## 例子 +## 示例 -### 查询重新委托记录 - -```shell +查询重新委托记录 +``` iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/zh/cli-client/stake/redelegations-from.md b/docs/zh/cli-client/stake/redelegations-from.md index 6d6b9ff7f..ee9f286e5 100644 --- a/docs/zh/cli-client/stake/redelegations-from.md +++ b/docs/zh/cli-client/stake/redelegations-from.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake redelegations-from [operator-addr] [flags] +iriscli stake redelegations-from [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake redelegations-from --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegations-from命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于某一验证者的所有重新委托查询 +## 示例 -```shell -iriscli stake redelegations-from ValidatorAddress +基于某一验证者的所有重新委托查询 +``` +iriscli stake redelegations-from [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/redelegations.md b/docs/zh/cli-client/stake/redelegations.md index 022597494..e7b74cea7 100644 --- a/docs/zh/cli-client/stake/redelegations.md +++ b/docs/zh/cli-client/stake/redelegations.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake redelegations [delegator-addr] [flags] +iriscli stake redelegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake redelegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于委托者地址的所有重新委托记录查询 +## 示例 -```shell -iriscli stake redelegations DelegatorAddress +基于委托者地址的所有重新委托记录查询 +``` +iriscli stake redelegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/signing-info.md b/docs/zh/cli-client/stake/signing-info.md index 0bd07259f..67590838f 100644 --- a/docs/zh/cli-client/stake/signing-info.md +++ b/docs/zh/cli-client/stake/signing-info.md @@ -9,25 +9,16 @@ ``` iriscli stake signing-info [validator-pubkey] [flags] ``` +打印帮助信息 +``` +iriscli stake signing-info --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | signing-info命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询验证者签名信息 +## 示例 -```shell -iriscli stake signing-info ValidatorPublicKey +查询验证者签名信息 +``` +iriscli stake signing-info [validator-pubkey] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unbonding-delegation.md b/docs/zh/cli-client/stake/unbonding-delegation.md index fcd74b018..b46190aa9 100644 --- a/docs/zh/cli-client/stake/unbonding-delegation.md +++ b/docs/zh/cli-client/stake/unbonding-delegation.md @@ -9,27 +9,22 @@ ``` iriscli stake unbonding-delegation [flags] ``` +打印帮助信息 +``` +iriscli stake unbonding-delegation --help +``` -## 标志 +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator | | [string] 验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 +## 示例 -### 查询unbonding-delegation - -```shell +查询unbonding-delegation +``` iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress ``` diff --git a/docs/zh/cli-client/stake/unbonding-delegations-from.md b/docs/zh/cli-client/stake/unbonding-delegations-from.md index 2e2ba849f..072f384d5 100644 --- a/docs/zh/cli-client/stake/unbonding-delegations-from.md +++ b/docs/zh/cli-client/stake/unbonding-delegations-from.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake unbonding-delegations-from [operator-addr] [flags] +iriscli stake unbonding-delegations-from [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake unbonding-delegations-from --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegations-from命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于验证者地址的所有unbonding-delegation记录查询 +## 示例 -```shell -iriscli stake unbonding-delegations ValidatorAddress +基于验证者地址的所有unbonding-delegation记录查询 +``` +iriscli stake unbonding-delegations [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unbonding-delegations.md b/docs/zh/cli-client/stake/unbonding-delegations.md index afc64451f..6ba055aeb 100644 --- a/docs/zh/cli-client/stake/unbonding-delegations.md +++ b/docs/zh/cli-client/stake/unbonding-delegations.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake unbonding-delegations [delegator-addr] [flags] +iriscli stake unbonding-delegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake unbonding-delegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询unbonding-delegation +## 示例 -```shell -iriscli stake unbonding-delegations DelegatorAddress +查询unbonding-delegation +``` +iriscli stake unbonding-delegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unjail.md b/docs/zh/cli-client/stake/unjail.md index c9cd36a8d..abbad5ca5 100644 --- a/docs/zh/cli-client/stake/unjail.md +++ b/docs/zh/cli-client/stake/unjail.md @@ -12,7 +12,7 @@ iriscli stake unjail [flags] 打印帮助信息 -```shell +``` iriscli stake unjail --help ``` @@ -22,6 +22,6 @@ iriscli stake unjail --help ## 示例 -```shell +``` iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` diff --git a/docs/zh/cli-client/stake/validator.md b/docs/zh/cli-client/stake/validator.md index 1c85223ec..c232ff93b 100644 --- a/docs/zh/cli-client/stake/validator.md +++ b/docs/zh/cli-client/stake/validator.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake validator [owner-addr] [flags] +iriscli stake validator [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake validator --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | validator命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询验证者 +## 示例 -```shell -iriscli stake validator YourValidatorOwnerAddress +查询验证者 +``` +iriscli stake validator [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/validators.md b/docs/zh/cli-client/stake/validators.md index 47b53758e..28dc0c17f 100644 --- a/docs/zh/cli-client/stake/validators.md +++ b/docs/zh/cli-client/stake/validators.md @@ -9,24 +9,15 @@ ``` iriscli stake validators [flags] ``` +打印帮助信息 +``` +iriscli stake validators --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | validators命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## E例子 - -### 查询验证者 +## 示例 -```shell +查询验证者 +``` iriscli stake validators ``` diff --git a/docs/zh/features/distribution.md b/docs/zh/features/distribution.md index d516cbf3a..398edd9e6 100644 --- a/docs/zh/features/distribution.md +++ b/docs/zh/features/distribution.md @@ -1,4 +1,4 @@ -# 收益分配模块的用户手册 +# distribution模块的用户手册 ## 简介