Skip to content

chore: ics29 fee payee event emission #1568

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

Merged
damiannolan merged 2 commits into from
Jun 23, 2022
Merged

chore: ics29 fee payee event emission #1568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38c64e0
adding event emission for registered payees and counterparty payees i…
damiannolan Jun 22, 2022
90a1712
updating naming of event emission funcs
damiannolan Jun 22, 2022
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
32 changes: 32 additions & 0 deletions modules/apps/29-fee/keeper/events.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,35 @@ func EmitIncentivizedPacketEvent(ctx sdk.Context, packetID channeltypes.PacketId
),
)
}

// EmitRegisterPayeeEvent emits an event containing information of a registered payee for a relayer on a particular channel
func EmitRegisterPayeeEvent(ctx sdk.Context, relayer, payee, channelID string) {
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeRegisterPayee,
sdk.NewAttribute(types.AttributeKeyRelayer, relayer),
sdk.NewAttribute(types.AttributeKeyPayee, payee),
sdk.NewAttribute(types.AttributeKeyChannelID, channelID),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
),
})
}

// EmitRegisterCounterpartyPayeeEvent emits an event containing information of a registered counterparty payee for a relayer on a particular channel
func EmitRegisterCounterpartyPayeeEvent(ctx sdk.Context, relayer, counterpartyPayee, channelID string) {
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeRegisterCounterpartyPayee,
sdk.NewAttribute(types.AttributeKeyRelayer, relayer),
sdk.NewAttribute(types.AttributeKeyCounterpartyPayee, counterpartyPayee),
sdk.NewAttribute(types.AttributeKeyChannelID, channelID),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
),
})
}
4 changes: 4 additions & 0 deletions modules/apps/29-fee/keeper/msg_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ func (k Keeper) RegisterPayee(goCtx context.Context, msg *types.MsgRegisterPayee

k.Logger(ctx).Info("registering payee address for relayer", "relayer", msg.Relayer, "payee", msg.Payee, "channel", msg.ChannelId)

EmitRegisterPayeeEvent(ctx, msg.Relayer, msg.Payee, msg.ChannelId)

return &types.MsgRegisterPayeeResponse{}, nil
}

Expand All @@ -57,6 +59,8 @@ func (k Keeper) RegisterCounterpartyPayee(goCtx context.Context, msg *types.MsgR

k.Logger(ctx).Info("registering counterparty payee for relayer", "relayer", msg.Relayer, "counterparty payee", msg.CounterpartyPayee, "channel", msg.ChannelId)

EmitRegisterCounterpartyPayeeEvent(ctx, msg.Relayer, msg.CounterpartyPayee, msg.ChannelId)

return &types.MsgRegisterCounterpartyPayeeResponse{}, nil
}

Expand Down
14 changes: 10 additions & 4 deletions modules/apps/29-fee/types/events.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@ package types

// 29-fee events
const (
EventTypeIncentivizedPacket = "incentivized_ibc_packet"
EventTypeIncentivizedPacket = "incentivized_ibc_packet"
EventTypeRegisterPayee = "register_payee"
Copy link
Contributor

@seantking seantking Jun 23, 2022

Choose a reason for hiding this comment

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

just thinking aloud would there be a benefit to prefixing these events with say ics29_register_payee. In the future, there may be similar events from other modules it might become harder to distinguish?

Copy link
Contributor Author

@damiannolan damiannolan Jun 23, 2022

Choose a reason for hiding this comment

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

When we emit events we should always be including the sdk.AttributeKeyModule with the module name as well so it can be correlated like that pretty easily too I guess!

EventTypeRegisterCounterpartyPayee = "register_counterparty_payee"

AttributeKeyRecvFee = "recv_fee"
AttributeKeyAckFee = "ack_fee"
AttributeKeyTimeoutFee = "timeout_fee"
AttributeKeyRecvFee = "recv_fee"
AttributeKeyAckFee = "ack_fee"
AttributeKeyTimeoutFee = "timeout_fee"
AttributeKeyChannelID = "channel_id"
AttributeKeyRelayer = "relayer"
AttributeKeyPayee = "payee"
AttributeKeyCounterpartyPayee = "counterparty_payee"
)