diff --git a/docs/modules/README.md b/docs/modules/README.md index 5f37809980d..74a822bd6ce 100644 --- a/docs/modules/README.md +++ b/docs/modules/README.md @@ -9,5 +9,5 @@ Updated Modules in V8 Rho ## New Modules in Rho V8 - [Global Fee](./globalfee.md) - [Group](./group.md) -- [ICA-Mauth](./icamauth/) +- [ICA-Mauth](./icamauth.md) diff --git a/docs/modules/icamauth/README.md b/docs/modules/icamauth.md similarity index 91% rename from docs/modules/icamauth/README.md rename to docs/modules/icamauth.md index 7a0c23ae64f..1b577fbd5e1 100644 --- a/docs/modules/icamauth/README.md +++ b/docs/modules/icamauth.md @@ -14,7 +14,7 @@ The following command allows you to query all the allowed message types on a hos gaiad q interchain-accounts host params ``` -The following tutorial will demonstrate how to use Interchain Accounts through the [icamauth module](../../../x/icamauth). +The following tutorial will demonstrate how to use Interchain Accounts through the [icamauth module](../../x/icamauth). ## Setup preparation We will run two Cosmos-SDK chains (controller chain: `test-0` and host chain: `test-1`) and a relayer to connect these two chains. We will create an account on chain `test-0` and call it `alice`, and register an Interchain Account (that we'll call `alice_ica`) on chain `test-1` for `alice` on chain `test-0`. We will also create a standard account, `bob` on chain `test-1`. @@ -26,15 +26,20 @@ Through these 3 accounts, we can test if: ### Prepare to run two chains We've simplified the setup process via several shell scripts. If you'd like to learn more about what's happening under the hood we suggest you inspect the files more closely. -Set up the two chains, create the keys for `alice` and `bob`, and start running both chains in different terminals: +Set up the two chains by [`init_chain_controller.sh`](https://github.com/cosmos/gaia/blob/main/docs/modules/icamauth_scripts/init_chain_controller.sh) and [`init_chain_host.sh`](https://github.com/cosmos/gaia/blob/main/docs/modules/icamauth_scripts/init_chain_host.sh), create the keys for `alice` and `bob`, and start running both chains in different terminals: ```shell -source ./docs/modules/icamauth/init_chain_controller.sh +cd gaia + +source ./docs/modules/icamauth_scripts/init_chain_controller.sh ``` -and ni another temrinal: +and in another terminal: ```shell -source ./docs/modules/icamauth/init_chain_host.sh +cd gaia + +source ./docs/modules/icamauth_scripts/init_chain_host.sh ``` + ### Setting up a Hermes relayer You can download or build the Hermes binary from the source code. #### Download the Hermes binary @@ -65,9 +70,9 @@ export PATH="$HOME/.hermes/bin:$PATH" ``` #### Create the IBC connection -Run the following command in `gaia/docs/modules/icamauth` directory to create an IBC connection: +Run the following script [`gaia/docs/modules/icamauth_scripts/hermes_setup.sh`](https://github.com/cosmos/gaia/blob/main/docs/modules/icamauth_scripts/hermes_setup.sh) to create an IBC connection: ```shell -cd ./docs/modules/icamauth +cd ./docs/modules/icamauth_scripts source hermes_setup.sh ``` @@ -168,7 +173,7 @@ gaiad tx bank send $BOB $ALICE_ICA 100stake --gas-prices 0.025stake --home $HOME Create a new IBC channel using Hermes: ```shell - hermes --config ./docs/modules/icamauth/rly-config.toml create channel --a-chain test-0 --a-connection connection-0 --a-port transfer --b-port transfer +hermes --config ./docs/modules/icamauth_scripts/rly-config.toml create channel --a-chain test-0 --a-connection connection-0 --a-port transfer --b-port transfer ``` Initiate the IBC token transfer: diff --git a/docs/modules/icamauth/hermes_setup.sh b/docs/modules/icamauth_scripts/hermes_setup.sh similarity index 100% rename from docs/modules/icamauth/hermes_setup.sh rename to docs/modules/icamauth_scripts/hermes_setup.sh diff --git a/docs/modules/icamauth/init_chain_controller.sh b/docs/modules/icamauth_scripts/init_chain_controller.sh similarity index 97% rename from docs/modules/icamauth/init_chain_controller.sh rename to docs/modules/icamauth_scripts/init_chain_controller.sh index fb436ed9d1d..21d0da70533 100644 --- a/docs/modules/icamauth/init_chain_controller.sh +++ b/docs/modules/icamauth_scripts/init_chain_controller.sh @@ -2,7 +2,7 @@ BINARY=$(which gaiad) # please do not reveal your mnemonic in production !!! -MNEMONIC_RLY0=`cat docs/modules/icamauth/rly0-mnemonic.txt` +MNEMONIC_RLY0=`cat docs/modules/icamauth_scripts/rly0-mnemonic.txt` MNEMONIC_ALICE="captain six loyal advice caution cost orient large mimic spare radar excess quote orchard error biology choice shop dish master quantum dumb accident between" CHAINID_0=test-0 HOME_0=$HOME/test-0 diff --git a/docs/modules/icamauth/init_chain_host.sh b/docs/modules/icamauth_scripts/init_chain_host.sh similarity index 97% rename from docs/modules/icamauth/init_chain_host.sh rename to docs/modules/icamauth_scripts/init_chain_host.sh index 2d718824a86..3a31b8dcc81 100644 --- a/docs/modules/icamauth/init_chain_host.sh +++ b/docs/modules/icamauth_scripts/init_chain_host.sh @@ -2,7 +2,7 @@ BINARY=$(which gaiad) # please do not reveal your mnemonic in production !!! -MNEMONIC_RLY1=`cat docs/modules/icamauth/rly1-mnemonic.txt` +MNEMONIC_RLY1=`cat docs/modules/icamauth_scripts/rly1-mnemonic.txt` MNEMONIC_BOB="uphold train large action document mixed exact cherry input evil sponsor digital used child engine fire attract sing little jeans decrease despair unfair what" CHAINID_1=test-1 HOME_1=$HOME/test-1 diff --git a/docs/modules/icamauth/rly-config.toml b/docs/modules/icamauth_scripts/rly-config.toml similarity index 100% rename from docs/modules/icamauth/rly-config.toml rename to docs/modules/icamauth_scripts/rly-config.toml diff --git a/docs/modules/icamauth/rly0-mnemonic.txt b/docs/modules/icamauth_scripts/rly0-mnemonic.txt similarity index 100% rename from docs/modules/icamauth/rly0-mnemonic.txt rename to docs/modules/icamauth_scripts/rly0-mnemonic.txt diff --git a/docs/modules/icamauth/rly1-mnemonic.txt b/docs/modules/icamauth_scripts/rly1-mnemonic.txt similarity index 100% rename from docs/modules/icamauth/rly1-mnemonic.txt rename to docs/modules/icamauth_scripts/rly1-mnemonic.txt