@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

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

@@ -0,0 +1,89 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to context events for a specific spot asset. */
+export declare const ActiveSpotAssetCtxRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"activeAssetCtx", undefined>, v.DescriptionAction<"activeAssetCtx", "Type of subscription.">]>;
+    /** Asset ID (e.g., @1). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset ID (e.g., @1).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "activeAssetCtx";
+    coin: string;
+}, "Subscription to context events for a specific spot asset.">]>;
+export type ActiveSpotAssetCtxRequest = v.InferOutput<typeof ActiveSpotAssetCtxRequest>;
+/** Event of active spot asset context. */
+export declare const ActiveSpotAssetCtxEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset ID (e.g., @1). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset ID (e.g., @1).">]>;
+    /** Context for a specific spot asset. */
+    readonly ctx: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Previous day's closing price. */
+        readonly prevDayPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Previous day's closing price.">]>;
+        /** Daily notional volume. */
+        readonly dayNtlVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Daily notional volume.">]>;
+        /** Mark price. */
+        readonly markPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Mark price.">]>;
+        /** Mid price. */
+        readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
+        /** Circulating supply. */
+        readonly circulatingSupply: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Circulating supply.">]>;
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Total supply. */
+        readonly totalSupply: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total supply.">]>;
+        /** Daily volume in base currency. */
+        readonly dayBaseVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+    }, undefined>, v.DescriptionAction<{
+        prevDayPx: string;
+        dayNtlVlm: string;
+        markPx: string;
+        midPx: string | null;
+        circulatingSupply: string;
+        coin: string;
+        totalSupply: string;
+        dayBaseVlm: string;
+    }, "Context for a specific spot asset.">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    ctx: {
+        prevDayPx: string;
+        dayNtlVlm: string;
+        markPx: string;
+        midPx: string | null;
+        circulatingSupply: string;
+        coin: string;
+        totalSupply: string;
+        dayBaseVlm: string;
+    };
+}, "Event of active spot asset context.">]>;
+export type ActiveSpotAssetCtxEvent = v.InferOutput<typeof ActiveSpotAssetCtxEvent>;
+/** Request parameters for the {@linkcode activeSpotAssetCtx} function. */
+export type ActiveSpotAssetCtxParameters = Omit<v.InferInput<typeof ActiveSpotAssetCtxRequest>, "type">;
+/**
+ * Subscribe to context updates for a specific spot 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.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { activeSpotAssetCtx } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await activeSpotAssetCtx(
+ *   { transport },
+ *   { coin: "@1" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function activeSpotAssetCtx(config: SubscriptionRequestConfig, params: DeepImmutable<ActiveSpotAssetCtxParameters>, listener: (data: ActiveSpotAssetCtxEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=activeSpotAssetCtx.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"activeSpotAssetCtx.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/activeSpotAssetCtx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,gEAAgE;AAChE,eAAO,MAAM,yBAAyB;IAGhC,4BAA4B;;IAK5B,2BAA2B;;;;;iEAQ7B,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,0CAA0C;AAC1C,eAAO,MAAM,uBAAuB;IAG9B,2BAA2B;;IAK3B,yCAAyC;;QAGrC,oCAAoC;;QAKpC,6BAA6B;;QAK7B,kBAAkB;;QAKlB,iBAAiB;;QAKjB,0BAA0B;;QAK1B,oBAAoB;;QAKpB,oBAAoB;;QAKpB,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;2CAW3C,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAIpF,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,4BAA4B,CAAC,EACnD,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,YAAY,CAAC,CAOvB"}

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

@@ -0,0 +1,71 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to context events for a specific spot asset. */
+export const ActiveSpotAssetCtxRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("activeAssetCtx"), v.description("Type of subscription.")),
+        /** Asset ID (e.g., @1). */
+        coin: v.pipe(v.string(), v.description("Asset ID (e.g., @1).")),
+    }), v.description("Subscription to context events for a specific spot asset."));
+})();
+/** Event of active spot asset context. */
+export const ActiveSpotAssetCtxEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Asset ID (e.g., @1). */
+        coin: v.pipe(v.string(), v.description("Asset ID (e.g., @1).")),
+        /** Context for a specific spot asset. */
+        ctx: v.pipe(v.object({
+            /** Previous day's closing price. */
+            prevDayPx: v.pipe(UnsignedDecimal, v.description("Previous day's closing price.")),
+            /** Daily notional volume. */
+            dayNtlVlm: v.pipe(UnsignedDecimal, v.description("Daily notional volume.")),
+            /** Mark price. */
+            markPx: v.pipe(UnsignedDecimal, v.description("Mark price.")),
+            /** Mid price. */
+            midPx: v.pipe(v.nullable(UnsignedDecimal), v.description("Mid price.")),
+            /** Circulating supply. */
+            circulatingSupply: v.pipe(UnsignedDecimal, v.description("Circulating supply.")),
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Total supply. */
+            totalSupply: v.pipe(UnsignedDecimal, v.description("Total supply.")),
+            /** Daily volume in base currency. */
+            dayBaseVlm: v.pipe(UnsignedDecimal, v.description("Daily volume in base currency.")),
+        }), v.description("Context for a specific spot asset.")),
+    }), v.description("Event of active spot asset context."));
+})();
+/**
+ * Subscribe to context updates for a specific spot 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.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { activeSpotAssetCtx } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await activeSpotAssetCtx(
+ *   { transport },
+ *   { coin: "@1" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function activeSpotAssetCtx(config, params, listener) {
+    const payload = parser(ActiveSpotAssetCtxRequest)({ type: "activeAssetCtx", ...params });
+    return config.transport.subscribe("activeSpotAssetCtx", payload, (e) => {
+        if (e.detail.coin === payload.coin) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=activeSpotAssetCtx.js.map

package/esm/src/api/subscription/activeSpotAssetCtx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeSpotAssetCtx.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/activeSpotAssetCtx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI5E,oDAAoD;AAEpD,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,2BAA2B;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAC3E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,0CAA0C;AAC1C,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,2BAA2B;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,yCAAyC;QACzC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,CAAC;YACP,oCAAoC;YACpC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;YACD,6BAA6B;YAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,kBAAkB;YAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,iBAAiB;YACjB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B;YACD,0BAA0B;YAC1B,iBAAiB,EAAE,CAAC,CAAC,IAAI,CACvB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;YACD,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,oBAAoB;YACpB,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,qCAAqC;YACrC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAiC,EACjC,MAAmD,EACnD,QAAiD;IAEjD,MAAM,OAAO,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACzF,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAA0B,oBAAoB,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC9F,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/allMids.d.ts

@@ -0,0 +1,58 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to mid price events for all coins. */
+export declare const AllMidsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"allMids", undefined>, v.DescriptionAction<"allMids", "Type of subscription.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "allMids";
+    dex?: string | undefined;
+}, "Subscription to mid price events for all coins.">]>;
+export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
+/** Event of mid prices for all assets. */
+export declare const AllMidsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Mapping of coin symbols to mid prices. */
+    readonly mids: v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<{
+        [x: string]: string;
+    }, "Mapping of coin symbols to mid prices.">]>;
+    /** DEX name (undefined for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    mids: {
+        [x: string]: string;
+    };
+    dex?: string | undefined;
+}, "Event of mid prices for all assets.">]>;
+export type AllMidsEvent = v.InferOutput<typeof AllMidsEvent>;
+/** 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.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @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),
+ * );
+ * ```
+ */
+export declare function allMids(config: SubscriptionRequestConfig, listener: (data: AllMidsEvent) => void): Promise<Subscription>;
+export declare function allMids(config: SubscriptionRequestConfig, params: DeepImmutable<AllMidsParameters>, listener: (data: AllMidsEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=allMids.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"allMids.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,sDAAsD;AACtD,eAAO,MAAM,cAAc;IAGrB,4BAA4B;;IAK5B,4CAA4C;;;;;uDAQ9C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAElE,0CAA0C;AAC1C,eAAO,MAAM,YAAY;IAGnB,6CAA6C;;;;IAK7C,yCAAyC;;;;;;;2CAQ3C,CAAC;AACL,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAI9D,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,yBAAyB,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,YAAY,CAAC,CAAC;AACzB,wBAAgB,OAAO,CACrB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,iBAAiB,CAAC,EACxC,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,YAAY,CAAC,CAAC"}

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

@@ -0,0 +1,36 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to mid price events for all coins. */
+export const AllMidsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("allMids"), v.description("Type of subscription.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Subscription to mid price events for all coins."));
+})();
+/** Event of mid prices for all assets. */
+export const AllMidsEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Mapping of coin symbols to mid prices. */
+        mids: v.pipe(v.record(v.string(), UnsignedDecimal), v.description("Mapping of coin symbols to mid prices.")),
+        /** DEX name (undefined for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Event of mid prices for all assets."));
+})();
+export function allMids(config, paramsOrListener, maybeListener) {
+    const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+    const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+    const payload = parser(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/src/api/subscription/allMids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allMids.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI5E,oDAAoD;AAEpD,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,0CAA0C;AAC1C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,6CAA6C;QAC7C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;QACD,yCAAyC;QACzC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAwCL,MAAM,UAAU,OAAO,CACrB,MAAiC,EACjC,gBAAmF,EACnF,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,MAAM,CAAC,cAAc,CAAC,CAAC;QACrC,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/src/api/subscription/assetCtxs.d.ts

@@ -0,0 +1,108 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to context events for all perpetual assets. */
+export declare const AssetCtxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"assetCtxs", undefined>, v.DescriptionAction<"assetCtxs", "Type of subscription.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "assetCtxs";
+    dex?: string | undefined;
+}, "Subscription to context events for all perpetual assets.">]>;
+export type AssetCtxsRequest = v.InferOutput<typeof AssetCtxsRequest>;
+/** Event of asset contexts for all perpetual assets on a specified DEX. */
+export declare const AssetCtxsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "DEX name (empty string for main dex).">]>;
+    /** Array of context information for each perpetual asset. */
+    readonly ctxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Previous day's closing price. */
+        readonly prevDayPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Previous day's closing price.">]>;
+        /** Daily notional volume. */
+        readonly dayNtlVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Daily notional volume.">]>;
+        /** Mark price. */
+        readonly markPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Mark price.">]>;
+        /** Mid price. */
+        readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
+        /** Funding rate. */
+        readonly funding: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Funding rate.">]>;
+        /** Total open interest. */
+        readonly openInterest: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total open interest.">]>;
+        /** Premium price. */
+        readonly premium: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<string | null, "Premium price.">]>;
+        /** Oracle price. */
+        readonly oraclePx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Oracle price.">]>;
+        /** Array of impact prices. */
+        readonly impactPxs: v.SchemaWithPipe<readonly [v.NullableSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>, v.DescriptionAction<string[] | null, "Array of impact prices.">]>;
+        /** Daily volume in base currency. */
+        readonly dayBaseVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+    }, undefined>, v.DescriptionAction<{
+        prevDayPx: string;
+        dayNtlVlm: string;
+        markPx: string;
+        midPx: string | null;
+        funding: string;
+        openInterest: string;
+        premium: string | null;
+        oraclePx: string;
+        impactPxs: string[] | null;
+        dayBaseVlm: string;
+    }, "Context for a specific perpetual asset.">]>, undefined>, v.DescriptionAction<{
+        prevDayPx: string;
+        dayNtlVlm: string;
+        markPx: string;
+        midPx: string | null;
+        funding: string;
+        openInterest: string;
+        premium: string | null;
+        oraclePx: string;
+        impactPxs: string[] | null;
+        dayBaseVlm: string;
+    }[], "Array of context information for each perpetual asset.">]>;
+}, undefined>, v.DescriptionAction<{
+    dex: string;
+    ctxs: {
+        prevDayPx: string;
+        dayNtlVlm: string;
+        markPx: string;
+        midPx: string | null;
+        funding: string;
+        openInterest: string;
+        premium: string | null;
+        oraclePx: string;
+        impactPxs: string[] | null;
+        dayBaseVlm: string;
+    }[];
+}, "Event of asset contexts for all perpetual assets on a specified DEX.">]>;
+export type AssetCtxsEvent = v.InferOutput<typeof AssetCtxsEvent>;
+/** 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.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @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),
+ * );
+ * ```
+ */
+export declare function assetCtxs(config: SubscriptionRequestConfig, listener: (data: AssetCtxsEvent) => void): Promise<Subscription>;
+export declare function assetCtxs(config: SubscriptionRequestConfig, params: DeepImmutable<AssetCtxsParameters>, listener: (data: AssetCtxsEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=assetCtxs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"assetCtxs.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB;IAGvB,4BAA4B;;IAK5B,4CAA4C;;;;;gEAQ9C,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,2EAA2E;AAC3E,eAAO,MAAM,cAAc;IAGrB,4CAA4C;;IAK5C,6DAA6D;;QAMrD,oCAAoC;;QAKpC,6BAA6B;;QAK7B,kBAAkB;;QAKlB,iBAAiB;;QAKjB,oBAAoB;;QAKpB,2BAA2B;;QAK3B,qBAAqB;;QAKrB,oBAAoB;;QAKpB,8BAA8B;;QAK9B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAc/C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAIlE,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,yBAAyB,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,YAAY,CAAC,CAAC;AACzB,wBAAgB,SAAS,CACvB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,YAAY,CAAC,CAAC"}

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

@@ -0,0 +1,59 @@
+import * as v from "valibot";
+import { Decimal, parser, UnsignedDecimal } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to context events for all perpetual assets. */
+export const AssetCtxsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("assetCtxs"), v.description("Type of subscription.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Subscription to context events for all perpetual assets."));
+})();
+/** Event of asset contexts for all perpetual assets on a specified DEX. */
+export const AssetCtxsEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.string(), v.description("DEX name (empty string for main dex).")),
+        /** Array of context information for each perpetual asset. */
+        ctxs: v.pipe(v.array(
+        /** Context for a specific perpetual asset. */
+        v.pipe(v.object({
+            /** Previous day's closing price. */
+            prevDayPx: v.pipe(UnsignedDecimal, v.description("Previous day's closing price.")),
+            /** Daily notional volume. */
+            dayNtlVlm: v.pipe(UnsignedDecimal, v.description("Daily notional volume.")),
+            /** Mark price. */
+            markPx: v.pipe(UnsignedDecimal, v.description("Mark price.")),
+            /** Mid price. */
+            midPx: v.pipe(v.nullable(UnsignedDecimal), v.description("Mid price.")),
+            /** Funding rate. */
+            funding: v.pipe(Decimal, v.description("Funding rate.")),
+            /** Total open interest. */
+            openInterest: v.pipe(UnsignedDecimal, v.description("Total open interest.")),
+            /** Premium price. */
+            premium: v.pipe(v.nullable(Decimal), v.description("Premium price.")),
+            /** Oracle price. */
+            oraclePx: v.pipe(UnsignedDecimal, v.description("Oracle price.")),
+            /** Array of impact prices. */
+            impactPxs: v.pipe(v.nullable(v.array(v.string())), v.description("Array of impact prices.")),
+            /** Daily volume in base currency. */
+            dayBaseVlm: v.pipe(UnsignedDecimal, v.description("Daily volume in base currency.")),
+        }), v.description("Context for a specific perpetual asset."))), v.description("Array of context information for each perpetual asset.")),
+    }), v.description("Event of asset contexts for all perpetual assets on a specified DEX."));
+})();
+export function assetCtxs(config, paramsOrListener, maybeListener) {
+    const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+    const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+    const payload = parser(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/src/api/subscription/assetCtxs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetCtxs.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAIrF,oDAAoD;AAEpD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,2EAA2E;AAC3E,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;QACD,6DAA6D;QAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK;QACL,8CAA8C;QAC9C,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oCAAoC;YACpC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;YACD,6BAA6B;YAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,kBAAkB;YAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,iBAAiB;YACjB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B;YACD,oBAAoB;YACpB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,2BAA2B;YAC3B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,qBAAqB;YACrB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,oBAAoB;YACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,8BAA8B;YAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,qCAAqC;YACrC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sEAAsE,CAAC,CACtF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAwCL,MAAM,UAAU,SAAS,CACvB,MAAiC,EACjC,gBAAuF,EACvF,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,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACvC,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/src/api/subscription/bbo.d.ts

@@ -0,0 +1,95 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to best bid and offer events for a specific asset. */
+export declare const BboRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"bbo", undefined>, v.DescriptionAction<"bbo", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "bbo";
+    coin: string;
+}, "Subscription to best bid and offer events for a specific asset.">]>;
+export type BboRequest = v.InferOutput<typeof BboRequest>;
+/** Event of best bid and offer. */
+export declare const BboEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Time of the BBO update (in ms since epoch). */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Time of the BBO update (in ms since epoch).">]>;
+    /** Best bid and offer tuple [bid, offer], either can be undefined if unavailable. */
+    readonly bbo: v.SchemaWithPipe<readonly [v.TupleSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Price. */
+        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
+        /** Total size. */
+        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total size.">]>;
+        /** Number of individual orders. */
+        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
+    }, undefined>, v.DescriptionAction<{
+        px: string;
+        sz: string;
+        n: number;
+    }, "L2 order book level.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Price. */
+        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
+        /** Total size. */
+        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total size.">]>;
+        /** Number of individual orders. */
+        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
+    }, undefined>, v.DescriptionAction<{
+        px: string;
+        sz: string;
+        n: number;
+    }, "L2 order book level.">]>], undefined>, v.DescriptionAction<[{
+        px: string;
+        sz: string;
+        n: number;
+    }, {
+        px: string;
+        sz: string;
+        n: number;
+    }], "Best bid and offer tuple [bid, offer], either can be undefined if unavailable.">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    time: number;
+    bbo: [{
+        px: string;
+        sz: string;
+        n: number;
+    }, {
+        px: string;
+        sz: string;
+        n: number;
+    }];
+}, "Event of best bid and offer.">]>;
+export type BboEvent = v.InferOutput<typeof BboEvent>;
+/** 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.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @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),
+ * );
+ * ```
+ */
+export declare function bbo(config: SubscriptionRequestConfig, params: DeepImmutable<BboParameters>, listener: (data: BboEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=bbo.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bbo.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC7F,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,sEAAsE;AACtE,eAAO,MAAM,UAAU;IAGjB,4BAA4B;;IAK5B,gCAAgC;;;;;uEAQlC,CAAC;AACL,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,UAAU,CAAC,CAAC;AA0B1D,mCAAmC;AACnC,eAAO,MAAM,QAAQ;IAGf,gCAAgC;;IAKhC,kDAAkD;;IAKlD,qFAAqF;;QAlCrF,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;QAVnC,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAgCrC,CAAC;AACL,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,QAAQ,CAAC,CAAC;AAItD,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,GAAG,CACjB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GACjC,OAAO,CAAC,YAAY,CAAC,CAOvB"}