@hfunlabs/hyperliquid 0.27.1 → 0.29.1-hfunlabs.1

package/esm/src/api/subscription/_methods/webData2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webData2.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/webData2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,iEAAiE;AACjE,eAAO,MAAM,eAAe;IAGtB,4BAA4B;;IAK5B,oBAAoB;;;;;kEAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,mDAAmD;AACnD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CAKtB,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAMhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,qBAAqB,CAAC,CAOhC"}

package/esm/src/api/subscription/_methods/webData2.js

@@ -0,0 +1,56 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } from "../../_schemas.js";
+import { WebData2Response } from "../../info/_methods/webData2.js";
+/** Subscription to comprehensive user and market data events. */
+export const WebData2Request = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("webData2"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to comprehensive user and market data events."));
+})();
+/** Event of comprehensive user and market data. */
+export const WebData2Event = /* @__PURE__ */ (() => {
+    return v.pipe(WebData2Response, v.description("Comprehensive user and market data."));
+})();
+/**
+ * Subscribe to comprehensive user and market data updates.
+ *
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ *
+ * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { webData2 } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await webData2(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function webData2(config, params, listener) {
+    const payload = v.parse(WebData2Request, { type: "webData2", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=webData2.js.map

package/esm/src/api/subscription/_methods/webData2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webData2.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/webData2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,iEAAiE;AACjE,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,mDAAmD;AACnD,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,gBAAgB,EAChB,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,QAAQ,CACtB,MAA0B,EAC1B,MAA0B,EAC1B,QAAuC;IAEvC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAgB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC5E,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/src/api/subscription/_methods/webData3.d.ts

@@ -0,0 +1,125 @@
+import * as v from "valibot";
+/** Subscription to comprehensive user and market data events. */
+export declare const WebData3Request: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"webData3", undefined>, v.DescriptionAction<"webData3", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "webData3";
+    user: `0x${string}`;
+}, "Subscription to comprehensive user and market data events.">]>;
+export type WebData3Request = v.InferOutput<typeof WebData3Request>;
+/** Event of comprehensive user and market data. */
+export declare const WebData3Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** User state information. */
+    readonly userState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Agent address if one exists. */
+        readonly agentAddress: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "Agent address if one exists.">]>;
+        /** Timestamp until which the agent is valid. */
+        readonly agentValidUntil: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null, "Timestamp until which the agent is valid.">]>;
+        /** Cumulative ledger value. */
+        readonly cumLedger: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Cumulative ledger value.">]>;
+        /** Server timestamp (in ms since epoch). */
+        readonly serverTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Server timestamp (in ms since epoch).">]>;
+        /** Whether this account is a vault. */
+        readonly isVault: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether this account is a vault.">]>;
+        /** User address. */
+        readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+        /** Whether the user has opted out of spot dusting. */
+        readonly optOutOfSpotDusting: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Whether the user has opted out of spot dusting.">]>;
+        /** Whether DEX abstraction is enabled. */
+        readonly dexAbstractionEnabled: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "Whether DEX abstraction is enabled.">]>;
+    }, undefined>, v.DescriptionAction<{
+        agentAddress: `0x${string}` | null;
+        agentValidUntil: number | null;
+        cumLedger: string;
+        serverTime: number;
+        isVault: boolean;
+        user: `0x${string}`;
+        optOutOfSpotDusting?: true | undefined;
+        dexAbstractionEnabled?: boolean | undefined;
+    }, "User state information.">]>;
+    /** Array of perpetual DEX states. */
+    readonly perpDexStates: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+        /** Total equity in vaults. */
+        readonly totalVaultEquity: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total equity in vaults.">]>;
+        /** Assets currently at their open interest cap. */
+        readonly perpsAtOpenInterestCap: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string[], "Array of perpetuals at open interest caps.">]>, undefined>, v.DescriptionAction<string[] | undefined, "Assets currently at their open interest cap.">]>;
+        /** Array of leading vaults. */
+        readonly leadingVaults: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            readonly address: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Vault address.">]>;
+            readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Vault name.">]>;
+        }, undefined>, v.DescriptionAction<{
+            address: `0x${string}`;
+            name: string;
+        }, "Vault that a user is leading.">]>, undefined>, v.DescriptionAction<{
+            address: `0x${string}`;
+            name: string;
+        }[], "Array of leading vaults for a user.">]>, undefined>, v.DescriptionAction<{
+            address: `0x${string}`;
+            name: string;
+        }[] | undefined, "Array of leading vaults.">]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        totalVaultEquity: string;
+        perpsAtOpenInterestCap?: string[] | undefined;
+        leadingVaults?: {
+            address: `0x${string}`;
+            name: string;
+        }[] | undefined;
+    }[], "Array of perpetual DEX states.">]>;
+}, undefined>, v.DescriptionAction<{
+    userState: {
+        agentAddress: `0x${string}` | null;
+        agentValidUntil: number | null;
+        cumLedger: string;
+        serverTime: number;
+        isVault: boolean;
+        user: `0x${string}`;
+        optOutOfSpotDusting?: true | undefined;
+        dexAbstractionEnabled?: boolean | undefined;
+    };
+    perpDexStates: {
+        totalVaultEquity: string;
+        perpsAtOpenInterestCap?: string[] | undefined;
+        leadingVaults?: {
+            address: `0x${string}`;
+            name: string;
+        }[] | undefined;
+    }[];
+}, "Comprehensive user and market data.">]>;
+export type WebData3Event = v.InferOutput<typeof WebData3Event>;
+import type { SubscriptionConfig } from "./_types.js";
+import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+/** Request parameters for the {@linkcode webData3} function. */
+export type WebData3Parameters = Omit<v.InferInput<typeof WebData3Request>, "type">;
+/**
+ * Subscribe to comprehensive user and market data updates.
+ *
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ *
+ * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { webData3 } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await webData3(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function webData3(config: SubscriptionConfig, params: WebData3Parameters, listener: (data: WebData3Event) => void): Promise<WebSocketSubscription>;
+//# sourceMappingURL=webData3.d.ts.map

package/esm/src/api/subscription/_methods/webData3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webData3.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/webData3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAU7B,iEAAiE;AACjE,eAAO,MAAM,eAAe;IAGtB,4BAA4B;;IAK5B,oBAAoB;;;;;kEAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,mDAAmD;AACnD,eAAO,MAAM,aAAa;IAGpB,8BAA8B;;QAG1B,mCAAmC;;QAKnC,gDAAgD;;QAKhD,+BAA+B;;QAK/B,4CAA4C;;QAK5C,uCAAuC;;QAKvC,oBAAoB;;QAKpB,sDAAsD;;QAKtD,0CAA0C;;;;;;;;;;;;IAQ9C,qCAAqC;;QAI/B,8BAA8B;;QAK9B,mDAAmD;;QAKnD,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CAYvC,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAMhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,qBAAqB,CAAC,CAOhC"}

package/esm/src/api/subscription/_methods/webData3.js

@@ -0,0 +1,86 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { LeadingVaultsResponse } from "../../info/_methods/leadingVaults.js";
+import { PerpsAtOpenInterestCapResponse } from "../../info/_methods/perpsAtOpenInterestCap.js";
+/** Subscription to comprehensive user and market data events. */
+export const WebData3Request = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("webData3"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to comprehensive user and market data events."));
+})();
+/** Event of comprehensive user and market data. */
+export const WebData3Event = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** User state information. */
+        userState: v.pipe(v.object({
+            /** Agent address if one exists. */
+            agentAddress: v.pipe(v.nullable(Address), v.description("Agent address if one exists.")),
+            /** Timestamp until which the agent is valid. */
+            agentValidUntil: v.pipe(v.nullable(UnsignedInteger), v.description("Timestamp until which the agent is valid.")),
+            /** Cumulative ledger value. */
+            cumLedger: v.pipe(UnsignedDecimal, v.description("Cumulative ledger value.")),
+            /** Server timestamp (in ms since epoch). */
+            serverTime: v.pipe(UnsignedInteger, v.description("Server timestamp (in ms since epoch).")),
+            /** Whether this account is a vault. */
+            isVault: v.pipe(v.boolean(), v.description("Whether this account is a vault.")),
+            /** User address. */
+            user: v.pipe(Address, v.description("User address.")),
+            /** Whether the user has opted out of spot dusting. */
+            optOutOfSpotDusting: v.pipe(v.optional(v.literal(true)), v.description("Whether the user has opted out of spot dusting.")),
+            /** Whether DEX abstraction is enabled. */
+            dexAbstractionEnabled: v.pipe(v.optional(v.boolean()), v.description("Whether DEX abstraction is enabled.")),
+        }), v.description("User state information.")),
+        /** Array of perpetual DEX states. */
+        perpDexStates: v.pipe(v.array(v.object({
+            /** Total equity in vaults. */
+            totalVaultEquity: v.pipe(UnsignedDecimal, v.description("Total equity in vaults.")),
+            /** Assets currently at their open interest cap. */
+            perpsAtOpenInterestCap: v.pipe(v.optional(PerpsAtOpenInterestCapResponse), v.description("Assets currently at their open interest cap.")),
+            /** Array of leading vaults. */
+            leadingVaults: v.pipe(v.optional(LeadingVaultsResponse), v.description("Array of leading vaults.")),
+        })), v.description("Array of perpetual DEX states.")),
+    }), v.description("Comprehensive user and market data."));
+})();
+/**
+ * Subscribe to comprehensive user and market data updates.
+ *
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ *
+ * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { webData3 } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await webData3(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function webData3(config, params, listener) {
+    const payload = v.parse(WebData3Request, { type: "webData3", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.userState.user === payload.user) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=webData3.js.map

package/esm/src/api/subscription/_methods/webData3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webData3.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/webData3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,8BAA8B,EAAE,MAAM,+CAA+C,CAAC;AAE/F,iEAAiE;AACjE,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,mDAAmD;AACnD,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,MAAM,CAAC;YACP,mCAAmC;YACnC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,gDAAgD;YAChD,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;YACD,+BAA+B;YAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,4CAA4C;YAC5C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;YACD,uCAAuC;YACvC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;YACD,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,sDAAsD;YACtD,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE;YACD,0CAA0C;YAC1C,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAC3B,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;QACD,qCAAqC;QACrC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;YACP,8BAA8B;YAC9B,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,mDAAmD;YACnD,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAC5B,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC,EAC1C,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;YACD,+BAA+B;YAC/B,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EACjC,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,QAAQ,CACtB,MAA0B,EAC1B,MAA0B,EAC1B,QAAuC;IAEvC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAgB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC5E,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YAC7C,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/src/api/subscription/client.d.ts

@@ -0,0 +1,139 @@
+import type { SubscriptionConfig } from "./_methods/_types.js";
+import type { WebSocketSubscription } from "../../transport/websocket/mod.js";
+import { type ActiveAssetCtxEvent, type ActiveAssetCtxParameters } from "./_methods/activeAssetCtx.js";
+import { type ActiveAssetDataEvent, type ActiveAssetDataParameters } from "./_methods/activeAssetData.js";
+import { type ActiveSpotAssetCtxEvent, type ActiveSpotAssetCtxParameters } from "./_methods/activeSpotAssetCtx.js";
+import { type AllDexsAssetCtxsEvent } from "./_methods/allDexsAssetCtxs.js";
+import { type AllDexsClearinghouseStateEvent, type AllDexsClearinghouseStateParameters } from "./_methods/allDexsClearinghouseState.js";
+import { type AllMidsEvent, type AllMidsParameters } from "./_methods/allMids.js";
+import { type AssetCtxsEvent, type AssetCtxsParameters } from "./_methods/assetCtxs.js";
+import { type BboEvent, type BboParameters } from "./_methods/bbo.js";
+import { type CandleEvent, type CandleParameters } from "./_methods/candle.js";
+import { type ClearinghouseStateEvent, type ClearinghouseStateParameters } from "./_methods/clearinghouseState.js";
+import { type ExplorerBlockEvent } from "./_methods/explorerBlock.js";
+import { type ExplorerTxsEvent } from "./_methods/explorerTxs.js";
+import { type L2BookEvent, type L2BookParameters } from "./_methods/l2Book.js";
+import { type NotificationEvent, type NotificationParameters } from "./_methods/notification.js";
+import { type OpenOrdersEvent, type OpenOrdersParameters } from "./_methods/openOrders.js";
+import { type OrderUpdatesEvent, type OrderUpdatesParameters } from "./_methods/orderUpdates.js";
+import { type SpotAssetCtxsEvent } from "./_methods/spotAssetCtxs.js";
+import { type SpotStateEvent, type SpotStateParameters } from "./_methods/spotState.js";
+import { type TradesEvent, type TradesParameters } from "./_methods/trades.js";
+import { type UserEventsEvent, type UserEventsParameters } from "./_methods/userEvents.js";
+import { type UserFillsEvent, type UserFillsParameters } from "./_methods/userFills.js";
+import { type UserFundingsEvent, type UserFundingsParameters } from "./_methods/userFundings.js";
+import { type UserHistoricalOrdersEvent, type UserHistoricalOrdersParameters } from "./_methods/userHistoricalOrders.js";
+import { type UserNonFundingLedgerUpdatesEvent, type UserNonFundingLedgerUpdatesParameters } from "./_methods/userNonFundingLedgerUpdates.js";
+import { type UserTwapHistoryEvent, type UserTwapHistoryParameters } from "./_methods/userTwapHistory.js";
+import { type UserTwapSliceFillsEvent, type UserTwapSliceFillsParameters } from "./_methods/userTwapSliceFills.js";
+import { type WebData2Event, type WebData2Parameters } from "./_methods/webData2.js";
+import { type WebData3Event, type WebData3Parameters } from "./_methods/webData3.js";
+/**
+ * A client for interacting with the Hyperliquid Subscription API.
+ */
+export declare class SubscriptionClient<C extends SubscriptionConfig = SubscriptionConfig> {
+    config_: C;
+    /**
+     * Creates an instance of the SubscriptionClient.
+     *
+     * @param args - Configuration for Exchange API requests. See {@link SubscriptionConfig}.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport(); // only `WebSocketTransport`
+     *
+     * const subsClient = new hl.SubscriptionClient({ transport });
+     * ```
+     */
+    constructor(config: C);
+    /** @see {@link activeAssetCtx} */
+    activeAssetCtx(params: ActiveAssetCtxParameters, listener: (data: ActiveAssetCtxEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link activeAssetData} */
+    activeAssetData(params: ActiveAssetDataParameters, listener: (data: ActiveAssetDataEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link activeSpotAssetCtx} */
+    activeSpotAssetCtx(params: ActiveSpotAssetCtxParameters, listener: (data: ActiveSpotAssetCtxEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link allDexsAssetCtxs} */
+    allDexsAssetCtxs(listener: (data: AllDexsAssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link allDexsClearinghouseState} */
+    allDexsClearinghouseState(params: AllDexsClearinghouseStateParameters, listener: (data: AllDexsClearinghouseStateEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link allMids} */
+    allMids(listener: (data: AllMidsEvent) => void): Promise<WebSocketSubscription>;
+    allMids(params: AllMidsParameters, listener: (data: AllMidsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link assetCtxs} */
+    assetCtxs(listener: (data: AssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+    assetCtxs(params: AssetCtxsParameters, listener: (data: AssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link bbo} */
+    bbo(params: BboParameters, listener: (data: BboEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link candle} */
+    candle(params: CandleParameters, listener: (data: CandleEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link clearinghouseState} */
+    clearinghouseState(params: ClearinghouseStateParameters, listener: (data: ClearinghouseStateEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link explorerBlock} */
+    explorerBlock(listener: (data: ExplorerBlockEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link explorerTxs} */
+    explorerTxs(listener: (data: ExplorerTxsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link l2Book} */
+    l2Book(params: L2BookParameters, listener: (data: L2BookEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link notification} */
+    notification(params: NotificationParameters, listener: (data: NotificationEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link openOrders} */
+    openOrders(params: OpenOrdersParameters, listener: (data: OpenOrdersEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link orderUpdates} */
+    orderUpdates(params: OrderUpdatesParameters, listener: (data: OrderUpdatesEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link spotAssetCtxs} */
+    spotAssetCtxs(listener: (data: SpotAssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link spotState} */
+    spotState(params: SpotStateParameters, listener: (data: SpotStateEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link trades} */
+    trades(params: TradesParameters, listener: (data: TradesEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userEvents} */
+    userEvents(params: UserEventsParameters, listener: (data: UserEventsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userFills} */
+    userFills(params: UserFillsParameters, listener: (data: UserFillsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userFundings} */
+    userFundings(params: UserFundingsParameters, listener: (data: UserFundingsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userHistoricalOrders} */
+    userHistoricalOrders(params: UserHistoricalOrdersParameters, listener: (data: UserHistoricalOrdersEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userNonFundingLedgerUpdates} */
+    userNonFundingLedgerUpdates(params: UserNonFundingLedgerUpdatesParameters, listener: (data: UserNonFundingLedgerUpdatesEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userTwapHistory} */
+    userTwapHistory(params: UserTwapHistoryParameters, listener: (data: UserTwapHistoryEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link userTwapSliceFills} */
+    userTwapSliceFills(params: UserTwapSliceFillsParameters, listener: (data: UserTwapSliceFillsEvent) => void): Promise<WebSocketSubscription>;
+    /** @see {@link webData2} */
+    webData2(params: WebData2Parameters, listener: (data: WebData2Event) => void): Promise<WebSocketSubscription>;
+    /** @see {@link webData3} */
+    webData3(params: WebData3Parameters, listener: (data: WebData3Event) => void): Promise<WebSocketSubscription>;
+}
+export type { SubscriptionConfig } from "./_methods/_types.js";
+export type { ActiveAssetCtxEvent as ActiveAssetCtxWsEvent, ActiveAssetCtxParameters as ActiveAssetCtxWsParameters, } from "./_methods/activeAssetCtx.js";
+export type { ActiveAssetDataEvent as ActiveAssetDataWsEvent, ActiveAssetDataParameters as ActiveAssetDataWsParameters, } from "./_methods/activeAssetData.js";
+export type { ActiveSpotAssetCtxEvent as ActiveSpotAssetCtxWsEvent, ActiveSpotAssetCtxParameters as ActiveSpotAssetCtxWsParameters, } from "./_methods/activeSpotAssetCtx.js";
+export type { AllDexsAssetCtxsEvent as AllDexsAssetCtxsWsEvent } from "./_methods/allDexsAssetCtxs.js";
+export type { AllDexsClearinghouseStateEvent as AllDexsClearinghouseStateWsEvent, AllDexsClearinghouseStateParameters as AllDexsClearinghouseStateWsParameters, } from "./_methods/allDexsClearinghouseState.js";
+export type { AllMidsEvent as AllMidsWsEvent, AllMidsParameters as AllMidsWsParameters } from "./_methods/allMids.js";
+export type { AssetCtxsEvent as AssetCtxsWsEvent, AssetCtxsParameters as AssetCtxsWsParameters, } from "./_methods/assetCtxs.js";
+export type { BboEvent as BboWsEvent, BboParameters as BboWsParameters } from "./_methods/bbo.js";
+export type { CandleEvent as CandleWsEvent, CandleParameters as CandleWsParameters } from "./_methods/candle.js";
+export type { ClearinghouseStateEvent as ClearinghouseStateWsEvent, ClearinghouseStateParameters as ClearinghouseStateWsParameters, } from "./_methods/clearinghouseState.js";
+export type { ExplorerBlockEvent as ExplorerBlockWsEvent } from "./_methods/explorerBlock.js";
+export type { ExplorerTxsEvent as ExplorerTxsWsEvent } from "./_methods/explorerTxs.js";
+export type { L2BookEvent as L2BookWsEvent, L2BookParameters as L2BookWsParameters } from "./_methods/l2Book.js";
+export type { NotificationEvent as NotificationWsEvent, NotificationParameters as NotificationWsParameters, } from "./_methods/notification.js";
+export type { OpenOrdersEvent as OpenOrdersWsEvent, OpenOrdersParameters as OpenOrdersWsParameters, } from "./_methods/openOrders.js";
+export type { OrderUpdatesEvent as OrderUpdatesWsEvent, OrderUpdatesParameters as OrderUpdatesWsParameters, } from "./_methods/orderUpdates.js";
+export type { SpotAssetCtxsEvent as SpotAssetCtxsWsEvent } from "./_methods/spotAssetCtxs.js";
+export type { SpotStateEvent as SpotStateWsEvent, SpotStateParameters as SpotStateWsParameters, } from "./_methods/spotState.js";
+export type { TradesEvent as TradesWsEvent, TradesParameters as TradesWsParameters } from "./_methods/trades.js";
+export type { UserEventsEvent as UserEventsWsEvent, UserEventsParameters as UserEventsWsParameters, } from "./_methods/userEvents.js";
+export type { UserFillsEvent as UserFillsWsEvent, UserFillsParameters as UserFillsWsParameters, } from "./_methods/userFills.js";
+export type { UserFundingsEvent as UserFundingsWsEvent, UserFundingsParameters as UserFundingsWsParameters, } from "./_methods/userFundings.js";
+export type { UserHistoricalOrdersEvent as UserHistoricalOrdersWsEvent, UserHistoricalOrdersParameters as UserHistoricalOrdersWsParameters, } from "./_methods/userHistoricalOrders.js";
+export type { UserNonFundingLedgerUpdatesEvent as UserNonFundingLedgerUpdatesWsEvent, UserNonFundingLedgerUpdatesParameters as UserNonFundingLedgerUpdatesWsParameters, } from "./_methods/userNonFundingLedgerUpdates.js";
+export type { UserTwapHistoryEvent as UserTwapHistoryWsEvent, UserTwapHistoryParameters as UserTwapHistoryWsParameters, } from "./_methods/userTwapHistory.js";
+export type { UserTwapSliceFillsEvent as UserTwapSliceFillsWsEvent, UserTwapSliceFillsParameters as UserTwapSliceFillsWsParameters, } from "./_methods/userTwapSliceFills.js";
+export type { WebData2Event as WebData2WsEvent, WebData2Parameters as WebData2WsParameters, } from "./_methods/webData2.js";
+export type { WebData3Event as WebData3WsEvent, WebData3Parameters as WebData3WsParameters, } from "./_methods/webData3.js";
+//# sourceMappingURL=client.d.ts.map

package/esm/src/api/subscription/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAM9E,OAAO,EAAkB,KAAK,mBAAmB,EAAE,KAAK,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACvH,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC/B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEL,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EAClC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAoB,KAAK,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC9F,OAAO,EAEL,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACzC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAW,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,EAAa,KAAK,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnG,OAAO,EAAO,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAU,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAEL,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EAClC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAiB,KAAK,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAU,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAgB,KAAK,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAC/G,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACvG,OAAO,EAAgB,KAAK,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAC/G,OAAO,EAAiB,KAAK,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAa,KAAK,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnG,OAAO,EAAU,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACvG,OAAO,EAAa,KAAK,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnG,OAAO,EAAgB,KAAK,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAC/G,OAAO,EAEL,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,EACpC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAEL,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAC3C,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC/B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEL,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EAClC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAY,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAY,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAM/F;;GAEG;AACH,qBAAa,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB;IAC/E,OAAO,EAAE,CAAC,CAAC;IAEX;;;;;;;;;;;;;OAaG;gBACS,MAAM,EAAE,CAAC;IAIrB,kCAAkC;IAClC,cAAc,CACZ,MAAM,EAAE,wBAAwB,EAChC,QAAQ,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,GAC5C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,mCAAmC;IACnC,eAAe,CACb,MAAM,EAAE,yBAAyB,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,GAC7C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,sCAAsC;IACtC,kBAAkB,CAChB,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,oCAAoC;IACpC,gBAAgB,CACd,QAAQ,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,GAC9C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,6CAA6C;IAC7C,yBAAyB,CACvB,MAAM,EAAE,mCAAmC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,IAAI,GACvD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,2BAA2B;IAC3B,OAAO,CACL,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,qBAAqB,CAAC;IACjC,OAAO,CACL,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,qBAAqB,CAAC;IAUjC,6BAA6B;IAC7B,SAAS,CACP,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC;IACjC,SAAS,CACP,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC;IAUjC,uBAAuB;IACvB,GAAG,CACD,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GACjC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,0BAA0B;IAC1B,MAAM,CACJ,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,sCAAsC;IACtC,kBAAkB,CAChB,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,iCAAiC;IACjC,aAAa,CACX,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,GAC3C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,+BAA+B;IAC/B,WAAW,CACT,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,GACzC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,0BAA0B;IAC1B,MAAM,CACJ,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,gCAAgC;IAChC,YAAY,CACV,MAAM,EAAE,sBAAsB,EAC9B,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,8BAA8B;IAC9B,UAAU,CACR,MAAM,EAAE,oBAAoB,EAC5B,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GACxC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,gCAAgC;IAChC,YAAY,CACV,MAAM,EAAE,sBAAsB,EAC9B,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,iCAAiC;IACjC,aAAa,CACX,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,GAC3C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,6BAA6B;IAC7B,SAAS,CACP,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,0BAA0B;IAC1B,MAAM,CACJ,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,8BAA8B;IAC9B,UAAU,CACR,MAAM,EAAE,oBAAoB,EAC5B,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GACxC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,6BAA6B;IAC7B,SAAS,CACP,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,gCAAgC;IAChC,YAAY,CACV,MAAM,EAAE,sBAAsB,EAC9B,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,wCAAwC;IACxC,oBAAoB,CAClB,MAAM,EAAE,8BAA8B,EACtC,QAAQ,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,GAClD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,+CAA+C;IAC/C,2BAA2B,CACzB,MAAM,EAAE,qCAAqC,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,gCAAgC,KAAK,IAAI,GACzD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,mCAAmC;IACnC,eAAe,CACb,MAAM,EAAE,yBAAyB,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,GAC7C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,sCAAsC;IACtC,kBAAkB,CAChB,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,qBAAqB,CAAC;IAIjC,4BAA4B;IAC5B,QAAQ,CACN,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,4BAA4B;IAC5B,QAAQ,CACN,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,qBAAqB,CAAC;CAGlC;AAMD,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,YAAY,EACV,mBAAmB,IAAI,qBAAqB,EAC5C,wBAAwB,IAAI,0BAA0B,GACvD,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,oBAAoB,IAAI,sBAAsB,EAC9C,yBAAyB,IAAI,2BAA2B,GACzD,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,kCAAkC,CAAC;AAC1C,YAAY,EAAE,qBAAqB,IAAI,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACvG,YAAY,EACV,8BAA8B,IAAI,gCAAgC,EAClE,mCAAmC,IAAI,qCAAqC,GAC7E,MAAM,yCAAyC,CAAC;AACjD,YAAY,EAAE,YAAY,IAAI,cAAc,EAAE,iBAAiB,IAAI,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACtH,YAAY,EACV,cAAc,IAAI,gBAAgB,EAClC,mBAAmB,IAAI,qBAAqB,GAC7C,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,QAAQ,IAAI,UAAU,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAClG,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACjH,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,kCAAkC,CAAC;AAC1C,YAAY,EAAE,kBAAkB,IAAI,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAC9F,YAAY,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACxF,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACjH,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,eAAe,IAAI,iBAAiB,EACpC,oBAAoB,IAAI,sBAAsB,GAC/C,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,kBAAkB,IAAI,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAC9F,YAAY,EACV,cAAc,IAAI,gBAAgB,EAClC,mBAAmB,IAAI,qBAAqB,GAC7C,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACjH,YAAY,EACV,eAAe,IAAI,iBAAiB,EACpC,oBAAoB,IAAI,sBAAsB,GAC/C,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,cAAc,IAAI,gBAAgB,EAClC,mBAAmB,IAAI,qBAAqB,GAC7C,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,yBAAyB,IAAI,2BAA2B,EACxD,8BAA8B,IAAI,gCAAgC,GACnE,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EACV,gCAAgC,IAAI,kCAAkC,EACtE,qCAAqC,IAAI,uCAAuC,GACjF,MAAM,2CAA2C,CAAC;AACnD,YAAY,EACV,oBAAoB,IAAI,sBAAsB,EAC9C,yBAAyB,IAAI,2BAA2B,GACzD,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,kCAAkC,CAAC;AAC1C,YAAY,EACV,aAAa,IAAI,eAAe,EAChC,kBAAkB,IAAI,oBAAoB,GAC3C,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,aAAa,IAAI,eAAe,EAChC,kBAAkB,IAAI,oBAAoB,GAC3C,MAAM,wBAAwB,CAAC"}

package/esm/src/api/subscription/client.js

@@ -0,0 +1,172 @@
+// =============================================================
+// Methods Imports
+// =============================================================
+import { activeAssetCtx } from "./_methods/activeAssetCtx.js";
+import { activeAssetData, } from "./_methods/activeAssetData.js";
+import { activeSpotAssetCtx, } from "./_methods/activeSpotAssetCtx.js";
+import { allDexsAssetCtxs } from "./_methods/allDexsAssetCtxs.js";
+import { allDexsClearinghouseState, } from "./_methods/allDexsClearinghouseState.js";
+import { allMids } from "./_methods/allMids.js";
+import { assetCtxs } from "./_methods/assetCtxs.js";
+import { bbo } from "./_methods/bbo.js";
+import { candle } from "./_methods/candle.js";
+import { clearinghouseState, } from "./_methods/clearinghouseState.js";
+import { explorerBlock } from "./_methods/explorerBlock.js";
+import { explorerTxs } from "./_methods/explorerTxs.js";
+import { l2Book } from "./_methods/l2Book.js";
+import { notification } from "./_methods/notification.js";
+import { openOrders } from "./_methods/openOrders.js";
+import { orderUpdates } from "./_methods/orderUpdates.js";
+import { spotAssetCtxs } from "./_methods/spotAssetCtxs.js";
+import { spotState } from "./_methods/spotState.js";
+import { trades } from "./_methods/trades.js";
+import { userEvents } from "./_methods/userEvents.js";
+import { userFills } from "./_methods/userFills.js";
+import { userFundings } from "./_methods/userFundings.js";
+import { userHistoricalOrders, } from "./_methods/userHistoricalOrders.js";
+import { userNonFundingLedgerUpdates, } from "./_methods/userNonFundingLedgerUpdates.js";
+import { userTwapHistory, } from "./_methods/userTwapHistory.js";
+import { userTwapSliceFills, } from "./_methods/userTwapSliceFills.js";
+import { webData2 } from "./_methods/webData2.js";
+import { webData3 } from "./_methods/webData3.js";
+// =============================================================
+// Client
+// =============================================================
+/**
+ * A client for interacting with the Hyperliquid Subscription API.
+ */
+export class SubscriptionClient {
+    config_;
+    /**
+     * Creates an instance of the SubscriptionClient.
+     *
+     * @param args - Configuration for Exchange API requests. See {@link SubscriptionConfig}.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport(); // only `WebSocketTransport`
+     *
+     * const subsClient = new hl.SubscriptionClient({ transport });
+     * ```
+     */
+    constructor(config) {
+        this.config_ = config;
+    }
+    /** @see {@link activeAssetCtx} */
+    activeAssetCtx(params, listener) {
+        return activeAssetCtx(this.config_, params, listener);
+    }
+    /** @see {@link activeAssetData} */
+    activeAssetData(params, listener) {
+        return activeAssetData(this.config_, params, listener);
+    }
+    /** @see {@link activeSpotAssetCtx} */
+    activeSpotAssetCtx(params, listener) {
+        return activeSpotAssetCtx(this.config_, params, listener);
+    }
+    /** @see {@link allDexsAssetCtxs} */
+    allDexsAssetCtxs(listener) {
+        return allDexsAssetCtxs(this.config_, listener);
+    }
+    /** @see {@link allDexsClearinghouseState} */
+    allDexsClearinghouseState(params, listener) {
+        return allDexsClearinghouseState(this.config_, params, listener);
+    }
+    allMids(paramsOrListener, maybeListener) {
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+        return allMids(this.config_, params, listener);
+    }
+    assetCtxs(paramsOrListener, maybeListener) {
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+        return assetCtxs(this.config_, params, listener);
+    }
+    /** @see {@link bbo} */
+    bbo(params, listener) {
+        return bbo(this.config_, params, listener);
+    }
+    /** @see {@link candle} */
+    candle(params, listener) {
+        return candle(this.config_, params, listener);
+    }
+    /** @see {@link clearinghouseState} */
+    clearinghouseState(params, listener) {
+        return clearinghouseState(this.config_, params, listener);
+    }
+    /** @see {@link explorerBlock} */
+    explorerBlock(listener) {
+        return explorerBlock(this.config_, listener);
+    }
+    /** @see {@link explorerTxs} */
+    explorerTxs(listener) {
+        return explorerTxs(this.config_, listener);
+    }
+    /** @see {@link l2Book} */
+    l2Book(params, listener) {
+        return l2Book(this.config_, params, listener);
+    }
+    /** @see {@link notification} */
+    notification(params, listener) {
+        return notification(this.config_, params, listener);
+    }
+    /** @see {@link openOrders} */
+    openOrders(params, listener) {
+        return openOrders(this.config_, params, listener);
+    }
+    /** @see {@link orderUpdates} */
+    orderUpdates(params, listener) {
+        return orderUpdates(this.config_, params, listener);
+    }
+    /** @see {@link spotAssetCtxs} */
+    spotAssetCtxs(listener) {
+        return spotAssetCtxs(this.config_, listener);
+    }
+    /** @see {@link spotState} */
+    spotState(params, listener) {
+        return spotState(this.config_, params, listener);
+    }
+    /** @see {@link trades} */
+    trades(params, listener) {
+        return trades(this.config_, params, listener);
+    }
+    /** @see {@link userEvents} */
+    userEvents(params, listener) {
+        return userEvents(this.config_, params, listener);
+    }
+    /** @see {@link userFills} */
+    userFills(params, listener) {
+        return userFills(this.config_, params, listener);
+    }
+    /** @see {@link userFundings} */
+    userFundings(params, listener) {
+        return userFundings(this.config_, params, listener);
+    }
+    /** @see {@link userHistoricalOrders} */
+    userHistoricalOrders(params, listener) {
+        return userHistoricalOrders(this.config_, params, listener);
+    }
+    /** @see {@link userNonFundingLedgerUpdates} */
+    userNonFundingLedgerUpdates(params, listener) {
+        return userNonFundingLedgerUpdates(this.config_, params, listener);
+    }
+    /** @see {@link userTwapHistory} */
+    userTwapHistory(params, listener) {
+        return userTwapHistory(this.config_, params, listener);
+    }
+    /** @see {@link userTwapSliceFills} */
+    userTwapSliceFills(params, listener) {
+        return userTwapSliceFills(this.config_, params, listener);
+    }
+    /** @see {@link webData2} */
+    webData2(params, listener) {
+        return webData2(this.config_, params, listener);
+    }
+    /** @see {@link webData3} */
+    webData3(params, listener) {
+        return webData3(this.config_, params, listener);
+    }
+}
+//# sourceMappingURL=client.js.map