allow Scaffolding Mode and Customization Mode

Author: PolkachuIntern

README.md

@@ -27,8 +27,23 @@ ansible-playbook main_hermes_install.yml
 
 ### Hermes deployment
 
-You will want to maintain your own `mainnet.toml.j2` file in the `hermes_config` playbook
+Here are two modes to deploy Hermes. For the Scaffolding Mode, you will specify a list of networks in the inventory file. For the Customization Mode, you will maintain your own jinja template.
+
+For both, you will need to specify `key_name`, `memo` and a list of target ips in the inventory file. Examples are provided in the sample file.
 
 ```bash
 ansible-playbook main_hermes_config.yml -e "target=mainnet"
+ansible-playbook main_hermes_config.yml -e "target=testnet"
 ```
+
+#### Scaffolding Mode
+
+This mode is suitable if you just want to get the relay going quickly among a few networks.
+
+You will fill in the list of networks you want to relay in the `mainnet_networks` or `testnet_networks` variables in the inventory file. The scaffolded config file will relay any channels among these networks.
+
+#### Customization Mode
+
+This mode is suitable when you connect lots of different networks and you want to fine-tune how they connect with each other.
+
+You will leave `mainnet_networks` or `testnet_networks` blank in the inventory file. You will customize the `mainnet.toml.j2` or `testnet.toml.j2` using our files as the starting point.

inventory.sample.ini

@@ -6,8 +6,11 @@ ansible_user=ubuntu
 ansible_port=22
 ansible_ssh_private_key_file="~/.ssh/id_rsa"
 
-# Relay Memo
-memo: 'Relayed by Polkachu'
+# Relay
+key_name="relayer"
+memo='Relayed by Polkachu'
+mainnet_networks=[]
+testnet_networks=[]
 
 # You will add more
 juno_ip="10.0.0.2"

roles/hermes_config/tasks/main.yml

@@ -6,13 +6,23 @@
     group: '{{ ansible_user }}'
     state: directory
 
-- name: Copy hermes config script
+- name: Copy hermes config script with customization
   template:
     src: '{{ target }}.toml.j2'
     dest: '/home/{{ ansible_user }}/.hermes/{{ target }}.toml'
     owner: '{{ ansible_user }}'
     group: '{{ ansible_user }}'
     mode: '0644'
+  when: mainnet_networks is not defined or mainnet_networks|length == 0
+
+- name: Copy hermes config script with scaffolding
+  template:
+    src: 'scaffold.toml.j2'
+    dest: '/home/{{ ansible_user }}/.hermes/{{ target }}.toml'
+    owner: '{{ ansible_user }}'
+    group: '{{ ansible_user }}'
+    mode: '0644'
+  when: mainnet_networks is defined and mainnet_networks|length > 0
 
 - name: create hermes systemd unit
   become: true

roles/hermes_config/templates/fragments/agoric.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/agoric.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws:/{{ agoric_ip }}:14457/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'agoric'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = { derivation = 'cosmos' }
 store_prefix = 'ibc'
 default_gas = 300000

roles/hermes_config/templates/fragments/akash.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/akash.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws:/{{ akash_ip }}:12857/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'akash'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = { derivation = 'cosmos' }
 store_prefix = 'ibc'
 default_gas = 100000

roles/hermes_config/templates/fragments/axelar.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/axelar.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws://{{ axelar_ip }}:15157/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'axelar'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = { derivation = 'cosmos' }
 store_prefix = 'ibc'
 default_gas = 200000

roles/hermes_config/templates/fragments/bitcanna.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/bitcanna.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws://{{ bitcanna_ip }}:13057/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'bcna'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 store_prefix = 'ibc'
 address_type = { derivation = 'cosmos' }
 default_gas = 100000

roles/hermes_config/templates/fragments/cheqd.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/cheqd.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws://{{ cheqd_ip }}:16157/websocket'
 
 rpc_timeout = '30s'
 account_prefix = 'cheqd'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = {derivation = 'cosmos'}
 store_prefix = 'ibc'
 default_gas = 1000000

roles/hermes_config/templates/fragments/chihuahua.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/chihuahua.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws://{{ chihuahua_ip }}:12957/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'chihuahua'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = { derivation = 'cosmos' }
 store_prefix = 'ibc'
 default_gas = 300000

roles/hermes_config/templates/fragments/cosmos.toml.j2 renamed to roles/hermes_config/templates/fragments/mainnet/cosmos.toml.j2

@@ -6,7 +6,7 @@ websocket_addr = 'ws://{{ cosmos_ip }}:14957/websocket'
 
 rpc_timeout = '20s'
 account_prefix = 'cosmos'
-key_name = 'relayer'
+key_name = '{{ key_name }}'
 address_type = { derivation = 'cosmos' }
 store_prefix = 'ibc'
 default_gas = 300000