@hfunlabs/hyperliquid 0.27.1-hfunlabs.5 → 0.29.1-hfunlabs.1

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

@@ -0,0 +1,69 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } from "../../_schemas.js";
+import { FrontendOpenOrdersResponse } from "../../info/_methods/frontendOpenOrders.js";
+/** Subscription to open order events for a specific user. */
+export const OpenOrdersRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("openOrders"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** 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 open order events for a specific user."));
+})();
+/** Event of open orders for a specific user. */
+export const OpenOrdersEvent = /* @__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).")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Array of open orders with additional display information. */
+        orders: FrontendOpenOrdersResponse,
+    }), v.description("Event of open orders for a specific user."));
+})();
+/**
+ * Subscribe to open orders updates 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.
+ *
+ * @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 { openOrders } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await openOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function openOrders(config, params, listener) {
+    const payload = v.parse(OpenOrdersRequest, {
+        type: "openOrders",
+        ...params,
+        dex: params.dex ?? "", // same value as in response
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user && e.detail.dex === payload.dex) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=openOrders.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"openOrders.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/openOrders.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,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AAEvF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EACvB,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;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,wDAAwD,CAAC,CACxE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,gDAAgD;AAChD,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,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,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,gEAAgE;QAChE,MAAM,EAAE,0BAA0B;KACnC,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,UAAU,CACxB,MAA0B,EAC1B,MAA4B,EAC5B,QAAyC;IAEzC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE;QACzC,IAAI,EAAE,YAAY;QAClB,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAkB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC9E,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACnE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,144 @@
+import * as v from "valibot";
+/** Subscription to order updates for a specific user. */
+export declare const OrderUpdatesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"orderUpdates", undefined>, v.DescriptionAction<"orderUpdates", "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: "orderUpdates";
+    user: `0x${string}`;
+}, "Subscription to order updates for a specific user.">]>;
+export type OrderUpdatesRequest = v.InferOutput<typeof OrderUpdatesRequest>;
+/** Event of array of orders with their current processing status. */
+export declare const OrderUpdatesEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Order details. */
+    readonly order: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+        readonly side: v.SchemaWithPipe<readonly [v.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+        /** Limit price. */
+        readonly limitPx: 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, "Limit price.">]>;
+        /** Size. */
+        readonly sz: 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, "Size.">]>;
+        /** Order ID. */
+        readonly oid: 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, "Order ID.">]>;
+        /** Timestamp when the order was placed (in ms since epoch). */
+        readonly timestamp: 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, "Timestamp when the order was placed (in ms since epoch).">]>;
+        /** Original size at order placement. */
+        readonly origSz: 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, "Original size at order placement.">]>;
+        /** Client Order ID. */
+        readonly cloid: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | undefined, "Client Order ID.">]>;
+        /** Indicates if the order is reduce-only. */
+        readonly reduceOnly: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if the order is reduce-only.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        side: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        cloid?: `0x${string}` | undefined;
+        reduceOnly?: true | undefined;
+    }, "Order details.">]>;
+    /**
+     * Order processing status.
+     * - `"open"`: Order active and waiting to be filled.
+     * - `"filled"`: Order fully executed.
+     * - `"canceled"`: Order canceled by the user.
+     * - `"triggered"`: Order triggered and awaiting execution.
+     * - `"rejected"`: Order rejected by the system.
+     * - `"marginCanceled"`: Order canceled due to insufficient margin.
+     * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
+     * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
+     * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
+     * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
+     * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
+     * - `"delistedCanceled"`: Canceled due to asset delisting.
+     * - `"liquidatedCanceled"`: Canceled due to liquidation.
+     * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
+     * - `"tickRejected"`: Rejected due to invalid tick price.
+     * - `"minTradeNtlRejected"`: Rejected due to order notional below minimum.
+     * - `"perpMarginRejected"`: Rejected due to insufficient margin.
+     * - `"reduceOnlyRejected"`: Rejected due to reduce only.
+     * - `"badAloPxRejected"`: Rejected due to post-only immediate match.
+     * - `"iocCancelRejected"`: Rejected due to IOC not able to match.
+     * - `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.
+     * - `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.
+     * - `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+     * - `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+     * - `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.
+     * - `"openInterestIncreaseRejected"`: Rejected due to open interest cap.
+     * - `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.
+     * - `"oracleRejected"`: Rejected due to price too far from oracle.
+     * - `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.
+     */
+    readonly status: v.SchemaWithPipe<readonly [v.PicklistSchema<["open", "filled", "canceled", "triggered", "rejected", "marginCanceled", "vaultWithdrawalCanceled", "openInterestCapCanceled", "selfTradeCanceled", "reduceOnlyCanceled", "siblingFilledCanceled", "delistedCanceled", "liquidatedCanceled", "scheduledCancel", "tickRejected", "minTradeNtlRejected", "perpMarginRejected", "reduceOnlyRejected", "badAloPxRejected", "iocCancelRejected", "badTriggerPxRejected", "marketOrderNoLiquidityRejected", "positionIncreaseAtOpenInterestCapRejected", "positionFlipAtOpenInterestCapRejected", "tooAggressiveAtOpenInterestCapRejected", "openInterestIncreaseRejected", "insufficientSpotBalanceRejected", "oracleRejected", "perpMaxPositionRejected"], undefined>, v.DescriptionAction<"open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected", string>]>;
+    /** Timestamp when the status was last updated (in ms since epoch). */
+    readonly statusTimestamp: 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, "Timestamp when the status was last updated (in ms since epoch).">]>;
+}, undefined>, v.DescriptionAction<{
+    order: {
+        coin: string;
+        side: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        cloid?: `0x${string}` | undefined;
+        reduceOnly?: true | undefined;
+    };
+    status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected";
+    statusTimestamp: number;
+}, "Order with its current processing status.">]>, undefined>, v.DescriptionAction<{
+    order: {
+        coin: string;
+        side: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        cloid?: `0x${string}` | undefined;
+        reduceOnly?: true | undefined;
+    };
+    status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected";
+    statusTimestamp: number;
+}[], "Event of array of orders with their current processing status.">]>;
+export type OrderUpdatesEvent = v.InferOutput<typeof OrderUpdatesEvent>;
+import type { SubscriptionConfig } from "./_types.js";
+import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+/** Request parameters for the {@linkcode orderUpdates} function. */
+export type OrderUpdatesParameters = Omit<v.InferInput<typeof OrderUpdatesRequest>, "type">;
+/**
+ * Subscribe to order status updates 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.
+ *
+ * @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 { orderUpdates } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await orderUpdates(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function orderUpdates(config: SubscriptionConfig, params: OrderUpdatesParameters, listener: (data: OrderUpdatesEvent) => void): Promise<WebSocketSubscription>;
+//# sourceMappingURL=orderUpdates.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orderUpdates.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/orderUpdates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,yDAAyD;AACzD,eAAO,MAAM,mBAAmB;IAG1B,4BAA4B;;IAK5B,oBAAoB;;;;;0DAQtB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,qEAAqE;AACrE,eAAO,MAAM,iBAAiB;IAMpB,qBAAqB;;QAGjB,oBAAoB;;QAKpB,kDAAkD;;QAKlD,mBAAmB;;QAKnB,YAAY;;QAKZ,gBAAgB;;QAKhB,+DAA+D;;QAO/D,wCAAwC;;QAKxC,uBAAuB;;QAKvB,6CAA6C;;;;;;;;;;;;;IAQjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;;IAkEH,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wEAW5E,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAMxE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,sBAAsB,EAC9B,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,qBAAqB,CAAC,CAKhC"}

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

@@ -0,0 +1,171 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+/** Subscription to order updates for a specific user. */
+export const OrderUpdatesRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("orderUpdates"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to order updates for a specific user."));
+})();
+/** Event of array of orders with their current processing status. */
+export const OrderUpdatesEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** Order with its current processing status. */
+    v.pipe(v.object({
+        /** Order details. */
+        order: v.pipe(v.object({
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+            side: v.pipe(v.picklist(["B", "A"]), v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).')),
+            /** Limit price. */
+            limitPx: v.pipe(UnsignedDecimal, v.description("Limit price.")),
+            /** Size. */
+            sz: v.pipe(UnsignedDecimal, v.description("Size.")),
+            /** Order ID. */
+            oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+            /** Timestamp when the order was placed (in ms since epoch). */
+            timestamp: v.pipe(UnsignedInteger, v.description("Timestamp when the order was placed (in ms since epoch).")),
+            /** Original size at order placement. */
+            origSz: v.pipe(UnsignedDecimal, v.description("Original size at order placement.")),
+            /** Client Order ID. */
+            cloid: v.pipe(v.optional(v.pipe(Hex, v.length(34))), v.description("Client Order ID.")),
+            /** Indicates if the order is reduce-only. */
+            reduceOnly: v.pipe(v.optional(v.literal(true)), v.description("Indicates if the order is reduce-only.")),
+        }), v.description("Order details.")),
+        /**
+         * Order processing status.
+         * - `"open"`: Order active and waiting to be filled.
+         * - `"filled"`: Order fully executed.
+         * - `"canceled"`: Order canceled by the user.
+         * - `"triggered"`: Order triggered and awaiting execution.
+         * - `"rejected"`: Order rejected by the system.
+         * - `"marginCanceled"`: Order canceled due to insufficient margin.
+         * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
+         * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
+         * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
+         * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
+         * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
+         * - `"delistedCanceled"`: Canceled due to asset delisting.
+         * - `"liquidatedCanceled"`: Canceled due to liquidation.
+         * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
+         * - `"tickRejected"`: Rejected due to invalid tick price.
+         * - `"minTradeNtlRejected"`: Rejected due to order notional below minimum.
+         * - `"perpMarginRejected"`: Rejected due to insufficient margin.
+         * - `"reduceOnlyRejected"`: Rejected due to reduce only.
+         * - `"badAloPxRejected"`: Rejected due to post-only immediate match.
+         * - `"iocCancelRejected"`: Rejected due to IOC not able to match.
+         * - `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.
+         * - `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.
+         * - `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+         * - `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+         * - `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.
+         * - `"openInterestIncreaseRejected"`: Rejected due to open interest cap.
+         * - `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.
+         * - `"oracleRejected"`: Rejected due to price too far from oracle.
+         * - `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.
+         */
+        status: v.pipe(v.picklist([
+            "open",
+            "filled",
+            "canceled",
+            "triggered",
+            "rejected",
+            "marginCanceled",
+            "vaultWithdrawalCanceled",
+            "openInterestCapCanceled",
+            "selfTradeCanceled",
+            "reduceOnlyCanceled",
+            "siblingFilledCanceled",
+            "delistedCanceled",
+            "liquidatedCanceled",
+            "scheduledCancel",
+            "tickRejected",
+            "minTradeNtlRejected",
+            "perpMarginRejected",
+            "reduceOnlyRejected",
+            "badAloPxRejected",
+            "iocCancelRejected",
+            "badTriggerPxRejected",
+            "marketOrderNoLiquidityRejected",
+            "positionIncreaseAtOpenInterestCapRejected",
+            "positionFlipAtOpenInterestCapRejected",
+            "tooAggressiveAtOpenInterestCapRejected",
+            "openInterestIncreaseRejected",
+            "insufficientSpotBalanceRejected",
+            "oracleRejected",
+            "perpMaxPositionRejected",
+        ]), v.description("Order processing status." +
+            '\n- `"open"`: Order active and waiting to be filled.' +
+            '\n- `"filled"`: Order fully executed.' +
+            '\n- `"canceled"`: Order canceled by the user.' +
+            '\n- `"triggered"`: Order triggered and awaiting execution.' +
+            '\n- `"rejected"`: Order rejected by the system.' +
+            '\n- `"marginCanceled"`: Order canceled due to insufficient margin.' +
+            '\n- `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.' +
+            '\n- `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.' +
+            '\n- `"selfTradeCanceled"`: Canceled due to self-trade prevention.' +
+            '\n- `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.' +
+            '\n- `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.' +
+            '\n- `"delistedCanceled"`: Canceled due to asset delisting.' +
+            '\n- `"liquidatedCanceled"`: Canceled due to liquidation.' +
+            '\n- `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man\'s switch).' +
+            '\n- `"tickRejected"`: Rejected due to invalid tick price.' +
+            '\n- `"minTradeNtlRejected"`: Rejected due to order notional below minimum.' +
+            '\n- `"perpMarginRejected"`: Rejected due to insufficient margin.' +
+            '\n- `"reduceOnlyRejected"`: Rejected due to reduce only.' +
+            '\n- `"badAloPxRejected"`: Rejected due to post-only immediate match.' +
+            '\n- `"iocCancelRejected"`: Rejected due to IOC not able to match.' +
+            '\n- `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.' +
+            '\n- `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.' +
+            '\n- `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.' +
+            '\n- `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.' +
+            '\n- `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.' +
+            '\n- `"openInterestIncreaseRejected"`: Rejected due to open interest cap.' +
+            '\n- `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.' +
+            '\n- `"oracleRejected"`: Rejected due to price too far from oracle.' +
+            '\n- `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.')),
+        /** Timestamp when the status was last updated (in ms since epoch). */
+        statusTimestamp: v.pipe(UnsignedInteger, v.description("Timestamp when the status was last updated (in ms since epoch).")),
+    }), v.description("Order with its current processing status."))), v.description("Event of array of orders with their current processing status."));
+})();
+/**
+ * Subscribe to order status updates 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.
+ *
+ * @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 { orderUpdates } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await orderUpdates(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function orderUpdates(config, params, listener) {
+    const payload = v.parse(OrderUpdatesRequest, { type: "orderUpdates", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=orderUpdates.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orderUpdates.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/orderUpdates.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,GAAG,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEnF,yDAAyD;AACzD,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,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,oDAAoD,CAAC,CACpE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,gDAAgD;IAChD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,qBAAqB;QACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;YACP,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,kDAAkD;YAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;YACD,mBAAmB;YACnB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;YACD,YAAY;YACZ,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CACvB;YACD,gBAAgB;YAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;YACD,+DAA+D;YAC/D,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CACX,0DAA0D,CAC3D,CACF;YACD,wCAAwC;YACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;YACD,uBAAuB;YACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;YACD,6CAA6C;YAC7C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,QAAQ,CAAC;YACT,MAAM;YACN,QAAQ;YACR,UAAU;YACV,WAAW;YACX,UAAU;YACV,gBAAgB;YAChB,yBAAyB;YACzB,yBAAyB;YACzB,mBAAmB;YACnB,oBAAoB;YACpB,uBAAuB;YACvB,kBAAkB;YAClB,oBAAoB;YACpB,iBAAiB;YACjB,cAAc;YACd,qBAAqB;YACrB,oBAAoB;YACpB,oBAAoB;YACpB,kBAAkB;YAClB,mBAAmB;YACnB,sBAAsB;YACtB,gCAAgC;YAChC,2CAA2C;YAC3C,uCAAuC;YACvC,wCAAwC;YACxC,8BAA8B;YAC9B,iCAAiC;YACjC,gBAAgB;YAChB,yBAAyB;SAC1B,CAAC,EACF,CAAC,CAAC,WAAW,CACX,0BAA0B;YACxB,sDAAsD;YACtD,uCAAuC;YACvC,+CAA+C;YAC/C,4DAA4D;YAC5D,iDAAiD;YACjD,oEAAoE;YACpE,gFAAgF;YAChF,4GAA4G;YAC5G,mEAAmE;YACnE,wFAAwF;YACxF,+EAA+E;YAC/E,4DAA4D;YAC5D,0DAA0D;YAC1D,oGAAoG;YACpG,2DAA2D;YAC3D,4EAA4E;YAC5E,kEAAkE;YAClE,0DAA0D;YAC1D,sEAAsE;YACtE,mEAAmE;YACnE,oEAAoE;YACpE,6FAA6F;YAC7F,uFAAuF;YACvF,mFAAmF;YACnF,4GAA4G;YAC5G,0EAA0E;YAC1E,qFAAqF;YACrF,oEAAoE;YACpE,mGAAmG,CACtG,CACF;QACD,sEAAsE;QACtE,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gEAAgE,CAAC,CAChF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,YAAY,CAC1B,MAA0B,EAC1B,MAA8B,EAC9B,QAA2C;IAE3C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAClF,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAoB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAChF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,69 @@
+import * as v from "valibot";
+/** Subscription to context events for all spot assets. */
+export declare const SpotAssetCtxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotAssetCtxs", undefined>, v.DescriptionAction<"spotAssetCtxs", "Type of subscription.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "spotAssetCtxs";
+}, "Subscription to context events for all spot assets.">]>;
+export type SpotAssetCtxsRequest = v.InferOutput<typeof SpotAssetCtxsRequest>;
+/** Event of spot asset contexts. */
+export declare const SpotAssetCtxsEvent: v.SchemaWithPipe<readonly [v.ArraySchema<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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+}, undefined>, undefined>, v.DescriptionAction<{
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx: string | null;
+    circulatingSupply: string;
+    coin: string;
+    totalSupply: string;
+    dayBaseVlm: string;
+}[], "Event of spot asset contexts.">]>;
+export type SpotAssetCtxsEvent = v.InferOutput<typeof SpotAssetCtxsEvent>;
+import type { SubscriptionConfig } from "./_types.js";
+import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+/**
+ * Subscribe to context updates for all spot 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 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 { spotAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await spotAssetCtxs(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare function spotAssetCtxs(config: SubscriptionConfig, listener: (data: SpotAssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+//# sourceMappingURL=spotAssetCtxs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spotAssetCtxs.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/spotAssetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,0DAA0D;AAC1D,eAAO,MAAM,oBAAoB;IAG3B,4BAA4B;;;;2DAQ9B,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E,oCAAoC;AACpC,eAAO,MAAM,kBAAkB;IAIvB,oCAAoC;;IAKpC,6BAA6B;;IAK7B,kBAAkB;;IAKlB,iBAAiB;;IAKjB,0BAA0B;;IAK1B,oBAAoB;;IAKpB,oBAAoB;;IAKpB,qCAAqC;;;;;;;;;;;uCASzC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,GAC3C,OAAO,CAAC,qBAAqB,CAAC,CAKhC"}

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

@@ -0,0 +1,67 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { UnsignedDecimal } from "../../_schemas.js";
+/** Subscription to context events for all spot assets. */
+export const SpotAssetCtxsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("spotAssetCtxs"), v.description("Type of subscription.")),
+    }), v.description("Subscription to context events for all spot assets."));
+})();
+/** Event of spot asset contexts. */
+export const SpotAssetCtxsEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(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("Event of spot asset contexts."));
+})();
+/**
+ * Subscribe to context updates for all spot 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 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 { spotAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await spotAssetCtxs(
+ *   { transport },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function spotAssetCtxs(config, listener) {
+    const payload = v.parse(SpotAssetCtxsRequest, { type: "spotAssetCtxs" });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=spotAssetCtxs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spotAssetCtxs.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/spotAssetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,0DAA0D;AAC1D,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qDAAqD,CAAC,CACrE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,oCAAoC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACP,oCAAoC;QACpC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,6BAA6B;QAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;QACD,kBAAkB;QAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,iBAAiB;QACjB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B;QACD,0BAA0B;QAC1B,iBAAiB,EAAE,CAAC,CAAC,IAAI,CACvB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,oBAAoB;QACpB,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,qCAAqC;QACrC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAUL;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,aAAa,CAC3B,MAA0B,EAC1B,QAA4C;IAE5C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAqB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACjF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}