keeper

package
v9.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 5, 2024 License: MIT Imports: 28 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EmitChannelUpgradeAckEvent 

func EmitChannelUpgradeAckEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, upgrade types.Upgrade)

EmitChannelUpgradeAckEvent emits a channel upgrade ack event

func EmitChannelUpgradeCancelEvent 

func EmitChannelUpgradeCancelEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, upgrade types.Upgrade)

EmitChannelUpgradeCancelEvent emits an upgraded cancelled event.

func EmitChannelUpgradeConfirmEvent 

func EmitChannelUpgradeConfirmEvent(ctx sdk.Context, portID, channelID string, currentChannel types.Channel)

EmitChannelUpgradeConfirmEvent emits a channel upgrade confirm event

func EmitChannelUpgradeInitEvent 

func EmitChannelUpgradeInitEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, upgrade types.Upgrade)

EmitChannelUpgradeInitEvent emits a channel upgrade init event

func EmitChannelUpgradeOpenEvent 

func EmitChannelUpgradeOpenEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel)

EmitChannelUpgradeOpenEvent emits a channel upgrade open event

func EmitChannelUpgradeTimeoutEvent 

func EmitChannelUpgradeTimeoutEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, upgrade types.Upgrade)

EmitChannelUpgradeTimeoutEvent emits an upgrade timeout event.

func EmitChannelUpgradeTryEvent 

func EmitChannelUpgradeTryEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, upgrade types.Upgrade)

EmitChannelUpgradeTryEvent emits a channel upgrade try event

func EmitErrorReceiptEvent 

func EmitErrorReceiptEvent(ctx sdk.Context, portID string, channelID string, currentChannel types.Channel, err error)

EmitErrorReceiptEvent emits an error receipt event

Types

type Keeper 

type Keeper struct {
	// implements gRPC QueryServer interface
	types.QueryServer
	// contains filtered or unexported fields
}

Keeper defines the IBC channel keeper

func NewKeeper 

func NewKeeper(
	cdc codec.BinaryCodec, key storetypes.StoreKey,
	clientKeeper types.ClientKeeper, connectionKeeper types.ConnectionKeeper,
	portKeeper types.PortKeeper, scopedKeeper exported.ScopedKeeper,
) Keeper

NewKeeper creates a new IBC channel Keeper instance

func (Keeper) AcknowledgePacket 

func (k Keeper) AcknowledgePacket(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packet exported.PacketI,
	acknowledgement []byte,
	proof []byte,
	proofHeight exported.Height,
) error

AcknowledgePacket is called by a module to process the acknowledgement of a packet previously sent by the calling module on a channel to a counterparty module on the counterparty chain. Its intended usage is within the ante handler. AcknowledgePacket will clean up the packet commitment, which is no longer necessary since the packet has been received and acted upon. It will also increment NextSequenceAck in case of ORDERED channels.

func (Keeper) ChanCloseConfirm 

func (k Keeper) ChanCloseConfirm(
	ctx sdk.Context,
	portID,
	channelID string,
	chanCap *capabilitytypes.Capability,
	initProof []byte,
	proofHeight exported.Height,
) error

ChanCloseConfirm is called by the counterparty module to close their end of the channel, since the other end has been closed.

func (Keeper) ChanCloseConfirmWithCounterpartyUpgradeSequence added in v9.1.5 

func (k Keeper) ChanCloseConfirmWithCounterpartyUpgradeSequence(
	ctx sdk.Context,
	portID,
	channelID string,
	chanCap *capabilitytypes.Capability,
	initProof []byte,
	proofHeight exported.Height,
	counterpartyUpgradeSequence uint64,
) error

ChanCloseConfirmWithCounterpartyUpgradeSequence is called by the counterparty module to close their end of the channel, since the other end has been closed. The difference with ChanCloseConfirm is that it accepts an extra argument counterpartyUpgradeSequence that was needed for channel upgradability.

This function will be removed in ibc-go v9.0.0 and the API of ChanCloseConfirm will be updated.

func (Keeper) ChanCloseInit 

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

Closing Handshake

This section defines the set of functions required to close a channel handshake as defined in https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#closing-handshake

ChanCloseInit is called by either module to close their end of the channel. Once closed, channels cannot be reopened.

func (Keeper) ChanOpenAck 

func (k Keeper) ChanOpenAck(
	ctx sdk.Context,
	portID,
	channelID string,
	chanCap *capabilitytypes.Capability,
	counterpartyVersion,
	counterpartyChannelID string,
	tryProof []byte,
	proofHeight exported.Height,
) error

ChanOpenAck is called by the handshake-originating module to acknowledge the acceptance of the initial request by the counterparty module on the other chain.

func (Keeper) ChanOpenConfirm 

