@nktkas/hyperliquid 0.13.1 → 0.13.2

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

@@ -1,206 +1,216 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebSocketRequestDispatcher = 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 {
+(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.WebSocketRequestDispatcher = exports.WebSocketRequestError = void 0;
+    const base_js_1 = require("../base.js");
     /**
-     * Creates a new WebSocket request error.
-     * @param message - The error message.
+     * Error thrown when a WebSocket request fails:
+     * - When the WebSocket connection is closed
+     * - When the server responds with an error message
      */
-    constructor(message) {
-        super(message);
-        this.name = "WebSocketRequestError";
+    class WebSocketRequestError extends base_js_1.TransportError {
+        /**
+         * Creates a new WebSocket request error.
+         * @param message - The error message.
+         */
+        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 WebSocketRequestDispatcher {
+    exports.WebSocketRequestError = WebSocketRequestError;
     /**
-     * Creates a new WebSocket request dispatcher.
-     * @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
+     * Manages WebSocket requests to the Hyperliquid API.
+     * Handles request creation, sending, and mapping responses to their corresponding requests.
      */
-    constructor(socket, hlEvents) {
-        Object.defineProperty(this, "socket", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: socket
-        });
-        /** Last used 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()
-        });
-        // 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.resolve(id, event.detail);
-        });
-        hlEvents.addEventListener("post", (event) => {
-            const data = event.detail.response.type === "info"
-                ? event.detail.response.payload.data
-                : event.detail.response.payload;
-            this.resolve(event.detail.id, data);
-        });
-        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) {
-                    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.reject(parsedRequest.id, new WebSocketRequestError(`Cannot process 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.reject(id, new WebSocketRequestError(`Cannot process subscription request: ${event.detail}`));
-                    }
-                    else {
-                        // If the request is not recognized, use the parsed request as an id
-                        const id = WebSocketRequestDispatcher.requestToId(parsedRequest);
-                        this.reject(id, new WebSocketRequestError(`Cannot process unrecognized request: ${event.detail}`));
+    class WebSocketRequestDispatcher {
+        /**
+         * Creates a new WebSocket request dispatcher.
+         * @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 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()
+            });
+            // 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.resolve(id, event.detail);
+            });
+            hlEvents.addEventListener("post", (event) => {
+                const data = event.detail.response.type === "info"
+                    ? event.detail.response.payload.data
+                    : event.detail.response.payload;
+                this.resolve(event.detail.id, data);
+            });
+            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) {
+                        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.reject(parsedRequest.id, 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.reject(id, 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.reject(id, 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.pending.forEach(({ reject }) => {
+                    reject(new WebSocketRequestError("Cannot complete WebSocket request: connection is closed"));
+                });
+                this.pending.clear();
+            });
+        }
+        /** Gets the next request ID */
+        get nextId() {
+            return ++this.lastId;
+        }
+        /**
+         * 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, payload, signal) {
+            signal?.throwIfAborted();
+            // Create a request object
+            let id;
+            let request;
+            if (method === "post") {
+                id = this.nextId;
+                request = { method, id, request: payload };
             }
-            catch {
-                // Ignore JSON parsing errors
+            else {
+                id = WebSocketRequestDispatcher.requestToId(payload);
+                request = { method, subscription: payload };
             }
-        });
-        // Throws all pending requests if the connection is dropped
-        socket.addEventListener("close", () => {
-            this.pending.forEach(({ reject }) => {
-                reject(new WebSocketRequestError("Cannot complete WebSocket request: connection is closed"));
+            // Send the request
+            this.socket.send(JSON.stringify(request));
+            // Wait for a response
+            let onAbort;
+            return 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
+                signal?.removeEventListener("abort", onAbort);
             });
-            this.pending.clear();
-        });
-    }
-    /** Gets the next request ID */
-    get nextId() {
-        return ++this.lastId;
+        }
+        /**
+         * Resolves a pending request.
+         * @param id - A request ID or a stringified request.
+         * @param value - A resolution value.
+         */
+        resolve(id, value) {
+            this.pending.get(id)?.resolve(value);
+            this.pending.delete(id);
+        }
+        /**
+         * Rejects a pending request.
+         * @param id - A request ID or a stringified request.
+         * @param reason - A rejection reason.
+         */
+        reject(id, reason) {
+            this.pending.get(id)?.reject(reason);
+            this.pending.delete(id);
+        }
+        /**
+         * Normalizes a request object to an ID.
+         * @param value - A request object.
+         * @returns A stringified request.
+         */
+        static requestToId(value) {
+            const lowerHex = deepLowerHex(value);
+            const sorted = deepSortKeys(lowerHex);
+            return JSON.stringify(sorted);
+        }
     }
+    exports.WebSocketRequestDispatcher = WebSocketRequestDispatcher;
     /**
-     * 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.
+     * Convert all hexadecimal strings to lowercase in an object/array.
+     * @param obj - The object/array to convert hexadecimal strings to lowercase.
+     * @returns A new object/array with hexadecimal strings converted to lowercase.
      */
-    request(method, payload, signal) {
-        signal?.throwIfAborted();
-        // Create a request object
-        let id;
-        let request;
-        if (method === "post") {
-            id = this.nextId;
-            request = { method, id, request: payload };
+    function deepLowerHex(obj) {
+        if (Array.isArray(obj)) {
+            return obj.map(deepLowerHex);
+        }
+        else if (obj && typeof obj === "object") {
+            return Object.entries(obj).reduce((acc, [key, val]) => ({
+                ...acc,
+                [key]: deepLowerHex(val),
+            }), {});
+        }
+        else if (typeof obj === "string" && /^0x[0-9A-Fa-f]+$/.test(obj)) {
+            return obj.toLowerCase();
         }
         else {
-            id = WebSocketRequestDispatcher.requestToId(payload);
-            request = { method, subscription: payload };
+            return obj;
         }
-        // Send the request
-        this.socket.send(JSON.stringify(request));
-        // Wait for a response
-        let onAbort;
-        return 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
-            signal?.removeEventListener("abort", onAbort);
-        });
-    }
-    /**
-     * Resolves a pending request.
-     * @param id - A request ID or a stringified request.
-     * @param value - A resolution value.
-     */
-    resolve(id, value) {
-        this.pending.get(id)?.resolve(value);
-        this.pending.delete(id);
-    }
-    /**
-     * Rejects a pending request.
-     * @param id - A request ID or a stringified request.
-     * @param reason - A rejection reason.
-     */
-    reject(id, reason) {
-        this.pending.get(id)?.reject(reason);
-        this.pending.delete(id);
     }
     /**
-     * Normalizes a request object to an ID.
-     * @param value - A request object.
-     * @returns A stringified request.
+     * Deeply sort the keys of an object.
+     * @param obj - An object to sort the keys of.
+     * @returns A new object with sorted keys.
      */
-    static requestToId(value) {
-        const lowerHex = deepLowerHex(value);
-        const sorted = deepSortKeys(lowerHex);
-        return JSON.stringify(sorted);
-    }
-}
-exports.WebSocketRequestDispatcher = WebSocketRequestDispatcher;
-/**
- * Convert all hexadecimal strings to lowercase in an object/array.
- * @param obj - The object/array to convert hexadecimal strings to lowercase.
- * @returns A new object/array with hexadecimal strings converted to lowercase.
- */
-function deepLowerHex(obj) {
-    if (Array.isArray(obj)) {
-        return obj.map(deepLowerHex);
-    }
-    else if (obj && typeof obj === "object") {
-        return Object.entries(obj).reduce((acc, [key, val]) => ({
-            ...acc,
-            [key]: deepLowerHex(val),
-        }), {});
-    }
-    else if (typeof obj === "string" && /^0x[0-9A-Fa-f]+$/.test(obj)) {
-        return obj.toLowerCase();
-    }
-    else {
-        return obj;
-    }
-}
-/**
- * Deeply sort the keys of an object.
- * @param obj - An object to sort the keys of.
- * @returns A new object with sorted keys.
- */
-function deepSortKeys(obj) {
-    if (obj === null || typeof obj !== "object") {
-        return obj;
-    }
-    if (Array.isArray(obj)) {
-        return obj.map(deepSortKeys);
+    function deepSortKeys(obj) {
+        if (obj === null || typeof obj !== "object") {
+            return obj;
+        }
+        if (Array.isArray(obj)) {
+            return obj.map(deepSortKeys);
+        }
+        return Object.fromEntries(Object.entries(obj)
+            .sort(([a], [b]) => a.localeCompare(b))
+            .map(([k, v]) => [k, deepSortKeys(v)]));
     }
-    return Object.fromEntries(Object.entries(obj)
-        .sort(([a], [b]) => a.localeCompare(b))
-        .map(([k, v]) => [k, deepSortKeys(v)]));
-}
+});

package/script/src/transports/websocket/websocket_transport.d.ts

@@ -48,12 +48,15 @@ export declare class WebSocketTransport implements IRequestTransport, ISubscript
     protected _hlEvents: HyperliquidEventTarget;
     /**
      * Map of active subscriptions.
-     * - Key: Unique subscription identifier (stringified payload)
-     * - Value: Subscription info containing payload and listener mappings
+     * - Key: Unique subscription identifier based on payload
+     * - Value: Subscription info containing the subscription request promise
+     *   and a map of listeners to their metadata (channel + unsubscribe function).
      */
     protected _subscriptions: Map<string, {
-        channel: string;
-        listeners: Map<(data: CustomEvent) => void, () => Promise<void>>;
+        listeners: Map<(data: CustomEvent) => void, {
+            channel: string;
+            unsubscribe: (signal?: AbortSignal) => Promise<void>;
+        }>;
         requestPromise: Promise<unknown>;
     }>;
     /**
@@ -107,11 +110,5 @@ export declare class WebSocketTransport implements IRequestTransport, ISubscript
      * @returns A promise that resolves when the connection is fully closed.
      */
     close(signal?: AbortSignal): Promise<void>;
-    /**
-     * Combines timeout and user-provided signal.
-     * @param signal - A user-provided signal.
-     * @returns An AbortSignal that triggers when either the timeout or user-provided signal aborts.
-     */
-    protected combineSignals(signal?: AbortSignal): AbortSignal;
 }
 //# sourceMappingURL=websocket_transport.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"websocket_transport.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/websocket_transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,KAAK,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AACvG,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE;QACR;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,4BAA4B,CAAC;CAC5C;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,iBAAiB,EAAE,sBAAsB;IAChF,qDAAqD;IACrD,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C,iDAAiD;IACjD,SAAS,CAAC,YAAY,EAAE,0BAA0B,CAAC;IAEnD,6CAA6C;IAC7C,SAAS,CAAC,SAAS,EAAE,sBAAsB,CAAC;IAE5C;;;;OAIG;IACH,SAAS,CAAC,cAAc,EAAE,GAAG,CACzB,MAAM,EACN;QACI,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACjE,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KACpC,CACJ,CAUG;IAEJ;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,yCAAyC;IACzC,QAAQ,CAAC,SAAS,EAAE;QAChB;;;WAGG;QACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC,CAAC;IAEF,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAEvC;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAwC/C;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAUvG;;;;;;;OAOG;IACG,SAAS,CACX,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EACrC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAqDxB;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB1C;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB1C;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW;CAM9D"}
+{"version":3,"file":"websocket_transport.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/websocket_transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,KAAK,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AACvG,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE;QACR;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,4BAA4B,CAAC;CAC5C;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,iBAAiB,EAAE,sBAAsB;IAChF,qDAAqD;IACrD,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C,iDAAiD;IACjD,SAAS,CAAC,YAAY,EAAE,0BAA0B,CAAC;IAEnD,6CAA6C;IAC7C,SAAS,CAAC,SAAS,EAAE,sBAAsB,CAAC;IAE5C;;;;;OAKG;IACH,SAAS,CAAC,cAAc,EAAE,GAAG,CACzB,MAAM,EACN;QACI,SAAS,EAAE,GAAG,CACV,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EAC3B;YACI,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;SACxD,CACJ,CAAC;QACF,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KACpC,CACJ,CAAa;IAEd;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,yCAAyC;IACzC,QAAQ,CAAC,SAAS,EAAE;QAChB;;;WAGG;QACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC,CAAC;IAEF,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAEvC;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAwC/C;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAevG;;;;;;;OAOG;IACG,SAAS,CACX,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EACrC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAwExB;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB1C;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB7C"}