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.
- Relayer CLI
- Fix a bug in the
evidencecommand which would sometimes prevent the detected misbehaviour evidence from being submitted, instead erroring out with a validator set hash mismatch. (#3697)
- Fix a bug in the
- Relayer Library
- Avoid retrieving a worker which is being removed by the idle worker clean-up process. (#3703)
- Telemetry & Metrics
- Fix the issue where
broadcast_errorsmetric would not correctly batch the same errors together.(#3720) - Update the values of
backlogmetrics when clearing packets. Change thebacklog_oldest_timestamptobacklog_latest_update_timestampwhich shows the last time thebacklogmetrics have been updated. (#3723)
- Fix the issue where
November 29th, 2023
This release improves the reliability of the evidence command and
fixes a bug that was preventing evidence to be reported,
as seen on the Gaia RS testnet.
- Relayer CLI
- Improve reliability of
evidencecommand and fix a bug that was preventing evidence to be reported, as seen on the Gaia RS testnet (#3702)
- Improve reliability of
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_errorsrecords the number of times a specific error is observed by Hermes when broadcasting transactions.client_updates_skippedrecords the number of client updates skipped due to the consensus states already existing.
November 13th, 2023
This patch release of Hermes now allows operators to set the clearing interval
at a different value for each chain, using the new per-chain clear_interval setting.
The global clear_interval setting is used as a default value if the per-chain
setting is not defined.
Additionally, operators can now override the CometBFT compatibility mode to be used
for a chain by using the new compat_mode per-chain setting. The main use case for this
is to override the automatically detected compatibility mode in case Hermes gets it wrong
or encounters a non-standard version number and falls back on the wrong CometBFT version.
On top of that, Hermes will now attempt to save on fees by not building a client update for a given height if the consensus state for that height is already present on chain.
- Add an optional per-chain setting
compat_mode, which can be used to specify which CometBFT compatibility mode is used for interacting with the node over RPC. (#3623) - Add a configuration which allows to override the
clear_intervalfor specific chains (#3691)
- Hermes now saves on fees by not including a client update if the consensus state at desired height is already present on chain. (#3521)
October 20th, 2023
This v1.7 release introduces new features and improvements to Hermes.
One of the key highlights is the addition of new misbehavior detection features.
- Hermes now includes a new command called
evidence, which monitors the blocks emitted by a chain for any presence of misbehavior evidence. - If misbehavior is detected, the CLI will report that evidence to all counterparty clients of that chain. On top of that, misbehavior evidence detected on a chain that is a CCV (Cross-Chain Validation) consumer is now sent to its provider chain, alerting it directly of the misbehaving consumer chain.
- Furthermore, when misbehavior is detected from an on-chain client, such as a light client attack or a double-sign, the evidence is now submitted to all counterparty clients of the misbehaving chain, rather than just the counterparty client of the misbehaving client.
In addition, the REST server of Hermes now has a /clear_packets endpoint which allows triggering
packet clearing for a specific chain or all chains if no specific chain is provided.
Another notable improvement is the ability to change tracing directives at runtime.
This feature lets users adjust tracing settings dynamically as needed, providing a more
customizable and efficient debugging experience.
Overall, the new misbehavior detection features in Hermes contribute to a more robust and secure environment, enabling timely identification and response to potential misbehaving actors.
- Relayer CLI
- Add a new
evidencecommand for monitoring the blocks emitted by a chain for the presence of a misbehaviour evidence, and report that evidence to all counteparty clients of that chain. (#3456) - Add a
/clear_packets?chain=CHAIN_IDendpoint to the built-in REST server to trigger packet clear for the chain specified in the chain query param or for all chains if the query param is omitted. (#3398) - Add support for changing
tracingdirectives at runtime. Please see the corresponding page in the Hermes guide for more information. (#3564)
- Add a new
- Relayer Library
- When Hermes detects a misbehaviour on a chain that is CCV
consumer, it will now send the misbehaviour evidence to the
provider chain using the new
IcsConsumerMisbehaviourmessage. (#3219) - When Hermes detects a misbehaviour from a on-chain client, eg. a light client attack or a double-sign, it will now submit the misbehaviour evidence to all counterparty clients of the misbehaving chain instead of to the counterparty client of the misbehaving client only. (#3223)
- Improve error message when scanning unsupported client (#3531)
- Regard the
finalize_block_eventsfield of theblock_resultsRPC endpoint, added in CometBFT 0.38 (#3548) - Change fallback compatibility version for CometBFT from v0.37 to v0.34 (#3666)
- When Hermes detects a misbehaviour on a chain that is CCV
consumer, it will now send the misbehaviour evidence to the
provider chain using the new
- Relayer CLI
- The
listencommand now works with bothpushandpullevent sources (#3501)
- The
- Relayer CLI
- Revert Docker image to Ubuntu LTS and set the UID and GID explicitly (#3580)
- IBC Data structures
- Fix build of
ibc-relayer-typesdocumentation on docs.rs (#3549)
- Fix build of
July 19th, 2023
This release of Hermes notably features a new pull-based event source which fetches events from the chain periodically using
the /block_results RPC endpoint instead of getting them over WebSocket.
To use the new pull-based event source, set
event_source = { mode = 'pull', interval = '1s' }`in the per-chain configuration.
Check the event_source setting in the example config.toml file in the Hermes repository for more details.
Additionally, it is now possible to skip the scanning phase during Hermes startup,
by disabling clients, connections and channels workers, and setting clear_on_start to false.
This significantly improve startup time when relaying on chains with hundreds or thousands of open channels, connections and clients.
See the Performance tuning page of the guide for more information.
⚠️ Be aware that this release contains breaking changes to the Hermes configuration.⚠️ Please consult theUPGRADING.mddocument for more details.
- The
websocket_addrconfiguration option has been removed in favour of the newevent_sourcesetting. Please consult theUPGRADING.mddocument for more details. - Bump MSRV to 1.71 (#3478)
- Relayer CLI
- Install CA certificates in Docker image for Hermes to be able to connect to TLS endpoints (#3423)
- Relayer Library
- Fix a bug where Hermes would discard the client updates corresponding to the supporting headers returned by the light client when assembling messages to relay from the operational data (#3465)
- Relayer Library
-
Add a pull-based event source which fetches events from the chain periodically using the
/block_resultsRPC endpoint instead of getting them over WebSocket.To use the pull-based event source, set
event_source = { mode = 'pull', interval = '1s' }in the per-chain configuration.Warning Only use this if you think Hermes is not getting all the events it should, eg. when relaying for a CosmWasm-enabled blockchain which emits IBC events in a smart contract where the events lack the
messageattribute key. See #3190 and #2809 for more background information. (#2850)
-
- Integration Test Framework
- Add integration tests for the Fee Grant module. (#3416)
- Add a new trait
InterchainSecurityChainTestand two functionsrun_binary_interchain_security_node_testandrun_binary_interchain_security_channel_testwhich can be used to bootstrap a Provider and Consumer chain for integration tests. Add a CI job to run tests with Gaia as a provider chain and Neutron as a Consumer chain. (#3450) (#3387)
- Relayer CLI
- By disabling clients, connections and channels workers, and setting
clear_on_starttofalse, Hermes will now skip the scanning phase during startup, significantly improve startup time when relaying on chains with hundreds or thousands of open channels, connections and/or clients. See the Performance tuning page of the guide for more information. (#3403)
- By disabling clients, connections and channels workers, and setting
- Relayer Library
- Telemetry & Metrics
- Add two new configurations for the telemetry
buckets: latency_submittedused to specify the range and number of buckets for thetx_latency_submittedmetric.latency_confirmedused to specify the range and number of buckets for thetx_latency_confirmedmetric. (#3366)
- Add two new configurations for the telemetry
- Integration Test Framework
June 5th, 2023
This is a patch release for Hermes, which includes a single bugfix and enables overflow checks in production builds.
- Fix a panic which can occur when querying connections filtered
by counterparty chain using
hermes query connections(#3381)
- Overflow checks are now enabled when Hermes is built in release mode, in order to better catch and address potential logic errors leading to overflows (#3390)
May 24th, 2023
🎉 Hermes v1.5.0 is here, packed with a slew of exciting updates, including breaking changes💥, brand-new features🎁, performance enhancements🚀, and sweeping improvements✨.
The one breaking change is the removal of the unbonding_period setting
from the chain configuration. This is now replaced by a fresh
ccv_consumer_chain setting for Cross-Chain Validation (CCV) consumer chains.
Also, Hermes has strengthened its misbehavior detection. With the
mode.misbehaviour.enabled setting enabled (now the case by default)
the relayer was already closely monitoring on-chain client updates,
comparing submitted headers with those fetched from its RPC node.
In the event of any discrepancy, Hermes would report the misbehaviour
to the chain hosting the IBC client. As of this version,
Hermes will also report the misbehaviour evidence to the reference chain.
This version rolls out a string of performance enhancements. Event batches
are now delivered after a configurable delay, greatly trimming down latency
when relaying, particularly on high-traffic channels. This can be adjusted
using the batch_delay setting in the per-chain configuration. Plus, packet
acknowledgments are only queried when there are packet commitments on the
counterparty, resulting in a major speed boost for packet clearing and
on-start scanning! 🚀
In addition, the trusted_node setting can now specify whether the full node
Hermes connects to is trusted or not. If untrusted, the light client will
verify headers included in the ClientUpdate message.
However, a word of caution: configuring the full node as trusted may cut
down latency but could risk sending invalid client updates to the chain. Use wisely!
Our Hermes guide has been re-organized a bit, now featuring a new Performance Tuning page that details the settings for optimizing the performance of the relayer.
For all the debuggers out there, Hermes now equips a new --debug global
flag with several selectable values, and two bonus flags, --archive-address
and --restart-height that enable a client update following a genesis restart
without an IBC upgrade proposal.
When it comes to telemetry, the destination chain is now added to the labels of the confirmed packet metrics.
Take note that some metrics now have the suffix _total. If you're using a running a
Grafana dashboard or any other tool relying on the metric names or labels, an update might be needed.
The corresponding page in the guide reflects the new metric names and
labels for your convenience.
There's also a fresh configuration option to specify the directory used for the keyring store.
From this version onwards, multi-platform (arm64 and amd64) images will be distributed both on Docker Hub and the GitHub Content Repository.
⚠️ Be aware that this release contains a couple breaking⚠️ changes to the Hermes configuration and telemetry metrics.⚠️ Please consult theUPGRADING.mddocument for more details.
-
Remove the
unbonding_periodsetting from the chain configuration, which was only used for CCV consumern chains. Instead, use theccv_consumer_chainsetting to identify a CCV consumer chains. (#3125) -
Due to the update of an internal dependency, some Prometheus metrics now have a
_totalsuffix. Check the corresponding guide page for the list of all metrics, including their new suffixes and labels.
- Support CometBFT when running version checks (#3288)
-
Add
ccv_consumer_chainsetting to the chain configuration to properly fetch the unbonding period of CCV consumer chains (#3125) -
Publish multi-platform (arm64/amd64) images to Docker Hub and GHCR (#3303)
-
When enabled for misbehaviour (ie. when
mode.misbehaviour.enabled = true), Hermes will now monitor on-chain client updates and verifies the submitted headers comparing with headers it retrieves from its RPC node. If it detects conflicting headers, it will submit aMisbehaviourMsgto the chain hosting the IBC client. In addition, Hermes will now also submit the evidence to the reference chain. (#3224) -
Add a global flag
--debugwhich can take one or more of the following values, separated by commas: -
Add two optional flags
--archive-addressand--restart-heighttohermes update clientCLI allowing a client update after a genesis restart without an IBC upgrade proposal. (#1152)
-
Emit event batches after a configurable delay. This considerably reduces the latency when relaying and therefore increases performance substantially on high traffic channels. See the
batch_delaysetting in the per-chain configuration. (#3331) -
Only query for packet acknowledgments when there are packet commitments on the counterparty, otherwise the query would return all acknowledments on chain, which is excruciatingly slow (#3348)
-
Use
/headerRPC endpoint instead of/blockto reduce pressure on the node and improve performance (#3226) -
Add a new
trusted_nodesetting to the per-chain configuration to specify whether or not the full node Hermes connects to is trusted. If not trusted (ie.trusted_node = false), Hermes will verify headers included in theClientUpdatemessage using the light client.If the full node is configured as trusted then, in addition to headers not being verified, the verification traces will not be provided. This may cause failure in client updates after significant change in validator sets.
Warning Setting this flag to
truemay reduce latency but at the expense of potentially sending invalid client updates to the chain, only use when latency is more critical than operating costs. Use at your own risk.(#3330)
- Enable misbehaviour detection by default (#3001)
- Add the destination chain to the labels of the confirmed packet metrics (#3297)
- Added a configuration to specify the directory used to the keyring store (#1541)
- Switch away from
rouilletoaxumin telemetry and REST servers (#1658) - Add Juno to chains tested in the integration tests (#3235)
- Add White Whale migaloo chain to ICS29 tests (#3345)
May 2nd, 2023
This patch release adds support for CometBFT in version checks.
- Support CometBFT when running version checks (#3288)
March 27th, 2023
Hermes v1.4.0 brings compatibility with chains based on Tendermint/CometBFT 0.37, while retaining compatibility with Tendermint/CometBFT 0.34. This is transparent and does not require any additional configuration.
The relayer now supports ICS consumer chains, which only requires operators
to specify the unbonding_period parameter in the chain settings. This is only
a temporary requirement, in the future Hermes will seamlessly support consumer
chains with minimal changes to the configuration.
This release also deprecates support for chains based on Cosmos SDK 0.43.x and lower, and bumps the compatibility to Cosmos SDK 0.47.x.
The relayer now also allows operators to filter out packets to relay based on whether or not they contain a fee, and the minimal amount of such fee. Please check the relevant documentation in the Hermes guide for more information. Additionally, Hermes now also tracks metrics for ICS29 fees.
This release includes a new query client status CLI to quickly check whether a client is active, expired or frozen.
| Crate | Version |
|---|---|
ibc-relayer-cli |
v1.4.0 |
ibc-relayer |
v0.23.0 |
ibc-relayer-types |
v0.23.0 |
ibc-relayer-rest |
v0.23.0 |
ibc-telemetry |
v0.23.0 |
ibc-chain-registry |
v0.23.0 |
ibc-test-framework |
v0.23.0 |
- Integration Test Framework
- Add integration tests for incentivized packet filtering (#1966)
- Relayer Library
- Relayer CLI
- Add a
query client statuscommand to query whether a client is active, frozen or expired (#3124)
- Add a
- Telemetry & Metrics
- Added metrics
ics29_fee_amountsandics29_period_feesto track fees rewarded to relayers. (#3090)
- Added metrics
- General
- Guide
- Add a section for ICS29 commands in Hermes guide (#3185)
- Integration Test Framework
- Use Rust structure instead of Chain's CLI for the packet forward tests (#3037)
- Relayer CLI
- Add
unbonding_periodsetting to the chain configuration to enable relaying between ICS consumer chains and other chains (#3112)
- Add
- General
- Rename
prometheus.yamltoprometheus.ymlto fix docker-compose used when setting up the monitoring platform. (#3106)
- Rename
- Relayer Library
- Ensure the event monitor is shut down cleanly (#3120)
- Relayer CLI
- Fix
query client consensusto sort the consensus states by height (#3041)
- Fix
February 17th, 2023
Hermes v1.3.0 adds support for Cross-chain Queries (ICS 031), implements optimistic channel handshake for lower latency, and comes with a major performance improvement when clearing packets on busy channels for chains using a recent version of IBC-Go. This release also brings a few bug fixes related to closing ordered channels and upgrading clients.
See the full release notes below for more details.
- Document
upgrade clientscommand, see the guide (#3066)
- Fix error message on client update with expired trusted state (#3054)
- Remove
query_consensus_statesfrom theChainEndpointtrait (#2001) - The
query consensus statecommand now only list heights and its--heights-onlyoption was removed (#2001) - Bump the default trust threshold for new clients from 1/3 to 2/3 (#2876)
- Enable optimistic channel handshake (#2910)
- Fetch consensus state heights using the more efficient
QueryConsensusStateHeightsgRPC query instead of fetching all the consensus states themselves usingQueryConsensusStatesand extracting the heights from the result (#2001)
- Fix proof in timeout on close messages for ordered channels (#3024)
- Fix upgraded client state latest height in upgrade proposal (#3057)
- Fix bug where one could sometimes not subscribe to events.
This mostly affected the
listencommand but also external consumers of events via theEventMonitorinterface (#3070)
Integration Test Framework - ibc-test-framework (v0.22.0)
- Updated packet forwarding tests to use memo field instead of overloading receiver following packet-forward-middleware v3.0.0 update (#3025)
- Add integration tests for ICS31 Cross Chain Queries (#2967)
December 13th, 2022
Hermes v1.2.0 brings a bunch of new features and other improvements, such as
support for Ed25519 keys, more robust health check which takes into account
the Tendermint min_gas_price setting, and various bug fixes related to
the handling of begin- and end-block events in the Tendermint indexer.
Additionally, IBC clients with a trust level between 1/3 and 2/3 inclusive are now allowed.
- Update minimum supported Rust version to 1.65.0 (#2817)
- Update to
tendermint-rs0.28 and ibc-proto 0.24 (#2944)
- Test against Gaia v8 in CI (#2820)
- Use rolling Ubuntu as base image in Hermes Docker image to reduce fix several vulnerabilities found in previous base image (#2810)
- Collate consecutive heights and sequence numbers shown in logs (#2847)
- Add support for Ed25519 keys (#2851)
- Ensure Hermes uses Rustls instead of OpenSSL for TLS on all platforms (#2799)
- Fix an issue where Hermes would sometimes fails to retrieve the begin/end block events because of a quirk of the Tendermint event indexer (#2867)
- Hermes tx CLIs that use the
packet_data_query_heightoption now also clear begin/end block events (#2868)
- The health check process now compares the configured
gas_priceconfig setting against the full node'smin_gas_pricesetting, ensuring that the former is at least equal to the latter (#2776) - IBC clients with trust thresholds in the range [1/3, 2/3] (inclusive) are now allowed (#2798)
- Move default implementations of
init_event_monitor,id,get_key, andadd_keyfrom CosmosSdkChain to ChainEndpoint, and changeChainEndpoint::config()to return a&ChainConfiginstead of aChainConfig(#2806) - Remove
init_event_monitorfromChainEndpointin favor ofsubscribemethod (#1456) - Added the possibility to specify multiple chains for integration tests (#2003)
- Clean up secp256k1 signing with other small changes
- The
k256library is no longer used; instead,secp256k1is used for both Evmos (aka Ethermint) and Cosmos - Move
sign_messageintoKeyEntryand remove the duplicated functions inKeyRingand at the top level - Move
from_seed_fileintoKeyEntry - Simplify the
get_addressimplementation
- The
Integration Test Framework - ibc-test-framework (v0.21.0)
- Added integration tests and guide entry for packet forwarding. (#1983)
- Improved error logs when the height given to upgrade a client is too low. (#2781)
- Added integration tests for client upgrade. (#2312)
Telemetry & Metrics - ibc-telemetry (v0.21.0)
- Add support for dumping Prometheus metrics to JSON (#2890)
October 28th, 2022
The ibc and ibc-proto crates
have been split into their own repositories under
the cosmos organization.
Moreover, Hermes will not be using the original ibc crate anymore,
and will from now on use instead the ibc-relayer-types crate, which is a
trimmed down version of the ibc crate that contains only the data structures used by Hermes.
This change does not impact end-users of Hermes, but may affect downstream
consumers of the ibc-relayer library in some cases.
Please reach out to us if you encounter any issue following from this reorganization of the repository.
The gm binary has been split out of the repo and has been moved into its own repository.
This change doesn't affect current local instances of the gm binary,
though new versions will need to be sourced from the new repository by running
git clone informalsystems/gm and running the install script from there.
For more information, see this section of the Hermes guide.
- Removed
gmfolder and its contents (#2754) - Remove the
ibc-protoandibc-proto-compilercrates from the repository (#2667)
- Fix incorrect Github workflow trigger paths (#2667)
- Fix comment in
config.tomlto correctly state that the default value ofclear_on_startistrue(#2750)
- Add
hermes auto configCLI command to automatically generate a config file with data from the chain registry (#2187) - Added new optional flag
--packet-data-query-heightto CLIhermes tx packet-recvin order to specify the height at which the packet data is queried (#2453) - New command
fee transferwhich transfers tokens with fees (#2714)
- Clean up the logs emitted by the relayer and add more structured information to the messages recorded in the logs (#1538)
- Log the packets cleared by the
clear packetscommand (#2653) - Add a new optional flag,
--denomto thehermes keys balancecommand in order to specify for which denomination the balance is queried. Specify the--allflag to get the balance for all denominations (#2726)
- Bump tendermint-rs dependencies to v0.25.0 (#2677)
- The channel and connection workers do not act needlessly on
NewBlockevents anymore (#2484) - Fix several bugs which were preventing Hermes to clear packets on ordered channels in some specific conditions, as exhibited on the Interchain Security testnet (#2670)
- Fix how headers are decoded from events (#2739)
- Support custom extension options to be able to specify
max_priority_pricefor Ethermint dynamic tx fee (#2566)
- Bump compatibility with IBC-Go v5 and Cosmos SDK v0.46 (#2532)
- Account for full transaction encoding when batching messages (#2575)
- Add a health check to warn user if
gas_multiplieris smaller than 1.1, and improve client refresh frequency to depend on thetrusting_period(#2487) - Set
max_tx_sizedefault value to 180KB instead of 2MB (#2595)
- New crate
ibc-chain-registryto fetch data from the chain-registry and query RPC/gRPC endpoints (#2187)
- Added Evmos compatible integration tests (#2442)
- Integration with
mdbooktemplates (#2605) - New script
auto_gen_templates.shto automatically generate templates files and warns users when one of them is updated. It is the responsibility of the users to update the guide when a template file is updated - New CI job to check that every template is up-to-date
August 22nd, 2022
After more than 2 years in the works, this is the first stable release of the Hermes relayer! 🎉
For reaching this milestone, we thank the valuable contributions of over 50 individuals, spread across more than 800 documented & resolved issues. Beside Cosmos-SDK and Tendermint, we are fortunate to maintain some of the most active and intense repository in the Cosmos ecosystem. Most importantly, we thank the relentless work of relayer operators that have already relayed billions worth of value in IBC production networks, and have provided us with invaluable feedback on improving Hermes and raising the overall stability of IBC. Kudos to everyone!
⚠️ If upgrading from Hermes v0.15.0, be aware that this release contains multiple breaking⚠️ changes to the Hermes command-line interface and configuration.⚠️ Please consult the UPGRADING document for instructions for more details.
- The performance and reliability of the relayer has been greatly improved
- Merged commands
keys addandkeys restoreinto single commandkeys addThe flag to specify the key name for the CLI commandkeys addhas been changed from-nto-k. Restoring a key now takes a file containing the mnemonic as input instead of directly taking the mnemonic - Deprecated
gas_adjustmentsetting in favor of newgas_multipliersetting. Check out the upgrading instructions for more details about the new setting. - Updated all CLI commands to take flags instead of positional arguments
- Renamed
query packet unreceived-packetstoquery packet pending-sendsandquery packet unreceived-ackstoquery packet pending-acks - Added CLI command
keys balancewhich outputs the balance of an account associated with a key - Added CLI command
query channel clientwhich outputs the channel's client state - Added CLI command
query transfer denom-tracewhich outputs the base denomination and path of a given trace hash - Dropped the
rawprefix from all thetx rawcommands - Remove the four duplicate commands:
tx raw update-client, which is the same asupdate clienttx raw upgrade-client, which is the same asupgrade clienttx raw upgrade-clients, which is the same asupgrade clientstx raw create-client, which is the same ascreate client
- A new section was added to guide which describes how the new metrics can be used to observe both the current state of the relayer and the networks it is connected to
- Added many new metrics to the telemetry. The full list can be found in new the guide section linked above
As of v1.0.0-rc.0, the Hermes CLI is now versioned separately from
the other crates in the project. As such, the top-level version
designates the version of the Hermes CLI, but the other crates in
the repository do not necessarily match this version. For example,
the ibc and ibc-relayer crates are released under version 0.19.0
for Hermes v1.0.0.
The structure of this changelog has therefore changed as well, changes are now grouped first by crate and then by the type of change, eg. feature, bug fix, etc.
The release notes below only contain the changes introduced since v1.0.0-rc.2. For the full list of changes since v0.15.0, please consult the sections below for v1.0.0-rc.2, v1.0.0-rc.1 and v1.0.0-rc.0.
- Bumped crates to the following versions:
ibc-relayer-cli: 1.0.0ibc-proto: 0.20.1ibc: 0.19.0ibc-relayer: 0.19.0ibc-telemetry: 0.19.0ibc-relayer-rest: 0.19.0
Hermes - ibc-relayer-cli (v1.0.0)
- Release version 1.0.0 of Hermes (
ibc-relayer-cli)
IBC Proto - ibc-proto (v0.20.0)
- Release version 0.20.1 of
ibc-proto
IBC Modules - ibc (v0.19.0)
- Release version 0.19.0 of
ibc
- Remove
heightattribute fromIbcEventand its variants (#2542)
- Fix
MsgTimeoutOnCloseto verify the channel proof (#2534)
Relayer Library - ibc-relayer (v0.19.0)
- Release version 0.19.0 of
ibc-relayer
- Introduces discovery phase to initialize Prometheus metrics (#2479)
- Refactor the
ChainEndpointtrait to expose the light client functionality directly. Instead of exposing a getter for theLightClienttrait, theChainEndpointtrait now defines the two methodsverify_headerandcheck_misbehaviourdirectly. (#2548)
Telemetry & Metrics - ibc-telemetry (v0.19.0)
- Release version 0.18.0 of
ibc-telemetry
- Multiple fixes related to telemetry, detailed below (#2479)
- Renamed the following metrics:
ibc_client_updatestoclient_updates_submittedibc_client_misbehaviourstoclient_misbehaviours_submittedibc_receive_packetstoreceive_packets_confirmedibc_acknowledgment_packetstoacknowledgment_packets_confirmedibc_timeout_packetstotimeout_packets_confirmedcache_hitstoqueries_cache_hitsmsg_numtototal_messages_submittedsend_packet_counttosend_packet_eventsacknowledgement_counttoacknowledgement_eventscleared_send_packet_counttocleared_send_packet_eventscleared_acknowledgment_counttocleared_acknowledgment_events
- Added the following metric:
timeout_events
- Fixed the following metrics:
client_updates_submitted: Now correctly count all ClientUpdate messagestotal_messages_submitted: Now count only submitted messages
- Changed telemetry
enabledtofalsein the default config.toml, to match the default value for this parameter - Changed
misbehaviourtofalsein the default config.toml, to match the default value for this parameter
- Renamed the following metrics:
REST API - ibc-relayer-rest (v0.19.0)
- Release version 0.19.0 of
ibc-relayer-rest
- Document all metrics and add a section describing how Hermes metrics can be used to observe both the current state of the Hermes relayer and the networks it is connected to (#2479)
August 8th, 2022
This is the third release candidate for Hermes v1.0.0 🎉
- Bumped crates to the following versions:
ibc-relayer-cli: 1.0.0-rc.2ibc-proto: 0.20.0ibc: 0.18.0ibc-relayer: 0.18.0ibc-telemetry: 0.18.0ibc-relayer-rest: 0.18.0
- Bump tendermint-rs dependencies to 0.23.9
Hermes - ibc-relayer-cli (v1.0.0-rc.2)
- Release version 1.0.0-rc.2 of Hermes (
ibc-relayer-cli)
IBC Proto - ibc-proto (v0.20.0)
- Release version 0.20.0 of
ibc-proto
IBC Modules - ibc (v0.18.0)
- Release version 0.18.0 of
ibc
Relayer Library - ibc-relayer (v0.18.0)
- Release version 0.18.0 of
ibc-relayer
- For the
ConnOpenTryandConnOpenAcksteps, wait for the destination app height to be higher than the consensus height, otherwise we fail to complete the handshake when the block times of the two chains involved differ significantly (#2433) - Fix code that could result in message batch size growing above the transaction size limit (#2477).
- Enable connecting to full nodes over IPv6 (#2380)
Telemetry & Metrics - ibc-telemetry (v0.18.0)
- Release version 0.18.0 of
ibc-telemetry
- Improve the metrics
- Renamed
oldest_sequencemetric tobacklog_oldest_sequence - Renamed
oldest_timestampmetric tobacklog_oldest_timestamp - Introduced
backlog_sizePrometheus metric to complement the otherbacklog_*data, as a metric reporting how many packets are pending on a channel - Ensures the
backlog_oldest_sequenceandbacklog_oldest_timestampare correctly updated when a timeout occurs or when another relayer clears the channel (#2451) - Ensures
backlog_timestampis never updated by a packet with a highersequencethan the oldest pending packet (#2469)
- Renamed
- Fixed a bug with updating of Prometheus metrics in the presence of concurrent relayers (#2467)
REST API - ibc-relayer-rest (v0.18.0)
- Release version 0.18.0 of
ibc-relayer-rest
- Document how to use HTTP basic authentication in the guide (#2459)
- Remove tutorial featuring raw commands from the guide (#2466)
July 27th, 2022
This is the second release candidate for Hermes v1.0.0 🎉
⚠️ This release contains multiple breaking changes to the Hermes command-line interface and configuration.⚠️ Please consult the UPGRADING document for instructions to update to Hermes v1.0.0-rc.1.
- Bump
ibc-protocrate to 0.19.1 - Bump
ibc,ibc-relayer,ibc-telemetry,ibc-relayer-restcrates to v0.17.0 - Bump tendermint-rs dependencies to 0.23.8 (#2455)
Hermes - ibc-relayer-cli (v1.0.0-rc.1)
- Drop the
rawprefix from all thetx rawcommands (#2315 - Remove the four duplicate commands:
tx raw update-client, which is the same asupdate clienttx raw upgrade-client, which is the same asupgrade clienttx raw upgrade-clients, which is the same asupgrade clientstx raw create-client, which is the same ascreate client- (#2315)
- Rename
--a-and--b-prefixes inhermes txsubcommands to--src-and--dst-(#2410) - Rename flags of
tx upgrade-chaincommand from--src/--dstto--reference/--host(#2376) - The default value of the configuration
tx_confirmationin Hermesconfig.tomlhas been changed fromtruetofalse. (#2408)
- Fixed filtering counterparty chain in Hermes command
query channels(#1132) - Fixed command
tx raw ft-transferto correctly use the address given by the--receiverflag (#2405)
- Add an optional
--show-counterpartyflag tohermes query channelswhich outputs every channel along with its corresponding port, and the counterparty chain's id, in a pretty way (#2429) - New optional flags
--counterparty-chainand--verbosefor the commandquery connections(#2310) - Added new optional flag
--host-chainto filter which clients are upgraded when runningupgrade clientscommand (#2311)
- Hermes command
keys addnow checks for existing key and overwrites only if the flag--overwriteis passed (#2375) - Rename
--a-and--b-prefixes inhermes txsubcommands to--src-and--dst-(#2410) - Increase default value for
gas_multipliersetting to 1.1 (#2435) - Output status is now colored in green for success and red for error (#2431)
IBC Proto - ibc-proto (v0.19.1)
- Update Protobuf definitions for IBC-Go to v4.0.0-rc0 and Cosmos SDK to v0.45.6 (#1)
IBC Modules - ibc (v0.17.0)
- Remove provided
Ics20Reader::get_channel_escrow_address()implementation and makecosmos_adr028_escrow_address()public. (#37)
- Fix serialization for ICS20 packet data structures (#38)
- Properly process
WriteAcknowledgements on packet callback (#36) - Fix
write_acknowledgementhandler which incorrectly used packet'ssource_{port, channel}as key for storing acks (#35)
- Propose ADR011 for light client extraction (#2356)
Relayer Library - ibc-relayer (v0.17.0)
- Fix a regression where Hermes would not retry relaying packet on account mismatch error when the sequence number used was smaller than the expected one (#2411)
- Fix a bug where the relayer would fail to relay any packets when the
/acbi_infoendpoint of a chain did not includedataandversionfields (#2444)
Telemetry & Metrics - ibc-telemetry (v0.17.0)
- Updated telemetry metric
wallet_balanceto f64 and removed downscaling displayed value. Please note that when converting the balance to f64 a loss in precision might be introduced in the displayed value (#2381) - Improved naming and description of some telemetry metrics and added
histogram buckets for
tx_latencymetrics (#2408)
July 7th, 2022
This is the first release candidate for Hermes v1.0.0 🎉
⚠️ This release contains multiple breaking changes to the Hermes command-line interface and configuration.⚠️ Please consult the UPGRADING document for instructions to update to Hermes v1.0.0-rc.0.
As of this release, the Hermes CLI will be versioned separately from
the other crates in the project. As such, the top-level version
designates the version of the Hermes CLI, but the other crates in
the repository do not necessarily match this version. For example,
the ibc and ibc-relayer crates are released under version 0.16.0.
The structure of this changelog has therefore changed as well, changes are now grouped first by crate and then by the type of change, eg. feature, bug fix, etc.
Hermes - ibc-relayer-cli (v1.0.0-rc.0)
- New ADR which describes the changes to the Hermes commands, specifically the move to flags instead of positional arguments. (#594)
- Merged commands
keys addandkeys restoreinto single commandkeys add. The flag to specify the key name for the CLI commandkeys addhas been changed from-nto-k. Restoring a key now takes a file containing the mnemonic as input instead of directly taking the mnemonic. (#1075) - Deprecate
gas_adjustmentsetting in favor of newgas_multipliersetting (#2174) - Updated all CLI commands to take flags instead of positional arguments. (#2239)
- Rename
query packet unreceived-packetstoquery packet pending-sendsandquery packet unreceived-ackstoquery packet pending-acks(#2379)
- CLI command
config validatenow correctly outputs an error if the configuration file does not exist or is empty. (#2143) - Fix the flow for crate connection to ensure success despite concurrent relayers racing to finish the handshake. (#2168)
- Added CLI command
keys balancewhich outputs the balance of an account associated with a key (#912) - Added CLI command
query channel clientwhich outputs the channel's client state (#999) - Added CLI command
query transfer denom-tracewhich outputs the base denomination and path of a given trace hash (#43) - Add unit tests for all Hermes commands with at least one argument (#2358)
- Add support for selecting a specific wallet in the
clear packetsCLI flow (#2111) - Added a required flag
--upgrade-heightthat halts the reference chain at the specified height when performing a client upgrade (#2300) - Added
--yesflag to thecreate channelflow to enable skipping the--new-client-connectionstep (#2317)
IBC Proto - ibc-proto (v0.19.0)
- Generate gRPC server code under feature 'server' (#2277)
IBC Modules - ibc (v0.16.0)
- Change
ChannelIdrepresentation to a string, allowing all IDs valid per ICS 024 (#39).
- Fix
recv_packethandler incorrectly queryingpacket_receiptandnext_sequence_recvusing packet'ssource_{port, channel}. (#40) - Permit channel identifiers with length up to 64 characters, as per the ICS 024 specification. (#39).
- Remove the concept of a zero Height (#1009)
- Complete ICS20 implementation (#59)
- Derive
serde::{Serialize, Deserialize}forU256. (#41) - Remove unnecessary supertraits requirements from ICS20 traits. (#2280)
Relayer Library - ibc-relayer (v0.16.0)
- Fix
execute_schedulemethod dropping operational data due to improper handling of errors. (#2118) - Fix duplicate packets being generated on start. (#2093)
- Use appropriate height when querying for client upgrade state (#2185)
- Fix the channel handshake issues that occur when concurrent relayers are present (#2254)
- When Hermes submits
Nmessages to a chain, it will now always gets backNresponses, even in the presence of errors. (#2333)
- Add preliminary support for multiple chain types, which can be specified in
the chain configuration. At the moment only the
CosmosSdkchain type is supported. (#2240) - Add support for fetching & parsing the Tendermint version of a network that Hermes is connected to. (#2301)
- Added handler for SDK error 13 in order to output an understandable error message. (#1400)
- Do not retry indefinitely on command handling failure in the packet worker (#2155)
- Consolidate
ChainEndpoint::proven_*methods with their correspondingquery_*form (#2223) - Reduce relaying delay when some account mismatch errors occur during Tx simulation (#2249)
Telemetry & Metrics - ibc-telemetry (v0.16.0)
- Added new metrics to track the number of relayed
SendPacketandWriteAcknowledgementmessages, the sequence number and the timestamp of the oldest pendingSendPacket(#2175)
May 23rd, 2022
This release brings a number of bug fixes, some performance improvements, notably when clearing packets, as well as new metrics for better observability of the relayer's operations.
- General
- Replaced gaia v5 with v7 in E2E tests. (#1986)
- Relayer Library
- Add six new metrics:
wallet_balance,ws_events,ws_reconnect,tx_latency_submitted,tx_latency_confirmed,msg_num(#2112)
- Add six new metrics:
- IBC Modules
- Remove object capabilities from the modules (#45)
- Relayer Library
- Ensure
max_msg_numis between 1 and 100 with a default of 30 (#1971) - Fixed misleading error message leaking from the misbehavior detection task. (#2031)
- Added support for incremental processing of packet clearing commands. (#2087)
- Implement ADR 9: add domain type for request messages that are passed to query functions (#2192)
- Ensure
May 2nd, 2022
This release improves the reliability of the relayer by fixing an edge case where some queries would fail if they reach a full node after a new block is committed but before the application state updates to reflect the changes in that block.
- Relayer Library
- Fixed query for application status when application state lags behind blockchain state. (#1970)
April 27th, 2022
This release notably features a new query packet pending command to
list outstanding packet commitments that are either unreceived or pending
acknowledgement at both ends of a channel.
The ibc crate now also come with a complete ICS 026 implementation.
There is a new query packet pending command, see above for more information.
The create channel command now requires an existing client and connection,
unless the --new-client-connection flag is provided.
Please refer to the guide for more information.
create channelnow requires a--new-client-connectionflag to create a new client and connection for the channel (#1421)- Update MSRV to Rust 1.60 (#2081)
- IBC Modules
- Relayer Library
- Fix the connection delay logic to use the timestamp of the host block when the client update header was installed. (#1772)
- Fixed Hermes retrying mechanism not regenerating operational data for messages (#1792)
- Adjusted max_block_time default value to 30s (#1998)
- Fix a bug in the wildcard filter where pattern would match in the middle of a string (#2075)
- Fixed target height used in misbehavior detection. (#2097)
- Relayer CLI
- Relayer Library
- Add a metric for query cache hits (#2036)
- General
- IBC Modules
- Relayer CLI
March 28th, 2022
Hermes v0.13.0 improves performance by lowering the pressure on the full nodes by adding a caching layer for some queries. It also fixes a bug which could cause an exponential slowdown when relaying between many chains with a low average block time.
This release also add support for wildcards in port and channel identifiers in the packet filter configuration, which enable operators to filter ICA channels based on the port prefix.
Additionally, the IBC Protocol Buffers definitions can now be used from CosmWasm.
As of version 0.13.0, Hermes supports relaying on Interchain Accounts channels.
If the packet_filter option in the chain configuration is disabled, then
Hermes will relay on all existing and future channels, including ICA channels.
There are two kinds of ICA channels:
- The host channels, whose port is
icahost - The controller channels, whose port starts with
icacontroller-followed by the owner account address. See the spec for more details.
If you wish to only relay on a few specific standard channels (here channel-0 and channel-1),
but also relay on all ICA channels, you can specify the following packet filter:
Note the use of wildcards in the port and channel identifiers (
['ica*', '*']) to match over all the possible ICA ports.
[chains.packet_filter]
policy = 'allow'
list = [
['ica*', '*'], # allow relaying on all channels whose port starts with `ica`
['transfer', 'channel-0'],
['transfer', 'channel-1'],
# Add any other port/channel pairs you wish to relay on
]If you wish to relay on all channels but not on ICA channels, you can use the following packet filter configuration:
[chains.packet_filter]
policy = 'deny'
list = [
['ica*', '*'], # deny relaying on all channels whose port starts with `ica`
]This information can also be found in the Hermes guide.
- IBC Proto
- Add CosmWasm support to the generated Protobuf code (#4)
- Add a new
clientfeature to gate the tonic client code, implies thestdfeature. - Add a new
json-schemafeature to deriveschemars::JsonSchemaon some proto types, implies thestdfeature. - Add
#[serde(default)]to fields that might be omitted by Golangomitemptydirective. - Change serialization of byte arrays to Base64 for compatibility with Go.
- Add a new
- Derive
SerializeandDeserializeforibc-proto::ibc::coreandibc_proto::ibc::applicationsstructs, and switch to Google's Protobuf standard types instead of Prost's types. (#3)
- Add CosmWasm support to the generated Protobuf code (#4)
- Relayer Library
- IBC Modules
- Refactored channels events in ICS 04 module (#86)
- Integration Test Framework
- Split out test framework as new crate
ibc-test-frameworkfromibc-integration-test. (#1961)
- Split out test framework as new crate
- Relayer Library
- Add documentation for the caching layer implemented in (#1908)
- Relayer CLI
- Print packet data on one line (#1559)
February 24th, 2022
This release notably brings compatibility with Cosmos SDK 0.45 and IBC v3.0.0-rc.0,
as well as support for non-standard ports in the channel handshake.
It also contains a fix for a bug where SendPacket events were duplicated when emitted at EndBlock,
and fixes another bug where Hermes would clear packet at startup even when clear_on_start = false.
The relayer will now also honor the tracing filter specified in the RUST_LOG environment variable, if any.
As of this release, the relayer will not respond to the SIGHUP signal and will therefore
not reload the configuration anymore. This feature has been deemed unnecessary given the
recent performance improvements, and it is now recommended to just restart the relayer
when the configuration is updated.
Additionally, a new CLI command clear packets
has been added for clearing packets in both direction on a given channel.
- IBC Modules
- Relayer Library
- Relayer CLI
- Disable reloading of configuration upon receiving a SIGHUP signal (#1885)
- General
- Upgrade protos and compatibility to IBC v3.0.0-rc.0 and Cosmos SDK v0.45.1 (#5)
- Relayer CLI
- Allow overriding the tracing filter with
RUST_LOGenvironment variable (#1895)
- Allow overriding the tracing filter with
- IBC Modules
- Relayer Library
- Relayer CLI
- Added
clear packetscommand, combining the effects oftx raw packet-recvandtx raw packet-ack(#1834)
- Added
February 4th, 2022
This release mainly adds support for channel events originating from Tendermint ABCI's BeginBlock and EndBlock methods.
- Relayer CLI
- Do not require a config file to be present for the
completionscommand. (#1822)
- Do not require a config file to be present for the
January 27th, 2022
This release notably speeds up the startup time of Hermes,
adds options to the create client command to customize the client parameters,
makes the deposit denomination configurable in tx raw upgrade-chain via a new --denom flag,
and adds a completions CLI command to generate shell auto-completion scripts.
This release includes a breaking change, which requires the configuration file to be edited.
The mode.packets.filter configuration option has been removed and is now enabled by default.
Before running Hermes v0.11.0, make sure you remove the mode.packets.filter option from the configuration file.
--- a/config.toml
+++ b/config.toml
@@ -50,18 +50,6 @@ clear_interval = 100
# Whether or not to clear packets on start. [Default: false]
clear_on_start = true
-# Enable or disable the filtering mechanism.
-# Valid options are 'true', 'false'.
-# Currently Hermes supports two filters:
-# 1. Packet filtering on a per-chain basis; see the chain-specific
-# filter specification below in [chains.packet_filter].
-# 2. Filter for all activities based on client state trust threshold; this filter
-# is parametrized with (numerator = 1, denominator = 3), so that clients with
-# thresholds different than this will be ignored.
-# If set to 'true', both of the above filters will be enabled.
-# [Default: false]
-filter = false
-
# Toggle the transaction confirmation mechanism.
# The tx confirmation mechanism periodically queries the `/tx_search` RPC
# endpoint to check that previously-submitted transactions- General
- Relayer Library
- Added a
denommember toupgrade_chain::UpgradePlanOptions(#1662)
- Added a
- IBC Modules
- Hide
ibc::Timestamp::now()behindclockfeature flag (#1612)
- Hide
- General
- Improve startup time of the relayer (#1705)
- When scanning a chain with filtering enabled and an allow list, skip scanning all the clients and query the allowed channels directly. This results in much fewer queries and a faster start.
- Add a
--full-scanoption tohermes startto opt out of the fast start mechanism and do a full scan.
- Update
tendermint-rsto v0.23.4 and harmonize the dependencies to use a single TLS stack. A system installation of OpenSSL is no longer required to build Hermes. (#1641) - Remove 1 second sleep in
generate_tm_blockduring testing with mock context. (#1687)
- Improve startup time of the relayer (#1705)
- IBC Modules
- Relayer Library
- Relayer CLI
January 13th, 2021
This release notably updates the underlying CLI framework (abscissa) to version 0.6.0-beta.1,
which now uses clap for parsing command line arguments. This substantially improves the UX of the CLI,
by adding support for --help flags in subcommands and improving help and usage printouts.
The --version option of the create channel subcommand has been renamed
to --channel-version, with the old name still supported as an alias.
Additionally, the -h short flag on many commands is now -H to avoid
clashes with the clap-provided short flag for help.
This release also improves the handling of account sequence mismatch errors, with a recovery mechanism to automatically retry or drop tx upon such errors.
The relayer now also supports dynamic versions in channel open handshake (which is needed by Interchain Accounts), and enables full support for IBC v2.
- General
- IBC Modules
- Add the
frozen_height()method to theClientStatetrait (includes breaking changes to the TendermintClientStateAPI). (#65) - Remove
TimestampAPI that depended on thechronocrate: (#1665):Timestamp::from_datetime; useFrom<tendermint::Time>Timestamp::as_datetime, superseded byTimestamp::into_datetime
- Add the
- Relayer Library
- Improve spawning of supervisor worker tasks (#1656)
- The
Supervisorstruct is removed. - Supervisor is now spawned using the
spawn_supervisorfunction.
- The
- Improve spawning of supervisor worker tasks (#1656)
- Relayer CLI
- Update to abscissa framework version 0.6.0-beta.1, adding support for
--helpflags in subcommands and improving help and usage printouts. The--versionoption of thecreate channelsubcommand has been renamed to--channel-version, with the old name still supported as an alias. Additionally, the-hshort flag on many commands is now-Hto avoid clashes with the clap-provided short flag for help. (#1576, #1743)
- Update to abscissa framework version 0.6.0-beta.1, adding support for
- IBC Modules
- Delete packet commitment instead of acknowledgement in acknowledgePacket #66
- Set the
counterparty_channel_idcorrectly to fix ICS04chanOpenAckhandler verification (#64) - Add missing assertion for non-zero trust-level in Tendermint client initialization. (#63)
- Fix conversion to Protocol Buffers of
ClientState'sfrozen_heightfield. (#62)
- Relayer Library
- General
- IBC Modules
- Implement proof verification for Tendermint client (ICS07). (#1583)
- Relayer Library
- General
- Update
CONTRIBUTING.mdfor latest version of unclog (#1634)
- Update
- IBC Modules
- More conventional ad-hoc conversion methods on
Timestamp(#1665): Timestamp::nanosecondsreplacesTimestamp::as_nanosecondsTimestamp::into_datetimesubstitutesTimestamp::as_datetime
- More conventional ad-hoc conversion methods on
- Relayer CLI
November 23rd, 2021
This release honors Anca Zamfir, who has lead ibc-rs from its inception and through its first two years of life. The whole team is grateful for her dedication and the nurturing environment she created. To many more achievements, Anca!! 🥂
This release requires operators to update their Hermes configuration.
The mode configuration section now replaces the strategy option.
If Hermes was configured with strategy = 'packets', then the configuration needs to be changed in the following way:
[global]
-strategy = 'packets'
log_level = 'trace'
-clear_packets_interval = 100
-tx_confirmation = true
+
+[mode]
+
+[mode.clients]
+enabled = true
+refresh = true
+misbehaviour = true
+
+[mode.connections]
+enabled = false
+
+[mode.channels]
+enabled = false
+
+[mode.packets]
+enabled = true
+clear_interval = 100
+clear_on_start = true
+filter = false
+tx_confirmation = trueIf Hermes was configured to complete connection and channel handshakes as well, ie. with strategy = 'all',
then on top of the changes above, mode.connections.enabled and mode.channels.enabled must be set to true.
See the relevant section of the documented config.toml file in the repository for more details.
- IBC Modules
- Set the connection counterparty in the ICS 003
connOpenAckhandler (#70)
- Set the connection counterparty in the ICS 003
- General
- Relayer Library
- Allow for more granular control of relaying modes. The
modeconfiguration section replaces thestrategyoption. (#1518)
- Allow for more granular control of relaying modes. The
- General
- IBC Modules
- Derive
PartialEqandEqonIbcEventand inner types (#1546)
- Derive
- Relayer Library
- The relayer will now avoid submitting a tx after the simulation failed (in all but one special case) to avoid wasting fees unnecessarily (#1479)
- Relayer CLI
October 29th, 2021
This is the final release of version 0.8.0, which now depends on the official releases of the prost and tonic crates.
In addition to everything that's included in v0.8.0-pre.1, this release updates the minimum supported Rust version to 1.56,
and contains various bug fixes and performance improvements which make the relayer more reliable.
A new setting was added to the Hermes configuration: max_block_time.
This setting specifies the maximum time per block for this chain.
The block time together with the clock drift are added to the source drift to estimate
the maximum clock drift when creating a client on this chain.
For Cosmos-SDK chains a good approximation is timeout_propose + timeout_commit
- Update MSRV to Rust 1.56 and use the 2021 edition (#1519)
- Fix for "new header has a time from the future" chain error which would arise due to clock drift (#1445):
- Added new config param
max_block_timeto prevent the problem for appearing in newly-created clients. - Added a synchronous waiting in client update logic to allow destination chain to reach a new height before submitting a client update message.
- Added new config param
- Ensure Hermes does not send timeouts for packets that have not expired yet (#1504)
- General
- Update to official releases of
prost0.9 andtonic0.6 (#1502)
- Update to official releases of
- IBC Modules
- Relayer Library
- Improve performance of misbehaviour checks triggered by an
UpdateClientevent (#1417)
- Improve performance of misbehaviour checks triggered by an
October 22nd, 2021
This is a pre-release which depends on in-house forks of various Rust libraries.
As such, it is advised to avoid depending on the ibc and ibc-relayer crates
at version 0.8.0-pre.1.
Hermes v0.8.0-pre.1 is considered stable and it is recommended for all users to update to this version.
This release notably includes a new memo_prefix configuration option
for specifying a prefix to be included in the memo of each transaction submitted
by Hermes.
Moreover, Hermes is now able to handle SendPacket events originating from Tendermint
ABCI's BeginBlock and EndBlock methods (#1231).
- IBC Modules
- The
check_header_and_update_statemethod of theClientDeftrait (ICS02) has been expanded to facilitate ICS07 (#71)
- The
- General
- Add support for the
tx.memofield (#1433)
- Add support for the
- IBC Modules
- Add ICS07 verification functionality by using
tendermint-light-client(#71)
- Add ICS07 verification functionality by using
- Relayer Library
October 4th, 2021
This minor release most notably includes a fix for a bug introduced in v0.7.0 where Hermes would always use the max gas when submitting transactions to chains based on Cosmos SDK <= 0.42. It also improves the handling of account sequence numbers
- Relayer Library
- Fix a bug introduced in Hermes v0.7.0 where tx simulations would fail on chains based on Cosmos SDK 0.42. This would cause Hermes to use the max gas specified in the config when submitted the tx, leading to high fees. (#1345)
- Only increase cached account sequence number when
broadcast_tx_syncfails, therefore ensuring that the cached sequence number stays in sync with the node. (#1402)
- Relayer Library
- Set default trusting period to be 2/3 of unbonding period for Cosmos chains (#1392)
September 24th, 2021
This minor release brings substantial performance improvements as well as support for chains using Secp256k1 signatures in consensus votes.
It also bumps the compatibility to Cosmos SDK 0.44.
-
Support for chains which use Secp256k1 signatures in consensus votes (#1155)
-
Modified packet worker to use stubborn strategy (#1290)
-
Skip
consensus_heightsquery inupdate_clientwhen possible (#1362) -
Support for disabling tx confirmation mechanism (#1380)
-
- Binaries in the config can be defined as URLs now.
- Add the option to set gm-lib path via the
$GM_LIBenvironment variable (#1365)
- Use
coreandalloccrates forno_stdcompatibility (#1156) - Improve performance of health check, and only perform it on
hermes start. Add ahermes health-checkcommand. (#1336) - Treat pre-releases of the Cosmos SDK as their standard version in compatibility check (#1337)
- Bump Cosmos SDK compatibility to v0.44.0 (#1344)
- Improve reliability of health check (#1382)
September 14th, 2021
This minor release of Hermes notably features support for Ethermint chains and transfer amounts expressed as a 256-bit unsigned integer.
This release also fixes a bug where the chain runtime within the relayer would crash when failing to decode a invalid header included in a ClientUpdate IBC event.
-
Fix header decoding error which resulted in killing the chain runtime (#1342)
-
General
August 24th, 2021
This release of Hermes is the first to be compatible with the development version of Cosmos SDK 0.43. Hermes 0.7.0 also improves the performance and reliability of the relayer, notably by waiting asynchronously for transactions to be confirmed. Additionally, Hermes now includes a REST server which exposes the relayer's internal state over HTTP.
-
- Set the index of
ibc::ics05_port::capabilities::Capability(#74)
- Set the index of
-
- Fix silent exit when requirements are missing
-
General
- Update CI to test with gaiad v5.0.5 (#1175)
-
General
- Update Modelator to 0.2.0 (#1249)
-
- Add optional destination chain and
--verboseoptions forquery channelsCLI (#1132)
- Add optional destination chain and
-
- Implement
ics02_client::client_consensus::ConsensusStateforAnyConsensusState(#1297)
- Implement
August 2nd, 2021
This minor release of Hermes re-enables the upgrade client, upgrade clients,
tx raw upgrade-clients, and tx raw upgrade-chain, and otherwise
contains a few bug fixes and internal improvements.
Upgrading from version 0.6.1 to 0.6.2 requires no explicit steps.
- Add missing
Protobufimpl forics03_connection::connection::Counterparty(#1247)
- Use the
flex-errorcrate to define and handle errors (#1158)
- Augment ClientCreationFailed error with chain id and WS address (#1020)
- Improve the error message for config file parse errors (#1021)
- Fix for upgrade CLI regression using new type ics02::TrustThreshold (#1229)
- Add semantic validation of of
max_tx_sizeandmax_num_msgconfig options (#1245)
July 22nd, 2021
This minor release mainly improves the reliability of the relayer by ensuring that pending packets are cleared on start, and that Hermes can recover from the WebSocket subscriptions being closed under its feet by Tendermint.
Upgrading from version 0.6.0 to 0.6.1 requires no explicit steps.
WARNING: Due to a regression (#1229), the
upgrade client,tx raw upgrade-clients, andtx raw upgrade-chaincommands have been temporarily disabled in this version. These commands will be re-enabled in the next version.
July 12th, 2021
Many thanks to Fraccaroli Gianmarco (@Fraccaman) for helping us improve the reliability of Hermes (#697).
This release includes two major features to Hermes: (1) support for reloading the chains from the configuration file at runtime, and (2) a filtering mechanism to restrict Hermes activity based on predefined parameters (e.g., packet relaying on certain ports and channels exclusively, and ignoring activity for clients that have non-standard trust threshold).
In addition to these two, we have also added a health checkup mechanism, plus new
config validate and query channel ends CLIs.
When upgrading from Hermes v0.5.0 to v0.6.0, the most important point to watch out for is the configuration file. The Hermes config.toml configuration file has went through a few revisions, with the changes described below.
Please have a look around the config.toml directly.
This feature will restrict the channels on which Hermes relays packets. There are two new options in the configuration file:
- A global
filterparameter to enable or disable filtering globally. - A per-chain
.filtersoption that expects apolicy(eitherallowordeny) plus a list of channel and port identifiers. If policy isallow, then packet relaying will be restricted to this list for the corresponding chain. If the policy isdeny, then any packets from this list will be ignored.
The global filter option additionally enables filtering of all activities
based on client state trust threshold. If enabled, Hermes will ignore all
activity for clients that have a trust threshold different than 1/3.
This will enable the parametrization of the frequency
at which Hermes will clear pending packets. This is a global option, called
clear_packets_interval, which applies to all chains in the configuration.
The full list of changes is described below.
-
Update to
tendermint-rsv0.20.0 (#1125) -
Add inline documentation to config.toml (#1127)
-
- Hermes will now clear pending packets at a configurable interval (#1124)
- ibc-relayer
- Fix for schedule refreshing bug (#1143)
June 22nd, 2021
This release brings a few features, and several improvements and bug fixes to the Hermes relayer, notably the capability for Hermes to complete IBC connection handshakes when it detects that one has been initialized, as well as the ability to detect chain impersonation attacks and to dynamically estimate the gas needed to submit a transaction.
Moreover, the overall reliability and availability of the relayer has also been improved
substantially by switching over to tx_broadcast_sync for submitting transactions.
-
- Add
--hd-pathoption tokeys restoreandkeys addcommands to specify derivation path when importing keys (#1049)
- Add
-
- Minor log output improvements: color enabled, reduced redundant information (#1100)
-
- Update the on-chain IBC client with supporting headers when light client verification performs bisection when verifying a header for a client update or a misbehaviour detection (#673)
- Add mitigation for chain impersonation attacks (#1038)
- Determine gas fee dynamically per transaction (#930)
- Submit transactions with
broadcast_tx_syncand keep track of account sequences (#986)
-
- Removed the testnet command as not all networks support it (#1050)
- Update for compatibility with Hermes's new
--hd-pathoption
- ibc-relayer-cli
- Removed
--coin-typeoption fromkeys restorecommand. Use--hd-pathinstead (#1049)
- Removed
June 3rd, 2021
- This release of Hermes features an internal telemetry service which can export metrics about the relayer to Prometheus.
- A new relaying strategy is now available, which enables Hermes to complete channel handshakes in an event-based fashion.
- Hermes now checks if another relayer may have already processed a packet event, and will not attempt to process it itself, which improves performance.
- The startup time of the relayer has been substantially improved.
- The
start-multicommand has been promoted tostart, which means that the worker-based relayer is not experimental anymore. - A regression where Hermes would not recover after a node went down and up again was fixed.
Special thanks to Colin Axnér (@colin-axner) and Jongwhan Lee (@leejw51crypto) for raising multiple issues that helped us improve the reliability of Hermes.
-
- Started
unwrapcleanup (#871)
- Started
- ibc-relayer-cli
- Promote
start-multicommand tostart(#911)
- Promote
May 21st, 2021
This is minor release which brings substantial performance improvements
to the relayer (relaying 1000 packets now takes 2-5min instead of 1h+),
better UX for the ft-transfer command, and automatic deployment of
Docker images to Docker Hub.
-
- Add a
--keyoption to the tx raw ft-transfer command to override the account used for sending messages (#963)
- Add a
-
- Add support for multiple keys to the keyring (#963)
-
[release]
- Released the official Hermes image on Docker Hub (#894)
- Automatically deploy Docker Hub image during release (#967)
- ibc-relayer
- Batch together all events from all transactions included in a block (#957)
- ibc-relayer-cli
- Prevent sending
ft-transferMsgTransfer on a non-Open channel (#960)
- Prevent sending
Nothing
May 14h, 2021
This release improves the UX of a couple commands, fixes a bug related to delay periods, and adds support for packet timeouts based on timestamps, as well as support Protobuf-encoded keys.
-
[scripts]
- Created the Gaiad Manager
gmCLI tool for managing gaiad instances on the local machine (#902)
- Created the Gaiad Manager
- ibc-relayer-cli
- Improve UX when querying non-existing connections and channels (#875, #920)
- More details in error messages to increase debuggability (#921, #934)
- Disallow creating a client with same source and destination chains (#932)
- Make packet worker more resilient to nodes being unreachable for a short amount of time (#943)
Nothing
May 7h, 2021
Special thanks to Jongwhan Lee (@leejw51crypto) for his contributions (#80).
This release mostly focuses on improving the UX and the experimental multi-paths relayer (start-multi command),
which has been made more resilient against nodes going down, and is now able to clear pending packets
and periodically refresh IBC clients. The relayer now also supports ICS 027 (Interchain Accounts).
-
- Support for ICS27 (#82)
-
- Change the default for client creation to allow governance recovery in case of expiration or misbehaviour (#785)
- Use a single supervisor in
start-multito subscribe to all configured chains (#862) - The
start-multicommand is now more resilient to a node not being up or going down, and will attempt to reconnect (#871)
-
- Fix parsing in
chain_versionwhen chain identifier has multiple dashes (#80)
- Fix parsing in
-
- Fix pagination in gRPC query for clients (#811)
- Fix relayer crash when hermes starts in the same time as packets are being sent (#851)
- Fix missing port information in
hermes query channels(#840) - Fix crash during initialization of event monitor when node is down (#863)
- Spawn a single Tokio runtime for the whole supervisor instead of one per chain (#909)
- ibc-relayer
hermes -j query channelscommand now returnsresultarray with the format[{"channel_id":"channel-0","port_id":"transfer"}, ...]instead of["channel-0", ...](#840)
April 14th, 2021
This release includes initial support for relaying over multiple paths from a single hermes instance.
Adds support for relayer restart, where pending packets are cleared.
Includes support for ordered channels, packet delay, misbehaviour detection and evidence submission, client upgrade after counterparty chain upgrades.
This release brings improvements to the relayer UX by providing new and updated commands for keys, client, connection and channel management. In addition, it simplifies the configuration of and integration with the light client.
This release also finalizes the initial implementation of all the ICS 004 handlers.
-
Update to
tendermint-rsv0.19.0 (#798) -
- Added
create connectionandcreate channelCLIs (#630, #715) - Proposed ADR 006 to describe Hermes v0.2.0 use-cases (#637)
- Added
client-upgradeCLI (#357) - Added delay feature for packet relaying (#640)
- Update gaia to version 4.2.0 for e2e tests on CI (#809)
- Add
start-multicommand to relay on all paths defined in the configuration (#748) - Add option to specify which events to listen for in
listencommand (#550) - Add option to customise receiver address for
ft-transfercommand (#806) - Add
keys restorecommand to import a signing key from its mnemonic ([#813])
- Added
-
- Consistent identifier handling across ICS 02, 03 and 04 (#91)
-
- Replaced
rust-crypto&bitcoin-walletdeprecated dependencies (#352) - Fix for hard-coded account number (#752)
- Fix for chains that don't have
cosmosaccount prefix (#416) - Fix for building the
trusted_validator_setfor the header used in client updates (#770) - Don't send
MsgAcknowledgmentif channel is closed (#675) - Fix a bug where the keys addresses had their account prefix overridden by the prefix in the configuration (#751)
- Replaced
-
- Fix for proto files re-compilation bug (#11)
-
MsgConnectionOpenAck.counterparty_connection_idis now aConnectionIdinstead of anOption<ConnectionId>(#700)
-
- Remove the light client configuration from the global configuration (#793)
-
- Remove the light add and light rm commands (#793)
February 17, 2021
This release brings a quick fix for a problem with a dependency of crate
ibc-relayer, which causes build & installation issues. Many thanks to
@Fraccaman for bringing this problem to our attention! (#672)
Additionally, this release also introduces initial implementation for most of ICS 004 handlers, and several bug fixes and improvements, e.g., refactored some CLI code, refactored the Height type in the IBC Events, and a bug fix involving packet acks in a 3-chain setup. More details below.
-
- Quick fix for
funtybreaking change bug (#665)
- Quick fix for
-
- Fix wrong acks sent with
tx raw packet-ackin a 3-chain setup (#614)
- Fix wrong acks sent with
-
- Remove the
proofoption from CLI (#572)
- Remove the
February 4, 2021
🎉 This release brings the first publication of ibc-relayer and
ibc-relayer-cli to crates.io.
Noteworthy changes in this release include:
- The binary in the
ibc-relayer-clicrate was given the name Hermes. - We published a comprehensive guide for Hermes at hermes.informal.systems.
- Major improvements to user experience, in particular at CLI level: JSON output, configurable log output level, dedicated channel handshake command, as well as overall improvements to error display and output.
-
Continuous Integration (CI) end-to-end (e2e) testing with gaia v4 (#32, #582, #602)
-
Add support for streamlining releases (#507)
-
- Implement command to query the channels associated with a connection (#505)
- JSON output for queries and txs (#500)
- Added 'required' annotation for CLIs queries & txs; better error display (#555)
- Implement commands for channel close init and confirm (#94)
- Implement command to perform the handshake for a new channel (#557)
- Query all clients command (#552)
- Query all connections command (#553)
- Query all channels command (#568)
- Added a relayer binary guide (#542)
- Split the dev-env script in
setup_chainsandinit_clients(#577)
-
- Added retry mechanism, restructured relayer (#519)
- Relay
MsgTimeoutOnCloseif counterparty channel state isState::Closed
-
Update to
tokio1.0,prost0.7 andtonic0.4 (#527)
-
- Help and usage commands show 'hermes' for executable name (#590)
-
- Fix for storing
ClientTypeupon 'create-client' (#96)
- Fix for storing
December 23, 2020
This release focuses on upgrading the relayer and ibc modules to the latest interfaces from the ecosystem:
tendermint-rs v0.17, which brings the protobuf changes from tendermint v0.34.0, plus alignment with
the latest cosmos proto versions from v0.40.0-rc5 (sometimes called 'stargate-5').
December 2, 2020
This release focuses on implementing relayer and relayer-cli functionality towards a full v0 implementation. We now have the full-stack implementation for supporting client creation & updates, as well as connection- and channel handshakes. We also consolidated our TLA+ specs into an "IBC Core TLA+ specification," and added ICS 020 spec.
Special thanks to external contributors for this release: @CharlyCst (#102, #419).
- ibc-relayer-cli
- Add
--alloption tolight rmcommand to remove all peers for a given chain (#431)
- Add
- Update to tendermint-rs version
0.17-RC3(#403) - changelog Added "unreleased" section in
CHANGELOG.MDto help streamline releases (#274) - ibc
- ibc-relayer
- Retrieve account sequence information from a chain using a GRPC client (#18)
- Implementation of chain runtime for v0 (#330)
- Integrate relayer spike into ibc-relayer crate (#335)
- Implement
query_header_at_heightvia plain RPC queries (no light client verification) (#336) - Implement the relayer logic for connection handshake messages (#358, #359, #360)
- Implement the relayer logic for channel handshake messages (#371, #372, #373, #374)
- ibc-relayer-cli
- Merge light clients config in relayer config and add commands to add/remove light clients (#348)
- CLI for client update message (#277)
- Implement the relayer CLI for connection handshake messages (#358, #359, #360)
- Implement the relayer CLI for channel handshake messages (#371, #372, #373, #374)
- Added basic client, connection, and channel lifecycle in relayer v0 (#376, #377, #378)
- Implement commands to add and list keys for a chain (#363)
- Allow overriding of peer_id, height and hash in light add command (#428)
- proto-compiler
- ibc/relayer-spec
- ibc-relayer
- ibc-relayer-cli
- Split tasks spawned by CLI commands into their own modules ([#331])
- V0 command implementation (#346)
- ibc
- Split
msgs.rsof ICS002 in separate modules (#367) - Fixed inconsistent versioning for ICS003 and ICS004 (#97)
- Fixed
get_sign_bytesmethod for messages (#98) - Homogenize ConnectionReader trait so that all functions return owned objects (#102)
- Align with tendermint-rs in the domain type definition of
block::Id(#103)
- Split
October 19, 2020
This release focuses on alignment with the Cosmos ecosystem: adaptations to Tendermint-rs 0.16 and subsequently to 0.17 (0.17.0-rc1), and numerous protobuf updates following latest stargate releases.
Additional highlights:
- Adding DomainTypes and (de)serialization capability to ICS02 and ICS03 messages and structures.
- Improvements of the IBC message processor framework (handlers, contexts and mocks).
- Added initial implementations for the ICS26 (routing module) and ICS18 (basic relayer algorithms module) for use in testing.
- Also added support for packet handling in the relayer algorithm specifications.
- ibc-relayer & ibc Alignment with ecosystem updates:
- ibc-relayer UX improvement: Remove proof option from client connections command (#205)
- ibc/ics03 ICS03 Ack and Confirm message processors (#223)
- ibc-relayer-cli
- ibc Routing module minimal implementation for MVP (#128, #113)
- ibc/relayer-spec Relayer specification for packet handling (#229, #234, #237)
- ibc/relayer-spec Basic packet handling in TLA+(#124)
- ibc Basic relayer functionality: a test with ClientUpdate ping-pong between two mocked chains (#109)
- ibc Implemented the
DomainTypetrait for IBC proto structures (#245, #249). - ibc & ibc-proto Several improvements to message processors, among which (#115):
- ICS03 connection handshake protocol initial implementation and tests (#127)
- Add capability to decode from protobuf Any* type into Tendermint and Mock client states
- Cleanup Any* client wrappers related code
- Migrate handlers to newer protobuf definitions (#226)
- Extend client context mock (#114)
- Context mock simplifications and cleanup (#111, #295, #296, #297)
- ibc/ics03 Split
msgs.rsin multiple files, implementFromfor all messages (#112) - ibc-proto
- ibc/relayer-spec Add support for APALACHE to the Relayer TLA+ spec (#165)
- ibc-relayer Update to tendermint v.0.16 and integrate with the new light client implementation (#90, #243)
- ibc Removed "Uninitialized" state from connection (#217)
- ibc-relayer-cli Fix for client query subcommands (#231)
- disclosure-log & spec/connection-handshake Disclosed bugs in ICS3 version negotiation and proposed a fix (#117, #116)
September 1, 2020
This release focuses on the IBC message processor framework and initial implementations in ICS02 and ICS07. It also introduces an initial specification for the relayer algorithm.
Other highlights:
- The ibc crate is published as ibc in crates.io
- ADR-001 and ADR-003 are complete. 🎉
- ibc Renamed
modulescrate toibccrate. Version number for the new crate is not reset. (#198) - ibc/ics02
ConnectionIds are now decoded toVec<ConnectionId>and validated instead ofVec<String>(#123) - ibc/ics03 Removed
ConnectionandConnectionCounterpartytraits (#119) - ibc/ics04 Removed
ChannelandChannelCounterpartytraits (#120)
- ibc/ics02 partial implementation of message handler (#119, #118)
- ibc/ics07 partial implementation of message handler (#119, #118)
- architecture/ADR-003 Proposal for IBC handler (message processor) architecture (#119, #118)
- ibc/relayer-spec Detailed technical specification of the relayer algorithm with focus on client update (#84)
- architecture/ADR-001 Documentation for the repository structure (#1)
- architecture/FSM-1 Connection Handshake FSM English description (#122)
- contributing Updated CONTRIBUTING.md. Please read before opening PRs (#195)
- ibc-relayer-cli Refactor ConnectionId decoding in
query client(#123)
August 1, 2020
This release is focused on updating the query system from amino to protobuf, implementing a few queries from the CLI, and establishing an initial testing framework that will support multiple chain types.
It does not target a stable release of Cosmos-SDK chains, but is tracking the latest state of development towards the Cosmos-SDK Stargate release.
- [ibc|ibc-relayer] Refactor queries, paths, and Chain trait to reduce code and use protobuf instead of Amino. #152, #174, #155
- [repo] Moved relayer/cli to relayer-cli, relayer/relay to relayer. #183
- ibc-relayer Query connections given client id. #169
- ibc-relayer Query connection given connection id. #136
- ibc-relayer Query channel given channel id and port #163
- [spec] Channel closing datagrams in TLA+ #141
- [ci] Framework (scripts and Github Actions) for integration testing the relayer queries against
the Cosmos-SDK's
simdbinary with prepopulated IBC state in the genesis #140, #184 - [ibc-relayer|ibc] Implemented better Raw type handling. #156
- [repo] Add rust-toolchain file. #154
- ibc Fixed the identifiers limits according to updated ics spec. #189
- [ibc/relayer] Remove some warnings triggered during compilation due to dependency specification. #132
- ibc Fix nightly runs. #161
- [repo] Fix for incomplete licence terms. #153
July 1st, 2020
This is the initial prototype release of an IBC relayer and TLA+ specifications. There are no compatibility guarantees until v0.1.0.
Includes:
- Configuration file definition and validation
- Client state, consensus state, connection, channel queries.
- Note: deserialization is unimplemented as it has dependency on migration to protobuf for ABCI queries
- Per chain light clients threads are created and headers are periodically retrieved and verified.
- Per chain IBC event monitor threads are spawned and main event handler that receives them.
- Note: the event handler just displays the events.
- IBC Modules partial implementation for datastructures, messages and queries.
- Some English and TLA+ specifications for Connection & Channel Handshake as well as naive relayer algorithm.