@pythnetwork/pyth-lazer-sdk 0.1.2 → 0.2.0

package/dist/cjs/client.d.ts

@@ -1,5 +1,6 @@
-import WebSocket from "isomorphic-ws";
+import { type Logger } from "ts-log";
 import { type ParsedPayload, type Request, type Response } from "./protocol.js";
+import { WebSocketPool } from "./socket/web-socket-pool.js";
 export type BinaryResponse = {
     subscriptionId: number;
     evm?: Buffer | undefined;
@@ -14,8 +15,18 @@ export type JsonOrBinaryResponse = {
     value: BinaryResponse;
 };
 export declare class PythLazerClient {
-    ws: WebSocket;
-    constructor(url: string, token: string);
+    wsp: WebSocketPool;
+    /**
+     * Creates a new PythLazerClient instance.
+     * @param urls - List of WebSocket URLs of the Pyth Lazer service
+     * @param token - The access token for authentication
+     * @param numConnections - The number of parallel WebSocket connections to establish (default: 3). A higher number gives a more reliable stream.
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls: string[], token: string, numConnections?: number, logger?: Logger);
     addMessageListener(handler: (event: JsonOrBinaryResponse) => void): void;
-    send(request: Request): void;
+    subscribe(request: Request): Promise<void>;
+    unsubscribe(subscriptionId: number): Promise<void>;
+    send(request: Request): Promise<void>;
+    shutdown(): void;
 }

package/dist/cjs/client.js

@@ -1,58 +1,57 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PythLazerClient = void 0;
-const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
+const ts_log_1 = require("ts-log");
 const protocol_js_1 = require("./protocol.js");
+const web_socket_pool_js_1 = require("./socket/web-socket-pool.js");
 const UINT16_NUM_BYTES = 2;
 const UINT32_NUM_BYTES = 4;
 const UINT64_NUM_BYTES = 8;
 class PythLazerClient {
-    ws;
-    constructor(url, token) {
-        const finalUrl = new URL(url);
-        finalUrl.searchParams.append("ACCESS_TOKEN", token);
-        this.ws = new isomorphic_ws_1.default(finalUrl);
+    wsp;
+    /**
+     * Creates a new PythLazerClient instance.
+     * @param urls - List of WebSocket URLs of the Pyth Lazer service
+     * @param token - The access token for authentication
+     * @param numConnections - The number of parallel WebSocket connections to establish (default: 3). A higher number gives a more reliable stream.
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls, token, numConnections = 3, logger = ts_log_1.dummyLogger) {
+        this.wsp = new web_socket_pool_js_1.WebSocketPool(urls, token, numConnections, logger);
     }
     addMessageListener(handler) {
-        this.ws.addEventListener("message", (event) => {
-            if (typeof event.data == "string") {
+        this.wsp.addMessageListener((data) => {
+            if (typeof data == "string") {
                 handler({
                     type: "json",
-                    value: JSON.parse(event.data),
+                    value: JSON.parse(data),
                 });
             }
-            else if (Buffer.isBuffer(event.data)) {
+            else if (Buffer.isBuffer(data)) {
                 let pos = 0;
-                const magic = event.data
-                    .subarray(pos, pos + UINT32_NUM_BYTES)
-                    .readUint32BE();
+                const magic = data.subarray(pos, pos + UINT32_NUM_BYTES).readUint32BE();
                 pos += UINT32_NUM_BYTES;
                 if (magic != protocol_js_1.BINARY_UPDATE_FORMAT_MAGIC) {
                     throw new Error("binary update format magic mismatch");
                 }
                 // TODO: some uint64 values may not be representable as Number.
-                const subscriptionId = Number(event.data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
+                const subscriptionId = Number(data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
                 pos += UINT64_NUM_BYTES;
                 const value = { subscriptionId };
-                while (pos < event.data.length) {
-                    const len = event.data
-                        .subarray(pos, pos + UINT16_NUM_BYTES)
-                        .readUint16BE();
+                while (pos < data.length) {
+                    const len = data.subarray(pos, pos + UINT16_NUM_BYTES).readUint16BE();
                     pos += UINT16_NUM_BYTES;
-                    const magic = event.data
+                    const magic = data
                         .subarray(pos, pos + UINT32_NUM_BYTES)
                         .readUint32BE();
                     if (magic == protocol_js_1.EVM_FORMAT_MAGIC) {
-                        value.evm = event.data.subarray(pos, pos + len);
+                        value.evm = data.subarray(pos, pos + len);
                     }
                     else if (magic == protocol_js_1.SOLANA_FORMAT_MAGIC_BE) {
-                        value.solana = event.data.subarray(pos, pos + len);
+                        value.solana = data.subarray(pos, pos + len);
                     }
                     else if (magic == protocol_js_1.PARSED_FORMAT_MAGIC) {
-                        value.parsed = JSON.parse(event.data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
+                        value.parsed = JSON.parse(data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
                     }
                     else {
                         throw new Error("unknown magic: " + magic.toString());
@@ -66,8 +65,20 @@ class PythLazerClient {
             }
         });
     }
-    send(request) {
-        this.ws.send(JSON.stringify(request));
+    async subscribe(request) {
+        if (request.type !== "subscribe") {
+            throw new Error("Request must be a subscribe request");
+        }
+        await this.wsp.addSubscription(request);
+    }
+    async unsubscribe(subscriptionId) {
+        await this.wsp.removeSubscription(subscriptionId);
+    }
+    async send(request) {
+        await this.wsp.sendRequest(request);
+    }
+    shutdown() {
+        this.wsp.shutdown();
     }
 }
 exports.PythLazerClient = PythLazerClient;

package/dist/cjs/socket/resilient-web-socket.d.ts

@@ -0,0 +1,38 @@
+import type { ClientRequestArgs } from "node:http";
+import WebSocket, { type ClientOptions, type ErrorEvent } from "isomorphic-ws";
+import type { Logger } from "ts-log";
+/**
+ * This class wraps websocket to provide a resilient web socket client.
+ *
+ * It will reconnect if connection fails with exponential backoff. Also, it will reconnect
+ * if it receives no ping request or regular message from server within a while as indication
+ * of timeout (assuming the server sends either regularly).
+ *
+ * This class also logs events if logger is given and by replacing onError method you can handle
+ * connection errors yourself (e.g: do not retry and close the connection).
+ */
+export declare class ResilientWebSocket {
+    endpoint: string;
+    wsClient: undefined | WebSocket;
+    wsUserClosed: boolean;
+    private wsOptions;
+    private wsFailedAttempts;
+    private heartbeatTimeout;
+    private logger;
+    onError: (error: ErrorEvent) => void;
+    onMessage: (data: WebSocket.Data) => void;
+    onReconnect: () => void;
+    constructor(endpoint: string, wsOptions?: ClientOptions | ClientRequestArgs, logger?: Logger);
+    send(data: string | Buffer): Promise<void>;
+    startWebSocket(): void;
+    /**
+     * Reset the heartbeat timeout. This is called when we receive any message (ping or regular)
+     * from the server. If we don't receive any message within HEARTBEAT_TIMEOUT_DURATION,
+     * we assume the connection is dead and reconnect.
+     */
+    private resetHeartbeat;
+    private waitForMaybeReadyWebSocket;
+    private handleClose;
+    private restartUnexpectedClosedWebsocket;
+    closeWebSocket(): void;
+}

package/dist/cjs/socket/resilient-web-socket.js

@@ -0,0 +1,161 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResilientWebSocket = void 0;
+const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
+// Reconnect with expo backoff if we don't get a message or ping for 10 seconds
+const HEARTBEAT_TIMEOUT_DURATION = 10_000;
+/**
+ * This class wraps websocket to provide a resilient web socket client.
+ *
+ * It will reconnect if connection fails with exponential backoff. Also, it will reconnect
+ * if it receives no ping request or regular message from server within a while as indication
+ * of timeout (assuming the server sends either regularly).
+ *
+ * This class also logs events if logger is given and by replacing onError method you can handle
+ * connection errors yourself (e.g: do not retry and close the connection).
+ */
+class ResilientWebSocket {
+    endpoint;
+    wsClient;
+    wsUserClosed;
+    wsOptions;
+    wsFailedAttempts;
+    heartbeatTimeout;
+    logger;
+    onError;
+    onMessage;
+    onReconnect;
+    constructor(endpoint, wsOptions, logger) {
+        this.endpoint = endpoint;
+        this.wsOptions = wsOptions;
+        this.logger = logger;
+        this.wsFailedAttempts = 0;
+        this.onError = (error) => {
+            this.logger?.error(error.error);
+        };
+        this.wsUserClosed = true;
+        this.onMessage = (data) => {
+            void data;
+        };
+        this.onReconnect = () => {
+            // Empty function, can be set by the user.
+        };
+    }
+    async send(data) {
+        this.logger?.info(`Sending message`);
+        await this.waitForMaybeReadyWebSocket();
+        if (this.wsClient === undefined) {
+            this.logger?.error("Couldn't connect to the websocket server. Error callback is called.");
+        }
+        else {
+            this.wsClient.send(data);
+        }
+    }
+    startWebSocket() {
+        if (this.wsClient !== undefined) {
+            return;
+        }
+        this.logger?.info(`Creating Web Socket client`);
+        this.wsClient = new isomorphic_ws_1.default(this.endpoint, this.wsOptions);
+        this.wsUserClosed = false;
+        this.wsClient.addEventListener("open", () => {
+            this.wsFailedAttempts = 0;
+            this.resetHeartbeat();
+        });
+        this.wsClient.addEventListener("error", (event) => {
+            this.onError(event);
+        });
+        this.wsClient.addEventListener("message", (event) => {
+            this.resetHeartbeat();
+            this.onMessage(event.data);
+        });
+        this.wsClient.addEventListener("close", () => {
+            void this.handleClose();
+        });
+        // Handle ping events if supported (Node.js only)
+        if ("on" in this.wsClient) {
+            // Ping handler is undefined in browser side
+            this.wsClient.on("ping", () => {
+                this.logger?.info("Ping received");
+                this.resetHeartbeat();
+            });
+        }
+    }
+    /**
+     * Reset the heartbeat timeout. This is called when we receive any message (ping or regular)
+     * from the server. If we don't receive any message within HEARTBEAT_TIMEOUT_DURATION,
+     * we assume the connection is dead and reconnect.
+     */
+    resetHeartbeat() {
+        if (this.heartbeatTimeout !== undefined) {
+            clearTimeout(this.heartbeatTimeout);
+        }
+        this.heartbeatTimeout = setTimeout(() => {
+            this.logger?.warn("Connection timed out. Reconnecting...");
+            this.wsClient?.terminate();
+            void this.restartUnexpectedClosedWebsocket();
+        }, HEARTBEAT_TIMEOUT_DURATION);
+    }
+    async waitForMaybeReadyWebSocket() {
+        let waitedTime = 0;
+        while (this.wsClient !== undefined &&
+            this.wsClient.readyState !== this.wsClient.OPEN) {
+            if (waitedTime > 5000) {
+                this.wsClient.close();
+                return;
+            }
+            else {
+                waitedTime += 10;
+                await sleep(10);
+            }
+        }
+    }
+    async handleClose() {
+        if (this.heartbeatTimeout !== undefined) {
+            clearTimeout(this.heartbeatTimeout);
+        }
+        if (this.wsUserClosed) {
+            this.logger?.info("The connection has been closed successfully.");
+        }
+        else {
+            this.wsFailedAttempts += 1;
+            this.wsClient = undefined;
+            const waitTime = expoBackoff(this.wsFailedAttempts);
+            this.logger?.error("Connection closed unexpectedly or because of timeout. Reconnecting after " +
+                String(waitTime) +
+                "ms.");
+            await sleep(waitTime);
+            await this.restartUnexpectedClosedWebsocket();
+        }
+    }
+    async restartUnexpectedClosedWebsocket() {
+        if (this.wsUserClosed) {
+            return;
+        }
+        this.startWebSocket();
+        await this.waitForMaybeReadyWebSocket();
+        if (this.wsClient === undefined) {
+            this.logger?.error("Couldn't reconnect to websocket. Error callback is called.");
+            return;
+        }
+        this.onReconnect();
+    }
+    closeWebSocket() {
+        if (this.wsClient !== undefined) {
+            const client = this.wsClient;
+            this.wsClient = undefined;
+            client.close();
+        }
+        this.wsUserClosed = true;
+    }
+}
+exports.ResilientWebSocket = ResilientWebSocket;
+async function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+function expoBackoff(attempts) {
+    return 2 ** attempts * 100;
+}

package/dist/cjs/socket/web-socket-pool.d.ts

@@ -0,0 +1,55 @@
+import WebSocket from "isomorphic-ws";
+import { type Logger } from "ts-log";
+import { ResilientWebSocket } from "./resilient-web-socket.js";
+import type { Request } from "../protocol.js";
+export declare class WebSocketPool {
+    private readonly logger;
+    rwsPool: ResilientWebSocket[];
+    private cache;
+    private subscriptions;
+    private messageListeners;
+    /**
+     * Creates a new WebSocketPool instance that uses multiple redundant WebSocket connections for reliability.
+     * Usage semantics are similar to using a regular WebSocket client.
+     * @param urls - List of WebSocket URLs to connect to
+     * @param token - Authentication token to use for the connections
+     * @param numConnections - Number of parallel WebSocket connections to maintain (default: 3)
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls: string[], token: string, numConnections?: number, logger?: Logger);
+    /**
+     * Checks for error responses in JSON messages and throws appropriate errors
+     */
+    private handleErrorMessages;
+    /**
+     * Handles incoming websocket messages by deduplicating identical messages received across
+     * multiple connections before forwarding to registered handlers
+     */
+    dedupeHandler: (data: WebSocket.Data) => void;
+    /**
+     * Sends a message to all websockets in the pool
+     * @param request - The request to send
+     */
+    sendRequest(request: Request): Promise<void>;
+    /**
+     * Adds a subscription by sending a subscribe request to all websockets in the pool
+     * and storing it for replay on reconnection
+     * @param request - The subscription request to send
+     */
+    addSubscription(request: Request): Promise<void>;
+    /**
+     * Removes a subscription by sending an unsubscribe request to all websockets in the pool
+     * and removing it from stored subscriptions
+     * @param subscriptionId - The ID of the subscription to remove
+     */
+    removeSubscription(subscriptionId: number): Promise<void>;
+    /**
+     * Adds a message handler function to receive websocket messages
+     * @param handler - Function that will be called with each received message
+     */
+    addMessageListener(handler: (data: WebSocket.Data) => void): void;
+    /**
+     * Elegantly closes all websocket connections in the pool
+     */
+    shutdown(): void;
+}

package/dist/cjs/socket/web-socket-pool.js

@@ -0,0 +1,174 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketPool = void 0;
+const ttlcache_1 = __importDefault(require("@isaacs/ttlcache"));
+const ts_log_1 = require("ts-log");
+const resilient_web_socket_js_1 = require("./resilient-web-socket.js");
+// Number of redundant parallel WebSocket connections
+const DEFAULT_NUM_CONNECTIONS = 3;
+class WebSocketPool {
+    logger;
+    rwsPool;
+    cache;
+    subscriptions; // id -> subscription Request
+    messageListeners;
+    /**
+     * Creates a new WebSocketPool instance that uses multiple redundant WebSocket connections for reliability.
+     * Usage semantics are similar to using a regular WebSocket client.
+     * @param urls - List of WebSocket URLs to connect to
+     * @param token - Authentication token to use for the connections
+     * @param numConnections - Number of parallel WebSocket connections to maintain (default: 3)
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls, token, numConnections = DEFAULT_NUM_CONNECTIONS, logger = ts_log_1.dummyLogger) {
+        this.logger = logger;
+        if (urls.length === 0) {
+            throw new Error("No URLs provided");
+        }
+        // This cache is used to deduplicate messages received across different websocket clients in the pool.
+        // A TTL cache is used to prevent unbounded memory usage. A very short TTL of 10 seconds is chosen since
+        // deduplication only needs to happen between messages received very close together in time.
+        this.cache = new ttlcache_1.default({ ttl: 1000 * 10 }); // TTL of 10 seconds
+        this.rwsPool = [];
+        this.subscriptions = new Map();
+        this.messageListeners = [];
+        for (let i = 0; i < numConnections; i++) {
+            const url = urls[i % urls.length];
+            if (!url) {
+                throw new Error(`URLs must not be null or empty`);
+            }
+            const wsOptions = {
+                headers: {
+                    Authorization: `Bearer ${token}`,
+                },
+            };
+            const rws = new resilient_web_socket_js_1.ResilientWebSocket(url, wsOptions, logger);
+            // If a websocket client unexpectedly disconnects, ResilientWebSocket will reestablish
+            // the connection and call the onReconnect callback.
+            // When we reconnect, replay all subscription messages to resume the data stream.
+            rws.onReconnect = () => {
+                if (rws.wsUserClosed) {
+                    return;
+                }
+                for (const [, request] of this.subscriptions) {
+                    try {
+                        void rws.send(JSON.stringify(request));
+                    }
+                    catch (error) {
+                        this.logger.error("Failed to resend subscription on reconnect:", error);
+                    }
+                }
+            };
+            // Handle all client messages ourselves. Dedupe before sending to registered message handlers.
+            rws.onMessage = this.dedupeHandler;
+            this.rwsPool.push(rws);
+        }
+        // Let it rip
+        // TODO: wait for sockets to receive `open` msg before subscribing?
+        for (const rws of this.rwsPool) {
+            rws.startWebSocket();
+        }
+        this.logger.info(`Using ${numConnections.toString()} redundant WebSocket connections`);
+    }
+    /**
+     * Checks for error responses in JSON messages and throws appropriate errors
+     */
+    handleErrorMessages(data) {
+        const message = JSON.parse(data);
+        if (message.type === "subscriptionError") {
+            throw new Error(`Error occurred for subscription ID ${String(message.subscriptionId)}: ${message.error}`);
+        }
+        else if (message.type === "error") {
+            throw new Error(`Error: ${message.error}`);
+        }
+    }
+    /**
+     * Handles incoming websocket messages by deduplicating identical messages received across
+     * multiple connections before forwarding to registered handlers
+     */
+    dedupeHandler = (data) => {
+        // For string data, use the whole string as the cache key. This avoids expensive JSON parsing during deduping.
+        // For binary data, use the hex string representation as the cache key
+        const cacheKey = typeof data === "string"
+            ? data
+            : Buffer.from(data).toString("hex");
+        // If we've seen this exact message recently, drop it
+        if (this.cache.has(cacheKey)) {
+            this.logger.debug("Dropping duplicate message");
+            return;
+        }
+        // Haven't seen this message, cache it and forward to handlers
+        this.cache.set(cacheKey, true);
+        // Check for errors in JSON responses
+        if (typeof data === "string") {
+            this.handleErrorMessages(data);
+        }
+        for (const handler of this.messageListeners) {
+            handler(data);
+        }
+    };
+    /**
+     * Sends a message to all websockets in the pool
+     * @param request - The request to send
+     */
+    async sendRequest(request) {
+        // Send to all websockets in the pool
+        const sendPromises = this.rwsPool.map(async (rws) => {
+            try {
+                await rws.send(JSON.stringify(request));
+            }
+            catch (error) {
+                this.logger.error("Failed to send request:", error);
+                throw error; // Re-throw the error
+            }
+        });
+        await Promise.all(sendPromises);
+    }
+    /**
+     * Adds a subscription by sending a subscribe request to all websockets in the pool
+     * and storing it for replay on reconnection
+     * @param request - The subscription request to send
+     */
+    async addSubscription(request) {
+        if (request.type !== "subscribe") {
+            throw new Error("Request must be a subscribe request");
+        }
+        this.subscriptions.set(request.subscriptionId, request);
+        await this.sendRequest(request);
+    }
+    /**
+     * Removes a subscription by sending an unsubscribe request to all websockets in the pool
+     * and removing it from stored subscriptions
+     * @param subscriptionId - The ID of the subscription to remove
+     */
+    async removeSubscription(subscriptionId) {
+        this.subscriptions.delete(subscriptionId);
+        const request = {
+            type: "unsubscribe",
+            subscriptionId,
+        };
+        await this.sendRequest(request);
+    }
+    /**
+     * Adds a message handler function to receive websocket messages
+     * @param handler - Function that will be called with each received message
+     */
+    addMessageListener(handler) {
+        this.messageListeners.push(handler);
+    }
+    /**
+     * Elegantly closes all websocket connections in the pool
+     */
+    shutdown() {
+        for (const rws of this.rwsPool) {
+            rws.closeWebSocket();
+        }
+        this.rwsPool = [];
+        this.subscriptions.clear();
+        this.messageListeners = [];
+    }
+}
+exports.WebSocketPool = WebSocketPool;

package/dist/esm/client.d.ts

@@ -1,5 +1,6 @@
-import WebSocket from "isomorphic-ws";
+import { type Logger } from "ts-log";
 import { type ParsedPayload, type Request, type Response } from "./protocol.js";
+import { WebSocketPool } from "./socket/web-socket-pool.js";
 export type BinaryResponse = {
     subscriptionId: number;
     evm?: Buffer | undefined;
@@ -14,8 +15,18 @@ export type JsonOrBinaryResponse = {
     value: BinaryResponse;
 };
 export declare class PythLazerClient {
-    ws: WebSocket;
-    constructor(url: string, token: string);
+    wsp: WebSocketPool;
+    /**
+     * Creates a new PythLazerClient instance.
+     * @param urls - List of WebSocket URLs of the Pyth Lazer service
+     * @param token - The access token for authentication
+     * @param numConnections - The number of parallel WebSocket connections to establish (default: 3). A higher number gives a more reliable stream.
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls: string[], token: string, numConnections?: number, logger?: Logger);
     addMessageListener(handler: (event: JsonOrBinaryResponse) => void): void;
-    send(request: Request): void;
+    subscribe(request: Request): Promise<void>;
+    unsubscribe(subscriptionId: number): Promise<void>;
+    send(request: Request): Promise<void>;
+    shutdown(): void;
 }

package/dist/esm/client.js

@@ -1,52 +1,55 @@
 import WebSocket from "isomorphic-ws";
+import { dummyLogger } from "ts-log";
 import { BINARY_UPDATE_FORMAT_MAGIC, EVM_FORMAT_MAGIC, PARSED_FORMAT_MAGIC, SOLANA_FORMAT_MAGIC_BE, } from "./protocol.js";
+import { WebSocketPool } from "./socket/web-socket-pool.js";
 const UINT16_NUM_BYTES = 2;
 const UINT32_NUM_BYTES = 4;
 const UINT64_NUM_BYTES = 8;
 export class PythLazerClient {
-    ws;
-    constructor(url, token) {
-        const finalUrl = new URL(url);
-        finalUrl.searchParams.append("ACCESS_TOKEN", token);
-        this.ws = new WebSocket(finalUrl);
+    wsp;
+    /**
+     * Creates a new PythLazerClient instance.
+     * @param urls - List of WebSocket URLs of the Pyth Lazer service
+     * @param token - The access token for authentication
+     * @param numConnections - The number of parallel WebSocket connections to establish (default: 3). A higher number gives a more reliable stream.
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls, token, numConnections = 3, logger = dummyLogger) {
+        this.wsp = new WebSocketPool(urls, token, numConnections, logger);
     }
     addMessageListener(handler) {
-        this.ws.addEventListener("message", (event) => {
-            if (typeof event.data == "string") {
+        this.wsp.addMessageListener((data) => {
+            if (typeof data == "string") {
                 handler({
                     type: "json",
-                    value: JSON.parse(event.data),
+                    value: JSON.parse(data),
                 });
             }
-            else if (Buffer.isBuffer(event.data)) {
+            else if (Buffer.isBuffer(data)) {
                 let pos = 0;
-                const magic = event.data
-                    .subarray(pos, pos + UINT32_NUM_BYTES)
-                    .readUint32BE();
+                const magic = data.subarray(pos, pos + UINT32_NUM_BYTES).readUint32BE();
                 pos += UINT32_NUM_BYTES;
                 if (magic != BINARY_UPDATE_FORMAT_MAGIC) {
                     throw new Error("binary update format magic mismatch");
                 }
                 // TODO: some uint64 values may not be representable as Number.
-                const subscriptionId = Number(event.data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
+                const subscriptionId = Number(data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
                 pos += UINT64_NUM_BYTES;
                 const value = { subscriptionId };
-                while (pos < event.data.length) {
-                    const len = event.data
-                        .subarray(pos, pos + UINT16_NUM_BYTES)
-                        .readUint16BE();
+                while (pos < data.length) {
+                    const len = data.subarray(pos, pos + UINT16_NUM_BYTES).readUint16BE();
                     pos += UINT16_NUM_BYTES;
-                    const magic = event.data
+                    const magic = data
                         .subarray(pos, pos + UINT32_NUM_BYTES)
                         .readUint32BE();
                     if (magic == EVM_FORMAT_MAGIC) {
-                        value.evm = event.data.subarray(pos, pos + len);
+                        value.evm = data.subarray(pos, pos + len);
                     }
                     else if (magic == SOLANA_FORMAT_MAGIC_BE) {
-                        value.solana = event.data.subarray(pos, pos + len);
+                        value.solana = data.subarray(pos, pos + len);
                     }
                     else if (magic == PARSED_FORMAT_MAGIC) {
-                        value.parsed = JSON.parse(event.data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
+                        value.parsed = JSON.parse(data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
                     }
                     else {
                         throw new Error("unknown magic: " + magic.toString());
@@ -60,7 +63,19 @@ export class PythLazerClient {
             }
         });
     }
-    send(request) {
-        this.ws.send(JSON.stringify(request));
+    async subscribe(request) {
+        if (request.type !== "subscribe") {
+            throw new Error("Request must be a subscribe request");
+        }
+        await this.wsp.addSubscription(request);
+    }
+    async unsubscribe(subscriptionId) {
+        await this.wsp.removeSubscription(subscriptionId);
+    }
+    async send(request) {
+        await this.wsp.sendRequest(request);
+    }
+    shutdown() {
+        this.wsp.shutdown();
     }
 }

package/dist/esm/socket/resilient-web-socket.d.ts

@@ -0,0 +1,38 @@
+import type { ClientRequestArgs } from "node:http";
+import WebSocket, { type ClientOptions, type ErrorEvent } from "isomorphic-ws";
+import type { Logger } from "ts-log";
+/**
+ * This class wraps websocket to provide a resilient web socket client.
+ *
+ * It will reconnect if connection fails with exponential backoff. Also, it will reconnect
+ * if it receives no ping request or regular message from server within a while as indication
+ * of timeout (assuming the server sends either regularly).
+ *
+ * This class also logs events if logger is given and by replacing onError method you can handle
+ * connection errors yourself (e.g: do not retry and close the connection).
+ */
+export declare class ResilientWebSocket {
+    endpoint: string;
+    wsClient: undefined | WebSocket;
+    wsUserClosed: boolean;
+    private wsOptions;
+    private wsFailedAttempts;
+    private heartbeatTimeout;
+    private logger;
+    onError: (error: ErrorEvent) => void;
+    onMessage: (data: WebSocket.Data) => void;
+    onReconnect: () => void;
+    constructor(endpoint: string, wsOptions?: ClientOptions | ClientRequestArgs, logger?: Logger);
+    send(data: string | Buffer): Promise<void>;
+    startWebSocket(): void;
+    /**
+     * Reset the heartbeat timeout. This is called when we receive any message (ping or regular)
+     * from the server. If we don't receive any message within HEARTBEAT_TIMEOUT_DURATION,
+     * we assume the connection is dead and reconnect.
+     */
+    private resetHeartbeat;
+    private waitForMaybeReadyWebSocket;
+    private handleClose;
+    private restartUnexpectedClosedWebsocket;
+    closeWebSocket(): void;
+}

package/dist/esm/socket/resilient-web-socket.js

@@ -0,0 +1,154 @@
+import WebSocket, {} from "isomorphic-ws";
+// Reconnect with expo backoff if we don't get a message or ping for 10 seconds
+const HEARTBEAT_TIMEOUT_DURATION = 10_000;
+/**
+ * This class wraps websocket to provide a resilient web socket client.
+ *
+ * It will reconnect if connection fails with exponential backoff. Also, it will reconnect
+ * if it receives no ping request or regular message from server within a while as indication
+ * of timeout (assuming the server sends either regularly).
+ *
+ * This class also logs events if logger is given and by replacing onError method you can handle
+ * connection errors yourself (e.g: do not retry and close the connection).
+ */
+export class ResilientWebSocket {
+    endpoint;
+    wsClient;
+    wsUserClosed;
+    wsOptions;
+    wsFailedAttempts;
+    heartbeatTimeout;
+    logger;
+    onError;
+    onMessage;
+    onReconnect;
+    constructor(endpoint, wsOptions, logger) {
+        this.endpoint = endpoint;
+        this.wsOptions = wsOptions;
+        this.logger = logger;
+        this.wsFailedAttempts = 0;
+        this.onError = (error) => {
+            this.logger?.error(error.error);
+        };
+        this.wsUserClosed = true;
+        this.onMessage = (data) => {
+            void data;
+        };
+        this.onReconnect = () => {
+            // Empty function, can be set by the user.
+        };
+    }
+    async send(data) {
+        this.logger?.info(`Sending message`);
+        await this.waitForMaybeReadyWebSocket();
+        if (this.wsClient === undefined) {
+            this.logger?.error("Couldn't connect to the websocket server. Error callback is called.");
+        }
+        else {
+            this.wsClient.send(data);
+        }
+    }
+    startWebSocket() {
+        if (this.wsClient !== undefined) {
+            return;
+        }
+        this.logger?.info(`Creating Web Socket client`);
+        this.wsClient = new WebSocket(this.endpoint, this.wsOptions);
+        this.wsUserClosed = false;
+        this.wsClient.addEventListener("open", () => {
+            this.wsFailedAttempts = 0;
+            this.resetHeartbeat();
+        });
+        this.wsClient.addEventListener("error", (event) => {
+            this.onError(event);
+        });
+        this.wsClient.addEventListener("message", (event) => {
+            this.resetHeartbeat();
+            this.onMessage(event.data);
+        });
+        this.wsClient.addEventListener("close", () => {
+            void this.handleClose();
+        });
+        // Handle ping events if supported (Node.js only)
+        if ("on" in this.wsClient) {
+            // Ping handler is undefined in browser side
+            this.wsClient.on("ping", () => {
+                this.logger?.info("Ping received");
+                this.resetHeartbeat();
+            });
+        }
+    }
+    /**
+     * Reset the heartbeat timeout. This is called when we receive any message (ping or regular)
+     * from the server. If we don't receive any message within HEARTBEAT_TIMEOUT_DURATION,
+     * we assume the connection is dead and reconnect.
+     */
+    resetHeartbeat() {
+        if (this.heartbeatTimeout !== undefined) {
+            clearTimeout(this.heartbeatTimeout);
+        }
+        this.heartbeatTimeout = setTimeout(() => {
+            this.logger?.warn("Connection timed out. Reconnecting...");
+            this.wsClient?.terminate();
+            void this.restartUnexpectedClosedWebsocket();
+        }, HEARTBEAT_TIMEOUT_DURATION);
+    }
+    async waitForMaybeReadyWebSocket() {
+        let waitedTime = 0;
+        while (this.wsClient !== undefined &&
+            this.wsClient.readyState !== this.wsClient.OPEN) {
+            if (waitedTime > 5000) {
+                this.wsClient.close();
+                return;
+            }
+            else {
+                waitedTime += 10;
+                await sleep(10);
+            }
+        }
+    }
+    async handleClose() {
+        if (this.heartbeatTimeout !== undefined) {
+            clearTimeout(this.heartbeatTimeout);
+        }
+        if (this.wsUserClosed) {
+            this.logger?.info("The connection has been closed successfully.");
+        }
+        else {
+            this.wsFailedAttempts += 1;
+            this.wsClient = undefined;
+            const waitTime = expoBackoff(this.wsFailedAttempts);
+            this.logger?.error("Connection closed unexpectedly or because of timeout. Reconnecting after " +
+                String(waitTime) +
+                "ms.");
+            await sleep(waitTime);
+            await this.restartUnexpectedClosedWebsocket();
+        }
+    }
+    async restartUnexpectedClosedWebsocket() {
+        if (this.wsUserClosed) {
+            return;
+        }
+        this.startWebSocket();
+        await this.waitForMaybeReadyWebSocket();
+        if (this.wsClient === undefined) {
+            this.logger?.error("Couldn't reconnect to websocket. Error callback is called.");
+            return;
+        }
+        this.onReconnect();
+    }
+    closeWebSocket() {
+        if (this.wsClient !== undefined) {
+            const client = this.wsClient;
+            this.wsClient = undefined;
+            client.close();
+        }
+        this.wsUserClosed = true;
+    }
+}
+async function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+function expoBackoff(attempts) {
+    return 2 ** attempts * 100;
+}

package/dist/esm/socket/web-socket-pool.d.ts

@@ -0,0 +1,55 @@
+import WebSocket from "isomorphic-ws";
+import { type Logger } from "ts-log";
+import { ResilientWebSocket } from "./resilient-web-socket.js";
+import type { Request } from "../protocol.js";
+export declare class WebSocketPool {
+    private readonly logger;
+    rwsPool: ResilientWebSocket[];
+    private cache;
+    private subscriptions;
+    private messageListeners;
+    /**
+     * Creates a new WebSocketPool instance that uses multiple redundant WebSocket connections for reliability.
+     * Usage semantics are similar to using a regular WebSocket client.
+     * @param urls - List of WebSocket URLs to connect to
+     * @param token - Authentication token to use for the connections
+     * @param numConnections - Number of parallel WebSocket connections to maintain (default: 3)
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls: string[], token: string, numConnections?: number, logger?: Logger);
+    /**
+     * Checks for error responses in JSON messages and throws appropriate errors
+     */
+    private handleErrorMessages;
+    /**
+     * Handles incoming websocket messages by deduplicating identical messages received across
+     * multiple connections before forwarding to registered handlers
+     */
+    dedupeHandler: (data: WebSocket.Data) => void;
+    /**
+     * Sends a message to all websockets in the pool
+     * @param request - The request to send
+     */
+    sendRequest(request: Request): Promise<void>;
+    /**
+     * Adds a subscription by sending a subscribe request to all websockets in the pool
+     * and storing it for replay on reconnection
+     * @param request - The subscription request to send
+     */
+    addSubscription(request: Request): Promise<void>;
+    /**
+     * Removes a subscription by sending an unsubscribe request to all websockets in the pool
+     * and removing it from stored subscriptions
+     * @param subscriptionId - The ID of the subscription to remove
+     */
+    removeSubscription(subscriptionId: number): Promise<void>;
+    /**
+     * Adds a message handler function to receive websocket messages
+     * @param handler - Function that will be called with each received message
+     */
+    addMessageListener(handler: (data: WebSocket.Data) => void): void;
+    /**
+     * Elegantly closes all websocket connections in the pool
+     */
+    shutdown(): void;
+}

package/dist/esm/socket/web-socket-pool.js

@@ -0,0 +1,168 @@
+import TTLCache from "@isaacs/ttlcache";
+import WebSocket from "isomorphic-ws";
+import { dummyLogger } from "ts-log";
+import { ResilientWebSocket } from "./resilient-web-socket.js";
+// Number of redundant parallel WebSocket connections
+const DEFAULT_NUM_CONNECTIONS = 3;
+export class WebSocketPool {
+    logger;
+    rwsPool;
+    cache;
+    subscriptions; // id -> subscription Request
+    messageListeners;
+    /**
+     * Creates a new WebSocketPool instance that uses multiple redundant WebSocket connections for reliability.
+     * Usage semantics are similar to using a regular WebSocket client.
+     * @param urls - List of WebSocket URLs to connect to
+     * @param token - Authentication token to use for the connections
+     * @param numConnections - Number of parallel WebSocket connections to maintain (default: 3)
+     * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
+     */
+    constructor(urls, token, numConnections = DEFAULT_NUM_CONNECTIONS, logger = dummyLogger) {
+        this.logger = logger;
+        if (urls.length === 0) {
+            throw new Error("No URLs provided");
+        }
+        // This cache is used to deduplicate messages received across different websocket clients in the pool.
+        // A TTL cache is used to prevent unbounded memory usage. A very short TTL of 10 seconds is chosen since
+        // deduplication only needs to happen between messages received very close together in time.
+        this.cache = new TTLCache({ ttl: 1000 * 10 }); // TTL of 10 seconds
+        this.rwsPool = [];
+        this.subscriptions = new Map();
+        this.messageListeners = [];
+        for (let i = 0; i < numConnections; i++) {
+            const url = urls[i % urls.length];
+            if (!url) {
+                throw new Error(`URLs must not be null or empty`);
+            }
+            const wsOptions = {
+                headers: {
+                    Authorization: `Bearer ${token}`,
+                },
+            };
+            const rws = new ResilientWebSocket(url, wsOptions, logger);
+            // If a websocket client unexpectedly disconnects, ResilientWebSocket will reestablish
+            // the connection and call the onReconnect callback.
+            // When we reconnect, replay all subscription messages to resume the data stream.
+            rws.onReconnect = () => {
+                if (rws.wsUserClosed) {
+                    return;
+                }
+                for (const [, request] of this.subscriptions) {
+                    try {
+                        void rws.send(JSON.stringify(request));
+                    }
+                    catch (error) {
+                        this.logger.error("Failed to resend subscription on reconnect:", error);
+                    }
+                }
+            };
+            // Handle all client messages ourselves. Dedupe before sending to registered message handlers.
+            rws.onMessage = this.dedupeHandler;
+            this.rwsPool.push(rws);
+        }
+        // Let it rip
+        // TODO: wait for sockets to receive `open` msg before subscribing?
+        for (const rws of this.rwsPool) {
+            rws.startWebSocket();
+        }
+        this.logger.info(`Using ${numConnections.toString()} redundant WebSocket connections`);
+    }
+    /**
+     * Checks for error responses in JSON messages and throws appropriate errors
+     */
+    handleErrorMessages(data) {
+        const message = JSON.parse(data);
+        if (message.type === "subscriptionError") {
+            throw new Error(`Error occurred for subscription ID ${String(message.subscriptionId)}: ${message.error}`);
+        }
+        else if (message.type === "error") {
+            throw new Error(`Error: ${message.error}`);
+        }
+    }
+    /**
+     * Handles incoming websocket messages by deduplicating identical messages received across
+     * multiple connections before forwarding to registered handlers
+     */
+    dedupeHandler = (data) => {
+        // For string data, use the whole string as the cache key. This avoids expensive JSON parsing during deduping.
+        // For binary data, use the hex string representation as the cache key
+        const cacheKey = typeof data === "string"
+            ? data
+            : Buffer.from(data).toString("hex");
+        // If we've seen this exact message recently, drop it
+        if (this.cache.has(cacheKey)) {
+            this.logger.debug("Dropping duplicate message");
+            return;
+        }
+        // Haven't seen this message, cache it and forward to handlers
+        this.cache.set(cacheKey, true);
+        // Check for errors in JSON responses
+        if (typeof data === "string") {
+            this.handleErrorMessages(data);
+        }
+        for (const handler of this.messageListeners) {
+            handler(data);
+        }
+    };
+    /**
+     * Sends a message to all websockets in the pool
+     * @param request - The request to send
+     */
+    async sendRequest(request) {
+        // Send to all websockets in the pool
+        const sendPromises = this.rwsPool.map(async (rws) => {
+            try {
+                await rws.send(JSON.stringify(request));
+            }
+            catch (error) {
+                this.logger.error("Failed to send request:", error);
+                throw error; // Re-throw the error
+            }
+        });
+        await Promise.all(sendPromises);
+    }
+    /**
+     * Adds a subscription by sending a subscribe request to all websockets in the pool
+     * and storing it for replay on reconnection
+     * @param request - The subscription request to send
+     */
+    async addSubscription(request) {
+        if (request.type !== "subscribe") {
+            throw new Error("Request must be a subscribe request");
+        }
+        this.subscriptions.set(request.subscriptionId, request);
+        await this.sendRequest(request);
+    }
+    /**
+     * Removes a subscription by sending an unsubscribe request to all websockets in the pool
+     * and removing it from stored subscriptions
+     * @param subscriptionId - The ID of the subscription to remove
+     */
+    async removeSubscription(subscriptionId) {
+        this.subscriptions.delete(subscriptionId);
+        const request = {
+            type: "unsubscribe",
+            subscriptionId,
+        };
+        await this.sendRequest(request);
+    }
+    /**
+     * Adds a message handler function to receive websocket messages
+     * @param handler - Function that will be called with each received message
+     */
+    addMessageListener(handler) {
+        this.messageListeners.push(handler);
+    }
+    /**
+     * Elegantly closes all websocket connections in the pool
+     */
+    shutdown() {
+        for (const rws of this.rwsPool) {
+            rws.closeWebSocket();
+        }
+        this.rwsPool = [];
+        this.subscriptions.clear();
+        this.messageListeners = [];
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-lazer-sdk",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Pyth Lazer SDK",
   "publishConfig": {
     "access": "public"
@@ -60,10 +60,12 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
+    "@isaacs/ttlcache": "^1.4.1",
     "@solana/buffer-layout": "^4.0.1",
     "@solana/web3.js": "^1.98.0",
     "isomorphic-ws": "^5.0.0",
+    "ts-log": "^2.2.7",
     "ws": "^8.18.0"
   },
-  "gitHead": "57670ca732de0be3ed7926f38f4853f01cd816fa"
+  "gitHead": "7cb1725be86f01810025b6ceac1a8d6df2c37285"
 }