distribution

Documentation

Overview

nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/distribution/keeper ALIASGEN: github.com/cosmos/cosmos-sdk/x/distribution/types ALIASGEN: github.com/cosmos/cosmos-sdk/x/distribution/client

Index

• Constants
• Variables
• func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, k keeper.Keeper)
• func ExportGenesis(ctx sdk.Context, keeper Keeper) types.GenesisState
• func InitGenesis(ctx sdk.Context, keeper Keeper, supplyKeeper types.SupplyKeeper, ...)
• func NewCommunityPoolSpendProposalHandler(k Keeper) govtypes.Handler
• func NewHandler(k keeper.Keeper) sdk.Handler
• type AppModule
  • func NewAppModule(keeper Keeper, supplyKeeper types.SupplyKeeper) AppModule
  • func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)
  • func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate
  • func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate
  • func (AppModule) Name() string
  • func (am AppModule) NewHandler() sdk.Handler
  • func (am AppModule) NewQuerierHandler() sdk.Querier
  • func (AppModule) QuerierRoute() string
  • func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)
  • func (AppModule) Route() string
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis() json.RawMessage
  • func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) Name() string
  • func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)
  • func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error
• type CodeType
• type CommunityPoolSpendProposal
• type DelegationDelegatorReward
• type DelegatorStartingInfo
• type DelegatorStartingInfoRecord
• type DelegatorWithdrawInfo
• type FeePool
• type GenesisState
• type Hooks
• type Keeper
• type MsgSetWithdrawAddress
• type MsgWithdrawDelegatorReward
• type MsgWithdrawValidatorCommission
• type QueryDelegationRewardsParams
• type QueryDelegatorParams
• type QueryDelegatorTotalRewardsResponse
• type QueryDelegatorWithdrawAddrParams
• type QueryValidatorCommissionParams
• type QueryValidatorOutstandingRewardsParams
• type QueryValidatorSlashesParams
• type ValidatorAccumulatedCommission
• type ValidatorAccumulatedCommissionRecord
• type ValidatorCurrentRewards
• type ValidatorCurrentRewardsRecord
• type ValidatorHistoricalRewards
• type ValidatorHistoricalRewardsRecord
• type ValidatorOutstandingRewards
• type ValidatorOutstandingRewardsRecord
• type ValidatorSlashEvent
• type ValidatorSlashEventRecord
• type ValidatorSlashEvents

Constants

const (
	DefaultParamspace                = keeper.DefaultParamspace
	DefaultCodespace                 = types.DefaultCodespace
	CodeInvalidInput                 = types.CodeInvalidInput
	CodeNoDistributionInfo           = types.CodeNoDistributionInfo
	CodeNoValidatorCommission        = types.CodeNoValidatorCommission
	CodeSetWithdrawAddrDisabled      = types.CodeSetWithdrawAddrDisabled
	ModuleName                       = types.ModuleName
	StoreKey                         = types.StoreKey
	RouterKey                        = types.RouterKey
	QuerierRoute                     = types.QuerierRoute
	ProposalTypeCommunityPoolSpend   = types.ProposalTypeCommunityPoolSpend
	QueryParams                      = types.QueryParams
	QueryValidatorOutstandingRewards = types.QueryValidatorOutstandingRewards
	QueryValidatorCommission         = types.QueryValidatorCommission
	QueryValidatorSlashes            = types.QueryValidatorSlashes
	QueryDelegationRewards           = types.QueryDelegationRewards
	QueryDelegatorTotalRewards       = types.QueryDelegatorTotalRewards
	QueryDelegatorValidators         = types.QueryDelegatorValidators
	QueryWithdrawAddr                = types.QueryWithdrawAddr
	QueryCommunityPool               = types.QueryCommunityPool
	ParamCommunityTax                = types.ParamCommunityTax
	ParamBaseProposerReward          = types.ParamBaseProposerReward
	ParamBonusProposerReward         = types.ParamBonusProposerReward
	ParamWithdrawAddrEnabled         = types.ParamWithdrawAddrEnabled
)

Variables

