Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ilgooz/relayer


https://github.com/ilgooz/relayer

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Relayer



![GOZ](./docs/images/github-repo-banner.png)



![Relayer Build](https://github.com/ilgooz/relayer/workflows/Build%20then%20run%20CI%20Chains/badge.svg)



The Cosmos IBC `relayer` package contains a basic relayer implementation that is

meant for users wishing to relay packets/data between sets of IBC enabled chains.

In additon, it is well documented and intended as an example where anyone who is

interested in building their own relayer can come for complete, working, examples.



If you are here for Game of Zones, please be sure to check out the [offical website](https://goz.cosmosnetwork.dev). The best place for questions is [[email protected]](mailto:[email protected]) regarding Game of Zones and prepratory testnets.



### Security Notice



If you would like to report a security critical bug related to the relayer repo, please send an email to [`[email protected]`](mailto:[email protected])



## Code of Conduct



The iqlusion team is dedicated to providing an inclusive and harrassment free experience for contributors. Please visit [Code of Conduct](CODE_OF_CONDUCT.md) for more information.



## Testnet



If you would like to join the relayer testnet, please [check out the instructions](./testnets/README.md).



### Compatability Table:



> NOTE: 



| chain | tests | supported ports |

|-------|--------|----------------|

| [`gaia`](https://github.com/cosmos/gaia) | ![gaia](https://github.com/ilgooz/relayer/workflows/TESTING%20-%20gaia%20to%20gaia%20integration/badge.svg) | `transfer` |



## Demoing the Relayer



![Demo](./docs/images/demo.gif)



While the relayer is under active development, it is meant primarily as a learning tool to better understand the Inter-Blockchain Communication (IBC) protocol. In that vein, the following demo demonstrates the core functionality which will remain even after the changes:



```bash

# ensure go is installed and GOPATH, GOBIN are set appropriately and GOBIN is in your PATH

# Documentation: https://golang.org/doc/install



# two-chainz creates two gaia-based chains with data directories in this

$ ./scripts/two-chainz

# NOTE: If you want to stop the two gaia-based chains running in the background use `killall gaiad`



# Make the relayer binary (rly)

$ make install



# First initialize your configuration for the relayer

$ rly config init



# NOTE: you may want to look at the config between these steps to see

# what is added in each step. The config is located at ~/.relayer/config/config.yaml

$ cat ~/.relayer/config/config.yaml



# Then add the chains and paths that you will need to work with the

# gaia chains spun up by the two-chains script

$ rly cfg add-dir configs/demo/



# NOTE: you may want to look at the config between these steps

$ cat ~/.relayer/config/config.yaml



# Now, add the key seeds from each chain to the relayer to give it funds to work with

$ rly keys restore ibc0 testkey "$(jq -r '.secret' data/ibc0/n0/gaiacli/key_seed.json)"

$ rly keys restore ibc1 testkey "$(jq -r '.secret' data/ibc1/n0/gaiacli/key_seed.json)"



# Then its time to initialize the relayer's light clients for each chain

# All data moving forward is validated by these light clients.

$ rly light init ibc0 -f

$ rly light init ibc1 -f



# At this point the relayer --home directory is ready for normal operations between

# ibc0 and ibc1. Looking at the folder structure of the relayer at this point is helpful

$ tree ~/.relayer



# Now you can connect the two chains with one command:

$ rly tx link demo -d -o 3s



# Check the token balances on both chains

$ rly q balance ibc0

$ rly q bal ibc1



# Then send some tokens between the chains

$ rly tx transfer ibc0 ibc1 1000000samoleans $(rly chains address ibc1)

$ rly tx relay demo



# See that the transfer has completed

$ rly q bal ibc0

$ rly q bal ibc1



# Query the ibc denom to send the tokens back to the sender

$ rly q bal ibc1 -i



# Send the tokens back to the account on ibc0

$ rly tx xfer ibc1 ibc0 1000000ibc/2EF4DA9D3880846723AE8514CA9D77738B4F11FBA2A437EDEE43FF62E6792037 $(rly ch addr ibc0)

$ rly tx relay demo



# See that the return trip has completed

$ rly q bal ibc0

$ rly q bal ibc1



# NOTE: you will see the stake balances decreasing on each chain. This is to pay for fees

# You can change the amount of fees you are paying on each chain in the configuration.

```



## Setting up Developer Environment



Working with the relayer can frequently involve working with local developement branches of `gaia`, `cosmos-sdk` and the `relayer`. To setup your environment to point at the local versions of the code and reduce the amount of time in your read-eval-print loops try the following:



1. Set `replace github.com/cosmos/cosmos-sdk => /path/to/local/github.com/comsos/cosmos-sdk` at the end of the `go.mod` files for the `relayer` and `gaia`. This will force building from the local version of the `cosmos-sdk` when running the `./dev-env` script.

2. After `./dev-env` has run, you can use `go run main.go` for any relayer commands you are working on. This allows you make changes and immediately test them as long as there are no server side changes.

3. If you make changes in `cosmos-sdk` that need to be reflected server-side, be sure to re-run `./two-chainz`.

4. If you need to work off of a `gaia` branch other than `master`, change the branch name at the top of the `./two-chainz` script.