Moved relayer/cli to relayer-cli, relayer/relay to relayer (informals…

…ystems#183) * Moved relayer/cli to relayer-cli, relayer/relay to relayer * Updated CHANGELOG * Changed paths in documentation and CI
hu55a1n1 · Jul 29, 2020 · 50dbd1c · 50dbd1c
1 parent 21f637f
commit 50dbd1c
Show file tree

Hide file tree

Showing 47 changed files with 24 additions and 19 deletions.
diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml
@@ -29,21 +29,21 @@ jobs:
           TRUSTED_HEADER="$(curl -s http://localhost:26657/status)"
           HASH="$(echo "${TRUSTED_HEADER}" | jq -r .result.sync_info.latest_block_hash)"
           HEIGHT="$(echo "${TRUSTED_HEADER}" | jq -r .result.sync_info.latest_block_height)"
-          cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/relayer_conf_example.toml light init -x "${HASH}" -h "${HEIGHT}" chain_A
+          cargo run --bin relayer -- -c relayer/tests/config/fixtures/relayer_conf_example.toml light init -x "${HASH}" -h "${HEIGHT}" chain_A
       - name: Set up chain_b
         run: |
           TRUSTED_HEADER="$(curl -s http://localhost:26557/status)"
           HASH="$(echo "${TRUSTED_HEADER}" | jq -r .result.sync_info.latest_block_hash)"
           HEIGHT="$(echo "${TRUSTED_HEADER}" | jq -r .result.sync_info.latest_block_height)"
-          cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/relayer_conf_example.toml light init -x "${HASH}" -h "${HEIGHT}" chain_B
+          cargo run --bin relayer -- -c relayer/tests/config/fixtures/relayer_conf_example.toml light init -x "${HASH}" -h "${HEIGHT}" chain_B
       - name: Run relayer in the background
         run: |
-          cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/relayer_conf_example.toml start --reset &
+          cargo run --bin relayer -- -c relayer/tests/config/fixtures/relayer_conf_example.toml start --reset &
           sleep 3
       - uses: actions-rs/cargo@v1
         with:
           command: run
-          args: --bin relayer -- -v -c relayer/relay/tests/config/fixtures/relayer_conf_example.toml query connection end chain_A testconnection
+          args: --bin relayer -- -v -c relayer/tests/config/fixtures/relayer_conf_example.toml query connection end chain_A testconnection
 #      - uses: actions-rs/cargo@v1
 #        with:
 #          command: test

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [pending_version]
+
+* Refactored `relayer/cli` into `relayer-cli` folder. ([#180](https://github.com/informalsystems/ibc-rs/issues/180))
+* Refactored `relayer/relay` into `relayer` folder. ([#180](https://github.com/informalsystems/ibc-rs/issues/180))
+
 ## [0.0.1]
 
 *July 1st, 2020*

diff --git a/Cargo.toml b/Cargo.toml
@@ -2,6 +2,6 @@
 
 members = [
     "modules",
-    "relayer/relay",
-    "relayer/cli",
+    "relayer",
+    "relayer-cli",
 ]
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ Sample output:
     > Replace `HASH` and `HEIGHT` with the appropriate values (from step 1 above) in the following command.
 
     ```bash
-    ibc-rs $ cargo run --bin relayer -- -c ./relayer/relay/tests/config/fixtures/relayer_conf_example.toml light init -x HASH -h HEIGHT chain_A
+    ibc-rs $ cargo run --bin relayer -- -c ./relayer/tests/config/fixtures/relayer_conf_example.toml light init -x HASH -h HEIGHT chain_A
     ```
 
 3. Repeat step 1 and 2 above for `chain_B`.
@@ -81,20 +81,20 @@ Sample output:
 4. Finally, start the main relayer thread, along with the light clients and IBC event monitor threads:
 
     ```bash
-    ibc-rs $ cargo run --bin relayer -- -c ./relayer/relay/tests/config/fixtures/relayer_conf_example.toml start --reset
+    ibc-rs $ cargo run --bin relayer -- -c ./relayer/tests/config/fixtures/relayer_conf_example.toml start --reset
     ```
 
     The `--reset` flag only needs to be passed once, for initializing the trusted headers based on the hash & height stored from steps 1-3 above.
 
 Beside the basic relayer `start` command, the following are also available:
 
 - `listen` will start only the monitor part of the relayer, without the light client functionality;
-- `query`can be used to initiate various queries against one of the chains, for example: `cargo run --bin relayer -- -v -c ./relayer/relay/tests/config/fixtures/relayer_conf_example.toml query connection end chain_A testconnection` will look up the connection with identifier `testconnection` on chain `chain_A`.
+- `query`can be used to initiate various queries against one of the chains, for example: `cargo run --bin relayer -- -v -c ./relayer/tests/config/fixtures/relayer_conf_example.toml query connection end chain_A testconnection` will look up the connection with identifier `testconnection` on chain `chain_A`.
 Note: Currently these commands fail in the response deserialization code and will be fixed as soon as  the protobuf encoding is available for tendermint and cosmos-sdk implementations.
 
-The `relayer/cli/src/commands.rs` file contains further description of the CLI subcommands.
+The `relayer-cli/src/commands.rs` file contains further description of the CLI subcommands.
 
-**Note:** Add a `-v` flag to the commands above to see detailed log output, eg. `cargo run --bin relayer -- -v -c ./relayer/relay/tests/config/fixtures/relayer_conf_example.toml run`
+**Note:** Add a `-v` flag to the commands above to see detailed log output, eg. `cargo run --bin relayer -- -v -c ./relayer/tests/config/fixtures/relayer_conf_example.toml run`
 
 ## Contributing
 

diff --git a/relayer/cli/.gitignore → relayer-cli/.gitignore b/relayer/cli/.gitignore → relayer-cli/.gitignore
diff --git a/relayer/cli/Cargo.toml → relayer-cli/Cargo.toml b/relayer/cli/Cargo.toml → relayer-cli/Cargo.toml
@@ -8,8 +8,8 @@ authors = [
 ]
 
 [dependencies]
-relayer = { path = "../relay" }
-relayer-modules = { path = "../../modules" }
+relayer = { path = "../relayer" }
+relayer-modules = { path = "../modules" }
 tendermint = { git = "https://github.com/informalsystems/tendermint-rs.git", branch = "master" }
 
 abscissa_tokio = "0.5.1"

diff --git a/relayer/cli/README.md → relayer-cli/README.md b/relayer/cli/README.md → relayer-cli/README.md
diff --git a/relayer/cli/src/application.rs → relayer-cli/src/application.rs b/relayer/cli/src/application.rs → relayer-cli/src/application.rs
diff --git a/relayer/cli/src/bin/relayer/main.rs → relayer-cli/src/bin/relayer/main.rs b/relayer/cli/src/bin/relayer/main.rs → relayer-cli/src/bin/relayer/main.rs
diff --git a/relayer/cli/src/commands.rs → relayer-cli/src/commands.rs b/relayer/cli/src/commands.rs → relayer-cli/src/commands.rs
diff --git a/relayer/cli/src/commands/config.rs → relayer-cli/src/commands/config.rs b/relayer/cli/src/commands/config.rs → relayer-cli/src/commands/config.rs
diff --git a/relayer/cli/src/commands/config/validate.rs → relayer-cli/src/commands/config/validate.rs b/relayer/cli/src/commands/config/validate.rs → relayer-cli/src/commands/config/validate.rs
diff --git a/relayer/cli/src/commands/light.rs → relayer-cli/src/commands/light.rs b/relayer/cli/src/commands/light.rs → relayer-cli/src/commands/light.rs
diff --git a/relayer/cli/src/commands/light/init.rs → relayer-cli/src/commands/light/init.rs b/relayer/cli/src/commands/light/init.rs → relayer-cli/src/commands/light/init.rs
diff --git a/relayer/cli/src/commands/listen.rs → relayer-cli/src/commands/listen.rs b/relayer/cli/src/commands/listen.rs → relayer-cli/src/commands/listen.rs
diff --git a/relayer/cli/src/commands/query.rs → relayer-cli/src/commands/query.rs b/relayer/cli/src/commands/query.rs → relayer-cli/src/commands/query.rs
diff --git a/relayer/cli/src/commands/query/channel.rs → relayer-cli/src/commands/query/channel.rs b/relayer/cli/src/commands/query/channel.rs → relayer-cli/src/commands/query/channel.rs
@@ -95,7 +95,7 @@ impl Runnable for QueryChannelEndCmd {
         status_info!("Options", "{:?}", opts);
 
         // run without proof:
-        // cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/simple_config.toml query channel end ibc-test firstport firstchannel --height 3 -p false
+        // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query channel end ibc-test firstport firstchannel --height 3 -p false
         let chain = CosmosSDKChain::from_config(chain_config).unwrap();
         let res = chain.query::<ChannelEnd>(
             ChannelEnds(opts.port_id, opts.channel_id),

diff --git a/relayer/cli/src/commands/query/client.rs → relayer-cli/src/commands/query/client.rs b/relayer/cli/src/commands/query/client.rs → relayer-cli/src/commands/query/client.rs
@@ -70,10 +70,10 @@ impl Runnable for QueryClientStateCmd {
         status_info!("Options", "{:?}", opts);
 
         // run with proof:
-        // cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/simple_config.toml query client state ibc-test ethbridge --height 3
+        // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query client state ibc-test ethbridge --height 3
         //
         // run without proof:
-        // cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/simple_config.toml query client state ibc-test ethbridge --height 3 -p false
+        // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query client state ibc-test ethbridge --height 3 -p false
         //
         // Note: currently both fail in amino_unmarshal_binary_length_prefixed().
         // To test this start a Gaia node and configure a client using the go relayer.
@@ -274,7 +274,7 @@ impl QueryClientConnectionsCmd {
 
 /// Command to handle query for client connections
 /// To run without proof:
-/// cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/relayer_conf_example.toml query client connections chain_A clientidone -h 4 -p false
+/// cargo run --bin relayer -- -c relayer/tests/config/fixtures/relayer_conf_example.toml query client connections chain_A clientidone -h 4 -p false
 impl Runnable for QueryClientConnectionsCmd {
     fn run(&self) {
         let config = app_config();

diff --git a/relayer/cli/src/commands/query/connection.rs → relayer-cli/src/commands/query/connection.rs b/relayer/cli/src/commands/query/connection.rs → relayer-cli/src/commands/query/connection.rs
@@ -84,7 +84,7 @@ impl Runnable for QueryConnectionEndCmd {
 
         let chain = CosmosSDKChain::from_config(chain_config).unwrap();
         // run without proof:
-        // cargo run --bin relayer -- -c relayer/relay/tests/config/fixtures/simple_config.toml query connection end ibc-test connectionidone --height 3 -p false
+        // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query connection end ibc-test connectionidone --height 3 -p false
         let res =
             chain.query::<ConnectionEnd>(Connections(opts.connection_id), opts.height, opts.proof);
 

diff --git a/relayer/cli/src/commands/start.rs → relayer-cli/src/commands/start.rs b/relayer/cli/src/commands/start.rs → relayer-cli/src/commands/start.rs
diff --git a/relayer/cli/src/commands/utils.rs → relayer-cli/src/commands/utils.rs b/relayer/cli/src/commands/utils.rs → relayer-cli/src/commands/utils.rs
diff --git a/relayer/cli/src/commands/version.rs → relayer-cli/src/commands/version.rs b/relayer/cli/src/commands/version.rs → relayer-cli/src/commands/version.rs
diff --git a/relayer/cli/src/config.rs → relayer-cli/src/config.rs b/relayer/cli/src/config.rs → relayer-cli/src/config.rs
diff --git a/relayer/cli/src/error.rs → relayer-cli/src/error.rs b/relayer/cli/src/error.rs → relayer-cli/src/error.rs
diff --git a/relayer/cli/src/lib.rs → relayer-cli/src/lib.rs b/relayer/cli/src/lib.rs → relayer-cli/src/lib.rs
diff --git a/relayer/cli/src/prelude.rs → relayer-cli/src/prelude.rs b/relayer/cli/src/prelude.rs → relayer-cli/src/prelude.rs
diff --git a/relayer/cli/tests/acceptance.rs → relayer-cli/tests/acceptance.rs b/relayer/cli/tests/acceptance.rs → relayer-cli/tests/acceptance.rs
diff --git a/relayer/cli/tests/fixtures/two_chains.toml → relayer-cli/tests/fixtures/two_chains.toml b/relayer/cli/tests/fixtures/two_chains.toml → relayer-cli/tests/fixtures/two_chains.toml
diff --git a/relayer/relay/Cargo.toml → relayer/Cargo.toml b/relayer/relay/Cargo.toml → relayer/Cargo.toml
@@ -8,7 +8,7 @@ authors = [
 ]
 
 [dependencies]
-relayer-modules = { path = "../../modules" }
+relayer-modules = { path = "../modules" }
 tendermint = { git = "https://github.com/informalsystems/tendermint-rs.git", branch = "master" }
 tendermint-rpc = { git = "https://github.com/informalsystems/tendermint-rs.git", branch = "master", features=["client"] }
 anomaly = "0.2.0"

diff --git a/relayer/relay/src/chain.rs → relayer/src/chain.rs b/relayer/relay/src/chain.rs → relayer/src/chain.rs
diff --git a/relayer/relay/src/chain/cosmos.rs → relayer/src/chain/cosmos.rs b/relayer/relay/src/chain/cosmos.rs → relayer/src/chain/cosmos.rs
diff --git a/relayer/relay/src/client.rs → relayer/src/client.rs b/relayer/relay/src/client.rs → relayer/src/client.rs
diff --git a/relayer/relay/src/client/rpc_requester.rs → relayer/src/client/rpc_requester.rs b/relayer/relay/src/client/rpc_requester.rs → relayer/src/client/rpc_requester.rs
diff --git a/relayer/relay/src/client/trust_options.rs → relayer/src/client/trust_options.rs b/relayer/relay/src/client/trust_options.rs → relayer/src/client/trust_options.rs
diff --git a/relayer/relay/src/config.rs → relayer/src/config.rs b/relayer/relay/src/config.rs → relayer/src/config.rs
diff --git a/relayer/relay/src/error.rs → relayer/src/error.rs b/relayer/relay/src/error.rs → relayer/src/error.rs
diff --git a/relayer/relay/src/event_handler.rs → relayer/src/event_handler.rs b/relayer/relay/src/event_handler.rs → relayer/src/event_handler.rs
diff --git a/relayer/relay/src/event_monitor.rs → relayer/src/event_monitor.rs b/relayer/relay/src/event_monitor.rs → relayer/src/event_monitor.rs
diff --git a/relayer/relay/src/lib.rs → relayer/src/lib.rs b/relayer/relay/src/lib.rs → relayer/src/lib.rs
diff --git a/relayer/relay/src/query/client.rs → relayer/src/query/client.rs b/relayer/relay/src/query/client.rs → relayer/src/query/client.rs
diff --git a/relayer/relay/src/store.rs → relayer/src/store.rs b/relayer/relay/src/store.rs → relayer/src/store.rs
diff --git a/relayer/relay/src/store/mem.rs → relayer/src/store/mem.rs b/relayer/relay/src/store/mem.rs → relayer/src/store/mem.rs
diff --git a/relayer/relay/src/store/sled.rs → relayer/src/store/sled.rs b/relayer/relay/src/store/sled.rs → relayer/src/store/sled.rs
diff --git a/relayer/relay/src/util.rs → relayer/src/util.rs b/relayer/relay/src/util.rs → relayer/src/util.rs
diff --git a/relayer/relay/src/util/sled.rs → relayer/src/util/sled.rs b/relayer/relay/src/util/sled.rs → relayer/src/util/sled.rs
diff --git a/...config/fixtures/relayer_conf_example.toml → ...config/fixtures/relayer_conf_example.toml b/...config/fixtures/relayer_conf_example.toml → ...config/fixtures/relayer_conf_example.toml
diff --git a/.../tests/config/fixtures/simple_config.toml → .../tests/config/fixtures/simple_config.toml b/.../tests/config/fixtures/simple_config.toml → .../tests/config/fixtures/simple_config.toml