@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/script/src/api/exchange/evmUserModify.js

@@ -0,0 +1,101 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuccessResponse = exports.EvmUserModifyRequest = void 0;
+exports.evmUserModify = evmUserModify;
+const _common_js_1 = require("../_common.js");
+const _common_js_2 = require("./_common.js");
+const v = __importStar(require("valibot"));
+// -------------------- Schemas --------------------
+/**
+ * Configure block type for EVM transactions.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/dual-block-architecture
+ */
+exports.EvmUserModifyRequest = (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("evmUserModify"), v.description("Type of action.")),
+            /** `true` for large blocks, `false` for small blocks. */
+            usingBigBlocks: v.pipe(v.boolean(), v.description("`true` for large blocks, `false` for small blocks.")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(_common_js_1.UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(_common_js_2.Signature, v.description("Cryptographic signature.")),
+        /** Expiration time of the action. */
+        expiresAfter: v.pipe(v.optional(_common_js_1.UnsignedInteger), v.description("Expiration time of the action.")),
+    }), v.description("Configure block type for EVM transactions."));
+})();
+const _common_js_3 = require("./_common.js");
+Object.defineProperty(exports, "SuccessResponse", { enumerable: true, get: function () { return _common_js_3.SuccessResponse; } });
+/**
+ * Configure block type for EVM transactions.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Response for creating a sub-account.
+ *
+ * @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/hyperevm/dual-block-architecture
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { evmUserModify } 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 evmUserModify(
+ *   { transport, wallet },
+ *   { usingBigBlocks: true },
+ * );
+ * ```
+ */
+async function evmUserModify(config, params, opts) {
+    const action = (0, _common_js_1.parser)(exports.EvmUserModifyRequest.entries.action)({
+        type: "evmUserModify",
+        ...params,
+    });
+    const expiresAfter = typeof config.defaultExpiresAfter === "number"
+        ? config.defaultExpiresAfter
+        : await config.defaultExpiresAfter?.();
+    return await (0, _common_js_2.executeL1Action)(config, { action, expiresAfter }, opts?.signal);
+}
+//# sourceMappingURL=evmUserModify.js.map

package/script/src/api/exchange/evmUserModify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evmUserModify.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/evmUserModify.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,sCAaC;AA1GD,8CAA4E;AAC5E,6CAOsB;AACtB,2CAA6B;AAE7B,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,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,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,yDAAyD;YACzD,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,sBAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,4BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,6CAA+C;AACtC,gGADA,4BAAe,OACA;AASxB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,aAAa,CACjC,MAAsD,EACtD,MAA8C,EAC9C,IAA2B;IAE3B,MAAM,MAAM,GAAG,IAAA,mBAAM,EAAC,4BAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,EAAE,eAAe;QACrB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;QACjE,CAAC,CAAC,MAAM,CAAC,mBAAmB;QAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzC,OAAO,MAAM,IAAA,4BAAe,EAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC"}

package/script/src/api/exchange/modify.d.ts

@@ -0,0 +1,210 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Modify an order.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export declare const ModifyRequest: 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<"modify", undefined>, v.DescriptionAction<"modify", "Type of action.">]>;
+        /** 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.">]>;
+        /** New order parameters. */
+        readonly order: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Asset ID. */
+            readonly a: 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, "Asset ID.">]>;
+            /** Position side (`true` for long, `false` for short). */
+            readonly b: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Position side (`true` for long, `false` for short).">]>;
+            /** Price. */
+            readonly p: 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, "Price.">]>;
+            /** Size (in base currency units). */
+            readonly s: 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 (in base currency units).">]>;
+            /** Is reduce-only? */
+            readonly r: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Is reduce-only?">]>;
+            /** Order type. */
+            readonly t: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+                /** Limit order parameters. */
+                readonly limit: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /**
+                     * Time-in-force.
+                     * - `"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.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<{
+                /** Trigger order parameters. */
+                readonly trigger: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /** Is market order? */
+                    readonly isMarket: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Is market 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.">]>;
+                    /** Indicates whether it is take profit or stop loss. */
+                    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.">]>;
+            /** Client Order ID. */
+            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;
+        }, "New order parameters.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "modify";
+        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.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.TransformAction<`0x${string}`, `0x${string}`>]>, 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.TransformAction<`0x${string}`, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, 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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "modify";
+        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 an order.">]>;
+export type ModifyRequest = v.InferOutput<typeof ModifyRequest>;
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/** Action parameters for the {@linkcode modify} function. */
+export type ModifyParameters = ExtractRequestAction<v.InferInput<typeof ModifyRequest>>;
+/** Request options for the {@linkcode modify} function. */
+export type ModifyOptions = ExtractRequestOptions<v.InferInput<typeof ModifyRequest>>;
+/**
+ * Modify an order.
+ * @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#modify-an-order
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { modify } 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 modify(
+ *   { transport, wallet },
+ *   {
+ *     oid: 123,
+ *     order: {
+ *       a: 0,
+ *       b: true,
+ *       p: "31000",
+ *       s: "0.2",
+ *       r: false,
+ *       t: { limit: { tif: "Gtc" } },
+ *       c: "0x...",
+ *     },
+ *   },
+ * );
+ * ```
+ */
+export declare function modify(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<ModifyParameters>, opts?: ModifyOptions): Promise<SuccessResponse>;
+//# sourceMappingURL=modify.d.ts.map

