Skip to content

feat: IBCv2 WriteAcknowledgement handler #2173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged

feat: IBCv2 WriteAcknowledgement handler #2173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
929100b
feat: Async ack support for IBCv2
kulikthebird Mar 18, 2025
3c76cc6
chore: Refactoring
kulikthebird May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,7 @@ func NewWasmApp(
distrkeeper.NewQuerier(app.DistrKeeper),
app.IBCKeeper.ChannelKeeper,
app.IBCKeeper.ChannelKeeper,
app.IBCKeeper.ChannelKeeperV2,
app.TransferKeeper,
app.MsgServiceRouter(),
app.GRPCQueryRouter(),
Expand Down
203 changes: 93 additions & 110 deletions tests/e2e/ibc2_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (
mockv2 "github.com/cosmos/ibc-go/v10/testing/mock/v2"
"github.com/stretchr/testify/require"

sdk "github.com/cosmos/cosmos-sdk/types"

wasmibctesting "github.com/CosmWasm/wasmd/tests/wasmibctesting"
wasmkeeper "github.com/CosmWasm/wasmd/x/wasm/keeper"
)
Expand All @@ -37,7 +39,18 @@ type IbcPayload struct {
SendAsyncAckForPrevMsg bool `json:"send_async_ack_for_prev_msg"`
}

func TestIBC2AckMsg(t *testing.T) {
type TestEnv struct {
contractPortA string
contractPortB string
contractAddrA sdk.AccAddress
contractAddrB sdk.AccAddress
path *wasmibctesting.WasmPath
chainA *wasmibctesting.WasmTestChain
chainB *wasmibctesting.WasmTestChain
coord *ibctesting.Coordinator
}

func setup(t *testing.T) TestEnv {
coord := wasmibctesting.NewCoordinator(t, 2)
chainA := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(1)))
chainB := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(2)))
Expand Down Expand Up @@ -67,80 +80,68 @@ func TestIBC2AckMsg(t *testing.T) {

path.Path.SetupV2()

return TestEnv{
contractPortA: contractPortA,
contractPortB: contractPortB,
contractAddrA: contractAddrA,
contractAddrB: contractAddrB,
path: path,
chainA: chainA,
chainB: chainB,
coord: coord,
}
}

func TestIBC2AckMsg(t *testing.T) {
testEnv := setup(t)

// IBC v2 Payload from contract on Chain B to contract on Chain A
payload := mockv2.NewMockPayload(contractPortB, contractPortA)
payload := mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
var err error
payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: false, SendAsyncAckForPrevMsg: false})
require.NoError(t, err)

// Message timeout
timeoutTimestamp := uint64(chainB.GetContext().BlockTime().Add(time.Minute * 5).Unix())
timeoutTimestamp := uint64(testEnv.chainB.GetContext().BlockTime().Add(time.Minute * 5).Unix())

_, err = path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
_, err = testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)

// First message send through test
err = wasmibctesting.RelayPendingPacketsWithAcksV2(path)
err = wasmibctesting.RelayPendingPacketsWithAcksV2(testEnv.path)
require.NoError(t, err)

// Check if counter was incremented in the recv entry point
var response State

err = chainB.SmartQuery(contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainB.SmartQuery(testEnv.contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(1), response.IBC2PacketAckCounter)
}

func TestIBC2SendReceiveMsg(t *testing.T) {
coord := wasmibctesting.NewCoordinator(t, 2)
chainA := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(1)))
chainB := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(2)))
contractCodeA := chainA.StoreCodeFile("./testdata/ibc2.wasm").CodeID
contractAddrA := chainA.InstantiateContract(contractCodeA, []byte(`{}`))
contractPortA := wasmkeeper.PortIDForContractV2(contractAddrA)
require.NotEmpty(t, contractAddrA)

contractCodeB := chainB.StoreCodeFile("./testdata/ibc2.wasm").CodeID
// Skip initial contract address to not overlap with ChainA
_ = chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractAddrB := chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractPortB := wasmkeeper.PortIDForContractV2(contractAddrB)
require.NotEmpty(t, contractAddrB)

path := wasmibctesting.NewWasmPath(chainA, chainB)
path.EndpointA.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortA,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}
path.EndpointB.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortB,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}

path.Path.SetupV2()
testEnv := setup(t)

// IBC v2 Payload from contract on Chain B to contract on Chain A
payload := mockv2.NewMockPayload(contractPortB, contractPortA)
payload := mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
var err error
payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: false, SendAsyncAckForPrevMsg: false})
require.NoError(t, err)

// Message timeout
timeoutTimestamp := uint64(chainB.GetContext().BlockTime().Add(time.Minute * 5).Unix())
timeoutTimestamp := uint64(testEnv.chainB.GetContext().BlockTime().Add(time.Minute * 5).Unix())

_, err = path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
_, err = testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)

// First message send through test
err = wasmibctesting.RelayPendingPacketsV2(path)
err = wasmibctesting.RelayPendingPacketsV2(testEnv.path)
require.NoError(t, err)

// Check if counter was incremented in the recv entry point
var response State

err = chainA.SmartQuery(contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainA.SmartQuery(testEnv.contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(1), response.IBC2PacketReceiveCounter)

Expand All @@ -149,141 +150,123 @@ func TestIBC2SendReceiveMsg(t *testing.T) {
// pending packets on the other chain is updated with new packet send from the contract.
for i := 1; i <= 100; i++ {
// Relay message sent by contract
err = wasmibctesting.RelayPendingPacketsV2(path)
err = wasmibctesting.RelayPendingPacketsV2(testEnv.path)
require.NoError(t, err)

// Check counter in contract A
err = chainA.SmartQuery(contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainA.SmartQuery(testEnv.contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(i+1), response.IBC2PacketReceiveCounter)

// Check counter in contract B
err = chainB.SmartQuery(contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainB.SmartQuery(testEnv.contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(i), response.IBC2PacketReceiveCounter)
}
}

func TestIBC2TimeoutMsg(t *testing.T) {
coord := wasmibctesting.NewCoordinator(t, 2)
chainA := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(1)))
chainB := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(2)))
contractCodeA := chainA.StoreCodeFile("./testdata/ibc2.wasm").CodeID
contractAddrA := chainA.InstantiateContract(contractCodeA, []byte(`{}`))
contractPortA := wasmkeeper.PortIDForContractV2(contractAddrA)
require.NotEmpty(t, contractAddrA)
func TestIBC2RAsyncAckSending(t *testing.T) {
testEnv := setup(t)

contractCodeB := chainB.StoreCodeFile("./testdata/ibc2.wasm").CodeID
// Skip initial contract address to not overlap with ChainA
_ = chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractAddrB := chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractPortB := wasmkeeper.PortIDForContractV2(contractAddrB)
require.NotEmpty(t, contractAddrB)
var err error
timeoutTimestamp := testEnv.chainA.GetTimeoutTimestampSecs()
payload := mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: true})
require.NoError(t, err)
packetToAck, err := testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)
err = testEnv.path.EndpointA.MsgRecvPacket(packetToAck)
require.NoError(t, err)

path := wasmibctesting.NewWasmPath(chainA, chainB)
path.EndpointA.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortA,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}
path.EndpointB.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortB,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}
timeoutTimestamp = testEnv.chainA.GetTimeoutTimestampSecs()
payload = mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
payload.Value, err = json.Marshal(IbcPayload{SendAsyncAckForPrevMsg: true})
require.NoError(t, err)
packet, err := testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)

path.Path.SetupV2()
// Check that the ACK was not sent at this moment
var response State
err = testEnv.chainB.SmartQuery(testEnv.contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(0), response.IBC2PacketAckCounter)

// Relay the second packet and expect an ACK sent for the first packet
err = wasmibctesting.RelayPacketV2(testEnv.path, packet, testEnv.path.EndpointB, testEnv.path.EndpointA, &packetToAck)
require.NoError(t, err)

// Check if counter was incremented in the recv entry point
err = testEnv.chainB.SmartQuery(testEnv.contractAddrB.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(1), response.IBC2PacketAckCounter)
}

func TestIBC2TimeoutMsg(t *testing.T) {
testEnv := setup(t)

// IBC v2 Payload from contract on Chain B to contract on Chain A
payload := mockv2.NewMockPayload(contractPortB, contractPortA)
payload := mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
var err error
payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: false, SendAsyncAckForPrevMsg: false})
require.NoError(t, err)

// Message timeout
timeoutTimestamp := uint64(chainB.GetContext().BlockTime().Add(time.Minute).Unix())
timeoutTimestamp := uint64(testEnv.chainB.GetContext().BlockTime().Add(time.Minute).Unix())

_, err = path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
_, err = testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)

// First message send through test.
// Contract replies back with the IbcPayload response.
err = wasmibctesting.RelayPendingPacketsV2(path)
err = wasmibctesting.RelayPendingPacketsV2(testEnv.path)
require.NoError(t, err)

