docs: add client spec for x/slashing (#10307)
<!-- 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: #10291 <!-- 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:
Prathyusha Lakkireddy
GitHub
parent
127d9a01fd
commit
90181d7cd2
|
|
@ -0,0 +1,296 @@
|
|||
<!--
|
||||
order: 9
|
||||
-->
|
||||
|
||||
## CLI
|
||||
|
||||
A user can query and interact with the `slashing` module using the CLI.
|
||||
|
||||
### Query
|
||||
|
||||
The `query` commands allow users to query `slashing` state.
|
||||
|
||||
```bash
|
||||
simd query slashing --help
|
||||
```
|
||||
|
||||
#### params
|
||||
|
||||
The `params` command allows users to query genesis parameters for the slashing module.
|
||||
|
||||
```bash
|
||||
simd query slashing params [flags]
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
simd query slashing params
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
downtime_jail_duration: 600s
|
||||
min_signed_per_window: "0.500000000000000000"
|
||||
signed_blocks_window: "100"
|
||||
slash_fraction_double_sign: "0.050000000000000000"
|
||||
slash_fraction_downtime: "0.010000000000000000"
|
||||
```
|
||||
|
||||
|
||||
#### signing-info
|
||||
|
||||
The `signing-info` command allows users to query signing-info of the validator using consensus public key.
|
||||
|
||||
```bash
|
||||
simd query slashing signing-infos [flags]
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
simd query slashing signing-info '{"@type":"/cosmos.crypto.ed25519.PubKey","key":"Auxs3865HpB/EfssYOzfqNhEJjzys6jD5B6tPgC8="}'
|
||||
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
address: cosmosvalcons1nrqsld3aw6lh6t082frdqc84uwxn0t958c
|
||||
index_offset: "2068"
|
||||
jailed_until: "1970-01-01T00:00:00Z"
|
||||
missed_blocks_counter: "0"
|
||||
start_height: "0"
|
||||
tombstoned: false
|
||||
```
|
||||
|
||||
#### signing-infos
|
||||
|
||||
The `signing-infos` command allows users to query signing infos of all validators.
|
||||
|
||||
```bash
|
||||
simd query slashing signing-infos [flags]
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
simd query slashing signing-infos
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
info:
|
||||
- address: cosmosvalcons1nrqsld3aw6lh6t082frdqc84uwxn0t958c
|
||||
index_offset: "2075"
|
||||
jailed_until: "1970-01-01T00:00:00Z"
|
||||
missed_blocks_counter: "0"
|
||||
start_height: "0"
|
||||
tombstoned: false
|
||||
pagination:
|
||||
next_key: null
|
||||
total: "0"
|
||||
```
|
||||
|
||||
### Transactions
|
||||
|
||||
The `tx` commands allow users to interact with the `slashing` module.
|
||||
|
||||
```bash
|
||||
simd tx slashing --help
|
||||
```
|
||||
|
||||
#### unjail
|
||||
|
||||
The `unjail` command allows users to unjail a validator previously jailed for downtime.
|
||||
|
||||
```bash
|
||||
simd tx slashing unjail --from mykey [flags]
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
simd tx slashing unjail --from mykey
|
||||
```
|
||||
|
||||
## gRPC
|
||||
|
||||
A user can query the `slashing` module using gRPC endpoints.
|
||||
|
||||
### Params
|
||||
|
||||
The `Params` endpoint allows users to query the parameters of slashing module.
|
||||
|
||||
```bash
|
||||
cosmos.slashing.v1beta1.Query/Params
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
grpcurl -plaintext localhost:9090 cosmos.slashing.v1beta1.Query/Params
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"params": {
|
||||
"signedBlocksWindow": "100",
|
||||
"minSignedPerWindow": "NTAwMDAwMDAwMDAwMDAwMDAw",
|
||||
"downtimeJailDuration": "600s",
|
||||
"slashFractionDoubleSign": "NTAwMDAwMDAwMDAwMDAwMDA=",
|
||||
"slashFractionDowntime": "MTAwMDAwMDAwMDAwMDAwMDA="
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### SigningInfo
|
||||
|
||||
The SigningInfo queries the signing info of given cons address.
|
||||
|
||||
```bash
|
||||
cosmos.slashing.v1beta1.Query/SigningInfo
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
grpcurl -plaintext -d '{"cons_address":"cosmosvalcons1nrqsld3aw6lh6t082frdqc84uwxn0t958c"}' localhost:9090 cosmos.slashing.v1beta1.Query/SigningInfo
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"valSigningInfo": {
|
||||
"address": "cosmosvalcons1nrqsld3aw6lh6t082frdqc84uwxn0t958c",
|
||||
"indexOffset": "3493",
|
||||
"jailedUntil": "1970-01-01T00:00:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### SigningInfos
|
||||
|
||||
The SigningInfos queries signing info of all validators.
|
||||
|
||||
```bash
|
||||
cosmos.slashing.v1beta1.Query/SigningInfos
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
grpcurl -plaintext localhost:9090 cosmos.slashing.v1beta1.Query/SigningInfos
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"info": [
|
||||
{
|
||||
"address": "cosmosvalcons1nrqslkwd3pz096lh6t082frdqc84uwxn0t958c",
|
||||
"indexOffset": "2467",
|
||||
"jailedUntil": "1970-01-01T00:00:00Z"
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
"total": "1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## REST
|
||||
|
||||
A user can query the `slashing` module using REST endpoints.
|
||||
|
||||
|
||||
### Params
|
||||
|
||||
```bash
|
||||
/cosmos/slashing/v1beta1/params
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
curl "localhost:1317/cosmos/slashing/v1beta1/params"
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"params": {
|
||||
"signed_blocks_window": "100",
|
||||
"min_signed_per_window": "0.500000000000000000",
|
||||
"downtime_jail_duration": "600s",
|
||||
"slash_fraction_double_sign": "0.050000000000000000",
|
||||
"slash_fraction_downtime": "0.010000000000000000"
|
||||
}
|
||||
```
|
||||
|
||||
### signing_info
|
||||
|
||||
```bash
|
||||
/cosmos/slashing/v1beta1/signing_infos/%s
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
curl "localhost:1317/cosmos/slashing/v1beta1/signing_infos/cosmosvalcons1nrqslkwd3pz096lh6t082frdqc84uwxn0t958c"
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"val_signing_info": {
|
||||
"address": "cosmosvalcons1nrqslkwd3pz096lh6t082frdqc84uwxn0t958c",
|
||||
"start_height": "0",
|
||||
"index_offset": "4184",
|
||||
"jailed_until": "1970-01-01T00:00:00Z",
|
||||
"tombstoned": false,
|
||||
"missed_blocks_counter": "0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### signing_infos
|
||||
|
||||
```bash
|
||||
/cosmos/slashing/v1beta1/signing_infos
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
curl "localhost:1317/cosmos/slashing/v1beta1/signing_infos
|
||||
```
|
||||
|
||||
Example Output:
|
||||
|
||||
```bash
|
||||
{
|
||||
"info": [
|
||||
{
|
||||
"address": "cosmosvalcons1nrqslkwd3pz096lh6t082frdqc84uwxn0t958c",
|
||||
"start_height": "0",
|
||||
"index_offset": "4169",
|
||||
"jailed_until": "1970-01-01T00:00:00Z",
|
||||
"tombstoned": false,
|
||||
"missed_blocks_counter": "0"
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
"next_key": null,
|
||||
"total": "1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -43,3 +43,7 @@ This module will be used by the Cosmos Hub, the first hub in the Cosmos ecosyste
|
|||
7. **[Staking Tombstone](07_tombstone.md)**
|
||||
- [Abstract](07_tombstone.md#abstract)
|
||||
8. **[Parameters](08_params.md)**
|
||||
9. **[Client](09_client.md)**
|
||||
- [CLI](09_client.md#cli)
|
||||
- [gRPC](09_client.md#grpc)
|
||||
- [REST](09_client.md#rest)
|
||||
Loading…
Reference in New Issue