Skip to content

Commit

Permalink
Merge pull request #632 from MrXJC/jiacheng/docs
Browse files Browse the repository at this point in the history 
R4R:Bech32,Genesis,Gov Params,Features/gov,Cli-client/upgrade
  • Loading branch information
HaoyangLiu authored Nov 18, 2018
2 parents 1555e78 + b5e7637 commit 6a6b628
Show file tree
Hide file tree
Showing 41 changed files with 796 additions and 609 deletions.
27 changes: 6 additions & 21 deletions docs/cli-client/gov/deposit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,17 @@ Deposit tokens for activing proposal
iriscli gov deposit [flags]
```
Print help messages:
```
iriscli gov deposit --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --account-number | | [int] AccountNumber number to sign the tx | |
| --async | | Broadcast transactions asynchronously | |
| --chain-id | | [string] Chain ID of tendermint node | Yes |
| --deposit | | [string] Deposit of proposal | Yes |
| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | |
| --fee | | [string] Fee to pay along with transaction | Yes |
| --from | | [string] Name of private key with which to sign | Yes |
| --from-addr | | [string] Specify from address in generate-only mode | |
| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | |
| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | |
| --generate-only | | Build an unsigned transaction and write it to STDOUT | |
| --help, -h | | Help for deposit | |
| --indent | | Add indent to JSON response | |
| --json | | Return output in json format | |
| --ledger | | Use a connected Ledger device | |
| --memo | | [string] Memo to send along with transaction | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --print-response | | return tx response (only works with async = false) | |
| --proposal-id | | [string] ProposalID of proposal depositing on | Yes |
| --sequence | | [int] Sequence number to sign the tx | |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
### Deposit
Expand All @@ -57,4 +42,4 @@ Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A8882
"proposal-id": "1"
}
}
```
```
15 changes: 7 additions & 8 deletions docs/cli-client/gov/pull-params.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Generate param.json file
iriscli gov pull-params [flags]
```
Print help messages:
```
iriscli gov pull-params --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --chain-id | | [string] Chain ID of tendermint node | |
| --height | | [int] Block height to query, omit to get most recent provable block | |
| --help, -h | | Help for pull-params | |
| --indent | | Add indent to JSON response | |
| --ledger | | Use a connected Ledger device | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --path | $HOME/.iris | [string] Directory of iris home | |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
Expand Down Expand Up @@ -84,4 +83,4 @@ If you open the params.json in the --path/config directory, you can see it's jso
}
}
}
```
```
14 changes: 6 additions & 8 deletions docs/cli-client/gov/query-deposit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,17 @@ Query details of a deposit
iriscli gov query-deposit [flags]
```
Print help messages:
```
iriscli gov query-deposit --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --chain-id | | [string] Chain ID of tendermint node | Yes |
| --depositor | | [string] Bech32 depositor address | Yes |
| --height | | [int] Block height to query, omit to get most recent provable block | |
| --help, -h | | Help for query-deposit | |
| --indent | | Add indent to JSON response | |
| --ledger | | Use a connected Ledger device | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --proposal-id | | [string] ProposalID of proposal depositing on | Yes |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
Expand All @@ -45,4 +43,4 @@ You could query the deposited tokens on a specific proposal.
}
]
}
```
```
15 changes: 7 additions & 8 deletions docs/cli-client/gov/query-deposits.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Query details of a deposits
iriscli gov query-deposits [flags]
```
Print help messages:
```
iriscli gov query-deposits --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --chain-id | | [string] Chain ID of tendermint node | Yes |
| --height | | [int] Block height to query, omit to get most recent provable block | |
| --help, -h | | Help for query-deposits | |
| --indent | | Add indent to JSON response | |
| --ledger | | Use a connected Ledger device | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --proposal-id | | [string] ProposalID of proposal depositing on | Yes |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
Expand All @@ -46,4 +45,4 @@ You could query all the deposited tokens on a specific proposal, includes deposi
]
}
]
```
```
14 changes: 6 additions & 8 deletions docs/cli-client/gov/query-params.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,17 @@ Query parameter proposal's config
iriscli gov query-params [flags]
```
Print help messages:
```
iriscli gov query-params --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --chain-id | | [string] Chain ID of tendermint node | |
| --height | | [int] Block height to query, omit to get most recent provable block | |
| --help, -h | | Help for query-params | |
| --indent | | Add indent to JSON response | |
| --key | | [string] Key name of parameter | |
| --ledger | | Use a connected Ledger device | |
| --module | | [string] Module name | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
Expand Down Expand Up @@ -54,4 +52,4 @@ You'll get all the details of the key specified in the gov module.
{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"1000000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""}
```

Note: --module and --key cannot be both empty.
Note: --module and --key cannot be both empty.
15 changes: 7 additions & 8 deletions docs/cli-client/gov/query-proposal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Query details of a single proposal
iriscli gov query-proposal [flags]
```
Print help messages:
```
iriscli gov query-proposal --help
```
## Flags
| Name, shorthand | Default | Description | Required |
| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| --chain-id | | [string] Chain ID of tendermint node | Yes |
| --height | | [int] Block height to query, omit to get most recent provable block | |
| --help, -h | | Help for query-proposal | |
| --indent | | Add indent to JSON response | |
| --ledger | | Use a connected Ledger device | |
| --node | tcp://localhost:26657 | [string] \<host>:\<port> to tendermint rpc interface for this chain | |
| --proposal-id | | [string] ProposalID of proposal depositing on | Yes |
| --trust-node | true | Don't verify proofs for responses | |
## Examples
Expand Down Expand Up @@ -62,4 +61,4 @@ You could query the details of a specific proposal.
"op": ""
}
}
```
```
Loading

0 comments on commit 6a6b628

Please sign in to comment.