@nktkas/hyperliquid 0.25.9 → 0.27.0

package/README.md

@@ -1,11 +1,12 @@
 # Hyperliquid API TypeScript SDK
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![npm](https://img.shields.io/npm/v/@nktkas/hyperliquid?style=flat-square&color=blue)](https://www.npmjs.com/package/@nktkas/hyperliquid)
-[![Downloads](https://img.shields.io/npm/dm/@nktkas/hyperliquid.svg?style=flat-square)](https://www.npmjs.com/package/@nktkas/hyperliquid)
-[![jsr](https://jsr.io/badges/@nktkas/hyperliquid?style=flat-square)](https://jsr.io/@nktkas/hyperliquid)
-[![coveralls](https://img.shields.io/coverallsCoverage/github/nktkas/hyperliquid?style=flat-square)](https://coveralls.io/github/nktkas/hyperliquid)
-[![bundlephobia](https://img.shields.io/bundlephobia/minzip/@nktkas/hyperliquid?style=flat-square)](https://bundlephobia.com/package/@nktkas/hyperliquid)
+[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+[![npm](https://img.shields.io/npm/v/@nktkas/hyperliquid?color=blue)](https://www.npmjs.com/package/@nktkas/hyperliquid)
+[![jsr](https://jsr.io/badges/@nktkas/hyperliquid)](https://jsr.io/@nktkas/hyperliquid)
+[![Downloads](https://img.shields.io/npm/dm/@nktkas/hyperliquid.svg)](https://www.npmjs.com/package/@nktkas/hyperliquid)
+[![coveralls](https://img.shields.io/coverallsCoverage/github/nktkas/hyperliquid)](https://coveralls.io/github/nktkas/hyperliquid)
+[![bundlejs](https://img.shields.io/bundlejs/size/@nktkas/hyperliquid)](https://bundlejs.com/?q=@nktkas/hyperliquid)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nktkas/hyperliquid)
 
 Unofficial [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api) SDK for all major JS
 runtimes, written in TypeScript.
@@ -24,10 +25,7 @@ runtimes, written in TypeScript.
 
 ## Installation
 
-> [!NOTE]
-> While this library is in TypeScript, it can also be used in JavaScript and supports ESM/CommonJS.
-
-### Node.js v20+ (choose your package manager)
+### Node.js 20+ (choose your package manager)
 
 ```
 npm i @nktkas/hyperliquid
@@ -37,9 +35,11 @@ pnpm add @nktkas/hyperliquid
 yarn add @nktkas/hyperliquid
 ```
 
-If you are using a version of **Node.js lower than v22** and intend to use [`WebSocketTransport`](#websocket-transport),
-you need to install the [`ws`](https://www.npmjs.com/package/ws) package and pass the `WebSocket` class to the
-constructor:
+<details>
+<summary>Note for Node.js versions below 22</summary>
+
+Node.js 22+ includes native `WebSocket`. For earlier versions using [`WebSocketTransport`](#websocket-transport),
+install [`ws`](https://www.npmjs.com/package/ws) package and pass the class:
 
 ```ts
 import WebSocket from "ws"; // install `ws` package
@@ -52,7 +52,9 @@ const transport = new hl.WebSocketTransport({
 });
 ```
 
-### Deno v2.0+
+</details>
+
+### Deno 2.0+
 
 ```
 deno add jsr:@nktkas/hyperliquid
@@ -68,13 +70,13 @@ The SDK is fully browser-compatible; integrate it via CDN or bundle it with your
 </script>
 ```
 
-### React Native v0.74.5 / Expo v51
+### React Native
 
 For React Native, you need to import polyfills before importing the SDK:
 
 ```ts
-import "fast-text-encoding"; // `TextEncoder` (utf-8)
-import "event-target-polyfill"; // `EventTarget`, `Event`
+import "fast-text-encoding"; // TextEncoder (utf-8)
+import "event-target-polyfill"; // EventTarget, Event
 import * as hl from "@nktkas/hyperliquid";
 ```
 
@@ -389,6 +391,7 @@ A client is an interface through which you can interact with the Hyperliquid API
 ```ts
 class InfoClient {
   constructor(args: {
+    /** The transport used to connect to the Hyperliquid API. */
     transport: HttpTransport | WebSocketTransport;
   });
 
@@ -483,84 +486,108 @@ class InfoClient {
 ```ts
 class ExchangeClient {
   constructor(args: {
+    /** The transport used to connect to the Hyperliquid Exchange API. */
     transport: HttpTransport | WebSocketTransport;
-    wallet: AbstractWallet | Hex; // viem, ethers or private key directly
+
+    /** The wallet used to sign requests (viem, ethers or private key directly). */
+    wallet: AbstractWallet | Hex;
+
+    /**
+     * The network that will be used to sign transactions.
+     * Must match the network of the {@link wallet}.
+     *
+     * Defaults to get chain id from wallet otherwise `0x1`.
+     */
+    signatureChainId?: Hex | (() => MaybePromise<Hex>);
+
+    /**
+     * Sets a default vaultAddress to be used if no vaultAddress is explicitly passed to a method.
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults
+     */
     defaultVaultAddress?: Hex; // Vault address used by default if not provided in method call
-    signatureChainId?: Hex | (() => MaybePromise<Hex>); // Chain ID used for signing (default: get chain id from wallet otherwise `0x1`)
+
+    /**
+     * Sets a default expiresAfter to be used if no expiresAfter is explicitly passed to a method.
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#expires-after
+     */
+    defaultExpiresAfter?: number | (() => MaybePromise<number>);
+
+    /**
+     * A fixed nonce or a function that returns a nonce to be used for signing requests.
+     *
+     * Defaults to a global nonce manager that uses the current timestamp in milliseconds,
+     * and increments if the timestamp is not greater than the last nonce.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#hyperliquid-nonces
+     */
+    nonceManager?: number | ((address: string) => MaybePromise<number>);
   });
 
   // Order & TWAP & Position
-  batchModify(params: BatchModifyParameters): Promise<OrderResponseSuccess>;
-  cancel(params: CancelParameters): Promise<CancelResponseSuccess>;
-  cancelByCloid(params: CancelByCloidParameters): Promise<CancelResponseSuccess>;
-  modify(params: ModifyParameters): Promise<SuccessResponse>;
-  order(params: OrderParameters): Promise<OrderResponseSuccess>;
-  scheduleCancel(params?: ScheduleCancelParameters): Promise<SuccessResponse>;
-  twapCancel(params: TwapCancelParameters): Promise<TwapCancelResponseSuccess>;
-  twapOrder(params: TwapOrderParameters): Promise<TwapOrderResponseSuccess>;
-  updateIsolatedMargin(params: UpdateIsolatedMarginParameters): Promise<SuccessResponse>;
-  updateLeverage(params: UpdateLeverageParameters): Promise<SuccessResponse>;
+  batchModify(params: BatchModifyParameters): Promise<BatchModifySuccessResponse>;
+  cancel(params: CancelParameters): Promise<CancelSuccessResponse>;
+  cancelByCloid(params: CancelByCloidParameters): Promise<CancelByCloidSuccessResponse>;
+  modify(params: ModifyParameters): Promise<ModifySuccessResponse>;
+  order(params: OrderParameters): Promise<OrderSuccessResponse>;
+  scheduleCancel(params?: ScheduleCancelParameters): Promise<ScheduleCancelSuccessResponse>;
+  twapCancel(params: TwapCancelParameters): Promise<TwapCancelSuccessResponse>;
+  twapOrder(params: TwapOrderParameters): Promise<TwapOrderSuccessResponse>;
+  updateIsolatedMargin(params: UpdateIsolatedMarginParameters): Promise<UpdateIsolatedMarginSuccessResponse>;
+  updateLeverage(params: UpdateLeverageParameters): Promise<UpdateLeverageSuccessResponse>;
 
   // Account
-  agentEnableDexAbstraction(): Promise<SuccessResponse>;
-  approveAgent(params: ApproveAgentParameters): Promise<SuccessResponse>;
-  approveBuilderFee(params: ApproveBuilderFeeParameters): Promise<SuccessResponse>;
-  evmUserModify(params: EvmUserModifyParameters): Promise<SuccessResponse>;
-  noop(): Promise<SuccessResponse>;
-  reserveRequestWeight(params: ReserveRequestWeightParameters): Promise<SuccessResponse>;
-  setDisplayName(params: SetDisplayNameParameters): Promise<SuccessResponse>;
-  spotUser(params: SpotUserParameters): Promise<SuccessResponse>;
-  userDexAbstraction(params: UserDexAbstractionExchangeParameters): Promise<UserDexAbstractionExchangeResponse>;
+  agentEnableDexAbstraction(): Promise<AgentEnableDexAbstractionSuccessResponse>;
+  approveAgent(params: ApproveAgentParameters): Promise<ApproveAgentSuccessResponse>;
+  approveBuilderFee(params: ApproveBuilderFeeParameters): Promise<ApproveBuilderFeeSuccessResponse>;
+  evmUserModify(params: EvmUserModifyParameters): Promise<EvmUserModifySuccessResponse>;
+  noop(): Promise<NoopSuccessResponse>;
+  reserveRequestWeight(params: ReserveRequestWeightParameters): Promise<ReserveRequestWeightSuccessResponse>;
+  setDisplayName(params: SetDisplayNameParameters): Promise<SetDisplayNameSuccessResponse>;
+  spotUser(params: SpotUserParameters): Promise<SpotUserSuccessResponse>;
+  userDexAbstraction(params: UserDexAbstractionExchangeParameters): Promise<UserDexAbstractionSuccessResponse>;
 
   // Fund Transfers
-  sendAsset(params: SendAssetParameters): Promise<SuccessResponse>;
-  spotSend(params: SpotSendParameters): Promise<SuccessResponse>;
-  usdClassTransfer(params: UsdClassTransferParameters): Promise<SuccessResponse>;
-  usdSend(params: UsdSendParameters): Promise<SuccessResponse>;
-  withdraw3(params: Withdraw3Parameters): Promise<SuccessResponse>;
+  sendAsset(params: SendAssetParameters): Promise<SendAssetSuccessResponse>;
+  spotSend(params: SpotSendParameters): Promise<SpotSendSuccessResponse>;
+  usdClassTransfer(params: UsdClassTransferParameters): Promise<UsdClassTransferSuccessResponse>;
+  usdSend(params: UsdSendParameters): Promise<UsdSendSuccessResponse>;
+  withdraw3(params: Withdraw3Parameters): Promise<Withdraw3SuccessResponse>;
 
   // Sub-Account
-  createSubAccount(params: CreateSubAccountParameters): Promise<CreateSubAccountResponse>;
-  subAccountModify(params: SubAccountModifyParameters): Promise<SuccessResponse>;
-  subAccountSpotTransfer(params: SubAccountSpotTransferParameters): Promise<SuccessResponse>;
-  subAccountTransfer(params: SubAccountTransferParameters): Promise<SuccessResponse>;
+  createSubAccount(params: CreateSubAccountParameters): Promise<CreateSubAccountSuccessResponse>;
+  subAccountModify(params: SubAccountModifyParameters): Promise<SubAccountModifySuccessResponse>;
+  subAccountSpotTransfer(params: SubAccountSpotTransferParameters): Promise<SubAccountSpotTransferSuccessResponse>;
+  subAccountTransfer(params: SubAccountTransferParameters): Promise<SubAccountTransferSuccessResponse>;
 
   // Referrer
-  claimRewards(): Promise<SuccessResponse>;
-  registerReferrer(params: RegisterReferrerParameters): Promise<SuccessResponse>;
-  setReferrer(params: SetReferrerParameters): Promise<SuccessResponse>;
+  claimRewards(): Promise<ClaimRewardsSuccessResponse>;
+  registerReferrer(params: RegisterReferrerParameters): Promise<RegisterReferrerSuccessResponse>;
+  setReferrer(params: SetReferrerParameters): Promise<SetReferrerSuccessResponse>;
 
   // Staking & Delegation
-  cDeposit(params: CDepositParameters): Promise<SuccessResponse>;
-  cWithdraw(params: CWithdrawParameters): Promise<SuccessResponse>;
-  linkStakingUser(params: LinkStakingUserParameters): Promise<SuccessResponse>;
-  tokenDelegate(params: TokenDelegateParameters): Promise<SuccessResponse>;
+  cDeposit(params: CDepositParameters): Promise<CDepositSuccessResponse>;
+  cWithdraw(params: CWithdrawParameters): Promise<CWithdrawSuccessResponse>;
+  linkStakingUser(params: LinkStakingUserParameters): Promise<LinkStakingUserSuccessResponse>;
+  tokenDelegate(params: TokenDelegateParameters): Promise<TokenDelegateSuccessResponse>;
 
   // Vault
-  createVault(params: CreateVaultParameters): Promise<CreateVaultResponse>;
-  vaultDistribute(params: VaultDistributeParameters): Promise<SuccessResponse>;
-  vaultModify(params: VaultModifyParameters): Promise<SuccessResponse>;
-  vaultTransfer(params: VaultTransferParameters): Promise<SuccessResponse>;
+  createVault(params: CreateVaultParameters): Promise<CreateVaultSuccessResponse>;
+  vaultDistribute(params: VaultDistributeParameters): Promise<VaultDistributeSuccessResponse>;
+  vaultModify(params: VaultModifyParameters): Promise<VaultModifySuccessResponse>;
+  vaultTransfer(params: VaultTransferParameters): Promise<VaultTransferSuccessResponse>;
 
   // Multi-Sign
-  convertToMultiSigUser(params: ConvertToMultiSigUserParameters): Promise<SuccessResponse>;
-  multiSig(params: MultiSigParameters): Promise<
-    | SuccessResponse
-    | CancelSuccessResponse
-    | CreateSubAccountResponse
-    | CreateVaultResponse
-    | OrderSuccessResponse
-    | TwapOrderSuccessResponse
-    | TwapCancelSuccessResponse
-  >;
+  convertToMultiSigUser(params: ConvertToMultiSigUserParameters): Promise<ConvertToMultiSigUserSuccessResponse>;
+  multiSig(params: MultiSigParameters): Promise<MultiSigSuccessResponse>;
 
   // Deploy Market
-  perpDeploy(params: PerpDeployParameters): Promise<SuccessResponse>;
-  spotDeploy(params: SpotDeployParameters): Promise<SuccessResponse>;
+  perpDeploy(params: PerpDeployParameters): Promise<PerpDeploySuccessResponse>;
+  spotDeploy(params: SpotDeployParameters): Promise<SpotDeploySuccessResponse>;
 
   // Validator Actions
-  cSignerAction(params: CSignerActionParameters): Promise<SuccessResponse>;
-  cValidatorAction(params: CValidatorActionParameters): Promise<SuccessResponse>;
+  cSignerAction(params: CSignerActionParameters): Promise<CSignerActionSuccessResponse>;
+  cValidatorAction(params: CValidatorActionParameters): Promise<CValidatorActionSuccessResponse>;
+  validatorL1Stream(params: ValidatorL1StreamParameters): Promise<ValidatorL1StreamSuccessResponse>;
 }
 ```
 
@@ -569,6 +596,7 @@ class ExchangeClient {
 ```ts
 class SubscriptionClient {
   constructor(args: {
+    /** The transport used to connect to the Hyperliquid API. */
     transport: WebSocketTransport;
   });
 
@@ -580,6 +608,7 @@ class SubscriptionClient {
   bbo(params: WsBboParameters, listener: (data: WsBboEvent) => void);
   candle(params: WsCandleParameters, listener: (data: WsCandleEvent) => void);
   l2Book(params: WsL2BookParameters, listener: (data: WsL2BookEvent) => void);
+  spotAssetCtxs(listener: (data: WsSpotAssetCtxsEvent) => void);
   trades(params: WsTradesParameters, listener: (data: WsTradesEvent) => void);
 
   // Account
@@ -725,17 +754,19 @@ class WebSocketTransport {
 All SDK errors extend from `HyperliquidError` base class for unified error handling:
 
 ```ts
-import { ApiRequestError, HyperliquidError, SchemaError, TransportError } from "@nktkas/hyperliquid";
+import { AbstractWalletError, ApiRequestError, HyperliquidError, SchemaError, TransportError } from "@nktkas/hyperliquid";
 
 try {
     await exchClient.order({ ... });
 } catch (error) {
     if (error instanceof SchemaError) {
-        // Invalid data format (before sending request)
+        // Invalid input data format
     } else if (error instanceof ApiRequestError) {
-        // API returned error (e.g., insufficient funds)
+        // Exchange API returned error (e.g., insufficient funds)
     } else if (error instanceof TransportError) {
-        // Network/connection failure (e.g., timeout)
+        // Network-related error (e.g., timeout)
+    } else if (error instanceof AbstractWalletError) {
+        // Wallet-related error (e.g., failed to get address)
     } else if (error instanceof HyperliquidError) {
         // Some other Hyperliquid SDK error
     }

package/bin/cli.ts

@@ -0,0 +1,319 @@
+#!/usr/bin/env node
+import process from "node:process";
+import * as v from "valibot";
+import * as hl from "../src/mod.ts";
+import { type Args, parseArgs, transformArgs } from "./_utils.ts";
+
+function transformParams(method: string, params: Args) {
+  switch (method) {
+    case "spotUser": {
+      return { toggleSpotDusting: { ...params } };
+    }
+    case "twapOrder": {
+      return { twap: { ...params } };
+    }
+    default: {
+      return params;
+    }
+  }
+}
+
+class EchoTransport implements hl.IRequestTransport {
+  isTestnet: boolean;
+  constructor(isTestnet: boolean) {
+    this.isTestnet = isTestnet;
+  }
+  request<T>(_: "info" | "exchange" | "explorer", payload: unknown): Promise<T> {
+    return new Promise((resolve) => resolve({ status: "ok", response: payload } as T));
+  }
+}
+async function executeEndpointMethod(
+  endpoint: string,
+  method: string,
+  args: Args,
+): Promise<unknown> {
+  const isTestnet = "testnet" in args;
+  const timeout = Number(args.timeout) || undefined;
+  const isOffline = "offline" in args;
+
+  const transport = isOffline ? new EchoTransport(isTestnet) : new hl.HttpTransport({ isTestnet, timeout });
+  let client: hl.InfoClient | hl.ExchangeClient;
+
+  if (endpoint === "info") {
+    client = new hl.InfoClient({ transport });
+
+    if (!(method in client)) {
+      throw new Error(`CLI does not support the "${method}" method in the "${endpoint}" endpoint`);
+    }
+  } else if (endpoint === "exchange") {
+    const pk = v.parse(
+      v.pipe(v.string(), v.hexadecimal()),
+      args["private-key"],
+      { message: 'Invalid format "private-key": Expected 32-byte hexadecimal string' },
+    );
+    delete args["private-key"]; // just in case
+
+    const defaultVaultAddress = v.parse(
+      v.optional(v.pipe(v.string(), v.hexadecimal())),
+      args.vault,
+      { message: 'Invalid format "vault": Expected 20-byte hexadecimal string OR nothing' },
+    );
+
+    client = new hl.ExchangeClient({ transport, wallet: pk, defaultVaultAddress });
+
+    if (!(method in client)) {
+      throw new Error(`CLI does not support the "${method}" method in the "${endpoint}" endpoint`);
+    }
+  } else {
+    throw new Error(`Invalid endpoint "${endpoint}". Use "info" or "exchange"`);
+  }
+
+  if (isOffline) {
+    // @ts-ignore - dynamic method access
+    const response = await client[method](transformParams(method, args));
+    return response.response;
+  } else {
+    // @ts-ignore - dynamic method access
+    return await client[method](transformParams(method, args));
+  }
+}
+
+// ──────────────────── Main ────────────────────
+
+function printHelp() {
+  console.log(`Hyperliquid CLI
+
+Usage:
+  npx @nktkas/hyperliquid <endpoint> <method> [options]
+
+Endpoints:
+  info      - Query blockchain and market information
+  exchange  - Execute trading operations (requires --private-key)
+
+Common Options:
+  --testnet               Use testnet instead of mainnet
+  --timeout <number>      Request timeout in milliseconds (default: 10000)
+  --help, -h              Show this help message
+  --offline               Generate transactions offline without broadcasting
+
+Exchange Options:
+  --private-key <key>     Private key for exchange operations (required)
+  --vault <address>       Vault address for operations
+
+=============================================================================
+INFO ENDPOINT METHODS
+=============================================================================
+
+Market Data:
+  alignedQuoteTokenInfo   --token <number>
+  allMids                 [--dex <string>]
+  allPerpMetas            (no params)
+  candleSnapshot          --coin <string> --interval <1m|3m|5m|15m|30m|1h|2h|4h|8h|12h|1d|3d|1w|1M>
+                          --startTime <number> [--endTime <number>]
+  fundingHistory          --coin <string> --startTime <number> [--endTime <number>]
+  l2Book                  --coin <string> [--nSigFigs <2|3|4|5>] [--mantissa <2|5>]
+  liquidatable            (no params)
+  marginTable             --id <number>
+  maxMarketOrderNtls      (no params)
+  meta                    [--dex <string>]
+  metaAndAssetCtxs        [--dex <string>]
+  perpDexLimits           --dex <string>
+  perpDexs                (no params)
+  perpsAtOpenInterestCap  [--dex <string>]
+  predictedFundings       (no params)
+  recentTrades            --coin <string>
+  spotMeta                (no params)
+  spotMetaAndAssetCtxs    (no params)
+
+User Account:
+  activeAssetData         --user <address> --coin <string>
+  clearinghouseState      --user <address> [--dex <string>]
+  extraAgents             --user <address>
+  isVip                   --user <address>
+  legalCheck              --user <address>
+  maxBuilderFee           --user <address> --builder <address>
+  portfolio               --user <address>
+  preTransferCheck        --user <address> --source <address>
+  referral                --user <address>
+  spotClearinghouseState  --user <address> [--dex <string>]
+  subAccounts             --user <address>
+  subAccounts2            --user <address>
+  userDexAbstraction      --user <address>
+  userFees                --user <address>
+  userFunding             --user <address> --startTime <number> [--endTime <number>]
+  userNonFundingLedgerUpdates  --user <address> --startTime <number> [--endTime <number>]
+  userRateLimit           --user <address>
+  userRole                --user <address>
+  userToMultiSigSigners   --user <address>
+  webData2                --user <address>
+
+Orders & TWAP & Position:
+  frontendOpenOrders      --user <address> [--dex <string>]
+  historicalOrders        --user <address>
+  openOrders              --user <address> [--dex <string>]
+  orderStatus             --user <address> --oid <number|hex>
+  twapHistory             --user <address>
+  userFills               --user <address> [--aggregateByTime <bool>]
+  userFillsByTime         --user <address> --startTime <number>
+                          [--endTime <number>] [--aggregateByTime <bool>]
+  userTwapSliceFills           --user <address>
+  userTwapSliceFillsByTime     --user <address> --startTime <number>
+                               [--endTime <number>] [--aggregateByTime <bool>]
+
+Delegation & Validators:
+  delegations             --user <address>
+  delegatorHistory        --user <address>
+  delegatorRewards        --user <address>
+  delegatorSummary        --user <address>
+  gossipRootIps           (no params)
+  validatorL1Votes        (no params)
+  validatorSummaries      (no params)
+
+Vault:
+  leadingVaults           --user <address>
+  userVaultEquities       --user <address>
+  vaultDetails            --vaultAddress <address> [--user <address>]
+  vaultSummaries          (no params)
+
+Deploy Market:
+  perpDeployAuctionStatus      (no params)
+  spotDeployState              --user <address>
+  spotPairDeployAuctionStatus  (no params)
+
+Other:
+  exchangeStatus          (no params)
+
+Transaction & Block Details:
+  blockDetails            --height <number>
+  tokenDetails            --tokenId <hex>
+  txDetails               --hash <hex>
+  userDetails             --user <address>
+
+=============================================================================
+EXCHANGE ENDPOINT METHODS
+=============================================================================
+
+Order & TWAP & Position:
+  batchModify             --modifies <json>
+  cancel                  --cancels <json>
+  cancelByCloid           --cancels <json>
+  modify                  --oid <number|hex> --order <json>
+  order                   --orders <json> [--grouping <na|normalTpsl|positionTpsl>] [--builder <json>]
+  scheduleCancel          [--time <number>]
+  twapCancel              --a <number> --t <number>
+  twapOrder               --a <number> --b <bool> --s <number> --r <bool> --m <number> --t <bool>
+  updateIsolatedMargin    --asset <number> --isBuy <bool> --ntli <number>
+  updateLeverage          --asset <number> --isCross <bool> --leverage <number>
+
+Account:
+  agentEnableDexAbstraction  (no params)
+  approveAgent            --agentAddress <address> [--agentName <string>]
+  approveBuilderFee       --maxFeeRate <number> --builder <address>
+  evmUserModify           --usingBigBlocks <bool>
+  noop                    (no params)
+  reserveRequestWeight    --weight <number>
+  setDisplayName          --displayName <string>
+  spotUser                --optOut <bool>
+  userDexAbstraction      --user <address> --enabled <bool>
+
+Fund Transfers:
+  sendAsset               --destination <address> --token <name:address> --amount <number>
+                          --sourceDex <string> --destinationDex <string> [--fromSubAccount <address>]
+  spotSend                --destination <address> --token <name:address> --amount <number>
+  usdClassTransfer        --amount <number> --toPerp <bool>
+  usdSend                 --destination <address> --amount <number>
+  withdraw3               --destination <address> --amount <number>
+
+Sub-Account:
+  createSubAccount        --name <string>
+  subAccountModify        --subAccountUser <address> --name <string>
+  subAccountSpotTransfer  --subAccountUser <address> --isDeposit <bool>
+                          --token <name:address> --amount <number>
+  subAccountTransfer      --subAccountUser <address> --isDeposit <bool> --usd <number>
+
+Referrer:
+  claimRewards            (no params)
+  registerReferrer        --code <string>
+  setReferrer             --code <string>
+
+Staking & Delegation:
+  cDeposit                --wei <number>
+  cWithdraw               --wei <number>
+  linkStakingUser         --user <address> --isFinalize <bool>
+  tokenDelegate           --validator <address> --wei <number> --isUndelegate <bool>
+
+Vault:
+  createVault             --name <string> --description <string> --initialUsd <number>
+  vaultDistribute         --vaultAddress <address> --usd <number>
+  vaultModify             --vaultAddress <address> [--allowDeposits <bool>]
+                          [--alwaysCloseOnWithdraw <bool>]
+  vaultTransfer           --vaultAddress <address> --isDeposit <bool> --usd <number>
+
+Deploy Market:
+  perpDeploy              --registerAsset <json> | --setOracle <json> | --setFundingMultipliers <json> |
+                          --haltTrading <json> | --setMarginTableIds <json> | --setFeeRecipient <json> |
+                          --setOpenInterestCaps <json> | --setSubDeployers <json> | --setFeeScale <json>
+  spotDeploy              --genesis <json> | --registerHyperliquidity <json> | --registerSpot <json> |
+                          --registerToken2 <json> | --setDeployerTradingFeeShare <json> | --userGenesis <json> |
+                          --enableQuoteToken <json>
+
+Validator Actions:
+  cSignerAction           --jailSelf null | --unjailSelf null
+  cValidatorAction        --changeProfile <json> | --register <json> | --unregister null
+  validatorL1Stream       --riskFreeRate <number>
+
+Other:
+  convertToMultiSigUser   --authorizedUsers <json> --threshold <number>
+
+=============================================================================
+
+Examples:
+  # Get all mid prices
+  npx @nktkas/hyperliquid info allMids
+
+  # Get ETH order book with 3 significant figures
+  npx @nktkas/hyperliquid info l2Book --coin ETH --nSigFigs 3
+
+  # Get user's portfolio
+  npx @nktkas/hyperliquid info portfolio --user 0x...
+
+  # Get candle data for BTC
+  npx @nktkas/hyperliquid info candleSnapshot --coin BTC --interval 1h --startTime 1700000000000
+
+  # Place a limit order
+  npx @nktkas/hyperliquid exchange order --private-key 0x... --orders '[{\\"a\\":0,\\"b\\":true,\\"p\\":30000,\\"s\\":0.1,\\"r\\":false,\\"t\\":{\\"limit\\":{\\"tif\\":\\"Gtc\\"}}}]'
+
+  # Modify an existing order
+  npx @nktkas/hyperliquid exchange modify --private-key 0x... --oid 12345 --order '{\\"a\\":0,\\"b\\":true,\\"p\\":31000,\\"s\\":0.1,\\"r\\":false,\\"t\\":{\\"limit\\":{\\"tif\\":\\"Gtc\\"}}}'
+
+  # Cancel orders
+  npx @nktkas/hyperliquid exchange cancel --private-key 0x... --cancels '[{\\"a\\":0,\\"o\\":12345}]'
+
+  # Update leverage
+  npx @nktkas/hyperliquid exchange updateLeverage --private-key 0x... --asset 0 --isCross true --leverage 5
+
+  # Withdraw funds
+  npx @nktkas/hyperliquid exchange withdraw3 --private-key 0x... --destination 0x... --amount 100.5
+
+  # Send USD to another user
+  npx @nktkas/hyperliquid exchange usdSend --private-key 0x... --destination 0x... --amount 50
+
+  # Create a vault
+  npx @nktkas/hyperliquid exchange createVault --private-key 0x... --name "My Vault" --description "Test vault" --initialUsd 1000`);
+}
+
+const rawArgs = parseArgs(process.argv.slice(2), {
+  flags: ["testnet", "help", "h", "offline"],
+});
+const args = transformArgs(rawArgs, {
+  number: "string",
+});
+const [endpoint, method] = args._;
+
+if (args.help || args.h || !endpoint || !method) {
+  printHelp();
+} else {
+  executeEndpointMethod(endpoint, method, args)
+    .then((result) => console.log(JSON.stringify(result)))
+    .catch((error) => console.error("Error:", error instanceof Error ? error.message : String(error)));
+}

package/dist/bin/_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_utils.d.ts","sourceRoot":"","sources":["../../bin/_utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC,GAAG;IACF,CAAC,EAAE,MAAM,EAAE,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CA8BzE;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAC,CAAC;IAC9D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,QAAQ,CAAC,CAAC;IAC/E;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,QAAQ,CAAC,CAAC;IAC/E;;;;OAIG;IACH,GAAG,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAClF;;;;OAIG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAC5F;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IACrF;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,IAAI;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;IACtF,CAAC,EAAE,MAAM,EAAE,CAAC;CACb;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAmE7E"}

package/dist/bin/_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_utils.js","sourceRoot":"","sources":["../../bin/_utils.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,IAAc,EAAE,OAAsB;IAC9D,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,EAAwB,CAAC;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAuB,CAAC;QAElD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK;gBAAE,SAAS,CAAC,wBAAwB;YAErE,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,IAAI,KAAyB,CAAC;YAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAErC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;gBACnB,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;gBACvC,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC1C,CAAC;iBAAM,IACL,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,wDAAwD;gBAC9F,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EACxF,CAAC;gBACD,KAAK,GAAG,OAAO,CAAC;gBAChB,CAAC,EAAE,CAAC,CAAC,0DAA0D;YACjE,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAoDD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,OAA0B;IACrE,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,QAAQ;QACb,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,QAAQ;QACd,GAAG,OAAO;KACF,CAAC;IAEX,MAAM,MAAM,GAAS,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,GAAG;YAAE,SAAS,CAAC,iCAAiC;QAE5D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QAExB,uBAAuB;QACvB,IAAI,gBAA8B,CAAC;QAEnC,OAAO;QACP,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5E,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,CAAC,CAAC,OAAO;aACJ,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,CAAC,CAAC,UAAU;aACP,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;QAChF,CAAC,CAAC,MAAM;aACH,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3F,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAChF,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvE,CAAC,CAAC,iBAAiB;aACd,IACH,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW;YACzE,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAC/D,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,aAAa,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YAC9G,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjE,CAAC,CAAC,SAAS;aACN,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACzF,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjE,CAAC,CAAC,oBAAoB;aACjB,IACH,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC9C,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,IAAI,CAAC;gBACH,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAwC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC5G,CAAC;YAAC,MAAM,CAAC;gBACP,gBAAgB,GAAG,KAAK,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,mBAAmB;aAChB,CAAC;YACJ,gBAAgB,GAAG,KAAK,CAAC;QAC3B,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/bin/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../bin/cli.ts"],"names":[],"mappings":""}