@nktkas/hyperliquid 0.19.1 → 0.20.0

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

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

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

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

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

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

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

@@ -1,7 +1,7 @@
 import { type MessageBufferStrategy, ReconnectingWebSocket, ReconnectingWebSocketError, type ReconnectingWebSocketOptions } from "./_reconnecting_websocket.js";
 import { HyperliquidEventTarget } from "./_hyperliquid_event_target.js";
-import { WebSocketRequestDispatcher, WebSocketRequestError } from "./_websocket_request_dispatcher.js";
-import type { IRequestTransport, ISubscriptionTransport, Subscription } from "../../base.js";
+import { WebSocketAsyncRequest, WebSocketRequestError } from "./_websocket_async_request.js";
+import type { IRequestTransport, ISubscriptionTransport, Subscription } from "../base.js";
 export { WebSocketRequestError };
 export { type MessageBufferStrategy, ReconnectingWebSocketError, type ReconnectingWebSocketOptions };
 /** Configuration options for the WebSocket transport layer. */
@@ -10,44 +10,42 @@ export interface WebSocketTransportOptions {
      * The WebSocket URL.
      * - Mainnet:
      *   - API: `wss://api.hyperliquid.xyz/ws`
-     *   - RPC: `wss://rpc.hyperliquid.xyz/ws`
+     *   - Explorer: `wss://rpc.hyperliquid.xyz/ws`
      * - Testnet:
      *   - API: `wss://api.hyperliquid-testnet.xyz/ws`
-     *   - RPC: `wss://rpc.hyperliquid-testnet.xyz/ws`
+     *   - Explorer: `wss://rpc.hyperliquid-testnet.xyz/ws`
      * @defaultValue `wss://api.hyperliquid.xyz/ws`
      */
     url?: string | URL;
     /**
-     * Request timeout in ms.
+     * Timeout for requests in ms.
      * Set to `null` to disable.
      * @defaultValue `10_000`
      */
     timeout?: number | null;
-    /**
-     * Keep-alive configuration.
-     * @defaultValue `{ interval: 20_000 }`
-     */
+    /** Keep-alive configuration. */
     keepAlive?: {
         /**
-         * The interval in ms to send keep-alive messages.
+         * Interval between sending ping messages in ms.
          * Set to `null` to disable.
-         * @defaultValue `20_000`
+         * @defaultValue `30_000`
          */
         interval?: number | null;
+        /**
+         * Timeout for the ping request in ms.
+         * Set to `null` to disable.
+         * same as {@link timeout} for requests.
+         */
+        timeout?: number | null;
     };
-    /**
-     * Reconnection policy configuration for closed connections.
-     */
+    /** Reconnection policy configuration for closed connections. */
     reconnect?: ReconnectingWebSocketOptions;
 }
 /** WebSocket implementation of the REST and Subscription transport interfaces. */
 export declare class WebSocketTransport implements IRequestTransport, ISubscriptionTransport, AsyncDisposable {
-    /** The interval timer ID for keep-alive messages. */
-    protected _keepAliveTimer: number | null;
-    /** The WebSocket request dispatcher instance. */
-    protected _wsRequester: WebSocketRequestDispatcher;
-    /** The Hyperliquid event target instance. */
+    protected _wsRequester: WebSocketAsyncRequest;
     protected _hlEvents: HyperliquidEventTarget;
+    protected _keepAliveTimeout: ReturnType<typeof setTimeout> | null;
     /**
      * Map of active subscriptions.
      * - Key: Unique subscription identifier based on payload
@@ -63,13 +61,18 @@ export declare class WebSocketTransport implements IRequestTransport, ISubscript
      * Set to `null` to disable.
      */
     timeout: number | null;
-    /** Keep-alive configuration settings. */
+    /** Keep-alive configuration. */
     readonly keepAlive: {
         /**
-         * The interval in ms to send keep-alive messages.
+         * Interval between sending ping messages in ms.
          * Set to `null` to disable.
          */
         readonly interval: number | null;
+        /**
+         * Timeout for the ping request in ms.
+         * Set to `null` to disable.
+         */
+        timeout?: number | null;
     };
     /** The WebSocket that is used for communication. */
     readonly socket: ReconnectingWebSocket;
@@ -80,23 +83,29 @@ export declare class WebSocketTransport implements IRequestTransport, ISubscript
     constructor(options?: WebSocketTransportOptions);
     /**
      * Sends a request to the Hyperliquid API via WebSocket.
+     *
+     * Note: Explorer requests are not supported in the Hyperliquid WebSocket API.
+     *
      * @param endpoint - The API endpoint to send the request to (`explorer` requests are not supported).
      * @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: "info" | "exchange" | "explorer", payload: unknown, signal?: AbortSignal): Promise<unknown>;
+    request<T>(type: "info" | "exchange" | "explorer", payload: unknown, signal?: AbortSignal): Promise<T>;
     /**
      * Subscribes to a Hyperliquid event channel.
+     *
+     * Sends a subscription request to the server and listens for events.
+     *
      * @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.
+     * @throws {WebSocketRequestError} - An error that occurs when a WebSocket request fails.
      */
-    subscribe(channel: string, payload: unknown, listener: (data: CustomEvent) => void, signal?: AbortSignal): Promise<Subscription>;
+    subscribe<T>(channel: string, payload: unknown, listener: (data: CustomEvent<T>) => void, signal?: AbortSignal): Promise<Subscription>;
     /**
      * Waits until the WebSocket connection is ready.
      * @param signal - An optional abort signal.
@@ -109,12 +118,13 @@ export declare class WebSocketTransport implements IRequestTransport, ISubscript
      * @returns A promise that resolves when the connection is fully closed.
      */
     close(signal?: AbortSignal): Promise<void>;
+    /** Combines the provided abort signal with the timeout signal. */
+    protected _getCombinedTimeoutSignal(signal?: AbortSignal): AbortSignal | undefined;
     /**
-     * Combines the provided abort signal with the timeout signal.
-     * @param signal An optional abort signal.
-     * @returns A combined abort signal or undefined.
+     * Initiate background keep the connection alive.
+     * Sends ping only when needed.
      */
-    protected _getCombinedTimeoutSignal(signal?: AbortSignal): AbortSignal | undefined;
+    protected _keepAlive(): void;
     [Symbol.asyncDispose](): Promise<void>;
 }
 //# 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,EACH,KAAK,qBAAqB,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AACvG,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7F,OAAO,EAAE,qBAAqB,EAAE,CAAC;AACjC,OAAO,EAAE,KAAK,qBAAqB,EAAE,0BAA0B,EAAE,KAAK,4BAA4B,EAAE,CAAC;AAErG,+DAA+D;AAC/D,MAAM,WAAW,yBAAyB;IACtC;;;;;;;;;OASG;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,kFAAkF;AAClF,qBAAa,kBAAmB,YAAW,iBAAiB,EAAE,sBAAsB,EAAE,eAAe;IACjG,qDAAqD;IACrD,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhD,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,CAAC,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,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;IAuC/C;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzG;;;;;;;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;IAgExB;;;;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,yBAAyB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAQ5E,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG/C"}
