@nktkas/hyperliquid 0.13.0

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

@@ -0,0 +1,682 @@
+import type { Hex } from "../types/common";
+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";
+import type { CancelResponse, CreateSubAccountResponse, ErrorResponse, OrderResponse, SuccessResponse, TwapCancelResponse, TwapOrderResponse } from "../types/exchange/responses";
+import type { IRequestTransport } from "../transports/base.js";
+import { type AbstractEthersSigner, type AbstractEthersV5Signer, type AbstractViemWalletClient } from "../utils/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`. */
+    isTestnet?: boolean;
+    /** Sets a default vaultAddress to be used if no vaultAddress is explicitly passed to a method. */
+    defaultVaultAddress?: Hex;
+}
+/** Parameters for the {@linkcode WalletClient.approveAgent} method. */
+export type ApproveAgentParameters = Omit<ApproveAgentRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveAgentRequest["action"], "signatureChainId" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.approveBuilderFee} method. */
+export type ApproveBuilderFeeParameters = Omit<ApproveBuilderFeeRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "nonce"> & Partial<Pick<ApproveBuilderFeeRequest["action"], "signatureChainId" | "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.cancelByCloid} method. */
+export type CancelByCloidParameters = Omit<CancelByCloidRequest["action"], "type"> & Partial<Pick<CancelByCloidRequest, "vaultAddress" | "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. */
+export type ModifyParameters = Omit<ModifyRequest["action"], "type"> & Partial<Pick<ModifyRequest, "vaultAddress" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.order} method. */
+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.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">>;
+/** Parameters for the {@linkcode WalletClient.subAccountTransfer} method. */
+export type SubAccountTransferParameters = Omit<SubAccountTransferRequest["action"], "type"> & Partial<Pick<SubAccountTransferRequest, "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. */
+export type TwapOrderParameters = TwapOrderRequest["action"]["twap"] & Partial<Pick<TwapOrderRequest, "vaultAddress" | "nonce">>;
+/** Parameters for the {@linkcode WalletClient.updateIsolatedMargin} method. */
+export type UpdateIsolatedMarginParameters = Omit<UpdateIsolatedMarginRequest["action"], "type"> & Partial<Pick<UpdateIsolatedMarginRequest, "vaultAddress" | "nonce">>;
+/** 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">>;
+/** Parameters for the {@linkcode WalletClient.usdSend} method. */
+export type UsdSendParameters = Omit<UsdSendRequest["action"], "type" | "hyperliquidChain" | "signatureChainId" | "time"> & Partial<Pick<UsdSendRequest["action"], "signatureChainId" | "time">>;
+/** 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">>;
+/** Successful variant of {@linkcode CancelResponse} without error statuses. */
+export type CancelResponseSuccess = CancelResponse & {
+    response: {
+        data: {
+            statuses: Exclude<CancelResponse["response"]["data"]["statuses"][number], {
+                error: string;
+            }>[];
+        };
+    };
+};
+/** Successful variant of {@linkcode OrderResponse} without error statuses. */
+export type OrderResponseSuccess = OrderResponse & {
+    response: {
+        data: {
+            statuses: Exclude<OrderResponse["response"]["data"]["statuses"][number], {
+                error: string;
+            }>[];
+        };
+    };
+};
+/** Successful variant of {@linkcode TwapCancelResponse} without error status. */
+export type TwapCancelResponseSuccess = TwapCancelResponse & {
+    response: {
+        data: {
+            status: Exclude<TwapCancelResponse["response"]["data"]["status"], {
+                error: string;
+            }>;
+        };
+    };
+};
+/** Successful variant of {@linkcode TwapOrderResponse} without error status. */
+export type TwapOrderResponseSuccess = TwapOrderResponse & {
+    response: {
+        data: {
+            status: Exclude<TwapOrderResponse["response"]["data"]["status"], {
+                error: string;
+            }>;
+        };
+    };
+};
+/** Error thrown when the API returns an error response. */
+export declare class ApiRequestError extends Error {
+    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.
+ */
+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. */
+    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;
+    /**
+     * Initialises a new instance.
+     * @param args - The parameters for the client.
+     *
+     * @example Private key via [viem](https://viem.sh/docs/clients/wallet#local-accounts-private-key-mnemonic-etc)
+     * ```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 });
+     * ```
+     *
+     * @example Private key via [ethers.js](https://docs.ethers.org/v6/api/wallet/#Wallet)
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { ethers } from "ethers";
+     *
+     * const wallet = new ethers.Wallet("0x...");
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     * ```
+     *
+     * @example External wallet (e.g. MetaMask) via [viem](https://viem.sh/docs/clients/wallet#optional-hoist-the-account)
+     * ```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 transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, 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.
+     * @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}
+     * @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.approveAgent({
+     *   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.
+     * @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}
+     * @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.approveBuilderFee({
+     *   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.
+     * @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}
+     * @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.batchModify({
+     *   modifies: [{
+     *     oid: 123, // Order ID
+     *     order: {
+     *       a: 0, // Asset index
+     *       b: true, // Buy order
+     *       p: "31000", // New price
+     *       s: "0.2", // New size
+     *       r: false, // Not reduce-only
+     *       t: {
+     *         limit: {
+     *           tif: "Gtc", // Good-til-cancelled
+     *         },
+     *       },
+     *       c: "0x...", // Optional: Client Order ID
+     *     },
+     *   }],
+     * });
+     * ```
+     */
+    batchModify(args: BatchModifyParameters, signal?: AbortSignal): Promise<OrderResponseSuccess>;
+    /**
+     * 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.
+     * @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}
+     * @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.cancel({
+     *   cancels: [{
+     *     a: 0, // Asset index
+     *     o: 123, // Order ID
+     *   }],
+     * });
+     * ```
+     */
+    cancel(args: CancelParameters, signal?: AbortSignal): Promise<CancelResponseSuccess>;
+    /**
+     * Cancel order(s) by Client Order ID.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns {CancelResponseSuccess} 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}
+     * @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.cancelByCloid({
+     *   cancels: [{
+     *     asset: 0,
+     *     cloid: "0x...", // Client Order ID
+     *   }],
+     * });
+     * ```
+     */
+    cancelByCloid(args: CancelByCloidParameters, signal?: AbortSignal): Promise<CancelResponseSuccess>;
+    /**
+     * 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.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @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.createSubAccount({
+     *   name: "subAccountName",
+     * });
+     * ```
+     */
+    createSubAccount(args: CreateSubAccountParameters, signal?: AbortSignal): Promise<CreateSubAccountResponse>;
+    /**
+     * Modify an order.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns {SuccessResponse} 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}
+     * @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.modify({
+     *   oid: 123, // Order ID
+     *   order: {
+     *     a: 0, // Asset index
+     *     b: true, // Buy order
+     *     p: "31000", // New price
+     *     s: "0.2", // New size
+     *     r: false, // Not reduce-only
+     *     t: {
+     *       limit: {
+     *         tif: "Gtc", // Good-til-cancelled
+     *       },
+     *     },
+     *     c: "0x...", // Optional: Client Order ID
+     *   },
+     * });
+     * ```
+     */
+    modify(args: ModifyParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * 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.
+     * @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}
+     * @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.order({
+     *   orders: [{
+     *     a: 0, // Asset index
+     *     b: true, // Buy order
+     *     p: "30000", // Price
+     *     s: "0.1", // Size
+     *     r: false, // Not reduce-only
+     *     t: {
+     *       limit: {
+     *         tif: "Gtc", // Good-til-cancelled
+     *       },
+     *     },
+     *     c: "0x...", // Optional: Client Order ID
+     *   }],
+     *   grouping: "na", // No grouping
+     * });
+     * ```
+     */
+    order(args: OrderParameters, signal?: AbortSignal): Promise<OrderResponseSuccess>;
+    /**
+     * 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.
+     * @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}
+     * @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.scheduleCancel({
+     *   time: Date.now() + 3600000, // Schedule cancellation 1 hour from now
+     * });
+     * ```
+     */
+    scheduleCancel(args?: ScheduleCancelParameters, 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.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @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.setReferrer({
+     *   code: "TEST",
+     * });
+     * ```
+     */
+    setReferrer(args: SetReferrerParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * 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.
+     * @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}
+     * @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.spotSend({
+     *   destination: "0x...",
+     *   token: "USDC:0xeb62eee3685fc4c43992febcd9e75443",
+     *   amount: "1",
+     * });
+     * ```
+     */
+    spotSend(args: SpotSendParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Transfer between sub-accounts.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns {SuccessResponse} Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @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.subAccountTransfer({
+     *   subAccountUser: "0x...",
+     *   isDeposit: true,
+     *   usd: 1000000, // 1 USD in raw units (float amount * 1e6)
+     * });
+     * ```
+     */
+    subAccountTransfer(args: SubAccountTransferParameters, 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.
+     * @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}
+     * @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.twapCancel({
+     *   a: 0, // Asset index
+     *   t: 1, // TWAP ID
+     * });
+     * ```
+     */
+    twapCancel(args: TwapCancelParameters, signal?: AbortSignal): Promise<TwapCancelResponseSuccess>;
+    /**
+     * 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.
+     * @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}
+     * @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.twapOrder({
+     *   a: 0, // Asset index
+     *   b: true, // Buy order
+     *   s: "1", // Size
+     *   r: false, // Not reduce-only
+     *   m: 10, // Duration in minutes
+     *   t: true, // Randomize order timing
+     * });
+     * ```
+     */
+    twapOrder(args: TwapOrderParameters, signal?: AbortSignal): Promise<TwapOrderResponseSuccess>;
+    /**
+     * 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.
+     * @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}
+     * @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.updateIsolatedMargin({
+     *   asset: 0,
+     *   isBuy: true, // Add to long position
+     *   ntli: 1000, // Add 1000 USD margin (integer only)
+     * });
+     * ```
+     */
+    updateIsolatedMargin(args: UpdateIsolatedMarginParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * 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.
+     * @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}
+     * @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.updateLeverage({
+     *   asset: 0,
+     *   isCross: true,
+     *   leverage: 5,
+     * });
+     * ```
+     */
+    updateLeverage(args: UpdateLeverageParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * 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.
+     * @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}
+     * @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.usdClassTransfer({
+     *   amount: "1000",
+     *   toPerp: true, // Transfer from Spot to Perp
+     * });
+     * ```
+     */
+    usdClassTransfer(args: UsdClassTransferParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * 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.
+     * @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}
+     * @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.usdSend({
+     *   destination: "0x...",
+     *   amount: "1000",
+     * });
+     * ```
+     */
+    usdSend(args: UsdSendParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Transfer funds to/from a vault.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns {SuccessResponse} 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}
+     * @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.vaultTransfer({
+     *   vaultAddress: "0x...",
+     *   isDeposit: true,
+     *   usd: 1000000, // 1 USD in raw units (float amount * 1e6)
+     * });
+     * ```
+     */
+    vaultTransfer(args: VaultTransferParameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /**
+     * Initiate a withdrawal request.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns {SuccessResponse} 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}
+     * @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.withdraw3({
+     *   destination: "0x...",
+     *   amount: "1000",
+     * });
+     * ```
+     */
+    withdraw3(args: Withdraw3Parameters, signal?: AbortSignal): Promise<SuccessResponse>;
+    /** Validate a response from the API. */
+    protected _validateResponse(response: SuccessResponse | ErrorResponse | CancelResponse | CreateSubAccountResponse | OrderResponse | TwapOrderResponse | TwapCancelResponse): asserts response is SuccessResponse | CancelResponseSuccess | CreateSubAccountResponse | OrderResponseSuccess | TwapOrderResponseSuccess | TwapCancelResponseSuccess;
+}
+//# sourceMappingURL=wallet.d.ts.map