@nktkas/hyperliquid 0.25.0-beta.3 → 0.25.0

package/esm/src/api/info/blockDetails.js

@@ -0,0 +1,88 @@
+import * as v from "valibot";
+import { Address, Hex, parser, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request block details by block height.
+ * @see null
+ */
+export const BlockDetailsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("blockDetails"), v.description("Type of request.")),
+        /** Block height. */
+        height: v.pipe(UnsignedInteger, v.description("Block height.")),
+    }), v.description("Request block details by block height."));
+})();
+/**
+ * Response containing block information.
+ * @see null
+ */
+export const BlockDetailsResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of response. */
+        type: v.pipe(v.literal("blockDetails"), v.description("Type of response.")),
+        /** The details of a block. */
+        blockDetails: v.pipe(v.object({
+            /** Block creation timestamp. */
+            blockTime: v.pipe(UnsignedInteger, v.description("Block creation timestamp.")),
+            /** Block hash. */
+            hash: v.pipe(v.pipe(Hex, v.length(66)), v.description("Block hash.")),
+            /** Block height in chain. */
+            height: v.pipe(UnsignedInteger, v.description("Block height in chain.")),
+            /** Total transactions in block. */
+            numTxs: v.pipe(UnsignedInteger, v.description("Total transactions in block.")),
+            /** Block proposer address. */
+            proposer: v.pipe(Address, v.description("Block proposer address.")),
+            /** Array of transactions in the block. */
+            txs: v.pipe(v.array(
+            /** Transaction details. */
+            v.pipe(v.object({
+                /** Action performed in transaction. */
+                action: v.pipe(v.looseObject({
+                    /** Action type. */
+                    type: v.pipe(v.string(), v.description("Action type.")),
+                }), v.description("Action performed in transaction.")),
+                /** Block number where transaction was included. */
+                block: v.pipe(UnsignedInteger, v.description("Block number where transaction was included.")),
+                /** Error message if transaction failed. */
+                error: v.pipe(v.nullable(v.string()), v.description("Error message if transaction failed.")),
+                /** Transaction hash. */
+                hash: v.pipe(v.pipe(Hex, v.length(66)), v.description("Transaction hash.")),
+                /** Transaction creation timestamp. */
+                time: v.pipe(UnsignedInteger, v.description("Transaction creation timestamp.")),
+                /** Creator's address. */
+                user: v.pipe(Address, v.description("Creator's address.")),
+            }), v.description("Transaction details."))), v.description("Array of transactions in the block.")),
+        }), v.description("The details of a block.")),
+    }), v.description("Response containing block information."));
+})();
+/**
+ * Request block details by block height.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Response containing block information.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { blockDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // only `HttpTransport` supports this API
+ * const data = await blockDetails(
+ *   { transport },
+ *   { height: 123 },
+ * );
+ * ```
+ */
+export function blockDetails(config, params, signal) {
+    const request = parser(BlockDetailsRequest)({
+        type: "blockDetails",
+        ...params,
+    });
+    return config.transport.request("explorer", request, signal);
+}
+//# sourceMappingURL=blockDetails.js.map

package/esm/src/api/info/blockDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockDetails.js","sourceRoot":"","sources":["../../../../src/src/api/info/blockDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI1F,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,wBAAwB;QACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,8BAA8B;QAC9B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,MAAM,CAAC;YACP,gCAAgC;YAChC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,kBAAkB;YAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,6BAA6B;YAC7B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,mCAAmC;YACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,8BAA8B;YAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,0CAA0C;YAC1C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK;YACL,2BAA2B;YAC3B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;gBACP,uCAAuC;gBACvC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,WAAW,CAAC;oBACZ,mBAAmB;oBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;gBACD,mDAAmD;gBACnD,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;gBACD,2CAA2C;gBAC3C,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;gBACD,wBAAwB;gBACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,sCAAsC;gBACtC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;gBACD,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAA+G,EAC/G,MAA6C,EAC7C,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAC1C,IAAI,EAAE,cAAc;QACpB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC/D,CAAC"}

package/esm/src/api/info/candleSnapshot.d.ts

