@nktkas/hyperliquid 0.13.0

package/esm/deps/jsr.io/@std/msgpack/1.0.2/encode.js

@@ -0,0 +1,237 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+import { concat } from "../../bytes/1.0.4/concat.js";
+const FOUR_BITS = 16;
+const FIVE_BITS = 32;
+const SEVEN_BITS = 128;
+const EIGHT_BITS = 256;
+const FIFTEEN_BITS = 32768;
+const SIXTEEN_BITS = 65536;
+const THIRTY_ONE_BITS = 2147483648;
+const THIRTY_TWO_BITS = 4294967296;
+const SIXTY_THREE_BITS = 9223372036854775808n;
+const SIXTY_FOUR_BITS = 18446744073709551616n;
+const encoder = new TextEncoder();
+/**
+ * Encode a value to {@link https://msgpack.org/ | MessagePack} binary format.
+ *
+ * @example Usage
+ * ```ts
+ * import { encode } from "@std/msgpack/encode";
+ * import { assertEquals } from "@std/assert";
+ *
+ * const obj = {
+ *   str: "deno",
+ *   arr: [1, 2, 3],
+ *   map: {
+ *     foo: "bar"
+ *   }
+ * }
+ *
+ * const encoded = encode(obj);
+ *
+ * assertEquals(encoded.length, 31);
+ * ```
+ *
+ * @param object Value to encode to MessagePack binary format.
+ * @returns Encoded MessagePack binary data.
+ */
+export function encode(object) {
+    const byteParts = [];
+    encodeSlice(object, byteParts);
+    return concat(byteParts);
+}
+function encodeFloat64(num) {
+    const dataView = new DataView(new ArrayBuffer(9));
+    dataView.setFloat64(1, num);
+    dataView.setUint8(0, 0xcb);
+    return new Uint8Array(dataView.buffer);
+}
+function encodeNumber(num) {
+    if (!Number.isInteger(num)) { // float 64
+        return encodeFloat64(num);
+    }
+    if (num < 0) {
+        if (num >= -FIVE_BITS) { // negative fixint
+            return new Uint8Array([num]);
+        }
+        if (num >= -SEVEN_BITS) { // int 8
+            return new Uint8Array([0xd0, num]);
+        }
+        if (num >= -FIFTEEN_BITS) { // int 16
+            const dataView = new DataView(new ArrayBuffer(3));
+            dataView.setInt16(1, num);
+            dataView.setUint8(0, 0xd1);
+            return new Uint8Array(dataView.buffer);
+        }
+        if (num >= -THIRTY_ONE_BITS) { // int 32
+            const dataView = new DataView(new ArrayBuffer(5));
+            dataView.setInt32(1, num);
+            dataView.setUint8(0, 0xd2);
+            return new Uint8Array(dataView.buffer);
+        }
+        // float 64
+        return encodeFloat64(num);
+    }
+    // if the number fits within a positive fixint, use it
+    if (num <= 0x7f) {
+        return new Uint8Array([num]);
+    }
+    if (num < EIGHT_BITS) { // uint8
+        return new Uint8Array([0xcc, num]);
+    }
+    if (num < SIXTEEN_BITS) { // uint16
+        const dataView = new DataView(new ArrayBuffer(3));
+        dataView.setUint16(1, num);
+        dataView.setUint8(0, 0xcd);
+        return new Uint8Array(dataView.buffer);
+    }
+    if (num < THIRTY_TWO_BITS) { // uint32
+        const dataView = new DataView(new ArrayBuffer(5));
+        dataView.setUint32(1, num);
+        dataView.setUint8(0, 0xce);
+        return new Uint8Array(dataView.buffer);
+    }
+    // float 64
+    return encodeFloat64(num);
+}
+function encodeSlice(object, byteParts) {
+    if (object === null) {
+        byteParts.push(new Uint8Array([0xc0]));
+        return;
+    }
+    if (object === false) {
+        byteParts.push(new Uint8Array([0xc2]));
+        return;
+    }
+    if (object === true) {
+        byteParts.push(new Uint8Array([0xc3]));
+        return;
+    }
+    if (typeof object === "number") {
+        byteParts.push(encodeNumber(object));
+        return;
+    }
+    if (typeof object === "bigint") {
+        if (object < 0) {
+            if (object < -SIXTY_THREE_BITS) {
+                throw new Error("Cannot safely encode bigint larger than 64 bits");
+            }
+            const dataView = new DataView(new ArrayBuffer(9));
+            dataView.setBigInt64(1, object);
+            dataView.setUint8(0, 0xd3);
+            byteParts.push(new Uint8Array(dataView.buffer));
+            return;
+        }
+        if (object >= SIXTY_FOUR_BITS) {
+            throw new Error("Cannot safely encode bigint larger than 64 bits");
+        }
+        const dataView = new DataView(new ArrayBuffer(9));
+        dataView.setBigUint64(1, object);
+        dataView.setUint8(0, 0xcf);
+        byteParts.push(new Uint8Array(dataView.buffer));
+        return;
+    }
+    if (typeof object === "string") {
+        const encoded = encoder.encode(object);
+        const len = encoded.length;
+        if (len < FIVE_BITS) { // fixstr
+            byteParts.push(new Uint8Array([0xa0 | len]));
+        }
+        else if (len < EIGHT_BITS) { // str 8
+            byteParts.push(new Uint8Array([0xd9, len]));
+        }
+        else if (len < SIXTEEN_BITS) { // str 16
+            const dataView = new DataView(new ArrayBuffer(3));
+            dataView.setUint16(1, len);
+            dataView.setUint8(0, 0xda);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else if (len < THIRTY_TWO_BITS) { // str 32
+            const dataView = new DataView(new ArrayBuffer(5));
+            dataView.setUint32(1, len);
+            dataView.setUint8(0, 0xdb);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else {
+            throw new Error("Cannot safely encode string with size larger than 32 bits");
+        }
+        byteParts.push(encoded);
+        return;
+    }
+    if (object instanceof Uint8Array) {
+        if (object.length < EIGHT_BITS) { // bin 8
+            byteParts.push(new Uint8Array([0xc4, object.length]));
+        }
+        else if (object.length < SIXTEEN_BITS) { // bin 16
+            const dataView = new DataView(new ArrayBuffer(3));
+            dataView.setUint16(1, object.length);
+            dataView.setUint8(0, 0xc5);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else if (object.length < THIRTY_TWO_BITS) { // bin 32
+            const dataView = new DataView(new ArrayBuffer(5));
+            dataView.setUint32(1, object.length);
+            dataView.setUint8(0, 0xc6);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else {
+            throw new Error("Cannot safely encode Uint8Array with size larger than 32 bits");
+        }
+        byteParts.push(object);
+        return;
+    }
+    if (Array.isArray(object)) {
+        if (object.length < FOUR_BITS) { // fixarray
+            byteParts.push(new Uint8Array([0x90 | object.length]));
+        }
+        else if (object.length < SIXTEEN_BITS) { // array 16
+            const dataView = new DataView(new ArrayBuffer(3));
+            dataView.setUint16(1, object.length);
+            dataView.setUint8(0, 0xdc);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else if (object.length < THIRTY_TWO_BITS) { // array 32
+            const dataView = new DataView(new ArrayBuffer(5));
+            dataView.setUint32(1, object.length);
+            dataView.setUint8(0, 0xdd);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else {
+            throw new Error("Cannot safely encode array with size larger than 32 bits");
+        }
+        for (const obj of object) {
+            encodeSlice(obj, byteParts);
+        }
+        return;
+    }
+    // If object is a plain object
+    const prototype = Object.getPrototypeOf(object);
+    if (prototype === null || prototype === Object.prototype) {
+        const numKeys = Object.keys(object).length;
+        if (numKeys < FOUR_BITS) { // fixarray
+            byteParts.push(new Uint8Array([0x80 | numKeys]));
+        }
+        else if (numKeys < SIXTEEN_BITS) { // map 16
+            const dataView = new DataView(new ArrayBuffer(3));
+            dataView.setUint16(1, numKeys);
+            dataView.setUint8(0, 0xde);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else if (numKeys < THIRTY_TWO_BITS) { // map 32
+            const dataView = new DataView(new ArrayBuffer(5));
+            dataView.setUint32(1, numKeys);
+            dataView.setUint8(0, 0xdf);
+            byteParts.push(new Uint8Array(dataView.buffer));
+        }
+        else {
+            throw new Error("Cannot safely encode map with size larger than 32 bits");
+        }
+        for (const [key, value] of Object.entries(object)) {
+            encodeSlice(key, byteParts);
+            encodeSlice(value, byteParts);
+        }
+        return;
+    }
+    throw new Error("Cannot safely encode value into messagepack");
+}

package/esm/mod.d.ts

@@ -0,0 +1,24 @@
+export * from "./src/clients/event.js";
+export * from "./src/clients/public.js";
+export * from "./src/clients/wallet.js";
+export * from "./src/transports/base.js";
+export * from "./src/transports/http/http_transport.js";
+export * from "./src/transports/websocket/websocket_transport.js";
+export type { MessageBufferStrategy, ReconnectingWebSocketOptions, } from "./src/transports/websocket/reconnecting_websocket.js";
+export { WebSocketRequestError } from "./src/transports/websocket/websocket_request_dispatcher.js";
+export type * from "./src/types/common";
+export type * from "./src/types/exchange/common";
+export type * from "./src/types/exchange/requests";
+export type * from "./src/types/exchange/responses";
+export type * from "./src/types/explorer/common";
+export type * from "./src/types/explorer/requests";
+export type * from "./src/types/explorer/responses";
+export type * from "./src/types/info/accounts";
+export type * from "./src/types/info/assets";
+export type * from "./src/types/info/orders";
+export type * from "./src/types/info/requests";
+export type * from "./src/types/info/vaults";
+export type * from "./src/types/subscriptions/common";
+export type * from "./src/types/subscriptions/requests";
+export type { AbstractEthersSigner, AbstractEthersV5Signer, AbstractViemWalletClient } from "./src/utils/signing.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AAGxC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,yCAAyC,CAAC;AAExD,cAAc,mDAAmD,CAAC;AAClE,YAAY,EACR,qBAAqB,EACrB,4BAA4B,GAC/B,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4DAA4D,CAAC;AAGnG,mBAAmB,oBAAoB,CAAC;AAExC,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,gCAAgC,CAAC;AAEpD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,gCAAgC,CAAC;AAEpD,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,yBAAyB,CAAC;AAE7C,mBAAmB,kCAAkC,CAAC;AACtD,mBAAmB,oCAAoC,CAAC;AAGxD,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC"}

package/esm/mod.js

@@ -0,0 +1,9 @@
+// Clients
+export * from "./src/clients/event.js";
+export * from "./src/clients/public.js";
+export * from "./src/clients/wallet.js";
+// Transports
+export * from "./src/transports/base.js";
+export * from "./src/transports/http/http_transport.js";
+export * from "./src/transports/websocket/websocket_transport.js";
+export { WebSocketRequestError } from "./src/transports/websocket/websocket_request_dispatcher.js";

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/src/clients/event.d.ts

@@ -0,0 +1,374 @@
+import type { ISubscriptionTransport, Subscription } from "../transports/base.js";
+import type { WsActiveAssetCtxRequest, WsActiveAssetDataRequest, WsCandleRequest, WsL2BookRequest, WsNotificationRequest, WsOrderUpdatesRequest, WsTradesRequest, WsUserEventsRequest, WsUserFillsRequest, WsUserFundingsRequest, WsUserNonFundingLedgerUpdatesRequest, WsUserTwapHistoryRequest, WsUserTwapSliceFillsRequest, WsWebData2Request } from "../types/subscriptions/requests";
+import type { WsActiveAssetCtx, WsActiveAssetData, WsActiveSpotAssetCtx, WsAllMids, WsNotification, WsTrade, WsUserEvent, WsUserFills, WsUserFundings, WsUserNonFundingLedgerUpdates, WsUserTwapHistory, WsUserTwapSliceFills, WsWebData2 } from "../types/subscriptions/common";
+import type { Candle } from "../types/info/assets";
+import type { Book, Order, OrderStatus } from "../types/info/orders";
+/** Parameters for the {@linkcode EventClient} constructor. */
+export interface EventClientParameters<T extends ISubscriptionTransport = ISubscriptionTransport> {
+    /** The transport used to connect to the Hyperliquid API. */
+    transport: T;
+}
+/** Parameters for the {@linkcode EventClient.activeAssetCtx} method. */
+export type EventActiveAssetCtxParameters = Omit<WsActiveAssetCtxRequest, "type">;
+/** Parameters for the {@linkcode EventClient.activeAssetData} method. */
+export type EventActiveAssetDataParameters = Omit<WsActiveAssetDataRequest, "type">;
+/** Parameters for the {@linkcode EventClient.candle} method. */
+export type EventCandleParameters = Omit<WsCandleRequest, "type">;
+/** Parameters for the {@linkcode EventClient.l2Book} method. */
+export type EventL2BookParameters = Omit<WsL2BookRequest, "type">;
+/** Parameters for the {@linkcode EventClient.notification} method. */
+export type EventNotificationParameters = Omit<WsNotificationRequest, "type">;
+/** Parameters for the {@linkcode EventClient.orderUpdates} method. */
+export type EventOrderUpdatesParameters = Omit<WsOrderUpdatesRequest, "type">;
+/** Parameters for the {@linkcode EventClient.trades} method. */
+export type EventTradesParameters = Omit<WsTradesRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userEvents} method. */
+export type EventUserEventsParameters = Omit<WsUserEventsRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userFills} method. */
+export type EventUserFillsParameters = Omit<WsUserFillsRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userFundings} method. */
+export type EventUserFundingsParameters = Omit<WsUserFundingsRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userNonFundingLedgerUpdates} method. */
+export type EventUserNonFundingLedgerUpdatesParameters = Omit<WsUserNonFundingLedgerUpdatesRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userTwapHistory} method. */
+export type EventUserTwapHistory = Omit<WsUserTwapHistoryRequest, "type">;
+/** Parameters for the {@linkcode EventClient.userTwapSliceFills} method. */
+export type EventUserTwapSliceFills = Omit<WsUserTwapSliceFillsRequest, "type">;
+/** Parameters for the {@linkcode EventClient.webData2} method. */
+export type EventWebData2Parameters = Omit<WsWebData2Request, "type">;
+/**
+ * Event client for subscribing to various Hyperliquid events.
+ * @typeParam T - The type of transport used to connect to the Hyperliquid Websocket API.
+ */
+export declare class EventClient<T extends ISubscriptionTransport = ISubscriptionTransport> {
+    /** The transport used to connect to the Hyperliquid API. */
+    transport: T;
+    /**
+     * Initialises a new instance.
+     * @param args - The arguments for initialisation.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     * ```
+     */
+    constructor(args: EventClientParameters<T>);
+    /**
+     * Subscribe to context updates for a specific perpetual asset.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.activeAssetCtx({ coin: "BTC" }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to trading data updates for a specific asset and user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.activeAssetData({ coin: "BTC", user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: WsActiveAssetData) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to mid prices for all actively traded assets.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.allMids((data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    allMids(listener: (data: WsAllMids) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to candlestick data updates for a specific asset.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.candle({ coin: "BTC", interval: "1h" }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    candle(args: EventCandleParameters, listener: (data: Candle) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to L2 order book updates for a specific asset.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.l2Book({ coin: "BTC" }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    l2Book(args: EventL2BookParameters, listener: (data: Book) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to user notification.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.notification({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    notification(args: EventNotificationParameters, listener: (data: WsNotification) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to order status updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.orderUpdates({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    orderUpdates(args: EventOrderUpdatesParameters, listener: (data: OrderStatus<Order>[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to real-time trade updates for a specific asset.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.trades({ coin: "BTC" }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to all events for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userEvents({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userEvents(args: EventUserEventsParameters, listener: (data: WsUserEvent) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to trade fill updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userFills({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userFills(args: EventUserFillsParameters, listener: (data: WsUserFills) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to funding payment updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userFundings({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userFundings(args: EventUserFundingsParameters, listener: (data: WsUserFundings) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to non-funding ledger updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userNonFundingLedgerUpdates({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userNonFundingLedgerUpdates(args: EventUserNonFundingLedgerUpdatesParameters, listener: (data: WsUserNonFundingLedgerUpdates) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to TWAP order history updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userTwapHistory({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userTwapHistory(args: EventUserTwapHistory, listener: (data: WsUserTwapHistory) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to TWAP execution updates for a specific user.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.userTwapSliceFills({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    userTwapSliceFills(args: EventUserTwapSliceFills, listener: (data: WsUserTwapSliceFills) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to comprehensive user and market data updates.
+     * @param args - The parameters for the subscription.
+     * @param listener - The callback function to be called when the event is received.
+     * @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.
+     *
+     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.webData2({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    webData2(args: EventWebData2Parameters, listener: (data: WsWebData2) => void, signal?: AbortSignal): Promise<Subscription>;
+}
+//# sourceMappingURL=event.d.ts.map

package/esm/src/clients/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../src/src/clients/event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,KAAK,EACR,uBAAuB,EACvB,wBAAwB,EAExB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,oCAAoC,EACpC,wBAAwB,EACxB,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACR,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,OAAO,EACP,WAAW,EACX,WAAW,EACX,cAAc,EACd,6BAA6B,EAC7B,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACb,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAIrE,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,sBAAsB,GAAG,sBAAsB;IAC5F,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAElF,yEAAyE;AACzE,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAEpF,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,oEAAoE;AACpE,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAE1E,mEAAmE;AACnE,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAExE,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,qFAAqF;AACrF,MAAM,MAAM,0CAA0C,GAAG,IAAI,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;AAE5G,yEAAyE;AACzE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAE1E,4EAA4E;AAC5E,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;AAEhF,kEAAkE;AAClE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAItE;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC,SAAS,sBAAsB,GAAG,sBAAsB;IAC9E,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC;IAEb;;;;;;;;;;;OAWG;gBACS,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CACV,IAAI,EAAE,6BAA6B,EACnC,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,GAAG,oBAAoB,KAAK,IAAI,EACjE,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAkBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CACX,IAAI,EAAE,8BAA8B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,EAC3C,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAkBxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACH,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,EACnC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACF,IAAI,EAAE,qBAAqB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAChC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAkBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACF,IAAI,EAAE,qBAAqB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,EAC9B,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAmBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CACR,IAAI,EAAE,2BAA2B,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,EACxC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAexB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CACR,IAAI,EAAE,2BAA2B,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,EAC9C,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAexB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACF,IAAI,EAAE,qBAAqB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,EACnC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CACN,IAAI,EAAE,yBAAyB,EAC/B,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EACrC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAexB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACL,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,EACrC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAkBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CACR,IAAI,EAAE,2BAA2B,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,EACxC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2BAA2B,CACvB,IAAI,EAAE,0CAA0C,EAChD,QAAQ,EAAE,CAAC,IAAI,EAAE,6BAA6B,KAAK,IAAI,EACvD,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CACX,IAAI,EAAE,oBAAoB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,EAC3C,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAAkB,CACd,IAAI,EAAE,uBAAuB,EAC7B,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,EAC9C,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CACJ,IAAI,EAAE,uBAAuB,EAC7B,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,EACpC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,YAAY,CAAC;CAgB3B"}