package/script/src/api/exchange/modify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modify.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/modify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AAC3G,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAE5B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAI7B;;;GAGG;AACH,eAAO,MAAM,aAAa;IAGpB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,mCAAmC;;QAQnC,4BAA4B;;YAGxB,gBAAgB;;YAKhB,0DAA0D;;YAK1D,aAAa;;YAKb,qCAAqC;;YAKrC,sBAAsB;;YAKtB,kBAAkB;;gBAIZ,8BAA8B;;oBAG1B;;;;;;;uBAOG;;;;;;gBAuBP,gCAAgC;;oBAG5B,uBAAuB;;oBAKvB,qBAAqB;;oBAKrB,wDAAwD;;;;;;;;;;;;;;;;;;YAYlE,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAW/B,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,yCAAyC;;IAKzC,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAQvC,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAI3B,6DAA6D;AAC7D,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC;AACxF,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,MAAM,CAC1B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,gBAAgB,CAAC,EACvC,IAAI,CAAC,EAAE,aAAa,GACnB,OAAO,CAAC,eAAe,CAAC,CAU1B"}

package/script/src/api/exchange/modify.js

@@ -0,0 +1,172 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuccessResponse = exports.ModifyRequest = void 0;
+exports.modify = modify;
+const _common_js_1 = require("../_common.js");
+const _common_js_2 = require("./_common.js");
+const v = __importStar(require("valibot"));
+// -------------------- Schemas --------------------
+/**
+ * Modify an order.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+exports.ModifyRequest = (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("modify"), v.description("Type of action.")),
+            /** Order ID or Client Order ID. */
+            oid: v.pipe(v.union([
+                _common_js_1.UnsignedInteger,
+                v.pipe(_common_js_1.Hex, v.length(34)),
+            ]), v.description("Order ID or Client Order ID.")),
+            /** New order parameters. */
+            order: v.pipe(v.object({
+                /** Asset ID. */
+                a: v.pipe(_common_js_1.UnsignedInteger, v.description("Asset ID.")),
+                /** Position side (`true` for long, `false` for short). */
+                b: v.pipe(v.boolean(), v.description("Position side (`true` for long, `false` for short).")),
+                /** Price. */
+                p: v.pipe(_common_js_1.UnsignedDecimal, v.description("Price.")),
+                /** Size (in base currency units). */
+                s: v.pipe(_common_js_1.UnsignedDecimal, v.description("Size (in base currency units).")),
+                /** Is reduce-only? */
+                r: v.pipe(v.boolean(), v.description("Is reduce-only?")),
+                /** Order type. */
+                t: v.pipe(v.union([
+                    v.object({
+                        /** Limit order parameters. */
+                        limit: v.pipe(v.object({
+                            /**
+                             * Time-in-force.
+                             * - `"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.literal("Gtc"),
+                                v.literal("Ioc"),
+                                v.literal("Alo"),
+                                v.literal("FrontendMarket"),
+                                v.literal("LiquidationMarket"),
+                            ]), v.description("Time-in-force." +
+                                '\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.')),
+                        }), v.description("Limit order parameters.")),
+                    }),
+                    v.object({
+                        /** Trigger order parameters. */
+                        trigger: v.pipe(v.object({
+                            /** Is market order? */
+                            isMarket: v.pipe(v.boolean(), v.description("Is market order?")),
+                            /** Trigger price. */
+                            triggerPx: v.pipe(_common_js_1.UnsignedDecimal, v.description("Trigger price.")),
+                            /** Indicates whether it is take profit or stop loss. */
+                            tpsl: v.pipe(v.union([v.literal("tp"), v.literal("sl")]), v.description("Indicates whether it is take profit or stop loss.")),
+                        }), v.description("Trigger order parameters.")),
+                    }),
+                ]), v.description("Order type.")),
+                /** Client Order ID. */
+                c: v.pipe(v.optional(v.pipe(_common_js_1.Hex, v.length(34))), v.description("Client Order ID.")),
+            }), v.description("New order parameters.")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(_common_js_1.UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(_common_js_2.Signature, v.description("Cryptographic signature.")),
+        /** Vault address (for vault trading). */
+        vaultAddress: v.pipe(v.optional(_common_js_1.Address), v.description("Vault address (for vault trading).")),
+        /** Expiration time of the action. */
+        expiresAfter: v.pipe(v.optional(_common_js_1.UnsignedInteger), v.description("Expiration time of the action.")),
+    }), v.description("Modify an order."));
+})();
+const _common_js_3 = require("./_common.js");
+Object.defineProperty(exports, "SuccessResponse", { enumerable: true, get: function () { return _common_js_3.SuccessResponse; } });
+/**
+ * Modify an order.
+ * @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#modify-an-order
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { modify } 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 modify(
+ *   { transport, wallet },
+ *   {
+ *     oid: 123,
+ *     order: {
+ *       a: 0,
+ *       b: true,
+ *       p: "31000",
+ *       s: "0.2",
+ *       r: false,
+ *       t: { limit: { tif: "Gtc" } },
+ *       c: "0x...",
+ *     },
+ *   },
+ * );
+ * ```
+ */
+async function modify(config, params, opts) {
+    const action = (0, _common_js_1.parser)(exports.ModifyRequest.entries.action)({
+        type: "modify",
+        ...params,
+    });
+    const vaultAddress = opts?.vaultAddress ?? config.defaultVaultAddress;
+    const expiresAfter = typeof config.defaultExpiresAfter === "number"
+        ? config.defaultExpiresAfter
+        : await config.defaultExpiresAfter?.();
+    return await (0, _common_js_2.executeL1Action)(config, { action, vaultAddress, expiresAfter }, opts?.signal);
+}
+//# sourceMappingURL=modify.js.map