func (k Keeper) ChanOpenConfirm(
	ctx sdk.Context,
	portID,
	channelID string,
	chanCap *capabilitytypes.Capability,
	ackProof []byte,
	proofHeight exported.Height,
) error

ChanOpenConfirm is called by the handshake-accepting module to confirm the acknowledgement of the handshake-originating module on the other chain and finish the channel opening handshake.

func (Keeper) ChanOpenInit 

func (k Keeper) ChanOpenInit(
	ctx sdk.Context,
	order types.Order,
	connectionHops []string,
	portID string,
	portCap *capabilitytypes.Capability,
	counterparty types.Counterparty,
	version string,
) (string, *capabilitytypes.Capability, error)

ChanOpenInit is called by a module to initiate a channel opening handshake with a module on another chain. The counterparty channel identifier is validated to be empty in msg validation.

func (Keeper) ChanOpenTry 

func (k Keeper) ChanOpenTry(
	ctx sdk.Context,
	order types.Order,
	connectionHops []string,
	portID string,
	portCap *capabilitytypes.Capability,
	counterparty types.Counterparty,
	counterpartyVersion string,
	initProof []byte,
	proofHeight exported.Height,
) (string, *capabilitytypes.Capability, error)

ChanOpenTry is called by a module to accept the first step of a channel opening handshake initiated by a module on another chain.

func (Keeper) ChanUpgradeAck 

func (k Keeper) ChanUpgradeAck(
	ctx sdk.Context,
	portID,
	channelID string,
	counterpartyUpgrade types.Upgrade,
	channelProof,
	upgradeProof []byte,
	proofHeight clienttypes.Height,
) error

ChanUpgradeAck is called by a module to accept the ACKUPGRADE handshake step of the channel upgrade protocol. This method should only be called by the IBC core msg server. This method will verify that the counterparty has called the ChanUpgradeTry handler. and that its own upgrade is compatible with the selected counterparty version. NOTE: the channel may be in either the OPEN or FLUSHING state. The channel may be in OPEN if we are in the happy path. 

A -> Init (OPEN), B -> Try (FLUSHING), A -> Ack (begins in OPEN)

The channel may be in FLUSHING if we are in a crossing hellos situation. 

A -> Init (OPEN), B -> Init (OPEN) -> A -> Try (FLUSHING), B -> Try (FLUSHING), A -> Ack (begins in FLUSHING)

func (Keeper) ChanUpgradeCancel 

func (k Keeper) ChanUpgradeCancel(ctx sdk.Context, portID, channelID string, errorReceipt types.ErrorReceipt, errorReceiptProof []byte, proofHeight clienttypes.Height) error

ChanUpgradeCancel is called by the msg server to prove that an error receipt was written on the counterparty which constitutes a valid situation where the upgrade should be cancelled. An error is returned if sufficient evidence for cancelling the upgrade has not been provided.

func (Keeper) ChanUpgradeConfirm 

func (k Keeper) ChanUpgradeConfirm(
	ctx sdk.Context,
	portID,
	channelID string,
	counterpartyChannelState types.State,
	counterpartyUpgrade types.Upgrade,
	channelProof,
	upgradeProof []byte,
	proofHeight clienttypes.Height,
) error

ChanUpgradeConfirm is called on the chain which is on FLUSHING after chanUpgradeAck is called on the counterparty. This will inform the TRY chain of the timeout set on ACK by the counterparty. If the timeout has already exceeded, we will write an error receipt and restore.

func (Keeper) ChanUpgradeInit 

func (k Keeper) ChanUpgradeInit(
	ctx sdk.Context,
	portID string,
	channelID string,
	upgradeFields types.UpgradeFields,
) (types.Upgrade, error)

ChanUpgradeInit is called by a module to initiate a channel upgrade handshake with a module on another chain.

func (Keeper) ChanUpgradeOpen 

func (k Keeper) ChanUpgradeOpen(
	ctx sdk.Context,
	portID,
	channelID string,
	counterpartyChannelState types.State,
	counterpartyUpgradeSequence uint64,
	channelProof []byte,
	proofHeight clienttypes.Height,
) error

ChanUpgradeOpen is called by a module to complete the channel upgrade handshake and move the channel back to an OPEN state. This method should only be called after both channels have flushed any in-flight packets. This method should only be called directly by the core IBC message server.

func (Keeper) ChanUpgradeTimeout 

func (k Keeper) ChanUpgradeTimeout(
	ctx sdk.Context,
	portID, channelID string,
	counterpartyChannel types.Channel,
	counterpartyChannelProof []byte,
	proofHeight exported.Height,
) error

ChanUpgradeTimeout times out an outstanding upgrade. This should be used by the initialising chain when the counterparty chain has not responded to an upgrade proposal within the specified timeout period.

