@nktkas/hyperliquid 0.20.0 → 0.21.0

package/{script/src/clients/event.d.ts → esm/src/clients/subscription.d.ts}

@@ -4,48 +4,48 @@ import type { WsActiveAssetCtx, WsActiveAssetData, WsActiveSpotAssetCtx, WsAllMi
 import type { Candle } from "../types/info/assets.js";
 import type { Book, Order, OrderStatus } from "../types/info/orders.js";
 import type { TxDetails } from "../types/explorer/responses.js";
-/** Parameters for the {@linkcode EventClient} constructor. */
-export interface EventClientParameters<T extends ISubscriptionTransport = ISubscriptionTransport> {
+/** Parameters for the {@linkcode SubscriptionClient} constructor. */
+export interface SubscriptionClientParameters<T extends ISubscriptionTransport = ISubscriptionTransport> {
     /** The transport used to connect to the Hyperliquid API. */
     transport: T;
 }
-/** Parameters for the {@linkcode EventClient.activeAssetCtx} method. */
+/** Parameters for the {@linkcode SubscriptionClient.activeAssetCtx} method. */
 export type EventActiveAssetCtxParameters = Omit<WsActiveAssetCtxRequest, "type">;
-/** Parameters for the {@linkcode EventClient.activeAssetData} method. */
+/** Parameters for the {@linkcode SubscriptionClient.activeAssetData} method. */
 export type EventActiveAssetDataParameters = Omit<WsActiveAssetDataRequest, "type">;
-/** Parameters for the {@linkcode EventClient.allMids} method. */
+/** Parameters for the {@linkcode SubscriptionClient.allMids} method. */
 export type WsAllMidsParameters = Omit<WsAllMidsRequest, "type">;
-/** Parameters for the {@linkcode EventClient.bbo} method. */
+/** Parameters for the {@linkcode SubscriptionClient.bbo} method. */
 export type EventBboParameters = Omit<WsBboRequest, "type">;
-/** Parameters for the {@linkcode EventClient.candle} method. */
+/** Parameters for the {@linkcode SubscriptionClient.candle} method. */
 export type EventCandleParameters = Omit<WsCandleRequest, "type">;
-/** Parameters for the {@linkcode EventClient.l2Book} method. */
+/** Parameters for the {@linkcode SubscriptionClient.l2Book} method. */
 export type EventL2BookParameters = Omit<WsL2BookRequest, "type">;
-/** Parameters for the {@linkcode EventClient.notification} method. */
+/** Parameters for the {@linkcode SubscriptionClient.notification} method. */
 export type EventNotificationParameters = Omit<WsNotificationRequest, "type">;
-/** Parameters for the {@linkcode EventClient.orderUpdates} method. */
+/** Parameters for the {@linkcode SubscriptionClient.orderUpdates} method. */
 export type EventOrderUpdatesParameters = Omit<WsOrderUpdatesRequest, "type">;
-/** Parameters for the {@linkcode EventClient.trades} method. */
+/** Parameters for the {@linkcode SubscriptionClient.trades} method. */
 export type EventTradesParameters = Omit<WsTradesRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userEvents} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userEvents} method. */
 export type EventUserEventsParameters = Omit<WsUserEventsRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userFills} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userFills} method. */
 export type EventUserFillsParameters = Omit<WsUserFillsRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userFundings} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userFundings} method. */
 export type EventUserFundingsParameters = Omit<WsUserFundingsRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userNonFundingLedgerUpdates} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userNonFundingLedgerUpdates} method. */
 export type EventUserNonFundingLedgerUpdatesParameters = Omit<WsUserNonFundingLedgerUpdatesRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userTwapHistory} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userTwapHistory} method. */
 export type EventUserTwapHistory = Omit<WsUserTwapHistoryRequest, "type">;
-/** Parameters for the {@linkcode EventClient.userTwapSliceFills} method. */
+/** Parameters for the {@linkcode SubscriptionClient.userTwapSliceFills} method. */
 export type EventUserTwapSliceFills = Omit<WsUserTwapSliceFillsRequest, "type">;
-/** Parameters for the {@linkcode EventClient.webData2} method. */
+/** Parameters for the {@linkcode SubscriptionClient.webData2} method. */
 export type EventWebData2Parameters = Omit<WsWebData2Request, "type">;
 /**
- * Event client for subscribing to various Hyperliquid events.
+ * Subscription client for subscribing to various Hyperliquid events.
  * @typeParam T The type of transport used to connect to the Hyperliquid Websocket API.
  */
