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

package/script/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.NumberSchema<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.NumberSchema<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.StringSchema<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.StringSchema<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.StringSchema<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.StringSchema<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.StringSchema<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.NumberSchema<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/script/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/script/src/api/subscription/_methods/candle.js

@@ -83,7 +83,7 @@ exports.CandleEvent = (() => {
  * @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/script/src/api/subscription/_methods/clearinghouseState.d.ts

@@ -20,12 +20,12 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
     /** User address. */
     readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
     /** Account summary for perpetual trading. */
-    readonly clearinghouseState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly clearinghouseState: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.ObjectSchema<{
         readonly marginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            readonly accountValue: 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 account value.">]>;
-            readonly totalNtlPos: 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 notional position value.">]>;
-            readonly totalRawUsd: 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 raw USD value.">]>;
-            readonly totalMarginUsed: 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 margin used.">]>;
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total account value.">]>;
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total margin used.">]>;
         }, undefined>, v.DescriptionAction<{
             accountValue: string;
             totalNtlPos: string;
@@ -33,30 +33,30 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
             totalMarginUsed: string;
         }, "Margin summary details.">]>;
         readonly crossMarginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            readonly accountValue: 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 account value.">]>;
-            readonly totalNtlPos: 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 notional position value.">]>;
-            readonly totalRawUsd: 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 raw USD value.">]>;
-            readonly totalMarginUsed: 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 margin used.">]>;
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total account value.">]>;
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total margin used.">]>;
         }, undefined>, v.DescriptionAction<{
             accountValue: string;
             totalNtlPos: string;
             totalRawUsd: string;
             totalMarginUsed: string;
         }, "Cross-margin summary details.">]>;
-        readonly crossMaintenanceMarginUsed: 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, "Maintenance margin used for cross-margin positions.">]>;
-        readonly withdrawable: 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, "Amount available for withdrawal.">]>;
-        readonly assetPositions: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly crossMaintenanceMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Maintenance margin used for cross-margin positions.">]>;
+        readonly withdrawable: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Amount available for withdrawal.">]>;
+        readonly assetPositions: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
             readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"oneWay", undefined>, v.DescriptionAction<"oneWay", "Position type.">]>;
             readonly position: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                 readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-                readonly szi: 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, "Signed position size.">]>;
+                readonly szi: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Signed position size.">]>;
                 readonly leverage: v.SchemaWithPipe<readonly [v.VariantSchema<"type", [v.ObjectSchema<{
                     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isolated", undefined>, v.DescriptionAction<"isolated", "Leverage type.">]>;
-                    readonly value: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
-                    readonly rawUsd: 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, "Amount of USD used (1 = $1).">]>;
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
+                    readonly rawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Amount of USD used (1 = $1).">]>;
                 }, undefined>, v.ObjectSchema<{
                     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"cross", undefined>, v.DescriptionAction<"cross", "Leverage type.">]>;
-                    readonly value: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
                 }, undefined>], undefined>, v.DescriptionAction<{
                     type: "isolated";
                     value: number;
@@ -65,17 +65,17 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
                     type: "cross";
                     value: number;
                 }, "Leverage details.">]>;
-                readonly entryPx: 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, "Average entry price.">]>;
-                readonly positionValue: 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, "Position value.">]>;
-                readonly unrealizedPnl: 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, "Unrealized profit and loss.">]>;
-                readonly returnOnEquity: 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, "Return on equity.">]>;
-                readonly liquidationPx: 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, "Liquidation price.">]>;
-                readonly marginUsed: 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, "Margin used.">]>;
-                readonly maxLeverage: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
+                readonly entryPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Average entry price.">]>;
+                readonly positionValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Position value.">]>;
+                readonly unrealizedPnl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Unrealized profit and loss.">]>;
+                readonly returnOnEquity: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Return on equity.">]>;
+                readonly liquidationPx: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, undefined>, v.DescriptionAction<string | null, "Liquidation price.">]>;
+                readonly marginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Margin used.">]>;
+                readonly maxLeverage: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
                 readonly cumFunding: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-                    readonly allTime: 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 funding paid or received since account opening.">]>;
