Module distribution
Expand description
Messages and services handling token distribution
Modules§
- msg_
client - Generated client implementations.
- msg_
server - Generated server implementations.
- query_
client - Generated client implementations.
- query_
server - Generated server implementations.
Structs§
- Community
Pool Spend Proposal - CommunityPoolSpendProposal details a proposal for use of community funds, together with how many coins are proposed to be spent, and to which recipient account.
- Community
Pool Spend Proposal With Deposit - CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal with a deposit
- Delegation
Delegator Reward - DelegationDelegatorReward represents the properties of a delegator’s delegation reward.
- Delegator
Starting Info - 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.
- Delegator
Starting Info Record - DelegatorStartingInfoRecord used for import / export via genesis json.
- Delegator
Withdraw Info - 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.
- FeePool
- FeePool is the global fee pool for distribution.
- Genesis
State - GenesisState defines the distribution module’s genesis state.
- MsgCommunity
Pool Spend - 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.
- MsgCommunity
Pool Spend Response - MsgCommunityPoolSpendResponse defines the response to executing a MsgCommunityPoolSpend message.
- MsgDeposit
Validator Rewards Pool - DepositValidatorRewardsPool defines the request structure to provide additional rewards to delegators from a specific validator.
- MsgDeposit
Validator Rewards Pool Response - MsgDepositValidatorRewardsPoolResponse defines the response to executing a MsgDepositValidatorRewardsPool message.
- MsgFund
Community Pool - MsgFundCommunityPool allows an account to directly fund the community pool.
- MsgFund
Community Pool Response - MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.
- MsgSet
Withdraw Address - MsgSetWithdrawAddress sets the withdraw address for a delegator (or validator self-delegation).
- MsgSet
Withdraw Address Response - MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response type.
- MsgUpdate
Params - MsgUpdateParams is the Msg/UpdateParams request type.
- MsgUpdate
Params Response - MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
- MsgWithdraw
Delegator Reward - MsgWithdrawDelegatorReward represents delegation withdrawal to a delegator from a single validator.
- MsgWithdraw
Delegator Reward Response - MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward response type.
- MsgWithdraw
Validator Commission - MsgWithdrawValidatorCommission withdraws the full commission to the validator address.
- MsgWithdraw
Validator Commission Response - MsgWithdrawValidatorCommissionResponse defines the Msg/WithdrawValidatorCommission response type.
- Params
- Params defines the set of params for the distribution module.
- Query
Community Pool Request - QueryCommunityPoolRequest is the request type for the Query/CommunityPool RPC method.
- Query
Community Pool Response - QueryCommunityPoolResponse is the response type for the Query/CommunityPool RPC method.
- Query
Delegation Rewards Request - QueryDelegationRewardsRequest is the request type for the Query/DelegationRewards RPC method.
- Query
Delegation Rewards Response - QueryDelegationRewardsResponse is the response type for the Query/DelegationRewards RPC method.
- Query
Delegation Total Rewards Request - QueryDelegationTotalRewardsRequest is the request type for the Query/DelegationTotalRewards RPC method.
- Query
Delegation Total Rewards Response - QueryDelegationTotalRewardsResponse is the response type for the Query/DelegationTotalRewards RPC method.
- Query
Delegator Validators Request - QueryDelegatorValidatorsRequest is the request type for the Query/DelegatorValidators RPC method.
- Query
Delegator Validators Response - QueryDelegatorValidatorsResponse is the response type for the Query/DelegatorValidators RPC method.
- Query
Delegator Withdraw Address Request - QueryDelegatorWithdrawAddressRequest is the request type for the Query/DelegatorWithdrawAddress RPC method.
- Query
Delegator Withdraw Address Response - QueryDelegatorWithdrawAddressResponse is the response type for the Query/DelegatorWithdrawAddress RPC method.
- Query
Params Request - QueryParamsRequest is the request type for the Query/Params RPC method.
- Query
Params Response - QueryParamsResponse is the response type for the Query/Params RPC method.
- Query
Validator Commission Request - QueryValidatorCommissionRequest is the request type for the Query/ValidatorCommission RPC method
- Query
Validator Commission Response - QueryValidatorCommissionResponse is the response type for the Query/ValidatorCommission RPC method
- Query
Validator Distribution Info Request - QueryValidatorDistributionInfoRequest is the request type for the Query/ValidatorDistributionInfo RPC method.
- Query
Validator Distribution Info Response - QueryValidatorDistributionInfoResponse is the response type for the Query/ValidatorDistributionInfo RPC method.
- Query
Validator Outstanding Rewards Request - QueryValidatorOutstandingRewardsRequest is the request type for the Query/ValidatorOutstandingRewards RPC method.
- Query
Validator Outstanding Rewards Response - QueryValidatorOutstandingRewardsResponse is the response type for the Query/ValidatorOutstandingRewards RPC method.
- Query
Validator Slashes Request - QueryValidatorSlashesRequest is the request type for the Query/ValidatorSlashes RPC method
- Query
Validator Slashes Response - QueryValidatorSlashesResponse is the response type for the Query/ValidatorSlashes RPC method.
- Validator
Accumulated Commission - ValidatorAccumulatedCommission represents accumulated commission for a validator kept as a running counter, can be withdrawn at any time.
- Validator
Accumulated Commission Record - ValidatorAccumulatedCommissionRecord is used for import / export via genesis json.
- Validator
Current Rewards - 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.
- Validator
Current Rewards Record - ValidatorCurrentRewardsRecord is used for import / export via genesis json.
- Validator
Historical Rewards - 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)
- Validator
Historical Rewards Record - ValidatorHistoricalRewardsRecord is used for import / export via genesis json.
- Validator
Outstanding Rewards - ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards for a validator inexpensive to track, allows simple sanity checks.
- Validator
Outstanding Rewards Record - ValidatorOutstandingRewardsRecord is used for import/export via genesis json.
- Validator
Slash Event - 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.
- Validator
Slash Event Record - ValidatorSlashEventRecord is used for import / export via genesis json.
- Validator
Slash Events - ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.