Class default

Channel

Example

await Channel.initialize({
  url: 'ws://localhost:3001',
  role: 'initiator'
  initiatorId: 'ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH',
  responderId: 'ak_V6an1xhec1xVaAhLuak7QoEbi6t7w5hEtYWp9bMKaJ19i6A9E',
  initiatorAmount: 1e18,
  responderAmount: 1e18,
  pushAmount: 0,
  channelReserve: 0,
  ttl: 1000,
  host: 'localhost',
  port: 3002,
  lockPeriod: 10,
  async sign (tag, tx) => await account.signTransaction(tx)
})

Hierarchy (view full)

Constructors

constructor

Properties

_actionQueue _channelId? _eventEmitter _fsm _fsmId? _isActionQueueLocked _isMessageQueueLocked _messageQueue _nextRpcMessageId _options _pingTimeoutId _rpcCallbacks _state _status _websocket

Methods

_debug balances deposit disconnect enqueueAction fsmId id leave off on poi round sendMessage shutdown state status update withdraw _initialize initialize

Constructors

Protectedconstructor

Properties

_actionQueue

_actionQueue: ChannelAction[] = []

Optional_channelId

_channelId?: `ch_${string}`

_eventEmitter

_eventEmitter: EventEmitter<DefaultEventMap> = ...

_fsm

_fsm: ChannelFsm

Optional_fsmId

_fsmId?: `ba_${string}`

_isActionQueueLocked

_isActionQueueLocked: boolean = false

_isMessageQueueLocked

_isMessageQueueLocked: boolean = false

_messageQueue

_messageQueue: ChannelMessage[] = []

_nextRpcMessageId

_nextRpcMessageId: number = 0

_options

_options: ChannelOptions

_pingTimeoutId

_pingTimeoutId: Timeout

_rpcCallbacks

_rpcCallbacks: Map<number, ((message: object) => void)> = ...

_state

_state: "" | `tx_${string}` = ''

_status

_status: ChannelStatus = 'disconnected'

_websocket

_websocket: w3cwebsocket

Methods

_debug

balances

  • balances(accounts): Promise<{
        [key: AccountAddress]: string;
    }>

  • Get balances

    The accounts param contains a list of addresses to fetch balances of. Those can be either account balances or a contract ones, encoded as an account addresses.

    If a certain account address had not being found in the state tree - it is simply skipped in the response.

    Parameters

    • accounts: `ak_${string}`[]

      List of addresses to fetch balances from

    Returns Promise<{
        [key: AccountAddress]: string;
    }>

    Example

    channel.balances([
      'ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH',
      'ak_V6an1xhec1xVaAhLuak7QoEbi6t7w5hEtYWp9bMKaJ19i6A9E'
      'ct_2dCUAWYZdrWfACz3a2faJeKVTVrfDYxCQHCqAt5zM15f3u2UfA'
    ]).then(balances =>
      console.log(balances['ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH'])
    )

deposit

  • deposit(amount, sign, callbacks?): Promise<{
        accepted: boolean;
        state: ChannelState;
    }>

  • Deposit coins into the channel

    After the channel had been opened any of the participants can initiate a deposit. The process closely resembles the update. The most notable difference is that the transaction has been co-signed: it is channel_deposit_tx and after the procedure is finished - it is being posted on-chain.

    Any of the participants can initiate a deposit. The only requirements are:

    • Channel is already opened
    • No off-chain update/deposit/withdrawal is currently being performed
    • Channel is not being closed or in a solo closing state
    • The deposit amount must be equal to or greater than zero, and cannot exceed the available balance on the channel (minus the channel_reserve)

    After the other party had signed the deposit transaction, the transaction is posted on-chain and onOnChainTx callback is called with on-chain transaction as first argument. After computing transaction hash it can be tracked on the chain: entering the mempool, block inclusion and a number of confirmations.

    After the minimum_depth block confirmations onOwnDepositLocked callback is called (without any arguments).

    When the other party had confirmed that the block height needed is reached onDepositLocked callback is called (without any arguments).

    Parameters

    • amount: number | BigNumber

      Amount of coins to deposit

    • sign: SignTx

      Function which verifies and signs deposit transaction

    • callbacks: Pick<ChannelState, "onOnChainTx" | "onOwnDepositLocked" | "onDepositLocked"> = {}

      Callbacks

    Returns Promise<{
        accepted: boolean;
        state: ChannelState;
    }>

    Example

    channel.deposit(
      100,
      async (tx) => await account.signTransaction(tx),
      { onOnChainTx: (tx) => console.log('on_chain_tx', tx) }
    ).then(({ accepted, state }) => {
      if (accepted) {
        console.log('Deposit has been accepted')
        console.log('The new state is:', state)
      } else {
        console.log('Deposit has been rejected')
      }
    })

disconnect

ProtectedenqueueAction

fsmId

id

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

