[Do not merge] Spike adr-8 #3359
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 |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| package callbacks | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types" | ||
|
|
||
| clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types" | ||
| channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types" | ||
| porttypes "github.com/cosmos/ibc-go/v7/modules/core/05-port/types" | ||
| "github.com/cosmos/ibc-go/v7/modules/core/exported" | ||
| ) | ||
|
|
||
| type Example struct { | ||
| } | ||
|
|
||
| var _ porttypes.Middleware = &IBCMiddleware[Example]{} | ||
|
|
||
| // todo: concrete type | ||
| type CallbackPacketData any | ||
|
|
||
| type IBCMiddleware[T CallbackPacketData] struct { | ||
| next porttypes.Middleware | ||
| decoder Decoder[T] | ||
| executor Executor[T] | ||
| limits GasLimits | ||
| } | ||
|
|
||
| // Decoder unpacks a raw ibc packet to the custom type | ||
| type Decoder[T CallbackPacketData] interface { | ||
| // Decode packet to custom type. An empty result skips callback execution, error aborts process | ||
| Decode(packet channeltypes.Packet) (*T, error) | ||
| } | ||
|
|
||
| // Executor executes the callback | ||
| type Executor[T CallbackPacketData] interface { | ||
| OnRecvPacket(ctx sdk.Context, obj T, relayer sdk.AccAddress) error | ||
| OnAcknowledgementPacket(ctx sdk.Context, obj T, acknowledgement []byte, relayer sdk.AccAddress) error | ||
| OnTimeoutPacket(ctx sdk.Context, obj T, relayer sdk.AccAddress) error | ||
| } | ||
| type GasLimits struct { | ||
| OnRecvPacketLimit *sdk.Gas | ||
| OnAcknowledgementPacketLimit *sdk.Gas | ||
| OnTimeoutPacketLimit *sdk.Gas | ||
| } | ||
|
|
||
| // NewIBCMiddleware constructor | ||
| func NewIBCMiddleware[T CallbackPacketData](next porttypes.Middleware, decoder Decoder[T], executor Executor[T], limits GasLimits) IBCMiddleware[T] { | ||
|
There was a problem hiding this comment. I choose |
||
| return IBCMiddleware[T]{ | ||
| next: next, | ||
| decoder: decoder, | ||
| executor: executor, | ||
| limits: limits, | ||
|
There was a problem hiding this comment. I configured limits with the middleware as this is in the adr-8 example. But when implemented into the executor, then it would be even more flexible There was a problem hiding this comment. Adr-8 defines the limits read from the packet not defined here. So this is wrong |
||
| } | ||
| } | ||
|
|
||
| // OnRecvPacket implements the IBCMiddleware interface. | ||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||
| func (im IBCMiddleware[T]) OnRecvPacket( | ||
| ctx sdk.Context, | ||
| packet channeltypes.Packet, | ||
| relayer sdk.AccAddress, | ||
| ) exported.Acknowledgement { | ||
|
|
||
| ack := im.next.OnRecvPacket(ctx, packet, relayer) | ||
|
|
||
| // todo: limit gas | ||
| p, err := im.decoder.Decode(packet) | ||
| if err != nil { | ||
| // see comments in https://github.com/cosmos/ibc-go/blob/main/docs/architecture/adr-008-app-caller-cbs/adr-008-app-caller-cbs.md | ||
| // todo: filter out events: https://github.com/cosmos/ibc-go/issues/3358 | ||
| // todo: set event with raw error for debug as defined in ErrorAcknowledgement? | ||
| return channeltypes.NewErrorAcknowledgement(err) | ||
|
There was a problem hiding this comment. There are some downsides with returning error ack, that are outlined well in in the adr:
An alternative would be raising panic to abort the process and reverting state. The data packet would eventually run into a timeout instead |
||
| } | ||
| if p != nil { | ||
| if err := im.executor.OnRecvPacket(ctx, *p, relayer); err != nil { | ||
| // see comments in https://github.com/cosmos/ibc-go/blob/main/docs/architecture/adr-008-app-caller-cbs/adr-008-app-caller-cbs.md | ||
| // todo: filter out events: https://github.com/cosmos/ibc-go/issues/3358 | ||
| // todo: set event with raw error for debug as defined in ErrorAcknowledgement? | ||
| return channeltypes.NewErrorAcknowledgement(err) | ||
|
There was a problem hiding this comment. Same as above. Should the callback be able to overwrite the ack or is panic the way to go? |
||
| } | ||
| } | ||
| return ack | ||
| } | ||
|
|
||
| // OnAcknowledgementPacket implements the IBCMiddleware interface | ||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||
| func (im IBCMiddleware[T]) OnAcknowledgementPacket( | ||
| ctx sdk.Context, | ||
| packet channeltypes.Packet, | ||
| acknowledgement []byte, | ||
| relayer sdk.AccAddress, | ||
| ) error { | ||
| // call underlying callback | ||
| if err := im.next.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer); err != nil { | ||
| return err | ||
| } | ||
| // todo: limit gas | ||
| p, err := im.decoder.Decode(packet) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if p != nil { | ||
| return im.executor.OnAcknowledgementPacket(ctx, *p, acknowledgement, relayer) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // OnTimeoutPacket implements the IBCMiddleware interface | ||
| // If fees are not enabled, this callback will default to the ibc-core packet callback | ||
| func (im IBCMiddleware[T]) OnTimeoutPacket( | ||
| ctx sdk.Context, | ||
| packet channeltypes.Packet, | ||
| relayer sdk.AccAddress, | ||
| ) error { | ||
| if err := im.next.OnTimeoutPacket(ctx, packet, relayer); err != nil { | ||
| return err | ||
| } | ||
| // todo: limit gas | ||
| p, err := im.decoder.Decode(packet) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if p != nil { | ||
| return im.executor.OnTimeoutPacket(ctx, *p, relayer) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // OnChanOpenInit implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanOpenInit( | ||
| ctx sdk.Context, | ||
| order channeltypes.Order, | ||
| connectionHops []string, | ||
| portID string, | ||
| channelID string, | ||
| chanCap *capabilitytypes.Capability, | ||
| counterparty channeltypes.Counterparty, | ||
| version string, | ||
| ) (string, error) { | ||
| return im.OnChanOpenInit(ctx, order, connectionHops, portID, channelID, chanCap, counterparty, version) | ||
| } | ||
|
|
||
| // OnChanOpenTry implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanOpenTry( | ||
| ctx sdk.Context, | ||
| order channeltypes.Order, | ||
| connectionHops []string, | ||
| portID, | ||
| channelID string, | ||
| chanCap *capabilitytypes.Capability, | ||
| counterparty channeltypes.Counterparty, | ||
| counterpartyVersion string, | ||
| ) (string, error) { | ||
| return im.OnChanOpenTry(ctx, order, connectionHops, portID, channelID, chanCap, counterparty, counterpartyVersion) | ||
| } | ||
|
|
||
| // OnChanOpenAck implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanOpenAck( | ||
| ctx sdk.Context, | ||
| portID, | ||
| channelID string, | ||
| counterpartyChannelID string, | ||
| counterpartyVersion string, | ||
| ) error { | ||
| return im.next.OnChanOpenAck(ctx, portID, channelID, counterpartyChannelID, counterpartyVersion) | ||
| } | ||
|
|
||
| // OnChanOpenConfirm implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanOpenConfirm( | ||
| ctx sdk.Context, | ||
| portID, | ||
| channelID string, | ||
| ) error { | ||
| return im.next.OnChanOpenConfirm(ctx, portID, channelID) | ||
| } | ||
|
|
||
| // OnChanCloseInit implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanCloseInit( | ||
| ctx sdk.Context, | ||
| portID, | ||
| channelID string, | ||
| ) error { | ||
| return im.next.OnChanCloseInit(ctx, portID, channelID) | ||
| } | ||
|
|
||
| // OnChanCloseConfirm implements the IBCMiddleware interface | ||
| func (im IBCMiddleware[T]) OnChanCloseConfirm( | ||
| ctx sdk.Context, | ||
| portID, | ||
| channelID string, | ||
| ) error { | ||
| return im.next.OnChanCloseConfirm(ctx, portID, channelID) | ||
| } | ||
|
|
||
| // SendPacket implements the ICS4 Wrapper interface | ||
| func (im IBCMiddleware[T]) SendPacket( | ||
| ctx sdk.Context, | ||
| chanCap *capabilitytypes.Capability, | ||
| sourcePort string, | ||
| sourceChannel string, | ||
| timeoutHeight clienttypes.Height, | ||
| timeoutTimestamp uint64, | ||
| data []byte, | ||
| ) (uint64, error) { | ||
| return im.next.SendPacket(ctx, chanCap, sourcePort, sourceChannel, timeoutHeight, timeoutTimestamp, data) | ||
| } | ||
|
|
||
| // WriteAcknowledgement implements the ICS4 Wrapper interface | ||
| func (im IBCMiddleware[T]) WriteAcknowledgement( | ||
| ctx sdk.Context, | ||
| chanCap *capabilitytypes.Capability, | ||
| packet exported.PacketI, | ||
| ack exported.Acknowledgement, | ||
| ) error { | ||
| return im.next.WriteAcknowledgement(ctx, chanCap, packet, ack) | ||
| } | ||
|
|
||
| // GetAppVersion returns the application version of the underlying application | ||
| func (im IBCMiddleware[T]) GetAppVersion(ctx sdk.Context, portID, channelID string) (string, bool) { | ||
| return "ics-8.0-alex", true | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package callbacks | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types" | ||
| channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types" | ||
| ) | ||
|
|
||
| // MyICS20Payload my random payload example | ||
| type MyICS20Payload struct { | ||
|
There was a problem hiding this comment. Some example data that would be extracted from memo |
||
| SrcCallbackAddress string `json:"src_callback_address"` | ||
| DstCallbackAddress string `json:"dst_callback_address"` | ||
| } | ||
|
|
||
| var _ Decoder[MyICS20Payload] = &MyICS20Decoder{} | ||
|
|
||
| type MyICS20Decoder struct { //nolint:gofumpt | ||
| } | ||
|
|
||
| func (m MyICS20Decoder) Decode(packet channeltypes.Packet) (*MyICS20Payload, error) { | ||
| var data types.FungibleTokenPacketData | ||
|
There was a problem hiding this comment. This decoder is for ics-20 packets only and can not be plugged into ics-29 for example There was a problem hiding this comment. it would not be hard to provide a generic decoder. Question is if the payload type still makes sense. type Memoable interface {
gogoproto.Message
GetMemo() string
}
type MyGenericMemoDecoder [T Memoable] struct {}
func (m MyGenericMemoDecoder[T]) Decode(packet channeltypes.Packet) (*MyICS20Payload, error) {
var data T
if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), data); err != nil {
return nil, err
}
// do we need a sanity check that type was unpacked proper? like denom not empty
if data.GetMemo() == "" {
return nil, nil
}
... |
||
| if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil { | ||
| return nil, err | ||
| } | ||
| // do we need a sanity check that type was unpacked proper? like denom not empty | ||
|
|
||
| if data.Memo == "" { | ||
| return nil, nil | ||
| } | ||
| // unmarshal json to type, I prefer using concrete type here: | ||
| var r MyICS20Payload | ||
| if err := json.Unmarshal([]byte(data.Memo), &r); err != nil { | ||
| return nil, err | ||
| } | ||
| // todo: check that contains valid data | ||
| return &r, nil | ||
| } | ||
|
|
||
| var _ Executor[MyICS20Payload] = &MyICS20Callbacks{} | ||
|
There was a problem hiding this comment. Executor for ics20 only. my assumption was that chains may want to customize the callbacks for each of the ibc apps. |
||
|
|
||
| type MyICS20Callbacks struct { //nolint:gofumpt | ||
| } | ||
|
|
||
| func (m MyICS20Callbacks) OnRecvPacket(ctx sdk.Context, obj MyICS20Payload, relayer sdk.AccAddress) error { | ||
| ctx.Logger().Info("OnRecvPacket executed") | ||
| return nil | ||
| } | ||
|
|
||
| func (m MyICS20Callbacks) OnAcknowledgementPacket(ctx sdk.Context, obj MyICS20Payload, acknowledgement []byte, relayer sdk.AccAddress) error { | ||
| ctx.Logger().Info("OnAcknowledgementPacket executed") | ||
| return nil | ||
| } | ||
|
|
||
| func (m MyICS20Callbacks) OnTimeoutPacket(ctx sdk.Context, obj MyICS20Payload, relayer sdk.AccAddress) error { | ||
| ctx.Logger().Info("OnTimeoutPacket executed") | ||
| return nil | ||
| } | ||
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
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.
Usage of pointers for value unset instead of 0.