Update master with v1.7.2 release changes (#3712)

informalsystems · Nov 29, 2023 · 3912f41 · 3912f41
1 parent e8e73ff
commit 3912f41
Show file tree

Hide file tree

Showing 23 changed files with 75 additions and 43 deletions.
diff --git a/.changelog/unreleased/features/ibc-telemetry/3708-add-broadcast-errors.md b/.changelog/unreleased/features/ibc-telemetry/3708-add-broadcast-errors.md
diff --git a/...etry/3707-skipped-client-update-metric.md → ...etry/3707-skipped-client-update-metric.md b/...etry/3707-skipped-client-update-metric.md → ...etry/3707-skipped-client-update-metric.md
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
@@ -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))
diff --git a/.changelog/v1.7.2/summary.md 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
@@ -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
diff --git 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.39.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
@@ -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
@@ -1,6 +1,6 @@
 [package]
 name         = "ibc-relayer-rest"
-version      = "0.26.1"
+version      = "0.26.2"
 authors      = ["Informal Systems <[email protected]>"]
 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
@@ -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
@@ -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
@@ -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.39.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"
@@ -109,7 +109,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"
 test-log = { version = "0.2.10", features = ["trace"] }

diff --git 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,
@@ -126,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;

diff --git a/crates/relayer/src/lib.rs b/crates/relayer/src/lib.rs
@@ -16,7 +16,7 @@
 //!
 //! For the IBC relayer binary, please see [Hermes] (`ibc-relayer-cli` crate).
 //!
-//! [Hermes]: https://docs.rs/ibc-relayer-cli/0.2.0/
+//! [Hermes]: https://docs.rs/ibc-relayer-cli/1.7.2/
 
 extern crate alloc;
 

diff --git a/crates/telemetry/Cargo.toml b/crates/telemetry/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name         = "ibc-telemetry"
-version      = "0.26.1"
+version      = "0.26.2"
 edition      = "2021"
 license      = "Apache-2.0"
 readme       = "README.md"
@@ -13,7 +13,7 @@ description  = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.26.1", path = "../relayer-types" }
+ibc-relayer-types = { version = "0.26.2", path = "../relayer-types" }
 
 once_cell                = "1.17.0"
 opentelemetry            = { version = "0.19.0", features = ["metrics"] }

diff --git 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
@@ -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
@@ -160,7 +160,7 @@ event_source = { mode = 'push', url = 'wss://hello:[email protected]: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/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
@@ -1,6 +1,6 @@
 [package]
 name         = "ibc-integration-test"
-version      = "0.26.1"
+version      = "0.26.2"
 edition      = "2021"
 rust-version = "1.71"
 license      = "Apache-2.0"

diff --git 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.39.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
@@ -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<CountingAndCachingChainHandle>,
 

diff --git 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<ChainA, ChainB, &'a
 pub type TaggedPortId<ChainA, ChainB> = DualTagged<ChainA, ChainB, PortId>;
 
 /**
-   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.
 */