-                    readonly sinceOpen: 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 accumulated since the position was opened.">]>;
-                    readonly sinceChange: 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 accumulated since the last change in position size.">]>;
+                    readonly allTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Total funding paid or received since account opening.">]>;
+                    readonly sinceOpen: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Funding accumulated since the position was opened.">]>;
+                    readonly sinceChange: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Funding accumulated since the last change in position size.">]>;
                 }, undefined>, v.DescriptionAction<{
                     allTime: string;
                     sinceOpen: string;
@@ -105,7 +105,7 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
                     sinceChange: string;
                 };
             }, "Position details.">]>;
-        }, undefined>, v.DescriptionAction<{
+        }, undefined>, undefined>, v.DescriptionAction<{
             type: "oneWay";
             position: {
                 coin: string;
@@ -131,7 +131,24 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
                     sinceChange: string;
                 };
             };
-        }, "Position for a specific asset.">]>, undefined>, v.DescriptionAction<{
+        }[], "Array of asset positions.">]>;
+        readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when data was retrieved (in ms since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        marginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMarginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMaintenanceMarginUsed: string;
+        withdrawable: string;
+        assetPositions: {
             type: "oneWay";
             position: {
                 coin: string;
@@ -157,9 +174,9 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
                     sinceChange: string;
                 };
             };
-        }[], "Array of asset positions.">]>;
-        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, "Timestamp when data was retrieved (in ms since epoch).">]>;
-    }, undefined>, v.DescriptionAction<{
+        }[];
+        time: number;
+    }, "Account summary for perpetual trading.">]>, v.DescriptionAction<{
         marginSummary: {
             accountValue: string;
             totalNtlPos: string;
@@ -253,7 +270,7 @@ export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.Objec
 }, "Event of clearinghouse state for a specific user.">]>;
 export type ClearinghouseStateEvent = v.InferOutput<typeof ClearinghouseStateEvent>;
 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 clearinghouseState} function. */
 export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
 /**
@@ -263,7 +280,7 @@ export type ClearinghouseStateParameters = Omit<v.InferInput<typeof Clearinghous
  * @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.
@@ -281,6 +298,8 @@ export type ClearinghouseStateParameters = Omit<v.InferInput<typeof Clearinghous
  *   (data) => console.log(data),
  * );
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function clearinghouseState(config: SubscriptionConfig, params: ClearinghouseStateParameters, listener: (data: ClearinghouseStateEvent) => void): Promise<WebSocketSubscription>;
+export declare function clearinghouseState(config: SubscriptionConfig, params: ClearinghouseStateParameters, listener: (data: ClearinghouseStateEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=clearinghouseState.d.ts.map

package/script/src/api/subscription/_methods/clearinghouseState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clearinghouseState.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/clearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,sEAAsE;AACtE,eAAO,MAAM,yBAAyB;IAGhC,4BAA4B;;IAK5B,oBAAoB;;IAKpB,4CAA4C;;;;;;uEAQ9C,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,wDAAwD;AACxD,eAAO,MAAM,uBAAuB;IAG9B,4CAA4C;;IAK5C,oBAAoB;;IAKpB,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yDAK/C,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAMpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,qBAAqB,CAAC,CAWhC"}
+{"version":3,"file":"clearinghouseState.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/clearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,sEAAsE;AACtE,eAAO,MAAM,yBAAyB;IAGhC,4BAA4B;;IAK5B,oBAAoB;;IAKpB,4CAA4C;;;;;;uEAQ9C,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,wDAAwD;AACxD,eAAO,MAAM,uBAAuB;IAG9B,4CAA4C;;IAK5C,oBAAoB;;IAKpB,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yDAQ/C,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAMpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,aAAa,CAAC,CAWxB"}

package/script/src/api/subscription/_methods/clearinghouseState.js

@@ -60,7 +60,7 @@ exports.ClearinghouseStateEvent = (() => {
         /** User address. */
         user: v.pipe(_schemas_js_1.Address, v.description("User address.")),
         /** Account summary for perpetual trading. */
