@nktkas/hyperliquid 0.30.2 → 0.31.0

package/src/src/api/exchange/client.ts

@@ -9,6 +9,12 @@ import {
   type AgentEnableDexAbstractionOptions,
   type AgentEnableDexAbstractionSuccessResponse,
 } from "./_methods/agentEnableDexAbstraction.js";
+import {
+  agentSetAbstraction,
+  type AgentSetAbstractionOptions,
+  type AgentSetAbstractionParameters,
+  type AgentSetAbstractionSuccessResponse,
+} from "./_methods/agentSetAbstraction.js";
 import {
   approveAgent,
   type ApproveAgentOptions,
@@ -27,6 +33,12 @@ import {
   type BatchModifyParameters,
   type BatchModifySuccessResponse,
 } from "./_methods/batchModify.js";
+import {
+  borrowLend,
+  type BorrowLendOptions,
+  type BorrowLendParameters,
+  type BorrowLendSuccessResponse,
+} from "./_methods/borrowLend.js";
 import { cancel, type CancelOptions, type CancelParameters, type CancelSuccessResponse } from "./_methods/cancel.js";
 import {
   cancelByCloid,
@@ -218,6 +230,18 @@ import {
   type UserDexAbstractionParameters,
   type UserDexAbstractionSuccessResponse,
 } from "./_methods/userDexAbstraction.js";
+import {
+  userSetAbstraction,
+  type UserSetAbstractionOptions,
+  type UserSetAbstractionParameters,
+  type UserSetAbstractionSuccessResponse,
+} from "./_methods/userSetAbstraction.js";
+import {
+  userPortfolioMargin,
+  type UserPortfolioMarginOptions,
+  type UserPortfolioMarginParameters,
+  type UserPortfolioMarginSuccessResponse,
+} from "./_methods/userPortfolioMargin.js";
 import {
   validatorL1Stream,
   type ValidatorL1StreamOptions,
@@ -309,14 +333,99 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     this.config_ = config;
   }
 
-  /** @see {@link agentEnableDexAbstraction} */
+  /**
+   * Enable HIP-3 DEX abstraction.
+   *
+   * @deprecated Use {@link agentSetAbstraction} instead.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.agentEnableDexAbstraction();
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#enable-hip-3-dex-abstraction-agent
+   */
   agentEnableDexAbstraction(
     opts?: AgentEnableDexAbstractionOptions,
   ): Promise<AgentEnableDexAbstractionSuccessResponse> {
     return agentEnableDexAbstraction(this.config_, opts);
   }
 
-  /** @see {@link approveAgent} */
+  /**
+   * Set User abstraction mode (method for agent wallet).
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.agentSetAbstraction({ abstraction: "u" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#set-user-abstraction-agent
+   */
+  agentSetAbstraction(
+    params: AgentSetAbstractionParameters,
+    opts?: AgentSetAbstractionOptions,
+  ): Promise<AgentSetAbstractionSuccessResponse> {
+    return agentSetAbstraction(this.config_, params, opts);
+  }
+
+  /**
+   * Approve an agent to sign on behalf of the master account.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.approveAgent({ agentAddress: "0x...", agentName: "myAgent" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet
+   */
   approveAgent(
     params: ApproveAgentParameters,
     opts?: ApproveAgentOptions,
@@ -324,7 +433,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return approveAgent(this.config_, params, opts);
   }
 
-  /** @see {@link approveBuilderFee} */
+  /**
+   * Approve a maximum fee rate for a builder.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.approveBuilderFee({ maxFeeRate: "0.01%", builder: "0x..." });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee
+   */
   approveBuilderFee(
     params: ApproveBuilderFeeParameters,
     opts?: ApproveBuilderFeeOptions,
@@ -332,7 +466,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return approveBuilderFee(this.config_, params, opts);
   }
 
-  /** @see {@link batchModify} */
+  /**
+   * Modify multiple orders.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link OrderResponse} without error statuses.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.batchModify({ modifies: [ { oid: 123, order: { a: 0, b: true, p: "31000", s: "0.2", r: false, t: { limit: { tif: "Gtc" } } } }, ] });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+   */
   batchModify(
     params: BatchModifyParameters,
     opts?: BatchModifyOptions,
@@ -340,7 +499,63 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return batchModify(this.config_, params, opts);
   }
 
-  /** @see {@link cancel} */
+  /**
+   * Borrow or lend assets.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.borrowLend({ operation: "supply", token: 0, amount: "20" });
+   * ```
+   */
+  borrowLend(
+    params: BorrowLendParameters,
+    opts?: BorrowLendOptions,
+  ): Promise<BorrowLendSuccessResponse> {
+    return borrowLend(this.config_, params, opts);
+  }
+
+  /**
+   * Cancel order(s).
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link CancelResponse} without error statuses.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.cancel({ cancels: [ { a: 0, o: 123 }, ] });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
+   */
   cancel(
     params: CancelParameters,
     opts?: CancelOptions,
@@ -348,7 +563,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return cancel(this.config_, params, opts);
   }
 
-  /** @see {@link cancelByCloid} */
+  /**
+   * Cancel order(s) by cloid.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link CancelResponse} without error statuses.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.cancelByCloid({ cancels: [ { asset: 0, cloid: "0x..." }, ] });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
+   */
   cancelByCloid(
     params: CancelByCloidParameters,
     opts?: CancelByCloidOptions,
@@ -356,7 +596,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return cancelByCloid(this.config_, params, opts);
   }
 
-  /** @see {@link cDeposit} */
+  /**
+   * Transfer native token from the user spot account into staking for delegating to validators.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.cDeposit({ wei: 1 * 1e8 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+   */
   cDeposit(
     params: CDepositParameters,
     opts?: CDepositOptions,
@@ -364,14 +629,73 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return cDeposit(this.config_, params, opts);
   }
 
-  /** @see {@link claimRewards} */
+  /**
+   * Claim rewards from referral program.
+   *
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.claimRewards();
+   * ```
+   */
   claimRewards(
     opts?: ClaimRewardsOptions,
   ): Promise<ClaimRewardsSuccessResponse> {
     return claimRewards(this.config_, opts);
   }
 
-  /** @see {@link convertToMultiSigUser} */
+  /**
+   * Convert a single-signature account to a multi-signature account or vice versa.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.convertToMultiSigUser({ signers: { authorizedUsers: ["0x...", "0x...", "0x..."], threshold: 2 } });
+   * ```
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.convertToMultiSigUser({ signers: null });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
+   */
   convertToMultiSigUser(
     params: ConvertToMultiSigUserParameters,
     opts?: ConvertToMultiSigUserOptions,
@@ -379,7 +703,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return convertToMultiSigUser(this.config_, params, opts);
   }
 
-  /** @see {@link createSubAccount} */
+  /**
+   * Create a sub-account.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Response for creating a sub-account.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.createSubAccount({ name: "..." });
+   * ```
+   */
   createSubAccount(
     params: CreateSubAccountParameters,
     opts?: CreateSubAccountOptions,
@@ -387,7 +734,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return createSubAccount(this.config_, params, opts);
   }
 
-  /** @see {@link createVault} */
+  /**
+   * Create a vault.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Response for creating a vault.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.createVault({ name: "...", description: "...", initialUsd: 100 * 1e6, nonce: Date.now() });
+   * ```
+   */
   createVault(
     params: CreateVaultParameters,
     opts?: CreateVaultOptions,
@@ -395,7 +765,42 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return createVault(this.config_, params, opts);
   }
 
-  /** @see {@link cSignerAction} */
+  /**
+   * Jail or unjail self as a validator signer.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.cSignerAction({ jailSelf: null });
+   * ```
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.cSignerAction({ unjailSelf: null });
+   * ```
+   */
   cSignerAction(
     params: CSignerActionParameters,
     opts?: CSignerActionOptions,
@@ -403,23 +808,96 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return cSignerAction(this.config_, params, opts);
   }
 
-  /** @see {@link cValidatorAction} */
-  cValidatorAction(
-    params: CValidatorActionParameters,
-    opts?: CValidatorActionOptions,
-  ): Promise<CValidatorActionSuccessResponse> {
-    return cValidatorAction(this.config_, params, opts);
-  }
-
-  /** @see {@link cWithdraw} */
-  cWithdraw(
+  /**
+   * Action related to validator management.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.cValidatorAction({ changeProfile: { node_ip: { Ip: "1.2.3.4" }, name: "...", description: "...", unjailed: true, disable_delegations: false, commission_bps: null, signer: null } });
+   * ```
+   */
+  cValidatorAction(
+    params: CValidatorActionParameters,
+    opts?: CValidatorActionOptions,
+  ): Promise<CValidatorActionSuccessResponse> {
+    return cValidatorAction(this.config_, params, opts);
+  }
+
+  /**
+   * Transfer native token from staking into the user's spot account.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.cWithdraw({ wei: 1 * 1e8 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
+   */
+  cWithdraw(
     params: CWithdrawParameters,
     opts?: CWithdrawOptions,
   ): Promise<CWithdrawSuccessResponse> {
     return cWithdraw(this.config_, params, opts);
   }
 
-  /** @see {@link evmUserModify} */
+  /**
+   * Configure block type for EVM transactions.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.evmUserModify({ usingBigBlocks: true });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/dual-block-architecture
+   */
   evmUserModify(
     params: EvmUserModifyParameters,
     opts?: EvmUserModifyOptions,
@@ -427,7 +905,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return evmUserModify(this.config_, params, opts);
   }
 
-  /** @see {@link linkStakingUser} */
+  /**
+   * Link staking and trading accounts for fee discount attribution.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.linkStakingUser({ user: "0x...", isFinalize: false });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+   */
   linkStakingUser(
     params: LinkStakingUserParameters,
     opts?: LinkStakingUserOptions,
@@ -435,7 +938,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return linkStakingUser(this.config_, params, opts);
   }
 
-  /** @see {@link modify} */
+  /**
+   * Modify an order.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.modify({ oid: 123, order: { a: 0, b: true, p: "31000", s: "0.2", r: false, t: { limit: { tif: "Gtc" } }, c: "0x..." } });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+   */
   modify(
     params: ModifyParameters,
     opts?: ModifyOptions,
@@ -443,7 +971,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return modify(this.config_, params, opts);
   }
 
-  /** @see {@link order} */
+  /**
+   * Place an order(s).
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link OrderResponse} without error statuses.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.order({ orders: [ { a: 0, b: true, p: "30000", s: "0.1", r: false, t: { limit: { tif: "Gtc" } }, c: "0x..." }, ], grouping: "na" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+   */
   order(
     params: OrderParameters,
     opts?: OrderOptions,
@@ -451,14 +1004,64 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return order(this.config_, params, opts);
   }
 
-  /** @see {@link noop} */
+  /**
+   * This action does not do anything (no operation), but causes the nonce to be marked as used.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.noop();
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#invalidate-pending-nonce-noop
+   */
   noop(
     opts?: NoopOptions,
   ): Promise<NoopSuccessResponse> {
     return noop(this.config_, opts);
   }
 
-  /** @see {@link perpDeploy} */
+  /**
+   * Deploying HIP-3 assets.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.perpDeploy({ registerAsset: { maxGas: 1000000, assetRequest: { coin: "USDC", szDecimals: 8, oraclePx: "1", marginTableId: 1, onlyIsolated: false }, dex: "test", schema: null } });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-3-deployer-actions
+   */
   perpDeploy(
     params: PerpDeployParameters,
     opts?: PerpDeployOptions,
@@ -466,7 +1069,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return perpDeploy(this.config_, params, opts);
   }
 
-  /** @see {@link registerReferrer} */
+  /**
+   * Create a referral code.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.registerReferrer({ code: "..." });
+   * ```
+   */
   registerReferrer(
     params: RegisterReferrerParameters,
     opts?: RegisterReferrerOptions,
@@ -474,7 +1100,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return registerReferrer(this.config_, params, opts);
   }
 
-  /** @see {@link reserveRequestWeight} */
+  /**
+   * Reserve additional rate-limited actions for a fee.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.reserveRequestWeight({ weight: 10 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#reserve-additional-actions
+   */
   reserveRequestWeight(
     params: ReserveRequestWeightParameters,
     opts?: ReserveRequestWeightOptions,
@@ -482,7 +1133,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return reserveRequestWeight(this.config_, params, opts);
   }
 
-  /** @see {@link scheduleCancel} */
+  /**
+   * Schedule a cancel-all operation at a future time.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.scheduleCancel({ time: Date.now() + 10_000 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
+   */
   scheduleCancel(
     params?: ScheduleCancelParameters,
     opts?: ScheduleCancelOptions,
@@ -500,7 +1176,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return scheduleCancel(this.config_, params, opts);
   }
 
-  /** @see {@link sendAsset} */
+  /**
+   * Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.sendAsset({ destination: "0x0000000000000000000000000000000000000001", sourceDex: "", destinationDex: "test", token: "USDC:0xeb62eee3685fc4c43992febcd9e75443", amount: "1" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset
+   */
   sendAsset(
     params: SendAssetParameters,
     opts?: SendAssetOptions,
@@ -508,7 +1209,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return sendAsset(this.config_, params, opts);
   }
 
-  /** @see {@link setDisplayName} */
+  /**
+   * Set the display name in the leaderboard.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.setDisplayName({ displayName: "..." });
+   * ```
+   */
   setDisplayName(
     params: SetDisplayNameParameters,
     opts?: SetDisplayNameOptions,
@@ -516,7 +1240,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return setDisplayName(this.config_, params, opts);
   }
 
-  /** @see {@link setReferrer} */
+  /**
+   * Set a referral code.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.setReferrer({ code: "..." });
+   * ```
+   */
   setReferrer(
     params: SetReferrerParameters,
     opts?: SetReferrerOptions,
@@ -524,7 +1271,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return setReferrer(this.config_, params, opts);
   }
 
-  /** @see {@link spotDeploy} */
+  /**
+   * Deploying HIP-1 and HIP-2 assets.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.spotDeploy({ registerToken2: { spec: { name: "USDC", szDecimals: 8, weiDecimals: 8 }, maxGas: 1000000, fullName: "USD Coin" } });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-1-and-hip-2-assets
+   */
   spotDeploy(
     params: SpotDeployParameters,
     opts?: SpotDeployOptions,
@@ -532,7 +1304,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return spotDeploy(this.config_, params, opts);
   }
 
-  /** @see {@link spotSend} */
+  /**
+   * Send spot assets to another address.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.spotSend({ destination: "0x...", token: "USDC:0xeb62eee3685fc4c43992febcd9e75443", amount: "1" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-spot-transfer
+   */
   spotSend(
     params: SpotSendParameters,
     opts?: SpotSendOptions,
@@ -540,7 +1337,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return spotSend(this.config_, params, opts);
   }
 
-  /** @see {@link spotUser} */
+  /**
+   * Opt Out of Spot Dusting.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.spotUser({ toggleSpotDusting: { optOut: false } });
+   * ```
+   */
   spotUser(
     params: SpotUserParameters,
     opts?: SpotUserOptions,
@@ -548,7 +1368,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return spotUser(this.config_, params, opts);
   }
 
-  /** @see {@link subAccountModify} */
+  /**
+   * Modify a sub-account.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.subAccountModify({ subAccountUser: "0x...", name: "..." });
+   * ```
+   */
   subAccountModify(
     params: SubAccountModifyParameters,
     opts?: SubAccountModifyOptions,
@@ -556,7 +1399,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return subAccountModify(this.config_, params, opts);
   }
 
-  /** @see {@link subAccountSpotTransfer} */
+  /**
+   * Transfer between sub-accounts (spot).
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.subAccountSpotTransfer({ subAccountUser: "0x...", isDeposit: true, token: "USDC:0xeb62eee3685fc4c43992febcd9e75443", amount: "1" });
+   * ```
+   */
   subAccountSpotTransfer(
     params: SubAccountSpotTransferParameters,
     opts?: SubAccountSpotTransferOptions,
@@ -564,7 +1430,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return subAccountSpotTransfer(this.config_, params, opts);
   }
 
-  /** @see {@link subAccountTransfer} */
+  /**
+   * Transfer between sub-accounts (perpetual).
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.subAccountTransfer({ subAccountUser: "0x...", isDeposit: true, usd: 1 * 1e6 });
+   * ```
+   */
   subAccountTransfer(
     params: SubAccountTransferParameters,
     opts?: SubAccountTransferOptions,
@@ -572,7 +1461,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return subAccountTransfer(this.config_, params, opts);
   }
 
-  /** @see {@link tokenDelegate} */
+  /**
+   * Delegate or undelegate native tokens to or from a validator.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.tokenDelegate({ validator: "0x...", isUndelegate: true, wei: 1 * 1e8 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#delegate-or-undelegate-stake-from-validator
+   */
   tokenDelegate(
     params: TokenDelegateParameters,
     opts?: TokenDelegateOptions,
@@ -580,7 +1494,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return tokenDelegate(this.config_, params, opts);
   }
 
-  /** @see {@link twapCancel} */
+  /**
+   * Cancel a TWAP order.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link TwapCancelResponse} without error status.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.twapCancel({ a: 0, t: 1 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order
+   */
   twapCancel(
     params: TwapCancelParameters,
     opts?: TwapCancelOptions,
@@ -588,7 +1527,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return twapCancel(this.config_, params, opts);
   }
 
-  /** @see {@link twapOrder} */
+  /**
+   * Place a TWAP order.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful variant of {@link TwapOrderResponse} without error status.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * const data = await client.twapOrder({ twap: { a: 0, b: true, s: "1", r: false, m: 10, t: true } });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order
+   */
   twapOrder(
     params: TwapOrderParameters,
     opts?: TwapOrderOptions,
@@ -596,7 +1560,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return twapOrder(this.config_, params, opts);
   }
 
-  /** @see {@link updateIsolatedMargin} */
+  /**
+   * Add or remove margin from isolated position.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.updateIsolatedMargin({ asset: 0, isBuy: true, ntli: 1 * 1e6 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin
+   */
   updateIsolatedMargin(
     params: UpdateIsolatedMarginParameters,
     opts?: UpdateIsolatedMarginOptions,
@@ -604,7 +1593,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return updateIsolatedMargin(this.config_, params, opts);
   }
 
-  /** @see {@link updateLeverage} */
+  /**
+   * Update cross or isolated leverage on a coin.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.updateLeverage({ asset: 0, isCross: true, leverage: 5 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage
+   */
   updateLeverage(
     params: UpdateLeverageParameters,
     opts?: UpdateLeverageOptions,
@@ -612,7 +1626,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return updateLeverage(this.config_, params, opts);
   }
 
-  /** @see {@link usdClassTransfer} */
+  /**
+   * Transfer funds between Spot account and Perp account.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.usdClassTransfer({ amount: "1", toPerp: true });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa
+   */
   usdClassTransfer(
     params: UsdClassTransferParameters,
     opts?: UsdClassTransferOptions,
@@ -620,7 +1659,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return usdClassTransfer(this.config_, params, opts);
   }
 
-  /** @see {@link usdSend} */
+  /**
+   * Send usd to another address.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.usdSend({ destination: "0x...", amount: "1" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-usdc-transfer
+   */
   usdSend(
     params: UsdSendParameters,
     opts?: UsdSendOptions,
@@ -628,7 +1692,34 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return usdSend(this.config_, params, opts);
   }
 
-  /** @see {@link userDexAbstraction} */
+  /**
+   * Enable/disable HIP-3 DEX abstraction.
+   *
+   * @deprecated Use {@link userSetAbstraction} instead.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.userDexAbstraction({ user: "0x...", enabled: true });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#enable-hip-3-dex-abstraction
+   */
   userDexAbstraction(
     params: UserDexAbstractionParameters,
     opts?: UserDexAbstractionOptions,
@@ -636,7 +1727,98 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return userDexAbstraction(this.config_, params, opts);
   }
 
-  /** @see {@link validatorL1Stream} */
+  /**
+   * Set User abstraction mode.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.userSetAbstraction({ user: "0x...", abstraction: "dexAbstraction" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#set-user-abstraction
+   */
+  userSetAbstraction(
+    params: UserSetAbstractionParameters,
+    opts?: UserSetAbstractionOptions,
+  ): Promise<UserSetAbstractionSuccessResponse> {
+    return userSetAbstraction(this.config_, params, opts);
+  }
+
+  /**
+   * Enable/disable user portfolio margin.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.userPortfolioMargin({ user: "0x...", enabled: true });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/portfolio-margin
+   */
+  userPortfolioMargin(
+    params: UserPortfolioMarginParameters,
+    opts?: UserPortfolioMarginOptions,
+  ): Promise<UserPortfolioMarginSuccessResponse> {
+    return userPortfolioMargin(this.config_, params, opts);
+  }
+
+  /**
+   * Validator vote on risk-free rate for aligned quote asset.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.validatorL1Stream({ riskFreeRate: "0.05" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#validator-vote-on-risk-free-rate-for-aligned-quote-asset
+   */
   validatorL1Stream(
     params: ValidatorL1StreamParameters,
     opts?: ValidatorL1StreamOptions,
@@ -644,7 +1826,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return validatorL1Stream(this.config_, params, opts);
   }
 
-  /** @see {@link vaultDistribute} */
+  /**
+   * Distribute funds from a vault between followers.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.vaultDistribute({ vaultAddress: "0x...", usd: 10 * 1e6 });
+   * ```
+   */
   vaultDistribute(
     params: VaultDistributeParameters,
     opts?: VaultDistributeOptions,
@@ -652,7 +1857,30 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return vaultDistribute(this.config_, params, opts);
   }
 
-  /** @see {@link vaultModify} */
+  /**
+   * Modify a vault's configuration.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.vaultModify({ vaultAddress: "0x...", allowDeposits: true, alwaysCloseOnWithdraw: false });
+   * ```
+   */
   vaultModify(
     params: VaultModifyParameters,
     opts?: VaultModifyOptions,
@@ -660,7 +1888,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return vaultModify(this.config_, params, opts);
   }
 
-  /** @see {@link vaultTransfer} */
+  /**
+   * Deposit or withdraw from a vault.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.vaultTransfer({ vaultAddress: "0x...", isDeposit: true, usd: 10 * 1e6 });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault
+   */
   vaultTransfer(
     params: VaultTransferParameters,
     opts?: VaultTransferOptions,
@@ -668,7 +1921,32 @@ export class ExchangeClient<C extends ExchangeConfig = ExchangeSingleWalletConfi
     return vaultTransfer(this.config_, params, opts);
   }
 
-  /** @see {@link withdraw3} */
+  /**
+   * Initiate a withdrawal request.
+   *
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   *
+   * @returns Successful response without specific data.
+   *
+   * @throws {ValiError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   * import { privateKeyToAccount } from "npm:viem/accounts";
+   *
+   * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.ExchangeClient({ transport, wallet });
+   *
+   * await client.withdraw3({ destination: "0x...", amount: "1" });
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
+   */
   withdraw3(
     params: Withdraw3Parameters,
     opts?: Withdraw3Options,
@@ -688,6 +1966,11 @@ export type {
   AgentEnableDexAbstractionOptions,
   AgentEnableDexAbstractionSuccessResponse,
 } from "./_methods/agentEnableDexAbstraction.js";
+export type {
+  AgentSetAbstractionOptions,
+  AgentSetAbstractionParameters,
+  AgentSetAbstractionSuccessResponse,
+} from "./_methods/agentSetAbstraction.js";
 export type {
   ApproveAgentOptions,
   ApproveAgentParameters,
@@ -699,6 +1982,7 @@ export type {
   ApproveBuilderFeeSuccessResponse,
 } from "./_methods/approveBuilderFee.js";
 export type { BatchModifyOptions, BatchModifyParameters, BatchModifySuccessResponse } from "./_methods/batchModify.js";
+export type { BorrowLendOptions, BorrowLendParameters, BorrowLendSuccessResponse } from "./_methods/borrowLend.js";
 export type { CancelOptions, CancelParameters, CancelSuccessResponse } from "./_methods/cancel.js";
 export type {
   CancelByCloidOptions,
@@ -808,9 +2092,22 @@ export type {
 export type { UsdSendOptions, UsdSendParameters, UsdSendSuccessResponse } from "./_methods/usdSend.js";
 export type {
   UserDexAbstractionOptions,
+  UserDexAbstractionOptions as UserDexAbstractionExchangeOptions,
   UserDexAbstractionParameters,
+  UserDexAbstractionParameters as UserDexAbstractionExchangeParameters,
   UserDexAbstractionSuccessResponse,
+  UserDexAbstractionSuccessResponse as UserDexAbstractionExchangeSuccessResponse,
 } from "./_methods/userDexAbstraction.js";
+export type {
+  UserSetAbstractionOptions,
+  UserSetAbstractionParameters,
+  UserSetAbstractionSuccessResponse,
+} from "./_methods/userSetAbstraction.js";
+export type {
+  UserPortfolioMarginOptions,
+  UserPortfolioMarginParameters,
+  UserPortfolioMarginSuccessResponse,
+} from "./_methods/userPortfolioMargin.js";
 export type {
   ValidatorL1StreamOptions,
   ValidatorL1StreamParameters,