[FEAT] ICS20-V2 Path Forwarding

CHANGELOG.md

@@ -73,6 +73,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Features
 
 * (apps/transfer) [\#6492](https://github.com/cosmos/ibc-go/pull/6492) Added new `Tokens` field to `MsgTransfer` to enable sending of multiple denoms, and deprecated the `Token` field.
+* (apps/transfer) [\#6693](https://github.com/cosmos/ibc-go/pull/6693) Added new `Forwarding` field to `MsgTransfer` to enable forwarding tokens through multiple intermediary chains with a single transaction. This also enables automatic unwinding of tokens to their native chain. `x/authz` support for transfer allows granters to specify a set of possible forwarding hops that are allowed for grantees.
 
 ### Bug Fixes
 

e2e/tests/core/03-connection/connection_test.go

@@ -34,7 +34,7 @@ type ConnectionTestSuite struct {
 }
 
 func (s *ConnectionTestSuite) SetupTest() {
-	s.SetupPath(ibc.DefaultClientOpts(), s.TransferChannelOptions())
+	s.SetupPaths(ibc.DefaultClientOpts(), s.TransferChannelOptions())
 }
 
 // QueryMaxExpectedTimePerBlockParam queries the on-chain max expected time per block param for 03-connection

e2e/tests/transfer/authz_test.go

@@ -33,7 +33,7 @@ type AuthzTransferTestSuite struct {
 }
 
 func (suite *AuthzTransferTestSuite) SetupTest() {
-	suite.SetupPath(ibc.DefaultClientOpts(), suite.TransferChannelOptions())
+	suite.SetupPaths(ibc.DefaultClientOpts(), suite.TransferChannelOptions())
 }
 
 // QueryGranterGrants returns all GrantAuthorizations for the given granterAddress.
@@ -131,6 +131,7 @@ func (suite *AuthzTransferTestSuite) TestAuthz_MsgTransfer_Succeeds() {
 			suite.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 
 		protoAny, err := codectypes.NewAnyWithValue(transferMsg)
@@ -191,6 +192,7 @@ func (suite *AuthzTransferTestSuite) TestAuthz_MsgTransfer_Succeeds() {
 			suite.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 
 		protoAny, err := codectypes.NewAnyWithValue(transferMsg)
@@ -274,6 +276,7 @@ func (suite *AuthzTransferTestSuite) TestAuthz_InvalidTransferAuthorizations() {
 				suite.GetTimeoutHeight(ctx, chainB),
 				0,
 				"",
+				transfertypes.Forwarding{},
 			)
 
 			protoAny, err := codectypes.NewAnyWithValue(transferMsg)
@@ -334,6 +337,7 @@ func (suite *AuthzTransferTestSuite) TestAuthz_InvalidTransferAuthorizations() {
 				suite.GetTimeoutHeight(ctx, chainB),
 				0,
 				"",
+				transfertypes.Forwarding{},
 			)
 
 			protoAny, err := codectypes.NewAnyWithValue(transferMsg)

e2e/tests/transfer/base_test.go

@@ -34,7 +34,7 @@ type TransferTestSuite struct {
 }
 
 func (s *TransferTestSuite) SetupTest() {
-	s.SetupPath(ibc.DefaultClientOpts(), s.TransferChannelOptions())
+	s.SetupPaths(ibc.DefaultClientOpts(), s.TransferChannelOptions())
 }
 
 // QueryTransferParams queries the on-chain send enabled param for the transfer module

e2e/tests/transfer/forwarding_test.go

@@ -5,12 +5,16 @@ package transfer
 import (
 	"context"
 	"testing"
+	"time"
 
+	"github.com/strangelove-ventures/interchaintest/v8/ibc"
 	testifysuite "github.com/stretchr/testify/suite"
 
 	"github.com/cosmos/ibc-go/e2e/testsuite"
 	"github.com/cosmos/ibc-go/e2e/testsuite/query"
 	"github.com/cosmos/ibc-go/e2e/testvalues"
+	transfertypes "github.com/cosmos/ibc-go/v8/modules/apps/transfer/types"
+	clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
 )
 
 func TestTransferForwardingTestSuite(t *testing.T) {
@@ -26,72 +30,67 @@ func (s *TransferForwardingTestSuite) SetupSuite() {
 	s.SetupChains(context.TODO(), nil, testsuite.ThreeChainSetup())
 }
 
-// TODO: replace this with actual tests https://github.com/cosmos/ibc-go/issues/6578
-// this test verifies that three chains can be set up, and the relayer will relay
-// packets between them as configured in the newInterchain function.
-func (s *TransferForwardingTestSuite) TestThreeChainSetup() {
+// TestForwarding_WithLastChainBeingICS20v1_Succeeds tests the case where a token is forwarded and successfully
+// received on a destination chain that is on ics20-v1 version.
+func (s *TransferForwardingTestSuite) TestForwarding_WithLastChainBeingICS20v1_Succeeds() {
 	ctx := context.TODO()
 	t := s.T()
 
 	relayer, chains := s.GetRelayer(), s.GetAllChains()
 
 	chainA, chainB, chainC := chains[0], chains[1], chains[2]
 
-	chainAChannels, err := relayer.GetChannels(ctx, s.GetRelayerExecReporter(), chainA.Config().ChainID)
-	s.Require().NoError(err)
-	chainBChannels, err := relayer.GetChannels(ctx, s.GetRelayerExecReporter(), chainB.Config().ChainID)
-	s.Require().NoError(err)
-	chainCChannels, err := relayer.GetChannels(ctx, s.GetRelayerExecReporter(), chainC.Config().ChainID)
-	s.Require().NoError(err)
+	channelAtoB := s.GetChainAChannel()
 
-	s.Require().Len(chainAChannels, 1, "expected 1 channels on chain A")
-	s.Require().Len(chainBChannels, 2, "expected 2 channels on chain B")
-	s.Require().Len(chainCChannels, 1, "expected 1 channels on chain C")
-
-	channelAToB := chainAChannels[0]
-	channelBToC := chainBChannels[1]
+	// Creating a new path between chain B and chain C with a ICS20-v1 channel
+	opts := s.TransferChannelOptions()
+	opts.Version = transfertypes.V1
+	channelBtoC, _ := s.CreatePath(ctx, chainB, chainC, ibc.DefaultClientOpts(), opts)
+	s.Require().Equal(transfertypes.V1, channelBtoC.Version, "the channel version is not ics20-1")
 
 	chainAWallet := s.CreateUserOnChainA(ctx, testvalues.StartingTokenAmount)
 	chainAAddress := chainAWallet.FormattedAddress()
 	chainADenom := chainA.Config().Denom
 
-	chainBWallet := s.CreateUserOnChainB(ctx, testvalues.StartingTokenAmount)
-	chainBAddress := chainBWallet.FormattedAddress()
-	chainBDenom := chainB.Config().Denom
-
 	chainCWallet := s.CreateUserOnChainC(ctx, testvalues.StartingTokenAmount)
 	chainCAddress := chainCWallet.FormattedAddress()
 
-	t.Run("IBC transfer from A to B", func(t *testing.T) {
-		transferTxResp := s.Transfer(ctx, chainA, chainAWallet, channelAToB.PortID, channelAToB.ChannelID, testvalues.DefaultTransferCoins(chainADenom), chainAAddress, chainBAddress, s.GetTimeoutHeight(ctx, chainB), 0, "")
-		s.AssertTxSuccess(transferTxResp)
-	})
-
-	t.Run("IBC transfer from B to C", func(t *testing.T) {
-		transferTxResp := s.Transfer(ctx, chainB, chainBWallet, channelBToC.PortID, channelBToC.ChannelID, testvalues.DefaultTransferCoins(chainBDenom), chainBAddress, chainCAddress, s.GetTimeoutHeight(ctx, chainC), 0, "")
-		s.AssertTxSuccess(transferTxResp)
+	t.Run("IBC transfer from A to C with forwarding through B", func(t *testing.T) {
+		inFiveMinutes := time.Now().Add(5 * time.Minute).UnixNano()
+		forwarding := transfertypes.NewForwarding(false, transfertypes.Hop{
+			PortId:    channelBtoC.PortID,
+			ChannelId: channelBtoC.ChannelID,
+		})
+
+		msgTransfer := testsuite.GetMsgTransfer(
+			channelAtoB.PortID,
+			channelAtoB.ChannelID,
+			transfertypes.V2,
+			testvalues.DefaultTransferCoins(chainADenom),
+			chainAAddress,
+			chainCAddress,
+			clienttypes.ZeroHeight(),
+			uint64(inFiveMinutes),
+			"",
+			forwarding)
+		resp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgTransfer)
+		s.AssertTxSuccess(resp)
 	})
 
 	t.Run("start relayer", func(t *testing.T) {
 		s.StartRelayer(relayer)
 	})
 
-	chainBIBCToken := testsuite.GetIBCToken(chainADenom, channelAToB.Counterparty.PortID, channelAToB.Counterparty.ChannelID)
-	t.Run("packets are relayed from A to B", func(t *testing.T) {
-		s.AssertPacketRelayed(ctx, chainA, channelAToB.PortID, channelAToB.ChannelID, 1)
-
-		actualBalance, err := query.Balance(ctx, chainB, chainBAddress, chainBIBCToken.IBCDenom())
-		s.Require().NoError(err)
-
-		expected := testvalues.IBCTransferAmount
-		s.Require().Equal(expected, actualBalance.Int64())
-	})
+	t.Run("packets are relayed from A to B to C", func(t *testing.T) {
+		chainCDenom := transfertypes.NewDenom(chainADenom,
+			transfertypes.NewTrace(channelBtoC.Counterparty.PortID, channelBtoC.Counterparty.ChannelID),
+			transfertypes.NewTrace(channelAtoB.Counterparty.PortID, channelAtoB.Counterparty.ChannelID),
+		)
 
-	chainCIBCToken := testsuite.GetIBCToken(chainBDenom, channelBToC.Counterparty.PortID, channelBToC.Counterparty.ChannelID)
-	t.Run("packets are relayed from B to C", func(t *testing.T) {
-		s.AssertPacketRelayed(ctx, chainB, channelBToC.PortID, channelBToC.ChannelID, 1)
+		s.AssertPacketRelayed(ctx, chainA, channelAtoB.PortID, channelAtoB.ChannelID, 1)
+		s.AssertPacketRelayed(ctx, chainB, channelBtoC.PortID, channelBtoC.ChannelID, 1)
 
-		actualBalance, err := query.Balance(ctx, chainC, chainCAddress, chainCIBCToken.IBCDenom())
+		actualBalance, err := query.Balance(ctx, chainC, chainCAddress, chainCDenom.IBCDenom())
 		s.Require().NoError(err)
 
 		expected := testvalues.IBCTransferAmount

e2e/tests/transfer/incentivized_test.go

@@ -20,6 +20,7 @@ import (
 	"github.com/cosmos/ibc-go/e2e/testsuite/query"
 	"github.com/cosmos/ibc-go/e2e/testvalues"
 	feetypes "github.com/cosmos/ibc-go/v8/modules/apps/29-fee/types"
+	transfertypes "github.com/cosmos/ibc-go/v8/modules/apps/transfer/types"
 	channeltypes "github.com/cosmos/ibc-go/v8/modules/core/04-channel/types"
 )
 
@@ -38,7 +39,7 @@ func TestIncentivizedTransferTestSuite(t *testing.T) {
 
 // SetupTest explicitly enables fee middleware in the channel options.
 func (s *IncentivizedTransferTestSuite) SetupTest() {
-	s.SetupPath(ibc.DefaultClientOpts(), s.FeeTransferChannelOptions())
+	s.SetupPaths(ibc.DefaultClientOpts(), s.FeeTransferChannelOptions())
 }
 
 func (s *IncentivizedTransferTestSuite) TestMsgPayPacketFee_AsyncSingleSender_Succeeds() {
@@ -216,6 +217,7 @@ func (s *IncentivizedTransferTestSuite) TestMsgPayPacketFee_InvalidReceiverAccou
 			s.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 		txResp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgTransfer)
 		// this message should be successful, as receiver account is not validated on the sending chain.
@@ -354,6 +356,7 @@ func (s *IncentivizedTransferTestSuite) TestMultiMsg_MsgPayPacketFeeSingleSender
 		s.GetTimeoutHeight(ctx, chainB),
 		0,
 		"",
+		transfertypes.Forwarding{},
 	)
 	resp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgPayPacketFee, msgTransfer)
 	s.AssertTxSuccess(resp)

e2e/tests/transfer/upgradesv1_test.go

@@ -33,7 +33,7 @@ type TransferChannelUpgradesV1TestSuite struct {
 func (s *TransferChannelUpgradesV1TestSuite) SetupTest() {
 	opts := s.TransferChannelOptions()
 	opts.Version = transfertypes.V1
-	s.SetupPath(ibc.DefaultClientOpts(), opts)
+	s.SetupPaths(ibc.DefaultClientOpts(), opts)
 }
 
 // TestChannelUpgrade_WithICS20v2_Succeeds tests upgrading a transfer channel to ICS20 v2.
@@ -306,6 +306,7 @@ func (s *TransferChannelUpgradesV1TestSuite) TestChannelUpgrade_WithFeeMiddlewar
 			s.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 		resp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgPayPacketFee, msgTransfer)
 		s.AssertTxSuccess(resp)

e2e/tests/transfer/upgradesv2_test.go

@@ -32,7 +32,7 @@ type TransferChannelUpgradesTestSuite struct {
 }
 
 func (s *TransferChannelUpgradesTestSuite) SetupTest() {
-	s.SetupPath(ibc.DefaultClientOpts(), s.TransferChannelOptions())
+	s.SetupPaths(ibc.DefaultClientOpts(), s.TransferChannelOptions())
 }
 
 // TestChannelUpgrade_WithFeeMiddleware_Succeeds tests upgrading a transfer channel to wire up fee middleware
@@ -213,6 +213,7 @@ func (s *TransferChannelUpgradesTestSuite) TestChannelUpgrade_WithFeeMiddleware_
 			s.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 		resp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgPayPacketFee, msgTransfer)
 		s.AssertTxSuccess(resp)

e2e/tests/upgrades/upgrade_test.go

@@ -29,6 +29,7 @@ import (
 	"github.com/cosmos/ibc-go/e2e/testsuite/query"
 	"github.com/cosmos/ibc-go/e2e/testvalues"
 	feetypes "github.com/cosmos/ibc-go/v8/modules/apps/29-fee/types"
+	transfertypes "github.com/cosmos/ibc-go/v8/modules/apps/transfer/types"
 	v7migrations "github.com/cosmos/ibc-go/v8/modules/core/02-client/migrations/v7"
 	clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
 	connectiontypes "github.com/cosmos/ibc-go/v8/modules/core/03-connection/types"
@@ -62,7 +63,7 @@ func (s *UpgradeTestSuite) SetupTest() {
 	if strings.HasSuffix(s.T().Name(), "TestV8ToV8_1ChainUpgrade") {
 		channelOpts = s.FeeTransferChannelOptions()
 	}
-	s.SetupPath(ibc.DefaultClientOpts(), channelOpts)
+	s.SetupPaths(ibc.DefaultClientOpts(), channelOpts)
 }
 
 // UpgradeChain upgrades a chain to a specific version using the planName provided.
@@ -978,6 +979,7 @@ func (s *UpgradeTestSuite) TestV8ToV8_1ChainUpgrade_ChannelUpgrades() {
 			s.GetTimeoutHeight(ctx, chainB),
 			0,
 			"",
+			transfertypes.Forwarding{},
 		)
 		resp := s.BroadcastMessages(ctx, chainA, chainAWallet, msgPayPacketFee, msgTransfer)
 		s.AssertTxSuccess(resp)

e2e/tests/wasm/grandpa_test.go

@@ -154,7 +154,7 @@ func (s *GrandpaTestSuite) SetupTest() {
 
 	channelOpts := ibc.DefaultChannelOpts()
 	channelOpts.Version = transfertypes.V1
-	s.SetupPath(ibc.DefaultClientOpts(), channelOpts)
+	s.SetupPaths(ibc.DefaultClientOpts(), channelOpts)
 }
 
 // TestMsgTransfer_Succeeds_GrandpaContract features