-        clearinghouseState: clearinghouseState_js_1.ClearinghouseStateResponse,
+        clearinghouseState: v.pipe(clearinghouseState_js_1.ClearinghouseStateResponse, v.description("Account summary for perpetual trading.")),
     }), v.description("Event of clearinghouse state for a specific user."));
 })();
 /**
@@ -70,7 +70,7 @@ exports.ClearinghouseStateEvent = (() => {
  * @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.
@@ -88,6 +88,8 @@ exports.ClearinghouseStateEvent = (() => {
  *   (data) => console.log(data),
  * );
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
 function clearinghouseState(config, params, listener) {
     const payload = v.parse(exports.ClearinghouseStateRequest, {

package/script/src/api/subscription/_methods/clearinghouseState.js.map

@@ -1 +1 @@
-{"version":3,"file":"clearinghouseState.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/clearinghouseState.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4FA,gDAeC;AA3GD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAA4C;AAC5C,qFAAuF;AAEvF,sEAAsE;AACzD,QAAA,yBAAyB,GAAmB,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;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,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,wDAAwD;AAC3C,QAAA,uBAAuB,GAAmB,CAAC,GAAG,EAAE;IAC3D,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,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,6CAA6C;QAC7C,kBAAkB,EAAE,kDAA0B;KAC/C,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,kBAAkB,CAChC,MAA0B,EAC1B,MAAoC,EACpC,QAAiD;IAEjD,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,iCAAyB,EAAE;QACjD,IAAI,EAAE,oBAAoB;QAC1B,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAA0B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACtF,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACnE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"clearinghouseState.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/clearinghouseState.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiGA,gDAeC;AAhHD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAA4C;AAC5C,qFAAuF;AAEvF,sEAAsE;AACzD,QAAA,yBAAyB,GAAmB,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;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,iEAAiE,CAAC,CACjF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,wDAAwD;AAC3C,QAAA,uBAAuB,GAAmB,CAAC,GAAG,EAAE;IAC3D,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,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,6CAA6C;QAC7C,kBAAkB,EAAE,CAAC,CAAC,IAAI,CACxB,kDAA0B,EAC1B,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAaL;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,kBAAkB,CAChC,MAA0B,EAC1B,MAAoC,EACpC,QAAiD;IAEjD,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,iCAAyB,EAAE;QACjD,IAAI,EAAE,oBAAoB;QAC1B,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,4BAA4B;KACpD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAA0B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACtF,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;YACnE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/script/src/api/subscription/_methods/explorerBlock.d.ts

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-/** Subscription to explorer block events (RPC endpoint). */
+/** Subscription to explorer block events. */
 export declare const ExplorerBlockRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Type of subscription. */
     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"explorerBlock", undefined>, v.DescriptionAction<"explorerBlock", "Type of subscription.">]>;
@@ -8,24 +8,18 @@ export declare const ExplorerBlockRequest: v.SchemaWithPipe<readonly [v.ObjectSc
 }, "Subscription to explorer block events.">]>;
 export type ExplorerBlockRequest = v.InferOutput<typeof ExplorerBlockRequest>;
 /** Event of array of block details. */
-export declare const ExplorerBlockEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+export declare const ExplorerBlockEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
     /** Block creation timestamp. */
-    readonly blockTime: 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, "Block creation timestamp.">]>;
+    readonly blockTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Block creation timestamp.">]>;
     /** Block hash. */
-    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Block hash.">]>;
+    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.DescriptionAction<`0x${string}`, "Block hash.">]>;
     /** Block height in chain. */
-    readonly height: 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, "Block height in chain.">]>;
+    readonly height: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Block height in chain.">]>;
     /** Total transactions in block. */
-    readonly numTxs: 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, "Total transactions in block.">]>;
+    readonly numTxs: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Total transactions in block.">]>;
     /** Block proposer address. */
     readonly proposer: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Block proposer address.">]>;
