docs: migration docs v4 to v5 (#1826) (#2386)

* wip: migration docs v4 to v5 * adding some code diffs * adding more code snippets and diffs * add link to docs * fix alignment * fix alignment * fix alignment * fix typo * code improvement * add links to sections in the document * add migration docs for #2058 * added link to PR that renamed the ante decorator * changes for #2083 * docs: updating migration docs with additional ics27 host parameter (#2309) * updating migration docs with additional ics27 host parameter * fix indentation Co-authored-by: colin axnér <[email protected]> Co-authored-by: Damian Nolan <[email protected]> (cherry picked from commit a278287) Co-authored-by: Carlos Rodriguez <[email protected]>
cosmos · Sep 26, 2022 · c1113f8 · c1113f8
1 parent f4d010e
commit c1113f8
Show file tree

Hide file tree

Showing 5 changed files with 437 additions and 5 deletions.
diff --git a/docs/apps/interchain-accounts/auth-modules.md b/docs/apps/interchain-accounts/auth-modules.md
@@ -272,7 +272,7 @@ Auth modules are expected to know how to decode the acknowledgement.
 
 If the controller chain is connected to a host chain using the host module on ibc-go, it may interpret the acknowledgement bytes as follows:
 
-Begin by unmarshaling the acknowledgement into sdk.TxMsgData:
+Begin by unmarshaling the acknowledgement into `sdk.TxMsgData`:
 ```go
 var ack channeltypes.Acknowledgement
 if err := channeltypes.SubModuleCdc.UnmarshalJSON(acknowledgement, &ack); err != nil {

diff --git a/docs/architecture/adr-003-ics27-acknowledgement.md b/docs/architecture/adr-003-ics27-acknowledgement.md
@@ -72,7 +72,7 @@ A forwards compatible approach was deemed infeasible.
 The `handler` provided by the `MsgServiceRouter` will only include the `*sdk.Result` and an error (if one occurred). 
 In v0.45 of the SDK, the `*sdk.Result.Data` will contain the MsgResponse marshaled data. 
 However, the MsgResponse is not packed and marshaled as a `*codectypes.Any`, thus making it impossible from a generalized point of view to unmarshal the bytes. 
-If the bytes could be unmarshaled, then they could be packed into an `*codectypes.Any` in antcipation of the upcoming format.  
+If the bytes could be unmarshaled, then they could be packed into an `*codectypes.Any` in anticipation of the upcoming format.  
 
 Intercepting the MsgResponse before it becomes marshaled requires replicating this [code](https://github.com/cosmos/cosmos-sdk/blob/dfd47f5b449f558a855da284a9a7eabbfbad435d/baseapp/msg_service_router.go#L109-#L128). 
 It may not even be possible to replicate the linked code. The method handler would need to be accessed somehow.

diff --git a/docs/migrations/v2-to-v3.md b/docs/migrations/v2-to-v3.md
@@ -79,7 +79,6 @@ This ensures that the new module's stores are added to the multistore before the
 The host and controller submodule keys only need to be added if the chain integrates those submodules.
 For example, if a chain chooses not to integrate a controller submodule, it does not need to add the controller key to the `Added` field.
 
-
 ### Genesis migrations
 
 If the chain will adopt ICS27 and chooses to upgrade via a genesis export, then the ICS27 parameters must be set during genesis migration. 
@@ -124,7 +123,6 @@ type AnteDecorator struct {
 
 ## IBC Apps
 
-
 ### `OnChanOpenTry` must return negotiated application version
 
 The `OnChanOpenTry` application callback has been modified.