@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.2-hfunlabs.2

package/src/src/api/subscription/_methods/spotAssetCtxs.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 all spot assets. */
 export const SpotAssetCtxsRequest = /* @__PURE__ */ (() => {
@@ -24,50 +24,7 @@ export type SpotAssetCtxsRequest = v.InferOutput<typeof SpotAssetCtxsRequest>;
 /** Event of spot asset contexts. */
 export const SpotAssetCtxsEvent = /* @__PURE__ */ (() => {
   return v.pipe(
-    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."),
-        ),
-        /** 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."),
-        ),
-      }),
-    ),
+    v.array(SpotAssetCtxSchema),
     v.description("Event of spot asset contexts."),
   );
 })();
@@ -78,7 +35,7 @@ export type SpotAssetCtxsEvent = v.InferOutput<typeof SpotAssetCtxsEvent>;
 // ============================================================
 
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 
 /**
  * Subscribe to context updates for all spot assets.
@@ -87,7 +44,7 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
  * @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.
@@ -110,7 +67,7 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
 export function spotAssetCtxs(
   config: SubscriptionConfig,
   listener: (data: SpotAssetCtxsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(SpotAssetCtxsRequest, { type: "spotAssetCtxs" });
   return config.transport.subscribe<SpotAssetCtxsEvent>(payload.type, payload, (e) => {
     listener(e.detail);

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

@@ -42,7 +42,10 @@ export const SpotStateEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Account summary for spot trading. */
-      spotState: SpotClearinghouseStateResponse,
+      spotState: v.pipe(
+        SpotClearinghouseStateResponse,
+        v.description("Account summary for spot trading."),
+      ),
     }),
     v.description("Event of user spot state."),
   );
@@ -54,7 +57,7 @@ export type SpotStateEvent = v.InferOutput<typeof SpotStateEvent>;
 // ============================================================
 
 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 spotState} function. */
 export type SpotStateParameters = Omit<v.InferInput<typeof SpotStateRequest>, "type">;
