From 54ae389e8595e0360005ba99a9f5446490069cd0 Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Wed, 27 Jul 2022 17:55:45 +0200 Subject: [PATCH] Release Hermes v1.0.0-RC1 (#2465) * Bump Hermes to v1.0.0-rc.1 * Bump crates to 0.17.0 and ibc-proto to 0.19.1 * Add changelog entry for #2444 * Release changelog for Hermes v1.0.0-rc.1 * Update changelog * Update upgrading instructions * Move a changelog entry to the proper section * Update changelog after rebase * Highlight breaking change in Hermes config --- .../2376-refactor-tx-raw-commands.md | 0 .../ibc-relayer-cli/2410-tx-cli-flags.md | 0 .../1132-fixed-query-channels-filter.md | 0 .../2405-fixed-ft-transfer-receiver-flag.md | 0 .../bug-fixes/ibc-relayer/2411-retry-snerr.md | 0 .../ibc-relayer/2444-abci-info-data.md | 3 + .../bug-fixes/ibc/2386-fix-ics20-ds-serde.md | 0 .../2387-fix-get_channel_escrow_address.md | 0 ...cknowledgement-packet-process-and-store.md | 0 ...te-acknowledgement-incorrect-store-type.md | 0 ...10-new-optional-flags-query-connections.md | 0 .../2311-new-optional-flag-upgrade-clients.md | 0 .../ibc-relayer-cli/2429-show-counterparty.md | 0 .../ibc-relayer-cli/2431-colored_output.md | 0 .../improvements/2455-tendermint-0.23.8.md | 0 .../guide/1935-global-options-doc.md | 0 .../2189-cleanup-dev-env-from-hermes-guide.md | 0 .../ibc-proto/2403-update-protobufs.md | 0 .../2375-keys-add-overwrite.md | 0 .../ibc-relayer-cli/2435-gas-multiplier.md | 0 ...-converted-wallet-balance-metric-to-f64.md | 0 ...8-better-metrics-naming-and-description.md | 0 .../improvements/ibc/2356-adr011.md | 0 .changelog/v1.0.0-rc.1/summary.md | 7 ++ CHANGELOG.md | 119 ++++++++++++++++++ Cargo.lock | 16 +-- UPGRADING.md | 56 ++++++++- guide/README.md | 2 +- guide/src/SUMMARY.md | 2 +- guide/src/commands/global.md | 2 +- guide/src/config.md | 4 +- guide/src/index.md | 2 +- guide/src/installation.md | 16 +-- guide/src/rest-api.md | 2 +- modules/Cargo.toml | 4 +- proto/Cargo.toml | 2 +- proto/src/lib.rs | 2 +- relayer-cli/Cargo.toml | 12 +- relayer-rest/Cargo.toml | 6 +- relayer-rest/tests/mock.rs | 2 +- relayer/Cargo.toml | 10 +- telemetry/Cargo.toml | 4 +- tools/integration-test/Cargo.toml | 2 +- tools/test-framework/Cargo.toml | 10 +- 44 files changed, 232 insertions(+), 53 deletions(-) rename .changelog/{unreleased => v1.0.0-rc.1}/breaking-changes/ibc-relayer-cli/2376-refactor-tx-raw-commands.md (100%) rename .changelog/{unreleased/improvements => v1.0.0-rc.1/breaking-changes}/ibc-relayer-cli/2410-tx-cli-flags.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc-relayer-cli/1132-fixed-query-channels-filter.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc-relayer-cli/2405-fixed-ft-transfer-receiver-flag.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc-relayer/2411-retry-snerr.md (100%) create mode 100644 .changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2444-abci-info-data.md rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc/2386-fix-ics20-ds-serde.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc/2387-fix-get_channel_escrow_address.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc/2424-add-write-acknowledgement-packet-process-and-store.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/bug-fixes/ibc/2428-fix-handle-process-write-acknowledgement-incorrect-store-type.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/features/ibc-relayer-cli/2310-new-optional-flags-query-connections.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/features/ibc-relayer-cli/2311-new-optional-flag-upgrade-clients.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/features/ibc-relayer-cli/2429-show-counterparty.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvement/ibc-relayer-cli/2431-colored_output.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/2455-tendermint-0.23.8.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/guide/1935-global-options-doc.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/guide/2189-cleanup-dev-env-from-hermes-guide.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc-proto/2403-update-protobufs.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc-relayer-cli/2375-keys-add-overwrite.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc-relayer-cli/2435-gas-multiplier.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc-telemetry/2381-converted-wallet-balance-metric-to-f64.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc-telemetry/2408-better-metrics-naming-and-description.md (100%) rename .changelog/{unreleased => v1.0.0-rc.1}/improvements/ibc/2356-adr011.md (100%) create mode 100644 .changelog/v1.0.0-rc.1/summary.md diff --git a/.changelog/unreleased/breaking-changes/ibc-relayer-cli/2376-refactor-tx-raw-commands.md b/.changelog/v1.0.0-rc.1/breaking-changes/ibc-relayer-cli/2376-refactor-tx-raw-commands.md similarity index 100% rename from .changelog/unreleased/breaking-changes/ibc-relayer-cli/2376-refactor-tx-raw-commands.md rename to .changelog/v1.0.0-rc.1/breaking-changes/ibc-relayer-cli/2376-refactor-tx-raw-commands.md diff --git a/.changelog/unreleased/improvements/ibc-relayer-cli/2410-tx-cli-flags.md b/.changelog/v1.0.0-rc.1/breaking-changes/ibc-relayer-cli/2410-tx-cli-flags.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer-cli/2410-tx-cli-flags.md rename to .changelog/v1.0.0-rc.1/breaking-changes/ibc-relayer-cli/2410-tx-cli-flags.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer-cli/1132-fixed-query-channels-filter.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer-cli/1132-fixed-query-channels-filter.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer-cli/1132-fixed-query-channels-filter.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer-cli/1132-fixed-query-channels-filter.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer-cli/2405-fixed-ft-transfer-receiver-flag.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer-cli/2405-fixed-ft-transfer-receiver-flag.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer-cli/2405-fixed-ft-transfer-receiver-flag.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer-cli/2405-fixed-ft-transfer-receiver-flag.md diff --git a/.changelog/unreleased/bug-fixes/ibc-relayer/2411-retry-snerr.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2411-retry-snerr.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc-relayer/2411-retry-snerr.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2411-retry-snerr.md diff --git a/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2444-abci-info-data.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2444-abci-info-data.md new file mode 100644 index 0000000000..3e2af4d463 --- /dev/null +++ b/.changelog/v1.0.0-rc.1/bug-fixes/ibc-relayer/2444-abci-info-data.md @@ -0,0 +1,3 @@ +- Fix a bug where the relayer would fail to relay any packets when the + `/acbi_info` endpoint of a chain did not include `data` and `version` fields + ([#2444](https://github.com/informalsystems/ibc-rs/issues/2444)) \ No newline at end of file diff --git a/.changelog/unreleased/bug-fixes/ibc/2386-fix-ics20-ds-serde.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc/2386-fix-ics20-ds-serde.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/2386-fix-ics20-ds-serde.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc/2386-fix-ics20-ds-serde.md diff --git a/.changelog/unreleased/bug-fixes/ibc/2387-fix-get_channel_escrow_address.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc/2387-fix-get_channel_escrow_address.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/2387-fix-get_channel_escrow_address.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc/2387-fix-get_channel_escrow_address.md diff --git a/.changelog/unreleased/bug-fixes/ibc/2424-add-write-acknowledgement-packet-process-and-store.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc/2424-add-write-acknowledgement-packet-process-and-store.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/2424-add-write-acknowledgement-packet-process-and-store.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc/2424-add-write-acknowledgement-packet-process-and-store.md diff --git a/.changelog/unreleased/bug-fixes/ibc/2428-fix-handle-process-write-acknowledgement-incorrect-store-type.md b/.changelog/v1.0.0-rc.1/bug-fixes/ibc/2428-fix-handle-process-write-acknowledgement-incorrect-store-type.md similarity index 100% rename from .changelog/unreleased/bug-fixes/ibc/2428-fix-handle-process-write-acknowledgement-incorrect-store-type.md rename to .changelog/v1.0.0-rc.1/bug-fixes/ibc/2428-fix-handle-process-write-acknowledgement-incorrect-store-type.md diff --git a/.changelog/unreleased/features/ibc-relayer-cli/2310-new-optional-flags-query-connections.md b/.changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2310-new-optional-flags-query-connections.md similarity index 100% rename from .changelog/unreleased/features/ibc-relayer-cli/2310-new-optional-flags-query-connections.md rename to .changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2310-new-optional-flags-query-connections.md diff --git a/.changelog/unreleased/features/ibc-relayer-cli/2311-new-optional-flag-upgrade-clients.md b/.changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2311-new-optional-flag-upgrade-clients.md similarity index 100% rename from .changelog/unreleased/features/ibc-relayer-cli/2311-new-optional-flag-upgrade-clients.md rename to .changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2311-new-optional-flag-upgrade-clients.md diff --git a/.changelog/unreleased/features/ibc-relayer-cli/2429-show-counterparty.md b/.changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2429-show-counterparty.md similarity index 100% rename from .changelog/unreleased/features/ibc-relayer-cli/2429-show-counterparty.md rename to .changelog/v1.0.0-rc.1/features/ibc-relayer-cli/2429-show-counterparty.md diff --git a/.changelog/unreleased/improvement/ibc-relayer-cli/2431-colored_output.md b/.changelog/v1.0.0-rc.1/improvement/ibc-relayer-cli/2431-colored_output.md similarity index 100% rename from .changelog/unreleased/improvement/ibc-relayer-cli/2431-colored_output.md rename to .changelog/v1.0.0-rc.1/improvement/ibc-relayer-cli/2431-colored_output.md diff --git a/.changelog/unreleased/improvements/2455-tendermint-0.23.8.md b/.changelog/v1.0.0-rc.1/improvements/2455-tendermint-0.23.8.md similarity index 100% rename from .changelog/unreleased/improvements/2455-tendermint-0.23.8.md rename to .changelog/v1.0.0-rc.1/improvements/2455-tendermint-0.23.8.md diff --git a/.changelog/unreleased/improvements/guide/1935-global-options-doc.md b/.changelog/v1.0.0-rc.1/improvements/guide/1935-global-options-doc.md similarity index 100% rename from .changelog/unreleased/improvements/guide/1935-global-options-doc.md rename to .changelog/v1.0.0-rc.1/improvements/guide/1935-global-options-doc.md diff --git a/.changelog/unreleased/improvements/guide/2189-cleanup-dev-env-from-hermes-guide.md b/.changelog/v1.0.0-rc.1/improvements/guide/2189-cleanup-dev-env-from-hermes-guide.md similarity index 100% rename from .changelog/unreleased/improvements/guide/2189-cleanup-dev-env-from-hermes-guide.md rename to .changelog/v1.0.0-rc.1/improvements/guide/2189-cleanup-dev-env-from-hermes-guide.md diff --git a/.changelog/unreleased/improvements/ibc-proto/2403-update-protobufs.md b/.changelog/v1.0.0-rc.1/improvements/ibc-proto/2403-update-protobufs.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-proto/2403-update-protobufs.md rename to .changelog/v1.0.0-rc.1/improvements/ibc-proto/2403-update-protobufs.md diff --git a/.changelog/unreleased/improvements/ibc-relayer-cli/2375-keys-add-overwrite.md b/.changelog/v1.0.0-rc.1/improvements/ibc-relayer-cli/2375-keys-add-overwrite.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer-cli/2375-keys-add-overwrite.md rename to .changelog/v1.0.0-rc.1/improvements/ibc-relayer-cli/2375-keys-add-overwrite.md diff --git a/.changelog/unreleased/improvements/ibc-relayer-cli/2435-gas-multiplier.md b/.changelog/v1.0.0-rc.1/improvements/ibc-relayer-cli/2435-gas-multiplier.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-relayer-cli/2435-gas-multiplier.md rename to .changelog/v1.0.0-rc.1/improvements/ibc-relayer-cli/2435-gas-multiplier.md diff --git a/.changelog/unreleased/improvements/ibc-telemetry/2381-converted-wallet-balance-metric-to-f64.md b/.changelog/v1.0.0-rc.1/improvements/ibc-telemetry/2381-converted-wallet-balance-metric-to-f64.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-telemetry/2381-converted-wallet-balance-metric-to-f64.md rename to .changelog/v1.0.0-rc.1/improvements/ibc-telemetry/2381-converted-wallet-balance-metric-to-f64.md diff --git a/.changelog/unreleased/improvements/ibc-telemetry/2408-better-metrics-naming-and-description.md b/.changelog/v1.0.0-rc.1/improvements/ibc-telemetry/2408-better-metrics-naming-and-description.md similarity index 100% rename from .changelog/unreleased/improvements/ibc-telemetry/2408-better-metrics-naming-and-description.md rename to .changelog/v1.0.0-rc.1/improvements/ibc-telemetry/2408-better-metrics-naming-and-description.md diff --git a/.changelog/unreleased/improvements/ibc/2356-adr011.md b/.changelog/v1.0.0-rc.1/improvements/ibc/2356-adr011.md similarity index 100% rename from .changelog/unreleased/improvements/ibc/2356-adr011.md rename to .changelog/v1.0.0-rc.1/improvements/ibc/2356-adr011.md diff --git a/.changelog/v1.0.0-rc.1/summary.md b/.changelog/v1.0.0-rc.1/summary.md new file mode 100644 index 0000000000..062c463e17 --- /dev/null +++ b/.changelog/v1.0.0-rc.1/summary.md @@ -0,0 +1,7 @@ +This is the second release candidate for Hermes v1.0.0 🎉 + +### Note for operators + +> ⚠️ This release contains multiple breaking changes to the Hermes command-line interface and configuration. +> ⚠️ Please consult the [UPGRADING document for instructions](UPGRADING.md) to update to Hermes v1.0.0-rc.1. + diff --git a/CHANGELOG.md b/CHANGELOG.md index eac9758f5e..2a7d2ad688 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,124 @@ # CHANGELOG +## v1.0.0-rc.1 + +This is the second release candidate for Hermes v1.0.0 🎉 + +### Note for operators + +> ⚠️ This release contains multiple breaking changes to the Hermes command-line interface and configuration. +> ⚠️ Please consult the [UPGRADING document for instructions](UPGRADING.md) to update to Hermes v1.0.0-rc.1. + +### General + +- Bump `ibc-proto` crate to 0.19.1 +- Bump `ibc`, `ibc-relayer`, `ibc-telemetry`, `ibc-relayer-rest` crates to v0.17.0 +- Bump tendermint-rs dependencies to 0.23.8 + ([#2455](https://github.com/informalsystems/ibc-rs/issues/2455)) + +### Hermes - [`ibc-relayer-cli`](relayer-cli) (v1.0.0-rc.1) + +#### BREAKING CHANGES + +- Drop the `raw` prefix from all the `tx raw` commands + ([#2315](https://github.com/informalsystems/ibc-rs/issues/2315) +- Remove the four duplicate commands: + * `tx raw update-client`, which is the same as `update client` + * `tx raw upgrade-client`, which is the same as `upgrade client` + * `tx raw upgrade-clients`, which is the same as `upgrade clients` + * `tx raw create-client`, which is the same as `create client` + * ([#2315](https://github.com/informalsystems/ibc-rs/issues/2376)) +- Rename `--a-` and `--b-` prefixes in `hermes tx` subcommands to `--src-` and `--dst-` + ([#2410](https://github.com/informalsystems/ibc-rs/issues/2410)) +- Rename flags of `tx upgrade-chain` command from `--src`/`--dst` to `--reference`/`--host` + ([#2376](https://github.com/informalsystems/ibc-rs/issues/2376)) +- The default value of the configuration `tx_confirmation` + in Hermes `config.toml` has been changed from `true` to `false`. + ([#2408](https://github.com/informalsystems/ibc-rs/issues/2408)) + +#### BUG FIXES + +- Fixed filtering counterparty chain in Hermes command `query channels` + ([#1132](https://github.com/informalsystems/ibc-rs/issues/1132)) +- Fixed command `tx raw ft-transfer` to correctly use the address given by the `--receiver` flag + ([#2405](https://github.com/informalsystems/ibc-rs/issues/2405)) + +#### FEATURES + +- Add an optional `--show-counterparty` flag to `hermes query channels` which outputs every channel + along with its corresponding port, and the counterparty chain's id, in a pretty way + ([#2429](https://github.com/informalsystems/ibc-rs/issues/2429)) +- New optional flags `--counterparty-chain` and `--verbose` for the command `query connections` + ([#2310](https://github.com/informalsystems/ibc-rs/issues/2310)) +- Added new optional flag `--host-chain` to filter which clients are upgraded when running `upgrade clients` command + ([#2311](https://github.com/informalsystems/ibc-rs/issues/2311)) + +#### IMPROVEMENTS + +- Hermes command `keys add` now checks for existing key and overwrites only if the flag `--overwrite` is passed + ([#2375](https://github.com/informalsystems/ibc-rs/issues/2375)) +- Rename `--a-` and `--b-` prefixes in `hermes tx` subcommands to `--src-` and `--dst-` + ([#2410](https://github.com/informalsystems/ibc-rs/issues/2410)) +- Increase default value for `gas_multiplier` setting to 1.1 + ([#2435](https://github.com/informalsystems/ibc-rs/issues/2435)) +- Output status is now colored in green for success and red for error + ([#2431](https://github.com/informalsystems/ibc-rs/issues/2431)) + + +### IBC Proto - [`ibc-proto`](proto) (v0.19.1) + +#### IMPROVEMENTS + +- Update Protobuf definitions for IBC-Go to v4.0.0-rc0 and Cosmos SDK to v0.45.6 + ([#2403](https://github.com/informalsystems/ibc-rs/issues/2403)) + + +### IBC Modules - [`ibc`](modules) (v0.17.0) + +#### BREAKING CHANGES + +- Remove provided `Ics20Reader::get_channel_escrow_address()` implementation and make `cosmos_adr028_escrow_address()` public. + ([#2387](https://github.com/informalsystems/ibc-rs/issues/2387)) + +#### BUG FIXES + +- Fix serialization for ICS20 packet data structures + ([#2386](https://github.com/informalsystems/ibc-rs/issues/2386)). +- Properly process `WriteAcknowledgement`s on packet callback + ([#2424](https://github.com/informalsystems/ibc-rs/issues/2424)). +- Fix `write_acknowledgement` handler which incorrectly used packet's `source_{port, channel}` as key for storing acks + ([#2428](https://github.com/informalsystems/ibc-rs/issues/2428)) + +#### IMPROVEMENTS + +- Propose ADR011 for light client extraction. + ([#2356](https://github.com/informalsystems/ibc-rs/pull/2356)). + + +### Relayer Library - [`ibc-relayer`](relayer) (v0.17.0) + +#### BUG FIXES + +- Fix a regression where Hermes would not retry relaying packet on account + mismatch error when the sequence number used was smaller than the expected one + ([#2411](https://github.com/informalsystems/ibc-rs/issues/2411)) +- Fix a bug where the relayer would fail to relay any packets when the + `/acbi_info` endpoint of a chain did not include `data` and `version` fields + ([#2444](https://github.com/informalsystems/ibc-rs/issues/2444)) + + +### Telemetry & Metrics - [`ibc-telemetry`](telemetry) (v0.17.0) + +#### IMPROVEMENTS + +- Updated telemetry metric `wallet_balance` to f64 and removed downscaling + displayed value. Please note that when converting the balance to f64 a loss in + precision might be introduced in the displayed value + ([#2381](https://github.com/informalsystems/ibc-rs/issues/2381)) +- Improved naming and description of some telemetry metrics and added + histogram buckets for `tx_latency` metrics + ([#2408](https://github.com/informalsystems/ibc-rs/issues/2408)) + ## v1.0.0-rc.0 *July 7th, 2022* diff --git a/Cargo.lock b/Cargo.lock index bc88378c4b..935228e2e0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1404,7 +1404,7 @@ dependencies = [ [[package]] name = "ibc" -version = "0.16.0" +version = "0.17.0" dependencies = [ "bytes", "derive_more", @@ -1437,7 +1437,7 @@ dependencies = [ [[package]] name = "ibc-integration-test" -version = "0.16.0" +version = "0.17.0" dependencies = [ "ibc", "ibc-proto", @@ -1454,7 +1454,7 @@ dependencies = [ [[package]] name = "ibc-proto" -version = "0.19.0" +version = "0.19.1" dependencies = [ "base64", "bytes", @@ -1468,7 +1468,7 @@ dependencies = [ [[package]] name = "ibc-relayer" -version = "0.16.0" +version = "0.17.0" dependencies = [ "anyhow", "async-stream", @@ -1527,7 +1527,7 @@ dependencies = [ [[package]] name = "ibc-relayer-cli" -version = "1.0.0-rc.0" +version = "1.0.0-rc.1" dependencies = [ "abscissa_core", "atty", @@ -1570,7 +1570,7 @@ dependencies = [ [[package]] name = "ibc-relayer-rest" -version = "0.16.0" +version = "0.17.0" dependencies = [ "crossbeam-channel 0.5.6", "ibc", @@ -1585,7 +1585,7 @@ dependencies = [ [[package]] name = "ibc-telemetry" -version = "0.16.0" +version = "0.17.0" dependencies = [ "crossbeam-channel 0.5.6", "dashmap 5.3.4", @@ -1602,7 +1602,7 @@ dependencies = [ [[package]] name = "ibc-test-framework" -version = "0.16.0" +version = "0.17.0" dependencies = [ "async-trait", "color-eyre", diff --git a/UPGRADING.md b/UPGRADING.md index aa4e9966e8..84ec8b5694 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,5 +1,55 @@ # Upgrading Hermes to a newer version +## v1.0.0-rc.1 + +> These instructions assume that you are running Hermes v1.0.0-rc.0. +> If you are running an older version, please refer the corresponding +> in reverse chronological order to update to v1.0.0-rc.0 first and then +> follow these instructions. + + +### Default value of `tx_confirmation` setting has changed + +The default value of the configuration `tx_confirmation` +in Hermes `config.toml` has been changed from `true` to `false`. + +If you previously did not specify a value for this setting, you will +have to set `tx_confirmation = true` in `config.toml` under +the `[mode.packets]` section. + +### All `tx raw` subcommands were moved to the `tx` namespace + +The `raw` prefix was removed from all the commands listed below, +they are now available directly under the `tx` namespace: + +- `hermes tx chan-close-confirm` +- `hermes tx chan-close-init` +- `hermes tx chan-open-ack` +- `hermes tx chan-open-confirm` +- `hermes tx chan-open-init` +- `hermes tx chan-open-try` +- `hermes tx conn-ack` +- `hermes tx conn-confirm` +- `hermes tx conn-init` +- `hermes tx conn-try` +- `hermes tx create-client` +- `hermes tx ft-transfer` +- `hermes tx packet-ack` +- `hermes tx packet-recv` +- `hermes tx update-client` +- `hermes tx upgrade-chain` +- `hermes tx upgrade-client` +- `hermes tx upgrade-clients` + +### Rename `--a-` and `--b-` prefixes in `hermes tx` subcommands to `--src-` and `--dst-` + +All commands under the `tx` namespace, with the exception of `tx upgrade-chain`, now use +`--src-` and `--dst` prefix for flags names instead of `--a-` and `--b-`. + +The `tx upgrade-chain` command now uses `--reference-` and `--host-` prefixes. + +Please check the commands help or [ADR 010](adr-010) for the full updated list of commands. + ## v1.0.0-rc.0 > These instructions assume that you are running Hermes v0.15.0. @@ -26,9 +76,7 @@ positional arguments: $ hermes create client --host-chain ibc-0 --reference-chain ibc-1 ``` -Please [consult the ADR][flags-adr] which describes the new CLI flags for all commands. - -[flags-adr]: https://github.com/informalsystems/ibc-rs/blob/v1.0.0-rc.0/docs/architecture/adr-010-unified-cli-arguments-hermes.md +Please [consult the ADR][adr-010] which describes the new CLI flags for all commands. ### The `keys restore` command has been merged into `keys add` @@ -94,3 +142,5 @@ Please [refer to the guide][create-channel] for more information. Please refer to the [CHANGELOG](CHANGELOG.md) for older versions. +[adr-010]: https://github.com/informalsystems/ibc-rs/blob/v1.0.0-rc.1/docs/architecture/adr-010-unified-cli-arguments-hermes.md + diff --git a/guide/README.md b/guide/README.md index 41874d08ef..9b55366fed 100644 --- a/guide/README.md +++ b/guide/README.md @@ -11,7 +11,7 @@ mdBook is a utility to create modern online books from Markdown files. This guide should be permanently deployed at its latest stable version at [hermes.informal.systems](https://hermes.informal.systems). -Current version: `v1.0.0-rc.0`. +Current version: `v1.0.0-rc.1`. The version of this guide is aligned with the [versioning of the ibc crates](../README.md). diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index 9e09ade5a2..c8ede7947b 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -# Hermes (v1.0.0-rc.0) +# Hermes (v1.0.0-rc.1) --- - [Introduction](./index.md) diff --git a/guide/src/commands/global.md b/guide/src/commands/global.md index 1a00004115..9e7d5b9453 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 v1.0.0-rc.0 +hermes v1.0.0-rc.1 Informal Systems Implementation of `hermes`, an IBC Relayer developed in Rust. diff --git a/guide/src/config.md b/guide/src/config.md index 5dd34cdc68..f19ad43972 100644 --- a/guide/src/config.md +++ b/guide/src/config.md @@ -25,7 +25,7 @@ hermes [--config 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/v1.0.0-rc.0/config.toml) +> Please read the configuration file [`config.toml`](https://github.com/informalsystems/ibc-rs/blob/v1.0.0-rc.1/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/v1.0.0-rc.0/config.toml#L209-L231). +To restrict relaying on specific channels, or uni-directionally, you can use [packet filtering policies](https://github.com/informalsystems/ibc-rs/blob/v1.0.0-rc.1/config.toml#L209-L231). ## Adding private keys diff --git a/guide/src/index.md b/guide/src/index.md index df0cae5e79..10e60f051e 100644 --- a/guide/src/index.md +++ b/guide/src/index.md @@ -1,4 +1,4 @@ -# Hermes Guide (v1.0.0-rc.0) +# Hermes Guide (v1.0.0-rc.1) Hermes is a an open-source Rust implementation of a relayer for the diff --git a/guide/src/installation.md b/guide/src/installation.md index a98da3c9d7..4550706c3f 100644 --- a/guide/src/installation.md +++ b/guide/src/installation.md @@ -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-v1.0.0-rc.0-x86_64-apple-darwin.tar.gz` (or .zip), -- Linux: `hermes-v1.0.0-rc.0-x86_64-unknown-linux-gnu.tar.gz` (or .zip). +- MacOS: `hermes-v1.0.0-rc.1-x86_64-apple-darwin.tar.gz` (or .zip), +- Linux: `hermes-v1.0.0-rc.1-x86_64-unknown-linux-gnu.tar.gz` (or .zip). The step-by-step instruction below should carry you through the whole process: @@ -47,7 +47,7 @@ hermes version ``` ``` -hermes v1.0.0-rc.0 +hermes v1.0.0-rc.1 ``` ## Install via Cargo @@ -59,7 +59,7 @@ Hermes is packaged in the `ibc-relayer-cli` Rust crate. To install the latest release of Hermes, run the following command in a terminal: ```shell -cargo install ibc-relayer-cli@1.0.0-rc.0 --bin hermes --locked +cargo install ibc-relayer-cli@1.0.0-rc.1 --bin hermes --locked ``` This will download and build the crate `ibc-relayer-cli`, and install the @@ -81,7 +81,7 @@ hermes version ``` ``` -hermes v1.0.0-rc.0 +hermes v1.0.0-rc.1 ``` ## 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 `v1.0.0-rc.0` then execute the command: +Then checkout the release, for example if the most recent release is `v1.0.0-rc.1` then execute the command: ```shell -git checkout v1.0.0-rc.0 +git checkout v1.0.0-rc.1 ``` ### Building with `cargo build` @@ -151,7 +151,7 @@ If you run the `hermes` without any additional parameters you should see the usa ``` ``` -hermes v1.0.0-rc.0 +hermes v1.0.0-rc.1 Informal Systems USAGE: diff --git a/guide/src/rest-api.md b/guide/src/rest-api.md index 4cddd2774c..91b114c974 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": "v1.0.0-rc.0" + "version": "v1.0.0-rc.1" }, { "name": "ibc-relayer-rest", diff --git a/modules/Cargo.toml b/modules/Cargo.toml index 4376faba6a..1ad433902c 100644 --- a/modules/Cargo.toml +++ b/modules/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc" -version = "0.16.0" +version = "0.17.0" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -27,7 +27,7 @@ mocks = ["tendermint-testgen", "clock", "std"] [dependencies] # Proto definitions for all IBC-related interfaces, e.g., connections or channels. -ibc-proto = { version = "0.19.0", path = "../proto", default-features = false } +ibc-proto = { version = "0.19.1", path = "../proto", default-features = false } ics23 = { version = "=0.8.0-alpha", default-features = false } time = { version = "0.3", default-features = false } serde_derive = { version = "1.0.104", default-features = false } diff --git a/proto/Cargo.toml b/proto/Cargo.toml index 758cf7eff0..4b95f6a558 100644 --- a/proto/Cargo.toml +++ b/proto/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-proto" -version = "0.19.0" +version = "0.19.1" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0" diff --git a/proto/src/lib.rs b/proto/src/lib.rs index 982562f05a..febfd89d72 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.19.0")] +#![doc(html_root_url = "https://docs.rs/ibc-proto/0.19.1")] pub mod google; diff --git a/relayer-cli/Cargo.toml b/relayer-cli/Cargo.toml index d29785936a..7b9ada84c3 100644 --- a/relayer-cli/Cargo.toml +++ b/relayer-cli/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-cli" -version = "1.0.0-rc.0" +version = "1.0.0-rc.1" 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.16.0", path = "../modules", features = ["std", "clock"] } -ibc-relayer = { version = "0.16.0", path = "../relayer" } -ibc-proto = { version = "0.19.0", path = "../proto" } -ibc-telemetry = { version = "0.16.0", path = "../telemetry", optional = true } -ibc-relayer-rest = { version = "0.16.0", path = "../relayer-rest", optional = true } +ibc = { version = "0.17.0", path = "../modules", features = ["std", "clock"] } +ibc-relayer = { version = "0.17.0", path = "../relayer" } +ibc-proto = { version = "0.19.1", path = "../proto" } +ibc-telemetry = { version = "0.17.0", path = "../telemetry", optional = true } +ibc-relayer-rest = { version = "0.17.0", path = "../relayer-rest", optional = true } clap = { version = "3.2", features = ["cargo"] } clap_complete = "3.2" diff --git a/relayer-rest/Cargo.toml b/relayer-rest/Cargo.toml index 70519bd984..ff8f3ac9ea 100644 --- a/relayer-rest/Cargo.toml +++ b/relayer-rest/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer-rest" -version = "0.16.0" +version = "0.17.0" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0" @@ -14,8 +14,8 @@ description = """ """ [dependencies] -ibc = { version = "0.16.0", path = "../modules" } -ibc-relayer = { version = "0.16.0", path = "../relayer" } +ibc = { version = "0.17.0", path = "../modules" } +ibc-relayer = { version = "0.17.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 9b0483e01e..3a7c68b316 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.16.0".to_string(), + version: "0.17.0".to_string(), }; let result = vec![version.clone(), rest_api_version]; diff --git a/relayer/Cargo.toml b/relayer/Cargo.toml index 30813491fa..1a6916d821 100644 --- a/relayer/Cargo.toml +++ b/relayer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-relayer" -version = "0.16.0" +version = "0.17.0" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -21,9 +21,9 @@ profiling = [] telemetry = ["ibc-telemetry"] [dependencies] -ibc = { version = "0.16.0", path = "../modules" } -ibc-proto = { version = "0.19.0", path = "../proto" } -ibc-telemetry = { version = "0.16.0", path = "../telemetry", optional = true } +ibc = { version = "0.17.0", path = "../modules" } +ibc-proto = { version = "0.19.1", path = "../proto" } +ibc-telemetry = { version = "0.17.0", path = "../telemetry", optional = true } subtle-encoding = "0.5" humantime-serde = "1.1.1" @@ -93,7 +93,7 @@ default-features = false version = "=0.23.8" [dev-dependencies] -ibc = { version = "0.16.0", path = "../modules", features = ["mocks"] } +ibc = { version = "0.17.0", path = "../modules", features = ["mocks"] } serial_test = "0.8.0" env_logger = "0.9.0" tracing-subscriber = { version = "0.3.14", features = ["fmt", "env-filter", "json"] } diff --git a/telemetry/Cargo.toml b/telemetry/Cargo.toml index a1e8efac66..72c7ac88cb 100644 --- a/telemetry/Cargo.toml +++ b/telemetry/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-telemetry" -version = "0.16.0" +version = "0.17.0" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -13,7 +13,7 @@ description = """ """ [dependencies] -ibc = { version = "0.16.0", path = "../modules" } +ibc = { version = "0.17.0", path = "../modules" } crossbeam-channel = "0.5.5" once_cell = "1.13.0" diff --git a/tools/integration-test/Cargo.toml b/tools/integration-test/Cargo.toml index 0a024ffc64..9ffe235bf5 100644 --- a/tools/integration-test/Cargo.toml +++ b/tools/integration-test/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-integration-test" -version = "0.16.0" +version = "0.17.0" edition = "2021" license = "Apache-2.0" readme = "README.md" diff --git a/tools/test-framework/Cargo.toml b/tools/test-framework/Cargo.toml index 2a7003a61c..2c6351b1b1 100644 --- a/tools/test-framework/Cargo.toml +++ b/tools/test-framework/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-test-framework" -version = "0.16.0" +version = "0.17.0" edition = "2021" license = "Apache-2.0" readme = "README.md" @@ -14,10 +14,10 @@ description = """ """ [dependencies] -ibc = { version = "=0.16.0", path = "../../modules" } -ibc-relayer = { version = "=0.16.0", path = "../../relayer" } -ibc-relayer-cli = { version = "=1.0.0-rc.0", path = "../../relayer-cli" } -ibc-proto = { version = "=0.19.0", path = "../../proto" } +ibc = { version = "=0.17.0", path = "../../modules" } +ibc-relayer = { version = "=0.17.0", path = "../../relayer" } +ibc-relayer-cli = { version = "=1.0.0-rc.1", path = "../../relayer-cli" } +ibc-proto = { version = "=0.19.1", path = "../../proto" } tendermint = { version = "=0.23.8" } tendermint-rpc = { version = "=0.23.8", features = ["http-client", "websocket-client"] }