func (Keeper) ChanUpgradeTry 

func (k Keeper) ChanUpgradeTry(
	ctx sdk.Context,
	portID,
	channelID string,
	proposedConnectionHops []string,
	counterpartyUpgradeFields types.UpgradeFields,
	counterpartyUpgradeSequence uint64,
	channelProof,
	upgradeProof []byte,
	proofHeight clienttypes.Height,
) (types.Channel, types.Upgrade, error)

ChanUpgradeTry is called by a module to accept the first step of a channel upgrade handshake initiated by a module on another chain. If this function is successful, the proposed upgrade will be returned. If the upgrade fails, the upgrade sequence will still be incremented but an error will be returned.

func (Keeper) Channel 

func (k Keeper) Channel(c context.Context, req *types.QueryChannelRequest) (*types.QueryChannelResponse, error)

Channel implements the Query/Channel gRPC method

func (Keeper) ChannelClientState 

func (k Keeper) ChannelClientState(c context.Context, req *types.QueryChannelClientStateRequest) (*types.QueryChannelClientStateResponse, error)

ChannelClientState implements the Query/ChannelClientState gRPC method

func (Keeper) ChannelConsensusState 

func (k Keeper) ChannelConsensusState(c context.Context, req *types.QueryChannelConsensusStateRequest) (*types.QueryChannelConsensusStateResponse, error)

ChannelConsensusState implements the Query/ChannelConsensusState gRPC method

func (Keeper) ChannelParams 

func (k Keeper) ChannelParams(c context.Context, req *types.QueryChannelParamsRequest) (*types.QueryChannelParamsResponse, error)

ChannelParams implements the Query/ChannelParams gRPC method.

func (Keeper) Channels 

func (k Keeper) Channels(c context.Context, req *types.QueryChannelsRequest) (*types.QueryChannelsResponse, error)

Channels implements the Query/Channels gRPC method

func (Keeper) ConnectionChannels 

func (k Keeper) ConnectionChannels(c context.Context, req *types.QueryConnectionChannelsRequest) (*types.QueryConnectionChannelsResponse, error)

ConnectionChannels implements the Query/ConnectionChannels gRPC method

func (Keeper) GenerateChannelIdentifier 

func (k Keeper) GenerateChannelIdentifier(ctx sdk.Context) string

GenerateChannelIdentifier returns the next channel identifier.

func (Keeper) GetAllChannels 

func (k Keeper) GetAllChannels(ctx sdk.Context) (channels []types.IdentifiedChannel)

GetAllChannels returns all stored Channel objects.

func (Keeper) GetAllChannelsWithPortPrefix 

func (k Keeper) GetAllChannelsWithPortPrefix(ctx sdk.Context, portPrefix string) []types.IdentifiedChannel

GetAllChannelsWithPortPrefix returns all channels with the specified port prefix. If an empty prefix is provided all channels will be returned.

func (Keeper) GetAllPacketAckSeqs 

func (k Keeper) GetAllPacketAckSeqs(ctx sdk.Context) (seqs []types.PacketSequence)

GetAllPacketAckSeqs returns all stored next acknowledgements sequences.

func (Keeper) GetAllPacketAcks 

func (k Keeper) GetAllPacketAcks(ctx sdk.Context) (acks []types.PacketState)

GetAllPacketAcks returns all stored PacketAcknowledgements objects.

func (Keeper) GetAllPacketCommitments 

func (k Keeper) GetAllPacketCommitments(ctx sdk.Context) (commitments []types.PacketState)

GetAllPacketCommitments returns all stored PacketCommitments objects.

func (Keeper) GetAllPacketCommitmentsAtChannel 

func (k Keeper) GetAllPacketCommitmentsAtChannel(ctx sdk.Context, portID, channelID string) (commitments []types.PacketState)

GetAllPacketCommitmentsAtChannel returns all stored PacketCommitments objects for a specified port ID and channel ID.

func (Keeper) GetAllPacketReceipts 

func (k Keeper) GetAllPacketReceipts(ctx sdk.Context) (receipts []types.PacketState)

GetAllPacketReceipts returns all stored PacketReceipt objects.

func (Keeper) GetAllPacketRecvSeqs 

func (k Keeper) GetAllPacketRecvSeqs(ctx sdk.Context) (seqs []types.PacketSequence)

GetAllPacketRecvSeqs returns all stored next recv sequences.

func (Keeper) GetAllPacketSendSeqs 

func (k Keeper) GetAllPacketSendSeqs(ctx sdk.Context) (seqs []types.PacketSequence)

GetAllPacketSendSeqs returns all stored next send sequences.

func (Keeper) GetAppVersion 

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

