Merge branch 'main' into colin/606-remove-proof-spec

cosmos · Dec 15, 2021 · 6d71da6 · 6d71da6
2 parents e02e96a + c0277d2
commit 6d71da6
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 6 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -124,9 +124,19 @@ module.exports = {
           title: "Migrations",
           children: [
             {
-              title: "v0.43 SDK to IBC-Go v1.0.0",
+              title: "SDK v0.43 to IBC-Go v1",
               directory: false,
-              path: "/migrations/ibc-migration-043.html"
+              path: "/migrations/sdk-to-v1.html"
+            },
+            {
+              title: "IBC-Go v1 to v2",
+              directory: false,
+              path: "/migrations/v1-to-v2.html"
+            },
+            {
+              title: "IBC-Go v2 to v3",
+              directory: false,
+              path: "/migrations/v2-to-v3.html"
             },
           ]
         },

diff --git a/docs/app_modules/interchain-accounts/integration.md b/docs/app_modules/interchain-accounts/integration.md
@@ -124,6 +124,49 @@ app.mm.SetOrderInitGenesis(
 )
 ```
 
-### Interchain Accounts on-chain parameters
+## Parameters
 
-#### Example Initialization of parameters
+The Interchain Accounts module contains the following on-chain parameters, logically separated for each distinct submodule:
+
+### Controller Submodule Parameters
+
+| Key                    | Type | Default Value |
+|------------------------|------|---------------|
+| `ControllerEnabled`    | bool | `true`        |
+
+#### ControllerEnabled
+
+The `ControllerEnabled` parameter controls a chains ability to service ICS-27 controller specific logic. This includes the sending of Interchain Accounts packet data as well as the following ICS-26 callback handlers:
+- `OnChanOpenInit`
+- `OnChanOpenAck`
+- `OnChanCloseConfirm`
+- `OnAcknowledgementPacket`
+- `OnTimeoutPacket`
+
+### Host Submodule Parameters
+
+| Key                    | Type     | Default Value |
+|------------------------|----------|---------------|
+| `HostEnabled`          | bool     | `true`        |
+| `AllowMessages`        | []string | `[]`          |
+
+#### HostEnabled
+
+The `HostEnabled` parameter controls a chains ability to service ICS27 host specific logic. This includes the following ICS-26 callback handlers:
+- `OnChanOpenTry`
+- `OnChanOpenConfirm`
+- `OnChanCloseConfirm`
+- `OnRecvPacket`
+
+#### AllowMessages
+
+The `AllowMessages` parameter provides the ability for a chain to limit the types of messages or transactions that it chooses to facilitate by defining an allowlist using the Protobuf message TypeURL format.
+
+For example, a Cosmos SDK based chain that elects to provide hosted Interchain Accounts with the ability of governance voting and staking delegations will define its parameters as follows:
+
+```
+"params": {
+    "host_enabled": true,
+    "allow_messages": ["/cosmos.staking.v1beta1.MsgDelegate", "/cosmos.gov.v1beta1.MsgVote"]
+}
+```
diff --git a/docs/migrations/ibc-migration-043.md → docs/migrations/sdk-to-v1.md b/docs/migrations/ibc-migration-043.md → docs/migrations/sdk-to-v1.md
diff --git a/docs/migrations/ibc-migration-v100.md → docs/migrations/v1-to-v2.md b/docs/migrations/ibc-migration-v100.md → docs/migrations/v1-to-v2.md
@@ -1,4 +1,4 @@
-# Migrating from ibc-go v1.x.x to v2.0.0
+# Migrating from ibc-go v1 to v2
 
 This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG.
 Any changes that must be done by a user of ibc-go should be documented here.

diff --git a/docs/migrations/v2-to-v3.md b/docs/migrations/v2-to-v3.md
@@ -1,4 +1,4 @@
-# Migrating from v2.0.0 to v3.0.0
+# Migrating from ibc-go v2 to v3
 
 This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG.
 Any changes that must be done by a user of ibc-go should be documented here.