470 lines
7.9 KiB
Markdown
470 lines
7.9 KiB
Markdown
<!--
|
|
order: 8
|
|
-->
|
|
|
|
# Client
|
|
|
|
## CLI
|
|
|
|
A user can query and interact with the `distribution` module using the CLI.
|
|
|
|
### Query
|
|
|
|
The `query` commands allow users to query `distribution` state.
|
|
|
|
```sh
|
|
simd query distribution --help
|
|
```
|
|
|
|
#### commission
|
|
|
|
The `commission` command allows users to query validator commission rewards by address.
|
|
|
|
```sh
|
|
simd query distribution commission [address] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution commission cosmosvaloper1..
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
commission:
|
|
- amount: "1000000.000000000000000000"
|
|
denom: stake
|
|
```
|
|
|
|
#### community-pool
|
|
|
|
The `community-pool` command allows users to query all coin balances within the community pool.
|
|
|
|
```sh
|
|
simd query distribution community-pool [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution community-pool
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
pool:
|
|
- amount: "1000000.000000000000000000"
|
|
denom: stake
|
|
```
|
|
|
|
#### params
|
|
|
|
The `params` command allows users to query the parameters of the `distribution` module.
|
|
|
|
```sh
|
|
simd query distribution params [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution params
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
base_proposer_reward: "0.010000000000000000"
|
|
bonus_proposer_reward: "0.040000000000000000"
|
|
community_tax: "0.020000000000000000"
|
|
withdraw_addr_enabled: true
|
|
```
|
|
|
|
#### rewards
|
|
|
|
The `rewards` command allows users to query delegator rewards. Users can optionally include the validator address to query rewards earned from a specific validator.
|
|
|
|
```sh
|
|
simd query distribution rewards [delegator-addr] [validator-addr] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution rewards cosmos1..
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
rewards:
|
|
- reward:
|
|
- amount: "1000000.000000000000000000"
|
|
denom: stake
|
|
validator_address: cosmosvaloper1..
|
|
total:
|
|
- amount: "1000000.000000000000000000"
|
|
denom: stake
|
|
```
|
|
|
|
#### slashes
|
|
|
|
The `slashes` command allows users to query all slashes for a given block range.
|
|
|
|
```sh
|
|
simd query distribution slashes [validator] [start-height] [end-height] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution slashes cosmosvaloper1.. 1 1000
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
pagination:
|
|
next_key: null
|
|
total: "0"
|
|
slashes:
|
|
- validator_period: 20,
|
|
fraction: "0.009999999999999999"
|
|
```
|
|
|
|
#### validator-outstanding-rewards
|
|
|
|
The `validator-outstanding-rewards` command allows users to query all outstanding (un-withdrawn) rewards for a validator and all their delegations.
|
|
|
|
```sh
|
|
simd query distribution validator-outstanding-rewards [validator] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd query distribution validator-outstanding-rewards cosmosvaloper1..
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```yml
|
|
rewards:
|
|
- amount: "1000000.000000000000000000"
|
|
denom: stake
|
|
```
|
|
|
|
### Transactions
|
|
|
|
The `tx` commands allow users to interact with the `distribution` module.
|
|
|
|
```sh
|
|
simd tx distribution --help
|
|
```
|
|
|
|
#### fund-community-pool
|
|
|
|
The `fund-community-pool` command allows users to send funds to the community pool.
|
|
|
|
```sh
|
|
simd tx distribution fund-community-pool [amount] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd tx distribution fund-community-pool 100stake --from cosmos1..
|
|
```
|
|
|
|
#### set-withdraw-addr
|
|
|
|
The `set-withdraw-addr` command allows users to set the withdraw address for rewards associated with a delegator address.
|
|
|
|
```sh
|
|
simd tx distribution set-withdraw-addr [withdraw-addr] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd tx distribution set-withdraw-addr cosmos1.. --from cosmos1..
|
|
```
|
|
|
|
#### withdraw-all-rewards
|
|
|
|
The `withdraw-all-rewards` command allows users to withdraw all rewards for a delegator.
|
|
|
|
```sh
|
|
simd tx distribution withdraw-all-rewards [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd tx distribution withdraw-all-rewards --from cosmos1..
|
|
```
|
|
|
|
#### withdraw-rewards
|
|
|
|
The `withdraw-rewards` command allows users to withdraw all rewards from a given delegation address,
|
|
and optionally withdraw validator commission if the delegation address given is a validator operator and the user proves the `--commision` flag.
|
|
|
|
```sh
|
|
simd tx distribution withdraw-rewards [validator-addr] [flags]
|
|
```
|
|
|
|
Example:
|
|
|
|
```sh
|
|
simd tx distribution withdraw-rewards cosmosvaloper1.. --from cosmos1.. --commision
|
|
```
|
|
|
|
## gRPC
|
|
|
|
A user can query the `distribution` module using gRPC endpoints.
|
|
|
|
### Params
|
|
|
|
The `Params` endpoint allows users to query parameters of the `distribution` module.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/Params
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"params": {
|
|
"communityTax": "20000000000000000",
|
|
"baseProposerReward": "10000000000000000",
|
|
"bonusProposerReward": "40000000000000000",
|
|
"withdrawAddrEnabled": true
|
|
}
|
|
}
|
|
```
|
|
|
|
### ValidatorOutstandingRewards
|
|
|
|
The `ValidatorOutstandingRewards` endpoint allows users to query rewards of a validator address.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"validator_address":"cosmosvalop1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/ValidatorOutstandingRewards
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"rewards": {
|
|
"rewards": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### ValidatorCommission
|
|
|
|
The `ValidatorCommission` endpoint allows users to query accumulated commission for a validator.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"validator_address":"cosmosvalop1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/ValidatorCommission
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"commission": {
|
|
"commission": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### ValidatorSlashes
|
|
|
|
The `ValidatorSlashes` endpoint allows users to query slash events of a validator.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"validator_address":"cosmosvalop1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/ValidatorSlashes
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"slashes": [
|
|
{
|
|
"validator_period": "20",
|
|
"fraction": "0.009999999999999999"
|
|
}
|
|
],
|
|
"pagination": {
|
|
"total": "1"
|
|
}
|
|
}
|
|
```
|
|
|
|
### DelegationRewards
|
|
|
|
The `DelegationRewards` endpoint allows users to query the total rewards accrued by a delegation.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"delegator_address":"cosmos1..","validator_address":"cosmosvalop1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/DelegationRewards
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"rewards": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### DelegationTotalRewards
|
|
|
|
The `DelegationTotalRewards` endpoint allows users to query the total rewards accrued by each validator.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"delegator_address":"cosmos1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/DelegationTotalRewards
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"rewards": [
|
|
{
|
|
"validatorAddress": "cosmosvaloper1..",
|
|
"reward": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"total": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### DelegatorValidators
|
|
|
|
The `DelegatorValidators` endpoint allows users to query all validators for given delegator.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"delegator_address":"cosmos1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/DelegatorValidators
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"validators": [
|
|
"cosmosvaloper1.."
|
|
]
|
|
}
|
|
```
|
|
|
|
### DelegatorWithdrawAddress
|
|
|
|
The `DelegatorWithdrawAddress` endpoint allows users to query the withdraw address of a delegator.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
-d '{"delegator_address":"cosmos1.."}' \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/DelegatorWithdrawAddress
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"withdrawAddress": "cosmos1.."
|
|
}
|
|
```
|
|
|
|
### CommunityPool
|
|
|
|
The `CommunityPool` endpoint allows users to query the community pool coins.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
grpcurl -plaintext \
|
|
localhost:9090 \
|
|
cosmos.distribution.v1beta1.Query/CommunityPool
|
|
```
|
|
|
|
Example Output:
|
|
|
|
```json
|
|
{
|
|
"pool": [
|
|
{
|
|
"denom": "stake",
|
|
"amount": "1000000000000000000"
|
|
}
|
|
]
|
|
}
|
|
```
|