package cosmos.distribution.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the distribution Msg service.

• rpc SetWithdrawAddress (MsgSetWithdrawAddress, MsgSetWithdrawAddressResponse)

  tx.proto:20

  SetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation).

  message MsgSetWithdrawAddress

  tx.proto:51

  MsgSetWithdrawAddress sets the withdraw address for a delegator (or validator self-delegation).

  • string delegator_address = 1

  • string withdraw_address = 2

  message MsgSetWithdrawAddressResponse

  tx.proto:64

  MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response type.

  (message has no fields)

• rpc WithdrawDelegatorReward (MsgWithdrawDelegatorReward, MsgWithdrawDelegatorRewardResponse)

  tx.proto:24

  WithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator.

  message MsgWithdrawDelegatorReward

  tx.proto:68

  MsgWithdrawDelegatorReward represents delegation withdrawal to a delegator from a single validator.

  • string delegator_address = 1

  • string validator_address = 2

  message MsgWithdrawDelegatorRewardResponse

  tx.proto:81

  MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward response type.

  • repeated base.v1beta1.Coin amount = 1

    Since: cosmos-sdk 0.46

• rpc WithdrawValidatorCommission (MsgWithdrawValidatorCommission, MsgWithdrawValidatorCommissionResponse)

  tx.proto:28

  WithdrawValidatorCommission defines a method to withdraw the full commission to the validator address.

  message MsgWithdrawValidatorCommission

  tx.proto:92

  MsgWithdrawValidatorCommission withdraws the full commission to the validator address.

  • string validator_address = 1

  message MsgWithdrawValidatorCommissionResponse

  tx.proto:104

  MsgWithdrawValidatorCommissionResponse defines the Msg/WithdrawValidatorCommission response type.

  • repeated base.v1beta1.Coin amount = 1

    Since: cosmos-sdk 0.46

• rpc FundCommunityPool (MsgFundCommunityPool, MsgFundCommunityPoolResponse)

  tx.proto:32

  FundCommunityPool defines a method to allow an account to directly fund the community pool.

  message MsgFundCommunityPool

  tx.proto:115

  MsgFundCommunityPool allows an account to directly fund the community pool.

  • repeated base.v1beta1.Coin amount = 1

  • string depositor = 2

  message MsgFundCommunityPoolResponse

  tx.proto:131

  MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.

  (message has no fields)

• rpc UpdateParams (MsgUpdateParams, MsgUpdateParamsResponse)

  tx.proto:38

  UpdateParams defines a governance operation for updating the x/distribution module parameters. The authority is defined in the keeper. Since: cosmos-sdk 0.47

  message MsgUpdateParams

  tx.proto:136

  MsgUpdateParams is the Msg/UpdateParams request type. Since: cosmos-sdk 0.47

  • string authority = 1

    authority is the address that controls the module (defaults to x/gov unless overwritten).

  • optional Params params = 2

    params defines the x/distribution parameters to update. NOTE: All parameters must be supplied.

  message MsgUpdateParamsResponse

  tx.proto:153

  MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message. Since: cosmos-sdk 0.47

  (message has no fields)

• rpc CommunityPoolSpend (MsgCommunityPoolSpend, MsgCommunityPoolSpendResponse)

  tx.proto:46

  CommunityPoolSpend defines a governance operation for sending tokens from the community pool in the x/distribution module to another account, which could be the governance module itself. The authority is defined in the keeper. Since: cosmos-sdk 0.47

  message MsgCommunityPoolSpend

  tx.proto:160

  MsgCommunityPoolSpend defines a message for sending tokens from the community pool to another account. This message is typically executed via a governance proposal with the governance module being the executing authority. Since: cosmos-sdk 0.47

  • string authority = 1

    authority is the address that controls the module (defaults to x/gov unless overwritten).

  • string recipient = 2

  • repeated base.v1beta1.Coin amount = 3

  message MsgCommunityPoolSpendResponse

  tx.proto:178

  MsgCommunityPoolSpendResponse defines the response to executing a MsgCommunityPoolSpend message. Since: cosmos-sdk 0.47

  (message has no fields)

Query defines the gRPC querier service for distribution module.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:17

  Params queries params of the distribution module.

  message QueryParamsRequest

  query.proto:76

  QueryParamsRequest is the request type for the Query/Params RPC method.

  (message has no fields)

  message QueryParamsResponse

  query.proto:79

  QueryParamsResponse is the response type for the Query/Params RPC method.

  • optional Params params = 1

    params defines the parameters of the module.