off

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

    Parameters

    Returns void

poi

  • poi(addresses): Promise<EntUnpacked & {
        tag: TreesPoi;
    }>

  • Get proof of inclusion

    If a certain address of an account or a contract is not found in the state tree - the response is an error.

    Parameters

    • addresses: {
          accounts: `ak_${string}`[];
          contracts?: `ct_${string}`[];
      }

      Addresses

      • accounts: `ak_${string}`[]

        List of account addresses to include in poi

      • Optionalcontracts?: `ct_${string}`[]

        List of contract addresses to include in poi

    Returns Promise<EntUnpacked & {
        tag: TreesPoi;
    }>

    Example

    channel.poi({
      accounts: [
        'ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH',
        'ak_V6an1xhec1xVaAhLuak7QoEbi6t7w5hEtYWp9bMKaJ19i6A9E'
      ],
      contracts: ['ct_2dCUAWYZdrWfACz3a2faJeKVTVrfDYxCQHCqAt5zM15f3u2UfA']
    }).then(poi => console.log(poi))

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

sendMessage

  • sendMessage(message, recipient): Promise<void>

  • Send generic message

    If message is an object it will be serialized into JSON string before sending.

    If there is ongoing update that has not yet been finished the message will be sent after that update is finalized.

    Parameters

    • message: string | object

      Message

    • recipient: `ak_${string}`

      Address of the recipient

    Returns Promise<void>

    Example

    channel.sendMessage(
      'hello world',
      'ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH'
    )

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

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

update

  • update(from, to, amount, sign, metadata?): Promise<{
        accepted: boolean;
        errorCode?: number;
        errorMessage?: string;
        signedTx?: `tx_${string}`;
    }>

  • Trigger a transfer update

    The transfer update is moving coins from one channel account to another. The update is a change to be applied on top of the latest state.

    Sender and receiver are the channel parties. Both the initiator and responder can take those roles. Any public key outside the channel is considered invalid.

    Parameters

    • from: `ak_${string}`

      Sender's public address

    • to: `ak_${string}`

      Receiver's public address

    • amount: number | BigNumber

      Transaction amount

    • sign: SignTx

      Function which verifies and signs offchain transaction

    • metadata: string[] = []

      Metadata

    Returns Promise<{
        accepted: boolean;
        errorCode?: number;
        errorMessage?: string;
        signedTx?: `tx_${string}`;
    }>

    Example

    channel.update(
      'ak_Y1NRjHuoc3CGMYMvCmdHSBpJsMDR6Ra2t5zjhRcbtMeXXLpLH',
      'ak_V6an1xhec1xVaAhLuak7QoEbi6t7w5hEtYWp9bMKaJ19i6A9E',
      10,
      async (tx) => await account.signTransaction(tx)
    ).then(({ accepted, signedTx }) =>
      if (accepted) {
        console.log('Update has been accepted')
      }
    )

withdraw

  • withdraw(amount, sign, callbacks?): Promise<{
        accepted: boolean;
        signedTx: `tx_${string}`;
    }>

  • Withdraw coins from the channel

    After the channel had been opened any of the participants can initiate a withdrawal. The process closely resembles the update. The most notable difference is that the transaction has been co-signed: it is channel_withdraw_tx and after the procedure is finished - it is being posted on-chain.

    Any of the participants can initiate a withdrawal. The only requirements are:

    • Channel is already opened
    • No off-chain update/deposit/withdrawal is currently being performed
    • Channel is not being closed or in a solo closing state
    • The withdrawal amount must be equal to or greater than zero, and cannot exceed the available balance on the channel (minus the channel_reserve)

    After the other party had signed the withdraw transaction, the transaction is posted on-chain and onOnChainTx callback is called with on-chain transaction as first argument. After computing transaction hash it can be tracked on the chain: entering the mempool, block inclusion and a number of confirmations.

    After the minimum_depth block confirmations onOwnWithdrawLocked callback is called (without any arguments).

    When the other party had confirmed that the block height needed is reached onWithdrawLocked callback is called (without any arguments).

    Parameters

    • amount: number | BigNumber

      Amount of coins to withdraw

    • sign: SignTx

      Function which verifies and signs withdraw transaction

    • callbacks: Pick<ChannelState, "onOnChainTx" | "onOwnWithdrawLocked" | "onWithdrawLocked"> = {}

      Callbacks

    Returns Promise<{
        accepted: boolean;
        signedTx: `tx_${string}`;
    }>

    Example

    channel.withdraw(
      100,
      async (tx) => await account.signTransaction(tx),
      { onOnChainTx: (tx) => console.log('on_chain_tx', tx) }
    ).then(({ accepted, signedTx }) => {
      if (accepted) {
        console.log('Withdrawal has been accepted')
      } else {
        console.log('Withdrawal has been rejected')
      }
    })

Static_initialize

Staticinitialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods