Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cosmos/relayer

An IBC relayer for ibc-go
https://github.com/cosmos/relayer

Last synced: 2 months ago
JSON representation

An IBC relayer for ibc-go

Lists

README 

        


  
Relayer



![banner](./docs/images/comp.gif)



[![Project Status: Initial Release](https://img.shields.io/badge/repo%20status-active-green.svg?style=flat-square)](https://www.repostatus.org/#active)

![GitHub Workflow Status](https://github.com/cosmos/relayer/actions/workflows/build.yml/badge.svg)

[![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://godoc.org/github.com/cosmos/relayer)

[![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/relayer)](https://goreportcard.com/report/github.com/cosmos/relayer)

[![License: Apache-2.0](https://img.shields.io/github/license/cosmos/relayer.svg?style=flat-square)](https://github.com/cosmos/relayer/blob/main/LICENSE)

[![Lines Of Code](https://img.shields.io/tokei/lines/github/cosmos/relayer?style=flat-square)](https://github.com/cosmos/relayer)

[![Version](https://img.shields.io/github/tag/cosmos/relayer.svg?style=flat-square)](https://github.com/cosmos/relayer/releases/latest)




In IBC, blockchains do not directly pass messages to each other over the network. This is where `relayer` comes in.

A relayer process monitors for updates on opens paths between sets of [IBC](https://ibcprotocol.org/) enabled chains.

The relayer submits these updates in the form of specific message types to the counterparty chain. Clients are then used to

track and verify the consensus state.



In addition to relaying packets, this relayer can open paths across chains, thus creating clients, connections and channels.



Additional information on how IBC works can be found [here](https://ibc.cosmos.network/).



---



## Table Of Contents

- [Basic Usage - Relaying Across Chains](#basic-usage---relaying-packets-across-chains)

- [Create Path Across Chains](./docs/create-path-across-chain.md)

- [Advanced Usage](./docs/advanced_usage.md)

- [Troubleshooting](./docs/troubleshooting.md)

- [Features](./docs/features.md)

- [Relayer Terminology](./docs/terminology.md)

- [New Chain Implementation](./docs/chain_implementation.md)

- [Recommended Pruning Settings](./docs/node_pruning.md)

- [Demo/Dev-Environment](./examples/README.md)



---



## Basic Usage - Relaying Packets Across Chains



> The `-h` (help) flag tailing any `rly` command will be your best friend. USE THIS IN YOUR RELAYING JOURNEY.



---



1. **Clone, checkout and install the latest release ([releases page](https://github.com/cosmos/relayer/releases)).**



   *[Go](https://go.dev/doc/install) needs to be installed and a proper Go environment needs to be configured*



    ```shell

    $ git clone https://github.com/cosmos/relayer.git

    $ cd relayer && git checkout v2.5.2

    $ make install

    ```



2. **Initialize the relayer's configuration directory/file.**



   ```shell

   $ rly config init

   ```

   **Default config file location:** `~/.relayer/config/config.yaml`



   By default, transactions will be relayed with a memo of `rly(VERSION)` e.g. `rly(v2.5.2)`.



   To customize the memo for all relaying, use the `--memo` flag when initializing the configuration.



   ```shell

   $ rly config init --memo "My custom memo"

   ```



   Custom memos will have `rly(VERSION)` appended. For example, a memo of `My custom memo` running on relayer version `v2.5.2` would result in a transaction memo of `My custom memo | rly(v2.5.2)`.



   The `--memo` flag is also available for other `rly` commands also that involve sending transactions such as `rly tx link` and `rly start`. It can be passed there to override the `config.yaml` value if desired.



   To omit the memo entirely, including the default value of `rly(VERSION)`, use `-` for the memo.



3. **Configure the chains you want to relay between.**



   In our example, we will configure the relayer to operate on the canonical path between the Cosmos Hub and Osmosis.

   


   The `rly chains add` command fetches chain meta-data from the [chain-registry](https://github.com/cosmos/chain-registry) and adds it to your config file.



   ```shell

   $ rly chains add cosmoshub osmosis

   ```



   Adding chains from the chain-registry randomly selects an RPC address from the registry entry.

   If you are running your own node, manually go into the config and adjust the `rpc-addr` setting.



   > NOTE: `rly chains add` will check the liveliness of the available RPC endpoints for that chain in the chain-registry.

   > It is possible that the command will fail if none of these RPC endpoints are available. In this case, you will want to manually add the chain config.



   To add the chain config files manually, example config files have been included [here](https://github.com/cosmos/relayer/tree/main/docs/example-configs/)

   ```shell

   $ rly chains add --url https://raw.githubusercontent.com/cosmos/relayer/main/docs/example-configs/cosmoshub-4.json cosmoshub

   $ rly chains add --url https://raw.githubusercontent.com/cosmos/relayer/main/docs/example-configs/osmosis-1.json osmosis

   ```



4. **Import OR create new keys for the relayer to use when signing and relaying transactions.**



   >`key-name` is an identifier of your choosing.



   If you need to generate a new private key you can use the `add` subcommand.



    ```shell

    $ rly keys add cosmoshub [key-name]

    $ rly keys add osmosis [key-name]

    ```



   If you already have a private key and want to restore it from your mnemonic you can use the `restore` subcommand.



   ```shell

   $ rly keys restore cosmoshub [key-name] "mnemonic words here"

   $ rly keys restore osmosis [key-name] "mnemonic words here"

   ```



5. **Use the `key-name` created above.**



   >This step is necessary if you chose a `key-name` other than "default"



    ```shell

    $ rly keys use cosmoshub [key-name]

    $ rly keys use osmosis [key-name]

    ```



6. **Ensure the keys associated with the configured chains are funded.**



   >Your configured addresses will need to contain some of the respective native tokens for paying relayer fees.



   


   You can query the balance of each configured key by running:



   ```shell

   $ rly q balance cosmoshub

   $ rly q balance osmosis

   ```



7. **Configure path meta-data in config file.**

   


   We have the chain meta-data configured, now we need path meta-data. For more info on `path` terminology visit [here](docs/troubleshooting.md).

   >NOTE: Thinking of chains in the config as "source" and "destination" can be confusing. Be aware that most path are bi-directional.



   



   `rly paths fetch` will check for IBC path meta data from the [chain-registry](https://github.com/cosmos/chain-registry/tree/master/_IBC) and add these paths to your config file.



     ```shell

     $ rly paths fetch

     ```

   > **NOTE:** Don't see the path metadata for paths you want to relay on?

   > Please open a PR to add this metadata to the GitHub repo!



8. #### **Configure the channel filter.**



   By default, the relayer will relay packets over all channels on a given connection.

   


   Each path has a `src-channel-filter` which you can utilize to specify which channels you would like to relay on.

   


   The `rule` can be one of three values:

   - `allowlist` which tells the relayer to relay on _ONLY_ the channels in `channel-list`

   - `denylist` which tells the relayer to relay on all channels _BESIDES_ the channels in `channel-list`

   - empty value, which is the default setting, and tells the relayer to relay on all channels

   



   Since we are only worried about the canonical channel between the Cosmos Hub and Osmosis our filter settings would look like the following.

   


   Example:

   ```yaml

   hubosmo:

      src:

          chain-id: cosmoshub-4

          client-id: 07-tendermint-259

          connection-id: connection-257

      dst:

          chain-id: osmosis-1

          client-id: 07-tendermint-1

          connection-id: connection-1

      src-channel-filter:

              rule: allowlist

              channel-list: [channel-141]

   ```



   >Because two channels between chains are tightly coupled, there is no need to specify the dst channels.

   >If you only know the "dst" channel-ID you can query the "src" channel-ID by running: `rly q channel    | jq '.channel.counterparty.channel_id'`



10. **Finally, we start the relayer on the desired path.**



     The relayer will periodically update the clients and listen for IBC messages to relay.



     ```shell

     $ rly paths list

     $ rly start [path]

     # Optionally you can omit the `path` argument to start all configured paths

     $ rly start

     ```



    >When running multiple instances of `rly start`, you will need to use the `--debug-addr` flag and provide an address:port. You can also pass an empty string `''`  to turn off this feature or pass `localhost:0` to randomly select a port.



    ---

    [[TROUBLESHOOTING](docs/troubleshooting.md)]

---



## Security Notice



If you would like to report a security bug related to the relayer repo,

please follow the instructions in [SECURITY.md](SECURITY.md).



## Code of Conduct



The Cosmos community is dedicated to providing an inclusive and harassment free

experience for contributors. Please visit [Code of Conduct](CODE_OF_CONDUCT.md) for more information.



---



[Create Path Across Chains -->](docs/create-path-across-chain.md)