@nktkas/hyperliquid 0.31.0 → 0.32.0

package/esm/api/subscription/_methods/allDexsAssetCtxs.d.ts

@@ -0,0 +1,48 @@
+import * as v from "valibot";
+import type { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
+/**
+ * Subscription to asset context events for all DEXs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const AllDexsAssetCtxsRequest: v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.LiteralSchema<"allDexsAssetCtxs", undefined>;
+}, undefined>;
+export type AllDexsAssetCtxsRequest = v.InferOutput<typeof AllDexsAssetCtxsRequest>;
+/**
+ * Event of asset contexts for all DEXs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export type AllDexsAssetCtxsEvent = {
+    /** Array of tuples of dex names and contexts for each perpetual asset. */
+    ctxs: [dex: string, ctx: PerpAssetCtxSchema[]][];
+};
+import type { ISubscription } from "../../../transport/mod.js";
+import type { SubscriptionConfig } from "./_types.js";
+/**
+ * Subscribe to asset contexts for all DEXs.
+ *
+ * @param config General configuration for Subscription API subscriptions.
+ * @param listener A callback function to be called when the event is received.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { allDexsAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allDexsAssetCtxs(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function allDexsAssetCtxs(config: SubscriptionConfig, listener: (data: AllDexsAssetCtxsEvent) => void): Promise<ISubscription>;
+//# sourceMappingURL=allDexsAssetCtxs.d.ts.map

package/esm/api/subscription/_methods/allDexsAssetCtxs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allDexsAssetCtxs.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allDexsAssetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAErF;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IAEhC,4BAA4B;;aAG5B,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAC;CAClD,CAAC;AAOF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,GAC9C,OAAO,CAAC,aAAa,CAAC,CAOxB"}

package/esm/api/subscription/_methods/allDexsAssetCtxs.js

@@ -0,0 +1,49 @@
+import * as v from "valibot";
+/**
+ * Subscription to asset context events for all DEXs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export const AllDexsAssetCtxsRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of subscription. */
+        type: v.literal("allDexsAssetCtxs"),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Subscribe to asset contexts for all DEXs.
+ *
+ * @param config General configuration for Subscription API subscriptions.
+ * @param listener A callback function to be called when the event is received.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { allDexsAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allDexsAssetCtxs(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function allDexsAssetCtxs(config, listener) {
+    const payload = parse(AllDexsAssetCtxsRequest, {
+        type: "allDexsAssetCtxs",
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=allDexsAssetCtxs.js.map

package/esm/api/subscription/_methods/allDexsAssetCtxs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allDexsAssetCtxs.js","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allDexsAssetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAYL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAI1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAA0B,EAC1B,QAA+C;IAE/C,MAAM,OAAO,GAAG,KAAK,CAAC,uBAAuB,EAAE;QAC7C,IAAI,EAAE,kBAAkB;KACzB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAwB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACpF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/api/subscription/_methods/allDexsClearinghouseState.d.ts

@@ -0,0 +1,59 @@
+import * as v from "valibot";
+import type { ClearinghouseStateResponse } from "../../info/_methods/clearinghouseState.js";
+/**
+ * Subscription to clearinghouse state events for all DEXs for a specific user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const AllDexsClearinghouseStateRequest: v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.LiteralSchema<"allDexsClearinghouseState", undefined>;
+    /** User address. */
+    readonly user: 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>;
+export type AllDexsClearinghouseStateRequest = v.InferOutput<typeof AllDexsClearinghouseStateRequest>;
+/**
+ * Event of clearinghouse states for all DEXs for a specific user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export type AllDexsClearinghouseStateEvent = {
+    /**
+     * User address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    user: `0x${string}`;
+    /** Array of tuples of dex names and clearinghouse states. */
+    clearinghouseStates: [dex: string, state: ClearinghouseStateResponse][];
+};
+import type { ISubscription } from "../../../transport/mod.js";
+import type { SubscriptionConfig } from "./_types.js";
+/** Request parameters for the {@linkcode allDexsClearinghouseState} function. */
+export type AllDexsClearinghouseStateParameters = Omit<v.InferInput<typeof AllDexsClearinghouseStateRequest>, "type">;
+/**
+ * Subscribe to clearinghouse states for all DEXs for a specific user.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { allDexsClearinghouseState } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allDexsClearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function allDexsClearinghouseState(config: SubscriptionConfig, params: AllDexsClearinghouseStateParameters, listener: (data: AllDexsClearinghouseStateEvent) => void): Promise<ISubscription>;
+//# sourceMappingURL=allDexsClearinghouseState.d.ts.map

package/esm/api/subscription/_methods/allDexsClearinghouseState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allDexsClearinghouseState.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allDexsClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAO7B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,gCAAgC;IAEzC,4BAA4B;;IAE5B,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAEtG;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,6DAA6D;IAC7D,mBAAmB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,CAAC,EAAE,CAAC;CACzE,CAAC;AAOF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD,iFAAiF;AACjF,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gCAAgC,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mCAAmC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,IAAI,GACvD,OAAO,CAAC,aAAa,CAAC,CAUxB"}

package/esm/api/subscription/_methods/allDexsClearinghouseState.js

@@ -0,0 +1,60 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } from "../../_schemas.js";
+/**
+ * Subscription to clearinghouse state events for all DEXs for a specific user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export const AllDexsClearinghouseStateRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of subscription. */
+        type: v.literal("allDexsClearinghouseState"),
+        /** User address. */
+        user: Address,
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Subscribe to clearinghouse states for all DEXs for a specific user.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { allDexsClearinghouseState } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allDexsClearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function allDexsClearinghouseState(config, params, listener) {
+    const payload = parse(AllDexsClearinghouseStateRequest, {
+        type: "allDexsClearinghouseState",
+        ...params,
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=allDexsClearinghouseState.js.map

package/esm/api/subscription/_methods/allDexsClearinghouseState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allDexsClearinghouseState.js","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allDexsClearinghouseState.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;AAG5C;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpE,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC;QAC5C,oBAAoB;QACpB,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAiBL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAO1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAA0B,EAC1B,MAA2C,EAC3C,QAAwD;IAExD,MAAM,OAAO,GAAG,KAAK,CAAC,gCAAgC,EAAE;QACtD,IAAI,EAAE,2BAA2B;QACjC,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7F,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/api/subscription/_methods/allMids.d.ts

@@ -0,0 +1,56 @@
+import * as v from "valibot";
+import type { AllMidsResponse } from "../../info/_methods/allMids.js";
+/**
+ * Subscription to mid price events for all coins.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const AllMidsRequest: v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.LiteralSchema<"allMids", undefined>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;
+export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
+/**
+ * Event of mid prices for all assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export type AllMidsEvent = {
+    /** Mapping of coin symbols to mid prices. */
+    mids: AllMidsResponse;
+    /** DEX name (empty string for main dex). */
+    dex?: string;
+};
+import type { ISubscription } from "../../../transport/mod.js";
+import type { SubscriptionConfig } from "./_types.js";
+/** Request parameters for the {@linkcode allMids} function. */
+export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
+/**
+ * Subscribe to mid prices for all actively traded assets.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { allMids } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allMids(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function allMids(config: SubscriptionConfig, listener: (data: AllMidsEvent) => void): Promise<ISubscription>;
+export declare function allMids(config: SubscriptionConfig, params: AllMidsParameters, listener: (data: AllMidsEvent) => void): Promise<ISubscription>;
+//# sourceMappingURL=allMids.d.ts.map

package/esm/api/subscription/_methods/allMids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allMids.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,cAAc;IAEvB,4BAA4B;;IAE5B,4CAA4C;;aAG5C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,6CAA6C;IAC7C,IAAI,EAAE,eAAe,CAAC;IACtB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAOF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1B,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC"}

package/esm/api/subscription/_methods/allMids.js

@@ -0,0 +1,32 @@
+import * as v from "valibot";
+/**
+ * Subscription to mid price events for all coins.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export const AllMidsRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of subscription. */
+        type: v.literal("allMids"),
+        /** DEX name (empty string for main dex). */
+        dex: v.optional(v.string()),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+export function allMids(config, paramsOrListener, maybeListener) {
+    const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+    const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+    const payload = parse(AllMidsRequest, {
+        type: "allMids",
+        ...params,
+        dex: params.dex || undefined, // Same value as in response
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.dex === payload.dex) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=allMids.js.map

package/esm/api/subscription/_methods/allMids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allMids.js","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1B,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAcL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA0C1C,MAAM,UAAU,OAAO,CACrB,MAA0B,EAC1B,gBAAoE,EACpE,aAA4C;IAE5C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,KAAK,CAAC,cAAc,EAAE;QACpC,IAAI,EAAE,SAAS;QACf,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,SAAS,EAAE,4BAA4B;KAC3D,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAe,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC3E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/api/subscription/_methods/assetCtxs.d.ts

@@ -0,0 +1,56 @@
+import * as v from "valibot";
+import type { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
+/**
+ * Subscription to context events for all perpetual assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const AssetCtxsRequest: v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.LiteralSchema<"assetCtxs", undefined>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;
+export type AssetCtxsRequest = v.InferOutput<typeof AssetCtxsRequest>;
+/**
+ * Event of asset contexts for all perpetual assets on a specified DEX.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export type AssetCtxsEvent = {
+    /** DEX name (empty string for main dex). */
+    dex: string;
+    /** Array of context information for each perpetual asset. */
+    ctxs: PerpAssetCtxSchema[];
+};
+import type { ISubscription } from "../../../transport/mod.js";
+import type { SubscriptionConfig } from "./_types.js";
+/** Request parameters for the {@linkcode assetCtxs} function. */
+export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "type">;
+/**
+ * Subscribe to asset contexts for all perpetual assets.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { assetCtxs } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await assetCtxs(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function assetCtxs(config: SubscriptionConfig, listener: (data: AssetCtxsEvent) => void): Promise<ISubscription>;
+export declare function assetCtxs(config: SubscriptionConfig, params: AssetCtxsParameters, listener: (data: AssetCtxsEvent) => void): Promise<ISubscription>;
+//# sourceMappingURL=assetCtxs.d.ts.map

package/esm/api/subscription/_methods/assetCtxs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetCtxs.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAErF;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAEzB,4BAA4B;;IAE5B,4CAA4C;;aAG5C,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC;AAOF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1B,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,aAAa,CAAC,CAAC"}

package/esm/api/subscription/_methods/assetCtxs.js

@@ -0,0 +1,32 @@
+import * as v from "valibot";
+/**
+ * Subscription to context events for all perpetual assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export const AssetCtxsRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of subscription. */
+        type: v.literal("assetCtxs"),
+        /** DEX name (empty string for main dex). */
+        dex: v.optional(v.string()),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+export function assetCtxs(config, paramsOrListener, maybeListener) {
+    const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+    const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+    const payload = parse(AssetCtxsRequest, {
+        type: "assetCtxs",
+        ...params,
+        dex: params.dex ?? "", // Same value as in response
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.dex === payload.dex) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=assetCtxs.js.map

package/esm/api/subscription/_methods/assetCtxs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetCtxs.js","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC5B,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAcL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA0C1C,MAAM,UAAU,SAAS,CACvB,MAA0B,EAC1B,gBAAwE,EACxE,aAA8C;IAE9C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,KAAK,CAAC,gBAAgB,EAAE;QACtC,IAAI,EAAE,WAAW;QACjB,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/api/subscription/_methods/bbo.d.ts

@@ -0,0 +1,86 @@
+import * as v from "valibot";
+/**
+ * Subscription to best bid and offer events for a specific asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const BboRequest: v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.LiteralSchema<"bbo", undefined>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.StringSchema<undefined>;
+}, undefined>;
+export type BboRequest = v.InferOutput<typeof BboRequest>;
+/**
+ * Event of best bid and offer.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export type BboEvent = {
+    /** Asset symbol (e.g., BTC). */
+    coin: string;
+    /** Time of the BBO update (in ms since epoch). */
+    time: number;
+    /** Best bid and offer tuple [bid, offer], either can be undefined if unavailable. */
+    bbo: [
+        {
+            /**
+             * Price.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            px: string;
+            /**
+             * Total size.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            sz: string;
+            /** Number of individual orders. */
+            n: number;
+        },
+        {
+            /**
+             * Price.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            px: string;
+            /**
+             * Total size.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            sz: string;
+            /** Number of individual orders. */
+            n: number;
+        }
+    ];
+};
+import type { ISubscription } from "../../../transport/mod.js";
+import type { SubscriptionConfig } from "./_types.js";
+/** Request parameters for the {@linkcode bbo} function. */
+export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
+/**
+ * Subscribe to best bid and offer updates for a specific asset.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { bbo } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await bbo(
+ *   { transport },
+ *   { coin: "ETH" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function bbo(config: SubscriptionConfig, params: BboParameters, listener: (data: BboEvent) => void): Promise<ISubscription>;
+//# sourceMappingURL=bbo.d.ts.map

package/esm/api/subscription/_methods/bbo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bbo.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B;;;GAGG;AACH,eAAO,MAAM,UAAU;IAEnB,4BAA4B;;IAE5B,gCAAgC;;aAGhC,CAAC;AACL,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,UAAU,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,qFAAqF;IACrF,GAAG,EAAE;QAAC;YACJ;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YACX,mCAAmC;YACnC,CAAC,EAAE,MAAM,CAAC;SACX;QAAE;YACD;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YACX,mCAAmC;YACnC,CAAC,EAAE,MAAM,CAAC;SACX;KAAC,CAAC;CACJ,CAAC;AAOF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,GAAG,CACjB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GACjC,OAAO,CAAC,aAAa,CAAC,CAOxB"}

package/esm/api/subscription/_methods/bbo.js

@@ -0,0 +1,56 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+/**
+ * Subscription to best bid and offer events for a specific asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export const BboRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of subscription. */
+        type: v.literal("bbo"),
+        /** Asset symbol (e.g., BTC). */
+        coin: v.string(),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Subscribe to best bid and offer updates for a specific asset.
+ *
+ * @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.
+ * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
+ *
+ * @throws {ValidationError} 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 { bbo } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await bbo(
+ *   { transport },
+ *   { coin: "ETH" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function bbo(config, params, listener) {
+    const payload = parse(BboRequest, { type: "bbo", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.coin === payload.coin) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=bbo.js.map

package/esm/api/subscription/_methods/bbo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bbo.js","sourceRoot":"","sources":["../../../../src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC9C,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QACtB,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AA0CL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAO1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,GAAG,CACjB,MAA0B,EAC1B,MAAqB,EACrB,QAAkC;IAElC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC9D,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAW,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACvE,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"}