Skip to content

Commit

Permalink
Release version 0.2.0 (#816)
Browse files Browse the repository at this point in the history
* Update ADR 006

* Update version number in guide

* Bump version number to 0.2.0 (0.8.0 for ibc-proto)
  • Loading branch information
romac authored Apr 14, 2021
1 parent cbf5138 commit 2cc5038
Show file tree
Hide file tree
Showing 15 changed files with 62 additions and 80 deletions.
12 changes: 8 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Changelog

## Unreleased Changes
## Unreleased

> Nothing yet.
## v0.2.0 (2021-04-14)

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.
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 initial implementation for all of ICS 004 handlers.
This release also finalizes the initial implementation of all the ICS 004 handlers.

### FEATURES

Expand Down
24 changes: 12 additions & 12 deletions Cargo.lock

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

4 changes: 2 additions & 2 deletions ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ __Note__: This assumes you are running this the first time, if not, please ensur
-----------------------------------------------------------------------------------------------------------------
Show relayer version
-----------------------------------------------------------------------------------------------------------------
relayer-cli 0.1.1
relayer-cli 0.2.0
-----------------------------------------------------------------------------------------------------------------
Setting up chains
-----------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -200,4 +200,4 @@ And in the relayer service:
```
args:
RELEASE: v4.1.0
```
```
19 changes: 1 addition & 18 deletions docs/architecture/adr-006-hermes-v0.2-usecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,23 +242,6 @@ will be in JSON.

Partially implemented.

## Limitations

### Light client security parameters

There are currently certain limitations on how a light client can be
instantiated, which can pose issues to the "client create" use-case that has
parametrized trust options.
(The discussion in [#673] provides further context on this.)
Consequently, the parametrized client create use-case may involve more complex
discussions and may not be handled within v0.2.0.

### Connection `delay_period` parameter

The present version v0.1.1 of Hermes as well as the planned v0.2.0 will __not__
include mechanism to obey the `delay_period` option of connections.
(Issue [#640] tracks this feature.)

## Consequences
### Positive

Expand Down Expand Up @@ -287,4 +270,4 @@ include mechanism to obey the `delay_period` option of connections.
[#640]: https://github.com/informalsystems/ibc-rs/issues/640
[client-state]: https://hermes.informal.systems/query_client.html#query-the-client-state
[client-create]: https://docs.rs/ibc/0.1.1/ibc/ics02_client/msgs/create_client/index.html
[output]: https://github.com/informalsystems/ibc-rs/blob/1f2e72dbcafee5a8bbdab381ff4927d5870b4b59/relayer-cli/src/conclude.rs#L80
[output]: https://github.com/informalsystems/ibc-rs/blob/1f2e72dbcafee5a8bbdab381ff4927d5870b4b59/relayer-cli/src/conclude.rs#L80
3 changes: 2 additions & 1 deletion guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ 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.1.1`.
Current version: `0.2.0`.

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

## Local deployment
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
# Hermes (v0.2.0)

---
- [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 @@
The Hermes accepts global options which affect all commands.

```shell
hermes 0.1.1
hermes 0.2.0
Informal Systems <hello@informal.systems>
Implementation of `hermes`, an IBC Relayer developed 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
# Hermes Guide (v0.2.0)

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.1.1-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.1.1-x86_64-unknown-linux-gnu.tar.gz` (or .zip).
- MacOS: `hermes-v0.2.0-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.2.0-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.1.1
hermes 0.2.0
```

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

## 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.1.1` then execute the command:
Then checkout the release, for example if the most recent release is `v0.2.0` then execute the command:

```shell
git checkout v0.1.1
git checkout v0.2.0
```

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

```
hermes 0.1.1
hermes 0.2.0
Informal Systems <hello@informal.systems>
USAGE:
Expand Down
8 changes: 3 additions & 5 deletions modules/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
[package]
name = "ibc"
version = "0.1.1"
version = "0.2.0"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
keywords = ["blockchain", "consensus", "cosmos", "ibc", "tendermint"]
repository = "https://github.com/informalsystems/ibc-rs"
authors = [
"Informal Systems <hello@informal.systems>"
]
authors = ["Informal Systems <hello@informal.systems>"]

description = """
Implementation of the Inter-Blockchain Communication Protocol (IBC).
Expand All @@ -22,7 +20,7 @@ mocks = [ "tendermint-testgen", "sha2" ]

[dependencies]
# Proto definitions for all IBC-related interfaces, e.g., connections or channels.
ibc-proto = { version = "0.7.1", path = "../proto" }
ibc-proto = { version = "0.8.0", path = "../proto" }
anomaly = "0.2.0"
chrono = "0.4"
thiserror = "1.0.24"
Expand Down
12 changes: 6 additions & 6 deletions proto/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[package]
name = "ibc-proto"
version = "0.7.1"
authors = ["Greg Szabo <greg@informal.systems>"]
edition = "2018"
license = "Apache-2.0"
name = "ibc-proto"
version = "0.8.0"
authors = ["Greg Szabo <greg@informal.systems>"]
edition = "2018"
license = "Apache-2.0"
repository = "https://github.com/informalsystems/ibc-proto/tree/master/ibc_proto"
readme = "README.md"
categories = ["cryptography", "cryptography::cryptocurrencies", "database"]
keywords = ["blockchain", "cosmos", "tendermint", "ibc", "proto"]
exclude = ["definitions"]
exclude = ["definitions"]

description = """
ibc-proto is a Rust implementation of the Cosmos SDK & IBC proto structs.
Expand Down
20 changes: 9 additions & 11 deletions relayer-cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
[package]
name = "ibc-relayer-cli"
version = "0.1.1"
edition = "2018"
name = "ibc-relayer-cli"
version = "0.2.0"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
keywords = ["blockchain", "consensus", "cosmos", "ibc", "tendermint"]
homepage = "https://hermes.informal.systems/"
homepage = "https://hermes.informal.systems/"
repository = "https://github.com/informalsystems/ibc-rs"
authors = [
"Informal Systems <hello@informal.systems>"
]
authors = ["Informal Systems <hello@informal.systems>"]

description = """
Implementation of `hermes`, an IBC Relayer developed in Rust.
Hermes is an IBC Relayer written in Rust.
"""

[[bin]]
Expand All @@ -22,9 +20,9 @@ name = "hermes"
profiling = ["ibc-relayer/profiling"]

[dependencies]
ibc = { version = "0.1.1", path = "../modules" }
ibc-relayer = { version = "0.1.1", path = "../relayer" }
ibc-proto = { version = "0.7.1", path = "../proto" }
ibc = { version = "0.2.0", path = "../modules" }
ibc-relayer = { version = "0.2.0", path = "../relayer" }
ibc-proto = { version = "0.8.0", path = "../proto" }

anomaly = "0.2.0"
gumdrop = "0.7"
Expand Down
2 changes: 1 addition & 1 deletion relayer-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//! For a comprehensive guide to using Hermes, the authoritative resource is
//! at [hermes.informal.systems].
//!
//! [ibc-relayer]: https://docs.rs/ibc-relayer/0.1.1/
//! [ibc-relayer]: https://docs.rs/ibc-relayer/0.2.0/
//! [Abscissa]: https://github.com/iqlusioninc/abscissa
//! [hermes.informal.systems]: https://hermes.informal.systems
Expand Down
16 changes: 7 additions & 9 deletions relayer/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
[package]
name = "ibc-relayer"
version = "0.1.1"
edition = "2018"
name = "ibc-relayer"
version = "0.2.0"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
keywords = ["blockchain", "consensus", "cosmos", "ibc", "tendermint"]
repository = "https://github.com/informalsystems/ibc-rs"
authors = [
"Informal Systems <hello@informal.systems>"
]
authors = ["Informal Systems <hello@informal.systems>"]

description = """
Implementation of an IBC Relayer in Rust, as a library.
Expand All @@ -18,8 +16,8 @@ description = """
profiling = []

[dependencies]
ibc = { version = "0.1.1", path = "../modules" }
ibc-proto = { version = "0.7.1", path = "../proto" }
ibc = { version = "0.2.0", path = "../modules" }
ibc-proto = { version = "0.8.0", path = "../proto" }

subtle-encoding = "0.5"
anomaly = "0.2.0"
Expand Down Expand Up @@ -71,7 +69,7 @@ version = "=0.19.0"

[dev-dependencies]
serial_test = "0.5.0"
ibc = { version = "0.1.1", path = "../modules", features = ["mocks"] }
ibc = { version = "0.2.0", path = "../modules", features = ["mocks"] }

# Needed for generating (synthetic) light blocks.
tendermint-testgen = { version = "=0.19.0" }
2 changes: 1 addition & 1 deletion relayer/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//!
//! For the IBC relayer binary, please see [Hermes] (`ibc-relayer-cli` crate).
//!
//! [Hermes]: https://docs.rs/ibc-relayer-cli/0.1.1/
//! [Hermes]: https://docs.rs/ibc-relayer-cli/0.2.0/
pub mod chain;
pub mod channel;
Expand Down

0 comments on commit 2cc5038

Please sign in to comment.