package/script/src/api/exchange/modify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modify.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/modify.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkNA,wBAcC;AAhOD,8CAA2G;AAC3G,6CAOsB;AACtB,2CAA6B;AAE7B,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,aAAa,GAAmB,CAAC,GAAG,EAAE;IACjD,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,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,mCAAmC;YACnC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC;gBACN,4BAAe;gBACf,CAAC,CAAC,IAAI,CAAC,gBAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;aAC1B,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,4BAA4B;YAC5B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;gBACP,gBAAgB;gBAChB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;gBACD,0DAA0D;gBAC1D,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,qDAAqD,CAAC,CACrE;gBACD,aAAa;gBACb,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;gBACD,qCAAqC;gBACrC,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;gBACD,sBAAsB;gBACtB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;gBACD,kBAAkB;gBAClB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,KAAK,CAAC;oBACN,CAAC,CAAC,MAAM,CAAC;wBACP,8BAA8B;wBAC9B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;4BACP;;;;;;;+BAOG;4BACH,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC;gCACN,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gCAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gCAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gCAChB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;gCAC3B,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;6BAC/B,CAAC,EACF,CAAC,CAAC,WAAW,CACX,gBAAgB;gCACd,uDAAuD;gCACvD,iEAAiE;gCACjE,mCAAmC;gCACnC,iEAAiE;gCACjE,oEAAoE,CACvE,CACF;yBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;qBACF,CAAC;oBACF,CAAC,CAAC,MAAM,CAAC;wBACP,gCAAgC;wBAChC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,MAAM,CAAC;4BACP,uBAAuB;4BACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;4BACD,qBAAqB;4BACrB,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;4BACD,wDAAwD;4BACxD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAC3C,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;yBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;qBACF,CAAC;iBACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;gBACD,uBAAuB;gBACvB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,sBAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,yCAAyC;QACzC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,oBAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,4BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,6CAA+C;AACtC,gGADA,4BAAe,OACA;AASxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACI,KAAK,UAAU,MAAM,CAC1B,MAAsD,EACtD,MAAuC,EACvC,IAAoB;IAEpB,MAAM,MAAM,GAAG,IAAA,mBAAM,EAAC,qBAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,EAAE,QAAQ;QACd,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,IAAI,EAAE,YAAY,IAAI,MAAM,CAAC,mBAAmB,CAAC;IACtE,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;QACjE,CAAC,CAAC,MAAM,CAAC,mBAAmB;QAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzC,OAAO,MAAM,IAAA,4BAAe,EAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC7F,CAAC"}