docs: fee middleware tutorial improvements (#4979)

* docs: removed duplicate code snippet * docs: consistent use of yaml vs yml * docs: using 'auto_register_counterparty_payee' * docs: added Fee Middleware docs to prereqs * docs: fixed broken link * docs: improved fee tutorial * imp: review item
cosmos · Oct 30, 2023 · aef6a3f · aef6a3f
1 parent 7267e07
commit aef6a3f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 22 deletions.
diff --git a/docs/tutorials/01-fee/01-intro.md b/docs/tutorials/01-fee/01-intro.md
@@ -16,10 +16,10 @@ This is a tutorial for wiring up the ICS-29 Fee Middleware to a Cosmos SDK block
 
 <HighlightBox type="prerequisite" title="Prerequisites">
 
-- Basic Knowledge of [Go](https://golang.org/doc/tutorial/getting-started)
-- Basic Knowledge of [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
+- Basic Knowledge of [TypeScript](https://www.typescriptlang.org/)
 - Basic Knowledge of Cosmos SDK
     - If you are new to Cosmos SDK, we recommend you to go through the first two categories of the [Developer Portal](https://tutorials.cosmos.network/academy/1-what-is-cosmos/)
+- Basic Knowledge of [the Fee Middleware module](https://ibc.cosmos.network/main/middleware/ics29-fee/overview)
 
 </HighlightBox>
 

diff --git a/docs/tutorials/01-fee/02-setup-env.md b/docs/tutorials/01-fee/02-setup-env.md
@@ -48,7 +48,13 @@ go version
 
 ## Hermes
 
-Install Hermes relayer version `v1.6.0` via cargo following the instructions on the [Hermes website](https://hermes.informal.systems/quick-start/installation.html#install-via-cargo). Test if Hermes is installed by running.
+Install Hermes relayer version `v1.6.0` via cargo following the instructions on the [Hermes website](https://hermes.informal.systems/quick-start/installation.html#install-via-cargo) or by using the command below.
+
+```bash
+cargo install ibc-relayer-cli --version 1.6.0 --bin hermes --locked
+```
+
+Test if Hermes is installed by running the following command:
 
 ```bash
 hermes version

diff --git a/docs/tutorials/01-fee/04-wire-feeibc-mod.md b/docs/tutorials/01-fee/04-wire-feeibc-mod.md
@@ -164,14 +164,6 @@ Next, we need to add the fee middleware to the `SetOrderBeginBlockers`, `SetOrde
 		consensusparamtypes.ModuleName,
 		// this line is used by starport scaffolding # stargate/app/endBlockers
 	)
-	app.mm.SetOrderEndBlockers(
-		// ... other modules
-		vestingtypes.ModuleName,
-		consensusparamtypes.ModuleName,
-		// plus-diff-line 
-+		ibcfeetypes.ModuleName,
-		// this line is used by starport scaffolding # stargate/app/endBlockers
-	)
 
 	// NOTE: The genutils module must occur after staking so that pools are
 	// properly initialized with tokens from genesis accounts.

diff --git a/docs/tutorials/01-fee/07-test-app.md b/docs/tutorials/01-fee/07-test-app.md
@@ -27,11 +27,11 @@ You can find the React app we created in the previous section [here](https://git
 Ignite supports running multiple chains locally with different configs. The source chain will be called earth and the destination chain will be called mars.
 Add the following config files to the root of the project:
 
-```yaml reference title="earth.yaml"
+```yaml reference title="earth.yml"
 https://github.com/srdtrk/cosmoverse2023-ibc-fee-demo/blob/96cb63bf2e60b4613a89841416066551dd666c0d/earth.yml
 ```
 
-```yaml reference title="mars.yaml"
+```yaml reference title="mars.yml"
 https://github.com/srdtrk/cosmoverse2023-ibc-fee-demo/blob/96cb63bf2e60b4613a89841416066551dd666c0d/mars.yml
 ```
 
@@ -50,7 +50,7 @@ ignite chain serve -c mars.yml --reset-once
 We first need to create a relayer configuration file. Add the following file to the root of the project:
 
 ```toml reference title="hermes/config.toml"
-https://github.com/srdtrk/cosmoverse2023-ibc-fee-demo/blob/960d8b7e148cbe2207c3a743bac7c0985a5b653a/hermes/config.toml
+https://github.com/srdtrk/cosmoverse2023-ibc-fee-demo/blob/0186b9ee979c288efbe3fe5fd071169d9dbcf91e/hermes/config.toml
 ```
 
 We can move this file to the `~/.hermes` directory to avoid having to specify the path to the config file every time we run the relayer:
@@ -105,15 +105,9 @@ hermes create channel --channel-version '{"fee_version":"ics29-1","app_version":
 ```
 
 This will create an incentivized IBC transfer channel between the two chains with the channel id `channel-0`, and channel version `{"fee_version":"ics29-1","app_version":"ics20-1"}`.
-Next recall that the Fee Middleware only pays fees on the source chain. That's why we should register `damian` and `charlie` as each other's counterparty on both chains.
-
-```bash title="Terminal 4"
-hermes fee register-counterparty-payee --chain mars --channel channel-0 --port transfer --counterparty-payee cosmos1vapwvcsr0m32ptal6z6g9hjctywrw4yzyf6y6v
-```
 
-```bash title="Terminal 4"
-hermes fee register-counterparty-payee --chain earth --channel channel-0 --port transfer --counterparty-payee cosmos1uu38gkyed0dte5f9xk20p8wcppulsjt90s7f8h
-```
+Next recall that the Fee Middleware only pays fees on the source chain. That's why we should register `damian` and `charlie` as each other's counterparty on both chains.
+Luckily, the relayer does this for us under the hood because we've enabled the `auto_register_counterparty_payee` option in the config file.
 
 Now we can run the relayer with the following command: