From c3210fc7c39c6710630cf15a67746d9a7b8660d2 Mon Sep 17 00:00:00 2001 From: Luca Joss <43531661+ljoss17@users.noreply.github.com> Date: Tue, 28 Nov 2023 16:53:03 +0100 Subject: [PATCH] Release Hermes v1.7.2 (#3709) * Add metric to count skipped client update messages (#3706) * Add metric to count skipped client update messages * Update guide with new metric * Add changelog entry * Update versions * Fix cargo doc warnings and update version reference in relayer crate * Fix clippy error * Fix relayer-rest test * Fix typo in changelog * Add `broadcast_errors` metric (#3710) * Add metric for broadcast errors * Update the guide with the new broadcast error metric * Add changelog entry * Update release date * Update changelog and summary message * Apply github suggestion and add missing entry in Changelog --- .../3707-skipped-client-update-metric.md | 3 ++ .../3708-add-broadcast-errors.md | 3 ++ .changelog/v1.7.2/summary.md | 7 +++ CHANGELOG.md | 20 +++++++ Cargo.lock | 16 +++--- crates/chain-registry/Cargo.toml | 4 +- crates/relayer-cli/Cargo.toml | 12 ++--- crates/relayer-rest/Cargo.toml | 6 +-- crates/relayer-rest/tests/mock.rs | 2 +- crates/relayer-types/Cargo.toml | 2 +- crates/relayer/Cargo.toml | 8 +-- crates/relayer/src/chain/cosmos/retry.rs | 19 +++++++ .../src/chain/cosmos/types/events/channel.rs | 2 +- crates/relayer/src/foreign_client.rs | 7 +++ crates/relayer/src/lib.rs | 2 +- crates/telemetry/Cargo.toml | 4 +- crates/telemetry/src/state.rs | 53 +++++++++++++++++++ guide/README.md | 2 +- guide/src/SUMMARY.md | 2 +- .../configuration/configure-hermes.md | 2 +- .../documentation/telemetry/integration.md | 4 ++ .../src/documentation/telemetry/operators.md | 2 + guide/src/templates/hermes-version.md | 2 +- tools/integration-test/Cargo.toml | 2 +- tools/test-framework/Cargo.toml | 8 +-- tools/test-framework/src/relayer/driver.rs | 4 +- tools/test-framework/src/types/id.rs | 2 +- 27 files changed, 159 insertions(+), 41 deletions(-) create mode 100644 .changelog/v1.7.2/features/ibc-telemetry/3707-skipped-client-update-metric.md create mode 100644 .changelog/v1.7.2/features/ibc-telemetry/3708-add-broadcast-errors.md create mode 100644 .changelog/v1.7.2/summary.md diff --git a/.changelog/v1.7.2/features/ibc-telemetry/3707-skipped-client-update-metric.md b/.changelog/v1.7.2/features/ibc-telemetry/3707-skipped-client-update-metric.md new file mode 100644 index 0000000000..db44abf7e4 --- /dev/null +++ b/.changelog/v1.7.2/features/ibc-telemetry/3707-skipped-client-update-metric.md @@ -0,0 +1,3 @@ +- Added metric `client_updates_skipped` to track the number of client + update messages skipped due to the conscensus state existing already. + ([\#3707](https://github.com/informalsystems/hermes/issues/3707)) \ No newline at end of file diff --git a/.changelog/v1.7.2/features/ibc-telemetry/3708-add-broadcast-errors.md b/.changelog/v1.7.2/features/ibc-telemetry/3708-add-broadcast-errors.md new file mode 100644 index 0000000000..9585d6dbc3 --- /dev/null +++ b/.changelog/v1.7.2/features/ibc-telemetry/3708-add-broadcast-errors.md @@ -0,0 +1,3 @@ +- Add a new metric `broadcast_errors` which + records the number of times a specific error is observed by Hermes when broadcasting transactions + ([\#3708](https://github.com/informalsystems/hermes/issues/3708)) \ No newline at end of file diff --git a/.changelog/v1.7.2/summary.md b/.changelog/v1.7.2/summary.md new file mode 100644 index 0000000000..1fe74eaa01 --- /dev/null +++ b/.changelog/v1.7.2/summary.md @@ -0,0 +1,7 @@ +*November 28th, 2023* + +This patch release of Hermes adds a metric to improve monitoring errors and one +to measure the efficiency of the client update skip feature released in patch v1.7.1. + +* `broadcast_errors` records the number of times a specific error is observed by Hermes when broadcasting transactions. +* `client_updates_skipped` records the number of client updates skipped due to the consensus states already existing. diff --git a/CHANGELOG.md b/CHANGELOG.md index d89c5132ff..27ebf30bee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # CHANGELOG +## v1.7.2 + +*November 28th, 2023* + +This patch release of Hermes adds a metric to improve monitoring errors and one +to measure the efficiency of the client update skip feature released in patch v1.7.1. + +* `broadcast_errors` records the number of times a specific error is observed by Hermes when broadcasting transactions. +* `client_updates_skipped` records the number of client updates skipped due to the consensus states already existing. + +### FEATURES + +- [Telemetry & Metrics](telemetry) + - Added metric `client_updates_skipped` to track the number of client + update messages skipped due to the conscensus state existing already. + ([\#3707](https://github.com/informalsystems/hermes/issues/3707)) + - Add a new metric `broadcast_errors` which + records the number of times a specific error is observed by Hermes when broadcasting transactions + ([\#3708](https://github.com/informalsystems/hermes/issues/3708)) + ## v1.7.1 *November 13th, 2023* diff --git a/Cargo.lock b/Cargo.lock index 8fa163d31a..4c1fd97055 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1323,7 +1323,7 @@ dependencies = [ [[package]] name = "ibc-chain-registry" -version = "0.26.1" +version = "0.26.2" dependencies = [ "async-trait", "flex-error", @@ -1342,7 +1342,7 @@ dependencies = [ [[package]] name = "ibc-integration-test" -version = "0.26.1" +version = "0.26.2" dependencies = [ "http", "ibc-relayer", @@ -1376,7 +1376,7 @@ dependencies = [ [[package]] name = "ibc-relayer" -version = "0.26.1" +version = "0.26.2" dependencies = [ "anyhow", "async-stream", @@ -1443,7 +1443,7 @@ dependencies = [ [[package]] name = "ibc-relayer-cli" -version = "1.7.1" +version = "1.7.2" dependencies = [ "abscissa_core", "clap", @@ -1484,7 +1484,7 @@ dependencies = [ [[package]] name = "ibc-relayer-rest" -version = "0.26.1" +version = "0.26.2" dependencies = [ "axum", "crossbeam-channel 0.5.8", @@ -1499,7 +1499,7 @@ dependencies = [ [[package]] name = "ibc-relayer-types" -version = "0.26.1" +version = "0.26.2" dependencies = [ "bytes", "derive_more", @@ -1530,7 +1530,7 @@ dependencies = [ [[package]] name = "ibc-telemetry" -version = "0.26.1" +version = "0.26.2" dependencies = [ "axum", "dashmap", @@ -1549,7 +1549,7 @@ dependencies = [ [[package]] name = "ibc-test-framework" -version = "0.26.1" +version = "0.26.2" dependencies = [ "color-eyre", "crossbeam-channel 0.5.8", diff --git a/crates/chain-registry/Cargo.toml b/crates/chain-registry/Cargo.toml index 1bdf80244e..921f2902b1 100644 --- a/crates/chain-registry/Cargo.toml +++ b/crates/chain-registry/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-chain-registry" -version = "0.26.1" +version = "0.26.2" edition = "2021" license = "Apache-2.0" keywords = ["cosmos", "ibc", "relayer", "chain", "registry"] @@ -12,7 +12,7 @@ description = """ """ [dependencies] -ibc-relayer-types = { version = "0.26.1", path = "../relayer-types" } +ibc-relayer-types = { version = "0.26.2", path = "../relayer-types" } ibc-proto = { version = "0.38.0", features = ["serde"] } tendermint-rpc = { version = "0.34.0", features = ["http-client", "websocket-client"] } diff --git a/crates/relayer-cli/Cargo.toml b/crates/relayer-cli/Cargo.toml index fdf832c805..495058a949 100644 --- a/crates/relayer-cli/Cargo.toml +++ b/crates/relayer-cli/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-cli" -version = "1.7.1" +version = "1.7.2" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -25,11 +25,11 @@ telemetry = ["ibc-relayer/telemetry", "ibc-telemetry"] rest-server = ["ibc-relayer-rest"] [dependencies] -ibc-relayer-types = { version = "0.26.1", path = "../relayer-types" } -ibc-relayer = { version = "0.26.1", path = "../relayer" } -ibc-telemetry = { version = "0.26.1", path = "../telemetry", optional = true } -ibc-relayer-rest = { version = "0.26.1", path = "../relayer-rest", optional = true } -ibc-chain-registry = { version = "0.26.1" , path = "../chain-registry" } +ibc-relayer-types = { version = "0.26.2", path = "../relayer-types" } +ibc-relayer = { version = "0.26.2", path = "../relayer" } +ibc-telemetry = { version = "0.26.2", path = "../telemetry", optional = true } +ibc-relayer-rest = { version = "0.26.2", path = "../relayer-rest", optional = true } +ibc-chain-registry = { version = "0.26.2" , path = "../chain-registry" } clap = { version = "3.2", features = ["cargo"] } clap_complete = "3.2" diff --git a/crates/relayer-rest/Cargo.toml b/crates/relayer-rest/Cargo.toml index a7d847859f..26d9de93a6 100644 --- a/crates/relayer-rest/Cargo.toml +++ b/crates/relayer-rest/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-rest" -version = "0.26.1" +version = "0.26.2" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0" @@ -14,8 +14,8 @@ description = """ """ [dependencies] -ibc-relayer-types = { version = "0.26.1", path = "../relayer-types" } -ibc-relayer = { version = "0.26.1", path = "../relayer" } +ibc-relayer-types = { version = "0.26.2", path = "../relayer-types" } +ibc-relayer = { version = "0.26.2", path = "../relayer" } crossbeam-channel = "0.5" serde = "1.0" diff --git a/crates/relayer-rest/tests/mock.rs b/crates/relayer-rest/tests/mock.rs index 7db71d0f10..65c1e4959d 100644 --- a/crates/relayer-rest/tests/mock.rs +++ b/crates/relayer-rest/tests/mock.rs @@ -64,7 +64,7 @@ async fn version() { let rest_api_version = VersionInfo { name: "ibc-relayer-rest".to_string(), - version: "0.26.1".to_string(), + version: "0.26.2".to_string(), }; let result: JsonResult<_, ()> = JsonResult::Success(vec![version.clone(), rest_api_version]); diff --git a/crates/relayer-types/Cargo.toml b/crates/relayer-types/Cargo.toml index dbc45e8835..ec180ed2fa 100644 --- a/crates/relayer-types/Cargo.toml +++ b/crates/relayer-types/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-types" -version = "0.26.1" +version = "0.26.2" edition = "2021" license = "Apache-2.0" readme = "README.md" diff --git a/crates/relayer/Cargo.toml b/crates/relayer/Cargo.toml index 914fc1ab70..d3f2a45e2a 100644 --- a/crates/relayer/Cargo.toml +++ b/crates/relayer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer" -version = "0.26.1" +version = "0.26.2" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -21,8 +21,8 @@ telemetry = ["ibc-telemetry"] [dependencies] ibc-proto = { version = "0.38.0", features = ["serde"] } -ibc-telemetry = { version = "0.26.1", path = "../telemetry", optional = true } -ibc-relayer-types = { version = "0.26.1", path = "../relayer-types", features = ["mocks"] } +ibc-telemetry = { version = "0.26.2", path = "../telemetry", optional = true } +ibc-relayer-types = { version = "0.26.2", path = "../relayer-types", features = ["mocks"] } subtle-encoding = "0.5" humantime-serde = "1.1.1" @@ -104,7 +104,7 @@ version = "0.34.0" default-features = false [dev-dependencies] -ibc-relayer-types = { version = "0.26.1", path = "../relayer-types", features = ["mocks"] } +ibc-relayer-types = { version = "0.26.2", path = "../relayer-types", features = ["mocks"] } serial_test = "2.0.0" env_logger = "0.10.0" tracing-subscriber = { version = "0.3.14", features = ["fmt", "env-filter", "json"] } diff --git a/crates/relayer/src/chain/cosmos/retry.rs b/crates/relayer/src/chain/cosmos/retry.rs index 4d0091fc92..305edf3d92 100644 --- a/crates/relayer/src/chain/cosmos/retry.rs +++ b/crates/relayer/src/chain/cosmos/retry.rs @@ -100,6 +100,9 @@ async fn do_send_tx_with_account_sequence_retry( } // Gas estimation succeeded but broadcast_tx_sync failed with a retry-able error. + // NOTE: The error code could potentially overlap between Cosmos SDK and Ibc-go channel + // error codes. This is currently not the case of incorrect account sequence error + //which is the Cosmos SDK code 32 and Ibc-go channel errors only go up to 25. Ok(ref response) if response.code == Code::from(INCORRECT_ACCOUNT_SEQUENCE_ERR) => { warn!( ?response, @@ -107,6 +110,13 @@ async fn do_send_tx_with_account_sequence_retry( refreshing account sequence number and retrying once" ); + telemetry!( + broadcast_errors, + &account.address.to_string(), + response.code.into(), + &response.log, + ); + refresh_account_and_retry_send_tx_with_account_sequence( rpc_client, config, key_pair, account, tx_memo, messages, ) @@ -119,6 +129,8 @@ async fn do_send_tx_with_account_sequence_retry( debug!("gas estimation succeeded"); // Gas estimation and broadcast_tx_sync were successful. + // NOTE: The error code could potentially overlap between Cosmos SDK and Ibc-go channel + // error codes. match response.code { Code::Ok => { let old_account_sequence = account.sequence; @@ -147,6 +159,13 @@ async fn do_send_tx_with_account_sequence_retry( "failed to broadcast tx with unrecoverable error" ); + telemetry!( + broadcast_errors, + &account.address.to_string(), + code.into(), + &response.log + ); + Ok(response) } } diff --git a/crates/relayer/src/chain/cosmos/types/events/channel.rs b/crates/relayer/src/chain/cosmos/types/events/channel.rs index 29730e3669..fa09493913 100644 --- a/crates/relayer/src/chain/cosmos/types/events/channel.rs +++ b/crates/relayer/src/chain/cosmos/types/events/channel.rs @@ -95,7 +95,7 @@ impl TryFrom> for WriteAcknowledgement { .into_bytes(); let mut packet = Packet::try_from(obj)?; - packet.data = Vec::from(data_str.as_str().as_bytes()); + packet.data = Vec::from(data_str.as_bytes()); Ok(Self { packet, ack }) } diff --git a/crates/relayer/src/foreign_client.rs b/crates/relayer/src/foreign_client.rs index b6c4bc1837..bc5e470b66 100644 --- a/crates/relayer/src/foreign_client.rs +++ b/crates/relayer/src/foreign_client.rs @@ -1145,6 +1145,13 @@ impl ForeignClient, + /// Number of client update skipped due to consensus state already + /// existing + client_updates_skipped: Counter, + /// Number of misbehaviours detected and submitted per client client_misbehaviours_submitted: Counter, @@ -193,6 +197,9 @@ pub struct TelemetryState { /// Sum of rewarded fees over the past FEE_LIFETIME seconds period_fees: ObservableGauge, + + /// Number of errors observed by Hermes when broadcasting a Tx + broadcast_errors: Counter, } impl TelemetryState { @@ -233,6 +240,11 @@ impl TelemetryState { .with_description("Number of client update messages submitted") .init(), + client_updates_skipped: meter + .u64_counter("client_updates_skipped") + .with_description("Number of client update messages skipped") + .init(), + client_misbehaviours_submitted: meter .u64_counter("client_misbehaviours_submitted") .with_description("Number of misbehaviours detected and submitted") @@ -362,6 +374,13 @@ impl TelemetryState { .u64_observable_gauge("ics29_period_fees") .with_description("Amount of ICS29 fees rewarded over the past 7 days") .init(), + + broadcast_errors: meter + .u64_counter("broadcast_errors") + .with_description( + "Number of errors observed by Hermes when broadcasting a Tx", + ) + .init(), } } @@ -458,6 +477,7 @@ impl TelemetryState { ]; self.client_updates_submitted.add(&cx, 0, labels); + self.client_updates_skipped.add(&cx, 0, labels); if misbehaviour { self.client_misbehaviours_submitted.add(&cx, 0, labels); @@ -512,6 +532,25 @@ impl TelemetryState { self.client_updates_submitted.add(&cx, count, labels); } + /// Update the number of client updates skipped per client + pub fn client_updates_skipped( + &self, + src_chain: &ChainId, + dst_chain: &ChainId, + client: &ClientId, + count: u64, + ) { + let cx = Context::current(); + + let labels = &[ + KeyValue::new("src_chain", src_chain.to_string()), + KeyValue::new("dst_chain", dst_chain.to_string()), + KeyValue::new("client", client.to_string()), + ]; + + self.client_updates_skipped.add(&cx, count, labels); + } + /// Number of client misbehaviours per client pub fn client_misbehaviours_submitted( &self, @@ -1040,6 +1079,20 @@ impl TelemetryState { pub fn add_visible_fee_address(&self, address: String) { self.visible_fee_addresses.insert(address); } + + /// Add an error and its description to the list of errors observed after broadcasting + /// a Tx with a specific account. + pub fn broadcast_errors(&self, address: &String, error_code: u32, error_description: &String) { + let cx = Context::current(); + + let labels = &[ + KeyValue::new("account", address.to_string()), + KeyValue::new("error_code", error_code.to_string()), + KeyValue::new("error_description", error_description.to_string()), + ]; + + self.broadcast_errors.add(&cx, 1, labels); + } } use std::sync::Arc; diff --git a/guide/README.md b/guide/README.md index b4713bfebf..421f7a1afa 100644 --- a/guide/README.md +++ b/guide/README.md @@ -10,7 +10,7 @@ mdBook is a utility to create modern online books from Markdown files. This guide should be permanently deployed at its latest stable version at [hermes.informal.systems](https://hermes.informal.systems). -Current version: `v1.7.1`. +Current version: `v1.7.2`. The version of this guide is aligned with the [versioning of the ibc crates](../README.md). diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index 0f4e106282..8b8abe50f0 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -# Hermes v1.7.1 +# Hermes v1.7.2 --- - [Introduction](./index.md) diff --git a/guide/src/documentation/configuration/configure-hermes.md b/guide/src/documentation/configuration/configure-hermes.md index a81924147a..cec76e4fb7 100644 --- a/guide/src/documentation/configuration/configure-hermes.md +++ b/guide/src/documentation/configuration/configure-hermes.md @@ -160,7 +160,7 @@ event_source = { mode = 'push', url = 'wss://hello:world@mydomain.com:26657/webs ## Configuring Support for Wasm Relaying -As of version 1.7.1, Hermes supports the relaying of wasm messages natively. This is facilitated by configuring +Hermes supports the relaying of wasm messages natively. This is facilitated by configuring Hermes to use pull-based relaying by polling for IBC events via the `/block_results` RPC endpoint. Set the `event_source` parameter to pull mode in `config.toml` like so: diff --git a/guide/src/documentation/telemetry/integration.md b/guide/src/documentation/telemetry/integration.md index ec67507c3c..451f95b9a7 100644 --- a/guide/src/documentation/telemetry/integration.md +++ b/guide/src/documentation/telemetry/integration.md @@ -34,6 +34,10 @@ backlog_size{chain="ibc-1",channel="channel-0",counterparty="ibc-0",port="transf # TYPE client_updates_submitted_total counter client_updates_submitted_total{client="07-tendermint-0",dst_chain="ibc-0",service_name="unknown_service",src_chain="ibc-1",otel_scope_name="hermes",otel_scope_version=""} 2 client_updates_submitted_total{client="07-tendermint-0",dst_chain="ibc-1",service_name="unknown_service",src_chain="ibc-0",otel_scope_name="hermes",otel_scope_version=""} 2 +# HELP client_updates_skipped_total Number of client update messages skipped +# TYPE client_updates_skipped_total counter +client_updates_skipped_total{client="07-tendermint-0",dst_chain="ibc-0",service_name="unknown_service",src_chain="ibc-1",otel_scope_name="hermes",otel_scope_version=""} 0 +client_updates_skipped_total{client="07-tendermint-0",dst_chain="ibc-1",service_name="unknown_service",src_chain="ibc-0",otel_scope_name="hermes",otel_scope_version=""} 0 # HELP ics29_period_fees Amount of ICS29 fees rewarded over the past 7 days # TYPE ics29_period_fees gauge ics29_period_fees{chain="ibc-0",denom="stake",receiver="cosmos1j6z6q9d2gf2suav88z8g3zf726vz9ehg4hkr8x",service_name="unknown_service",otel_scope_name="hermes",otel_scope_version=""} 0 diff --git a/guide/src/documentation/telemetry/operators.md b/guide/src/documentation/telemetry/operators.md index e98d903f05..c550232beb 100644 --- a/guide/src/documentation/telemetry/operators.md +++ b/guide/src/documentation/telemetry/operators.md @@ -34,6 +34,7 @@ The metrics in the table below are design to answer this question on multiple di | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -------------------------- | | `workers` | Number of workers per type | `i64` UpDownCounter | Corresponding workers enabled | | `client_updates_submitted_total` | Number of client update messages submitted, per sending chain, receiving chain and client | `u64` Counter | Client, Connection, Channel or Packet workers enabled | +| `client_updates_skipped_total` | Number of client update messages skipped because the consensus state already exists, per sending chain, receiving chain and client | `u64` Counter | Client, Connection, Channel or Packet workers enabled | | `wallet_balance` | The balance of each wallet Hermes uses per chain | `f64` ValueRecorder | None | | `tx_latency_submitted` | Latency for all transactions submitted to a chain | `u64` ValueRecorder | None | | `messages_submitted_total` | Number of messages submitted to a specific chain | `u64` Counter | None | @@ -141,6 +142,7 @@ the `backlog_oldest_sequence` that is blocked. | `tx_latency_submitted` | Latency for all transactions submitted to a chain (i.e., difference between the moment when Hermes received an event until the corresponding transaction(s) were submitted), per chain, counterparty chain, channel and port | `u64` ValueRecorder | None | | `cleared_send_packet_count_total`  | Number of SendPacket events received during the initial and periodic clearing, per chain, counterparty chain, channel and port | `u64` Counter | Packet workers enabled, and periodic packet clearing or clear on start enabled | | `cleared_acknowledgment_count_total` | Number of WriteAcknowledgement events received during the initial and periodic clearing, per chain, counterparty chain, channel and port | `u64` Counter | Packet workers enabled, and periodic packet clearing or clear on start enabled | +| `broadcast_errors_total` | Number of errors observed by Hermes when broadcasting a Tx, per error type and account | `u64` Counter | Packet workers enabled | Notes: - The two metrics `cleared_send_packet_count_total` and `cleared_acknowledgment_count_total` are only populated if `tx_confirmation = true`. diff --git a/guide/src/templates/hermes-version.md b/guide/src/templates/hermes-version.md index a97fc4411a..3b34d22941 100644 --- a/guide/src/templates/hermes-version.md +++ b/guide/src/templates/hermes-version.md @@ -1 +1 @@ -v1.7.1 +v1.7.2 diff --git a/tools/integration-test/Cargo.toml b/tools/integration-test/Cargo.toml index 19779b6f6a..ba2fc667e3 100644 --- a/tools/integration-test/Cargo.toml +++ b/tools/integration-test/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-integration-test" -version = "0.26.1" +version = "0.26.2" edition = "2021" rust-version = "1.70" license = "Apache-2.0" diff --git a/tools/test-framework/Cargo.toml b/tools/test-framework/Cargo.toml index 39764e7c2b..9945ce501e 100644 --- a/tools/test-framework/Cargo.toml +++ b/tools/test-framework/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-test-framework" -version = "0.26.1" +version = "0.26.2" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -14,9 +14,9 @@ description = """ """ [dependencies] -ibc-relayer-types = { version = "=0.26.1", path = "../../crates/relayer-types" } -ibc-relayer = { version = "=0.26.1", path = "../../crates/relayer" } -ibc-relayer-cli = { version = "=1.7.1", path = "../../crates/relayer-cli" } +ibc-relayer-types = { version = "=0.26.2", path = "../../crates/relayer-types" } +ibc-relayer = { version = "=0.26.2", path = "../../crates/relayer" } +ibc-relayer-cli = { version = "=1.7.2", path = "../../crates/relayer-cli" } ibc-proto = { version = "0.38.0", features = ["serde"] } tendermint-rpc = { version = "0.34.0", features = ["http-client", "websocket-client"] } diff --git a/tools/test-framework/src/relayer/driver.rs b/tools/test-framework/src/relayer/driver.rs index 4e16c3483d..967df6355b 100644 --- a/tools/test-framework/src/relayer/driver.rs +++ b/tools/test-framework/src/relayer/driver.rs @@ -30,7 +30,7 @@ pub struct RelayerDriver { /** The relayer [`Config`]. Use this config when spawning new supervisor - using [`spawn_supervisor`](ibc_relayer::supervisor::spawn_supervisor). + using [`spawn_supervisor`]. */ pub config: Config, @@ -39,7 +39,7 @@ pub struct RelayerDriver { that is shared with any running supervisor. Use this shared registry when spawning new supervisor using - [`spawn_supervisor`](ibc_relayer::supervisor::spawn_supervisor). + [`spawn_supervisor`]. */ pub registry: SharedRegistry, diff --git a/tools/test-framework/src/types/id.rs b/tools/test-framework/src/types/id.rs index 8d5884aa8a..d103a7ab5b 100644 --- a/tools/test-framework/src/types/id.rs +++ b/tools/test-framework/src/types/id.rs @@ -37,7 +37,7 @@ pub type TaggedClientIdRef<'a, ChainA, ChainB> = DualTagged = DualTagged; /** - A reference to [`PortId`](PortId) tagged with first, the host chain + A reference to [`PortId`] tagged with first, the host chain that has the port ID, and second, the counterparty chain that the port ID corresponds to. */