Skip to content

Port ibc PR #42

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 4 commits into from
Apr 8, 2025
Merged

Port ibc PR #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76ede5d
Port ibc PR
philipsu522 Mar 31, 2025
b835ddb
bump go
philipsu522 Mar 31, 2025
86e520f
bump go
philipsu522 Mar 31, 2025
0799ebb
Add marshalling error
philipsu522 Apr 7, 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
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-go@v4
with:
go-version: 1.18
go-version: 1.21
- uses: technote-space/get-diff-action@v6.1.0
id: git_diff
with:
Expand Down Expand Up @@ -69,7 +69,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-go@v4
with:
go-version: 1.18
go-version: 1.21
- uses: technote-space/get-diff-action@v6.1.0
with:
PATTERNS: |
Expand Down
6 changes: 5 additions & 1 deletion modules/apps/transfer/ibc_module.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package transfer

import (
"bytes"
"fmt"
"math"

Expand Down Expand Up @@ -218,7 +219,10 @@ func (im IBCModule) OnAcknowledgementPacket(
if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet data: %s", err.Error())
}

bz := types.ModuleCdc.MustMarshalJSON(&ack)
if !bytes.Equal(bz, acknowledgement) {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidType, "acknowledgement did not marshal to expected bytes: %X ≠ %X", bz, acknowledgement)
}
if err := im.keeper.OnAcknowledgementPacket(ctx, packet, data, ack); err != nil {
return err
}
Expand Down
343 changes: 343 additions & 0 deletions modules/apps/transfer/ibc_module_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
package transfer_test

import (
"errors"
"math"

sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"github.com/cosmos/ibc-go/v3/modules/core/exported"

capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types"

"github.com/cosmos/ibc-go/v3/modules/apps/transfer/types"
Expand Down Expand Up @@ -233,3 +238,341 @@ func (suite *TransferTestSuite) TestOnChanOpenAck() {
})
}
}

func (suite *TransferTestSuite) TestOnRecvPacket() {
var (
packet channeltypes.Packet
expectedAttributes []sdk.Attribute
path *ibctesting.Path
packetData types.FungibleTokenPacketData
)
testCases := []struct {
name string
malleate func()
expAck exported.Acknowledgement
expEventErrorMsg string
}{
{
"success",
func() {
coin := sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(100))
packetData = types.NewFungibleTokenPacketData(
coin.Denom,
coin.Amount.String(),
suite.chainA.SenderAccount.GetAddress().String(),
suite.chainB.SenderAccount.GetAddress().String(),
)
expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(sdk.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyDenom, packetData.Denom),
sdk.NewAttribute(types.AttributeKeyAmount, packetData.Amount),
sdk.NewAttribute(types.AttributeKeyMemo, ""),
sdk.NewAttribute(types.AttributeKeyAckSuccess, "true"),
}
},
channeltypes.NewResultAcknowledgement([]byte{byte(1)}),
"",
},
{
"failure: invalid packet data bytes",
func() {
packet.Data = []byte("invalid data")
expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(sdk.AttributeKeySender, ""),
sdk.NewAttribute(types.AttributeKeyReceiver, ""),
sdk.NewAttribute(types.AttributeKeyDenom, ""),
sdk.NewAttribute(types.AttributeKeyAmount, ""),
sdk.NewAttribute(types.AttributeKeyMemo, ""),
sdk.NewAttribute(types.AttributeKeyAckSuccess, "false"),
}
},
channeltypes.NewErrorAcknowledgement("cannot unmarshal ICS-20 transfer packet data"),
"cannot unmarshal ICS-20 transfer packet data",
},
{
"failure: receive disabled",
func() {
suite.chainB.GetSimApp().TransferKeeper.SetParams(suite.chainB.GetContext(), types.Params{ReceiveEnabled: false})
expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(sdk.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyDenom, packetData.Denom),
sdk.NewAttribute(types.AttributeKeyAmount, packetData.Amount),
sdk.NewAttribute(types.AttributeKeyMemo, ""),
sdk.NewAttribute(types.AttributeKeyAckSuccess, "false"),
}
},
channeltypes.NewErrorAcknowledgement("ABCI code: 8: error handling packet on destination chain: see events for details"),
"ABCI code: 8: error handling packet on destination chain: see events for details",
},
}

