@nktkas/hyperliquid 0.30.3 → 0.32.0

package/esm/api/exchange/_methods/linkStakingUser.d.ts

@@ -0,0 +1,160 @@
+import * as v from "valibot";
+import { type ErrorResponse, type SuccessResponse } from "./_base/commonSchemas.js";
+/**
+ * Link staking and trading accounts for fee discount attribution.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export declare const LinkStakingUserRequest: v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.LiteralSchema<"linkStakingUser", undefined>;
+        /** Chain ID in hex format for EIP-712 signing. */
+        readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
+        /** HyperLiquid network type. */
+        readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
+        /**
+         * Target account address.
+         * - Trading user initiating: enter staking account address.
+         * - Staking user finalizing: enter trading account address.
+         */
+        readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+        /**
+         * Link phase.
+         * - `false` = trading user initiates link request.
+         * - `true` = staking user finalizes permanent link.
+         */
+        readonly isFinalize: v.BooleanSchema<undefined>;
+        /** Nonce (timestamp in ms) used to prevent replay attacks. */
+        readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+    }, undefined>;
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+    /** ECDSA signature components. */
+    readonly signature: v.ObjectSchema<{
+        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
+        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
+        readonly v: v.PicklistSchema<[27, 28], undefined>;
+    }, undefined>;
+}, undefined>;
+export type LinkStakingUserRequest = v.InferOutput<typeof LinkStakingUserRequest>;
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export type LinkStakingUserResponse = SuccessResponse | ErrorResponse;
+import type { ExcludeErrorResponse } from "./_base/errors.js";
+import { type ExchangeConfig, type ExtractRequestOptions } from "./_base/execute.js";
+/** Schema for user-provided action parameters (excludes system fields). */
+declare const LinkStakingUserParameters: Omit<v.ObjectSchema<{
+    /** Type of action. */
+    readonly type: v.LiteralSchema<"linkStakingUser", undefined>;
+    /** Chain ID in hex format for EIP-712 signing. */
+    readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
+    /** HyperLiquid network type. */
+    readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
+    /**
+     * Target account address.
+     * - Trading user initiating: enter staking account address.
+     * - Staking user finalizing: enter trading account address.
+     */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+    /**
+     * Link phase.
+     * - `false` = trading user initiates link request.
+     * - `true` = staking user finalizes permanent link.
+     */
+    readonly isFinalize: v.BooleanSchema<undefined>;
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+}, undefined>, "~types" | "~run" | "~standard" | "entries"> & {
+    readonly entries: Omit<{
+        /** Type of action. */
+        readonly type: v.LiteralSchema<"linkStakingUser", undefined>;
+        /** Chain ID in hex format for EIP-712 signing. */
+        readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
+        /** HyperLiquid network type. */
+        readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
+        /**
+         * Target account address.
+         * - Trading user initiating: enter staking account address.
+         * - Staking user finalizing: enter trading account address.
+         */
+        readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+        /**
+         * Link phase.
+         * - `false` = trading user initiates link request.
+         * - `true` = staking user finalizes permanent link.
+         */
+        readonly isFinalize: v.BooleanSchema<undefined>;
+        /** Nonce (timestamp in ms) used to prevent replay attacks. */
+        readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+    }, "type" | "nonce" | "signatureChainId" | "hyperliquidChain">;
+    readonly "~standard": v.StandardProps<{
+        user: string;
+        isFinalize: boolean;
+    }, {
+        user: `0x${string}`;
+        isFinalize: boolean;
+    }>;
+    readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
+        user: `0x${string}`;
+        isFinalize: boolean;
+    }, v.StringIssue | v.RegexIssue<string> | v.LengthIssue<`0x${string}`, 42> | v.ObjectIssue | v.BooleanIssue>;
+    readonly "~types"?: {
+        readonly input: {
+            user: string;
+            isFinalize: boolean;
+        };
+        readonly output: {
+            user: `0x${string}`;
+            isFinalize: boolean;
+        };
+        readonly issue: v.StringIssue | v.RegexIssue<string> | v.LengthIssue<`0x${string}`, 42> | v.ObjectIssue | v.BooleanIssue;
+    } | undefined;
+};
+/** Action parameters for the {@linkcode linkStakingUser} function. */
+export type LinkStakingUserParameters = v.InferInput<typeof LinkStakingUserParameters>;
+/** Request options for the {@linkcode linkStakingUser} function. */
+export type LinkStakingUserOptions = ExtractRequestOptions<v.InferInput<typeof LinkStakingUserRequest>>;
+/** Successful variant of {@linkcode LinkStakingUserResponse} without errors. */
+export type LinkStakingUserSuccessResponse = ExcludeErrorResponse<LinkStakingUserResponse>;
+/** EIP-712 types for the {@linkcode linkStakingUser} function. */
+export declare const LinkStakingUserTypes: {
+    "HyperliquidTransaction:LinkStakingUser": {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * Link staking and trading accounts for fee discount attribution.
+ *
+ * @param config General configuration for Exchange API requests.
+ * @param params Parameters specific to the API request.
+ * @param opts Request execution options.
+ * @return Successful response without specific data.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { linkStakingUser } 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 linkStakingUser(
+ *   { transport, wallet },
+ *   { user: "0x...", isFinalize: false },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export declare function linkStakingUser(config: ExchangeConfig, params: LinkStakingUserParameters, opts?: LinkStakingUserOptions): Promise<LinkStakingUserSuccessResponse>;
+export {};
+//# sourceMappingURL=linkStakingUser.d.ts.map

package/esm/api/exchange/_methods/linkStakingUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkStakingUser.d.ts","sourceRoot":"","sources":["../../../../src/api/exchange/_methods/linkStakingUser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAO7B,OAAO,EACL,KAAK,aAAa,EAGlB,KAAK,eAAe,EACrB,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IAE/B,yBAAyB;;QAEvB,sBAAsB;;QAEtB,kDAAkD;;QAElD,gCAAgC;;QAEhC;;;;WAIG;;QAEH;;;;WAIG;;QAEH,8DAA8D;;;IAGhE,8DAA8D;;IAE9D,kCAAkC;;;;;;aAGlC,CAAC;AACL,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,aAAa,CAAC;AAOtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,KAAK,cAAc,EAA2B,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE9G,2EAA2E;AAC3E,QAAA,MAAM,yBAAyB;IA5CzB,sBAAsB;;IAEtB,kDAAkD;;IAElD,gCAAgC;;IAEhC;;;;OAIG;;IAEH;;;;OAIG;;IAEH,8DAA8D;;;;QAlB9D,sBAAsB;;QAEtB,kDAAkD;;QAElD,gCAAgC;;QAEhC;;;;WAIG;;QAEH;;;;WAIG;;QAEH,8DAA8D;;;;;;;;;;;;;;;;;;;;;;;;;CA+BhE,CAAC;AAEL,sEAAsE;AACtE,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAEvF,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC,CAAC;AAExG,gFAAgF;AAChF,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AAE3F,kEAAkE;AAClE,eAAO,MAAM,oBAAoB;;;;;CAOhC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,yBAAyB,EACjC,IAAI,CAAC,EAAE,sBAAsB,GAC5B,OAAO,CAAC,8BAA8B,CAAC,CAQzC"}

package/esm/api/exchange/_methods/linkStakingUser.js

@@ -0,0 +1,93 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
+import { HyperliquidChainSchema, SignatureSchema, } from "./_base/commonSchemas.js";
+/**
+ * Link staking and trading accounts for fee discount attribution.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export const LinkStakingUserRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Action to perform. */
+        action: v.object({
+            /** Type of action. */
+            type: v.literal("linkStakingUser"),
+            /** Chain ID in hex format for EIP-712 signing. */
+            signatureChainId: Hex,
+            /** HyperLiquid network type. */
+            hyperliquidChain: HyperliquidChainSchema,
+            /**
+             * Target account address.
+             * - Trading user initiating: enter staking account address.
+             * - Staking user finalizing: enter trading account address.
+             */
+            user: Address,
+            /**
+             * Link phase.
+             * - `false` = trading user initiates link request.
+             * - `true` = staking user finalizes permanent link.
+             */
+            isFinalize: v.boolean(),
+            /** Nonce (timestamp in ms) used to prevent replay attacks. */
+            nonce: UnsignedInteger,
+        }),
+        /** Nonce (timestamp in ms) used to prevent replay attacks. */
+        nonce: UnsignedInteger,
+        /** ECDSA signature components. */
+        signature: SignatureSchema,
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+import { executeUserSignedAction } from "./_base/execute.js";
+/** Schema for user-provided action parameters (excludes system fields). */
+const LinkStakingUserParameters = /* @__PURE__ */ (() => {
+    return v.omit(v.object(LinkStakingUserRequest.entries.action.entries), ["type", "signatureChainId", "hyperliquidChain", "nonce"]);
+})();
+/** EIP-712 types for the {@linkcode linkStakingUser} function. */
+export const LinkStakingUserTypes = {
+    "HyperliquidTransaction:LinkStakingUser": [
+        { name: "hyperliquidChain", type: "string" },
+        { name: "user", type: "address" },
+        { name: "isFinalize", type: "bool" },
+        { name: "nonce", type: "uint64" },
+    ],
+};
+/**
+ * Link staking and trading accounts for fee discount attribution.
+ *
+ * @param config General configuration for Exchange API requests.
+ * @param params Parameters specific to the API request.
+ * @param opts Request execution options.
+ * @return Successful response without specific data.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { linkStakingUser } 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 linkStakingUser(
+ *   { transport, wallet },
+ *   { user: "0x...", isFinalize: false },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export function linkStakingUser(config, params, opts) {
+    const action = parse(LinkStakingUserParameters, params);
+    return executeUserSignedAction(config, { type: "linkStakingUser", ...action }, LinkStakingUserTypes, opts);
+}
+//# sourceMappingURL=linkStakingUser.js.map

package/esm/api/exchange/_methods/linkStakingUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkStakingUser.js","sourceRoot":"","sources":["../../../../src/api/exchange/_methods/linkStakingUser.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,mBAAmB,CAAC;AAClE,OAAO,EAEL,sBAAsB,EACtB,eAAe,GAEhB,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;YACf,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAClC,kDAAkD;YAClD,gBAAgB,EAAE,GAAG;YACrB,gCAAgC;YAChC,gBAAgB,EAAE,sBAAsB;YACxC;;;;eAIG;YACH,IAAI,EAAE,OAAO;YACb;;;;eAIG;YACH,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;YACvB,8DAA8D;YAC9D,KAAK,EAAE,eAAe;SACvB,CAAC;QACF,8DAA8D;QAC9D,KAAK,EAAE,eAAe;QACtB,kCAAkC;QAClC,SAAS,EAAE,eAAe;KAC3B,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AASL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C,OAAO,EAAuB,uBAAuB,EAA8B,MAAM,oBAAoB,CAAC;AAE9G,2EAA2E;AAC3E,MAAM,yBAAyB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EACvD,CAAC,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAC1D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAWL,kEAAkE;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,wCAAwC,EAAE;QACxC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5C,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;QACjC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE;QACpC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;KAClC;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAsB,EACtB,MAAiC,EACjC,IAA6B;IAE7B,MAAM,MAAM,GAAG,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACxD,OAAO,uBAAuB,CAC5B,MAAM,EACN,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,EAAE,EACtC,oBAAoB,EACpB,IAAI,CACL,CAAC;AACJ,CAAC"}

package/esm/api/exchange/_methods/modify.d.ts

@@ -0,0 +1,326 @@
+import * as v from "valibot";
+import { type ErrorResponse, type SuccessResponse } from "./_base/commonSchemas.js";
+/**
+ * Modify an order.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export declare const ModifyRequest: v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.LiteralSchema<"modify", undefined>;
+        /** Order ID or Client Order ID. */
+        readonly oid: v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<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>;
+        /** New order parameters. */
+        readonly order: v.ObjectSchema<{
+            /** Asset ID. */
+            readonly a: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+            /** Position side (`true` for long, `false` for short). */
+            readonly b: v.BooleanSchema<undefined>;
+            /** Price. */
+            readonly p: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+            /** Size (in base currency units). */
+            readonly s: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>;
+            /** Is reduce-only? */
+            readonly r: v.BooleanSchema<undefined>;
+            /** Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
+            readonly t: v.UnionSchema<[v.ObjectSchema<{
+                /** Limit order parameters. */
+                readonly limit: 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, but add a note that this is market order.
+                     */
+                    readonly tif: v.PicklistSchema<["Gtc", "Ioc", "Alo", "FrontendMarket"], undefined>;
+                }, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                /** Trigger order parameters. */
+                readonly trigger: v.ObjectSchema<{
+                    /** Is market order? */
+                    readonly isMarket: v.BooleanSchema<undefined>;
+                    /** Trigger price. */
+                    readonly triggerPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+                    /** Indicates whether it is take profit or stop loss. */
+                    readonly tpsl: v.PicklistSchema<["tp", "sl"], undefined>;
+                }, undefined>;
+            }, undefined>], undefined>;
+            /** Client Order ID. */
+            readonly c: 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>;
+        }, undefined>;
+    }, undefined>;
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+    /** ECDSA signature components. */
+    readonly signature: v.ObjectSchema<{
+        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
+        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
+        readonly v: v.PicklistSchema<[27, 28], undefined>;
+    }, undefined>;
+    /** Vault address (for vault trading). */
+    readonly vaultAddress: 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>;
+    /** Expiration time of the action. */
+    readonly expiresAfter: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
+}, undefined>;
+export type ModifyRequest = v.InferOutput<typeof ModifyRequest>;
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export type ModifyResponse = SuccessResponse | ErrorResponse;
+import type { ExcludeErrorResponse } from "./_base/errors.js";
+import { type ExchangeConfig, type ExtractRequestOptions } from "./_base/execute.js";
+/** Schema for user-provided action parameters (excludes system fields). */
+declare const ModifyParameters: Omit<v.ObjectSchema<{
+    /** Type of action. */
+    readonly type: v.LiteralSchema<"modify", undefined>;
+    /** Order ID or Client Order ID. */
+    readonly oid: v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<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>;
+    /** New order parameters. */
+    readonly order: v.ObjectSchema<{
+        /** Asset ID. */
+        readonly a: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+        /** Position side (`true` for long, `false` for short). */
+        readonly b: v.BooleanSchema<undefined>;
+        /** Price. */
+        readonly p: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+        /** Size (in base currency units). */
+        readonly s: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>;
+        /** Is reduce-only? */
+        readonly r: v.BooleanSchema<undefined>;
+        /** Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
+        readonly t: v.UnionSchema<[v.ObjectSchema<{
+            /** Limit order parameters. */
+            readonly limit: 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, but add a note that this is market order.
+                 */
+                readonly tif: v.PicklistSchema<["Gtc", "Ioc", "Alo", "FrontendMarket"], undefined>;
+            }, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            /** Trigger order parameters. */
+            readonly trigger: v.ObjectSchema<{
+                /** Is market order? */
+                readonly isMarket: v.BooleanSchema<undefined>;
+                /** Trigger price. */
+                readonly triggerPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+                /** Indicates whether it is take profit or stop loss. */
+                readonly tpsl: v.PicklistSchema<["tp", "sl"], undefined>;
+            }, undefined>;
+        }, undefined>], undefined>;
+        /** Client Order ID. */
+        readonly c: 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>;
+    }, undefined>;
+}, undefined>, "~types" | "~run" | "~standard" | "entries"> & {
+    readonly entries: Omit<{
+        /** Type of action. */
+        readonly type: v.LiteralSchema<"modify", undefined>;
+        /** Order ID or Client Order ID. */
+        readonly oid: v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<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>;
+        /** New order parameters. */
+        readonly order: v.ObjectSchema<{
+            /** Asset ID. */
+            readonly a: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+            /** Position side (`true` for long, `false` for short). */
+            readonly b: v.BooleanSchema<undefined>;
+            /** Price. */
+            readonly p: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+            /** Size (in base currency units). */
+            readonly s: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>;
+            /** Is reduce-only? */
+            readonly r: v.BooleanSchema<undefined>;
+            /** Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
+            readonly t: v.UnionSchema<[v.ObjectSchema<{
+                /** Limit order parameters. */
+                readonly limit: 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, but add a note that this is market order.
+                     */
+                    readonly tif: v.PicklistSchema<["Gtc", "Ioc", "Alo", "FrontendMarket"], undefined>;
+                }, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                /** Trigger order parameters. */
+                readonly trigger: v.ObjectSchema<{
+                    /** Is market order? */
+                    readonly isMarket: v.BooleanSchema<undefined>;
+                    /** Trigger price. */
+                    readonly triggerPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.CheckAction<string, "Value must be greater than zero">]>;
+                    /** Indicates whether it is take profit or stop loss. */
+                    readonly tpsl: v.PicklistSchema<["tp", "sl"], undefined>;
+                }, undefined>;
+            }, undefined>], undefined>;
+            /** Client Order ID. */
+            readonly c: 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>;
+        }, undefined>;
+    }, "type">;
+    readonly "~standard": v.StandardProps<{
+        order: {
+            a: string | number;
+            b: boolean;
+            p: string | number;
+            s: string | number;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string | number;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: string | undefined;
+        };
+        oid: string | number;
+    }, {
+        order: {
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        };
+        oid: number | `0x${string}`;
+    }>;
+    readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
+        order: {
+            a: number;
+            b: boolean;
+            p: string;
+            s: string;
+            r: boolean;
+            t: {
+                limit: {
+                    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket";
+                };
+            } | {
+                trigger: {
+                    isMarket: boolean;
+                    triggerPx: string;
+                    tpsl: "tp" | "sl";
+                };
+            };
+            c?: `0x${string}` | undefined;
+        };
+        oid: number | `0x${string}`;
+    }, v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.ToStringIssue<string | number> | v.RegexIssue<string> | v.ToNumberIssue<string | number> | v.SafeIntegerIssue<number> | v.MinValueIssue<number, 0> | v.LengthIssue<`0x${string}`, 34> | v.PicklistIssue | v.ObjectIssue | v.CheckIssue<string> | v.BooleanIssue | v.UnionIssue<v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.ToStringIssue<string | number> | v.RegexIssue<string> | v.PicklistIssue | v.ObjectIssue | v.CheckIssue<string> | v.BooleanIssue> | v.UnionIssue<v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.RegexIssue<string> | v.ToNumberIssue<string | number> | v.SafeIntegerIssue<number> | v.MinValueIssue<number, 0> | v.LengthIssue<`0x${string}`, 34>>>;
+    readonly "~types"?: {
+        readonly input: {
+            order: {
+                a: string | number;
+                b: boolean;
+                p: string | number;
+                s: string | number;
+                r: boolean;
+                t: {
+                    limit: {
+                        tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket";
+                    };
+                } | {
+                    trigger: {
+                        isMarket: boolean;
+                        triggerPx: string | number;
+                        tpsl: "tp" | "sl";
+                    };
+                };
+                c?: string | undefined;
+            };
+            oid: string | number;
+        };
+        readonly output: {
+            order: {
+                a: number;
+                b: boolean;
+                p: string;
+                s: string;
+                r: boolean;
+                t: {
+                    limit: {
+                        tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket";
+                    };
+                } | {
+                    trigger: {
+                        isMarket: boolean;
+                        triggerPx: string;
+                        tpsl: "tp" | "sl";
+                    };
+                };
+                c?: `0x${string}` | undefined;
+            };
+            oid: number | `0x${string}`;
+        };
+        readonly issue: v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.ToStringIssue<string | number> | v.RegexIssue<string> | v.ToNumberIssue<string | number> | v.SafeIntegerIssue<number> | v.MinValueIssue<number, 0> | v.LengthIssue<`0x${string}`, 34> | v.PicklistIssue | v.ObjectIssue | v.CheckIssue<string> | v.BooleanIssue | v.UnionIssue<v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.ToStringIssue<string | number> | v.RegexIssue<string> | v.PicklistIssue | v.ObjectIssue | v.CheckIssue<string> | v.BooleanIssue> | v.UnionIssue<v.StringIssue | v.NumberIssue | v.UnionIssue<v.StringIssue | v.NumberIssue> | v.RegexIssue<string> | v.ToNumberIssue<string | number> | v.SafeIntegerIssue<number> | v.MinValueIssue<number, 0> | v.LengthIssue<`0x${string}`, 34>>;
+    } | undefined;
+};
+/** Action parameters for the {@linkcode modify} function. */
+export type ModifyParameters = v.InferInput<typeof ModifyParameters>;
+/** Request options for the {@linkcode modify} function. */
+export type ModifyOptions = ExtractRequestOptions<v.InferInput<typeof ModifyRequest>>;
+/** Successful variant of {@linkcode ModifyResponse} without errors. */
+export type ModifySuccessResponse = ExcludeErrorResponse<ModifyResponse>;
+/**
+ * Modify an order.
+ *
+ * @param config General configuration for Exchange API requests.
+ * @param params Parameters specific to the API request.
+ * @param opts Request execution options.
+ * @return Successful response without specific data.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ *
+ * @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" } },
+ *     },
+ *   },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export declare function modify(config: ExchangeConfig, params: ModifyParameters, opts?: ModifyOptions): Promise<ModifySuccessResponse>;
+export {};
+//# sourceMappingURL=modify.d.ts.map

package/esm/api/exchange/_methods/modify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modify.d.ts","sourceRoot":"","sources":["../../../../src/api/exchange/_methods/modify.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAO7B,OAAO,EAAE,KAAK,aAAa,EAAmB,KAAK,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAErG;;;GAGG;AACH,eAAO,MAAM,aAAa;IAEtB,yBAAyB;;QAEvB,sBAAsB;;QAEtB,mCAAmC;;QAEnC,4BAA4B;;YAE1B,gBAAgB;;YAEhB,0DAA0D;;YAE1D,aAAa;;YAKb,qCAAqC;;YAErC,sBAAsB;;YAEtB,yFAAyF;;gBAGrF,8BAA8B;;oBAE5B;;;;;;uBAMG;;;;gBAKL,gCAAgC;;oBAE9B,uBAAuB;;oBAEvB,qBAAqB;;oBAKrB,wDAAwD;;;;YAK9D,uBAAuB;;;;IAI3B,8DAA8D;;IAE9D,kCAAkC;;;;;;IAElC,yCAAyC;;IAEzC,qCAAqC;;aAGrC,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,aAAa,CAAC;AAO7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,KAAK,cAAc,EAAmB,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEtG,2EAA2E;AAC3E,QAAA,MAAM,gBAAgB;IAhFhB,sBAAsB;;IAEtB,mCAAmC;;IAEnC,4BAA4B;;QAE1B,gBAAgB;;QAEhB,0DAA0D;;QAE1D,aAAa;;QAKb,qCAAqC;;QAErC,sBAAsB;;QAEtB,yFAAyF;;YAGrF,8BAA8B;;gBAE5B;;;;;;mBAMG;;;;YAKL,gCAAgC;;gBAE9B,uBAAuB;;gBAEvB,qBAAqB;;gBAKrB,wDAAwD;;;;QAK9D,uBAAuB;;;;;QAjDzB,sBAAsB;;QAEtB,mCAAmC;;QAEnC,4BAA4B;;YAE1B,gBAAgB;;YAEhB,0DAA0D;;YAE1D,aAAa;;YAKb,qCAAqC;;YAErC,sBAAsB;;YAEtB,yFAAyF;;gBAGrF,8BAA8B;;oBAE5B;;;;;;uBAMG;;;;gBAKL,gCAAgC;;oBAE9B,uBAAuB;;oBAEvB,qBAAqB;;oBAKrB,wDAAwD;;;;YAK9D,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC3B,CAAC;AAEL,6DAA6D;AAC7D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAErE,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC;AAEtF,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,gBAAgB,EACxB,IAAI,CAAC,EAAE,aAAa,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAGhC"}