-}, undefined>, v.DescriptionAction<{
-    blockTime: number;
-    hash: `0x${string}`;
-    height: number;
-    numTxs: number;
-    proposer: `0x${string}`;
-}, "The details of a block.">]>, undefined>, v.DescriptionAction<{
+}, undefined>, undefined>, v.DescriptionAction<{
     blockTime: number;
     hash: `0x${string}`;
     height: number;
@@ -34,14 +28,14 @@ export declare const ExplorerBlockEvent: v.SchemaWithPipe<readonly [v.ArraySchem
 }[], "Event of array of block details.">]>;
 export type ExplorerBlockEvent = v.InferOutput<typeof ExplorerBlockEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /**
  * Subscribe to explorer block updates.
  *
  * @param config - General configuration for Subscription API subscriptions.
  * @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.
@@ -58,6 +52,8 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
  *   (data) => console.log(data),
  * );
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function explorerBlock(config: SubscriptionConfig, listener: (data: ExplorerBlockEvent) => void): Promise<WebSocketSubscription>;
+export declare function explorerBlock(config: SubscriptionConfig, listener: (data: ExplorerBlockEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=explorerBlock.d.ts.map

package/script/src/api/subscription/_methods/explorerBlock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"explorerBlock.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerBlock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,4DAA4D;AAC5D,eAAO,MAAM,oBAAoB;IAG3B,4BAA4B;;;;8CAQ9B,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E,uCAAuC;AACvC,eAAO,MAAM,kBAAkB;IAMrB,gCAAgC;;IAKhC,kBAAkB;;IAKlB,6BAA6B;;IAK7B,mCAAmC;;IAKnC,8BAA8B;;;;;;;;;;;;;;0CAWpC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,GAC3C,OAAO,CAAC,qBAAqB,CAAC,CAKhC"}
+{"version":3,"file":"explorerBlock.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerBlock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,6CAA6C;AAC7C,eAAO,MAAM,oBAAoB;IAG3B,4BAA4B;;;;8CAQ9B,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E,uCAAuC;AACvC,eAAO,MAAM,kBAAkB;IAIvB,gCAAgC;;IAKhC,kBAAkB;;IAMlB,6BAA6B;;IAK7B,mCAAmC;;IAKnC,8BAA8B;;;;;;;;0CASlC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,GAC3C,OAAO,CAAC,aAAa,CAAC,CAKxB"}

package/script/src/api/subscription/_methods/explorerBlock.js

@@ -40,7 +40,7 @@ const v = __importStar(require("valibot"));
 // API Schemas
 // ============================================================
 const _schemas_js_1 = require("../../_schemas.js");
-/** Subscription to explorer block events (RPC endpoint). */
+/** Subscription to explorer block events. */
 exports.ExplorerBlockRequest = (() => {
     return v.pipe(v.object({
         /** Type of subscription. */
@@ -49,20 +49,18 @@ exports.ExplorerBlockRequest = (() => {
 })();
 /** Event of array of block details. */
 exports.ExplorerBlockEvent = (() => {
-    return v.pipe(v.array(
-    /** Block details. */
-    v.pipe(v.object({
+    return v.pipe(v.array(v.object({
         /** Block creation timestamp. */
         blockTime: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Block creation timestamp.")),
         /** Block hash. */
-        hash: v.pipe(v.pipe(_schemas_js_1.Hex, v.length(66)), v.description("Block hash.")),
+        hash: v.pipe(_schemas_js_1.Hex, v.length(66), v.description("Block hash.")),
         /** Block height in chain. */
         height: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Block height in chain.")),
         /** Total transactions in block. */
         numTxs: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Total transactions in block.")),
         /** Block proposer address. */
         proposer: v.pipe(_schemas_js_1.Address, v.description("Block proposer address.")),
-    }), v.description("The details of a block."))), v.description("Event of array of block details."));
+    })), v.description("Event of array of block details."));
 })();
 /**
  * Subscribe to explorer block updates.
@@ -70,7 +68,7 @@ exports.ExplorerBlockEvent = (() => {
  * @param config - General configuration for Subscription API subscriptions.
  * @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.
@@ -87,6 +85,8 @@ exports.ExplorerBlockEvent = (() => {
  *   (data) => console.log(data),
  * );
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
 function explorerBlock(config, listener) {
     const payload = v.parse(exports.ExplorerBlockRequest, { type: "explorerBlock" });

package/script/src/api/subscription/_methods/explorerBlock.js.map

@@ -1 +1 @@
-{"version":3,"file":"explorerBlock.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerBlock.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+FA,sCAQC;AAvGD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAAkE;AAElE,4DAA4D;AAC/C,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,uCAAuC;AAC1B,QAAA,kBAAkB,GAAmB,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,qBAAqB;IACrB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kBAAkB;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,iBAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,6BAA6B;QAC7B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;QACD,mCAAmC;QACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,8BAA8B;QAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAUL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,aAAa,CAC3B,MAA0B,EAC1B,QAA4C;IAE5C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,4BAAoB,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAqB,gBAAgB,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACrF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"explorerBlock.js","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerBlock.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,sCAQC;AAtGD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAAkE;AAElE,6CAA6C;AAChC,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,uCAAuC;AAC1B,QAAA,kBAAkB,GAAmB,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kBAAkB;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,iBAAG,EACH,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EACZ,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,6BAA6B;QAC7B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;QACD,mCAAmC;QACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,8BAA8B;QAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;KACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAUL;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,aAAa,CAC3B,MAA0B,EAC1B,QAA4C;IAE5C,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,4BAAoB,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAqB,gBAAgB,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACrF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/script/src/api/subscription/_methods/explorerTxs.d.ts

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-/** Subscription to explorer transaction events (RPC endpoint). */
+/** Subscription to explorer transaction events. */
 export declare const ExplorerTxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Type of subscription. */
     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"explorerTxs", undefined>, v.DescriptionAction<"explorerTxs", "Type of subscription.">]>;
@@ -9,24 +9,17 @@ export declare const ExplorerTxsRequest: v.SchemaWithPipe<readonly [v.ObjectSche
 export type ExplorerTxsRequest = v.InferOutput<typeof ExplorerTxsRequest>;
 /** Event of array of transaction details. */
 export declare const ExplorerTxsEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Action performed in transaction. */
     readonly action: v.SchemaWithPipe<readonly [v.LooseObjectSchema<{
-        /** Action type. */
         readonly type: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Action type.">]>;
     }, undefined>, v.DescriptionAction<{
         type: string;
     } & {
         [key: string]: unknown;
     }, "Action performed in transaction.">]>;
-    /** Block number where transaction was included. */
-    readonly block: 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, "Block number where transaction was included.">]>;
-    /** Error message if transaction failed. */
+    readonly block: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Block number where transaction was included.">]>;
     readonly error: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Error message if transaction failed.">]>;
-    /** Transaction hash. */
-    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
-    /** Transaction creation timestamp. */
-    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, "Transaction creation timestamp.">]>;
-    /** Creator's address. */
+    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Transaction creation timestamp.">]>;
     readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Creator's address.">]>;
 }, undefined>, v.DescriptionAction<{
     action: {
@@ -39,7 +32,7 @@ export declare const ExplorerTxsEvent: v.SchemaWithPipe<readonly [v.ArraySchema<
     hash: `0x${string}`;
     time: number;
     user: `0x${string}`;
-}, "Transaction details.">]>, undefined>, v.DescriptionAction<{
+}, "Explorer transaction.">]>, undefined>, v.DescriptionAction<{
     action: {
         type: string;
     } & {
@@ -53,13 +46,13 @@ export declare const ExplorerTxsEvent: v.SchemaWithPipe<readonly [v.ArraySchema<
 }[], "Event of array of transaction details.">]>;
 export type ExplorerTxsEvent = v.InferOutput<typeof ExplorerTxsEvent>;
 import type { SubscriptionConfig } from "./_types.js";
-import type { WebSocketSubscription } from "../../../transport/websocket/mod.js";
+import type { ISubscription } from "../../../transport/mod.js";
 /**
  * Subscribe to explorer transaction updates.
  *
  * @param config - General configuration for Subscription API subscriptions.
  * @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.
@@ -76,6 +69,8 @@ import type { WebSocketSubscription } from "../../../transport/websocket/mod.js"
  *   (data) => console.log(data),
  * );
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
  */
-export declare function explorerTxs(config: SubscriptionConfig, listener: (data: ExplorerTxsEvent) => void): Promise<WebSocketSubscription>;
+export declare function explorerTxs(config: SubscriptionConfig, listener: (data: ExplorerTxsEvent) => void): Promise<ISubscription>;
 //# sourceMappingURL=explorerTxs.d.ts.map

package/script/src/api/subscription/_methods/explorerTxs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"explorerTxs.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerTxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;IAGzB,4BAA4B;;;;oDAQ9B,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,6CAA6C;AAC7C,eAAO,MAAM,gBAAgB;IAMnB,uCAAuC;;QAGnC,mBAAmB;;;;;;;IAQvB,mDAAmD;;IAKnD,2CAA2C;;IAK3C,wBAAwB;;IAKxB,sCAAsC;;IAKtC,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;gDAW/B,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,GACzC,OAAO,CAAC,qBAAqB,CAAC,CAKhC"}
+{"version":3,"file":"explorerTxs.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/subscription/_methods/explorerTxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,mDAAmD;AACnD,eAAO,MAAM,kBAAkB;IAGzB,4BAA4B;;;;oDAQ9B,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,6CAA6C;AAC7C,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gDAKzB,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,GACzC,OAAO,CAAC,aAAa,CAAC,CAKxB"}