var (
	// functions aliases
	RegisterInvariants                         = keeper.RegisterInvariants
	AllInvariants                              = keeper.AllInvariants
	NonNegativeOutstandingInvariant            = keeper.NonNegativeOutstandingInvariant
	CanWithdrawInvariant                       = keeper.CanWithdrawInvariant
	ReferenceCountInvariant                    = keeper.ReferenceCountInvariant
	ModuleAccountInvariant                     = keeper.ModuleAccountInvariant
	NewKeeper                                  = keeper.NewKeeper
	GetValidatorOutstandingRewardsAddress      = keeper.GetValidatorOutstandingRewardsAddress
	GetDelegatorWithdrawInfoAddress            = keeper.GetDelegatorWithdrawInfoAddress
	GetDelegatorStartingInfoAddresses          = keeper.GetDelegatorStartingInfoAddresses
	GetValidatorHistoricalRewardsAddressPeriod = keeper.GetValidatorHistoricalRewardsAddressPeriod
	GetValidatorCurrentRewardsAddress          = keeper.GetValidatorCurrentRewardsAddress
	GetValidatorAccumulatedCommissionAddress   = keeper.GetValidatorAccumulatedCommissionAddress
	GetValidatorSlashEventAddressHeight        = keeper.GetValidatorSlashEventAddressHeight
	GetValidatorOutstandingRewardsKey          = keeper.GetValidatorOutstandingRewardsKey
	GetDelegatorWithdrawAddrKey                = keeper.GetDelegatorWithdrawAddrKey
	GetDelegatorStartingInfoKey                = keeper.GetDelegatorStartingInfoKey
	GetValidatorHistoricalRewardsPrefix        = keeper.GetValidatorHistoricalRewardsPrefix
	GetValidatorHistoricalRewardsKey           = keeper.GetValidatorHistoricalRewardsKey
	GetValidatorCurrentRewardsKey              = keeper.GetValidatorCurrentRewardsKey
	GetValidatorAccumulatedCommissionKey       = keeper.GetValidatorAccumulatedCommissionKey
	GetValidatorSlashEventPrefix               = keeper.GetValidatorSlashEventPrefix
	GetValidatorSlashEventKeyPrefix            = keeper.GetValidatorSlashEventKeyPrefix
	GetValidatorSlashEventKey                  = keeper.GetValidatorSlashEventKey
	ParamKeyTable                              = keeper.ParamKeyTable
	HandleCommunityPoolSpendProposal           = keeper.HandleCommunityPoolSpendProposal
	NewQuerier                                 = keeper.NewQuerier
	MakeTestCodec                              = keeper.MakeTestCodec
	CreateTestInputDefault                     = keeper.CreateTestInputDefault
	CreateTestInputAdvanced                    = keeper.CreateTestInputAdvanced
	RegisterCodec                              = types.RegisterCodec
	NewDelegatorStartingInfo                   = types.NewDelegatorStartingInfo
	ErrNilDelegatorAddr                        = types.ErrNilDelegatorAddr
	ErrNilWithdrawAddr                         = types.ErrNilWithdrawAddr
	ErrNilValidatorAddr                        = types.ErrNilValidatorAddr
	ErrNoDelegationDistInfo                    = types.ErrNoDelegationDistInfo
	ErrNoValidatorDistInfo                     = types.ErrNoValidatorDistInfo
	ErrNoValidatorCommission                   = types.ErrNoValidatorCommission
	ErrSetWithdrawAddrDisabled                 = types.ErrSetWithdrawAddrDisabled
	ErrBadDistribution                         = types.ErrBadDistribution
	ErrInvalidProposalAmount                   = types.ErrInvalidProposalAmount
	ErrEmptyProposalRecipient                  = types.ErrEmptyProposalRecipient
	InitialFeePool                             = types.InitialFeePool
	NewGenesisState                            = types.NewGenesisState
	DefaultGenesisState                        = types.DefaultGenesisState
	ValidateGenesis                            = types.ValidateGenesis
	NewMsgSetWithdrawAddress                   = types.NewMsgSetWithdrawAddress
	NewMsgWithdrawDelegatorReward              = types.NewMsgWithdrawDelegatorReward
	NewMsgWithdrawValidatorCommission          = types.NewMsgWithdrawValidatorCommission
	NewCommunityPoolSpendProposal              = types.NewCommunityPoolSpendProposal
	NewQueryValidatorOutstandingRewardsParams  = types.NewQueryValidatorOutstandingRewardsParams
	NewQueryValidatorCommissionParams          = types.NewQueryValidatorCommissionParams
	NewQueryValidatorSlashesParams             = types.NewQueryValidatorSlashesParams
	NewQueryDelegationRewardsParams            = types.NewQueryDelegationRewardsParams
	NewQueryDelegatorParams                    = types.NewQueryDelegatorParams
	NewQueryDelegatorWithdrawAddrParams        = types.NewQueryDelegatorWithdrawAddrParams
	NewQueryDelegatorTotalRewardsResponse      = types.NewQueryDelegatorTotalRewardsResponse
	NewDelegationDelegatorReward               = types.NewDelegationDelegatorReward
	NewValidatorHistoricalRewards              = types.NewValidatorHistoricalRewards
	NewValidatorCurrentRewards                 = types.NewValidatorCurrentRewards
	InitialValidatorAccumulatedCommission      = types.InitialValidatorAccumulatedCommission
	NewValidatorSlashEvent                     = types.NewValidatorSlashEvent

	// variable aliases
	FeePoolKey                           = keeper.FeePoolKey
	ProposerKey                          = keeper.ProposerKey
	ValidatorOutstandingRewardsPrefix    = keeper.ValidatorOutstandingRewardsPrefix
	DelegatorWithdrawAddrPrefix          = keeper.DelegatorWithdrawAddrPrefix
	DelegatorStartingInfoPrefix          = keeper.DelegatorStartingInfoPrefix
	ValidatorHistoricalRewardsPrefix     = keeper.ValidatorHistoricalRewardsPrefix
	ValidatorCurrentRewardsPrefix        = keeper.ValidatorCurrentRewardsPrefix
	ValidatorAccumulatedCommissionPrefix = keeper.ValidatorAccumulatedCommissionPrefix
	ValidatorSlashEventPrefix            = keeper.ValidatorSlashEventPrefix
	ParamStoreKeyCommunityTax            = keeper.ParamStoreKeyCommunityTax
	ParamStoreKeyBaseProposerReward      = keeper.ParamStoreKeyBaseProposerReward
	ParamStoreKeyBonusProposerReward     = keeper.ParamStoreKeyBonusProposerReward
	ParamStoreKeyWithdrawAddrEnabled     = keeper.ParamStoreKeyWithdrawAddrEnabled
	TestAddrs                            = keeper.TestAddrs
	ModuleCdc                            = types.ModuleCdc
	EventTypeSetWithdrawAddress          = types.EventTypeSetWithdrawAddress
	EventTypeRewards                     = types.EventTypeRewards
	EventTypeCommission                  = types.EventTypeCommission
	EventTypeWithdrawRewards             = types.EventTypeWithdrawRewards
	EventTypeWithdrawCommission          = types.EventTypeWithdrawCommission
	EventTypeProposerReward              = types.EventTypeProposerReward
	AttributeKeyWithdrawAddress          = types.AttributeKeyWithdrawAddress
	AttributeKeyValidator                = types.AttributeKeyValidator
	AttributeValueCategory               = types.AttributeValueCategory
	ProposalHandler                      = client.ProposalHandler
)