• rpc ValidatorDistributionInfo (QueryValidatorDistributionInfoRequest, QueryValidatorDistributionInfoResponse)

  query.proto:22

  ValidatorDistributionInfo queries validator commission and self-delegation rewards for validator

  message QueryValidatorDistributionInfoRequest

  query.proto:85

  QueryValidatorDistributionInfoRequest is the request type for the Query/ValidatorDistributionInfo RPC method.

  • string validator_address = 1

    validator_address defines the validator address to query for.

  message QueryValidatorDistributionInfoResponse

  query.proto:91

  QueryValidatorDistributionInfoResponse is the response type for the Query/ValidatorDistributionInfo RPC method.

  • string operator_address = 1

    operator_address defines the validator operator address.

  • repeated base.v1beta1.DecCoin self_bond_rewards = 2

    self_bond_rewards defines the self delegations rewards.

  • repeated base.v1beta1.DecCoin commission = 3

    commission defines the commission the validator received.

• rpc ValidatorOutstandingRewards (QueryValidatorOutstandingRewardsRequest, QueryValidatorOutstandingRewardsResponse)

  query.proto:28

  ValidatorOutstandingRewards queries rewards of a validator address.

  message QueryValidatorOutstandingRewardsRequest

  query.proto:107

  QueryValidatorOutstandingRewardsRequest is the request type for the Query/ValidatorOutstandingRewards RPC method.

  • string validator_address = 1

    validator_address defines the validator address to query for.

  message QueryValidatorOutstandingRewardsResponse

  query.proto:114

  QueryValidatorOutstandingRewardsResponse is the response type for the Query/ValidatorOutstandingRewards RPC method.

  • optional ValidatorOutstandingRewards rewards = 1

• rpc ValidatorCommission (QueryValidatorCommissionRequest, QueryValidatorCommissionResponse)

  query.proto:35

  ValidatorCommission queries accumulated commission for a validator.

  message QueryValidatorCommissionRequest

  query.proto:120

  QueryValidatorCommissionRequest is the request type for the Query/ValidatorCommission RPC method

  • string validator_address = 1

    validator_address defines the validator address to query for.

  message QueryValidatorCommissionResponse

  query.proto:127

  QueryValidatorCommissionResponse is the response type for the Query/ValidatorCommission RPC method

  • optional ValidatorAccumulatedCommission commission = 1

    commission defines the commission the validator received.

• rpc ValidatorSlashes (QueryValidatorSlashesRequest, QueryValidatorSlashesResponse)

  query.proto:41

  ValidatorSlashes queries slash events of a validator.

  message QueryValidatorSlashesRequest

  query.proto:134

  QueryValidatorSlashesRequest is the request type for the Query/ValidatorSlashes RPC method

  • string validator_address = 1

    validator_address defines the validator address to query for.

  • uint64 starting_height = 2

    starting_height defines the optional starting height to query the slashes.

  • uint64 ending_height = 3

    starting_height defines the optional ending height to query the slashes.

  • optional base.query.v1beta1.PageRequest pagination = 4

    pagination defines an optional pagination for the request.

  message QueryValidatorSlashesResponse

  query.proto:150

  QueryValidatorSlashesResponse is the response type for the Query/ValidatorSlashes RPC method.

  • repeated ValidatorSlashEvent slashes = 1

    slashes defines the slashes the validator received.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc DelegationRewards (QueryDelegationRewardsRequest, QueryDelegationRewardsResponse)

  query.proto:46

  DelegationRewards queries the total rewards accrued by a delegation.

  message QueryDelegationRewardsRequest

  query.proto:160

  QueryDelegationRewardsRequest is the request type for the Query/DelegationRewards RPC method.

  • string delegator_address = 1

    delegator_address defines the delegator address to query for.

  • string validator_address = 2

    validator_address defines the validator address to query for.

  message QueryDelegationRewardsResponse

  query.proto:172

  QueryDelegationRewardsResponse is the response type for the Query/DelegationRewards RPC method.

  • repeated base.v1beta1.DecCoin rewards = 1

    rewards defines the rewards accrued by a delegation.

• rpc DelegationTotalRewards (QueryDelegationTotalRewardsRequest, QueryDelegationTotalRewardsResponse)

  query.proto:53

  DelegationTotalRewards queries the total rewards accrued by a each validator.

  message QueryDelegationTotalRewardsRequest

  query.proto:183

  QueryDelegationTotalRewardsRequest is the request type for the Query/DelegationTotalRewards RPC method.

  • string delegator_address = 1

    delegator_address defines the delegator address to query for.

  message QueryDelegationTotalRewardsResponse

  query.proto:192

  QueryDelegationTotalRewardsResponse is the response type for the Query/DelegationTotalRewards RPC method.

  • repeated DelegationDelegatorReward rewards = 1

    rewards defines all the rewards accrued by a delegator.

  • repeated base.v1beta1.DecCoin total = 2

    total defines the sum of all the rewards.