+{"version":3,"file":"websocket_transport.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/websocket_transport.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,qBAAqB,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAC7F,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1F,OAAO,EAAE,qBAAqB,EAAE,CAAC;AACjC,OAAO,EAAE,KAAK,qBAAqB,EAAE,0BAA0B,EAAE,KAAK,4BAA4B,EAAE,CAAC;AAErG,+DAA+D;AAC/D,MAAM,WAAW,yBAAyB;IACtC;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,gCAAgC;IAChC,SAAS,CAAC,EAAE;QACR;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,CAAC;IAEF,gEAAgE;IAChE,SAAS,CAAC,EAAE,4BAA4B,CAAC;CAC5C;AAED,kFAAkF;AAClF,qBAAa,kBAAmB,YAAW,iBAAiB,EAAE,sBAAsB,EAAE,eAAe;IACjG,SAAS,CAAC,YAAY,EAAE,qBAAqB,CAAC;IAC9C,SAAS,CAAC,SAAS,EAAE,sBAAsB,CAAC;IAC5C,SAAS,CAAC,iBAAiB,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAQ;IAEzE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,EAAE,GAAG,CACzB,MAAM,EACN;QACI,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KACpC,CACJ,CAAa;IAEd;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,gCAAgC;IAChC,QAAQ,CAAC,SAAS,EAAE;QAChB;;;WAGG;QACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,CAAC;IAEF,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAEvC;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAoC/C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC;IAQtG;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,CAAC,EACb,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EACxC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAgExB;;;;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,kEAAkE;IAClE,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAQlF;;;OAGG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAuBtB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG/C"}

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

@@ -4,7 +4,7 @@
         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);
