@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/esm/src/api/exchange/order.d.ts

@@ -0,0 +1,354 @@
+import * as v from "valibot";
+/**
+ * Place an order(s).
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
+export declare const OrderRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"order", undefined>, v.DescriptionAction<"order", "Type of action.">]>;
+        /** Order parameters. */
+        readonly orders: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            readonly a: 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, "Asset ID.">]>;
+            readonly b: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Position side (`true` for long, `false` for short).">]>;
+            readonly p: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
+            readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Size (in base currency units).">]>;
+            readonly r: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Is reduce-only?">]>;
+            readonly t: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+                readonly limit: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    readonly tif: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Gtc", undefined>, v.LiteralSchema<"Ioc", undefined>, v.LiteralSchema<"Alo", undefined>, v.LiteralSchema<"FrontendMarket", undefined>, v.LiteralSchema<"LiquidationMarket", undefined>], undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket", string>]>;
+                }, undefined>, v.DescriptionAction<{
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                }, "Limit order parameters.">]>;
+            }, undefined>, v.ObjectSchema<{
+                readonly trigger: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    readonly isMarket: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Is market 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Trigger price.">]>;
+                    readonly tpsl: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"tp", undefined>, v.LiteralSchema<"sl", undefined>], undefined>, v.DescriptionAction<"tp" | "sl", "Indicates whether it is take profit or stop loss.">]>;
+                }, undefined>, v.DescriptionAction<{
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                }, "Trigger order parameters.">]>;
+            }, undefined>], undefined>, v.DescriptionAction<{
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            }, "Order type.">]>;
+            readonly c: 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<{
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        }, "Place order parameters.">]>, undefined>, v.DescriptionAction<{
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        }[], "Order parameters.">]>;
+        /**
+         * Order grouping strategy:
+         * - `na`: Standard order without grouping (default).
+         * - `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes.
+         * - `positionTpsl`: TP/SL order that adjusts proportionally with the position size.
+         */
+        readonly grouping: v.SchemaWithPipe<readonly [v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"na", undefined>, v.LiteralSchema<"normalTpsl", undefined>, v.LiteralSchema<"positionTpsl", undefined>], undefined>, "na">, v.DescriptionAction<"na" | "normalTpsl" | "positionTpsl", string>]>;
+        /** Builder fee. */
+        readonly builder: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ObjectSchema<{
+            /** Builder address. */
+            readonly b: 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}`, "Builder address.">]>;
+            /** Builder fee in 0.1bps (1 = 0.0001%). */
+            readonly f: 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, "Builder fee in 0.1bps (1 = 0.0001%).">]>;
+        }, undefined>, undefined>, v.DescriptionAction<{
+            b: `0x${string}`;
+            f: number;
+        } | undefined, "Builder fee.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "order";
+        orders: {
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        }[];
+        grouping: "na" | "normalTpsl" | "positionTpsl";
+        builder?: {
+            b: `0x${string}`;
+            f: number;
+        } | undefined;
+    }, "Action to perform.">]>;
+    /** Unique request identifier (current timestamp in ms). */
+    readonly nonce: 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, "Unique request identifier (current timestamp in ms).">]>;
+    /** Cryptographic signature. */
+    readonly signature: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly r: 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}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "First 32-byte component of ECDSA signature.">]>;
+        readonly s: 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}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<27, undefined>, v.LiteralSchema<28, undefined>], undefined>, v.DescriptionAction<27 | 28, "Recovery identifier.">]>;
+    }, undefined>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "ECDSA signature components for Ethereum typed data.">]>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "Cryptographic signature.">]>;
+    /** Vault address (for vault trading). */
+    readonly vaultAddress: 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}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | undefined, "Vault address (for vault trading).">]>;
+    /** Expiration time of the action. */
+    readonly expiresAfter: v.SchemaWithPipe<readonly [v.OptionalSchema<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>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "order";
+        orders: {
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        }[];
+        grouping: "na" | "normalTpsl" | "positionTpsl";
+        builder?: {
+            b: `0x${string}`;
+            f: number;
+        } | undefined;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    vaultAddress?: `0x${string}` | undefined;
+    expiresAfter?: number | undefined;
+}, "Place an order(s).">]>;
+export type OrderRequest = v.InferOutput<typeof OrderRequest>;
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
+export declare const OrderResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Successful status. */
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    /** Response details. */
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Type of response. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"order", undefined>, v.DescriptionAction<"order", "Type of response.">]>;
+        /** Specific data. */
+        readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Array of statuses or error messages. */
+            readonly statuses: v.SchemaWithPipe<readonly [v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
+                /** Resting order status. */
+                readonly resting: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /** 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.">]>;
+                    /** 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<{
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                }, "Resting order status.">]>;
+            }, undefined>, v.ObjectSchema<{
+                /** Filled order status. */
+                readonly filled: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /** Total size filled. */
+                    readonly totalSz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total size filled.">]>;
+                    /** Average price of fill. */
+                    readonly avgPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Average price of fill.">]>;
+                    /** 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.">]>;
+                    /** 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<{
+                    totalSz: string;
+                    avgPx: string;
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                }, "Filled order status.">]>;
+            }, undefined>, v.ObjectSchema<{
+                /** Error message. */
+                readonly error: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+            }, undefined>], undefined>, undefined>, v.DescriptionAction<({
+                resting: {
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                filled: {
+                    totalSz: string;
+                    avgPx: string;
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                error: string;
+            })[], "Array of statuses or error messages.">]>;
+        }, undefined>, v.DescriptionAction<{
+            statuses: ({
+                resting: {
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                filled: {
+                    totalSz: string;
+                    avgPx: string;
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                error: string;
+            })[];
+        }, "Specific data.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "order";
+        data: {
+            statuses: ({
+                resting: {
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                filled: {
+                    totalSz: string;
+                    avgPx: string;
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                error: string;
+            })[];
+        };
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "order";
+        data: {
+            statuses: ({
+                resting: {
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                filled: {
+                    totalSz: string;
+                    avgPx: string;
+                    oid: number;
+                    cloid?: `0x${string}` | undefined;
+                };
+            } | {
+                error: string;
+            })[];
+        };
+    };
+}, "Response for order placement and batch modifications.">]>;
+export type OrderResponse = v.InferOutput<typeof OrderResponse>;
+import { type DeepImmutable } from "../_base.js";
+import { type ExchangeRequestConfig, type ExcludeErrorResponse, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_base/mod.js";
+/** Action parameters for the {@linkcode order} function. */
+export type OrderParameters = ExtractRequestAction<v.InferInput<typeof OrderRequest>>;
+/** Request options for the {@linkcode order} function. */
+export type OrderOptions = ExtractRequestOptions<v.InferInput<typeof OrderRequest>>;
+/** Successful variant of {@linkcode OrderResponse} without errors. */
+export type OrderSuccessResponse = ExcludeErrorResponse<OrderResponse>;
+/**
+ * Place an order(s).
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful variant of {@link OrderResponse} without error statuses.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { order } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await order(
+ *   { transport, wallet },
+ *   {
+ *     orders: [
+ *       {
+ *         a: 0,
+ *         b: true,
+ *         p: "30000",
+ *         s: "0.1",
+ *         r: false,
+ *         t: { limit: { tif: "Gtc" } },
+ *         c: "0x...",
+ *       },
+ *     ],
+ *     grouping: "na",
+ *   },
+ * );
+ * ```
+ */
+export declare function order(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<OrderParameters>, opts?: OrderOptions): Promise<OrderSuccessResponse>;
+//# sourceMappingURL=order.d.ts.map

