@nktkas/hyperliquid 0.13.1 → 0.13.2

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

@@ -65,19 +65,19 @@ export class WebSocketRequestDispatcher {
                     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}`));
+                        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 process subscription request: ${event.detail}`));
+                        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 process unrecognized request: ${event.detail}`));
+                        this.reject(id, new WebSocketRequestError(`Cannot complete WebSocket request: ${event.detail}`));
                     }
                 }
             }

package/esm/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/esm/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"}

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

@@ -33,8 +33,9 @@ export class WebSocketTransport {
         });
         /**
          * 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).
          */
         Object.defineProperty(this, "_subscriptions", {
             enumerable: true,
@@ -89,8 +90,8 @@ export class WebSocketTransport {
                 this._keepAliveTimer = undefined;
             }
             // Clear all subscriptions
-            for (const [_, { channel, listeners }] of this._subscriptions.entries()) {
-                for (const [listener] of listeners) {
+            for (const subscriptionInfo of this._subscriptions.values()) {
+                for (const [listener, { channel }] of subscriptionInfo.listeners) {
                     this._hlEvents.removeEventListener(channel, listener);
                 }
             }
@@ -112,7 +113,11 @@ export class WebSocketTransport {
             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));
+        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.
@@ -124,48 +129,62 @@ export class WebSocketTransport {
      */
     async subscribe(channel, payload, listener, signal) {
         // Create a unique identifier for the subscription
-        const id = `${channel}::${WebSocketRequestDispatcher.requestToId(payload)}`;
+        const id = 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;
-            });
+            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 = { channel, listeners: new Map(), requestPromise };
+            subscriptionInfo = { 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) => {
+        // 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);
-                    await this._wsRequester.request("unsubscribe", payload, this.combineSignals(signal));
+                    // 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);
                 }
             };
-            // Add event listener & Cache unsubscribe function
+            // Cache listener info
+            listenerInfo = { channel, unsubscribe };
+            subscriptionInfo.listeners.set(listener, listenerInfo);
+            // Add event listener
             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
+            // Remove listener and cleanup
             this._hlEvents.removeEventListener(channel, listener);
             subscriptionInfo.listeners.delete(listener);
+            // If no listeners remain, remove subscription entirely
+            if (subscriptionInfo.listeners.size === 0)
+                this._subscriptions.delete(id);
+            // Rethrow the error
             throw error;
         });
         // Return subscription control object
-        return { unsubscribe };
+        return {
+            unsubscribe: listenerInfo.unsubscribe,
+        };
     }
     /**
      * Waits until the WebSocket connection is ready.
@@ -217,17 +236,4 @@ export class WebSocketTransport {
             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];
-    }
 }

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

@@ -1,10 +1,10 @@
 import type { Hex } from "../common.js";
 import type { TIF } from "../info/orders.js";
 /** Order parameters. */
-export type OrderParms = {
-    /** An integer representing the asset being traded. */
+export type OrderParams = {
+    /** Asset ID. */
     a: number;
-    /** Position side (true for long, false for short). */
+    /** Position side (`true` for long, `false` for short). */
     b: boolean;
     /** Price. */
     p: string;
@@ -12,7 +12,7 @@ export type OrderParms = {
     s: string;
     /** Is reduce-only? */
     r: boolean;
-    /** Order type and parameters. */
+    /** Order type. */
     t: {
         /** Limit order parameters. */
         limit: {
@@ -22,11 +22,11 @@ export type OrderParms = {
     } | {
         /** Trigger order parameters. */
         trigger: {
-            /** Is the market order. */
+            /** Is market order? */
             isMarket: boolean;
             /** Trigger price. */
             triggerPx: string;
-            /** Indicates if it's take-profit or stop-loss. */
+            /** Indicates whether it is take profit or stop loss. */
             tpsl: "tp" | "sl";
         };
     };

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

@@ -1 +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,UAAU,GAAG;IACrB,sDAAsD;IACtD,CAAC,EAAE,MAAM,CAAC;IAEV,sDAAsD;IACtD,CAAC,EAAE,OAAO,CAAC;IAEX,aAAa;IACb,CAAC,EAAE,MAAM,CAAC;IAEV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IAEV,sBAAsB;IACtB,CAAC,EAAE,OAAO,CAAC;IAEX,iCAAiC;IACjC,CAAC,EACK;QACE,8BAA8B;QAC9B,KAAK,EAAE;YACH,qBAAqB;YACrB,GAAG,EAAE,GAAG,CAAC;SACZ,CAAC;KACL,GACC;QACE,gCAAgC;QAChC,OAAO,EAAE;YACL,2BAA2B;YAC3B,QAAQ,EAAE,OAAO,CAAC;YAElB,qBAAqB;YACrB,SAAS,EAAE,MAAM,CAAC;YAElB,kDAAkD;YAClD,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;SACrB,CAAC;KACL,CAAC;IAEN,uBAAuB;IACvB,CAAC,CAAC,EAAE,GAAG,CAAC;CACX,CAAC"}
+{"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"}