adamant-api / index / WebSocketClient

Class: WebSocketClient

Defined in: src/helpers/wsClient.ts:129

Constructors

Constructor

new WebSocketClient(options): WebSocketClient;

Defined in: src/helpers/wsClient.ts:178

Parameters

Parameter	Type
options	WsOptions

Returns

WebSocketClient

Properties

options

options: WsOptions;

Defined in: src/helpers/wsClient.ts:133

Web socket client options.

Methods

catch()

catch(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:433

Sets an error handler for all event handlers.

Parameters

Parameter	Type
callback	ErrorHandler

Returns

WebSocketClient

Example

socket.onMessage(() => throw new Error('catch me'))

socket.catch((error) => {
  console.log(error) // Error: catch me
})

---

chooseNode()

chooseNode(): string;

Defined in: src/helpers/wsClient.ts:762

Chooses fastest or random node based on WsOptions.useFastest option

Returns

string

WebSocket url

---

connect()

connect(): WebSocketClient;

Defined in: src/helpers/wsClient.ts:304

Connects using the current healthy-node list.

Returns

WebSocketClient

---

disconnect()

disconnect(): WebSocketClient;

Defined in: src/helpers/wsClient.ts:325

Disconnects and cancels pending reconnection attempts.

Returns

WebSocketClient

---

fastestNode()

fastestNode(): ActiveNode;

Defined in: src/helpers/wsClient.ts:780

Returns

ActiveNode

---

off()

off(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:453

Removes the handler from all transaction, block, and balance event types.

Parameters

Parameter	Type
handler	SingleWebSocketHandler

Returns

WebSocketClient

---

on()

Call Signature

on(handler): this;

Defined in: src/helpers/wsClient.ts:492

Adds an event listener handler for all transaction types.

Parameters

Parameter	Type
handler	AnyTransactionHandler

Returns

this

Call Signature

on<T>(types, handler): this;

Defined in: src/helpers/wsClient.ts:496

Adds an event listener handler for the specific transaction types.

Type Parameters

Type Parameter
T extends keyof TransactionMap

Parameters

Parameter	Type
types	T | T[]
handler	TransactionHandler<TransactionMap[T]>

Returns

this

---

onBalanceChange()

Call Signature

onBalanceChange(handler): this;

Defined in: src/helpers/wsClient.ts:616

Registers a handler for current absolute confirmed and unconfirmed balances after a change. Payload values replace previous values; they are not deltas. At least one ADM address must be configured on the client.

Parameters

Parameter	Type
handler	BalanceChangeHandler

Returns

this

Call Signature

onBalanceChange(fields, handler): this;

Defined in: src/helpers/wsClient.ts:618

Registers a handler for selected public balance fields.

Parameters

Parameter	Type
fields	| "balance" | "unconfirmedBalance" | ("balance" | "unconfirmedBalance")[]
handler	BalanceChangeHandler

Returns

this

---

onChatMessage()

onChatMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:550

Registers a handler for plain chat messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onConnection()

onConnection(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:439

Registers a callback for the first successful connection.

Parameters

Parameter	Type
callback	ConnectionHandler

Returns

WebSocketClient

---

onKVS()

onKVS(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:592

Registers an event handler for Key-Value Store (KVS) transactions.

Parameters

Parameter	Type
handler	TransactionHandler<KVSTransaction>

Returns

WebSocketClient

---

onMessage()

Call Signature

onMessage(handler): this;

Defined in: src/helpers/wsClient.ts:526

Registers an event handler for Chat Message transactions.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

this

Call Signature

onMessage(messageTypes, handler): this;

Defined in: src/helpers/wsClient.ts:527

Registers an event handler for Chat Message transactions.

Parameters

Parameter	Type
messageTypes	| MessageType | MessageType[]
handler	TransactionHandler<ChatMessageTransaction>

Returns

this

---

onNewBlock()

onNewBlock(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:601

Registers a handler for compact headers of newly applied blocks.

Registering a handler opts the socket in to the node's newBlock event.

Parameters

Parameter	Type
handler	NewBlockHandler

Returns

WebSocketClient

---

onNewDelegate()

onNewDelegate(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:574

Registers an event handler for Register Delegate transactions.

Parameters

Parameter	Type
handler	TransactionHandler<RegisterDelegateTransaction>

Returns

WebSocketClient

---

onReconnection()

onReconnection(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:445

Registers a callback for successful reconnections.

Parameters

Parameter	Type
callback	ConnectionHandler

Returns

WebSocketClient

---

onRichMessage()

onRichMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:555

Registers a handler for rich messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onSignalMessage()

onSignalMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:560

Registers a handler for signal messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onTransfer()

onTransfer(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:567

Registers an event handler for Token Transfer transactions.

Parameters

Parameter	Type
handler	TransactionHandler<TokenTransferTransaction>

Returns

WebSocketClient

---

onVoteForDelegate()

onVoteForDelegate(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:583

Registers an event handler for Vote for Delegate transactions.

Parameters

Parameter	Type
handler	TransactionHandler<VoteForDelegateTransaction>

Returns

WebSocketClient

---

randomNode()

randomNode(): ActiveNode;

Defined in: src/helpers/wsClient.ts:784

Returns

ActiveNode

---

reviseConnection()

reviseConnection(nodes): void;

Defined in: src/helpers/wsClient.ts:217

Filters nodes that support websocket and connects to one of them.

Parameters

Parameter	Type	Description
nodes	ActiveNode[]	Sorted by ping array of active nodes

Returns

void

---

setConnection()

setConnection(): void;

Defined in: src/helpers/wsClient.ts:238

Chooses node and sets up connection.

Returns

void