-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into fix/tx-fees-null-guard
- Loading branch information
Showing
8 changed files
with
281 additions
and
18 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <!-- | ||
| order: 7 | ||
| --> | ||
|
|
||
| # Client | ||
|
|
||
| ## CLI | ||
|
|
||
| A user can query and interact with the `vesting` module using the CLI. | ||
|
|
||
| ### Transactions | ||
|
|
||
| The `tx` commands allow users to interact with the `vesting` module. | ||
|
|
||
| ```bash | ||
| simd tx vesting --help | ||
| ``` | ||
|
|
||
| #### create-periodic-vesting-account | ||
|
|
||
| The `create-periodic-vesting-account` command creates a new vesting account funded with an allocation of tokens, where a sequence of coins and period length in seconds. Periods are sequential, in that the duration of of a period only starts at the end of the previous period. The duration of the first period starts upon account creation. | ||
|
|
||
| ```bash | ||
| simd tx vesting create-periodic-vesting-account [to_address] [periods_json_file] [flags] | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| simd tx vesting create-periodic-vesting-account cosmos1.. periods.json | ||
| ``` | ||
|
|
||
| #### create-vesting-account | ||
|
|
||
| The `create-vesting-account` command creates a new vesting account funded with an allocation of tokens. The account can either be a delayed or continuous vesting account, which is determined by the '--delayed' flag. All vesting accouts created will have their start time set by the committed block's time. The end_time must be provided as a UNIX epoch timestamp. | ||
|
|
||
| ```bash | ||
| simd tx vesting create-vesting-account [to_address] [amount] [end_time] [flags] | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| simd tx vesting create-vesting-account cosmos1.. 100stake 2592000 | ||
| ``` |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| <!-- | ||
| order: 6 | ||
| --> | ||
|
|
||
| # Client | ||
|
|
||
|
|
||
| ## CLI | ||
|
|
||
| A user can query and interact with the `mint` module using the CLI. | ||
|
|
||
| ### Query | ||
|
|
||
| The `query` commands allow users to query `mint` state. | ||
|
|
||
| ``` | ||
| simd query mint --help | ||
| ``` | ||
|
|
||
| #### annual-provisions | ||
|
|
||
| The `annual-provisions` command allow users to query the current minting annual provisions value | ||
|
|
||
| ``` | ||
| simd query mint annual-provisions [flags] | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| simd query mint annual-provisions | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| 22268504368893.612100895088410693 | ||
| ``` | ||
|
|
||
|
|
||
| #### inflation | ||
|
|
||
| The `inflation` command allow users to query the current minting inflation value | ||
|
|
||
| ``` | ||
| simd query mint inflation [flags] | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| simd query mint inflation | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| 0.199200302563256955 | ||
| ``` | ||
|
|
||
| #### params | ||
|
|
||
| The `params` command allow users to query the current minting parameters | ||
|
|
||
|
|
||
| ``` | ||
| simd query mint params [flags] | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| blocks_per_year: "4360000" | ||
| goal_bonded: "0.670000000000000000" | ||
| inflation_max: "0.200000000000000000" | ||
| inflation_min: "0.070000000000000000" | ||
| inflation_rate_change: "0.130000000000000000" | ||
| mint_denom: stake | ||
| ``` | ||
|
|
||
| ## gRPC | ||
|
|
||
| A user can query the `mint` module using gRPC endpoints. | ||
|
|
||
| ### AnnualProvisions | ||
|
|
||
| The `AnnualProvisions` endpoint allow users to query the current minting annual provisions value | ||
|
|
||
| ``` | ||
| /cosmos.mint.v1beta1.Query/AnnualProvisions | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/AnnualProvisions | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "annualProvisions": "1432452520532626265712995618" | ||
| } | ||
| ``` | ||
|
|
||
| ### Inflation | ||
|
|
||
| The `Inflation` endpoint allow users to query the current minting inflation value | ||
|
|
||
| ``` | ||
| /cosmos.mint.v1beta1.Query/Inflation | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/Inflation | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "inflation": "130197115720711261" | ||
| } | ||
| ``` | ||
|
|
||
| ### Params | ||
|
|
||
| The `Params` endpoint allow users to query the current minting parameters | ||
|
|
||
|
|
||
| ``` | ||
| /cosmos.mint.v1beta1.Query/Params | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/Params | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "params": { | ||
| "mintDenom": "stake", | ||
| "inflationRateChange": "130000000000000000", | ||
| "inflationMax": "200000000000000000", | ||
| "inflationMin": "70000000000000000", | ||
| "goalBonded": "670000000000000000", | ||
| "blocksPerYear": "6311520" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## REST | ||
|
|
||
| A user can query the `mint` module using REST endpoints. | ||
|
|
||
| ### annual-provisions | ||
|
|
||
| ``` | ||
| /cosmos/mint/v1beta1/annual_provisions | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| curl "localhost:1317/cosmos/mint/v1beta1/annual_provisions" | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "annualProvisions": "1432452520532626265712995618" | ||
| } | ||
| ``` | ||
|
|
||
| ### inflation | ||
|
|
||
| ``` | ||
| /cosmos/mint/v1beta1/inflation | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| curl "localhost:1317/cosmos/mint/v1beta1/inflation" | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "inflation": "130197115720711261" | ||
| } | ||
| ``` | ||
|
|
||
| ### params | ||
|
|
||
| ``` | ||
| /cosmos/mint/v1beta1/params | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| curl "localhost:1317/cosmos/mint/v1beta1/params" | ||
| ``` | ||
|
|
||
| Example Output: | ||
|
|
||
| ``` | ||
| { | ||
| "params": { | ||
| "mintDenom": "stake", | ||
| "inflationRateChange": "130000000000000000", | ||
| "inflationMax": "200000000000000000", | ||
| "inflationMin": "70000000000000000", | ||
| "goalBonded": "670000000000000000", | ||
| "blocksPerYear": "6311520" | ||
| } | ||
| } | ||
| ``` |
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