GetAppVersion gets the version for the specified channel.

func (Keeper) GetChannel 

func (k Keeper) GetChannel(ctx sdk.Context, portID, channelID string) (types.Channel, bool)

GetChannel returns a channel with a particular identifier binded to a specific port

func (Keeper) GetChannelClientState 

func (k Keeper) GetChannelClientState(ctx sdk.Context, portID, channelID string) (string, exported.ClientState, error)

GetChannelClientState returns the associated client state with its ID, from a port and channel identifier.

func (Keeper) GetChannelConnection 

func (k Keeper) GetChannelConnection(ctx sdk.Context, portID, channelID string) (string, exported.ConnectionI, error)

GetChannelConnection returns the connection ID and state associated with the given port and channel identifier.

func (Keeper) GetConnection 

func (k Keeper) GetConnection(ctx sdk.Context, connectionID string) (exported.ConnectionI, error)

GetConnection wraps the connection keeper's GetConnection function.

func (Keeper) GetCounterpartyUpgrade 

func (k Keeper) GetCounterpartyUpgrade(ctx sdk.Context, portID, channelID string) (types.Upgrade, bool)

GetCounterpartyUpgrade gets the counterparty upgrade from the store.

func (Keeper) GetNextChannelSequence 

func (k Keeper) GetNextChannelSequence(ctx sdk.Context) uint64

GetNextChannelSequence gets the next channel sequence from the store.

func (Keeper) GetNextSequenceAck 

func (k Keeper) GetNextSequenceAck(ctx sdk.Context, portID, channelID string) (uint64, bool)

GetNextSequenceAck gets a channel's next ack sequence from the store

func (Keeper) GetNextSequenceRecv 

func (k Keeper) GetNextSequenceRecv(ctx sdk.Context, portID, channelID string) (uint64, bool)

GetNextSequenceRecv gets a channel's next receive sequence from the store

func (Keeper) GetNextSequenceSend 

func (k Keeper) GetNextSequenceSend(ctx sdk.Context, portID, channelID string) (uint64, bool)

GetNextSequenceSend gets a channel's next send sequence from the store

func (Keeper) GetPacketAcknowledgement 

func (k Keeper) GetPacketAcknowledgement(ctx sdk.Context, portID, channelID string, sequence uint64) ([]byte, bool)

GetPacketAcknowledgement gets the packet ack hash from the store

func (Keeper) GetPacketCommitment 

func (k Keeper) GetPacketCommitment(ctx sdk.Context, portID, channelID string, sequence uint64) []byte

GetPacketCommitment gets the packet commitment hash from the store

func (Keeper) GetPacketReceipt 

func (k Keeper) GetPacketReceipt(ctx sdk.Context, portID, channelID string, sequence uint64) (string, bool)

GetPacketReceipt gets a packet receipt from the store

func (Keeper) GetParams 

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

GetParams returns the total set of the channel parameters.

func (Keeper) GetPruningSequenceStart 

func (k Keeper) GetPruningSequenceStart(ctx sdk.Context, portID, channelID string) (uint64, bool)

GetPruningSequenceStart gets a channel's pruning sequence start from the store.

func (Keeper) GetRecvStartSequence 

func (k Keeper) GetRecvStartSequence(ctx sdk.Context, portID, channelID string) (uint64, bool)

GetRecvStartSequence gets a channel's recv start sequence from the store. The recv start sequence will be set to the counterparty's next sequence send upon a successful channel upgrade. It will be used for replay protection of historical packets and as the upper bound for pruning stale packet receives.

func (Keeper) GetUpgrade 

func (k Keeper) GetUpgrade(ctx sdk.Context, portID, channelID string) (types.Upgrade, bool)

GetUpgrade returns the proposed upgrade for the provided port and channel identifiers.

func (Keeper) GetUpgradeErrorReceipt 

func (k Keeper) GetUpgradeErrorReceipt(ctx sdk.Context, portID, channelID string) (types.ErrorReceipt, bool)

GetUpgradeErrorReceipt returns the upgrade error receipt for the provided port and channel identifiers.

func (Keeper) HasChannel 

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

HasChannel true if the channel with the given identifiers exists in state.

func (Keeper) HasInflightPackets 

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

HasInflightPackets returns true if there are packet commitments stored at the specified port and channel, and false otherwise.

func (Keeper) HasPacketAcknowledgement 

func (k Keeper) HasPacketAcknowledgement(ctx sdk.Context, portID, channelID string, sequence uint64) bool

HasPacketAcknowledgement check if the packet ack hash is already on the store

func (Keeper) HasPacketCommitment 

func (k Keeper) HasPacketCommitment(ctx sdk.Context, portID, channelID string, sequence uint64) bool

