@nktkas/hyperliquid 0.25.1 → 0.25.3

package/src/src/api/info/~client.ts

@@ -1,8 +1,9 @@
-import type { OmitFirst, OverloadedParameters } from "../_common.js";
+import type { OmitFirst, OverloadedParameters } from "../_base.js";
 import type { IRequestTransport } from "../../transport/base.js";
-import type { InfoRequestConfig } from "./_common.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 import { activeAssetData } from "./activeAssetData.js";
+import { alignedQuoteTokenInfo } from "./alignedQuoteTokenInfo.js";
 import { allMids } from "./allMids.js";
 import { blockDetails } from "./blockDetails.js";
 import { candleSnapshot } from "./candleSnapshot.js";
@@ -66,6 +67,7 @@ import { vaultSummaries } from "./vaultSummaries.js";
 import { webData2 } from "./webData2.js";
 
 export type { ActiveAssetDataParameters, ActiveAssetDataResponse } from "./activeAssetData.js";
+export type { AlignedQuoteTokenInfoParameters, AlignedQuoteTokenInfoResponse } from "./alignedQuoteTokenInfo.js";
 export type { AllMidsParameters, AllMidsResponse } from "./allMids.js";
 export type { BlockDetailsParameters, BlockDetailsResponse } from "./blockDetails.js";
 export type { CandleSnapshotParameters, CandleSnapshotResponse } from "./candleSnapshot.js";
@@ -180,6 +182,29 @@ export class InfoClient<T extends IRequestTransport = IRequestTransport> impleme
     return activeAssetData(this, ...args);
   }
 
+  /**
+   * Request supply, rate, and pending payment information for an aligned quote token.
+   * @param params - Parameters specific to the API request.
+   * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+   * @returns Supply, rate, and pending payment information for an aligned quote token.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @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.alignedQuoteTokenInfo({ token: 1328 });
+   * ```
+   */
+  alignedQuoteTokenInfo(...args: OmitFirst<OverloadedParameters<typeof alignedQuoteTokenInfo>>) {
+    return alignedQuoteTokenInfo(this, ...args);
+  }
+
   /**
    * Request mid coin prices.
    * @param params - Parameters specific to the API request.

package/src/src/api/info/~mod.ts

@@ -21,10 +21,11 @@
  * @module
  */
 
-export { parser, SchemaError } from "../_common.js";
-export type { InfoRequestConfig } from "./_common.js";
+export { parser, SchemaError } from "../_base.js";
+export type { InfoRequestConfig } from "./_base.js";
 
 export * from "./activeAssetData.js";
+export * from "./alignedQuoteTokenInfo.js";
 export * from "./allMids.js";
 export * from "./blockDetails.js";
 export * from "./candleSnapshot.js";

package/src/src/api/subscription/activeAssetCtx.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/activeAssetData.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { ActiveAssetDataResponse } from "../info/activeAssetData.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to active asset data events for a specific user and coin. */
@@ -32,73 +34,7 @@ export type ActiveAssetDataRequest = v.InferOutput<typeof ActiveAssetDataRequest
 
 /** Event of user active asset data. */
 export const ActiveAssetDataEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Asset symbol (e.g., BTC). */
-      coin: v.pipe(
-        v.string(),
-        v.description("Asset symbol (e.g., BTC)."),
-      ),
-      /** Leverage configuration. */
-      leverage: v.pipe(
-        v.union([
-          v.object({
-            /** Leverage type. */
-            type: v.pipe(
-              v.literal("isolated"),
-              v.description("Leverage type."),
-            ),
-            /** Leverage value used. */
-            value: v.pipe(
-              UnsignedInteger,
-              v.minValue(1),
-              v.description("Leverage value used."),
-            ),
-            /** Amount of USD used (1 = 1$). */
-            rawUsd: v.pipe(
-              UnsignedDecimal,
-              v.description("Amount of USD used (1 = 1$)."),
-            ),
-          }),
-          v.object({
-            /** Leverage type. */
-            type: v.pipe(
-              v.literal("cross"),
-              v.description("Leverage type."),
-            ),
-            /** Leverage value used. */
-            value: v.pipe(
-              UnsignedInteger,
-              v.minValue(1),
-              v.description("Leverage value used."),
-            ),
-          }),
-        ]),
-        v.description("Leverage configuration."),
-      ),
-      /** Maximum trade size range [min, max]. */
-      maxTradeSzs: v.pipe(
-        v.tuple([UnsignedDecimal, UnsignedDecimal]),
-        v.description("Maximum trade size range [min, max]."),
-      ),
-      /** Available to trade range [min, max]. */
-      availableToTrade: v.pipe(
-        v.tuple([UnsignedDecimal, UnsignedDecimal]),
-        v.description("Available to trade range [min, max]."),
-      ),
-      /** Mark price. */
-      markPx: v.pipe(
-        UnsignedDecimal,
-        v.description("Mark price."),
-      ),
-    }),
-    v.description("Event of user active asset data."),
-  );
+  return ActiveAssetDataResponse;
 })();
 export type ActiveAssetDataEvent = v.InferOutput<typeof ActiveAssetDataEvent>;
 