• rpc DelegatorValidators (QueryDelegatorValidatorsRequest, QueryDelegatorValidatorsResponse)

  query.proto:58

  DelegatorValidators queries the validators of a delegator.

  message QueryDelegatorValidatorsRequest

  query.proto:205

  QueryDelegatorValidatorsRequest is the request type for the Query/DelegatorValidators RPC method.

  • string delegator_address = 1

    delegator_address defines the delegator address to query for.

  message QueryDelegatorValidatorsResponse

  query.proto:215

  QueryDelegatorValidatorsResponse is the response type for the Query/DelegatorValidators RPC method.

  • repeated string validators = 1

    validators defines the validators a delegator is delegating for.

• rpc DelegatorWithdrawAddress (QueryDelegatorWithdrawAddressRequest, QueryDelegatorWithdrawAddressResponse)

  query.proto:64

  DelegatorWithdrawAddress queries withdraw address of a delegator.

  message QueryDelegatorWithdrawAddressRequest

  query.proto:225

  QueryDelegatorWithdrawAddressRequest is the request type for the Query/DelegatorWithdrawAddress RPC method.

  • string delegator_address = 1

    delegator_address defines the delegator address to query for.

  message QueryDelegatorWithdrawAddressResponse

  query.proto:235

  QueryDelegatorWithdrawAddressResponse is the response type for the Query/DelegatorWithdrawAddress RPC method.

  • string withdraw_address = 1

    withdraw_address defines the delegator address to query for.

• rpc CommunityPool (QueryCommunityPoolRequest, QueryCommunityPoolResponse)

  query.proto:70

  CommunityPool queries the community pool coins.

  message QueryCommunityPoolRequest

  query.proto:245

  QueryCommunityPoolRequest is the request type for the Query/CommunityPool RPC method.

  (message has no fields)

  message QueryCommunityPoolResponse

  query.proto:249

  QueryCommunityPoolResponse is the response type for the Query/CommunityPool RPC method.

  • repeated base.v1beta1.DecCoin pool = 1

    pool defines community pool's coins.

CommunityPoolSpendProposal details a proposal for use of community funds, together with how many coins are proposed to be spent, and to which recipient account. Deprecated: Do not use. As of the Cosmos SDK release v0.47.x, there is no longer a need for an explicit CommunityPoolSpendProposal. To spend community pool funds, a simple MsgCommunityPoolSpend can be invoked from the x/gov module via a v1 governance proposal.

• string title = 1

• string description = 2

• string recipient = 3

• repeated base.v1beta1.Coin amount = 4

CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal with a deposit

• string title = 1

• string description = 2

• string recipient = 3

• string amount = 4

• string deposit = 5

DelegationDelegatorReward represents the properties of a delegator's delegation reward.

Used in: QueryDelegationTotalRewardsResponse

• string validator_address = 1

• repeated base.v1beta1.DecCoin reward = 2

DelegatorStartingInfo represents the starting info for a delegator reward period. It tracks the previous validator period, the delegation's amount of staking token, and the creation height (to check later on if any slashes have occurred). NOTE: Even though validators are slashed to whole staking tokens, the delegators within the validator may be left with less than a full token, thus sdk.Dec is used.

Used in: DelegatorStartingInfoRecord

• uint64 previous_period = 1

• string stake = 2

• uint64 height = 3

DelegatorStartingInfoRecord used for import / export via genesis json.

Used in: GenesisState

• string delegator_address = 1

  delegator_address is the address of the delegator.

• string validator_address = 2

  validator_address is the address of the validator.

• optional DelegatorStartingInfo starting_info = 3

  starting_info defines the starting info of a delegator.

DelegatorWithdrawInfo is the address for where distributions rewards are withdrawn to by default this struct is only used at genesis to feed in default withdraw addresses.

Used in: GenesisState

• string delegator_address = 1

  delegator_address is the address of the delegator.

• string withdraw_address = 2

  withdraw_address is the address to withdraw the delegation rewards to.

FeePool is the global fee pool for distribution.

Used in: GenesisState

• repeated base.v1beta1.DecCoin community_pool = 1

GenesisState defines the distribution module's genesis state.

• optional Params params = 1

  params defines all the parameters of the module.

• optional FeePool fee_pool = 2

  fee_pool defines the fee pool at genesis.

• repeated DelegatorWithdrawInfo delegator_withdraw_infos = 3

  fee_pool defines the delegator withdraw infos at genesis.

• string previous_proposer = 4

  fee_pool defines the previous proposer at genesis.

