From ad2cc7405b20863284e485e4f263381e24514fc5 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Tue, 29 Aug 2023 14:49:54 +0200 Subject: [PATCH 1/6] docs: migration docs for v7.3 --- docs/.vuepress/config.js | 5 +++++ docs/migrations/v7_1-to-v7_3.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 docs/migrations/v7_1-to-v7_3.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 1c37fb59ef6..c1d4ec5e0bd 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -621,6 +621,11 @@ module.exports = { directory: false, path: "/migrations/v7-to-v7_1.html", }, + { + title: "IBC-Go v7.1 to v7.3", + directory: false, + path: "/migrations/v7_1-to-v7_3.html", + }, ], }, { diff --git a/docs/migrations/v7_1-to-v7_3.md b/docs/migrations/v7_1-to-v7_3.md new file mode 100644 index 00000000000..364574ee5d9 --- /dev/null +++ b/docs/migrations/v7_1-to-v7_3.md @@ -0,0 +1,29 @@ +# Migrating from v7.1 to v7.3 + +This guide provides instructions for migrating to version `v7.3.0` of ibc-go. + +There are four sections based on the four potential user groups of this document: + +- [Migrating from v7.1 to v7.3](#migrating-from-v71-to-v73) + - [Chains](#chains) + - [IBC Apps](#ibc-apps) + - [Relayers](#relayers) + - [IBC Light Clients](#ibc-light-clients) + +**Note:** ibc-go supports golang semantic versioning and therefore all imports must be updated on major version releases. + +## Chains + +- No relevant changes were made in this release. + +## IBC Apps + +A set of interfaces have been added that IBC applications may optionally implement. Developers interested in integrating their applications with the [callbacks middleware](../middleware/callbacks/overview.md) should implement these interfaces so that the callbacks middleware retrieve desired callback addresses on the source and destination chains and execute actions on packet lifecycle events. The interfaces are [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/05-port/types/module.go#L142-L147), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L43-L52) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L36-L41). Sample implementations are available for reference: implementation of [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/ibc_module.go#L303-L313), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L85-L105) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L74-L83) for `transfer`; and implementations of [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/controller/ibc_middleware.go#L258-L268), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L94-L114) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L78-L92) for `27-interchain-accounts`. + +## Relayers + +- No relevant changes were made in this release. + +## IBC Light Clients + +- No relevant changes were made in this release. From 43b619eadac30f5b91fc974143ccfe725aa5426a Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Tue, 29 Aug 2023 14:52:33 +0200 Subject: [PATCH 2/6] formatting --- docs/migrations/v7_1-to-v7_3.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/migrations/v7_1-to-v7_3.md b/docs/migrations/v7_1-to-v7_3.md index 364574ee5d9..0756a028100 100644 --- a/docs/migrations/v7_1-to-v7_3.md +++ b/docs/migrations/v7_1-to-v7_3.md @@ -18,7 +18,19 @@ There are four sections based on the four potential user groups of this document ## IBC Apps -A set of interfaces have been added that IBC applications may optionally implement. Developers interested in integrating their applications with the [callbacks middleware](../middleware/callbacks/overview.md) should implement these interfaces so that the callbacks middleware retrieve desired callback addresses on the source and destination chains and execute actions on packet lifecycle events. The interfaces are [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/05-port/types/module.go#L142-L147), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L43-L52) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L36-L41). Sample implementations are available for reference: implementation of [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/ibc_module.go#L303-L313), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L85-L105) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L74-L83) for `transfer`; and implementations of [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/controller/ibc_middleware.go#L258-L268), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L94-L114) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L78-L92) for `27-interchain-accounts`. +A set of interfaces have been added that IBC applications may optionally implement. Developers interested in integrating their applications with the [callbacks middleware](../middleware/callbacks/overview.md) should implement these interfaces so that the callbacks middleware retrieve desired callback addresses on the source and destination chains and execute actions on packet lifecycle events. The interfaces are [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/05-port/types/module.go#L142-L147), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L43-L52) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L36-L41). + +Sample implementations are available for reference. For `transfer`: + +- [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/ibc_module.go#L303-L313), +- [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L85-L105) +- and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/transfer/types/packet.go#L74-L83). + +For `27-interchain-accounts`: + +- [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/controller/ibc_middleware.go#L258-L268), +- [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L94-L114) +- and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/apps/27-interchain-accounts/types/packet.go#L78-L92). ## Relayers From e157842dd3db7c827b31cd86aa2af6d8366d01e4 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Tue, 29 Aug 2023 16:17:55 +0200 Subject: [PATCH 3/6] Update docs/migrations/v7_1-to-v7_3.md Co-authored-by: Jim Fasarakis-Hilliard --- docs/migrations/v7_1-to-v7_3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/migrations/v7_1-to-v7_3.md b/docs/migrations/v7_1-to-v7_3.md index 0756a028100..2b3b59949a5 100644 --- a/docs/migrations/v7_1-to-v7_3.md +++ b/docs/migrations/v7_1-to-v7_3.md @@ -18,7 +18,7 @@ There are four sections based on the four potential user groups of this document ## IBC Apps -A set of interfaces have been added that IBC applications may optionally implement. Developers interested in integrating their applications with the [callbacks middleware](../middleware/callbacks/overview.md) should implement these interfaces so that the callbacks middleware retrieve desired callback addresses on the source and destination chains and execute actions on packet lifecycle events. The interfaces are [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/05-port/types/module.go#L142-L147), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L43-L52) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L36-L41). +A set of interfaces have been added that IBC applications may optionally implement. Developers interested in integrating their applications with the [callbacks middleware](../middleware/callbacks/overview.md) should implement these interfaces so that the callbacks middleware can retrieve the desired callback addresses on the source and destination chains and execute actions on packet lifecycle events. The interfaces are [`PacketDataUnmarshaler`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/05-port/types/module.go#L142-L147), [`PacketDataProvider`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L43-L52) and [`PacketData`](https://github.com/cosmos/ibc-go/blob/v7.3.0-rc1/modules/core/exported/packet.go#L36-L41). Sample implementations are available for reference. For `transfer`: From b6c78e08d6c985d9b151158447f2f58190f57436 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Wed, 30 Aug 2023 09:14:24 +0200 Subject: [PATCH 4/6] address review feedback --- docs/.vuepress/config.js | 2 +- docs/migrations/{v7_1-to-v7_3.md => v7_2-to-v7_3.md} | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) rename docs/migrations/{v7_1-to-v7_3.md => v7_2-to-v7_3.md} (96%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index c1d4ec5e0bd..412edea9210 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -624,7 +624,7 @@ module.exports = { { title: "IBC-Go v7.1 to v7.3", directory: false, - path: "/migrations/v7_1-to-v7_3.html", + path: "/migrations/v7_2-to-v7_3.html", }, ], }, diff --git a/docs/migrations/v7_1-to-v7_3.md b/docs/migrations/v7_2-to-v7_3.md similarity index 96% rename from docs/migrations/v7_1-to-v7_3.md rename to docs/migrations/v7_2-to-v7_3.md index 2b3b59949a5..cda093ad687 100644 --- a/docs/migrations/v7_1-to-v7_3.md +++ b/docs/migrations/v7_2-to-v7_3.md @@ -1,10 +1,10 @@ -# Migrating from v7.1 to v7.3 +# Migrating from v7.2 to v7.3 This guide provides instructions for migrating to version `v7.3.0` of ibc-go. There are four sections based on the four potential user groups of this document: -- [Migrating from v7.1 to v7.3](#migrating-from-v71-to-v73) +- [Migrating from v7.2 to v7.3](#migrating-from-v72-to-v73) - [Chains](#chains) - [IBC Apps](#ibc-apps) - [Relayers](#relayers) From ed2caf66a05425703e5f2f43ae59a3cbcdbae02b Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Wed, 30 Aug 2023 09:15:40 +0200 Subject: [PATCH 5/6] Update config.js --- docs/.vuepress/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 412edea9210..0a2aa6b5a42 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -622,7 +622,7 @@ module.exports = { path: "/migrations/v7-to-v7_1.html", }, { - title: "IBC-Go v7.1 to v7.3", + title: "IBC-Go v7.2 to v7.3", directory: false, path: "/migrations/v7_2-to-v7_3.html", }, From 835ae22816c5d1b09937aca18eb9a8c1eee13f59 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Wed, 30 Aug 2023 11:28:29 +0200 Subject: [PATCH 6/6] migration docs for 06-solomachine --- docs/migrations/v7_2-to-v7_3.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/migrations/v7_2-to-v7_3.md b/docs/migrations/v7_2-to-v7_3.md index cda093ad687..3017e2bca76 100644 --- a/docs/migrations/v7_2-to-v7_3.md +++ b/docs/migrations/v7_2-to-v7_3.md @@ -38,4 +38,6 @@ For `27-interchain-accounts`: ## IBC Light Clients -- No relevant changes were made in this release. +### 06-solomachine + +Solo machines are now expected to sign data on a path that 1) does not include a connection prefix (e.g `ibc`) and 2) does not escape any characters. See PR [#4429](https://github.com/cosmos/ibc-go/pull/4429) for more details. We recommend __NOT__ using the solo machine light client of versions lower than v7.3.0.