@nktkas/hyperliquid 0.29.1 → 0.30.0

package/esm/src/api/subscription/_methods/allDexsClearinghouseState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"allDexsClearinghouseState.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allDexsClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,mFAAmF;AACnF,eAAO,MAAM,gCAAgC;IAGvC,4BAA4B;;IAK5B,oBAAoB;;;;;oFAQtB,CAAC;AACL,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAEtG,sEAAsE;AACtE,eAAO,MAAM,8BAA8B;IAGrC,oBAAoB;;IAKpB,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAa/D,CAAC;AACL,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMlG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,iFAAiF;AACjF,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gCAAgC,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mCAAmC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,IAAI,GACvD,OAAO,CAAC,qBAAqB,CAAC,CAQhC"}
+{"version":3,"file":"allDexsClearinghouseState.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allDexsClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,mFAAmF;AACnF,eAAO,MAAM,gCAAgC;IAGvC,4BAA4B;;IAK5B,oBAAoB;;;;;oFAQtB,CAAC;AACL,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAEtG,sEAAsE;AACtE,eAAO,MAAM,8BAA8B;IAGrC,oBAAoB;;IAKpB,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAa/D,CAAC;AACL,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMlG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,iFAAiF;AACjF,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gCAAgC,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mCAAmC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,IAAI,GACvD,OAAO,CAAC,aAAa,CAAC,CAUxB"}

package/esm/src/api/subscription/_methods/allDexsClearinghouseState.js

@@ -32,7 +32,7 @@ export const AllDexsClearinghouseStateEvent = /* @__PURE__ */ (() => {
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -59,7 +59,9 @@ export function allDexsClearinghouseState(config, params, listener) {
         ...params,
     });
     return config.transport.subscribe(payload.type, payload, (e) => {
-        listener(e.detail);
+        if (e.detail.user === payload.user) {
+            listener(e.detail);
+        }
     });
 }
 //# sourceMappingURL=allDexsClearinghouseState.js.map

package/esm/src/api/subscription/_methods/allDexsClearinghouseState.js.map

@@ -1 +1 @@
-{"version":3,"file":"allDexsClearinghouseState.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allDexsClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AAEvF,mFAAmF;AACnF,MAAM,CAAC,MAAM,gCAAgC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,EACtC,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8EAA8E,CAAC,CAC9F,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,sEAAsE;AACtE,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,6DAA6D;QAC7D,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,MAAM,EAAE;YACV,0BAA0B;SAC3B,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAA0B,EAC1B,MAA2C,EAC3C,QAAwD;IAExD,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,gCAAgC,EAAE;QACxD,IAAI,EAAE,2BAA2B;QACjC,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7F,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"allDexsClearinghouseState.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allDexsClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AAEvF,mFAAmF;AACnF,MAAM,CAAC,MAAM,gCAAgC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,EACtC,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8EAA8E,CAAC,CAC9F,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,sEAAsE;AACtE,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,6DAA6D;QAC7D,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,MAAM,EAAE;YACV,0BAA0B;SAC3B,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAA0B,EAC1B,MAA2C,EAC3C,QAAwD;IAExD,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,gCAAgC,EAAE;QACxD,IAAI,EAAE,2BAA2B;QACjC,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7F,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -13,10 +13,12 @@ export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
 /** Event of mid prices for all assets. */
 export declare const AllMidsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Mapping of coin symbols to mid prices. */
-    readonly mids: v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<{
+    readonly mids: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<{
+        [x: string]: string;
+    }, "Mapping of coin symbols to mid prices.">]>, v.DescriptionAction<{
         [x: string]: string;
     }, "Mapping of coin symbols to mid prices.">]>;