@@ -138,7 +74,7 @@ export function activeAssetData(
 ): Promise<Subscription> {
   const payload = parser(ActiveAssetDataRequest)({ type: "activeAssetData", ...params });
   return config.transport.subscribe<ActiveAssetDataEvent>(payload.type, payload, (e) => {
-    if (e.detail.coin === payload.coin && e.detail.user === payload.user.toLowerCase()) {
+    if (e.detail.coin === payload.coin && e.detail.user === payload.user) {
       listener(e.detail);
     }
   });

package/src/src/api/subscription/activeSpotAssetCtx.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/allMids.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/assetCtxs.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/bbo.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { L2BookLevelSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to best bid and offer events for a specific asset. */
@@ -25,30 +27,6 @@ export const BboRequest = /* @__PURE__ */ (() => {
 })();
 export type BboRequest = v.InferOutput<typeof BboRequest>;
 
-/** L2 order book level. */
-const L2BookLevel = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Price. */
-      px: v.pipe(
-        UnsignedDecimal,
-        v.description("Price."),
-      ),
-      /** Total size. */
-      sz: v.pipe(
-        UnsignedDecimal,
-        v.description("Total size."),
-      ),
-      /** Number of individual orders. */
-      n: v.pipe(
-        UnsignedInteger,
-        v.description("Number of individual orders."),
-      ),
-    }),
-    v.description("L2 order book level."),
-  );
-})();
-
 /** Event of best bid and offer. */
 export const BboEvent = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -65,7 +43,7 @@ export const BboEvent = /* @__PURE__ */ (() => {
       ),
       /** Best bid and offer tuple [bid, offer], either can be undefined if unavailable. */
       bbo: v.pipe(
-        v.tuple([L2BookLevel, L2BookLevel]),
+        v.tuple([L2BookLevelSchema, L2BookLevelSchema]),
         v.description("Best bid and offer tuple [bid, offer], either can be undefined if unavailable."),
       ),
     }),

package/src/src/api/subscription/candle.ts

@@ -1,8 +1,11 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { CandleIntervalSchema } from "../_common_schemas.js";
+import { CandleSnapshotResponse } from "../info/candleSnapshot.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to candlestick events for a specific asset and time interval. */
@@ -20,25 +23,7 @@ export const CandleRequest = /* @__PURE__ */ (() => {
         v.description("Asset symbol (e.g., BTC)."),
       ),
       /** Time interval. */
-      interval: v.pipe(
-        v.union([
-          v.literal("1m"),
-          v.literal("3m"),
-          v.literal("5m"),
-          v.literal("15m"),
-          v.literal("30m"),
-          v.literal("1h"),
-          v.literal("2h"),
-          v.literal("4h"),
-          v.literal("8h"),
-          v.literal("12h"),
-          v.literal("1d"),
-          v.literal("3d"),
-          v.literal("1w"),
-          v.literal("1M"),
-        ]),
-        v.description("Time interval."),
-      ),
+      interval: CandleIntervalSchema,
     }),
     v.description("Subscription to candlestick events for a specific asset and time interval."),
   );
@@ -47,76 +32,7 @@ export type CandleRequest = v.InferOutput<typeof CandleRequest>;
 
 /** Event of candlestick data point. */
 export const CandleEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Opening timestamp (ms since epoch). */
