@nktkas/hyperliquid 0.13.0

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

@@ -0,0 +1,117 @@
+import { ReconnectingWebSocket, type ReconnectingWebSocketOptions } from "./reconnecting_websocket.js";
+import { HyperliquidEventTarget } from "./hyperliquid_event_target.js";
+import { WebSocketRequestDispatcher } from "./websocket_request_dispatcher.js";
+import type { IRequestTransport, ISubscriptionTransport, Subscription } from "../base.js";
+/**
+ * Configuration options for the WebSocket transport layer.
+ */
+export interface WebSocketTransportOptions {
+    /**
+     * The WebSocket URL.
+     * - Mainnet: `wss://api.hyperliquid.xyz/ws`
+     * - Testnet: `wss://api.hyperliquid-testnet.xyz/ws`
+     * @defaultValue `wss://api.hyperliquid.xyz/ws`
+     */
+    url?: string | URL;
+    /**
+     * Request timeout in ms.
+     * Set to `null` to disable.
+     * @defaultValue `10_000`
+     */
+    timeout?: number | null;
+    /**
+     * Keep-alive configuration.
+     * @defaultValue `{ interval: 20_000 }`
+     */
+    keepAlive?: {
+        /**
+         * The interval in ms to send keep-alive messages.
+         * Set to `null` to disable.
+         * @defaultValue `20_000`
+         */
+        interval?: number | null;
+    };
+    /**
+     * Reconnection policy configuration for closed connections.
+     */
+    reconnect?: ReconnectingWebSocketOptions;
+}
+/**
+ * WebSocket implementation of the REST and Subscription transport interfaces.
+ */
+export declare class WebSocketTransport implements IRequestTransport, ISubscriptionTransport {
+    /** The interval timer ID for keep-alive messages. */
+    protected _keepAliveTimer: number | undefined;
+    /** The WebSocket request dispatcher instance. */
+    protected _wsRequester: WebSocketRequestDispatcher;
+    /** The Hyperliquid event target instance. */
+    protected _hlEvents: HyperliquidEventTarget;
+    /**
+     * Map of active subscriptions.
+     * - Key: Unique subscription identifier (stringified payload)
+     * - Value: Subscription info containing payload and listener mappings
+     */
+    protected _subscriptions: Map<string, {
+        channel: string;
+        listeners: Map<(data: CustomEvent) => void, () => Promise<void>>;
+        requestPromise: Promise<unknown>;
+    }>;
+    /**
+     * Request timeout in ms.
+     * Set to `null` to disable.
+     */
+    timeout: number | null;
+    /** Keep-alive configuration settings. */
+    readonly keepAlive: {
+        /**
+         * The interval in ms to send keep-alive messages.
+         * Set to `null` to disable.
+         */
+        readonly interval: number | null;
+    };
+    /** The WebSocket that is used for communication. */
+    readonly socket: ReconnectingWebSocket;
+    /**
+     * Creates a new WebSocket transport instance.
+     * @param options - Configuration options for the WebSocket transport layer.
+     */
+    constructor(options?: WebSocketTransportOptions);
+    /**
+     * 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: "info" | "action" | "explorer", payload: unknown, signal?: AbortSignal): Promise<unknown>;
+    /**
+     * 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.
+     */
+    subscribe(channel: string, payload: unknown, listener: (data: CustomEvent) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * 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?: AbortSignal): Promise<void>;
+    /**
+     * 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?: 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

@@ -0,0 +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"}

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

@@ -0,0 +1,233 @@
+import { ReconnectingWebSocket } from "./reconnecting_websocket.js";
+import { HyperliquidEventTarget } from "./hyperliquid_event_target.js";
+import { WebSocketRequestDispatcher } from "./websocket_request_dispatcher.js";
+/**
+ * WebSocket implementation of the REST and Subscription transport interfaces.
+ */
+export class WebSocketTransport {
+    /**
+     * 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: 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 (stringified payload)
+         * - Value: Subscription info containing payload and listener mappings
+         */
+        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 ReconnectingWebSocket(options?.url ?? "wss://api.hyperliquid.xyz/ws", undefined, options?.reconnect);
+        this._hlEvents = new HyperliquidEventTarget(this.socket);
+        this._wsRequester = new 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 [_, { channel, listeners }] of this._subscriptions.entries()) {
+                for (const [listener] of listeners) {
+                    this._hlEvents.removeEventListener(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}::${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) => {
+                // 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) {
+                    this._subscriptions.delete(id);
+                    await this._wsRequester.request("unsubscribe", payload, this.combineSignals(signal));
+                }
+            };
+            // 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];
+    }
+}

