docs: adding migration doc for ibc-go v6 #2417

damiannolan · 2022-09-28T07:32:17Z

Description

Adding migration doc for ibc-go/v6

closes: #2184

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

damiannolan · 2022-09-30T12:40:08Z

docs/migrations/v5-to-v6.md

+These functions have been deprecated in favour of the new `controller` submodule `MsgServer` and will be removed in later releases. 
+Both APIs remain functional and maintain backwards compatibility in `ibc-go/v6`, however consumers of these APIs are now recommended to follow the message passing paradigm outlined in Cosmos SDK [ADR 031](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-031-msg-service.md) and [ADR 033](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-033-protobuf-inter-module-comm.md). This is facilitated by the Cosmos SDK [`MsgServiceRouter`](https://github.com/cosmos/cosmos-sdk/blob/main/baseapp/msg_service_router.go#L17) and chain developers creating custom application logic can now omit the ICS27 `ControllerKeeper` from their module and instead depend on message routing.
+
+For more information see the new [ICS27 integration documentation](TODO: add link to new docs).


I'll put together some new docs for message routing examples for MsgRegisterInterchainAccount and MsgSendTx.

docs/migrations/v5-to-v6.md

chatton

Really clear write up, nice job! 🥇

docs/migrations/v5-to-v6.md

…-go into damian/2184-migration-docs-v6

colin-axner

Great work :) Really nice migration docs!

docs/migrations/v5-to-v6.md

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

…-go into damian/2184-migration-docs-v6

crodriguezvega

Awesome docs, @damiannolan!

I think we need to add some information about the following API breaking PRs: #2395, #2035, #2034, #2025, #2024, #2433, #2446 and maybe also for the changes I mention here.

Sorry, I know that this is still a lot of work, so happy to help here.

docs/migrations/v5-to-v6.md

crodriguezvega · 2022-10-11T11:35:18Z

docs/migrations/v5-to-v6.md

+These functions have been deprecated in favour of the new `controller` submodule `MsgServer` and will be removed in later releases. 
+Both APIs remain functional and maintain backwards compatibility in `ibc-go/v6`, however consumers of these APIs are now recommended to follow the message passing paradigm outlined in Cosmos SDK [ADR 031](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-031-msg-service.md) and [ADR 033](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-033-protobuf-inter-module-comm.md). This is facilitated by the Cosmos SDK [`MsgServiceRouter`](https://github.com/cosmos/cosmos-sdk/blob/main/baseapp/msg_service_router.go#L17) and chain developers creating custom application logic can now omit the ICS27 `ControllerKeeper` from their module and instead depend on message routing.
+
+Legacy APIs are still required if application developers wish to consume IBC packet callbacks and react upon packet acknowledgements. In future this will be replaced by IBC Actor Callbacks, see [ADR 008](https://github.com/cosmos/ibc-go/pull/1976).


Would be nice to get it merged, so that we can use a relative link...

docs/migrations/v5-to-v6.md

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

…Transfer

damiannolan · 2022-10-14T12:14:23Z

Thanks for the detailed review @crodriguezvega .

I think we need to add some information about the following API breaking PRs: #2395, #2035, #2034, #2025, #2024, #2433, #2446 and maybe also for the changes I mention here.

I've documented changes in #2395 and #2446 as they effect end users. I've omitted adding info for the ScopedKeeper changes as we discussed it may add unnecessary noise - this won't cause any compiler to complain as most, if not all users are using the standard x/capability module. I've also omitted the change of PortPrefix -> ControllerPortPrefix and Port to HostPort as these const are likely only used within 27-interchain-accounts.
Migration docs from #1703 have been pulled in.

* WIP ics27 v6 migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * readding migration doc after merge nuked my file -_- * updating migration doc with ics27 host params updates * cleanup * adding controller api deprecation to migration doc * updating links * updating formatting * formatting * moving upgrade handler and migration details to chains section * Apply suggestions from code review Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * mitigate copy pasta by breaking code snippet compilation * added note about legacy APIs for packet cbs and ADR 008 ref * Apply suggestions from code review Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * removing backticks in all refs to ibc-go, controller and host * addressing indentation * adding ics29 NewKeeper api breaking changes and removal of ics20 SendTransfer Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 90b051e)

* WIP ics27 v6 migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * updating migration doc * readding migration doc after merge nuked my file -_- * updating migration doc with ics27 host params updates * cleanup * adding controller api deprecation to migration doc * updating links * updating formatting * formatting * moving upgrade handler and migration details to chains section * Apply suggestions from code review Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * mitigate copy pasta by breaking code snippet compilation * added note about legacy APIs for packet cbs and ADR 008 ref * Apply suggestions from code review Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * removing backticks in all refs to ibc-go, controller and host * addressing indentation * adding ics29 NewKeeper api breaking changes and removal of ics20 SendTransfer Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 90b051e) Co-authored-by: Damian Nolan <damiannolan@gmail.com>

