keeper

Documentation

Index

• type Keeper
  • func NewKeeper(cdc codec.Codec, storeKey storetypes.StoreKey) *Keeper
  • func (k Keeper) AfterEpochEnd(ctx sdk.Context, identifier string, epochNumber int64)
  • func (k Keeper) AllEpochInfos(ctx sdk.Context) []types.EpochInfo
  • func (k Keeper) BeforeEpochStart(ctx sdk.Context, identifier string, epochNumber int64)
  • func (k Keeper) BeginBlocker(ctx sdk.Context)
  • func (k Keeper) CurrentEpoch(c context.Context, req *types.QueryCurrentEpochRequest) (*types.QueryCurrentEpochResponse, error)
  • func (k Keeper) DeleteEpochInfo(ctx sdk.Context, identifier string)
  • func (k Keeper) EpochInfos(c context.Context, req *types.QueryEpochsInfoRequest) (*types.QueryEpochsInfoResponse, error)
  • func (k Keeper) GetEpochInfo(ctx sdk.Context, identifier string) (types.EpochInfo, bool)
  • func (k Keeper) IterateEpochInfo(ctx sdk.Context, fn func(index int64, epochInfo types.EpochInfo) (stop bool))
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) SetEpochInfo(ctx sdk.Context, epoch types.EpochInfo)
  • func (k *Keeper) SetHooks(eh types.EpochHooks) *Keeper
• type MultiEpochHooks
  • func NewMultiEpochHooks(hooks ...types.EpochHooks) MultiEpochHooks
  • func (mh MultiEpochHooks) AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64)
  • func (mh MultiEpochHooks) BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64)

Types

type Keeper

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

Keeper of this module maintains collections of epochs and hooks.

func NewKeeper

func NewKeeper(cdc codec.Codec, storeKey storetypes.StoreKey) *Keeper

NewKeeper returns a new instance of epochs Keeper

func (Keeper) AfterEpochEnd

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

AfterEpochEnd executes the indicated hook after epochs ends

func (Keeper) AllEpochInfos

func (k Keeper) AllEpochInfos(ctx sdk.Context) []types.EpochInfo

AllEpochInfos returns every epochInfo in the store

func (Keeper) BeforeEpochStart

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

BeforeEpochStart executes the indicated hook before the epochs

func (Keeper) BeginBlocker

func (k Keeper) BeginBlocker(ctx sdk.Context)

BeginBlocker of epochs module

func (Keeper) CurrentEpoch

func (k Keeper) CurrentEpoch(
	c context.Context,
	req *types.QueryCurrentEpochRequest,
) (*types.QueryCurrentEpochResponse, error)

CurrentEpoch provides current epoch of specified identifier

func (Keeper) DeleteEpochInfo

func (k Keeper) DeleteEpochInfo(ctx sdk.Context, identifier string)

DeleteEpochInfo delete epoch info

func (Keeper) EpochInfos

func (k Keeper) EpochInfos(
	c context.Context,
	req *types.QueryEpochsInfoRequest,
) (*types.QueryEpochsInfoResponse, error)

EpochInfos provide running epochInfos

func (Keeper) GetEpochInfo

func (k Keeper) GetEpochInfo(ctx sdk.Context, identifier string) (types.EpochInfo, bool)

GetEpochInfo returns epoch info by identifier

func (Keeper) IterateEpochInfo

func (k Keeper) IterateEpochInfo(ctx sdk.Context, fn func(index int64, epochInfo types.EpochInfo) (stop bool))

IterateEpochInfo iterate through epochs

func (Keeper) Logger

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (Keeper) SetEpochInfo

func (k Keeper) SetEpochInfo(ctx sdk.Context, epoch types.EpochInfo)

SetEpochInfo set epoch info

func (*Keeper) SetHooks

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

SetHooks set the epoch hooks

type MultiEpochHooks

type MultiEpochHooks []types.EpochHooks

combine multiple epoch hooks, all hook functions are run in array sequence

func NewMultiEpochHooks

func NewMultiEpochHooks(hooks ...types.EpochHooks) MultiEpochHooks

func (MultiEpochHooks) AfterEpochEnd

func (mh MultiEpochHooks) AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64)

AfterEpochEnd is called when epoch is going to be ended, epochNumber is the number of epoch that is ending

func (MultiEpochHooks) BeforeEpochStart

func (mh MultiEpochHooks) BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64)

BeforeEpochStart is called when epoch is going to be started, epochNumber is the number of epoch that is starting