DNM: IBC-Gaia Integration #130
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| # IBC instruction | ||
|
|
||
| ## Dependencies | ||
|
|
||
| This branch uses non-canonical branch of cosmos-sdk. Before building, run `go mod vendor` on the root directory to retrieve the dependencies. To build: | ||
|
|
||
| ```shell | ||
| git clone git@github.com:cosmos/gaia | ||
| cd gaia | ||
| git checkout joon/ibc-gaia-interface | ||
| go mod vendor | ||
| make install | ||
| gaiad version | ||
| gaiacli version | ||
| ``` | ||
|
|
||
| ## Environment Setup | ||
|
|
||
| Stub out testnet files for 2 nodes, this example does so in your $HOME directory: | ||
|
|
||
| ```shell | ||
| cd ~ && mkdir ibc-testnets && cd ibc-testnets | ||
| gaiad testnet -o ibc0 --v 1 --chain-id ibc0 --node-dir-prefix n | ||
| gaiad testnet -o ibc1 --v 1 --chain-id ibc1 --node-dir-prefix n | ||
| ``` | ||
|
|
||
| ### Set `gaiad` and `gaiacli` Configuation | ||
|
|
||
| Fix the configuration files for both `gaiad` and `gaiacli` to allow both chains/nodes to run on the same machine: | ||
|
|
||
| ```bash | ||
| # Configure the proper database backend for each node and different listening ports | ||
| sed -i '' 's/"leveldb"/"goleveldb"/g' ibc0/n0/gaiad/config/config.toml | ||
| sed -i '' 's/"leveldb"/"goleveldb"/g' ibc1/n0/gaiad/config/config.toml | ||
| sed -i '' 's#"tcp://0.0.0.0:26656"#"tcp://0.0.0.0:26556"#g' ibc1/n0/gaiad/config/config.toml | ||
| sed -i '' 's#"tcp://0.0.0.0:26657"#"tcp://0.0.0.0:26557"#g' ibc1/n0/gaiad/config/config.toml | ||
| sed -i '' 's#"localhost:6060"#"localhost:6061"#g' ibc1/n0/gaiad/config/config.toml | ||
| sed -i '' 's#"tcp://127.0.0.1:26658"#"tcp://127.0.0.1:26558"#g' ibc1/n0/gaiad/config/config.toml | ||
| gaiacli config --home ibc0/n0/gaiacli/ chain-id ibc0 | ||
| gaiacli config --home ibc1/n0/gaiacli/ chain-id ibc1 | ||
| gaiacli config --home ibc0/n0/gaiacli/ output json | ||
| gaiacli config --home ibc1/n0/gaiacli/ output json | ||
| gaiacli config --home ibc0/n0/gaiacli/ node http://localhost:26657 | ||
| gaiacli config --home ibc1/n0/gaiacli/ node http://localhost:26557 | ||
| ``` | ||
|
|
||
| Add keys from each chain to the other and make sure that the key at `ibc1/n0/gaiacli/key_seed.json` is named `n1` on each `gaiacli` instance and the same for `n0`. After this is complete the results of `gaiacli keys list` from each chain should be identical. The following are instructions for how to do this on Mac: | ||
|
|
||
| ```bash | ||
| # These commands copy the seed phrase from each dir into the clipboard on mac | ||
| jq -r '.secret' ibc0/n0/gaiacli/key_seed.json | pbcopy | ||
| jq -r '.secret' ibc1/n0/gaiacli/key_seed.json | pbcopy | ||
|
|
||
| # Remove the key n0 on ibc1 | ||
| gaiacli --home ibc1/n0/gaiacli keys delete n0 | ||
|
|
||
| # seed from ibc1/n0/gaiacli/key_seed.json -> ibc0/n1 | ||
| gaiacli --home ibc0/n0/gaiacli keys add n1 --recover | ||
|
|
||
| # seed from ibc0/n0/gaiacli/key_seed.json -> ibc1/n0 | ||
| gaiacli --home ibc1/n0/gaiacli keys add n0 --recover | ||
|
|
||
| # seed from ibc1/n0/gaiacli/key_seed.json -> ibc1/n1 | ||
| gaiacli --home ibc1/n0/gaiacli keys add n1 --recover | ||
|
|
||
| # Ensure keys match | ||
| gaiacli --home ibc0/n0/gaiacli keys list | jq '.[].address' | ||
| gaiacli --home ibc1/n0/gaiacli keys list | jq '.[].address' | ||
| ``` | ||
|
|
||
| After configuration is complete, start your `gaiad` processes: | ||
|
|
||
| ```bash | ||
| nohup gaiad --home ibc0/n0/gaiad start > ibc0.log & | ||
| nohup gaiad --home ibc1/n0/gaiad start > ibc1.log & | ||
| ``` | ||
|
|
||
| ## IBC Command Sequence | ||
|
|
||
| ### Client Creation | ||
|
|
||
| Create IBC clients on each chain using the following commands. Note that we are using the consensus state of `ibc1` to create the client on `ibc0` and visa-versa. These "roots of trust" are used to validate transactions coming from the other chain. They will be updated periodically during handshakes and will require update at least once per unbonding period: | ||
|
|
||
| ```bash | ||
| # client for chain ibc1 on chain ibc0 | ||
| gaiacli --home ibc0/n0/gaiacli \ | ||
| tx ibc client create c0 \ | ||
| $(gaiacli --home ibc1/n0/gaiacli q ibc client consensus-state) \ | ||
| --from n0 -y -o text | ||
|
|
||
| # client for chain ibc0 on chain ibc1 | ||
| gaiacli --home ibc1/n0/gaiacli \ | ||
| tx ibc client create c1 \ | ||
| $(gaiacli --home ibc0/n0/gaiacli q ibc client consensus-state) \ | ||
| --from n1 -y -o text | ||
| ``` | ||
|
|
||
| To query details about the clients use the following commands : | ||
|
|
||
| ```bash | ||
| gaiacli --home ibc0/n0/gaiacli q ibc client client c0 --indent | ||
| gaiacli --home ibc1/n0/gaiacli q ibc client client c1 --indent | ||
| ``` | ||
|
|
||
| ### Connection Creation | ||
|
|
||
| In order to send transactions using IBC there are two different handshakes that must be performed. First there is a `connection` created between the two chains. Once the connection is created, an application specific `channel` handshake is performed which allows the transfer of application specific data. Examples of applications are token transfer, cross-chain validation, cross-chain accounts, and in this tutorial `ibc-mock`. | ||
|
|
||
| Create a `connection` with the following command: | ||
|
|
||
| > NOTE: This command broadcasts a total of 7 transactions between the two chains from 2 different wallets. At the start of the command you will be prompted for passwords for the two different keys. The command may then take some time. Please wait for the command to return! | ||
|
|
||
| ```shell | ||
| gaiacli \ | ||
| --home ibc0/n0/gaiacli \ | ||
| tx ibc connection handshake \ | ||
| conn0 c0 $(gaiacli --home ibc1/n0/gaiacli q ibc client path) \ | ||
| conn1 c1 $(gaiacli --home ibc0/n0/gaiacli q ibc client path) \ | ||
| --chain-id2 ibc1 \ | ||
| --from1 n0 --from2 n1 \ | ||
| --node1 tcp://localhost:26657 \ | ||
| --node2 tcp://localhost:26557 | ||
| ``` | ||
|
|
||
| Once the connection is established you should be able to query it: | ||
|
|
||
| ```bash | ||
| gaiacli --home ibc0/n0/gaiacli q ibc connection connection conn0 --indent --trust-node | ||
| gaiacli --home ibc1/n0/gaiacli q ibc connection connection conn1 --indent --trust-node | ||
| ``` | ||
|
|
||
| ### Channel | ||
|
|
||
| Now that the `connection` has been created, it's time to establish a `channel` for the `ibc-mock` application protocol. This will allow sending of data between `ibc0` and `ibc1`. To create the `channel`, run the following command: | ||
|
|
||
| > NOTE: This command broadcasts a total of 7 transactions between the two chains from 2 different wallets. At the start of the command you will be prompted for passwords for the two different keys. The command may then take some time. Please wait for the command to return! | ||
|
|
||
| ```bash | ||
| gaiacli \ | ||
| --home ibc0/n0/gaiacli \ | ||
| tx ibc channel handshake \ | ||
| ibcmocksend chan0 conn0 \ | ||
| ibcmockrecv chan1 conn1 \ | ||
| --node1 tcp://localhost:26657 \ | ||
| --node2 tcp://localhost:26557 \ | ||
| --chain-id2 ibc1 \ | ||
| --from1 n0 --from2 n1 | ||
| ``` | ||
|
|
||
| You can query the `channel` after establishment by running the following command: | ||
|
|
||
| ```bash | ||
| gaiacli --home ibc0/n0/gaiacli query ibc channel channel ibcmocksend chan0 --indent --trust-node | ||
| gaiacli --home ibc1/n0/gaiacli query ibc channel channel ibcmockrecv chan1 --indent --trust-node | ||
| ``` | ||
|
|
||
| ## Send Packet | ||
|
There was a problem hiding this comment. Both send-packet commands are using There was a problem hiding this comment. How should the commands look? This part of the instructions are left over from the loopback demo There was a problem hiding this comment.
There was a problem hiding this comment. @mossid so how would you rewrite the example? |
||
|
|
||
| To send a packet using the `ibc-mock` application protocol, you need to know the channel you plan to send on, as well as the sequence number on the channel. To get the sequence you use the following commands: | ||
|
|
||
| ```bash | ||
| # Returns the last sequence number | ||
| gaiacli --home ibc0/n0/gaiacli q ibcmocksend sequence chan0 | ||
|
|
||
| # Returns the next expected sequence number, for use in scripting | ||
| gaiacli --home ibc0/n0/gaiacli q ibcmocksend next chan0 | ||
|
There was a problem hiding this comment. On a fresh install: Running Running I was able to reproduce the above after stopping the testnet gaiad processes, removing the entire ibc-testnets directory, and starting over. Will try on a new machine tomorrow (currently, on a Mac). There was a problem hiding this comment. Wanted to add that manually inputting the correct sequence number (should be There was a problem hiding this comment. In L74 of the function add 1 to res, so if value is nil, res should be set to 0 instead of 1. |
||
| ``` | ||
|
|
||
| Now you are ready to send an `ibc-mock` packet down the channel (`chan0`) from chain `ibc0` to chain `ibc1`! To do so run the following commands to send a packet down the channel: | ||
|
|
||
| ```bash | ||
| gaiacli --home ibc0/n0/gaiacli tx ibcmocksend sequence chan0 $(gaiacli --home ibc0/n0/gaiacli q ibcmocksend next chan0) --from n0 -o text -y | ||
| ``` | ||
|
|
||
| ### Receive Packet | ||
|
|
||
| Once packets are sent, receipt must be confirmed on the destination chain. To `pull` the packets from `ibc0` on `ibc1`, run the following command: | ||
|
|
||
| ```bash | ||
| gaiacli \ | ||
| --home ibc1/n0/gaiacli \ | ||
| tx ibc channel pull ibcmockrecv chan1 \ | ||
| --node1 tcp://localhost:26557 \ | ||
| --node2 tcp://localhost:26657 \ | ||
| --chain-id2 ibc0 \ | ||
| --from n1 | ||
| ``` | ||
|
|
||
| This command sends two transactions. You should see the reciept of the packet: | ||
|
|
||
| ``` | ||
| ibc1 <- update-client [OK] txid(7D4B4DE7A6B8E1045CA7BEB16E21DD0491BED000E5FB0D05BBB7960AABE5CC78) client(c1) | ||
| ibc1 <- empty-packet [OK] txid(6E90B9CE19394D7D41CF55E4ADCC94D6169B476B45527F9C47346080C85A289F) packets(1) | ||
| ``` | ||
|
|
||
| > Note: This command pushes all the packets out of the channel with one command. Try pushing a **couple of packets** from `ibc0` to `ibc1` then fulshing them at once. You should see output like: | ||
|
|
||
| ``` | ||
| ibc1 <- update-client [OK] txid(21E0CE99A21DD7630A7DDE62459DD82C4051CC46B231A7B31529928B1B1B2C53) client(c1) | ||
| ibc1 <- empty-packet [OK] txid(92D76EF46FDCB3739DB06960BECCD7DA30AAA6AECA687DF4D92CC272D4941F7E) packets(2) | ||
| ``` | ||
|
|
||
| Once the packets have been sent, you can check the updated sequence by running: | ||
|
|
||
| ```bash | ||
| gaiacli --home ibc1/n0/gaiacli q ibcmockrecv sequence chan1 --trust-node | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mmmm how comes? Did you have any issues with
-mod=readonly? Is there anything I can help out with?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure! I was having issues with
-mod=readonly!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this the case @alessio?