Merge branch 'main' into carlos/update-middleware-docs

cosmos · Jul 14, 2022 · ab3ed9e · ab3ed9e
2 parents 3522c5e + e8dd1a8
commit ab3ed9e
Show file tree

Hide file tree

Showing 31 changed files with 420 additions and 656 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -18,8 +18,8 @@
 
 ## CODEOWNERS for core/02-client
 
-/modules/core/02-client @seantking @damiannolan
-/proto/ibc/core/client @seantking @damiannolan
+/modules/core/02-client @colin-axner @fedekunze @AdityaSripal @seantking @damiannolan
+/proto/ibc/core/client @colin-axner @fedekunze @AdityaSripal @seantking @damiannolan
 
 # CODEOWNERS for the light-clients
 

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -20,6 +20,10 @@ through the appropriate channels won't receive any bounty.
 
 <!-- Concisely describe the issue -->
 
+## Expected Behaviour
+
+<!-- What is the expected behaviour? -->
+
 ## Version
 
 <!-- git commit hash or release version -->

diff --git a/.github/scripts/determine_simd_tag.go b/.github/scripts/determine_simd_tag.go
@@ -0,0 +1,34 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+)
+
+var prNum int
+var ref string
+
+func init() {
+	flag.IntVar(&prNum, "pr", 0, "the number of the pr")
+	flag.StringVar(&ref, "ref", "", "the github ref")
+	flag.Parse()
+}
+
+// in the context of a GithubAction workflow, the PR is the event number. So if the ref is not specified
+// but the event number is, that means we are running for a PR. If the ref is specified, this means
+// we have merged the PR, so we want to use the ref as a tag instead of the PR number.
+func main() {
+	if prNum == 0 && ref == "" {
+		fmt.Printf("must specify one or bot of [pr, ref]")
+		os.Exit(1)
+	}
+	fmt.Printf(getSimdTag(prNum, ref))
+}
+
+func getSimdTag(prNum int, ref string) string {
+	if ref != "" {
+		return ref
+	}
+	return fmt.Sprintf("pr-%d", prNum)
+}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,6 +6,11 @@ on:
   push:
     branches:
       - main
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ibc-go-simd-e2e
+
 jobs:
   cleanup-runs:
     runs-on: ubuntu-latest
@@ -51,13 +56,6 @@ jobs:
       - name: Build
         run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false make build
 
-  docker-build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Docker Build
-        run: docker build . --no-cache
-
   split-test-files:
     runs-on: ubuntu-latest
     steps:
@@ -108,7 +106,7 @@ jobs:
         if: env.GIT_DIFF
       - name: test & coverage report creation
         run: |
-          cat pkgs.txt.part.${{ matrix.part }} | xargs go test -race -mod=readonly -timeout 30m -coverprofile=${{ matrix.part }}profile.out -covermode=atomic -tags='ledger test_ledger_mock'
+          cat pkgs.txt.part.${{ matrix.part }} | xargs go test $(go list ./... | grep -v e2e) -race -mod=readonly -timeout 30m -coverprofile=${{ matrix.part }}profile.out -covermode=atomic -tags='ledger test_ledger_mock'
         if: env.GIT_DIFF
       - uses: actions/upload-artifact@v3
         with:
@@ -161,3 +159,86 @@ jobs:
         with:
           file: ./coverage.txt
         if: env.GIT_DIFF
