Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release ibc-rs v0.10.0 #1712

Merged
merged 16 commits into from
Jan 13, 2022
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Improve spawning of supervisor worker tasks ([#1656](https://github.com/informalsystems/ibc-rs/issues/1656))
- The `Supervisor` struct is removed.
- Supervisor is now spawned using the `spawn_supervisor` function.
3 changes: 1 addition & 2 deletions .changelog/unreleased/bug-fixes/1264-recover-acct-seq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
- Added a recovery mechanism to automatically retry or drop tx upon account
sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-
rs/issues/1264))
sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-rs/issues/1264))
14 changes: 7 additions & 7 deletions Cargo.lock

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

8 changes: 4 additions & 4 deletions guide/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Hermes Guide

Hermes is the name of the binary that comes packaged with
Hermes is the name of the binary that comes packaged with
[IBC Relayer CLI](https://crates.io/crates/ibc-relayer-cli) crate.

This directory comprises a comprehensive guide to Hermes.
In order to build and view this guide you need to install [`mdBook`]
(https://github.com/rust-lang/mdBook).
mdBook is a utility to create modern online books from Markdown files.

This guide should be permanently deployed at its latest stable version at
This guide should be permanently deployed at its latest stable version at
[hermes.informal.systems](https://hermes.informal.systems).

Current version: `0.9.0`.
Current version: `0.10.0`.

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

Expand Down Expand Up @@ -64,7 +64,7 @@ http://localhost:3000

## Adding or editing new content to the guide

Please check the [mdBook documentation](https://rust-lang.github.io/mdBook/index.html) for additional information on how to add new content to the guide.
Please check the [mdBook documentation](https://rust-lang.github.io/mdBook/index.html) for additional information on how to add new content to the guide.

Basically if you want to add new content to the guide, just add an entry to the `SUMMARY.md` Markdown file which is the TOC page. Then create a page for the entry you've added to the `SUMMARY.md` page. If you don't create the page, but save the `SUMMARY.md` file and build again, `mdBook` will create the page automatically for you.

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

# Hermes (v0.9.0)
# Hermes (v0.10.0)

---
- [Introduction](./index.md)
Expand Down Expand Up @@ -29,7 +29,7 @@
- [Commands Reference](./commands/index.md)
- [Global options and JSON output](./commands/global.md)
- [Keys](./commands/keys/index.md)
- [Config](./commands/config.md)
- [Config](./commands/config.md)
- [Path setup](./commands/path-setup/index.md)
- [Clients](./commands/path-setup/clients.md)
- [Connections](./commands/path-setup/connections.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.9.0
hermes 0.10.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/commands/path-setup/channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ FLAGS:
--port-a PORT-A identifier of the side `a` port for the new channel
--port-b PORT-B identifier of the side `b` port for the new channel
-o, --order ORDER the channel ordering, valid options 'unordered' (default) and 'ordered'
-v, --version VERSION the version for the new channel
-v, --channel-version VERSION the version for the new channel
```

## Examples
Expand Down
4 changes: 2 additions & 2 deletions guide/src/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ hermes [-c CONFIG_FILE] COMMAND
The configuration file must have one `global` section, and one `chains` section for each chain.

> **Note:** As of 0.6.0, the Hermes configuration file is self-documented.
> Please read the configuration file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v0.9.0/config.toml)
> Please read the configuration file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v0.10.0/config.toml)
> itself for the most up-to-date documentation of parameters.

By default, Hermes will relay on all channels available between all the configured chains.
Expand All @@ -36,7 +36,7 @@ For example, if there are only two chains configured, then Hermes will only rela
i.e. the two chains will serve as a source for each other, and likewise as a destination for each other's relevant events.
Hermes will ignore all events that pertain to chains which are unknown (ie. not present in config.toml).

To restrict relaying on specific channels, or uni-directionally, you can use [packet filtering policies](https://github.com/informalsystems/ibc-rs/blob/v0.9.0/config.toml#L156-L173).
To restrict relaying on specific channels, or uni-directionally, you can use [packet filtering policies](https://github.com/informalsystems/ibc-rs/blob/v0.10.0/config.toml#L156-L173).
romac marked this conversation as resolved.
Show resolved Hide resolved
romac marked this conversation as resolved.
Show resolved Hide resolved

## Adding private keys

Expand Down
5 changes: 3 additions & 2 deletions guide/src/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,11 @@ FLAGS:
--port-a PORT-A identifier of the side `a` port for the new channel
--port-b PORT-B identifier of the side `b` port for the new channel
-o, --order ORDER the channel ordering, valid options 'unordered' (default) and 'ordered'
-v, --version VERSION the version for the new channel
-v, --channel-version VERSION the version for the new channel
```

The `help` command is a replacement of the familiar `-h`/ `--help` flag typical for CLI applications.
Additionally, the `-h`/`--help` flags typical for CLI applications work on
all commands.

## Parametrizing the log output level

Expand Down
3 changes: 1 addition & 2 deletions guide/src/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hermes Guide (v0.9.0)
# Hermes Guide (v0.10.0)


Hermes is a an open-source Rust implementation of a relayer for the
Expand Down Expand Up @@ -51,4 +51,3 @@ packets between two or more IBC-enabled chains.
## Disclaimer

This project is undergoing heavy development, use at your own risk.

18 changes: 9 additions & 9 deletions guide/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ 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.9.0-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.9.0-x86_64-unknown-linux-gnu.tar.gz` (or .zip).
- MacOS: `hermes-v0.10.0-x86_64-apple-darwin.tar.gz` (or .zip),
- Linux: `hermes-v0.10.0-x86_64-unknown-linux-gnu.tar.gz` (or .zip).

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

1. Make the directory where we'll place the binary:
```shell
mkdir -p $HOME/.hermes/bin
Expand Down Expand Up @@ -47,7 +47,7 @@ hermes version
```

```
hermes 0.9.0
hermes 0.10.0
```

## Install via Cargo
Expand All @@ -62,7 +62,7 @@ To install the latest release of Hermes, run the following command in a terminal
cargo install ibc-relayer-cli --bin hermes --locked
```

This will download and build the crate `ibc-relayer-cli`, and install the
This will download and build the crate `ibc-relayer-cli`, and install the
`hermes` binary in `$HOME/.cargo/bin`.

> If you have not installed Rust and Cargo via [rustup.rs](https://rustup.rs), you may need to
Expand All @@ -81,7 +81,7 @@ hermes version
```

```
hermes 0.9.0
hermes 0.10.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.9.0` then execute the command:
Then checkout the release, for example if the most recent release is `v0.10.0` then execute the command:

```shell
git checkout v0.9.0
git checkout v0.10.0
```

### 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.9.0
hermes 0.10.0
Informal Systems <hello@informal.systems>

USAGE:
Expand Down
3 changes: 1 addition & 2 deletions guide/src/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ as the version of the REST server itself (under the `ibc-relayer-rest` key).
[
{
"name": "ibc-relayer",
"version": "0.9.0"
"version": "0.10.0"
},
{
"name": "ibc-relayer-rest",
Expand Down Expand Up @@ -175,4 +175,3 @@ of all the workers which are currently active.
}
}
```

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.9.0
git checkout v0.10.0
```

### 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.9.0"
version = "0.10.0"
edition = "2021"
license = "Apache-2.0"
readme = "README.md"
Expand All @@ -25,7 +25,7 @@ mocks = ["tendermint-testgen"]

[dependencies]
# Proto definitions for all IBC-related interfaces, e.g., connections or channels.
ibc-proto = { version = "0.13.0", path = "../proto" }
ibc-proto = { version = "0.14.0", path = "../proto" }
ics23 = { version = "0.6.7", default-features = false }
time = { version = "0.3", default-features = false }
thiserror = { version = "1.0.30", default-features = false }
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.13.0"
version = "0.14.0"
authors = ["Informal Systems <hello@informal.systems>"]
edition = "2021"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion proto/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#![allow(clippy::large_enum_variant)]
#![allow(rustdoc::bare_urls)]
#![forbid(unsafe_code)]
#![doc(html_root_url = "https://docs.rs/ibc-proto/0.13.0")]
#![doc(html_root_url = "https://docs.rs/ibc-proto/0.14.0")]

extern crate alloc;
extern crate core as std;
Expand Down
12 changes: 6 additions & 6 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.9.0"
version = "0.10.0"
edition = "2021"
license = "Apache-2.0"
readme = "README.md"
Expand All @@ -26,11 +26,11 @@ telemetry = ["ibc-relayer/telemetry", "ibc-telemetry"]
rest-server = ["ibc-relayer-rest"]

[dependencies]
ibc = { version = "0.9.0", path = "../modules" }
ibc-relayer = { version = "0.9.0", path = "../relayer" }
ibc-proto = { version = "0.13.0", path = "../proto" }
ibc-telemetry = { version = "0.9.0", path = "../telemetry", optional = true }
ibc-relayer-rest = { version = "0.9.0", path = "../relayer-rest", optional = true }
ibc = { version = "0.10.0", path = "../modules" }
ibc-relayer = { version = "0.10.0", path = "../relayer" }
ibc-proto = { version = "0.14.0", path = "../proto" }
ibc-telemetry = { version = "0.10.0", path = "../telemetry", optional = true }
ibc-relayer-rest = { version = "0.10.0", path = "../relayer-rest", optional = true }

clap = { version = "=3.0.0-beta.5" }
serde = { version = "1.0", features = ["serde_derive"] }
Expand Down
6 changes: 3 additions & 3 deletions relayer-rest/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc-relayer-rest"
version = "0.9.0"
version = "0.10.0"
authors = ["Informal Systems <hello@informal.systems>"]
edition = "2021"
license = "Apache-2.0"
Expand All @@ -14,8 +14,8 @@ description = """
"""

[dependencies]
ibc = { version = "0.9.0", path = "../modules" }
ibc-relayer = { version = "0.9.0", path = "../relayer" }
ibc = { version = "0.10.0", path = "../modules" }
ibc-relayer = { version = "0.10.0", path = "../relayer" }

crossbeam-channel = "0.5"
rouille = "3.5"
Expand Down
2 changes: 1 addition & 1 deletion relayer-rest/tests/mock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ fn version() {

let rest_api_version = VersionInfo {
name: "ibc-relayer-rest".to_string(),
version: "0.9.0".to_string(),
version: "0.10.0".to_string(),
};

let result = vec![version.clone(), rest_api_version];
Expand Down
10 changes: 5 additions & 5 deletions relayer/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc-relayer"
version = "0.9.0"
version = "0.10.0"
edition = "2021"
license = "Apache-2.0"
readme = "README.md"
Expand All @@ -21,9 +21,9 @@ profiling = []
telemetry = ["ibc-telemetry"]

[dependencies]
ibc = { version = "0.9.0", path = "../modules" }
ibc-proto = { version = "0.13.0", path = "../proto" }
ibc-telemetry = { version = "0.9.0", path = "../telemetry", optional = true }
ibc = { version = "0.10.0", path = "../modules" }
ibc-proto = { version = "0.14.0", path = "../proto" }
ibc-telemetry = { version = "0.10.0", path = "../telemetry", optional = true }

subtle-encoding = "0.5"
humantime-serde = "1.0.0"
Expand Down Expand Up @@ -86,7 +86,7 @@ features = ["rpc-client", "secp256k1", "unstable"]
version = "=0.23.2"

[dev-dependencies]
ibc = { version = "0.9.0", path = "../modules", features = ["mocks"] }
ibc = { version = "0.10.0", path = "../modules", features = ["mocks"] }
serial_test = "0.5.0"
env_logger = "0.9.0"
tracing-subscriber = { version = "0.3.5", features = ["fmt", "env-filter", "json"] }
Expand Down
Loading