keeper

Documentation

Index

• Constants
• func NewQuerier(k Keeper) sdk.Querier
• type Keeper
  • func NewKeeper(skipUpgradeHeights map[int64]bool, storeKey sdk.StoreKey, cdc codec.Marshaler, ...) Keeper
  • func (k Keeper) ApplyUpgrade(ctx sdk.Context, plan types.Plan)
  • func (k Keeper) ClearUpgradePlan(ctx sdk.Context)
  • func (k Keeper) DumpUpgradeInfoToDisk(height int64, name string) error
  • func (k Keeper) GetDoneHeight(ctx sdk.Context, name string) int64
  • func (k Keeper) GetUpgradeInfoPath() (string, error)
  • func (k Keeper) GetUpgradePlan(ctx sdk.Context) (plan types.Plan, havePlan bool)
  • func (k Keeper) HasHandler(name string) bool
  • func (k Keeper) IsSkipHeight(height int64) bool
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) ReadUpgradeInfoFromDisk() (upgradeInfo store.UpgradeInfo)
  • func (k Keeper) ScheduleUpgrade(ctx sdk.Context, plan types.Plan) error
  • func (k Keeper) SetUpgradeHandler(name string, upgradeHandler types.UpgradeHandler)

Constants

const UpgradeInfoFileName string = "upgrade-info.json"

UpgradeInfoFileName file to store upgrade information

Functions

func NewQuerier

func NewQuerier(k Keeper) sdk.Querier

NewQuerier creates a querier for upgrade cli and REST endpoints

Types

type Keeper

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

func NewKeeper

func NewKeeper(skipUpgradeHeights map[int64]bool, storeKey sdk.StoreKey, cdc codec.Marshaler, homePath string) Keeper

NewKeeper constructs an upgrade Keeper

func (Keeper) ApplyUpgrade

func (k Keeper) ApplyUpgrade(ctx sdk.Context, plan types.Plan)

ApplyUpgrade will execute the handler associated with the Plan and mark the plan as done.

func (Keeper) ClearUpgradePlan

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

ClearUpgradePlan clears any schedule upgrade

func (Keeper) DumpUpgradeInfoToDisk

func (k Keeper) DumpUpgradeInfoToDisk(height int64, name string) error

DumpUpgradeInfoToDisk writes upgrade information to UpgradeInfoFileName.

func (Keeper) GetDoneHeight

func (k Keeper) GetDoneHeight(ctx sdk.Context, name string) int64

GetDoneHeight returns the height at which the given upgrade was executed

func (Keeper) GetUpgradeInfoPath

func (k Keeper) GetUpgradeInfoPath() (string, error)

GetUpgradeInfoPath returns the upgrade info file path

func (Keeper) GetUpgradePlan

func (k Keeper) GetUpgradePlan(ctx sdk.Context) (plan types.Plan, havePlan bool)

GetUpgradePlan returns the currently scheduled Plan if any, setting havePlan to true if there is a scheduled upgrade or false if there is none

func (Keeper) HasHandler

func (k Keeper) HasHandler(name string) bool

HasHandler returns true iff there is a handler registered for this name

func (Keeper) IsSkipHeight

func (k Keeper) IsSkipHeight(height int64) bool

IsSkipHeight checks if the given height is part of skipUpgradeHeights

func (Keeper) Logger

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

Logger returns a module-specific logger.

func (Keeper) ReadUpgradeInfoFromDisk

func (k Keeper) ReadUpgradeInfoFromDisk() (upgradeInfo store.UpgradeInfo)

ReadUpgradeInfoFromDisk returns the name and height of the upgrade which is written to disk by the old binary when panic'ing if there's an error in reading the info, it assumes that the upgrade info is not available

func (Keeper) ScheduleUpgrade

func (k Keeper) ScheduleUpgrade(ctx sdk.Context, plan types.Plan) error

ScheduleUpgrade schedules an upgrade based on the specified plan. If there is another Plan already scheduled, it will overwrite it (implicitly cancelling the current plan)

func (Keeper) SetUpgradeHandler

func (k Keeper) SetUpgradeHandler(name string, upgradeHandler types.UpgradeHandler)

SetUpgradeHandler sets an UpgradeHandler for the upgrade specified by name. This handler will be called when the upgrade with this name is applied. In order for an upgrade with the given name to proceed, a handler for this upgrade must be set even if it is a no-op function.