@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.0

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

@@ -0,0 +1,81 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to candlestick events for a specific asset and time interval. */
+export declare const CandleRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"candle", undefined>, v.DescriptionAction<"candle", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Time interval. */
+    readonly interval: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"1m", undefined>, v.LiteralSchema<"3m", undefined>, v.LiteralSchema<"5m", undefined>, v.LiteralSchema<"15m", undefined>, v.LiteralSchema<"30m", undefined>, v.LiteralSchema<"1h", undefined>, v.LiteralSchema<"2h", undefined>, v.LiteralSchema<"4h", undefined>, v.LiteralSchema<"8h", undefined>, v.LiteralSchema<"12h", undefined>, v.LiteralSchema<"1d", undefined>, v.LiteralSchema<"3d", undefined>, v.LiteralSchema<"1w", undefined>, v.LiteralSchema<"1M", undefined>], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Time interval.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "candle";
+    coin: string;
+    interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
+}, "Subscription to candlestick events for a specific asset and time interval.">]>;
+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.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.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.">]>;
+    /** Candle interval. */
+    readonly i: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"1m", undefined>, v.LiteralSchema<"3m", undefined>, v.LiteralSchema<"5m", undefined>, v.LiteralSchema<"15m", undefined>, v.LiteralSchema<"30m", undefined>, v.LiteralSchema<"1h", undefined>, v.LiteralSchema<"2h", undefined>, v.LiteralSchema<"4h", undefined>, v.LiteralSchema<"8h", undefined>, v.LiteralSchema<"12h", undefined>, v.LiteralSchema<"1d", undefined>, v.LiteralSchema<"3d", undefined>, v.LiteralSchema<"1w", undefined>, v.LiteralSchema<"1M", undefined>], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Candle 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of trades executed.">]>;
+}, undefined>, v.DescriptionAction<{
+    t: number;
+    T: number;
+    s: string;
+    i: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
+    o: string;
+    c: string;
+    h: string;
+    l: string;
+    v: string;
+    n: number;
+}, "Event of candlestick data point.">]>;
+export type CandleEvent = v.InferOutput<typeof CandleEvent>;
+/** Request parameters for the {@linkcode candle} function. */
+export type CandleParameters = Omit<v.InferInput<typeof CandleRequest>, "type">;
+/**
+ * Subscribe to candlestick data updates for a specific asset.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { candle } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await candle(
+ *   { transport },
+ *   { coin: "ETH", interval: "1h" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function candle(config: SubscriptionRequestConfig, params: DeepImmutable<CandleParameters>, listener: (data: CandleEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=candle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"candle.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/candle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC7F,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,iFAAiF;AACjF,eAAO,MAAM,aAAa;IAGpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qBAAqB;;;;;;kFAuBvB,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,uBAAuB;;IAoBvB,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;AAI5D,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,gBAAgB,CAAC,EACvC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,YAAY,CAAC,CAOvB"}

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

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to candlestick events for a specific asset and time interval. */
+export const CandleRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("candle"), v.description("Type of subscription.")),
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+        /** Time interval. */
+        interval: v.pipe(v.union([
+            v.literal("1m"),
+            v.literal("3m"),
+            v.literal("5m"),
+            v.literal("15m"),
+            v.literal("30m"),
+            v.literal("1h"),
+            v.literal("2h"),
+            v.literal("4h"),
+            v.literal("8h"),
+            v.literal("12h"),
+            v.literal("1d"),
+            v.literal("3d"),
+            v.literal("1w"),
+            v.literal("1M"),
+        ]), v.description("Time interval.")),
+    }), v.description("Subscription to candlestick events for a specific asset and time interval."));
+})();
+/** Event of candlestick data point. */
+export const CandleEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Opening timestamp (ms since epoch). */
+        t: v.pipe(UnsignedInteger, v.description("Opening timestamp (ms since epoch).")),
+        /** Closing timestamp (ms since epoch). */
+        T: v.pipe(UnsignedInteger, v.description("Closing timestamp (ms since epoch).")),
+        /** Asset symbol. */
+        s: v.pipe(v.string(), v.description("Asset symbol.")),
+        /** Candle interval. */
+        i: v.pipe(v.union([
+            v.literal("1m"),
+            v.literal("3m"),
+            v.literal("5m"),
+            v.literal("15m"),
+            v.literal("30m"),
+            v.literal("1h"),
+            v.literal("2h"),
+            v.literal("4h"),
+            v.literal("8h"),
+            v.literal("12h"),
+            v.literal("1d"),
+            v.literal("3d"),
+            v.literal("1w"),
+            v.literal("1M"),
+        ]), v.description("Candle interval.")),
+        /** Opening price. */
+        o: v.pipe(UnsignedDecimal, v.description("Opening price.")),
+        /** Closing price. */
+        c: v.pipe(UnsignedDecimal, v.description("Closing price.")),
+        /** Highest price. */
+        h: v.pipe(UnsignedDecimal, v.description("Highest price.")),
+        /** Lowest price. */
+        l: v.pipe(UnsignedDecimal, v.description("Lowest price.")),
+        /** Total volume traded in base currency. */
+        v: v.pipe(UnsignedDecimal, v.description("Total volume traded in base currency.")),
+        /** Number of trades executed. */
+        n: v.pipe(UnsignedInteger, v.description("Number of trades executed.")),
+    }), v.description("Event of candlestick data point."));
+})();
+/**
+ * Subscribe to candlestick data updates for a specific asset.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { candle } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await candle(
+ *   { transport },
+ *   { coin: "ETH", interval: "1h" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function candle(config, params, listener) {
+    const payload = parser(CandleRequest)({ type: "candle", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.s === payload.coin && e.detail.i === payload.interval) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=candle.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"candle.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/candle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI7F,oDAAoD;AAEpD,iFAAiF;AACjF,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,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;QACD,qBAAqB;QACrB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;SAChB,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4EAA4E,CAAC,CAC5F,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,uCAAuC;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC/C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,0CAA0C;QAC1C,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;QACD,0CAA0C;QAC1C,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;QACD,oBAAoB;QACpB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,uBAAuB;QACvB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;SAChB,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,qBAAqB;QACrB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,qBAAqB;QACrB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,qBAAqB;QACrB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,oBAAoB;QACpB,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,4CAA4C;QAC5C,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;QACD,iCAAiC;QACjC,CAAC,EAAE,CAAC,CAAC,IAAI,CACP,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,MAAM,CACpB,MAAiC,EACjC,MAAuC,EACvC,QAAqC;IAErC,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACrE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAc,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1E,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/src/api/subscription/clearinghouseState.d.ts

@@ -0,0 +1,320 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to clearinghouse state events for a specific user. */
+export declare const ClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"clearinghouseState", undefined>, v.DescriptionAction<"clearinghouseState", "Type of subscription.">]>;
+    /** 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.">]>;
+    /** 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<{
+    type: "clearinghouseState";
+    user: `0x${string}`;
+    dex?: string | undefined;
+}, "Subscription to clearinghouse state events for a specific user.">]>;
+export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateRequest>;
+/** Event of clearinghouse state for a specific user. */
+export declare const ClearinghouseStateEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "DEX name (empty string for main dex).">]>;
+    /** 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<{
+        /** Margin summary details. */
+        readonly marginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Total account value. */
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total account value.">]>;
+            /** Total notional position value. */
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            /** Total raw USD value. */
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            /** Total margin used. */
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total margin used.">]>;
+        }, undefined>, v.DescriptionAction<{
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        }, "Margin summary details.">]>;
+        /** Cross-margin summary details. */
+        readonly crossMarginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Total account value. */
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total account value.">]>;
+            /** Total notional position value. */
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            /** Total raw USD value. */
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            /** Total margin used. */
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total margin used.">]>;
+        }, undefined>, v.DescriptionAction<{
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        }, "Cross-margin summary details.">]>;
+        /** Maintenance margin used for cross-margin positions. */
+        readonly crossMaintenanceMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Maintenance margin used for cross-margin positions.">]>;
+        /** Amount available for withdrawal. */
+        readonly withdrawable: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount available for withdrawal.">]>;
+        /** Array of asset positions. */
+        readonly assetPositions: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Position type. */
+            readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"oneWay", undefined>, v.DescriptionAction<"oneWay", "Position type.">]>;
+            /** Position details. */
+            readonly position: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Asset symbol. */
+                readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+                /** Signed position size. */
+                readonly szi: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
+                /** Leverage details. */
+                readonly leverage: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+                    /** Leverage type. */
+                    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isolated", undefined>, v.DescriptionAction<"isolated", "Leverage type.">]>;
+                    /** Leverage value used. */
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
+                    /** Amount of USD used (1 = 1$). */
+                    readonly rawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount of USD used (1 = 1$).">]>;
+                }, undefined>, v.ObjectSchema<{
+                    /** Leverage type. */
+                    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"cross", undefined>, v.DescriptionAction<"cross", "Leverage type.">]>;
+                    /** Leverage value used. */
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, 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;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                }, "Leverage details.">]>;
+                /** Average entry price. */
+                readonly entryPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Average entry price.">]>;
+                /** Position value. */
+                readonly positionValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Position value.">]>;
+                /** Unrealized profit and loss. */
+                readonly unrealizedPnl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Unrealized profit and loss.">]>;
+                /** Return on equity. */
+                readonly returnOnEquity: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Return on equity.">]>;
+                /** Liquidation price. */
+                readonly liquidationPx: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<string | null, "Liquidation price.">]>;
+                /** Margin used. */
+                readonly marginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Margin used.">]>;
+                /** Maximum allowed leverage. */
+                readonly maxLeverage: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
+                /** Cumulative funding details. */
+                readonly cumFunding: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /** Total funding paid or received since account opening. */
+                    readonly allTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total funding paid or received since account opening.">]>;
+                    /** Funding accumulated since the position was opened. */
+                    readonly sinceOpen: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Funding accumulated since the position was opened.">]>;
+                    /** Funding accumulated since the last change in position size. */
+                    readonly sinceChange: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Funding accumulated since the last change in position size.">]>;
+                }, undefined>, v.DescriptionAction<{
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                }, "Cumulative funding details.">]>;
+            }, undefined>, v.DescriptionAction<{
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            }, "Position details.">]>;
+        }, undefined>, v.DescriptionAction<{
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }, "Position for a specific asset.">]>, undefined>, v.DescriptionAction<{
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[], "Array of asset positions.">]>;
+        /** Timestamp when data was retrieved (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.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;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[];
+        time: number;
+    }, "Account summary for perpetual trading.">]>;
+}, undefined>, v.DescriptionAction<{
+    dex: string;
+    user: `0x${string}`;
+    clearinghouseState: {
+        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;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[];
+        time: number;
+    };
+}, "Event of clearinghouse state for a specific user.">]>;
+export type ClearinghouseStateEvent = v.InferOutput<typeof ClearinghouseStateEvent>;
+/** Request parameters for the {@linkcode clearinghouseState} function. */
+export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
+/**
+ * Subscribe to clearinghouse state updates for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { clearinghouseState } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await clearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function clearinghouseState(config: SubscriptionRequestConfig, params: DeepImmutable<ClearinghouseStateParameters>, listener: (data: ClearinghouseStateEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=clearinghouseState.d.ts.map

package/esm/src/api/subscription/clearinghouseState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearinghouseState.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/clearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC/G,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,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;;QAGzC,8BAA8B;;YAG1B,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,oCAAoC;;YAGhC,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,0DAA0D;;QAK1D,uCAAuC;;QAKvC,gCAAgC;;YAMxB,qBAAqB;;YAKrB,wBAAwB;;gBAGpB,oBAAoB;;gBAKpB,4BAA4B;;gBAK5B,wBAAwB;;oBAIlB,qBAAqB;;oBAKrB,2BAA2B;;oBAM3B,mCAAmC;;;oBAOnC,qBAAqB;;oBAKrB,2BAA2B;;;;;;;;;;gBAUjC,2BAA2B;;gBAK3B,sBAAsB;;gBAKtB,kCAAkC;;gBAKlC,wBAAwB;;gBAKxB,yBAAyB;;gBAKzB,mBAAmB;;gBAKnB,gCAAgC;;gBAMhC,kCAAkC;;oBAG9B,4DAA4D;;oBAK5D,yDAAyD;;oBAKzD,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAiBlF,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yDAWnE,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAIpF,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,4BAA4B,CAAC,EACnD,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,YAAY,CAAC,CAWvB"}