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

    This section is empty.

    Variables

    This section is empty.

    Functions

    func BeginBlocker

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

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

      func NewCommunityPoolSpendProposalHandler

      func NewCommunityPoolSpendProposalHandler(k keeper.Keeper) govtypes.Handler

      func NewHandler

      func NewHandler(k keeper.Keeper) sdk.Handler

      Types

      type AppModule

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

        AppModule implements an application module for the distribution module.

        func NewAppModule

        func NewAppModule(
        	cdc codec.Marshaler, keeper keeper.Keeper, accountKeeper types.AccountKeeper,
        	bankKeeper types.BankKeeper, stakingKeeper stakingkeeper.Keeper,
        ) AppModule

          NewAppModule creates a new AppModule object

          func (AppModule) BeginBlock

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

            BeginBlock returns the begin blocker for the distribution module.

            func (AppModule) EndBlock

              EndBlock returns the end blocker for the distribution module. It returns no validator updates.

              func (AppModule) ExportGenesis

              func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json.RawMessage

                ExportGenesis returns the exported genesis state as raw bytes for the distribution module.

                func (AppModule) GenerateGenesisState

                func (AppModule) GenerateGenesisState(simState *module.SimulationState)

                  GenerateGenesisState creates a randomized GenState of the distribution module.

                  func (AppModule) InitGenesis

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

                    InitGenesis performs genesis initialization for the distribution module. It returns no validator updates.

                    func (AppModule) LegacyQuerierHandler

                    func (am AppModule) LegacyQuerierHandler(legacyQuerierCdc *codec.LegacyAmino) sdk.Querier

                      LegacyQuerierHandler returns the distribution module sdk.Querier.

                      func (AppModule) Name

                      func (AppModule) Name() string

                        Name returns the distribution module's name.

                        func (AppModule) ProposalContents

                        func (am AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent

                          ProposalContents returns all the distribution content functions used to simulate governance proposals.

                          func (AppModule) QuerierRoute

                          func (AppModule) QuerierRoute() string

                            QuerierRoute returns the distribution module's querier route name.

                            func (AppModule) RandomizedParams

                            func (AppModule) RandomizedParams(r *rand.Rand) []simtypes.ParamChange

                              RandomizedParams creates randomized distribution param changes for the simulator.

                              func (AppModule) RegisterInvariants

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

                                RegisterInvariants registers the distribution module invariants.

                                func (AppModule) RegisterServices

                                func (am AppModule) RegisterServices(cfg module.Configurator)

                                  RegisterServices registers module services.

                                  func (AppModule) RegisterStoreDecoder

                                  func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry)

                                    RegisterStoreDecoder registers a decoder for distribution module's types

                                    func (AppModule) Route

                                    func (am AppModule) Route() sdk.Route

                                      Route returns the message routing key for the distribution module.

                                      func (AppModule) WeightedOperations

                                      func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation

                                        WeightedOperations returns the all the gov module operations with their respective weights.

                                        type AppModuleBasic

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

                                          AppModuleBasic defines the basic application module used by the distribution module.

                                          func (AppModuleBasic) DefaultGenesis

                                          func (AppModuleBasic) DefaultGenesis(cdc codec.JSONMarshaler) json.RawMessage

                                            DefaultGenesis returns default genesis state as raw bytes for the distribution module.

                                            func (AppModuleBasic) GetQueryCmd

                                            func (AppModuleBasic) GetQueryCmd() *cobra.Command

                                              GetQueryCmd returns the root query command for the distribution module.

                                              func (AppModuleBasic) GetTxCmd

                                              func (AppModuleBasic) GetTxCmd() *cobra.Command

                                                GetTxCmd returns the root tx command for the distribution module.

                                                func (AppModuleBasic) Name

                                                func (AppModuleBasic) Name() string

                                                  Name returns the distribution module's name.

                                                  func (AppModuleBasic) RegisterGRPCGatewayRoutes

                                                  func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx sdkclient.Context, mux *runtime.ServeMux)

                                                    RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the distribution module.

                                                    func (AppModuleBasic) RegisterInterfaces

                                                    func (b AppModuleBasic) RegisterInterfaces(registry cdctypes.InterfaceRegistry)

                                                      RegisterInterfaces implements InterfaceModule

                                                      func (AppModuleBasic) RegisterLegacyAminoCodec

                                                      func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

                                                        RegisterLegacyAminoCodec registers the distribution module's types for the given codec.

                                                        func (AppModuleBasic) RegisterRESTRoutes

                                                        func (AppModuleBasic) RegisterRESTRoutes(clientCtx sdkclient.Context, rtr *mux.Router)

                                                          RegisterRESTRoutes registers the REST routes for the distribution module.

                                                          func (AppModuleBasic) ValidateGenesis

                                                            ValidateGenesis performs genesis state validation for the distribution module.

                                                            Directories

                                                            Path Synopsis
                                                            cli
                                                            legacy
                                                            v034
                                                            DONTCOVER nolint
                                                            DONTCOVER nolint
                                                            v036
                                                            DONTCOVER nolint
                                                            DONTCOVER nolint
                                                            nolint Package types is a reverse proxy.
                                                            nolint Package types is a reverse proxy.