docs: ica tx atomicity docs and code snippet updates (#719)

* adding parameters.md to ica docs * updating interchain accounts docs, adding parameters.md and transactions.md * updating formatting * correcting wording * adding diagram to docs/assets/ * fixing ChanOpenTry api in code snippet * fixing broken image link * updating wording * Update docs/app-modules/interchain-accounts/transactions.md Co-authored-by: Sean King <seantking@users.noreply.github.com> * Update docs/app-modules/interchain-accounts/transactions.md Co-authored-by: Sean King <seantking@users.noreply.github.com> * Update docs/app-modules/interchain-accounts/parameters.md Co-authored-by: Sean King <seantking@users.noreply.github.com> * updating as per review discussion * removing capitals in heading as per review Co-authored-by: Sean King <seantking@users.noreply.github.com>
cosmos · Jan 18, 2022 · bfcf9ab · bfcf9ab
1 parent 87b058d
commit bfcf9ab
Show file tree

Hide file tree

Showing 9 changed files with 1,012 additions and 772 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -109,17 +109,32 @@ module.exports = {
             {
               title: "Interchain Accounts",
               directory: true,
-              path: "/app_modules",
+              path: "/app-modules",
               children: [
                 {
                     title: "Overview",
                     directory: false,
-                    path: "/app_modules/interchain-accounts/overview.html"
+                    path: "/app-modules/interchain-accounts/overview.html"
                 }, 
+                {
+                  title: "Authentication Modules",
+                  directory: false,
+                  path: "/app-modules/interchain-accounts/auth-modules.html"
+                },
                 {
                     title: "Integration",
                     directory: false,
-                    path: "/app_modules/interchain-accounts/integration.html"
+                    path: "/app-modules/interchain-accounts/integration.html"
+                },
+                {
+                  title: "Parameters",
+                  directory: false,
+                  path: "/app-modules/interchain-accounts/parameters.html"
+                },
+                {
+                  title: "Transactions",
+                  directory: false,
+                  path: "/app-modules/interchain-accounts/transactions.html"
                 },
                 {
                     title: "Authentication module development",

diff --git a/...p_modules/interchain-accounts/ica_auth.md → ...dules/interchain-accounts/auth-modules.md b/...p_modules/interchain-accounts/ica_auth.md → ...dules/interchain-accounts/auth-modules.md
@@ -1,10 +1,12 @@
 <!--
-order: 3
+order: 2
 -->
 
-# Building an ICA authentication module
+# Building an authentication module
 
-The controller module is used for account registration and packet sending. 
+Authentication modules play the role of the `Base Application` as described in [ICS30 IBC Middleware](https://github.com/cosmos/ibc/tree/master/spec/app/ics-030-middleware), and enable application developers to perform custom logic when working with the Interchain Accounts controller API. {synopsis}
+
+The controller submodule is used for account registration and packet sending. 
 It executes only logic required of all controllers of interchain accounts. 
 The type of authentication used to manage the interchain accounts remains unspecified. 
 There may exist many different types of authentication which are desirable for different use cases. 
@@ -108,9 +110,8 @@ func (im IBCModule) OnChanOpenTry(
     channelID string,
     chanCap *capabilitytypes.Capability,
     counterparty channeltypes.Counterparty,
-    version,
     counterpartyVersion string,
-) error {
+) (string, error) {
     panic("UNIMPLEMENTED")
 }
 
@@ -142,26 +143,14 @@ func (im IBCModule) OnRecvPacket(
 ) ibcexported.Acknowledgement {
     panic("UNIMPLEMENTED")
 }
-
-// NegotiateAppVersion implements the IBCModule interface
-func (im IBCModule) NegotiateAppVersion(
-    ctx sdk.Context,
-    order channeltypes.Order,
-    connectionID string,
-    portID string,
-    counterparty channeltypes.Counterparty,
-    proposedVersion string,
-) (string, error) {
-    panic("UNIMPLEMENTED")
-}
 ```
 
 ## `InitInterchainAccount`
 
 The authentication module can begin registering interchain accounts by calling `InitInterchainAccount`:
 
 ```go
-if err := keeper.icaControllerKeeper.InitInterchainAccount(ctx, connectionID, counterpartyConnectionID, owner.String()); err != nil {
+if err := keeper.icaControllerKeeper.InitInterchainAccount(ctx, connectionID, owner.String()); err != nil {
     return err
 }
 
@@ -176,19 +165,18 @@ The authentication module can attempt to send a packet by calling `TrySendTx`:
 // Authenticate owner
 // perform custom logic
 
-// Lookup portID based on interchain account owner address
-portID, err := icatypes.GeneratePortID(owner.String(), connectionID, counterpartyConnectionID)
+// Construct controller portID based on interchain account owner address
+portID, err := icatypes.NewControllerPortID(owner.String())
 if err != nil {
     return err
 }
 
 channelID, found := keeper.icaControllerKeeper.GetActiveChannelID(ctx, portID)
 if !found {
-    return sdkerrors.Wrapf(icatypes.ErrActiveChannelNotFound, "failed to retrieve active channel for port %s", portId)
+    return sdkerrors.Wrapf(icatypes.ErrActiveChannelNotFound, "failed to retrieve active channel for port %s", portID)
 }
 
-// Obtain the channel capability. 
-// The channel capability should have been claimed by the authentication module in OnChanOpenInit
+// Obtain the channel capability, claimed in OnChanOpenInit
 chanCap, found := keeper.scopedKeeper.GetCapability(ctx, host.ChannelCapabilityPath(portID, channelID))
 if !found {
     return sdkerrors.Wrap(channeltypes.ErrChannelCapabilityNotFound, "module does not own channel capability")
@@ -215,7 +203,8 @@ packetData := icatypes.InterchainAccountPacketData{
 // If the packet times out, the channel will be closed requiring a new channel to be created 
 timeoutTimestamp := obtainTimeoutTimestamp()
 
-_, err = keeper.icaControllerKeeper.TrySendTx(ctx, chanCap, p, packetData, timeoutTimestamp)
+// Send the interchain accounts packet, returning the packet sequence
+seq, err = keeper.icaControllerKeeper.TrySendTx(ctx, chanCap, portID, packetData, timeoutTimestamp)
 ```
 
 The data within an `InterchainAccountPacketData` must be serialized using a format supported by the host chain. 

diff --git a/...odules/interchain-accounts/integration.md → ...odules/interchain-accounts/integration.md b/...odules/interchain-accounts/integration.md → ...odules/interchain-accounts/integration.md
@@ -1,10 +1,10 @@
 <!--
-order: 2
+order: 3
 -->
 
-# Integrating Interchain Accounts into a Chain
+# Integration
 
-Learn how to integrate Interchain Accounts host and controller functionality to your chain. The following document only applies for Cosmos SDK chains.
+Learn how to integrate Interchain Accounts host and controller functionality to your chain. The following document only applies for Cosmos SDK chains. {synopsis}
 
 The Interchain Accounts module contains two submodules. Each submodule has its own IBC application. The Interchain Accounts module should be registered as an `AppModule` in the same way all SDK modules are registered on a chain, but each submodule should create its own `IBCModule` as necessary. A route should be added to the IBC router for each submodule which will be used. 
 
@@ -122,51 +122,4 @@ app.mm.SetOrderInitGenesis(
     icatypes.ModuleName,
     ...
 )
-```
-
-## 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/...p_modules/interchain-accounts/overview.md → ...p-modules/interchain-accounts/overview.md b/...p_modules/interchain-accounts/overview.md → ...p-modules/interchain-accounts/overview.md
@@ -7,7 +7,7 @@ order: 1
 Learn about what the Interchain Accounts module is, and how to build custom modules that utilize Interchain Accounts functionality {synopsis}
 
 
-# What is the Interchain Accounts module?
+## What is the Interchain Accounts module?
 
 Interchain Accounts is the Cosmos SDK implementation of the ICS-27 protocol, which enables cross-chain account management built upon IBC. Chains using the Interchain Accounts module can programmatically create accounts on other chains and control these accounts via IBC transactions. 
 
@@ -19,14 +19,14 @@ Developers looking to build upon Interchain Accounts must write custom logic in
 
 Regular accounts use a private key to sign transactions on-chain. Interchain Accounts are instead controlled programmatically by separate chains via IBC transactions. Interchain Accounts are implemented as sub-accounts of the interchain accounts module account. 
 
-# Concepts 
+## Concepts 
 
-*Host Chain*: The chain where the interchain account is registered. The host chain listens for IBC packets from a controller chain which should contain instructions (e.g. cosmos SDK messages) for which the interchain account will execute.
+`Host Chain`: The chain where the interchain account is registered. The host chain listens for IBC packets from a controller chain which should contain instructions (e.g. cosmos SDK messages) for which the interchain account will execute.
 
-*Controller Chain*: The chain registering and controlling an account on a host chain. The controller chain sends IBC packets to the host chain to control the account. A controller chain must have at least one interchain accounts authentication module in order to act as a controller chain. 
+`Controller Chain`: The chain registering and controlling an account on a host chain. The controller chain sends IBC packets to the host chain to control the account. A controller chain must have at least one interchain accounts authentication module in order to act as a controller chain. 
 
-*Authentication Module*: A custom IBC application module on the controller chain that uses the Interchain Accounts module API to build custom logic for the creation & management of interchain accounts. For a controller chain to utilize the interchain accounts module functionality, an authentication module is required.
+`Authentication Module`: A custom IBC application module on the controller chain that uses the Interchain Accounts module API to build custom logic for the creation & management of interchain accounts. For a controller chain to utilize the interchain accounts module functionality, an authentication module is required.
 
-*Interchain Account*: An account on a host chain. An interchain account has all the capabilities of a normal account. However, rather than signing transactions with a private key, a controller chain's authentication module will send IBC packets to the host chain which signals what transactions the interchain account should execute.
+`Interchain Account`: An account on a host chain. An interchain account has all the capabilities of a normal account. However, rather than signing transactions with a private key, a controller chain's authentication module will send IBC packets to the host chain which signals what transactions the interchain account should execute.
 
 
diff --git a/docs/app-modules/interchain-accounts/parameters.md b/docs/app-modules/interchain-accounts/parameters.md
@@ -0,0 +1,50 @@
+<!--
+order: 4
+-->
+
+# 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 hosted interchain accounts are authorized to execute 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/app-modules/interchain-accounts/transactions.md b/docs/app-modules/interchain-accounts/transactions.md
@@ -0,0 +1,21 @@
+<!--
+order: 5
+-->
+
+# Transactions
+
+Learn about Interchain Accounts transaction execution {synopsis}
+
+## Executing a transaction
+
+As described in [Authentication Modules](./auth-modules.md#trysendtx) transactions are executed using the interchain accounts controller API and require a `Base Application` as outlined in [ICS30 IBC Middleware](https://github.com/cosmos/ibc/tree/master/spec/app/ics-030-middleware) to facilitate authentication. The method of authentication remains unspecified to provide flexibility for the authentication module developer.
+
+Transactions are executed via the ICS27 [`TrySendTx` API](./auth-modules.md#trysendtx). This must be invoked through an Interchain Accounts authentication module and follows the outlined path of execution below. Packet relaying semantics provided by the IBC core transport, authentication, and ordering (IBC/TAO) layer are omitted for brevity.
+
+![send-tx-flow](../../assets/send-interchain-tx.png "Transaction Execution")
+
+## Atomicity
+
+As the Interchain Accounts module supports the execution of multiple transactions using the Cosmos SDK `Msg` interface, it provides the same atomicity guarantees as Cosmos SDK-based applications, leveraging the [`CacheMultiStore`](https://docs.cosmos.network/master/core/store.html#cachemultistore) architecture provided by the [`Context`](https://docs.cosmos.network/master/core/context.html) type. 
+
+This provides atomic execution of transactions when using Interchain Accounts, where state changes are only committed if all `Msg`s succeed.
diff --git a/docs/assets/send-interchain-tx.png b/docs/assets/send-interchain-tx.png
diff --git a/docs/migrations/v2-to-v3.md b/docs/migrations/v2-to-v3.md
@@ -26,7 +26,7 @@ The ICS4Wrapper should be the IBC Channel Keeper unless ICS 20 is being connecte
 ### ICS27
 
 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.
+Please see the [ICS27 documentation](../app-modules/interchain-accounts/overview.md) for more information.
 
 ## IBC Apps