-      t: v.pipe(
-        UnsignedInteger,
-        v.description("Opening timestamp (ms since epoch)."),
-      ),
-      /** Closing timestamp (ms since epoch). */
-      T: v.pipe(
-        UnsignedInteger,
-        v.description("Closing timestamp (ms since epoch)."),
-      ),
-      /** Asset symbol. */
-      s: v.pipe(
-        v.string(),
-        v.description("Asset symbol."),
-      ),
-      /** Candle interval. */
-      i: v.pipe(
-        v.union([
-          v.literal("1m"),
-          v.literal("3m"),
-          v.literal("5m"),
-          v.literal("15m"),
-          v.literal("30m"),
-          v.literal("1h"),
-          v.literal("2h"),
-          v.literal("4h"),
-          v.literal("8h"),
-          v.literal("12h"),
-          v.literal("1d"),
-          v.literal("3d"),
-          v.literal("1w"),
-          v.literal("1M"),
-        ]),
-        v.description("Candle interval."),
-      ),
-      /** Opening price. */
-      o: v.pipe(
-        UnsignedDecimal,
-        v.description("Opening price."),
-      ),
-      /** Closing price. */
-      c: v.pipe(
-        UnsignedDecimal,
-        v.description("Closing price."),
-      ),
-      /** Highest price. */
-      h: v.pipe(
-        UnsignedDecimal,
-        v.description("Highest price."),
-      ),
-      /** Lowest price. */
-      l: v.pipe(
-        UnsignedDecimal,
-        v.description("Lowest price."),
-      ),
-      /** Total volume traded in base currency. */
-      v: v.pipe(
-        UnsignedDecimal,
-        v.description("Total volume traded in base currency."),
-      ),
-      /** Number of trades executed. */
-      n: v.pipe(
-        UnsignedInteger,
-        v.description("Number of trades executed."),
-      ),
-    }),
-    v.description("Event of candlestick data point."),
-  );
+  return CandleSnapshotResponse.item;
 })();
 export type CandleEvent = v.InferOutput<typeof CandleEvent>;
 