// Send timeout on the packet sent by the contract
err = wasmibctesting.TimeoutPendingPacketsV2(coord, path)
err = wasmibctesting.TimeoutPendingPacketsV2(testEnv.coord, testEnv.path)
require.NoError(t, err)

// Check that timeout message was sent to the contract
var response State
err = chainA.SmartQuery(contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainA.SmartQuery(testEnv.contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, uint32(1), response.IBC2PacketTimeoutCounter)
}

func TestIBC2SendMsg(t *testing.T) {
coord := wasmibctesting.NewCoordinator(t, 2)
chainA := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(1)))
chainB := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(2)))
contractCodeA := chainA.StoreCodeFile("./testdata/ibc2.wasm").CodeID
contractAddrA := chainA.InstantiateContract(contractCodeA, []byte(`{}`))
contractPortA := wasmkeeper.PortIDForContractV2(contractAddrA)
require.NotEmpty(t, contractAddrA)

contractCodeB := chainB.StoreCodeFile("./testdata/ibc2.wasm").CodeID
// Skip initial contract address to not overlap with ChainA
_ = chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractAddrB := chainB.InstantiateContract(contractCodeB, []byte(`{}`))
contractPortB := wasmkeeper.PortIDForContractV2(contractAddrB)
require.NotEmpty(t, contractAddrB)

path := wasmibctesting.NewWasmPath(chainA, chainB)
path.EndpointA.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortA,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}
path.EndpointB.ChannelConfig = &ibctesting.ChannelConfig{
PortID: contractPortB,
Version: ibctransfertypes.V1,
Order: channeltypes.UNORDERED,
}

path.Path.SetupV2()
testEnv := setup(t)

// IBC v2 Payload from contract on Chain B to contract on Chain A
payload := mockv2.NewMockPayload(contractPortB, contractPortA)
payload := mockv2.NewMockPayload(testEnv.contractPortB, testEnv.contractPortA)
var err error
payload.Value, err = json.Marshal(IbcPayload{ResponseWithoutAck: false, SendAsyncAckForPrevMsg: false})
require.NoError(t, err)

// Message timeout
timeoutTimestamp := uint64(chainB.GetContext().BlockTime().Add(time.Minute).Unix())
timeoutTimestamp := uint64(testEnv.chainB.GetContext().BlockTime().Add(time.Minute).Unix())

_, err = path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
_, err = testEnv.path.EndpointB.MsgSendPacket(timeoutTimestamp, payload)
require.NoError(t, err)

// First message send through test.
// Contract replies back with the IbcPayload response.
err = wasmibctesting.RelayPendingPacketsV2(path)
err = wasmibctesting.RelayPendingPacketsV2(testEnv.path)
require.NoError(t, err)

// Check that send message was sent to the contract
var response State
err = chainA.SmartQuery(contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
err = testEnv.chainA.SmartQuery(testEnv.contractAddrA.String(), QueryMsg{QueryState: struct{}{}}, &response)
require.NoError(t, err)
require.Equal(t, &wasmvmtypes.IBC2PacketSendMsg{
Payload: wasmvmtypes.IBC2Payload{
SourcePort: wasmkeeper.PortIDForContractV2(contractAddrA),
DestinationPort: wasmkeeper.PortIDForContractV2(contractAddrB),
SourcePort: wasmkeeper.PortIDForContractV2(testEnv.contractAddrA),
DestinationPort: wasmkeeper.PortIDForContractV2(testEnv.contractAddrB),
Version: "mock-version",
Encoding: "application/x-protobuf",
Value: []byte(`{"response_without_ack":false,"send_async_ack_for_prev_msg":false}`),
},
SourceClient: "07-tendermint-0",
DestinationClient: "07-tendermint-0",
PacketSequence: 1,
Signer: contractAddrA.String(),
Signer: testEnv.contractAddrA.String(),
}, response.LastPacketSent)
}
2 changes: 1 addition & 1 deletion tests/integration/ibc_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ func TestIBCAsyncAck(t *testing.T) {
require.Equal(t, 0, len(*chainB.PendingSendPackets))

// we don't expect an ack yet
err = wasmibctesting.RelayPacketWithoutAck(&path.Path, (*chainA.PendingSendPackets)[0])
err = wasmibctesting.RelayPacketWithoutAck(&path.Path, (*chainA.PendingSendPackets)[0], path.EndpointB)

noAckPacket := (*chainA.PendingSendPackets)[0]
chainA.PendingSendPackets = &[]channeltypes.Packet{}
Expand Down
Loading