@nktkas/hyperliquid 0.13.1 → 0.14.0

package/script/src/clients/wallet.d.ts

@@ -1,29 +1,47 @@
-import type { Hex } from "../types/common.js";
-import type { ApproveAgentRequest, ApproveBuilderFeeRequest, BatchModifyRequest, CancelByCloidRequest, CancelRequest, CreateSubAccountRequest, ModifyRequest, OrderRequest, ScheduleCancelRequest, SetReferrerRequest, SpotSendRequest, SubAccountTransferRequest, TwapCancelRequest, TwapOrderRequest, UpdateIsolatedMarginRequest, UpdateLeverageRequest, UsdClassTransferRequest, UsdSendRequest, VaultTransferRequest, Withdraw3Request } from "../types/exchange/requests.js";
+import { type Hex, HyperliquidError, type IRequestTransport } from "../base.js";
+import type { ApproveAgentRequest, ApproveBuilderFeeRequest, BatchModifyRequest, CancelByCloidRequest, CancelRequest, CDepositRequest, ClaimRewardsRequest, CreateSubAccountRequest, CWithdrawRequest, EvmUserModifyRequest, ModifyRequest, OrderRequest, ScheduleCancelRequest, SetDisplayNameRequest, SetReferrerRequest, SpotSendRequest, SpotUserRequest, SubAccountSpotTransferRequest, SubAccountTransferRequest, TokenDelegateRequest, TwapCancelRequest, TwapOrderRequest, UpdateIsolatedMarginRequest, UpdateLeverageRequest, UsdClassTransferRequest, UsdSendRequest, VaultDistributeRequest, VaultModifyRequest, VaultTransferRequest, Withdraw3Request } from "../types/exchange/requests.js";
 import type { CancelResponse, CreateSubAccountResponse, ErrorResponse, OrderResponse, SuccessResponse, TwapCancelResponse, TwapOrderResponse } from "../types/exchange/responses.js";
-import type { IRequestTransport } from "../transports/base.js";
-import { type AbstractEthersSigner, type AbstractEthersV5Signer, type AbstractViemWalletClient } from "../utils/signing.js";
+import { type AbstractEthersSigner, type AbstractEthersV5Signer, type AbstractViemWalletClient } from "../signing.js";
 /** Parameters for the {@linkcode WalletClient} constructor. */
 export interface WalletClientParameters<T extends IRequestTransport = IRequestTransport, W extends AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer = AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer> {
     /** The transport used to connect to the Hyperliquid API. */
     transport: T;
     /** The WalletClient/Account ([viem](https://viem.sh/docs/clients/wallet)) or Signer ([ethers.js](https://docs.ethers.org/v6/api/providers/#Signer)) used for signing transactions. */
     wallet: W;
-    /** Specifies whether the client uses testnet. Defaults to `false`. */
+    /**
+     * Specifies whether the client uses testnet.
+     *
+     * Defaults to `false`.
+     */
     isTestnet?: boolean;
     /** Sets a default vaultAddress to be used if no vaultAddress is explicitly passed to a method. */
     defaultVaultAddress?: Hex;
+    /**
+     * The network that will be used to sign transactions.
+     * Must match the network of the {@link wallet}.
+     *
+     * Defaults to `0xa4b1` for `isTestnet = false` or `0x66eee` for `isTestnet = true`.
+     */
+    signatureChainId?: Hex;
 }
 /** Parameters for the {@linkcode WalletClient.approveAgent} method. */
-export type ApproveAgentParameters = Omit<ApproveAgentRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveAgentRequest["action"], "signatureChainId" | "nonce">>;
+export type ApproveAgentParameters = Omit<ApproveAgentRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveAgentRequest["action"], "nonce">>;
 /** Parameters for the {@linkcode WalletClient.approveBuilderFee} method. */
-export type ApproveBuilderFeeParameters = Omit<ApproveBuilderFeeRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveBuilderFeeRequest["action"], "signatureChainId" | "nonce">>;
+export type ApproveBuilderFeeParameters = Omit<ApproveBuilderFeeRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveBuilderFeeRequest["action"], "nonce">>;
 /** Parameters for the {@linkcode WalletClient.batchModify} method. */
 export type BatchModifyParameters = Omit<BatchModifyRequest["action"], "type"> & Partial<Pick<BatchModifyRequest, "vaultAddress" | "nonce">>;
 /** Parameters for the {@linkcode WalletClient.cancel} method. */
 export type CancelParameters = Omit<CancelRequest["action"], "type"> & Partial<Pick<CancelRequest, "vaultAddress" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.cDeposit} method. */
