Release Hermes v0.7.0

.changelog/v0.7.0/improvements/1265-async-tx-confirmation.md

@@ -0,0 +1,5 @@
+- Improve performance and reliability of the relayer by asynchronously waiting for tx confirmations ([#1124], [#1265])
+
+[#1124]: https://github.com/informalsystems/ibc-rs/issues/1124
+[#1265]: https://github.com/informalsystems/ibc-rs/issues/1265
+

.changelog/v0.7.0/summary.md

@@ -0,0 +1,3 @@
+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.
+Additionnally, Hermes now includes a REST server which exposes the relayer's internal state over HTTP.

CHANGELOG.md

@@ -1,5 +1,65 @@
 # CHANGELOG
 
+## v0.7.0
+
+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.
+Additionnally, Hermes now includes a REST server which exposes the relayer's internal state over HTTP.
+
+### BUG FIXES
+
+- [ibc](modules)
+ - Set the index of `ibc::ics05_port::capabilities::Capability` ([#1257])
+
+- [gm](scripts/gm)
+ - Fix silent exit when requirements are missing
+
+[#1257]: https://github.com/informalsystems/ibc-rs/issues/1257
+[#1261]: https://github.com/informalsystems/ibc-rs/issues/1261
+
+### FEATURES
+
+- General
+ - Update CI to test with gaiad v5.0.5 ([#1175])
+
+- [ibc-relayer-cli](relayer-cli)
+ - Add `keys delete` CLI command ([#1065])
+ - Add `--legacy | -l` flag to support upgrades for chains built with Cosmos SDK < v0.43.0 ([#1287])
+
+- [ibc-relayer](relayer)
+ - Expose the Hermes config and internal state over a REST API ([#843])
+ - Spawn packet workers only when there are outstanding packets or acknowledgements to relay ([#901])
+ - Upgrade to Cosmos SDK proto (v0.43.0) & ibc-go proto (v1.0.0) ([#948])
+
+[#843]: https://github.com/informalsystems/ibc-rs/issues/843
+[#901]: https://github.com/informalsystems/ibc-rs/issues/901
+[#948]: https://github.com/informalsystems/ibc-rs/pull/948
+[#1065]: https://github.com/informalsystems/ibc-rs/issues/1065
+[#1175]: https://github.com/informalsystems/ibc-rs/issues/1175
+[#1287]: https://github.com/informalsystems/ibc-rs/issues/1287
+
+### IMPROVEMENTS
+
+- General
+ - Update Modelator to 0.2.0 ([#1249])
+
+- [ibc-relayer-cli](relayer-cli)
+ - Add optional destination chain and `--verbose` options for `query channels` CLI ([#1132])
+
+- [ibc-relayer](relayer)
+ - Improve support for Interchain Accounts (ICS 027) ([#1191])
+ - Improve performance and reliability of the relayer by asynchronously waiting for tx confirmations ([#1124], [#1265])
+
+- [ibc](modules)
+ - Implement `ics02_client::client_consensus::ConsensusState` for `AnyConsensusState` ([#1297])
+
+[#1124]: https://github.com/informalsystems/ibc-rs/issues/1124
+[#1132]: https://github.com/informalsystems/ibc-rs/issues/1132
+[#1191]: https://github.com/informalsystems/ibc-rs/issues/1191
+[#1249]: https://github.com/informalsystems/ibc-rs/pull/1249
+[#1265]: https://github.com/informalsystems/ibc-rs/issues/1265
+[#1297]: https://github.com/informalsystems/ibc-rs/issues/1297
+
 ## v0.6.2
 
 This minor release of Hermes re-enables the `upgrade client`, `upgrade clients`,
@@ -36,7 +96,6 @@ handle errors ([#1158])
 
 [#1245]: https://github.com/informalsystems/ibc-rs/issues/1245
 
-
 ## v0.6.1
 *July 22nd, 2021*
 

README.md

@@ -32,6 +32,7 @@ Includes [TLA+ specifications](docs/spec).
 | [ibc](./modules) (modules) | lib| [![IBC Crate][ibc-crate-image]][ibc-crate-link] | [![IBC Docs][ibc-docs-image]][ibc-docs-link] |
 | [ibc-relayer](./relayer) | lib | [![IBC Relayer Crate][relayer-crate-image]][relayer-crate-link] | [![IBC Relayer Docs][relayer-docs-image]][relayer-docs-link] |
 | [ibc-relayer-cli](./relayer-cli) | bin: [hermes](relayer-cli/) | [![IBC Relayer CLI Crate][relayer-cli-crate-image]][relayer-cli-crate-link] | [![IBC Relayer CLI Docs][relayer-cli-docs-image]][relayer-cli-docs-link] |
+| [ibc-relayer-rest](./relayer-rest) | lib | [![IBC Relayer REST Crate][relayer-rest-crate-image]][relayer-rest-crate-link] | [![IBC Relayer REST Docs][relayer-rest-docs-image]][relayer-rest-docs-link] |
 | [ibc-proto](./proto) | lib | [![IBC Proto Crate][ibc-proto-crate-image]][ibc-proto-crate-link] | [![IBC Proto Docs][ibc-proto-docs-image]][ibc-proto-docs-link] |
 | [ibc-telemetry](./telemetry) | lib | [![IBC Telemetry Crate][ibc-telemetry-crate-image]][ibc-telemetry-crate-link] | [![IBC Telemetry Docs][ibc-telemetry-docs-image]][ibc-telemetry-docs-link] |
 
@@ -91,6 +92,10 @@ Unless required by applicable law or agreed to in writing, software distributed
 [relayer-cli-crate-link]: https://crates.io/crates/ibc-relayer-cli
 [relayer-cli-docs-image]: https://docs.rs/ibc-relayer-cli/badge.svg
 [relayer-cli-docs-link]: https://docs.rs/ibc-relayer-cli/
+[relayer-rest-crate-image]: https://img.shields.io/crates/v/ibc-relayer-rest.svg
+[relayer-rest-crate-link]: https://crates.io/crates/ibc-relayer-rest
+[relayer-rest-docs-image]: https://docs.rs/ibc-relayer-rest/badge.svg
+[relayer-rest-docs-link]: https://docs.rs/ibc-relayer-rest/
 [ibc-proto-crate-image]: https://img.shields.io/crates/v/ibc-proto.svg
 [ibc-proto-crate-link]: https://crates.io/crates/ibc-proto
 [ibc-proto-docs-image]: https://docs.rs/ibc-proto/badge.svg

guide/README.md

@@ -11,7 +11,7 @@ mdBook is a utility to create modern online books from Markdown files.
 This guide should be permanently deployed at its latest stable version at 
 [hermes.informal.systems](https://hermes.informal.systems).
 
-Current version: `0.6.2`.
+Current version: `0.7.0`.
 
 The version of this guide is aligned with the [versioning of the ibc crates](../README.md).
 

guide/src/SUMMARY.md

@@ -1,6 +1,6 @@
 # Summary
 
-# Hermes (v0.6.2)
+# Hermes (v0.7.0)
 
 ---
 - [Introduction](./index.md)
@@ -12,6 +12,7 @@
  - [Installation](./installation.md)
  - [Configuration](./config.md)
 - [Telemetry](./telemetry.md)
+- [REST API](./rest-api.md)
 - [Tutorials](./tutorials/index.md)
  - [Local chains](./tutorials/local-chains/index.md)
  - [Install Gaia](./tutorials/local-chains/gaia.md)

guide/src/commands/global.md

@@ -3,7 +3,7 @@
 Hermes accepts global options which affect all commands.
 
 ```shell
-hermes 0.6.2
+hermes 0.7.0
 Informal Systems <hello@informal.systems>
 Implementation of `hermes`, an IBC Relayer developed in Rust.
 

guide/src/config.md

@@ -27,7 +27,7 @@ The configuration file must have one `global` section, and one `chains` section
 > **Note:** As of 0.6.0, the Hermes configuration file is self-documented.
 > This section of the guide which discusses each parameter in turn is no
 > longer maintained, and we may remove it soon. Please read the configuration
-> file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v0.6.2/config.toml) itself for the most up-to-date documentation of parameters.
+> file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v0.7.0/config.toml) itself for the most up-to-date documentation of parameters.
 
 ### `[global]`
 
@@ -68,8 +68,29 @@ Here is an example for the `telemetry` section:
 ```toml
 [telemetry]
 enabled = true
-host = '127.0.0.1'
-port = 3001
+host = '127.0.0.1'
+port = 3001
+```
+
+### `[rest]`
+
+The `rest` section defines parameters for Hermes' built-in [REST API](rest-api.md)..
+
+#### Parameters
+
+* __enabled__: *(boolean)* Whether or not to enable the built-in REST server. Default: `false`.
+
+* __host__: *(string)* Specify the IPv4/6 host over which the built-in HTTP server will be listening. Default: `127.0.0.1`
+
+* __port__: *(u16)* Specify the port over which the built-in HTTP server will be listening. Default: `3000`
+
+Here is an example for the `rest` section:
+
+```toml
+[rest]
+enabled = true
+host = '127.0.0.1'
+port = 3000
 ```
 
 ### `[[chains]]`

guide/src/features.md

@@ -5,7 +5,7 @@ A feature matrix and comparison between the Rust and Go relayer implementations
 
 > **Cosmos SDK compatibility:**
 > Hermes supports Cosmos SDK chains implementing the [IBC v1.0][ibcv1] protocol specification.
-> Cosmos SDK versions `0.41.3` to `0.42.6` are officially supported.
+> Cosmos SDK versions `0.41.3` to `0.42.9` are officially supported.
 > In case Hermes finds an incompatible SDK version, it will output a log warning.
 
 [ibcv1]: https://github.com/cosmos/ibc-go/tree/main/proto/ibc

guide/src/help.md

@@ -39,7 +39,7 @@ hermes help create
 will provide details about all the valid invocations of the `create` CLI command.
 
 ```
-hermes 0.6.2
+hermes 0.7.0
 Informal Systems <hello@informal.systems>
 Hermes is an IBC Relayer written in Rust.
 
@@ -63,7 +63,7 @@ hermes help create channel
 ```
 
 ```
-hermes 0.6.2
+hermes 0.7.0
 Informal Systems <hello@informal.systems>
 Hermes is an IBC Relayer written in Rust.