Documentation ¶
Overview ¶
Package distribution implements a Cosmos SDK module, that provides an implementation of the F1 fee distribution algorithm. It handles reward tracking, allocation, and distribution. Please refer to the specification under /spec for further information.
Index ¶
- Constants
- func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, k keeper.Keeper)
- func NewCommunityPoolSpendProposalHandler(k keeper.Keeper) govtypes.Handler
- type AppModule
- func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)
- func (AppModule) ConsensusVersion() uint64
- func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage
- func (AppModule) GenerateGenesisState(simState *module.SimulationState)
- func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) []abci.ValidatorUpdate
- func (AppModule) Name() string
- func (am AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent
- func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)
- func (am AppModule) RegisterServices(cfg module.Configurator)
- func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry)
- func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation
- type AppModuleBasic
- func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
- func (AppModuleBasic) GetQueryCmd() *cobra.Command
- func (AppModuleBasic) GetTxCmd() *cobra.Command
- func (AppModuleBasic) Name() string
- func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx sdkclient.Context, mux *gwruntime.ServeMux)
- func (b AppModuleBasic) RegisterInterfaces(registry cdctypes.InterfaceRegistry)
- func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
- func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config sdkclient.TxEncodingConfig, bz json.RawMessage) error
Constants ¶
const ConsensusVersion = 3
ConsensusVersion defines the current x/distribution module consensus version.
Variables ¶
This section is empty.
Functions ¶
func BeginBlocker ¶ added in v0.25.0
BeginBlocker sets the proposer for determining distribution during endblock and distribute rewards for the previous block
Types ¶
type AppModule ¶ added in v0.47.0
type AppModule struct { AppModuleBasic // contains filtered or unexported fields }
AppModule implements an application module for the distribution module.
func NewAppModule ¶ added in v0.47.0
func NewAppModule( cdc codec.Codec, keeper keeper.Keeper, accountKeeper types.AccountKeeper, bankKeeper types.BankKeeper, stakingKeeper types.StakingKeeper, ss exported.Subspace, ) AppModule
NewAppModule creates a new AppModule object
func (AppModule) BeginBlock ¶ added in v0.47.0
func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock)
BeginBlock returns the begin blocker for the distribution module.
func (AppModule) ConsensusVersion ¶ added in v0.47.0
ConsensusVersion implements AppModule/ConsensusVersion.
func (AppModule) ExportGenesis ¶ added in v0.47.0
ExportGenesis returns the exported genesis state as raw bytes for the distribution module.
func (AppModule) GenerateGenesisState ¶ added in v0.47.0
func (AppModule) GenerateGenesisState(simState *module.SimulationState)
GenerateGenesisState creates a randomized GenState of the distribution module.
func (AppModule) InitGenesis ¶ added in v0.47.0
func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) []abci.ValidatorUpdate
InitGenesis performs genesis initialization for the distribution module. It returns no validator updates.
func (AppModule) ProposalContents ¶ added in v0.47.0
func (am AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent
ProposalContents returns all the distribution content functions used to simulate governance proposals.
func (AppModule) RegisterInvariants ¶ added in v0.47.0
func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)
RegisterInvariants registers the distribution module invariants.
func (AppModule) RegisterServices ¶ added in v0.47.0
func (am AppModule) RegisterServices(cfg module.Configurator)
RegisterServices registers module services.
func (AppModule) RegisterStoreDecoder ¶ added in v0.47.0
func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry)
RegisterStoreDecoder registers a decoder for distribution module's types
func (AppModule) WeightedOperations ¶ added in v0.47.0
func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation
WeightedOperations returns the all the gov module operations with their respective weights.
type AppModuleBasic ¶ added in v0.47.0
type AppModuleBasic struct {
// contains filtered or unexported fields
}
AppModuleBasic defines the basic application module used by the distribution module.
func (AppModuleBasic) DefaultGenesis ¶ added in v0.47.0
func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns default genesis state as raw bytes for the distribution module.
func (AppModuleBasic) GetQueryCmd ¶ added in v0.47.0
func (AppModuleBasic) GetQueryCmd() *cobra.Command
GetQueryCmd returns the root query command for the distribution module.
func (AppModuleBasic) GetTxCmd ¶ added in v0.47.0
func (AppModuleBasic) GetTxCmd() *cobra.Command
GetTxCmd returns the root tx command for the distribution module.
func (AppModuleBasic) Name ¶ added in v0.47.0
func (AppModuleBasic) Name() string
Name returns the distribution module's name.
func (AppModuleBasic) RegisterGRPCGatewayRoutes ¶ added in v0.47.0
func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx sdkclient.Context, mux *gwruntime.ServeMux)
RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the distribution module.
func (AppModuleBasic) RegisterInterfaces ¶ added in v0.47.0
func (b AppModuleBasic) RegisterInterfaces(registry cdctypes.InterfaceRegistry)
RegisterInterfaces implements InterfaceModule
func (AppModuleBasic) RegisterLegacyAminoCodec ¶ added in v0.47.0
func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
RegisterLegacyAminoCodec registers the distribution module's types for the given codec.
func (AppModuleBasic) ValidateGenesis ¶ added in v0.47.0
func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config sdkclient.TxEncodingConfig, bz json.RawMessage) error
ValidateGenesis performs genesis state validation for the distribution module.