ibctransfer

Documentation

Index

• type AppModule
  • func NewAppModule(k Keeper) AppModule
• type AppModuleBasic
• type GmpKeeper
• type IBCModule
  • func NewIBCModule(k Keeper) IBCModule
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, key storetypes.StoreKey, paramSpace paramtypes.Subspace, ...) Keeper
  • func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.MsgTransferResponse, error)

Types

type AppModule

type AppModule struct {
	ibctransfer.AppModule
	// contains filtered or unexported fields
}

AppModule represents the AppModule for this module

func NewAppModule

func NewAppModule(k Keeper) AppModule

NewAppModule creates a new 20-transfer module

type AppModuleBasic

type AppModuleBasic struct {
	ibctransfer.AppModuleBasic
}

AppModuleBasic is the IBC Transfer AppModuleBasic

type GmpKeeper

type GmpKeeper interface {
	GetParams(ctx sdk.Context) (params gmptypes.Params)
	BuildGmpRequest(
		goCtx context.Context,
		msg *gmptypes.MsgRelayPrice,
	) (*ibctransfertypes.MsgTransfer, error)
}

GmpKeeper defines the expected GmpKeeper interface needed by the IBCTransfer keeper.

type IBCModule

type IBCModule struct {
	ibctransfer.IBCModule
	// contains filtered or unexported fields
}

IBCModule implements the ICS26 interface for transfer given the transfer keeper.

func NewIBCModule

func NewIBCModule(k Keeper) IBCModule

NewIBCModule creates a new IBCModule given the keeper

type Keeper

type Keeper struct {
	ibctransferkeeper.Keeper

	GmpKeeper *GmpKeeper
	// contains filtered or unexported fields
}

func NewKeeper

func NewKeeper(
	cdc codec.BinaryCodec, key storetypes.StoreKey, paramSpace paramtypes.Subspace,
	ics4Wrapper porttypes.ICS4Wrapper, channelKeeper types.ChannelKeeper, portKeeper types.PortKeeper,
	authKeeper types.AccountKeeper, bankKeeper types.BankKeeper, scopedKeeper exported.ScopedKeeper,
	gmpKeeper GmpKeeper,
) Keeper

NewKeeper creates a new IBC transfer Keeper instance

func (Keeper) Transfer

func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.MsgTransferResponse, error)

Transfer defines a wrapper function for the ICS20 Transfer method. If the receiver for the tx is axelar's GMP address, Then it expects a payload of the gmptypes.MsgRelayPrice msg. If it does not have this format, it will error out. If it does, it will build a MsgTransfer with the payload.