@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,329 @@
+import * as v from "valibot";
+import { OrderResponse } from "./order.js";
+/**
+ * Modify multiple orders.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export declare const BatchModifyRequest: 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<"batchModify", undefined>, v.DescriptionAction<"batchModify", "Type of action.">]>;
+        /** Order modifications. */
+        readonly modifies: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+            /** 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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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.">]>;
+            /** New order parameters. */
+            readonly order: 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>, undefined>, v.DescriptionAction<{
+            oid: number | `0x${string}`;
+            order: {
+                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 modifications.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "batchModify";
+        modifies: {
+            oid: number | `0x${string}`;
+            order: {
+                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;
+            };
+        }[];
+    }, "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: "batchModify";
+        modifies: {
+            oid: number | `0x${string}`;
+            order: {
+                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;
+            };
+        }[];
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    vaultAddress?: `0x${string}` | undefined;
+    expiresAfter?: number | undefined;
+}, "Modify multiple orders.">]>;
+export type BatchModifyRequest = v.InferOutput<typeof BatchModifyRequest>;
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export declare const BatchModifyResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"order", undefined>, v.DescriptionAction<"order", "Type of response.">]>;
+        readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            readonly statuses: v.SchemaWithPipe<readonly [v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
+                readonly resting: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    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 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<{
+                readonly filled: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    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.">]>;
+                    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.">]>;
+                    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 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<{
+                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 BatchModifyResponse = 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 batchModify} function. */
+export type BatchModifyParameters = ExtractRequestAction<v.InferInput<typeof BatchModifyRequest>>;
+/** Request options for the {@linkcode batchModify} function. */
+export type BatchModifyOptions = ExtractRequestOptions<v.InferInput<typeof BatchModifyRequest>>;
+/** Successful variant of {@linkcode BatchModifyResponse} without errors. */
+export type BatchModifySuccessResponse = ExcludeErrorResponse<BatchModifyResponse>;
+/**
+ * Modify multiple orders.
+ * @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#modify-multiple-orders
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { batchModify } 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 batchModify(
+ *   { transport, wallet },
+ *   {
+ *     modifies: [
+ *       {
+ *         oid: 123,
+ *         order: {
+ *           a: 0,
+ *           b: true,
+ *           p: "31000",
+ *           s: "0.2",
+ *           r: false,
+ *           t: { limit: { tif: "Gtc" } },
+ *         },
+ *       },
+ *     ],
+ *   },
+ * );
+ * ```
+ */
+export declare function batchModify(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<BatchModifyParameters>, opts?: BatchModifyOptions): Promise<BatchModifySuccessResponse>;
+//# sourceMappingURL=batchModify.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchModify.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/batchModify.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,2BAA2B;;YAGvB,mCAAmC;;YAQnC,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAQpC,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,yCAAyC;;IAKzC,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAQvC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6DAAgB,CAAC;AACjD,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAMhD,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,kEAAkE;AAClE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAElG,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAEhG,4EAA4E;AAC5E,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,IAAI,CAAC,EAAE,kBAAkB,GACxB,OAAO,CAAC,0BAA0B,CAAC,CAkBrC"}

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

@@ -0,0 +1,109 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Hex, UnsignedInteger } from "../_base.js";
+import { Signature } from "./_base/mod.js";
+import { PlaceOrderParamsSchema } from "../_common_schemas.js";
+import { OrderResponse } from "./order.js";
+/**
+ * Modify multiple orders.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export const BatchModifyRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("batchModify"), v.description("Type of action.")),
+            /** Order modifications. */
+            modifies: v.pipe(v.array(v.object({
+                /** 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.")),
+                /** New order parameters. */
+                order: PlaceOrderParamsSchema,
+            })), v.description("Order modifications.")),
+        }), 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("Modify multiple orders."));
+})();
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export const BatchModifyResponse = OrderResponse;
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parser } from "../_base.js";
+import { executeL1Action, } from "./_base/mod.js";
+/**
+ * Modify multiple orders.
+ * @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#modify-multiple-orders
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { batchModify } 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 batchModify(
+ *   { transport, wallet },
+ *   {
+ *     modifies: [
+ *       {
+ *         oid: 123,
+ *         order: {
+ *           a: 0,
+ *           b: true,
+ *           p: "31000",
+ *           s: "0.2",
+ *           r: false,
+ *           t: { limit: { tif: "Gtc" } },
+ *         },
+ *       },
+ *     ],
+ *   },
+ * );
+ * ```
+ */
+export async function batchModify(config, params, opts) {
+    const request = parser(BatchModifyRequest)({
+        action: {
+            type: "batchModify",
+            ...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=batchModify.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchModify.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/batchModify.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,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,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,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,2BAA2B;YAC3B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;gBACf,mCAAmC;gBACnC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC;oBACN,eAAe;oBACf,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;iBAC1B,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;gBACD,4BAA4B;gBAC5B,KAAK,EAAE,sBAAsB;aAC9B,CAAC,CAAC,EACH,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;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,yBAAyB,CAAC,CACzC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAGjD,+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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAsD,EACtD,MAA4C,EAC5C,IAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACzC,MAAM,EAAE;YACN,IAAI,EAAE,aAAa;YACnB,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"}

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

@@ -0,0 +1,132 @@
+import * as v from "valibot";
+/**
+ * Transfer native token from the user spot account into staking for delegating to validators.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+ */
+export declare const CDepositRequest: 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<"cDeposit", undefined>, v.DescriptionAction<"cDeposit", "Type of action.">]>;
+        /** Chain ID used for signing. */
+        readonly signatureChainId: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Chain ID used for signing.">]>;
+        /** HyperLiquid network. */
+        readonly hyperliquidChain: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Mainnet", undefined>, v.LiteralSchema<"Testnet", undefined>], undefined>, v.DescriptionAction<"Testnet" | "Mainnet", "HyperLiquid network.">]>;
+        /** Amount of wei to deposit into staking balance (float * 1e8). */
+        readonly wei: 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, "Amount of wei to deposit into staking balance (float * 1e8).">]>;
+        /** 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).">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "cDeposit";
+        signatureChainId: `0x${string}`;
+        hyperliquidChain: "Testnet" | "Mainnet";
+        wei: number;
+        nonce: number;
+    }, "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.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "cDeposit";
+        signatureChainId: `0x${string}`;
+        hyperliquidChain: "Testnet" | "Mainnet";
+        wei: number;
+        nonce: number;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+}, "Transfer native token from the user spot account into staking for delegating to validators.">]>;
+export type CDepositRequest = v.InferOutput<typeof CDepositRequest>;
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+ */
+export declare const CDepositResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"default", undefined>, v.DescriptionAction<"default", "Type of response.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "default";
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"err", undefined>, v.DescriptionAction<"err", "Error status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+}, "Error response for failed operations.">]>], undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+} | {
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data or error response.">]>;
+export type CDepositResponse = v.InferOutput<typeof CDepositResponse>;
+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 cDeposit} function. */
+export type CDepositParameters = ExtractRequestAction<v.InferInput<typeof CDepositRequest>>;
+/** Request options for the {@linkcode cDeposit} function. */
+export type CDepositOptions = ExtractRequestOptions<v.InferInput<typeof CDepositRequest>>;
+/** Successful variant of {@linkcode CDepositResponse} without errors. */
+export type CDepositSuccessResponse = ExcludeErrorResponse<CDepositResponse>;
+/** EIP-712 types for the {@linkcode cDeposit} function. */
+export declare const CDepositTypes: {
+    "HyperliquidTransaction:CDeposit": {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * Transfer native token from the user spot account into staking for delegating to validators.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @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#deposit-into-staking
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { cDeposit } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await cDeposit(
+ *   { transport, wallet },
+ *   { wei: 1 * 1e8 },
+ * );
+ * ```
+ */
+export declare function cDeposit(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<CDepositParameters>, opts?: CDepositOptions): Promise<CDepositSuccessResponse>;
+//# sourceMappingURL=cDeposit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cDeposit.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/cDeposit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,iCAAiC;;QAKjC,2BAA2B;;QAK3B,mEAAmE;;QAKnE,2DAA2D;;;;;;;;;IAQ/D,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;mGAQjC,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;oEAKzB,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAE1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,+DAA+D;AAC/D,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC;AAE5F,6DAA6D;AAC7D,MAAM,MAAM,eAAe,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC;AAE1F,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAE7E,2DAA2D;AAC3D,eAAO,MAAM,aAAa;;;;;CAMzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACzC,IAAI,CAAC,EAAE,eAAe,GACrB,OAAO,CAAC,uBAAuB,CAAC,CAiBlC"}