@nktkas/hyperliquid 0.30.2 → 0.31.0

package/script/src/api/exchange/client.js

@@ -5,9 +5,11 @@ exports.ApiRequestError = exports.ExchangeClient = void 0;
 // Methods Imports
 // =============================================================
 const agentEnableDexAbstraction_js_1 = require("./_methods/agentEnableDexAbstraction.js");
+const agentSetAbstraction_js_1 = require("./_methods/agentSetAbstraction.js");
 const approveAgent_js_1 = require("./_methods/approveAgent.js");
 const approveBuilderFee_js_1 = require("./_methods/approveBuilderFee.js");
 const batchModify_js_1 = require("./_methods/batchModify.js");
+const borrowLend_js_1 = require("./_methods/borrowLend.js");
 const cancel_js_1 = require("./_methods/cancel.js");
 const cancelByCloid_js_1 = require("./_methods/cancelByCloid.js");
 const cDeposit_js_1 = require("./_methods/cDeposit.js");
@@ -44,6 +46,8 @@ const updateLeverage_js_1 = require("./_methods/updateLeverage.js");
 const usdClassTransfer_js_1 = require("./_methods/usdClassTransfer.js");
 const usdSend_js_1 = require("./_methods/usdSend.js");
 const userDexAbstraction_js_1 = require("./_methods/userDexAbstraction.js");
+const userSetAbstraction_js_1 = require("./_methods/userSetAbstraction.js");
+const userPortfolioMargin_js_1 = require("./_methods/userPortfolioMargin.js");
 const validatorL1Stream_js_1 = require("./_methods/validatorL1Stream.js");
 const vaultDistribute_js_1 = require("./_methods/vaultDistribute.js");
 const vaultModify_js_1 = require("./_methods/vaultModify.js");
@@ -106,91 +110,710 @@ class ExchangeClient {
     constructor(config) {
         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) {
         return (0, agentEnableDexAbstraction_js_1.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, opts) {
+        return (0, agentSetAbstraction_js_1.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, opts) {
         return (0, approveAgent_js_1.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, opts) {
         return (0, approveBuilderFee_js_1.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, opts) {
         return (0, batchModify_js_1.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, opts) {
+        return (0, borrowLend_js_1.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, opts) {
         return (0, cancel_js_1.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, opts) {
         return (0, cancelByCloid_js_1.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, opts) {
         return (0, cDeposit_js_1.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) {
         return (0, claimRewards_js_1.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, opts) {
         return (0, convertToMultiSigUser_js_1.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, opts) {
         return (0, createSubAccount_js_1.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, opts) {
         return (0, createVault_js_1.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, opts) {
         return (0, cSignerAction_js_1.cSignerAction)(this.config_, params, opts);
     }
-    /** @see {@link cValidatorAction} */
+    /**
+     * 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, opts) {
         return (0, cValidatorAction_js_1.cValidatorAction)(this.config_, params, opts);
     }
-    /** @see {@link cWithdraw} */
+    /**
+     * 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, opts) {
         return (0, cWithdraw_js_1.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, opts) {
         return (0, evmUserModify_js_1.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, opts) {
         return (0, linkStakingUser_js_1.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, opts) {
         return (0, modify_js_1.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, opts) {
         return (0, order_js_1.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) {
         return (0, noop_js_1.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, opts) {
         return (0, perpDeploy_js_1.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, opts) {
         return (0, registerReferrer_js_1.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, opts) {
         return (0, reserveRequestWeight_js_1.reserveRequestWeight)(this.config_, params, opts);
     }
@@ -200,91 +823,685 @@ class ExchangeClient {
         const opts = isFirstArgParams ? maybeOpts : paramsOrOpts;
         return (0, scheduleCancel_js_1.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, opts) {
         return (0, sendAsset_js_1.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, opts) {
         return (0, setDisplayName_js_1.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, opts) {
         return (0, setReferrer_js_1.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, opts) {
         return (0, spotDeploy_js_1.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, opts) {
         return (0, spotSend_js_1.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, opts) {
         return (0, spotUser_js_1.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, opts) {
         return (0, subAccountModify_js_1.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, opts) {
         return (0, subAccountSpotTransfer_js_1.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, opts) {
         return (0, subAccountTransfer_js_1.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, opts) {
         return (0, tokenDelegate_js_1.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, opts) {
         return (0, twapCancel_js_1.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, opts) {
         return (0, twapOrder_js_1.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, opts) {
         return (0, updateIsolatedMargin_js_1.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, opts) {
         return (0, updateLeverage_js_1.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, opts) {
         return (0, usdClassTransfer_js_1.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, opts) {
         return (0, usdSend_js_1.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, opts) {
         return (0, userDexAbstraction_js_1.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, opts) {
+        return (0, userSetAbstraction_js_1.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, opts) {
+        return (0, userPortfolioMargin_js_1.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, opts) {
         return (0, validatorL1Stream_js_1.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, opts) {
         return (0, vaultDistribute_js_1.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, opts) {
         return (0, vaultModify_js_1.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, opts) {
         return (0, vaultTransfer_js_1.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, opts) {
         return (0, withdraw3_js_1.withdraw3)(this.config_, params, opts);
     }