Last active
July 5, 2022 00:56
-
-
Save zeroFruit/c9e62a87fe9a2d0f6e1ed056411d5f76 to your computer and use it in GitHub Desktop.
Cosmos Dev Series: Cosmos-SDK-based Blockchain Upgrade - UpgradeHandler
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // UpgradeHandler specifies the type of function that is called when an upgrade | |
| // is applied. | |
| // | |
| // `fromVM` is a VersionMap of moduleName to fromVersion (unit64), where | |
| // fromVersion denotes the version from which we should migrate the module, the | |
| // target version being the module's latest version in the return VersionMap, | |
| // let's call it `toVM`. | |
| // | |
| // `fromVM` is retrieved from x/upgrade's store, whereas `toVM` is chosen | |
| // arbitrarily by the app developer (and persisted to x/upgrade's store right | |
| // after the upgrade handler runs). In general, `toVM` should map all modules | |
| // to their latest ConsensusVersion so that x/upgrade can track each module's | |
| // latest ConsensusVersion; `fromVM` can be left as-is, but can also be | |
| // modified inside the upgrade handler, e.g. to skip running InitGenesis or | |
| // migrations for certain modules when calling the `module.Manager#RunMigrations` | |
| // function. | |
| // | |
| // Please also refer to docs/core/upgrade.md for more information. | |
| type UpgradeHandler func(ctx sdk.Context, plan Plan, fromVM module.VersionMap) (module.VersionMap, error) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment