Release Hermes v1.7.4

.changelog/v1.7.4/bug-fixes/ibc-relayer-cli/3697-fix-evidence-report.md

@@ -0,0 +1,4 @@
+- Fix a bug in the `evidence` command which would sometimes
+ prevent the detected misbehaviour evidence from being submitted,
+ instead erroring out with a validator set hash mismatch.
+ ([\#3697](https://github.com/informalsystems/hermes/pull/3697))

.changelog/v1.7.4/bug-fixes/ibc-relayer/3703-avoid-returning-stopped-worker.md

@@ -0,0 +1,3 @@
+- Avoid retrieving a worker which is being removed by the idle worker clean-up
+ process.
+ process ([\#3703](https://github.com/informalsystems/hermes/issues/3703))

.changelog/v1.7.4/bug-fixes/ibc-telemetry/3720-fix-broadcasting-errors-metric.md

@@ -0,0 +1,3 @@
+- Fix the issue where `broadcast_errors` metric would not correctly batch
+ the same errors together.
+ together ([\#3720](https://github.com/informalsystems/hermes/issues/3720))

.changelog/v1.7.4/bug-fixes/ibc-telemetry/3723-fix-backlog-metrics.md

@@ -0,0 +1,4 @@
+- Update the values of `backlog` metrics when clearing packets.
+ Change the `backlog_oldest_timestamp` to `backlog_latest_update_timestamp`
+ which shows the last time the `backlog` metrics have been updated.
+ ([\#3723](https://github.com/informalsystems/hermes/issues/3723))

.changelog/v1.7.4/summary.md

@@ -0,0 +1,9 @@
+*December 15th, 2023*
+
+This release improves the monitoring of Hermes instances by fixing the `broadcast_errors` metric so
+that it correctly batches the same errors together. It also improves the metrics `backlog_*` by
+updating them whenever Hermes queries pending packets.
+
+This release also improves the reliability of the idle worker clean-up and 
+fixes a bug within the `evidence` command which would sometimes prevent
+the misbehaviour evidence from being reported.

CHANGELOG.md

@@ -1,5 +1,42 @@
 # CHANGELOG
 
+## v1.7.4
+
+*December 15th, 2023*
+
+Special thanks to Yun Yeo (@beer-1) for his contributions ([#3697] and [#3703]).
+
+This release improves the monitoring of Hermes instances by fixing the `broadcast_errors` metric so
+that it correctly batches the same errors together. It also improves the metrics `backlog_*` by
+updating them whenever Hermes queries pending packets.
+
+This release also improves the reliability of the idle worker clean-up and 
+fixes a bug within the `evidence` command which would sometimes prevent
+the misbehaviour evidence from being reported.
+
+### BUG FIXES
+
+- [Relayer Library](relayer)
+ - Avoid retrieving a worker which is being removed by the idle worker clean-up
+ process.
+ process ([\#3703](https://github.com/informalsystems/hermes/issues/3703))
+- [Relayer CLI](relayer-cli)
+ - Fix a bug in the `evidence` command which would sometimes
+ prevent the detected misbehaviour evidence from being submitted,
+ instead erroring out with a validator set hash mismatch.
+ ([\#3697](https://github.com/informalsystems/hermes/pull/3697))
+- [Telemetry & Metrics](telemetry)
+ - Fix the issue where `broadcast_errors` metric would not correctly batch
+ the same errors together.
+ together ([\#3720](https://github.com/informalsystems/hermes/issues/3720))
+ - Update the values of `backlog` metrics when clearing packets.
+ Change the `backlog_oldest_timestamp` to `backlog_latest_update_timestamp`
+ which shows the last time the `backlog` metrics have been updated.
+ ([\#3723](https://github.com/informalsystems/hermes/issues/3723))
+
+[#3697]: https://github.com/informalsystems/hermes/issues/3697
+[#3703]: https://github.com/informalsystems/hermes/issues/3703
+
 ## v1.7.3
 
 *November 29th, 2023*

crates/chain-registry/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-chain-registry"
-version = "0.26.3"
+version = "0.26.4"
 edition = "2021"
 license = "Apache-2.0"
 keywords = ["cosmos", "ibc", "relayer", "chain", "registry"]
@@ -12,7 +12,7 @@ description = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.26.3", path = "../relayer-types" }
+ibc-relayer-types = { version = "0.26.4", path = "../relayer-types" }
 ibc-proto = { version = "0.38.0", features = ["serde"] }
 tendermint-rpc = { version = "0.34.0", features = ["http-client", "websocket-client"] }
 

crates/relayer-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-relayer-cli"
-version = "1.7.3"
+version = "1.7.4"
 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.3", path = "../relayer-types" }
-ibc-relayer = { version = "0.26.3", path = "../relayer" }
-ibc-telemetry = { version = "0.26.3", path = "../telemetry", optional = true }
-ibc-relayer-rest = { version = "0.26.3", path = "../relayer-rest", optional = true }
-ibc-chain-registry = { version = "0.26.3" , path = "../chain-registry" }
+ibc-relayer-types = { version = "0.26.4", path = "../relayer-types" }
+ibc-relayer = { version = "0.26.4", path = "../relayer" }
+ibc-telemetry = { version = "0.26.4", path = "../telemetry", optional = true }
+ibc-relayer-rest = { version = "0.26.4", path = "../relayer-rest", optional = true }
+ibc-chain-registry = { version = "0.26.4" , path = "../chain-registry" }
 
 clap = { version = "3.2", features = ["cargo"] }
 clap_complete = "3.2"

crates/relayer-rest/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-relayer-rest"
-version = "0.26.3"
+version = "0.26.4"
 authors = ["Informal Systems <hello@informal.systems>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -14,8 +14,8 @@ description = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.26.3", path = "../relayer-types" }
-ibc-relayer = { version = "0.26.3", path = "../relayer" }
+ibc-relayer-types = { version = "0.26.4", path = "../relayer-types" }
+ibc-relayer = { version = "0.26.4", path = "../relayer" }
 
 crossbeam-channel = "0.5"
 serde = "1.0"

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.3".to_string(),
+ version: "0.26.4".to_string(),
  };
 
  let result: JsonResult<_, ()> = JsonResult::Success(vec![version.clone(), rest_api_version]);

crates/relayer-types/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-relayer-types"
-version = "0.26.3"
+version = "0.26.4"
 edition = "2021"
 license = "Apache-2.0"
 readme = "README.md"

crates/relayer/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-relayer"
-version = "0.26.3"
+version = "0.26.4"
 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.3", path = "../telemetry", optional = true }
-ibc-relayer-types = { version = "0.26.3", path = "../relayer-types", features = ["mocks"] }
+ibc-telemetry = { version = "0.26.4", path = "../telemetry", optional = true }
+ibc-relayer-types = { version = "0.26.4", 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.3", path = "../relayer-types", features = ["mocks"] }
+ibc-relayer-types = { version = "0.26.4", 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"] }

crates/relayer/src/chain/counterparty.rs

@@ -32,6 +32,7 @@ use crate::channel::ChannelError;
 use crate::client_state::IdentifiedAnyClientState;
 use crate::path::PathIdentifiers;
 use crate::supervisor::Error;
+use crate::telemetry;
 
 pub fn counterparty_chain_from_connection(
  src_chain: &impl ChainHandle,
@@ -502,6 +503,19 @@ pub fn unreceived_packets(
  &path.counterparty_channel_id,
  )?;
 
+ telemetry!(
+ update_backlog,
+ commit_sequences
+ .iter()
+ .map(|s| u64::from(*s))
+ .collect::<Vec<u64>>()
+ .clone(),
+ &counterparty_chain.id(),
+ &path.counterparty_channel_id,
+ &path.counterparty_port_id,
+ &chain.id()
+ );
+
  let packet_seq_nrs =
  unreceived_packets_sequences(chain, &path.port_id, &path.channel_id, commit_sequences)?;
 

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/1.7.2/
+//! [Hermes]: https://docs.rs/ibc-relayer-cli/1.7.4/
 
 extern crate alloc;
 

crates/relayer/src/light_client/tendermint.rs

@@ -173,7 +173,8 @@ impl super::LightClient<CosmosSdkChain> for LightClient {
  provider: self.peer_id,
  };
 
- let trusted_block = self.fetch(update_header.trusted_height)?;
+ // Get the light block at trusted_height + 1 from chain.
+ let trusted_block = self.fetch(update_header.trusted_height.increment())?;
  if trusted_block.validators.hash() != update_header.trusted_validator_set.hash() {
  return Err(Error::misbehaviour(format!(
  "mismatch between the trusted validator set of the update \

crates/relayer/src/worker/map.rs

@@ -125,7 +125,17 @@ impl WorkerMap {
  config: &Config,
  ) -> &WorkerHandle {
  if self.workers.contains_key(&object) {
- &self.workers[&object]
+ if self.workers[&object].shutdown_stopped_tasks() {
+ self.remove_stopped(
+ self.workers[&object].id(),
+ self.workers[&object].object().clone(),
+ );
+
+ let worker = self.spawn_worker(src, dst, &object, config);
+ self.workers.entry(object).or_insert(worker)
+ } else {
+ &self.workers[&object]
+ }
  } else {
  let worker = self.spawn_worker(src, dst, &object, config);
  self.workers.entry(object).or_insert(worker)

crates/telemetry/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibc-telemetry"
-version = "0.26.3"
+version = "0.26.4"
 edition = "2021"
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,7 +13,7 @@ description = """
 """
 
 [dependencies]
-ibc-relayer-types = { version = "0.26.3", path = "../relayer-types" }
+ibc-relayer-types = { version = "0.26.4", path = "../relayer-types" }
 
 once_cell = "1.17.0"
 opentelemetry = { version = "0.19.0", features = ["metrics"] }