@hfunlabs/hyperliquid 0.27.1-hfunlabs.5 → 0.29.1-hfunlabs.1

package/README.md

@@ -4,10 +4,10 @@
 [![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)
+[![bundlephobia](https://img.shields.io/bundlephobia/minzip/@nktkas/hyperliquid)](https://bundlephobia.com/package/@nktkas/hyperliquid)
 
-Unofficial [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api) SDK for all major JS
-runtimes, written in TypeScript.
+**@nktkas/hyperliquid** is a TypeScript SDK for the
+[Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api).
 
 ## Features
 
@@ -17,1118 +17,47 @@ runtimes, written in TypeScript.
 - 🌐 **Cross-Environment Support**: Compatible with all major JS runtimes.
 - 🔧 **Integratable**: Easy to use with wallet providers ([viem](https://github.com/wevm/viem) or
   [ethers](https://github.com/ethers-io/ethers.js)).
-- 📚 **Documented**: JSDoc annotations with usage examples.
-- 🌲 [**Tree-shaking friendly**](#tree-shaking-api-functions): Easily import only the API calls you use for minimal
-  bundle size.
 
 ## Installation
 
-### Node.js 20+ (choose your package manager)
-
-```
+```sh
 npm i @nktkas/hyperliquid
-
-pnpm add @nktkas/hyperliquid
-
-yarn add @nktkas/hyperliquid
-```
-
-<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
-import * as hl from "@nktkas/hyperliquid";
-
-const transport = new hl.WebSocketTransport({
-  reconnect: {
-    WebSocket, // pass `WebSocket` class from `ws` package
-  },
-});
-```
-
-</details>
-
-### Deno 2.0+
-
-```
-deno add jsr:@nktkas/hyperliquid
-```
-
-### Web
-
-The SDK is fully browser-compatible; integrate it via CDN or bundle it with your application.
-
-```html
-<script type="module">
-  import * as hl from "https://esm.sh/jsr/@nktkas/hyperliquid";
-</script>
-```
-
-### 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 * as hl from "@nktkas/hyperliquid";
-```
-
-## Quick Start
-
-### CLI
-
-The SDK includes a command-line interface for quick interactions with Hyperliquid API without writing code.
-
-```bash
-npx @nktkas/hyperliquid --help
-```
-
-### [Info endpoint](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint)
-
-```ts
-// 1. Import module
-import * as hl from "@nktkas/hyperliquid";
-
-// 2. Set up client with transport
-const infoClient = new hl.InfoClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-});
-
-// 3. Query data
-const openOrders = await infoClient.openOrders({ user: "0x..." });
-```
-
-### [Exchange endpoint](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint)
-
-```ts
-// 1. Import module
-import * as hl from "@nktkas/hyperliquid";
-
-// 2. Set up client with wallet and transport
-const exchClient = new hl.ExchangeClient({
-  wallet: "0x...", // `viem`, `ethers`, or private key directly
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-});
-
-// 3. Execute an action
-const result = await exchClient.order({
-  orders: [{
-    a: 0,
-    b: true,
-    p: "30000",
-    s: "0.1",
-    r: false,
-    t: {
-      limit: {
-        tif: "Gtc",
-      },
-    },
-  }],
-  grouping: "na",
-});
-```
-
-### [Subscription](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions)
-
-```ts
-// 1. Import module
-import * as hl from "@nktkas/hyperliquid";
-
-// 2. Set up client with transport
-const subsClient = new hl.SubscriptionClient({
-  transport: new hl.WebSocketTransport(),
-});
-
-// 3. Subscribe to events
-const sub = await subsClient.allMids((event) => {
-  console.log(event);
-});
-await sub.unsubscribe();
-```
-
-### [Multi-Sign](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig)
-
-```ts
-// 1. Import module
-import * as hl from "@nktkas/hyperliquid";
-
-// 2. Set up client with transport, multi-sign address, and signers
-const multiSignClient = new hl.MultiSignClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-  multiSigUser: "0x...",
-  signers: [
-    "0x...", // `viem`, `ethers`, or private key directly
-    // ... (more signers if needed)
-  ],
-});
-
-// 3. Execute an action (same as `ExchangeClient`)
-await multiSignClient.approveAgent({ agentAddress: "0x..." });
-```
-
-## Usage
-
-### 1) Initialize Transport
-
-First, choose and configure your transport layer (more details in the [Transports](#transports)):
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-// 1. HTTP Transport: suitable for one-time requests or serverless environments
-const httpTransport = new hl.HttpTransport({ ... }); // Accepts optional parameters (e.g. isTestnet, timeout, etc.)
-
-// 2. WebSocket Transport: has better network latency than HTTP transport
-const wsTransport = new hl.WebSocketTransport({ ... }); // Accepts optional parameters (e.g. isTestnet, timeout, reconnect, etc.)
-```
-
-### 2) Initialize Client
-
-Next, initialize a client with the transport layer (more details in the [Clients](#clients)):
-
-#### Create [InfoClient](#infoclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const infoClient = new hl.InfoClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-});
-```
-
-#### Create [ExchangeClient](#exchangeclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-import { createWalletClient, custom } from "viem";
-import { privateKeyToAccount } from "viem/accounts";
-import { ethers } from "ethers";
-
-const transport = new hl.HttpTransport(); // or `WebSocketTransport`
-
-// 1. Using private key directly
-const pk = "0x...";
-const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
-
-// 2. Using Viem
-const viemAccount = privateKeyToAccount("0x...");
-const exchClient = new hl.ExchangeClient({ wallet: viemAccount, transport });
-
-// 3. Using Ethers
-const ethersWallet = new ethers.Wallet("0x...");
-const exchClient = new hl.ExchangeClient({ wallet: ethersWallet, transport });
-
-// 4. Using external wallet (e.g. MetaMask) via Viem
-const [account] = await window.ethereum.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
-const externalWallet = createWalletClient({ account, transport: custom(window.ethereum) });
-const exchClient = new hl.ExchangeClient({ wallet: externalWallet, transport });
-```
-
-#### Create [SubscriptionClient](#subscriptionclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const subsClient = new hl.SubscriptionClient({
-  transport: new hl.WebSocketTransport(),
-});
-```
-
-#### Create [MultiSignClient](#multisignclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts";
-import { ethers } from "ethers";
-
-const multiSignClient = new hl.MultiSignClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-  multiSigUser: "0x...",
-  signers: [
-    privateKeyToAccount("0x..."), // leader (first signer), signs the transaction twice
-    new ethers.Wallet("0x..."),
-    { // can be a custom async wallet
-      async signTypedData(params: {
-        domain: {
-          name: string;
-          version: string;
-          chainId: number;
-          verifyingContract: Hex;
-        };
-        types: {
-          [key: string]: {
-            name: string;
-            type: string;
-          }[];
-        };
-        primaryType: string;
-        message: Record<string, unknown>;
-      }): Promise<Hex> {
-        // Custom signer logic
-        return "0x..."; // return hex signature
-      },
-    },
-    "0x...", // private key directly
-    // ... more signers
-  ],
-});
-```
-
-### 3) Use Client
-
-Finally, use client methods to interact with the Hyperliquid API (more details in the [API Reference](#clients)):
-
-#### Example of using an [InfoClient](#infoclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const infoClient = new hl.InfoClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-});
-
-// L2 Book
-const l2Book = await infoClient.l2Book({ coin: "ETH" });
-
-// User clearinghouse state
-const clearinghouseState = await infoClient.clearinghouseState({ user: "0x..." });
-
-// User open orders
-const openOrders = await infoClient.openOrders({ user: "0x..." });
-```
-
-#### Example of using an [ExchangeClient](#exchangeclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const exchClient = new hl.ExchangeClient({
-  wallet: "0x...", // `viem`, `ethers`, or private key directly
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-});
-
-// Place an order
-const result = await exchClient.order({
-  orders: [{
-    a: 0,
-    b: true,
-    p: "30000",
-    s: "0.1",
-    r: false,
-    t: {
-      limit: {
-        tif: "Gtc",
-      },
-    },
-  }],
-  grouping: "na",
-});
-
-// Approve an agent
-const result = await exchClient.approveAgent({ agentAddress: "0x..." });
-
-// Withdraw funds
-const result = await exchClient.withdraw3({ destination: "0x...", amount: "100" });
-```
-
-#### Example of using a [SubscriptionClient](#subscriptionclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const subsClient = new hl.SubscriptionClient({
-  transport: new hl.WebSocketTransport(),
-});
-
-// L2 Book updates
-await subsClient.l2Book({ coin: "ETH" }, (data) => {
-  console.log(data);
-});
-
-// User fills
-await subsClient.userFills({ user: "0x..." }, (data) => {
-  console.log(data);
-});
-
-// Candle updates
-await subsClient.candle({ coin: "ETH", interval: "1h" }, (data) => {
-  console.log(data);
-});
-```
-
-#### Example of using a [MultiSignClient](#multisignclient)
-
-```ts
-import * as hl from "@nktkas/hyperliquid";
-
-const multiSignClient = new hl.MultiSignClient({
-  transport: new hl.HttpTransport(), // or `WebSocketTransport`
-  multiSigUser: "0x...",
-  signers: [
-    "0x...", // `viem`, `ethers`, or private key directly
-    // ... (more signers if needed)
-  ],
-});
-
-// Interaction is the same as with `ExchangeClient`
-```
-
-## API Reference
-
-### Clients
-
-A client is an interface through which you can interact with the Hyperliquid API.
-
-#### InfoClient
-
-```ts
-class InfoClient {
-  constructor(args: {
-    /** The transport used to connect to the Hyperliquid API. */
-    transport: HttpTransport | WebSocketTransport;
-  });
-
-  // Market Data
-  alignedQuoteTokenInfo(params: AlignedQuoteTokenInfoParameters): Promise<AlignedQuoteTokenInfoResponse>;
-  allMids(params?: AllMidsParameters): Promise<AllMidsResponse>;
-  allPerpMetas(): Promise<AllPerpMetasResponse>;
-  candleSnapshot(params: CandleSnapshotParameters): Promise<CandleSnapshotResponse>;
-  fundingHistory(params: FundingHistoryParameters): Promise<FundingHistoryResponse>;
-  l2Book(params: L2BookParameters): Promise<L2BookResponse>;
-  liquidatable(): Promise<LiquidatableResponse>;
-  marginTable(params: MarginTableParameters): Promise<MarginTableResponse>;
-  maxMarketOrderNtls(): Promise<MaxMarketOrderNtlsResponse>;
-  meta(params?: MetaParameters): Promise<MetaResponse>;
-  metaAndAssetCtxs(params?: MetaAndAssetCtxsParameters): Promise<MetaAndAssetCtxsResponse>;
-  perpDexLimits(params: PerpDexLimitsParameters): Promise<PerpDexLimitsResponse>;
-  perpDexs(): Promise<PerpDexsResponse>;
-  perpsAtOpenInterestCap(params?: PerpsAtOpenInterestCapParameters): Promise<PerpsAtOpenInterestCapResponse>;
-  predictedFundings(): Promise<PredictedFundingsResponse>;
-  recentTrades(params: RecentTradesParameters): Promise<RecentTradesResponse>;
-  spotMeta(): Promise<SpotMetaResponse>;
-  spotMetaAndAssetCtxs(): Promise<SpotMetaAndAssetCtxsResponse>;
-
-  // User Account
-  activeAssetData(params: ActiveAssetDataParameters): Promise<ActiveAssetDataResponse>;
-  clearinghouseState(params: ClearinghouseStateParameters): Promise<ClearinghouseStateResponse>;
-  extraAgents(params: ExtraAgentsParameters): Promise<ExtraAgentsResponse>;
-  isVip(params: IsVipParameters): Promise<IsVipResponse>;
-  legalCheck(params: LegalCheckParameters): Promise<LegalCheckResponse>;
-  maxBuilderFee(params: MaxBuilderFeeParameters): Promise<MaxBuilderFeeResponse>;
-  portfolio(params: PortfolioParameters): Promise<PortfolioResponse>;
-  preTransferCheck(params: PreTransferCheckParameters): Promise<PreTransferCheckResponse>;
-  referral(params: ReferralParameters): Promise<ReferralResponse>;
-  spotClearinghouseState(params: SpotClearinghouseStateParameters): Promise<SpotClearinghouseStateResponse>;
-  subAccounts(params: SubAccountsParameters): Promise<SubAccountsResponse>;
-  subAccounts2(params: SubAccounts2Parameters): Promise<SubAccounts2Response>;
-  userDexAbstraction(params: UserDexAbstractionInfoParameters): Promise<UserDexAbstractionInfoResponse>;
-  userFees(params: UserFeesParameters): Promise<UserFeesResponse>;
-  userFunding(params: UserFundingParameters): Promise<UserFundingResponse>;
-  userNonFundingLedgerUpdates(
-    params: UserNonFundingLedgerUpdatesParameters,
-  ): Promise<UserNonFundingLedgerUpdatesResponse>;
-  userRateLimit(params: UserRateLimitParameters): Promise<UserRateLimitResponse>;
-  userRole(params: UserRoleParameters): Promise<UserRoleResponse>;
-  userToMultiSigSigners(params: UserToMultiSigSignersParameters): Promise<UserToMultiSigSignersResponse>;
-  webData2(params: WebData2Parameters): Promise<WebData2Response>;
-
-  // Orders & TWAP & Position
-  frontendOpenOrders(params: FrontendOpenOrdersParameters): Promise<FrontendOpenOrdersResponse>;
-  historicalOrders(params: HistoricalOrdersParameters): Promise<HistoricalOrdersResponse>;
-  openOrders(params: OpenOrdersParameters): Promise<OpenOrdersResponse>;
-  orderStatus(params: OrderStatusParameters): Promise<OrderStatusResponse>;
-  twapHistory(params: TwapHistoryParameters): Promise<TwapHistoryResponse>;
-  userFills(params: UserFillsParameters): Promise<UserFillsResponse>;
-  userFillsByTime(params: UserFillsByTimeParameters): Promise<UserFillsByTimeResponse>;
-  userTwapSliceFills(params: UserTwapSliceFillsParameters): Promise<UserTwapSliceFillsResponse>;
-  userTwapSliceFillsByTime(params: UserTwapSliceFillsByTimeParameters): Promise<UserTwapSliceFillsByTimeResponse>;
-
-  // Delegation & Validators
-  delegations(params: DelegationsParameters): Promise<DelegationsResponse>;
-  delegatorHistory(params: DelegatorHistoryParameters): Promise<DelegatorHistoryResponse>;
-  delegatorRewards(params: DelegatorRewardsParameters): Promise<DelegatorRewardsResponse>;
-  delegatorSummary(params: DelegatorSummaryParameters): Promise<DelegatorSummaryResponse>;
-  gossipRootIps(): Promise<GossipRootIpsResponse>;
-  validatorL1Votes(): Promise<ValidatorL1VotesResponse>;
-  validatorSummaries(): Promise<ValidatorSummariesResponse>;
-
-  // Vault
-  leadingVaults(params: LeadingVaultsParameters): Promise<LeadingVaultsResponse>;
-  userVaultEquities(params: UserVaultEquitiesParameters): Promise<UserVaultEquitiesResponse>;
-  vaultDetails(params: VaultDetailsParameters): Promise<VaultDetailsResponse>;
-  vaultSummaries(): Promise<VaultSummariesResponse>;
-
-  // Deploy Market
-  perpDeployAuctionStatus(): Promise<PerpDeployAuctionStatusResponse>;
-  spotDeployState(params: SpotDeployStateParameters): Promise<SpotDeployStateResponse>;
-  spotPairDeployAuctionStatus(): Promise<SpotPairDeployAuctionStatusResponse>;
-
-  // Other
-  exchangeStatus(): Promise<ExchangeStatusResponse>;
-
-  // Transaction & Block Details (RPC endpoint)
-  blockDetails(params: BlockDetailsParameters): Promise<BlockDetailsResponse>;
-  txDetails(params: TxDetailsParameters): Promise<TxDetailsResponse>;
-  userDetails(params: UserDetailsParameters): Promise<UserDetailsResponse>;
-  tokenDetails(params: TokenDetailsParameters): Promise<TokenDetailsResponse>;
-}
-```
-
-#### ExchangeClient
-
-```ts
-class ExchangeClient {
-  constructor(args: {
-    /** The transport used to connect to the Hyperliquid Exchange API. */
-    transport: HttpTransport | WebSocketTransport;
-
-    /** 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
-
-    /**
-     * 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<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<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<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<CreateSubAccountSuccessResponse>;
-  subAccountModify(params: SubAccountModifyParameters): Promise<SubAccountModifySuccessResponse>;
-  subAccountSpotTransfer(params: SubAccountSpotTransferParameters): Promise<SubAccountSpotTransferSuccessResponse>;
-  subAccountTransfer(params: SubAccountTransferParameters): Promise<SubAccountTransferSuccessResponse>;
-
-  // Referrer
-  claimRewards(): Promise<ClaimRewardsSuccessResponse>;
-  registerReferrer(params: RegisterReferrerParameters): Promise<RegisterReferrerSuccessResponse>;
-  setReferrer(params: SetReferrerParameters): Promise<SetReferrerSuccessResponse>;
-
-  // Staking & Delegation
-  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<CreateVaultSuccessResponse>;
-  vaultDistribute(params: VaultDistributeParameters): Promise<VaultDistributeSuccessResponse>;
-  vaultModify(params: VaultModifyParameters): Promise<VaultModifySuccessResponse>;
-  vaultTransfer(params: VaultTransferParameters): Promise<VaultTransferSuccessResponse>;
-
-  // Multi-Sign
-  convertToMultiSigUser(params: ConvertToMultiSigUserParameters): Promise<ConvertToMultiSigUserSuccessResponse>;
-  multiSig(params: MultiSigParameters): Promise<MultiSigSuccessResponse>;
-
-  // Deploy Market
-  perpDeploy(params: PerpDeployParameters): Promise<PerpDeploySuccessResponse>;
-  spotDeploy(params: SpotDeployParameters): Promise<SpotDeploySuccessResponse>;
-
-  // Validator Actions
-  cSignerAction(params: CSignerActionParameters): Promise<CSignerActionSuccessResponse>;
-  cValidatorAction(params: CValidatorActionParameters): Promise<CValidatorActionSuccessResponse>;
-  validatorL1Stream(params: ValidatorL1StreamParameters): Promise<ValidatorL1StreamSuccessResponse>;
-}
 ```
 
-#### SubscriptionClient
+## Quick Example
 
 ```ts
-class SubscriptionClient {
-  constructor(args: {
-    /** The transport used to connect to the Hyperliquid API. */
-    transport: WebSocketTransport;
-  });
-
-  // Market
-  activeAssetCtx(params: WsActiveAssetCtxParameters, listener: (data: WsActiveAssetCtxEvent) => void);
-  activeSpotAssetCtx(params: WsActiveSpotAssetCtxParameters, listener: (data: WsActiveSpotAssetCtxEvent) => void);
-  allMids(params?: WsAllMidsParameters, listener: (data: WsAllMidsEvent) => void);
-  assetCtxs(params?: WsAssetCtxsParameters, listener: (data: WsAssetCtxsEvent) => void);
-  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
-  activeAssetData(params: WsActiveAssetDataParameters, listener: (data: WsActiveAssetDataEvent) => void);
-  clearinghouseState(params: WsClearinghouseStateParameters, listener: (data: WsClearinghouseStateEvent) => void);
-  notification(params: WsNotificationParameters, listener: (data: WsNotificationEvent) => void);
-  spotState(params: WsSpotStateParameters, listener: (data: WsSpotStateEvent) => void);
-  userEvents(params: WsUserEventsParameters, listener: (data: WsUserEventsEvent) => void);
-  userFundings(params: WsUserFundingsParameters, listener: (data: WsUserFundingsEvent) => void);
-  userHistoricalOrders(params: WsUserHistoricalOrdersParameters, listener: (data: WsUserHistoricalOrdersEvent) => void);
-  userNonFundingLedgerUpdates(
-    params: WsUserNonFundingLedgerUpdatesParameters,
-    listener: (data: WsUserNonFundingLedgerUpdatesEvent) => void,
-  );
-  webData2(params: WsWebData2Parameters, listener: (data: WsWebData2Event) => void);
-  webData3(params: WsWebData3Parameters, listener: (data: WsWebData3Event) => void);
-
-  // Order
-  openOrders(params: WsOpenOrdersParameters, listener: (data: WsOpenOrdersEvent) => void);
-  orderUpdates(params: WsOrderUpdatesParameters, listener: (data: WsOrderUpdatesEvent) => void);
-  userFills(params: WsUserFillsParameters, listener: (data: WsUserFillsEvent) => void);
-  userTwapHistory(params: WsUserTwapHistoryParameters, listener: (data: WsUserTwapHistoryEvent) => void);
-  userTwapSliceFills(params: WsUserTwapSliceFillsParameters, listener: (data: WsUserTwapSliceFillsEvent) => void);
-
-  // Transaction & Block Details (RPC endpoint)
-  explorerBlock(listener: (data: WsExplorerBlockEvent) => void);
-  explorerTxs(listener: (data: WsExplorerTxsEvent) => void);
-}
-```
-
-#### MultiSignClient
-
-```ts
-class MultiSignClient extends ExchangeClient {
-  constructor(
-    args: {
-      // ... same params as in `ExchangeClient` except `wallet`
-      // and
-      multiSigUser: Hex;
-      signers: [
-        AbstractWallet | Hex, // leader (first signer), signs the transaction twice
-        ...(AbstractWallet | Hex)[], // ... more signers
-      ];
-    },
-  );
-
-  // Same methods as `ExchangeClient`
-}
-```
-
-### Transports
-
-Transport is a layer between class/function requests and Hyperliquid servers.
-
-#### HTTP Transport
-
-Uses [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) for requests. Supports
-[Info](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint) /
-[Exchange](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint) / Explorer endpoints.
-
-**Features:**
-
-- Can change any settings in the created instance without creating a new instance (e.g. switch between mainnet/testnet).
-- Intercepting and modifying requests/responses/errors using on* functions.
-
-```ts
-class HttpTransport {
-  constructor(options?: {
-    /** Whether to use testnet url (default: false) */
-    isTestnet?: boolean;
-    /** Request timeout in ms (default: 10_000) */
-    timeout?: number;
-    /** Custom server URLs */
-    server?: {
-      mainnet?: { api?: string | URL; rpc?: string | URL };
-      testnet?: { api?: string | URL; rpc?: string | URL };
-    };
-    /** Custom fetch options */
-    fetchOptions?: RequestInit;
-    /** Callback before request is sent */
-    onRequest?: (request: Request) => MaybePromise<Request | void | null | undefined>;
-    /** Callback after response is received */
-    onResponse?: (response: Response) => MaybePromise<Response | void | null | undefined>;
-    /** Callback on error during fetching */
-    onError?: (error: unknown) => MaybePromise<Error | void | null | undefined>;
-  });
-}
-```
-
-#### WebSocket Transport
-
-Uses [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) for requests. Supports
-[subscriptions](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions) and
-[post requests](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/post-requests).
-
-**Features:**
-
-- Automatically restores connection after loss and resubscribes to previous subscriptions.
-- Smart keep alive (pings only when idle).
-- Lazy initialization with message buffering during connection establishment.
-
-**Limitations:**
-
-- 1 instance = 1 immutable endpoint. Cannot mix api/explorer endpoints or mainnet/testnet in single connection. Need to
-  create separate instances for different endpoints.
-- Cannot send explorer post-requests, only explorer subscriptions.
-
-```ts
-class WebSocketTransport {
-  constructor(options?: {
-    /** Indicates this transport uses testnet endpoint (default: false) */
-    isTestnet?: boolean;
-    /**
-     * Custom WebSocket endpoint for API and Subscription requests.
-     * (default: `wss://api.hyperliquid.xyz/ws` for `isTestnet` = false, `wss://api.hyperliquid-testnet.xyz/ws` for `isTestnet` = true)
-     */
-    url?: string | URL;
-    /** Timeout for requests in ms (default: 10_000) */
-    timeout?: number;
-    /** Interval between sending ping messages in ms (default: 30_000) */
-    keepAliveInterval?: number;
-    /** Reconnection policy configuration for closed connections */
-    reconnect?: {
-      /** Custom WebSocket constructor (default: global WebSocket) */
-      WebSocket?: new (url: string | URL) => WebSocket;
-      /** Maximum number of reconnection attempts (default: 3) */
-      maxRetries?: number;
-      /** Maximum time in ms to wait for a connection to open (default: 10_000) */
-      connectionTimeout?: number;
-      /** Delay before reconnection in ms (default: Exponential backoff (max 10s)) */
-      reconnectionDelay?: number | ((attempt: number) => number);
-    };
-    /** Enable automatic re-subscription to Hyperliquid subscription after reconnection (default: true) */
-    resubscribe?: boolean;
-  });
-  ready(signal?: AbortSignal): Promise<void>;
-  close(signal?: AbortSignal): Promise<void>;
-}
-```
-
-### Errors
-
-All SDK errors extend from `HyperliquidError` base class for unified error handling:
-
-```ts
-import { AbstractWalletError, ApiRequestError, HyperliquidError, SchemaError, TransportError } from "@nktkas/hyperliquid";
-
-try {
-    await exchClient.order({ ... });
-} catch (error) {
-    if (error instanceof SchemaError) {
-        // Invalid input data format
-    } else if (error instanceof ApiRequestError) {
-        // Exchange API returned error (e.g., insufficient funds)
-    } else if (error instanceof TransportError) {
-        // 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
-    }
-}
-```
-
-## Additional Import Points
-
-### `/signing`
-
-This module contains functions for generating Hyperliquid transaction signatures.
-
-#### L1 Action
-
-```ts
-import { signL1Action } from "@nktkas/hyperliquid/signing";
-import { CancelRequest, parser } from "@nktkas/hyperliquid/api/exchange";
-import { privateKeyToAccount } from "viem/accounts";
-
-const wallet = privateKeyToAccount("0x..."); // viem or ethers
-
-const action = parser(CancelRequest.entries.action)({ // for correct signature generation
-  type: "cancel",
-  cancels: [
-    { a: 0, o: 12345 },
-  ],
-});
-const nonce = Date.now();
-
-const signature = await signL1Action({ wallet, action, nonce });
-
-// Send the signed action to the Hyperliquid API
-const response = await fetch("https://api.hyperliquid.xyz/exchange", {
-  method: "POST",
-  headers: { "Content-Type": "application/json" },
-  body: JSON.stringify({ action, signature, nonce }),
-});
-const body = await response.json();
-```
-
-#### User Signed Action
-
-```ts
-import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
-import { ApproveAgentRequest, ApproveAgentTypes, parser } from "@nktkas/hyperliquid/api/exchange";
+import { ExchangeClient, HttpTransport, InfoClient } from "@nktkas/hyperliquid";
 import { privateKeyToAccount } from "viem/accounts";
 
-const wallet = privateKeyToAccount("0x..."); // viem or ethers
-
-const action = parser(ApproveAgentRequest.entries.action)({ // for correct signature generation
-  type: "approveAgent",
-  signatureChainId: "0x66eee",
-  hyperliquidChain: "Mainnet",
-  agentAddress: "0x...",
-  agentName: "Agent",
-  nonce: Date.now(),
-});
-
-const signature = await signUserSignedAction({ wallet, action, types: ApproveAgentTypes });
+// Read data
+const info = new InfoClient({ transport: new HttpTransport() });
+const mids = await info.allMids();
+console.log(mids); // { "BTC": "97000.5", "ETH": "3500.25", ... }
 
-// Send the signed action to the Hyperliquid API
-const response = await fetch("https://api.hyperliquid.xyz/exchange", {
-  method: "POST",
-  headers: { "Content-Type": "application/json" },
-  body: JSON.stringify({ action, signature, nonce: action.nonce }),
+// Place order
+const exchange = new ExchangeClient({
+  transport: new HttpTransport(),
+  wallet: privateKeyToAccount("0x..."),
 });
-const body = await response.json();
-```
-
-### `/api`
-
-This module contains raw functions for interacting with the Hyperliquid API and
-[valibot](https://github.com/fabian-hiller/valibot) schemas for API requests/responses.
-
-#### Tree-shaking API functions
-
-You can use raw functions to maximize tree-shaking in your app. This is useful if you are pedantic about bundle size and
-want to only include the API calls you use.
-
-##### `/api/info`
-
-```ts
-import { HttpTransport } from "@nktkas/hyperliquid";
-import { clearinghouseState } from "@nktkas/hyperliquid/api/info";
-//       ^^^^^^^^^^^^^^^^^^
-//       same name as in `InfoClient`
-
-const transport = new HttpTransport(); // or `WebSocketTransport`
-const data = await clearinghouseState(
-  { transport }, // same params as in `InfoClient`
-  { user: "0x..." },
-);
-```
 
-##### `/api/exchange`
-
-```ts
-import { HttpTransport } from "@nktkas/hyperliquid";
-import { privateKeyToAccount } from "viem/accounts";
-import { order } from "@nktkas/hyperliquid/api/exchange";
-//       ^^^^^
-//       same name as in `ExchangeClient`
-
-const wallet = privateKeyToAccount("0x..."); // viem or ethers
-const transport = new HttpTransport(); // or `WebSocketTransport`
-
-const data = await order(
-  { transport, wallet }, // same params as in `ExchangeClient` or `MultiSignClient`
-  {
-    orders: [
-      {
-        a: 0,
-        b: true,
-        p: "30000",
-        s: "0.1",
-        r: false,
-        t: { limit: { tif: "Gtc" } },
-        c: "0x...",
-      },
-    ],
-    grouping: "na",
-  },
-);
-```
-
-##### `/api/subscription`
-
-```ts
-import { WebSocketTransport } from "@nktkas/hyperliquid";
-import { candle } from "@nktkas/hyperliquid/api/subscription";
-//       ^^^^^^
-//       same name as in `SubscriptionClient`
-
-const transport = new WebSocketTransport();
-
-const sub = await candle(
-  { transport }, // same params as in `SubscriptionClient`
-  { coin: "ETH", interval: "1h" },
-  (data) => console.log(data),
-);
-```
-
-#### Valibot Schemas
-
-Another way to use this module is to access [valibot](https://github.com/fabian-hiller/valibot) schemas for API
-requests/responses. For example, to validate data and sort object keys before creating a signature.
-
-```ts
-import { OrderRequest, parser } from "@nktkas/hyperliquid/api/exchange";
-//       ^^^^^^^^^^^^
-//       both a valibot schema and a typescript type
-
-const action = {
-  type: "order",
+const result = await exchange.order({
   orders: [{
-    a: 0,
-    b: true,
-    p: "50000",
-    s: "0.1",
-    r: false,
+    a: 0, // Asset index (BTC)
+    b: true, // Buy side
+    p: "95000", // Price
+    s: "0.01", // Size
+    r: false, // Reduce only
     t: { limit: { tif: "Gtc" } },
   }],
   grouping: "na",
-} satisfies OrderRequest["action"]; // can be used as type
-
-//                             or as valibot schema
-//                             ⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄
-const validatedAction = parser(OrderRequest.entries.action)(action);
-//                      ^^^^^^
-//                      validates, formats, sorts object keys for correct signature generation
-//                      and returns typed data
-```
-
-Also valibot schema can be converted to JSON Schema (e.g. for generating OpenAPI spec):
-
-```ts
-import { OrderRequest } from "@nktkas/hyperliquid/api/exchange";
-import { toJsonSchema } from "@valibot/to-json-schema";
-
-const schema = toJsonSchema(OrderRequest, { errorMode: "ignore", typeMode: "output" });
-
-console.log(JSON.stringify(schema, null, 2));
-// {
-//   "$schema": "http://json-schema.org/draft-07/schema#",
-//   "type": "object",
-//   "properties": {
-//     "action": {
-//       "type": "object",
-//       "properties": {
-//         "type": { "const": "order" },
-//         "orders": { "type": "array", "items": {...} },
-//         "grouping": { "anyOf": [...] },
-//         "builder": { "type": "object", ... }
-//       },
-//       "required": ["type", "orders", "grouping"]
-//     },
-//     "nonce": { "type": "number" },
-//     "signature": {
-//       "type": "object",
-//       "properties": {
-//         "r": { "type": "string", ... },
-//         "s": { "type": "string", ... },
-//         "v": { "anyOf": [{"const": 27}, {"const": 28}] }
-//       },
-//       "required": ["r", "s", "v"]
-//     },
-//     "vaultAddress": { "type": "string", ... },
-//     "expiresAfter": { "type": "number" }
-//   },
-//   "required": ["action", "nonce", "signature"]
-// }
-```
-
-### `/utils`
-
-This module contains helper functions for interacting with the HyperLiquid API.
-
-#### `SymbolConverter`
-
-Helper class for converting asset symbols to asset IDs and size decimals. See
-[hyperliquid docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids).
-
-```ts
-import { HttpTransport } from "@nktkas/hyperliquid";
-import { SymbolConverter } from "@nktkas/hyperliquid/utils";
-
-const transport = new HttpTransport(); // or `WebSocketTransport`
-const converter = await SymbolConverter.create({ transport });
-
-// By default, dexs are not loaded; specify them when creating an instance
-const converter = await SymbolConverter.create({ transport, dexs: ["test"] });
-```
-
-##### Get asset ID for a coin
-
-```ts
-// For Perpetuals, use the coin name
-const btcId = converter.getAssetId("BTC"); // → 0
-
-// For Spot markets, use the "BASE/QUOTE" format
-const hypeUsdcId = converter.getAssetId("HYPE/USDC"); // → 10107
-
-// For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format
-const dexAbcId = converter.getAssetId("test:ABC"); // → 110000
-```
-
-##### Get size decimals for a coin.
-
-```ts
-// For Perpetuals, use the coin name
-const btcSzDecimals = converter.getSzDecimals("BTC"); // → 5
-
-// For Spot markets, use the "BASE/QUOTE" format
-const hypeUsdcSzDecimals = converter.getSzDecimals("HYPE/USDC"); // → 2
-
-// For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format
-const dexAbcSzDecimals = converter.getSzDecimals("test:ABC"); // → 0
-```
-
-##### Get spot pair ID for info endpoints and subscriptions
-
-```ts
-// Accepts spot markets in the "BASE/QUOTE" format
-const spotPairId = converter.getSpotPairId("HFUN/USDC"); // → "@2"
-```
-
-#### Formatting functions
-
-Helper functions for formatting price and size based on `szDecimals`. See
-[hyperliquid docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size).
-
-```ts
-import { formatPrice, formatSize } from "@nktkas/hyperliquid/utils";
-
-//                                              `true` for perp (default), `false` for spot
-// Format price (PUMP/USDC, szDecimals=0)       ⌄⌄⌄⌄⌄
-const price = formatPrice("0.0000123456789", 0, false); // → "0.00001234"
-
-// Format size (BTC, szDecimals=5)
-const size = formatSize("1.23456789", 5); // → "1.23456"
-```
-
-#### Recovering signer address
-
-##### Recover Address from L1 Action
-
-```ts
-import { recoverUserFromL1Action } from "@nktkas/hyperliquid/utils";
-
-const action = {
-  type: "cancel",
-  cancels: [{ a: 0, o: 12345 }],
-};
-const nonce = 1700000000000;
-const signature = {
-  r: "0x...",
-  s: "0x...",
-  v: 27,
-} as const;
-
-const address = await recoverUserFromL1Action({ action, nonce, signature });
-console.log(`Signer address: ${address}`);
-```
-
-##### Recover Address from User Signed Action
-
-```ts
-import { recoverUserFromUserSigned } from "@nktkas/hyperliquid/utils";
-
-const action = {
-  type: "approveAgent",
-  signatureChainId: "0x66eee" as const,
-  hyperliquidChain: "Mainnet",
-  agentAddress: "0x...",
-  agentName: "Agent",
-  nonce: 1700000000000,
-};
-const types = {
-  HyperliquidTransaction: [
-    { name: "hyperliquidChain", type: "string" },
-    // ... other fields
-  ],
-};
-const signature = {
-  r: "0x...",
-  s: "0x...",
-  v: 27,
-} as const;
-
-const address = await recoverUserFromUserSigned({ action, types, signature });
-console.log(`Signer address: ${address}`);
+});
 ```
 
-## FAQ
-
-### How to execute an L1 action via an external wallet (e.g. MetaMask)?
-
-Hyperliquid requires chain `1337` for L1 action signatures. To handle this with external wallets:
-
-- (recommended) Create an
-  [Agent Wallet](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#api-wallets)
-  and execute all L1 actions through it
-- Change a user's chain to `1337`, however, the user will sign unreadable data
-
-### How to create a market order?
-
-Hyperliquid doesn't have traditional market orders, but you can achieve market-like execution by placing limit order
-with `tif: "Ioc"` and price that guarantee immediate execution:
-
-- For buys: set limit price >= current best ask
-- For sells: set limit price <= current best bid
-
-### How to use the [Agent Wallet](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#api-wallets)?
-
-Use agent's private key instead of master account's private key.
-
-### How to use the [Vault](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults) / [Sub-Account](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults)?
-
-Pass vault or sub-account address via `vaultAddress` options to method or set `defaultVaultAddress` in client options.
-
-### How to use Testnet?
+## Documentation
 
-Set `isTestnet: true` in [transport](#transports) options.
+📚 **[Read the full documentation](https://nktkas.gitbook.io/hyperliquid)**
 
-## Contributing
+## License
 
-We appreciate your help! To contribute, please read the [contributing instructions](CONTRIBUTING.md).
+[MIT](/LICENSE) License © 2024-2025 nktkas