+
+
+  docker-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Log in to the Container registry
+        uses: docker/login-action@49ed152c8eca782a232dede0303416e8f356c37b
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@69f6fc9d46f2f8bf0d5491e4aabe0bb8c6a4678a
+        with:
+          images: ${{ env.REGISTRY }}/cosmos/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@e551b19e49efd4e98792db7592c17c09b89db8d8
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+
+  # dynamically build a matrix of test/test suite pairs to run
+  build-test-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+      - id: set-matrix
+        run: echo "::set-output name=matrix::$(go run .github/scripts/build_test_matrix.go)"
+
+
+  # the tag of the image will differ if this is a PR or the branch is being merged into main.
+  # we store the tag as an environment variable and use it in the E2E tests to determine the tag.
+  determine-image-tag:
+    runs-on: ubuntu-latest
+    outputs:
+      simd-tag: ${{ steps.get-tag.outputs.simd-tag }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+      - id: get-tag
+        run: |
+          tag=$(go run .github/scripts/determine_simd_tag.go -ref "${{ github.event.push.ref }}" -pr "${{ github.event.pull_request.number }}" )
+          echo "Using tag $tag"
+          echo "::set-output name=simd-tag::$tag"
+
+
+  e2e:
+    runs-on: ubuntu-latest
+    needs:
+      - build-test-matrix
+      - determine-image-tag
+      - docker-build
+    env:
+      SIMD_TAG: ${{ needs.determine-image-tag.outputs.simd-tag }}
+      SIMD_IMAGE: ghcr.io/cosmos/ibc-go-simd-e2e
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJSON(needs.build-test-matrix.outputs.matrix) }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Log in to the Container registry
+        uses: docker/login-action@49ed152c8eca782a232dede0303416e8f356c37b
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run e2e Test
+        run: |
+          make e2e-test suite=${{ matrix.suite }} test=${{ matrix.test }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### API Breaking
 
+* (modules/core/03-connection) [\#1672](https://github.com/cosmos/ibc-go/pull/1672) Remove crossing hellos from connection handshakes. The `PreviousConnectionId` in `MsgConnectionOpenTry` has been deprecated.
+* (modules/core/04-channel) [\#1317](https://github.com/cosmos/ibc-go/pull/1317) Remove crossing hellos from channel handshakes. The `PreviousChannelId` in `MsgChannelOpenTry` has been deprecated.  
 * (transfer) [\#1250](https://github.com/cosmos/ibc-go/pull/1250) Deprecate `GetTransferAccount` since the `transfer` module account is never used.
 * (channel) [\#1283](https://github.com/cosmos/ibc-go/pull/1283) The `OnChanOpenInit` application callback now returns a version string in line with the latest [spec changes](https://github.com/cosmos/ibc/pull/629).  
 * (modules/29-fee)[\#1338](https://github.com/cosmos/ibc-go/pull/1338) Renaming `Result` field in `IncentivizedAcknowledgement` to `AppAcknowledgement`.
@@ -62,6 +64,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (modules/core/04-channel) [\#1232](https://github.com/cosmos/ibc-go/pull/1232) Updating params on `NewPacketId` and moving to bottom of file.
 * (app/29-fee) [\#1305](https://github.com/cosmos/ibc-go/pull/1305) Change version string for fee module to `ics29-1`
 * (app/29-fee) [\#1341](https://github.com/cosmos/ibc-go/pull/1341) Check if the fee module is locked and if the fee module is enabled before refunding all fees
+* (transfer) [\#1414](https://github.com/cosmos/ibc-go/pull/1414) Emitting Sender address from `fungible_token_packet` events in `OnRecvPacket` and `OnAcknowledgementPacket`.
 * (testing/simapp) [\#1397](https://github.com/cosmos/ibc-go/pull/1397) Adding mock module to maccperms and adding check to ensure mock module is not a blocked account address. 
 * (core/02-client) [\#1570](https://github.com/cosmos/ibc-go/pull/1570) Emitting an event when handling an upgrade client proposal. 
 

diff --git a/Makefile b/Makefile
@@ -12,6 +12,7 @@ MOCKS_DIR = $(CURDIR)/tests/mocks
 HTTPS_GIT := https://github.com/cosmos/ibc-go.git
 DOCKER := $(shell which docker)
 DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf:1.0.0-rc8
+TEST_CONTAINERS=$(shell docker ps --filter "label=ibc-test" -a -q)
 
 export GO111MODULE = on
 
@@ -324,6 +325,15 @@ benchmark:
 	@go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
 .PHONY: benchmark
 
+cleanup-ibc-test-containers:
+	for id in $(TEST_CONTAINERS) ; do \
+		$(DOCKER) stop $$id ; \
+		$(DOCKER) rm $$id ; \
+	done
+
+e2e-test: cleanup-ibc-test-containers
+	@go test -v ./e2e --run $(suite) -testify.m ^$(test)$$
+
 ###############################################################################
 ###                                Linting                                  ###
 ###############################################################################

diff --git a/docs/ibc/apps.md b/docs/ibc/apps.md
@@ -73,15 +73,9 @@ OnChanOpenTry(
     counterparty channeltypes.Counterparty,
     counterpartyVersion string,
 ) (string, error) {
-    // Module may have already claimed capability in OnChanOpenInit in the case of crossing hellos
-    // (ie chainA and chainB both call ChanOpenInit before one of them calls ChanOpenTry)
-    // If the module can already authenticate the capability then the module already owns it so we don't need to claim
-    // Otherwise, module does not have channel capability and we must claim it from IBC
-    if !k.AuthenticateCapability(ctx, chanCap, host.ChannelCapabilityPath(portID, channelID)) {
-        // Only claim channel capability passed back by IBC module if we do not already own it
-        if err := k.scopedKeeper.ClaimCapability(ctx, chanCap, host.ChannelCapabilityPath(portID, channelID)); err != nil {
-            return err
-        }
+    // OpenTry must claim the channelCapability that IBC passes into the callback
+    if err := k.scopedKeeper.ClaimCapability(ctx, chanCap, host.ChannelCapabilityPath(portID, channelID)); err != nil {
+        return err
     }
 
     // ... do custom initialization logic

diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md
@@ -2949,7 +2949,7 @@ value will be ignored by core IBC.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `port_id` | [string](#string) |  |  |
-| `previous_channel_id` | [string](#string) |  | in the case of crossing hello's, when both chains call OpenInit, we need the channel identifier of the previous channel in state INIT |
+| `previous_channel_id` | [string](#string) |  | **Deprecated.** Deprecated: this field is unused. Crossing hello's are no longer supported in core IBC. |
 | `channel` | [Channel](#ibc.core.channel.v1.Channel) |  | NOTE: the version field within the channel has been deprecated. Its value will be ignored by core IBC. |
 | `counterparty_version` | [string](#string) |  |  |
 | `proof_init` | [bytes](#bytes) |  |  |
@@ -4244,7 +4244,7 @@ connection on Chain B.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `client_id` | [string](#string) |  |  |
-| `previous_connection_id` | [string](#string) |  | in the case of crossing hello's, when both chains call OpenInit, we need the connection identifier of the previous connection in state INIT |
+| `previous_connection_id` | [string](#string) |  | **Deprecated.** Deprecated: this field is unused. Crossing hellos are no longer supported in core IBC. |
 | `client_state` | [google.protobuf.Any](#google.protobuf.Any) |  |  |
 | `counterparty` | [Counterparty](#ibc.core.connection.v1.Counterparty) |  |  |
 | `delay_period` | [uint64](#uint64) |  |  |

diff --git a/docs/migrations/v3-to-v4.md b/docs/migrations/v3-to-v4.md
@@ -18,6 +18,15 @@ No genesis or in-place migrations required when upgrading from v1 or v2 of ibc-g
 
 ## Chains
 
+- No relevant changes were made in this release.
+
+## IBC Apps
+
+### ICS03 - Connection
+
+Crossing hellos have been removed from 03-connection handshake negotiation. 
+`PreviousConnectionId` in `MsgConnectionOpenTry` has been deprecated and is no longer used by core IBC.
+
 ### ICS04 - Channel 
 
 The `WriteAcknowledgement` API now takes the `exported.Acknowledgement` type instead of passing in the acknowledgement byte array directly. 
@@ -30,6 +39,10 @@ The `NewErrorAcknowledgement` method signature has changed.
 It now accepts an `error` rather than a `string`. This was done in order to prevent accidental state changes.
 All error acknowledgements now contain a deterministic ABCI code and error message. It is the responsibility of the application developer to emit error details in events.
 
+Crossing hellos have been removed from 04-channel handshake negotiation. 
+IBC Applications no longer need to account from already claimed capabilities in the `OnChanOpenTry` callback. The capability provided by core IBC must be able to be claimed with error. 
+`PreviousChannelId` in `MsgChannelOpenTry` has been deprecated and is no longer used by core IBC.
+
 ### ICS27 - Interchain Accounts
 
 The `RegisterInterchainAccount` API has been modified to include an additional `version` argument. This change has been made in order to support ICS29 fee middleware, for relayer incentivization of ICS27 packets.
@@ -91,3 +104,5 @@ if err := k.icaControllerKeeper.RegisterInterchainAccount(ctx, msg.ConnectionId,
 ## Relayers
 
 When using the `DenomTrace` gRPC, the full IBC denomination with the `ibc/` prefix may now be passed in.
+
+Crossing hellos are no longer supported by core IBC for 03-connection and 04-channel. The handshake should be completed in the logical 4 step process (INIT, TRY, ACK, CONFIRM).
diff --git a/docs/roadmap/roadmap.md b/docs/roadmap/roadmap.md
@@ -4,55 +4,46 @@ order: 1
 
 # Roadmap ibc-go
 
-_Lastest update: March 31, 2022_
+_Lastest update: July 7, 2022_
 
 This document endeavours to inform the wider IBC community about plans and priorities for work on ibc-go by the team at Interchain GmbH. It is intended to broadly inform all users of ibc-go, including developers and operators of IBC, relayer, chain and wallet applications.
 
 This roadmap should be read as a high-level guide, rather than a commitment to schedules and deliverables. The degree of specificity is inversely proportional to the timeline. We will update this document periodically to reflect the status and plans.
 
-## Q2 - 2022
+## Q3 - 2022
 
 At a high level we will focus on:
 
-- Finishing the implementation of [relayer incentivisation](https://github.com/orgs/cosmos/projects/7/views/8).
-- Finishing the [refactoring of 02-client](https://github.com/cosmos/ibc-go/milestone/16).
-- Finishing the upgrade to Cosmos SDK v0.46 and Tendermint v0.35.
-- Implementing and testing the changes needed to support the [transtion to SMT storage](https://github.com/cosmos/ibc-go/milestone/21) in the Cosmos SDK.
-- Desiging the implementation and scoping the engineering work for [channel upgradability](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics/UPGRADES.md).
-- Improving the project's documentation and writing guides for [light client](https://github.com/cosmos/ibc-go/issues/59) and middleware implementation.
-- Working on [core backlog issues](https://github.com/cosmos/ibc-go/milestone/8).
-- Spending time on expanding and deepening our knowledge of IBC, but also other parts of the Cosmos stack.
-- And last, but not least, onboarding new members to the team.
+- Releasing [v4.0.0](https://github.com/cosmos/ibc-go/milestone/26), which includes the ICS-29 Fee Middleware module.
+- Finishing and releasing the [refactoring of 02-client](https://github.com/cosmos/ibc-go/milestone/16). This refactor will make the development of light clients easier.
+- Finishing and releasing the upgrade to Cosmos SDK v0.46.
+- Starting the implementation of channel upgradability (see [epic](https://github.com/cosmos/ibc-go/issues/1599) and [alpha milestone](https://github.com/cosmos/ibc-go/milestone/29)) with the goal of cutting an alpha1 pre-release by the end of the quarter. Channel upgradability will allow chains to renegotiate an existing channel to take advantage of new features without having to create a new channel, thus preserving all existing packet state processed on the channel.
+- Implementing the new [`ORDERED_ALLOW_TIMEOUT` channel type](https://github.com/cosmos/ibc-go/milestone/31) and hopefully releasing it as well. This new channel type will allow packets on an ordered channel to timeout without causing the closure of the channel.
+- Adding [automated e2e tests](https://github.com/cosmos/ibc-go/milestone/32) to the repo's CI.
+- Writing the [light client implementation guide](https://github.com/cosmos/ibc-go/issues/59).
+- Working on [core backlog issues](https://github.com/cosmos/ibc-go/milestone/28).
+- Depending on the timeline of the Cosmos SDK, implementing and testing the changes needed to support the [transtion to SMT storage](https://github.com/cosmos/ibc-go/milestone/21).
+
+We have also received a lot of feedback to improve Interchain Accounts and we might also work on a few things, but will depend on priorities and availability.
 
 For a detail view of each iteration's planned work, please check out our [project board](https://github.com/orgs/cosmos/projects/7).
 
 ### Release schedule
 
-#### **April**
-
-In the first half of the month we will probably cut:
+#### **July**
 
-- Alpha/beta pre-releases with the upgrade to SDK 0.46 and Tendermint v0.35.
-- [Alpha](https://github.com/cosmos/ibc-go/milestone/5) pre-release with the implementation of relayer incentivisation.
+We will probably cut at least one more release candidate of v4.0.0 before the final release, which should happen around the end of the month. 
 
-In the second half, and depending on the date of the final release of Cosmos SDK 0.46, we will probably cut the final release with the upgrade to SDK 0.46 and Tendermint v0.35, and also a [beta](https://github.com/cosmos/ibc-go/milestone/23) pre-release with the implementation of relayer incentivisation.
+For the Rho upgrade of the Cosmos Hub we will also release a new minor version of v3 with SDK 0.46.
 
-In the second half of the month we also plan to do a second internal audit of the implementation of relayer incentivisation, and issues will most likely will be created from the audit. Depending on the nature and type of the issues we create, those would be released in a second beta pre-release or in a [release candidate](https://github.com/cosmos/ibc-go/milestone/24).
+#### **August**
 
-#### **May**
+In the first half we will probably start cutting release candidates for the 02-client refactor. Final release would most likely come out at the end of the month or beginning of September.
 
-In the first half we will probably start cutting release candidates with relayer incentivisation and the 02-client refactor. Final release would most likely come out at the end of the month or beginning of June.
+#### **September**
 
-#### **June**
+We might cut some pre-releases for the new channel type, and by the end of the month we expect to cut the first alpha pre-release for channel upgradability.
 
-We will probably cut at the end of the month or beginning of Q3 patch or minor releases on all the supported release lines with the [small features and core improvements](https://github.com/cosmos/ibc-go/milestone/8) that we work on during the quarter.
-
-## Q3 - 2022
-
-We will most likely start the implementation of [channel upgradability](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics/UPGRADES.md). At the end of Q2 or maybe beginning of Q3 we might also work on designing the implementation and scoping the engineering work to add support for [ordered channels that can timeout](https://github.com/cosmos/ibc/pull/636), and we could potentially work on this feature also in Q3.
-
-We will also probably do an audit of the implementation of the [CCV application](https://github.com/cosmos/interchain-security/tree/main/x/ccv) for Interchain Security.
-
-### Release schedule
+## Q4 - 2022
 
-In this quarter we will make the final release to support the migration to SMT storage.
+We will continue the implementation and cut the final release of [channel upgradability](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics/UPGRADES.md). At the end of Q3 or maybe beginning of Q4 we might also work on designing the implementation and scoping the engineering work to add support for [multihop channels](https://github.com/cosmos/ibc/pull/741/files), so that we could start the implementation of this feature during Q4 (but this is still be decided).