Skip to content

Commit

Permalink
Release Hermes v0.6.1 (#1226)
Browse files Browse the repository at this point in the history
* Bump crates and guide to 0.6.1

* Fix `hdpath` version

* Update changelog

* Bump proto crate version.

* Fixed typo

* Fix for query tx events unwrap

* Add warning on cancelled subscription in supervisor

* Bump ibc-proto to 0.9.0

* Update `hdpath`'s dep on `bitcoin`

* Disable `upgrade client` command due to a regression

See #1229 for more info

* Disable `tx raw upgrade-chain` due to a regression

See #1229 for more info

* Remove mention of `upgrade clients` from the changelog

* Add warninga about newly disabled commands

* Disable `tx raw upgrade-clients` due to a regression

See #1229 for more info

* Update changelog

Co-authored-by: Adi Seredinschi <adi@informal.systems>
  • Loading branch information
romac and adizere authored Jul 22, 2021
1 parent 693f7d4 commit 9f38c37
Show file tree
Hide file tree
Showing 21 changed files with 124 additions and 74 deletions.
27 changes: 21 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# Changelog

## UNRELEASED
## Unreleased

> Nothing yet
## v0.6.1
*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`, and `tx raw upgrade-chain` commands have
> been temporarily disabled in this version.
> These commands will be re-enabled in the next version.
### FEATURES

Expand All @@ -9,9 +26,6 @@
- Add `ics26_routing::handler::decode` function ([#1194])
- Add a pseudo root to `MockConsensusState` ([#1215])

- [ibc-relayer-cli]
- Added `upgrade-clients` CLI ([#763])

### IMPROVEMENTS

- [ibc-relayer-cli]
Expand All @@ -25,7 +39,7 @@
- Align `as_str` and `from_str` behavior in `ClientType` ([#1192])

- [ibc-relayer]
- Fixed: Hermes does not clear packets on start ([#1200])
- Ensure pending packets are cleared on start ([#1200])
- Recover from missed RPC events after WebSocket subscription is closed by Tendermint ([#1196])


Expand All @@ -36,6 +50,8 @@
[#1196]: https://github.com/informalsystems/ibc-rs/issues/1196
[#1198]: https://github.com/informalsystems/ibc-rs/issues/1198
[#1200]: https://github.com/informalsystems/ibc-rs/issues/1200
[#1215]: https://github.com/informalsystems/ibc-rs/issues/1215
[#1229]: https://github.com/informalsystems/ibc-rs/issues/1229


## v0.6.0
Expand Down Expand Up @@ -122,7 +138,6 @@ The full list of changes is described below.
[#69]: https://github.com/informalsystems/ibc-rs/issues/69
[#600]: https://github.com/informalsystems/ibc-rs/issues/600
[#697]: https://github.com/informalsystems/ibc-rs/issues/697
[#763]: https://github.com/informalsystems/ibc-rs/issues/763
[#1062]: https://github.com/informalsystems/ibc-rs/issues/1062
[#1117]: https://github.com/informalsystems/ibc-rs/issues/1117
[#1057]: https://github.com/informalsystems/ibc-rs/issues/1057
Expand Down
44 changes: 19 additions & 25 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0`.
Current version: `0.6.1`.

The version of this guide is aligned with the [versioning of the ibc crates](../README.md).

Expand Down
2 changes: 1 addition & 1 deletion guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

# Hermes (v0.6.0)
# Hermes (v0.6.1)

---
- [Introduction](./index.md)
Expand Down
2 changes: 1 addition & 1 deletion guide/src/commands/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Hermes accepts global options which affect all commands.

```shell
hermes 0.6.0
hermes 0.6.1
Informal Systems <hello@informal.systems>
Implementation of `hermes`, an IBC Relayer developed in Rust.

Expand Down
6 changes: 3 additions & 3 deletions guide/src/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0/config.toml) itself for the most up-to-date documentation of parameters.
> file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v0.6.1/config.toml) itself for the most up-to-date documentation of parameters.
### `[global]`

Expand Down Expand Up @@ -183,10 +183,10 @@ trust_threshold = { numerator = '1', denominator = '3' }

## Update the configuration without restarting Hermes

Before Hermes 0.6.0, the only way to get Hermes to pick up a change in the
Before Hermes 0.6.1, the only way to get Hermes to pick up a change in the
configuration was to stop and restart Hermes.

As of version 0.6.0, Hermes will react to receiving a `SIGHUP` signal
As of version 0.6.1, Hermes will react to receiving a `SIGHUP` signal
by reloading the `[chains]` section of the configuration, and
stopping, starting or restarting the affected workers.

Expand Down
4 changes: 2 additions & 2 deletions guide/src/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ hermes help create
will provide details about all the valid invocations of the `create` CLI command.

```
hermes 0.6.0
hermes 0.6.1
Informal Systems <hello@informal.systems>
Hermes is an IBC Relayer written in Rust.
Expand All @@ -63,7 +63,7 @@ hermes help create channel
```

```
hermes 0.6.0
hermes 0.6.1
Informal Systems <hello@informal.systems>
Hermes is an IBC Relayer written in Rust.
Expand Down
2 changes: 1 addition & 1 deletion guide/src/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hermes Guide (v0.6.0)
# Hermes Guide (v0.6.1)

This guide can help you setup, configure, and operate Hermes to transfer
packets between two IBC enabled chains.
Expand Down
14 changes: 7 additions & 7 deletions guide/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ There are two main approaches for obtaining Hermes:

Simply head to the GitHub [Releases][releases] page and download the latest
version of Hermes binary matching your platform:
- MacOS: `hermes-v0.6.0-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.6.0-x86_64-unknown-linux-gnu.tar.gz` (or .zip).
- MacOS: `hermes-v0.6.1-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.6.1-x86_64-unknown-linux-gnu.tar.gz` (or .zip).

The step-by-step instruction below should carry you through the whole process:

Expand Down Expand Up @@ -47,7 +47,7 @@ hermes version
```

```
hermes 0.6.0
hermes 0.6.1
```

## Install via Cargo
Expand Down Expand Up @@ -81,7 +81,7 @@ hermes version
```
```
hermes 0.6.0
hermes 0.6.1
```

## Build from source
Expand All @@ -103,10 +103,10 @@ cd ibc-rs

Go to the [ibc-rs releases](https://github.com/informalsystems/ibc-rs/releases) page to see what is the most recent release.

Then checkout the release, for example if the most recent release is `v0.6.0` then execute the command:
Then checkout the release, for example if the most recent release is `v0.6.1` then execute the command:

```shell
git checkout v0.6.0
git checkout v0.6.1
```

### Building with `cargo build`
Expand Down Expand Up @@ -151,7 +151,7 @@ If you run the `hermes` without any additional parameters you should see the usa
```

```
hermes 0.6.0
hermes 0.6.1
Informal Systems <hello@informal.systems>
USAGE:
Expand Down
2 changes: 1 addition & 1 deletion guide/src/tutorials/local-chains/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To this end, clone the `ibc-rs` repository and check out the current version:
```bash
git clone git@github.com:informalsystems/ibc-rs.git
cd ibc-rs
git checkout v0.6.0
git checkout v0.6.1
```

### Stop existing `gaiad` processes
Expand Down
4 changes: 2 additions & 2 deletions modules/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc"
version = "0.6.0"
version = "0.6.1"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
Expand All @@ -20,7 +20,7 @@ mocks = [ "tendermint-testgen", "sha2" ]

[dependencies]
# Proto definitions for all IBC-related interfaces, e.g., connections or channels.
ibc-proto = { version = "0.8.0", path = "../proto" }
ibc-proto = { version = "0.9.0", path = "../proto" }
ics23 = "0.6.5"
anomaly = "0.2.0"
chrono = "0.4.19"
Expand Down
2 changes: 1 addition & 1 deletion proto/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc-proto"
version = "0.8.2"
version = "0.9.0"
authors = ["Informal Systems <hello@informal.systems>"]
edition = "2018"
license = "Apache-2.0"
Expand Down
10 changes: 5 additions & 5 deletions relayer-cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc-relayer-cli"
version = "0.6.0"
version = "0.6.1"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
Expand All @@ -22,10 +22,10 @@ profiling = ["ibc-relayer/profiling"]
telemetry = ["ibc-relayer/telemetry", "ibc-telemetry"]

[dependencies]
ibc = { version = "0.6.0", path = "../modules" }
ibc-relayer = { version = "0.6.0", path = "../relayer" }
ibc-proto = { version = "0.8.2", path = "../proto" }
ibc-telemetry = { version = "0.6.0", path = "../telemetry", optional = true }
ibc = { version = "0.6.1", path = "../modules" }
ibc-relayer = { version = "0.6.1", path = "../relayer" }
ibc-proto = { version = "0.9.0", path = "../proto" }
ibc-telemetry = { version = "0.6.1", path = "../telemetry", optional = true }

anomaly = "0.2.0"
gumdrop = { version = "0.7", features = ["default_expr"] }
Expand Down
Loading

0 comments on commit 9f38c37

Please sign in to comment.