Documentation
¶
Index ¶
- func ExportGenesis(ctx sdk.Context, k *keeper.Keeper) *types.GenesisState
- func InitGenesis(ctx sdk.Context, k *keeper.Keeper, genState types.GenesisState)
- type AppModule
- func (AppModule) ConsensusVersion() uint64
- func (am AppModule) EndBlock(_ context.Context) error
- func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage
- func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate
- func (am AppModule) IsAppModule()
- func (am AppModule) IsOnePerModuleType()
- func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
- func (am AppModule) RegisterServices(cfg module.Configurator)
- type AppModuleBasic
- func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
- func (AppModuleBasic) GetQueryCmd() *cobra.Command
- func (a AppModuleBasic) GetTxCmd() *cobra.Command
- func (AppModuleBasic) Name() string
- func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)
- func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)
- func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
- func (AppModuleBasic) RegisterRESTRoutes(_ client.Context, _ *mux.Router)
- func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ client.TxEncodingConfig, bz json.RawMessage) error
- type PreBlockHandler
- func (h *PreBlockHandler) PaymentScheduleCheck(ctx sdktypes.Context) error
- func (h *PreBlockHandler) ProcessExtendedCommitInfo(ctx sdktypes.Context, extendedCommitInfo cometabcitypes.ExtendedCommitInfo) error
- func (h *PreBlockHandler) WrappedPreBlocker(oraclePreBlocker sdktypes.PreBlocker) sdktypes.PreBlocker
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExportGenesis ¶
ExportGenesis returns the module's exported genesis
func InitGenesis ¶
InitGenesis initializes the module's state from a provided genesis state.
Types ¶
type AppModule ¶
type AppModule struct { AppModuleBasic // contains filtered or unexported fields }
AppModule implements the AppModule interface that defines the inter-dependent methods that modules need to implement
func (AppModule) ConsensusVersion ¶
ConsensusVersion is a sequence number for state-breaking change of the module. It should be incremented on each consensus-breaking change introduced by the module. To avoid wrong/empty versions, the initial version should be set to 1
func (AppModule) EndBlock ¶
EndBlock contains the logic that is automatically triggered at the end of each block
func (AppModule) ExportGenesis ¶
ExportGenesis returns the module's exported genesis state as raw JSON bytes.
func (AppModule) InitGenesis ¶
func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate
InitGenesis performs the module's genesis initialization. It returns no validator updates.
func (AppModule) IsAppModule ¶
func (am AppModule) IsAppModule()
IsAppModule implements the appmodule.AppModule interface.
func (AppModule) IsOnePerModuleType ¶
func (am AppModule) IsOnePerModuleType()
IsOnePerModuleType implements the depinject.OnePerModuleType interface.
func (AppModule) RegisterInvariants ¶
func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
RegisterInvariants registers the invariants of the module. If an invariant deviates from its predicted value, the InvariantRegistry triggers appropriate logic (most often the chain will be halted)
func (AppModule) RegisterServices ¶
func (am AppModule) RegisterServices(cfg module.Configurator)
RegisterServices registers a gRPC query service to respond to the module-specific gRPC queries
type AppModuleBasic ¶
type AppModuleBasic struct {
// contains filtered or unexported fields
}
AppModuleBasic implements the AppModuleBasic interface that defines the independent methods a Cosmos SDK module needs to implement.
func NewAppModuleBasic ¶
func NewAppModuleBasic(cdc codec.BinaryCodec) AppModuleBasic
func (AppModuleBasic) DefaultGenesis ¶
func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns a default GenesisState for the module, marshalled to json.RawMessage. The default GenesisState need to be defined by the module developer and is primarily used for testing
func (AppModuleBasic) GetQueryCmd ¶
func (AppModuleBasic) GetQueryCmd() *cobra.Command
GetQueryCmd returns the root query command for the module. The subcommands of this root command are used by end-users to generate new queries to the subset of the state defined by the module
func (AppModuleBasic) GetTxCmd ¶
func (a AppModuleBasic) GetTxCmd() *cobra.Command
GetTxCmd returns the root Tx command for the module. The subcommands of this root command are used by end-users to generate new transactions containing messages defined in the module
func (AppModuleBasic) Name ¶
func (AppModuleBasic) Name() string
Name returns the name of the module as a string
func (AppModuleBasic) RegisterGRPCGatewayRoutes ¶
func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)
RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the module
func (AppModuleBasic) RegisterInterfaces ¶
func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)
RegisterInterfaces registers a module's interface types and their concrete implementations as proto.Message
func (AppModuleBasic) RegisterLegacyAminoCodec ¶
func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
RegisterLegacyAminoCodec registers the amino codec for the module, which is used to marshal and unmarshal structs to/from []byte in order to persist them in the module's KVStore
func (AppModuleBasic) RegisterRESTRoutes ¶
func (AppModuleBasic) RegisterRESTRoutes(_ client.Context, _ *mux.Router)
RegisterRESTRoutes registers the capability module's REST service handlers.
func (AppModuleBasic) ValidateGenesis ¶
func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ client.TxEncodingConfig, bz json.RawMessage) error
ValidateGenesis used to validate the GenesisState, given in its json.RawMessage form
type PreBlockHandler ¶
type PreBlockHandler struct {
// contains filtered or unexported fields
}
PreBlockHandler is responsible for recording validators' participation in network operations and distribute revenue to validators.
func NewPreBlockHandler ¶
func NewPreBlockHandler( revenueKeeper *revenuekeeper.Keeper, stakingKeeper revenuetypes.StakingKeeper, veCodec codec.VoteExtensionCodec, ecCodec codec.ExtendedCommitCodec, ) *PreBlockHandler
NewPreBlockHandler returns a new PreBlockHandler. The handler is responsible for recording validators' participation in network operations and distribute revenue to validators.
func (*PreBlockHandler) PaymentScheduleCheck ¶
func (h *PreBlockHandler) PaymentScheduleCheck(ctx sdktypes.Context) error
PaymentScheduleCheck maintains payment schedule state and consistency, and ensures revenue is distributed across validators according to the payment schedule.
func (*PreBlockHandler) ProcessExtendedCommitInfo ¶
func (h *PreBlockHandler) ProcessExtendedCommitInfo(ctx sdktypes.Context, extendedCommitInfo cometabcitypes.ExtendedCommitInfo) error
ProcessExtendedCommitInfo decodes the extended commit info and records validators' participation in the block creation and oracle prices provision.
func (*PreBlockHandler) WrappedPreBlocker ¶
func (h *PreBlockHandler) WrappedPreBlocker(oraclePreBlocker sdktypes.PreBlocker) sdktypes.PreBlocker
WrappedPreBlocker is called by the base app before the block is finalized. It is responsible for calling the oraclePreBlocker, maintaining data for proper reward asset TWAP calculation, distributing revenue to validators, and recording validators' participation in network operations.