From 736b23dd62599411873815e9ad7a2c498712d513 Mon Sep 17 00:00:00 2001 From: Soares Chen Date: Thu, 23 Dec 2021 11:33:41 +0100 Subject: [PATCH 01/13] Update package versions from v0.9.0 to v0.10.0 --- Cargo.lock | 12 ++++++------ guide/README.md | 8 ++++---- guide/src/SUMMARY.md | 4 ++-- guide/src/commands/global.md | 2 +- guide/src/config.md | 4 ++-- guide/src/index.md | 3 +-- guide/src/installation.md | 18 +++++++++--------- guide/src/rest-api.md | 3 +-- guide/src/tutorials/local-chains/start.md | 2 +- modules/Cargo.toml | 2 +- relayer-cli/Cargo.toml | 10 +++++----- relayer-rest/Cargo.toml | 6 +++--- relayer-rest/tests/mock.rs | 2 +- relayer/Cargo.toml | 8 ++++---- telemetry/Cargo.toml | 4 ++-- tools/integration-test/Cargo.toml | 2 +- 16 files changed, 44 insertions(+), 46 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 7fb9e17319..67bb67f7cb 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1367,7 +1367,7 @@ dependencies = [ [[package]] name = "ibc" -version = "0.9.0" +version = "0.10.0" dependencies = [ "bytes", "env_logger", @@ -1397,7 +1397,7 @@ dependencies = [ [[package]] name = "ibc-integration-test" -version = "0.8.0" +version = "0.10.0" dependencies = [ "color-eyre", "crossbeam-channel 0.5.1", @@ -1442,7 +1442,7 @@ dependencies = [ [[package]] name = "ibc-relayer" -version = "0.9.0" +version = "0.10.0" dependencies = [ "anyhow", "async-stream", @@ -1497,7 +1497,7 @@ dependencies = [ [[package]] name = "ibc-relayer-cli" -version = "0.9.0" +version = "0.10.0" dependencies = [ "abscissa_core", "atty", @@ -1537,7 +1537,7 @@ dependencies = [ [[package]] name = "ibc-relayer-rest" -version = "0.9.0" +version = "0.10.0" dependencies = [ "crossbeam-channel 0.5.1", "ibc", @@ -1552,7 +1552,7 @@ dependencies = [ [[package]] name = "ibc-telemetry" -version = "0.9.0" +version = "0.10.0" dependencies = [ "crossbeam-channel 0.5.1", "ibc", diff --git a/guide/README.md b/guide/README.md index 9194922a88..4dd5170585 100644 --- a/guide/README.md +++ b/guide/README.md @@ -1,6 +1,6 @@ # 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. @@ -8,10 +8,10 @@ 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). @@ -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. diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index cd779335b9..8bfe3ffb74 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -# Hermes (v0.9.0) +# Hermes (v0.10.0) --- - [Introduction](./index.md) @@ -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) diff --git a/guide/src/commands/global.md b/guide/src/commands/global.md index 11a12faa0a..4bae012db2 100644 --- a/guide/src/commands/global.md +++ b/guide/src/commands/global.md @@ -3,7 +3,7 @@ Hermes accepts global options which affect all commands. ```shell -hermes 0.9.0 +hermes 0.10.0 Informal Systems Implementation of `hermes`, an IBC Relayer developed in Rust. diff --git a/guide/src/config.md b/guide/src/config.md index 266ce99d94..cf88d9d52e 100644 --- a/guide/src/config.md +++ b/guide/src/config.md @@ -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. @@ -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). ## Adding private keys diff --git a/guide/src/index.md b/guide/src/index.md index 5f5d208c4f..ae3786cd45 100644 --- a/guide/src/index.md +++ b/guide/src/index.md @@ -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 @@ -51,4 +51,3 @@ packets between two or more IBC-enabled chains. ## Disclaimer This project is undergoing heavy development, use at your own risk. - diff --git a/guide/src/installation.md b/guide/src/installation.md index 0649666533..5e7b8a16f4 100644 --- a/guide/src/installation.md +++ b/guide/src/installation.md @@ -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 @@ -47,7 +47,7 @@ hermes version ``` ``` -hermes 0.9.0 +hermes 0.10.0 ``` ## Install via Cargo @@ -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 @@ -81,7 +81,7 @@ hermes version ``` ``` -hermes 0.9.0 +hermes 0.10.0 ``` ## Build from source @@ -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` @@ -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 USAGE: diff --git a/guide/src/rest-api.md b/guide/src/rest-api.md index 0dc084498d..7d31159e02 100644 --- a/guide/src/rest-api.md +++ b/guide/src/rest-api.md @@ -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", @@ -175,4 +175,3 @@ of all the workers which are currently active. } } ``` - diff --git a/guide/src/tutorials/local-chains/start.md b/guide/src/tutorials/local-chains/start.md index 62d67344c3..b555a14038 100644 --- a/guide/src/tutorials/local-chains/start.md +++ b/guide/src/tutorials/local-chains/start.md @@ -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 diff --git a/modules/Cargo.toml b/modules/Cargo.toml index 9fc3ca2a1c..1951cc2ca7 100644 --- a/modules/Cargo.toml +++ b/modules/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc" -version = "0.9.0" +version = "0.10.0" edition = "2021" license = "Apache-2.0" readme = "README.md" diff --git a/relayer-cli/Cargo.toml b/relayer-cli/Cargo.toml index c29d8771ee..770c07eafc 100644 --- a/relayer-cli/Cargo.toml +++ b/relayer-cli/Cargo.toml @@ -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" @@ -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 = { version = "0.10.0", path = "../modules" } +ibc-relayer = { version = "0.10.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-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"] } diff --git a/relayer-rest/Cargo.toml b/relayer-rest/Cargo.toml index 075f4ea387..f7dbe935d2 100644 --- a/relayer-rest/Cargo.toml +++ b/relayer-rest/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-rest" -version = "0.9.0" +version = "0.10.0" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0" @@ -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" diff --git a/relayer-rest/tests/mock.rs b/relayer-rest/tests/mock.rs index 4e1b9e519a..5b792cc329 100644 --- a/relayer-rest/tests/mock.rs +++ b/relayer-rest/tests/mock.rs @@ -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]; diff --git a/relayer/Cargo.toml b/relayer/Cargo.toml index fd8a8c1236..fd21514d16 100644 --- a/relayer/Cargo.toml +++ b/relayer/Cargo.toml @@ -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" @@ -21,9 +21,9 @@ profiling = [] telemetry = ["ibc-telemetry"] [dependencies] -ibc = { version = "0.9.0", path = "../modules" } +ibc = { version = "0.10.0", path = "../modules" } ibc-proto = { version = "0.13.0", path = "../proto" } -ibc-telemetry = { version = "0.9.0", path = "../telemetry", optional = true } +ibc-telemetry = { version = "0.10.0", path = "../telemetry", optional = true } subtle-encoding = "0.5" humantime-serde = "1.0.0" @@ -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.3", features = ["fmt", "env-filter", "json"] } diff --git a/telemetry/Cargo.toml b/telemetry/Cargo.toml index ec3b460211..29fb933ad1 100644 --- a/telemetry/Cargo.toml +++ b/telemetry/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-telemetry" -version = "0.9.0" +version = "0.10.0" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -13,7 +13,7 @@ description = """ """ [dependencies] -ibc = { version = "0.9.0", path = "../modules" } +ibc = { version = "0.10.0", path = "../modules" } crossbeam-channel = "0.5.1" once_cell = "1.9.0" diff --git a/tools/integration-test/Cargo.toml b/tools/integration-test/Cargo.toml index 316467c3f2..233d1b11ee 100644 --- a/tools/integration-test/Cargo.toml +++ b/tools/integration-test/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-integration-test" -version = "0.8.0" +version = "0.10.0" edition = "2021" license = "Apache-2.0" readme = "README.md" From c826cea38c2c0e2b7a91a96a3707d25ecf100777 Mon Sep 17 00:00:00 2001 From: Soares Chen Date: Thu, 23 Dec 2021 11:41:46 +0100 Subject: [PATCH 02/13] Add changelog for #1656 --- .../breaking-changes/ibc-relayer/1656-supervisor-spawn.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md diff --git a/.changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md b/.changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md new file mode 100644 index 0000000000..aab7c64a3e --- /dev/null +++ b/.changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md @@ -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. From 209fcdd5bc9a1c06e7301d6bd5d0a8ce5558ae63 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Thu, 23 Dec 2021 13:49:01 +0100 Subject: [PATCH 03/13] Bump `ibc-proto` version to 0.14.0 --- Cargo.lock | 2 +- modules/Cargo.toml | 2 +- proto/Cargo.toml | 2 +- relayer-cli/Cargo.toml | 2 +- relayer/Cargo.toml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 67bb67f7cb..7238af9d19 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1429,7 +1429,7 @@ dependencies = [ [[package]] name = "ibc-proto" -version = "0.13.0" +version = "0.14.0" dependencies = [ "bytes", "getrandom 0.2.3", diff --git a/modules/Cargo.toml b/modules/Cargo.toml index 1951cc2ca7..a846e4307c 100644 --- a/modules/Cargo.toml +++ b/modules/Cargo.toml @@ -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 } diff --git a/proto/Cargo.toml b/proto/Cargo.toml index e7a1b4e213..5839dd0f0f 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-proto" -version = "0.13.0" +version = "0.14.0" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0" diff --git a/relayer-cli/Cargo.toml b/relayer-cli/Cargo.toml index 770c07eafc..333be016c6 100644 --- a/relayer-cli/Cargo.toml +++ b/relayer-cli/Cargo.toml @@ -28,7 +28,7 @@ rest-server = ["ibc-relayer-rest"] [dependencies] ibc = { version = "0.10.0", path = "../modules" } ibc-relayer = { version = "0.10.0", path = "../relayer" } -ibc-proto = { version = "0.13.0", path = "../proto" } +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 } diff --git a/relayer/Cargo.toml b/relayer/Cargo.toml index fd21514d16..0006eda995 100644 --- a/relayer/Cargo.toml +++ b/relayer/Cargo.toml @@ -22,7 +22,7 @@ telemetry = ["ibc-telemetry"] [dependencies] ibc = { version = "0.10.0", path = "../modules" } -ibc-proto = { version = "0.13.0", path = "../proto" } +ibc-proto = { version = "0.14.0", path = "../proto" } ibc-telemetry = { version = "0.10.0", path = "../telemetry", optional = true } subtle-encoding = "0.5" From 3acc1c3a1ba3c71de15838179f547464bc803d63 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Thu, 23 Dec 2021 16:02:36 +0100 Subject: [PATCH 04/13] Update guide wrt --help and --channel-version --- guide/src/commands/path-setup/channels.md | 2 +- guide/src/help.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/guide/src/commands/path-setup/channels.md b/guide/src/commands/path-setup/channels.md index 0f96e8ab17..4b44dd9e8f 100644 --- a/guide/src/commands/path-setup/channels.md +++ b/guide/src/commands/path-setup/channels.md @@ -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 diff --git a/guide/src/help.md b/guide/src/help.md index 7147969495..a6992e4dd3 100644 --- a/guide/src/help.md +++ b/guide/src/help.md @@ -74,10 +74,13 @@ 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 +most commands (with the exception of some commands currently using `-h` for +other purposes; these should be changed to follow the convention in a +future version). ## Parametrizing the log output level From 60829af18b60f8b944cc028d28031724b8070e88 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Thu, 23 Dec 2021 16:47:46 +0100 Subject: [PATCH 05/13] Disambiguate between help and height flags by using `-H` for the latter --- guide/src/commands/path-setup/clients.md | 2 +- guide/src/commands/queries/channel.md | 6 +++--- guide/src/commands/queries/client.md | 8 ++++---- guide/src/commands/queries/connection.md | 2 +- guide/src/commands/queries/packet.md | 4 ++-- guide/src/commands/raw/client.md | 2 +- relayer-cli/src/commands/query/channel.rs | 3 +-- relayer-cli/src/commands/query/channel_ends.rs | 2 +- relayer-cli/src/commands/query/client.rs | 10 ++++------ relayer-cli/src/commands/query/connection.rs | 3 +-- relayer-cli/src/commands/query/packet/ack.rs | 3 +-- relayer-cli/src/commands/query/packet/commitment.rs | 3 +-- relayer-cli/src/commands/tx/client.rs | 3 +-- 13 files changed, 22 insertions(+), 29 deletions(-) diff --git a/guide/src/commands/path-setup/clients.md b/guide/src/commands/path-setup/clients.md index 5e0c43b2dc..0f79a0cb8a 100644 --- a/guide/src/commands/path-setup/clients.md +++ b/guide/src/commands/path-setup/clients.md @@ -67,7 +67,7 @@ POSITIONAL ARGUMENTS: dst_client_id identifier of the client to be updated on destination chain FLAGS: - -h, --target-height TARGET-HEIGHT + -H, --target-height TARGET-HEIGHT -t, --trusted-height TRUSTED-HEIGHT ``` diff --git a/guide/src/commands/queries/channel.md b/guide/src/commands/queries/channel.md index 670ddbc8e6..54c731f12b 100644 --- a/guide/src/commands/queries/channel.md +++ b/guide/src/commands/queries/channel.md @@ -79,7 +79,7 @@ POSITIONAL ARGUMENTS: channel_id identifier of the channel to query FLAGS: - -h, --height HEIGHT height of the state to query + -H, --height HEIGHT height of the state to query ``` __Example__ @@ -131,7 +131,7 @@ POSITIONAL ARGUMENTS: channel_id identifier of the channel to query FLAGS: - -h, --height HEIGHT height of the state to query + -H, --height HEIGHT height of the state to query -v, --verbose enable verbose output, displaying all details of channels, connections & clients ``` @@ -181,4 +181,4 @@ Success: ChannelEndsSummary { ``` Passing the `-v` flag will additionally print all the details of the -channel, connection, and client on both ends. \ No newline at end of file +channel, connection, and client on both ends. diff --git a/guide/src/commands/queries/client.md b/guide/src/commands/queries/client.md index 85001ab55a..1603f8332e 100644 --- a/guide/src/commands/queries/client.md +++ b/guide/src/commands/queries/client.md @@ -100,7 +100,7 @@ POSITIONAL ARGUMENTS: client_id identifier of the client to query FLAGS: - -h, --height HEIGHT the chain height which this query should reflect + -H, --height HEIGHT the chain height which this query should reflect ``` __Example__ @@ -159,7 +159,7 @@ POSITIONAL ARGUMENTS: FLAGS: -c, --consensus-height CONSENSUS-HEIGHT -s, --heights-only show only consensus heights - -h, --height HEIGHT the chain height context to be used, applicable only to a specific height + -H, --height HEIGHT the chain height context to be used, applicable only to a specific height ``` __Example__ @@ -235,7 +235,7 @@ POSITIONAL ARGUMENTS: client_id identifier of the client to query FLAGS: - -h, --height HEIGHT the chain height which this query should reflect + -H, --height HEIGHT the chain height which this query should reflect ``` __Example__ @@ -268,7 +268,7 @@ POSITIONAL ARGUMENTS: consensus_height height of header to query FLAGS: - -h, --height HEIGHT the chain height context for the query + -H, --height HEIGHT the chain height context for the query ``` __Example__ diff --git a/guide/src/commands/queries/connection.md b/guide/src/commands/queries/connection.md index 8529218eb0..2f2c4ad61f 100644 --- a/guide/src/commands/queries/connection.md +++ b/guide/src/commands/queries/connection.md @@ -68,7 +68,7 @@ POSITIONAL ARGUMENTS: connection_id identifier of the connection to query FLAGS: - -h, --height HEIGHT height of the state to query + -H, --height HEIGHT height of the state to query ``` __Example__ diff --git a/guide/src/commands/queries/packet.md b/guide/src/commands/queries/packet.md index 62ad310a59..6d76ade405 100644 --- a/guide/src/commands/queries/packet.md +++ b/guide/src/commands/queries/packet.md @@ -82,7 +82,7 @@ POSITIONAL ARGUMENTS: sequence sequence of packet to query FLAGS: - -h, --height HEIGHT height of the state to query + -H, --height HEIGHT height of the state to query ``` __Example__ @@ -154,7 +154,7 @@ POSITIONAL ARGUMENTS: sequence sequence of packet to query FLAGS: - -h, --height HEIGHT height of the state to query + -H, --height HEIGHT height of the state to query ``` __Example__ diff --git a/guide/src/commands/raw/client.md b/guide/src/commands/raw/client.md index 4be3bc69f5..b0041246ef 100644 --- a/guide/src/commands/raw/client.md +++ b/guide/src/commands/raw/client.md @@ -63,7 +63,7 @@ POSITIONAL ARGUMENTS: dst_client_id identifier of the client to be updated on destination chain FLAGS: - -h, --target-height TARGET-HEIGHT + -H, --target-height TARGET-HEIGHT -t, --trusted-height TRUSTED-HEIGHT ``` diff --git a/relayer-cli/src/commands/query/channel.rs b/relayer-cli/src/commands/query/channel.rs index b488b2b139..a2e4631cd3 100644 --- a/relayer-cli/src/commands/query/channel.rs +++ b/relayer-cli/src/commands/query/channel.rs @@ -24,8 +24,7 @@ pub struct QueryChannelEndCmd { #[clap(required = true, about = "identifier of the channel to query")] channel_id: ChannelId, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "height of the state to query")] + #[clap(short = 'H', long, about = "height of the state to query")] height: Option, } diff --git a/relayer-cli/src/commands/query/channel_ends.rs b/relayer-cli/src/commands/query/channel_ends.rs index b4d1fd7538..bcba66184b 100644 --- a/relayer-cli/src/commands/query/channel_ends.rs +++ b/relayer-cli/src/commands/query/channel_ends.rs @@ -27,7 +27,7 @@ pub struct QueryChannelEndsCmd { channel_id: ChannelId, // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "height of the state to query")] + #[clap(short = 'H', long, about = "height of the state to query")] height: Option, #[clap( diff --git a/relayer-cli/src/commands/query/client.rs b/relayer-cli/src/commands/query/client.rs index 8bff0e6473..a3ae2f781e 100644 --- a/relayer-cli/src/commands/query/client.rs +++ b/relayer-cli/src/commands/query/client.rs @@ -30,8 +30,7 @@ pub struct QueryClientStateCmd { #[clap(required = true, about = "identifier of the client to query")] client_id: ClientId, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "the chain height context for the query")] + #[clap(short = 'H', long, about = "the chain height context for the query")] height: Option, } @@ -84,7 +83,7 @@ pub struct QueryClientConsensusCmd { heights_only: bool, #[clap( - short = 'h', + short = 'H', long, about = "the chain height context to be used, applicable only to a specific height" )] @@ -172,8 +171,7 @@ pub struct QueryClientHeaderCmd { #[clap(required = true, about = "height of header to query")] consensus_height: u64, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "the chain height context for the query")] + #[clap(short = 'H', long, about = "the chain height context for the query")] height: Option, } @@ -239,7 +237,7 @@ pub struct QueryClientConnectionsCmd { client_id: ClientId, #[clap( - short = 'h', + short = 'H', long, about = "the chain height which this query should reflect" )] diff --git a/relayer-cli/src/commands/query/connection.rs b/relayer-cli/src/commands/query/connection.rs index 2ff5552f0a..eb7d768124 100644 --- a/relayer-cli/src/commands/query/connection.rs +++ b/relayer-cli/src/commands/query/connection.rs @@ -25,8 +25,7 @@ pub struct QueryConnectionEndCmd { #[clap(required = true, about = "identifier of the connection to query")] connection_id: ConnectionId, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "height of the state to query")] + #[clap(short = 'H', long, about = "height of the state to query")] height: Option, } diff --git a/relayer-cli/src/commands/query/packet/ack.rs b/relayer-cli/src/commands/query/packet/ack.rs index 7d21fb6644..269e357705 100644 --- a/relayer-cli/src/commands/query/packet/ack.rs +++ b/relayer-cli/src/commands/query/packet/ack.rs @@ -27,8 +27,7 @@ pub struct QueryPacketAcknowledgmentCmd { #[clap(required = true, about = "sequence of packet to query")] sequence: Sequence, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "height of the state to query")] + #[clap(short = 'H', long, about = "height of the state to query")] height: Option, } diff --git a/relayer-cli/src/commands/query/packet/commitment.rs b/relayer-cli/src/commands/query/packet/commitment.rs index 0a205f3599..6534d0ebb8 100644 --- a/relayer-cli/src/commands/query/packet/commitment.rs +++ b/relayer-cli/src/commands/query/packet/commitment.rs @@ -34,8 +34,7 @@ pub struct QueryPacketCommitmentCmd { #[clap(required = true, about = "sequence of packet to query")] sequence: Sequence, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "height of the state to query")] + #[clap(short = 'H', long, about = "height of the state to query")] height: Option, } diff --git a/relayer-cli/src/commands/tx/client.rs b/relayer-cli/src/commands/tx/client.rs index d682ed92ab..dbaf8329ba 100644 --- a/relayer-cli/src/commands/tx/client.rs +++ b/relayer-cli/src/commands/tx/client.rs @@ -66,8 +66,7 @@ pub struct TxUpdateClientCmd { )] dst_client_id: ClientId, - // FIXME: rename the short option to avoid confusion with --help? - #[clap(short = 'h', long, about = "the target height of the client update")] + #[clap(short = 'H', long, about = "the target height of the client update")] target_height: Option, #[clap(short = 't', long, about = "the trusted height of the client update")] From 2bf80a40245c70b1cf1605b80a06bdbdcbdfe559 Mon Sep 17 00:00:00 2001 From: Shoaib Ahmed Date: Thu, 23 Dec 2021 21:47:45 +0530 Subject: [PATCH 06/13] Update ibc-proto doc(html_root_url) --- proto/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proto/src/lib.rs b/proto/src/lib.rs index 0baed4e934..7bb1d4a61b 100644 --- a/proto/src/lib.rs +++ b/proto/src/lib.rs @@ -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; From f8a3a1e5b47c326a88928bc2d41f97d2df7d7f0b Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Tue, 4 Jan 2022 15:16:46 +0100 Subject: [PATCH 07/13] Remove outdated comment --- relayer-cli/src/commands/query/channel_ends.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/relayer-cli/src/commands/query/channel_ends.rs b/relayer-cli/src/commands/query/channel_ends.rs index bcba66184b..267c241344 100644 --- a/relayer-cli/src/commands/query/channel_ends.rs +++ b/relayer-cli/src/commands/query/channel_ends.rs @@ -26,7 +26,6 @@ pub struct QueryChannelEndsCmd { #[clap(required = true, about = "identifier of the channel to query")] channel_id: ChannelId, - // FIXME: rename the short option to avoid confusion with --help? #[clap(short = 'H', long, about = "height of the state to query")] height: Option, From 0c4efb8e5118b7c211f8973cb7e305e5d7f10070 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Tue, 4 Jan 2022 15:17:18 +0100 Subject: [PATCH 08/13] Fix broken link in changelog --- .changelog/unreleased/bug-fixes/1264-recover-acct-seq.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.changelog/unreleased/bug-fixes/1264-recover-acct-seq.md b/.changelog/unreleased/bug-fixes/1264-recover-acct-seq.md index 850ce5b86e..6a7bf3d093 100644 --- a/.changelog/unreleased/bug-fixes/1264-recover-acct-seq.md +++ b/.changelog/unreleased/bug-fixes/1264-recover-acct-seq.md @@ -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)) \ No newline at end of file + sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-rs/issues/1264)) From 8edbf602df57e538fd44d4551bfa4f3bff82d9a6 Mon Sep 17 00:00:00 2001 From: Mikhail Zabaluev Date: Fri, 7 Jan 2022 12:37:15 +0200 Subject: [PATCH 09/13] Rename application-handled -h CLI flags to -H (#1743) * Disambiguate between help and height flags by using `-H` for the latter * Enable clap-provided help flags on all subcommands Since all application-assigned short -h options have been renamed to -H, there is no need to suppress the -h flags provided by clap with the DisableHelpFlag setting. * Update changelog for #1743 * Remove a FIXME comment Resolved by e59bb13f9a0a5d2793517585ba4403b15bbd05ec Co-authored-by: Romain Ruetschi --- .../improvements/ibc-relayer/1576-update-abscissa.md | 3 ++- relayer-cli/src/commands/query/channel.rs | 2 -- relayer-cli/src/commands/query/channel_ends.rs | 2 -- relayer-cli/src/commands/query/client.rs | 3 --- relayer-cli/src/commands/query/connection.rs | 2 -- relayer-cli/src/commands/query/packet/ack.rs | 2 -- relayer-cli/src/commands/query/packet/commitment.rs | 2 -- relayer-cli/src/commands/tx/client.rs | 2 -- 8 files changed, 2 insertions(+), 16 deletions(-) diff --git a/.changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md b/.changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md index a4b5cc0ee5..31d107373e 100644 --- a/.changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md +++ b/.changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md @@ -2,4 +2,5 @@ `--help` flags in subcommands and improving help and usage printouts. The `--version` option of the `create channel` subcommand has been renamed to `--channel-version`, with the old name still supported as an alias. - ([#1576](https://github.com/informalsystems/ibc-rs/pull/1576)) + ([#1576](https://github.com/informalsystems/ibc-rs/pull/1576), + [#1743](https://github.com/informalsystems/ibc-rs/pull/1743)) diff --git a/relayer-cli/src/commands/query/channel.rs b/relayer-cli/src/commands/query/channel.rs index a2e4631cd3..7be6a3753b 100644 --- a/relayer-cli/src/commands/query/channel.rs +++ b/relayer-cli/src/commands/query/channel.rs @@ -1,7 +1,6 @@ use alloc::sync::Arc; use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use tokio::runtime::Runtime as TokioRuntime; use ibc::core::ics24_host::identifier::ChainId; @@ -13,7 +12,6 @@ use crate::prelude::*; use ibc::core::ics04_channel::channel::State; #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryChannelEndCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/query/channel_ends.rs b/relayer-cli/src/commands/query/channel_ends.rs index 267c241344..09f5d246a7 100644 --- a/relayer-cli/src/commands/query/channel_ends.rs +++ b/relayer-cli/src/commands/query/channel_ends.rs @@ -1,5 +1,4 @@ use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use serde::{Deserialize, Serialize}; use ibc::core::ics02_client::client_state::{AnyClientState, ClientState}; @@ -15,7 +14,6 @@ use crate::conclude::Output; use crate::prelude::*; #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryChannelEndsCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/query/client.rs b/relayer-cli/src/commands/query/client.rs index a3ae2f781e..2444a16543 100644 --- a/relayer-cli/src/commands/query/client.rs +++ b/relayer-cli/src/commands/query/client.rs @@ -1,7 +1,6 @@ use alloc::sync::Arc; use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use tokio::runtime::Runtime as TokioRuntime; use tracing::debug; @@ -22,7 +21,6 @@ use crate::conclude::{exit_with_unrecoverable_error, Output}; /// Query client state command #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryClientStateCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, @@ -160,7 +158,6 @@ impl Runnable for QueryClientConsensusCmd { } #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryClientHeaderCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/query/connection.rs b/relayer-cli/src/commands/query/connection.rs index eb7d768124..fd727af6c3 100644 --- a/relayer-cli/src/commands/query/connection.rs +++ b/relayer-cli/src/commands/query/connection.rs @@ -1,7 +1,6 @@ use alloc::sync::Arc; use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use tokio::runtime::Runtime as TokioRuntime; use ibc::core::{ @@ -17,7 +16,6 @@ use crate::error::Error; use crate::prelude::*; #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryConnectionEndCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/query/packet/ack.rs b/relayer-cli/src/commands/query/packet/ack.rs index 269e357705..297a9fd7cb 100644 --- a/relayer-cli/src/commands/query/packet/ack.rs +++ b/relayer-cli/src/commands/query/packet/ack.rs @@ -1,5 +1,4 @@ use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use subtle_encoding::{Encoding, Hex}; use ibc::core::ics04_channel::packet::{PacketMsgType, Sequence}; @@ -13,7 +12,6 @@ use crate::error::Error; use crate::prelude::*; #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryPacketAcknowledgmentCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/query/packet/commitment.rs b/relayer-cli/src/commands/query/packet/commitment.rs index 6534d0ebb8..7bcc0c4bd2 100644 --- a/relayer-cli/src/commands/query/packet/commitment.rs +++ b/relayer-cli/src/commands/query/packet/commitment.rs @@ -1,5 +1,4 @@ use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use serde::Serialize; use subtle_encoding::{Encoding, Hex}; @@ -20,7 +19,6 @@ struct PacketSeqs { } #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct QueryPacketCommitmentCmd { #[clap(required = true, about = "identifier of the chain to query")] chain_id: ChainId, diff --git a/relayer-cli/src/commands/tx/client.rs b/relayer-cli/src/commands/tx/client.rs index dbaf8329ba..47d94c0ce8 100644 --- a/relayer-cli/src/commands/tx/client.rs +++ b/relayer-cli/src/commands/tx/client.rs @@ -1,7 +1,6 @@ use core::fmt; use abscissa_core::{Clap, Command, Runnable}; -use clap::AppSettings::DisableHelpFlag; use ibc::core::ics02_client::client_state::ClientState; use ibc::core::ics24_host::identifier::{ChainId, ClientId}; @@ -55,7 +54,6 @@ impl Runnable for TxCreateClientCmd { } #[derive(Clone, Command, Debug, Clap)] -#[clap(setting(DisableHelpFlag))] pub struct TxUpdateClientCmd { #[clap(required = true, about = "identifier of the destination chain")] dst_chain_id: ChainId, From 5bf5de0fbdbc8960efe8bc796bb6d7736ca3c2a9 Mon Sep 17 00:00:00 2001 From: Mikhail Zabaluev Date: Mon, 10 Jan 2022 14:05:28 +0200 Subject: [PATCH 10/13] guide: Removed wording about missing -h/--help The -h flags have been freed for built-in clap use and are supported on all subcommands. --- guide/src/help.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/guide/src/help.md b/guide/src/help.md index a6992e4dd3..a228816b8b 100644 --- a/guide/src/help.md +++ b/guide/src/help.md @@ -78,9 +78,7 @@ FLAGS: ``` Additionally, the `-h`/`--help` flags typical for CLI applications work on -most commands (with the exception of some commands currently using `-h` for -other purposes; these should be changed to follow the convention in a -future version). +all commands. ## Parametrizing the log output level From a007129864ad8b4e46e3b6174ee0b54ad3fc0776 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Wed, 12 Jan 2022 16:23:49 +0100 Subject: [PATCH 11/13] Fix link to packet filtering policy in config page --- guide/src/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/config.md b/guide/src/config.md index cf88d9d52e..2f1c4b3e70 100644 --- a/guide/src/config.md +++ b/guide/src/config.md @@ -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.10.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#L207-L224). ## Adding private keys From e546b1e71470c3e065022860aa264f92c46cb367 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Wed, 12 Jan 2022 16:38:28 +0100 Subject: [PATCH 12/13] Release changelog for 0.10.0 --- .../breaking-changes/1660-msrv-1.57.md | 0 .../1665-tendermint-0.23.2.md | 0 .../ibc-relayer/1656-supervisor-spawn.md | 0 .../ibc/1618-get-frozen-height.md | 0 .../ibc/1665-remove-chrono.md | 0 .../bug-fixes/1264-recover-acct-seq.md | 0 .../1634-update-unclog-instructions.md | 0 .../ibc-relayer/1664-handle-expired-client.md | 0 .../1715-execute-schedule-after-packet-cmd.md | 0 .../ibc-relayer/1750-misbehavior-config.md | 0 ...-delete-commitment-in-acknowledgePacket.md | 0 .../ibc/1649-fix-chan-open-ack-verify.md | 0 .../ibc/1697-assert-non-zero-trust-level.md | 0 .../ibc/1710-fix-frozen-height-proto-conv.md | 0 .../features}/1410-dynamic-version.md | 0 .../features/1550-ci-gaiav6.md | 0 .../{unreleased => v0.10.0}/features/1606.md | 0 .../features/1633-allow-fee-granters.md | 0 .../ibc-relayer/1561-config-proof-specs.md | 0 .../ibc/1583-module-verification-ICS07.md | 0 .../1063-event-monitor-on-demand.md | 0 .../improvements/ibc-relayer-cli/1636.md | 0 .../ibc-relayer/1576-update-abscissa.md | 0 .../improvements/ibc/1665-remove-chrono.md | 0 .changelog/v0.10.0/summary.md | 1 + CHANGELOG.md | 81 +++++++++++++++++++ 26 files changed, 82 insertions(+) rename .changelog/{unreleased => v0.10.0}/breaking-changes/1660-msrv-1.57.md (100%) rename .changelog/{unreleased => v0.10.0}/breaking-changes/1665-tendermint-0.23.2.md (100%) rename .changelog/{unreleased => v0.10.0}/breaking-changes/ibc-relayer/1656-supervisor-spawn.md (100%) rename .changelog/{unreleased => v0.10.0}/breaking-changes/ibc/1618-get-frozen-height.md (100%) rename .changelog/{unreleased => v0.10.0}/breaking-changes/ibc/1665-remove-chrono.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/1264-recover-acct-seq.md (100%) rename .changelog/{unreleased/bug => v0.10.0/bug-fixes}/1634-update-unclog-instructions.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc-relayer/1664-handle-expired-client.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc-relayer/1715-execute-schedule-after-packet-cmd.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc-relayer/1750-misbehavior-config.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc/1573-delete-commitment-in-acknowledgePacket.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc/1649-fix-chan-open-ack-verify.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc/1697-assert-non-zero-trust-level.md (100%) rename .changelog/{unreleased => v0.10.0}/bug-fixes/ibc/1710-fix-frozen-height-proto-conv.md (100%) rename .changelog/{unreleased/feature => v0.10.0/features}/1410-dynamic-version.md (100%) rename .changelog/{unreleased => v0.10.0}/features/1550-ci-gaiav6.md (100%) rename .changelog/{unreleased => v0.10.0}/features/1606.md (100%) rename .changelog/{unreleased => v0.10.0}/features/1633-allow-fee-granters.md (100%) rename .changelog/{unreleased => v0.10.0}/features/ibc-relayer/1561-config-proof-specs.md (100%) rename .changelog/{unreleased => v0.10.0}/features/ibc/1583-module-verification-ICS07.md (100%) rename .changelog/{unreleased => v0.10.0}/improvements/ibc-relayer-cli/1063-event-monitor-on-demand.md (100%) rename .changelog/{unreleased => v0.10.0}/improvements/ibc-relayer-cli/1636.md (100%) rename .changelog/{unreleased => v0.10.0}/improvements/ibc-relayer/1576-update-abscissa.md (100%) rename .changelog/{unreleased => v0.10.0}/improvements/ibc/1665-remove-chrono.md (100%) create mode 100644 .changelog/v0.10.0/summary.md diff --git a/.changelog/unreleased/breaking-changes/1660-msrv-1.57.md b/.changelog/v0.10.0/breaking-changes/1660-msrv-1.57.md similarity index 100% rename from .changelog/unreleased/breaking-changes/1660-msrv-1.57.md rename to .changelog/v0.10.0/breaking-changes/1660-msrv-1.57.md diff --git a/.changelog/unreleased/breaking-changes/1665-tendermint-0.23.2.md b/.changelog/v0.10.0/breaking-changes/1665-tendermint-0.23.2.md similarity index 100% rename from .changelog/unreleased/breaking-changes/1665-tendermint-0.23.2.md rename to .changelog/v0.10.0/breaking-changes/1665-tendermint-0.23.2.md diff --git a/.changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md b/.changelog/v0.10.0/breaking-changes/ibc-relayer/1656-supervisor-spawn.md similarity index 100% rename from .changelog/unreleased/breaking-changes/ibc-relayer/1656-supervisor-spawn.md rename to .changelog/v0.10.0/breaking-changes/ibc-relayer/1656-supervisor-spawn.md diff --git a/.changelog/unreleased/breaking-changes/ibc/1618-get-frozen-height.md b/.changelog/v0.10.0/breaking-changes/ibc/1618-get-frozen-height.md similarity index 100% rename from .changelog/unreleased/breaking-changes/ibc/1618-get-frozen-height.md rename to .changelog/v0.10.0/breaking-changes/ibc/1618-get-frozen-height.md diff --git a/.changelog/unreleased/breaking-changes/ibc/1665-remove-chrono.md b/.changelog/v0.10.0/breaking-changes/ibc/1665-remove-chrono.md similarity index 100% rename from .changelog/unreleased/breaking-changes/ibc/1665-remove-chrono.md rename to .changelog/v0.10.0/breaking-changes/ibc/1665-remove-chrono.md diff --git a/.changelog/unreleased/bug-fixes/1264-recover-acct-seq.md b/.changelog/v0.10.0/bug-fixes/1264-recover-acct-seq.md similarity index 100% rename from .changelog/unreleased/bug-fixes/1264-recover-acct-seq.md rename to .changelog/v0.10.0/bug-fixes/1264-recover-acct-seq.md diff --git a/.changelog/unreleased/bug/1634-update-unclog-instructions.md b/.changelog/v0.10.0/bug-fixes/1634-update-unclog-instructions.md similarity index 100% rename from .changelog/unreleased/bug/1634-update-unclog-instructions.md rename to .changelog/v0.10.0/bug-fixes/1634-update-unclog-instructions.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer/1664-handle-expired-client.md b/.changelog/v0.10.0/bug-fixes/ibc-relayer/1664-handle-expired-client.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer/1664-handle-expired-client.md rename to .changelog/v0.10.0/bug-fixes/ibc-relayer/1664-handle-expired-client.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer/1715-execute-schedule-after-packet-cmd.md b/.changelog/v0.10.0/bug-fixes/ibc-relayer/1715-execute-schedule-after-packet-cmd.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer/1715-execute-schedule-after-packet-cmd.md rename to .changelog/v0.10.0/bug-fixes/ibc-relayer/1715-execute-schedule-after-packet-cmd.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer/1750-misbehavior-config.md b/.changelog/v0.10.0/bug-fixes/ibc-relayer/1750-misbehavior-config.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer/1750-misbehavior-config.md rename to .changelog/v0.10.0/bug-fixes/ibc-relayer/1750-misbehavior-config.md diff --git a/.changelog/unreleased/bug-fixes/ibc/1573-delete-commitment-in-acknowledgePacket.md b/.changelog/v0.10.0/bug-fixes/ibc/1573-delete-commitment-in-acknowledgePacket.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/1573-delete-commitment-in-acknowledgePacket.md rename to .changelog/v0.10.0/bug-fixes/ibc/1573-delete-commitment-in-acknowledgePacket.md diff --git a/.changelog/unreleased/bug-fixes/ibc/1649-fix-chan-open-ack-verify.md b/.changelog/v0.10.0/bug-fixes/ibc/1649-fix-chan-open-ack-verify.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/1649-fix-chan-open-ack-verify.md rename to .changelog/v0.10.0/bug-fixes/ibc/1649-fix-chan-open-ack-verify.md diff --git a/.changelog/unreleased/bug-fixes/ibc/1697-assert-non-zero-trust-level.md b/.changelog/v0.10.0/bug-fixes/ibc/1697-assert-non-zero-trust-level.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/1697-assert-non-zero-trust-level.md rename to .changelog/v0.10.0/bug-fixes/ibc/1697-assert-non-zero-trust-level.md diff --git a/.changelog/unreleased/bug-fixes/ibc/1710-fix-frozen-height-proto-conv.md b/.changelog/v0.10.0/bug-fixes/ibc/1710-fix-frozen-height-proto-conv.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/1710-fix-frozen-height-proto-conv.md rename to .changelog/v0.10.0/bug-fixes/ibc/1710-fix-frozen-height-proto-conv.md diff --git a/.changelog/unreleased/feature/1410-dynamic-version.md b/.changelog/v0.10.0/features/1410-dynamic-version.md similarity index 100% rename from .changelog/unreleased/feature/1410-dynamic-version.md rename to .changelog/v0.10.0/features/1410-dynamic-version.md diff --git a/.changelog/unreleased/features/1550-ci-gaiav6.md b/.changelog/v0.10.0/features/1550-ci-gaiav6.md similarity index 100% rename from .changelog/unreleased/features/1550-ci-gaiav6.md rename to .changelog/v0.10.0/features/1550-ci-gaiav6.md diff --git a/.changelog/unreleased/features/1606.md b/.changelog/v0.10.0/features/1606.md similarity index 100% rename from .changelog/unreleased/features/1606.md rename to .changelog/v0.10.0/features/1606.md diff --git a/.changelog/unreleased/features/1633-allow-fee-granters.md b/.changelog/v0.10.0/features/1633-allow-fee-granters.md similarity index 100% rename from .changelog/unreleased/features/1633-allow-fee-granters.md rename to .changelog/v0.10.0/features/1633-allow-fee-granters.md diff --git a/.changelog/unreleased/features/ibc-relayer/1561-config-proof-specs.md b/.changelog/v0.10.0/features/ibc-relayer/1561-config-proof-specs.md similarity index 100% rename from .changelog/unreleased/features/ibc-relayer/1561-config-proof-specs.md rename to .changelog/v0.10.0/features/ibc-relayer/1561-config-proof-specs.md diff --git a/.changelog/unreleased/features/ibc/1583-module-verification-ICS07.md b/.changelog/v0.10.0/features/ibc/1583-module-verification-ICS07.md similarity index 100% rename from .changelog/unreleased/features/ibc/1583-module-verification-ICS07.md rename to .changelog/v0.10.0/features/ibc/1583-module-verification-ICS07.md diff --git a/.changelog/unreleased/improvements/ibc-relayer-cli/1063-event-monitor-on-demand.md b/.changelog/v0.10.0/improvements/ibc-relayer-cli/1063-event-monitor-on-demand.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer-cli/1063-event-monitor-on-demand.md rename to .changelog/v0.10.0/improvements/ibc-relayer-cli/1063-event-monitor-on-demand.md diff --git a/.changelog/unreleased/improvements/ibc-relayer-cli/1636.md b/.changelog/v0.10.0/improvements/ibc-relayer-cli/1636.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer-cli/1636.md rename to .changelog/v0.10.0/improvements/ibc-relayer-cli/1636.md diff --git a/.changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md b/.changelog/v0.10.0/improvements/ibc-relayer/1576-update-abscissa.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer/1576-update-abscissa.md rename to .changelog/v0.10.0/improvements/ibc-relayer/1576-update-abscissa.md diff --git a/.changelog/unreleased/improvements/ibc/1665-remove-chrono.md b/.changelog/v0.10.0/improvements/ibc/1665-remove-chrono.md similarity index 100% rename from .changelog/unreleased/improvements/ibc/1665-remove-chrono.md rename to .changelog/v0.10.0/improvements/ibc/1665-remove-chrono.md diff --git a/.changelog/v0.10.0/summary.md b/.changelog/v0.10.0/summary.md new file mode 100644 index 0000000000..739ac3c9d8 --- /dev/null +++ b/.changelog/v0.10.0/summary.md @@ -0,0 +1 @@ +ibc-rs v0.10.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 442066b7c7..126da80f60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,86 @@ # CHANGELOG +## v0.10.0 +*January 13th, 2021* + +### BREAKING CHANGES + +- General + - Update MSRV to Rust 1.57 + ([#1660](https://github.com/informalsystems/ibc-rs/issues/1660)) + - Pin tendermint-rs dependencies to =0.23.2 + ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)) + - Update `CONTRIBUTING.md` for latest version of unclog + ([#1634](https://github.com/informalsystems/ibc-rs/issues/1634)) +- [IBC Modules](modules) + - Add the `frozen_height()` method to the `ClientState` trait. (Includes breaking changes to the Tendermint + `ClientState` API.) + ([#1618](https://github.com/informalsystems/ibc-rs/issues/1618)) + - Remove `Timestamp` API that depended on the `chrono` crate: + ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)): + - `Timestamp::from_datetime`; use `From` + - `Timestamp::as_datetime`, superseded by `Timestamp::into_datetime` +- [Relayer Library](relayer) + - 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. + +### BUG FIXES + +- General + - Added a recovery mechanism to automatically retry or drop tx upon account + sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-rs/issues/1264)) +- [IBC Modules](modules) + - Delete packet commitment instead of acknowledgement in acknowledgePacket + [#1573](https://github.com/informalsystems/ibc-rs/issues/1573) + - Set the `counterparty_channel_id` correctly to fix ICS04 [`chanOpenAck` handler verification](https://github.com/informalsystems/ibc-rs/blob/master/modules/src/core/ics04_channel/handler/chan_open_ack.rs) + ([#1649](https://github.com/informalsystems/ibc-rs/issues/1649)) + - Add missing assertion for non-zero trust-level in Tendermint client initialization. + ([#1697](https://github.com/informalsystems/ibc-rs/issues/1697)) + - Fix conversion to Protocol Buffers of `ClientState`'s `frozen_height` field. + ([#1710](https://github.com/informalsystems/ibc-rs/issues/1710)) +- [Relayer Library](relayer) + - Handle expired client errors in workers ([#1543](https://github.com/informalsystems/ibc-rs/issues/1543)) + - Perform `execute_schedule` after handling packet commands in packet worker ([#1715](https://github.com/informalsystems/ibc-rs/issues/1715)) + - Do not spawn detect misbehavior task if it is disabled in config [#1750](https://github.com/informalsystems/ibc-rs/issues/1750) + +### FEATURES + +- General + - Extend CI test suite to include E2E tests using Gaia v6.0.0 [#1550](https://github.com/informalsystems/ibc-rs/issues/1550) + - Added the `extra_wallets` parameter to `gm` to create additional funded wallets. + - Added the possibility of JSON output to `gm` by setting the environment variable `OUTPUT=json`. + - Added support for fee granters through config file + ([#1633](https://github.com/informalsystems/ibc-rs/issues/1633)) +- [IBC Modules](modules) + - Implement proof verification for Tendermint client (ICS07). + ([#1583](https://github.com/informalsystems/ibc-rs/pull/1583)) +- [Relayer Library](relayer) + - Support dynamic versions in channel open handshake & enable full support for + ibc-go v2 ([#1410](https://github.com/informalsystems/ibc-rs/issues/1410)) + - Allow custom proof-specs in chain config + ([#1561](https://github.com/informalsystems/ibc-rs/issues/1561)) + +### IMPROVEMENTS + +- [IBC Modules](modules) + - More conventional ad-hoc conversion methods on `Timestamp` + ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)): + - `Timestamp::nanoseconds` replaces `Timestamp::as_nanoseconds` + - `Timestamp::into_datetime` substitutes `Timestamp::as_datetime` +- [Relayer Library](relayer) + - Update to abscissa framework version 0.6.0-beta.1, adding support for + `--help` flags in subcommands and improving help and usage printouts. + The `--version` option of the `create channel` subcommand has been renamed + to `--channel-version`, with the old name still supported as an alias. + ([#1576](https://github.com/informalsystems/ibc-rs/pull/1576), + [#1743](https://github.com/informalsystems/ibc-rs/pull/1743)) +- [Relayer CLI](relayer-cli) + - Improve performance of standalone commands by starting the event monitor on-demand + ([#1063](https://github.com/informalsystems/ibc-rs/issues/1063)) + - Increase the default for `max_gas` from `300_000` to `400_000` + ([#1636](https://github.com/informalsystems/ibc-rs/pull/1636)) + ## v0.9.0, the “Zamfir” release *November 23rd, 2021* From fff14beec77e75af1bc281f873ac71481d63c871 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Thu, 13 Jan 2022 09:51:42 +0100 Subject: [PATCH 13/13] Update changelog summary --- .changelog/v0.10.0/summary.md | 17 ++++++++++- CHANGELOG.md | 53 ++++++++++++++++++++++------------- 2 files changed, 50 insertions(+), 20 deletions(-) diff --git a/.changelog/v0.10.0/summary.md b/.changelog/v0.10.0/summary.md index 739ac3c9d8..7d8ccc26c6 100644 --- a/.changelog/v0.10.0/summary.md +++ b/.changelog/v0.10.0/summary.md @@ -1 +1,16 @@ -ibc-rs v0.10.0 +*January 13th, 2021* + +This release notably updates the underlying CLI framework (`abscissa`) to version 0.6.0-beta.1, +which now uses `clap` for parsing command line arguments. This substantially improves the UX of the CLI, +by adding support for `--help` flags in subcommands and improving help and usage printouts. + +The `--version` option of the `create channel` subcommand has been renamed +to `--channel-version`, with the old name still supported as an alias. +Additionally, the `-h` short flag on many commands is now `-H` to avoid +clashes with the clap-provided short flag for help. + +This release also improves the handling of account sequence mismatch errors, +with a recovery mechanism to automatically retry or drop tx upon such errors. + +The relayer now also supports dynamic versions in channel open handshake (which is needed by Interchain Accounts), and enables full support for IBC v2. + diff --git a/CHANGELOG.md b/CHANGELOG.md index 126da80f60..fcdfe699c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,20 @@ ## v0.10.0 *January 13th, 2021* +This release notably updates the underlying CLI framework (`abscissa`) to version 0.6.0-beta.1, +which now uses `clap` for parsing command line arguments. This substantially improves the UX of the CLI, +by adding support for `--help` flags in subcommands and improving help and usage printouts. + +The `--version` option of the `create channel` subcommand has been renamed +to `--channel-version`, with the old name still supported as an alias. +Additionally, the `-h` short flag on many commands is now `-H` to avoid +clashes with the clap-provided short flag for help. + +This release also improves the handling of account sequence mismatch errors, +with a recovery mechanism to automatically retry or drop tx upon such errors. + +The relayer now also supports dynamic versions in channel open handshake (which is needed by Interchain Accounts), and enables full support for IBC v2. + ### BREAKING CHANGES - General @@ -10,26 +24,29 @@ ([#1660](https://github.com/informalsystems/ibc-rs/issues/1660)) - Pin tendermint-rs dependencies to =0.23.2 ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)) - - Update `CONTRIBUTING.md` for latest version of unclog - ([#1634](https://github.com/informalsystems/ibc-rs/issues/1634)) - [IBC Modules](modules) - - Add the `frozen_height()` method to the `ClientState` trait. (Includes breaking changes to the Tendermint - `ClientState` API.) + - Add the `frozen_height()` method to the `ClientState` trait (includes breaking changes to the Tendermint `ClientState` API). ([#1618](https://github.com/informalsystems/ibc-rs/issues/1618)) - Remove `Timestamp` API that depended on the `chrono` crate: ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)): - - `Timestamp::from_datetime`; use `From` - - `Timestamp::as_datetime`, superseded by `Timestamp::into_datetime` + - `Timestamp::from_datetime`; use `From` + - `Timestamp::as_datetime`, superseded by `Timestamp::into_datetime` - [Relayer Library](relayer) - - 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. + - 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. +- [Relayer CLI](relayer-cli) + - Update to abscissa framework version 0.6.0-beta.1, adding support for + `--help` flags in subcommands and improving help and usage printouts. + The `--version` option of the `create channel` subcommand has been renamed + to `--channel-version`, with the old name still supported as an alias. + Additionally, the `-h` short flag on many commands is now `-H` to avoid + clashes with the clap-provided short flag for help. + ([#1576](https://github.com/informalsystems/ibc-rs/pull/1576), + [#1743](https://github.com/informalsystems/ibc-rs/pull/1743)) ### BUG FIXES -- General - - Added a recovery mechanism to automatically retry or drop tx upon account - sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-rs/issues/1264)) - [IBC Modules](modules) - Delete packet commitment instead of acknowledgement in acknowledgePacket [#1573](https://github.com/informalsystems/ibc-rs/issues/1573) @@ -56,6 +73,8 @@ - Implement proof verification for Tendermint client (ICS07). ([#1583](https://github.com/informalsystems/ibc-rs/pull/1583)) - [Relayer Library](relayer) + - Added a recovery mechanism to automatically retry or drop tx upon account + sequence mismatch errors ([#1264](https://github.com/informalsystems/ibc-rs/issues/1264)) - Support dynamic versions in channel open handshake & enable full support for ibc-go v2 ([#1410](https://github.com/informalsystems/ibc-rs/issues/1410)) - Allow custom proof-specs in chain config @@ -63,18 +82,14 @@ ### IMPROVEMENTS +- General + - Update `CONTRIBUTING.md` for latest version of unclog + ([#1634](https://github.com/informalsystems/ibc-rs/issues/1634)) - [IBC Modules](modules) - More conventional ad-hoc conversion methods on `Timestamp` ([#1665](https://github.com/informalsystems/ibc-rs/pull/1665)): - `Timestamp::nanoseconds` replaces `Timestamp::as_nanoseconds` - `Timestamp::into_datetime` substitutes `Timestamp::as_datetime` -- [Relayer Library](relayer) - - Update to abscissa framework version 0.6.0-beta.1, adding support for - `--help` flags in subcommands and improving help and usage printouts. - The `--version` option of the `create channel` subcommand has been renamed - to `--channel-version`, with the old name still supported as an alias. - ([#1576](https://github.com/informalsystems/ibc-rs/pull/1576), - [#1743](https://github.com/informalsystems/ibc-rs/pull/1743)) - [Relayer CLI](relayer-cli) - Improve performance of standalone commands by starting the event monitor on-demand ([#1063](https://github.com/informalsystems/ibc-rs/issues/1063))