HasPacketCommitment returns true if the packet commitment exists

func (Keeper) HasPruningSequenceStart 

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

HasPruningSequenceStart returns true if the pruning sequence start is set for the specified channel.

func (Keeper) IterateChannels 

func (k Keeper) IterateChannels(ctx sdk.Context, cb func(types.IdentifiedChannel) bool)

IterateChannels provides an iterator over all Channel objects. For each Channel, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) IteratePacketAcknowledgement 

func (k Keeper) IteratePacketAcknowledgement(ctx sdk.Context, cb func(portID, channelID string, sequence uint64, hash []byte) bool)

IteratePacketAcknowledgement provides an iterator over all PacketAcknowledgement objects. For each aknowledgement, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) IteratePacketCommitment 

func (k Keeper) IteratePacketCommitment(ctx sdk.Context, cb func(portID, channelID string, sequence uint64, hash []byte) bool)

IteratePacketCommitment provides an iterator over all PacketCommitment objects. For each packet commitment, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) IteratePacketCommitmentAtChannel 

func (k Keeper) IteratePacketCommitmentAtChannel(ctx sdk.Context, portID, channelID string, cb func(_, _ string, sequence uint64, hash []byte) bool)

IteratePacketCommitmentAtChannel provides an iterator over all PacketCommmitment objects at a specified channel. For each packet commitment, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) IteratePacketReceipt 

func (k Keeper) IteratePacketReceipt(ctx sdk.Context, cb func(portID, channelID string, sequence uint64, receipt []byte) bool)

IteratePacketReceipt provides an iterator over all PacketReceipt objects. For each receipt, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) IteratePacketSequence 

func (Keeper) IteratePacketSequence(ctx sdk.Context, iterator db.Iterator, cb func(portID, channelID string, sequence uint64) bool)

IteratePacketSequence provides an iterator over all send, receive or ack sequences. For each sequence, cb will be called. If the cb returns true, the iterator will close and stop.

func (Keeper) Logger 