damiannolan added 6 commits September 27, 2022 23:30

WIP ics27 v6 migration doc

9fa567e

updating migration doc

8935dc6

updating migration doc

1be7d30

updating migration doc

e4a0053

updating migration doc

c847c7c

updating migration doc

417fbe2

damiannolan mentioned this pull request Sep 28, 2022

chore: renaming migration doc for 02-client refactor ibc-go/v7 #2418

Merged

9 tasks

damiannolan added 5 commits September 28, 2022 09:53

updating migration doc

deea020

updating migration doc

1edca61

Merge branch 'main' into damian/2184-migration-docs-v6

b165eee

Merge branch 'main' into damian/2184-migration-docs-v6

25af341

readding migration doc after merge nuked my file -_-

02815c7

damiannolan mentioned this pull request Sep 28, 2022

chore: add v6 upgrade handler to simapp #2383

Merged

9 tasks

damiannolan added 7 commits September 28, 2022 14:08

updating migration doc with ics27 host params updates

bd85430

cleanup

c05eb76

adding controller api deprecation to migration doc

3e0e945

updating links

54bcdda

updating formatting

719ba90

formatting

2232a43

Merge branch 'main' into damian/2184-migration-docs-v6

9f66eb0

damiannolan marked this pull request as ready for review September 30, 2022 12:39

damiannolan requested review from colin-axner, AdityaSripal, crodriguezvega, seantking, charleenfei and chatton as code owners September 30, 2022 12:39

damiannolan commented Sep 30, 2022

View reviewed changes

docs/migrations/v5-to-v6.md Show resolved Hide resolved

chatton reviewed Sep 30, 2022

View reviewed changes

docs/migrations/v5-to-v6.md Show resolved Hide resolved

damiannolan added 2 commits September 30, 2022 16:52

moving upgrade handler and migration details to chains section

8666362

Merge branch 'damian/2184-migration-docs-v6' of github.com:cosmos/ibc…

4d273a5

…-go into damian/2184-migration-docs-v6

colin-axner approved these changes Oct 3, 2022

View reviewed changes

damiannolan and others added 4 commits October 4, 2022 11:21

Apply suggestions from code review

ca1bd41

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

mitigate copy pasta by breaking code snippet compilation

f5c883f

added note about legacy APIs for packet cbs and ADR 008 ref

fa56276

Merge branch 'damian/2184-migration-docs-v6' of github.com:cosmos/ibc…

202148c

…-go into damian/2184-migration-docs-v6

damiannolan added the backport-to-v6.0.x label Oct 4, 2022

Merge branch 'main' into damian/2184-migration-docs-v6

5fadba1

crodriguezvega reviewed Oct 11, 2022

View reviewed changes

damiannolan and others added 4 commits October 11, 2022 14:04

Apply suggestions from code review

5350568

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

removing backticks in all refs to ibc-go, controller and host

3acc779

addressing indentation

cc13942

adding ics29 NewKeeper api breaking changes and removal of ics20 Send…

f8751c2

…Transfer

charleenfei approved these changes Oct 14, 2022

View reviewed changes

Merge branch 'main' into damian/2184-migration-docs-v6

ef8f237

damiannolan enabled auto-merge (squash) October 14, 2022 16:23

damiannolan merged commit 90b051e into main Oct 14, 2022

damiannolan deleted the damian/2184-migration-docs-v6 branch October 14, 2022 16:26

mergify bot mentioned this pull request Oct 14, 2022

docs: adding migration doc for ibc-go v6 (backport #2417) #2553

Merged

chatton mentioned this pull request Nov 7, 2022

Add git cliff toml to support generation of changelog #2697

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: adding migration doc for ibc-go v6 #2417

docs: adding migration doc for ibc-go v6 #2417

damiannolan commented Sep 28, 2022

damiannolan Sep 30, 2022

chatton left a comment

colin-axner left a comment

crodriguezvega left a comment

crodriguezvega Oct 11, 2022

damiannolan commented Oct 14, 2022 •

edited

Loading

docs: adding migration doc for ibc-go v6 #2417

docs: adding migration doc for ibc-go v6 #2417

Conversation

damiannolan commented Sep 28, 2022

Description

damiannolan Sep 30, 2022

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

crodriguezvega Oct 11, 2022

Choose a reason for hiding this comment

damiannolan commented Oct 14, 2022 • edited Loading

damiannolan commented Oct 14, 2022 •

edited

Loading