@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.0-hfunlabs.1

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

@@ -2,7 +2,7 @@
  * This module re-exports all info-related API request functions and types.
  *
  * You can use raw functions to maximize tree-shaking in your app,
- * or to access [valibot](https://github.com/fabian-hiller/valibot) schemas Request/Response.
+ * or to access {@link https://github.com/fabian-hiller/valibot | valibot} schemas Request/Response.
  *
  * @example
  * ```ts
@@ -22,13 +22,15 @@
  * @module
  */
 
-export type { InfoConfig } from "./_methods/_types.js";
+export type { InfoConfig } from "./_methods/_base/types.js";
 
 export * from "./_methods/activeAssetData.js";
 export * from "./_methods/alignedQuoteTokenInfo.js";
+export * from "./_methods/allBorrowLendReserveStates.js";
 export * from "./_methods/allMids.js";
 export * from "./_methods/allPerpMetas.js";
 export * from "./_methods/blockDetails.js";
+export * from "./_methods/borrowLendUserState.js";
 export * from "./_methods/candleSnapshot.js";
 export * from "./_methods/clearinghouseState.js";
 export * from "./_methods/delegations.js";

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

@@ -1,7 +1,7 @@
-import type { WebSocketTransport } from "../../../transport/websocket/mod.js";
+import type { ISubscriptionTransport } from "../../../transport/mod.js";
 
 /** Configuration for subscription API requests. */
-export interface SubscriptionConfig<T extends WebSocketTransport = WebSocketTransport> {
+export interface SubscriptionConfig<T extends ISubscriptionTransport = ISubscriptionTransport> {
   /** The transport used to connect to the Hyperliquid API. */
   transport: T;
 }

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

@@ -4,7 +4,7 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Decimal, UnsignedDecimal } from "../../_schemas.js";
+import { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
 
 /** Subscription to context events for a specific perpetual asset. */
 export const ActiveAssetCtxRequest = /* @__PURE__ */ (() => {
@@ -37,58 +37,7 @@ export const ActiveAssetCtxEvent = /* @__PURE__ */ (() => {
       ),
       /** Context for a specific perpetual asset. */
       ctx: v.pipe(
-        v.object({
-          /** Previous day's closing price. */
-          prevDayPx: v.pipe(
-            UnsignedDecimal,
-            v.description("Previous day's closing price."),
-          ),
-          /** Daily notional volume. */
-          dayNtlVlm: v.pipe(
-            UnsignedDecimal,
-            v.description("Daily notional volume."),
-          ),
-          /** Mark price. */
-          markPx: v.pipe(
-            UnsignedDecimal,
-            v.description("Mark price."),
-          ),
-          /** Mid price. */
-          midPx: v.pipe(
-            v.nullable(UnsignedDecimal),
-            v.description("Mid price."),
-          ),
-          /** Funding rate. */
-          funding: v.pipe(
-            Decimal,
-            v.description("Funding rate."),
-          ),
-          /** Total open interest. */
-          openInterest: v.pipe(
-            UnsignedDecimal,
-            v.description("Total open interest."),
-          ),
-          /** Premium price. */
-          premium: v.pipe(
-            v.nullable(Decimal),
-            v.description("Premium price."),
-          ),
-          /** Oracle price. */
-          oraclePx: v.pipe(
-            UnsignedDecimal,
-            v.description("Oracle price."),
-          ),
-          /** Array of impact prices. */
-          impactPxs: v.pipe(
-            v.nullable(v.array(v.string())),
-            v.description("Array of impact prices."),
-          ),
-          /** Daily volume in base currency. */
-          dayBaseVlm: v.pipe(
-            UnsignedDecimal,
-            v.description("Daily volume in base currency."),
-          ),
-        }),
+        PerpAssetCtxSchema,
         v.description("Context for a specific perpetual asset."),
       ),
     }),
@@ -102,7 +51,7 @@ export type ActiveAssetCtxEvent = v.InferOutput<typeof ActiveAssetCtxEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode activeAssetCtx} function. */
 export type ActiveAssetCtxParameters = Omit<v.InferInput<typeof ActiveAssetCtxRequest>, "type">;
@@ -114,7 +63,7 @@ export type ActiveAssetCtxParameters = Omit<v.InferInput<typeof ActiveAssetCtxRe
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -139,7 +88,7 @@ export function activeAssetCtx(
   config: SubscriptionConfig,
   params: ActiveAssetCtxParameters,
   listener: (data: ActiveAssetCtxEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(ActiveAssetCtxRequest, { type: "activeAssetCtx", ...params });
   return config.transport.subscribe<ActiveAssetCtxEvent>(payload.type, payload, (e) => {
     if (e.detail.coin === payload.coin) {

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

@@ -46,7 +46,7 @@ export type ActiveAssetDataEvent = v.InferOutput<typeof ActiveAssetDataEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode activeAssetData} function. */
 export type ActiveAssetDataParameters = Omit<v.InferInput<typeof ActiveAssetDataRequest>, "type">;
@@ -58,7 +58,7 @@ export type ActiveAssetDataParameters = Omit<v.InferInput<typeof ActiveAssetData
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -83,7 +83,7 @@ export function activeAssetData(
   config: SubscriptionConfig,
   params: ActiveAssetDataParameters,
   listener: (data: ActiveAssetDataEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(ActiveAssetDataRequest, { type: "activeAssetData", ...params });
   return config.transport.subscribe<ActiveAssetDataEvent>(payload.type, payload, (e) => {
     if (e.detail.coin === payload.coin && e.detail.user === payload.user) {

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

@@ -4,7 +4,7 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { UnsignedDecimal } from "../../_schemas.js";
+import { SpotAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
 
 /** Subscription to context events for a specific spot asset. */
 export const ActiveSpotAssetCtxRequest = /* @__PURE__ */ (() => {
@@ -37,48 +37,7 @@ export const ActiveSpotAssetCtxEvent = /* @__PURE__ */ (() => {
       ),
       /** Context for a specific spot asset. */
       ctx: v.pipe(
-        v.object({
-          /** Previous day's closing price. */
-          prevDayPx: v.pipe(
-            UnsignedDecimal,
-            v.description("Previous day's closing price."),
-          ),
-          /** Daily notional volume. */
-          dayNtlVlm: v.pipe(
-            UnsignedDecimal,
-            v.description("Daily notional volume."),
-          ),
-          /** Mark price. */
-          markPx: v.pipe(
-            UnsignedDecimal,
-            v.description("Mark price."),
-          ),
-          /** Mid price. */
-          midPx: v.pipe(
-            v.nullable(UnsignedDecimal),
-            v.description("Mid price."),
-          ),
-          /** Circulating supply. */
-          circulatingSupply: v.pipe(
-            UnsignedDecimal,
-            v.description("Circulating supply."),
-          ),
-          /** Asset symbol. */
-          coin: v.pipe(
-            v.string(),
-            v.description("Asset symbol."),
-          ),
-          /** Total supply. */
-          totalSupply: v.pipe(
-            UnsignedDecimal,
-            v.description("Total supply."),
-          ),
-          /** Daily volume in base currency. */
-          dayBaseVlm: v.pipe(
-            UnsignedDecimal,
-            v.description("Daily volume in base currency."),
-          ),
-        }),
+        SpotAssetCtxSchema,
         v.description("Context for a specific spot asset."),
       ),
     }),
@@ -92,7 +51,7 @@ export type ActiveSpotAssetCtxEvent = v.InferOutput<typeof ActiveSpotAssetCtxEve
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode activeSpotAssetCtx} function. */
 export type ActiveSpotAssetCtxParameters = Omit<v.InferInput<typeof ActiveSpotAssetCtxRequest>, "type">;
@@ -103,7 +62,7 @@ export type ActiveSpotAssetCtxParameters = Omit<v.InferInput<typeof ActiveSpotAs
  * @param config - General configuration for Subscription API subscriptions.
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -128,7 +87,7 @@ export function activeSpotAssetCtx(
   config: SubscriptionConfig,
   params: ActiveSpotAssetCtxParameters,
   listener: (data: ActiveSpotAssetCtxEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(ActiveSpotAssetCtxRequest, { type: "activeAssetCtx", ...params });
   return config.transport.subscribe<ActiveSpotAssetCtxEvent>("activeSpotAssetCtx", payload, (e) => {
     if (e.detail.coin === payload.coin) {

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

@@ -4,7 +4,7 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Decimal, UnsignedDecimal } from "../../_schemas.js";
+import { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
 
 /** Subscription to asset context events for all DEXs. */
 export const AllDexsAssetCtxsRequest = /* @__PURE__ */ (() => {
@@ -30,60 +30,7 @@ export const AllDexsAssetCtxsEvent = /* @__PURE__ */ (() => {
         v.array(
           v.tuple([
             v.string(),
-            v.array(
-              v.object({
-                /** Previous day's closing price. */
-                prevDayPx: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Previous day's closing price."),
-                ),
-                /** Daily notional volume. */
-                dayNtlVlm: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Daily notional volume."),
-                ),
-                /** Mark price. */
-                markPx: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Mark price."),
-                ),
-                /** Mid price. */
-                midPx: v.pipe(
-                  v.nullable(UnsignedDecimal),
-                  v.description("Mid price."),
-                ),
-                /** Funding rate. */
-                funding: v.pipe(
-                  Decimal,
-                  v.description("Funding rate."),
-                ),
-                /** Total open interest. */
-                openInterest: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Total open interest."),
-                ),
-                /** Premium price. */
-                premium: v.pipe(
-                  v.nullable(Decimal),
-                  v.description("Premium price."),
-                ),
-                /** Oracle price. */
-                oraclePx: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Oracle price."),
-                ),
-                /** Array of impact prices. */
-                impactPxs: v.pipe(
-                  v.nullable(v.array(v.string())),
-                  v.description("Array of impact prices."),
-                ),
-                /** Daily volume in base currency. */
-                dayBaseVlm: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Daily volume in base currency."),
-                ),
-              }),
-            ),
+            v.array(PerpAssetCtxSchema),
           ]),
         ),
         v.description("Array of tuples of dex names and contexts for each perpetual asset."),
@@ -99,7 +46,7 @@ export type AllDexsAssetCtxsEvent = v.InferOutput<typeof AllDexsAssetCtxsEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /**
  * Subscribe to asset contexts for all DEXs.
@@ -107,7 +54,7 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
  * @param config - General configuration for Subscription API subscriptions.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -130,7 +77,7 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
 export function allDexsAssetCtxs(
   config: SubscriptionConfig,
   listener: (data: AllDexsAssetCtxsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(AllDexsAssetCtxsRequest, {
     type: "allDexsAssetCtxs",
   });

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

@@ -57,7 +57,7 @@ export type AllDexsClearinghouseStateEvent = v.InferOutput<typeof AllDexsClearin
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode allDexsClearinghouseState} function. */
 export type AllDexsClearinghouseStateParameters = Omit<v.InferInput<typeof AllDexsClearinghouseStateRequest>, "type">;
@@ -69,7 +69,7 @@ export type AllDexsClearinghouseStateParameters = Omit<v.InferInput<typeof AllDe
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -94,7 +94,7 @@ export function allDexsClearinghouseState(
   config: SubscriptionConfig,
   params: AllDexsClearinghouseStateParameters,
   listener: (data: AllDexsClearinghouseStateEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(AllDexsClearinghouseStateRequest, {
     type: "allDexsClearinghouseState",
     ...params,

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

@@ -31,8 +31,11 @@ export const AllMidsEvent = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** Mapping of coin symbols to mid prices. */
-      mids: AllMidsResponse,
-      /** DEX name (undefined for main dex). */
+      mids: v.pipe(
+        AllMidsResponse,
+        v.description("Mapping of coin symbols to mid prices."),
+      ),
+      /** DEX name (empty string for main dex). */
       dex: v.pipe(
         v.optional(v.string()),
         v.description("DEX name (empty string for main dex)."),
@@ -48,7 +51,7 @@ export type AllMidsEvent = v.InferOutput<typeof AllMidsEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode allMids} function. */
 export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
@@ -60,7 +63,7 @@ export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type"
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -83,17 +86,17 @@ export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type"
 export function allMids(
   config: SubscriptionConfig,
   listener: (data: AllMidsEvent) => void,
-): Promise<WebSocketSubscription>;
+): Promise<ISubscription>;
 export function allMids(
   config: SubscriptionConfig,
   params: AllMidsParameters,
   listener: (data: AllMidsEvent) => void,
-): Promise<WebSocketSubscription>;
+): Promise<ISubscription>;
 export function allMids(
   config: SubscriptionConfig,
   paramsOrListener: AllMidsParameters | ((data: AllMidsEvent) => void),
   maybeListener?: (data: AllMidsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
   const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;
 

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

@@ -4,7 +4,7 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Decimal, UnsignedDecimal } from "../../_schemas.js";
+import { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
 
 /** Subscription to context events for all perpetual assets. */
 export const AssetCtxsRequest = /* @__PURE__ */ (() => {
@@ -37,64 +37,7 @@ export const AssetCtxsEvent = /* @__PURE__ */ (() => {
       ),
       /** Array of context information for each perpetual asset. */
       ctxs: v.pipe(
-        v.array(
-          /** Context for a specific perpetual asset. */
-          v.pipe(
-            v.object({
-              /** Previous day's closing price. */
-              prevDayPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Previous day's closing price."),
-              ),
-              /** Daily notional volume. */
-              dayNtlVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily notional volume."),
-              ),
-              /** Mark price. */
-              markPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Mark price."),
-              ),
-              /** Mid price. */
-              midPx: v.pipe(
-                v.nullable(UnsignedDecimal),
-                v.description("Mid price."),
-              ),
-              /** Funding rate. */
-              funding: v.pipe(
-                Decimal,
-                v.description("Funding rate."),
-              ),
-              /** Total open interest. */
-              openInterest: v.pipe(
-                UnsignedDecimal,
-                v.description("Total open interest."),
-              ),
-              /** Premium price. */
-              premium: v.pipe(
-                v.nullable(Decimal),
-                v.description("Premium price."),
-              ),
-              /** Oracle price. */
-              oraclePx: v.pipe(
-                UnsignedDecimal,
-                v.description("Oracle price."),
-              ),
-              /** Array of impact prices. */
-              impactPxs: v.pipe(
-                v.nullable(v.array(v.string())),
-                v.description("Array of impact prices."),
-              ),
-              /** Daily volume in base currency. */
-              dayBaseVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily volume in base currency."),
-              ),
-            }),
-            v.description("Context for a specific perpetual asset."),
-          ),
-        ),
+        v.array(PerpAssetCtxSchema),
         v.description("Array of context information for each perpetual asset."),
       ),
     }),
@@ -108,7 +51,7 @@ export type AssetCtxsEvent = v.InferOutput<typeof AssetCtxsEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode assetCtxs} function. */
 export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "type">;
@@ -120,7 +63,7 @@ export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "t
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -141,17 +84,17 @@ export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "t
 export function assetCtxs(
   config: SubscriptionConfig,
   listener: (data: AssetCtxsEvent) => void,
-): Promise<WebSocketSubscription>;
+): Promise<ISubscription>;
 export function assetCtxs(
   config: SubscriptionConfig,
   params: AssetCtxsParameters,
   listener: (data: AssetCtxsEvent) => void,
-): Promise<WebSocketSubscription>;
+): Promise<ISubscription>;
 export function assetCtxs(
   config: SubscriptionConfig,
   paramsOrListener: AssetCtxsParameters | ((data: AssetCtxsEvent) => void),
   maybeListener?: (data: AssetCtxsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
   const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;
 

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

@@ -26,7 +26,7 @@ export const BboRequest = /* @__PURE__ */ (() => {
 })();
 export type BboRequest = v.InferOutput<typeof BboRequest>;
 
-const L2BookLevel = /* @__PURE__ */ (() => {
+const L2BookLevelSchema = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** Price. */
@@ -65,7 +65,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."),
       ),
     }),
@@ -79,7 +79,7 @@ export type BboEvent = v.InferOutput<typeof BboEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode bbo} function. */
 export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
@@ -91,7 +91,7 @@ export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -116,7 +116,7 @@ export function bbo(
   config: SubscriptionConfig,
   params: BboParameters,
   listener: (data: BboEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(BboRequest, { type: "bbo", ...params });
   return config.transport.subscribe<BboEvent>(payload.type, payload, (e) => {
     if (e.detail.coin === payload.coin) {

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

@@ -96,7 +96,7 @@ export type CandleEvent = v.InferOutput<typeof CandleEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode candle} function. */
 export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
@@ -108,7 +108,7 @@ export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -133,7 +133,7 @@ export function candle(
   config: SubscriptionConfig,
   params: CandleParameters,
   listener: (data: CandleEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(CandleRequest, { type: "candle", ...params });
   return config.transport.subscribe<CandleEvent>(payload.type, payload, (e) => {
     if (e.detail.s === payload.coin && e.detail.i === payload.interval) {

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

@@ -47,7 +47,10 @@ export const ClearinghouseStateEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Account summary for perpetual trading. */
-      clearinghouseState: ClearinghouseStateResponse,
+      clearinghouseState: v.pipe(
+        ClearinghouseStateResponse,
+        v.description("Account summary for perpetual trading."),
+      ),
     }),
     v.description("Event of clearinghouse state for a specific user."),
   );
@@ -59,7 +62,7 @@ export type ClearinghouseStateEvent = v.InferOutput<typeof ClearinghouseStateEve
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /** Request parameters for the {@linkcode clearinghouseState} function. */
 export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
@@ -71,7 +74,7 @@ export type ClearinghouseStateParameters = Omit<v.InferInput<typeof Clearinghous
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -94,7 +97,7 @@ export function clearinghouseState(
   config: SubscriptionConfig,
   params: ClearinghouseStateParameters,
   listener: (data: ClearinghouseStateEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(ClearinghouseStateRequest, {
     type: "clearinghouseState",
     ...params,