Class default

_actionQueue

Optional_channelId

_eventEmitter

_fsm

Optional_fsmId

_isActionQueueLocked

_isMessageQueueLocked

_messageQueue

_nextRpcMessageId

_options

_pingTimeoutId

_rpcCallbacks

_state

_status

_websocket

_debug

• _debug(...args): void

• Parameters

  • Rest...args: any[]

  Returns void

disconnect

• disconnect(): void

• Close the connection

  Returns void

fsmId

• fsmId(): `ba_${string}`

• Get channel's fsm id

  Returns `ba_${string}`

id

• id(): `ch_${string}`

• Get channel id

  Returns `ch_${string}`

leave

• leave(): Promise<{
      channelId: `ch_${string}`;
      signedTx: `tx_${string}`;
  }>

• Leave channel

  It is possible to leave a channel and then later reestablish the channel off-chain state and continue operation. When a leave method is called, the channel fsm passes it on to the peer fsm, reports the current mutually signed state and then terminates.

  The channel can be reestablished by instantiating another Channel instance with two extra params: existingChannelId and existingFsmId.

  Returns Promise<{
      channelId: `ch_${string}`;
      signedTx: `tx_${string}`;
  }>

  Example

  channel.leave().then(({ channelId, signedTx }) => {
    console.log(channelId)
    console.log(signedTx)
  })
  Copy

off

• off<E>(eventName, callback): void

• Remove event listener function

  Type Parameters

  • E extends keyof ChannelEvents

  Parameters

  • eventName: E

    Event name
  • callback: ChannelEvents[E]

    Callback function

  Returns void

on

• on<E>(eventName, callback): void

• Register event listener function

  Possible events:

  • "error"
  • "stateChanged"
  • "statusChanged"
  • "message"
  • "peerDisconnected"
  • "onChainTx"
  • "ownWithdrawLocked"
  • "withdrawLocked"
  • "ownDepositLocked"
  • "depositLocked"
  • "channelReestablished"
  • "newContract"

  Type Parameters

  • E extends keyof ChannelEvents

  Parameters

  • eventName: E

    Event name
  • callback: ChannelEvents[E]

    Callback function

  Returns void

round

• round(): null | number

• Get current round

  If round cannot be determined (for example when channel has not been opened) it will return null.

  Returns null | number

shutdown

• shutdown(sign): Promise<`tx_${string}`>

• Trigger mutual close

  At any moment after the channel is opened, a closing procedure can be triggered. This can be done by either of the parties. The process is similar to the off-chain updates.

  Parameters

  • sign: SignTx

    Function which verifies and signs mutual close transaction

  Returns Promise<`tx_${string}`>

  Example

  channel.shutdown(
    async (tx) => await account.signTransaction(tx)
  ).then(tx => console.log('on_chain_tx', tx))
  Copy

state

• state(): Promise<{
      calls: EntUnpacked & {
          tag: CallsMtree;
      };
      halfSignedTx?: TxUnpacked & { tag: Tag.SignedTx; };
      signedTx?: TxUnpacked & { tag: Tag.SignedTx; };
      trees: EntUnpacked & {
          tag: StateTrees;
      };
  }>

• Get current state

  Returns Promise<{
      calls: EntUnpacked & {
          tag: CallsMtree;
      };
      halfSignedTx?: TxUnpacked & { tag: Tag.SignedTx; };
      signedTx?: TxUnpacked & { tag: Tag.SignedTx; };
      trees: EntUnpacked & {
          tag: StateTrees;
      };
  }>

status

• status(): ChannelStatus

• Get current status

  Returns ChannelStatus

Static_initialize

• _initialize<T>(channel, options): Promise<T>

• Type Parameters

  • T extends default

  Parameters

  • channel: T
  • options: ChannelOptions

  Returns Promise<T>

Staticinitialize

• initialize(options): Promise<default>

• Parameters

  • options: ChannelOptions

    Channel params

  Returns Promise<default>