docs: add client spec for x/mint (#10330)
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes: #10290 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
parent
3458f64f0a
commit
50e146d764
|
@ -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"
|
||||
}
|
||||
}
|
||||
```
|
|
@ -20,3 +20,7 @@ parent:
|
|||
4. **[Parameters](04_params.md)**
|
||||
5. **[Events](05_events.md)**
|
||||
- [BeginBlocker](05_events.md#beginblocker)
|
||||
6. **[Client](06_client.md)**
|
||||
- [CLI](06_client.md#cli)
|
||||
- [gRPC](06_client.md#grpc)
|
||||
- [REST](06_client.md#rest)
|
||||
|
|
Loading…
Reference in New Issue