@nktkas/hyperliquid 0.26.0 → 0.27.1

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

@@ -0,0 +1,792 @@
+import type { OmitFirst, OverloadedParameters } from "../_base.js";
+import type { ISubscriptionTransport } from "../../transport/base.js";
+import type { SubscriptionRequestConfig } from "./_types.js";
+
+import { activeAssetCtx } from "./activeAssetCtx.js";
+import { activeAssetData } from "./activeAssetData.js";
+import { activeSpotAssetCtx } from "./activeSpotAssetCtx.js";
+import { allMids } from "./allMids.js";
+import { assetCtxs } from "./assetCtxs.js";
+import { bbo } from "./bbo.js";
+import { candle } from "./candle.js";
+import { clearinghouseState } from "./clearinghouseState.js";
+import { explorerBlock } from "./explorerBlock.js";
+import { explorerTxs } from "./explorerTxs.js";
+import { l2Book } from "./l2Book.js";
+import { notification } from "./notification.js";
+import { openOrders } from "./openOrders.js";
+import { orderUpdates } from "./orderUpdates.js";
+import { spotAssetCtxs } from "./spotAssetCtxs.js";
+import { spotState } from "./spotState.js";
+import { trades } from "./trades.js";
+import { userEvents } from "./userEvents.js";
+import { userFills } from "./userFills.js";
+import { userFundings } from "./userFundings.js";
+import { userHistoricalOrders } from "./userHistoricalOrders.js";
+import { userNonFundingLedgerUpdates } from "./userNonFundingLedgerUpdates.js";
+import { userTwapHistory } from "./userTwapHistory.js";
+import { userTwapSliceFills } from "./userTwapSliceFills.js";
+import { webData2 } from "./webData2.js";
+import { webData3 } from "./webData3.js";
+
+export type {
+  ActiveAssetCtxEvent as WsActiveAssetCtxEvent,
+  ActiveAssetCtxParameters as WsActiveAssetCtxParameters,
+} from "./activeAssetCtx.js";
+export type {
+  ActiveAssetDataEvent as WsActiveAssetDataEvent,
+  ActiveAssetDataParameters as WsActiveAssetDataParameters,
+} from "./activeAssetData.js";
+export type {
+  ActiveSpotAssetCtxEvent as WsActiveSpotAssetCtxEvent,
+  ActiveSpotAssetCtxParameters as WsActiveSpotAssetCtxParameters,
+} from "./activeSpotAssetCtx.js";
+export type { AllMidsEvent as WsAllMidsEvent, AllMidsParameters as WsAllMidsParameters } from "./allMids.js";
+export type { AssetCtxsEvent as WsAssetCtxsEvent, AssetCtxsParameters as WsAssetCtxsParameters } from "./assetCtxs.js";
+export type { BboEvent as WsBboEvent, BboParameters as WsBboParameters } from "./bbo.js";
+export type { CandleEvent as WsCandleEvent, CandleParameters as WsCandleParameters } from "./candle.js";
+export type {
+  ClearinghouseStateEvent as WsClearinghouseStateEvent,
+  ClearinghouseStateParameters as WsClearinghouseStateParameters,
+} from "./clearinghouseState.js";
+export type {
+  ExplorerBlockEvent as WsExplorerBlockEvent,
+  ExplorerBlockParameters as WsExplorerBlockParameters,
+} from "./explorerBlock.js";
+export type {
+  ExplorerTxsEvent as WsExplorerTxsEvent,
+  ExplorerTxsParameters as WsExplorerTxsParameters,
+} from "./explorerTxs.js";
+export type { L2BookEvent as WsL2BookEvent, L2BookParameters as WsL2BookParameters } from "./l2Book.js";
+export type {
+  NotificationEvent as WsNotificationEvent,
+  NotificationParameters as WsNotificationParameters,
+} from "./notification.js";
+export type {
+  OpenOrdersEvent as WsOpenOrdersEvent,
+  OpenOrdersParameters as WsOpenOrdersParameters,
+} from "./openOrders.js";
+export type {
+  OrderUpdatesEvent as WsOrderUpdatesEvent,
+  OrderUpdatesParameters as WsOrderUpdatesParameters,
+} from "./orderUpdates.js";
+export type {
+  SpotAssetCtxsEvent as WsSpotAssetCtxsEvent,
+  SpotAssetCtxsParameters as WsSpotAssetCtxsParameters,
+} from "./spotAssetCtxs.js";
+export type { SpotStateEvent as WsSpotStateEvent, SpotStateParameters as WsSpotStateParameters } from "./spotState.js";
+export type { TradesEvent as WsTradesEvent, TradesParameters as WsTradesParameters } from "./trades.js";
+export type {
+  UserEventsEvent as WsUserEventsEvent,
+  UserEventsParameters as WsUserEventsParameters,
+} from "./userEvents.js";
+export type { UserFillsEvent as WsUserFillsEvent, UserFillsParameters as WsUserFillsParameters } from "./userFills.js";
+export type {
+  UserFundingsEvent as WsUserFundingsEvent,
+  UserFundingsParameters as WsUserFundingsParameters,
+} from "./userFundings.js";
+export type {
+  UserHistoricalOrdersEvent as WsUserHistoricalOrdersEvent,
+  UserHistoricalOrdersParameters as WsUserHistoricalOrdersParameters,
+} from "./userHistoricalOrders.js";
+export type {
+  UserNonFundingLedgerUpdatesEvent as WsUserNonFundingLedgerUpdatesEvent,
+  UserNonFundingLedgerUpdatesParameters as WsUserNonFundingLedgerUpdatesParameters,
+} from "./userNonFundingLedgerUpdates.js";
+export type {
+  UserTwapHistoryEvent as WsUserTwapHistoryEvent,
+  UserTwapHistoryParameters as WsUserTwapHistoryParameters,
+} from "./userTwapHistory.js";
+export type {
+  UserTwapSliceFillsEvent as WsUserTwapSliceFillsEvent,
+  UserTwapSliceFillsParameters as WsUserTwapSliceFillsParameters,
+} from "./userTwapSliceFills.js";
+export type { WebData2Event as WsWebData2Event, WebData2Parameters as WsWebData2Parameters } from "./webData2.js";
+export type { WebData3Event as WsWebData3Event, WebData3Parameters as WsWebData3Parameters } from "./webData3.js";
+
+export type { SubscriptionRequestConfig } from "./_types.js";
+
+/**
+ * A client for interacting with the Hyperliquid Subscription API.
+ * @typeParam T - The transport (extends {@linkcode ISubscriptionTransport}) used to connect to the Hyperliquid API.
+ */
+export class SubscriptionClient<
+  T extends ISubscriptionTransport = ISubscriptionTransport,
+> implements SubscriptionRequestConfig<T> {
+  transport: T;
+
+  /**
+   * Initialises a new instance.
+   * @param args - The arguments for initialisation.
+   *
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   * const subsClient = new hl.SubscriptionClient({ transport });
+   * ```
+   */
+  constructor(args: SubscriptionRequestConfig<T>) {
+    this.transport = args.transport;
+  }
+
+  /**
+   * Subscribe to context updates for a specific perpetual asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.activeAssetCtx({ coin: "ETH" }, (data) => console.log(data));
+   * ```
+   */
+  activeAssetCtx(
+    ...args: OmitFirst<OverloadedParameters<typeof activeAssetCtx>>
+  ): ReturnType<typeof activeAssetCtx> {
+    return activeAssetCtx(this, ...args);
+  }
+
+  /**
+   * Subscribe to trading data updates for a specific asset and user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.activeAssetData({ coin: "ETH", user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  activeAssetData(
+    ...args: OmitFirst<OverloadedParameters<typeof activeAssetData>>
+  ): ReturnType<typeof activeAssetData> {
+    return activeAssetData(this, ...args);
+  }
+
+  /**
+   * Subscribe to context updates for a specific spot asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.activeSpotAssetCtx({ coin: "@1" }, (data) => console.log(data));
+   * ```
+   */
+  activeSpotAssetCtx(
+    ...args: OmitFirst<OverloadedParameters<typeof activeSpotAssetCtx>>
+  ): ReturnType<typeof activeSpotAssetCtx> {
+    return activeSpotAssetCtx(this, ...args);
+  }
+
+  /**
+   * Subscribe to mid prices for all actively traded assets.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.allMids((data) => console.log(data));
+   * ```
+   */
+  allMids(
+    ...args: OmitFirst<OverloadedParameters<typeof allMids>>
+  ): ReturnType<typeof allMids> {
+    return allMids(
+      this,
+      // @ts-ignore: TypeScript can't resolve overloaded signatures from parameter unions
+      ...args,
+    );
+  }
+
+  /**
+   * Subscribe to asset contexts for all perpetual assets.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.assetCtxs((data) => console.log(data));
+   * ```
+   */
+  assetCtxs(
+    ...args: OmitFirst<OverloadedParameters<typeof assetCtxs>>
+  ): ReturnType<typeof assetCtxs> {
+    return assetCtxs(
+      this,
+      // @ts-ignore: TypeScript can't resolve overloaded signatures from parameter unions
+      ...args,
+    );
+  }
+
+  /**
+   * Subscribe to best bid and offer updates for a specific asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.bbo({ coin: "ETH" }, (data) => console.log(data));
+   * ```
+   */
+  bbo(
+    ...args: OmitFirst<OverloadedParameters<typeof bbo>>
+  ): ReturnType<typeof bbo> {
+    return bbo(this, ...args);
+  }
+
+  /**
+   * Subscribe to candlestick data updates for a specific asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.candle({ coin: "ETH", interval: "1h" }, (data) => console.log(data));
+   * ```
+   */
+  candle(
+    ...args: OmitFirst<OverloadedParameters<typeof candle>>
+  ): ReturnType<typeof candle> {
+    return candle(this, ...args);
+  }
+
+  /**
+   * Subscribe to clearinghouse state updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.clearinghouseState({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  clearinghouseState(
+    ...args: OmitFirst<OverloadedParameters<typeof clearinghouseState>>
+  ): ReturnType<typeof clearinghouseState> {
+    return clearinghouseState(this, ...args);
+  }
+
+  /**
+   * Subscribe to explorer block updates.
+   * @param listener - A callback function to be called when the event is received.
+   * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+   * @note Make sure the endpoint in the {@link transport} supports this method.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.explorerBlock((data) => console.log(data));
+   * ```
+   */
+  explorerBlock(
+    ...args: OmitFirst<OverloadedParameters<typeof explorerBlock>>
+  ): ReturnType<typeof explorerBlock> {
+    return explorerBlock(this, ...args);
+  }
+
+  /**
+   * Subscribe to explorer transaction updates.
+   * @param listener - A callback function to be called when the event is received.
+   * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+   * @note Make sure the endpoint in the {@link transport} supports this method.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.explorerTxs((data) => console.log(data));
+   * ```
+   */
+  explorerTxs(
+    ...args: OmitFirst<OverloadedParameters<typeof explorerTxs>>
+  ): ReturnType<typeof explorerTxs> {
+    return explorerTxs(this, ...args);
+  }
+
+  /**
+   * Subscribe to L2 order book updates for a specific asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.l2Book({ coin: "ETH" }, (data) => console.log(data));
+   * ```
+   */
+  l2Book(
+    ...args: OmitFirst<OverloadedParameters<typeof l2Book>>
+  ): ReturnType<typeof l2Book> {
+    return l2Book(this, ...args);
+  }
+
+  /**
+   * Subscribe to notification updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.notification({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  notification(
+    ...args: OmitFirst<OverloadedParameters<typeof notification>>
+  ): ReturnType<typeof notification> {
+    return notification(this, ...args);
+  }
+
+  /**
+   * Subscribe to open orders updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.openOrders({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  openOrders(
+    ...args: OmitFirst<OverloadedParameters<typeof openOrders>>
+  ): ReturnType<typeof openOrders> {
+    return openOrders(this, ...args);
+  }
+
+  /**
+   * Subscribe to order status updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.orderUpdates({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  orderUpdates(
+    ...args: OmitFirst<OverloadedParameters<typeof orderUpdates>>
+  ): ReturnType<typeof orderUpdates> {
+    return orderUpdates(this, ...args);
+  }
+
+  /**
+   * Subscribe to context updates for all spot assets.
+   * @param listener - A callback function to be called when the event is received.
+   * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.spotAssetCtxs((data) => console.log(data));
+   * ```
+   */
+  spotAssetCtxs(
+    ...args: OmitFirst<OverloadedParameters<typeof spotAssetCtxs>>
+  ): ReturnType<typeof spotAssetCtxs> {
+    return spotAssetCtxs(this, ...args);
+  }
+
+  /**
+   * Subscribe to spot state updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.spotState({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  spotState(
+    ...args: OmitFirst<OverloadedParameters<typeof spotState>>
+  ): ReturnType<typeof spotState> {
+    return spotState(this, ...args);
+  }
+
+  /**
+   * Subscribe to real-time trade updates for a specific asset.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.trades({ coin: "ETH" }, (data) => console.log(data));
+   * ```
+   */
+  trades(
+    ...args: OmitFirst<OverloadedParameters<typeof trades>>
+  ): ReturnType<typeof trades> {
+    return trades(this, ...args);
+  }
+
+  /**
+   * Subscribe to non-order events for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   * @note Different subscriptions cannot be distinguished from each other.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userEvents({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userEvents(
+    ...args: OmitFirst<OverloadedParameters<typeof userEvents>>
+  ): ReturnType<typeof userEvents> {
+    return userEvents(this, ...args);
+  }
+
+  /**
+   * Subscribe to trade fill updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userFills({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userFills(
+    ...args: OmitFirst<OverloadedParameters<typeof userFills>>
+  ): ReturnType<typeof userFills> {
+    return userFills(this, ...args);
+  }
+
+  /**
+   * Subscribe to funding payment updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userFundings({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userFundings(
+    ...args: OmitFirst<OverloadedParameters<typeof userFundings>>
+  ): ReturnType<typeof userFundings> {
+    return userFundings(this, ...args);
+  }
+
+  /**
+   * Subscribe to historical order 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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userHistoricalOrders({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userHistoricalOrders(
+    ...args: OmitFirst<OverloadedParameters<typeof userHistoricalOrders>>
+  ): ReturnType<typeof userHistoricalOrders> {
+    return userHistoricalOrders(this, ...args);
+  }
+
+  /**
+   * Subscribe to non-funding ledger updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userNonFundingLedgerUpdates({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userNonFundingLedgerUpdates(
+    ...args: OmitFirst<OverloadedParameters<typeof userNonFundingLedgerUpdates>>
+  ): ReturnType<typeof userNonFundingLedgerUpdates> {
+    return userNonFundingLedgerUpdates(this, ...args);
+  }
+
+  /**
+   * Subscribe to TWAP order history updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userTwapHistory({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userTwapHistory(
+    ...args: OmitFirst<OverloadedParameters<typeof userTwapHistory>>
+  ): ReturnType<typeof userTwapHistory> {
+    return userTwapHistory(this, ...args);
+  }
+
+  /**
+   * Subscribe to TWAP execution updates for a specific user.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.userTwapSliceFills({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  userTwapSliceFills(
+    ...args: OmitFirst<OverloadedParameters<typeof userTwapSliceFills>>
+  ): ReturnType<typeof userTwapSliceFills> {
+    return userTwapSliceFills(this, ...args);
+  }
+
+  /**
+   * Subscribe to comprehensive user and market data updates.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.webData2({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  webData2(
+    ...args: OmitFirst<OverloadedParameters<typeof webData2>>
+  ): ReturnType<typeof webData2> {
+    return webData2(this, ...args);
+  }
+
+  /**
+   * Subscribe to comprehensive user and market data updates.
+   * @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 Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.webData3({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  webData3(
+    ...args: OmitFirst<OverloadedParameters<typeof webData3>>
+  ): ReturnType<typeof webData3> {
+    return webData3(this, ...args);
+  }
+}