cosmos/distribution

Table of Contents

• cosmos/distribution/module/v1/module.proto
  • MModule
• cosmos/distribution/v1beta1/distribution.proto
  • MCommunityPoolSpendProposal
  • MCommunityPoolSpendProposalWithDeposit
  • MDelegationDelegatorReward
  • MDelegatorStartingInfo
  • MFeePool
  • MParams
  • MValidatorAccumulatedCommission
  • MValidatorCurrentRewards
  • MValidatorHistoricalRewards
  • MValidatorOutstandingRewards
  • MValidatorSlashEvent
  • MValidatorSlashEvents
• cosmos/distribution/v1beta1/genesis.proto
  • MDelegatorStartingInfoRecord
  • MDelegatorWithdrawInfo
  • MGenesisState
  • MValidatorAccumulatedCommissionRecord
  • MValidatorCurrentRewardsRecord
  • MValidatorHistoricalRewardsRecord
  • MValidatorOutstandingRewardsRecord
  • MValidatorSlashEventRecord
• cosmos/distribution/v1beta1/query.proto
  • MQueryCommunityPoolRequest
  • MQueryCommunityPoolResponse
  • MQueryDelegationRewardsRequest
  • MQueryDelegationRewardsResponse
  • MQueryDelegationTotalRewardsRequest
  • MQueryDelegationTotalRewardsResponse
  • MQueryDelegatorValidatorsRequest
  • MQueryDelegatorValidatorsResponse
  • MQueryDelegatorWithdrawAddressRequest
  • MQueryDelegatorWithdrawAddressResponse
  • MQueryParamsRequest
  • MQueryParamsResponse
  • MQueryValidatorCommissionRequest
  • MQueryValidatorCommissionResponse
  • MQueryValidatorDistributionInfoRequest
  • MQueryValidatorDistributionInfoResponse
  • MQueryValidatorOutstandingRewardsRequest
  • MQueryValidatorOutstandingRewardsResponse
  • MQueryValidatorSlashesRequest
  • MQueryValidatorSlashesResponse
  • SQuery
• cosmos/distribution/v1beta1/tx.proto
  • MMsgCommunityPoolSpend
  • MMsgCommunityPoolSpendResponse
  • MMsgDepositValidatorRewardsPool
  • MMsgDepositValidatorRewardsPoolResponse
  • MMsgFundCommunityPool
  • MMsgFundCommunityPoolResponse
  • MMsgSetWithdrawAddress
  • MMsgSetWithdrawAddressResponse
  • MMsgUpdateParams
  • MMsgUpdateParamsResponse
  • MMsgWithdrawDelegatorReward
  • MMsgWithdrawDelegatorRewardResponse
  • MMsgWithdrawValidatorCommission
  • MMsgWithdrawValidatorCommissionResponse
  • SMsg
• Scalar Value Types

cosmos/distribution/module/v1/module.proto

Top

Module

Module is the config object of the distribution module.

Field	Type	Label	Description
fee_collector_name	string
authority	string		authority defines the custom module authority. If not set, defaults to the governance module.

cosmos/distribution/v1beta1/distribution.proto

Top

CommunityPoolSpendProposal

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.

Field	Type	Label	Description
title	string
description	string
recipient	string
amount	cosmos.base.v1beta1.Coin	repeated

CommunityPoolSpendProposalWithDeposit

CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal

with a deposit

Field	Type	Label	Description
title	string
description	string
recipient	string
amount	string
deposit	string

DelegationDelegatorReward

DelegationDelegatorReward represents the properties

of a delegator's delegation reward.

Field	Type	Label	Description
validator_address	string
reward	cosmos.base.v1beta1.DecCoin	repeated

DelegatorStartingInfo

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.

Field	Type	Label	Description
previous_period	uint64
stake	string
height	uint64

FeePool

FeePool is the global fee pool for distribution.

Field	Type	Label	Description
community_pool	cosmos.base.v1beta1.DecCoin	repeated

Params

Params defines the set of params for the distribution module.

Field	Type	Label	Description
community_tax	string
base_proposer_reward	string		Deprecated. Deprecated: The base_proposer_reward field is deprecated and is no longer used in the x/distribution module's reward mechanism.
bonus_proposer_reward	string		Deprecated. Deprecated: The bonus_proposer_reward field is deprecated and is no longer used in the x/distribution module's reward mechanism.
withdraw_addr_enabled	bool

