Release Hermes v1.8.1 (#3876)

* Build release changelog * Bump version number * Fix typos * Update CHANGELOG.md Co-authored-by: Romain Ruetschi <[email protected]> Signed-off-by: Luca Joss <[email protected]> * Update changelog --------- Signed-off-by: Luca Joss <[email protected]> Co-authored-by: Romain Ruetschi <[email protected]>
informalsystems · Mar 7, 2024 · 79d10c5 · 79d10c5
1 parent cac00ee
commit 79d10c5
Show file tree

Hide file tree

Showing 24 changed files with 126 additions and 36 deletions.
diff --git a/.../ibc-relayer/3770-non-utf8-packet-data.md → .../ibc-relayer/3770-non-utf8-packet-data.md b/.../ibc-relayer/3770-non-utf8-packet-data.md → .../ibc-relayer/3770-non-utf8-packet-data.md
@@ -2,5 +2,5 @@
   Hermes does not assume anymore that an ICS-04 packet data is valid UTF-8,
   by using the `packet_data_hex` attribute when assembling a packet from events, instead of the deprecated `packet_data` attribute.
   Relying on the `packet_data` attribute enforces a UTF-8 encoded payload (eg. JSON), disallowing eg. Protobuf-encoded payloads.
-  The `packet_data` atttribute [has been deprecated][0] in favor of `packet_data_hex` since IBC-Go v1.0.0.
+  The `packet_data` attribute [has been deprecated][0] in favor of `packet_data_hex` since IBC-Go v1.0.0.
   [0]: https://github.com/cosmos/ibc-go/blob/fadf8f2b0ab184798d021d220d877e00c7634e26/CHANGELOG.md?plain=1#L1417
diff --git a/...s/ibc-relayer/3831-better-compat-check.md → ...s/ibc-relayer/3831-better-compat-check.md b/...s/ibc-relayer/3831-better-compat-check.md → ...s/ibc-relayer/3831-better-compat-check.md
diff --git a/...bc-relayer/3754-filter-packet-clearing.md → ...bc-relayer/3754-filter-packet-clearing.md b/...bc-relayer/3754-filter-packet-clearing.md → ...bc-relayer/3754-filter-packet-clearing.md
diff --git a/...bc-relayer/3811-relayer-memo-overwrite.md → ...bc-relayer/3811-relayer-memo-overwrite.md b/...bc-relayer/3811-relayer-memo-overwrite.md → ...bc-relayer/3811-relayer-memo-overwrite.md
@@ -1,3 +1,3 @@
 - Add a per-chain configuration `memo_overwrite` allowing users
-  to overwite the relayer memo used for each transaction
+  to overwrite the relayer memo used for each transaction
   ([\#3811](https://github.com/informalsystems/hermes/issues/3811))
diff --git a/...emetry/3845-add-simulate-errors-metric.md → ...emetry/3845-add-simulate-errors-metric.md b/...emetry/3845-add-simulate-errors-metric.md → ...emetry/3845-add-simulate-errors-metric.md
diff --git a/...eleased/improvements/3814-grpc-syncing.md → .../v1.8.1/improvements/3814-grpc-syncing.md b/...eleased/improvements/3814-grpc-syncing.md → .../v1.8.1/improvements/3814-grpc-syncing.md
diff --git a/...s/3814-status-use-client-latest-height.md → ...s/3814-status-use-client-latest-height.md b/...s/3814-status-use-client-latest-height.md → ...s/3814-status-use-client-latest-height.md
diff --git a/.../ibc-relayer/3530-out-of-gas-error-log.md → .../ibc-relayer/3530-out-of-gas-error-log.md b/.../ibc-relayer/3530-out-of-gas-error-log.md → .../ibc-relayer/3530-out-of-gas-error-log.md
diff --git a/...layer/3540-ordered-channels-resilience.md → ...layer/3540-ordered-channels-resilience.md b/...layer/3540-ordered-channels-resilience.md → ...layer/3540-ordered-channels-resilience.md
diff --git a/...ibc-relayer-cli/3792-legacy-simulation.md → ...nts/ibc-relayer/3792-legacy-simulation.md b/...ibc-relayer-cli/3792-legacy-simulation.md → ...nts/ibc-relayer/3792-legacy-simulation.md
diff --git a/.changelog/v1.8.1/summary.md b/.changelog/v1.8.1/summary.md
@@ -0,0 +1,19 @@
+*March 6th, 2024*
+
+This release improves reliability when relaying, more enhanced configuration and improved monitoring.
+
+Reliability has been improved:
+* It is now possible to relay ICS-04 packets with non-UTF-8 payloads
+* Packet sequences are now verified for ordered channels before trying to relay
+
+Additional per-chain configurations have been added:
+* `excluded_sequences` used to skip problematic packets when clearing
+* `memo_overwrite` allowing users to overwrite the relayer memo when chains have a
+strict limit for the size of the memo
+
+Monitoring issues improvements:
+* A new metric `simulate_errors` which counts the number of failed simulated transactions
+* Out of gas error diagnostic gives more information and a dedicated entry to the guide has been added
+* Failed gas simulation will not be considered as unrecoverable for legacy chains
+* The compatibility check during the health-check has been improved will assess more correctly the versions
+  for Ibc-Go and Cosmos SDK
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,76 @@
 # CHANGELOG
 
+## v1.8.1
+
+*March 7th, 2024*
+
+This v1.8.1 release brings better reliability when relaying, more enhanced configuration and improved monitoring.
+
+Reliability has been improved:
+* It is now possible to relay ICS-04 packets with non-UTF-8 payloads
+* Packet sequences are now verified for ordered channels before trying to relay
+
+Additional per-chain configurations have been added:
+* `excluded_sequences` used to skip problematic packets when clearing
+* `memo_overwrite` allowing users to overwrite the relayer memo when chains have a strict limit for the size of the memo.
+
+Monitoring issues improvements:
+* A new metric `simulate_errors` which counts the number of failed simulated transactions
+* Out of gas error diagnostic gives more information and a dedicated entry to the guide has been added
+* Failed gas simulation will not be considered as unrecoverable for legacy chains.
+* The compatibility check during the health-check has been improved will assess more correctly the versions for Ibc-Go and Cosmos SDK
+
+Special thanks to our contributors for their valuable additions to this release:
+
+* Sergey (@freak12techno) for adding the `simulate_errors` metric ([#3845])
+* Martin Dyring-Andersen (@mdyring) for adding recovery from failed gas simulation for legacy chains ([#3792])
+
+### BUG FIXES
+
+- Allow relaying ICS-04 packets with non-UTF-8 payloads ([\#3770](https://github.com/informalsystems/hermes/issues/3770))
+  Hermes does not assume anymore that an ICS-04 packet data is valid UTF-8,
+  by using the `packet_data_hex` attribute when assembling a packet from events, instead of the deprecated `packet_data` attribute.
+  Relying on the `packet_data` attribute enforces a UTF-8 encoded payload (eg. JSON), disallowing eg. Protobuf-encoded payloads.
+  The `packet_data` attribute [has been deprecated][0] in favor of `packet_data_hex` since IBC-Go v1.0.0.
+- Improve reliability of compatibility check and fix parsing of expected modules versions ([\#3831](https://github.com/informalsystems/hermes/issues/3831))
+
+[0]: https://github.com/cosmos/ibc-go/blob/fadf8f2b0ab184798d021d220d877e00c7634e26/CHANGELOG.md?plain=1#L1417
+
+### FEATURES
+
+- Add a per-chain configuration `excluded_sequences` allowing users to specify a list of packet sequences which will not be cleared.
+  This configuration has no impact on standard packet relaying.
+  ([\#3754](https://github.com/informalsystems/hermes/issues/3754))
+- Add a per-chain configuration `memo_overwrite` allowing users to overwrite the relayer memo used for each transaction
+  ([\#3811](https://github.com/informalsystems/hermes/issues/3811))
+- Added a new Prometheus metric `simulate_errors` for tracking when a transaction simulation fails, with the following labels:
+  ([\#3845](https://github.com/informalsystems/hermes/issues/3845))
+  * `recoverable` (can the execution continue if this happened?)
+  * `account` (account from which the tx was sent)
+  * `error_description` (description of the error)
+
+    ```
+    # HELP simulate_errors_total Number of errors observed by Hermes when simulating a Tx
+    # TYPE simulate_errors_total counter
+    simulate_errors_total{account="osmo17ndx5qfku28ymxgmq6zq4a6d02dvpfjjul0hyh",error_description="Unknown error",recoverable="false",service_name="unknown_service",otel_scope_name="hermes",otel_scope_version=""} 4
+    ```
+
+### IMPROVEMENTS
+
+- Use the consensus state at client latest height in status CLI ([#3814](https://github.com/informalsystems/ibc-rs/issues/3814))
+- Add syncing check for gRPC node ([#3814](https://github.com/informalsystems/ibc-rs/issues/3814))
+- Improve the log diagnostic when an out of gas error is thrown.
+  And a new entry related to gas error has been added to the Hermes guide.
+  ([\#3530](https://github.com/informalsystems/hermes/issues/3530))
+- Improve resilience when relaying on ordered channels.
+  When relaying packets on an ordered channel, Hermes will now attempt
+  to detect whether the next message to send has the sequence number
+  expected on that channel. If there is a mismatch, then Hermes will trigger a packet
+  clear on the channel to unblock it before resuming operations on that channel.
+  ([\#3540](https://github.com/informalsystems/hermes/issues/3540))
+- Recover from gas simulation failures on legacy chains.
+  ([\#3792](https://github.com/informalsystems/hermes/issues/3792))
+
 ## v1.8.0
 
 *January 23rd, 2024*

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.27.0"
+version      = "0.27.1"
 edition      = "2021"
 license      = "Apache-2.0"
 keywords     = ["cosmos", "ibc", "relayer", "chain", "registry"]
@@ -12,7 +12,7 @@ description  = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.27.0", path = "../relayer-types" }
+ibc-relayer-types = { version = "0.27.1", path = "../relayer-types" }
 ibc-proto         = { version = "0.42.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.8.0"
+version    = "1.8.1"
 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.27.0", path = "../relayer-types" }
-ibc-relayer        = { version = "0.27.0", path = "../relayer" }
-ibc-telemetry      = { version = "0.27.0", path = "../telemetry", optional = true }
-ibc-relayer-rest   = { version = "0.27.0", path = "../relayer-rest", optional = true }
-ibc-chain-registry = { version = "0.27.0" , path = "../chain-registry" }
+ibc-relayer-types  = { version = "0.27.1", path = "../relayer-types" }
+ibc-relayer        = { version = "0.27.1", path = "../relayer" }
+ibc-telemetry      = { version = "0.27.1", path = "../telemetry", optional = true }
+ibc-relayer-rest   = { version = "0.27.1", path = "../relayer-rest", optional = true }
+ibc-chain-registry = { version = "0.27.1" , 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.27.0"
+version      = "0.27.1"
 authors      = ["Informal Systems <[email protected]>"]
 edition      = "2021"
 license      = "Apache-2.0"
@@ -14,8 +14,8 @@ description  = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.27.0", path = "../relayer-types" }
-ibc-relayer       = { version = "0.27.0", path = "../relayer" }
+ibc-relayer-types = { version = "0.27.1", path = "../relayer-types" }
+ibc-relayer       = { version = "0.27.1", 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.27.0".to_string(),
+        version: "0.27.1".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.27.0"
+version      = "0.27.1"
 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.27.0"
+version      = "0.27.1"
 edition      = "2021"
 license      = "Apache-2.0"
 readme       = "README.md"
@@ -21,8 +21,8 @@ telemetry = ["ibc-telemetry"]
 
 [dependencies]
 ibc-proto         = { version = "0.42.0", features = ["serde"] }
-ibc-telemetry     = { version = "0.27.0", path = "../telemetry", optional = true }
-ibc-relayer-types = { version = "0.27.0", path = "../relayer-types", features = ["mocks"] }
+ibc-telemetry     = { version = "0.27.1", path = "../telemetry", optional = true }
+ibc-relayer-types = { version = "0.27.1", path = "../relayer-types", features = ["mocks"] }
 
 subtle-encoding = "0.5"
 humantime-serde = "1.1.1"
@@ -110,7 +110,7 @@ version = "0.34.0"
 default-features = false
 
 [dev-dependencies]
-ibc-relayer-types = { version = "0.27.0", path = "../relayer-types", features = ["mocks"] }
+ibc-relayer-types = { version = "0.27.1", path = "../relayer-types", features = ["mocks"] }
 serial_test = "3.0.0"
 env_logger = "0.11.1"
 test-log = { version = "0.2.14", features = ["trace"] }

diff --git a/crates/relayer/src/lib.rs b/crates/relayer/src/lib.rs
@@ -15,7 +15,7 @@
 //!
 //! For the IBC relayer binary, please see [Hermes] (`ibc-relayer-cli` crate).
 //!
-//! [Hermes]: https://docs.rs/ibc-relayer-cli/1.8.0/
+//! [Hermes]: https://docs.rs/ibc-relayer-cli/1.8.1/
 
 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.27.0"
+version      = "0.27.1"
 edition      = "2021"
 license      = "Apache-2.0"
 readme       = "README.md"
@@ -13,7 +13,7 @@ description  = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.27.0", path = "../relayer-types" }
+ibc-relayer-types = { version = "0.27.1", path = "../relayer-types" }
 
 once_cell                = "1.19.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.8.0`.
+Current version: `v1.8.1`.
 
 The version of this guide is aligned with the [versioning of the ibc crates](../README.md).
 

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.27.0"
+version      = "0.27.1"
 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.27.0"
+version    = "0.27.1"
 edition    = "2021"
 license    = "Apache-2.0"
 readme     = "README.md"
@@ -14,9 +14,9 @@ description = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "=0.27.0",     path = "../../crates/relayer-types" }
-ibc-relayer       = { version = "=0.27.0",     path = "../../crates/relayer" }
-ibc-relayer-cli   = { version = "=1.8.0",      path = "../../crates/relayer-cli" }
+ibc-relayer-types = { version = "=0.27.1",     path = "../../crates/relayer-types" }
+ibc-relayer       = { version = "=0.27.1",     path = "../../crates/relayer" }
+ibc-relayer-cli   = { version = "=1.8.1",      path = "../../crates/relayer-cli" }
 ibc-proto         = { version = "0.42.0", features = ["serde"] }
 tendermint-rpc    = { version = "0.34.0", features = ["http-client", "websocket-client"] }