@pythnetwork/pyth-lazer-sdk 5.0.0 → 5.2.1

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

@@ -1,201 +0,0 @@
-"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_websocket_js_1 = require("./resilient-websocket.js");
-const constants_js_1 = require("../constants.js");
-const index_js_1 = require("../util/index.js");
-const DEFAULT_NUM_CONNECTIONS = 4;
-class WebSocketPool {
-    logger;
-    rwsPool;
-    cache;
-    subscriptions; // id -> subscription Request
-    messageListeners;
-    allConnectionsDownListeners;
-    wasAllDown = true;
-    checkConnectionStatesInterval;
-    constructor(logger) {
-        this.logger = logger;
-        this.rwsPool = [];
-        this.cache = new ttlcache_1.default({ ttl: 1000 * 10 }); // TTL of 10 seconds
-        this.subscriptions = new Map();
-        this.messageListeners = [];
-        this.allConnectionsDownListeners = [];
-        // Start monitoring connection states
-        this.checkConnectionStatesInterval = setInterval(() => {
-            this.checkConnectionStates();
-        }, 100);
-    }
-    /**
-     * 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`.
-     */
-    static async create(config, token, logger) {
-        const urls = config.urls ?? [
-            constants_js_1.DEFAULT_STREAM_SERVICE_0_URL,
-            constants_js_1.DEFAULT_STREAM_SERVICE_1_URL,
-        ];
-        const log = logger ?? ts_log_1.dummyLogger;
-        const pool = new WebSocketPool(log);
-        const numConnections = config.numConnections ?? DEFAULT_NUM_CONNECTIONS;
-        for (let i = 0; i < numConnections; i++) {
-            const baseUrl = urls[i % urls.length];
-            const isBrowser = (0, index_js_1.envIsBrowserOrWorker)();
-            const url = isBrowser
-                ? (0, index_js_1.addAuthTokenToWebSocketUrl)(baseUrl, token)
-                : baseUrl;
-            if (!url) {
-                throw new Error(`URLs must not be null or empty`);
-            }
-            const wsOptions = {
-                ...config.rwsConfig?.wsOptions,
-                headers: isBrowser ? undefined : { Authorization: `Bearer ${token}` },
-            };
-            const rws = new resilient_websocket_js_1.ResilientWebSocket({
-                ...config.rwsConfig,
-                endpoint: url,
-                wsOptions,
-                logger: log,
-            });
-            // If a websocket client unexpectedly disconnects, ResilientWebSocket will reestablish
-            // the connection and call the onReconnect callback.
-            rws.onReconnect = () => {
-                if (rws.wsUserClosed) {
-                    return;
-                }
-                for (const [, request] of pool.subscriptions) {
-                    try {
-                        rws.send(JSON.stringify(request));
-                    }
-                    catch (error) {
-                        pool.logger.error("Failed to resend subscription on reconnect:", error);
-                    }
-                }
-            };
-            if (config.onError) {
-                rws.onError = config.onError;
-            }
-            // Handle all client messages ourselves. Dedupe before sending to registered message handlers.
-            rws.onMessage = (data) => {
-                pool.dedupeHandler(data).catch((error) => {
-                    const errMsg = `An error occurred in the WebSocket pool's dedupeHandler: ${error instanceof Error ? error.message : String(error)}`;
-                    throw new Error(errMsg);
-                });
-            };
-            pool.rwsPool.push(rws);
-            rws.startWebSocket();
-        }
-        pool.logger.info(`Started WebSocketPool with ${numConnections.toString()} connections. Waiting for at least one to connect...`);
-        while (!pool.isAnyConnectionEstablished()) {
-            await new Promise((resolve) => setTimeout(resolve, 100));
-        }
-        pool.logger.info(`At least one WebSocket connection is established. WebSocketPool is ready.`);
-        return pool;
-    }
-    /**
-     * 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}`);
-        }
-    }
-    async constructCacheKeyFromWebsocketData(data) {
-        if (typeof data === "string")
-            return data;
-        const buff = await (0, index_js_1.bufferFromWebsocketData)(data);
-        return buff.toString("hex");
-    }
-    /**
-     * Handles incoming websocket messages by deduplicating identical messages received across
-     * multiple connections before forwarding to registered handlers
-     */
-    dedupeHandler = async (data) => {
-        const cacheKey = await this.constructCacheKeyFromWebsocketData(data);
-        if (this.cache.has(cacheKey)) {
-            this.logger.debug("Dropping duplicate message");
-            return;
-        }
-        this.cache.set(cacheKey, true);
-        if (typeof data === "string") {
-            this.handleErrorMessages(data);
-        }
-        await Promise.all(this.messageListeners.map((handler) => handler(data)));
-    };
-    sendRequest(request) {
-        for (const rws of this.rwsPool) {
-            rws.send(JSON.stringify(request));
-        }
-    }
-    addSubscription(request) {
-        if (request.type !== "subscribe") {
-            throw new Error("Request must be a subscribe request");
-        }
-        this.subscriptions.set(request.subscriptionId, request);
-        this.sendRequest(request);
-    }
-    removeSubscription(subscriptionId) {
-        this.subscriptions.delete(subscriptionId);
-        const request = {
-            type: "unsubscribe",
-            subscriptionId,
-        };
-        this.sendRequest(request);
-    }
-    addMessageListener(handler) {
-        this.messageListeners.push(handler);
-    }
-    /**
-     * Calls the handler if all websocket connections are currently down or in reconnecting state.
-     * The connections may still try to reconnect in the background.
-     */
-    addAllConnectionsDownListener(handler) {
-        this.allConnectionsDownListeners.push(handler);
-    }
-    areAllConnectionsDown() {
-        return this.rwsPool.every((ws) => !ws.isConnected() || ws.isReconnecting());
-    }
-    isAnyConnectionEstablished() {
-        return this.rwsPool.some((ws) => ws.isConnected());
-    }
-    checkConnectionStates() {
-        const allDown = this.areAllConnectionsDown();
-        // If all connections just went down
-        if (allDown && !this.wasAllDown) {
-            this.wasAllDown = true;
-            this.logger.error("All WebSocket connections are down or reconnecting");
-            // Notify all listeners
-            for (const listener of this.allConnectionsDownListeners) {
-                listener();
-            }
-        }
-        // If at least one connection was restored
-        if (!allDown && this.wasAllDown) {
-            this.wasAllDown = false;
-        }
-    }
-    shutdown() {
-        for (const rws of this.rwsPool) {
-            rws.closeWebSocket();
-        }
-        this.rwsPool = [];
-        this.subscriptions.clear();
-        this.messageListeners = [];
-        this.allConnectionsDownListeners = [];
-        clearInterval(this.checkConnectionStatesInterval);
-    }
-}
-exports.WebSocketPool = WebSocketPool;

