@nktkas/hyperliquid 0.25.0-beta.3 → 0.25.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"l2Book.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/l2Book.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAItG,oDAAoD;AAEpD,iEAAiE;AACjE,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,qCAAqC;QACrC,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,CACP,CAAC,CAAC,IAAI,CACJ,OAAO,EACP,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAClE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;QACD,qDAAqD;QACrD,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,CACP,CAAC,CAAC,IAAI,CACJ,OAAO,EACP,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,2BAA2B;AAC3B,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxC,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,aAAa;QACb,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;QACD,kBAAkB;QAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,mCAAmC;QACnC,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAEL,uCAAuC;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC/C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,qDAAqD;QACrD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE;QACD,2DAA2D;QAC3D,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EACrD,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,MAAM,CACpB,MAAiC,EACjC,MAAuC,EACvC,QAAqC;IAErC,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;QACpC,IAAI,EAAE,QAAQ;QACd,GAAG,MAAM;QACT,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;KAClC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAc,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1E,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/notification.d.ts

@@ -0,0 +1,51 @@
+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 notification events for a specific user. */
+export declare const NotificationRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"notification", undefined>, v.DescriptionAction<"notification", "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: "notification";
+    user: `0x${string}`;
+}, "Subscription to notification events for a specific user.">]>;
+export type NotificationRequest = v.InferOutput<typeof NotificationRequest>;
+/** Event of user notification. */
+export declare const NotificationEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Notification content. */
+    readonly notification: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Notification content.">]>;
+}, undefined>, v.DescriptionAction<{
+    notification: string;
+}, "Event of user notification.">]>;
+export type NotificationEvent = v.InferOutput<typeof NotificationEvent>;
+/** Request parameters for the {@linkcode notification} function. */
+export type NotificationParameters = Omit<v.InferInput<typeof NotificationRequest>, "type">;
+/**
+ * Subscribe to notification 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 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 { notification } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await notification(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function notification(config: SubscriptionRequestConfig, params: DeepImmutable<NotificationParameters>, listener: (data: NotificationEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=notification.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAU,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB;IAG1B,4BAA4B;;IAK5B,oBAAoB;;;;;gEAQtB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,kCAAkC;AAClC,eAAO,MAAM,iBAAiB;IAGxB,4BAA4B;;;;mCAQ9B,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,YAAY,CAAC,CAKvB"}

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

@@ -0,0 +1,50 @@
+import * as v from "valibot";
+import { Address, parser } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to notification events for a specific user. */
+export const NotificationRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("notification"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to notification events for a specific user."));
+})();
+/** Event of user notification. */
+export const NotificationEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Notification content. */
+        notification: v.pipe(v.string(), v.description("Notification content.")),
+    }), v.description("Event of user notification."));
+})();
+/**
+ * Subscribe to notification 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 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 { notification } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await notification(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function notification(config, params, listener) {
+    const payload = parser(NotificationRequest)({ type: "notification", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=notification.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,MAAM,eAAe,CAAC;AAIpE,oDAAoD;AAEpD,+DAA+D;AAC/D,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,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,kCAAkC;AAClC,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAiC,EACjC,MAA6C,EAC7C,QAA2C;IAE3C,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACjF,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/openOrders.d.ts

@@ -0,0 +1,160 @@
+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 open order events for a specific user. */
+export declare const OpenOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"openOrders", undefined>, v.DescriptionAction<"openOrders", "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.">]>;
+    /** 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: "openOrders";
+    user: `0x${string}`;
+    dex?: string | undefined;
+}, "Subscription to open order events for a specific user.">]>;
+export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
+/** Event of open orders for a specific user. */
+export declare const OpenOrdersEvent: 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).">]>;
+    /** 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.">]>;
+    /** Array of open orders with additional display information. */
+    readonly orders: v.SchemaWithPipe<readonly [v.ArraySchema<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.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Original size at order placement.">]>;
+        /** Condition for triggering the order. */
+        readonly triggerCondition: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Condition for triggering the order.">]>;
+        /** Indicates if the order is a trigger order. */
+        readonly isTrigger: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a trigger order.">]>;
+        /** Trigger price. */
+        readonly triggerPx: 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, "Trigger price.">]>;
+        /** Child orders associated with this order. */
+        readonly children: v.SchemaWithPipe<readonly [v.LazySchema<any>, v.DescriptionAction<any, "Child orders associated with this order.">]>;
+        /** Indicates if the order is a position TP/SL order. */
+        readonly isPositionTpsl: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a position TP/SL order.">]>;
+        /** Indicates whether the order is reduce-only. */
+        readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates whether the order is reduce-only.">]>;
+        /**
+         * Order type for market execution.
+         * - `"Market"`: Executes immediately at the market price.
+         * - `"Limit"`: Executes at the specified limit price or better.
+         * - `"Stop Market"`: Activates as a market order when a stop price is reached.
+         * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
+         * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
+         * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
+         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
+         */
+        readonly orderType: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Market", undefined>, v.LiteralSchema<"Limit", undefined>, v.LiteralSchema<"Stop Market", undefined>, v.LiteralSchema<"Stop Limit", undefined>, v.LiteralSchema<"Take Profit Market", undefined>, v.LiteralSchema<"Take Profit Limit", undefined>], undefined>, v.DescriptionAction<"Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit", string>]>;
+        /**
+         * Time-in-force options.
+         * - `"Gtc"`: Remains active until filled or canceled.
+         * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
+         * - `"Alo"`: Adds liquidity only.
+         * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
+         * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
+         */
+        readonly tif: v.SchemaWithPipe<readonly [v.UnionSchema<[v.UnionSchema<[v.LiteralSchema<"Gtc", undefined>, v.LiteralSchema<"Ioc", undefined>, v.LiteralSchema<"Alo", undefined>, v.LiteralSchema<"FrontendMarket", undefined>, v.LiteralSchema<"LiquidationMarket", undefined>], undefined>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null, string>]>;
+        /** Client Order ID. */
+        readonly cloid: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<`0x${string}` | null, "Client Order ID.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        side: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: any;
+        isPositionTpsl: boolean;
+        reduceOnly: boolean;
+        orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+        tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+        cloid: `0x${string}` | null;
+    }, "Open order with additional display information.">]>, undefined>, v.DescriptionAction<{
+        coin: string;
+        side: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: any;
+        isPositionTpsl: boolean;
+        reduceOnly: boolean;
+        orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+        tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+        cloid: `0x${string}` | null;
+    }[], "Array of open orders with additional display information.">]>;
+}, undefined>, v.DescriptionAction<{
+    dex: string;
+    user: `0x${string}`;
+    orders: {
+        coin: string;
+        side: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: any;
+        isPositionTpsl: boolean;
+        reduceOnly: boolean;
+        orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+        tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+        cloid: `0x${string}` | null;
+    }[];
+}, "Event of open orders for a specific user.">]>;
+export type OpenOrdersEvent = v.InferOutput<typeof OpenOrdersEvent>;
+/** Request parameters for the {@linkcode openOrders} function. */
+export type OpenOrdersParameters = Omit<v.InferInput<typeof OpenOrdersRequest>, "type">;
+/**
+ * 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 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 { openOrders } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await openOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function openOrders(config: SubscriptionRequestConfig, params: DeepImmutable<OpenOrdersParameters>, listener: (data: OpenOrdersEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=openOrders.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"openOrders.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/openOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AAC3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,6DAA6D;AAC7D,eAAO,MAAM,iBAAiB;IAGxB,4BAA4B;;IAK5B,oBAAoB;;IAKpB,4CAA4C;;;;;;8DAQ9C,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAExE,gDAAgD;AAChD,eAAO,MAAM,eAAe;IAGtB,4CAA4C;;IAK5C,oBAAoB;;IAKpB,gEAAgE;;QAMxD,oBAAoB;;QAKpB,kDAAkD;;QAKlD,mBAAmB;;QAKnB,YAAY;;QAKZ,gBAAgB;;QAKhB,+DAA+D;;QAK/D,wCAAwC;;QAKxC,0CAA0C;;QAK1C,iDAAiD;;QAKjD,qBAAqB;;QAKrB,+CAA+C;;QAM/C,wDAAwD;;QAKxD,kDAAkD;;QAKlD;;;;;;;;;WASG;;QAoBH;;;;;;;WAOG;;QAqBH,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iDAcjC,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAIpE,kEAAkE;AAClE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GACxC,OAAO,CAAC,YAAY,CAAC,CAWvB"}

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

@@ -0,0 +1,142 @@
+import * as v from "valibot";
+import { Address, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/** 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: v.pipe(v.array(
+        /** Open order with additional display information. */
+        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.union([v.literal("B"), v.literal("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.")),
+            /** Condition for triggering the order. */
+            triggerCondition: v.pipe(v.string(), v.description("Condition for triggering the order.")),
+            /** Indicates if the order is a trigger order. */
+            isTrigger: v.pipe(v.boolean(), v.description("Indicates if the order is a trigger order.")),
+            /** Trigger price. */
+            triggerPx: v.pipe(UnsignedDecimal, v.description("Trigger price.")),
+            /** Child orders associated with this order. */
+            children: v.pipe(
+            // deno-lint-ignore no-explicit-any
+            v.lazy(() => OpenOrdersEvent.entries.orders), v.description("Child orders associated with this order.")),
+            /** Indicates if the order is a position TP/SL order. */
+            isPositionTpsl: v.pipe(v.boolean(), v.description("Indicates if the order is a position TP/SL order.")),
+            /** Indicates whether the order is reduce-only. */
+            reduceOnly: v.pipe(v.boolean(), v.description("Indicates whether the order is reduce-only.")),
+            /**
+             * Order type for market execution.
+             * - `"Market"`: Executes immediately at the market price.
+             * - `"Limit"`: Executes at the specified limit price or better.
+             * - `"Stop Market"`: Activates as a market order when a stop price is reached.
+             * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
+             * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
+             * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
+             * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
+             */
+            orderType: v.pipe(v.union([
+                v.literal("Market"),
+                v.literal("Limit"),
+                v.literal("Stop Market"),
+                v.literal("Stop Limit"),
+                v.literal("Take Profit Market"),
+                v.literal("Take Profit Limit"),
+            ]), v.description("Order type for market execution." +
+                '\n- `"Market"`: Executes immediately at the market price. ' +
+                '\n- `"Limit"`: Executes at the specified limit price or better. ' +
+                '\n- `"Stop Market"`: Activates as a market order when a stop price is reached. ' +
+                '\n- `"Stop Limit"`: Activates as a limit order when a stop price is reached. ' +
+                '\n- `"Take Profit Market"`: Executes as a market order when a take profit price is reached. ' +
+                '\n- `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached. ')),
+            /**
+             * Time-in-force options.
+             * - `"Gtc"`: Remains active until filled or canceled.
+             * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
+             * - `"Alo"`: Adds liquidity only.
+             * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
+             * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
+             */
+            tif: v.pipe(v.union([
+                v.union([
+                    v.literal("Gtc"),
+                    v.literal("Ioc"),
+                    v.literal("Alo"),
+                    v.literal("FrontendMarket"),
+                    v.literal("LiquidationMarket"),
+                ]),
+                v.null(),
+            ]), v.description("Time-in-force options." +
+                '\n- `"Gtc"`: Remains active until filled or canceled. ' +
+                '\n- `"Ioc"`: Fills immediately or cancels any unfilled portion. ' +
+                '\n- `"Alo"`: Adds liquidity only. ' +
+                '\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI. ' +
+                '\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.')),
+            /** Client Order ID. */
+            cloid: v.pipe(v.union([v.pipe(Hex, v.length(34)), v.null()]), v.description("Client Order ID.")),
+        }), v.description("Open order with additional display information."))), v.description("Array of open orders with additional display information.")),
+    }), 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 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 { openOrders } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await openOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function openOrders(config, params, listener) {
+    const payload = parser(OpenOrdersRequest)({
+        type: "openOrders",
+        ...params,
+        dex: params.dex ?? "",
+    });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user.toLowerCase() && e.detail.dex === payload.dex) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=openOrders.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"openOrders.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/openOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI3G,oDAAoD;AAEpD,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,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK;QACL,sDAAsD;QACtD,CAAC,CAAC,IAAI,CACJ,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,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EACzC,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,CAAC,0DAA0D,CAAC,CAC1E;YACD,wCAAwC;YACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;YACD,0CAA0C;YAC1C,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;YACD,iDAAiD;YACjD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D;YACD,qBAAqB;YACrB,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,+CAA+C;YAC/C,QAAQ,EAAE,CAAC,CAAC,IAAI;YACd,mCAAmC;YACnC,CAAC,CAAC,IAAI,CAAM,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,EACjD,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;YACD,wDAAwD;YACxD,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;YACD,kDAAkD;YAClD,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;YACD;;;;;;;;;eASG;YACH,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,KAAK,CAAC;gBACN,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACnB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;gBAClB,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;gBACxB,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;gBACvB,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;aAC/B,CAAC,EACF,CAAC,CAAC,WAAW,CACX,kCAAkC;gBAChC,4DAA4D;gBAC5D,kEAAkE;gBAClE,iFAAiF;gBACjF,+EAA+E;gBAC/E,8FAA8F;gBAC9F,4FAA4F,CAC/F,CACF;YACD;;;;;;;eAOG;YACH,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC;gBACN,CAAC,CAAC,KAAK,CAAC;oBACN,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oBAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oBAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oBAChB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;oBAC3B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;iBAC/B,CAAC;gBACF,CAAC,CAAC,IAAI,EAAE;aACT,CAAC,EACF,CAAC,CAAC,WAAW,CACX,wBAAwB;gBACtB,wDAAwD;gBACxD,kEAAkE;gBAClE,oCAAoC;gBACpC,kEAAkE;gBAClE,oEAAoE,CACvE,CACF;YACD,uBAAuB;YACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAC9C,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAC3E;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,UAAU,CACxB,MAAiC,EACjC,MAA2C,EAC3C,QAAyC;IAEzC,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACxC,IAAI,EAAE,YAAY;QAClB,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE;KACtB,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,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,126 @@
+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 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.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Original size at order placement.">]>;
+        /** Indicates whether the order is reduce-only. */
+        readonly reduceOnly: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates whether the order is reduce-only.">]>;
+        /** 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.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        side: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        reduceOnly?: true | undefined;
+        cloid?: `0x${string}` | 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).
+     */
+    readonly status: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"open", undefined>, v.LiteralSchema<"filled", undefined>, v.LiteralSchema<"canceled", undefined>, v.LiteralSchema<"triggered", undefined>, v.LiteralSchema<"rejected", undefined>, v.LiteralSchema<"marginCanceled", undefined>, v.LiteralSchema<"vaultWithdrawalCanceled", undefined>, v.LiteralSchema<"openInterestCapCanceled", undefined>, v.LiteralSchema<"selfTradeCanceled", undefined>, v.LiteralSchema<"reduceOnlyCanceled", undefined>, v.LiteralSchema<"siblingFilledCanceled", undefined>, v.LiteralSchema<"delistedCanceled", undefined>, v.LiteralSchema<"liquidatedCanceled", undefined>, v.LiteralSchema<"scheduledCancel", undefined>, v.LiteralSchema<"reduceOnlyRejected", undefined>], undefined>, v.DescriptionAction<"open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected", 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.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: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        reduceOnly?: true | undefined;
+        cloid?: `0x${string}` | undefined;
+    };
+    status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected";
+    statusTimestamp: number;
+}, "Order with its current processing status.">]>, undefined>, v.DescriptionAction<{
+    order: {
+        coin: string;
+        side: "B" | "A";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        reduceOnly?: true | undefined;
+        cloid?: `0x${string}` | undefined;
+    };
+    status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected";
+    statusTimestamp: number;
+}[], "Event of array of orders with their current processing status.">]>;
+export type OrderUpdatesEvent = v.InferOutput<typeof OrderUpdatesEvent>;
+/** 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 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 { orderUpdates } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await orderUpdates(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function orderUpdates(config: SubscriptionRequestConfig, params: DeepImmutable<OrderUpdatesParameters>, listener: (data: OrderUpdatesEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=orderUpdates.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"orderUpdates.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/orderUpdates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AAC3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,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;;QAK/D,wCAAwC;;QAKxC,kDAAkD;;QAKlD,uBAAuB;;;;;;;;;;;;;IAQ3B;;;;;;;;;;;;;;;;OAgBG;;IAqCH,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wEAW5E,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,YAAY,CAAC,CAKvB"}