func (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 will return the IBCModule along with the capability associated with a given channel defined by its portID and channelID

func (Keeper) MustAbortUpgrade 

func (k Keeper) MustAbortUpgrade(ctx sdk.Context, portID, channelID string, err error)

MustAbortUpgrade will restore the channel state to its pre-upgrade state so that upgrade is aborted. Any unnecessary state is deleted and an error receipt is written. This function is expected to always succeed, a panic will occur if an error occurs.

func (Keeper) NextSequenceReceive 

func (k Keeper) NextSequenceReceive(c context.Context, req *types.QueryNextSequenceReceiveRequest) (*types.QueryNextSequenceReceiveResponse, error)

NextSequenceReceive implements the Query/NextSequenceReceive gRPC method

func (Keeper) NextSequenceSend 

func (k Keeper) NextSequenceSend(c context.Context, req *types.QueryNextSequenceSendRequest) (*types.QueryNextSequenceSendResponse, error)

NextSequenceSend implements the Query/NextSequenceSend gRPC method

func (Keeper) PacketAcknowledgement 

func (k Keeper) PacketAcknowledgement(c context.Context, req *types.QueryPacketAcknowledgementRequest) (*types.QueryPacketAcknowledgementResponse, error)

PacketAcknowledgement implements the Query/PacketAcknowledgement gRPC method

func (Keeper) PacketAcknowledgements 

func (k Keeper) PacketAcknowledgements(c context.Context, req *types.QueryPacketAcknowledgementsRequest) (*types.QueryPacketAcknowledgementsResponse, error)

PacketAcknowledgements implements the Query/PacketAcknowledgements gRPC method

func (Keeper) PacketCommitment 

func (k Keeper) PacketCommitment(c context.Context, req *types.QueryPacketCommitmentRequest) (*types.QueryPacketCommitmentResponse, error)

PacketCommitment implements the Query/PacketCommitment gRPC method

func (Keeper) PacketCommitments 

func (k Keeper) PacketCommitments(c context.Context, req *types.QueryPacketCommitmentsRequest) (*types.QueryPacketCommitmentsResponse, error)

PacketCommitments implements the Query/PacketCommitments gRPC method

func (Keeper) PacketReceipt 

func (k Keeper) PacketReceipt(c context.Context, req *types.QueryPacketReceiptRequest) (*types.QueryPacketReceiptResponse, error)

PacketReceipt implements the Query/PacketReceipt gRPC method

func (Keeper) PruneAcknowledgements 

func (k Keeper) PruneAcknowledgements(ctx sdk.Context, portID, channelID string, limit uint64) (uint64, uint64, error)

PruneAcknowledgements prunes packet acknowledgements and receipts that have a sequence number less than pruning sequence end. The number of packet acks/receipts pruned is bounded by the limit. Pruning can only occur after a channel has been upgraded.

Pruning sequence start keeps track of the packet ack/receipt that can be pruned next. When it reaches pruningSequenceEnd, pruning is complete.

func (Keeper) RecvAggregatePacket added in v9.2.0 

func (k Keeper) RecvAggregatePacket(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packets []exported.PacketI,
	proof [][]byte,
	leafNumber []uint64,
	proofHeight exported.Height,
) error

RecvAggregatePacket is called by a module in order to receive & process an IBC aggregatepacket sent on the corresponding channel end on the counterparty chain.

func (Keeper) RecvPacket 

func (k Keeper) RecvPacket(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packet exported.PacketI,
	proof []byte,
	proofHeight exported.Height,
) error

RecvPacket is called by a module in order to receive & process an IBC packet sent on the corresponding channel end on the counterparty chain.

func (Keeper) SendPacket 

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

SendPacket is called by a module in order to send an IBC packet on a channel. The packet sequence generated for the packet to be sent is returned. An error is returned if one occurs.

func (Keeper) SetChannel 

func (k Keeper) SetChannel(ctx sdk.Context, portID, channelID string, channel types.Channel)

SetChannel sets a channel to the store

func (Keeper) SetCounterpartyUpgrade 

func (k Keeper) SetCounterpartyUpgrade(ctx sdk.Context, portID, channelID string, upgrade types.Upgrade)

SetCounterpartyUpgrade sets the counterparty upgrade in the store.

func (Keeper) SetNextChannelSequence 

func (k Keeper) SetNextChannelSequence(ctx sdk.Context, sequence uint64)

SetNextChannelSequence sets the next channel sequence to the store.

func (Keeper) SetNextSequenceAck 

func (k Keeper) SetNextSequenceAck(ctx sdk.Context, portID, channelID string, sequence uint64)

SetNextSequenceAck sets a channel's next ack sequence to the store

func (Keeper) SetNextSequenceRecv 

func (k Keeper) SetNextSequenceRecv(ctx sdk.Context, portID, channelID string, sequence uint64)

SetNextSequenceRecv sets a channel's next receive sequence to the store

func (Keeper) SetNextSequenceSend 

func (k Keeper) SetNextSequenceSend(ctx sdk.Context, portID, channelID string, sequence uint64)

SetNextSequenceSend sets a channel's next send sequence to the store

func (Keeper) SetPacketAcknowledgement 

func (k Keeper) SetPacketAcknowledgement(ctx sdk.Context, portID, channelID string, sequence uint64, ackHash []byte)

SetPacketAcknowledgement sets the packet ack hash to the store

func (Keeper) SetPacketCommitment 

func (k Keeper) SetPacketCommitment(ctx sdk.Context, portID, channelID string, sequence uint64, commitmentHash []byte)

SetPacketCommitment sets the packet commitment hash to the store

func (Keeper) SetPacketReceipt 

func (k Keeper) SetPacketReceipt(ctx sdk.Context, portID, channelID string, sequence uint64)

SetPacketReceipt sets an empty packet receipt to the store

func (Keeper) SetParams 

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

SetParams sets the channel parameters.

func (Keeper) SetPruningSequenceStart 

func (k Keeper) SetPruningSequenceStart(ctx sdk.Context, portID, channelID string, sequence uint64)

SetPruningSequenceStart sets a channel's pruning sequence start to the store.

func (Keeper) SetUpgrade 

func (k Keeper) SetUpgrade(ctx sdk.Context, portID, channelID string, upgrade types.Upgrade)

SetUpgrade sets the proposed upgrade using the provided port and channel identifiers.

func (Keeper) TimeoutExecuted 

func (k Keeper) TimeoutExecuted(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packet exported.PacketI,
) error

TimeoutExecuted deletes the commitment send from this chain after it verifies timeout. If the timed-out packet came from an ORDERED channel then this channel will be closed. If the channel is in the FLUSHING state and there is a counterparty upgrade, then the upgrade will be aborted if the upgrade has timed out. Otherwise, if there are no more inflight packets, then the channel will be set to the FLUSHCOMPLETE state.

CONTRACT: this function must be called in the IBC handler

func (Keeper) TimeoutOnClose 

func (k Keeper) TimeoutOnClose(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packet exported.PacketI,
	proof,
	closedProof []byte,
	proofHeight exported.Height,
	nextSequenceRecv uint64,
) error

TimeoutOnClose is called by a module in order to prove that the channel to which an unreceived packet was addressed has been closed, so the packet will never be received (even if the timeoutHeight has not yet been reached).

func (Keeper) TimeoutOnCloseWithCounterpartyUpgradeSequence added in v9.1.5 

func (k Keeper) TimeoutOnCloseWithCounterpartyUpgradeSequence(
	ctx sdk.Context,
	chanCap *capabilitytypes.Capability,
	packet exported.PacketI,
	proof,
	closedProof []byte,
	proofHeight exported.Height,
	nextSequenceRecv uint64,
	counterpartyUpgradeSequence uint64,
) error

TimeoutOnCloseWithCounterpartyUpgradeSequence is called by a module in order to prove that the channel to which an unreceived packet was addressed has been closed, so the packet will never be received (even if the timeoutHeight has not yet been reached). The difference with TimeoutOnClose is that it accepts an extra argument counterpartyUpgradeSequence that was needed for channel upgradability.

This function will be removed in ibc-go v9.0.0 and the API of TimeoutOnClose will be updated.

func (Keeper) TimeoutPacket 

func (k Keeper) TimeoutPacket(
	ctx sdk.Context,
	packet exported.PacketI,
	proof []byte,
	proofHeight exported.Height,
	nextSequenceRecv uint64,
) error

TimeoutPacket is called by a module which originally attempted to send a packet to a counterparty module, where the timeout height has passed on the counterparty chain without the packet being committed, to prove that the packet can no longer be executed and to allow the calling module to safely perform appropriate state transitions. Its intended usage is within the ante handler.

func (Keeper) UnreceivedAcks 

func (k Keeper) UnreceivedAcks(c context.Context, req *types.QueryUnreceivedAcksRequest) (*types.QueryUnreceivedAcksResponse, error)

UnreceivedAcks implements the Query/UnreceivedAcks gRPC method. Given a list of counterparty packet acknowledgements, the querier checks if the packet has already been received by checking if the packet commitment still exists on this chain (original sender) for the packet sequence. All acknowledgmeents that haven't been received yet are returned in the response. Usage: To use this method correctly, first query all packet acknowledgements on the original receiving chain (ie the chain that wrote the acks) using the Query/PacketAcknowledgements gRPC method. Then input the returned sequences into the QueryUnreceivedAcksRequest and send the request to this Query/UnreceivedAcks on the **original sending** chain. This gRPC method will then return the list of packet sequences whose acknowledgements are already written on the receiving chain but haven't yet been received back to the sending chain.

NOTE: The querier makes the assumption that the provided list of packet acknowledgements is correct and will not function properly if the list is not up to date. Ideally the query height should equal the latest height on the counterparty's client which represents this chain.

func (Keeper) UnreceivedPackets 

func (k Keeper) UnreceivedPackets(c context.Context, req *types.QueryUnreceivedPacketsRequest) (*types.QueryUnreceivedPacketsResponse, error)

UnreceivedPackets implements the Query/UnreceivedPackets gRPC method. Given a list of counterparty packet commitments, the querier checks if the packet has already been received by checking if a receipt exists on this chain for the packet sequence. All packets that haven't been received yet are returned in the response Usage: To use this method correctly, first query all packet commitments on the sending chain using the Query/PacketCommitments gRPC method. Then input the returned sequences into the QueryUnreceivedPacketsRequest and send the request to this Query/UnreceivedPackets on the **receiving** chain. This gRPC method will then return the list of packet sequences that are yet to be received on the receiving chain.

NOTE: The querier makes the assumption that the provided list of packet commitments is correct and will not function properly if the list is not up to date. Ideally the query height should equal the latest height on the counterparty's client which represents this chain.

func (Keeper) Upgrade 

func (k Keeper) Upgrade(c context.Context, req *types.QueryUpgradeRequest) (*types.QueryUpgradeResponse, error)

Upgrade implements the Query/UpgradeSequence gRPC method

func (Keeper) UpgradeErrorReceipt 

func (k Keeper) UpgradeErrorReceipt(c context.Context, req *types.QueryUpgradeErrorRequest) (*types.QueryUpgradeErrorResponse, error)

UpgradeErrorReceipt implements the Query/UpgradeErrorReceipt gRPC method

func (Keeper) WriteAcknowledgement 

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

WriteAcknowledgement writes the packet execution acknowledgement to the state, which will be verified by the counterparty chain using AcknowledgePacket.

CONTRACT:

1) For synchronous execution, this function is be called in the IBC handler . For async handling, it needs to be called directly by the module which originally processed the packet.

