upgrades

Documentation

Index

• type AppKeepers
• type ConsensusParamsReaderWriter
• type Upgrade

Types

type AppKeepers

type AppKeepers struct {
	AppCodec        codec.Codec
	AccountKeeper   authkeeper.AccountKeeper
	BankKeeper      bankkeeper.Keeper
	GetKey          func(moduleName string) *storetypes.KVStoreKey
	ModuleManager   *module.Manager
	EvmKeeper       *evmkeeper.Keeper
	FeeMarketKeeper feemarketkeeper.Keeper

	ReaderWriter ConsensusParamsReaderWriter
}

type ConsensusParamsReaderWriter

type ConsensusParamsReaderWriter interface {
	StoreConsensusParams(ctx sdk.Context, cp *abci.ConsensusParams)
	GetConsensusParams(ctx sdk.Context) *abci.ConsensusParams
}

type Upgrade

type Upgrade struct {
	// Upgrade version name, for the upgrade handler, e.g. `v7`
	UpgradeName string

	// UpgradeHandlerConstructor defines the function that creates an upgrade handler
	UpgradeHandlerConstructor func(*module.Manager, module.Configurator, AppKeepers) upgradetypes.UpgradeHandler

	// Store upgrades, should be used for any new modules introduced, new modules deleted, or store names renamed.
	StoreUpgrades *store.StoreUpgrades
}

Upgrade defines a struct containing necessary fields that a SoftwareUpgradeProposal must have written, in order for the state migration to go smoothly. An upgrade must implement this struct, and then set it in the app.go. The app.go will then define the handler.