package/src/src/api/subscription/clearinghouseState.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, Decimal, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { ClearinghouseStateResponse } from "../info/clearinghouseState.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to clearinghouse state events for a specific user. */
@@ -45,205 +47,7 @@ export const ClearinghouseStateEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Account summary for perpetual trading. */
-      clearinghouseState: v.pipe(
-        v.object({
-          /** Margin summary details. */
-          marginSummary: v.pipe(
-            v.object({
-              /** Total account value. */
-              accountValue: v.pipe(
-                UnsignedDecimal,
-                v.description("Total account value."),
-              ),
-              /** Total notional position value. */
-              totalNtlPos: v.pipe(
-                UnsignedDecimal,
-                v.description("Total notional position value."),
-              ),
-              /** Total raw USD value. */
-              totalRawUsd: v.pipe(
-                UnsignedDecimal,
-                v.description("Total raw USD value."),
-              ),
-              /** Total margin used. */
-              totalMarginUsed: v.pipe(
-                UnsignedDecimal,
-                v.description("Total margin used."),
-              ),
-            }),
-            v.description("Margin summary details."),
-          ),
-          /** Cross-margin summary details. */
-          crossMarginSummary: v.pipe(
-            v.object({
-              /** Total account value. */
-              accountValue: v.pipe(
-                UnsignedDecimal,
-                v.description("Total account value."),
-              ),
-              /** Total notional position value. */
-              totalNtlPos: v.pipe(
-                UnsignedDecimal,
-                v.description("Total notional position value."),
-              ),
-              /** Total raw USD value. */
-              totalRawUsd: v.pipe(
-                UnsignedDecimal,
-                v.description("Total raw USD value."),
-              ),
-              /** Total margin used. */
-              totalMarginUsed: v.pipe(
-                UnsignedDecimal,
-                v.description("Total margin used."),
-              ),
-            }),
-            v.description("Cross-margin summary details."),
-          ),
-          /** Maintenance margin used for cross-margin positions. */
-          crossMaintenanceMarginUsed: v.pipe(
-            UnsignedDecimal,
-            v.description("Maintenance margin used for cross-margin positions."),
-          ),
-          /** Amount available for withdrawal. */
-          withdrawable: v.pipe(
-            UnsignedDecimal,
-            v.description("Amount available for withdrawal."),
-          ),
-          /** Array of asset positions. */
-          assetPositions: v.pipe(
-            v.array(
-              /** Position for a specific asset. */
-              v.pipe(
-                v.object({
-                  /** Position type. */
-                  type: v.pipe(
-                    v.literal("oneWay"),
-                    v.description("Position type."),
-                  ),
-                  /** Position details. */
-                  position: v.pipe(
-                    v.object({
-                      /** Asset symbol. */
-                      coin: v.pipe(
-                        v.string(),
-                        v.description("Asset symbol."),
-                      ),
-                      /** Signed position size. */
-                      szi: v.pipe(
-                        Decimal,
-                        v.description("Signed position size."),
-                      ),
-                      /** Leverage details. */
-                      leverage: v.pipe(
-                        v.union([
-                          v.object({
-                            /** Leverage type. */
-                            type: v.pipe(
-                              v.literal("isolated"),
-                              v.description("Leverage type."),
-                            ),
-                            /** Leverage value used. */
-                            value: v.pipe(
-                              UnsignedInteger,
-                              v.minValue(1),
-                              v.description("Leverage value used."),
-                            ),
-                            /** Amount of USD used (1 = 1$). */
-                            rawUsd: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Amount of USD used (1 = 1$)."),
-                            ),
-                          }),
-                          v.object({
-                            /** Leverage type. */
-                            type: v.pipe(
-                              v.literal("cross"),
-                              v.description("Leverage type."),
-                            ),
-                            /** Leverage value used. */
-                            value: v.pipe(
-                              UnsignedInteger,
-                              v.minValue(1),
-                              v.description("Leverage value used."),
-                            ),
-                          }),
-                        ]),
-                        v.description("Leverage details."),
-                      ),
-                      /** Average entry price. */
-                      entryPx: v.pipe(
-                        UnsignedDecimal,
-                        v.description("Average entry price."),
-                      ),
-                      /** Position value. */
-                      positionValue: v.pipe(
-                        UnsignedDecimal,
-                        v.description("Position value."),
-                      ),
-                      /** Unrealized profit and loss. */
-                      unrealizedPnl: v.pipe(
-                        Decimal,
-                        v.description("Unrealized profit and loss."),
-                      ),
-                      /** Return on equity. */
-                      returnOnEquity: v.pipe(
-                        Decimal,
-                        v.description("Return on equity."),
-                      ),
-                      /** Liquidation price. */
-                      liquidationPx: v.pipe(
-                        v.union([UnsignedDecimal, v.null()]),
-                        v.description("Liquidation price."),
-                      ),
-                      /** Margin used. */
-                      marginUsed: v.pipe(
-                        UnsignedDecimal,
-                        v.description("Margin used."),
-                      ),
-                      /** Maximum allowed leverage. */
-                      maxLeverage: v.pipe(
-                        UnsignedInteger,
-                        v.minValue(1),
-                        v.description("Maximum allowed leverage."),
-                      ),
-                      /** Cumulative funding details. */
-                      cumFunding: v.pipe(
-                        v.object({
-                          /** Total funding paid or received since account opening. */
-                          allTime: v.pipe(
-                            Decimal,
-                            v.description("Total funding paid or received since account opening."),
-                          ),
-                          /** Funding accumulated since the position was opened. */
-                          sinceOpen: v.pipe(
-                            Decimal,
-                            v.description("Funding accumulated since the position was opened."),
-                          ),
-                          /** Funding accumulated since the last change in position size. */
-                          sinceChange: v.pipe(
-                            Decimal,
-                            v.description("Funding accumulated since the last change in position size."),
-                          ),
-                        }),
-                        v.description("Cumulative funding details."),
-                      ),
-                    }),
-                    v.description("Position details."),
-                  ),
-                }),
-                v.description("Position for a specific asset."),
-              ),
-            ),
-            v.description("Array of asset positions."),
-          ),
-          /** Timestamp when data was retrieved (in ms since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Timestamp when data was retrieved (in ms since epoch)."),
-          ),
-        }),
-        v.description("Account summary for perpetual trading."),
-      ),
+      clearinghouseState: ClearinghouseStateResponse,
     }),
     v.description("Event of clearinghouse state for a specific user."),
   );
@@ -290,7 +94,7 @@ export function clearinghouseState(
     dex: params.dex ?? "", // same value as in response
   });
   return config.transport.subscribe<ClearinghouseStateEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user.toLowerCase() && e.detail.dex === payload.dex) {
+    if (e.detail.user === payload.user && e.detail.dex === payload.dex) {
       listener(e.detail);
     }
   });

package/src/src/api/subscription/explorerBlock.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, Hex, parser, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, Hex, parser, UnsignedInteger } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/explorerTxs.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, Hex, parser, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, Hex, parser, UnsignedInteger } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------