package/esm/src/api/exchange/order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/order.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAU7B;;;GAGG;AACH,eAAO,MAAM,YAAY;IAGnB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAKxB;;;;;WAKG;;QAiBH,mBAAmB;;YAGf,uBAAuB;;YAKvB,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAWnD,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,yCAAyC;;IAKzC,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAQvC,CAAC;AACL,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,aAAa;IAGpB,yBAAyB;;IAKzB,wBAAwB;;QAGpB,wBAAwB;;QAKxB,qBAAqB;;YAGjB,2CAA2C;;gBAKnC,4BAA4B;;oBAGxB,gBAAgB;;oBAKhB,uBAAuB;;;;;;;gBAU3B,2BAA2B;;oBAGvB,yBAAyB;;oBAKzB,6BAA6B;;oBAK7B,gBAAgB;;oBAKhB,uBAAuB;;;;;;;;;gBAU3B,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6DAmBvC,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAMhE,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,4DAA4D;AAC5D,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,MAAM,YAAY,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC;AAEpF,sEAAsE;AACtE,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,KAAK,CACzB,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,oBAAoB,CAAC,CAkB/B"}

package/esm/src/api/exchange/order.js

@@ -0,0 +1,162 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { Signature } from "./_base/mod.js";
+import { PlaceOrderParamsSchema } from "../_common_schemas.js";
+/**
+ * Place an order(s).
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
+export const OrderRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("order"), v.description("Type of action.")),
+            /** Order parameters. */
+            orders: v.pipe(v.array(PlaceOrderParamsSchema), v.description("Order parameters.")),
+            /**
+             * Order grouping strategy:
+             * - `na`: Standard order without grouping (default).
+             * - `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes.
+             * - `positionTpsl`: TP/SL order that adjusts proportionally with the position size.
+             */
+            grouping: v.pipe(v.optional(v.union([
+                v.literal("na"),
+                v.literal("normalTpsl"),
+                v.literal("positionTpsl"),
+            ]), "na"), v.description("Order grouping strategy:" +
+                "\n- `na`: Standard order without grouping." +
+                "\n- `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes." +
+                "\n- `positionTpsl`: TP/SL order that adjusts proportionally with the position size.")),
+            /** Builder fee. */
+            builder: v.pipe(v.optional(v.object({
+                /** Builder address. */
+                b: v.pipe(Address, v.description("Builder address.")),
+                /** Builder fee in 0.1bps (1 = 0.0001%). */
+                f: v.pipe(UnsignedInteger, v.description("Builder fee in 0.1bps (1 = 0.0001%).")),
+            })), v.description("Builder fee.")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(Signature, v.description("Cryptographic signature.")),
+        /** Vault address (for vault trading). */
+        vaultAddress: v.pipe(v.optional(Address), v.description("Vault address (for vault trading).")),
+        /** Expiration time of the action. */
+        expiresAfter: v.pipe(v.optional(UnsignedInteger), v.description("Expiration time of the action.")),
+    }), v.description("Place an order(s)."));
+})();
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
+export const OrderResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Successful status. */
+        status: v.pipe(v.literal("ok"), v.description("Successful status.")),
+        /** Response details. */
+        response: v.pipe(v.object({
+            /** Type of response. */
+            type: v.pipe(v.literal("order"), v.description("Type of response.")),
+            /** Specific data. */
+            data: v.pipe(v.object({
+                /** Array of statuses or error messages. */
+                statuses: v.pipe(v.array(v.union([
+                    v.object({
+                        /** Resting order status. */
+                        resting: v.pipe(v.object({
+                            /** Order ID. */
+                            oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+                            /** Client Order ID. */
+                            cloid: v.pipe(v.optional(v.pipe(Hex, v.length(34))), v.description("Client Order ID.")),
+                        }), v.description("Resting order status.")),
+                    }),
+                    v.object({
+                        /** Filled order status. */
+                        filled: v.pipe(v.object({
+                            /** Total size filled. */
+                            totalSz: v.pipe(UnsignedDecimal, v.description("Total size filled.")),
+                            /** Average price of fill. */
+                            avgPx: v.pipe(UnsignedDecimal, v.description("Average price of fill.")),
+                            /** Order ID. */
+                            oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+                            /** Client Order ID. */
+                            cloid: v.pipe(v.optional(v.pipe(Hex, v.length(34))), v.description("Client Order ID.")),
+                        }), v.description("Filled order status.")),
+                    }),
+                    v.object({
+                        /** Error message. */
+                        error: v.pipe(v.string(), v.description("Error message.")),
+                    }),
+                ])), v.description("Array of statuses or error messages.")),
+            }), v.description("Specific data.")),
+        }), v.description("Response details.")),
+    }), v.description("Response for order placement and batch modifications."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parser } from "../_base.js";
+import { executeL1Action, } from "./_base/mod.js";
+/**
+ * Place an order(s).
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful variant of {@link OrderResponse} without error statuses.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { order } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await order(
+ *   { transport, wallet },
+ *   {
+ *     orders: [
+ *       {
+ *         a: 0,
+ *         b: true,
+ *         p: "30000",
+ *         s: "0.1",
+ *         r: false,
+ *         t: { limit: { tif: "Gtc" } },
+ *         c: "0x...",
+ *       },
+ *     ],
+ *     grouping: "na",
+ *   },
+ * );
+ * ```
+ */
+export async function order(config, params, opts) {
+    const request = parser(OrderRequest)({
+        action: {
+            type: "order",
+            ...params,
+        },
+        nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
+        signature: {
+            r: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            s: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            v: 27,
+        },
+        vaultAddress: opts?.vaultAddress ?? config.defaultVaultAddress,
+        expiresAfter: typeof config.defaultExpiresAfter === "number"
+            ? config.defaultExpiresAfter
+            : await config.defaultExpiresAfter?.(),
+    });
+    return await executeL1Action(config, request, opts?.signal);
+}
+//# sourceMappingURL=order.js.map

