@nktkas/hyperliquid 0.19.2 → 0.20.0

package/script/src/transports/websocket/_reconnecting_websocket.js

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../../../deps/jsr.io/@std/async/1.0.13/delay.js", "../../base.js"], factory);
+        define(["require", "exports", "../../../deps/jsr.io/@std/async/1.0.13/delay.js", "../base.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -12,44 +12,27 @@
     exports.ReconnectingWebSocket = exports.ReconnectingWebSocketError = void 0;
     // deno-lint-ignore-file no-explicit-any
     const delay_js_1 = require("../../../deps/jsr.io/@std/async/1.0.13/delay.js");
-    const base_js_1 = require("../../base.js");
+    const base_js_1 = require("../base.js");
     /** Simple FIFO (First In, First Out) buffer implementation. */
     class FIFOMessageBuffer {
-        constructor() {
-            Object.defineProperty(this, "messages", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: []
-            });
-        }
+        queue = [];
         push(data) {
-            this.messages.push(data);
-        }
-        shift() {
-            return this.messages.shift();
+            this.queue.push(data);
         }
-        clear() {
-            this.messages = [];
+        *[Symbol.iterator]() {
+            while (this.queue.length > 0) {
+                yield this.queue.shift();
+            }
         }
     }
     /** Error thrown when reconnection problems occur. */
     class ReconnectingWebSocketError extends base_js_1.TransportError {
-        constructor(code, originalError) {
+        code;
+        constructor(code, cause) {
             super(`Error when reconnecting WebSocket: ${code}`);
-            Object.defineProperty(this, "code", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: code
-            });
-            Object.defineProperty(this, "originalError", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: originalError
-            });
+            this.code = code;
             this.name = "ReconnectingWebSocketError";
+            this.cause = cause;
         }
     }
     exports.ReconnectingWebSocketError = ReconnectingWebSocketError;
@@ -58,131 +41,13 @@
      * Fully compatible with standard WebSocket API.
      */
     class ReconnectingWebSocket {
+        _socket;
+        _protocols;
+        _listeners = [];
+        _attempt = 0;
+        reconnectOptions;
+        reconnectAbortController = new AbortController();
         constructor(url, protocols, options) {
-            Object.defineProperty(this, "_socket", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: void 0
-            });
-            Object.defineProperty(this, "_protocols", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: void 0
-            });
-            Object.defineProperty(this, "_listeners", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: []
-            });
-            Object.defineProperty(this, "_attempt", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 0
-            });
-            Object.defineProperty(this, "reconnectOptions", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: void 0
-            });
-            Object.defineProperty(this, "reconnectAbortController", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: new AbortController()
-            });
-            Object.defineProperty(this, "_open", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: () => {
-                    // Reset the attempt counter
-                    this._attempt = 0;
-                    // Send all buffered messages
-                    let message;
-                    while ((message = this.reconnectOptions.messageBuffer.shift()) !== undefined) {
-                        this._socket.send(message);
-                    }
-                }
-            });
-            Object.defineProperty(this, "_close", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: async (event) => {
-                    try {
-                        // If the event was triggered but the socket is not closing, ignore it
-                        if (this._socket.readyState !== ReconnectingWebSocket.CLOSING &&
-                            this._socket.readyState !== ReconnectingWebSocket.CLOSED)
-                            return;
-                        // If the instance is terminated, do not attempt to reconnect
-                        if (this.reconnectAbortController.signal.aborted)
-                            return;
-                        // Check if reconnection should be attempted
-                        if (++this._attempt > this.reconnectOptions.maxRetries) {
-                            this._cleanup("RECONNECTION_LIMIT_REACHED");
-                            return;
-                        }
-                        const userDecision = await this.reconnectOptions.shouldReconnect(event, this.reconnectAbortController.signal);
-                        if (this.reconnectAbortController.signal.aborted)
-                            return;
-                        if (!userDecision) {
-                            this._cleanup("RECONNECTION_STOPPED_BY_USER");
-                            return;
-                        }
-                        // Delay before reconnecting
-                        const reconnectDelay = typeof this.reconnectOptions.connectionDelay === "number"
-                            ? this.reconnectOptions.connectionDelay
-                            : await this.reconnectOptions.connectionDelay(this._attempt, this.reconnectAbortController.signal);
-                        if (this.reconnectAbortController.signal.aborted)
-                            return;
-                        await (0, delay_js_1.delay)(reconnectDelay, { signal: this.reconnectAbortController.signal });
-                        // Create a new WebSocket instance
-                        const { onclose, onerror, onmessage, onopen } = this._socket;
-                        this._socket = this._createSocket(this._socket.url, this._protocols);
-                        // Reconnect all listeners
-                        this._setupEventListeners();
-                        this._listeners.forEach(({ type, listenerProxy, options }) => {
-                            this._socket.addEventListener(type, listenerProxy, options);
-                        });
-                        this._socket.onclose = onclose;
-                        this._socket.onerror = onerror;
-                        this._socket.onmessage = onmessage;
-                        this._socket.onopen = onopen;
-                    }
-                    catch (error) {
-                        this._cleanup("UNKNOWN_ERROR", error);
-                    }
-                }
-            });
-            Object.defineProperty(this, "CONNECTING", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 0
-            });
-            Object.defineProperty(this, "OPEN", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 1
-            });
-            Object.defineProperty(this, "CLOSING", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 2
-            });
-            Object.defineProperty(this, "CLOSED", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 3
-            });
             this.reconnectOptions = {
                 maxRetries: options?.maxRetries ?? 3,
                 connectionTimeout: options?.connectionTimeout === undefined ? 10_000 : options.connectionTimeout,
@@ -220,10 +85,62 @@
             this._socket.addEventListener("open", this._open, { once: true });
             this._socket.addEventListener("close", this._close, { once: true });
         }
