refactor: cleanup middleware stacks #1248
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,6 @@ import ( | |
| abci "github.com/tendermint/tendermint/abci/types" | ||
|
|
||
| "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/client/cli" | ||
| controllerkeeper "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/controller/keeper" | ||
| controllertypes "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/controller/types" | ||
| "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/host" | ||
|
|
@@ -31,7 +30,6 @@ var ( | |
| _ module.AppModule = AppModule{} | ||
| _ module.AppModuleBasic = AppModuleBasic{} | ||
|
|
||
| _ porttypes.IBCModule = host.IBCModule{} | ||
| ) | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -12,22 +12,25 @@ import ( | |||||
| "github.com/cosmos/ibc-go/v3/modules/core/exported" | ||||||
| ) | ||||||
|
|
||||||
| var _ porttypes.Middleware = &IBCMiddleware{} | ||||||
|
|
||||||
| // IBCMiddlware implements the ICS26 callbacks for the fee middleware given the | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| // fee keeper and the underlying application. | ||||||
| type IBCMiddleware struct { | ||||||
| app porttypes.IBCModule | ||||||
| keeper keeper.Keeper | ||||||
| } | ||||||
|
|
||||||
| // NewIBCMiddlware creates a new IBCMiddlware given the keeper and underlying application | ||||||
| func NewIBCMiddleware(app porttypes.IBCModule, k keeper.Keeper) IBCMiddleware { | ||||||
| return IBCMiddleware{ | ||||||
| app: app, | ||||||
| keeper: k, | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenInit implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanOpenInit( | ||||||
| ctx sdk.Context, | ||||||
| order channeltypes.Order, | ||||||
| connectionHops []string, | ||||||
|
|
@@ -57,10 +60,10 @@ func (im IBCModule) OnChanOpenInit( | |||||
| chanCap, counterparty, versionMetadata.AppVersion) | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenTry implements the IBCMiddleware interface | ||||||
| // If the channel is not fee enabled the underlying application version will be returned | ||||||
| // If the channel is fee enabled we merge the underlying application version with the ics29 version | ||||||
| func (im IBCMiddleware) OnChanOpenTry( | ||||||
| ctx sdk.Context, | ||||||
| order channeltypes.Order, | ||||||
| connectionHops []string, | ||||||
|
|
@@ -100,8 +103,8 @@ func (im IBCModule) OnChanOpenTry( | |||||
| return string(versionBytes), nil | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenAck implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanOpenAck( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -128,8 +131,8 @@ func (im IBCModule) OnChanOpenAck( | |||||
| return im.app.OnChanOpenAck(ctx, portID, channelID, counterpartyChannelID, counterpartyVersion) | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenConfirm implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanOpenConfirm( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -138,8 +141,8 @@ func (im IBCModule) OnChanOpenConfirm( | |||||
| return im.app.OnChanOpenConfirm(ctx, portID, channelID) | ||||||
| } | ||||||
|
|
||||||
| // OnChanCloseInit implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanCloseInit( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -166,8 +169,8 @@ func (im IBCModule) OnChanCloseInit( | |||||
| return nil | ||||||
| } | ||||||
|
|
||||||
| // OnChanCloseConfirm implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanCloseConfirm( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -189,9 +192,9 @@ func (im IBCModule) OnChanCloseConfirm( | |||||
| return im.app.OnChanCloseConfirm(ctx, portID, channelID) | ||||||
| } | ||||||
|
|
||||||
| // OnRecvPacket implements the IBCMiddleware interface. | ||||||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||||||
| func (im IBCMiddleware) OnRecvPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| relayer sdk.AccAddress, | ||||||
|
|
@@ -214,9 +217,9 @@ func (im IBCModule) OnRecvPacket( | |||||
| return types.NewIncentivizedAcknowledgement(forwardRelayer, ack.Acknowledgement(), ack.Success()) | ||||||
| } | ||||||
|
|
||||||
| // OnAcknowledgementPacket implements the IBCMiddleware interface | ||||||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||||||
| func (im IBCMiddleware) OnAcknowledgementPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| acknowledgement []byte, | ||||||
|
|
@@ -244,9 +247,9 @@ func (im IBCModule) OnAcknowledgementPacket( | |||||
| return im.app.OnAcknowledgementPacket(ctx, packet, ack.Result, relayer) | ||||||
| } | ||||||
|
|
||||||
| // OnTimeoutPacket implements the IBCMiddleware interface | ||||||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||||||
| func (im IBCMiddleware) OnTimeoutPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| relayer sdk.AccAddress, | ||||||
|
|
@@ -267,3 +270,22 @@ func (im IBCModule) OnTimeoutPacket( | |||||
| // call underlying callback | ||||||
| return im.app.OnTimeoutPacket(ctx, packet, relayer) | ||||||
| } | ||||||
|
|
||||||
| // SendPacket implements the ICS4 Wrapper interface | ||||||
| func (im IBCMiddleware) SendPacket( | ||||||
| ctx sdk.Context, | ||||||
| chanCap *capabilitytypes.Capability, | ||||||
| packet exported.PacketI, | ||||||
| ) error { | ||||||
| return im.keeper.SendPacket(ctx, chanCap, packet) | ||||||
| } | ||||||
|
|
||||||
| // WriteAcknowledgement implements the ICS4 Wrapper interface | ||||||
| func (im IBCMiddleware) WriteAcknowledgement( | ||||||
| ctx sdk.Context, | ||||||
| chanCap *capabilitytypes.Capability, | ||||||
| packet exported.PacketI, | ||||||
| ack exported.Acknowledgement, | ||||||
| ) error { | ||||||
| return im.keeper.WriteAcknowledgement(ctx, chanCap, packet, ack) | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,12 +20,10 @@ import ( | |
| "github.com/cosmos/ibc-go/v3/modules/apps/29-fee/client/cli" | ||
| "github.com/cosmos/ibc-go/v3/modules/apps/29-fee/keeper" | ||
| "github.com/cosmos/ibc-go/v3/modules/apps/29-fee/types" | ||
| ) | ||
|
|
||
| var ( | ||
| _ module.AppModule = AppModule{} | ||
| _ module.AppModuleBasic = AppModuleBasic{} | ||
| ) | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -154,6 +154,15 @@ func (im IBCModule) OnTimeoutPacket(ctx sdk.Context, packet channeltypes.Packet, | |
| return nil | ||
| } | ||
|
|
||
| // SendPacket implements the ICS4 Wrapper interface | ||
| func (im IBCModule) SendPacket( | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ctx sdk.Context, | ||
| chanCap *capabilitytypes.Capability, | ||
| packet exported.PacketI, | ||
| ) error { | ||
| return nil | ||
| } | ||
|
|
||
| // GetMockRecvCanaryCapabilityName generates a capability name for testing OnRecvPacket functionality. | ||
| func GetMockRecvCanaryCapabilityName(packet channeltypes.Packet) string { | ||
| return fmt.Sprintf("%s%s%s%s", MockRecvCanaryCapabilityName, packet.GetDestPort(), packet.GetDestChannel(), strconv.Itoa(int(packet.GetSequence()))) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...callbacks for the
fee middlewaregiven...?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The next line continues the comment :)