@nktkas/hyperliquid 0.20.0 → 0.21.0

package/esm/src/clients/{wallet.js → exchange.js}

@@ -54,11 +54,11 @@ class NonceManager {
     }
 }
 /**
- * Wallet client for interacting with the Hyperliquid API.
+ * Exchange client for interacting with the Hyperliquid API.
  * @typeParam T The transport used to connect to the Hyperliquid API.
  * @typeParam W The WalletClient/Account ([viem](https://viem.sh/docs/clients/wallet)) or Signer ([ethers.js](https://docs.ethers.io/v6/api/providers/#Signer)) used for signing transactions.
  */
-export class WalletClient {
+export class ExchangeClient {
     transport;
     wallet;
     isTestnet;
@@ -78,7 +78,7 @@ export class WalletClient {
      * const wallet = privateKeyToAccount("0x...");
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
      * @example Private key via [ethers.js](https://docs.ethers.org/v6/api/wallet/#Wallet) or [ethers.js v5](https://docs.ethers.org/v5/api/signer/#Wallet)
@@ -89,7 +89,7 @@ export class WalletClient {
      * const wallet = new ethers.Wallet("0x...");
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
      * @example External wallet (e.g. MetaMask) via [viem](https://viem.sh/docs/clients/wallet#optional-hoist-the-account)
@@ -101,7 +101,7 @@ export class WalletClient {
      * const wallet = createWalletClient({ account, transport: custom(window.ethereum) });
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      * ```
      *
      * @example External wallet (e.g. MetaMask) via `window.ethereum` directly
@@ -109,7 +109,7 @@ export class WalletClient {
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet: window.ethereum, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet: window.ethereum, transport });
      * ```
      */
     constructor(args) {
@@ -136,7 +136,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.approveAgent({ agentAddress: "0x...", agentName: "agentName" });
      * ```
@@ -185,7 +185,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.approveBuilderFee({ maxFeeRate: "0.01%", builder: "0x..." });
      * ```
@@ -231,7 +231,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.batchModify({
      *   modifies: [{
@@ -317,7 +317,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.cancel({
      *   cancels: [{
@@ -366,7 +366,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.cancelByCloid({
      *   cancels: [
@@ -414,7 +414,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.cDeposit({ wei: 1 * 1e8 });
      * ```
@@ -459,7 +459,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.claimRewards();
      * ```
@@ -493,7 +493,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.convertToMultiSigUser({
      *   authorizedUsers: ["0x...", "0x..."],
@@ -541,7 +541,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.createSubAccount({ name: "subAccountName" });
      * ```
@@ -578,7 +578,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.createVault({
      *   name: "VaultName",
@@ -696,7 +696,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.cWithdraw({ wei: 1 * 1e8 });
      * ```
@@ -741,7 +741,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.evmUserModify({ usingBigBlocks: true });
      * ```
@@ -778,7 +778,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.modify({
      *   oid: 123,
@@ -857,7 +857,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const multiSigUser = "0x..."; // Multi-sig user address
      *
@@ -932,7 +932,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.order({
      *   orders: [{
@@ -1070,7 +1070,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.perpDexClassTransfer({
      *   dex: "test",
@@ -1123,7 +1123,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.registerReferrer({ code: "TEST" });
      * ```
@@ -1160,7 +1160,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.reserveRequestWeight({ weight: 10 });
      * ```
@@ -1225,7 +1225,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.setDisplayName({ displayName: "My Name" });
      * ```
@@ -1262,7 +1262,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.setReferrer({ code: "TEST" });
      * ```
@@ -1389,7 +1389,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.spotSend({
      *   destination: "0x...",
@@ -1440,7 +1440,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.spotUser({ toggleSpotDusting: { optOut: false } });
      * ```
@@ -1479,7 +1479,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.subAccountSpotTransfer({
      *   subAccountUser: "0x...",
@@ -1524,7 +1524,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.subAccountTransfer({
      *   subAccountUser: "0x...",
@@ -1567,7 +1567,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.tokenDelegate({
      *   validator: "0x...",
@@ -1618,7 +1618,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.twapCancel({
      *   a: 0, // Asset index
@@ -1663,7 +1663,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.twapOrder({
      *   a: 0, // Asset index
@@ -1718,7 +1718,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.updateIsolatedMargin({ asset: 0, isBuy: true, ntli: 1 * 1e6 });
      * ```
@@ -1761,7 +1761,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.updateLeverage({ asset: 0, isCross: true, leverage: 5 });
      * ```
@@ -1804,7 +1804,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.usdClassTransfer({ amount: "1", toPerp: true });
      * ```
@@ -1850,7 +1850,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.usdSend({ destination: "0x...", amount: "1" });
      * ```
@@ -1896,7 +1896,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.vaultDistribute({ vaultAddress: "0x...", usd: 10 * 1e6 });
      * ```
@@ -1934,7 +1934,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.vaultModify({
      *   vaultAddress: "0x...",
@@ -1977,7 +1977,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.vaultTransfer({
      *   vaultAddress: "0x...",
@@ -2023,7 +2023,7 @@ export class WalletClient {
      *
      * const wallet = privateKeyToAccount("0x...");
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const client = new hl.WalletClient({ wallet, transport });
+     * const exchClient = new hl.ExchangeClient({ wallet, transport });
      *
      * const result = await client.withdraw3({ destination: "0x...", amount: "1" });
      * ```