+        _open = () => {
+            // Reset the attempt counter
+            this._attempt = 0;
+            // Send all buffered messages
+            for (const message of this.reconnectOptions.messageBuffer) {
+                this._socket.send(message);
+            }
+        };
+        _close = async (event) => {
+            try {
+                // If the event was triggered but the socket is not closing, ignore it
+                if (this._socket.readyState !== ReconnectingWebSocket.CLOSING &&
+                    this._socket.readyState !== ReconnectingWebSocket.CLOSED)
+                    return;
+                // If the instance is terminated, do not attempt to reconnect
+                if (this.reconnectAbortController.signal.aborted)
+                    return;
+                // Check if reconnection should be attempted
+                if (++this._attempt > this.reconnectOptions.maxRetries) {
+                    this._cleanup("RECONNECTION_LIMIT_REACHED");
+                    return;
+                }
+                const userDecision = await this.reconnectOptions.shouldReconnect(event, this.reconnectAbortController.signal);
+                if (this.reconnectAbortController.signal.aborted)
+                    return;
+                if (!userDecision) {
+                    this._cleanup("RECONNECTION_STOPPED_BY_USER");
+                    return;
+                }
+                // Delay before reconnecting
+                const reconnectDelay = typeof this.reconnectOptions.connectionDelay === "number"
+                    ? this.reconnectOptions.connectionDelay
+                    : await this.reconnectOptions.connectionDelay(this._attempt, this.reconnectAbortController.signal);
+                if (this.reconnectAbortController.signal.aborted)
+                    return;
+                await (0, delay_js_1.delay)(reconnectDelay, { signal: this.reconnectAbortController.signal });
+                // Create a new WebSocket instance
+                const { onclose, onerror, onmessage, onopen } = this._socket;
+                this._socket = this._createSocket(this._socket.url, this._protocols);
+                // Reconnect all listeners
+                this._setupEventListeners();
+                this._listeners.forEach(({ type, listenerProxy, options }) => {
+                    this._socket.addEventListener(type, listenerProxy, options);
+                });
+                this._socket.onclose = onclose;
+                this._socket.onerror = onerror;
+                this._socket.onmessage = onmessage;
+                this._socket.onopen = onopen;
+            }
+            catch (error) {
+                this._cleanup("UNKNOWN_ERROR", error);
+            }
+        };
         /** Clean up internal resources. */