package/dist/cjs/util/env-util.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.envIsServiceOrWebWorker = envIsServiceOrWebWorker;
-exports.envIsBrowser = envIsBrowser;
-exports.envIsBrowserOrWorker = envIsBrowserOrWorker;
-// we create this local-only type, which has assertions made to indicate
-// that we do not know and cannot guarantee which JS environment we are in
-const g = globalThis;
-/**
- * Detects if this code is running within any Service or WebWorker context.
- * @returns true if in a worker of some kind, false if otherwise
- */
-function envIsServiceOrWebWorker() {
-    return (typeof WorkerGlobalScope !== "undefined" &&
-        g.self instanceof WorkerGlobalScope);
-}
-/**
- * Detects if the code is running in a regular DOM or Web Worker context.
- * @returns true if running in a DOM or Web Worker context, false if running in Node.js
- */
-function envIsBrowser() {
-    return g.window !== undefined;
-}
-/**
- * a convenience method that returns whether or not
- * this code is executing in some type of browser-centric environment
- *
- * @returns true if in the browser's main UI thread or in a worker, false if otherwise
- */
-function envIsBrowserOrWorker() {
-    return envIsServiceOrWebWorker() || envIsBrowser();
-}

package/dist/cjs/util/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./buffer-util.js"), exports);
-__exportStar(require("./env-util.js"), exports);
-__exportStar(require("./url-util.js"), exports);

