Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewUpgradeRouter ¶
func NewUpgradeRouter() *upgradeRouter
NewUpgradeRouter creates a new upgrade router.
No parameters. Returns a pointer to upgradeRouter.
Types ¶
type ConsensusParamsReaderWriter ¶
type ConsensusParamsReaderWriter interface {
StoreConsensusParams(ctx sdk.Context, cp *tmproto.ConsensusParams)
GetConsensusParams(ctx sdk.Context) *tmproto.ConsensusParams
}
ConsensusParamsReaderWriter defines the interface for reading and writing consensus params
type Toolbox ¶
type Toolbox struct {
AppCodec codec.Codec
ModuleManager *module.Manager
ReaderWriter ConsensusParamsReaderWriter
keepers.AppKeepers
}
Toolbox contains all the modules necessary for an upgrade
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, Toolbox) 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.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.