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

default
- default

Index

Constructors

constructor

new default(): default
Returns default

Properties

_actionQueue

_actionQueue: ChannelAction[] = []

`Optional` _channelId

_channelId?: `ch_${string}`

_eventEmitter

_eventEmitter: EventEmitter = ...

_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

disconnect

disconnect(): void
Close the connection

Returns void
- Defined in channel/Base.ts:188

`Protected` enqueueAction

enqueueAction(action: (() => {
handler: ChannelHandler;
state?: Partial<ChannelState>;
})): Promise<any>
Parameters
- action: (() => {
  handler: ChannelHandler;
  state?: Partial<ChannelState>;
  })
  - - (): {
      handler: ChannelHandler;
      state?: Partial<ChannelState>;
      }
    - Returns {
      handler: ChannelHandler;
      state?: Partial<ChannelState>;
      }
      
      handler: ChannelHandler
      
      Optional state?: Partial<ChannelState>
Returns Promise<any>
- Defined in channel/Base.ts:263

fsmId

fsmId(): `ba_${string}`
Get channel's fsm id

Returns `ba_${string}`
- Defined in channel/Base.ts:258

id

id(): `ch_${string}`
Get channel id

Returns `ch_${string}`
- Defined in channel/Base.ts:249

leave

leave(): Promise<{
channelId: `ba_${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 offchainTx (returned from leave method as channelId and signedTx respectively).

Example
```
channel.leave().then(({ channelId, signedTx }) => {
  console.log(channelId)
  console.log(signedTx)
})
```
Returns Promise<{
channelId: `ba_${string}`;
signedTx: `tx_${string}`;
}>
- Defined in channel/Base.ts:293

off

off<E>(eventName: E, callback: ChannelEvents[E]): void
Remove event listener function
Type Parameters
- E extends keyof ChannelEvents
Parameters
- eventName: E
  
  Event name
- callback: ChannelEvents[E]
  
  Callback function
Returns void
- Defined in channel/Base.ts:181

on

on<E>(eventName: E, callback: ChannelEvents[E]): 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
- Defined in channel/Base.ts:172

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
- Defined in channel/Base.ts:228

shutdown

shutdown(sign: SignTx): 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.

Example
```
channel.shutdown(
  async (tx) => await account.signTransaction(tx)
).then(tx => console.log('on_chain_tx', tx))
```
Parameters
- sign: SignTx
  
  Function which verifies and signs mutual close transaction
Returns Promise<`tx_${string}`>
- Defined in channel/Base.ts:314

state

state(): Promise<{
    calls: Object;
    halfSignedTx?: Object;
    signedTx?: Object;
    trees: Object;
}>
Get current state

Returns Promise<{
    calls: Object;
    halfSignedTx?: Object;
    signedTx?: Object;
    trees: Object;
}>
- Defined in channel/Base.ts:202

status

status(): ChannelStatus
Get current status

Returns ChannelStatus
- Defined in channel/Base.ts:195

`Static` _initialize

_initialize<T>(channel: T, options: ChannelOptions): Promise<T>
Type Parameters
- T extends default<T>
Parameters
- channel: T
- options: ChannelOptions
Returns Promise<T>
- Defined in channel/Base.ts:140

`Static` initialize

initialize(options: ChannelOptions): Promise<default>
Parameters
- options: ChannelOptions
  
  Channel params
Returns Promise<default>
- Defined in channel/Base.ts:136

`Static` reconnect

reconnect(options: ChannelOptions, txParams: any): Promise<default>
Parameters
- options: ChannelOptions
- txParams: any
Returns Promise<default>
- Defined in channel/Base.ts:324

Class default

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

_actionQueue

Optional _channelId

_eventEmitter

_fsm

Optional _fsmId

_isActionQueueLocked

_isMessageQueueLocked

_messageQueue

_nextRpcMessageId

_options

_pingTimeoutId

_rpcCallbacks

_state

_status

_websocket

Methods

disconnect

Returns void

Protected enqueueAction

Parameters

action: (() => { handler: ChannelHandler; state?: Partial<ChannelState>; })

Returns { handler: ChannelHandler; state?: Partial<ChannelState>; }

handler: ChannelHandler

Optional state?: Partial<ChannelState>

Returns Promise<any>

fsmId

Returns `ba_${string}`

id

Returns `ch_${string}`

leave

Example

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

off

Type Parameters

E extends keyof ChannelEvents

Parameters

eventName: E

callback: ChannelEvents[E]

Returns void

on

Type Parameters

E extends keyof ChannelEvents

Parameters

eventName: E

callback: ChannelEvents[E]

Returns void

round

Returns null | number

shutdown

Example

Parameters

sign: SignTx

Returns Promise<`tx_${string}`>

state

Returns Promise<{ calls: Object; halfSignedTx?: Object; signedTx?: Object; trees: Object; }>

status

Returns ChannelStatus

Static _initialize

Type Parameters

T extends default<T>

Parameters

channel: T

options: ChannelOptions

Returns Promise<T>

Static initialize

Parameters

options: ChannelOptions

Returns Promise<default>

Static reconnect

`Optional` _channelId

`Optional` _fsmId

`Protected` enqueueAction

action: (() => {
handler: ChannelHandler;
state?: Partial<ChannelState>;
})

Returns {
handler: ChannelHandler;
state?: Partial<ChannelState>;
}

`Optional` state?: Partial<ChannelState>

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

Returns Promise<{
calls: Object;
halfSignedTx?: Object;
signedTx?: Object;
trees: Object;
}>

`Static` _initialize

`Static` initialize

`Static` reconnect