feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) #630

youngjoon-lee · 2023-02-04T14:02:49Z

Motivation

Susannah, [Feb 2, 2023 22:12:17]:
Hello, I have queried medibloc and see that you are using v2.0.3 of ibc-go which is in the end of life. This means that patches and bug fixes are no longer back-ported to this version. We strongly encourage you to upgrade your version of ibc to v4.2.0, this is because v3.4.x will be in end of life in the middle of march. The migration documentation to go from v2 to v3 is here https://ibc.cosmos.network/main/migrations/v2-to-v3.html and for v3 to v4, take a look here https://ibc.cosmos.network/main/migrations/v3-to-v4.html

What I did

Upgraded ibc-go from v2 to v4
- Without adopting the following new features:
  - ICS27 Interchain Accounts (aka, ICA)
  - ICS29 Fee Middleware. For more details, see a comment below.
- This requires us to upgrade wasmd to v0.30.0+ and cosmos-sdk to v0.45.12+. For more details, please see a comment below.
- There are a lot of changes in app.go. I put reference links as PR comments below.

Tests

Tested IBC transfers manually with a Panacea Localnet and the Osmosis Mainnet.
- Panacea -> Osmosis: Success
- Osmosis -> Panacea: Success
Also tested IBC transfers before and after upgrading the chain from v2.0.5 to HEAD.

Future work

Automate IBC tests by referring to e2e tests in ibc-go, gaia, or osmosis.

Reference: CosmWasm/wasmd#824

Reference: CosmWasm/wasmd#837 https://ibc.cosmos.network/main/migrations/v2-to-v3.html#upgrade-proposal https://github.com/cosmos/gaia/blob/6742b7158a9b7abf28e3615143620e759cb8307d/app/upgrades/v7/upgrades.go#L15 https://github.com/cosmos/gaia/blob/a4e9d1171d6ab82c95e96bd65c7366d6dee87a49/app/upgrades/v8/upgrades.go#L119

…om v0.45.9 to v0.45.12 Reference: CosmWasm/wasmd#1088

youngjoon-lee · 2023-02-08T07:55:44Z

app/ante.go

@@ -62,7 +62,7 @@ func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error) {
 		ante.NewSigGasConsumeDecorator(options.AccountKeeper, sigGasConsumer),
 		ante.NewSigVerificationDecorator(options.AccountKeeper, options.SignModeHandler),
 		ante.NewIncrementSequenceDecorator(options.AccountKeeper),
-		ibcante.NewAnteDecorator(options.IBCChannelkeeper),
+		ibcante.NewAnteDecorator(options.IBCKeeper),


https://ibc.cosmos.network/main/migrations/v2-to-v3.html#ante-decorator

youngjoon-lee · 2023-02-08T07:59:00Z

app/app.go

@@ -492,8 +492,8 @@ func New(

 	// Create static IBC router, add transfer route, then set and seal it
 	ibcRouter := porttypes.NewRouter()
-	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule)
-	ibcRouter.AddRoute(wasm.ModuleName, wasm.NewIBCHandler(app.wasmKeeper, app.IBCKeeper.ChannelKeeper))
+	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transfer.NewIBCModule(app.TransferKeeper))


Regarding the use of transfer.NewIBCModule(...) instead of transferModule (that was created by transfer.NewAppModule(...)), https://ibc.cosmos.network/main/migrations/v2-to-v3.html#ibc-application-callbacks-moved-from-appmodule-to-ibcmodule

youngjoon-lee · 2023-02-08T08:01:02Z

go.mod

@@ -3,72 +3,75 @@ module github.com/medibloc/panacea-core/v2
 go 1.19

 require (
-	github.com/CosmWasm/wasmd v0.24.0
-	github.com/btcsuite/btcd v0.22.1
+	github.com/CosmWasm/wasmd v0.30.0


For IBC v4, wasmd must be also upgraded to v0.30.0 that is the first version based on IBC v4. This also requires us to upgrade cosmos-sdk to v0.45.11+.
https://github.com/CosmWasm/wasmd/blob/main/CHANGELOG.md#v0300-2022-12-02

Anyway, we have to upgrade cosmos-sdk to v0.45.12, as ibc-go v4.3.0 requires it.
https://github.com/cosmos/ibc-go/blob/main/RELEASES.md#version-matrix

youngjoon-lee · 2023-02-08T08:38:53Z

app/app.go

 	// Create Transfer Keepers
 	app.TransferKeeper = ibctransferkeeper.NewKeeper(
 		appCodec, keys[ibctransfertypes.StoreKey], app.GetSubspace(ibctransfertypes.ModuleName),
+		app.IBCKeeper.ChannelKeeper, // may be replaced with middleware such as ics29 fee
 		app.IBCKeeper.ChannelKeeper, &app.IBCKeeper.PortKeeper,
 		app.AccountKeeper, app.BankKeeper, scopedTransferKeeper,
 	)


Since IBC v3, IBC middleware has been introduced.

As above, if we don't want to use any middleware for now, we can just pass the app.IBCKeeper.ChannelKeeer as a ICS4Wrapper parameter. It's explained in the IBC v2->v3 migration guide. Also, I referenced the ibc-go simapp.

Later, when we want to use any IBC middleware such as IBC Fee middleware, we can modify this code to pass a IBCFeeKeeper, as ibc-go simapp did.

Still, both Cosmos Hub and Osmosis don't use IBC Fee middleware yet.

youngjoon-lee · 2023-02-08T08:44:11Z

app/app.go

-	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule)
-	ibcRouter.AddRoute(wasm.ModuleName, wasm.NewIBCHandler(app.wasmKeeper, app.IBCKeeper.ChannelKeeper))
+	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transfer.NewIBCModule(app.TransferKeeper))
+	ibcRouter.AddRoute(wasm.ModuleName, wasm.NewIBCHandler(app.wasmKeeper, app.IBCKeeper.ChannelKeeper, app.IBCKeeper.ChannelKeeper))


