479485f95d
## Description + fixing `x/bank/migrations/v44.migrateDenomMetadata` - we could potentially put a wrong data in a new key if the old keys have variable length. + linting the code Putting in the same PR because i found the issue when running a linter. Depends on: #10112 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# Pre-Upgrade Handling
|
|
|
|
Cosmovisor supports custom pre-upgrade handling. Use pre-upgrade handling when you need to implement application config changes that are required in the newer version before you perform the upgrade.
|
|
|
|
Using Cosmovisor pre-upgrade handling is optional. If pre-upgrade handling is not implemented, the upgrade continues.
|
|
|
|
For example, make the required new-version changes to `app.toml` settings during the pre-upgrade handling. The pre-upgrade handling process means that the file does not have to be manually updated after the upgrade.
|
|
|
|
Before the application binary is upgraded, Cosmovisor calls a `pre-upgrade` command that can be implemented by the application.
|
|
|
|
The `pre-upgrade` command does not take in any command-line arguments and is expected to terminate with the following exit codes:
|
|
|
|
| Exit status code | How it is handled in Cosmosvisor |
|
|
|------------------|---------------------------------------------------------------------------------------------------------------------|
|
|
| `0` | Assumes `pre-upgrade` command executed successfully and continues the upgrade. |
|
|
| `1` | Default exit code when `pre-upgrade` command has not been implemented. |
|
|
| `30` | `pre-upgrade` command was executed but failed. This fails the entire upgrade. |
|
|
| `31` | `pre-upgrade` command was executed but failed. But the command is retried until exit code `1` or `30` are returned. |
|
|
|
|
## Sample
|
|
|
|
Here is a sample structure of the `pre-upgrade` command:
|
|
|
|
```go
|
|
func preUpgradeCommand() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "pre-upgrade",
|
|
Short: "Pre-upgrade command",
|
|
Long: "Pre-upgrade command to implement custom pre-upgrade handling",
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
|
|
err := HandlePreUpgrade()
|
|
|
|
if err != nil {
|
|
os.Exit(30)
|
|
}
|
|
|
|
os.Exit(0)
|
|
|
|
},
|
|
}
|
|
|
|
return cmd
|
|
}
|
|
```
|
|
|
|
Ensure that the pre-upgrade command has been registered in the application:
|
|
|
|
```go
|
|
rootCmd.AddCommand(
|
|
// ..
|
|
preUpgradeCommand(),
|
|
// ..
|
|
)
|
|
```
|