for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest() // reset

path = NewTransferPath(suite.chainA, suite.chainB)
suite.coordinator.Setup(path)

coin := sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(100))
packetData = types.NewFungibleTokenPacketData(
coin.Denom,
coin.Amount.String(),
suite.chainA.SenderAccount.GetAddress().String(),
suite.chainB.SenderAccount.GetAddress().String(),
)

expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(sdk.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyDenom, packetData.Denom),
sdk.NewAttribute(types.AttributeKeyAmount, packetData.Amount),
sdk.NewAttribute(types.AttributeKeyMemo, packetData.Memo),
}
if tc.expAck == nil || tc.expAck.Success() {
expectedAttributes = append(expectedAttributes, sdk.NewAttribute(types.AttributeKeyAckSuccess, "true"))
} else {
expectedAttributes = append(expectedAttributes,
sdk.NewAttribute(types.AttributeKeyAckSuccess, "false"),
sdk.NewAttribute(types.AttributeKeyAckError, tc.expEventErrorMsg),
)
}

seq := uint64(1)
timeout := suite.chainA.GetTimeoutHeight()
packet = channeltypes.NewPacket(packetData.GetBytes(), seq, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, timeout, 0)

ctx := suite.chainB.GetContext()
cbs, ok := suite.chainB.App.GetIBCKeeper().PortKeeper.Router.GetRoute(ibctesting.TransferPort)
suite.Require().True(ok)

tc.malleate() // change fields in packet

ack := cbs.OnRecvPacket(ctx, packet, suite.chainB.SenderAccount.GetAddress())

suite.Require().Equal(tc.expAck, ack)

expectedEvents := sdk.Events{
sdk.NewEvent(
types.EventTypePacket,
expectedAttributes...,
),
}.ToABCIEvents()

ibctesting.AssertEvents(suite.T(), expectedEvents, ctx.EventManager().Events().ToABCIEvents())
})
}
}

func (suite *TransferTestSuite) TestOnAcknowledgePacket() {
var (
path *ibctesting.Path
packet channeltypes.Packet
ack []byte
)

testCases := []struct {
name string
malleate func()
expError error
expRefund bool
}{
{
"success",
func() {},
nil,
false,
},
{
"success: refund coins",
func() {
ack = channeltypes.NewErrorAcknowledgement(types.ErrInvalidAmount.Error()).Acknowledgement()
},
nil,
true,
},
{
"cannot refund ack on non-existent channel",
func() {
ack = channeltypes.NewErrorAcknowledgement(types.ErrInvalidAmount.Error()).Acknowledgement()

packet.SourceChannel = "channel-100"
},
errors.New("unable to unescrow tokens"),
false,
},
{
"invalid packet data",
func() {
packet.Data = []byte("invalid data")
},
sdkerrors.ErrUnknownRequest,
false,
},
{
"invalid acknowledgement",
func() {
ack = []byte("invalid ack")
},
sdkerrors.ErrUnknownRequest,
false,
},
{
"cannot refund already acknowledged packet",
func() {
ack = channeltypes.NewErrorAcknowledgement(sdkerrors.ErrInsufficientFunds.Error()).Acknowledgement()

cbs, ok := suite.chainA.App.GetIBCKeeper().PortKeeper.Router.GetRoute(ibctesting.TransferPort)
suite.Require().True(ok)

suite.Require().NoError(cbs.OnAcknowledgementPacket(suite.chainA.GetContext(), packet, ack, suite.chainA.SenderAccount.GetAddress()))
},
errors.New("unable to unescrow tokens"),
false,
},
}

for _, tc := range testCases {
tc := tc
suite.Run(tc.name, func() {
suite.SetupTest() // reset

path = NewTransferPath(suite.chainA, suite.chainB)
suite.coordinator.Setup(path)

timeoutHeight := suite.chainA.GetTimeoutHeight()
msg := types.NewMsgTransfer(
path.EndpointA.ChannelConfig.PortID,
path.EndpointA.ChannelID,
ibctesting.TestCoin,
suite.chainA.SenderAccount.GetAddress().String(),
suite.chainB.SenderAccount.GetAddress().String(),
timeoutHeight,
0,
)
res, err := suite.chainA.SendMsgs(msg)
suite.Require().NoError(err) // message committed

packet, err = ibctesting.ParsePacketFromEvents(res.GetEvents())
suite.Require().NoError(err)

cbs, ok := suite.chainA.App.GetIBCKeeper().PortKeeper.Router.GetRoute(ibctesting.TransferPort)
suite.Require().True(ok)

ack = channeltypes.NewResultAcknowledgement([]byte{byte(1)}).Acknowledgement()

tc.malleate() // change fields in packet

err = cbs.OnAcknowledgementPacket(suite.chainA.GetContext(), packet, ack, suite.chainA.SenderAccount.GetAddress())

if tc.expError == nil {
suite.Require().NoError(err)

if tc.expRefund {
escrowAddress := types.GetEscrowAddress(packet.GetSourcePort(), packet.GetSourceChannel())
escrowBalanceAfter := suite.chainA.GetSimApp().BankKeeper.GetBalance(suite.chainA.GetContext(), escrowAddress, sdk.DefaultBondDenom)
suite.Require().Equal(sdk.NewInt(0), escrowBalanceAfter.Amount)
}
} else {
suite.Require().Error(err)
suite.Require().Contains(err.Error(), tc.expError.Error())
}
})
}
}

