@hfunlabs/hyperliquid 0.27.1 → 0.29.1-hfunlabs.1

package/script/src/api/subscription/_methods/notification.js

@@ -0,0 +1,93 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationEvent = exports.NotificationRequest = void 0;
+exports.notification = notification;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _schemas_js_1 = require("../../_schemas.js");
+/** Subscription to notification events for a specific user. */
+exports.NotificationRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("notification"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(_schemas_js_1.Address, v.description("User address.")),
+    }), v.description("Subscription to notification events for a specific user."));
+})();
+/** Event of user notification. */
+exports.NotificationEvent = (() => {
+    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 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 { notification } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await notification(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+function notification(config, params, listener) {
+    const payload = v.parse(exports.NotificationRequest, { type: "notification", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=notification.js.map

package/script/src/api/subscription/_methods/notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/notification.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiFA,oCASC;AA1FD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAA4C;AAE5C,+DAA+D;AAClD,QAAA,mBAAmB,GAAmB,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,qBAAO,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;AACrB,QAAA,iBAAiB,GAAmB,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;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,YAAY,CAC1B,MAA0B,EAC1B,MAA8B,EAC9B,QAA2C;IAE3C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,2BAAmB,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/script/src/api/subscription/_methods/openOrders.d.ts

@@ -0,0 +1,131 @@
+import * as v from "valibot";
+/** 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<{
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        readonly side: v.SchemaWithPipe<readonly [v.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+        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.">]>;
+        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.">]>;
+        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.">]>;
+        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).">]>;
+        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.">]>;
+        readonly triggerCondition: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Condition for triggering the order.">]>;
+        readonly isTrigger: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a trigger order.">]>;
+        readonly triggerPx: 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, "Trigger price.">]>;
+        readonly children: v.SchemaWithPipe<readonly [v.ArraySchema<v.UnknownSchema, undefined>, v.DescriptionAction<unknown[], "Child orders associated with this order.">]>;
+        readonly isPositionTpsl: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a position TP/SL order.">]>;
+        readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates whether the order is reduce-only.">]>;
+        readonly orderType: v.SchemaWithPipe<readonly [v.PicklistSchema<["Market", "Limit", "Stop Market", "Stop Limit", "Take Profit Market", "Take Profit Limit"], undefined>, v.DescriptionAction<"Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit", string>]>;
+        readonly tif: v.SchemaWithPipe<readonly [v.NullableSchema<v.PicklistSchema<["Gtc", "Ioc", "Alo", "FrontendMarket", "LiquidationMarket"], undefined>, undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null, string>]>;
+        readonly cloid: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "Client Order ID.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        side: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: unknown[];
+        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: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: unknown[];
+        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: "A" | "B";
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+        triggerCondition: string;
+        isTrigger: boolean;
+        triggerPx: string;
+        children: unknown[];
+        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>;
+import type { SubscriptionConfig } from "./_types.js";
+import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+/** 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 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 declare function openOrders(config: SubscriptionConfig, params: OpenOrdersParameters, listener: (data: OpenOrdersEvent) => void): Promise<WebSocketSubscription>;
+//# sourceMappingURL=openOrders.d.ts.map

package/script/src/api/subscription/_methods/openOrders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openOrders.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/openOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iDAKlE,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAMpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,kEAAkE;AAClE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB,EAC5B,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GACxC,OAAO,CAAC,qBAAqB,CAAC,CAWhC"}

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

@@ -0,0 +1,106 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenOrdersEvent = exports.OpenOrdersRequest = void 0;
+exports.openOrders = openOrders;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _schemas_js_1 = require("../../_schemas.js");
+const frontendOpenOrders_js_1 = require("../../info/_methods/frontendOpenOrders.js");
+/** Subscription to open order events for a specific user. */
+exports.OpenOrdersRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("openOrders"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(_schemas_js_1.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. */
+exports.OpenOrdersEvent = (() => {
+    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(_schemas_js_1.Address, v.description("User address.")),
+        /** Array of open orders with additional display information. */
+        orders: frontendOpenOrders_js_1.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
+ */
+function openOrders(config, params, listener) {
+    const payload = v.parse(exports.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/script/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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,gCAeC;AA7GD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAA4C;AAC5C,qFAAuF;AAEvF,6DAA6D;AAChD,QAAA,iBAAiB,GAAmB,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,qBAAO,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;AACnC,QAAA,eAAe,GAAmB,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,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,gEAAgE;QAChE,MAAM,EAAE,kDAA0B;KACnC,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,UAAU,CACxB,MAA0B,EAC1B,MAA4B,EAC5B,QAAyC;IAEzC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,yBAAiB,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/script/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/script/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"}