@nktkas/hyperliquid 0.13.1 → 0.14.0

package/esm/src/types/exchange/requests.d.ts

@@ -1,5 +1,38 @@
-import type { Hex } from "../common.js";
-import type { OrderParms } from "./common.js";
+import type { Hex } from "../../base.js";
+import type { TIF } from "../info/orders.js";
+/** Order parameters. */
+export type OrderParams = {
+    /** Asset ID. */
+    a: number;
+    /** Position side (`true` for long, `false` for short). */
+    b: boolean;
+    /** Price. */
+    p: string;
+    /** Size (in base currency units). */
+    s: string;
+    /** Is reduce-only? */
+    r: boolean;
+    /** Order type. */
+    t: {
+        /** Limit order parameters. */
+        limit: {
+            /** Time-in-force. */
+            tif: TIF;
+        };
+    } | {
+        /** Trigger order parameters. */
+        trigger: {
+            /** Is market order? */
+            isMarket: boolean;
+            /** Trigger price. */
+            triggerPx: string;
+            /** Indicates whether it is take profit or stop loss. */
+            tpsl: "tp" | "sl";
+        };
+    };
+    /** Client Order ID. */
+    c?: Hex | null;
+};
 /** Base structure for exchange requests. */
 export interface BaseExchangeRequest {
     /** Action to perform. */
@@ -9,7 +42,7 @@ export interface BaseExchangeRequest {
         /** Additional action parameters. */
         [key: string]: unknown;
     };
-    /** Unique request identifier (recommended: current timestamp in ms). */
+    /** Unique request identifier (recommended current timestamp in ms). */
     nonce: number;
     /** Cryptographic signature. */
     signature: {
@@ -21,7 +54,7 @@ export interface BaseExchangeRequest {
 /**
  * Approve an agent to sign on behalf of the master or sub-accounts.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet
  */
 export interface ApproveAgentRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -32,18 +65,18 @@ export interface ApproveAgentRequest extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
         /** Agent address. */
         agentAddress: Hex;
         /** Agent name. */
         agentName: string;
-        /** Unique request identifier (recommended: current timestamp in ms). */
-        nonce: number;
     };
 }
 /**
  * Approve a max fee rate for a builder address.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee
  */
 export interface ApproveBuilderFeeRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -54,18 +87,18 @@ export interface ApproveBuilderFeeRequest extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
         /** Max fee rate (e.g., "0.01%"). */
         maxFeeRate: `${string}%`;
         /** Builder address. */
         builder: Hex;
-        /** Unique request identifier (recommended: current timestamp in ms). */
-        nonce: number;
     };
 }
 /**
  * Modify multiple orders.
  * @returns {OrderResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
  */
 export interface BatchModifyRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -77,16 +110,37 @@ export interface BatchModifyRequest extends BaseExchangeRequest {
             /** Order ID to modify. */
             oid: number;
             /** New order parameters. */
-            order: OrderParms;
+            order: OrderParams;
+        }[];
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Cancel order(s) by cloid.
+ * @returns {CancelResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
+ */
+export interface CancelByCloidRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cancelByCloid";
+        /** Orders to cancel. */
+        cancels: {
+            /** Asset ID. */
+            asset: number;
+            /** Client Order ID. */
+            cloid: Hex;
         }[];
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Cancel order(s).
  * @returns {CancelResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
  */
 export interface CancelRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -95,39 +149,51 @@ export interface CancelRequest extends BaseExchangeRequest {
         type: "cancel";
         /** Orders to cancel. */
         cancels: {
-            /** An integer representing the asset being traded. */
+            /** Asset ID. */
             a: number;
             /** Order ID. */
             o: number;
         }[];
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
- * Cancel order(s) by Client Order ID.
- * @returns {CancelResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid | Hyperliquid GitBook}
+ * Deposit into staking balance.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
  */
-export interface CancelByCloidRequest extends BaseExchangeRequest {
+export interface CDepositRequest extends BaseExchangeRequest {
     /** Action to be performed. */
     action: {
         /** Type of action. */
-        type: "cancelByCloid";
-        /** Orders to cancel. */
-        cancels: {
-            /** An integer representing the asset being traded. */
-            asset: number;
-            /** Client Order ID. */
-            cloid: Hex;
-        }[];
+        type: "cDeposit";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount of wei to deposit into staking balance. */
+        wei: number;
+    };
+}
+/**
+ * Claim rewards from referral program.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface ClaimRewardsRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "claimRewards";
     };
-    /** Vault address (optional, for vault trading). */
-    vaultAddress?: Hex;
 }
 /**
  * Create a sub-account.
  * @returns {CreateSubAccountResponse}
+ * @see null - no documentation
  */
 export interface CreateSubAccountRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -138,10 +204,44 @@ export interface CreateSubAccountRequest extends BaseExchangeRequest {
         name: string;
     };
 }
+/**
+ * Withdraw from staking balance.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
+ */
+export interface CWithdrawRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cWithdraw";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount of wei to withdraw from staking balance. */
+        wei: number;
+    };
+}
+/**
+ * Configure block type for EVM transactions.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/evm/dual-block-architecture
+ */
+export interface EvmUserModifyRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "evmUserModify";
+        /** `true` for large blocks, `false` for small blocks. */
+        usingBigBlocks: boolean;
+    };
+}
 /**
  * Modify an order.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
  */
 export interface ModifyRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -151,15 +251,15 @@ export interface ModifyRequest extends BaseExchangeRequest {
         /** Order ID to modify. */
         oid: number;
         /** New order parameters. */
-        order: OrderParms;
+        order: OrderParams;
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Place an order(s).
  * @returns {OrderResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
  */
 export interface OrderRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -167,29 +267,29 @@ export interface OrderRequest extends BaseExchangeRequest {
         /** Type of action. */
         type: "order";
         /** Order parameters. */
-        orders: OrderParms[];
+        orders: OrderParams[];
         /**
          * Order grouping strategy:
-         * - `"na"`: Standard order without grouping.
-         * - `"normalTpsl"`: TP/SL order with fixed size that doesn't adjust with position changes.
-         * - `"positionTpsl"`: TP/SL order that adjusts proportionally with the position size.
+         * - `na`: Standard order without grouping.
+         * - `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes.
+         * - `positionTpsl`: TP/SL order that adjusts proportionally with the position size.
          */
         grouping: "na" | "normalTpsl" | "positionTpsl";
         /** Builder fee. */
         builder?: {
-            /** The address of the builder. */
+            /** Builder address. */
             b: Hex;
-            /** The builder fee to charge in tenths of basis points. */
+            /** Builder fee in 0.1bps (1 = 0.0001%). */
             f: number;
         };
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Schedule a time to cancel all open orders.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
  */
 export interface ScheduleCancelRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -200,16 +300,35 @@ export interface ScheduleCancelRequest extends BaseExchangeRequest {
          * Scheduled time (in ms since epoch).
          * Must be at least 5 seconds in the future.
          *
-         * If not specified, will cause all scheduled cancel operations to be deleted
+         * If not specified, will cause all scheduled cancel operations to be deleted.
          */
         time?: number;
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
+/**
+ * Set the display name in the leaderboard.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface SetDisplayNameRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "setDisplayName";
+        /**
+         * Display name.
+         *
+         * Set to an empty string to remove the display name.
+         */
+        displayName: string;
+    };
+}
 /**
  * Set a referral code.
  * @returns {SuccessResponse}
+ * @see null - no documentation
  */
 export interface SetReferrerRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -223,7 +342,7 @@ export interface SetReferrerRequest extends BaseExchangeRequest {
 /**
  * Transfer a spot asset on L1 to another address.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-spot-transfer | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-spot-transfer
  */
 export interface SpotSendRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -234,19 +353,57 @@ export interface SpotSendRequest extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
-        /** Recipient address. */
+        /** Unique request identifier (recommended current timestamp in ms). */
+        time: number;
+        /** Destination address. */
         destination: Hex;
         /** Token identifier. */
         token: `${string}:${Hex}`;
         /** Amount to send. */
         amount: string;
-        /** Current timestamp in ms. */
-        time: number;
     };
 }
 /**
- * Transfer between sub-accounts.
+ * Opt Out of Spot Dusting.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface SpotUserRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "spotUser";
+        /** Spot dusting options. */
+        toggleSpotDusting: {
+            /** Opt out of spot dusting. */
+            optOut: boolean;
+        };
+    };
+}
+/**
+ * Transfer between sub-accounts (spot).
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface SubAccountSpotTransferRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "subAccountSpotTransfer";
+        /** Sub-account address. */
+        subAccountUser: Hex;
+        /** `true` for deposit, `false` for withdrawal. */
+        isDeposit: boolean;
+        /** Token identifier. */
+        token: `${string}:${Hex}`;
+        /** Amount to send. */
+        amount: string;
+    };
+}
+/**
+ * Transfer between sub-accounts (perpetual).
  * @returns {SuccessResponse}
+ * @see null - no documentation
  */
 export interface SubAccountTransferRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -257,32 +414,56 @@ export interface SubAccountTransferRequest extends BaseExchangeRequest {
         subAccountUser: Hex;
         /** `true` for deposit, `false` for withdrawal. */
         isDeposit: boolean;
-        /** Amount to transfer (float * 1e6). */
+        /** Raw amount to transfer (float * 1e6). */
         usd: number;
     };
 }
