@pythnetwork/pyth-lazer-sdk 5.2.1 → 6.2.0

package/dist/esm/socket/websocket-pool.mjs

@@ -1,21 +1,26 @@
 import TTLCache from "@isaacs/ttlcache";
 import { dummyLogger } from "ts-log";
-import { ResilientWebSocket } from "./resilient-websocket.mjs";
 import { DEFAULT_STREAM_SERVICE_0_URL, DEFAULT_STREAM_SERVICE_1_URL } from "../constants.mjs";
 import { IsomorphicEventEmitter } from "../emitter/index.mjs";
 import { addAuthTokenToWebSocketUrl, bufferFromWebsocketData, envIsBrowserOrWorker } from "../util/index.mjs";
+import { ResilientWebSocket } from "./resilient-websocket.mjs";
 const DEFAULT_NUM_CONNECTIONS = 4;
 export class WebSocketPool extends IsomorphicEventEmitter {
     logger;
+    abortSignal;
     rwsPool;
     cache;
     subscriptions;
     messageListeners;
     allConnectionsDownListeners;
+    connectionRestoredListeners;
+    connectionTimeoutListeners;
+    connectionReconnectListeners;
     wasAllDown = true;
     checkConnectionStatesInterval;
-    constructor(logger){
-        super(), this.logger = logger;
+    isShutdown = false;
+    constructor(logger, abortSignal){
+        super(), this.logger = logger, this.abortSignal = abortSignal;
         this.rwsPool = [];
         this.cache = new TTLCache({
             ttl: 1000 * 10
@@ -23,6 +28,9 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         this.subscriptions = new Map();
         this.messageListeners = [];
         this.allConnectionsDownListeners = [];
+        this.connectionRestoredListeners = [];
+        this.connectionTimeoutListeners = [];
+        this.connectionReconnectListeners = [];
         // Start monitoring connection states
         this.checkConnectionStatesInterval = setInterval(()=>{
             this.checkConnectionStates();
@@ -35,13 +43,13 @@ export class WebSocketPool extends IsomorphicEventEmitter {
    * @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`.
-   */ static async create(config, token, logger) {
+   */ static async create(config, token, abortSignal, logger) {
         const urls = config.urls ?? [
             DEFAULT_STREAM_SERVICE_0_URL,
             DEFAULT_STREAM_SERVICE_1_URL
         ];
         const log = logger ?? dummyLogger;
-        const pool = new WebSocketPool(log);
+        const pool = new WebSocketPool(log, abortSignal);
         const numConnections = config.numConnections ?? DEFAULT_NUM_CONNECTIONS;
         // bind a handler to capture any emitted errors and send them to the user-provided
         // onWebSocketPoolError callback (if it is present)
@@ -68,15 +76,20 @@ export class WebSocketPool extends IsomorphicEventEmitter {
             const rws = new ResilientWebSocket({
                 ...config.rwsConfig,
                 endpoint: url,
-                wsOptions,
-                logger: log
+                logger: log,
+                wsOptions
             });
+            const connectionIndex = i;
+            const connectionEndpoint = url;
             // If a websocket client unexpectedly disconnects, ResilientWebSocket will reestablish
             // the connection and call the onReconnect callback.
             rws.onReconnect = ()=>{
-                if (rws.wsUserClosed) {
+                if (rws.wsUserClosed || pool.isShutdown || pool.abortSignal?.aborted) {
                     return;
                 }
+                for (const listener of pool.connectionReconnectListeners){
+                    listener(connectionIndex, connectionEndpoint);
+                }
                 for (const [, request] of pool.subscriptions){
                     try {
                         rws.send(JSON.stringify(request));
@@ -85,6 +98,11 @@ export class WebSocketPool extends IsomorphicEventEmitter {
                     }
                 }
             };
+            rws.onTimeout = ()=>{
+                for (const listener of pool.connectionTimeoutListeners){
+                    listener(connectionIndex, connectionEndpoint);
+                }
+            };
             // eslint-disable-next-line @typescript-eslint/no-deprecated
             const onErrorHandler = config.onWebSocketError ?? config.onError;
             if (typeof onErrorHandler === "function") {
@@ -101,6 +119,11 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         }
         pool.logger.info(`Started WebSocketPool with ${numConnections.toString()} connections. Waiting for at least one to connect...`);
         while(!pool.isAnyConnectionEstablished()){
+            if (pool.abortSignal?.aborted) {
+                pool.logger.warn("the WebSocket Pool's abort signal was aborted during connection. Shutting down.");
+                pool.shutdown();
+                return pool;
+            }
             await new Promise((resolve)=>setTimeout(resolve, 100));
         }
         pool.logger.info(`At least one WebSocket connection is established. WebSocketPool is ready.`);
@@ -156,6 +179,10 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         }
     };
     sendRequest(request) {
+        if (this.isShutdown || this.abortSignal?.aborted) {
+            this.logger.warn("Cannot send request: WebSocketPool is shutdown or aborted");
+            return;
+        }
         for (const rws of this.rwsPool){
             try {
                 rws.send(JSON.stringify(request));
@@ -165,6 +192,10 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         }
     }
     addSubscription(request) {
+        if (this.isShutdown || this.abortSignal?.aborted) {
+            this.logger.warn("Cannot add subscription: WebSocketPool is shutdown or aborted");
+            return;
+        }
         if (request.type !== "subscribe") {
             this.emitPoolError(new Error("Request must be a subscribe request"));
             return;
@@ -173,10 +204,14 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         this.sendRequest(request);
     }
     removeSubscription(subscriptionId) {
+        if (this.isShutdown || this.abortSignal?.aborted) {
+            this.logger.warn("Cannot remove subscription: WebSocketPool is shutdown or aborted");
+            return;
+        }
         this.subscriptions.delete(subscriptionId);
         const request = {
-            type: "unsubscribe",
-            subscriptionId
+            subscriptionId,
+            type: "unsubscribe"
         };
         this.sendRequest(request);
     }
@@ -189,6 +224,23 @@ export class WebSocketPool extends IsomorphicEventEmitter {
    */ addAllConnectionsDownListener(handler) {
         this.allConnectionsDownListeners.push(handler);
     }
+    /**
+   * Calls the handler when at least one connection is restored after all connections were down.
+   */ addConnectionRestoredListener(handler) {
+        this.connectionRestoredListeners.push(handler);
+    }
+    /**
+   * Calls the handler when an individual connection times out (heartbeat timeout).
+   * @param handler - Callback with connection index and endpoint URL
+   */ addConnectionTimeoutListener(handler) {
+        this.connectionTimeoutListeners.push(handler);
+    }
+    /**
+   * Calls the handler when an individual connection reconnects after being down.
+   * @param handler - Callback with connection index and endpoint URL
+   */ addConnectionReconnectListener(handler) {
+        this.connectionReconnectListeners.push(handler);
+    }
     areAllConnectionsDown() {
         return this.rwsPool.every((ws)=>!ws.isConnected() || ws.isReconnecting());
     }
@@ -196,6 +248,10 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         return this.rwsPool.some((ws)=>ws.isConnected());
     }
     checkConnectionStates() {
+        // Stop monitoring if shutdown or aborted
+        if (this.isShutdown || this.abortSignal?.aborted) {
+            return;
+        }
         const allDown = this.areAllConnectionsDown();
         // If all connections just went down
         if (allDown && !this.wasAllDown) {
@@ -210,12 +266,25 @@ export class WebSocketPool extends IsomorphicEventEmitter {
                 }
             }
         }
-        // If at least one connection was restored
+        // If at least one connection was restored after all were down
         if (!allDown && this.wasAllDown) {
             this.wasAllDown = false;
+            this.logger.info("At least one WebSocket connection restored");
+            for (const listener of this.connectionRestoredListeners){
+                try {
+                    listener();
+                } catch (error) {
+                    this.emitPoolError(error, "Connection-restored listener threw");
+                }
+            }
         }
     }
     shutdown() {
+        // Prevent multiple shutdown calls
+        if (this.isShutdown) {
+            return;
+        }
+        this.isShutdown = true;
         for (const rws of this.rwsPool){
             rws.closeWebSocket();
         }
@@ -223,6 +292,9 @@ export class WebSocketPool extends IsomorphicEventEmitter {
         this.subscriptions.clear();
         this.messageListeners = [];
         this.allConnectionsDownListeners = [];
+        this.connectionRestoredListeners = [];
+        this.connectionTimeoutListeners = [];
+        this.connectionReconnectListeners = [];
         clearInterval(this.checkConnectionStatesInterval);
         // execute all bound shutdown handlers
         for (const shutdownHandler of this.getListeners("shutdown")){

package/package.json

@@ -1,176 +1,168 @@
 {
-  "name": "@pythnetwork/pyth-lazer-sdk",
-  "version": "5.2.1",
+  "bugs": {
+    "url": "https://github.com/pyth-network/pyth-crosschain/issues"
+  },
+  "dependencies": {
+    "@isaacs/ttlcache": "^1.4.1",
+    "buffer": "^6.0.3",
+    "isomorphic-ws": "^5.0.0",
+    "ts-log": "^2.2.7",
+    "ws": "^8.19.0"
+  },
   "description": "Pyth Lazer SDK",
+  "devDependencies": {
+    "@cprussin/tsconfig": "^4.0.2",
+    "@types/node": "^24.10.1",
+    "@types/ws": "^8.18.1",
+    "typedoc": "^0.28.17"
+  },
   "engines": {
     "node": "^24.0.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "dist/**/*"
-  ],
-  "main": "./dist/cjs/index.cjs",
-  "types": "./dist/cjs/index.d.ts",
   "exports": {
-    "./client": {
-      "require": {
-        "types": "./dist/cjs/client.d.ts",
-        "default": "./dist/cjs/client.cjs"
+    ".": {
+      "import": {
+        "default": "./dist/esm/index.mjs",
+        "types": "./dist/esm/index.d.ts"
       },
+      "require": {
+        "default": "./dist/cjs/index.cjs",
+        "types": "./dist/cjs/index.d.ts"
+      }
+    },
+    "./client": {
       "import": {
-        "types": "./dist/esm/client.d.ts",
-        "default": "./dist/esm/client.mjs"
+        "default": "./dist/esm/client.mjs",
+        "types": "./dist/esm/client.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/client.cjs",
+        "types": "./dist/cjs/client.d.ts"
       }
     },
     "./constants": {
-      "require": {
-        "types": "./dist/cjs/constants.d.ts",
-        "default": "./dist/cjs/constants.cjs"
-      },
       "import": {
-        "types": "./dist/esm/constants.d.ts",
-        "default": "./dist/esm/constants.mjs"
+        "default": "./dist/esm/constants.mjs",
+        "types": "./dist/esm/constants.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/constants.cjs",
+        "types": "./dist/cjs/constants.d.ts"
       }
     },
     "./emitter": {
-      "require": {
-        "types": "./dist/cjs/emitter/index.d.ts",
-        "default": "./dist/cjs/emitter/index.cjs"
-      },
       "import": {
-        "types": "./dist/esm/emitter/index.d.ts",
-        "default": "./dist/esm/emitter/index.mjs"
-      }
-    },
-    ".": {
-      "require": {
-        "types": "./dist/cjs/index.d.ts",
-        "default": "./dist/cjs/index.cjs"
+        "default": "./dist/esm/emitter/index.mjs",
+        "types": "./dist/esm/emitter/index.d.ts"
       },
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.mjs"
+      "require": {
+        "default": "./dist/cjs/emitter/index.cjs",
+        "types": "./dist/cjs/emitter/index.d.ts"
       }
     },
+    "./package.json": "./package.json",
     "./protocol": {
-      "require": {
-        "types": "./dist/cjs/protocol.d.ts",
-        "default": "./dist/cjs/protocol.cjs"
-      },
       "import": {
-        "types": "./dist/esm/protocol.d.ts",
-        "default": "./dist/esm/protocol.mjs"
+        "default": "./dist/esm/protocol.mjs",
+        "types": "./dist/esm/protocol.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/protocol.cjs",
+        "types": "./dist/cjs/protocol.d.ts"
       }
     },
     "./socket/resilient-websocket": {
-      "require": {
-        "types": "./dist/cjs/socket/resilient-websocket.d.ts",
-        "default": "./dist/cjs/socket/resilient-websocket.cjs"
-      },
       "import": {
-        "types": "./dist/esm/socket/resilient-websocket.d.ts",
-        "default": "./dist/esm/socket/resilient-websocket.mjs"
+        "default": "./dist/esm/socket/resilient-websocket.mjs",
+        "types": "./dist/esm/socket/resilient-websocket.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/socket/resilient-websocket.cjs",
+        "types": "./dist/cjs/socket/resilient-websocket.d.ts"
       }
     },
     "./socket/websocket-pool": {
-      "require": {
-        "types": "./dist/cjs/socket/websocket-pool.d.ts",
-        "default": "./dist/cjs/socket/websocket-pool.cjs"
+      "import": {
+        "default": "./dist/esm/socket/websocket-pool.mjs",
+        "types": "./dist/esm/socket/websocket-pool.d.ts"
       },
+      "require": {
+        "default": "./dist/cjs/socket/websocket-pool.cjs",
+        "types": "./dist/cjs/socket/websocket-pool.d.ts"
+      }
+    },
+    "./util": {
       "import": {
-        "types": "./dist/esm/socket/websocket-pool.d.ts",
-        "default": "./dist/esm/socket/websocket-pool.mjs"
+        "default": "./dist/esm/util/index.mjs",
+        "types": "./dist/esm/util/index.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/util/index.cjs",
+        "types": "./dist/cjs/util/index.d.ts"
       }
     },
     "./util/buffer-util": {
-      "require": {
-        "types": "./dist/cjs/util/buffer-util.d.ts",
-        "default": "./dist/cjs/util/buffer-util.cjs"
-      },
       "import": {
-        "types": "./dist/esm/util/buffer-util.d.ts",
-        "default": "./dist/esm/util/buffer-util.mjs"
+        "default": "./dist/esm/util/buffer-util.mjs",
+        "types": "./dist/esm/util/buffer-util.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/util/buffer-util.cjs",
+        "types": "./dist/cjs/util/buffer-util.d.ts"
       }
     },
     "./util/env-util": {
-      "require": {
-        "types": "./dist/cjs/util/env-util.d.ts",
-        "default": "./dist/cjs/util/env-util.cjs"
-      },
       "import": {
-        "types": "./dist/esm/util/env-util.d.ts",
-        "default": "./dist/esm/util/env-util.mjs"
-      }
-    },
-    "./util": {
-      "require": {
-        "types": "./dist/cjs/util/index.d.ts",
-        "default": "./dist/cjs/util/index.cjs"
+        "default": "./dist/esm/util/env-util.mjs",
+        "types": "./dist/esm/util/env-util.d.ts"
       },
-      "import": {
-        "types": "./dist/esm/util/index.d.ts",
-        "default": "./dist/esm/util/index.mjs"
+      "require": {
+        "default": "./dist/cjs/util/env-util.cjs",
+        "types": "./dist/cjs/util/env-util.d.ts"
       }
     },
     "./util/url-util": {
-      "require": {
-        "types": "./dist/cjs/util/url-util.d.ts",
-        "default": "./dist/cjs/util/url-util.cjs"
-      },
       "import": {
-        "types": "./dist/esm/util/url-util.d.ts",
-        "default": "./dist/esm/util/url-util.mjs"
+        "default": "./dist/esm/util/url-util.mjs",
+        "types": "./dist/esm/util/url-util.d.ts"
+      },
+      "require": {
+        "default": "./dist/cjs/util/url-util.cjs",
+        "types": "./dist/cjs/util/url-util.d.ts"
       }
-    },
-    "./package.json": "./package.json"
-  },
-  "devDependencies": {
-    "@cprussin/eslint-config": "^4.0.2",
-    "@cprussin/tsconfig": "^3.1.2",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^18.19.54",
-    "@types/ws": "^8.5.12",
-    "eslint": "^9.23.0",
-    "prettier": "^3.5.3",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.26.8"
-  },
-  "bugs": {
-    "url": "https://github.com/pyth-network/pyth-crosschain/issues"
+    }
   },
-  "type": "module",
+  "files": [
+    "dist/**/*"
+  ],
   "homepage": "https://github.com/pyth-network/pyth-crosschain/tree/main/lazer/sdk/js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/pyth-network/pyth-crosschain",
-    "directory": "lazer/sdk/js"
-  },
   "keywords": [
     "pyth",
     "oracle"
   ],
   "license": "Apache-2.0",
-  "dependencies": {
-    "@isaacs/ttlcache": "^1.4.1",
-    "buffer": "^6.0.3",
-    "isomorphic-ws": "^5.0.0",
-    "ts-log": "^2.2.7",
-    "ws": "^8.18.0"
-  },
+  "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.mjs",
+  "name": "@pythnetwork/pyth-lazer-sdk",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "lazer/sdk/js",
+    "type": "git",
+    "url": "https://github.com/pyth-network/pyth-crosschain"
+  },
   "scripts": {
     "build": "ts-duality --clean",
-    "fix:lint": "eslint --fix . --max-warnings 0",
-    "test:lint": "eslint . --max-warnings 0",
-    "test:types": "tsc",
-    "test:format": "prettier --check .",
-    "fix:format": "prettier --write .",
-    "example:streaming": "node --loader ts-node/esm examples/streaming.js",
-    "example:history": "node --loader ts-node/esm examples/history.js",
-    "example:symbols": "node --loader ts-node/esm examples/symbols.js",
+    "clean": "rm -rf ./dist",
     "doc": "typedoc --out docs/typedoc src",
-    "clean": "rm -rf ./dist"
-  }
-}
+    "example:history": "bun examples/history.js",
+    "example:streaming": "bun examples/streaming.js",
+    "example:symbols": "bun examples/symbols.js",
+    "test:types": "tsc --project ./tsconfig.build.json --noEmit",
+    "test:unit": "bun test"
+  },
+  "type": "module",
+  "types": "./dist/cjs/index.d.ts",
+  "version": "6.2.0"
+}

package/LICENSE

@@ -1,13 +0,0 @@
-Copyright 2025 Pyth Data Association.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.