package/esm/src/utils/key_sort.d.ts

@@ -0,0 +1,21 @@
+import type { BatchModifyRequest, CancelByCloidRequest, CancelRequest, CreateSubAccountRequest, ModifyRequest, OrderRequest, ScheduleCancelRequest, SetReferrerRequest, SubAccountTransferRequest, TwapCancelRequest, TwapOrderRequest, UpdateIsolatedMarginRequest, UpdateLeverageRequest, VaultTransferRequest } from "../types/exchange/requests";
+import type { OrderParms } from "../types/exchange/common";
+/** Record of action types and their corresponding sorters. */
+export declare const sorters: {
+    batchModify: (action: BatchModifyRequest["action"]) => BatchModifyRequest["action"];
+    cancel: (action: CancelRequest["action"]) => CancelRequest["action"];
+    cancelByCloid: (action: CancelByCloidRequest["action"]) => CancelByCloidRequest["action"];
+    createSubAccount: (action: CreateSubAccountRequest["action"]) => CreateSubAccountRequest["action"];
+    modify: (action: ModifyRequest["action"]) => ModifyRequest["action"];
+    order: (action: OrderRequest["action"]) => OrderRequest["action"];
+    scheduleCancel: (action: ScheduleCancelRequest["action"]) => ScheduleCancelRequest["action"];
+    setReferrer: (action: SetReferrerRequest["action"]) => SetReferrerRequest["action"];
+    subAccountTransfer: (action: SubAccountTransferRequest["action"]) => SubAccountTransferRequest["action"];
+    twapCancel: (action: TwapCancelRequest["action"]) => TwapCancelRequest["action"];
+    twapOrder: (action: TwapOrderRequest["action"]) => TwapOrderRequest["action"];
+    updateIsolatedMargin: (action: UpdateIsolatedMarginRequest["action"]) => UpdateIsolatedMarginRequest["action"];
+    updateLeverage: (action: UpdateLeverageRequest["action"]) => UpdateLeverageRequest["action"];
+    vaultTransfer: (action: VaultTransferRequest["action"]) => VaultTransferRequest["action"];
+    _order: (order: OrderParms) => OrderParms;
+};
+//# sourceMappingURL=key_sort.d.ts.map

package/esm/src/utils/key_sort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key_sort.d.ts","sourceRoot":"","sources":["../../../src/src/utils/key_sort.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,uBAAuB,EACvB,aAAa,EACb,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,2BAA2B,EAC3B,qBAAqB,EACrB,oBAAoB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAE3D,8DAA8D;AAE9D,eAAO,MAAM,OAAO;0BACM,kBAAkB,CAAC,QAAQ,CAAC,KAAG,kBAAkB,CAAC,QAAQ,CAAC;qBAOhE,aAAa,CAAC,QAAQ,CAAC,KAAG,aAAa,CAAC,QAAQ,CAAC;4BAO1C,oBAAoB,CAAC,QAAQ,CAAC,KAAG,oBAAoB,CAAC,QAAQ,CAAC;+BAO5D,uBAAuB,CAAC,QAAQ,CAAC,KAAG,uBAAuB,CAAC,QAAQ,CAAC;qBAI/E,aAAa,CAAC,QAAQ,CAAC,KAAG,aAAa,CAAC,QAAQ,CAAC;oBAKlD,YAAY,CAAC,QAAQ,CAAC,KAAG,YAAY,CAAC,QAAQ,CAAC;6BAUtC,qBAAqB,CAAC,QAAQ,CAAC,KAAG,qBAAqB,CAAC,QAAQ,CAAC;0BAQpE,kBAAkB,CAAC,QAAQ,CAAC,KAAG,kBAAkB,CAAC,QAAQ,CAAC;iCAIpD,yBAAyB,CAAC,QAAQ,CAAC,KAAG,yBAAyB,CAAC,QAAQ,CAAC;yBAMjF,iBAAiB,CAAC,QAAQ,CAAC,KAAG,iBAAiB,CAAC,QAAQ,CAAC;wBAK1D,gBAAgB,CAAC,QAAQ,CAAC,KAAG,gBAAgB,CAAC,QAAQ,CAAC;mCAW5C,2BAA2B,CAAC,QAAQ,CAAC,KAAG,2BAA2B,CAAC,QAAQ,CAAC;6BAMnF,qBAAqB,CAAC,QAAQ,CAAC,KAAG,qBAAqB,CAAC,QAAQ,CAAC;4BAMlE,oBAAoB,CAAC,QAAQ,CAAC,KAAG,oBAAoB,CAAC,QAAQ,CAAC;oBAOvE,UAAU,KAAG,UAAU;CAyB1C,CAAC"}