-    /** DEX name (undefined for main dex). */
+    /** DEX name (empty string for main dex). */
     readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
 }, undefined>, v.DescriptionAction<{
     mids: {
@@ -26,7 +28,7 @@ export declare const AllMidsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
 }, "Event of mid prices for all assets.">]>;
 export type AllMidsEvent = v.InferOutput<typeof AllMidsEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /** Request parameters for the {@linkcode allMids} function. */
 export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
 /**
@@ -36,7 +38,7 @@ export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type"
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -56,6 +58,6 @@ export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type"
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function allMids(config: SubscriptionConfig, listener: (data: AllMidsEvent) => void): Promise<WebSocketSubscription>;
-export declare function allMids(config: SubscriptionConfig, params: AllMidsParameters, listener: (data: AllMidsEvent) => void): Promise<WebSocketSubscription>;
+export declare function allMids(config: SubscriptionConfig, listener: (data: AllMidsEvent) => void): Promise<ISubscription>;
+export declare function allMids(config: SubscriptionConfig, params: AllMidsParameters, listener: (data: AllMidsEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=allMids.d.ts.map

package/esm/src/api/subscription/_methods/allMids.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"allMids.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,sDAAsD;AACtD,eAAO,MAAM,cAAc;IAGrB,4BAA4B;;IAK5B,4CAA4C;;;;;uDAQ9C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAElE,0CAA0C;AAC1C,eAAO,MAAM,YAAY;IAGnB,6CAA6C;;;;IAE7C,yCAAyC;;;;;;;2CAQ3C,CAAC;AACL,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAM9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAClC,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"allMids.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,sDAAsD;AACtD,eAAO,MAAM,cAAc;IAGrB,4BAA4B;;IAK5B,4CAA4C;;;;;uDAQ9C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAElE,0CAA0C;AAC1C,eAAO,MAAM,YAAY;IAGnB,6CAA6C;;;;;;IAK7C,4CAA4C;;;;;;;2CAQ9C,CAAC;AACL,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAM9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1B,wBAAgB,OAAO,CACrB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GACrC,OAAO,CAAC,aAAa,CAAC,CAAC"}

package/esm/src/api/subscription/_methods/allMids.js

@@ -16,8 +16,8 @@ export const AllMidsRequest = /* @__PURE__ */ (() => {
 export const AllMidsEvent = /* @__PURE__ */ (() => {
     return v.pipe(v.object({
         /** Mapping of coin symbols to mid prices. */
-        mids: AllMidsResponse,
-        /** DEX name (undefined for main dex). */
+        mids: v.pipe(AllMidsResponse, v.description("Mapping of coin symbols to mid prices.")),
+        /** DEX name (empty string for main dex). */
         dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
     }), v.description("Event of mid prices for all assets."));
 })();

package/esm/src/api/subscription/_methods/allMids.js.map

@@ -1 +1 @@
-{"version":3,"file":"allMids.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,0CAA0C;AAC1C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,6CAA6C;QAC7C,IAAI,EAAE,eAAe;QACrB,yCAAyC;QACzC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAiDL,MAAM,UAAU,OAAO,CACrB,MAA0B,EAC1B,gBAAoE,EACpE,aAA4C;IAE5C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE;QACtC,IAAI,EAAE,SAAS;QACf,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,SAAS,EAAE,4BAA4B;KAC3D,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAe,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC3E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"allMids.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/allMids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,0CAA0C;AAC1C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,6CAA6C;QAC7C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAiDL,MAAM,UAAU,OAAO,CACrB,MAA0B,EAC1B,gBAAoE,EACpE,aAA4C;IAE5C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE;QACtC,IAAI,EAAE,SAAS;QACf,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,SAAS,EAAE,4BAA4B;KAC3D,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAe,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC3E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -16,26 +16,16 @@ export declare const AssetCtxsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "DEX name (empty string for main dex).">]>;
     /** Array of context information for each perpetual asset. */
     readonly ctxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Previous day's closing price. */
-        readonly prevDayPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Previous day's closing price.">]>;
-        /** Daily notional volume. */
-        readonly dayNtlVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily notional volume.">]>;
-        /** Mark price. */
-        readonly markPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Mark price.">]>;
-        /** Mid price. */
-        readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
-        /** Funding rate. */
-        readonly funding: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Funding rate.">]>;
-        /** Total open interest. */
-        readonly openInterest: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total open interest.">]>;
-        /** Premium price. */
-        readonly premium: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<string | null, "Premium price.">]>;
-        /** Oracle price. */
-        readonly oraclePx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Oracle price.">]>;
-        /** Array of impact prices. */
+        readonly prevDayPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Previous day's closing price.">]>;
+        readonly dayNtlVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily notional volume.">]>;
+        readonly markPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Mark price.">]>;
+        readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
+        readonly funding: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Funding rate.">]>;
+        readonly openInterest: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total open interest.">]>;
+        readonly premium: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<string | null, "Premium price.">]>;
+        readonly oraclePx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Oracle price.">]>;
         readonly impactPxs: v.SchemaWithPipe<readonly [v.NullableSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>, v.DescriptionAction<string[] | null, "Array of impact prices.">]>;