+/**
+ * Delegate or undelegate stake from a validator.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#delegate-or-undelegate-stake-from-validator
+ */
+export interface TokenDelegateRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "tokenDelegate";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Validator address. */
+        validator: Hex;
+        /** `true` for undelegate, `false` for delegate. */
+        isUndelegate: boolean;
+        /** Amount of wei to delegate. */
+        wei: number;
+    };
+}
 /**
  * Cancel a TWAP order.
  * @returns {TwapCancelResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order
  */
 export interface TwapCancelRequest extends BaseExchangeRequest {
     /** Action to be performed. */
     action: {
         /** Type of action. */
         type: "twapCancel";
-        /** An integer representing the asset being traded. */
+        /** Asset ID. */
         a: number;
         /** Twap ID. */
         t: number;
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Place a TWAP order.
  * @returns {TwapOrderResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order
  */
 export interface TwapOrderRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -291,7 +472,7 @@ export interface TwapOrderRequest extends BaseExchangeRequest {
         type: "twapOrder";
         /** Twap parameters. */
         twap: {
-            /** An integer representing the asset being traded. */
+            /** Asset ID. */
             a: number;
             /** Position side (`true` for long, `false` for short). */
             b: boolean;
@@ -305,53 +486,53 @@ export interface TwapOrderRequest extends BaseExchangeRequest {
             t: boolean;
         };
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Update isolated margin for a position.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin
  */
 export interface UpdateIsolatedMarginRequest extends BaseExchangeRequest {
     /** Action to be performed. */
     action: {
         /** Type of action. */
         type: "updateIsolatedMargin";
-        /** An integer representing the asset being traded. */
+        /** Asset ID. */
         asset: number;
         /** Position side (`true` for long, `false` for short). */
         isBuy: boolean;
-        /** Amount to adjust (in USD). This should be an integer value. */
+        /** Amount to adjust (in USD). */
         ntli: number;
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Update leverage for cross or isolated margin.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage
  */
 export interface UpdateLeverageRequest extends BaseExchangeRequest {
     /** Action to be performed. */
     action: {
         /** Type of action. */
         type: "updateLeverage";
-        /** An integer representing the asset being traded. */
+        /** Asset ID. */
         asset: number;
         /** `true` for cross leverage, `false` for isolated leverage. */
         isCross: boolean;
         /** New leverage value. */
         leverage: number;
     };
-    /** Vault address (optional, for vault trading). */
+    /** Vault address (for vault trading). */
     vaultAddress?: Hex;
 }
 /**
  * Transfer funds between Spot and Perp accounts.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa
  */
 export interface UsdClassTransferRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -362,18 +543,18 @@ export interface UsdClassTransferRequest extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
-        /** USD amount to transfer. */
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount to transfer. */
         amount: string;
         /** `true` for Spot to Perp, `false` for Perp to Spot. */
         toPerp: boolean;
-        /** Unique request identifier (recommended: current timestamp in ms). */
-        nonce: number;
     };
 }
 /**
  * Transfer USDC on L1 to another address.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-usdc-transfer | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-usdc-transfer
  */
 export interface UsdSendRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -384,18 +565,56 @@ export interface UsdSendRequest extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
-        /** Recipient address. */
+        /** Unique request identifier (recommended current timestamp in ms). */
+        time: number;
+        /** Destination address. */
         destination: Hex;
-        /** USD amount to send. */
+        /** Amount to send. */
         amount: string;
-        /** Current timestamp in ms. */
-        time: number;
     };
 }
 /**
- * Transfer funds to/from a vault.
+ * Distribute funds from a vault between followers.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault | Hyperliquid GitBook}
+ * @see null - no documentation
+ */
+export interface VaultDistributeRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "vaultDistribute";
+        /** Vault address. */
+        vaultAddress: Hex;
+        /**
+         * Raw amount to distribute (float * 1e6).
+         *
+         * Set to 0 to close the vault.
+         */
+        usd: number;
+    };
+}
+/**
+ * Modify a vault's configuration.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface VaultModifyRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "vaultModify";
+        /** Vault address. */
+        vaultAddress: Hex;
+        /** Allow deposits from followers. */
+        allowDeposits: boolean | null;
+        /** Always close positions on withdrawal. */
+        alwaysCloseOnWithdraw: boolean | null;
+    };
+}
+/**
+ * Add or remove funds from a vault.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault
  */
 export interface VaultTransferRequest extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -406,14 +625,14 @@ export interface VaultTransferRequest extends BaseExchangeRequest {
         vaultAddress: Hex;
         /** `true` for deposit, `false` for withdrawal. */
         isDeposit: boolean;
-        /** Amount to transfer (float * 1e6). */
+        /** Raw amount to transfer (float * 1e6). */
         usd: number;
     };
 }
 /**
  * Initiate a withdrawal request.
  * @returns {SuccessResponse}
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request | Hyperliquid GitBook}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
  */
 export interface Withdraw3Request extends BaseExchangeRequest {
     /** Action to be performed. */
@@ -424,11 +643,11 @@ export interface Withdraw3Request extends BaseExchangeRequest {
         hyperliquidChain: "Mainnet" | "Testnet";
         /** Chain ID used for signing. */
         signatureChainId: Hex;
-        /** USD amount to withdraw. */
-        amount: string;
-        /** Current timestamp in ms. */
+        /** Unique request identifier (recommended current timestamp in ms). */
         time: number;
-        /** Recipient address. */
+        /** Amount to withdraw. */
+        amount: string;
+        /** Destination address. */
         destination: Hex;
     };
 }