package/esm/src/utils/key_sort.js

@@ -0,0 +1,124 @@
+/** Record of action types and their corresponding sorters. */
+// NOTE: An object after sorting must not contain undefined values.
+export const sorters = {
+    batchModify: (action) => ({
+        type: action.type,
+        modifies: action.modifies.map((m) => ({
+            oid: m.oid,
+            order: sorters._order(m.order),
+        })),
+    }),
+    cancel: (action) => ({
+        type: action.type,
+        cancels: action.cancels.map((c) => ({
+            a: c.a,
+            o: c.o,
+        })),
+    }),
+    cancelByCloid: (action) => ({
+        type: action.type,
+        cancels: action.cancels.map((cancel) => ({
+            asset: cancel.asset,
+            cloid: cancel.cloid,
+        })),
+    }),
+    createSubAccount: (action) => ({
+        type: action.type,
+        name: action.name,
+    }),
+    modify: (action) => ({
+        type: action.type,
+        oid: action.oid,
+        order: sorters._order(action.order),
+    }),
+    order: (action) => {
+        const sortedAction = {
+            type: action.type,
+            orders: action.orders.map(sorters._order),
+            grouping: action.grouping,
+            builder: action.builder ? { b: action.builder.b, f: action.builder.f } : undefined,
+        };
+        if (action.builder === undefined)
+            delete sortedAction.builder;
+        return sortedAction;
+    },
+    scheduleCancel: (action) => {
+        const sortedAction = {
+            type: action.type,
+            time: action.time,
+        };
+        if (action.time === undefined)
+            delete sortedAction.time;
+        return sortedAction;
+    },
+    setReferrer: (action) => ({
+        type: action.type,
+        code: action.code,
+    }),
+    subAccountTransfer: (action) => ({
+        type: action.type,
+        subAccountUser: action.subAccountUser,
+        isDeposit: action.isDeposit,
+        usd: action.usd,
+    }),
+    twapCancel: (action) => ({
+        type: action.type,
+        a: action.a,
+        t: action.t,
+    }),
+    twapOrder: (action) => ({
+        type: action.type,
+        twap: {
+            a: action.twap.a,
+            b: action.twap.b,
+            s: action.twap.s,
+            r: action.twap.r,
+            m: action.twap.m,
+            t: action.twap.t,
+        },
+    }),
+    updateIsolatedMargin: (action) => ({
+        type: action.type,
+        asset: action.asset,
+        isBuy: action.isBuy,
+        ntli: action.ntli,
+    }),
+    updateLeverage: (action) => ({
+        type: action.type,
+        asset: action.asset,
+        isCross: action.isCross,
+        leverage: action.leverage,
+    }),
+    vaultTransfer: (action) => ({
+        type: action.type,
+        vaultAddress: action.vaultAddress,
+        isDeposit: action.isDeposit,
+        usd: action.usd,
+    }),
+    _order: (order) => {
+        const sortedOrder = {
+            a: order.a,
+            b: order.b,
+            p: order.p,
+            s: order.s,
+            r: order.r,
+            t: "limit" in order.t
+                ? {
+                    limit: {
+                        tif: order.t.limit.tif,
+                    },
+                }
+                : {
+                    trigger: {
+                        isMarket: order.t.trigger.isMarket,
+                        triggerPx: order.t.trigger.triggerPx,
+                        tpsl: order.t.trigger.tpsl,
+                    },
+                },
+            c: order.c,
+        };
+        if (order.c === undefined)
+            delete sortedOrder.c;
+        return sortedOrder;
+    },
+};

package/esm/src/utils/signing.d.ts