-        /** Daily volume in base currency. */
-        readonly dayBaseVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+        readonly dayBaseVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
     }, undefined>, v.DescriptionAction<{
         prevDayPx: string;
         dayNtlVlm: string;
@@ -47,7 +37,7 @@ export declare const AssetCtxsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         oraclePx: string;
         impactPxs: string[] | null;
         dayBaseVlm: string;
-    }, "Context for a specific perpetual asset.">]>, undefined>, v.DescriptionAction<{
+    }, "Perpetual asset context.">]>, undefined>, v.DescriptionAction<{
         prevDayPx: string;
         dayNtlVlm: string;
         markPx: string;
@@ -76,7 +66,7 @@ export declare const AssetCtxsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
 }, "Event of asset contexts for all perpetual assets on a specified DEX.">]>;
 export type AssetCtxsEvent = v.InferOutput<typeof AssetCtxsEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /** Request parameters for the {@linkcode assetCtxs} function. */
 export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "type">;
 /**
@@ -86,7 +76,7 @@ export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "t
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -104,6 +94,6 @@ export type AssetCtxsParameters = Omit<v.InferInput<typeof AssetCtxsRequest>, "t
  * );
  * ```
  */
-export declare function assetCtxs(config: SubscriptionConfig, listener: (data: AssetCtxsEvent) => void): Promise<WebSocketSubscription>;
-export declare function assetCtxs(config: SubscriptionConfig, params: AssetCtxsParameters, listener: (data: AssetCtxsEvent) => void): Promise<WebSocketSubscription>;
+export declare function assetCtxs(config: SubscriptionConfig, listener: (data: AssetCtxsEvent) => void): Promise<ISubscription>;
+export declare function assetCtxs(config: SubscriptionConfig, params: AssetCtxsParameters, listener: (data: AssetCtxsEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=assetCtxs.d.ts.map

package/esm/src/api/subscription/_methods/assetCtxs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assetCtxs.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB;IAGvB,4BAA4B;;IAK5B,4CAA4C;;;;;gEAQ9C,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,2EAA2E;AAC3E,eAAO,MAAM,cAAc;IAGrB,4CAA4C;;IAK5C,6DAA6D;;QAMrD,oCAAoC;;QAKpC,6BAA6B;;QAK7B,kBAAkB;;QAKlB,iBAAiB;;QAKjB,oBAAoB;;QAKpB,2BAA2B;;QAK3B,qBAAqB;;QAKrB,oBAAoB;;QAKpB,8BAA8B;;QAK9B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAc/C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAMlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAClC,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"assetCtxs.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB;IAGvB,4BAA4B;;IAK5B,4CAA4C;;;;;gEAQ9C,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,2EAA2E;AAC3E,eAAO,MAAM,cAAc;IAGrB,4CAA4C;;IAK5C,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAQ/D,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAMlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,aAAa,CAAC,CAAC;AAC1B,wBAAgB,SAAS,CACvB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,aAAa,CAAC,CAAC"}

package/esm/src/api/subscription/_methods/assetCtxs.js

@@ -2,7 +2,7 @@ import * as v from "valibot";
 // ============================================================
 // API Schemas
 // ============================================================
-import { Decimal, UnsignedDecimal } from "../../_schemas.js";
+import { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
 /** Subscription to context events for all perpetual assets. */
 export const AssetCtxsRequest = /* @__PURE__ */ (() => {
     return v.pipe(v.object({
@@ -18,30 +18,7 @@ export const AssetCtxsEvent = /* @__PURE__ */ (() => {
         /** DEX name (empty string for main dex). */
         dex: v.pipe(v.string(), v.description("DEX name (empty string for main dex).")),
         /** Array of context information for each perpetual asset. */
-        ctxs: v.pipe(v.array(
-        /** Context for a specific perpetual asset. */
-        v.pipe(v.object({
-            /** Previous day's closing price. */
-            prevDayPx: v.pipe(UnsignedDecimal, v.description("Previous day's closing price.")),
-            /** Daily notional volume. */
-            dayNtlVlm: v.pipe(UnsignedDecimal, v.description("Daily notional volume.")),
-            /** Mark price. */
-            markPx: v.pipe(UnsignedDecimal, v.description("Mark price.")),
-            /** Mid price. */
-            midPx: v.pipe(v.nullable(UnsignedDecimal), v.description("Mid price.")),
-            /** Funding rate. */
-            funding: v.pipe(Decimal, v.description("Funding rate.")),
-            /** Total open interest. */
-            openInterest: v.pipe(UnsignedDecimal, v.description("Total open interest.")),
-            /** Premium price. */
-            premium: v.pipe(v.nullable(Decimal), v.description("Premium price.")),
-            /** Oracle price. */
-            oraclePx: v.pipe(UnsignedDecimal, v.description("Oracle price.")),
-            /** Array of impact prices. */
-            impactPxs: v.pipe(v.nullable(v.array(v.string())), v.description("Array of impact prices.")),
-            /** Daily volume in base currency. */
-            dayBaseVlm: v.pipe(UnsignedDecimal, v.description("Daily volume in base currency.")),
-        }), v.description("Context for a specific perpetual asset."))), v.description("Array of context information for each perpetual asset.")),
+        ctxs: v.pipe(v.array(PerpAssetCtxSchema), v.description("Array of context information for each perpetual asset.")),
     }), v.description("Event of asset contexts for all perpetual assets on a specified DEX."));
 })();
 export function assetCtxs(config, paramsOrListener, maybeListener) {

package/esm/src/api/subscription/_methods/assetCtxs.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetCtxs.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,2EAA2E;AAC3E,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;QACD,6DAA6D;QAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK;QACL,8CAA8C;QAC9C,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oCAAoC;YACpC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;YACD,6BAA6B;YAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,kBAAkB;YAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,iBAAiB;YACjB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B;YACD,oBAAoB;YACpB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,2BAA2B;YAC3B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,qBAAqB;YACrB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,oBAAoB;YACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,8BAA8B;YAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,qCAAqC;YACrC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sEAAsE,CAAC,CACtF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AA+CL,MAAM,UAAU,SAAS,CACvB,MAA0B,EAC1B,gBAAwE,EACxE,aAA8C;IAE9C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE;QACxC,IAAI,EAAE,WAAW;QACjB,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"assetCtxs.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/assetCtxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAEhF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,2EAA2E;AAC3E,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;QACD,6DAA6D;QAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sEAAsE,CAAC,CACtF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AA+CL,MAAM,UAAU,SAAS,CACvB,MAA0B,EAC1B,gBAAwE,EACxE,aAA8C;IAE9C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;IAE5F,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE;QACxC,IAAI,EAAE,WAAW;QACjB,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7E,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -15,26 +15,26 @@ export declare const BboEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Asset symbol (e.g., BTC). */
     readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
     /** Time of the BBO update (in ms since epoch). */
-    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Time of the BBO update (in ms since epoch).">]>;
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Time of the BBO update (in ms since epoch).">]>;
     /** Best bid and offer tuple [bid, offer], either can be undefined if unavailable. */
     readonly bbo: v.SchemaWithPipe<readonly [v.TupleSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
         /** Price. */
-        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Price.">]>;
+        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Price.">]>;
         /** Total size. */
-        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total size.">]>;
+        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total size.">]>;
         /** Number of individual orders. */
-        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
+        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
     }, undefined>, v.DescriptionAction<{
         px: string;
         sz: string;
         n: number;
     }, "L2 order book level.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
         /** Price. */
-        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Price.">]>;
+        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Price.">]>;
         /** Total size. */
-        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total size.">]>;
+        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total size.">]>;
         /** Number of individual orders. */
-        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
+        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
     }, undefined>, v.DescriptionAction<{
         px: string;
         sz: string;
@@ -63,7 +63,7 @@ export declare const BboEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
 }, "Event of best bid and offer.">]>;
 export type BboEvent = v.InferOutput<typeof BboEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /** Request parameters for the {@linkcode bbo} function. */
 export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
 /**
@@ -73,7 +73,7 @@ export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -94,5 +94,5 @@ export type BboParameters = Omit<v.InferInput<typeof BboRequest>, "type">;
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function bbo(config: SubscriptionConfig, params: BboParameters, listener: (data: BboEvent) => void): Promise<WebSocketSubscription>;
+export declare function bbo(config: SubscriptionConfig, params: BboParameters, listener: (data: BboEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=bbo.d.ts.map

package/esm/src/api/subscription/_methods/bbo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bbo.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,sEAAsE;AACtE,eAAO,MAAM,UAAU;IAGjB,4BAA4B;;IAK5B,gCAAgC;;;;;uEAQlC,CAAC;AACL,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,UAAU,CAAC,CAAC;AAyB1D,mCAAmC;AACnC,eAAO,MAAM,QAAQ;IAGf,gCAAgC;;IAKhC,kDAAkD;;IAKlD,qFAAqF;;QAlCrF,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;QAVnC,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAgCrC,CAAC;AACL,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,QAAQ,CAAC,CAAC;AAMtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,GAAG,CACjB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GACjC,OAAO,CAAC,qBAAqB,CAAC,CAOhC"}
+{"version":3,"file":"bbo.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,sEAAsE;AACtE,eAAO,MAAM,UAAU;IAGjB,4BAA4B;;IAK5B,gCAAgC;;;;;uEAQlC,CAAC;AACL,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,UAAU,CAAC,CAAC;AAyB1D,mCAAmC;AACnC,eAAO,MAAM,QAAQ;IAGf,gCAAgC;;IAKhC,kDAAkD;;IAKlD,qFAAqF;;QAlCrF,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;QAVnC,aAAa;;QAKb,kBAAkB;;QAKlB,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAgCrC,CAAC;AACL,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,QAAQ,CAAC,CAAC;AAMtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,GAAG,CACjB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GACjC,OAAO,CAAC,aAAa,CAAC,CAOxB"}

package/esm/src/api/subscription/_methods/bbo.js

@@ -12,7 +12,7 @@ export const BboRequest = /* @__PURE__ */ (() => {
         coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
     }), v.description("Subscription to best bid and offer events for a specific asset."));
 })();