Regarding the last new parameter of wasm.NewIBCHandler(...), https://github.com/osmosis-labs/osmosis/pull/3838/files#diff-1ac782d2fab1d48ad7f7ef06cf2d58b37c99b6b4c98879a5ad86a985b73fad58R403

go.mod

gyuguen

LGTM
Thank you for your hard working!

It seems to have applied well when I saw the migration documentation

0xHansLee

lgtm.

youngjoon-lee · 2023-02-13T08:14:07Z

go.mod

 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	nhooyr.io/websocket v1.8.6 // indirect
 )

 replace (
-	github.com/confio/ics23/go => github.com/cosmos/cosmos-sdk/ics23/go v0.8.0


This replace directive can be deleted as described in the release note of cosmos-sdk v0.45.12. https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.12

we don't need this redirection anymore 👍

youngjoon-lee added 3 commits February 4, 2023 15:41

feat: minimal ibc-go v3.0.0 upgrade

f9221e3

Reference: CosmWasm/wasmd#824

build: bump ibc-go from v3.0.0 to v3.3.0

63dd61d

youngjoon-lee self-assigned this Feb 4, 2023

feat: upgrade ibc-go from v3.3.0 to v4.2.0 with bumping cosmos-sdk fr…

006a9cb

…om v0.45.9 to v0.45.12 Reference: CosmWasm/wasmd#1088

youngjoon-lee force-pushed the ibc-go-v4.2.0 branch from 7e672f9 to 006a9cb Compare February 5, 2023 02:05

remove ICA Host

f9ee85f

youngjoon-lee force-pushed the ibc-go-v4.2.0 branch from be95e2a to f9ee85f Compare February 8, 2023 06:51

youngjoon-lee added 5 commits February 8, 2023 15:52

add TODO

4a0987f

more comments

c1a3e90

remove IBC Fee

9d8a67e

remove duplicated

fb3ccbc

bump ibc-go v4.2.0 -> v4.3.0

5f4ffe0

youngjoon-lee commented Feb 8, 2023

View reviewed changes

fix test suite

05588de

youngjoon-lee changed the title ~~feat: WIP: upgrade ibc-go from v2 to v4 (with upgrading cosmos-sdk to v0.45.12)~~ feat: WIP: upgrade ibc-go from v2 to v4.3.0 (with upgrading cosmos-sdk to v0.45.12) Feb 10, 2023

youngjoon-lee changed the title ~~feat: WIP: upgrade ibc-go from v2 to v4.3.0 (with upgrading cosmos-sdk to v0.45.12)~~ feat: upgrade ibc-go from v2 to v4.3.0 (with upgrading cosmos-sdk to v0.45.12) Feb 10, 2023

Merge branch 'main' into ibc-go-v4.2.0

340fb96

youngjoon-lee commented Feb 10, 2023

View reviewed changes

go.mod Outdated Show resolved Hide resolved

youngjoon-lee marked this pull request as ready for review February 10, 2023 07:27

youngjoon-lee requested review from cl9200, gyuguen, 0xHansLee, inchori and audtlr24 as code owners February 10, 2023 07:27

youngjoon-lee changed the title ~~feat: upgrade ibc-go from v2 to v4.3.0 (with upgrading cosmos-sdk to v0.45.12)~~ feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) Feb 10, 2023

gyuguen approved these changes Feb 10, 2023

View reviewed changes

0xHansLee approved these changes Feb 13, 2023

View reviewed changes

youngjoon-lee added 2 commits February 13, 2023 17:04

use medibloc/cosmos-sdk v0.45.12-panacea.1

278089f

delete a replace directive for ics23

3408a59

youngjoon-lee commented Feb 13, 2023

View reviewed changes

youngjoon-lee merged commit 8293dbb into main Feb 13, 2023

youngjoon-lee deleted the ibc-go-v4.2.0 branch February 13, 2023 08:17

youngjoon-lee mentioned this pull request Feb 16, 2023

build(deps): use Informal System fork of Tendermint #634

Merged

youngjoon-lee pushed a commit that referenced this pull request Feb 16, 2023

feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) (#630)

94b94e8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) #630

feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) #630

youngjoon-lee commented Feb 4, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

gyuguen left a comment

0xHansLee left a comment

youngjoon-lee Feb 13, 2023

0xHansLee Feb 13, 2023

gyuguen Feb 13, 2023

feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) #630

feat: upgrade ibc-go from v2 to v4.3.0 (with cosmos-sdk v0.45.12) #630

Conversation

youngjoon-lee commented Feb 4, 2023 • edited Loading

Motivation

What I did

Tests

Future work

youngjoon-lee Feb 8, 2023

Choose a reason for hiding this comment

youngjoon-lee Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

youngjoon-lee Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

youngjoon-lee Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

youngjoon-lee Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

gyuguen left a comment

Choose a reason for hiding this comment

0xHansLee left a comment

Choose a reason for hiding this comment

youngjoon-lee Feb 13, 2023

Choose a reason for hiding this comment

0xHansLee Feb 13, 2023

Choose a reason for hiding this comment

gyuguen Feb 13, 2023

Choose a reason for hiding this comment

youngjoon-lee commented Feb 4, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading

youngjoon-lee Feb 8, 2023 •

edited

Loading