upgrades

Documentation

Index

• type Upgrade
• type UpgradeHandlerArgs

Types

type Upgrade

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

	// CreateUpgradeHandler defines the function that creates an upgrade handler
	CreateUpgradeHandler func(args UpgradeHandlerArgs) upgradetypes.UpgradeHandler

	// Store upgrades, should be used for any new modules introduced, new modules deleted, or store names renamed.
	StoreUpgrades storetypes.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.

type UpgradeHandlerArgs

type UpgradeHandlerArgs struct {
	ModuleManager *module.Manager
	Configurator  module.Configurator
	Keepers       *keepers.AppKeepers
	Codec         codec.BinaryCodec
}