@nktkas/hyperliquid 0.19.2 → 0.21.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,30 @@
     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, signal) {
+            this.queue.push({ data, signal });
         }
-        push(data) {
-            this.messages.push(data);
-        }
-        shift() {
-            return this.messages.shift();
-        }
-        clear() {
-            this.messages = [];
+        *[Symbol.iterator]() {
+            while (this.queue.length > 0) {
+                const { data, signal } = this.queue.shift();
+                if (signal?.aborted)
+                    continue;
+                yield data;
+            }
         }
     }
     /** 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 +44,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 +88,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 +169,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;
         }
@@ -282,11 +210,14 @@
                 this._cleanup("USER_INITIATED_CLOSE");
         }
         /**
+         * @param signal - `AbortSignal` to cancel sending a message if it was in the buffer.
          * @note If the connection is not open, the data will be buffered and sent when the connection is established.
          */
-        send(data) {
+        send(data, signal) {
+            if (signal?.aborted)
+                return;
             if (this._socket.readyState !== ReconnectingWebSocket.OPEN && !this.reconnectAbortController.signal.aborted) {
-                this.reconnectOptions.messageBuffer.push(data);
+                this.reconnectOptions.messageBuffer.push(data, signal);
             }
             else {
                 this._socket.send(data);
@@ -351,30 +282,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,5 @@
-import { TransportError } from "../../base.js";
+import { TransportError } from "../base.js";
+import type { ReconnectingWebSocket } from "./_reconnecting_websocket.js";
 import type { HyperliquidEventTarget } from "./_hyperliquid_event_target.js";
 /**
  * Error thrown when a WebSocket request fails:
@@ -12,31 +13,28 @@ 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: ReconnectingWebSocket;
+    protected lastId: number;
+    protected queue: {
+        id: 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);
+    constructor(socket: ReconnectingWebSocket, 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,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,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;IAgBlB,SAAS,CAAC,MAAM,EAAE,qBAAqB;IAfnD,SAAS,CAAC,MAAM,EAAE,MAAM,CAAK;IAC7B,SAAS,CAAC,KAAK,EAAE;QACb,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;QAEpB,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;QAE/B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;KAClC,EAAE,CAAM;IACT,eAAe,EAAE,MAAM,CAAK;IAE5B;;;;OAIG;gBACmB,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE,sBAAsB;IAsFrF;;;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;IA6ClH,6DAA6D;IAC7D,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;CAK7C"}

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

@@ -0,0 +1,192 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "../base.js"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    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
+     * - When the server responds with an error message
+     */
+    class WebSocketRequestError extends base_js_1.TransportError {
+        constructor(message) {
+            super(message);
+            this.name = "WebSocketRequestError";
+        }
+    }
+    exports.WebSocketRequestError = WebSocketRequestError;
+    /**
+     * Manages WebSocket requests to the Hyperliquid API.
+     * Handles request creation, sending, and mapping responses to their corresponding requests.
+     */
+    class WebSocketAsyncRequest {
+        socket;
+        lastId = 0;
+        queue = [];
+        lastRequestTime = 0;
+        /**
+         * 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) {
+            this.socket = socket;
+            // Monitor responses and match the pending request
+            hlEvents.addEventListener("subscriptionResponse", (event) => {
+                // Use a stringified request as an id
+                const id = WebSocketAsyncRequest.requestToId(event.detail);
+                this.queue.findLast((item) => item.id === 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.queue.findLast((item) => item.id === event.detail.id)?.resolve(data);
+            });
+            hlEvents.addEventListener("pong", () => {
+                this.queue.findLast((item) => item.id === "ping")?.resolve();
+            });
+            hlEvents.addEventListener("error", (event) => {
+                try {
+                    // Error event doesn't have an id, use original request to match
+                    const request = event.detail.match(/{.*}/)?.[0];
+                    if (!request)
+                        return;
+                    const parsedRequest = JSON.parse(request);
+                    // For `post` requests
+                    if ("id" in parsedRequest && typeof parsedRequest.id === "number") {
+                        this.queue.findLast((item) => item.id === parsedRequest.id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                        return;
+                    }
+                    // For `subscribe` and `unsubscribe` requests
+                    if ("subscription" in parsedRequest &&
+                        typeof parsedRequest.subscription === "object" && parsedRequest.subscription !== null) {
+                        const id = WebSocketAsyncRequest.requestToId(parsedRequest);
+                        this.queue.findLast((item) => item.id === id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                        return;
+                    }
+                    // For already/invalid subscribed requests
+                    if (event.detail.startsWith("Already subscribed") || event.detail.startsWith("Invalid subscription")) {
+                        const id = WebSocketAsyncRequest.requestToId({
+                            method: "subscribe",
+                            subscription: parsedRequest,
+                        });
+                        this.queue.findLast((item) => item.id === id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                        return;
+                    }
+                    // For already unsubscribed requests
+                    if (event.detail.startsWith("Already unsubscribed")) {
+                        const id = WebSocketAsyncRequest.requestToId({
+                            method: "unsubscribe",
+                            subscription: parsedRequest,
+                        });
+                        this.queue.findLast((item) => item.id === id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                        return;
+                    }
+                    // For unknown requests
+                    const id = WebSocketAsyncRequest.requestToId(parsedRequest);
+                    this.queue.findLast((item) => item.id === id)?.reject(new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
+                }
+                catch {
+                    // Ignore JSON parsing errors
+                }
+            });
+            // Throws all pending requests if the connection is dropped
+            socket.addEventListener("close", () => {
+                this.queue.forEach(({ reject }) => {
+                    reject(new WebSocketRequestError("Cannot complete WebSocket request: connection is closed"));
+                });
+                this.queue = [];
+            });
+        }
+        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
+            let id;
+            let request;
+            if (method === "post") {
+                id = ++this.lastId;
+                request = { method, id, request: payload };
+            }
+            else if (method === "ping") {
+                id = "ping";
+                request = { method };
+            }
+            else {
+                request = { method, subscription: payload };
+                id = WebSocketAsyncRequest.requestToId(request);
+            }
+            // Send the request
+            this.socket.send(JSON.stringify(request), signal);
+            this.lastRequestTime = Date.now();
+            // Wait for a response
+            const { promise, resolve, reject } = Promise.withResolvers();
+            this.queue.push({ id, resolve, reject });
+            const onAbort = () => reject(signal?.reason);
+            signal?.addEventListener("abort", onAbort, { once: true });
+            return await promise.finally(() => {
+                const index = this.queue.findLastIndex((item) => item.id === id);
+                if (index !== -1)
+                    this.queue.splice(index, 1);
+                signal?.removeEventListener("abort", onAbort);
+            });
+        }
+        /** 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.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;
+        }
+        if (Array.isArray(obj)) {
+            return obj.map(deepLowerHex);
+        }
+        if (typeof obj === "object" && obj !== null) {
+            const result = {};
+            const entries = Object.entries(obj);
+            for (const [key, value] of entries) {
+                result[key] = deepLowerHex(value);
+            }
+            return result;
+        }
+        return obj;
+    }
+    /** 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. */
+    function deepSortKeys(obj) {
+        if (typeof obj !== "object" || obj === null) {
+            return obj;
+        }
+        if (Array.isArray(obj)) {
+            return obj.map(deepSortKeys);
+        }
+        const result = {};
+        const keys = Object.keys(obj).sort();
+        for (const key of keys) {
+            result[key] = deepSortKeys(obj[key]);
+        }
+        return result;
+    }
+});