Modify ICS-20 transfer module to use Protobuf encoding for packet data

informalsystems · Jan 17, 2024 · f9090a2 · f9090a2
1 parent 9258dd9
commit f9090a2
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/modules/apps/callbacks/ibc_middleware_test.go b/modules/apps/callbacks/ibc_middleware_test.go
@@ -477,7 +477,7 @@ func (s *CallbacksTestSuite) TestOnTimeoutPacket() {
 			s.Require().NoError(err)
 			s.Require().NotNil(packet)
 
-			err = transfertypes.ModuleCdc.UnmarshalJSON(packet.Data, &packetData)
+			err = transfertypes.ModuleCdc.Unmarshal(packet.Data, &packetData)
 			s.Require().NoError(err)
 
 			ctx = s.chainA.GetContext()

diff --git a/modules/apps/transfer/ibc_module.go b/modules/apps/transfer/ibc_module.go
@@ -181,7 +181,7 @@ func (im IBCModule) OnRecvPacket(
 
 	var data types.FungibleTokenPacketData
 	var ackErr error
-	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
+	if err := types.ModuleCdc.Unmarshal(packet.GetData(), &data); err != nil {
 		ackErr = errorsmod.Wrapf(ibcerrors.ErrInvalidType, "cannot unmarshal ICS-20 transfer packet data")
 		logger.Error(fmt.Sprintf("%s sequence %d", ackErr.Error(), packet.Sequence))
 		ack = channeltypes.NewErrorAcknowledgement(ackErr)
@@ -237,7 +237,7 @@ func (im IBCModule) OnAcknowledgementPacket(
 		return errorsmod.Wrapf(ibcerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet acknowledgement: %v", err)
 	}
 	var data types.FungibleTokenPacketData
-	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
+	if err := types.ModuleCdc.Unmarshal(packet.GetData(), &data); err != nil {
 		return errorsmod.Wrapf(ibcerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet data: %s", err.Error())
 	}
 
@@ -285,7 +285,7 @@ func (im IBCModule) OnTimeoutPacket(
 	relayer sdk.AccAddress,
 ) error {
 	var data types.FungibleTokenPacketData
-	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
+	if err := types.ModuleCdc.Unmarshal(packet.GetData(), &data); err != nil {
 		return errorsmod.Wrapf(ibcerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet data: %s", err.Error())
 	}
 	// refund tokens
@@ -312,7 +312,7 @@ func (im IBCModule) OnTimeoutPacket(
 // PacketDataUnmarshaler interface required for ADR 008 support.
 func (IBCModule) UnmarshalPacketData(bz []byte) (interface{}, error) {
 	var packetData types.FungibleTokenPacketData
-	if err := types.ModuleCdc.UnmarshalJSON(bz, &packetData); err != nil {
+	if err := types.ModuleCdc.Unmarshal(bz, &packetData); err != nil {
 		return nil, err
 	}
 

diff --git a/modules/apps/transfer/types/codec.go b/modules/apps/transfer/types/codec.go
@@ -68,3 +68,12 @@ func mustProtoMarshalJSON(msg proto.Message) []byte {
 
 	return buf.Bytes()
 }
+
+func mustProtoMarshal(msg proto.Message) []byte {
+	buf, err := proto.Marshal(msg)
+	if err != nil {
+		panic(err)
+	}
+
+	return buf
+}
diff --git a/modules/apps/transfer/types/packet.go b/modules/apps/transfer/types/packet.go
@@ -8,8 +8,6 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	sdkmath "cosmossdk.io/math"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
-
 	ibcerrors "github.com/cosmos/ibc-go/v8/modules/core/errors"
 	ibcexported "github.com/cosmos/ibc-go/v8/modules/core/exported"
 )
@@ -69,7 +67,8 @@ func (ftpd FungibleTokenPacketData) ValidateBasic() error {
 
 // GetBytes is a helper for serialising
 func (ftpd FungibleTokenPacketData) GetBytes() []byte {
-	return sdk.MustSortJSON(mustProtoMarshalJSON(&ftpd))
+	// return sdk.MustSortJSON(mustProtoMarshalJSON(&ftpd))
+	return mustProtoMarshal(&ftpd)
 }
 
 // GetPacketSender returns the sender address embedded in the packet data.