@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,269 @@
+import * as v from "valibot";
+/**
+ * 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
+            /** Leverage details. */
+            readonly leverage: v.SchemaWithPipe<readonly [v.VariantSchema<"type", [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.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.">]>;
+                /** 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.StringSchema<undefined>, 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.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.">]>;
+            }, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Return on equity.">]>;
+            /** Liquidation price. */
+            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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, 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.StringSchema<undefined>, 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.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.">]>;
+            /** 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.StringSchema<undefined>, 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.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<{
+    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>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** 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/script/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;AAQ7B;;;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;AAM1F,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,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"}

package/script/src/api/info/clearinghouseState.js

@@ -0,0 +1,180 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClearinghouseStateResponse = exports.ClearinghouseStateRequest = void 0;
+exports.clearinghouseState = clearinghouseState;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _base_js_1 = require("../_base.js");
+/**
+ * Request clearinghouse state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+exports.ClearinghouseStateRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("clearinghouseState"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(_base_js_1.Address, v.description("User address.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Request clearinghouse state."));
+})();
+/**
+ * Account summary for perpetual trading.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+exports.ClearinghouseStateResponse = (() => {
+    return v.pipe(v.object({
+        /** Margin summary details. */
+        marginSummary: v.pipe(v.object({
+            /** Total account value. */
+            accountValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total account value.")),
+            /** Total notional position value. */
+            totalNtlPos: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total notional position value.")),
+            /** Total raw USD value. */
+            totalRawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total raw USD value.")),
+            /** Total margin used. */
+            totalMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total margin used.")),
+        }), v.description("Margin summary details.")),
+        /** Cross-margin summary details. */
+        crossMarginSummary: v.pipe(v.object({
+            /** Total account value. */
+            accountValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total account value.")),
+            /** Total notional position value. */
+            totalNtlPos: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total notional position value.")),
+            /** Total raw USD value. */
+            totalRawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total raw USD value.")),
+            /** Total margin used. */
+            totalMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total margin used.")),
+        }), v.description("Cross-margin summary details.")),
+        /** Maintenance margin used for cross-margin positions. */
+        crossMaintenanceMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Maintenance margin used for cross-margin positions.")),
+        /** Amount available for withdrawal. */
+        withdrawable: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount available for withdrawal.")),
+        /** Array of asset positions. */
+        assetPositions: v.pipe(v.array(
+        /** Position for a specific asset. */
+        v.pipe(v.object({
+            /** Position type. */
+            type: v.pipe(v.literal("oneWay"), v.description("Position type.")),
+            /** Position details. */
+            position: v.pipe(v.object({
+                /** Asset symbol. */
+                coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                /** Signed position size. */
+                szi: v.pipe(_base_js_1.Decimal, v.description("Signed position size.")),
+                /** Leverage details. */
+                leverage: v.pipe(v.variant("type", [
+                    v.object({
+                        /** Leverage type. */
+                        type: v.pipe(v.literal("isolated"), v.description("Leverage type.")),
+                        /** Leverage value used. */
+                        value: v.pipe(_base_js_1.UnsignedInteger, v.minValue(1), v.description("Leverage value used.")),
+                        /** Amount of USD used (1 = $1). */
+                        rawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount of USD used (1 = $1).")),
+                    }),
+                    v.object({
+                        /** Leverage type. */
+                        type: v.pipe(v.literal("cross"), v.description("Leverage type.")),
+                        /** Leverage value used. */
+                        value: v.pipe(_base_js_1.UnsignedInteger, v.minValue(1), v.description("Leverage value used.")),
+                    }),
+                ]), v.description("Leverage details.")),
+                /** Average entry price. */
+                entryPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Average entry price.")),
+                /** Position value. */
+                positionValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Position value.")),
+                /** Unrealized profit and loss. */
+                unrealizedPnl: v.pipe(_base_js_1.Decimal, v.description("Unrealized profit and loss.")),
+                /** Return on equity. */
+                returnOnEquity: v.pipe(_base_js_1.Decimal, v.description("Return on equity.")),
+                /** Liquidation price. */
+                liquidationPx: v.pipe(v.nullable(_base_js_1.UnsignedDecimal), v.description("Liquidation price.")),
+                /** Margin used. */
+                marginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Margin used.")),
+                /** Maximum allowed leverage. */
+                maxLeverage: v.pipe(_base_js_1.UnsignedInteger, v.minValue(1), v.description("Maximum allowed leverage.")),
+                /** Cumulative funding details. */
+                cumFunding: v.pipe(v.object({
+                    /** Total funding paid or received since account opening. */
+                    allTime: v.pipe(_base_js_1.Decimal, v.description("Total funding paid or received since account opening.")),
+                    /** Funding accumulated since the position was opened. */
+                    sinceOpen: v.pipe(_base_js_1.Decimal, v.description("Funding accumulated since the position was opened.")),
+                    /** Funding accumulated since the last change in position size. */
+                    sinceChange: v.pipe(_base_js_1.Decimal, v.description("Funding accumulated since the last change in position size.")),
+                }), v.description("Cumulative funding details.")),
+            }), v.description("Position details.")),
+        }), v.description("Position for a specific asset."))), v.description("Array of asset positions.")),
+        /** Timestamp when data was retrieved (in ms since epoch). */
+        time: v.pipe(_base_js_1.UnsignedInteger, v.description("Timestamp when data was retrieved (in ms since epoch).")),
+    }), v.description("Account summary for perpetual trading."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_2 = require("../_base.js");
+/**
+ * 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..." },
+ * );
+ * ```
+ */
+function clearinghouseState(config, params, signal) {
+    const request = (0, _base_js_2.parser)(exports.ClearinghouseStateRequest)({
+        type: "clearinghouseState",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=clearinghouseState.js.map

package/script/src/api/info/clearinghouseState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearinghouseState.js","sourceRoot":"","sources":["../../../../src/src/api/info/clearinghouseState.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmRA,gDAUC;AA7RD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,0CAAiF;AAEjF;;;GAGG;AACU,QAAA,yBAAyB,GAAmB,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,kBAAO,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,8BAA8B,CAAC,CAC9C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,0BAA0B,GAAmB,CAAC,GAAG,EAAE;IAC9D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,MAAM,CAAC;YACP,2BAA2B;YAC3B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,qCAAqC;YACrC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;YACD,2BAA2B;YAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,yBAAyB;YACzB,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;QACD,oCAAoC;QACpC,kBAAkB,EAAE,CAAC,CAAC,IAAI,CACxB,CAAC,CAAC,MAAM,CAAC;YACP,2BAA2B;YAC3B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,qCAAqC;YACrC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;YACD,2BAA2B;YAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,yBAAyB;YACzB,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,0DAA0D;QAC1D,0BAA0B,EAAE,CAAC,CAAC,IAAI,CAChC,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,qDAAqD,CAAC,CACrE;QACD,uCAAuC;QACvC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,gCAAgC;QAChC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK;QACL,qCAAqC;QACrC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,qBAAqB;YACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,wBAAwB;YACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,CAAC;gBACP,oBAAoB;gBACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,4BAA4B;gBAC5B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;gBACD,wBAAwB;gBACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE;oBAChB,CAAC,CAAC,MAAM,CAAC;wBACP,qBAAqB;wBACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;wBACD,2BAA2B;wBAC3B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,0BAAe,EACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACb,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;wBACD,mCAAmC;wBACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;qBACF,CAAC;oBACF,CAAC,CAAC,MAAM,CAAC;wBACP,qBAAqB;wBACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;wBACD,2BAA2B;wBAC3B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,0BAAe,EACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACb,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;qBACF,CAAC;iBACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,2BAA2B;gBAC3B,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,sBAAsB;gBACtB,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;gBACD,kCAAkC;gBAClC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;gBACD,wBAAwB;gBACxB,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,yBAAyB;gBACzB,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,QAAQ,CAAC,0BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,mBAAmB;gBACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,gCAAgC;gBAChC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACb,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;gBACD,kCAAkC;gBAClC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,MAAM,CAAC;oBACP,4DAA4D;oBAC5D,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE;oBACD,yDAAyD;oBACzD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE;oBACD,kEAAkE;oBAClE,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,6DAA6D,CAAC,CAC7E;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,6DAA6D;QAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,0CAAyD;AAMzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,kBAAkB,CAChC,MAAyB,EACzB,MAAmD,EACnD,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,iCAAyB,CAAC,CAAC;QAChD,IAAI,EAAE,oBAAoB;QAC1B,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/script/src/api/info/delegations.d.ts

@@ -0,0 +1,64 @@
+import * as v from "valibot";
+/**
+ * Request user staking delegations.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
+ */
+export declare const DelegationsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegations", undefined>, v.DescriptionAction<"delegations", "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.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "delegations";
+    user: `0x${string}`;
+}, "Request user staking delegations.">]>;
+export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
+/**
+ * Array of user's delegations to validators.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
+ */
+export declare const DelegationsResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Validator address. */
+    readonly validator: 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}`, "Validator address.">]>;
+    /** Amount of tokens delegated to the validator. */
+    readonly amount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount of tokens delegated to the validator.">]>;
+    /** Locked until timestamp (in ms since epoch). */
+    readonly lockedUntilTimestamp: 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, "Locked until timestamp (in ms since epoch).">]>;
+}, undefined>, v.DescriptionAction<{
+    validator: `0x${string}`;
+    amount: string;
+    lockedUntilTimestamp: number;
+}, "User delegation to a validator.">]>, undefined>, v.DescriptionAction<{
+    validator: `0x${string}`;
+    amount: string;
+    lockedUntilTimestamp: number;
+}[], "Array of user's delegations to validators.">]>;
+export type DelegationsResponse = v.InferOutput<typeof DelegationsResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** Request parameters for the {@linkcode delegations} function. */
+export type DelegationsParameters = Omit<v.InferInput<typeof DelegationsRequest>, "type">;
+/**
+ * Request user staking delegations.
+ * @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 user's delegations to validators.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { delegations } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await delegations(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function delegations(config: InfoRequestConfig, params: DeepImmutable<DelegationsParameters>, signal?: AbortSignal): Promise<DelegationsResponse>;
+//# sourceMappingURL=delegations.d.ts.map

package/script/src/api/info/delegations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delegations.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/delegations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,uBAAuB;;IAKvB,oBAAoB;;;;;yCAQtB,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAMtB,yBAAyB;;IAKzB,mDAAmD;;IAKnD,kDAAkD;;;;;;;;;;oDAWxD,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAM5E,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC,CAM9B"}