feat(pyth-lazer-stk): correctly handle connection drops + other improvements (#2737)

* fix: pyth lazer js sdk

* increase version

* make resilient websocket configurable

* fix: config types

* handle onError

* fix

* fix example

* fix

* fix format

* fix typo

* fix format

Author: keyvankhademi

lazer/sdk/js/examples/index.ts

@@ -6,12 +6,24 @@ import { PythLazerClient } from "../src/index.js";
 // Ignore debug messages
 console.debug = () => {};
 
-const client = await PythLazerClient.create(
-  ["wss://pyth-lazer.dourolabs.app/v1/stream"],
-  "access_token",
-  3, // Optionally specify number of parallel redundant connections to reduce the chance of dropped messages. The connections will round-robin across the provided URLs. Default is 3.
-  console, // Optionally log socket operations (to the console in this case.)
-);
+const client = await PythLazerClient.create({
+  urls: [
+    "wss://pyth-lazer-0.dourolabs.app/v1/stream",
+    "wss://pyth-lazer-1.dourolabs.app/v1/stream",
+  ],
+  token: "you-access-token-here", // Replace with your actual access token
+  numConnections: 4, // Optionally specify number of parallel redundant connections to reduce the chance of dropped messages. The connections will round-robin across the provided URLs. Default is 4.
+  logger: console, // Optionally log socket operations (to the console in this case.)
+  onError: (error) => {
+    console.error("WebSocket error:", error);
+  },
+  // Optional configuration for resilient WebSocket connections
+  rwsConfig: {
+    heartbeatTimeoutDurationMs: 5000, // Optional heartbeat timeout duration in milliseconds
+    maxRetryDelayMs: 1000, // Optional maximum retry delay in milliseconds
+    logAfterRetryCount: 10, // Optional log after how many retries
+  },
+});
 
 // Read and process messages from the Lazer stream
 client.addMessageListener((message) => {
@@ -47,7 +59,7 @@ client.addAllConnectionsDownListener(() => {
 });
 
 // Create and remove one or more subscriptions on the fly
-await client.subscribe({
+client.subscribe({
   type: "subscribe",
   subscriptionId: 1,
   priceFeedIds: [1, 2],
@@ -58,7 +70,7 @@ await client.subscribe({
   parsed: false,
   jsonBinaryEncoding: "base64",
 });
-await client.subscribe({
+client.subscribe({
   type: "subscribe",
   subscriptionId: 2,
   priceFeedIds: [1, 2, 3, 4, 5],
@@ -72,6 +84,6 @@ await client.subscribe({
 
 await new Promise((resolve) => setTimeout(resolve, 10_000));
 
-await client.unsubscribe(1);
-await client.unsubscribe(2);
+client.unsubscribe(1);
+client.unsubscribe(2);
 client.shutdown();

lazer/sdk/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-lazer-sdk",
-  "version": "0.5.1",
+  "version": "1.0.0",
   "description": "Pyth Lazer SDK",
   "publishConfig": {
     "access": "public"

lazer/sdk/js/src/client.ts

@@ -1,9 +1,8 @@
 import WebSocket from "isomorphic-ws";
-import type { Logger } from "ts-log";
-import { dummyLogger } from "ts-log";
 
 import type { ParsedPayload, Request, Response } from "./protocol.js";
 import { BINARY_UPDATE_FORMAT_MAGIC_LE, FORMAT_MAGICS_LE } from "./protocol.js";
+import type { WebSocketPoolConfig } from "./socket/websocket-pool.js";
 import { WebSocketPool } from "./socket/websocket-pool.js";
 
 export type BinaryResponse = {
@@ -35,13 +34,8 @@ export class PythLazerClient {
    * @param numConnections - The number of parallel WebSocket connections to establish (default: 3). A higher number gives a more reliable stream. The connections will round-robin across the provided URLs.
    * @param logger - Optional logger to get socket level logs. Compatible with most loggers such as the built-in console and `bunyan`.
    */
-  static async create(
-    urls: string[],
-    token: string,
-    numConnections = 3,
-    logger: Logger = dummyLogger,
-  ): Promise<PythLazerClient> {
-    const wsp = await WebSocketPool.create(urls, token, numConnections, logger);
+  static async create(config: WebSocketPoolConfig): Promise<PythLazerClient> {
+    const wsp = await WebSocketPool.create(config);
     return new PythLazerClient(wsp);
   }
 
@@ -102,19 +96,19 @@ export class PythLazerClient {
     });
   }
 
-  async subscribe(request: Request): Promise<void> {
+  subscribe(request: Request) {
     if (request.type !== "subscribe") {
       throw new Error("Request must be a subscribe request");
     }
-    await this.wsp.addSubscription(request);
+    this.wsp.addSubscription(request);
   }
 
-  async unsubscribe(subscriptionId: number): Promise<void> {
-    await this.wsp.removeSubscription(subscriptionId);
+  unsubscribe(subscriptionId: number) {
+    this.wsp.removeSubscription(subscriptionId);
   }
 
-  async send(request: Request): Promise<void> {
-    await this.wsp.sendRequest(request);
+  send(request: Request) {
+    this.wsp.sendRequest(request);
   }
 
   /**