package/dist/cjs/util/url-util.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addAuthTokenToWebSocketUrl = addAuthTokenToWebSocketUrl;
-const ACCESS_TOKEN_QUERY_PARAM_KEY = "ACCESS_TOKEN";
-/**
- * Given a URL to a hosted lazer stream service and a possible auth token,
- * appends the auth token as a query parameter and returns the URL with the token
- * contained within.
- * If the URL provided is nullish, it is returned as-is (in the same nullish format).
- * If the token is nullish, the baseUrl given is returned, instead.
- */
-function addAuthTokenToWebSocketUrl(baseUrl, authToken) {
-    if (!baseUrl || !authToken)
-        return baseUrl;
-    const parsedUrl = new URL(baseUrl);
-    parsedUrl.searchParams.set(ACCESS_TOKEN_QUERY_PARAM_KEY, authToken);
-    return parsedUrl.toString();
-}

package/dist/esm/index.js

@@ -1,3 +0,0 @@
-export * from "./client.js";
-export * from "./protocol.js";
-export * from "./constants.js";

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

@@ -1,195 +0,0 @@
-import TTLCache from "@isaacs/ttlcache";
-import WebSocket from "isomorphic-ws";
-import { dummyLogger } from "ts-log";
-import { ResilientWebSocket } from "./resilient-websocket.js";
-import { DEFAULT_STREAM_SERVICE_0_URL, DEFAULT_STREAM_SERVICE_1_URL, } from "../constants.js";
-import { addAuthTokenToWebSocketUrl, bufferFromWebsocketData, envIsBrowserOrWorker, } from "../util/index.js";
-const DEFAULT_NUM_CONNECTIONS = 4;
-export class WebSocketPool {
-    logger;
-    rwsPool;
-    cache;
-    subscriptions; // id -> subscription Request
-    messageListeners;
-    allConnectionsDownListeners;
-    wasAllDown = true;
-    checkConnectionStatesInterval;
-    constructor(logger) {
-        this.logger = logger;
-        this.rwsPool = [];
-        this.cache = new TTLCache({ ttl: 1000 * 10 }); // TTL of 10 seconds
-        this.subscriptions = new Map();
-        this.messageListeners = [];
-        this.allConnectionsDownListeners = [];
-        // Start monitoring connection states
-        this.checkConnectionStatesInterval = setInterval(() => {
-            this.checkConnectionStates();
-        }, 100);
-    }
-    /**
-     * 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`.
-     */
-    static async create(config, token, 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 numConnections = config.numConnections ?? DEFAULT_NUM_CONNECTIONS;
-        for (let i = 0; i < numConnections; i++) {
-            const baseUrl = urls[i % urls.length];
-            const isBrowser = envIsBrowserOrWorker();
-            const url = isBrowser
-                ? addAuthTokenToWebSocketUrl(baseUrl, token)
-                : baseUrl;
-            if (!url) {
-                throw new Error(`URLs must not be null or empty`);
-            }
-            const wsOptions = {
-                ...config.rwsConfig?.wsOptions,
-                headers: isBrowser ? undefined : { Authorization: `Bearer ${token}` },
-            };
-            const rws = new ResilientWebSocket({
-                ...config.rwsConfig,
-                endpoint: url,
-                wsOptions,
-                logger: log,
-            });
-            // If a websocket client unexpectedly disconnects, ResilientWebSocket will reestablish
-            // the connection and call the onReconnect callback.
-            rws.onReconnect = () => {
-                if (rws.wsUserClosed) {
-                    return;
-                }
-                for (const [, request] of pool.subscriptions) {
-                    try {
-                        rws.send(JSON.stringify(request));
-                    }
-                    catch (error) {
-                        pool.logger.error("Failed to resend subscription on reconnect:", error);
-                    }
-                }
-            };
-            if (config.onError) {
-                rws.onError = config.onError;
-            }
-            // Handle all client messages ourselves. Dedupe before sending to registered message handlers.
-            rws.onMessage = (data) => {
-                pool.dedupeHandler(data).catch((error) => {
-                    const errMsg = `An error occurred in the WebSocket pool's dedupeHandler: ${error instanceof Error ? error.message : String(error)}`;
-                    throw new Error(errMsg);
-                });
-            };
-            pool.rwsPool.push(rws);
-            rws.startWebSocket();
-        }
-        pool.logger.info(`Started WebSocketPool with ${numConnections.toString()} connections. Waiting for at least one to connect...`);
-        while (!pool.isAnyConnectionEstablished()) {
-            await new Promise((resolve) => setTimeout(resolve, 100));
-        }
-        pool.logger.info(`At least one WebSocket connection is established. WebSocketPool is ready.`);
-        return pool;
-    }
-    /**
-     * 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}`);
-        }
-    }
-    async constructCacheKeyFromWebsocketData(data) {
-        if (typeof data === "string")
-            return data;
-        const buff = await bufferFromWebsocketData(data);
-        return buff.toString("hex");
-    }
-    /**
-     * Handles incoming websocket messages by deduplicating identical messages received across
-     * multiple connections before forwarding to registered handlers
-     */
-    dedupeHandler = async (data) => {
-        const cacheKey = await this.constructCacheKeyFromWebsocketData(data);
-        if (this.cache.has(cacheKey)) {
-            this.logger.debug("Dropping duplicate message");
-            return;
-        }
-        this.cache.set(cacheKey, true);
-        if (typeof data === "string") {
-            this.handleErrorMessages(data);
-        }
-        await Promise.all(this.messageListeners.map((handler) => handler(data)));
-    };
-    sendRequest(request) {
-        for (const rws of this.rwsPool) {
-            rws.send(JSON.stringify(request));
-        }
-    }
-    addSubscription(request) {
-        if (request.type !== "subscribe") {
-            throw new Error("Request must be a subscribe request");
-        }
-        this.subscriptions.set(request.subscriptionId, request);
-        this.sendRequest(request);
-    }
-    removeSubscription(subscriptionId) {
-        this.subscriptions.delete(subscriptionId);
-        const request = {
-            type: "unsubscribe",
-            subscriptionId,
-        };
-        this.sendRequest(request);
-    }
-    addMessageListener(handler) {
-        this.messageListeners.push(handler);
-    }
-    /**
-     * Calls the handler if all websocket connections are currently down or in reconnecting state.
-     * The connections may still try to reconnect in the background.
-     */
-    addAllConnectionsDownListener(handler) {
-        this.allConnectionsDownListeners.push(handler);
-    }
-    areAllConnectionsDown() {
-        return this.rwsPool.every((ws) => !ws.isConnected() || ws.isReconnecting());
-    }
-    isAnyConnectionEstablished() {
-        return this.rwsPool.some((ws) => ws.isConnected());
-    }
-    checkConnectionStates() {
-        const allDown = this.areAllConnectionsDown();
-        // If all connections just went down
-        if (allDown && !this.wasAllDown) {
-            this.wasAllDown = true;
-            this.logger.error("All WebSocket connections are down or reconnecting");
-            // Notify all listeners
-            for (const listener of this.allConnectionsDownListeners) {
-                listener();
-            }
-        }
-        // If at least one connection was restored
-        if (!allDown && this.wasAllDown) {
-            this.wasAllDown = false;
-        }
-    }
-    shutdown() {
-        for (const rws of this.rwsPool) {
-            rws.closeWebSocket();
-        }
-        this.rwsPool = [];
-        this.subscriptions.clear();
-        this.messageListeners = [];
-        this.allConnectionsDownListeners = [];
-        clearInterval(this.checkConnectionStatesInterval);
-    }
-}

package/dist/esm/util/index.js

@@ -1,3 +0,0 @@
-export * from "./buffer-util.js";
-export * from "./env-util.js";
-export * from "./url-util.js";