Fields with deprecated option

Name	Option
base_proposer_reward	true
bonus_proposer_reward	true

ValidatorAccumulatedCommission

ValidatorAccumulatedCommission represents accumulated commission

for a validator kept as a running counter, can be withdrawn at any time.

Field	Type	Label	Description
commission	cosmos.base.v1beta1.DecCoin	repeated

ValidatorCurrentRewards

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.

Field	Type	Label	Description
rewards	cosmos.base.v1beta1.DecCoin	repeated
period	uint64

ValidatorHistoricalRewards

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

Field	Type	Label	Description
cumulative_reward_ratio	cosmos.base.v1beta1.DecCoin	repeated
reference_count	uint32

ValidatorOutstandingRewards

ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards

for a validator inexpensive to track, allows simple sanity checks.

Field	Type	Label	Description
rewards	cosmos.base.v1beta1.DecCoin	repeated

ValidatorSlashEvent

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.

Field	Type	Label	Description
validator_period	uint64
fraction	string

ValidatorSlashEvents

ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.

Field	Type	Label	Description
validator_slash_events	ValidatorSlashEvent	repeated

cosmos/distribution/v1beta1/genesis.proto

Top

DelegatorStartingInfoRecord

DelegatorStartingInfoRecord used for import / export via genesis json.

Field	Type	Label	Description
delegator_address	string		delegator_address is the address of the delegator.
validator_address	string		validator_address is the address of the validator.
starting_info	DelegatorStartingInfo		starting_info defines the starting info of a delegator.

DelegatorWithdrawInfo

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.

Field	Type	Label	Description
delegator_address	string		delegator_address is the address of the delegator.
withdraw_address	string		withdraw_address is the address to withdraw the delegation rewards to.

GenesisState

GenesisState defines the distribution module's genesis state.

Field	Type	Label	Description
params	Params		params defines all the parameters of the module.
fee_pool	FeePool		fee_pool defines the fee pool at genesis.
delegator_withdraw_infos	DelegatorWithdrawInfo	repeated	fee_pool defines the delegator withdraw infos at genesis.
previous_proposer	string		fee_pool defines the previous proposer at genesis.
outstanding_rewards	ValidatorOutstandingRewardsRecord	repeated	fee_pool defines the outstanding rewards of all validators at genesis.
validator_accumulated_commissions	ValidatorAccumulatedCommissionRecord	repeated	fee_pool defines the accumulated commissions of all validators at genesis.
validator_historical_rewards	ValidatorHistoricalRewardsRecord	repeated	fee_pool defines the historical rewards of all validators at genesis.
validator_current_rewards	ValidatorCurrentRewardsRecord	repeated	fee_pool defines the current rewards of all validators at genesis.
delegator_starting_infos	DelegatorStartingInfoRecord	repeated	fee_pool defines the delegator starting infos at genesis.
validator_slash_events	ValidatorSlashEventRecord	repeated	fee_pool defines the validator slash events at genesis.

ValidatorAccumulatedCommissionRecord

ValidatorAccumulatedCommissionRecord is used for import / export via genesis

json.

Field	Type	Label	Description
validator_address	string		validator_address is the address of the validator.
accumulated	ValidatorAccumulatedCommission		accumulated is the accumulated commission of a validator.

ValidatorCurrentRewardsRecord

ValidatorCurrentRewardsRecord is used for import / export via genesis json.

Field	Type	Label	Description
validator_address	string		validator_address is the address of the validator.
rewards	ValidatorCurrentRewards		rewards defines the current rewards of a validator.

ValidatorHistoricalRewardsRecord

ValidatorHistoricalRewardsRecord is used for import / export via genesis

json.

Field	Type	Label	Description
validator_address	string		validator_address is the address of the validator.
period	uint64		period defines the period the historical rewards apply to.
rewards	ValidatorHistoricalRewards		rewards defines the historical rewards of a validator.

ValidatorOutstandingRewardsRecord

ValidatorOutstandingRewardsRecord is used for import/export via genesis json.