-export declare class EventClient<T extends ISubscriptionTransport = ISubscriptionTransport> implements EventClientParameters, AsyncDisposable {
+export declare class SubscriptionClient<T extends ISubscriptionTransport = ISubscriptionTransport> implements SubscriptionClientParameters, AsyncDisposable {
     transport: T;
     /**
      * Initialises a new instance.
@@ -56,15 +56,14 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      * ```
      */
-    constructor(args: EventClientParameters<T>);
+    constructor(args: SubscriptionClientParameters<T>);
     /**
      * Subscribe to context updates for a specific perpetual asset.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -73,19 +72,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.activeAssetCtx({ coin: "BTC" }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void, signal?: AbortSignal): Promise<Subscription>;
+    activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void): Promise<Subscription>;
     /**
      * Subscribe to trading data updates for a specific asset and user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -94,18 +92,17 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.activeAssetData({ coin: "BTC", user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: WsActiveAssetData) => void, signal?: AbortSignal): Promise<Subscription>;
+    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: WsActiveAssetData) => void): Promise<Subscription>;
     /**
      * Subscribe to mid prices for all actively traded assets.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -114,20 +111,19 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.allMids((data) => {
      *   console.log(data);
      * });
      * ```
      */
-    allMids(listener: (data: WsAllMids) => void, signal?: AbortSignal): Promise<Subscription>;
-    allMids(args: WsAllMidsParameters, listener: (data: WsAllMids) => void, signal?: AbortSignal): Promise<Subscription>;
+    allMids(listener: (data: WsAllMids) => void): Promise<Subscription>;
+    allMids(args: WsAllMidsParameters, listener: (data: WsAllMids) => void): Promise<Subscription>;
     /**
      * Subscribe to best bid and offer updates for a specific asset.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -136,19 +132,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.bbo({ coin: "BTC" }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    bbo(args: EventBboParameters, listener: (data: WsBbo) => void, signal?: AbortSignal): Promise<Subscription>;
+    bbo(args: EventBboParameters, listener: (data: WsBbo) => void): Promise<Subscription>;
     /**
      * Subscribe to candlestick data updates for a specific asset.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -157,18 +152,17 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.candle({ coin: "BTC", interval: "1h" }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    candle(args: EventCandleParameters, listener: (data: Candle) => void, signal?: AbortSignal): Promise<Subscription>;
+    candle(args: EventCandleParameters, listener: (data: Candle) => void): Promise<Subscription>;
     /**
      * Subscribe to explorer block updates.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A 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.
      *
@@ -178,18 +172,17 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.explorerBlock((data) => {
      *   console.log(data);
      * });
      * ```
      */
-    explorerBlock(listener: (data: WsBlockDetails[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    explorerBlock(listener: (data: WsBlockDetails[]) => void): Promise<Subscription>;
     /**
      * Subscribe to explorer transaction updates.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A 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.
      *
@@ -199,19 +192,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.explorerTxs((data) => {
      *   console.log(data);
      * });
      * ```
      */
-    explorerTxs(listener: (data: TxDetails[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    explorerTxs(listener: (data: TxDetails[]) => void): Promise<Subscription>;
     /**
      * Subscribe to L2 order book updates for a specific asset.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -220,19 +212,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.l2Book({ coin: "BTC" }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    l2Book(args: EventL2BookParameters, listener: (data: Book) => void, signal?: AbortSignal): Promise<Subscription>;
+    l2Book(args: EventL2BookParameters, listener: (data: Book) => void): Promise<Subscription>;
     /**
      * Subscribe to notification updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -241,19 +232,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.notification({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    notification(args: EventNotificationParameters, listener: (data: WsNotification) => void, signal?: AbortSignal): Promise<Subscription>;
+    notification(args: EventNotificationParameters, listener: (data: WsNotification) => void): Promise<Subscription>;
     /**
      * Subscribe to order status updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -262,19 +252,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.orderUpdates({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    orderUpdates(args: EventOrderUpdatesParameters, listener: (data: OrderStatus<Order>[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    orderUpdates(args: EventOrderUpdatesParameters, listener: (data: OrderStatus<Order>[]) => void): Promise<Subscription>;
     /**
      * Subscribe to real-time trade updates for a specific asset.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -283,19 +272,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.trades({ coin: "BTC" }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void): Promise<Subscription>;
     /**
      * Subscribe to non-order events for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @note Different subscriptions cannot be distinguished from each other.
@@ -306,19 +294,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userEvents({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userEvents(args: EventUserEventsParameters, listener: (data: WsUserEvent) => void, signal?: AbortSignal): Promise<Subscription>;
+    userEvents(args: EventUserEventsParameters, listener: (data: WsUserEvent) => void): Promise<Subscription>;
     /**
      * Subscribe to trade fill updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -327,19 +314,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userFills({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userFills(args: EventUserFillsParameters, listener: (data: WsUserFills) => void, signal?: AbortSignal): Promise<Subscription>;
+    userFills(args: EventUserFillsParameters, listener: (data: WsUserFills) => void): Promise<Subscription>;
     /**
      * Subscribe to funding payment updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -348,19 +334,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userFundings({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userFundings(args: EventUserFundingsParameters, listener: (data: WsUserFundings) => void, signal?: AbortSignal): Promise<Subscription>;
+    userFundings(args: EventUserFundingsParameters, listener: (data: WsUserFundings) => void): Promise<Subscription>;
     /**
      * Subscribe to non-funding ledger updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -369,19 +354,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userNonFundingLedgerUpdates({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userNonFundingLedgerUpdates(args: EventUserNonFundingLedgerUpdatesParameters, listener: (data: WsUserNonFundingLedgerUpdates) => void, signal?: AbortSignal): Promise<Subscription>;
+    userNonFundingLedgerUpdates(args: EventUserNonFundingLedgerUpdatesParameters, listener: (data: WsUserNonFundingLedgerUpdates) => void): Promise<Subscription>;
     /**
      * Subscribe to TWAP order history updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -390,19 +374,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userTwapHistory({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userTwapHistory(args: EventUserTwapHistory, listener: (data: WsUserTwapHistory) => void, signal?: AbortSignal): Promise<Subscription>;
+    userTwapHistory(args: EventUserTwapHistory, listener: (data: WsUserTwapHistory) => void): Promise<Subscription>;
     /**
      * Subscribe to TWAP execution updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -411,19 +394,18 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.userTwapSliceFills({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    userTwapSliceFills(args: EventUserTwapSliceFills, listener: (data: WsUserTwapSliceFills) => void, signal?: AbortSignal): Promise<Subscription>;
+    userTwapSliceFills(args: EventUserTwapSliceFills, listener: (data: WsUserTwapSliceFills) => void): Promise<Subscription>;
     /**
      * Subscribe to comprehensive user and market data updates.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
-     * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
@@ -432,14 +414,14 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * import * as hl from "@nktkas/hyperliquid";
      *
      * const transport = new hl.WebSocketTransport();
-     * const client = new hl.EventClient({ transport });
+     * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await client.webData2({ user: "0x..." }, (data) => {
      *   console.log(data);
      * });
      * ```
      */
-    webData2(args: EventWebData2Parameters, listener: (data: WsWebData2) => void, signal?: AbortSignal): Promise<Subscription>;
+    webData2(args: EventWebData2Parameters, listener: (data: WsWebData2) => void): Promise<Subscription>;
     [Symbol.asyncDispose](): Promise<void>;
 }
-//# sourceMappingURL=event.d.ts.map
+//# sourceMappingURL=subscription.d.ts.map

package/esm/src/clients/subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../../src/src/clients/subscription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,KAAK,EACR,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,eAAe,EAGf,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,oCAAoC,EACpC,wBAAwB,EACxB,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EACR,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,EACT,KAAK,EACL,cAAc,EACd,cAAc,EACd,OAAO,EACP,WAAW,EACX,WAAW,EACX,cAAc,EACd,6BAA6B,EAC7B,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACb,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAEhE,qEAAqE;AACrE,MAAM,WAAW,4BAA4B,CAAC,CAAC,SAAS,sBAAsB,GAAG,sBAAsB;IACnG,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC;CAChB;AAED,+EAA+E;AAC/E,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAElF,gFAAgF;AAChF,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAEpF,wEAAwE;AACxE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAEjE,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAE5D,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,6EAA6E;AAC7E,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,6EAA6E;AAC7E,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAElE,2EAA2E;AAC3E,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAE1E,0EAA0E;AAC1E,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAExE,6EAA6E;AAC7E,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE9E,4FAA4F;AAC5F,MAAM,MAAM,0CAA0C,GAAG,IAAI,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;AAE5G,gFAAgF;AAChF,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAE1E,mFAAmF;AACnF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;AAEhF,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAEtE;;;GAGG;AACH,qBAAa,kBAAkB,CAC3B,CAAC,SAAS,sBAAsB,GAAG,sBAAsB,CAC3D,YAAW,4BAA4B,EAAE,eAAe;IACtD,SAAS,EAAE,CAAC,CAAC;IAEb;;;;;;;;;;;OAWG;gBACS,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC;IAIjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CACV,IAAI,EAAE,6BAA6B,EACnC,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,GAAG,oBAAoB,KAAK,IAAI,GAClE,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CACX,IAAI,EAAE,8BAA8B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC5C,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IACnE,OAAO,CACH,IAAI,EAAE,mBAAmB,EACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,GACpC,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAYrF;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAa5F;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IASzE;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAc1F;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,IAAI,EAAE,2BAA2B,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAUhH;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACR,IAAI,EAAE,2BAA2B,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,GAC/C,OAAO,CAAC,YAAY,CAAC;IAUxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAY/F;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,IAAI,EAAE,yBAAyB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAUzG;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,IAAI,EAAE,wBAAwB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAavG;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,IAAI,EAAE,2BAA2B,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAYhH;;;;;;;;;;;;;;;;;;OAkBG;IACH,2BAA2B,CACvB,IAAI,EAAE,0CAA0C,EAChD,QAAQ,EAAE,CAAC,IAAI,EAAE,6BAA6B,KAAK,IAAI,GACxD,OAAO,CAAC,YAAY,CAAC;IAYxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAY/G;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CACd,IAAI,EAAE,uBAAuB,EAC7B,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,GAC/C,OAAO,CAAC,YAAY,CAAC;IAYxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAY9F,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG/C"}