@@ -66,7 +69,7 @@ export type SpotStateParameters = Omit<v.InferInput<typeof SpotStateRequest>, "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.
@@ -91,7 +94,7 @@ export function spotState(
   config: SubscriptionConfig,
   params: SpotStateParameters,
   listener: (data: SpotStateEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(SpotStateRequest, { type: "spotState", user: params.user });
   return config.transport.subscribe<SpotStateEvent>(payload.type, payload, (e) => {
     if (e.detail.user === payload.user) {

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

@@ -40,7 +40,7 @@ export type TradesEvent = v.InferOutput<typeof TradesEvent>;
 // ============================================================
 
 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 trades} function. */
 export type TradesParameters = Omit<v.InferInput<typeof TradesRequest>, "type">;
@@ -52,7 +52,7 @@ export type TradesParameters = Omit<v.InferInput<typeof TradesRequest>, "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.
@@ -77,7 +77,7 @@ export function trades(
   config: SubscriptionConfig,
   params: TradesParameters,
   listener: (data: TradesEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(TradesRequest, { type: "trades", ...params });
   return config.transport.subscribe<TradesEvent>(payload.type, payload, (e) => {
     if (e.detail[0]?.coin === payload.coin) {

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

@@ -0,0 +1,113 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedInteger } from "../../_schemas.js";
+import { TwapStateSchema } from "../../info/_methods/_base/commonSchemas.js";
+
+/** Subscribe to TWAP states updates for a specific user. */
+export const TwapStatesRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of subscription. */
+      type: v.pipe(
+        v.literal("twapStates"),
+        v.description("Type of subscription."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** DEX name (empty string for main dex). */
+      dex: v.pipe(
+        v.optional(v.string()),
+        v.description("DEX name (empty string for main dex)."),
+      ),
+    }),
+    v.description("Subscribe to TWAP states updates for a specific user."),
+  );
+})();
+export type TwapStatesRequest = v.InferOutput<typeof TwapStatesRequest>;
+
+/** Event of user TWAP states. */
+export const TwapStatesEvent = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** DEX name (empty string for main dex). */
+      dex: v.pipe(
+        v.string(),
+        v.description("DEX name (empty string for main dex)."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** Array of tuples of TWAP ID and TWAP state. */
+      states: v.pipe(
+        v.array(v.tuple([UnsignedInteger, TwapStateSchema])),
+        v.description("Array of tuples of TWAP ID and TWAP state."),
+      ),
+    }),
+    v.description("Event of user TWAP states."),
+  );
+})();
+export type TwapStatesEvent = v.InferOutput<typeof TwapStatesEvent>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import type { SubscriptionConfig } from "./_types.js";
+import type { ISubscription } from "../../../transport/mod.js";
+
+/** Request parameters for the {@linkcode twapStates} function. */
+export type TwapStatesParameters = Omit<v.InferInput<typeof TwapStatesRequest>, "type">;
+
+/**
+ * Subscribe to TWAP states updates for a specific user.
+ *
+ * @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 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.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { twapStates } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport(); // only `WebSocketTransport`
+ *
+ * const sub = await twapStates(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export function twapStates(
+  config: SubscriptionConfig,
+  params: TwapStatesParameters,
+  listener: (data: TwapStatesEvent) => void,
+): Promise<ISubscription> {
+  const payload = v.parse(TwapStatesRequest, {
+    type: "twapStates",
+    ...params,
+    dex: params.dex ?? "", // same value as in response
+  });
+  return config.transport.subscribe<TwapStatesEvent>(payload.type, payload, (e) => {
+    if (e.detail.user === payload.user && e.detail.dex === payload.dex) {
+      listener(e.detail);
+    }
+  });
+}

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

@@ -34,131 +34,119 @@ export const UserEventsEvent = /* @__PURE__ */ (() => {
   return v.pipe(
     v.union([
       /** Event of array of user trade fills. */
-      v.pipe(
-        v.object({
-          /** Array of user trade fills. */
-          fills: UserFillsResponse,
-        }),
-        v.description("Event of array of user trade fills."),
-      ),
+      v.object({
+        /** Array of user trade fills. */
+        fills: v.pipe(
+          UserFillsResponse,
+          v.description("Array of user trade fills."),
+        ),
+      }),
       /** Event of user funding update. */
-      v.pipe(
-        v.object({
-          /** Funding update details. */
-          funding: v.pipe(
+      v.object({
+        /** Funding update details. */
+        funding: v.pipe(
+          v.object({
+            /** Asset symbol. */
+            coin: v.pipe(
+              v.string(),
+              v.description("Asset symbol."),
+            ),
+            /** Amount transferred in USDC. */
+            usdc: v.pipe(
+              Decimal,
+              v.description("Amount transferred in USDC."),
+            ),
+            /** Signed position size. */
+            szi: v.pipe(
+              Decimal,
+              v.description("Signed position size."),
+            ),
+            /** Applied funding rate. */
+            fundingRate: v.pipe(
+              Decimal,
+              v.description("Applied funding rate."),
+            ),
+            /** Number of samples. */
+            nSamples: v.pipe(
+              v.nullable(UnsignedInteger),
+              v.description("Number of samples."),
+            ),
+          }),
+          v.description("Funding update details."),
+        ),
+      }),
+      /** Event of user liquidation. */
+      v.object({
+        /** Liquidation details. */
+        liquidation: v.pipe(
+          v.object({
+            /** Unique liquidation ID. */
+            lid: v.pipe(
+              UnsignedInteger,
+              v.description("Unique liquidation ID."),
+            ),
+            /** Address of the liquidator. */
+            liquidator: v.pipe(
+              Address,
+              v.description("Address of the liquidator."),
+            ),
+            /** Address of the liquidated user. */
+            liquidated_user: v.pipe(
+              Address,
+              v.description("Address of the liquidated user."),
+            ),
+            /** Notional position size that was liquidated. */
+            liquidated_ntl_pos: v.pipe(
+              UnsignedDecimal,
+              v.description("Notional position size that was liquidated."),
+            ),
+            /** Account value at time of liquidation. */
+            liquidated_account_value: v.pipe(
+              UnsignedDecimal,
+              v.description("Account value at time of liquidation."),
+            ),
+          }),
+          v.description("Liquidation details."),
+        ),
+      }),
+      /** Event of array of non-user initiated order cancellations. */
+      v.object({
+        /** Array of non-user initiated order cancellations. */
+        nonUserCancel: v.pipe(
+          v.array(
+            /** Cancelled order not initiated by the user. */
             v.object({
-              /** Asset symbol. */
+              /** Asset symbol (e.g., BTC). */
               coin: v.pipe(
                 v.string(),
-                v.description("Asset symbol."),
-              ),
-              /** Amount transferred in USDC. */
-              usdc: v.pipe(
-                Decimal,
-                v.description("Amount transferred in USDC."),
-              ),
-              /** Signed position size. */
-              szi: v.pipe(
-                Decimal,
-                v.description("Signed position size."),
-              ),
-              /** Applied funding rate. */
-              fundingRate: v.pipe(
-                Decimal,
-                v.description("Applied funding rate."),
-              ),
-              /** Number of samples. */
-              nSamples: v.pipe(
-                v.nullable(UnsignedInteger),
-                v.description("Number of samples."),
+                v.description("Asset symbol (e.g., BTC)."),
               ),
-            }),
-            v.description("Funding update details."),
-          ),
-        }),
-        v.description("Event of user funding update."),
-      ),
-      /** Event of user liquidation. */
-      v.pipe(
-        v.object({
-          /** Liquidation details. */
-          liquidation: v.pipe(
-            v.object({
-              /** Unique liquidation ID. */
-              lid: v.pipe(
+              /** Order ID. */
+              oid: v.pipe(
                 UnsignedInteger,
-                v.description("Unique liquidation ID."),
-              ),
-              /** Address of the liquidator. */
-              liquidator: v.pipe(
-                Address,
-                v.description("Address of the liquidator."),
-              ),
-              /** Address of the liquidated user. */
-              liquidated_user: v.pipe(
-                Address,
-                v.description("Address of the liquidated user."),
-              ),
-              /** Notional position size that was liquidated. */
-              liquidated_ntl_pos: v.pipe(
-                UnsignedDecimal,
-                v.description("Notional position size that was liquidated."),
-              ),
-              /** Account value at time of liquidation. */
-              liquidated_account_value: v.pipe(
-                UnsignedDecimal,
-                v.description("Account value at time of liquidation."),
+                v.description("Order ID."),
               ),
             }),
-            v.description("Liquidation details."),
           ),
-        }),
-        v.description("Event of user liquidation."),
-      ),
-      /** Event of array of non-user initiated order cancellations. */
-      v.pipe(
-        v.object({
-          /** Array of non-user initiated order cancellations. */
-          nonUserCancel: v.pipe(
-            v.array(
-              /** Cancelled order not initiated by the user. */
-              v.pipe(
-                v.object({
-                  /** Asset symbol (e.g., BTC). */
-                  coin: v.pipe(
-                    v.string(),
-                    v.description("Asset symbol (e.g., BTC)."),
-                  ),
-                  /** Order ID. */
-                  oid: v.pipe(
-                    UnsignedInteger,
-                    v.description("Order ID."),
-                  ),
-                }),
-                v.description("Cancelled order not initiated by the user."),
-              ),
-            ),
-            v.description("Array of non-user initiated order cancellations."),
-          ),
-        }),
-        v.description("Event of array of non-user initiated order cancellations."),
-      ),
+          v.description("Array of non-user initiated order cancellations."),
+        ),
+      }),
       /** Event of a TWAP history entry. */
-      v.pipe(
-        v.object({
-          /** Array of user's TWAP history. */
-          twapHistory: TwapHistoryResponse,
-        }),
-        v.description("Event of a TWAP history entry."),
-      ),
+      v.object({
+        /** Array of user's TWAP history. */
+        twapHistory: v.pipe(
+          TwapHistoryResponse,
+          v.description("Array of user's TWAP history."),
+        ),
+      }),
       /** Event of TWAP slice fills. */
-      v.pipe(
-        v.object({
-          /** Array of user's twap slice fills. */
-          twapSliceFills: UserTwapSliceFillsResponse,
-        }),
-        v.description("Event of TWAP slice fills."),
-      ),
+      v.object({
+        /** Array of user's twap slice fills. */
+        twapSliceFills: v.pipe(
+          UserTwapSliceFillsResponse,
+          v.description("Array of user's twap slice fills."),
+        ),
+      }),
     ]),
     v.description("Event of one of possible user events."),
   );
@@ -170,7 +158,7 @@ export type UserEventsEvent = v.InferOutput<typeof UserEventsEvent>;
 // ============================================================
 
 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 userEvents} function. */
 export type UserEventsParameters = Omit<v.InferInput<typeof UserEventsRequest>, "type">;
@@ -182,7 +170,7 @@ export type UserEventsParameters = Omit<v.InferInput<typeof UserEventsRequest>,
  * @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.
@@ -207,7 +195,7 @@ export function userEvents(
   config: SubscriptionConfig,
   params: UserEventsParameters,
   listener: (data: UserEventsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(UserEventsRequest, { type: "userEvents", ...params });
   return config.transport.subscribe<UserEventsEvent>("user", payload, (e) => {
     listener(e.detail);

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

@@ -42,7 +42,10 @@ export const UserFillsEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Array of user trade fills. */
-      fills: UserFillsResponse,
+      fills: v.pipe(
+        UserFillsResponse,
+        v.description("Array of user trade fills."),
+      ),
       /** Whether this is an initial snapshot. */
       isSnapshot: v.pipe(
         v.optional(v.literal(true)),
@@ -59,7 +62,7 @@ export type UserFillsEvent = v.InferOutput<typeof UserFillsEvent>;
 // ============================================================
 
 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 userFills} function. */
 export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "type">;
@@ -71,7 +74,7 @@ export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "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.
@@ -96,7 +99,7 @@ export function userFills(
   config: SubscriptionConfig,
   params: UserFillsParameters,
   listener: (data: UserFillsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(UserFillsRequest, {
     type: "userFills",
     ...params,

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

@@ -89,7 +89,7 @@ export type UserFundingsEvent = v.InferOutput<typeof UserFundingsEvent>;
 // ============================================================
 
 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 userFundings} function. */
 export type UserFundingsParameters = Omit<v.InferInput<typeof UserFundingsRequest>, "type">;
@@ -101,7 +101,7 @@ export type UserFundingsParameters = Omit<v.InferInput<typeof UserFundingsReques
  * @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.
@@ -126,7 +126,7 @@ export function userFundings(
   config: SubscriptionConfig,
   params: UserFundingsParameters,
   listener: (data: UserFundingsEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(UserFundingsRequest, { type: "userFundings", ...params });
   return config.transport.subscribe<UserFundingsEvent>(payload.type, payload, (e) => {
     if (e.detail.user === payload.user) {

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

@@ -37,7 +37,10 @@ export const UserHistoricalOrdersEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Array of frontend orders with current processing status. */
-      orderHistory: HistoricalOrdersResponse,
+      orderHistory: v.pipe(
+        HistoricalOrdersResponse,
+        v.description("Array of frontend orders with current processing status."),
+      ),
       /** Whether this is an initial snapshot. */
       isSnapshot: v.pipe(
         v.optional(v.literal(true)),
@@ -54,7 +57,7 @@ export type UserHistoricalOrdersEvent = v.InferOutput<typeof UserHistoricalOrder
 // ============================================================
 
 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 userHistoricalOrders} function. */
 export type UserHistoricalOrdersParameters = Omit<v.InferInput<typeof UserHistoricalOrdersRequest>, "type">;
@@ -66,7 +69,7 @@ export type UserHistoricalOrdersParameters = Omit<v.InferInput<typeof UserHistor
  * @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.
@@ -91,7 +94,7 @@ export function userHistoricalOrders(
   config: SubscriptionConfig,
   params: UserHistoricalOrdersParameters,
   listener: (data: UserHistoricalOrdersEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(UserHistoricalOrdersRequest, { type: "userHistoricalOrders", ...params });
   return config.transport.subscribe<UserHistoricalOrdersEvent>(payload.type, payload, (e) => {
     if (e.detail.user === payload.user) {

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

@@ -37,7 +37,10 @@ export const UserNonFundingLedgerUpdatesEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Array of user's non-funding ledger update. */
-      nonFundingLedgerUpdates: UserNonFundingLedgerUpdatesResponse,
+      nonFundingLedgerUpdates: v.pipe(
+        UserNonFundingLedgerUpdatesResponse,
+        v.description("Array of user's non-funding ledger update."),
+      ),
       /** Whether this is an initial snapshot. */
       isSnapshot: v.pipe(
         v.optional(v.literal(true)),
@@ -54,7 +57,7 @@ export type UserNonFundingLedgerUpdatesEvent = v.InferOutput<typeof UserNonFundi
 // ============================================================
 
 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 userNonFundingLedgerUpdates} function. */
 export type UserNonFundingLedgerUpdatesParameters = Omit<
@@ -69,7 +72,7 @@ export type UserNonFundingLedgerUpdatesParameters = Omit<
  * @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 userNonFundingLedgerUpdates(
   config: SubscriptionConfig,
   params: UserNonFundingLedgerUpdatesParameters,
   listener: (data: UserNonFundingLedgerUpdatesEvent) => void,
-): Promise<WebSocketSubscription> {
+): Promise<ISubscription> {
   const payload = v.parse(UserNonFundingLedgerUpdatesRequest, { type: "userNonFundingLedgerUpdates", ...params });
   return config.transport.subscribe<UserNonFundingLedgerUpdatesEvent>(payload.type, payload, (e) => {
     if (e.detail.user === payload.user) {