adamant-api / index / WsOptions

Interface: WsOptions

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

Properties

admAddress?

optional admAddress?: `U${string}`;

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

ADM address to subscribe to. Kept for backward compatibility.

---

admAddresses?

optional admAddresses?: `U${string}`[];

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

ADM addresses to subscribe to.

---

assetChatTypes?

optional assetChatTypes?: number[];

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

transaction.asset.chat.type values to subscribe to.

---

direction?

optional direction?: "allDirections" | "self" | "incoming" | "outgoing";

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

Direction of transactions delivered to handlers. Filtering is performed client-side against the subscribed ADM address(es). Default is allDirections.

---

logger?

optional logger?: Logger;

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

---

maxTries?

optional maxTries?: number;

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

Maximum reconnection attempts. Default is 3.

---

reconnectionDelay?

optional reconnectionDelay?: number;

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

Delay between reconnection attempts in milliseconds. Default is 5000.

---

types?

optional types?: number[];

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

Transaction types to subscribe to.

---

useFastest?

optional useFastest?: boolean;

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

Must connect to node with minimum ping. Not recommended. Default is false.

---

wsType?

optional wsType?: WsType;

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

Websocket type: 'wss' or 'ws'. 'wss' is recommended.