Field	Type	Label	Description
validator_address	string		validator_address is the address of the validator.
outstanding_rewards	cosmos.base.v1beta1.DecCoin	repeated	outstanding_rewards represents the outstanding rewards of a validator.

ValidatorSlashEventRecord

ValidatorSlashEventRecord is used for import / export via genesis json.

Field	Type	Label	Description
validator_address	string		validator_address is the address of the validator.
height	uint64		height defines the block height at which the slash event occurred.
period	uint64		period is the period of the slash event.
validator_slash_event	ValidatorSlashEvent		validator_slash_event describes the slash event.

cosmos/distribution/v1beta1/query.proto

Top

QueryCommunityPoolRequest

QueryCommunityPoolRequest is the request type for the Query/CommunityPool RPC

method.

QueryCommunityPoolResponse

QueryCommunityPoolResponse is the response type for the Query/CommunityPool

RPC method.

Field	Type	Label	Description
pool	cosmos.base.v1beta1.DecCoin	repeated	pool defines community pool's coins.

QueryDelegationRewardsRequest

QueryDelegationRewardsRequest is the request type for the

Query/DelegationRewards RPC method.

Field	Type	Label	Description
delegator_address	string		delegator_address defines the delegator address to query for.
validator_address	string		validator_address defines the validator address to query for.

QueryDelegationRewardsResponse

QueryDelegationRewardsResponse is the response type for the

Query/DelegationRewards RPC method.

Field	Type	Label	Description
rewards	cosmos.base.v1beta1.DecCoin	repeated	rewards defines the rewards accrued by a delegation.

QueryDelegationTotalRewardsRequest

QueryDelegationTotalRewardsRequest is the request type for the

Query/DelegationTotalRewards RPC method.

Field	Type	Label	Description
delegator_address	string		delegator_address defines the delegator address to query for.

QueryDelegationTotalRewardsResponse

QueryDelegationTotalRewardsResponse is the response type for the

Query/DelegationTotalRewards RPC method.

Field	Type	Label	Description
rewards	DelegationDelegatorReward	repeated	rewards defines all the rewards accrued by a delegator.
total	cosmos.base.v1beta1.DecCoin	repeated	total defines the sum of all the rewards.

QueryDelegatorValidatorsRequest

QueryDelegatorValidatorsRequest is the request type for the

Query/DelegatorValidators RPC method.

Field	Type	Label	Description
delegator_address	string		delegator_address defines the delegator address to query for.

QueryDelegatorValidatorsResponse

QueryDelegatorValidatorsResponse is the response type for the

Query/DelegatorValidators RPC method.

Field	Type	Label	Description
validators	string	repeated	validators defines the validators a delegator is delegating for.

QueryDelegatorWithdrawAddressRequest

QueryDelegatorWithdrawAddressRequest is the request type for the

Query/DelegatorWithdrawAddress RPC method.

Field	Type	Label	Description
delegator_address	string		delegator_address defines the delegator address to query for.

QueryDelegatorWithdrawAddressResponse

QueryDelegatorWithdrawAddressResponse is the response type for the

Query/DelegatorWithdrawAddress RPC method.

Field	Type	Label	Description
withdraw_address	string		withdraw_address defines the delegator address to query for.

QueryParamsRequest

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

QueryParamsResponse

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

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

QueryValidatorCommissionRequest

QueryValidatorCommissionRequest is the request type for the

Query/ValidatorCommission RPC method

Field	Type	Label	Description
validator_address	string		validator_address defines the validator address to query for.

QueryValidatorCommissionResponse

QueryValidatorCommissionResponse is the response type for the

Query/ValidatorCommission RPC method

Field	Type	Label	Description
commission	ValidatorAccumulatedCommission		commission defines the commission the validator received.

QueryValidatorDistributionInfoRequest

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

Field	Type	Label	Description
validator_address	string		validator_address defines the validator address to query for.

QueryValidatorDistributionInfoResponse

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

Field	Type	Label	Description
operator_address	string		operator_address defines the validator operator address.
self_bond_rewards	cosmos.base.v1beta1.DecCoin	repeated	self_bond_rewards defines the self delegations rewards.
commission	cosmos.base.v1beta1.DecCoin	repeated	commission defines the commission the validator received.

QueryValidatorOutstandingRewardsRequest

QueryValidatorOutstandingRewardsRequest is the request type for the

Query/ValidatorOutstandingRewards RPC method.

Field	Type	Label	Description
validator_address	string		validator_address defines the validator address to query for.

QueryValidatorOutstandingRewardsResponse

QueryValidatorOutstandingRewardsResponse is the response type for the

Query/ValidatorOutstandingRewards RPC method.

Field	Type	Label	Description
rewards	ValidatorOutstandingRewards

QueryValidatorSlashesRequest

QueryValidatorSlashesRequest is the request type for the

Query/ValidatorSlashes RPC method

Field	Type	Label	Description
validator_address	string		validator_address defines the validator address to query for.
starting_height	uint64		starting_height defines the optional starting height to query the slashes.
ending_height	uint64		starting_height defines the optional ending height to query the slashes.
pagination	cosmos.base.query.v1beta1.PageRequest		pagination defines an optional pagination for the request.

QueryValidatorSlashesResponse

QueryValidatorSlashesResponse is the response type for the

Query/ValidatorSlashes RPC method.

Field	Type	Label	Description
slashes	ValidatorSlashEvent	repeated	slashes defines the slashes the validator received.
pagination	cosmos.base.query.v1beta1.PageResponse		pagination defines the pagination in the response.

Query

Query defines the gRPC querier service for distribution module.

Method Name	Request Type	Response Type	Description
Params	QueryParamsRequest	QueryParamsResponse	Params queries params of the distribution module.
ValidatorDistributionInfo	QueryValidatorDistributionInfoRequest	QueryValidatorDistributionInfoResponse	ValidatorDistributionInfo queries validator commission and self-delegation rewards for validator
ValidatorOutstandingRewards	QueryValidatorOutstandingRewardsRequest	QueryValidatorOutstandingRewardsResponse	ValidatorOutstandingRewards queries rewards of a validator address.
ValidatorCommission	QueryValidatorCommissionRequest	QueryValidatorCommissionResponse	ValidatorCommission queries accumulated commission for a validator.
ValidatorSlashes	QueryValidatorSlashesRequest	QueryValidatorSlashesResponse	ValidatorSlashes queries slash events of a validator.
DelegationRewards	QueryDelegationRewardsRequest	QueryDelegationRewardsResponse	DelegationRewards queries the total rewards accrued by a delegation.
DelegationTotalRewards	QueryDelegationTotalRewardsRequest	QueryDelegationTotalRewardsResponse	DelegationTotalRewards queries the total rewards accrued by each validator.
DelegatorValidators	QueryDelegatorValidatorsRequest	QueryDelegatorValidatorsResponse	DelegatorValidators queries the validators of a delegator.
DelegatorWithdrawAddress	QueryDelegatorWithdrawAddressRequest	QueryDelegatorWithdrawAddressResponse	DelegatorWithdrawAddress queries withdraw address of a delegator.
CommunityPool	QueryCommunityPoolRequest	QueryCommunityPoolResponse	CommunityPool queries the community pool coins.

Methods with HTTP bindings

Method Name	Method	Pattern	Body
Params	GET	/cosmos/distribution/v1beta1/params
ValidatorDistributionInfo	GET	/cosmos/distribution/v1beta1/validators/{validator_address}
ValidatorOutstandingRewards	GET	/cosmos/distribution/v1beta1/validators/{validator_address}/outstanding_rewards
ValidatorCommission	GET	/cosmos/distribution/v1beta1/validators/{validator_address}/commission
ValidatorSlashes	GET	/cosmos/distribution/v1beta1/validators/{validator_address}/slashes
DelegationRewards	GET	/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards/{validator_address}
DelegationTotalRewards	GET	/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards
DelegatorValidators	GET	/cosmos/distribution/v1beta1/delegators/{delegator_address}/validators
DelegatorWithdrawAddress	GET	/cosmos/distribution/v1beta1/delegators/{delegator_address}/withdraw_address
CommunityPool	GET	/cosmos/distribution/v1beta1/community_pool

cosmos/distribution/v1beta1/tx.proto

Top

MsgCommunityPoolSpend

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

