keeper

Documentation

Index

• Constants
• func NewQuerier(k Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier
• type Keeper
  • func NewKeeper(skipUpgradeHeights map[int64]bool, storeKey sdk.StoreKey, ...) Keeper
  • func (k Keeper) AppliedPlan(c context.Context, req *types.QueryAppliedPlanRequest) (*types.QueryAppliedPlanResponse, error)
  • func (k Keeper) ApplyUpgrade(ctx sdk.Context, plan types.Plan)
  • func (k Keeper) ClearIBCState(ctx sdk.Context, lastHeight int64)
  • func (k Keeper) ClearUpgradePlan(ctx sdk.Context)
  • func (k Keeper) CurrentPlan(c context.Context, req *types.QueryCurrentPlanRequest) (*types.QueryCurrentPlanResponse, error)
  • func (k Keeper) DumpUpgradeInfoToDisk(height int64, name string) error
  • func (k Keeper) DumpUpgradeInfoWithInfoToDisk(height int64, name string, info string) error
  • func (k Keeper) GetDoneHeight(ctx sdk.Context, name string) int64
  • func (k Keeper) GetModuleVersionMap(ctx sdk.Context) module.VersionMap
  • func (k Keeper) GetModuleVersions(ctx sdk.Context) []*types.ModuleVersion
  • func (k Keeper) GetUpgradeInfoPath() (string, error)
  • func (k Keeper) GetUpgradePlan(ctx sdk.Context) (plan types.Plan, havePlan bool)
  • func (k Keeper) GetUpgradedClient(ctx sdk.Context, height int64) ([]byte, bool)
  • func (k Keeper) GetUpgradedConsensusState(ctx sdk.Context, lastHeight int64) ([]byte, 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) ModuleVersions(c context.Context, req *types.QueryModuleVersionsRequest) (*types.QueryModuleVersionsResponse, error)
  • func (k Keeper) ReadUpgradeInfoFromDisk() (store.UpgradeInfo, error)
  • func (k Keeper) ScheduleUpgrade(ctx sdk.Context, plan types.Plan) error
  • func (k Keeper) SetModuleVersionMap(ctx sdk.Context, vm module.VersionMap)
  • func (k Keeper) SetUpgradeHandler(name string, upgradeHandler types.UpgradeHandler)
  • func (k Keeper) SetUpgradedClient(ctx sdk.Context, planHeight int64, bz []byte) error
  • func (k Keeper) SetUpgradedConsensusState(ctx sdk.Context, planHeight int64, bz []byte) error
  • func (k Keeper) UpgradedConsensusState(c context.Context, req *types.QueryUpgradedConsensusStateRequest) (*types.QueryUpgradedConsensusStateResponse, error)

Constants

const UpgradeInfoFileName string = "upgrade-info.json"

UpgradeInfoFileName file to store upgrade information

Functions

func NewQuerier

func NewQuerier(k Keeper, legacyQuerierCdc *codec.LegacyAmino) 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.BinaryCodec, homePath string, vs xp.ProtocolVersionSetter) Keeper

NewKeeper constructs an upgrade Keeper which requires the following arguments: skipUpgradeHeights - map of heights to skip an upgrade storeKey - a store key with which to access upgrade's store cdc - the app-wide binary codec homePath - root directory of the application's config vs - the interface implemented by baseapp which allows setting baseapp's protocol version field

func (Keeper) AppliedPlan

func (k Keeper) AppliedPlan(c context.Context, req *types.QueryAppliedPlanRequest) (*types.QueryAppliedPlanResponse, error)

AppliedPlan implements the Query/AppliedPlan gRPC method

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) ClearIBCState

func (k Keeper) ClearIBCState(ctx sdk.Context, lastHeight int64)

ClearIBCState clears any planned IBC state

func (Keeper) ClearUpgradePlan

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

ClearUpgradePlan clears any schedule upgrade and associated IBC states.

func (Keeper) CurrentPlan

func (k Keeper) CurrentPlan(c context.Context, req *types.QueryCurrentPlanRequest) (*types.QueryCurrentPlanResponse, error)

CurrentPlan implements the Query/CurrentPlan gRPC method

func (Keeper) DumpUpgradeInfoToDisk

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

DumpUpgradeInfoToDisk writes upgrade information to UpgradeInfoFileName. The function doesn't save the `Plan.Info` data, hence it won't support auto download functionality by cosmvisor. NOTE: this function will be update in the next release.

func (Keeper) DumpUpgradeInfoWithInfoToDisk

func (k Keeper) DumpUpgradeInfoWithInfoToDisk(height int64, name string, info string) error

Deprecated: DumpUpgradeInfoWithInfoToDisk writes upgrade information to UpgradeInfoFileName. `info` should be provided and contain Plan.Info data in order to support auto download functionality by cosmovisor and other tools using upgarde-info.json (GetUpgradeInfoPath()) file.

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) GetModuleVersionMap

func (k Keeper) GetModuleVersionMap(ctx sdk.Context) module.VersionMap

GetModuleVersionMap returns a map of key module name and value module consensus version as defined in ADR-041.

func (Keeper) GetModuleVersions

func (k Keeper) GetModuleVersions(ctx sdk.Context) []*types.ModuleVersion

GetModuleVersions gets a slice of module consensus versions

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) GetUpgradedClient

func (k Keeper) GetUpgradedClient(ctx sdk.Context, height int64) ([]byte, bool)

GetUpgradedClient gets the expected upgraded client for the next version of this chain

func (Keeper) GetUpgradedConsensusState

func (k Keeper) GetUpgradedConsensusState(ctx sdk.Context, lastHeight int64) ([]byte, bool)

GetUpgradedConsensusState set the expected upgraded consensus state for the next version of this chain

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) ModuleVersions

func (k Keeper) ModuleVersions(c context.Context, req *types.QueryModuleVersionsRequest) (*types.QueryModuleVersionsResponse, error)

ModuleVersions implements the Query/QueryModuleVersions gRPC method

func (Keeper) ReadUpgradeInfoFromDisk

func (k Keeper) ReadUpgradeInfoFromDisk() (store.UpgradeInfo, error)

ReadUpgradeInfoFromDisk returns the name and height of the upgrade which is written to disk by the old binary when panicking. An error is returned if the upgrade path directory cannot be created or if the file exists and cannot be read or if the upgrade info fails to unmarshal.

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) ScheduleUpgrade will also write the upgraded client to the upgraded client path if an upgraded client is specified in the plan

func (Keeper) SetModuleVersionMap

func (k Keeper) SetModuleVersionMap(ctx sdk.Context, vm module.VersionMap)

SetModuleVersionMap saves a given version map to state

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.

func (Keeper) SetUpgradedClient

func (k Keeper) SetUpgradedClient(ctx sdk.Context, planHeight int64, bz []byte) error

SetUpgradedClient sets the expected upgraded client for the next version of this chain at the last height the current chain will commit.

func (Keeper) SetUpgradedConsensusState

func (k Keeper) SetUpgradedConsensusState(ctx sdk.Context, planHeight int64, bz []byte) error

SetUpgradedConsensusState set the expected upgraded consensus state for the next version of this chain using the last height committed on this chain.

func (Keeper) UpgradedConsensusState

func (k Keeper) UpgradedConsensusState(c context.Context, req *types.QueryUpgradedConsensusStateRequest) (*types.QueryUpgradedConsensusStateResponse, error)

UpgradedConsensusState implements the Query/UpgradedConsensusState gRPC method nolint: staticcheck