Functions

func BeginBlocker

func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, k keeper.Keeper)

set the proposer for determining distribution during endblock and distribute rewards for the previous block

func ExportGenesis

func ExportGenesis(ctx sdk.Context, keeper Keeper) types.GenesisState

ExportGenesis returns a GenesisState for a given context and keeper.

func InitGenesis

func InitGenesis(ctx sdk.Context, keeper Keeper, supplyKeeper types.SupplyKeeper, data types.GenesisState)

InitGenesis sets distribution information for genesis

func NewCommunityPoolSpendProposalHandler

func NewCommunityPoolSpendProposalHandler(k Keeper) govtypes.Handler

func NewHandler

func NewHandler(k keeper.Keeper) sdk.Handler

Types

type AppModule

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

app module

func NewAppModule

func NewAppModule(keeper Keeper, supplyKeeper types.SupplyKeeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock

func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)

module begin-block

func (AppModule) EndBlock

func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate

module end-block

func (AppModule) ExportGenesis

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

module export genesis

func (AppModule) InitGenesis

func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

module init-genesis

func (AppModule) Name

func (AppModule) Name() string

module name

func (AppModule) NewHandler

func (am AppModule) NewHandler() sdk.Handler

module handler

func (AppModule) NewQuerierHandler

func (am AppModule) NewQuerierHandler() sdk.Querier