Field	Type	Label	Description
authority	string		authority is the address that controls the module (defaults to x/gov unless overwritten).
recipient	string
amount	cosmos.base.v1beta1.Coin	repeated

MsgCommunityPoolSpendResponse

MsgCommunityPoolSpendResponse defines the response to executing a

MsgCommunityPoolSpend message.

Since: cosmos-sdk 0.47

MsgDepositValidatorRewardsPool

DepositValidatorRewardsPool defines the request structure to provide

additional rewards to delegators from a specific validator.

Since: cosmos-sdk 0.50

Field	Type	Label	Description
depositor	string
validator_address	string
amount	cosmos.base.v1beta1.Coin	repeated

MsgDepositValidatorRewardsPoolResponse

MsgDepositValidatorRewardsPoolResponse defines the response to executing a

MsgDepositValidatorRewardsPool message.

Since: cosmos-sdk 0.50

MsgFundCommunityPool

MsgFundCommunityPool allows an account to directly

fund the community pool.

Field	Type	Label	Description
amount	cosmos.base.v1beta1.Coin	repeated
depositor	string

MsgFundCommunityPoolResponse

MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.

MsgSetWithdrawAddress

MsgSetWithdrawAddress sets the withdraw address for

a delegator (or validator self-delegation).

Field	Type	Label	Description
delegator_address	string
withdraw_address	string

MsgSetWithdrawAddressResponse

MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response

type.

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
authority	string		authority is the address that controls the module (defaults to x/gov unless overwritten).
params	Params		params defines the x/distribution parameters to update. NOTE: All parameters must be supplied.

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a

MsgUpdateParams message.

Since: cosmos-sdk 0.47

MsgWithdrawDelegatorReward

MsgWithdrawDelegatorReward represents delegation withdrawal to a delegator

from a single validator.

Field	Type	Label	Description
delegator_address	string
validator_address	string

MsgWithdrawDelegatorRewardResponse

MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward

response type.

Field	Type	Label	Description
amount	cosmos.base.v1beta1.Coin	repeated	Since: cosmos-sdk 0.46

MsgWithdrawValidatorCommission

MsgWithdrawValidatorCommission withdraws the full commission to the validator

address.

Field	Type	Label	Description
validator_address	string

MsgWithdrawValidatorCommissionResponse

MsgWithdrawValidatorCommissionResponse defines the

Msg/WithdrawValidatorCommission response type.

Field	Type	Label	Description
amount	cosmos.base.v1beta1.Coin	repeated	Since: cosmos-sdk 0.46

Msg

Msg defines the distribution Msg service.

Method Name	Request Type	Response Type	Description
SetWithdrawAddress	MsgSetWithdrawAddress	MsgSetWithdrawAddressResponse	SetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation).
WithdrawDelegatorReward	MsgWithdrawDelegatorReward	MsgWithdrawDelegatorRewardResponse	WithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator.
WithdrawValidatorCommission	MsgWithdrawValidatorCommission	MsgWithdrawValidatorCommissionResponse	WithdrawValidatorCommission defines a method to withdraw the full commission to the validator address.
FundCommunityPool	MsgFundCommunityPool	MsgFundCommunityPoolResponse	FundCommunityPool defines a method to allow an account to directly fund the community pool.
UpdateParams	MsgUpdateParams	MsgUpdateParamsResponse	UpdateParams defines a governance operation for updating the x/distribution module parameters. The authority is defined in the keeper. Since: cosmos-sdk 0.47
CommunityPoolSpend	MsgCommunityPoolSpend	MsgCommunityPoolSpendResponse	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
DepositValidatorRewardsPool	MsgDepositValidatorRewardsPool	MsgDepositValidatorRewardsPoolResponse	DepositValidatorRewardsPool defines a method to provide additional rewards to delegators to a specific validator. Since: cosmos-sdk 0.50

Scalar Value Types

.proto Type	Notes	Python Type
double		float
float		float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long
uint32	Uses variable-length encoding.	int/long
uint64	Uses variable-length encoding.	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long
sfixed32	Always four bytes.	int
sfixed64	Always eight bytes.	int/long
bool		boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode
bytes	May contain any arbitrary sequence of bytes.	str