Middleware Wiring Improvements

modules/apps/27-interchain-accounts/controller/ibc_middleware.go

@@ -26,27 +26,37 @@
 // ICA controller keeper and the underlying application.
 type IBCMiddleware struct {
 	app    porttypes.IBCModule
-	keeper keeper.Keeper
+	keeper *keeper.Keeper
 }
 
 // NewIBCMiddleware creates a new IBCMiddleware given the associated keeper.
 // The underlying application is set to nil and authentication is assumed to
 // be performed by a Cosmos SDK module that sends messages to controller message server.
-func NewIBCMiddleware(k keeper.Keeper) IBCMiddleware {
-	return IBCMiddleware{
+func NewIBCMiddleware(k *keeper.Keeper) *IBCMiddleware {
+	return &IBCMiddleware{
 		app:    nil,
 		keeper: k,
 	}
 }
 
 // NewIBCMiddlewareWithAuth creates a new IBCMiddleware given the associated keeper and underlying application
-func NewIBCMiddlewareWithAuth(app porttypes.IBCModule, k keeper.Keeper) IBCMiddleware {
-	return IBCMiddleware{
+func NewIBCMiddlewareWithAuth(app porttypes.IBCModule, k *keeper.Keeper) *IBCMiddleware {
+	return &IBCMiddleware{
 		app:    app,
 		keeper: k,
 	}
 }
 
+// SetUnderlyingApplication sets the underlying application for the middleware.
+func (im *IBCMiddleware) SetUnderlyingApplication(app porttypes.IBCModule) {
+	im.app = app
+}
+
+// SetICS4Wrapper sets the ICS4Wrapper for the middleware.
+func (im *IBCMiddleware) SetICS4Wrapper(ics4Wrapper porttypes.ICS4Wrapper) {
+	im.keeper.WithICS4Wrapper(ics4Wrapper)
+}
+
 // OnChanOpenInit implements the IBCMiddleware interface
 //
 // Interchain Accounts is implemented to act as middleware for connected authentication modules on

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go

@@ -829,7 +829,7 @@ func (suite *InterchainAccountsTestSuite) TestInFlightHandshakeRespectsGoAPICall
 		suite.Require().NoError(err)
 
 		// attempt to start a second handshake via the controller msg server
-		msgServer := controllerkeeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAControllerKeeper)
+		msgServer := controllerkeeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAControllerKeeper)
 		msgRegisterInterchainAccount := types.NewMsgRegisterInterchainAccount(path.EndpointA.ConnectionID, suite.chainA.SenderAccount.GetAddress().String(), TestVersion, ordering)
 
 		res, err := msgServer.RegisterInterchainAccount(suite.chainA.GetContext(), msgRegisterInterchainAccount)
@@ -846,7 +846,7 @@ func (suite *InterchainAccountsTestSuite) TestInFlightHandshakeRespectsMsgServer
 		path.SetupConnections()
 
 		// initiate a channel handshake such that channel.State == INIT
-		msgServer := controllerkeeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAControllerKeeper)
+		msgServer := controllerkeeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAControllerKeeper)
 		msgRegisterInterchainAccount := types.NewMsgRegisterInterchainAccount(path.EndpointA.ConnectionID, suite.chainA.SenderAccount.GetAddress().String(), TestVersion, ordering)
 
 		res, err := msgServer.RegisterInterchainAccount(suite.chainA.GetContext(), msgRegisterInterchainAccount)
@@ -881,7 +881,7 @@ func (suite *InterchainAccountsTestSuite) TestClosedChannelReopensWithMsgServer(
 		channelSeq := suite.chainA.GetSimApp().GetIBCKeeper().ChannelKeeper.GetNextChannelSequence(suite.chainA.GetContext())
 
 		// route a new MsgRegisterInterchainAccount in order to reopen the
-		msgServer := controllerkeeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAControllerKeeper)
+		msgServer := controllerkeeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAControllerKeeper)
 		msgRegisterInterchainAccount := types.NewMsgRegisterInterchainAccount(path.EndpointA.ConnectionID, suite.chainA.SenderAccount.GetAddress().String(), path.EndpointA.ChannelConfig.Version, ordering)
 
 		res, err := msgServer.RegisterInterchainAccount(suite.chainA.GetContext(), msgRegisterInterchainAccount)

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