+        define(["require", "exports", "./_reconnecting_websocket.js", "./_hyperliquid_event_target.js", "./_websocket_async_request.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -13,93 +13,52 @@
     const _reconnecting_websocket_js_1 = require("./_reconnecting_websocket.js");
     Object.defineProperty(exports, "ReconnectingWebSocketError", { enumerable: true, get: function () { return _reconnecting_websocket_js_1.ReconnectingWebSocketError; } });
     const _hyperliquid_event_target_js_1 = require("./_hyperliquid_event_target.js");
-    const _websocket_request_dispatcher_js_1 = require("./_websocket_request_dispatcher.js");
-    Object.defineProperty(exports, "WebSocketRequestError", { enumerable: true, get: function () { return _websocket_request_dispatcher_js_1.WebSocketRequestError; } });
+    const _websocket_async_request_js_1 = require("./_websocket_async_request.js");
+    Object.defineProperty(exports, "WebSocketRequestError", { enumerable: true, get: function () { return _websocket_async_request_js_1.WebSocketRequestError; } });
     /** WebSocket implementation of the REST and Subscription transport interfaces. */
     class WebSocketTransport {
+        _wsRequester;
+        _hlEvents;
+        _keepAliveTimeout = null;
+        /**
+         * 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).
+         */
+        _subscriptions = new Map();
+        /**
+         * Request timeout in ms.
+         * Set to `null` to disable.
+         */
+        timeout;
+        /** Keep-alive configuration. */
+        keepAlive;
+        /** The WebSocket that is used for communication. */
+        socket;
         /**
          * Creates a new WebSocket transport instance.
          * @param options - Configuration options for the WebSocket transport layer.
          */
         constructor(options) {
-            /** The interval timer ID for keep-alive messages. */
-            Object.defineProperty(this, "_keepAliveTimer", {
-                enumerable: true,
-                configurable: true,
-                writable: true,
-                value: null
-            });
-            /** 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._wsRequester = new _websocket_async_request_js_1.WebSocketAsyncRequest(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,
+                interval: options?.keepAlive?.interval === undefined ? 30_000 : options.keepAlive?.interval,
+                timeout: options?.keepAlive?.timeout === undefined ? this.timeout : options.keepAlive?.timeout,
             };
             // Initialize listeners
             this.socket.addEventListener("open", () => {
-                // Start keep-alive timer
-                if (this.keepAlive.interval && this._keepAliveTimer === null) {
-                    this._keepAliveTimer = setInterval(() => {
-                        this.socket.send(JSON.stringify({ method: "ping" }));
-                    }, this.keepAlive.interval);
-                }
+                // Start keep-alive handler
+                this._keepAlive();
             });
             this.socket.addEventListener("close", () => {
                 // Clear keep-alive timer
-                if (this._keepAliveTimer !== null) {
-                    clearInterval(this._keepAliveTimer);
-                    this._keepAliveTimer = null;
+                if (this._keepAliveTimeout !== null) {
+                    clearTimeout(this._keepAliveTimeout);
+                    this._keepAliveTimeout = null;
                 }
                 // Clear all subscriptions
                 for (const subscriptionInfo of this._subscriptions.values()) {
@@ -111,12 +70,14 @@
         }
         /**
          * Sends a request to the Hyperliquid API via WebSocket.
+         *
+         * Note: Explorer requests are not supported in the Hyperliquid WebSocket API.
+         *
          * @param endpoint - The API endpoint to send the request to (`explorer` requests are not supported).
          * @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) {
             const combinedTimeoutSignal = this._getCombinedTimeoutSignal(signal);
@@ -127,15 +88,19 @@
         }
         /**
          * Subscribes to a Hyperliquid event channel.
+         *
+         * Sends a subscription request to the server and listens for events.
+         *
          * @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.
+         * @throws {WebSocketRequestError} - An error that occurs when a WebSocket request fails.
          */
         async subscribe(channel, payload, listener, signal) {
             // Create a unique identifier for the subscription
-            const id = _websocket_request_dispatcher_js_1.WebSocketRequestDispatcher.requestToId(payload);
+            const id = _websocket_async_request_js_1.WebSocketAsyncRequest.requestToId(payload);
             // Initialize new subscription, if it doesn't exist
             let subscription = this._subscriptions.get(id);
             if (!subscription) {
@@ -236,11 +201,7 @@
                 this.socket.close();
             });
         }
-        /**
-         * Combines the provided abort signal with the timeout signal.
-         * @param signal An optional abort signal.
-         * @returns A combined abort signal or undefined.
-         */
+        /** Combines the provided abort signal with the timeout signal. */
         _getCombinedTimeoutSignal(signal) {
             const timeoutSignal = this.timeout ? AbortSignal.timeout(this.timeout) : undefined;
             const combinedSignal = signal && timeoutSignal
@@ -248,6 +209,30 @@
                 : signal ?? timeoutSignal;
             return combinedSignal;
         }
+        /**
+         * Initiate background keep the connection alive.
+         * Sends ping only when needed.
+         */
+        _keepAlive() {
+            if (this.keepAlive.interval === null || this._keepAliveTimeout)
+                return;
+            const tick = async () => {
+                if (this.socket.readyState !== _reconnecting_websocket_js_1.ReconnectingWebSocket.OPEN || !this._keepAliveTimeout)
+                    return;
+                // Check if the last request was sent more than the keep-alive interval ago
+                if (Date.now() - this._wsRequester.lastRequestTime >= this.keepAlive.interval) {
+                    const timeoutSignal = this.keepAlive.timeout ? AbortSignal.timeout(this.keepAlive.timeout) : undefined;
+                    await this._wsRequester.request("ping", timeoutSignal)
+                        .catch(() => undefined); // Ignore errors
+                }
+                // Schedule the next ping
+                if (this.socket.readyState === _reconnecting_websocket_js_1.ReconnectingWebSocket.OPEN && this._keepAliveTimeout) {
+                    const nextDelay = this.keepAlive.interval - (Date.now() - this._wsRequester.lastRequestTime);
+                    this._keepAliveTimeout = setTimeout(tick, nextDelay);
+                }
+            };
+            this._keepAliveTimeout = setTimeout(tick, this.keepAlive.interval);
+        }
         async [Symbol.asyncDispose]() {
             await this.close();
         }