ica: unspecified type enum for interchain account packet data (#487)

* adding unspecified type enum, adding defensive check to ValidateBasic * Update modules/apps/27-interchain-accounts/types/packet_test.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
cosmos · Oct 13, 2021 · cd263c7 · cd263c7
1 parent 300f133
commit cd263c7
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 45 deletions.
diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md
@@ -435,13 +435,13 @@ InterchainAccountPacketData is comprised of a raw transaction, type of transacti
 <a name="ibc.applications.interchain_accounts.v1.Type"></a>
 
 ### Type
-The different types of interchain account transactions
-EXECUTE_TX is used when sending a TX from the controller side to the host side. The host side will execute the tx on
-behalf of the interchain account.
+Type defines a classification of message issued from a controller chain to its associated interchain accounts
+host
 
 | Name | Number | Description |
 | ---- | ------ | ----------- |
-| TYPE_EXECUTE_TX_UNSPECIFIED | 0 | Execute message type |
+| TYPE_UNSPECIFIED | 0 | Default zero value enumeration |
+| TYPE_EXECUTE_TX | 1 | Execute a transaction on an interchain accounts host chain |
 
 
  <!-- end enums -->

diff --git a/modules/apps/27-interchain-accounts/types/packet.go b/modules/apps/27-interchain-accounts/types/packet.go
@@ -11,6 +11,10 @@ const MaxMemoCharLength = 256
 // ValidateBasic performs basic validation of the interchain account packet data.
 // The memo may be empty.
 func (iapd InterchainAccountPacketData) ValidateBasic() error {
+	if iapd.Type == UNSPECIFIED {
+		return sdkerrors.Wrap(ErrInvalidOutgoingData, "packet data type cannot be unspecified")
+	}
+
 	if iapd.Data == nil {
 		return sdkerrors.Wrap(ErrInvalidOutgoingData, "packet data cannot be empty")
 	}

diff --git a/modules/apps/27-interchain-accounts/types/packet_test.go b/modules/apps/27-interchain-accounts/types/packet_test.go
@@ -29,6 +29,15 @@ func (suite *TypesTestSuite) TestValidateBasic() {
 			},
 			true,
 		},
+		{
+			"type unspecified",
+			types.InterchainAccountPacketData{
+				Type: types.UNSPECIFIED,
+				Data: []byte("data"), 
+				Memo: "memo",
+			},
+			false,
+		},
 		{
 			"empty data",
 			types.InterchainAccountPacketData{

diff --git a/modules/apps/27-interchain-accounts/types/types.pb.go b/modules/apps/27-interchain-accounts/types/types.pb.go
diff --git a/proto/ibc/applications/interchain_accounts/v1/types.proto b/proto/ibc/applications/interchain_accounts/v1/types.proto
@@ -5,24 +5,25 @@ import "google/protobuf/any.proto";
 import "gogoproto/gogo.proto";
 option go_package = "github.com/cosmos/ibc-go/v2/modules/apps/27-interchain-accounts/types";
 
-// The different types of interchain account transactions
-// EXECUTE_TX is used when sending a TX from the controller side to the host side. The host side will execute the tx on
-// behalf of the interchain account.
+// Type defines a classification of message issued from a controller chain to its associated interchain accounts
+// host
 enum Type {
   option (gogoproto.goproto_enum_prefix) = false;
-  // Execute message type
-  TYPE_EXECUTE_TX_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "EXECUTE_TX"];
+
+  // Default zero value enumeration
+  TYPE_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "UNSPECIFIED"];
+  // Execute a transaction on an interchain accounts host chain
+  TYPE_EXECUTE_TX = 1 [(gogoproto.enumvalue_customname) = "EXECUTE_TX"];
 }
 
 // InterchainAccountPacketData is comprised of a raw transaction, type of transaction and optional memo field.
 message InterchainAccountPacketData {
-  Type  type = 1;
-  bytes data = 2;
+  Type   type = 1;
+  bytes  data = 2;
   string memo = 3;
 }
 
 // CosmosTx contains a list of sdk.Msg's. It should be used when sending transactions to an SDK host chain.
 message CosmosTx {
   repeated google.protobuf.Any messages = 1;
 }
-