From 053e00eeb1cffc55aff2d9bf1af14e7eb32da4ee Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Tue, 15 Feb 2022 15:04:12 +0000
Subject: [PATCH] docs: update migration docs for upgrade proposal in relation
 to ICS27 (#920) (#923)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Description

closes: #XXXX

---

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](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] 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

(cherry picked from commit d31f92d9bf709f5550b75db5c70a3b44314d9781)

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
---
 docs/migrations/v2-to-v3.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/docs/migrations/v2-to-v3.md b/docs/migrations/v2-to-v3.md
index 710e273a954..9b7615974c0 100644
--- a/docs/migrations/v2-to-v3.md
+++ b/docs/migrations/v2-to-v3.md
@@ -28,6 +28,33 @@ The ICS4Wrapper should be the IBC Channel Keeper unless ICS 20 is being connecte
 ICS27 Interchain Accounts has been added as a supported IBC application of ibc-go.
 Please see the [ICS27 documentation](../app-modules/interchain-accounts/overview.md) for more information.
 
+### Upgrade Proposal
+
+If the chain will adopt ICS27, it must set the appropriate params during the execution of the upgrade handler in `app.go`: 
+```go
+app.UpgradeKeeper.SetUpgradeHandler("v3",
+    func(ctx sdk.Context, _ upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
+        // set ICS27 Host submodule params
+        app.ICAHostKeeper.SetParams(ctx, icahosttypes.Params{
+            HostEnabled: true, 
+            AllowMessages: []string{"/cosmos.bank.v1beta1.MsgSend", ...], 
+        })
+
+        // set ICS27 Controller submodule params
+        app.ICAControllerKeeper.SetParams(ctx, icacontrollertypes.Params{
+            ControllerEnabled: true, 
+        })
+        
+        ...
+
+        return app.mm.RunMigrations(ctx, app.configurator, fromVM)
+    })
+
+```
+
+The host and controller submodule params only need to be set if you integrate those submodules. 
+For example, if a chain chooses not to integrate a controller submodule, it does not need to set the controller params. 
+
 ## IBC Apps