From 39ff596e4f4bb9fab6c1d3bf2d17fdf122ab19e6 Mon Sep 17 00:00:00 2001 From: Bernd Mueller Date: Wed, 17 Apr 2024 16:20:58 +0200 Subject: [PATCH] updated upgrading instructions --- UPGRADING.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/UPGRADING.md b/UPGRADING.md index 4eb4540599..64710e5bde 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,7 +2,7 @@ This guide provides instructions for upgrading to specific versions of Replicated Security. -## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-rc2) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm-rc2) +## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm) ### Provider @@ -15,17 +15,17 @@ as well as the corresponding migrators [here](https://github.com/cosmos/intercha ## [v4.0.x](https://github.com/cosmos/interchain-security/tree/release/v4.0.x) -`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3. +`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3. -### Provider +### Provider -Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31. +Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31. -### Consumer +### Consumer -***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.*** +***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.*** -Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22. +Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22. In addition, the following migration needs to be added to the upgrade handler of the consumer chain: ```golang @@ -49,15 +49,15 @@ func migrateICSOutstandingDowntime(ctx sdk.Context, keepers *upgrades.UpgradeKee ## [v3.3.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x) -### Provider +### Provider -Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration. +Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration. ## [v3.2.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x) `v3.2.0` bumps IBC to `v7.3`. As a result, `legacy_ibc_testing` is not longer required and was removed, see https://github.com/cosmos/interchain-security/pull/1185. This means that when upgrading to `v3.2.0`, any customized tests relying on `legacy_ibc_testing` need to be updated. -### Consumer +### Consumer Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v3.2.x/x/ccv/consumer/keeper/migration.go#L25. @@ -67,13 +67,13 @@ Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require The following should be considered as complementary to [Cosmos SDK v0.47 UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc2/UPGRADING.md). -#### Protobuf +#### Protobuf Protobuf code generation, linting and formatting have been updated to leverage the `ghcr.io/cosmos/proto-builder:0.11.5` docker container. Replicated Security protobuf definitions are now packaged and published to [buf.build/cosmos/interchain-security](https://buf.build/cosmos/interchain-security) via CI workflows. The `third_party/proto` directory has been removed in favour of dependency management using [buf.build](https://docs.buf.build/introduction). #### App modules -Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for +Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for ```diff - // Route implements the AppModule interface @@ -123,10 +123,10 @@ import ( ## [v2.0.x](https://github.com/cosmos/interchain-security/releases/tag/v2.0.0) -### Provider +### Provider Upgrading a provider from `v1.1.0-multiden` to `v2.0.0` will require state migrations. See [migration.go](https://github.com/cosmos/interchain-security/blob/v2.0.0/x/ccv/provider/keeper/migration.go). ### Consumer -Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations. \ No newline at end of file +Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations. \ No newline at end of file