@nktkas/hyperliquid 0.32.1 → 0.32.2

package/src/api/info/_methods/subAccounts2.ts

@@ -73,10 +73,9 @@ export type SubAccounts2Parameters = Omit<v.InferInput<typeof SubAccounts2Reques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await subAccounts2(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await subAccounts2({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/_methods/tokenDetails.ts

@@ -144,10 +144,9 @@ export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsReques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await tokenDetails(
- *   { transport },
- *   { tokenId: "0x..." },
- * );
+ * const data = await tokenDetails({ transport }, {
+ *   tokenId: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token

package/src/api/info/_methods/twapHistory.ts

@@ -78,10 +78,9 @@ export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await twapHistory(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await twapHistory({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/_methods/txDetails.ts

@@ -60,10 +60,9 @@ export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "t
  *
  * const transport = new HttpTransport(); // only `HttpTransport` supports this API
  *
- * const data = await txDetails(
- *   { transport },
- *   { hash: "0x..." },
- * );
+ * const data = await txDetails({ transport }, {
+ *   hash: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/_methods/userAbstraction.ts

@@ -59,10 +59,9 @@ export type UserAbstractionParameters = Omit<v.InferInput<typeof UserAbstraction
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userAbstraction(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-abstraction-state

package/src/api/info/_methods/userBorrowLendInterest.ts

@@ -73,13 +73,10 @@ export type UserBorrowLendInterestParameters = Omit<v.InferInput<typeof UserBorr
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userBorrowLendInterest(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userBorrowLendInterest({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state

package/src/api/info/_methods/userDetails.ts

@@ -60,10 +60,9 @@ export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>
  *
  * const transport = new HttpTransport(); // only `HttpTransport` supports this API
  *
- * const data = await userDetails(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userDetails({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/_methods/userDexAbstraction.ts

@@ -54,10 +54,9 @@ export type UserDexAbstractionParameters = Omit<v.InferInput<typeof UserDexAbstr
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userDexAbstraction(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userDexAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state

package/src/api/info/_methods/userFees.ts

@@ -231,10 +231,9 @@ export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFees(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFees({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees

package/src/api/info/_methods/userFills.ts

@@ -78,10 +78,9 @@ export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "t
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFills(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFills({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills

package/src/api/info/_methods/userFillsByTime.ts

@@ -63,13 +63,10 @@ export type UserFillsByTimeParameters = Omit<v.InferInput<typeof UserFillsByTime
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFillsByTime(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userFillsByTime({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time

package/src/api/info/_methods/userFunding.ts

@@ -90,10 +90,9 @@ export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFunding(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFunding({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates

package/src/api/info/_methods/userNonFundingLedgerUpdates.ts

@@ -92,7 +92,7 @@ export type UserNonFundingLedgerUpdatesResponse = {
       liquidatedNtlPos: string;
       /**
        * Account value at liquidation time.
-       * @pattern ^[0-9]+(\.[0-9]+)?$
+       * @pattern ^-?[0-9]+(\.[0-9]+)?$
        */
       accountValue: string;
       /** Leverage type for liquidated positions. */
@@ -389,6 +389,20 @@ export type UserNonFundingLedgerUpdatesResponse = {
        * @pattern ^[0-9]+(\.[0-9]+)?$
        */
       amount: string;
+    }
+    | {
+      /** Update type. */
+      type: "vaultLeaderCommission";
+      /**
+       * Address of the leader.
+       * @pattern ^0x[a-fA-F0-9]{40}$
+       */
+      user: `0x${string}`;
+      /**
+       * Amount earned in USDC.
+       * @pattern ^[0-9]+(\.[0-9]+)?$
+       */
+      usdc: string;
     };
 }[];
 
@@ -423,10 +437,9 @@ export type UserNonFundingLedgerUpdatesParameters = Omit<
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userNonFundingLedgerUpdates(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userNonFundingLedgerUpdates({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates

package/src/api/info/_methods/userRateLimit.ts

@@ -66,10 +66,9 @@ export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userRateLimit(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userRateLimit({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits

package/src/api/info/_methods/userRole.ts

@@ -79,10 +79,9 @@ export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userRole(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userRole({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role

package/src/api/info/_methods/userToMultiSigSigners.ts

@@ -62,10 +62,9 @@ export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMul
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userToMultiSigSigners(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userToMultiSigSigners({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/_methods/userTwapSliceFills.ts

@@ -60,10 +60,9 @@ export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSlic
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userTwapSliceFills(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userTwapSliceFills({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills

package/src/api/info/_methods/userTwapSliceFillsByTime.ts

@@ -61,13 +61,10 @@ export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTw
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userTwapSliceFillsByTime(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userTwapSliceFillsByTime({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills

package/src/api/info/_methods/userVaultEquities.ts

@@ -67,10 +67,9 @@ export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEqui
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userVaultEquities(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userVaultEquities({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits

package/src/api/info/_methods/vaultDetails.ts

@@ -151,10 +151,9 @@ export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsReques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await vaultDetails(
- *   { transport },
- *   { vaultAddress: "0x..." },
- * );
+ * const data = await vaultDetails({ transport }, {
+ *   vaultAddress: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault

package/src/api/info/_methods/webData2.ts

@@ -108,10 +108,9 @@ export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await webData2(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await webData2({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

package/src/api/info/client.ts

@@ -108,6 +108,7 @@ import {
   type PerpAnnotationResponse,
 } from "./_methods/perpAnnotation.js";
 import { perpCategories, type PerpCategoriesResponse } from "./_methods/perpCategories.js";
+import { perpConciseAnnotations, type PerpConciseAnnotationsResponse } from "./_methods/perpConciseAnnotations.js";
 import { perpDeployAuctionStatus, type PerpDeployAuctionStatusResponse } from "./_methods/perpDeployAuctionStatus.js";
 import { perpDexLimits, type PerpDexLimitsParameters, type PerpDexLimitsResponse } from "./_methods/perpDexLimits.js";
 import { perpDexs, type PerpDexsResponse } from "./_methods/perpDexs.js";
@@ -1296,6 +1297,33 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
     return perpCategories(this.config_, signal);
   }
 
+  /**
+   * Request concise annotations for all perpetual assets.
+   *
+   * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+   * @return Array of tuples mapping coin names to their concise annotations.
+   *
+   * @throws {ValidationError} When the request parameters fail validation (before sending).
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   * const client = new hl.InfoClient({ transport });
+   *
+   * const data = await client.perpConciseAnnotations();
+   * ```
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-concise-perp-annotations
+   */
+  perpConciseAnnotations(
+    signal?: AbortSignal,
+  ): Promise<PerpConciseAnnotationsResponse> {
+    return perpConciseAnnotations(this.config_, signal);
+  }
+
   /**
    * Request for the status of the perpetual deploy auction.
    *
@@ -2505,6 +2533,7 @@ export type { OrderStatusParameters, OrderStatusResponse } from "./_methods/orde
 export type { OutcomeMetaResponse } from "./_methods/outcomeMeta.js";
 export type { PerpAnnotationParameters, PerpAnnotationResponse } from "./_methods/perpAnnotation.js";
 export type { PerpCategoriesResponse } from "./_methods/perpCategories.js";
+export type { PerpConciseAnnotationsResponse } from "./_methods/perpConciseAnnotations.js";
 export type { PerpDeployAuctionStatusResponse } from "./_methods/perpDeployAuctionStatus.js";
 export type { PerpDexLimitsParameters, PerpDexLimitsResponse } from "./_methods/perpDexLimits.js";
 export type { PerpDexsResponse } from "./_methods/perpDexs.js";

package/src/api/info/mod.ts

@@ -60,6 +60,7 @@ export * from "./_methods/orderStatus.js";
 export * from "./_methods/outcomeMeta.js";
 export * from "./_methods/perpAnnotation.js";
 export * from "./_methods/perpCategories.js";
+export * from "./_methods/perpConciseAnnotations.js";
 export * from "./_methods/perpDeployAuctionStatus.js";
 export * from "./_methods/perpDexLimits.js";
 export * from "./_methods/perpDexs.js";

package/src/api/subscription/_methods/l2Book.ts

@@ -4,8 +4,6 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Integer } from "../../_schemas.js";
-
 /**
  * Subscription to L2 order book events for a specific asset.
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -17,13 +15,28 @@ export const L2BookRequest = /* @__PURE__ */ (() => {
     /** Asset symbol (e.g., BTC). */
     coin: v.string(),
     /** Number of significant figures. */
-    nSigFigs: v.nullish(v.pipe(Integer, v.picklist([2, 3, 4, 5]))),
+    nSigFigs: v.nullish(v.picklist([2, 3, 4, 5])),
     /** Mantissa for aggregation (if `nSigFigs` is 5). */
-    mantissa: v.nullish(v.pipe(Integer, v.picklist([2, 5]))),
+    mantissa: v.nullish(v.picklist([2, 5])),
   });
 })();
 export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
 
+type L2BookLevel = {
+  /**
+   * Price.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  px: string;
+  /**
+   * Total size.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  sz: string;
+  /** Number of individual orders. */
+  n: number;
+};
+
 /**
  * Event of L2 order book snapshot.
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -34,38 +47,12 @@ export type L2BookEvent = {
   /** Timestamp of the snapshot (in ms since epoch). */
   time: number;
   /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-  levels: [{
-    /**
-     * Price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    px: string;
-    /**
-     * Total size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Number of individual orders. */
-    n: number;
-  }[], {
-    /**
-     * Price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    px: string;
-    /**
-     * Total size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Number of individual orders. */
-    n: number;
-  }[]];
+  levels: [bids: L2BookLevel[], asks: L2BookLevel[]];
   /**
    * Spread (only present when `nSigFigs` is non-null).
    * @pattern ^[0-9]+(\.[0-9]+)?$
    */
-  spread?: string | undefined;
+  spread?: string;
 };
 
 // ============================================================

package/src/api/subscription/_methods/spotState.ts

@@ -18,7 +18,7 @@ export const SpotStateRequest = /* @__PURE__ */ (() => {
     /** User address. */
     user: Address,
     /** Whether to ignore portfolio margin calculations. */
-    ignorePortfolioMargin: v.optional(v.boolean(), false),
+    ignorePortfolioMargin: v.optional(v.boolean()),
   });
 })();
 export type SpotStateRequest = v.InferOutput<typeof SpotStateRequest>;
@@ -80,7 +80,7 @@ export function spotState(
   params: SpotStateParameters,
   listener: (data: SpotStateEvent) => void,
 ): Promise<ISubscription> {
-  const payload = parse(SpotStateRequest, { type: "spotState", user: params.user });
+  const payload = parse(SpotStateRequest, { type: "spotState", ...params });
   return config.transport.subscribe<SpotStateEvent>(payload.type, payload, (e) => {
     if (e.detail.user === payload.user) {
       listener(e.detail);

package/src/api/subscription/_methods/userFundings.ts

@@ -55,7 +55,7 @@ export type UserFundingsEvent = {
     nSamples: number | null;
   }[];
   /** Whether this is an initial snapshot. */
-  isSnapshot?: true | undefined;
+  isSnapshot?: true;
 };
 
 // ============================================================

package/src/signing/_abstractWallet.ts

@@ -195,9 +195,16 @@ export async function signTypedData(args: {
 }
 
 function splitSignature(signature: `0x${string}`): Signature {
-  const r = `0x${signature.slice(2, 66)}` as const;
-  const s = `0x${signature.slice(66, 130)}` as const;
-  const v = parseInt(signature.slice(130, 132), 16) as 27 | 28;
+  if (signature.length !== 132) {
+    throw new AbstractWalletError(`Expected 65-byte signature (132 hex chars), got ${signature.length}`);
+  }
+  const r = `0x${signature.slice(2, 66)}` as `0x${string}`;
+  const s = `0x${signature.slice(66, 130)}` as `0x${string}`;
+  let v = parseInt(signature.slice(130, 132), 16);
+  if (v === 0 || v === 1) v += 27;
+  if (v !== 27 && v !== 28) {
+    throw new AbstractWalletError(`Invalid signature recovery value: ${v}, expected 27 or 28`);
+  }
   return { r, s, v };
 }
 
@@ -248,6 +255,7 @@ export async function getWalletAddress(wallet: AbstractWallet): Promise<`0x${str
     // Viem JSON-RPC account uses getAddresses()
     if (isViemJsonRpcAccount(wallet)) {
       const addresses = await wallet.getAddresses() as `0x${string}`[];
+      if (!addresses.length) throw new AbstractWalletError("Wallet returned no addresses");
       return addresses[0].toLowerCase() as `0x${string}`;
     }
 

package/src/transport/websocket/_postRequest.ts

@@ -3,6 +3,10 @@ import { TransportError } from "../_base.js";
 import { AbortSignal_, Promise_ } from "../_polyfills.js";
 import type { HyperliquidEventTarget } from "./_hyperliquidEventTarget.js";
 
+// ============================================================
+// Request Types
+// ============================================================
+
 interface PostRequest {
   method: "post";
   id: number;
@@ -24,6 +28,10 @@ interface PendingRequest {
   reject: (reason?: any) => void;
 }
 
+// ============================================================
+// Error Classes
+// ============================================================
+
 /** Error thrown when a WebSocket request fails. */
 export class WebSocketRequestError extends TransportError {
   constructor(message?: string, options?: ErrorOptions) {
@@ -32,6 +40,10 @@ export class WebSocketRequestError extends TransportError {
   }
 }
 
+// ============================================================
+// Post Request Manager
+// ============================================================
+
 /**
  * Manages WebSocket post requests to the Hyperliquid API.
  * Handles request creation, sending, and mapping responses to their corresponding requests.
@@ -232,6 +244,10 @@ export class WebSocketPostRequest {
   }
 }
 
+// ============================================================
+// Helpers
+// ============================================================
+
 function recursiveSortObjectKeys<T>(obj: T): T {
   if (Array.isArray(obj)) {
     return obj.map(recursiveSortObjectKeys) as T;

package/src/utils/_format.ts

@@ -173,7 +173,7 @@ const StringMath = {
   },
 };
 
-function formatDecimalString(value: string): string {
+export function formatDecimalString(value: string): string {
   return value
     // remove leading/trailing whitespace
     .trim() // "  123.45  " → "123.45"

package/src/utils/mod.ts

@@ -24,4 +24,4 @@
  */
 
 export * from "./_symbolConverter.js";
-export * from "./_format.js";
+export { formatPrice, formatSize } from "./_format.js";