keeper

Documentation

Index

• Variables
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, key storetypes.StoreKey, ...) *Keeper
  • func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState
  • func (k *Keeper) ForwardTransferPacket(ctx sdk.Context, inFlightPacket *types.InFlightPacket, ...) error
  • func (k *Keeper) GetAndClearInFlightPacket(ctx sdk.Context, channel string, port string, sequence uint64) *types.InFlightPacket
  • func (k *Keeper) GetAppVersion(ctx sdk.Context, portID, channelID string) (string, bool)
  • func (k Keeper) GetAuthority() string
  • func (k Keeper) InitGenesis(ctx sdk.Context, state types.GenesisState)
  • func (k *Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k *Keeper) LookupModuleByChannel(ctx sdk.Context, portID, channelID string) (string, *capabilitytypes.Capability, error)
  • func (k *Keeper) RemoveInFlightPacket(ctx sdk.Context, packet channeltypes.Packet)
  • func (k *Keeper) RetryTimeout(ctx sdk.Context, channel, port string, ...) error
  • func (k Keeper) SendPacket(ctx sdk.Context, chanCap *capabilitytypes.Capability, sourcePort string, ...) (sequence uint64, err error)
  • func (k *Keeper) SetTransferKeeper(transferKeeper types.TransferKeeper)
  • func (k *Keeper) TimeoutShouldRetry(ctx sdk.Context, packet channeltypes.Packet) (*types.InFlightPacket, error)
  • func (k *Keeper) WriteAcknowledgement(ctx sdk.Context, chanCap *capabilitytypes.Capability, ...) error
  • func (k *Keeper) WriteAcknowledgementForForwardedPacket(ctx sdk.Context, packet channeltypes.Packet, ...) error
• type Migrator
  • func NewMigrator(k *Keeper) Migrator
  • func (m Migrator) Migrate2to3(ctx sdk.Context) error

Variables

var (
	// DefaultTransferPacketTimeoutHeight is the timeout height following IBC defaults
	DefaultTransferPacketTimeoutHeight = clienttypes.Height{
		RevisionNumber: 0,
		RevisionHeight: 0,
	}

	// DefaultForwardTransferPacketTimeoutTimestamp is the timeout timestamp following IBC defaults
	DefaultForwardTransferPacketTimeoutTimestamp = time.Duration(transfertypes.DefaultRelativePacketTimeoutTimestamp) * time.Nanosecond
)

Types

type Keeper

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper defines the packet forward middleware keeper

func NewKeeper

func NewKeeper(
	cdc codec.BinaryCodec,
	key storetypes.StoreKey,
	transferKeeper types.TransferKeeper,
	channelKeeper types.ChannelKeeper,
	bankKeeper types.BankKeeper,
	ics4Wrapper porttypes.ICS4Wrapper,
	authority string,
) *Keeper

NewKeeper creates a new forward Keeper instance

func (Keeper) ExportGenesis

func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState

ExportGenesis

func (*Keeper) ForwardTransferPacket

func (k *Keeper) ForwardTransferPacket(
	ctx sdk.Context,
	inFlightPacket *types.InFlightPacket,
	srcPacket channeltypes.Packet,
	srcPacketSender string,
	receiver string,
	metadata *types.ForwardMetadata,
	token sdk.Coin,
	maxRetries uint8,
	timeout time.Duration,
	labels []metrics.Label,
	nonrefundable bool,
) error

func (*Keeper) GetAndClearInFlightPacket

func (k *Keeper) GetAndClearInFlightPacket(
	ctx sdk.Context,
	channel string,
	port string,
	sequence uint64,
) *types.InFlightPacket

GetAndClearInFlightPacket will fetch an InFlightPacket from the store, remove it if it exists, and return it.

func (*Keeper) GetAppVersion

func (k *Keeper) GetAppVersion(
	ctx sdk.Context,
	portID,
	channelID string,
) (string, bool)

WriteAcknowledgement wraps IBC ICS4Wrapper GetAppVersion function.

func (Keeper) GetAuthority

func (k Keeper) GetAuthority() string

GetAuthority returns the module's authority.

func (Keeper) InitGenesis

func (k Keeper) InitGenesis(ctx sdk.Context, state types.GenesisState)

InitGenesis

func (*Keeper) Logger

func (k *Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (*Keeper) LookupModuleByChannel

func (k *Keeper) LookupModuleByChannel(ctx sdk.Context, portID, channelID string) (string, *capabilitytypes.Capability, error)

LookupModuleByChannel wraps ChannelKeeper LookupModuleByChannel function.

func (*Keeper) RemoveInFlightPacket

func (k *Keeper) RemoveInFlightPacket(ctx sdk.Context, packet channeltypes.Packet)

func (*Keeper) RetryTimeout

func (k *Keeper) RetryTimeout(
	ctx sdk.Context,
	channel, port string,
	data transfertypes.FungibleTokenPacketData,
	inFlightPacket *types.InFlightPacket,
) error

func (Keeper) SendPacket

func (k Keeper) SendPacket(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	sourcePort string, sourceChannel string,
	timeoutHeight clienttypes.Height,
	timeoutTimestamp uint64,
	data []byte,
) (sequence uint64, err error)

SendPacket wraps IBC ChannelKeeper's SendPacket function

func (*Keeper) SetTransferKeeper

func (k *Keeper) SetTransferKeeper(transferKeeper types.TransferKeeper)

SetTransferKeeper sets the transferKeeper

func (*Keeper) TimeoutShouldRetry

func (k *Keeper) TimeoutShouldRetry(
	ctx sdk.Context,
	packet channeltypes.Packet,
) (*types.InFlightPacket, error)

TimeoutShouldRetry returns inFlightPacket and no error if retry should be attempted. Error is returned if IBC refund should occur.

func (*Keeper) WriteAcknowledgement

func (k *Keeper) WriteAcknowledgement(ctx sdk.Context, chanCap *capabilitytypes.Capability, packet ibcexported.PacketI, acknowledgement ibcexported.Acknowledgement) error

WriteAcknowledgement wraps IBC ICS4Wrapper WriteAcknowledgement function. ICS29 WriteAcknowledgement is used for asynchronous acknowledgements.

func (*Keeper) WriteAcknowledgementForForwardedPacket

func (k *Keeper) WriteAcknowledgementForForwardedPacket(
	ctx sdk.Context,
	packet channeltypes.Packet,
	data transfertypes.FungibleTokenPacketData,
	inFlightPacket *types.InFlightPacket,
	ack channeltypes.Acknowledgement,
) error

type Migrator

type Migrator struct {
	// contains filtered or unexported fields
}

Migrator is a struct for handling in-place state migrations.

func NewMigrator

func NewMigrator(k *Keeper) Migrator

func (Migrator) Migrate2to3

func (m Migrator) Migrate2to3(ctx sdk.Context) error

Migrate2to3 migrates the module state from the consensus version 2 to version 3