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

refactor(templates): use go context instead of sdk.Context #4445

Merged
merged 5 commits into from
Dec 16, 2024
Merged

refactor(templates): use go context instead of sdk.Context #4445

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8013e8c
refactor(templates): use go context instead of sdk.Context
julienrbrt Dec 15, 2024
11a3fe7
updates
julienrbrt Dec 15, 2024
2f3d2bd
spacing
julienrbrt Dec 15, 2024
fcc0dfc
updates
julienrbrt Dec 16, 2024
a8df50c
Merge branch 'main' into julien/sdk-context
julienrbrt Dec 16, 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
2 changes: 1 addition & 1 deletion ignite/templates/app/files/app/export.go.plush
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func (app *App) ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs
// NOTE zero height genesis is a temporary feature which will be deprecated
//
// in favor of export at a block height
func (app *App) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []string) {
func (app *App) prepForZeroHeightGenesis(ctx context.Context, jailAllowedAddrs []string) {
applyAllowedAddrs := false

// check if there is a allowed address list
Expand Down
12 changes: 6 additions & 6 deletions ignite/templates/ibc/files/packet/component/x/{{moduleName}}/keeper/{{packetName}}.go.plush
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package keeper

import (
"errors"
"context"
"errors"

errorsmod "cosmossdk.io/errors"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"<%= ModulePath %>/x/<%= moduleName %>/types"
clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
Expand All @@ -14,7 +14,7 @@ import (

// Transmit<%= packetName.UpperCamel %>Packet transmits the packet over IBC with the specified source port and source channel
func (k Keeper) Transmit<%= packetName.UpperCamel %>Packet(
ctx sdk.Context,
ctx context.Context,
packetData types.<%= packetName.UpperCamel %>PacketData,
sourcePort,
sourceChannel string,
Expand All @@ -35,7 +35,7 @@ func (k Keeper) Transmit<%= packetName.UpperCamel %>Packet(
}

// OnRecv<%= packetName.UpperCamel %>Packet processes packet reception
func (k Keeper) OnRecv<%= packetName.UpperCamel %>Packet(ctx sdk.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData) (packetAck types.<%= packetName.UpperCamel %>PacketAck, err error) {
func (k Keeper) OnRecv<%= packetName.UpperCamel %>Packet(ctx context.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData) (packetAck types.<%= packetName.UpperCamel %>PacketAck, err error) {
// validate packet data upon receiving

// TODO: packet reception logic
Expand All @@ -45,7 +45,7 @@ func (k Keeper) OnRecv<%= packetName.UpperCamel %>Packet(ctx sdk.Context, packet

// OnAcknowledgement<%= packetName.UpperCamel %>Packet responds to the success or failure of a packet
// acknowledgement written on the receiving chain.
func (k Keeper) OnAcknowledgement<%= packetName.UpperCamel %>Packet(ctx sdk.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData, ack channeltypes.Acknowledgement) error {
func (k Keeper) OnAcknowledgement<%= packetName.UpperCamel %>Packet(ctx context.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData, ack channeltypes.Acknowledgement) error {
switch dispatchedAck := ack.Response.(type) {
case *channeltypes.Acknowledgement_Error:

Expand All @@ -72,7 +72,7 @@ func (k Keeper) OnAcknowledgement<%= packetName.UpperCamel %>Packet(ctx sdk.Cont
}

// OnTimeout<%= packetName.UpperCamel %>Packet responds to the case where a packet has not been transmitted because of a timeout
func (k Keeper) OnTimeout<%= packetName.UpperCamel %>Packet(ctx sdk.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData) error {
func (k Keeper) OnTimeout<%= packetName.UpperCamel %>Packet(ctx context.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData) error {

// TODO: packet timeout logic

Expand Down
47 changes: 21 additions & 26 deletions ignite/templates/module/create/files/ibc/x/{{moduleName}}/module/module_ibc.go.plush
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ package <%= moduleName %>
import (
"fmt"

"cosmossdk.io/core/event"
errorsmod "cosmossdk.io/errors"

sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
capabilitytypes "github.com/cosmos/ibc-go/modules/capability/types"
Expand All @@ -29,7 +31,7 @@ func NewIBCModule(k keeper.Keeper) IBCModule {

// OnChanOpenInit implements the IBCModule interface
func (im IBCModule) OnChanOpenInit(
ctx sdk.Context,
ctx context.Context,
order channeltypes.Order,
connectionHops []string,
portID string,
Expand Down Expand Up @@ -62,7 +64,7 @@ func (im IBCModule) OnChanOpenInit(

// OnChanOpenTry implements the IBCModule interface
func (im IBCModule) OnChanOpenTry(
ctx sdk.Context,
ctx context.Context,
order channeltypes.Order,
connectionHops []string,
portID,
Expand Down Expand Up @@ -101,7 +103,7 @@ func (im IBCModule) OnChanOpenTry(

// OnChanOpenAck implements the IBCModule interface
func (im IBCModule) OnChanOpenAck(
ctx sdk.Context,
ctx context.Context,
portID,
channelID string,
_,
Expand All @@ -115,7 +117,7 @@ func (im IBCModule) OnChanOpenAck(

// OnChanOpenConfirm implements the IBCModule interface
func (im IBCModule) OnChanOpenConfirm(
ctx sdk.Context,
ctx context.Context,
portID,
channelID string,
) error {
Expand All @@ -124,7 +126,7 @@ func (im IBCModule) OnChanOpenConfirm(

// OnChanCloseInit implements the IBCModule interface
func (im IBCModule) OnChanCloseInit(
ctx sdk.Context,
ctx context.Context,
portID,
channelID string,
) error {
Expand All @@ -134,7 +136,7 @@ func (im IBCModule) OnChanCloseInit(

// OnChanCloseConfirm implements the IBCModule interface
func (im IBCModule) OnChanCloseConfirm(
ctx sdk.Context,
ctx context.Context,
portID,
channelID string,
) error {
Expand All @@ -143,7 +145,7 @@ func (im IBCModule) OnChanCloseConfirm(

// OnRecvPacket implements the IBCModule interface
func (im IBCModule) OnRecvPacket(
ctx sdk.Context,
ctx context.Context,
modulePacket channeltypes.Packet,
relayer sdk.AccAddress,
) ibcexported.Acknowledgement {
Expand All @@ -168,7 +170,7 @@ func (im IBCModule) OnRecvPacket(

// OnAcknowledgementPacket implements the IBCModule interface
func (im IBCModule) OnAcknowledgementPacket(
ctx sdk.Context,
ctx context.Context,
modulePacket channeltypes.Packet,
acknowledgement []byte,
relayer sdk.AccAddress,
Expand All @@ -193,28 +195,21 @@ func (im IBCModule) OnAcknowledgementPacket(
return errorsmod.Wrap(sdkerrors.ErrUnknownRequest, errMsg)
}

ctx.EventManager().EmitEvent(
sdk.NewEvent(
eventType,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(types.AttributeKeyAck, fmt.Sprintf("%v", ack)),
),
)
_ = im.EventService.EventManager(ctx).EmitKV(
eventType,
event.NewAttribute(types.AttributeKeyAck, fmt.Sprintf("%v", ack)),
)

switch resp := ack.Response.(type) {
case *channeltypes.Acknowledgement_Result:
ctx.EventManager().EmitEvent(
sdk.NewEvent(
eventType,
sdk.NewAttribute(types.AttributeKeyAckSuccess, string(resp.Result)),
),
_ = im.EventService.EventManager(ctx).EmitKV(
eventType,
event.NewAttribute(types.AttributeKeyAckSuccess, string(resp.Result)),
)
case *channeltypes.Acknowledgement_Error:
ctx.EventManager().EmitEvent(
sdk.NewEvent(
eventType,
sdk.NewAttribute(types.AttributeKeyAckError, resp.Error),
),
_ = im.EventService.EventManager(ctx).EmitKV(
eventType,
event.NewAttribute(types.AttributeKeyAckError, resp.Error),
)
}

Expand All @@ -223,7 +218,7 @@ func (im IBCModule) OnAcknowledgementPacket(

// OnTimeoutPacket implements the IBCModule interface
func (im IBCModule) OnTimeoutPacket(
ctx sdk.Context,
ctx context.Context,
modulePacket channeltypes.Packet,
relayer sdk.AccAddress,
) error {
Expand Down
6 changes: 3 additions & 3 deletions integration/relayer/cmd_relayer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ var (

nameOnRecvIbcPostPacket = "OnRecvIbcPostPacket"
funcOnRecvIbcPostPacket = `package keeper
func (k Keeper) OnRecvIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData) (packetAck types.IbcPostPacketAck, err error) {
func (k Keeper) OnRecvIbcPostPacket(ctx context.Context, packet channeltypes.Packet, data types.IbcPostPacketData) (packetAck types.IbcPostPacketAck, err error) {
packetAck.PostId, err = k.PostSeq.Next(ctx)
if err != nil {
return packetAck, err
Expand All @@ -139,7 +139,7 @@ func (k Keeper) OnRecvIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet,

nameOnAcknowledgementIbcPostPacket = "OnAcknowledgementIbcPostPacket"
funcOnAcknowledgementIbcPostPacket = `package keeper
func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData, ack channeltypes.Acknowledgement) error {
func (k Keeper) OnAcknowledgementIbcPostPacket(ctx context.Context, packet channeltypes.Packet, data types.IbcPostPacketData, ack channeltypes.Acknowledgement) error {
switch dispatchedAck := ack.Response.(type) {
case *channeltypes.Acknowledgement_Error:
// We will not treat acknowledgment error in this tutorial
Expand Down Expand Up @@ -171,7 +171,7 @@ func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channelty

nameOnTimeoutIbcPostPacket = "OnTimeoutIbcPostPacket"
funcOnTimeoutIbcPostPacket = `package keeper
func (k Keeper) OnTimeoutIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData) error {
func (k Keeper) OnTimeoutIbcPostPacket(ctx context.Context, packet channeltypes.Packet, data types.IbcPostPacketData) error {
seq, err := k.TimeoutPostSeq.Next(ctx)
if err != nil {
return err
Expand Down
Loading