Merge upstream changes from informalsystems/hermes

.cargo/config → .cargo/config.toml

@@ -1,3 +1,4 @@
 [build]
 # Enable Tokio's `tracing` support for `tokio-console`
-rustflags = ["--cfg", "tokio_unstable"]
+rustflags = ["--cfg", "tokio_unstable"]
+

.changelog/unreleased/bug-fixes/ibc-relayer-cli/3893-fix-min-gas-price-healthcheck.md

@@ -0,0 +1,2 @@
+- Fixed `minimum-gas-prices` health-check messages and make it more verbose and legible
+  ([\#3893](https://github.com/informalsystems/hermes/issues/3893))

.changelog/unreleased/bug-fixes/ibc-relayer-cli/3910-fix-subscribe-bug.md

@@ -0,0 +1,2 @@
+- Set `compat_mode` for pull mode in `hermes listen` command
+  ([\#3910](https://github.com/informalsystems/hermes/issues/3910))

.changelog/unreleased/features/ibc-relayer/3894-continue-event-sourcing.md

@@ -0,0 +1,6 @@
+- Improve reliabily of event source in `pull` mode by proceeding to next block even if Hermes cannot parse the current block.
+  Add new configuration option to `event_source` setting: `max_retries` defines how many times Hermes should attempt to pull a block over RPC.
+  ```toml
+  event_source = { mode = 'pull', interval = '1s', max_retries = 4 }
+  ```
+  ([\#3894](https://github.com/informalsystems/hermes/issues/3894))

.changelog/unreleased/improvements/ibc-relayer-cli/3913-config-auto-pull.md

@@ -0,0 +1,2 @@
+- Use RPC (pull) event source instead of WebSocket (push) when generating configuration with `hermes config auto`
+  ([\#3913](https://github.com/informalsystems/hermes/issues/3913))

.changelog/v1.8.1/bug-fixes/ibc-relayer/3770-non-utf8-packet-data.md

@@ -0,0 +1,6 @@
+- Allow relaying ICS-04 packets with non-UTF-8 payloads ([\#3770](https://github.com/informalsystems/hermes/issues/3770))
+  Hermes does not assume anymore that an ICS-04 packet data is valid UTF-8,
+  by using the `packet_data_hex` attribute when assembling a packet from events, instead of the deprecated `packet_data` attribute.
+  Relying on the `packet_data` attribute enforces a UTF-8 encoded payload (eg. JSON), disallowing eg. Protobuf-encoded payloads.
+  The `packet_data` attribute [has been deprecated][0] in favor of `packet_data_hex` since IBC-Go v1.0.0.
+  [0]: https://github.com/cosmos/ibc-go/blob/fadf8f2b0ab184798d021d220d877e00c7634e26/CHANGELOG.md?plain=1#L1417

.changelog/v1.8.1/bug-fixes/ibc-relayer/3831-better-compat-check.md

@@ -0,0 +1,2 @@
+- Improve reliability of compatibility check and fix parsing of expected modules
+  versions ([\#3831](https://github.com/informalsystems/hermes/issues/3831))

.changelog/v1.8.1/features/ibc-relayer/3754-filter-packet-clearing.md

@@ -0,0 +1,5 @@
+- Add a per-chain configuration `excluded_sequences` allowing
+  users to specify a list of packet sequences which will not be
+  cleared.
+  This configuration has no impact on standard packet relaying.
+  ([\#3754](https://github.com/informalsystems/hermes/issues/3754))

.changelog/v1.8.1/features/ibc-relayer/3811-relayer-memo-overwrite.md

@@ -0,0 +1,3 @@
+- Add a per-chain configuration `memo_overwrite` allowing users
+  to overwrite the relayer memo used for each transaction
+  ([\#3811](https://github.com/informalsystems/hermes/issues/3811))

.changelog/v1.8.1/features/ibc-telemetry/3845-add-simulate-errors-metric.md

@@ -0,0 +1,11 @@
+- Added a new Prometheus metric `simulate_errors` for tracking when a transaction simulation fails, with the following labels: 
+  * `recoverable` (can the execution continue if this happened?) 
+  * `account` (account from which the tx was sent) 
+  * `error_description` (description of the error) 
+  ([\#3845](https://github.com/informalsystems/hermes/issues/3845))
+
+  ```
+  # HELP simulate_errors_total Number of errors observed by Hermes when simulating a Tx
+  # TYPE simulate_errors_total counter
+  simulate_errors_total{account="osmo17ndx5qfku28ymxgmq6zq4a6d02dvpfjjul0hyh",error_description="Unknown error",recoverable="false",service_name="unknown_service",otel_scope_name="hermes",otel_scope_version=""} 4
+  ```

.changelog/v1.8.1/improvements/3814-grpc-syncing.md

@@ -0,0 +1,3 @@
+- Add syncing check for gRPC node ([#3814])
+
+[#3814]: https://github.com/informalsystems/ibc-rs/issues/3814

.changelog/v1.8.1/improvements/3814-status-use-client-latest-height.md

@@ -0,0 +1,3 @@
+- Use the consensus state at client latest height in status CLI ([#3814])
+
+[#3814]: https://github.com/informalsystems/ibc-rs/issues/3814

.changelog/v1.8.1/improvements/ibc-relayer/3530-out-of-gas-error-log.md

@@ -0,0 +1,4 @@
+- Improve the log diagnostic when an out of gas error is thrown.
+  And a new entry related to gas error has been added to the Hermes
+  guide.
+  ([\#3530](https://github.com/informalsystems/hermes/issues/3530))

.changelog/v1.8.1/improvements/ibc-relayer/3540-ordered-channels-resilience.md

@@ -0,0 +1,6 @@
+- Improve resilience when relaying on ordered channels. 
+  When relaying packets on an ordered channel, Hermes will now attempt
+  to detect whether the next message to send has the sequence number
+  expected on that channel. If there is a mismatch, then Hermes will trigger a packet
+  clear on the channel to unblock it before resuming operations on that channel.
+  ([\#3540](https://github.com/informalsystems/hermes/issues/3540))

.changelog/v1.8.1/improvements/ibc-relayer/3792-legacy-simulation.md

@@ -0,0 +1,2 @@
+- Recover from gas simulation failures on legacy chains.
+  ([\#3792](https://github.com/informalsystems/hermes/issues/3792))

.changelog/v1.8.1/summary.md

@@ -0,0 +1,19 @@
+*March 6th, 2024*
+
+This release improves reliability when relaying, more enhanced configuration and improved monitoring.
+
+Reliability has been improved:
+* It is now possible to relay ICS-04 packets with non-UTF-8 payloads
+* Packet sequences are now verified for ordered channels before trying to relay
+
+Additional per-chain configurations have been added:
+* `excluded_sequences` used to skip problematic packets when clearing
+* `memo_overwrite` allowing users to overwrite the relayer memo when chains have a
+strict limit for the size of the memo
+
+Monitoring issues improvements:
+* A new metric `simulate_errors` which counts the number of failed simulated transactions
+* Out of gas error diagnostic gives more information and a dedicated entry to the guide has been added
+* Failed gas simulation will not be considered as unrecoverable for legacy chains
+* The compatibility check during the health-check has been improved will assess more correctly the versions
+  for Ibc-Go and Cosmos SDK

.changelog/v1.8.2/bug-fixes/ibc-relayer-cli/3889-clear-packet-cli-fix.md

@@ -0,0 +1,3 @@
+- Correctly use the counterparty channel and port IDs when clearing the packets
+  from the destination chain to the source chain in the `packet clear` command
+  ([\#3889](https://github.com/informalsystems/hermes/issues/3889))

.changelog/v1.8.2/bug-fixes/ibc-relayer/3880-health-check-fix.md

@@ -0,0 +1,2 @@
+- Fix parsing of IBC-Go version in health check and improve health check
+  reporting ([\#3880](https://github.com/informalsystems/hermes/issues/3880))

.changelog/v1.8.2/features/ibc-integration-test/3887-test-with-injective.md

@@ -0,0 +1,2 @@
+- Add Injective chain to the chains running the integration tests in the CI.
+  ([\#3887](https://github.com/informalsystems/hermes/issues/3887))

.changelog/v1.8.2/improvements/ibc-relayer/3864-handshake-retry.md

@@ -0,0 +1,3 @@
+- Change connection and channel handshake retry strategy
+  to retry at most 10 times (5 times per block max)
+  ([\#3864](https://github.com/informalsystems/hermes/issues/3864))

.changelog/v1.8.2/summary.md

@@ -0,0 +1,6 @@
+*March 12th, 2024*
+
+This release fixes the two following bugs and improves the connection and channel handshake retry mechanism:
+
+* Fix erroneous warnings for incompatible version of IBC-Go during health checks, ensuring accurate compatibility reporting
+* Fix a bug in the `clear packets` command which caused packet clearing to fail with an "counterparty channel not found" error

.github/ISSUE_TEMPLATE/release-template.md

@@ -20,3 +20,4 @@ v                     without deliberation
 - [ ] Create a new release in the changelog, using [`unclog`](https://github.com/informalsystems/unclog)
   - If doing a release candidate (`rc`) version, then skip the `unclog release` step
 - [ ] Reassign unfinished issues of previous milestone to the next milestone
+- [ ] Notify the comms team about the pending new release by tagging [@isa-belch](https://github.com/isa-belch) as a reviewer here

.github/codespell/codespell.ini

@@ -1,3 +1,3 @@
 [codespell]
-skip = *.js,*.ts,*.css,*.svg,*.html,*.json,./target,./tools/integration-test/data,./tools/check-guide/target,./ci/misbehaviour/data
+skip = *.js,*.ts,*.css,*.svg,*.html,*.json,./target,./tools/integration-test/data,./tools/check-guide/target,./ci/misbehaviour/data,Cargo.lock
 ignore-words = .github/codespell/words.txt

.github/workflows/audit.yaml

@@ -15,5 +15,7 @@ jobs:
           path: ~/.cargo/bin
           key: ${{ runner.os }}-cargo-audit-v0.11.2
       - uses: actions-rs/audit-check@v1.2.0
+        env:
+          RUSTFLAGS: --cfg tokio_unstable
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/cargo-doc.yaml

@@ -16,6 +16,9 @@ on:
       - Cargo.lock
       - crates/**
 
+env:
+  RUSTFLAGS: --cfg tokio_unstable
+
 # Cancel previous runs of this workflow when a new commit is added to the PR, branch or tag
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -26,23 +29,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: nightly-2023-07-13
-          override: true
-
+      - name: Install rust toolchain
+        # The script for rustdoc build requires nightly toolchain.
+        uses: dtolnay/rust-toolchain@nightly
+      # Loading cache takes ~15s, but saves us minutes of build.
+      - name: Load rust cache
+        uses: astriaorg/buildjet-rust-cache@v2.5.1
       - name: Build API documentation
         uses: actions-rs/cargo@v1
         env:
-          RUSTDOCFLAGS: "--cfg docsrs"
+          RUSTDOCFLAGS: "--enable-index-page -Zunstable-options --cfg docsrs"
         with:
           command: doc
-          args: --all-features
-
-      - name: Push API documentation to GitHub Pages
-        if: github.ref == 'refs/heads/main'
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          deploy_key: ${{ secrets.IBC_RS_DOC_PRIVATE_KEY }}
-          external_repository: informalsystems/hermes-api-doc
-          publish_dir: ./target/doc
+          args: --all-features --no-deps
+      # Disabled on penumbra hermes fork
+      # - name: Push API documentation to GitHub Pages
+      #   if: github.ref == 'refs/heads/main'
+      #   uses: peaceiris/actions-gh-pages@v3
+      #   with:
+      #     deploy_key: ${{ secrets.IBC_RS_DOC_PRIVATE_KEY }}
+      #     external_repository: informalsystems/hermes-api-doc
+      #     publish_dir: ./target/doc

.github/workflows/codespell.yml

@@ -17,6 +17,6 @@ jobs:
       - uses: actions/checkout@v4
       - uses: codespell-project/actions-codespell@v2
         with:
-          skip: '*.js,*.ts,*.css,*.svg,*.html,*.json,./target,./tools/integration-test/data,./tools/check-guide/target,./ci/misbehaviour/data'
+          skip: '*.js,*.ts,*.css,*.svg,*.html,*.json,./target,./tools/integration-test/data,./tools/check-guide/target,./ci/misbehaviour/data,Cargo.lock'
           ignore_words_file: .github/codespell/words.txt
 

.github/workflows/docker.yml

@@ -31,6 +31,10 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY_IMAGE }}
+          tags: |
+            type=ref,event=tag
+            type=ref,event=branch
+            type=semver,pattern={{version}}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -91,6 +95,10 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY_IMAGE }}
+          tags: |
+            type=ref,event=tag
+            type=ref,event=branch
+            type=semver,pattern={{version}}
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3

.github/workflows/guide-templates.yaml

@@ -17,6 +17,9 @@ on:
       - tools/check-guide/**
       - guide/src/templates/**
 
+env:
+  RUSTFLAGS: --cfg tokio_unstable
+
 # Cancel previous runs of this workflow when a new commit is added to the PR, branch or tag
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -28,10 +31,9 @@ jobs:
     timeout-minutes: 60
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           toolchain: stable
-          override: true
       - name: Check templates
         run: bash scripts/auto_gen_templates.sh --mode "check"
       - uses: actions-rs/cargo@v1