R4R: irishub gov module docs #621
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Good job! |
zhangyelong
suggested changes
Nov 16, 2018
docs/cli-client/gov/README.md
Outdated
|
|
||
| IRIShub Gov module allows you to submit proposals, vote and query the governance information you care about on the chain: | ||
| 1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value min_deposit, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches min_deposit, enter voting period. However, if the block-time exceeds max_deposit_period in the deposit period, the proposal will be closed. |
There was a problem hiding this comment.
Duplicate from Extended description, can we remove it here ? cli-client documents only aim to show users how to use iris from command line, we have a feature documents to declare the details of our modules.
docs/cli-client/gov/README.md
Outdated
| | ------------------------------------- | --------------------------------------------------------------- | | ||
| | [query-proposal](query-proposal.md) | Query details of a single proposal | | ||
| | [query-proposals](query-proposals.md) | query proposals with optional filters | |
There was a problem hiding this comment.
Maybe we could keep the first letter of description uppercase
docs/cli-client/gov/deposit.md
Outdated
| | --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 submit-proposal | | |
docs/cli-client/gov/pull-params.md
Outdated
| | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| | --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 submit-proposal | | |
docs/cli-client/gov/query-deposit.md
Outdated
| | --chain-id | | [string] Chain ID of tendermint node | Yes | | ||
| | --depositer | | [string] bech32 depositer address | Yes | | ||
| | --height | | [int] block height to query, omit to get most recent provable block | | | ||
| | --help, -h | | help for submit-proposal | | |
There was a problem hiding this comment.
Help for query-deposit
| | --chain-id | | [string] Chain ID of tendermint node | Yes | | ||
| | --depositer | | [string] (optional) filter by proposals deposited on by depositer | | | ||
| | --height | | [int] block height to query, omit to get most recent provable block | | | ||
| | --help, -h | | help for submit-proposal | | |
There was a problem hiding this comment.
Help for query-proposals
| iriscli gov query-proposals --chain-id=test | ||
| ``` | ||
|
|
||
| After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. |
docs/cli-client/gov/query-tally.md
Outdated
| | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| | --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 submit-proposal | | |
docs/cli-client/gov/query-vote.md
Outdated
| | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| | --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 submit-proposal | | |
docs/cli-client/gov/query-votes.md
Outdated
| | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| | --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 submit-proposal | | |
zhangyelong
approved these changes
Nov 16, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.