94377f1cb3
<!-- 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: #9694 goes hand-in-hand with https://github.com/cosmos/cosmos-proto/pull/17 <!-- 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 - [ ] 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 - [x] 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` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] 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)
220 lines
9.4 KiB
Protocol Buffer
220 lines
9.4 KiB
Protocol Buffer
syntax = "proto3";
|
|
package cosmos.distribution.v1beta1;
|
|
|
|
import "cosmos/base/query/v1beta1/pagination.proto";
|
|
import "gogoproto/gogo.proto";
|
|
import "google/api/annotations.proto";
|
|
import "cosmos/base/v1beta1/coin.proto";
|
|
import "cosmos/distribution/v1beta1/distribution.proto";
|
|
import "cosmos_proto/cosmos.proto";
|
|
|
|
option go_package = "github.com/cosmos/cosmos-sdk/x/distribution/types";
|
|
|
|
// Query defines the gRPC querier service for distribution module.
|
|
service Query {
|
|
// Params queries params of the distribution module.
|
|
rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/params";
|
|
}
|
|
|
|
// ValidatorOutstandingRewards queries rewards of a validator address.
|
|
rpc ValidatorOutstandingRewards(QueryValidatorOutstandingRewardsRequest)
|
|
returns (QueryValidatorOutstandingRewardsResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/validators/"
|
|
"{validator_address}/outstanding_rewards";
|
|
}
|
|
|
|
// ValidatorCommission queries accumulated commission for a validator.
|
|
rpc ValidatorCommission(QueryValidatorCommissionRequest) returns (QueryValidatorCommissionResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/validators/"
|
|
"{validator_address}/commission";
|
|
}
|
|
|
|
// ValidatorSlashes queries slash events of a validator.
|
|
rpc ValidatorSlashes(QueryValidatorSlashesRequest) returns (QueryValidatorSlashesResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/validators/{validator_address}/slashes";
|
|
}
|
|
|
|
// DelegationRewards queries the total rewards accrued by a delegation.
|
|
rpc DelegationRewards(QueryDelegationRewardsRequest) returns (QueryDelegationRewardsResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards/"
|
|
"{validator_address}";
|
|
}
|
|
|
|
// DelegationTotalRewards queries the total rewards accrued by a each
|
|
// validator.
|
|
rpc DelegationTotalRewards(QueryDelegationTotalRewardsRequest) returns (QueryDelegationTotalRewardsResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards";
|
|
}
|
|
|
|
// DelegatorValidators queries the validators of a delegator.
|
|
rpc DelegatorValidators(QueryDelegatorValidatorsRequest) returns (QueryDelegatorValidatorsResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/delegators/"
|
|
"{delegator_address}/validators";
|
|
}
|
|
|
|
// DelegatorWithdrawAddress queries withdraw address of a delegator.
|
|
rpc DelegatorWithdrawAddress(QueryDelegatorWithdrawAddressRequest) returns (QueryDelegatorWithdrawAddressResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/delegators/"
|
|
"{delegator_address}/withdraw_address";
|
|
}
|
|
|
|
// CommunityPool queries the community pool coins.
|
|
rpc CommunityPool(QueryCommunityPoolRequest) returns (QueryCommunityPoolResponse) {
|
|
option (google.api.http).get = "/cosmos/distribution/v1beta1/community_pool";
|
|
}
|
|
}
|
|
|
|
// QueryParamsRequest is the request type for the Query/Params RPC method.
|
|
message QueryParamsRequest {}
|
|
|
|
// QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
message QueryParamsResponse {
|
|
// params defines the parameters of the module.
|
|
Params params = 1 [(gogoproto.nullable) = false];
|
|
}
|
|
|
|
// QueryValidatorOutstandingRewardsRequest is the request type for the
|
|
// Query/ValidatorOutstandingRewards RPC method.
|
|
message QueryValidatorOutstandingRewardsRequest {
|
|
// validator_address defines the validator address to query for.
|
|
string validator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryValidatorOutstandingRewardsResponse is the response type for the
|
|
// Query/ValidatorOutstandingRewards RPC method.
|
|
message QueryValidatorOutstandingRewardsResponse {
|
|
ValidatorOutstandingRewards rewards = 1 [(gogoproto.nullable) = false];
|
|
}
|
|
|
|
// QueryValidatorCommissionRequest is the request type for the
|
|
// Query/ValidatorCommission RPC method
|
|
message QueryValidatorCommissionRequest {
|
|
// validator_address defines the validator address to query for.
|
|
string validator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryValidatorCommissionResponse is the response type for the
|
|
// Query/ValidatorCommission RPC method
|
|
message QueryValidatorCommissionResponse {
|
|
// commission defines the commision the validator received.
|
|
ValidatorAccumulatedCommission commission = 1 [(gogoproto.nullable) = false];
|
|
}
|
|
|
|
// QueryValidatorSlashesRequest is the request type for the
|
|
// Query/ValidatorSlashes RPC method
|
|
message QueryValidatorSlashesRequest {
|
|
option (gogoproto.goproto_getters) = false;
|
|
option (gogoproto.goproto_stringer) = true;
|
|
|
|
// validator_address defines the validator address to query for.
|
|
string validator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
// starting_height defines the optional starting height to query the slashes.
|
|
uint64 starting_height = 2;
|
|
// starting_height defines the optional ending height to query the slashes.
|
|
uint64 ending_height = 3;
|
|
// pagination defines an optional pagination for the request.
|
|
cosmos.base.query.v1beta1.PageRequest pagination = 4;
|
|
}
|
|
|
|
// QueryValidatorSlashesResponse is the response type for the
|
|
// Query/ValidatorSlashes RPC method.
|
|
message QueryValidatorSlashesResponse {
|
|
// slashes defines the slashes the validator received.
|
|
repeated ValidatorSlashEvent slashes = 1 [(gogoproto.nullable) = false];
|
|
|
|
// pagination defines the pagination in the response.
|
|
cosmos.base.query.v1beta1.PageResponse pagination = 2;
|
|
}
|
|
|
|
// QueryDelegationRewardsRequest is the request type for the
|
|
// Query/DelegationRewards RPC method.
|
|
message QueryDelegationRewardsRequest {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
// delegator_address defines the delegator address to query for.
|
|
string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
// validator_address defines the validator address to query for.
|
|
string validator_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryDelegationRewardsResponse is the response type for the
|
|
// Query/DelegationRewards RPC method.
|
|
message QueryDelegationRewardsResponse {
|
|
// rewards defines the rewards accrued by a delegation.
|
|
repeated cosmos.base.v1beta1.DecCoin rewards = 1
|
|
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"];
|
|
}
|
|
|
|
// QueryDelegationTotalRewardsRequest is the request type for the
|
|
// Query/DelegationTotalRewards RPC method.
|
|
message QueryDelegationTotalRewardsRequest {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
// delegator_address defines the delegator address to query for.
|
|
string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryDelegationTotalRewardsResponse is the response type for the
|
|
// Query/DelegationTotalRewards RPC method.
|
|
message QueryDelegationTotalRewardsResponse {
|
|
// rewards defines all the rewards accrued by a delegator.
|
|
repeated DelegationDelegatorReward rewards = 1 [(gogoproto.nullable) = false];
|
|
// total defines the sum of all the rewards.
|
|
repeated cosmos.base.v1beta1.DecCoin total = 2
|
|
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"];
|
|
}
|
|
|
|
// QueryDelegatorValidatorsRequest is the request type for the
|
|
// Query/DelegatorValidators RPC method.
|
|
message QueryDelegatorValidatorsRequest {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
// delegator_address defines the delegator address to query for.
|
|
string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryDelegatorValidatorsResponse is the response type for the
|
|
// Query/DelegatorValidators RPC method.
|
|
message QueryDelegatorValidatorsResponse {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
// validators defines the validators a delegator is delegating for.
|
|
repeated string validators = 1;
|
|
}
|
|
|
|
// QueryDelegatorWithdrawAddressRequest is the request type for the
|
|
// Query/DelegatorWithdrawAddress RPC method.
|
|
message QueryDelegatorWithdrawAddressRequest {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
// delegator_address defines the delegator address to query for.
|
|
string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryDelegatorWithdrawAddressResponse is the response type for the
|
|
// Query/DelegatorWithdrawAddress RPC method.
|
|
message QueryDelegatorWithdrawAddressResponse {
|
|
option (gogoproto.equal) = false;
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
// withdraw_address defines the delegator address to query for.
|
|
string withdraw_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
|
}
|
|
|
|
// QueryCommunityPoolRequest is the request type for the Query/CommunityPool RPC
|
|
// method.
|
|
message QueryCommunityPoolRequest {}
|
|
|
|
// QueryCommunityPoolResponse is the response type for the Query/CommunityPool
|
|
// RPC method.
|
|
message QueryCommunityPoolResponse {
|
|
// pool defines community pool's coins.
|
|
repeated cosmos.base.v1beta1.DecCoin pool = 1
|
|
[(gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins", (gogoproto.nullable) = false];
|
|
}
|