refactor!: remove unnecessary exported.ChannelI interface (cosmos#5703)

* refactor: remove unnecessary channelI interface * docs: add migration docs entry * lint
notional-labs · Jan 24, 2024 · 203ea71 · 203ea71
1 parent 65306ac
commit 203ea71
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 41 deletions.
diff --git a/docs/docs/05-migrations/13-v8-to-v9.md b/docs/docs/05-migrations/13-v8-to-v9.md
@@ -24,7 +24,9 @@ There are four sections based on the four potential user groups of this document
 
 ## IBC Apps
 
-- No relevant changes were made in this release.
+### API removals
+
+The `exported.ChannelI` interface has been removed. Please use the concrete type. 
 
 ## Relayers
 

diff --git a/modules/core/02-client/migrations/v7/solomachine.go b/modules/core/02-client/migrations/v7/solomachine.go
@@ -166,14 +166,6 @@ func (ClientState) VerifyConnectionState(
 	panic(errors.New("legacy solo machine is deprecated"))
 }
 
-// VerifyChannelState panics!
-func (ClientState) VerifyChannelState(
-	storetypes.KVStore, codec.BinaryCodec, exported.Height, exported.Prefix,
-	[]byte, string, string, exported.ChannelI,
-) error {
-	panic(errors.New("legacy solo machine is deprecated"))
-}
-
 // VerifyPacketCommitment panics!
 func (ClientState) VerifyPacketCommitment(
 	sdk.Context, storetypes.KVStore, codec.BinaryCodec, exported.Height,

diff --git a/modules/core/03-connection/keeper/verify.go b/modules/core/03-connection/keeper/verify.go
@@ -156,7 +156,7 @@ func (k Keeper) VerifyChannelState(
 	proof []byte,
 	portID,
 	channelID string,
-	channel exported.ChannelI,
+	channel channeltypes.Channel,
 ) error {
 	clientID := connection.GetClientID()
 	clientState, clientStore, err := k.getClientStateAndVerificationStore(ctx, clientID)
@@ -174,12 +174,7 @@ func (k Keeper) VerifyChannelState(
 		return err
 	}
 
-	channelEnd, ok := channel.(channeltypes.Channel)
-	if !ok {
-		return errorsmod.Wrapf(ibcerrors.ErrInvalidType, "invalid channel type %T", channel)
-	}
-
-	bz, err := k.cdc.Marshal(&channelEnd)
+	bz, err := k.cdc.Marshal(&channel)
 	if err != nil {
 		return err
 	}

diff --git a/modules/core/04-channel/types/channel.go b/modules/core/04-channel/types/channel.go
@@ -9,10 +9,7 @@ import (
 	"github.com/cosmos/ibc-go/v8/modules/core/exported"
 )
 
-var (
-	_ exported.ChannelI             = (*Channel)(nil)
-	_ exported.CounterpartyChannelI = (*Counterparty)(nil)
-)
+var _ exported.CounterpartyChannelI = (*Counterparty)(nil)
 
 // NewChannel creates a new Channel instance
 func NewChannel(

diff --git a/modules/core/04-channel/types/codec.go b/modules/core/04-channel/types/codec.go
@@ -12,11 +12,6 @@ import (
 // RegisterInterfaces register the ibc channel submodule interfaces to protobuf
 // Any.
 func RegisterInterfaces(registry codectypes.InterfaceRegistry) {
-	registry.RegisterInterface(
-		"ibc.core.channel.v1.ChannelI",
-		(*exported.ChannelI)(nil),
-		&Channel{},
-	)
 	registry.RegisterInterface(
 		"ibc.core.channel.v1.CounterpartyChannelI",
 		(*exported.CounterpartyChannelI)(nil),

diff --git a/modules/core/04-channel/types/codec_test.go b/modules/core/04-channel/types/codec_test.go
@@ -18,11 +18,6 @@ func TestCodecTypeRegistration(t *testing.T) {
 		typeURL string
 		expPass bool
 	}{
-		{
-			"success: Channel",
-			sdk.MsgTypeURL(&types.Channel{}),
-			true,
-		},
 		{
 			"success: Counterparty",
 			sdk.MsgTypeURL(&types.Counterparty{}),

diff --git a/modules/core/04-channel/types/expected_keepers.go b/modules/core/04-channel/types/expected_keepers.go
@@ -33,7 +33,7 @@ type ConnectionKeeper interface {
 		proof []byte,
 		portID,
 		channelID string,
-		channel exported.ChannelI,
+		channel Channel,
 	) error
 	VerifyPacketCommitment(
 		ctx sdk.Context,

diff --git a/modules/core/exported/channel.go b/modules/core/exported/channel.go
@@ -1,15 +1,5 @@
 package exported
 
-// ChannelI defines the standard interface for a channel end.
-type ChannelI interface {
-	GetState() int32
-	GetOrdering() int32
-	GetCounterparty() CounterpartyChannelI
-	GetConnectionHops() []string
-	GetVersion() string
-	ValidateBasic() error
-}
-
 // CounterpartyChannelI defines the standard interface for a channel end's
 // counterparty.
 type CounterpartyChannelI interface {