Documentation
¶
Index ¶
- Constants
- func NewMsgServerImpl(k Keeper) types.MsgServer
- type Keeper
- func (k Keeper) ApplyUpgrade(ctx sdk.Context, plan sdkupgradetypes.Plan)
- func (k Keeper) ClearIBCState(ctx sdk.Context, lastHeight int64)
- func (k Keeper) ClearUpgradePlan(ctx sdk.Context)
- func (k Keeper) DowngradeVerified() bool
- func (k Keeper) DumpUpgradeInfoToDisk(height int64, name string) error
- func (k Keeper) GetAuthority(ctx sdk.Context) (authority string)
- func (k Keeper) GetDoneHeight(ctx sdk.Context, name string) int64
- func (k Keeper) GetLastCompletedUpgrade(ctx sdk.Context) (string, int64)
- func (k Keeper) GetModuleVersionMap(ctx sdk.Context) module.VersionMap
- func (k Keeper) GetModuleVersions(ctx sdk.Context) []*sdkupgradetypes.ModuleVersion
- func (k Keeper) GetUpgradeInfoPath() (string, error)
- func (k Keeper) GetUpgradePlan(ctx sdk.Context) (plan sdkupgradetypes.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) ReadUpgradeInfoFromDisk() (storetypes.UpgradeInfo, error)
- func (k Keeper) ScheduleUpgrade(ctx sdk.Context, plan sdkupgradetypes.Plan) error
- func (k *Keeper) SetDowngradeVerified(v bool)
- func (k Keeper) SetModuleVersionMap(ctx sdk.Context, vm module.VersionMap)
- func (k Keeper) SetParams(ctx sdk.Context, params types.Params)
- func (k Keeper) SetUpgradeHandler(name string, upgradeHandler sdkupgradetypes.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
Constants ¶
const UpgradeInfoFileName string = "upgrade-info.json"
Deprecated: UpgradeInfoFileName file to store upgrade information use x/upgrade/types.UpgradeInfoFilename instead.
Variables ¶
This section is empty.
Functions ¶
func NewMsgServerImpl ¶
NewMsgServerImpl returns an implementation of the upgrade MsgServer interface for the provided Keeper.
Types ¶
type Keeper ¶
type Keeper struct {
sdkupgradekeeper.Keeper
// contains filtered or unexported fields
}
func NewKeeper ¶
func NewKeeper(skipUpgradeHeights map[int64]bool, storeKey storetypes.StoreKey, cdc codec.BinaryCodec, homePath string, vs xp.ProtocolVersionSetter, paramSpace sdkparamstypes.Subspace) 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) ApplyUpgrade ¶
func (k Keeper) ApplyUpgrade(ctx sdk.Context, plan sdkupgradetypes.Plan)
ApplyUpgrade will execute the handler associated with the Plan and mark the plan as done.
func (Keeper) ClearIBCState ¶
ClearIBCState clears any planned IBC state
func (Keeper) ClearUpgradePlan ¶
ClearUpgradePlan clears any schedule upgrade and associated IBC states.
func (Keeper) DowngradeVerified ¶
DowngradeVerified returns downgradeVerified.
func (Keeper) DumpUpgradeInfoToDisk ¶
DumpUpgradeInfoToDisk writes upgrade information to UpgradeInfoFileName.
func (Keeper) GetAuthority ¶
GetAuthority returns the module authority
func (Keeper) GetDoneHeight ¶
GetDoneHeight returns the height at which the given upgrade was executed
func (Keeper) GetLastCompletedUpgrade ¶
GetLastCompletedUpgrade returns the last applied upgrade name and height.
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) []*sdkupgradetypes.ModuleVersion
GetModuleVersions gets a slice of module consensus versions
func (Keeper) GetUpgradeInfoPath ¶
GetUpgradeInfoPath returns the upgrade info file path
func (Keeper) GetUpgradePlan ¶
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 ¶
GetUpgradedClient gets the expected upgraded client for the next version of this chain
func (Keeper) GetUpgradedConsensusState ¶
GetUpgradedConsensusState set the expected upgraded consensus state for the next version of this chain
func (Keeper) HasHandler ¶
HasHandler returns true iff there is a handler registered for this name
func (Keeper) IsSkipHeight ¶
IsSkipHeight checks if the given height is part of skipUpgradeHeights
func (Keeper) ReadUpgradeInfoFromDisk ¶
func (k Keeper) ReadUpgradeInfoFromDisk() (storetypes.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 ¶
ScheduleUpgrade schedules an upgrade based on the specified plan. If there is another Plan already scheduled, it will cancel and overwrite it. ScheduleUpgrade will also write the upgraded IBC ClientState to the upgraded client path if it is specified in the plan.
func (*Keeper) SetDowngradeVerified ¶
SetDowngradeVerified updates downgradeVerified.
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 sdkupgradetypes.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 ¶
SetUpgradedClient sets the expected upgraded client for the next version of this chain at the last height the current chain will commit.
Source Files