• repeated ValidatorOutstandingRewardsRecord outstanding_rewards = 5

  fee_pool defines the outstanding rewards of all validators at genesis.

• repeated ValidatorAccumulatedCommissionRecord validator_accumulated_commissions = 6

  fee_pool defines the accumulated commissions of all validators at genesis.

• repeated ValidatorHistoricalRewardsRecord validator_historical_rewards = 7

  fee_pool defines the historical rewards of all validators at genesis.

• repeated ValidatorCurrentRewardsRecord validator_current_rewards = 8

  fee_pool defines the current rewards of all validators at genesis.

• repeated DelegatorStartingInfoRecord delegator_starting_infos = 9

  fee_pool defines the delegator starting infos at genesis.

• repeated ValidatorSlashEventRecord validator_slash_events = 10

  fee_pool defines the validator slash events at genesis.

Params defines the set of params for the distribution module.

Used in: GenesisState, MsgUpdateParams, QueryParamsResponse

• string community_tax = 1

• string base_proposer_reward = 2

  Deprecated: The base_proposer_reward field is deprecated and is no longer used in the x/distribution module's reward mechanism.

• string bonus_proposer_reward = 3

  Deprecated: The bonus_proposer_reward field is deprecated and is no longer used in the x/distribution module's reward mechanism.

• bool withdraw_addr_enabled = 4

ValidatorAccumulatedCommission represents accumulated commission for a validator kept as a running counter, can be withdrawn at any time.

Used in: QueryValidatorCommissionResponse, ValidatorAccumulatedCommissionRecord

• repeated base.v1beta1.DecCoin commission = 1

ValidatorAccumulatedCommissionRecord is used for import / export via genesis json.

Used in: GenesisState

• string validator_address = 1

  validator_address is the address of the validator.

• optional ValidatorAccumulatedCommission accumulated = 2

  accumulated is the accumulated commission of a validator.

ValidatorCurrentRewards represents current rewards and current period for a validator kept as a running counter and incremented each block as long as the validator's tokens remain constant.

Used in: ValidatorCurrentRewardsRecord

• repeated base.v1beta1.DecCoin rewards = 1

• uint64 period = 2

ValidatorCurrentRewardsRecord is used for import / export via genesis json.

Used in: GenesisState

• string validator_address = 1

  validator_address is the address of the validator.

• optional ValidatorCurrentRewards rewards = 2

  rewards defines the current rewards of a validator.

ValidatorHistoricalRewards represents historical rewards for a validator. Height is implicit within the store key. Cumulative reward ratio is the sum from the zeroeth period until this period of rewards / tokens, per the spec. The reference count indicates the number of objects which might need to reference this historical entry at any point. ReferenceCount = number of outstanding delegations which ended the associated period (and might need to read that record) + number of slashes which ended the associated period (and might need to read that record) + one per validator for the zeroeth period, set on initialization

Used in: ValidatorHistoricalRewardsRecord

• repeated base.v1beta1.DecCoin cumulative_reward_ratio = 1

• uint32 reference_count = 2

ValidatorHistoricalRewardsRecord is used for import / export via genesis json.

Used in: GenesisState

• string validator_address = 1

  validator_address is the address of the validator.

• uint64 period = 2

  period defines the period the historical rewards apply to.

• optional ValidatorHistoricalRewards rewards = 3

  rewards defines the historical rewards of a validator.

ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards for a validator inexpensive to track, allows simple sanity checks.

Used in: QueryValidatorOutstandingRewardsResponse

• repeated base.v1beta1.DecCoin rewards = 1

ValidatorOutstandingRewardsRecord is used for import/export via genesis json.

Used in: GenesisState

• string validator_address = 1

  validator_address is the address of the validator.

• repeated base.v1beta1.DecCoin outstanding_rewards = 2

  outstanding_rewards represents the outstanding rewards of a validator.

ValidatorSlashEvent represents a validator slash event. Height is implicit within the store key. This is needed to calculate appropriate amount of staking tokens for delegations which are withdrawn after a slash has occurred.

Used in: QueryValidatorSlashesResponse, ValidatorSlashEventRecord, ValidatorSlashEvents

• uint64 validator_period = 1

• string fraction = 2

ValidatorSlashEventRecord is used for import / export via genesis json.

Used in: GenesisState

• string validator_address = 1

  validator_address is the address of the validator.

• uint64 height = 2

  height defines the block height at which the slash event occurred.

• uint64 period = 3

  period is the period of the slash event.

• optional ValidatorSlashEvent validator_slash_event = 4

  validator_slash_event describes the slash event.

ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.

• repeated ValidatorSlashEvent validator_slash_events = 1