@@ -52,7 +52,7 @@ func (suite *KeeperTestSuite) TestInitGenesis() {
 
 			tc.malleate()
 
-			keeper.InitGenesis(suite.chainA.GetContext(), suite.chainA.GetSimApp().ICAControllerKeeper, genesisState)
+			keeper.InitGenesis(suite.chainA.GetContext(), *suite.chainA.GetSimApp().ICAControllerKeeper, genesisState)
 
 			channelID, found := suite.chainA.GetSimApp().ICAControllerKeeper.GetActiveChannelID(suite.chainA.GetContext(), ibctesting.FirstConnectionID, TestPortID)
 			suite.Require().True(found)
@@ -93,7 +93,7 @@ func (suite *KeeperTestSuite) TestExportGenesis() {
 		interchainAccAddr, exists := suite.chainB.GetSimApp().ICAHostKeeper.GetInterchainAccountAddress(suite.chainB.GetContext(), path.EndpointB.ConnectionID, path.EndpointA.ChannelConfig.PortID)
 		suite.Require().True(exists)
 
-		genesisState := keeper.ExportGenesis(suite.chainA.GetContext(), suite.chainA.GetSimApp().ICAControllerKeeper)
+		genesisState := keeper.ExportGenesis(suite.chainA.GetContext(), *suite.chainA.GetSimApp().ICAControllerKeeper)
 
 		suite.Require().Equal(path.EndpointA.ChannelID, genesisState.ActiveChannels[0].ChannelId)
 		suite.Require().Equal(path.EndpointA.ChannelConfig.PortID, genesisState.ActiveChannels[0].PortId)

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

@@ -41,17 +41,17 @@ type Keeper struct {
 // NewKeeper creates a new interchain accounts controller Keeper instance
 func NewKeeper(
 	cdc codec.Codec, storeService corestore.KVStoreService,
-	ics4Wrapper porttypes.ICS4Wrapper, channelKeeper icatypes.ChannelKeeper,
+	channelKeeper icatypes.ChannelKeeper,
 	msgRouter icatypes.MessageRouter, authority string,
-) Keeper {
+) *Keeper {
 	if strings.TrimSpace(authority) == "" {
 		panic(errors.New("authority must be non-empty"))
 	}
 
-	return Keeper{
+	return &Keeper{
 		storeService:  storeService,
 		cdc:           cdc,
-		ics4Wrapper:   ics4Wrapper,
+		ics4Wrapper:   channelKeeper,
 		channelKeeper: channelKeeper,
 		msgRouter:     msgRouter,
 		authority:     authority,

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

@@ -120,7 +120,6 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 				suite.chainA.GetSimApp().AppCodec(),
 				runtime.NewKVStoreService(suite.chainA.GetSimApp().GetKey(types.StoreKey)),
 				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
-				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
 				suite.chainA.GetSimApp().MsgServiceRouter(),
 				suite.chainA.GetSimApp().ICAControllerKeeper.GetAuthority(),
 			)
@@ -130,7 +129,6 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 				suite.chainA.GetSimApp().AppCodec(),
 				runtime.NewKVStoreService(suite.chainA.GetSimApp().GetKey(types.StoreKey)),
 				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
-				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
 				suite.chainA.GetSimApp().MsgServiceRouter(),
 				"", // authority
 			)

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

@@ -80,7 +80,7 @@ func (suite *KeeperTestSuite) TestRegisterInterchainAccount_MsgServer() {
 				tc.malleate()
 
 				ctx := suite.chainA.GetContext()
-				msgServer := keeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAControllerKeeper)
+				msgServer := keeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAControllerKeeper)
 				res, err := msgServer.RegisterInterchainAccount(ctx, msg)
 
 				if tc.expErr == nil {
@@ -186,7 +186,7 @@ func (suite *KeeperTestSuite) TestSubmitTx() {
 				tc.malleate() // malleate mutates test data
 
 				ctx := suite.chainA.GetContext()
-				msgServer := keeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAControllerKeeper)
+				msgServer := keeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAControllerKeeper)
 				res, err := msgServer.SendTx(ctx, msg)
 
 				if tc.expErr == nil {

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

@@ -23,12 +23,12 @@
 
 // IBCModule implements the ICS26 interface for interchain accounts host chains
 type IBCModule struct {
-	keeper keeper.Keeper
+	keeper *keeper.Keeper
 }
 
 // NewIBCModule creates a new IBCModule given the associated keeper
-func NewIBCModule(k keeper.Keeper) IBCModule {
-	return IBCModule{
+func NewIBCModule(k *keeper.Keeper) *IBCModule {
+	return &IBCModule{
 		keeper: k,
 	}
 }
@@ -173,3 +173,11 @@
 
 	return data, version, nil
 }
+
+// SetICS4Wrapper sets the ICS4Wrapper for the IBCModule.
+func (im *IBCModule) SetICS4Wrapper(wrapper porttypes.ICS4Wrapper) {
+	if wrapper == nil {
+		panic("ICS4Wrapper cannot be nil")
+	}
+	im.keeper.WithICS4Wrapper(wrapper)
+}

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

@@ -29,7 +29,7 @@ func (suite *KeeperTestSuite) TestInitGenesis() {
 		Port: icatypes.HostPortID,
 	}
 
-	keeper.InitGenesis(suite.chainA.GetContext(), suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
+	keeper.InitGenesis(suite.chainA.GetContext(), *suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
 
 	channelID, found := suite.chainA.GetSimApp().ICAHostKeeper.GetActiveChannelID(suite.chainA.GetContext(), ibctesting.FirstConnectionID, TestPortID)
 	suite.Require().True(found)
@@ -83,7 +83,7 @@ func (suite *KeeperTestSuite) TestGenesisParams() {
 				Params: tc.input,
 			}
 			if tc.expPanicMsg == "" {
-				keeper.InitGenesis(suite.chainA.GetContext(), suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
+				keeper.InitGenesis(suite.chainA.GetContext(), *suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
 
 				channelID, found := suite.chainA.GetSimApp().ICAHostKeeper.GetActiveChannelID(suite.chainA.GetContext(), ibctesting.FirstConnectionID, TestPortID)
 				suite.Require().True(found)
@@ -98,7 +98,7 @@ func (suite *KeeperTestSuite) TestGenesisParams() {
 				suite.Require().Equal(expParams, params)
 			} else {
 				suite.PanicsWithError(tc.expPanicMsg, func() {
-					keeper.InitGenesis(suite.chainA.GetContext(), suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
+					keeper.InitGenesis(suite.chainA.GetContext(), *suite.chainA.GetSimApp().ICAHostKeeper, genesisState)
 				})
 			}
 		})
@@ -118,7 +118,7 @@ func (suite *KeeperTestSuite) TestExportGenesis() {
 		interchainAccAddr, exists := suite.chainB.GetSimApp().ICAHostKeeper.GetInterchainAccountAddress(suite.chainB.GetContext(), path.EndpointB.ConnectionID, path.EndpointA.ChannelConfig.PortID)
 		suite.Require().True(exists)
 
-		genesisState := keeper.ExportGenesis(suite.chainB.GetContext(), suite.chainB.GetSimApp().ICAHostKeeper)
+		genesisState := keeper.ExportGenesis(suite.chainB.GetContext(), *suite.chainB.GetSimApp().ICAHostKeeper)
 
 		suite.Require().Equal(path.EndpointB.ChannelID, genesisState.ActiveChannels[0].ChannelId)
 		suite.Require().Equal(path.EndpointA.ChannelConfig.PortID, genesisState.ActiveChannels[0].PortId)

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

@@ -52,9 +52,9 @@ type Keeper struct {
 // NewKeeper creates a new interchain accounts host Keeper instance
 func NewKeeper(
 	cdc codec.Codec, storeService corestore.KVStoreService,
-	ics4Wrapper porttypes.ICS4Wrapper, channelKeeper icatypes.ChannelKeeper,
+	channelKeeper icatypes.ChannelKeeper,
 	accountKeeper icatypes.AccountKeeper, msgRouter icatypes.MessageRouter, queryRouter icatypes.QueryRouter, authority string,
-) Keeper {
+) *Keeper {
 	// ensure ibc interchain accounts module account is set
 	if addr := accountKeeper.GetModuleAddress(icatypes.ModuleName); addr == nil {
 		panic(errors.New("the Interchain Accounts module account has not been set"))
@@ -64,10 +64,10 @@ func NewKeeper(
 		panic(errors.New("authority must be non-empty"))
 	}
 
-	return Keeper{
+	return &Keeper{
 		storeService:  storeService,
 		cdc:           cdc,
-		ics4Wrapper:   ics4Wrapper,
+		ics4Wrapper:   channelKeeper,
 		channelKeeper: channelKeeper,
 		accountKeeper: accountKeeper,
 		msgRouter:     msgRouter,

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

@@ -143,7 +143,6 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 				suite.chainA.GetSimApp().AppCodec(),
 				runtime.NewKVStoreService(suite.chainA.GetSimApp().GetKey(types.StoreKey)),
 				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
-				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
 				suite.chainA.GetSimApp().AccountKeeper,
 				suite.chainA.GetSimApp().MsgServiceRouter(),
 				suite.chainA.GetSimApp().GRPCQueryRouter(),
@@ -155,7 +154,6 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 				suite.chainA.GetSimApp().AppCodec(),
 				runtime.NewKVStoreService(suite.chainA.GetSimApp().GetKey(types.StoreKey)),
 				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
-				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
 				authkeeper.AccountKeeper{}, // empty account keeper
 				suite.chainA.GetSimApp().MsgServiceRouter(),
 				suite.chainA.GetSimApp().GRPCQueryRouter(),
@@ -167,7 +165,6 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 				suite.chainA.GetSimApp().AppCodec(),
 				runtime.NewKVStoreService(suite.chainA.GetSimApp().GetKey(types.StoreKey)),
 				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
-				suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper,
 				suite.chainA.GetSimApp().AccountKeeper,
 				suite.chainA.GetSimApp().MsgServiceRouter(),
 				suite.chainA.GetSimApp().GRPCQueryRouter(),

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

@@ -134,7 +134,7 @@ func (suite *KeeperTestSuite) TestModuleQuerySafe() {
 			tc.malleate()
 
 			ctx := suite.chainA.GetContext()
-			msgServer := keeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAHostKeeper)
+			msgServer := keeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAHostKeeper)
 			res, err := msgServer.ModuleQuerySafe(ctx, msg)
 
 			if tc.expErr == nil {
@@ -173,7 +173,7 @@ func (suite *KeeperTestSuite) TestUpdateParams() {
 			suite.SetupTest()
 
 			ctx := suite.chainA.GetContext()
-			msgServer := keeper.NewMsgServerImpl(&suite.chainA.GetSimApp().ICAHostKeeper)
+			msgServer := keeper.NewMsgServerImpl(suite.chainA.GetSimApp().ICAHostKeeper)
 			res, err := msgServer.UpdateParams(ctx, tc.msg)
 
 			if tc.expErr == nil {

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

@@ -7,6 +7,7 @@ import (
 
 	connectiontypes "github.com/cosmos/ibc-go/v10/modules/core/03-connection/types"
 	channeltypes "github.com/cosmos/ibc-go/v10/modules/core/04-channel/types"
+	porttypes "github.com/cosmos/ibc-go/v10/modules/core/05-port/types"
 )
 
 // AccountKeeper defines the expected account keeper
@@ -20,6 +21,7 @@ type AccountKeeper interface {
 
 // ChannelKeeper defines the expected IBC channel keeper
 type ChannelKeeper interface {
+	porttypes.ICS4Wrapper
 	GetChannel(ctx sdk.Context, srcPort, srcChan string) (channel channeltypes.Channel, found bool)
 	GetNextSequenceSend(ctx sdk.Context, portID, channelID string) (uint64, bool)
 	GetConnection(ctx sdk.Context, connectionID string) (connectiontypes.ConnectionEnd, error)

modules/apps/callbacks/ibc_middleware.go

@@ -22,7 +22,7 @@
 // IBCMiddleware implements the ICS26 callbacks for the ibc-callbacks middleware given
 // the underlying application.
 type IBCMiddleware struct {
-	app         porttypes.PacketUnmarshalarModule
+	app         porttypes.PacketUnmarshalerModule
 	ics4Wrapper porttypes.ICS4Wrapper
 
 	contractKeeper types.ContractKeeper
@@ -37,18 +37,8 @@
 // NewIBCMiddleware creates a new IBCMiddleware given the keeper and underlying application.
 // The underlying application must implement the required callback interfaces.
 func NewIBCMiddleware(
-	app porttypes.IBCModule, ics4Wrapper porttypes.ICS4Wrapper,
 	contractKeeper types.ContractKeeper, maxCallbackGas uint64,
-) IBCMiddleware {
-	packetDataUnmarshalerApp, ok := app.(porttypes.PacketUnmarshalarModule)
-	if !ok {
-		panic(fmt.Errorf("underlying application does not implement %T", (*porttypes.PacketUnmarshalarModule)(nil)))
-	}
-
-	if ics4Wrapper == nil {
-		panic(errors.New("ICS4Wrapper cannot be nil"))
-	}
-
+) *IBCMiddleware {
 	if contractKeeper == nil {
 		panic(errors.New("contract keeper cannot be nil"))
 	}
@@ -57,21 +47,36 @@
 		panic(errors.New("maxCallbackGas cannot be zero"))
 	}
 
-	return IBCMiddleware{
-		app:            packetDataUnmarshalerApp,
-		ics4Wrapper:    ics4Wrapper,
+	return &IBCMiddleware{
 		contractKeeper: contractKeeper,
 		maxCallbackGas: maxCallbackGas,
 	}
 }
 
-// WithICS4Wrapper sets the ICS4Wrapper. This function may be used after the
+// SetICS4Wrapper sets the ICS4Wrapper. This function may be used after the
 // middleware's creation to set the middleware which is above this module in
 // the IBC application stack.
-func (im *IBCMiddleware) WithICS4Wrapper(wrapper porttypes.ICS4Wrapper) {
+func (im *IBCMiddleware) SetICS4Wrapper(wrapper porttypes.ICS4Wrapper) {
 	im.ics4Wrapper = wrapper
 }
 
+// SetUnderlyingApplication sets the underlying IBC module. This function may be used after
+// the middleware's creation to set the ibc module which is below this middleware.
+func (im *IBCMiddleware) SetUnderlyingApplication(app porttypes.IBCModule) {
+	if app == nil {
+		panic(errors.New("underlying application cannot be nil"))
+	}
+	if im.app != nil {
+		panic(errors.New("underlying application already set"))
+	}
+	// the underlying application must implement the PacketUnmarshalerModule interface
+	pdApp, ok := app.(porttypes.PacketUnmarshalerModule)
+	if !ok {
+		panic(fmt.Errorf("underlying application must implement PacketUnmarshalerModule, got %T", app))
+	}
+	im.app = pdApp
+}
+
 // GetICS4Wrapper returns the ICS4Wrapper.
 func (im *IBCMiddleware) GetICS4Wrapper() porttypes.ICS4Wrapper {
 	return im.ics4Wrapper