keeper

Documentation

Index

• type Keeper
  • func NewKeeper(env appmodule.Environment, cdc codec.BinaryCodec) Keeper
  • func (k Keeper) AddEpochInfo(ctx context.Context, epoch types.EpochInfo) error
  • func (k Keeper) AfterEpochEnd(ctx context.Context, identifier string, epochNumber int64) error
  • func (k Keeper) AllEpochInfos(ctx context.Context) ([]types.EpochInfo, error)
  • func (k Keeper) BeforeEpochStart(ctx context.Context, identifier string, epochNumber int64) error
  • func (k Keeper) BeginBlocker(ctx context.Context) error
  • func (k Keeper) ExportGenesis(ctx context.Context) (*types.GenesisState, error)
  • func (k Keeper) Hooks() types.EpochHooks
  • func (k Keeper) InitGenesis(ctx context.Context, genState types.GenesisState) error
  • func (k Keeper) NumBlocksSinceEpochStart(ctx context.Context, identifier string) (int64, error)
  • func (k Keeper) SetHooks(eh types.EpochHooks) Keeper
• type Querier
  • func NewQuerier(k Keeper) Querier
  • func (q Querier) CurrentEpoch(ctx context.Context, req *types.QueryCurrentEpochRequest) (*types.QueryCurrentEpochResponse, error)
  • func (q Querier) EpochInfos(ctx context.Context, _ *types.QueryEpochsInfoRequest) (*types.QueryEpochsInfoResponse, error)

Types

type Keeper

type Keeper struct {
	appmodule.Environment

	Schema    collections.Schema
	EpochInfo collections.Map[string, types.EpochInfo]
	// contains filtered or unexported fields
}

func NewKeeper

func NewKeeper(env appmodule.Environment, cdc codec.BinaryCodec) Keeper

NewKeeper returns a new keeper by codec and storeKey inputs.

func (Keeper) AddEpochInfo

func (k Keeper) AddEpochInfo(ctx context.Context, epoch types.EpochInfo) error

AddEpochInfo adds a new epoch info. Will return an error if the epoch fails validation, or re-uses an existing identifier. This method also sets the start time if left unset, and sets the epoch start height.

func (Keeper) AfterEpochEnd

func (k Keeper) AfterEpochEnd(ctx context.Context, identifier string, epochNumber int64) error

AfterEpochEnd gets called at the end of the epoch, end of epoch is the timestamp of first block produced after epoch duration.

func (Keeper) AllEpochInfos

func (k Keeper) AllEpochInfos(ctx context.Context) ([]types.EpochInfo, error)

AllEpochInfos iterate through epochs to return all epochs info.

func (Keeper) BeforeEpochStart

func (k Keeper) BeforeEpochStart(ctx context.Context, identifier string, epochNumber int64) error

BeforeEpochStart new epoch is next block of epoch end block

func (Keeper) BeginBlocker

func (k Keeper) BeginBlocker(ctx context.Context) error

BeginBlocker of epochs module.

func (Keeper) ExportGenesis

func (k Keeper) ExportGenesis(ctx context.Context) (*types.GenesisState, error)

ExportGenesis returns the capability module's exported genesis.

func (Keeper) Hooks

func (k Keeper) Hooks() types.EpochHooks

Hooks gets the hooks for governance Keeper

func (Keeper) InitGenesis

func (k Keeper) InitGenesis(ctx context.Context, genState types.GenesisState) error

InitGenesis sets epoch info from genesis

func (Keeper) NumBlocksSinceEpochStart

func (k Keeper) NumBlocksSinceEpochStart(ctx context.Context, identifier string) (int64, error)

NumBlocksSinceEpochStart returns the number of blocks since the epoch started. if the epoch started on block N, then calling this during block N (after BeforeEpochStart) would return 0. Calling it any point in block N+1 (assuming the epoch doesn't increment) would return 1.

func (Keeper) SetHooks

func (k Keeper) SetHooks(eh types.EpochHooks) Keeper

Set the gamm hooks.

type Querier

type Querier struct {
	Keeper
}

Querier defines a wrapper around the x/epochs keeper providing gRPC method handlers.

func NewQuerier

func NewQuerier(k Keeper) Querier

NewQuerier initializes new querier.

func (Querier) CurrentEpoch

func (q Querier) CurrentEpoch(ctx context.Context, req *types.QueryCurrentEpochRequest) (*types.QueryCurrentEpochResponse, error)

CurrentEpoch provides current epoch of specified identifier.

func (Querier) EpochInfos

func (q Querier) EpochInfos(ctx context.Context, _ *types.QueryEpochsInfoRequest) (*types.QueryEpochsInfoResponse, error)

EpochInfos provide running epochInfos.