incentives

Documentation

Index

• Constants
• type AppModule
  • func NewAppModule(cdc codec.Codec, k keeper.Keeper) AppModule
  • func (am AppModule) BeginBlock(ctx context.Context) error
  • func (AppModule) ConsensusVersion() uint64
  • func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, bz json.RawMessage) []cometabci.ValidatorUpdate
  • func (AppModule) IsAppModule()
  • func (AppModule) IsOnePerModuleType()
  • func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
  • func (am AppModule) RegisterServices(cfc module.Configurator)
• 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(cliCtx client.Context, mux *runtime.ServeMux)
  • func (AppModuleBasic) RegisterInterfaces(_ codectypes.InterfaceRegistry)
  • func (AppModuleBasic) RegisterLegacyAminoCodec(_ *codec.LegacyAmino)
  • func (AppModuleBasic) RegisterRESTRoutes(_ client.Context, _ *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ client.TxEncodingConfig, bz json.RawMessage) error
• type Inputs
• type Outputs
  • func ProvideModule(in Inputs) Outputs

Constants

const ConsensusVersion = 1

ConsensusVersion is the x/incentives module's current version, as modules integrate and updates are made, this value determines what version of the module is being run by the chain.

Types

type AppModule

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

AppModule represents an application module for the x/incentives module.

func NewAppModule

func NewAppModule(cdc codec.Codec, k keeper.Keeper) AppModule

NewAppModule returns an application module for the x/incentives module.

func (AppModule) BeginBlock

func (am AppModule) BeginBlock(ctx context.Context) error

BeginBlock returns the begin blocker for the incentives module.

func (AppModule) ConsensusVersion

func (AppModule) ConsensusVersion() uint64

ConsensusVersion implements AppModule/ConsensusVersion.

func (AppModule) ExportGenesis

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

ExportGenesis returns the incentives module's exported genesis state as raw JSON bytes. This method panics on any error.

func (AppModule) InitGenesis

func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, bz json.RawMessage) []cometabci.ValidatorUpdate

InitGenesis performs the genesis initialization for the x/incentives module. It determines the genesis state to initialize from via a json-encoded genesis-state. This method returns no validator set updates. This method panics on any errors.

func (AppModule) IsAppModule

func (AppModule) IsAppModule()

IsAppModule implements the appmodule.AppModule interface.

func (AppModule) IsOnePerModuleType

func (AppModule) IsOnePerModuleType()

IsOnePerModuleType implements the depinject.OnePerModuleType interface.

func (AppModule) RegisterInvariants

func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

RegisterInvariants registers the invariants of the incentives module. If an invariant deviates from its predicted value, the InvariantRegistry triggers appropriate logic (most often the chain will be halted). No invariants exist for the incentives module.

func (AppModule) RegisterServices

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

RegisterServices registers the module's services with the app's module configurator

type AppModuleBasic

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

AppModuleBasic defines the base interface that the x/incentives module exposes to the application.

func (AppModuleBasic) DefaultGenesis

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

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

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd() *cobra.Command

GetQueryCmd returns the x/incentives module base query cli-command.

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd() *cobra.Command

GetTxCmd is a no-op, as no txs are registered for submission.

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

Name returns the name of this module.

func (AppModuleBasic) RegisterGRPCGatewayRoutes

func (AppModuleBasic) RegisterGRPCGatewayRoutes(cliCtx client.Context, mux *runtime.ServeMux)

RegisterGRPCGatewayRoutes registers the necessary REST routes for the GRPC-gateway to the x/incentives module QueryService on mux. This method panics on failure.

func (AppModuleBasic) RegisterInterfaces

func (AppModuleBasic) RegisterInterfaces(_ codectypes.InterfaceRegistry)

RegisterInterfaces registers the necessary implementations / interfaces in the x/incentives module w/ the interface-registry.

func (AppModuleBasic) RegisterLegacyAminoCodec

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

RegisterLegacyAminoCodec registers the necessary types from the x/incentives module for amino serialization.

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(_ client.Context, _ *mux.Router)

No RESTful routes exist for the incentives module (outside of those served via the grpc-gateway).

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ client.TxEncodingConfig, bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the incentives module.

type Inputs

type Inputs struct {
	depinject.In

	Config *incentivesmodulev1.Module
	Cdc    codec.Codec
	Key    *storetypes.KVStoreKey

	// IncentiveStrategies
	IncentiveStrategies map[types.Incentive]types.Strategy `optional:"true"`
}

type Outputs

type Outputs struct {
	depinject.Out

	IncentivesKeeper keeper.Keeper
	Module           appmodule.AppModule
}

func ProvideModule

func ProvideModule(in Inputs) Outputs