+export type CDepositParameters = Omit<CDepositRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<CDepositRequest["action"], "nonce">>;
+/** Parameters for the {@linkcode WalletClient.claimRewards} method. */
+export type ClaimRewardsParameters = Omit<ClaimRewardsRequest["action"], "type"> & Partial<Pick<ClaimRewardsRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.cancelByCloid} method. */
 export type CancelByCloidParameters = Omit<CancelByCloidRequest["action"], "type"> & Partial<Pick<CancelByCloidRequest, "vaultAddress" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.cWithdraw} method. */
+export type CWithdrawParameters = Omit<CWithdrawRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<CWithdrawRequest["action"], "nonce">>;
+/** Parameters for the {@linkcode WalletClient.evmUserModify} method. */
+export type EvmUserModifyParameters = Omit<EvmUserModifyRequest["action"], "type"> & Partial<Pick<EvmUserModifyRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.createSubAccount} method. */
 export type CreateSubAccountParameters = Omit<CreateSubAccountRequest["action"], "type"> & Partial<Pick<CreateSubAccountRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.modify} method. */
@@ -32,12 +50,20 @@ export type ModifyParameters = Omit<ModifyRequest["action"], "type"> & Partial<P
 export type OrderParameters = Omit<OrderRequest["action"], "type"> & Partial<Pick<OrderRequest, "vaultAddress" | "nonce">>;
 /** Parameters for the {@linkcode WalletClient.scheduleCancel} method. */
 export type ScheduleCancelParameters = Omit<ScheduleCancelRequest["action"], "type"> & Partial<Pick<ScheduleCancelRequest, "vaultAddress" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.setDisplayName} method. */
+export type SetDisplayNameParameters = Omit<SetDisplayNameRequest["action"], "type"> & Partial<Pick<SetDisplayNameRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.setReferrer} method. */
 export type SetReferrerParameters = Omit<SetReferrerRequest["action"], "type"> & Partial<Pick<SetReferrerRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.spotSend} method. */
-export type SpotSendParameters = Omit<SpotSendRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<SpotSendRequest["action"], "signatureChainId" | "time">>;
+export type SpotSendParameters = Omit<SpotSendRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<SpotSendRequest["action"], "time">>;
+/** Parameters for the {@linkcode WalletClient.spotUser} method. */
+export type SpotUserParameters = Omit<SpotUserRequest["action"], "type"> & Partial<Pick<SpotUserRequest, "nonce">>;
+/** Parameters for the {@linkcode WalletClient.subAccountSpotTransfer} method. */
+export type SubAccountSpotTransferParameters = Omit<SubAccountSpotTransferRequest["action"], "type"> & Partial<Pick<SubAccountSpotTransferRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.subAccountTransfer} method. */
 export type SubAccountTransferParameters = Omit<SubAccountTransferRequest["action"], "type"> & Partial<Pick<SubAccountTransferRequest, "nonce">>;
+/** Parameters for the {@linkcode WalletClient.tokenDelegate} method. */
+export type TokenDelegateParameters = Omit<TokenDelegateRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<TokenDelegateRequest["action"], "nonce">>;
 /** Parameters for the {@linkcode WalletClient.twapCancel} method. */
 export type TwapCancelParameters = Omit<TwapCancelRequest["action"], "type"> & Partial<Pick<TwapCancelRequest, "vaultAddress" | "nonce">>;
 /** Parameters for the {@linkcode WalletClient.twapOrder} method. */