@@ -0,0 +1,111 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request candlestick snapshots.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ */
+export declare const CandleSnapshotRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"candleSnapshot", undefined>, v.DescriptionAction<"candleSnapshot", "Type of request.">]>;
+    /** Request parameters. */
+    readonly req: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Asset symbol (e.g., BTC). */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+        /** Time 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.">]>;
+        /** Start time (in ms since epoch). */
+        readonly startTime: 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, "Start time (in ms since epoch).">]>;
+        /** End time (in ms since epoch). */
+        readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<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>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
+        startTime: number;
+        endTime?: number | null | undefined;
+    }, "Request parameters.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "candleSnapshot";
+    req: {
+        coin: string;
+        interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
+        startTime: number;
+        endTime?: number | null | undefined;
+    };
+}, "Request candlestick snapshots.">]>;
+export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
+/**
+ * Array of candlestick data points.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ */
+export declare const CandleSnapshotResponse: v.SchemaWithPipe<readonly [v.ArraySchema<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;
+}, "Candlestick data point.">]>, 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;
+}[], "Array of candlestick data points.">]>;
+export type CandleSnapshotResponse = v.InferOutput<typeof CandleSnapshotResponse>;
+/** Request parameters for the {@linkcode candleSnapshot} function. */
+export type CandleSnapshotParameters = v.InferInput<typeof CandleSnapshotRequest>["req"];
+/**
+ * Request candlestick snapshots.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of candlestick data points.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { candleSnapshot } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await candleSnapshot(
+ *   { transport },
+ *   { coin: "ETH", interval: "1h", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export declare function candleSnapshot(config: InfoRequestConfig, params: DeepImmutable<CandleSnapshotParameters>, signal?: AbortSignal): Promise<CandleSnapshotResponse>;
+//# sourceMappingURL=candleSnapshot.d.ts.map

package/esm/src/api/info/candleSnapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"candleSnapshot.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/candleSnapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC7F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAG5B,uBAAuB;;IAKvB,0BAA0B;;QAGtB,gCAAgC;;QAKhC,qBAAqB;;QAoBrB,sCAAsC;;QAKtC,oCAAoC;;;;;;;;;;;;;;;;sCAW1C,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IAMzB,0CAA0C;;IAK1C,0CAA0C;;IAK1C,oBAAoB;;IAKpB,uBAAuB;;IAoBvB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,qBAAqB;;IAKrB,oBAAoB;;IAKpB,4CAA4C;;IAK5C,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;2CAWvC,CAAC;AACL,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAIlF,sEAAsE;AACtE,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,KAAK,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,wBAAwB,CAAC,EAC/C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,sBAAsB,CAAC,CAMjC"}

package/esm/src/api/info/candleSnapshot.js

@@ -0,0 +1,114 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request candlestick snapshots.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ */
+export const CandleSnapshotRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("candleSnapshot"), v.description("Type of request.")),
+        /** Request parameters. */
+        req: v.pipe(v.object({
+            /** 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.")),
+            /** Start time (in ms since epoch). */
+            startTime: v.pipe(UnsignedInteger, v.description("Start time (in ms since epoch).")),
+            /** End time (in ms since epoch). */
+            endTime: v.pipe(v.nullish(UnsignedInteger), v.description("End time (in ms since epoch).")),
+        }), v.description("Request parameters.")),
+    }), v.description("Request candlestick snapshots."));
+})();
+/**
+ * Array of candlestick data points.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ */
+export const CandleSnapshotResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** Candlestick data point. */
+    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("Candlestick data point."))), v.description("Array of candlestick data points."));
+})();
+/**
+ * Request candlestick snapshots.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of candlestick data points.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { candleSnapshot } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await candleSnapshot(
+ *   { transport },
+ *   { coin: "ETH", interval: "1h", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function candleSnapshot(config, params, signal) {
+    const request = parser(CandleSnapshotRequest)({
+        type: "candleSnapshot",
+        req: params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=candleSnapshot.js.map

package/esm/src/api/info/candleSnapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"candleSnapshot.js","sourceRoot":"","sources":["../../../../src/src/api/info/candleSnapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAG7F,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACzD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,0BAA0B;QAC1B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,CAAC;YACP,gCAAgC;YAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,qBAAqB;YACrB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CAAC;gBACN,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gBAChB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gBAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gBAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;aAChB,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,sCAAsC;YACtC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;YACD,oCAAoC;YACpC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,8BAA8B;IAC9B,CAAC,CAAC,IAAI,CACJ,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,yBAAyB,CAAC,CACzC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAyB,EACzB,MAA+C,EAC/C,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAC5C,IAAI,EAAE,gBAAgB;QACtB,GAAG,EAAE,MAAM;KACZ,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,269 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request clearinghouse state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+export declare const ClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"clearinghouseState", undefined>, v.DescriptionAction<"clearinghouseState", "Type of request.">]>;
+    /** 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;
+}, "Request clearinghouse state.">]>;
+export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateRequest>;
+/**
+ * Account summary for perpetual trading.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+export declare const ClearinghouseStateResponse: 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.">]>;
+export type ClearinghouseStateResponse = v.InferOutput<typeof ClearinghouseStateResponse>;
+/** Request parameters for the {@linkcode clearinghouseState} function. */
+export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
+/**
+ * Request clearinghouse state.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Account summary for perpetual trading.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { clearinghouseState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await clearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function clearinghouseState(config: InfoRequestConfig, params: DeepImmutable<ClearinghouseStateParameters>, signal?: AbortSignal): Promise<ClearinghouseStateResponse>;
+//# sourceMappingURL=clearinghouseState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clearinghouseState.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/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,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,yBAAyB;IAGhC,uBAAuB;;IAKvB,oBAAoB;;IAKpB,4CAA4C;;;;;;oCAQ9C,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF;;;GAGG;AACH,eAAO,MAAM,0BAA0B;IAGjC,8BAA8B;;QAG1B,2BAA2B;;QAK3B,qCAAqC;;QAKrC,2BAA2B;;QAK3B,yBAAyB;;;;;;;;IAQ7B,oCAAoC;;QAGhC,2BAA2B;;QAK3B,qCAAqC;;QAKrC,2BAA2B;;QAK3B,yBAAyB;;;;;;;;IAQ7B,0DAA0D;;IAK1D,uCAAuC;;IAKvC,gCAAgC;;QAMxB,qBAAqB;;QAKrB,wBAAwB;;YAGpB,oBAAoB;;YAKpB,4BAA4B;;YAK5B,wBAAwB;;gBAIlB,qBAAqB;;gBAKrB,2BAA2B;;gBAM3B,mCAAmC;;;gBAOnC,qBAAqB;;gBAKrB,2BAA2B;;;;;;;;;;YAUjC,2BAA2B;;YAK3B,sBAAsB;;YAKtB,kCAAkC;;YAKlC,wBAAwB;;YAKxB,yBAAyB;;YAKzB,mBAAmB;;YAKnB,gCAAgC;;YAMhC,kCAAkC;;gBAG9B,4DAA4D;;gBAK5D,yDAAyD;;gBAKzD,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiBlF,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8CAQ/D,CAAC;AACL,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAI1F,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,4BAA4B,CAAC,EACnD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,0BAA0B,CAAC,CAMrC"}