Merge branch 'main' into add-spawn-page

.changelog/epilogue.md

@@ -1,3 +1,26 @@
+## v4.5.0
+
+*September 30, 2024*
+
+### BUG FIXES
+
+- Remove duplicate event emission on cached context.
+  ([\#2282](https://github.com/cosmos/interchain-security/pull/2282))
+
+### FEATURES
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+
+### STATE BREAKING
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+
 ## v4.4.0
 
 *July 16, 2024*

.changelog/unreleased/bug-fixes/2363-zero-rewards.md

@@ -0,0 +1,2 @@
+- `[x/provider]` Add check for zero rewards to the rewards distribution logic.
+  ([\#2363](https://github.com/cosmos/interchain-security/pull/2363))

.changelog/unreleased/features/provider/2101-introduce-priority-validators.md

@@ -0,0 +1,2 @@
+- Allow consumer chains to specify a list of priority validators that are included in the validator set before other validators are considered
+  ([\#2101](https://github.com/cosmos/interchain-security/pull/2101))

.changelog/unreleased/improvements/2357-init-params.md

@@ -0,0 +1,3 @@
+- `[x/provider]` Add validation for initial height and set
+  default values for consumer initialization params.
+  ([\#2357](https://github.com/cosmos/interchain-security/pull/2357))

.changelog/unreleased/state-breaking/2101-introduce-priority-validators.md

@@ -0,0 +1,2 @@
+- Allow consumer chains to specify a list of priority validators that are included in the validator set before other validators are considered
+  ([\#2101](https://github.com/cosmos/interchain-security/pull/2101))

.changelog/unreleased/state-breaking/2357-init-params.md

@@ -0,0 +1,3 @@
+- `[x/provider]` Add validation for initial height and set
+  default values for consumer initialization params.
+  ([\#2357](https://github.com/cosmos/interchain-security/pull/2357))

.changelog/unreleased/state-breaking/2363-zero-rewards.md

@@ -0,0 +1,2 @@
+- `[x/provider]` Add check for zero rewards to the rewards distribution logic.
+  ([\#2363](https://github.com/cosmos/interchain-security/pull/2363))

.changelog/v6.2.0/summary.md

@@ -0,0 +1,2 @@
+*October 4, 2024*
+

.github/dependabot.yml

@@ -68,3 +68,22 @@ updates:
     labels:
       - dependencies
 
+  - package-ecosystem: gomod
+    directory: "/"
+    schedule:
+      interval: daily
+    target-branch: "release/v6.2.x"
+    # Only allow automated security-related dependency updates on release branches.
+    open-pull-requests-limit: 0
+    labels:
+      - dependencies
+
+  - package-ecosystem: gomod
+    directory: "/"
+    schedule:
+      interval: daily
+    target-branch: "release/v6.3.x"
+    # Only allow automated security-related dependency updates on release branches.
+    open-pull-requests-limit: 0
+    labels:
+      - dependencies

.github/workflows/docker-publish.yml

@@ -42,15 +42,15 @@ jobs:
       # https://github.com/sigstore/cosign-installer
       - name: Install cosign
         if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@4959ce089c160fddf62f7b42464195ba1a56d382 #v3.6.0
+        uses: sigstore/cosign-installer@dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da #v3.7.0
         with:
           cosign-release: 'v2.2.3'
 
       # Set up BuildKit Docker container builder to be able to build
       # multi-platform images and export cache
       # https://github.com/docker/setup-buildx-action
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1
+        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
 
 
       # Login against a Docker registry except on PR

.github/workflows/nightly-e2e.yml

@@ -277,6 +277,22 @@ jobs:
           go-version: "1.22" # The Go version to download (if necessary) and use.
       - name: E2E partial set security denylist
         run: go run ./tests/e2e/... --tc partial-set-security-validators-denylisted
+  partial-set-security-validators-prioritylisted-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - uses: actions/checkout@v4
+      - name: Checkout LFS objects
+        run: git lfs checkout
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22" # The Go version to download (if necessary) and use.
+      - name: E2E partial set security prioritylist
+        run: go run ./tests/e2e/... --tc partial-set-security-validators-prioritylisted
   partial-set-security-modification-proposal:
     runs-on: ubuntu-latest
     timeout-minutes: 20
@@ -376,6 +392,7 @@ jobs:
       - partial-set-security-validators-power-cap-test
       - partial-set-security-validators-allowlisted-test
       - partial-set-security-validators-denylisted-test
+      - partial-set-security-validators-prioritylisted-test
       - partial-set-security-modification-proposal
       - active-set-changes-test
       - permissionless-basic-test

.github/workflows/proto-registry.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: bufbuild/buf-setup-action@v1.42.0
+      - uses: bufbuild/buf-setup-action@v1.45.0
       - uses: bufbuild/buf-push-action@v1
         with:
           input: "proto"

.github/workflows/proto.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: bufbuild/buf-setup-action@v1.42.0
+      - uses: bufbuild/buf-setup-action@v1.45.0
       - uses: bufbuild/buf-breaking-action@v1
         with:
           input: "proto"

.github/workflows/test.yml

@@ -39,7 +39,7 @@ jobs:
             **/go.sum
             **/Makefile
             Makefile
-      - uses: actions/cache@v4.0.2
+      - uses: actions/cache@v4.1.0
         with:
           path: |
             ~/.cache/go-build

.github/workflows/testing-docs.yml

@@ -0,0 +1,70 @@
+name: Generate testing docs
+
+on:
+    workflow_call:
+    pull_request:
+    merge_group:
+    push:
+      branches:
+        - main
+        - release/v*
+        - feat/*
+
+permissions:
+  contents: write
+  pull-requests: write      # 'write' access to pull requests in order to update test documentation automatically 
+
+jobs:
+    testing-docs:
+        runs-on: ubuntu-latest
+
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+
+        - uses: actions/setup-go@v5
+          with:
+            go-version: "1.22"
+            check-latest: true
+            cache: true
+            cache-dependency-path: go.sum
+        - uses: technote-space/get-diff-action@v6.1.2
+          id: git_diff
+          with:
+            PATTERNS: |
+              tests/integration/**/*.go
+              **/Makefile
+              Makefile
+
+        - name: Generate testing docs
+          if: env.GIT_DIFF
+          run: make build-testing-docs
+
+        - name: Check for changes and update automatically
+          if: env.GIT_DIFF
+          id: check_changes_and_update
+          run: |
+            git show HEAD:scripts/test_doc/test_documentation.md > committed_file.md
+            cp scripts/test_doc/test_documentation.md generated_file.md
+            if ! diff -q generated_file.md committed_file.md; then
+              echo "Documentation for integration tests is out of date. Updating and pushing changes..."
+              cp generated_file.md scripts/test_doc/test_documentation.md
+
+              if [ -n "$GITHUB_HEAD_REF" ]; then
+                branch=$GITHUB_HEAD_REF
+              else
+                branch=${GITHUB_REF#refs/heads/}
+              fi
+              
+              git fetch origin $branch
+              git checkout $branch
+
+              cp generated_file.md scripts/test_doc/test_documentation.md
+              git config user.name "github-actions"
+              git config user.email "github-actions@github.com"
+              git add scripts/test_doc/test_documentation.md
+              git commit -m "Update testing documentation"
+
+              git push origin "$branch"
+
+            fi

.mergify.yml

@@ -50,3 +50,19 @@ pull_request_rules:
       backport:
         branches:
           - release/v6.1.x
+  - name: Backport patches to the release/v6.2.x branch
+    conditions:
+      - base=main
+      - label=A:backport/v6.2.x
+    actions:
+      backport:
+        branches:
+          - release/v6.2.x
+  - name: Backport patches to the release/v6.3.x branch
+    conditions:
+      - base=main
+      - label=A:backport/v6.3.x
+    actions:
+      backport:
+        branches:
+          - release/v6.3.x

CHANGELOG.md

@@ -1,5 +1,33 @@
 # CHANGELOG
 
+## v6.2.0
+
+*October 4, 2024*
+
+### DEPENDENCIES
+
+- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
+  [v8.5.1](https://github.com/cosmos/ibc-go/releases/tag/v8.5.1).
+  ([\#2277](https://github.com/cosmos/interchain-security/pull/2277))
+
+### FEATURES
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards.
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+- `[x/provider]` Enable permissionless allowlisting of reward denoms (at most 3) per consumer chain. 
+  ([\#2309](https://github.com/cosmos/interchain-security/pull/2309))
+
+### STATE BREAKING
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards.
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+- `[x/provider]` Enable permissionless allowlisting of reward denoms (at most 3) per consumer chain.
+  ([\#2309](https://github.com/cosmos/interchain-security/pull/2309))
+
 ## v6.1.0
 
 *September 20, 2024*
@@ -317,6 +345,29 @@ Backporting of ([\#1964](https://github.com/cosmos/interchain-security/pull/1964
 - Revert `PutUnbondingOnHold` behavior to ICS@v1
 ([\#1819](https://github.com/cosmos/interchain-security/pull/1819))
 
+## v4.5.0
+
+*September 30, 2024*
+
+### BUG FIXES
+
+- Remove duplicate event emission on cached context.
+  ([\#2282](https://github.com/cosmos/interchain-security/pull/2282))
+
+### FEATURES
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+
+### STATE BREAKING
+
+- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards
+with the required consumer chain Id to identify the consumer to the provider.
+- `[x/provider]` Identify the source of ICS rewards from the IBC transfer packet memo.
+  ([\#2290](https://github.com/cosmos/interchain-security/pull/2290))
+
 ## v4.4.0
 
 *July 16, 2024*

Dockerfile

@@ -29,7 +29,10 @@ RUN go mod tidy
 RUN make install
 
 # Get Hermes build
-FROM --platform=linux/amd64 ghcr.io/informalsystems/hermes:1.10.2 AS hermes-builder
+# TODO: import Hermes release from ghcr.io/informalsystems repository when 
+# a Hermes release contains the patch in 
+# https://github.com/informalsystems/hermes/pull/4182
+FROM --platform=linux/amd64 otacrew/hermes-ics:latest AS hermes-builder
 
 # Get CometMock
 FROM ghcr.io/informalsystems/cometmock:v0.38.x as cometmock-builder

Dockerfile.combined

@@ -24,7 +24,10 @@ FROM --platform=linux/amd64 ${PROVIDER_IMAGE} AS provider
 FROM --platform=linux/amd64 ${CONSUMER_IMAGE} AS consumer
 
 # Get Hermes build
-FROM --platform=linux/amd64 ghcr.io/informalsystems/hermes:1.10.2 AS hermes-builder
+# TODO: import Hermes release from ghcr.io/informalsystems repository when 
+# a Hermes release contains the patch in 
+# https://github.com/informalsystems/hermes/pull/4182
+FROM --platform=linux/amd64 otacrew/hermes-ics:latest AS hermes-builder
 
 
 # Get GoRelayer

Makefile

@@ -265,6 +265,9 @@ build-docs-deploy:
 build-docs-local:
 	@cd docs && ./build_local.sh
 
+build-testing-docs:
+	@cd scripts/test_doc && go run extract_docstrings.go
+
 ###############################################################################
 ### 							Test Traces									###
 ###############################################################################

TESTING.md

@@ -14,6 +14,18 @@ Unit tests are useful for simple standalone functionality, and CRUD operations.
 
 To run integration tests against your own consumer/provider implementations, use [instance_test.go](tests/integration/instance_test.go) as an example. All you'll need to do is make sure your applications implement the necessary interfaces defined in [interfaces.go](testutil/integration/interfaces.go), pattern match [specific_setup.go](testutil/ibc_testing/specific_setup.go), then pass in the appropriate types and parameters to the suite, as is done in `instance_test.go` for the dummy provider/consumer implementations.
 
+A list of test scenarios covered by integration tests can be found in [scripts/test_doc/test_documentation.md](scripts/test_doc/test_documentation.md).
+When adding an integration test, write a brief description as a docstring in the Golang code in this schema:
+
+```go
+// This is a test that tests foo and bar.
+// @Long Description@
+// Here is a detailed description
+// that goes into more detail and describes the scenario.
+```
+
+Then, run `make build-testing-docs` to update the test documentation.
+
 ## Model-Based Tests (MBT)
 
 [MBT](tests/mbt/) tests are similar to integration tests, but they compare the system state to an expected state generated from a formally verified specification written in Quint.

contrib/local-testnet.sh

@@ -317,7 +317,8 @@ tee ${PROV_NODE_DIR}/consumer_prop.json<<EOF
                 "allowlist": [],
                 "denylist": [],
                 "min_stake": 1000,
-                "allow_inactive_vals": true
+                "allow_inactive_vals": true,
+                "prioritylist": []
             }
         }
     ],