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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,30 +10,34 @@ import ( | |||||
| icatypes "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/types" | ||||||
| channeltypes "github.com/cosmos/ibc-go/v3/modules/core/04-channel/types" | ||||||
| porttypes "github.com/cosmos/ibc-go/v3/modules/core/05-port/types" | ||||||
| "github.com/cosmos/ibc-go/v3/modules/core/exported" | ||||||
| ibcexported "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
|
||||||
| // ICA controller keeper and the underlying application. | ||||||
| type IBCMiddleware struct { | ||||||
| app porttypes.IBCModule | ||||||
| keeper keeper.Keeper | ||||||
| } | ||||||
|
|
||||||
| // IBCMiddleware creates a new IBCMiddleware given the associated keeper and underlying application | ||||||
| func NewIBCMiddleware(k keeper.Keeper, app porttypes.IBCModule) IBCMiddleware { | ||||||
| return IBCMiddleware{ | ||||||
| keeper: k, | ||||||
| app: app, | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenInit implements the IBCMiddleware interface | ||||||
| // | ||||||
| // Interchain Accounts is implemented to act as middleware for connected authentication modules on | ||||||
| // the controller side. The connected modules may not change the controller side portID or | ||||||
| // version. They will be allowed to perform custom logic without changing | ||||||
| // the parameters stored within a channel struct. | ||||||
| func (im IBCMiddleware) OnChanOpenInit( | ||||||
| ctx sdk.Context, | ||||||
| order channeltypes.Order, | ||||||
| connectionHops []string, | ||||||
|
|
@@ -56,8 +60,8 @@ func (im IBCModule) OnChanOpenInit( | |||||
| chanCap, counterparty, version) | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenTry implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanOpenTry( | ||||||
| ctx sdk.Context, | ||||||
| order channeltypes.Order, | ||||||
| connectionHops []string, | ||||||
|
|
@@ -70,13 +74,13 @@ func (im IBCModule) OnChanOpenTry( | |||||
| return "", sdkerrors.Wrap(icatypes.ErrInvalidChannelFlow, "channel handshake must be initiated by controller chain") | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenAck implements the IBCMiddleware interface | ||||||
| // | ||||||
| // Interchain Accounts is implemented to act as middleware for connected authentication modules on | ||||||
| // the controller side. The connected modules may not change the portID or | ||||||
| // version. They will be allowed to perform custom logic without changing | ||||||
| // the parameters stored within a channel struct. | ||||||
| func (im IBCMiddleware) OnChanOpenAck( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -95,17 +99,17 @@ func (im IBCModule) OnChanOpenAck( | |||||
| return im.app.OnChanOpenAck(ctx, portID, channelID, counterpartyChannelID, counterpartyVersion) | ||||||
| } | ||||||
|
|
||||||
| // OnChanOpenAck implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanOpenConfirm( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
| ) error { | ||||||
| return sdkerrors.Wrap(icatypes.ErrInvalidChannelFlow, "channel handshake must be initiated by controller chain") | ||||||
| } | ||||||
|
|
||||||
| // OnChanCloseInit implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanCloseInit( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
|
|
@@ -114,26 +118,26 @@ func (im IBCModule) OnChanCloseInit( | |||||
| return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "user cannot close channel") | ||||||
| } | ||||||
|
|
||||||
| // OnChanCloseConfirm implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnChanCloseConfirm( | ||||||
| ctx sdk.Context, | ||||||
| portID, | ||||||
| channelID string, | ||||||
| ) error { | ||||||
| return im.keeper.OnChanCloseConfirm(ctx, portID, channelID) | ||||||
| } | ||||||
|
|
||||||
| // OnRecvPacket implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnRecvPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| _ sdk.AccAddress, | ||||||
| ) ibcexported.Acknowledgement { | ||||||
| return channeltypes.NewErrorAcknowledgement("cannot receive packet on controller chain") | ||||||
| } | ||||||
|
|
||||||
| // OnAcknowledgementPacket implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnAcknowledgementPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| acknowledgement []byte, | ||||||
|
|
@@ -147,8 +151,8 @@ func (im IBCModule) OnAcknowledgementPacket( | |||||
| return im.app.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer) | ||||||
| } | ||||||
|
|
||||||
| // OnTimeoutPacket implements the IBCMiddleware interface | ||||||
| func (im IBCMiddleware) OnTimeoutPacket( | ||||||
| ctx sdk.Context, | ||||||
| packet channeltypes.Packet, | ||||||
| relayer sdk.AccAddress, | ||||||
|
|
@@ -163,3 +167,22 @@ func (im IBCModule) OnTimeoutPacket( | |||||
|
|
||||||
| 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 { | ||||||
| panic("SendPacket not supported for ICA controller module") | ||||||
|
There was a problem hiding this comment. ICA auth There was a problem hiding this comment. Why would this occur? ICA auth calls There was a problem hiding this comment. ICA auth is being wrapped by ICA correct? In that case we will want the packet flow to be:
The ICA middleware in this case will do nothing but forward the packet one layer up. This is to keep consistency and to make sure ICA-auth packets are not missed by additional middleware that is wrapping the stack There was a problem hiding this comment.
Only partially (not all callbacks/interfaces should be implemented). ICA controller constructs the packet and thus calls |
||||||
| } | ||||||
|
|
||||||
| // WriteAcknowledgement implements the ICS4 Wrapper interface | ||||||
| func (im IBCMiddleware) WriteAcknowledgement( | ||||||
| ctx sdk.Context, | ||||||
| chanCap *capabilitytypes.Capability, | ||||||
| packet exported.PacketI, | ||||||
| ack exported.Acknowledgement, | ||||||
| ) error { | ||||||
| panic("WriteAcknowledgement not supported for ICA controller module") | ||||||
| } | ||||||
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
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{} | ||
| ) | ||
|
|
||
|
|
||
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 :)