feat: New IBCv2 msg handler

Author: kulikthebird

app/app.go

@@ -593,6 +593,7 @@ func NewWasmApp(
 		app.StakingKeeper,
 		distrkeeper.NewQuerier(app.DistrKeeper),
 		app.IBCKeeper.ChannelKeeper,
+		app.IBCKeeper.ChannelKeeperV2,
 		app.IBCKeeper.ChannelKeeper,
 		app.TransferKeeper,
 		app.MsgServiceRouter(),

go.mod

@@ -3,7 +3,7 @@ module github.com/CosmWasm/wasmd
 go 1.23.6
 
 require (
-	github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250311142732-2684ad434449
+	github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250328101044-d6dfa29f9935
 	github.com/cosmos/cosmos-proto v1.0.0-beta.5
 	github.com/cosmos/cosmos-sdk v0.50.12
 	github.com/cosmos/gogogateway v1.2.0 // indirect

go.sum

@@ -229,6 +229,12 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
 github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250311142732-2684ad434449 h1:7dFOzheG+3HatTz/OmbPaudVCweJMz0dn2+8/eQPMcw=
 github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250311142732-2684ad434449/go.mod h1:bMhLQL4Yp9CzJi9A83aR7VO9wockOsSlZbT4ztOl6bg=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250327151355-f5074f3c7b15 h1:mxr3yBBey5G3nbQ4iKnhGge92G0uZ8Z9roUJY31XI6I=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250327151355-f5074f3c7b15/go.mod h1:bMhLQL4Yp9CzJi9A83aR7VO9wockOsSlZbT4ztOl6bg=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250328082303-e8348960e65e h1:hFK2GkaUr03fPPENn6xf8cH2wa35wSvqDeKEJoulMfM=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250328082303-e8348960e65e/go.mod h1:bMhLQL4Yp9CzJi9A83aR7VO9wockOsSlZbT4ztOl6bg=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250328101044-d6dfa29f9935 h1:Vcn1k7PUiV1wyz+d1aEZEVQfbwzPO3B8DA6rnE5bhok=
+github.com/CosmWasm/wasmvm/v2 v2.2.2-0.20250328101044-d6dfa29f9935/go.mod h1:bMhLQL4Yp9CzJi9A83aR7VO9wockOsSlZbT4ztOl6bg=
 github.com/DataDog/datadog-go v3.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
 github.com/DataDog/datadog-go v4.8.3+incompatible h1:fNGaYSuObuQb5nzeTQqowRAd9bpDIRRV4/gUtIBjh8Q=
 github.com/DataDog/datadog-go v4.8.3+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=

tests/e2e/ibc2_test.go

@@ -1,6 +1,7 @@
 package e2e_test
 
 import (
+	"encoding/json"
 	"testing"
 
 	ibctransfertypes "github.com/cosmos/ibc-go/v10/modules/apps/transfer/types"
@@ -21,6 +22,14 @@ type QueryMsg struct {
 // ibc2 contract response type
 type State struct {
 	IBC2PacketReceiveCounter uint32 `json:"ibc2_packet_receive_counter"`
+	LastChannelID            string `json:"last_channel_id"`
+	LastPacketSeq            uint64 `json:"last_packet_seq"`
+}
+
+// Message sent to the ibc2 contract over IBCv2 channel
+type IbcPayload struct {
+	ResponseWithoutAck     bool `json:"response_without_ack"`
+	SendAsyncAckForPrevMsg bool `json:"send_async_ack_for_prev_msg"`
 }
 
 func TestIBC2ReceiveEntrypoint(t *testing.T) {
@@ -53,7 +62,10 @@ func TestIBC2ReceiveEntrypoint(t *testing.T) {
 
 	var err error
 	timeoutTimestamp := chainA.GetTimeoutTimestampSecs()
-	packet, err := path.EndpointB.MsgSendPacket(timeoutTimestamp, mockv2.NewMockPayload(contractPortB, contractPortA))
+	payload := mockv2.NewMockPayload(contractPortB, contractPortA)
+	payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: true})
+	require.NoError(t, err)
+	packet, err := path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
 	require.NoError(t, err)
 	err = path.EndpointA.MsgRecvPacket(packet)
 	require.NoError(t, err)
@@ -62,4 +74,15 @@ func TestIBC2ReceiveEntrypoint(t *testing.T) {
 	err = chainA.SmartQuery(contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
 	require.NoError(t, err)
 	require.Equal(t, uint32(1), response.IBC2PacketReceiveCounter)
+
+	timeoutTimestamp = chainA.GetTimeoutTimestampSecs()
+	payload = mockv2.NewMockPayload(contractPortB, contractPortA)
+	payload.Value, err = json.Marshal(IbcPayload{SendAsyncAckForPrevMsg: true})
+	require.NoError(t, err)
+	packet, err = path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
+	require.NoError(t, err)
+	err = path.EndpointA.MsgRecvPacket(packet)
+	require.NoError(t, err)
+
+	// TODO tkulik: We need https://github.com/CosmWasm/wasmd/issues/2171 in order to properly test receiving async ACKs
 }

tests/e2e/testdata/ibc2.wasm

@@ -695,6 +695,7 @@ func setupKeeper(t *testing.T) (*Keeper, sdk.Context) {
 		nil,
 		nil,
 		nil,
+		nil,
 		tempDir,
 		nodeConfig,
 		wasmtypes.VMConfig{},

x/wasm/keeper/genesis_test.go

@@ -15,6 +15,7 @@ import (
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 
 	"github.com/CosmWasm/wasmd/x/wasm/types"
+	channelv2types "github.com/cosmos/ibc-go/v10/modules/core/04-channel/v2/types"
 )
 
 // msgEncoder is an extension point to customize encodings
@@ -40,6 +41,7 @@ func NewDefaultMessageHandler(
 	keeper *Keeper,
 	router MessageRouter,
 	ics4Wrapper types.ICS4Wrapper,
+	ics4v2Wrapper types.ICS4v2Wrapper,
 	channelKeeper types.ChannelKeeper,
 	bankKeeper types.Burner,
 	cdc codec.Codec,
@@ -53,6 +55,7 @@ func NewDefaultMessageHandler(
 	return NewMessageHandlerChain(
 		NewSDKMessageHandler(cdc, router, encoders),
 		NewIBCRawPacketHandler(ics4Wrapper, keeper, channelKeeper),
+		NewIBC2RawPacketHandler(ics4v2Wrapper),
 		NewBurnCoinMessageHandler(bankKeeper),
 	)
 }
@@ -261,6 +264,58 @@ func (h IBCRawPacketHandler) DispatchMsg(ctx sdk.Context, _ sdk.AccAddress, cont
 	}
 }
 
+// IBC2RawPacketHandler handles IBC2Msg received from CosmWasm.
+type IBC2RawPacketHandler struct {
+	ics4v2Wrapper types.ICS4v2Wrapper
+}
+
+// NewIBCRawPacketHandler constructor
+func NewIBC2RawPacketHandler(ics4v2Wrapper types.ICS4v2Wrapper) IBC2RawPacketHandler {
+	return IBC2RawPacketHandler{
+		ics4v2Wrapper: ics4v2Wrapper,
+	}
+}
+
+// DispatchMsg publishes a raw IBC packet onto the channel.
+func (h IBC2RawPacketHandler) DispatchMsg(ctx sdk.Context, _ sdk.AccAddress, contractIBCPortID string, msg wasmvmtypes.CosmosMsg) ([]sdk.Event, [][]byte, [][]*codectypes.Any, error) {
+	if msg.IBC2 == nil {
+		return nil, nil, nil, types.ErrUnknownMsg
+	}
+	msgIBC2 := msg.IBC2
+	switch {
+	case msgIBC2.WriteAcknowledgement != nil:
+		packet := msgIBC2.WriteAcknowledgement
+		if contractIBCPortID == "" {
+			return nil, nil, nil, errorsmod.Wrapf(types.ErrUnsupportedForContract, "ibc not supported")
+		}
+		contractIBCChannelID := msgIBC2.WriteAcknowledgement.ChannelID
+		if contractIBCChannelID == "" {
+			return nil, nil, nil, errorsmod.Wrapf(types.ErrEmpty, "ibc channel")
+		}
+
+		err := h.ics4v2Wrapper.WriteAcknowledgement(ctx, packet.ChannelID, packet.PacketSequence, channelv2types.Acknowledgement{AppAcknowledgements: [][]byte{msgIBC2.WriteAcknowledgement.Ack.Data}})
+		if err != nil {
+			return nil, nil, nil, errorsmod.Wrap(err, "acknowledgement")
+		}
+
+		resp := &types.MsgIBCWriteAcknowledgementResponse{}
+		val, err := resp.Marshal()
+		if err != nil {
+			return nil, nil, nil, errorsmod.Wrap(err, "failed to marshal IBC send response")
+		}
+
+		any, err := codectypes.NewAnyWithValue(resp)
+		if err != nil {
+			return nil, nil, nil, errorsmod.Wrap(err, "failed to convert IBC send response to Any")
+		}
+		msgResponses := [][]*codectypes.Any{{any}}
+
+		return nil, [][]byte{val}, msgResponses, nil
+	default:
+		return nil, nil, nil, types.ErrUnknownMsg
+	}
+}
+
 var _ Messenger = MessageHandlerFunc(nil)
 
 // MessageHandlerFunc is a helper to construct a function based message handler.

x/wasm/keeper/handler_plugin.go

@@ -52,7 +52,7 @@ func (module IBC2Handler) OnRecvPacket(
 	}
 
 	em := sdk.NewEventManager()
-	msg := wasmvmtypes.IBC2PacketReceiveMsg{Payload: newIBC2Payload(payload), Relayer: relayer.String(), SourceClient: sourceClient}
+	msg := wasmvmtypes.IBC2PacketReceiveMsg{Payload: newIBC2Payload(payload), Relayer: relayer.String(), SourceClient: sourceClient, PacketSequence: sequence}
 
 	ack := module.keeper.OnRecvIBC2Packet(ctx.WithEventManager(em), contractAddr, msg)
 
@@ -133,7 +133,7 @@ func (k Keeper) OnRecvIBC2Packet(
 	}
 
 	// note submessage reply results can overwrite the `Acknowledgement` data
-	data, err := k.handleContractResponse(ctx, contractAddr, contractInfo.IBCPortID, res.Ok.Messages, res.Ok.Attributes, res.Ok.Acknowledgement, res.Ok.Events)
+	data, err := k.handleContractResponse(ctx, contractAddr, contractInfo.IBC2PortID, res.Ok.Messages, res.Ok.Attributes, res.Ok.Acknowledgement, res.Ok.Events)
 	if err != nil {
 		// submessage errors result in error ACK with state reverted. Error message is redacted
 		return channeltypesv2.RecvPacketResult{
@@ -143,16 +143,6 @@ func (k Keeper) OnRecvIBC2Packet(
 	}
 
 	if data == nil {
-		// In case of lack of ack, we assume that the packet should
-		// be handled asynchronously.
-		// TODO: https://github.com/CosmWasm/wasmd/issues/2161
-		// err = k.StoreAsyncAckPacket(ctx, convertPacket(msg.Payload))
-		// if err != nil {
-		// 	return channeltypesv2.RecvPacketResult{
-		// 		Status:          channeltypesv2.PacketStatus_Failure,
-		// 		Acknowledgement: []byte(err.Error()),
-		// 	}
-		// }
 		return channeltypesv2.RecvPacketResult{
 			Status: channeltypesv2.PacketStatus_Async,
 		}

x/wasm/keeper/ibc2.go

@@ -27,6 +27,7 @@ func NewKeeper(
 	stakingKeeper types.StakingKeeper,
 	distrKeeper types.DistributionKeeper,
 	ics4Wrapper types.ICS4Wrapper,
+	ics4v2Wrapper types.ICS4v2Wrapper,
 	channelKeeper types.ChannelKeeper,
 	portSource types.ICS20TransferPortSource,
 	router MessageRouter,
@@ -60,7 +61,7 @@ func NewKeeper(
 		wasmLimits:  vmConfig.WasmLimits,
 		ibcRouterV2: ibcRouterV2,
 	}
-	keeper.messenger = NewDefaultMessageHandler(keeper, router, ics4Wrapper, channelKeeper, bankKeeper, cdc, portSource)
+	keeper.messenger = NewDefaultMessageHandler(keeper, router, ics4Wrapper, ics4v2Wrapper, channelKeeper, bankKeeper, cdc, portSource)
 	keeper.wasmVMQueryHandler = DefaultQueryPlugins(bankKeeper, stakingKeeper, distrKeeper, channelKeeper, keeper)
 	preOpts, postOpts := splitOpts(opts)
 	for _, o := range preOpts {

x/wasm/keeper/keeper_cgo.go

@@ -848,7 +848,7 @@ func TestInstantiateWithContractFactoryChildQueriesParent(t *testing.T) {
 	router := baseapp.NewMsgServiceRouter()
 	router.SetInterfaceRegistry(keepers.EncodingConfig.InterfaceRegistry)
 	types.RegisterMsgServer(router, NewMsgServerImpl(keeper))
-	keeper.messenger = NewDefaultMessageHandler(nil, router, nil, nil, nil, keepers.EncodingConfig.Codec, nil)
+	keeper.messenger = NewDefaultMessageHandler(nil, router, nil, nil, nil, nil, keepers.EncodingConfig.Codec, nil)
 	// overwrite wasmvm in response handler
 	keeper.wasmVMResponseHandler = NewDefaultWasmVMContractResponseHandler(NewMessageDispatcher(keeper.messenger, keeper))
 

x/wasm/keeper/keeper_test.go

@@ -155,7 +155,7 @@ func TestConstructorOptions(t *testing.T) {
 			opt := spec.srcOpt
 			_, gotPostOptMarker := opt.(postOptsFn)
 			require.Equal(t, spec.isPostOpt, gotPostOptMarker)
-			k := NewKeeper(codec, runtime.NewKVStoreService(storeKey), authkeeper.AccountKeeper{}, &bankkeeper.BaseKeeper{}, stakingkeeper.Keeper{}, nil, nil, nil, nil, nil, nil, tempDir, types.DefaultNodeConfig(), types.VMConfig{}, AvailableCapabilities, "", nil, spec.srcOpt)
+			k := NewKeeper(codec, runtime.NewKVStoreService(storeKey), authkeeper.AccountKeeper{}, &bankkeeper.BaseKeeper{}, stakingkeeper.Keeper{}, nil, nil, nil, nil, nil, nil, nil, tempDir, types.DefaultNodeConfig(), types.VMConfig{}, AvailableCapabilities, "", nil, spec.srcOpt)
 			spec.verify(t, k)
 		})
 	}

x/wasm/keeper/options_test.go

@@ -377,7 +377,8 @@ func createTestInput(
 		bankKeeper,
 		stakingKeeper,
 		distributionkeeper.NewQuerier(distKeeper),
-		ibcKeeper.ChannelKeeper, // ICS4Wrapper
+		ibcKeeper.ChannelKeeper,   // ICS4Wrapper
+		ibcKeeper.ChannelKeeperV2, // ICS4WrapperV2
 		ibcKeeper.ChannelKeeper,
 		wasmtesting.MockIBCTransferKeeper{},
 		msgRouter,

x/wasm/keeper/test_common.go

@@ -12,6 +12,7 @@ import (
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	channelv2types "github.com/cosmos/ibc-go/v10/modules/core/04-channel/v2/types"
 )
 
 // BankViewKeeper defines a subset of methods implemented by the cosmos-sdk bank keeper
@@ -88,9 +89,6 @@ type ChannelKeeper interface {
 // The interface is implemented by the channel keeper on the lowest level in ibc-go. Middlewares or other abstractions
 // can add functionality on top of it. See ics4Wrapper in ibc-go.
 // It is important to choose the right implementation that is configured for any middleware used in the ibc-stack of wasm.
-//
-// For example, when ics-29 fee middleware is set up for the wasm ibc-stack, then the IBCFeeKeeper should be used, so
-// that they are in sync.
 type ICS4Wrapper interface {
 	// SendPacket is called by a module in order to send an IBC packet on a channel.
 	// The packet sequence generated for the packet to be sent is returned. An error
@@ -111,6 +109,19 @@ type ICS4Wrapper interface {
 	) error
 }
 
+// ICS4Wrapper defines the method for an IBC data package to be submitted.
+// The interface is implemented by the channel keeper on the lowest level in ibc-go. Middlewares or other abstractions
+// can add functionality on top of it. See ics4Wrapper in ibc-go.
+// It is important to choose the right implementation that is configured for any middleware used in the ibc-stack of wasm.
+type ICS4v2Wrapper interface {
+	WriteAcknowledgement(
+		ctx sdk.Context,
+		clientID string,
+		sequence uint64,
+		ack channelv2types.Acknowledgement,
+	) error
+}
+
 // ClientKeeper defines the expected IBC client keeper
 type ClientKeeper interface {
 	GetClientConsensusState(ctx sdk.Context, clientID string) (connection ibcexported.ConsensusState, found bool)