From bbaec08b8616d7530d5d0e6e71708865ddea8090 Mon Sep 17 00:00:00 2001 From: DeepakBomjan Date: Fri, 11 Aug 2023 10:22:10 +0545 Subject: [PATCH 1/4] docs: add README for relay setup on localnet and testnet --- docs/running_relayer.md | 130 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 docs/running_relayer.md diff --git a/docs/running_relayer.md b/docs/running_relayer.md new file mode 100644 index 000000000..328e2103b --- /dev/null +++ b/docs/running_relayer.md @@ -0,0 +1,130 @@ +## Running ibc-relay +### Running relayer locally + +###### Prerequisites +- Go version: 1.19 +- Setup go environment + ``` + export GOROOT=/usr/local/bin/go/go-1.9 + export GOPATH=/opt/go/packages + export PATH=$PATH:$GOROOT/bin:$GOPATH/bin + ``` +- Install goloop + ``` + go install github.com/icon-project/goloop/cmd/goloop@latest + ``` + + +### Build relay +- Run below command to build the relay + ``` + make build + ``` +- To build and install the relayer binary + ``` + make install + ``` + + +### Relay configuration + +Within this setup for a local relayer, we will establish the configuration of the relay with both the ICON and Archway local nodes. + +- Modify environment variables in `const.sh`. + +- Clone icon-ibc-setup repo + ``` + git clone https://github.com/izyak/icon-ibc-setup.git + ``` +- Start nodes + ``` + make nodes + ``` +- Setup ICON node + ``` + make icon + ``` + +- Setup Archway node + ``` + make archway + ``` + +- Update relayer config file + `` + ake config + ``` +- Relay config file +
+ The following is an example configuration of a relayer. + + ``` + global: + api-listen-addr: :5183 + timeout: 10s + memo: "" + light-cache-size: 20 + chains: + archway: + type: archway + value: + key-directory: /home/.relayer/keys/constantine-3 + key: default + chain-id: constantine-3 + rpc-addr: https://rpc.constantine.archway.tech:443 + account-prefix: archway + keyring-backend: test + gas-adjustment: 1.5 + gas-prices: 1000000000000aconst + min-gas-amount: 1000000 + debug: true + timeout: 20s + block-timeout: "" + output-format: json + sign-mode: direct + extra-codecs: [] + coin-type: 0 + broadcast-mode: batch + ibc-handler-address: + first-retry-block-after: 0 + icon: + type: icon + value: + key: "" + chain-id: ibc-icon + rpc-addr: https://berlin.net.solidwallet.io/api/v3/ + timeout: 30s + keystore: /home/.relayer/keystore/godWallet.json + password: **** + icon-network-id: 1 + btp-network-id: 2 + btp-network-type-id: 1 + start-btp-height: 0 + ibc-handler-address: + first-retry-block-after: 0 + paths: + icon-archway: + src: + chain-id: + client-id: + dst: + chain-id: + client-id: + src-channel-filter: + rule: "" + channel-list: [] + ``` +
+ +Prior to executing the relayer, ensure that the relay configuration file is accurately and properly configured. + +### Running Relayer + +- Start link + ``` + rly tx link icon-archway --client-tp=10000m --src-port mock --dst-port mock -d + ``` +- Run relayer + ``` + rly start icon-archway + ``` From a3c2936bbf16922efb5d92d10c591d925d45a1c7 Mon Sep 17 00:00:00 2001 From: DeepakBomjan Date: Fri, 11 Aug 2023 10:47:38 +0545 Subject: [PATCH 2/4] docs: running relayer locally --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b21c91a14..f934a0bbf 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Additional information on how IBC works can be found [here](https://ibc.cosmos.n - [New Chain Implementation](./docs/chain_implementation.md) - [Recommended Pruning Settings](./docs/node_pruning.md) - [Demo/Dev-Environmnet](./examples/README.md) +- [Running Relayer Locally](./docs/running_relayer.md) --- ## Basic Usage - Relaying Packets Across Chains From 22169f452c3f8e1b96decb4af654ea14f927f90b Mon Sep 17 00:00:00 2001 From: DeepakBomjan Date: Mon, 14 Aug 2023 15:46:11 +0545 Subject: [PATCH 3/4] docs: update reference --- README.md | 2 +- docs/running_relayer.md | 130 ---------------------------------------- 2 files changed, 1 insertion(+), 131 deletions(-) delete mode 100644 docs/running_relayer.md diff --git a/README.md b/README.md index f934a0bbf..94fd45d3a 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Additional information on how IBC works can be found [here](https://ibc.cosmos.n - [New Chain Implementation](./docs/chain_implementation.md) - [Recommended Pruning Settings](./docs/node_pruning.md) - [Demo/Dev-Environmnet](./examples/README.md) -- [Running Relayer Locally](./docs/running_relayer.md) +- [Running Relayer Locally](https://github.com/izyak/icon-ibc/blob/master/README.md) --- ## Basic Usage - Relaying Packets Across Chains diff --git a/docs/running_relayer.md b/docs/running_relayer.md deleted file mode 100644 index 328e2103b..000000000 --- a/docs/running_relayer.md +++ /dev/null @@ -1,130 +0,0 @@ -## Running ibc-relay -### Running relayer locally - -###### Prerequisites -- Go version: 1.19 -- Setup go environment - ``` - export GOROOT=/usr/local/bin/go/go-1.9 - export GOPATH=/opt/go/packages - export PATH=$PATH:$GOROOT/bin:$GOPATH/bin - ``` -- Install goloop - ``` - go install github.com/icon-project/goloop/cmd/goloop@latest - ``` - - -### Build relay -- Run below command to build the relay - ``` - make build - ``` -- To build and install the relayer binary - ``` - make install - ``` - - -### Relay configuration - -Within this setup for a local relayer, we will establish the configuration of the relay with both the ICON and Archway local nodes. - -- Modify environment variables in `const.sh`. - -- Clone icon-ibc-setup repo - ``` - git clone https://github.com/izyak/icon-ibc-setup.git - ``` -- Start nodes - ``` - make nodes - ``` -- Setup ICON node - ``` - make icon - ``` - -- Setup Archway node - ``` - make archway - ``` - -- Update relayer config file - `` - ake config - ``` -- Relay config file -
- The following is an example configuration of a relayer. - - ``` - global: - api-listen-addr: :5183 - timeout: 10s - memo: "" - light-cache-size: 20 - chains: - archway: - type: archway - value: - key-directory: /home/.relayer/keys/constantine-3 - key: default - chain-id: constantine-3 - rpc-addr: https://rpc.constantine.archway.tech:443 - account-prefix: archway - keyring-backend: test - gas-adjustment: 1.5 - gas-prices: 1000000000000aconst - min-gas-amount: 1000000 - debug: true - timeout: 20s - block-timeout: "" - output-format: json - sign-mode: direct - extra-codecs: [] - coin-type: 0 - broadcast-mode: batch - ibc-handler-address: - first-retry-block-after: 0 - icon: - type: icon - value: - key: "" - chain-id: ibc-icon - rpc-addr: https://berlin.net.solidwallet.io/api/v3/ - timeout: 30s - keystore: /home/.relayer/keystore/godWallet.json - password: **** - icon-network-id: 1 - btp-network-id: 2 - btp-network-type-id: 1 - start-btp-height: 0 - ibc-handler-address: - first-retry-block-after: 0 - paths: - icon-archway: - src: - chain-id: - client-id: - dst: - chain-id: - client-id: - src-channel-filter: - rule: "" - channel-list: [] - ``` -
- -Prior to executing the relayer, ensure that the relay configuration file is accurately and properly configured. - -### Running Relayer - -- Start link - ``` - rly tx link icon-archway --client-tp=10000m --src-port mock --dst-port mock -d - ``` -- Run relayer - ``` - rly start icon-archway - ``` From 6222af120cb15d0be68cfb35237b61d3a5236395 Mon Sep 17 00:00:00 2001 From: izyak Date: Tue, 15 Aug 2023 08:28:38 +0545 Subject: [PATCH 4/4] chore: remove demo/dev environmtn --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 94fd45d3a..6d023ea23 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ Additional information on how IBC works can be found [here](https://ibc.cosmos.n - [Relayer Terminology](./docs/terminology.md) - [New Chain Implementation](./docs/chain_implementation.md) - [Recommended Pruning Settings](./docs/node_pruning.md) -- [Demo/Dev-Environmnet](./examples/README.md) - [Running Relayer Locally](https://github.com/izyak/icon-ibc/blob/master/README.md) ---