More content to tutorial (#542)

informalsystems · Jan 29, 2021 · fa94412 · fa94412
1 parent d8f5995
commit fa94412
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 79 deletions.
diff --git a/guide/book.toml b/guide/book.toml
@@ -3,7 +3,7 @@ authors = ["Informal Systems Inc."]
 language = "en"
 multilingual = false
 src = "src"
-title = "IBC Relayer (Rust)"
+title = "Hermes Documentation"
 
 [preprocessor]
 [preprocessor.mermaid]

diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md
@@ -1,6 +1,6 @@
 # Summary
 
-# IBC Relayer Guide
+# Hermes (IBC Relayer)
 
 ---
 - [Introduction](./index.md)
@@ -11,8 +11,8 @@
    - [Configuration](./config.md)
 - [Tutorials](./tutorials.md)
    - [Two Local Chains](./two_chains.md)
-     - [Install Gaia](./gaia.md)
-     - [Start local chains](./local_chains.md)
+     - [Installing Gaia](./gaia.md)
+     - [Starting the local chains](./local_chains.md)
      - [Relaying packets](./relay_packets.md)
 - [Commands Reference](./commands.md)
    - [Keys](./keys.md)

diff --git a/guide/src/local_chains.md b/guide/src/local_chains.md
@@ -10,6 +10,48 @@ cd ibc-rs
 
 In order to run the script, you will need a `TOML` configuration file to be passed as a parameter. Please check the [`Configuration`](./config.md) section for more information about the relayer configuration file.
 
+The following configuration file can be used for running the local chains:
+
+##### loop_config.toml
+```toml
+[global]
+timeout = '10s'
+strategy = 'naive'
+log_level = 'error'
+
+[[chains]]
+id = 'ibc-0'
+rpc_addr = 'tcp://localhost:26657'
+grpc_addr = 'tcp://localhost:9090'
+account_prefix = 'cosmos'
+key_name = 'testkey'
+store_prefix = 'ibc'
+
+gas = 200000
+max_msg_num = 4
+max_tx_size = 1048576
+clock_drift = '5s'
+trusting_period = '14days'
+
+[chains.trust_threshold]
+numerator = '1'
+denominator = '3'
+
+[[chains]]
+id = 'ibc-1'
+rpc_addr = 'tcp://localhost:26557'
+grpc_addr = 'tcp://localhost:9091'
+account_prefix = 'cosmos'
+key_name = 'testkey'
+store_prefix = 'ibc'
+clock_drift = '5s'
+trusting_period = '14days'
+
+[chains.trust_threshold]
+numerator = '1'
+denominator = '3'
+```
+
 #### Stop and cleanup
 
 If this is not the first time you are running the script, you can manually stop the two gaia instances and clean up the data executing the following commands:
@@ -24,7 +66,7 @@ rm -rf data/
 Run the following script with the parameters below to start the chains:
 
 ```bash
-./dev-env two_chains.toml ibc-0 ibc-1
+./dev-env loop_config.toml ibc-0 ibc-1
 ```
 
 The script will configure and start two `gaiad` instances, one named `ibc-0` and the other `ibc-1`