@@ -0,0 +1,109 @@
+import { type ValueType } from "../../deps/jsr.io/@std/msgpack/1.0.2/encode.js";
+type Hex = `0x${string}`;
+/** Abstract interface for a [ethers.js](https://docs.ethers.org/v6/api/providers/#Signer) signer. */
+export interface AbstractEthersSigner {
+    signTypedData(domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    }, types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    }, value: Record<string, unknown>): Promise<string>;
+}
+/** Abstract interface for a [ethers.js v5](https://docs.ethers.org/v5/api/providers/#Signer) signer. */
+export interface AbstractEthersV5Signer {
+    _signTypedData(domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    }, types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    }, value: Record<string, unknown>): Promise<string>;
+}
+/** Abstract interface for a [viem](https://viem.sh/docs/clients/wallet) wallet client. */
+export interface AbstractViemWalletClient {
+    signTypedData(params: {
+        domain: {
+            name: string;
+            version: string;
+            chainId: number;
+            verifyingContract: Hex;
+        };
+        types: {
+            [key: string]: {
+                name: string;
+                type: string;
+            }[];
+        };
+        primaryType: string;
+        message: Record<string, unknown>;
+    }): Promise<Hex>;
+}
+/**
+ * Create a hash of the action.
+ * @param action - The action to hash.
+ * @param nonce - The nonce of the action.
+ * @param vaultAddress - Optional vault address.
+ * @returns The hash of the action.
+ */
+export declare function createActionHash(action: ValueType, nonce: number, vaultAddress?: Hex): Hex;
+/**
+ * Sign an L1 action.
+ * @param wallet - The wallet to sign with.
+ * @param isTestnet - A boolean indicating if the action is for the testnet.
+ * @param action - The action to sign.
+ * @param nonce - The nonce of the action.
+ * @param vaultAddress - Optional vault address.
+ * @returns The signature.
+ */
+export declare function signL1Action(wallet: AbstractEthersSigner | AbstractEthersV5Signer | AbstractViemWalletClient, isTestnet: boolean, action: ValueType, nonce: number, vaultAddress?: Hex): Promise<{
+    r: Hex;
+    s: Hex;
+    v: number;
+}>;
+/**
+ * Sign a user-signed action.
+ * @param wallet - The wallet to sign with.
+ * @param action - The action to sign.
+ * @param types - The types of the action.
+ * @param chainId - The chain ID of the action.
+ * @returns The signature.
+ */
+export declare function signUserSignedAction(wallet: AbstractEthersSigner | AbstractEthersV5Signer | AbstractViemWalletClient, action: Record<string, unknown>, types: {
+    [key: string]: {
+        name: string;
+        type: string;
+    }[];
+}, chainId: number): Promise<{
+    r: Hex;
+    s: Hex;
+    v: number;
+}>;
+/**
+ * Checks if the given client is an abstract signer (ethers.js).
+ * @param client - The client to check.
+ * @returns A boolean indicating if the client is an abstract signer.
+ */
+export declare function isAbstractEthersSigner(client: unknown): client is AbstractEthersSigner;
+/**
+ * Checks if the given client is an abstract signer (ethers.js v5).
+ * @param client - The client to check.
+ * @returns A boolean indicating if the client is an abstract signer.
+ */
+export declare function isAbstractEthersV5Signer(client: unknown): client is AbstractEthersV5Signer;
+/**
+ * Checks if the given client is an abstract wallet client (viem).
+ * @param client - The client to check.
+ * @returns A boolean indicating if the client is an abstract wallet client.
+ */
+export declare function isAbstractViemWalletClient(client: unknown): client is AbstractViemWalletClient;
+export {};
+//# sourceMappingURL=signing.d.ts.map

package/esm/src/utils/signing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signing.d.ts","sourceRoot":"","sources":["../../../src/src/utils/signing.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAGxF,KAAK,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAEzB,qGAAqG;AACrG,MAAM,WAAW,oBAAoB;IACjC,aAAa,CACT,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,wGAAwG;AACxG,MAAM,WAAW,sBAAsB;IACnC,cAAc,CACV,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,0FAA0F;AAC1F,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,MAAM,EAAE;QAClB,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,GAAG,CAoB1F;AA+BD;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAC9B,MAAM,EAAE,oBAAoB,GAAG,sBAAsB,GAAG,wBAAwB,EAChF,SAAS,EAAE,OAAO,EAClB,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,GAAG,GACnB,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA+BxC;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACtC,MAAM,EAAE,oBAAoB,GAAG,sBAAsB,GAAG,wBAAwB,EAChF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,KAAK,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,EAC1D,OAAO,EAAE,MAAM,GAChB,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAoBxC;AAmBD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAItF;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F"}