Skip to content

Commit

Permalink
Release Hermes v1.1.0 (#2774)
Browse files Browse the repository at this point in the history
* Bump crates version to 0.20.0 and Hermes version to 1.1.0

* Update lockfile

* Update CHANGELOG

* Release changelog

* Fix relayer-rest test

* Apply suggestions from code review

Co-authored-by: Sean Chen <[email protected]>
Co-authored-by: Luca Joss <[email protected]>
Signed-off-by: Romain Ruetschi <[email protected]>

* Update changelog

Signed-off-by: Romain Ruetschi <[email protected]>
Co-authored-by: Sean Chen <[email protected]>
Co-authored-by: Luca Joss <[email protected]>
  • Loading branch information
3 people authored Oct 28, 2022
1 parent 3aba0ff commit b7cbc35
Show file tree
Hide file tree
Showing 43 changed files with 427 additions and 200 deletions.
26 changes: 15 additions & 11 deletions .changelog/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,18 @@ general_entries_title = "General"
# The number of spaces to inject before each component-related entry.
entry_indent = 2

# The components themselves. Each component has a name (used when rendered
# to Markdown) and a path relative to the project folder (i.e. relative to
# the parent of the `.changelog` folder).
[components.all]
chain-registry = { name = "Chain Registry", path = "chain-registry" }
ibc = { name = "IBC Modules", path = "modules" }
ibc-relayer = { name = "Relayer Library", path = "relayer" }
ibc-relayer-cli = { name = "Relayer CLI", path = "relayer-cli" }
ibc-telemetry = { name = "Telemetry & Metrics", path = "telemetry" }
ibc-integration-test = { name = "Integration Test Framework", path = "tools/test-framework" }
guide = { name = "Guide", path = "guide" }
# The components themselves. Each component has a name (used when rendered
# to Markdown) and a path relative to the project folder (i.e. relative to
# the parent of the `.changelog` folder).
[components.all]
ibc-relayer = { name = "Relayer Library", path = "relayer" }
ibc-relayer-cli = { name = "Relayer CLI", path = "relayer-cli" }
ibc-relayer-types = { name = "IBC Data structures", path = "relayer-types" }
ibc-telemetry = { name = "Telemetry & Metrics", path = "telemetry" }
ibc-chain-registry = { name = "Chain Registry", path = "chain-registry" }
ibc-integration-test = { name = "Integration Test Framework", path = "tools/test-framework" }
guide = { name = "Guide", path = "guide" }

# Split off into their own repositories
ibc = { name = "IBC Modules", path = "modules" }
ibc-proto = { name = "IBC Protos", path = "proto" }

This file was deleted.

24 changes: 24 additions & 0 deletions .changelog/v1.1.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
*October 28th, 2022*

### Note to developers

The [`ibc`][ibc] and [`ibc-proto`][ibc-proto] crates
[have been split into their own repositories][split-tweet] under
the `cosmos` organization.

Moreover, Hermes [will not be using][split-issue] 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.

[ibc]: https://github.com/cosmos/ibc-rs
[ibc-proto]: https://github.com/cosmos/ibc-proto-rs
[cosmos]: https://github.com/cosmos
[split-tweet]: https://twitter.com/informalinc/status/1578120684508692481
[split-issue]: https://github.com/informalsystems/hermes/issues/2639

134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,139 @@
# CHANGELOG

## v1.1.0

*October 28th, 2022*

### Note to developers

The [`ibc`][ibc] and [`ibc-proto`][ibc-proto] crates
[have been split into their own repositories][split-tweet] under
the `cosmos` organization.

Moreover, Hermes [will not be using][split-issue] 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.

[ibc]: https://github.com/cosmos/ibc-rs
[ibc-proto]: https://github.com/cosmos/ibc-proto-rs
[cosmos]: https://github.com/cosmos
[split-tweet]: https://twitter.com/informalinc/status/1578120684508692481
[split-issue]: https://github.com/informalsystems/hermes/issues/2639

### General

The `gm` binary has been split out of the repo and has been moved into its own [repository](https://github.com/informalsystems/gm).
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](https://hermes.informal.systems/tutorials/local-chains/gaiad-manager.html#how-to-run) of the Hermes guide.

#### BREAKING CHANGES

- Removed `gm` folder and its contents
([#2754](https://github.com/informalsystems/hermes/issues/2754))
- Remove the `ibc-proto` and `ibc-proto-compiler` crates from the repository
([#2667](https://github.com/informalsystems/hermes/pull/2667))

#### BUG FIXES

- Fix incorrect Github workflow trigger paths
([#2667](https://github.com/informalsystems/hermes/pull/2667))
- Fix comment in `config.toml` to correctly state that the default value of `clear_on_start` is `true`
([#2750](https://github.com/informalsystems/hermes/issues/2750))


### Hermes - `ibc-relayer-cli` (v1.1.0)

#### FEATURES

- Add `hermes auto config` CLI command to automatically generate a config file with data from the chain registry
([#2187](https://github.com/informalsystems/hermes/issues/2187))
- Added new optional flag `--packet-data-query-height` to CLI `hermes tx packet-recv`
in order to specify the height at which the packet data is queried
([#2453](https://github.com/informalsystems/hermes/issues/2453))
- New command `fee transfer` which transfers tokens with fees
([#2714](https://github.com/informalsystems/hermes/issues/2714))

#### IMPROVEMENTS

- Clean up the logs emitted by the relayer and add more
structured information to the messages recorded in the logs
([#1538](https://github.com/informalsystems/hermes/issues/1538))
- Log the packets cleared by the `clear packets` command
([#2653](https://github.com/informalsystems/hermes/pull/2653))
- Add a new optional flag, `--denom` to the `hermes keys balance` command in order
to specify for which denomination the balance is queried.
Specify the `--all` flag to get the balance for all denominations
([#2726](https://github.com/informalsystems/hermes/issues/2726))


### Relayer Library - `ibc-relayer` (v0.20.0)

#### BREAKING CHANGES

- Bump tendermint-rs dependencies to v0.25.0
([#2677](https://github.com/informalsystems/ibc-rs/issues/2677))

#### BUG FIXES

- The channel and connection workers do not act needlessly on `NewBlock` events
anymore ([#2484](https://github.com/informalsystems/hermes/issues/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](https://github.com/informalsystems/hermes/issues/2670))
- Fix how headers are decoded from events
([#2739](https://github.com/informalsystems/hermes/issues/2739))

#### FEATURES

- Support custom extension options to be able to specify `max_priority_price` for Ethermint dynamic tx fee
([#2566](https://github.com/informalsystems/hermes/issues/2566))

#### IMPROVEMENTS

- Bump compatibility with IBC-Go v5 and Cosmos SDK v0.46
([#2532](https://github.com/informalsystems/hermes/issues/2532))
- Account for full transaction encoding when batching messages
([#2575](https://github.com/informalsystems/hermes/pull/2575))
- Add a health check to warn user if `gas_multiplier` is smaller than 1.1,
and improve client refresh frequency to depend on the `trusting_period`
([#2487](https://github.com/informalsystems/hermes/issues/2487))
- Set `max_tx_size` default value to 180KB instead of 2MB
([#2595](https://github.com/informalsystems/hermes/issues/2595))


### Chain Registry - `ibc-chain-registry` (v0.20.0)

- New crate `ibc-chain-registry` to fetch data from the [chain-registry][cosmos-chain-registry] and query RPC/gRPC endpoints
([#2187](https://github.com/informalsystems/hermes/issues/2187))

[cosmos-chain-registry]: https://github.com/cosmos/chain-registry

### `ibc-test-framework` (v0.20.0)

#### FEATURES

- Added Evmos compatible integration tests
([#2442](https://github.com/informalsystems/hermes/issues/2442))

### Guide

#### IMPROVEMENTS

- Integration with `mdbook` templates
([#2605](https://github.com/informalsystems/hermes/issues/2605))
- New script `auto_gen_templates.sh` to 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


## v1.0.0
*August 22nd, 2022*

Expand Down
Loading

0 comments on commit b7cbc35

Please sign in to comment.