Skip to content

Latest commit

 

History

History
224 lines (147 loc) · 5.96 KB

README.md

File metadata and controls

224 lines (147 loc) · 5.96 KB
Raw

IBC testing chains

Start chains

There are 2 chains, wasmd and osmosisd for testing, you will need to start both of the chains to test IBC.

First run

Before running the chain, you will need to generate the chain config files.

$ ./ci-scripts/wasmd/generate_template.sh
$ ./ci-scripts/osmosis/generate_template.sh

Start wasmd in terminal 1:

$ ./ci-scripts/wasmd/start.sh

Start osmosis in terminal 2:

$ ./ci-scripts/osmosis/start.sh

Close chains.

To shut down the chains, go into the terminal and click ctrl + z after that, run the stop script.

$ ./ci-scripts/wasmd/stop.sh
$ ./ci-scripts/osmosis/stop.sh

NOTE: ctrl + c might not stop the process because of the way we run the docker, ctrl + z will abort and allow you to run the stop script.
You should also be able to run the stop script in other terminal.

Start hermes

To run hermes, the chains already include the relayer wallets for signing txs, but we still need hermes to be able to use them.

Quick start

This will run the needed commands to validate the chains and the config, set up the keys for the wallets, create connection between the chains and run hermes proess.

$ ./hermes/start.sh

Custom hermes

If you need anything else from hermes, you can always run hermes commands

$ cd hermes

$ hermes --config config.toml [COMMAND]

Working with the test chains

When you stop a chain, all data are deleted, and a fresh chain will be spawned when you start the chain again.

General data

Currently we have 2 chains, wasmd and osmosis, naming is important, so here is the list of things we need to know:

Docker names

wasmd = wasmd  
osmosis = osmosis

Chain ids
Those names are important as those names are what you use in hermes.

wasmd = wasmd-1  
osmosis = osmo-testing

Relayer wallets
Those wallets are automatically added inside the chains when you start them.

wasmd = wasm1ll3s59aawh0qydpz2q3xmqf6pwzmj24t8l43cp
osmosis = osmo1ll3s59aawh0qydpz2q3xmqf6pwzmj24t9ch58c

Chain rpc

wasmd = http://127.0.0.1:26659
osmosis = http://127.0.0.1:26653

Using docker

Because our chains runs inside a docker, we have to talk with the chains from inside the docker.

  • You can talk with the chain from outside the docker, by using the --node and giving the RPC URL of the chain: wasmd: http://127.0.0.1:26659

You can enter the docker shell:

docker exec -it [CHAIN_NAME] sh

// To exit the shell, type:
exit

You can run a single command:

docker exec -it [CHAIN_NAME] [COMMAND]

And you can run multiple commands:

docker exec -it [CHAIN_NAME] sh -c "[COMMAND]; [COMMAND]"

Working with contracts

After our chains started, we can upload contracts from inside the docker.

Move wasm file inside docker

To upload the contract you need to move the contract wasm file to the docker.

Move the .wasm files into the template/contracts folder of each chains.

This will place the files inside the docker, in the same path inside the docker, at /template/contracts/wasm.wasm.

Upload and init contracts

./upload_init.sh

We have created a script to make this process easier, see ci-scripts/extra/scripts/upload_init.sh

This script will upload and init the contract on the chain, you will need to run this script once per chain.

Options:

    -d|--docker-name (required) - docker name of the chain. Ex: wasm | osmosis
    -c|--contract-name (required) - full name of the contract. Ex: (ibc_example.wasm)
    -i|--init-json (optional) - init msg for the contract. Default: "{}"
    -w|--wallet (optional) - wallet that will be used for the process. Default: The relayer wallet
    -l|--label (optional) - label for the contract. Default: "testing"
    -nd|--no-admin (optional) - make contract without an admin. Default: -w|--wallet

Example:

./upload_init.sh -d wasmd -c ibc_example.wasm -i "{owner: "ADDR"}" -w ADDR -l "example" --no-admin

Initialize contracts

./init.sh

We also created a script to only init a contract, see ci-scripts/extra/scripts/init.sh

Options:

    -d|--docker-name (required) - docker name of the chain. Ex: wasm | osmosis
->  -c|--code-id (required) - code id of uploaded contract. Ex: (1)
    -i|--init-json (optional) - init msg for the contract. Default: "{}"
    -w|--wallet (optional) - wallet that will be used for the process. Default: The relayer wallet
    -l|--label (optional) - label for the contract. Default: "testing"
    -nd|--no-admin (optional) - make contract without an admin. Default: -w|--wallet

Example:

./init.sh -d wasmd -c 1 -i "{owner: "ADDR"}" -w ADDR -l "example" --no-admin

Start channel (enable IBC for our contracts)

To enable IBC, you need to create a channel between our contracts, we created a script to do that automatically.

  • You will need to upload the contracts on your chains and provide the script the 2 contract addresses.
  • By default, this script assume you are using wasmd and osmosis chains, if you modified your dockers, you might need to adjust this script.

Options:

    -ac|--a-contract (required) - wasmd contract address
    -bc|--b-contract (required) - osmosis contract address
    -cv|--channel-version (required) - the version your contracts expect
    -c|--a-connection (optional) - choose specific connection, if not provided, we will get it from the chain.
    -o|--order (optional) - order of the channel. Default: unordered

Example:

./open_channel.sh -ac wasm14hj2tavq8fpesdwxxcu44rty3hh90vhujrvcmstl4zr3txmfvw9s0phg4d \
-bc osmo14hj2tavq8fpesdwxxcu44rty3hh90vhujrvcmstl4zr3txmfvw9sq2r9g9 \
-cv "ping-1" \
-c connection-0

You will get the channel id in response.

If went successful, the 2 contracts are connected and can talk with each other over IBC! You done it!

Now you can interact with your contracts as usual and test them.