Interface V1Channel

Channel defines pipeline for exactly-once packet delivery between specific modules on separate blockchains, which has at least one end capable of sending packets and one end capable of receiving packets.

Hierarchy

  • V1Channel

Properties

connection_hops? counterparty? ordering? state? version?

Properties

Optional connection_hops

connection_hops?: string[]

list of connection identifiers, in order, along which packets sent on this channel will travel

Optional counterparty

counterparty?: V1Counterparty

counterparty channel end

Optional ordering

ordering?: V1Order

whether the channel is ordered or unordered

  • ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
  • ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in which they were sent.
  • ORDER_ORDERED: packets are delivered exactly in the order which they were sent

Optional state

state?: V1State

current state of the channel end State defines if a channel is in one of the following states: CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.

  • STATE_UNINITIALIZED_UNSPECIFIED: Default State
  • STATE_INIT: A channel has just started the opening handshake.
  • STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
  • STATE_OPEN: A channel has completed the handshake. Open channels are ready to send and receive packets.
  • STATE_CLOSED: A channel has been closed and can no longer be used to send or receive packets.

Optional version

version?: string

opaque channel version, which is agreed upon during the handshake

Settings

Member Visibility

Theme

Generated using TypeDoc