func (suite *TransferTestSuite) TestOnTimeoutPacket() {
var path *ibctesting.Path
var packet channeltypes.Packet

testCases := []struct {
name string
coinsToSendToB sdk.Coin
malleate func()
expError error
}{
{
"success",
ibctesting.TestCoin,
func() {},
nil,
},
{
"non-existent channel",
ibctesting.TestCoin,
func() {
packet.SourceChannel = "channel-100"
},
errors.New("unable to unescrow tokens"),
},
{
"invalid packet data",
ibctesting.TestCoin,
func() {
packet.Data = []byte("invalid data")
},
errors.New("cannot unmarshal ICS-20 transfer packet data"),
},
{
"already timed-out packet",
ibctesting.TestCoin,
func() {
// First timeout the packet
cbs, ok := suite.chainA.App.GetIBCKeeper().PortKeeper.Router.GetRoute(ibctesting.TransferPort)
suite.Require().True(ok)
err := cbs.OnTimeoutPacket(suite.chainA.GetContext(), packet, suite.chainA.SenderAccount.GetAddress())
suite.Require().NoError(err)
},
errors.New("unable to unescrow tokens"),
},
}

for _, tc := range testCases {
tc := tc
suite.Run(tc.name, func() {
suite.SetupTest() // reset

path = NewTransferPath(suite.chainA, suite.chainB)
suite.coordinator.Setup(path)

timeoutHeight := suite.chainA.GetTimeoutHeight()
msg := types.NewMsgTransfer(
path.EndpointA.ChannelConfig.PortID,
path.EndpointA.ChannelID,
tc.coinsToSendToB,
suite.chainA.SenderAccount.GetAddress().String(),
suite.chainB.SenderAccount.GetAddress().String(),
timeoutHeight,
0,
)
res, err := suite.chainA.SendMsgs(msg)
suite.Require().NoError(err) // message committed
packet, err = ibctesting.ParsePacketFromEvents(res.GetEvents())

suite.Require().NoError(err)

cbs, ok := suite.chainA.App.GetIBCKeeper().PortKeeper.Router.GetRoute(ibctesting.TransferPort)
suite.Require().True(ok)

tc.malleate() // change fields in packet

err = cbs.OnTimeoutPacket(suite.chainA.GetContext(), packet, suite.chainA.SenderAccount.GetAddress())

if tc.expError == nil {
suite.Require().NoError(err)

escrowAddress := types.GetEscrowAddress(packet.GetSourcePort(), packet.GetSourceChannel())
escrowBalanceAfter := suite.chainA.GetSimApp().BankKeeper.GetBalance(suite.chainA.GetContext(), escrowAddress, sdk.DefaultBondDenom)
suite.Require().Equal(sdk.NewInt(0), escrowBalanceAfter.Amount)
} else {
suite.Require().Error(err)
suite.Require().Contains(err.Error(), tc.expError.Error())
}
})
}
}
Loading
Loading