@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/info/orderStatus.d.ts

@@ -0,0 +1,198 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request order status.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ */
+export declare const OrderStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"orderStatus", undefined>, v.DescriptionAction<"orderStatus", "Type of request.">]>;
+    /** 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.">]>;
+    /** Order ID or Client Order ID. */
+    readonly oid: v.SchemaWithPipe<readonly [v.UnionSchema<[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.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<number | `0x${string}`, "Order ID or Client Order ID.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "orderStatus";
+    user: `0x${string}`;
+    oid: number | `0x${string}`;
+}, "Request order status.">]>;
+export type OrderStatusRequest = v.InferOutput<typeof OrderStatusRequest>;
+/**
+ * Order status response.
+ * - If the order is found, returns detailed order information and its current status.
+ * - If the order is not found, returns a status of "unknownOid".
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ */
+export declare const OrderStatusResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+    /** Indicates that the order was found. */
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"order", undefined>, v.DescriptionAction<"order", "Indicates that the order was found.">]>;
+    /** Order status details. */
+    readonly order: 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.">]>;
+            /** 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.ArraySchema<v.LazySchema<any>, undefined>, 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;
+        }, "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;
+            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;
+        };
+        status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected";
+        statusTimestamp: number;
+    }, "Order status details.">]>;
+}, undefined>, v.ObjectSchema<{
+    /** Indicates that the order was not found. */
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"unknownOid", undefined>, v.DescriptionAction<"unknownOid", "Indicates that the order was not found.">]>;
+}, undefined>], undefined>, v.DescriptionAction<{
+    status: "order";
+    order: {
+        order: {
+            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;
+        };
+        status: "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected";
+        statusTimestamp: number;
+    };
+} | {
+    status: "unknownOid";
+}, string>]>;
+export type OrderStatusResponse = v.InferOutput<typeof OrderStatusResponse>;
+/** Request parameters for the {@linkcode orderStatus} function. */
+export type OrderStatusParameters = Omit<v.InferInput<typeof OrderStatusRequest>, "type">;
+/**
+ * Request order status.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Order status response.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { orderStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await orderStatus(
+ *   { transport },
+ *   { user: "0x...", oid: 12345 },
+ * );
+ * ```
+ */
+export declare function orderStatus(config: InfoRequestConfig, params: DeepImmutable<OrderStatusParameters>, signal?: AbortSignal): Promise<OrderStatusResponse>;
+//# sourceMappingURL=orderStatus.d.ts.map

package/esm/src/api/info/orderStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderStatus.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/orderStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AAC3G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,uBAAuB;;IAKvB,oBAAoB;;IAKpB,mCAAmC;;;;;;6BAQrC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAIxB,0CAA0C;;IAK1C,4BAA4B;;QAGxB,qBAAqB;;YAGjB,oBAAoB;;YAKpB,kDAAkD;;YAKlD,mBAAmB;;YAKnB,YAAY;;YAKZ,gBAAgB;;YAKhB,+DAA+D;;YAK/D,wCAAwC;;YAKxC,0CAA0C;;YAK1C,iDAAiD;;YAKjD,qBAAqB;;YAKrB,+CAA+C;;YAM/C,wDAAwD;;YAKxD,kDAAkD;;YAKlD;;;;;;;;;eASG;;YAoBH;;;;;;;eAOG;;YAqBH,uBAAuB;;;;;;;;;;;;;;;;;;;;QAQ3B;;;;;;;;;;;;;;;;WAgBG;;QAqCH,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;IAU1E,8CAA8C;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAalD,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAI5E,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC,CAM9B"}

package/esm/src/api/info/orderStatus.js

