staking

Documentation

Overview

Package staking defines a "wrapper" module around the Cosmos SDK's native x/staking module. In other words, it provides the exact same functionality as the native module in that it simply embeds the native module. However, it overrides `EndBlock` and `InitGenesis`, which will return no validator set updates. Instead, it is assumed that some other module will provide the validator set updates.

Index

• type AppModule
  • func NewAppModule(cdc codec.Codec, keeper *keeper.Keeper, ak types.AccountKeeper, ...) AppModule
  • func (am AppModule) EndBlock(ctx context.Context) ([]abci.ValidatorUpdate, error)
  • func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) []abci.ValidatorUpdate
• type AppModuleBasic

Types

type AppModule

type AppModule struct {
	// embed the Cosmos SDK's x/staking AppModule
	staking.AppModule
	// contains filtered or unexported fields
}

AppModule embeds the Cosmos SDK's x/staking AppModule where we only override specific methods.

func NewAppModule

func NewAppModule(
	cdc codec.Codec,
	keeper *keeper.Keeper,
	ak types.AccountKeeper,
	bk types.BankKeeper,
	ls exported.Subspace,
) AppModule

NewAppModule creates a new AppModule object using the native x/staking module AppModule constructor.

func (AppModule) EndBlock

func (am AppModule) EndBlock(ctx context.Context) ([]abci.ValidatorUpdate, error)

EndBlock delegates the EndBlock call to the underlying x/staking module, however, it returns no validator updates as validator updates will be provided by the provider module.

func (AppModule) InitGenesis

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

InitGenesis delegates the InitGenesis call to the underlying x/staking module, however, it returns no validator updates as validator updates will be provided by the provider module.

type AppModuleBasic

type AppModuleBasic struct {
	staking.AppModuleBasic
}

AppModule embeds the Cosmos SDK's x/staking AppModuleBasic.