@nktkas/hyperliquid 0.13.0 → 0.13.2

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

@@ -1,237 +1,253 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebSocketTransport = void 0;
-const reconnecting_websocket_js_1 = require("./reconnecting_websocket.js");
-const hyperliquid_event_target_js_1 = require("./hyperliquid_event_target.js");
-const websocket_request_dispatcher_js_1 = require("./websocket_request_dispatcher.js");
-/**
- * WebSocket implementation of the REST and Subscription transport interfaces.
- */
-class WebSocketTransport {
+(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", "./reconnecting_websocket.js", "./hyperliquid_event_target.js", "./websocket_request_dispatcher.js"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.WebSocketTransport = void 0;
+    const reconnecting_websocket_js_1 = require("./reconnecting_websocket.js");
+    const hyperliquid_event_target_js_1 = require("./hyperliquid_event_target.js");
+    const websocket_request_dispatcher_js_1 = require("./websocket_request_dispatcher.js");
     /**
-     * Creates a new WebSocket transport instance.
-     * @param options - Configuration options for the WebSocket transport layer.
+     * WebSocket implementation of the REST and Subscription transport interfaces.
      */
-    constructor(options) {
-        /** The interval timer ID for keep-alive messages. */
-        Object.defineProperty(this, "_keepAliveTimer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** The WebSocket request dispatcher instance. */
-        Object.defineProperty(this, "_wsRequester", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** The Hyperliquid event target instance. */
-        Object.defineProperty(this, "_hlEvents", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
+    class WebSocketTransport {
         /**
-         * Map of active subscriptions.
-         * - Key: Unique subscription identifier (stringified payload)
-         * - Value: Subscription info containing payload and listener mappings
+         * Creates a new WebSocket transport instance.
+         * @param options - Configuration options for the WebSocket transport layer.
          */
-        Object.defineProperty(this, "_subscriptions", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
+        constructor(options) {
+            /** The interval timer ID for keep-alive messages. */
+            Object.defineProperty(this, "_keepAliveTimer", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            /** The WebSocket request dispatcher instance. */
+            Object.defineProperty(this, "_wsRequester", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            /** The Hyperliquid event target instance. */
+            Object.defineProperty(this, "_hlEvents", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            /**
+             * Map of active subscriptions.
+             * - 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).
+             */
+            Object.defineProperty(this, "_subscriptions", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: new Map()
+            });
+            /**
+             * Request timeout in ms.
+             * Set to `null` to disable.
+             */
+            Object.defineProperty(this, "timeout", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            /** Keep-alive configuration settings. */
+            Object.defineProperty(this, "keepAlive", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            /** The WebSocket that is used for communication. */
+            Object.defineProperty(this, "socket", {
+                enumerable: true,
+                configurable: true,
+                writable: true,
+                value: void 0
+            });
+            this.socket = new reconnecting_websocket_js_1.ReconnectingWebSocket(options?.url ?? "wss://api.hyperliquid.xyz/ws", undefined, options?.reconnect);
+            this._hlEvents = new hyperliquid_event_target_js_1.HyperliquidEventTarget(this.socket);
+            this._wsRequester = new websocket_request_dispatcher_js_1.WebSocketRequestDispatcher(this.socket, this._hlEvents);
+            this.timeout = options?.timeout === undefined ? 10_000 : options.timeout;
+            this.keepAlive = {
+                interval: options?.keepAlive?.interval === undefined ? 20_000 : options.keepAlive.interval,
+            };
+            // Initialize listeners
+            this.socket.addEventListener("open", () => {
+                // Start keep-alive timer
+                if (this.keepAlive.interval && !this._keepAliveTimer) {
+                    this._keepAliveTimer = setInterval(() => {
+                        this.socket.send(JSON.stringify({ method: "ping" }));
+                    }, this.keepAlive.interval);
+                }
+            });
+            this.socket.addEventListener("close", () => {
+                // Clear keep-alive timer
+                if (this._keepAliveTimer) {
+                    clearInterval(this._keepAliveTimer);
+                    this._keepAliveTimer = undefined;
+                }
+                // Clear all subscriptions
+                for (const subscriptionInfo of this._subscriptions.values()) {
+                    for (const [listener, { channel }] of subscriptionInfo.listeners) {
+                        this._hlEvents.removeEventListener(channel, listener);
+                    }
+                }
+                this._subscriptions.clear();
+            });
+        }
         /**
-         * Request timeout in ms.
-         * Set to `null` to disable.
+         * Sends a request to the Hyperliquid API via WebSocket.
+         * @param endpoint - The API endpoint to send the request to.
+         * @param payload - The payload to send with the request.
+         * @param signal - An optional abort signal.
+         * @returns A promise that resolves with parsed JSON response body.
+         * @throws {WebSocketRequestError} - An error that occurs when a WebSocket request fails.
+         * @note Explorer requests are not supported in the Hyperliquid WebSocket API.
          */
-        Object.defineProperty(this, "timeout", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** Keep-alive configuration settings. */
-        Object.defineProperty(this, "keepAlive", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** The WebSocket that is used for communication. */
-        Object.defineProperty(this, "socket", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.socket = new reconnecting_websocket_js_1.ReconnectingWebSocket(options?.url ?? "wss://api.hyperliquid.xyz/ws", undefined, options?.reconnect);
-        this._hlEvents = new hyperliquid_event_target_js_1.HyperliquidEventTarget(this.socket);
-        this._wsRequester = new websocket_request_dispatcher_js_1.WebSocketRequestDispatcher(this.socket, this._hlEvents);
-        this.timeout = options?.timeout === undefined ? 10_000 : options.timeout;
-        this.keepAlive = {
-            interval: options?.keepAlive?.interval === undefined ? 20_000 : options.keepAlive.interval,
-        };
-        // Initialize listeners
-        this.socket.addEventListener("open", () => {
-            // Start keep-alive timer
-            if (this.keepAlive.interval && !this._keepAliveTimer) {
-                this._keepAliveTimer = setInterval(() => {
-                    this.socket.send(JSON.stringify({ method: "ping" }));
-                }, this.keepAlive.interval);
+        request(type, payload, signal) {
+            // Reject explorer requests because they are not supported by the Hyperliquid WebSocket API
+            if (type === "explorer") {
+                throw new Error("Explorer requests are not supported in the Hyperliquid WebSocket API.");
             }
-        });
-        this.socket.addEventListener("close", () => {
-            // Clear keep-alive timer
-            if (this._keepAliveTimer) {
-                clearInterval(this._keepAliveTimer);
-                this._keepAliveTimer = undefined;
+            // Send the request and wait for a response
+            const timeoutSignal = this.timeout ? AbortSignal.timeout(this.timeout) : undefined;
+            const combinedSignal = timeoutSignal && signal
+                ? AbortSignal.any([timeoutSignal, signal])
+                : timeoutSignal ?? signal;
+            return this._wsRequester.request("post", { type, payload }, combinedSignal);
+        }
+        /**
+         * Subscribes to a Hyperliquid event channel.
+         * @param channel - The event channel to listen to.
+         * @param payload - A payload to send with the subscription request.
+         * @param listener - A function to call when the event is dispatched.
+         * @param signal - An optional abort signal for canceling the subscription request.
+         * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+         */
+        async subscribe(channel, payload, listener, signal) {
+            // Create a unique identifier for the subscription
+            const id = websocket_request_dispatcher_js_1.WebSocketRequestDispatcher.requestToId(payload);
+            // Initialize new subscription, if it doesn't exist
+            let subscriptionInfo = this._subscriptions.get(id);
+            if (!subscriptionInfo) {
+                // Send subscription request
+                const timeoutSignal = this.timeout ? AbortSignal.timeout(this.timeout) : undefined;
+                const combinedSignal = timeoutSignal && signal
+                    ? AbortSignal.any([timeoutSignal, signal])
+                    : timeoutSignal ?? signal;
+                const requestPromise = this._wsRequester.request("subscribe", payload, combinedSignal);
+                // Cache subscription info
+                subscriptionInfo = { listeners: new Map(), requestPromise };
+                this._subscriptions.set(id, subscriptionInfo);
             }
-            // Clear all subscriptions
-            for (const [_, { channel, listeners }] of this._subscriptions.entries()) {
-                for (const [listener] of listeners) {
+            // Initialize new listener, if it doesn't exist
+            let listenerInfo = subscriptionInfo.listeners.get(listener);
+            if (!listenerInfo) {
+                // Create new unsubscribe function
+                const unsubscribe = async (signal) => {
+                    // Remove listener and cleanup
                     this._hlEvents.removeEventListener(channel, listener);
-                }
+                    const isDeleted = subscriptionInfo.listeners.delete(listener);
+                    // If no listeners remain, remove subscription entirely
+                    // `isDeleted` means that the map had a listener before and became 0 after that
+                    if (subscriptionInfo.listeners.size === 0 && isDeleted) {
+                        // Cleanup subscription
+                        this._subscriptions.delete(id);
+                        // Send unsubscription request
+                        const timeoutSignal = this.timeout ? AbortSignal.timeout(this.timeout) : undefined;
+                        const combinedSignal = timeoutSignal && signal
+                            ? AbortSignal.any([timeoutSignal, signal])
+                            : timeoutSignal ?? signal;
+                        await this._wsRequester.request("unsubscribe", payload, combinedSignal);
+                    }
+                };
+                // Cache listener info
+                listenerInfo = { channel, unsubscribe };
+                subscriptionInfo.listeners.set(listener, listenerInfo);
+                // Add event listener
+                this._hlEvents.addEventListener(channel, listener);
             }
-            this._subscriptions.clear();
-        });
-    }
-    /**
-     * Sends a request to the Hyperliquid API via WebSocket.
-     * @param endpoint - The API endpoint to send the request to.
-     * @param payload - The payload to send with the request.
-     * @param signal - An optional abort signal.
-     * @returns A promise that resolves with parsed JSON response body.
-     * @throws {WebSocketRequestError} - An error that occurs when a WebSocket request fails.
-     * @note Explorer requests are not supported in the Hyperliquid WebSocket API.
-     */
-    request(type, payload, signal) {
-        // Reject explorer requests because they are not supported by the Hyperliquid WebSocket API
-        if (type === "explorer") {
-            throw new Error("Explorer requests are not supported in the Hyperliquid WebSocket API.");
-        }
-        // Send the request and wait for a response
-        return this._wsRequester.request("post", { type, payload }, this.combineSignals(signal));
-    }
-    /**
-     * Subscribes to a Hyperliquid event channel.
-     * @param channel - The event channel to listen to.
-     * @param payload - A payload to send with the subscription request.
-     * @param listener - A function to call when the event is dispatched.
-     * @param signal - An optional abort signal for canceling the subscription request.
-     * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
-     */
-    async subscribe(channel, payload, listener, signal) {
-        // Create a unique identifier for the subscription
-        const id = `${channel}::${websocket_request_dispatcher_js_1.WebSocketRequestDispatcher.requestToId(payload)}`;
-        // Initialize new subscription, if it doesn't exist
-        let subscriptionInfo = this._subscriptions.get(id);
-        if (!subscriptionInfo) {
-            // Send subscription request
-            const requestPromise = this._wsRequester.request("subscribe", payload, this.combineSignals(signal))
-                .catch((error) => {
-                this._subscriptions.delete(id);
-                throw error;
-            });
-            // Cache subscription info
-            subscriptionInfo = { channel, listeners: new Map(), requestPromise };
-            this._subscriptions.set(id, subscriptionInfo);
-        }
-        // Check if we already have an unsubscribe function for this listener
-        let unsubscribe = subscriptionInfo.listeners.get(listener);
-        if (!unsubscribe) {
-            // Create new unsubscribe function if none exists
-            unsubscribe = async (signal) => {
+            // Wait for the initial subscription request to complete
+            await subscriptionInfo.requestPromise.catch((error) => {
                 // Remove listener and cleanup
                 this._hlEvents.removeEventListener(channel, listener);
-                const isDeleted = subscriptionInfo.listeners.delete(listener);
+                subscriptionInfo.listeners.delete(listener);
                 // If no listeners remain, remove subscription entirely
-                // `isDeleted` means that the map had a listener before and became 0 after that
-                if (subscriptionInfo.listeners.size === 0 && isDeleted) {
+                if (subscriptionInfo.listeners.size === 0)
                     this._subscriptions.delete(id);
-                    await this._wsRequester.request("unsubscribe", payload, this.combineSignals(signal));
-                }
+                // Rethrow the error
+                throw error;
+            });
+            // Return subscription control object
+            return {
+                unsubscribe: listenerInfo.unsubscribe,
             };
-            // Add event listener & Cache unsubscribe function
-            this._hlEvents.addEventListener(channel, listener);
-            subscriptionInfo.listeners.set(listener, unsubscribe);
         }
-        // Wait for the initial subscription request to complete
-        await subscriptionInfo.requestPromise.catch((error) => {
-            // Cleanup the subscription and rethrow the error
-            this._hlEvents.removeEventListener(channel, listener);
-            subscriptionInfo.listeners.delete(listener);
-            throw error;
-        });
-        // Return subscription control object
-        return { unsubscribe };
-    }
-    /**
-     * Waits until the WebSocket connection is ready.
-     * @param signal - An optional abort signal.
-     * @returns A promise that resolves when the connection is ready.
-     */
-    ready(signal) {
-        return new Promise((resolve, reject) => {
-            const combinedSignal = signal
-                ? AbortSignal.any([this.socket.terminationSignal, signal])
-                : this.socket.terminationSignal;
-            if (combinedSignal.aborted)
-                return reject(combinedSignal.reason);
-            if (this.socket.readyState === WebSocket.OPEN)
-                return resolve();
-            const handleOpen = () => {
-                combinedSignal.removeEventListener("abort", handleAbort);
-                resolve();
-            };
-            const handleAbort = () => {
-                this.socket.removeEventListener("open", handleOpen);
-                reject(combinedSignal.reason);
-            };
-            this.socket.addEventListener("open", handleOpen, { once: true });
-            combinedSignal.addEventListener("abort", handleAbort, { once: true });
-        });
-    }
-    /**
-     * Closes the WebSocket connection and waits until it is fully closed.
-     * @param signal - An optional abort signal.
-     * @returns A promise that resolves when the connection is fully closed.
-     */
-    close(signal) {
-        return new Promise((resolve, reject) => {
-            if (signal?.aborted)
-                return reject(signal.reason);
-            if (this.socket.readyState === WebSocket.CLOSED)
-                return resolve();
-            const handleClose = () => {
-                signal?.removeEventListener("abort", handleAbort);
-                resolve();
-            };
-            const handleAbort = () => {
-                this.socket.removeEventListener("close", handleClose);
-                reject(signal?.reason);
-            };
-            this.socket.addEventListener("close", handleClose, { once: true });
-            signal?.addEventListener("abort", handleAbort, { once: true });
-            this.socket.close();
-        });
-    }
-    /**
-     * 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.
-     */
-    combineSignals(signal) {
-        const signals = [];
-        if (this.timeout)
-            signals.push(AbortSignal.timeout(this.timeout));
-        if (signal)
-            signals.push(signal);
-        return signals.length > 1 ? AbortSignal.any(signals) : signals[0];
+        /**
+         * Waits until the WebSocket connection is ready.
+         * @param signal - An optional abort signal.
+         * @returns A promise that resolves when the connection is ready.
+         */
+        ready(signal) {
+            return new Promise((resolve, reject) => {
+                const combinedSignal = signal
+                    ? AbortSignal.any([this.socket.terminationSignal, signal])
+                    : this.socket.terminationSignal;
+                if (combinedSignal.aborted)
+                    return reject(combinedSignal.reason);
+                if (this.socket.readyState === WebSocket.OPEN)
+                    return resolve();
+                const handleOpen = () => {
+                    combinedSignal.removeEventListener("abort", handleAbort);
+                    resolve();
+                };
+                const handleAbort = () => {
+                    this.socket.removeEventListener("open", handleOpen);
+                    reject(combinedSignal.reason);
+                };
+                this.socket.addEventListener("open", handleOpen, { once: true });
+                combinedSignal.addEventListener("abort", handleAbort, { once: true });
+            });
+        }
+        /**
+         * Closes the WebSocket connection and waits until it is fully closed.
+         * @param signal - An optional abort signal.
+         * @returns A promise that resolves when the connection is fully closed.
+         */
+        close(signal) {
+            return new Promise((resolve, reject) => {
+                if (signal?.aborted)
+                    return reject(signal.reason);
+                if (this.socket.readyState === WebSocket.CLOSED)
+                    return resolve();
+                const handleClose = () => {
+                    signal?.removeEventListener("abort", handleAbort);
+                    resolve();
+                };
+                const handleAbort = () => {
+                    this.socket.removeEventListener("close", handleClose);
+                    reject(signal?.reason);
+                };
+                this.socket.addEventListener("close", handleClose, { once: true });
+                signal?.addEventListener("abort", handleAbort, { once: true });
+                this.socket.close();
+            });
+        }
     }
-}
-exports.WebSocketTransport = WebSocketTransport;
+    exports.WebSocketTransport = WebSocketTransport;
+});

package/script/src/types/common.d.ts

@@ -0,0 +1,3 @@
+/** Hexadecimal string starting with `0x`. */
+export type Hex = `0x${string}`;
+//# sourceMappingURL=common.d.ts.map

package/script/src/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/src/types/common.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC"}

package/script/src/types/common.js

@@ -0,0 +1,12 @@
+(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"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/script/src/types/exchange/common.d.ts

@@ -0,0 +1,36 @@
+import type { Hex } from "../common.js";
+import type { TIF } from "../info/orders.js";
+/** Order parameters. */
+export type OrderParams = {
+    /** Asset ID. */
+    a: number;
+    /** Position side (`true` for long, `false` for short). */
+    b: boolean;
+    /** Price. */
+    p: string;
+    /** Size (in base currency units). */
+    s: string;
+    /** Is reduce-only? */
+    r: boolean;
+    /** Order type. */
+    t: {
+        /** Limit order parameters. */
+        limit: {
+            /** Time-in-force. */
+            tif: TIF;
+        };
+    } | {
+        /** Trigger order parameters. */
+        trigger: {
+            /** Is market order? */
+            isMarket: boolean;
+            /** Trigger price. */
+            triggerPx: string;
+            /** Indicates whether it is take profit or stop loss. */
+            tpsl: "tp" | "sl";
+        };
+    };
+    /** Client Order ID. */
+    c?: Hex;
+};
+//# sourceMappingURL=common.d.ts.map

package/script/src/types/exchange/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../src/src/types/exchange/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAE7C,wBAAwB;AACxB,MAAM,MAAM,WAAW,GAAG;IACtB,gBAAgB;IAChB,CAAC,EAAE,MAAM,CAAC;IACV,0DAA0D;IAC1D,CAAC,EAAE,OAAO,CAAC;IACX,aAAa;IACb,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,sBAAsB;IACtB,CAAC,EAAE,OAAO,CAAC;IACX,kBAAkB;IAClB,CAAC,EACK;QACE,8BAA8B;QAC9B,KAAK,EAAE;YACH,qBAAqB;YACrB,GAAG,EAAE,GAAG,CAAC;SACZ,CAAC;KACL,GACC;QACE,gCAAgC;QAChC,OAAO,EAAE;YACL,uBAAuB;YACvB,QAAQ,EAAE,OAAO,CAAC;YAClB,qBAAqB;YACrB,SAAS,EAAE,MAAM,CAAC;YAClB,wDAAwD;YACxD,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;SACrB,CAAC;KACL,CAAC;IACN,uBAAuB;IACvB,CAAC,CAAC,EAAE,GAAG,CAAC;CACX,CAAC"}

package/script/src/types/exchange/common.js

@@ -0,0 +1,12 @@
+(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"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});