2) Assumes that packet receipt has been written (unordered), or nextSeqRecv was incremented (ordered) previously by RecvPacket.

func (Keeper) WriteErrorReceipt 

func (k Keeper) WriteErrorReceipt(ctx sdk.Context, portID, channelID string, upgradeError *types.UpgradeError)

WriteErrorReceipt will write an error receipt from the provided UpgradeError.

func (Keeper) WriteOpenAckChannel 

func (k Keeper) WriteOpenAckChannel(
	ctx sdk.Context,
	portID,
	channelID,
	counterpartyVersion,
	counterpartyChannelID string,
)

WriteOpenAckChannel writes an updated channel state for the successful OpenAck handshake step. An event is emitted for the handshake step.

func (Keeper) WriteOpenConfirmChannel 

func (k Keeper) WriteOpenConfirmChannel(
	ctx sdk.Context,
	portID,
	channelID string,
)

WriteOpenConfirmChannel writes an updated channel state for the successful OpenConfirm handshake step. An event is emitted for the handshake step.

func (Keeper) WriteOpenInitChannel 

func (k Keeper) WriteOpenInitChannel(
	ctx sdk.Context,
	portID,
	channelID string,
	order types.Order,
	connectionHops []string,
	counterparty types.Counterparty,
	version string,
)

