keeper

Documentation

Index

• Variables
• type ForwardMetadata
  • func (m *ForwardMetadata) Validate() error
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, key storetypes.StoreKey, paramSpace paramtypes.Subspace, ...) 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) GetFeePercentage(ctx sdk.Context) sdk.Dec
  • func (k Keeper) GetParams(ctx sdk.Context) types.Params
  • func (k Keeper) InitGenesis(ctx sdk.Context, state types.GenesisState)
  • func (k Keeper) Logger(ctx sdk.Context) log.Logger
  • func (k Keeper) Params(c context.Context, _ *types.QueryParamsRequest) (*types.QueryParamsResponse, 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) SetParams(ctx sdk.Context, params types.Params)
  • func (k Keeper) TimeoutShouldRetry(ctx sdk.Context, packet channeltypes.Packet) (*types.InFlightPacket, error)
  • func (k Keeper) WriteAcknowledgementForForwardedPacket(ctx sdk.Context, packet channeltypes.Packet, ...) error
• type PacketMetadata

Variables

var (
	// Timeout height following IBC defaults
	DefaultTransferPacketTimeoutHeight = clienttypes.Height{
		RevisionNumber: 0,
		RevisionHeight: 0,
	}
	// Timeout timestamp following IBC defaults
	DefaultForwardTransferPacketTimeoutTimestamp = time.Duration(transfertypes.DefaultRelativePacketTimeoutTimestamp) * time.Nanosecond

	// 28 day timeout for refund packets since funds are stuck in router module otherwise.
	DefaultRefundTransferPacketTimeoutTimestamp = 28 * 24 * time.Hour
)

Types

type ForwardMetadata

type ForwardMetadata struct {
	Receiver string        `json:"receiver,omitempty"`
	Port     string        `json:"port,omitempty"`
	Channel  string        `json:"channel,omitempty"`
	Timeout  time.Duration `json:"timeout,omitempty"`
	Retries  *uint8        `json:"retries,omitempty"`
	Next     *string       `json:"next,omitempty"`
}

func (*ForwardMetadata) Validate

func (m *ForwardMetadata) Validate() error

type Keeper

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

Keeper defines the IBC fungible transfer keeper

func NewKeeper

func NewKeeper(
	cdc codec.BinaryCodec, key storetypes.StoreKey, paramSpace paramtypes.Subspace,
	transferKeeper types.TransferKeeper, channelKeeper types.ChannelKeeper,
	distrKeeper types.DistributionKeeper, bankKeeper types.BankKeeper,
) Keeper

NewKeeper creates a new 29-fee 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 *ForwardMetadata,
	token sdk.Coin,
	maxRetries uint8,
	timeout time.Duration,
	labels []metrics.Label,
) 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) GetFeePercentage

func (k Keeper) GetFeePercentage(ctx sdk.Context) sdk.Dec

GetSendEnabled retrieves the send enabled boolean from the paramstore

func (Keeper) GetParams

func (k Keeper) GetParams(ctx sdk.Context) types.Params

GetParams returns the total set of ibc-transfer parameters.

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) Params

func (k Keeper) Params(c context.Context, _ *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

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) SetParams

func (k Keeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the total set of ibc-transfer parameters.

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) WriteAcknowledgementForForwardedPacket

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

type PacketMetadata

type PacketMetadata struct {
	Forward *ForwardMetadata `json:"forward"`
}