Rename IBCAccountPacketData, Remove TxRaw (#456)

* rename IBCAccountPacketData, remove txRaw type

* Update proto/ibc/applications/interchain_accounts/v1/types.proto

docs/ibc/proto-docs.md

@@ -17,9 +17,8 @@
     - [Query](#ibc.applications.interchain_accounts.v1.Query)
 
 - [ibc/applications/interchain_accounts/v1/types.proto](#ibc/applications/interchain_accounts/v1/types.proto)
-    - [IBCAccountPacketData](#ibc.applications.interchain_accounts.v1.IBCAccountPacketData)
     - [IBCTxBody](#ibc.applications.interchain_accounts.v1.IBCTxBody)
-    - [IBCTxRaw](#ibc.applications.interchain_accounts.v1.IBCTxRaw)
+    - [InterchainAccountPacketData](#ibc.applications.interchain_accounts.v1.InterchainAccountPacketData)
 
     - [Type](#ibc.applications.interchain_accounts.v1.Type)
 
@@ -399,22 +398,6 @@ Query defines the gRPC querier service.
 
 
 
-<a name="ibc.applications.interchain_accounts.v1.IBCAccountPacketData"></a>
-
-### IBCAccountPacketData
-Packet data is comprised of raw transaction & type of transaction
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| `type` | [Type](#ibc.applications.interchain_accounts.v1.Type) |  |  |
-| `data` | [bytes](#bytes) |  |  |
-
-
-
-
-
-
 <a name="ibc.applications.interchain_accounts.v1.IBCTxBody"></a>
 
 ### IBCTxBody
@@ -430,15 +413,17 @@ Body of a tx for an ics27 IBC packet
 
 
 
-<a name="ibc.applications.interchain_accounts.v1.IBCTxRaw"></a>
+<a name="ibc.applications.interchain_accounts.v1.InterchainAccountPacketData"></a>
 
-### IBCTxRaw
-Raw tx body
+### InterchainAccountPacketData
+InterchainAccountPacketData is comprised of araw transaction,type of transaction and optional memo field.
 
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| `body_bytes` | [bytes](#bytes) |  |  |
+| `type` | [Type](#ibc.applications.interchain_accounts.v1.Type) |  |  |
+| `data` | [bytes](#bytes) |  |  |
+| `memo` | [string](#string) |  |  |
 
 
 

modules/apps/27-interchain-accounts/ibc_module.go

@@ -98,7 +98,7 @@ func (im IBCModule) OnRecvPacket(
 ) ibcexported.Acknowledgement {
 	ack := channeltypes.NewResultAcknowledgement([]byte{byte(1)})
 
-	var data types.IBCAccountPacketData
+	var data types.InterchainAccountPacketData
 	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
 		ack = channeltypes.NewErrorAcknowledgement(fmt.Sprintf("cannot unmarshal ICS-27 interchain account packet data: %s", err.Error()))
 	}
@@ -127,7 +127,7 @@ func (im IBCModule) OnAcknowledgementPacket(
 	if err := types.ModuleCdc.UnmarshalJSON(acknowledgement, &ack); err != nil {
 		return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-27 interchain account packet acknowledgment: %v", err)
 	}
-	var data types.IBCAccountPacketData
+	var data types.InterchainAccountPacketData
 	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
 		return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-27 interchain account packet data: %s", err.Error())
 	}

modules/apps/27-interchain-accounts/keeper/keeper.go

@@ -83,11 +83,7 @@ func (k Keeper) SerializeCosmosTx(cdc codec.BinaryCodec, data interface{}) ([]by
 		Messages: msgAnys,
 	}
 
-	txRaw := &types.IBCTxRaw{
-		BodyBytes: cdc.MustMarshal(txBody),
-	}
-
-	bz, err := cdc.Marshal(txRaw)
+	bz, err := cdc.Marshal(txBody)
 	if err != nil {
 		return nil, err
 	}

modules/apps/27-interchain-accounts/keeper/relay.go

@@ -15,7 +15,7 @@ import (
 
 // TODO: implement middleware functionality, this will allow us to use capabilities to
 // manage helper module access to owner addresses they do not have capabilities for
-func (k Keeper) TrySendTx(ctx sdk.Context, portID string, data interface{}) ([]byte, error) {
+func (k Keeper) TrySendTx(ctx sdk.Context, portID string, data interface{}, memo string) ([]byte, error) {
 	// Check for the active channel
 	activeChannelId, found := k.GetActiveChannel(ctx, portID)
 	if !found {
@@ -30,7 +30,7 @@ func (k Keeper) TrySendTx(ctx sdk.Context, portID string, data interface{}) ([]b
 	destinationPort := sourceChannelEnd.GetCounterparty().GetPortID()
 	destinationChannel := sourceChannelEnd.GetCounterparty().GetChannelID()
 
-	return k.createOutgoingPacket(ctx, portID, activeChannelId, destinationPort, destinationChannel, data)
+	return k.createOutgoingPacket(ctx, portID, activeChannelId, destinationPort, destinationChannel, data, memo)
 }
 
 func (k Keeper) createOutgoingPacket(
@@ -40,6 +40,7 @@ func (k Keeper) createOutgoingPacket(
 	destinationPort,
 	destinationChannel string,
 	data interface{},
+	memo string,
 ) ([]byte, error) {
 	if data == nil {
 		return []byte{}, types.ErrInvalidOutgoingData
@@ -61,9 +62,10 @@ func (k Keeper) createOutgoingPacket(
 		return []byte{}, channeltypes.ErrSequenceSendNotFound
 	}
 
-	packetData := types.IBCAccountPacketData{
+	packetData := types.InterchainAccountPacketData{
 		Type: types.EXECUTE_TX,
 		Data: txBytes,
+		Memo: memo,
 	}
 
 	// timeoutTimestamp is set to be a max number here so that we never recieve a timeout
@@ -85,17 +87,9 @@ func (k Keeper) createOutgoingPacket(
 }
 
 func (k Keeper) DeserializeTx(_ sdk.Context, txBytes []byte) ([]sdk.Msg, error) {
-	var txRaw types.IBCTxRaw
-
-	err := k.cdc.Unmarshal(txBytes, &txRaw)
-	if err != nil {
-		return nil, err
-	}
-
 	var txBody types.IBCTxBody
 
-	err = k.cdc.Unmarshal(txRaw.BodyBytes, &txBody)
-	if err != nil {
+	if err := k.cdc.Unmarshal(txBytes, &txBody); err != nil {
 		return nil, err
 	}
 
@@ -189,7 +183,7 @@ func (k Keeper) ComputeVirtualTxHash(txBytes []byte, seq uint64) []byte {
 }
 
 func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet) error {
-	var data types.IBCAccountPacketData
+	var data types.InterchainAccountPacketData
 
 	if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
 		return sdkerrors.Wrapf(types.ErrUnknownPacketData, "cannot unmarshal ICS-27 interchain account packet data")
@@ -213,7 +207,7 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet) error
 	}
 }
 
-func (k Keeper) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IBCAccountPacketData, ack channeltypes.Acknowledgement) error {
+func (k Keeper) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Packet, data types.InterchainAccountPacketData, ack channeltypes.Acknowledgement) error {
 	switch ack.Response.(type) {
 	case *channeltypes.Acknowledgement_Error:
 		if k.hook != nil {
@@ -232,7 +226,7 @@ func (k Keeper) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Pac
 	}
 }
 
-func (k Keeper) OnTimeoutPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IBCAccountPacketData) error {
+func (k Keeper) OnTimeoutPacket(ctx sdk.Context, packet channeltypes.Packet, data types.InterchainAccountPacketData) error {
 	if k.hook != nil {
 		k.hook.OnTxFailed(ctx, packet.SourcePort, packet.SourceChannel, k.ComputeVirtualTxHash(data.Data, packet.Sequence), data.Data)
 	}

modules/apps/27-interchain-accounts/keeper/relay_test.go

@@ -81,6 +81,7 @@ func (suite *KeeperTestSuite) TestTrySendTx() {
 			suite.SetupTest() // reset
 			path = NewICAPath(suite.chainA, suite.chainB)
 			suite.coordinator.SetupConnections(path)
+			memo := "memo"
 
 			err := suite.SetupICAPath(path, TestOwnerAddress)
 			suite.Require().NoError(err)
@@ -89,7 +90,7 @@ func (suite *KeeperTestSuite) TestTrySendTx() {
 
 			tc.malleate()
 
-			_, err = suite.chainA.GetSimApp().ICAKeeper.TrySendTx(suite.chainA.GetContext(), portID, msg)
+			_, err = suite.chainA.GetSimApp().ICAKeeper.TrySendTx(suite.chainA.GetContext(), portID, msg, memo)
 
 			if tc.expPass {
 				suite.Require().NoError(err)
@@ -124,28 +125,15 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() {
 				txBytes, err := suite.chainA.GetSimApp().ICAKeeper.SerializeCosmosTx(suite.chainA.Codec, msg)
 				suite.Require().NoError(err)
 
-				data := types.IBCAccountPacketData{Type: types.EXECUTE_TX,
+				data := types.InterchainAccountPacketData{Type: types.EXECUTE_TX,
 					Data: txBytes}
 				packetData = data.GetBytes()
 			}, true,
 		},
 		{
 			"Cannot deserialize txBytes", func() {
 				txBytes = []byte("invalid tx bytes")
-				data := types.IBCAccountPacketData{Type: types.EXECUTE_TX,
-					Data: txBytes}
-				packetData = data.GetBytes()
-			}, false,
-		},
-		{
-			"Cannot deserialize txBytes: invalid IBCTxRaw", func() {
-				txBody := []byte("invalid tx body")
-				txRaw := &types.IBCTxRaw{
-					BodyBytes: txBody,
-				}
-
-				txBytes = suite.chainB.Codec.MustMarshal(txRaw)
-				data := types.IBCAccountPacketData{Type: types.EXECUTE_TX,
+				data := types.InterchainAccountPacketData{Type: types.EXECUTE_TX,
 					Data: txBytes}
 				packetData = data.GetBytes()
 			}, false,
@@ -155,13 +143,13 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() {
 				txBytes = []byte{}
 				// Type here is an ENUM
 				// Valid type is types.EXECUTE_TX
-				data := types.IBCAccountPacketData{Type: 100,
+				data := types.InterchainAccountPacketData{Type: 100,
 					Data: txBytes}
 				packetData = data.GetBytes()
 			}, false,
 		},
 		{
-			"Cannot unmarshal interchain account packet data into types.IBCAccountPacketData", func() {
+			"Cannot unmarshal interchain account packet data into types.InterchainAccountPacketData", func() {
 				packetData = []byte{}
 			}, false,
 		},
@@ -179,7 +167,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() {
 				// build packet data
 				txBytes, err := suite.chainA.GetSimApp().ICAKeeper.SerializeCosmosTx(suite.chainA.Codec, msg)
 				suite.Require().NoError(err)
-				data := types.IBCAccountPacketData{Type: types.EXECUTE_TX,
+				data := types.InterchainAccountPacketData{Type: types.EXECUTE_TX,
 					Data: txBytes}
 				packetData = data.GetBytes()
 			}, false,

modules/apps/27-interchain-accounts/types/packet.go

@@ -4,6 +4,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-func (packet IBCAccountPacketData) GetBytes() []byte {
+func (packet InterchainAccountPacketData) GetBytes() []byte {
 	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&packet))
 }