@@ -47,13 +73,17 @@ export type UpdateIsolatedMarginParameters = Omit<UpdateIsolatedMarginRequest["a
 /** Parameters for the {@linkcode WalletClient.updateLeverage} method. */
 export type UpdateLeverageParameters = Omit<UpdateLeverageRequest["action"], "type"> & Partial<Pick<UpdateLeverageRequest, "vaultAddress" | "nonce">>;
 /** Parameters for the {@linkcode WalletClient.usdClassTransfer} method. */
-export type UsdClassTransferParameters = Omit<UsdClassTransferRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<UsdClassTransferRequest["action"], "signatureChainId" | "nonce">>;
+export type UsdClassTransferParameters = Omit<UsdClassTransferRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<UsdClassTransferRequest["action"], "nonce">>;
 /** Parameters for the {@linkcode WalletClient.usdSend} method. */
-export type UsdSendParameters = Omit<UsdSendRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<UsdSendRequest["action"], "signatureChainId" | "time">>;
+export type UsdSendParameters = Omit<UsdSendRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<UsdSendRequest["action"], "time">>;
+/** Parameters for the {@linkcode WalletClient.vaultDistribute} method. */
+export type VaultDistributeParameters = Omit<VaultDistributeRequest["action"], "type"> & Partial<Pick<VaultDistributeRequest, "nonce">>;
+/** Parameters for the {@linkcode WalletClient.vaultModify} method. */
+export type VaultModifyParameters = Omit<VaultModifyRequest["action"], "type"> & Partial<Pick<VaultModifyRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.vaultTransfer} method. */
 export type VaultTransferParameters = Omit<VaultTransferRequest["action"], "type"> & Partial<Pick<VaultTransferRequest, "nonce">>;
 /** Parameters for the {@linkcode WalletClient.withdraw3} method. */