-        _cleanup(code, error) {
-            this.reconnectAbortController.abort(new ReconnectingWebSocketError(code, error));
-            this.reconnectOptions.messageBuffer.clear();
+        _cleanup(code, cause) {
+            this.reconnectAbortController.abort(new ReconnectingWebSocketError(code, cause));
             this._listeners = [];
             this._socket.close();
         }
@@ -249,6 +166,14 @@
         set binaryType(value) {
             this._socket.binaryType = value;
         }
+        CONNECTING = 0;
+        OPEN = 1;
+        CLOSING = 2;
+        CLOSED = 3;
+        static CONNECTING = 0;
+        static OPEN = 1;
+        static CLOSING = 2;
+        static CLOSED = 3;
         get onclose() {
             return this._socket.onclose;
         }
@@ -351,30 +276,6 @@
         }
     }
     exports.ReconnectingWebSocket = ReconnectingWebSocket;
-    Object.defineProperty(ReconnectingWebSocket, "CONNECTING", {
-        enumerable: true,
-        configurable: true,
-        writable: true,
-        value: 0
-    });
-    Object.defineProperty(ReconnectingWebSocket, "OPEN", {
-        enumerable: true,
-        configurable: true,
-        writable: true,
-        value: 1
-    });
-    Object.defineProperty(ReconnectingWebSocket, "CLOSING", {
-        enumerable: true,
-        configurable: true,
-        writable: true,
-        value: 2
-    });
-    Object.defineProperty(ReconnectingWebSocket, "CLOSED", {
-        enumerable: true,
-        configurable: true,
-        writable: true,
-        value: 3
-    });
     /** Check if two event listeners are the same (just like EventTarget). */
     function listenersMatch(a, b) {
         // EventTarget only compares capture in options, even if one is an object and the other is boolean

package/{esm/src/transports/websocket/_websocket_request_dispatcher.d.ts → script/src/transports/websocket/_websocket_async_request.d.ts}

@@ -1,4 +1,4 @@
-import { TransportError } from "../../base.js";
+import { TransportError } from "../base.js";
 import type { HyperliquidEventTarget } from "./_hyperliquid_event_target.js";
 /**
  * Error thrown when a WebSocket request fails:
@@ -12,31 +12,27 @@ export declare class WebSocketRequestError extends TransportError {
  * Manages WebSocket requests to the Hyperliquid API.
  * Handles request creation, sending, and mapping responses to their corresponding requests.
  */
-export declare class WebSocketRequestDispatcher {
-    private socket;
-    /** Last used post request ID */
-    private lastId;
-    /** Map of pending requests waiting for responses */
-    private pending;
+export declare class WebSocketAsyncRequest {
+    protected socket: WebSocket;
+    protected lastId: number;
+    protected queue: Map<number | string, {
+        resolve: (value?: any) => void;
+        reject: (reason?: any) => void;
+    }>;
+    lastRequestTime: number;
     /**
-     * Creates a new WebSocket request dispatcher.
+     * Creates a new WebSocket async request handler.
      * @param socket - WebSocket connection instance for sending requests to the Hyperliquid WebSocket API
      * @param hlEvents - Used to recognize Hyperliquid responses and match them with sent requests
      */
     constructor(socket: WebSocket, hlEvents: HyperliquidEventTarget);
     /**
      * Sends a request to the Hyperliquid API.
-     * @param method - The method of websocket request.
-     * @param payload - The payload to send with the request.
-     * @param signal - An optional abort signal.
      * @returns A promise that resolves with the parsed JSON response body.
      */
-    request(method: "post" | "subscribe" | "unsubscribe", payload: unknown, signal?: AbortSignal): Promise<unknown>;
-    /**
-     * Normalizes a request object to an ID.
-     * @param value - A request object.
-     * @returns A stringified request.
-     */
+    request(method: "ping", signal?: AbortSignal): Promise<void>;
+    request<T>(method: "post" | "subscribe" | "unsubscribe", payload: unknown, signal?: AbortSignal): Promise<T>;
+    /** Normalizes an object and then converts it to a string. */
     static requestToId(value: unknown): string;
 }
-//# sourceMappingURL=_websocket_request_dispatcher.d.ts.map
+//# sourceMappingURL=_websocket_async_request.d.ts.map

package/script/src/transports/websocket/_websocket_async_request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_websocket_async_request.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/_websocket_async_request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAiB7E;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,cAAc;gBACzC,OAAO,EAAE,MAAM;CAI9B;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAkBlB,SAAS,CAAC,MAAM,EAAE,SAAS;IAjBvC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAK;IAC7B,SAAS,CAAC,KAAK,EAAE,GAAG,CAChB,MAAM,GAAG,MAAM,EACf;QAEI,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;QAE/B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;KAClC,CACJ,CAAa;IACd,eAAe,EAAE,MAAM,CAAK;IAE5B;;;;OAIG;gBACmB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,sBAAsB;IA2DzE;;;OAGG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5D,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC;IA2ClH,6DAA6D;IAC7D,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;CAK7C"}

package/script/src/transports/websocket/{_websocket_request_dispatcher.js → _websocket_async_request.js}

@@ -4,13 +4,13 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../../base.js"], factory);
+        define(["require", "exports", "../base.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.WebSocketRequestDispatcher = exports.WebSocketRequestError = void 0;
-    const base_js_1 = require("../../base.js");
+    exports.WebSocketAsyncRequest = exports.WebSocketRequestError = void 0;
+    const base_js_1 = require("../base.js");
     /**
      * Error thrown when a WebSocket request fails:
      * - When the WebSocket connection is closed
@@ -27,44 +27,32 @@
      * Manages WebSocket requests to the Hyperliquid API.
      * Handles request creation, sending, and mapping responses to their corresponding requests.
      */
-    class WebSocketRequestDispatcher {
+    class WebSocketAsyncRequest {
+        socket;
+        lastId = 0;
+        queue = new Map();
+        lastRequestTime = 0;
         /**
-         * Creates a new WebSocket request dispatcher.
+         * Creates a new WebSocket async request handler.
          * @param socket - WebSocket connection instance for sending requests to the Hyperliquid WebSocket API
          * @param hlEvents - Used to recognize Hyperliquid responses and match them with sent requests
          */
         constructor(socket, hlEvents) {
-            Object.defineProperty(this, "socket", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: socket
-            });
-            /** Last used post request ID */
-            Object.defineProperty(this, "lastId", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: 0
-            });
-            /** Map of pending requests waiting for responses */
-            Object.defineProperty(this, "pending", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: new Map()
-            });
+            this.socket = socket;
             // Monitor responses and match the pending request
             hlEvents.addEventListener("subscriptionResponse", (event) => {
                 // Use a stringified request as an id
-                const id = WebSocketRequestDispatcher.requestToId(event.detail.subscription);
-                this.pending.get(id)?.resolve(event.detail);
+                const id = WebSocketAsyncRequest.requestToId(event.detail.subscription);
+                this.queue.get(id)?.resolve(event.detail);
             });
             hlEvents.addEventListener("post", (event) => {
                 const data = event.detail.response.type === "info"
                     ? event.detail.response.payload.data
                     : event.detail.response.payload;
-                this.pending.get(event.detail.id)?.resolve(data);
+                this.queue.get(event.detail.id)?.resolve(data);
+            });
+            hlEvents.addEventListener("pong", () => {
+                this.queue.get("ping")?.resolve();
             });
             hlEvents.addEventListener("error", (event) => {
                 try {
@@ -74,19 +62,19 @@
                         const parsedRequest = JSON.parse(request);
                         if ("id" in parsedRequest && typeof parsedRequest.id === "number") {
                             // If a post request was sent, it is possible to get the id from the request
-                            this.pending.get(parsedRequest.id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                            this.queue.get(parsedRequest.id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
                         }
                         else if ("subscription" in parsedRequest &&
                             typeof parsedRequest.subscription === "object" &&
                             parsedRequest.subscription !== null) {
                             // If a subscription/unsubscribe request was sent, use the request as an id
-                            const id = WebSocketRequestDispatcher.requestToId(parsedRequest.subscription);
-                            this.pending.get(id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                            const id = WebSocketAsyncRequest.requestToId(parsedRequest.subscription);
+                            this.queue.get(id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
                         }
                         else {
                             // If the request is not recognized, use the parsed request as an id
-                            const id = WebSocketRequestDispatcher.requestToId(parsedRequest);
-                            this.pending.get(id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                            const id = WebSocketAsyncRequest.requestToId(parsedRequest);
+                            this.queue.get(id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
                         }
                     }
                 }
@@ -96,68 +84,55 @@
             });
             // Throws all pending requests if the connection is dropped
             socket.addEventListener("close", () => {
-                this.pending.forEach(({ reject }) => {
+                this.queue.forEach(({ reject }) => {
                     reject(new WebSocketRequestError("Cannot complete WebSocket request: connection is closed"));
                 });
-                this.pending.clear();
+                this.queue.clear();
             });
         }
-        /**
-         * Sends a request to the Hyperliquid API.
-         * @param method - The method of websocket request.
-         * @param payload - The payload to send with the request.
-         * @param signal - An optional abort signal.
-         * @returns A promise that resolves with the parsed JSON response body.
-         */
-        async request(method, payload, signal) {
+        async request(method, payload_or_signal, maybeSignal) {
+            const payload = payload_or_signal instanceof AbortSignal ? undefined : payload_or_signal;
+            const signal = payload_or_signal instanceof AbortSignal ? payload_or_signal : maybeSignal;
             // Reject the request if the signal is aborted
             if (signal?.aborted)
                 return Promise.reject(signal.reason);
-            // Create a request object
+            // Create a request
             let id;
             let request;
             if (method === "post") {
                 id = ++this.lastId;
                 request = { method, id, request: payload };
             }
+            else if (method === "ping") {
+                id = "ping";
+                request = { method };
+            }
             else {
-                id = WebSocketRequestDispatcher.requestToId(payload);
+                id = WebSocketAsyncRequest.requestToId(payload);
                 request = { method, subscription: payload };
             }
             // Send the request
             this.socket.send(JSON.stringify(request));
+            this.lastRequestTime = Date.now();
             // Wait for a response
-            let onAbort;
-            return await new Promise((resolve, reject) => {
-                // Add an abort listener
-                onAbort = () => reject(signal?.reason);
-                signal?.addEventListener("abort", onAbort, { once: true });
-                // Add the promise to the pending list
-                this.pending.set(id, { resolve, reject });
-            }).finally(() => {
-                // Remove the abort listener when the promise is settled
+            const { promise, resolve, reject } = Promise.withResolvers();
+            this.queue.set(id, { resolve, reject });
+            const onAbort = () => reject(signal?.reason);
+            signal?.addEventListener("abort", onAbort, { once: true });
+            return await promise.finally(() => {
+                this.queue.delete(id);
                 signal?.removeEventListener("abort", onAbort);
-                // Clean up the pending list
-                this.pending.delete(id);
             });
         }
-        /**
-         * Normalizes a request object to an ID.
-         * @param value - A request object.
-         * @returns A stringified request.
-         */
+        /** Normalizes an object and then converts it to a string. */
         static requestToId(value) {
             const lowerHex = containsUppercaseHex(value) ? deepLowerHex(value) : value;
             const sorted = deepSortKeys(lowerHex);
             return JSON.stringify(sorted); // Also removes undefined
         }
     }
-    exports.WebSocketRequestDispatcher = WebSocketRequestDispatcher;
-    /**
-     * Deeply converts hexadecimal strings in an object/array to lowercase.
-     * @param obj - The object/array to convert hexadecimal strings to lowercase.
-     * @returns A new object/array with hexadecimal strings converted to lowercase.
-     */
+    exports.WebSocketAsyncRequest = WebSocketAsyncRequest;
+    /** Deeply converts hexadecimal strings in an object/array to lowercase. */
     function deepLowerHex(obj) {
         if (typeof obj === "string") {
             return /^(0X[0-9a-fA-F]*|0x[0-9a-fA-F]*[A-F][0-9a-fA-F]*)$/.test(obj) ? obj.toLowerCase() : obj;
@@ -175,20 +150,12 @@
         }
         return obj;
     }
-    /**
-     * Check if an object contains uppercase hexadecimal strings.
-     * @param obj - The object to check.
-     * @returns True if the object contains uppercase hexadecimal strings, false otherwise.
-     */
+    /** Check if an object contains uppercase hexadecimal strings. */
     function containsUppercaseHex(obj) {
         const str = JSON.stringify(obj);
         return /0X[0-9a-fA-F]*|0x[0-9a-fA-F]*[A-F][0-9a-fA-F]*/.test(str);
     }
-    /**
-     * Deeply sort the keys of an object.
-     * @param obj - An object to sort the keys of.
-     * @returns A new object with sorted keys.
-     */
+    /** Deeply sort the keys of an object. */
     function deepSortKeys(obj) {
         if (typeof obj !== "object" || obj === null) {
             return obj;