module querier

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

module querier route name

func (AppModule) RegisterInvariants

func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)

register invariants

func (AppModule) Route

func (AppModule) Route() string

module message route name

type AppModuleBasic

type AppModuleBasic struct{}

app module basics object

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

default genesis state

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

get the root query command of this module

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

get the root tx command of this module

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

module name

func (AppModuleBasic) RegisterCodec

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

register module codec

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

register rest routes

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

module validate genesis

type CodeType

type CodeType = types.CodeType

type CommunityPoolSpendProposal

type CommunityPoolSpendProposal = types.CommunityPoolSpendProposal

type DelegationDelegatorReward

type DelegationDelegatorReward = types.DelegationDelegatorReward

type DelegatorStartingInfo

type DelegatorStartingInfo = types.DelegatorStartingInfo

type DelegatorStartingInfoRecord

type DelegatorStartingInfoRecord = types.DelegatorStartingInfoRecord

type DelegatorWithdrawInfo

type DelegatorWithdrawInfo = types.DelegatorWithdrawInfo

type FeePool

type FeePool = types.FeePool

type GenesisState

type GenesisState = types.GenesisState

type Hooks

type Hooks = keeper.Hooks

type Keeper

type Keeper = keeper.Keeper

type MsgSetWithdrawAddress

type MsgSetWithdrawAddress = types.MsgSetWithdrawAddress

type MsgWithdrawDelegatorReward

type MsgWithdrawDelegatorReward = types.MsgWithdrawDelegatorReward

type MsgWithdrawValidatorCommission

type MsgWithdrawValidatorCommission = types.MsgWithdrawValidatorCommission

type QueryDelegationRewardsParams

type QueryDelegationRewardsParams = types.QueryDelegationRewardsParams

type QueryDelegatorParams

type QueryDelegatorParams = types.QueryDelegatorParams

type QueryDelegatorTotalRewardsResponse

type QueryDelegatorTotalRewardsResponse = types.QueryDelegatorTotalRewardsResponse

type QueryDelegatorWithdrawAddrParams

type QueryDelegatorWithdrawAddrParams = types.QueryDelegatorWithdrawAddrParams

type QueryValidatorCommissionParams

type QueryValidatorCommissionParams = types.QueryValidatorCommissionParams

type QueryValidatorOutstandingRewardsParams

type QueryValidatorOutstandingRewardsParams = types.QueryValidatorOutstandingRewardsParams

type QueryValidatorSlashesParams

type QueryValidatorSlashesParams = types.QueryValidatorSlashesParams

type ValidatorAccumulatedCommission

type ValidatorAccumulatedCommission = types.ValidatorAccumulatedCommission

type ValidatorAccumulatedCommissionRecord

type ValidatorAccumulatedCommissionRecord = types.ValidatorAccumulatedCommissionRecord

type ValidatorCurrentRewards

type ValidatorCurrentRewards = types.ValidatorCurrentRewards

type ValidatorCurrentRewardsRecord

type ValidatorCurrentRewardsRecord = types.ValidatorCurrentRewardsRecord

type ValidatorHistoricalRewards

type ValidatorHistoricalRewards = types.ValidatorHistoricalRewards

type ValidatorHistoricalRewardsRecord

type ValidatorHistoricalRewardsRecord = types.ValidatorHistoricalRewardsRecord

type ValidatorOutstandingRewards

type ValidatorOutstandingRewards = types.ValidatorOutstandingRewards

type ValidatorOutstandingRewardsRecord

type ValidatorOutstandingRewardsRecord = types.ValidatorOutstandingRewardsRecord

type ValidatorSlashEvent

type ValidatorSlashEvent = types.ValidatorSlashEvent

type ValidatorSlashEventRecord

type ValidatorSlashEventRecord = types.ValidatorSlashEventRecord

type ValidatorSlashEvents

type ValidatorSlashEvents = types.ValidatorSlashEvents