From 9f770e1c502c7774ae832d4d7d5faed17e05aeee Mon Sep 17 00:00:00 2001 From: mpoke Date: Thu, 11 Jan 2024 15:06:13 +0100 Subject: [PATCH 1/2] update upgrading instructions --- UPGRADING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/UPGRADING.md b/UPGRADING.md index 06df8eb91e..6dd7d9b2c6 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,6 +2,34 @@ This guide provides instructions for upgrading to specific versions of Replicated Security. +## [v4.0.x](https://github.com/cosmos/interchain-security/tree/release/v4.0.x) + +`v4.0.x` sets the required minimum version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3. + +### 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. + +### Consumer + +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. + +Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`. + +## [v3.3.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x) + +### Provider + +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 + +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. + ## [v3.0.x](https://github.com/cosmos/interchain-security/releases/tag/v3.0.0-rc0) ### Upgrading to Cosmos SDK 0.47 From f8718f937f8ef04965451e7ad52c3547c2f200d3 Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Thu, 11 Jan 2024 15:12:54 +0100 Subject: [PATCH 2/2] Update UPGRADING.md --- UPGRADING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UPGRADING.md b/UPGRADING.md index 6dd7d9b2c6..cc7de42395 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -4,7 +4,7 @@ This guide provides instructions for upgrading to specific versions of Replicate ## [v4.0.x](https://github.com/cosmos/interchain-security/tree/release/v4.0.x) -`v4.0.x` sets the required minimum 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