@nktkas/hyperliquid 0.22.1 → 0.22.2

package/esm/src/clients/exchange.js

@@ -1,5 +1,5 @@
 import { HyperliquidError } from "../base.js";
-import { actionSorter, isAbstractEthersSigner, isAbstractEthersV5Signer, isAbstractViemWalletClient, isAbstractWindowEthereum, signL1Action, signMultiSigAction, signUserSignedAction, userSignedActionEip712Types, } from "../signing.js";
+import { actionSorter, isAbstractEthersSigner, isAbstractEthersV5Signer, isAbstractViemWalletClient, isAbstractWindowEthereum, signL1Action, signMultiSigAction, signUserSignedAction, userSignedActionEip712Types, } from "../signing/mod.js";
 /** Error thrown when the API returns an error response. */
 export class ApiRequestError extends HyperliquidError {
     response;
@@ -70,6 +70,16 @@ export class ExchangeClient {
      * Initialises a new instance.
      * @param args - The parameters for the client.
      *
+     * @example Private key
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const privateKey = "0x...";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
+     * ```
+     *
      * @example Private key via [viem](https://viem.sh/docs/clients/wallet#local-accounts-private-key-mnemonic-etc)
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -77,7 +87,7 @@ export class ExchangeClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
@@ -88,7 +98,7 @@ export class ExchangeClient {
      *
      * const wallet = new ethers.Wallet("0x...");
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
@@ -100,7 +110,7 @@ export class ExchangeClient {
      * const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
      * const wallet = createWalletClient({ account, transport: custom(window.ethereum) });
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
@@ -108,7 +118,7 @@ export class ExchangeClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const exchClient = new hl.ExchangeClient({ wallet: window.ethereum, transport });
      * ```
      */
@@ -132,11 +142,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.approveAgent({ agentAddress: "0x...", agentName: "agentName" });
      * ```
@@ -177,11 +186,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.approveBuilderFee({ maxFeeRate: "0.01%", builder: "0x..." });
      * ```
@@ -219,11 +227,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.batchModify({
      *   modifies: [{
@@ -277,11 +284,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.cancel({
      *   cancels: [{
@@ -323,11 +329,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.cancelByCloid({
      *   cancels: [
@@ -368,11 +373,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.cDeposit({ wei: 1 * 1e8 });
      * ```
@@ -410,11 +414,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.claimRewards();
      * ```
@@ -446,11 +449,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.convertToMultiSigUser({ // convert to multi-sig user
      *   authorizedUsers: ["0x...", "0x...", "0x..."],
@@ -460,7 +462,7 @@ export class ExchangeClient {
      */
     async convertToMultiSigUser(args, signal) {
         // Destructure the parameters
-        const { ...actionArgs } = args;
+        const actionArgs = args;
         // Construct an action
         const nonce = await this.nonceManager();
         const action = {
@@ -491,11 +493,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.createSubAccount({ name: "subAccountName" });
      * ```
@@ -530,11 +531,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.createVault({
      *   name: "VaultName",
@@ -614,11 +614,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.cWithdraw({ wei: 1 * 1e8 });
      * ```
@@ -656,11 +655,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.evmUserModify({ usingBigBlocks: true });
      * ```
@@ -695,11 +693,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.modify({
      *   oid: 123,
@@ -751,11 +748,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const multiSigUser = "0x..."; // Multi-sig user address
      *
@@ -815,11 +811,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.order({
      *   orders: [{
@@ -890,11 +885,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.perpDexClassTransfer({
      *   dex: "test",
@@ -937,11 +931,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.registerReferrer({ code: "TEST" });
      * ```
@@ -976,11 +969,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.reserveRequestWeight({ weight: 10 });
      * ```
@@ -1039,11 +1031,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.setDisplayName({ displayName: "My Name" });
      * ```
@@ -1078,11 +1069,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.setReferrer({ code: "TEST" });
      * ```
@@ -1136,11 +1126,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.spotSend({
      *   destination: "0x...",
@@ -1182,11 +1171,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.spotUser({ toggleSpotDusting: { optOut: false } });
      * ```
@@ -1221,11 +1209,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.subAccountSpotTransfer({
      *   subAccountUser: "0x...",
@@ -1265,11 +1252,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.subAccountTransfer({
      *   subAccountUser: "0x...",
@@ -1308,11 +1294,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.tokenDelegate({
      *   validator: "0x...",
@@ -1354,11 +1339,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.twapCancel({
      *   a: 0, // Asset index
@@ -1398,11 +1382,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.twapOrder({
      *   a: 0, // Asset index
@@ -1448,11 +1431,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.updateIsolatedMargin({
      *   asset: 0,
@@ -1493,11 +1475,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.updateLeverage({
      *   asset: 0,
@@ -1538,11 +1519,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.usdClassTransfer({ amount: "1", toPerp: true });
      * ```
@@ -1580,11 +1560,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.usdSend({ destination: "0x...", amount: "1" });
      * ```
@@ -1622,11 +1601,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.vaultDistribute({ vaultAddress: "0x...", usd: 10 * 1e6 });
      * ```
@@ -1661,11 +1639,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.vaultModify({
      *   vaultAddress: "0x...",
@@ -1704,11 +1681,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.vaultTransfer({
      *   vaultAddress: "0x...",
@@ -1748,11 +1724,10 @@ export class ExchangeClient {
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
-     * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x...");
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const exchClient = new hl.ExchangeClient({ wallet, transport });
+     * const privateKey = "0x..."; // or `viem`, `ethers`
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
      *
      * const data = await exchClient.withdraw3({ destination: "0x...", amount: "1" });
      * ```