package/esm/src/api/exchange/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/order.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,MAAM,CAAC;YACP,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,wBAAwB;YACxB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD;;;;;eAKG;YACH,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,KAAK,CAAC;gBACN,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;gBACvB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;aAC1B,CAAC,EACF,IAAI,CACL,EACD,CAAC,CAAC,WAAW,CACX,0BAA0B;gBACxB,4CAA4C;gBAC5C,0FAA0F;gBAC1F,qFAAqF,CACxF,CACF;YACD,mBAAmB;YACnB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;gBAClB,uBAAuB;gBACvB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;gBACD,2CAA2C;gBAC3C,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;aACF,CAAC,CAAC,EACH,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,SAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,yCAAyC;QACzC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,wBAAwB;QACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,qBAAqB;YACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;gBACP,2CAA2C;gBAC3C,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,KAAK,CAAC;oBACN,CAAC,CAAC,MAAM,CAAC;wBACP,4BAA4B;wBAC5B,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,MAAM,CAAC;4BACP,gBAAgB;4BAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;4BACD,uBAAuB;4BACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;yBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;qBACF,CAAC;oBACF,CAAC,CAAC,MAAM,CAAC;wBACP,2BAA2B;wBAC3B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,MAAM,CAAC;4BACP,yBAAyB;4BACzB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;4BACD,6BAA6B;4BAC7B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;4BACD,gBAAgB;4BAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;4BACD,uBAAuB;4BACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;yBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;qBACF,CAAC;oBACF,CAAC,CAAC,MAAM,CAAC;wBACP,qBAAqB;wBACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;qBACF,CAAC;iBACH,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAGL,eAAe,GAIhB,MAAM,gBAAgB,CAAC;AAWxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,MAAsD,EACtD,MAAsC,EACtC,IAAmB;IAEnB,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;QACnC,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,GAAG,MAAM;SACV;QACD,KAAK,EAAE,CAAC,EAAE,2DAA2D;QACrE,SAAS,EAAE;YACT,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,EAAE;SACN;QACD,YAAY,EAAE,IAAI,EAAE,YAAY,IAAI,MAAM,CAAC,mBAAmB;QAC9D,YAAY,EAAE,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;YAC1D,CAAC,CAAC,MAAM,CAAC,mBAAmB;YAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE;KACzC,CAAC,CAAC;IACH,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC9D,CAAC"}