-const L2BookLevel = /* @__PURE__ */ (() => {
+const L2BookLevelSchema = /* @__PURE__ */ (() => {
     return v.pipe(v.object({
         /** Price. */
         px: v.pipe(UnsignedDecimal, v.description("Price.")),
@@ -30,7 +30,7 @@ export const BboEvent = /* @__PURE__ */ (() => {
         /** Time of the BBO update (in ms since epoch). */
         time: v.pipe(UnsignedInteger, v.description("Time of the BBO update (in ms since epoch).")),
         /** Best bid and offer tuple [bid, offer], either can be undefined if unavailable. */
-        bbo: v.pipe(v.tuple([L2BookLevel, L2BookLevel]), v.description("Best bid and offer tuple [bid, offer], either can be undefined if unavailable.")),
+        bbo: v.pipe(v.tuple([L2BookLevelSchema, L2BookLevelSchema]), v.description("Best bid and offer tuple [bid, offer], either can be undefined if unavailable.")),
     }), v.description("Event of best bid and offer."));
 })();
 /**
@@ -40,7 +40,7 @@ export const BboEvent = /* @__PURE__ */ (() => {
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.

package/esm/src/api/subscription/_methods/bbo.js.map

@@ -1 +1 @@
-{"version":3,"file":"bbo.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,sEAAsE;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC9C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAChB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxC,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,aAAa;QACb,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;QACD,kBAAkB;QAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,mCAAmC;QACnC,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAEL,mCAAmC;AACnC,MAAM,CAAC,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC5C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kDAAkD;QAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,qFAAqF;QACrF,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,EACnC,CAAC,CAAC,WAAW,CAAC,gFAAgF,CAAC,CAChG;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,GAAG,CACjB,MAA0B,EAC1B,MAAqB,EACrB,QAAkC;IAElC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAW,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACvE,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"bbo.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/bbo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,sEAAsE;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC9C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAChB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC9C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,aAAa;QACb,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;QACD,kBAAkB;QAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,mCAAmC;QACnC,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAEL,mCAAmC;AACnC,MAAM,CAAC,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC5C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kDAAkD;QAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,qFAAqF;QACrF,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,EAC/C,CAAC,CAAC,WAAW,CAAC,gFAAgF,CAAC,CAChG;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,GAAG,CACjB,MAA0B,EAC1B,MAAqB,EACrB,QAAkC;IAElC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAW,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACvE,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -16,25 +16,25 @@ export type CandleRequest = v.InferOutput<typeof CandleRequest>;
 /** Event of candlestick data point. */
 export declare const CandleEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Opening timestamp (ms since epoch). */
-    readonly t: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Opening timestamp (ms since epoch).">]>;
+    readonly t: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Opening timestamp (ms since epoch).">]>;
     /** Closing timestamp (ms since epoch). */
-    readonly T: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Closing timestamp (ms since epoch).">]>;
+    readonly T: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Closing timestamp (ms since epoch).">]>;
     /** Asset symbol. */
     readonly s: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
     /** Time interval. */
     readonly i: v.SchemaWithPipe<readonly [v.PicklistSchema<["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Time interval.">]>;
     /** Opening price. */
-    readonly o: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Opening price.">]>;
+    readonly o: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Opening price.">]>;
     /** Closing price. */
-    readonly c: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Closing price.">]>;
+    readonly c: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Closing price.">]>;
     /** Highest price. */
-    readonly h: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Highest price.">]>;
+    readonly h: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Highest price.">]>;
     /** Lowest price. */
-    readonly l: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Lowest price.">]>;
+    readonly l: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Lowest price.">]>;
     /** Total volume traded in base currency. */
-    readonly v: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total volume traded in base currency.">]>;
+    readonly v: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total volume traded in base currency.">]>;
     /** Number of trades executed. */
-    readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of trades executed.">]>;
+    readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of trades executed.">]>;
 }, undefined>, v.DescriptionAction<{
     t: number;
     T: number;
@@ -49,7 +49,7 @@ export declare const CandleEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
 }, "Event of candlestick data point.">]>;
 export type CandleEvent = v.InferOutput<typeof CandleEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /** Request parameters for the {@linkcode candle} function. */
 export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
 /**
@@ -59,7 +59,7 @@ export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
@@ -80,5 +80,5 @@ export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function candle(config: SubscriptionConfig, params: CandleParameters, listener: (data: CandleEvent) => void): Promise<WebSocketSubscription>;
+export declare function candle(config: SubscriptionConfig, params: CandleParameters, listener: (data: CandleEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=candle.d.ts.map

package/esm/src/api/subscription/_methods/candle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"candle.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/candle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,iFAAiF;AACjF,eAAO,MAAM,aAAa;IAGpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qBAAqB;;;;;;kFAQvB,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,uCAAuC;AACvC,eAAO,MAAM,WAAW;IAGlB,0CAA0C;;IAK1C,0CAA0C;;IAK1C,oBAAoB;;IAKpB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,oBAAoB;;IAKpB,4CAA4C;;IAK5C,iCAAiC;;;;;;;;;;;;;wCAQnC,CAAC;AACL,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;AAM5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,qBAAqB,CAAC,CAOhC"}
+{"version":3,"file":"candle.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/candle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,iFAAiF;AACjF,eAAO,MAAM,aAAa;IAGpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qBAAqB;;;;;;kFAQvB,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,uCAAuC;AACvC,eAAO,MAAM,WAAW;IAGlB,0CAA0C;;IAK1C,0CAA0C;;IAK1C,oBAAoB;;IAKpB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,oBAAoB;;IAKpB,4CAA4C;;IAK5C,iCAAiC;;;;;;;;;;;;;wCAQnC,CAAC;AACL,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;AAM5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,aAAa,CAAC,CAOxB"}

package/esm/src/api/subscription/_methods/candle.js

@@ -46,7 +46,7 @@ export const CandleEvent = /* @__PURE__ */ (() => {
  * @param params - Parameters specific to the API subscription.
  * @param listener - A callback function to be called when the event is received.
  *
- * @returns A request-promise that resolves with a {@link WebSocketSubscription} object to manage the subscription lifecycle.
+ * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
  *
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.