WriteOpenInitChannel writes a channel which has successfully passed the OpenInit handshake step. The channel is set in state and all the associated Send and Recv sequences are set to 1. An event is emitted for the handshake step.

func (Keeper) WriteOpenTryChannel 

func (k Keeper) WriteOpenTryChannel(
	ctx sdk.Context,
	portID,
	channelID string,
	order types.Order,
	connectionHops []string,
	counterparty types.Counterparty,
	version string,
)

WriteOpenTryChannel writes a channel which has successfully passed the OpenTry handshake step. The channel is set in state. If a previous channel state did not exist, all the Send and Recv sequences are set to 1. An event is emitted for the handshake step.

func (Keeper) WriteUpgradeAckChannel 

func (k Keeper) WriteUpgradeAckChannel(ctx sdk.Context, portID, channelID string, counterpartyUpgrade types.Upgrade) (types.Channel, types.Upgrade)

WriteUpgradeAckChannel writes a channel which has successfully passed the UpgradeAck handshake step as well as setting the upgrade for that channel. An event is emitted for the handshake step.

func (Keeper) WriteUpgradeCancelChannel 

func (k Keeper) WriteUpgradeCancelChannel(ctx sdk.Context, portID, channelID string, sequence uint64)

WriteUpgradeCancelChannel writes a channel which has canceled the upgrade process.Auxiliary upgrade state is also deleted.

func (Keeper) WriteUpgradeConfirmChannel 

func (k Keeper) WriteUpgradeConfirmChannel(ctx sdk.Context, portID, channelID string, counterpartyUpgrade types.Upgrade) types.Channel

WriteUpgradeConfirmChannel writes a channel which has successfully passed the ChanUpgradeConfirm handshake step. If the channel has no in-flight packets, its state is updated to indicate that flushing has completed. Otherwise, the counterparty upgrade is set and the channel state is left unchanged. An event is emitted for the handshake step.

func (Keeper) WriteUpgradeInitChannel 

func (k Keeper) WriteUpgradeInitChannel(ctx sdk.Context, portID, channelID string, upgrade types.Upgrade, upgradeVersion string) (types.Channel, types.Upgrade)

WriteUpgradeInitChannel writes a channel which has successfully passed the UpgradeInit handshake step. An event is emitted for the handshake step.

func (Keeper) WriteUpgradeOpenChannel 

func (k Keeper) WriteUpgradeOpenChannel(ctx sdk.Context, portID, channelID string) types.Channel

WriteUpgradeOpenChannel writes the agreed upon upgrade fields to the channel, and sets the channel state back to OPEN. This can be called in one of two cases: - In the UpgradeConfirm step of the handshake if both sides have already flushed all in-flight packets. - In the UpgradeOpen step of the handshake.

func (Keeper) WriteUpgradeTimeoutChannel 

func (k Keeper) WriteUpgradeTimeoutChannel(
	ctx sdk.Context,
	portID, channelID string,
) (types.Channel, types.Upgrade)

WriteUpgradeTimeoutChannel restores the channel state of an initialising chain in the event that the counterparty chain has passed the timeout set in ChanUpgradeInit to the state before the upgrade was proposed. Auxiliary upgrade state is also deleted. An event is emitted for the handshake step.

func (Keeper) WriteUpgradeTryChannel 

func (k Keeper) WriteUpgradeTryChannel(ctx sdk.Context, portID, channelID string, upgrade types.Upgrade, upgradeVersion string) (types.Channel, types.Upgrade)

WriteUpgradeTryChannel writes the channel end and upgrade to state after successfully passing the UpgradeTry handshake step. An event is emitted for the handshake step.

type Migrator 

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

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

func NewMigrator 

func NewMigrator(keeper Keeper) Migrator

NewMigrator returns a new Migrator.

func (Migrator) MigrateParams 

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

MigrateParams migrates params to the default channel params.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.