-export type Withdraw3Parameters = Omit<Withdraw3Request["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<Withdraw3Request["action"], "signatureChainId" | "time">>;
+export type Withdraw3Parameters = Omit<Withdraw3Request["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<Withdraw3Request["action"], "time">>;
 /** Successful variant of {@linkcode CancelResponse} without error statuses. */
 export type CancelResponseSuccess = CancelResponse & {
     response: {
@@ -95,24 +125,32 @@ export type TwapOrderResponseSuccess = TwapOrderResponse & {
     };
 };
 /** Error thrown when the API returns an error response. */
-export declare class ApiRequestError extends Error {
+export declare class ApiRequestError extends HyperliquidError {
     response: ErrorResponse | OrderResponse | CancelResponse | TwapOrderResponse | TwapCancelResponse;
     constructor(response: ErrorResponse | OrderResponse | CancelResponse | TwapOrderResponse | TwapCancelResponse);
 }
 /**
  * Wallet client for interacting with the Hyperliquid API.
- * @typeParam T - The transport used to connect to the Hyperliquid API.
- * @typeParam W - The WalletClient/Account ([viem](https://viem.sh/docs/clients/wallet)) or Signer ([ethers.js](https://docs.ethers.io/v6/api/providers/#Signer)) used for signing transactions.
+ * @typeParam T The transport used to connect to the Hyperliquid API.
+ * @typeParam W The WalletClient/Account ([viem](https://viem.sh/docs/clients/wallet)) or Signer ([ethers.js](https://docs.ethers.io/v6/api/providers/#Signer)) used for signing transactions.
  */
 export declare class WalletClient<T extends IRequestTransport = IRequestTransport, W extends AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer = AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer> {
     /** The transport used to connect to the Hyperliquid API. */
     transport: T;
-    /** The WalletClient/Account ([viem](https://viem.sh/docs/clients/wallet)) or Signer ([ethers.js](https://docs.ethers.org/v6/api/providers/#Signer)) used for signing transactions. */
+    /**
+     * The [viem](https://viem.sh/docs/clients/wallet) or [ethers.js](https://docs.ethers.org/v6/api/providers/#Signer)
+     * used for signing transactions.
+     */
     wallet: W;
     /** Specifies whether the client uses testnet. */
     isTestnet: boolean;
     /** Sets a default vaultAddress to be used if no vaultAddress is explicitly passed to a method. */
     defaultVaultAddress?: Hex;
+    /**
+     * The network that will be used to sign transactions.
+     * Must match the network of the {@link wallet}.
+     */
+    signatureChainId: Hex;
     /**
      * Initialises a new instance.
      * @param args - The parameters for the client.
@@ -128,7 +166,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const client = new hl.WalletClient({ wallet, transport });
      * ```
      *
-     * @example Private key via [ethers.js](https://docs.ethers.org/v6/api/wallet/#Wallet)
+     * @example Private key via [ethers.js](https://docs.ethers.org/v6/api/wallet/#Wallet) or [ethers.js v5](https://docs.ethers.org/v5/api/signer/#Wallet)
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      * import { ethers } from "ethers";
@@ -143,24 +181,31 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      * import { createWalletClient, custom } from "viem";
-     * import { arbitrum } from "viem/chains";
      *
      * const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
-     * const wallet = createWalletClient({ account, chain: arbitrum, transport: custom(window.ethereum) });
+     * const wallet = createWalletClient({ account, transport: custom(window.ethereum) });
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      * ```
+     *
+     * @example External wallet (e.g. MetaMask) via `window.ethereum` directly
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet: window.ethereum, transport });
+     * ```
      */
     constructor(args: WalletClientParameters<T, W>);
     /**
      * Approve an agent to sign on behalf of the master or sub-accounts.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -174,16 +219,17 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      *   agentAddress: "0x...",
      *   agentName: "agentName",
      * });
+     * ```
      */
     approveAgent(args: ApproveAgentParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
      * Approve a max fee rate for a builder address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -197,16 +243,17 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      *   maxFeeRate: "0.01%",
      *   builder: "0x...",
      * });
+     * ```
      */
     approveBuilderFee(args: ApproveBuilderFeeParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
      * Modify multiple orders.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {OrderResponseSuccess} Successful variant of {@link OrderResponse} without error statuses.
+     * @returns Successful variant of {@link OrderResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -241,10 +288,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Cancel order(s).
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CancelResponseSuccess} Successful variant of {@link CancelResponse} without error statuses.
+     * @returns Successful variant of {@link CancelResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -264,13 +311,55 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      */
     cancel(args: CancelParameters, signal?: AbortSignal): Promise<CancelResponseSuccess>;
     /**
-     * Cancel order(s) by Client Order ID.
+     * Deposit into staking balance.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.cDeposit({ wei: 1 * 1e8 });
+     * ```
+     */
+    cDeposit(args: CDepositParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Claim rewards from referral program.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.claimRewards();
+     * ```
+     */
+    claimRewards(args?: ClaimRewardsParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Cancel order(s) by cloid.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CancelResponseSuccess} Successful variant of {@link CancelResponse} without error statuses.
+     * @returns Successful variant of {@link CancelResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -289,13 +378,56 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * ```
      */
     cancelByCloid(args: CancelByCloidParameters, signal?: AbortSignal): Promise<CancelResponseSuccess>;
+    /**
+     * Withdraw from staking balance.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.cWithdraw({ wei: 1 * 1e8 });
+     * ```
+     */
+    cWithdraw(args: CWithdrawParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Configure block type for EVM transactions.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Response for creating a sub-account.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/evm/dual-block-architecture
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.evmUserModify({ usingBigBlocks: true });
+     * ```
+     */
+    evmUserModify(args: EvmUserModifyParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
      * Create a sub-account.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CreateSubAccountResponse} Response for creating a sub-account.
+     * @returns Response for creating a sub-account.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -305,9 +437,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.createSubAccount({
-     *   name: "subAccountName",
-     * });
+     * const result = await client.createSubAccount({ name: "subAccountName" });
      * ```
      */
     createSubAccount(args: CreateSubAccountParameters, signal?: AbortSignal): Promise<CreateSubAccountResponse>;
@@ -315,10 +445,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Modify an order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -351,10 +481,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Place an order(s).
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {OrderResponseSuccess} Successful variant of {@link OrderResponse} without error statuses.
+     * @returns Successful variant of {@link OrderResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -387,10 +517,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Schedule a time to cancel all open orders.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -400,19 +530,39 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.scheduleCancel({
-     *   time: Date.now() + 3600000, // Schedule cancellation 1 hour from now
-     * });
+     * const result = await client.scheduleCancel({ time: Date.now() + 3600000 });
      * ```
      */
     scheduleCancel(args?: ScheduleCancelParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Set the display name in the leaderboard.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.setDisplayName({ displayName: "My Name" });
+     * ```
+     */
+    setDisplayName(args: SetDisplayNameParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
      * Set a referral code.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -422,9 +572,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.setReferrer({
-     *   code: "TEST",
-     * });
+     * const result = await client.setReferrer({ code: "TEST" });
      * ```
      */
     setReferrer(args: SetReferrerParameters, signal?: AbortSignal): Promise<SuccessResponse>;
@@ -432,10 +580,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Transfer a spot asset on L1 to another address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -454,12 +602,62 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      */
     spotSend(args: SpotSendParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
-     * Transfer between sub-accounts.
+     * Opt Out of Spot Dusting.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.spotUser({
+     *   toggleSpotDusting: { optOut: false },
+     * });
+     * ```
+     */
+    spotUser(args: SpotUserParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Transfer between sub-accounts (spot).
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.subAccountSpotTransfer({
+     *   subAccountUser: "0x...",
+     *   isDeposit: true,
+     *   token: "USDC:0xeb62eee3685fc4c43992febcd9e75443",
+     *   amount: "1",
+     * });
+     * ```
+     */
+    subAccountSpotTransfer(args: SubAccountSpotTransferParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Transfer between sub-accounts (perpetual).
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -472,19 +670,44 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const result = await client.subAccountTransfer({
      *   subAccountUser: "0x...",
      *   isDeposit: true,
-     *   usd: 1000000, // 1 USD in raw units (float amount * 1e6)
+     *   usd: 1 * 1e6,
      * });
      * ```
      */
     subAccountTransfer(args: SubAccountTransferParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Delegate or undelegate stake from a validator.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#delegate-or-undelegate-stake-from-validator
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.tokenDelegate({
+     *   validator: "0x...",
+     *   isUndelegate: true,
+     *   wei: 1 * 1e8,
+     * });
+     * ```
+     */
+    tokenDelegate(args: TokenDelegateParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
      * Cancel a TWAP order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {TwapCancelResponseSuccess} Successful variant of {@link TwapCancelResponse} without error status.
+     * @returns Successful variant of {@link TwapCancelResponse} without error status.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -505,10 +728,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Place a TWAP order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {TwapOrderResponseSuccess} Successful variant of {@link TwapOrderResponse} without error status.
+     * @returns Successful variant of {@link TwapOrderResponse} without error status.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -533,10 +756,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Update isolated margin for a position.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -549,7 +772,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const result = await client.updateIsolatedMargin({
      *   asset: 0,
      *   isBuy: true, // Add to long position
-     *   ntli: 1000, // Add 1000 USD margin (integer only)
+     *   ntli: 1, // Add 1 USD margin (integer only)
      * });
      * ```
      */
@@ -558,10 +781,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Update leverage for cross or isolated margin.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -583,10 +806,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Transfer funds between Spot and Perp accounts.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -597,7 +820,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const client = new hl.WalletClient({ wallet, transport });
      *
      * const result = await client.usdClassTransfer({
-     *   amount: "1000",
+     *   amount: "1",
      *   toPerp: true, // Transfer from Spot to Perp
      * });
      * ```
@@ -607,10 +830,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Transfer USDC on L1 to another address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -622,19 +845,68 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      *
      * const result = await client.usdSend({
      *   destination: "0x...",
-     *   amount: "1000",
+     *   amount: "1",
      * });
      * ```
      */
     usdSend(args: UsdSendParameters, signal?: AbortSignal): Promise<SuccessResponse>;
     /**
-     * Transfer funds to/from a vault.
+     * Distribute funds from a vault between followers.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.vaultDistribute({
+     *   vaultAddress: "0x...",
+     *   usd: 10 * 1e6,
+     * });
+     * ```
+     */
+    vaultDistribute(args: VaultDistributeParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Modify a vault's configuration.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.vaultModify({
+     *   vaultAddress: "0x...",
+     *   allowDeposits: true,
+     *   alwaysCloseOnWithdraw: false,
+     * });
+     * ```
+     */
+    vaultModify(args: VaultModifyParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Add or remove funds from a vault.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -647,7 +919,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * const result = await client.vaultTransfer({
      *   vaultAddress: "0x...",
      *   isDeposit: true,
-     *   usd: 1000000, // 1 USD in raw units (float amount * 1e6)
+     *   usd: 10 * 1e6,
      * });
      * ```
      */
@@ -656,10 +928,10 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      * Initiate a withdrawal request.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @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
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -671,7 +943,7 @@ export declare class WalletClient<T extends IRequestTransport = IRequestTranspor
      *
      * const result = await client.withdraw3({
      *   destination: "0x...",
-     *   amount: "1000",
+     *   amount: "1",
      * });
      * ```
      */