imp: add upgrade sequence to identified channel (#5436)

* imp: add upgrade sequence to identified channel * Add ValidateBasic tests for IdentifiedChannel. --------- Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
cosmos · Dec 18, 2023 · beb46ae · beb46ae
1 parent 7967cfd
commit beb46ae
Show file tree

Hide file tree

Showing 5 changed files with 178 additions and 67 deletions.
diff --git a/docs/client/swagger-ui/swagger.yaml b/docs/client/swagger-ui/swagger.yaml
@@ -9107,6 +9107,15 @@ paths:
                     channel_id:
                       type: string
                       title: channel identifier
+                    upgrade_sequence:
+                      type: string
+                      format: uint64
+                      title: >-
+                        upgrade sequence indicates the latest upgrade attempt
+                        performed by this channel
+
+                        the value of 0 indicates the channel has never been
+                        upgraded
                   description: >-
                     IdentifiedChannel defines a channel with additional port and
                     channel
@@ -13970,6 +13979,15 @@ paths:
                     channel_id:
                       type: string
                       title: channel identifier
+                    upgrade_sequence:
+                      type: string
+                      format: uint64
+                      title: >-
+                        upgrade sequence indicates the latest upgrade attempt
+                        performed by this channel
+
+                        the value of 0 indicates the channel has never been
+                        upgraded
                   description: >-
                     IdentifiedChannel defines a channel with additional port and
                     channel
@@ -19088,6 +19106,14 @@ definitions:
       channel_id:
         type: string
         title: channel identifier
+      upgrade_sequence:
+        type: string
+        format: uint64
+        title: >-
+          upgrade sequence indicates the latest upgrade attempt performed by
+          this channel
+
+          the value of 0 indicates the channel has never been upgraded
     description: |-
       IdentifiedChannel defines a channel with additional port and channel
       identifier fields.
@@ -19864,6 +19890,14 @@ definitions:
             channel_id:
               type: string
               title: channel identifier
+            upgrade_sequence:
+              type: string
+              format: uint64
+              title: >-
+                upgrade sequence indicates the latest upgrade attempt performed
+                by this channel
+
+                the value of 0 indicates the channel has never been upgraded
           description: |-
             IdentifiedChannel defines a channel with additional port and channel
             identifier fields.
@@ -20006,6 +20040,14 @@ definitions:
             channel_id:
               type: string
               title: channel identifier
+            upgrade_sequence:
+              type: string
+              format: uint64
+              title: >-
+                upgrade sequence indicates the latest upgrade attempt performed
+                by this channel
+
+                the value of 0 indicates the channel has never been upgraded
           description: |-
             IdentifiedChannel defines a channel with additional port and channel
             identifier fields.

diff --git a/modules/core/04-channel/types/channel.go b/modules/core/04-channel/types/channel.go
@@ -117,13 +117,14 @@ func (c Counterparty) ValidateBasic() error {
 // NewIdentifiedChannel creates a new IdentifiedChannel instance
 func NewIdentifiedChannel(portID, channelID string, ch Channel) IdentifiedChannel {
 	return IdentifiedChannel{
-		State:          ch.State,
-		Ordering:       ch.Ordering,
-		Counterparty:   ch.Counterparty,
-		ConnectionHops: ch.ConnectionHops,
-		Version:        ch.Version,
-		PortId:         portID,
-		ChannelId:      channelID,
+		State:           ch.State,
+		Ordering:        ch.Ordering,
+		Counterparty:    ch.Counterparty,
+		ConnectionHops:  ch.ConnectionHops,
+		Version:         ch.Version,
+		UpgradeSequence: ch.UpgradeSequence,
+		PortId:          portID,
+		ChannelId:       channelID,
 	}
 }
 

diff --git a/modules/core/04-channel/types/channel.pb.go b/modules/core/04-channel/types/channel.pb.go
diff --git a/modules/core/04-channel/types/channel_test.go b/modules/core/04-channel/types/channel_test.go
@@ -6,6 +6,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/cosmos/ibc-go/v8/modules/core/04-channel/types"
+	host "github.com/cosmos/ibc-go/v8/modules/core/24-host"
 )
 
 func TestChannelValidateBasic(t *testing.T) {
@@ -57,3 +58,37 @@ func TestCounterpartyValidateBasic(t *testing.T) {
 		}
 	}
 }
+
+// TestIdentifiedChannelValidateBasic tests ValidateBasic for IdentifiedChannel.
+func TestIdentifiedChannelValidateBasic(t *testing.T) {
+	channel := types.NewChannel(types.TRYOPEN, types.ORDERED, types.Counterparty{"portidone", "channelidone"}, connHops, version)
+
+	testCases := []struct {
+		name              string
+		identifiedChannel types.IdentifiedChannel
+		expErr            error
+	}{
+		{
+			"valid identified channel",
+			types.NewIdentifiedChannel("portidone", "channelidone", channel),
+			nil,
+		},
+		{
+			"invalid portID",
+			types.NewIdentifiedChannel("(InvalidPort)", "channelidone", channel),
+			host.ErrInvalidID,
+		},
+		{
+			"invalid channelID",
+			types.NewIdentifiedChannel("portidone", "(InvalidChannel)", channel),
+			host.ErrInvalidID,
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+
+		err := tc.identifiedChannel.ValidateBasic()
+		require.ErrorIs(t, err, tc.expErr)
+	}
+}
diff --git a/proto/ibc/core/channel/v1/channel.proto b/proto/ibc/core/channel/v1/channel.proto
@@ -49,6 +49,9 @@ message IdentifiedChannel {
   string port_id = 6;
   // channel identifier
   string channel_id = 7;
+  // upgrade sequence indicates the latest upgrade attempt performed by this channel
+  // the value of 0 indicates the channel has never been upgraded
+  uint64 upgrade_sequence = 8;
 }
 
 // State defines if a channel is in one of the following states: