Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(transfer): emit forwarding information in events. #6647

Merged
merged 3 commits into from
Jun 20, 2024
Merged

chore(transfer): emit forwarding information in events. #6647

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
affe572
chore(transfer): emit forwarding information in events.
DimitrisJim Jun 19, 2024
2292cdc
nit: rename as per Carlos's suggestion
DimitrisJim Jun 20, 2024
9f13c62
Merge branch 'feat/ics20-v2-path-forwarding' into jim/emit-forwarding…
DimitrisJim Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions modules/apps/transfer/ibc_module_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,15 @@ func (suite *TransferTestSuite) TestOnRecvPacket() {
types.NewForwarding("", types.Hop{PortId: "transfer", ChannelId: "channel-0"}),
)
packet.Data = packetData.GetBytes()

forwardingBz, err := json.Marshal(packetData.Forwarding)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

way this test is written is slightly annoying, can also directly modify the expectedAttribute's 4th element if the loop is overkill.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about generating expected events after the tc.malleate() call?

Copy link
Contributor Author

@DimitrisJim DimitrisJim Jun 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to make it conditional for the test case where packet data cannot be marshalled no? (fill in all those empty event fields). Issue here is we malleate both packet and events and generate events based on packet, will give a quick look again if I'm missing something obvious.

edit: not seeing it, at least not this morning 😄 please do open issue if you're seeing some thing I'm not getting

suite.Require().NoError(err)
for i, attr := range expectedAttributes {
if attr.Key == types.AttributeKeyForwarding {
expectedAttributes[i].Value = string(forwardingBz)
break
}
}
},
nil,
"",
Expand All @@ -316,11 +325,15 @@ func (suite *TransferTestSuite) TestOnRecvPacket() {
packet.Data = []byte("invalid data")

// Override expected attributes because this fails on unmarshaling packet data (so can't get the attributes)
forwardingBz, err := json.Marshal(types.Forwarding{})
suite.Require().NoError(err)

expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(types.AttributeKeySender, ""),
sdk.NewAttribute(types.AttributeKeyReceiver, ""),
sdk.NewAttribute(types.AttributeKeyTokens, "null"),
sdk.NewAttribute(types.AttributeKeyMemo, ""),
sdk.NewAttribute(types.AttributeKeyForwarding, string(forwardingBz)),
sdk.NewAttribute(types.AttributeKeyAckSuccess, "false"),
sdk.NewAttribute(types.AttributeKeyAckError, "cannot unmarshal ICS20-V2 transfer packet data: invalid character 'i' looking for beginning of value: invalid type: invalid type"),
}
Expand Down Expand Up @@ -360,11 +373,15 @@ func (suite *TransferTestSuite) TestOnRecvPacket() {

tokensBz, err := json.Marshal(packetData.Tokens)
suite.Require().NoError(err)
forwardingBz, err := json.Marshal(packetData.Forwarding)
suite.Require().NoError(err)

expectedAttributes = []sdk.Attribute{
sdk.NewAttribute(types.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyTokens, string(tokensBz)),
sdk.NewAttribute(types.AttributeKeyMemo, packetData.Memo),
sdk.NewAttribute(types.AttributeKeyForwarding, string(forwardingBz)),
}
if tc.expAck == nil || tc.expAck.Success() {
expectedAttributes = append(expectedAttributes, sdk.NewAttribute(types.AttributeKeyAckSuccess, "true"))
Expand Down
30 changes: 19 additions & 11 deletions modules/apps/transfer/internal/events/events.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,18 @@ import (
)

// EmitTransferEvent emits a ibc transfer event on successful transfers.
func EmitTransferEvent(ctx sdk.Context, sender, receiver string, tokens types.Tokens, memo string) {
jsonTokens := mustMarshalType[types.Tokens](tokens)
func EmitTransferEvent(ctx sdk.Context, sender, receiver string, tokens types.Tokens, memo string, forwarding types.Forwarding) {
tokensBz := mustMarshalType[types.Tokens](tokens)
forwardingBz := mustMarshalType[types.Forwarding](forwarding)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since mustMarshalType returns a string, should these variables be tokensStr and forwardingStr instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you're definitely right there.


ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeTransfer,
sdk.NewAttribute(types.AttributeKeySender, sender),
sdk.NewAttribute(types.AttributeKeyReceiver, receiver),
sdk.NewAttribute(types.AttributeKeyTokens, jsonTokens),
sdk.NewAttribute(types.AttributeKeyTokens, tokensBz),
sdk.NewAttribute(types.AttributeKeyMemo, memo),
sdk.NewAttribute(types.AttributeKeyForwarding, forwardingBz),
),
sdk.NewEvent(
sdk.EventTypeMessage,
Expand All @@ -31,13 +33,15 @@ func EmitTransferEvent(ctx sdk.Context, sender, receiver string, tokens types.To

// EmitOnRecvPacketEvent emits a fungible token packet event in the OnRecvPacket callback
func EmitOnRecvPacketEvent(ctx sdk.Context, packetData types.FungibleTokenPacketDataV2, ack channeltypes.Acknowledgement, ackErr error) {
jsonTokens := mustMarshalType[types.Tokens](packetData.Tokens)
tokensBz := mustMarshalType[types.Tokens](packetData.Tokens)
forwardingBz := mustMarshalType[types.Forwarding](packetData.Forwarding)

eventAttributes := []sdk.Attribute{
sdk.NewAttribute(types.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyTokens, jsonTokens),
sdk.NewAttribute(types.AttributeKeyTokens, tokensBz),
sdk.NewAttribute(types.AttributeKeyMemo, packetData.Memo),
sdk.NewAttribute(types.AttributeKeyForwarding, forwardingBz),
sdk.NewAttribute(types.AttributeKeyAckSuccess, strconv.FormatBool(ack.Success())),
}

Expand All @@ -59,15 +63,17 @@ func EmitOnRecvPacketEvent(ctx sdk.Context, packetData types.FungibleTokenPacket

// EmitOnAcknowledgementPacketEvent emits a fungible token packet event in the OnAcknowledgementPacket callback
func EmitOnAcknowledgementPacketEvent(ctx sdk.Context, packetData types.FungibleTokenPacketDataV2, ack channeltypes.Acknowledgement) {
jsonTokens := mustMarshalType[types.Tokens](types.Tokens(packetData.Tokens))
tokensBz := mustMarshalType[types.Tokens](packetData.Tokens)
forwardingBz := mustMarshalType[types.Forwarding](packetData.Forwarding)

ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypePacket,
sdk.NewAttribute(sdk.AttributeKeySender, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Receiver),
sdk.NewAttribute(types.AttributeKeyTokens, jsonTokens),
sdk.NewAttribute(types.AttributeKeyTokens, tokensBz),
sdk.NewAttribute(types.AttributeKeyMemo, packetData.Memo),
sdk.NewAttribute(types.AttributeKeyForwarding, forwardingBz),
sdk.NewAttribute(types.AttributeKeyAck, ack.String()),
),
sdk.NewEvent(
Expand Down Expand Up @@ -96,14 +102,16 @@ func EmitOnAcknowledgementPacketEvent(ctx sdk.Context, packetData types.Fungible

// EmitOnTimeoutPacketEvent emits a fungible token packet event in the OnTimeoutPacket callback
func EmitOnTimeoutEvent(ctx sdk.Context, packetData types.FungibleTokenPacketDataV2) {
jsonTokens := mustMarshalType[types.Tokens](types.Tokens(packetData.Tokens))
tokensBz := mustMarshalType[types.Tokens](packetData.Tokens)
forwardingBz := mustMarshalType[types.Forwarding](packetData.Forwarding)

ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeTimeout,
sdk.NewAttribute(types.AttributeKeyReceiver, packetData.Sender),
sdk.NewAttribute(types.AttributeKeyRefundTokens, jsonTokens),
sdk.NewAttribute(types.AttributeKeyRefundTokens, tokensBz),
sdk.NewAttribute(types.AttributeKeyMemo, packetData.Memo),
sdk.NewAttribute(types.AttributeKeyForwarding, forwardingBz),
),
sdk.NewEvent(
sdk.EventTypeMessage,
Expand All @@ -114,13 +122,13 @@ func EmitOnTimeoutEvent(ctx sdk.Context, packetData types.FungibleTokenPacketDat

// EmitDenomEvent emits a denomination event in the OnRecv callback.
func EmitDenomEvent(ctx sdk.Context, token types.Token) {
jsonDenom := mustMarshalType[types.Denom](token.Denom)
denomBz := mustMarshalType[types.Denom](token.Denom)

ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventTypeDenom,
sdk.NewAttribute(types.AttributeKeyDenomHash, token.Denom.Hash().String()),
sdk.NewAttribute(types.AttributeKeyDenom, jsonDenom),
sdk.NewAttribute(types.AttributeKeyDenom, denomBz),
),
)
}
Expand Down
8 changes: 6 additions & 2 deletions modules/apps/transfer/keeper/msg_server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,10 @@ func (suite *KeeperTestSuite) TestMsgTransfer() {
tokens = append(tokens, token)
}

jsonTokens, err := json.Marshal(types.Tokens(tokens))
tokensBz, err := json.Marshal(types.Tokens(tokens))
suite.Require().NoError(err)

forwardingBz, err := json.Marshal(msg.Forwarding)
suite.Require().NoError(err)

res, err := suite.chainA.GetSimApp().TransferKeeper.Transfer(ctx, msg)
Expand All @@ -162,8 +165,9 @@ func (suite *KeeperTestSuite) TestMsgTransfer() {
sdk.NewEvent(types.EventTypeTransfer,
sdk.NewAttribute(types.AttributeKeySender, msg.Sender),
sdk.NewAttribute(types.AttributeKeyReceiver, msg.Receiver),
sdk.NewAttribute(types.AttributeKeyTokens, string(jsonTokens)),
sdk.NewAttribute(types.AttributeKeyTokens, string(tokensBz)),
sdk.NewAttribute(types.AttributeKeyMemo, msg.Memo),
sdk.NewAttribute(types.AttributeKeyForwarding, string(forwardingBz)),
),
sdk.NewEvent(
sdk.EventTypeMessage,
Expand Down
2 changes: 1 addition & 1 deletion modules/apps/transfer/keeper/relay.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func (k Keeper) sendTransfer(
return 0, err
}

events.EmitTransferEvent(ctx, sender.String(), receiver, tokens, memo)
events.EmitTransferEvent(ctx, sender.String(), receiver, tokens, memo, forwarding)

defer internaltelemetry.ReportTransferTelemetry(tokens, labels)

Expand Down
1 change: 1 addition & 0 deletions modules/apps/transfer/types/events.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ const (
AttributeKeyAck = "acknowledgement"
AttributeKeyAckError = "error"
AttributeKeyMemo = "memo"
AttributeKeyForwarding = "forwarding"
)
Loading