@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,598 @@
+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 declare 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>);
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+//# sourceMappingURL=~client.d.ts.map

package/script/src/api/subscription/~client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"~client.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/~client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,YAAY,EACV,mBAAmB,IAAI,qBAAqB,EAC5C,wBAAwB,IAAI,0BAA0B,GACvD,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,oBAAoB,IAAI,sBAAsB,EAC9C,yBAAyB,IAAI,2BAA2B,GACzD,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,YAAY,IAAI,cAAc,EAAE,iBAAiB,IAAI,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC7G,YAAY,EAAE,cAAc,IAAI,gBAAgB,EAAE,mBAAmB,IAAI,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvH,YAAY,EAAE,QAAQ,IAAI,UAAU,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,UAAU,CAAC;AACzF,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACxG,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,kBAAkB,IAAI,oBAAoB,EAC1C,uBAAuB,IAAI,yBAAyB,GACrD,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,gBAAgB,IAAI,kBAAkB,EACtC,qBAAqB,IAAI,uBAAuB,GACjD,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACxG,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,eAAe,IAAI,iBAAiB,EACpC,oBAAoB,IAAI,sBAAsB,GAC/C,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,kBAAkB,IAAI,oBAAoB,EAC1C,uBAAuB,IAAI,yBAAyB,GACrD,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,cAAc,IAAI,gBAAgB,EAAE,mBAAmB,IAAI,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvH,YAAY,EAAE,WAAW,IAAI,aAAa,EAAE,gBAAgB,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACxG,YAAY,EACV,eAAe,IAAI,iBAAiB,EACpC,oBAAoB,IAAI,sBAAsB,GAC/C,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,cAAc,IAAI,gBAAgB,EAAE,mBAAmB,IAAI,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvH,YAAY,EACV,iBAAiB,IAAI,mBAAmB,EACxC,sBAAsB,IAAI,wBAAwB,GACnD,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,yBAAyB,IAAI,2BAA2B,EACxD,8BAA8B,IAAI,gCAAgC,GACnE,MAAM,2BAA2B,CAAC;AACnC,YAAY,EACV,gCAAgC,IAAI,kCAAkC,EACtE,qCAAqC,IAAI,uCAAuC,GACjF,MAAM,kCAAkC,CAAC;AAC1C,YAAY,EACV,oBAAoB,IAAI,sBAAsB,EAC9C,yBAAyB,IAAI,2BAA2B,GACzD,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,uBAAuB,IAAI,yBAAyB,EACpD,4BAA4B,IAAI,8BAA8B,GAC/D,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,aAAa,IAAI,eAAe,EAAE,kBAAkB,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAClH,YAAY,EAAE,aAAa,IAAI,eAAe,EAAE,kBAAkB,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAElH,YAAY,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE7D;;;GAGG;AACH,qBAAa,kBAAkB,CAC7B,CAAC,SAAS,sBAAsB,GAAG,sBAAsB,CACzD,YAAW,yBAAyB,CAAC,CAAC,CAAC;IACvC,SAAS,EAAE,CAAC,CAAC;IAEb;;;;;;;;;;;OAWG;gBACS,IAAI,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAI9C;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CACZ,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,cAAc,CAAC,CAAC,GAC9D,UAAU,CAAC,OAAO,cAAc,CAAC;IAIpC;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CACb,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,eAAe,CAAC,CAAC,GAC/D,UAAU,CAAC,OAAO,eAAe,CAAC;IAIrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAChB,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,kBAAkB,CAAC,CAAC,GAClE,UAAU,CAAC,OAAO,kBAAkB,CAAC;IAIxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,OAAO,CAAC,CAAC,GACvD,UAAU,CAAC,OAAO,OAAO,CAAC;IAQ7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,SAAS,CAAC,CAAC,GACzD,UAAU,CAAC,OAAO,SAAS,CAAC;IAQ/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CACD,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,GAAG,CAAC,CAAC,GACnD,UAAU,CAAC,OAAO,GAAG,CAAC;IAIzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,MAAM,CAAC,CAAC,GACtD,UAAU,CAAC,OAAO,MAAM,CAAC;IAI5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAChB,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,kBAAkB,CAAC,CAAC,GAClE,UAAU,CAAC,OAAO,kBAAkB,CAAC;IAIxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,aAAa,CAAC,CAAC,GAC7D,UAAU,CAAC,OAAO,aAAa,CAAC;IAInC;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CACT,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,WAAW,CAAC,CAAC,GAC3D,UAAU,CAAC,OAAO,WAAW,CAAC;IAIjC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,MAAM,CAAC,CAAC,GACtD,UAAU,CAAC,OAAO,MAAM,CAAC;IAI5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,YAAY,CAAC,CAAC,GAC5D,UAAU,CAAC,OAAO,YAAY,CAAC;IAIlC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,UAAU,CAAC,CAAC,GAC1D,UAAU,CAAC,OAAO,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,YAAY,CAAC,CAAC,GAC5D,UAAU,CAAC,OAAO,YAAY,CAAC;IAIlC;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,aAAa,CAAC,CAAC,GAC7D,UAAU,CAAC,OAAO,aAAa,CAAC;IAInC;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,SAAS,CAAC,CAAC,GACzD,UAAU,CAAC,OAAO,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,MAAM,CAAC,CAAC,GACtD,UAAU,CAAC,OAAO,MAAM,CAAC;IAI5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,UAAU,CAAC,CAAC,GAC1D,UAAU,CAAC,OAAO,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,SAAS,CAAC,CAAC,GACzD,UAAU,CAAC,OAAO,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,YAAY,CAAC,CAAC,GAC5D,UAAU,CAAC,OAAO,YAAY,CAAC;IAIlC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAClB,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,oBAAoB,CAAC,CAAC,GACpE,UAAU,CAAC,OAAO,oBAAoB,CAAC;IAI1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,2BAA2B,CACzB,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,2BAA2B,CAAC,CAAC,GAC3E,UAAU,CAAC,OAAO,2BAA2B,CAAC;IAIjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CACb,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,eAAe,CAAC,CAAC,GAC/D,UAAU,CAAC,OAAO,eAAe,CAAC;IAIrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAChB,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,kBAAkB,CAAC,CAAC,GAClE,UAAU,CAAC,OAAO,kBAAkB,CAAC;IAIxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,QAAQ,CAAC,CAAC,GACxD,UAAU,CAAC,OAAO,QAAQ,CAAC;IAI9B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,GAAG,IAAI,EAAE,SAAS,CAAC,oBAAoB,CAAC,OAAO,QAAQ,CAAC,CAAC,GACxD,UAAU,CAAC,OAAO,QAAQ,CAAC;CAG/B"}