@@ -0,0 +1,200 @@
+import * as v from "valibot";
+import { Address, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request order status.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ */
+export const OrderStatusRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("orderStatus"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Order ID or Client Order ID. */
+        oid: v.pipe(v.union([UnsignedInteger, v.pipe(Hex, v.length(34))]), v.description("Order ID or Client Order ID.")),
+    }), v.description("Request order status."));
+})();
+/**
+ * Order status response.
+ * - If the order is found, returns detailed order information and its current status.
+ * - If the order is not found, returns a status of "unknownOid".
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ */
+export const OrderStatusResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.union([
+        v.object({
+            /** Indicates that the order was found. */
+            status: v.pipe(v.literal("order"), v.description("Indicates that the order was found.")),
+            /** Order status details. */
+            order: 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.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.array(v.lazy(() => OrderStatusResponse.options[0].entries.order)), 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("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).
+                 */
+                status: v.pipe(v.union([
+                    v.literal("open"),
+                    v.literal("filled"),
+                    v.literal("canceled"),
+                    v.literal("triggered"),
+                    v.literal("rejected"),
+                    v.literal("marginCanceled"),
+                    v.literal("vaultWithdrawalCanceled"),
+                    v.literal("openInterestCapCanceled"),
+                    v.literal("selfTradeCanceled"),
+                    v.literal("reduceOnlyCanceled"),
+                    v.literal("siblingFilledCanceled"),
+                    v.literal("delistedCanceled"),
+                    v.literal("liquidatedCanceled"),
+                    v.literal("scheduledCancel"),
+                    v.literal("reduceOnlyRejected"),
+                ]), 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).')),
+                /** 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 status details.")),
+        }),
+        v.object({
+            /** Indicates that the order was not found. */
+            status: v.pipe(v.literal("unknownOid"), v.description("Indicates that the order was not found.")),
+        }),
+    ]), v.description("Order status response." +
+        "\n- If the order is found, returns detailed order information and its current status." +
+        '\n- If the order is not found, returns a status of "unknownOid".'));
+})();
+/**
+ * Request order status.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Order status response.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { orderStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await orderStatus(
+ *   { transport },
+ *   { user: "0x...", oid: 12345 },
+ * );
+ * ```
+ */
+export function orderStatus(config, params, signal) {
+    const request = parser(OrderStatusRequest)({
+        type: "orderStatus",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=orderStatus.js.map

package/esm/src/api/info/orderStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderStatus.js","sourceRoot":"","sources":["../../../../src/src/api/info/orderStatus.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;AAG3G,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,mCAAmC;QACnC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EACrD,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC;QACN,CAAC,CAAC,MAAM,CAAC;YACP,0CAA0C;YAC1C,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;YACD,4BAA4B;YAC5B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;gBACP,qBAAqB;gBACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;oBACP,oBAAoB;oBACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;oBACD,kDAAkD;oBAClD,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;oBACD,mBAAmB;oBACnB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;oBACD,YAAY;oBACZ,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CACvB;oBACD,gBAAgB;oBAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;oBACD,+DAA+D;oBAC/D,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;oBACD,wCAAwC;oBACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;oBACD,0CAA0C;oBAC1C,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;oBACD,iDAAiD;oBACjD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D;oBACD,qBAAqB;oBACrB,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;oBACD,+CAA+C;oBAC/C,QAAQ,EAAE,CAAC,CAAC,IAAI;oBACd,mCAAmC;oBACnC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAM,GAAG,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;oBACD,wDAAwD;oBACxD,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;oBACD,kDAAkD;oBAClD,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;oBACD;;;;;;;;;uBASG;oBACH,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,KAAK,CAAC;wBACN,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;wBACnB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;wBAClB,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;wBACxB,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;wBACvB,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;wBAC/B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;qBAC/B,CAAC,EACF,CAAC,CAAC,WAAW,CACX,kCAAkC;wBAChC,4DAA4D;wBAC5D,kEAAkE;wBAClE,iFAAiF;wBACjF,+EAA+E;wBAC/E,8FAA8F;wBAC9F,4FAA4F,CAC/F,CACF;oBACD;;;;;;;uBAOG;oBACH,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC;wBACN,CAAC,CAAC,KAAK,CAAC;4BACN,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;4BAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;4BAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;4BAChB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;4BAC3B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;yBAC/B,CAAC;wBACF,CAAC,CAAC,IAAI,EAAE;qBACT,CAAC,EACF,CAAC,CAAC,WAAW,CACX,wBAAwB;wBACtB,wDAAwD;wBACxD,kEAAkE;wBAClE,oCAAoC;wBACpC,kEAAkE;wBAClE,oEAAoE,CACvE,CACF;oBACD,uBAAuB;oBACvB,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;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;gBACD;;;;;;;;;;;;;;;;mBAgBG;gBACH,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC;oBACN,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;oBACjB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACnB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;oBACrB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;oBACtB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;oBACrB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;oBAC3B,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC;oBACpC,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC;oBACpC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBAC9B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;oBAC/B,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC;oBAClC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;oBAC7B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;oBAC/B,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;oBAC5B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;iBAChC,CAAC,EACF,CAAC,CAAC,WAAW,CACX,0BAA0B;oBACxB,uDAAuD;oBACvD,wCAAwC;oBACxC,gDAAgD;oBAChD,6DAA6D;oBAC7D,kDAAkD;oBAClD,qEAAqE;oBACrE,iFAAiF;oBACjF,6GAA6G;oBAC7G,oEAAoE;oBACpE,yFAAyF;oBACzF,gFAAgF;oBAChF,6DAA6D;oBAC7D,2DAA2D;oBAC3D,oGAAoG,CACvG,CACF;gBACD,sEAAsE;gBACtE,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;SACF,CAAC;QACF,CAAC,CAAC,MAAM,CAAC;YACP,8CAA8C;YAC9C,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;SACF,CAAC;KACH,CAAC,EACF,CAAC,CAAC,WAAW,CACX,wBAAwB;QACtB,uFAAuF;QACvF,kEAAkE,CACrE,CACF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,WAAW,CACzB,MAAyB,EACzB,MAA4C,EAC5C,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACzC,IAAI,EAAE,aAAa;QACnB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/src/api/info/perpDeployAuctionStatus.d.ts

@@ -0,0 +1,56 @@
+import * as v from "valibot";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export declare const PerpDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeployAuctionStatus", undefined>, v.DescriptionAction<"perpDeployAuctionStatus", "Type of request.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "perpDeployAuctionStatus";
+}, "Request for the status of the perpetual deploy auction.">]>;
+export type PerpDeployAuctionStatusRequest = v.InferOutput<typeof PerpDeployAuctionStatusRequest>;
+/**
+ * Status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export declare const PerpDeployAuctionStatusResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Current gas. */
+    readonly currentGas: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<string | null, "Current gas.">]>;
+    /** Duration in seconds. */
+    readonly durationSeconds: 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, "Duration in seconds.">]>;
+    /** Ending gas. */
+    readonly endGas: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, undefined>, v.DescriptionAction<string | null, "Ending gas.">]>;
+    /** Starting gas. */
+    readonly startGas: 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, "Starting gas.">]>;
+    /** Auction start time (seconds since epoch). */
+    readonly startTimeSeconds: 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, "Auction start time (seconds since epoch).">]>;
+}, undefined>, v.DescriptionAction<{
+    currentGas: string | null;
+    durationSeconds: number;
+    endGas: string | null;
+    startGas: string;
+    startTimeSeconds: number;
+}, "Status of the perpetual deploy auction.">]>;
+export type PerpDeployAuctionStatusResponse = v.InferOutput<typeof PerpDeployAuctionStatusResponse>;
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Status of the perpetual deploy auction.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDeployAuctionStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDeployAuctionStatus({ transport });
+ * ```
+ */
+export declare function perpDeployAuctionStatus(config: InfoRequestConfig, signal?: AbortSignal): Promise<PerpDeployAuctionStatusResponse>;
+//# sourceMappingURL=perpDeployAuctionStatus.d.ts.map

package/esm/src/api/info/perpDeployAuctionStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDeployAuctionStatus.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/perpDeployAuctionStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,8BAA8B;IAGrC,uBAAuB;;;;+DAQzB,CAAC;AACL,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAElG;;;GAGG;AACH,eAAO,MAAM,+BAA+B;IAGtC,mBAAmB;;IAKnB,2BAA2B;;IAK3B,kBAAkB;;IAKlB,oBAAoB;;IAKpB,gDAAgD;;;;;;;;+CAQlD,CAAC;AACL,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAIpG;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,+BAA+B,CAAC,CAK1C"}

package/esm/src/api/info/perpDeployAuctionStatus.js

@@ -0,0 +1,57 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export const PerpDeployAuctionStatusRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("perpDeployAuctionStatus"), v.description("Type of request.")),
+    }), v.description("Request for the status of the perpetual deploy auction."));
+})();
+/**
+ * Status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export const PerpDeployAuctionStatusResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Current gas. */
+        currentGas: v.pipe(v.nullable(UnsignedDecimal), v.description("Current gas.")),
+        /** Duration in seconds. */
+        durationSeconds: v.pipe(UnsignedInteger, v.description("Duration in seconds.")),
+        /** Ending gas. */
+        endGas: v.pipe(v.nullable(UnsignedDecimal), v.description("Ending gas.")),
+        /** Starting gas. */
+        startGas: v.pipe(UnsignedDecimal, v.description("Starting gas.")),
+        /** Auction start time (seconds since epoch). */
+        startTimeSeconds: v.pipe(UnsignedInteger, v.description("Auction start time (seconds since epoch).")),
+    }), v.description("Status of the perpetual deploy auction."));
+})();
+// -------------------- Function --------------------
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Status of the perpetual deploy auction.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDeployAuctionStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDeployAuctionStatus({ transport });
+ * ```
+ */
+export function perpDeployAuctionStatus(config, signal) {
+    const request = parser(PerpDeployAuctionStatusRequest)({
+        type: "perpDeployAuctionStatus",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=perpDeployAuctionStatus.js.map

package/esm/src/api/info/perpDeployAuctionStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDeployAuctionStatus.js","sourceRoot":"","sources":["../../../../src/src/api/info/perpDeployAuctionStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGzE,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,EACpC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yDAAyD,CAAC,CACzE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,mBAAmB;QACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;QACD,2BAA2B;QAC3B,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,kBAAkB;QAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,oBAAoB;QACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,gDAAgD;QAChD,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qDAAqD;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAyB,EACzB,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC;QACrD,IAAI,EAAE,yBAAyB;KAChC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/src/api/info/perpDexLimits.d.ts

@@ -0,0 +1,63 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export declare const PerpDexLimitsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexLimits", undefined>, v.DescriptionAction<"perpDexLimits", "Type of request.">]>;
+    /** 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).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "perpDexLimits";
+    dex: string;
+}, "Request builder deployed perpetual market limits.">]>;
+export type PerpDexLimitsRequest = v.InferOutput<typeof PerpDexLimitsRequest>;
+/**
+ * Builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export declare const PerpDexLimitsResponse: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+    /** Total open interest cap. */
+    readonly totalOiCap: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total open interest cap.">]>;
+    /** Open interest size cap per perpetual. */
+    readonly oiSzCapPerPerp: 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, "Open interest size cap per perpetual.">]>;
+    /** Maximum transfer notional amount. */
+    readonly maxTransferNtl: 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, "Maximum transfer notional amount.">]>;
+    /** Coin to open interest cap mapping. */
+    readonly coinToOiCap: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[string, string][], "Coin to open interest cap mapping.">]>;
+}, undefined>, undefined>, v.DescriptionAction<{
+    totalOiCap: string;
+    oiSzCapPerPerp: string;
+    maxTransferNtl: string;
+    coinToOiCap: [string, string][];
+} | null, "Builder deployed perpetual market limits.">]>;
+export type PerpDexLimitsResponse = v.InferOutput<typeof PerpDexLimitsResponse>;
+/** Request parameters for the {@linkcode perpDexLimits} function. */
+export type PerpDexLimitsParameters = Omit<v.InferInput<typeof PerpDexLimitsRequest>, "type">;
+/**
+ * Request builder deployed perpetual market limits.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Builder deployed perpetual market limits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexLimits } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexLimits(
+ *   { transport },
+ *   { dex: "test" },
+ * );
+ * ```
+ */
+export declare function perpDexLimits(config: InfoRequestConfig, params: DeepImmutable<PerpDexLimitsParameters>, signal?: AbortSignal): Promise<PerpDexLimitsResponse>;
+//# sourceMappingURL=perpDexLimits.d.ts.map

package/esm/src/api/info/perpDexLimits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDexLimits.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/perpDexLimits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,uBAAuB;;IAKvB,4CAA4C;;;;;yDAQ9C,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAI1B,+BAA+B;;IAK/B,4CAA4C;;IAK5C,wCAAwC;;IAKxC,yCAAyC;;;;;;;wDAS7C,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAIhF,qEAAqE;AACrE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC9C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAMhC"}