Documentation
¶
Overview ¶
Package test includes convenience functions and types to help with testing
Index ¶
- Variables
- func PollForAck(ctx context.Context, chain ChainAcker, startHeight, maxHeight uint64, ...) (ibc.PacketAcknowledgement, error)
- func PollForTimeout(ctx context.Context, chain ChainTimeouter, startHeight, maxHeight uint64, ...) (ibc.PacketTimeout, error)
- func WaitForBlocks(ctx context.Context, delta int, chains ...ChainHeighter) error
- func WaitForInSync(ctx context.Context, chain ChainHeighter, nodes ...ChainHeighter) error
- type BlockPoller
- type ChainAcker
- type ChainHeighter
- type ChainTimeouter
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = errors.New("not found")
Functions ¶
func PollForAck ¶
func PollForAck(ctx context.Context, chain ChainAcker, startHeight, maxHeight uint64, packet ibc.Packet) (ibc.PacketAcknowledgement, error)
PollForAck attempts to find an acknowledgement containing a packet equal to the packet argument. Polling starts at startHeight and continues until maxHeight. It is safe to call this function even if the chain has yet to produce blocks for the target min/max height range. Polling delays until heights exist on the chain. Returns an error if acknowledgement not found or problems getting height or acknowledgements.
func PollForTimeout ¶
func PollForTimeout(ctx context.Context, chain ChainTimeouter, startHeight, maxHeight uint64, packet ibc.Packet) (ibc.PacketTimeout, error)
PollForTimeout attempts to find a timeout containing a packet equal to the packet argument. Otherwise, works identically to PollForAck.
func WaitForBlocks ¶
func WaitForBlocks(ctx context.Context, delta int, chains ...ChainHeighter) error
WaitForBlocks blocks until all chains reach a block height delta equal to or greater than the delta argument. If a ChainHeighter does not monotonically increase the height, this function may block program execution indefinitely.
func WaitForInSync ¶
func WaitForInSync(ctx context.Context, chain ChainHeighter, nodes ...ChainHeighter) error
WaitForInSync blocks until all nodes have heights greater than or equal to the chain height.
Types ¶
type BlockPoller ¶
type ChainAcker ¶
type ChainAcker interface {
ChainHeighter
Acknowledgements(ctx context.Context, height uint64) ([]ibc.PacketAcknowledgement, error)
}
ChainAcker is a chain that can get its acknowledgements at a specified height
type ChainHeighter ¶
ChainHeighter fetches the current chain block height.
type ChainTimeouter ¶
type ChainTimeouter interface {
ChainHeighter
Timeouts(ctx context.Context, height uint64) ([]ibc.PacketTimeout, error)
}
ChainTimeouter is a chain that can get its timeouts at a specified height
Source Files