@nktkas/hyperliquid 0.31.0 → 0.32.0

package/esm/api/info/_methods/validatorL1Votes.js

@@ -0,0 +1,47 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+/**
+ * Request validator L1 votes.
+ * @see null
+ */
+export const ValidatorL1VotesRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("validatorL1Votes"),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Request validator L1 votes.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of L1 governance votes cast by validators.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { validatorL1Votes } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await validatorL1Votes({ transport });
+ * ```
+ *
+ * @see null
+ */
+export function validatorL1Votes(config, signal) {
+    const request = parse(ValidatorL1VotesRequest, {
+        type: "validatorL1Votes",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=validatorL1Votes.js.map

package/esm/api/info/_methods/validatorL1Votes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatorL1Votes.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/validatorL1Votes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAuBL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAkB,EAClB,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,uBAAuB,EAAE;QAC7C,IAAI,EAAE,kBAAkB;KACzB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/api/info/_methods/validatorSummaries.d.ts

@@ -0,0 +1,101 @@
+import * as v from "valibot";
+/**
+ * Request validator summaries.
+ * @see null
+ */
+export declare const ValidatorSummariesRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"validatorSummaries", undefined>;
+}, undefined>;
+export type ValidatorSummariesRequest = v.InferOutput<typeof ValidatorSummariesRequest>;
+/** Statistics for validator performance over a time period. */
+type ValidatorStats = {
+    /**
+     * Fraction of time the validator was online.
+     * @pattern ^0(\.\d+)?|1(\.0+)?$
+     */
+    uptimeFraction: string;
+    /**
+     * Predicted annual percentage rate of returns.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    predictedApr: string;
+    /** Number of samples used for statistics calculation. */
+    nSamples: number;
+};
+/**
+ * Array of validator performance statistics.
+ * @see null
+ */
+export type ValidatorSummariesResponse = {
+    /**
+     * Address of the validator.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    validator: `0x${string}`;
+    /**
+     * Address of the validator signer.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    signer: `0x${string}`;
+    /** Name of the validator. */
+    name: string;
+    /** Description of the validator. */
+    description: string;
+    /** Number of blocks produced recently. */
+    nRecentBlocks: number;
+    /** Total amount of tokens staked **(unsafe integer)**. */
+    stake: number;
+    /** Whether the validator is currently jailed. */
+    isJailed: boolean;
+    /** Timestamp when the validator can be unjailed (in ms since epoch). */
+    unjailableAfter: number | null;
+    /** Whether the validator is currently active. */
+    isActive: boolean;
+    /**
+     * Commission rate charged by the validator.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    commission: string;
+    /** Performance statistics over different time periods. */
+    stats: [
+        [
+            period: "day",
+            stats: ValidatorStats
+        ],
+        [
+            period: "week",
+            stats: ValidatorStats
+        ],
+        [
+            period: "month",
+            stats: ValidatorStats
+        ]
+    ];
+}[];
+import type { InfoConfig } from "./_base/types.js";
+/**
+ * Request validator summaries.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of validator performance statistics.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { validatorSummaries } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await validatorSummaries({ transport });
+ * ```
+ *
+ * @see null
+ */
+export declare function validatorSummaries(config: InfoConfig, signal?: AbortSignal): Promise<ValidatorSummariesResponse>;
+export {};
+//# sourceMappingURL=validatorSummaries.d.ts.map

package/esm/api/info/_methods/validatorSummaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatorSummaries.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/validatorSummaries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B;;;GAGG;AACH,eAAO,MAAM,yBAAyB;IAElC,uBAAuB;;aAGvB,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,+DAA+D;AAC/D,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,SAAS,EAAE,KAAK,MAAM,EAAE,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,wEAAwE;IACxE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,KAAK,EAAE;QACL;YAAC,MAAM,EAAE,KAAK;YAAE,KAAK,EAAE,cAAc;SAAC;QACtC;YAAC,MAAM,EAAE,MAAM;YAAE,KAAK,EAAE,cAAc;SAAC;QACvC;YAAC,MAAM,EAAE,OAAO;YAAE,KAAK,EAAE,cAAc;SAAC;KACzC,CAAC;CACH,EAAE,CAAC;AAOJ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,UAAU,EAClB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,0BAA0B,CAAC,CAKrC"}

package/esm/api/info/_methods/validatorSummaries.js

@@ -0,0 +1,47 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+/**
+ * Request validator summaries.
+ * @see null
+ */
+export const ValidatorSummariesRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("validatorSummaries"),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Request validator summaries.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of validator performance statistics.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { validatorSummaries } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await validatorSummaries({ transport });
+ * ```
+ *
+ * @see null
+ */
+export function validatorSummaries(config, signal) {
+    const request = parse(ValidatorSummariesRequest, {
+        type: "validatorSummaries",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=validatorSummaries.js.map

package/esm/api/info/_methods/validatorSummaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatorSummaries.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/validatorSummaries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;KACtC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AA6DL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAkB,EAClB,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,yBAAyB,EAAE;QAC/C,IAAI,EAAE,oBAAoB;KAC3B,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/api/info/_methods/vaultDetails.d.ts

@@ -0,0 +1,145 @@
+import * as v from "valibot";
+import type { VaultRelationshipSchema } from "./_base/commonSchemas.js";
+import type { PortfolioResponse } from "./portfolio.js";
+/**
+ * Request details of a vault.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+export declare const VaultDetailsRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"vaultDetails", undefined>;
+    /** Vault address. */
+    readonly vaultAddress: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+    /** User address. */
+    readonly user: v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>;
+}, undefined>;
+export type VaultDetailsRequest = v.InferOutput<typeof VaultDetailsRequest>;
+/**
+ * Details of a vault or null if the vault does not exist.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+export type VaultDetailsResponse = {
+    /** Vault name. */
+    name: string;
+    /**
+     * Vault address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    vaultAddress: `0x${string}`;
+    /**
+     * Leader address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    leader: `0x${string}`;
+    /** Vault description. */
+    description: string;
+    /** Vault portfolio metrics grouped by time periods. */
+    portfolio: PortfolioResponse;
+    /** Annual percentage rate. */
+    apr: number;
+    /** Current user follower state. */
+    followerState: {
+        /**
+         * Follower address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Follower vault equity.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        vaultEquity: string;
+        /**
+         * Current profit and loss.
+         * @pattern ^-?[0-9]+(\.[0-9]+)?$
+         */
+        pnl: string;
+        /**
+         * All-time profit and loss.
+         * @pattern ^-?[0-9]+(\.[0-9]+)?$
+         */
+        allTimePnl: string;
+        /** Subscription duration in days. */
+        daysFollowing: number;
+        /** Vault entry timestamp. */
+        vaultEntryTime: number;
+        /** Timestamp when funds become unlocked. */
+        lockupUntil: number;
+    } | null;
+    /** Ownership percentage held by leader. */
+    leaderFraction: number;
+    /** Leader commission percentage. */
+    leaderCommission: number;
+    /** Array of vault followers. */
+    followers: {
+        /**
+         * Follower address or Leader.
+         * @pattern ^0x[a-fA-F0-9]{40}$|^Leader$
+         */
+        user: `0x${string}` | "Leader";
+        /**
+         * Follower vault equity.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        vaultEquity: string;
+        /**
+         * Current profit and loss.
+         * @pattern ^-?[0-9]+(\.[0-9]+)?$
+         */
+        pnl: string;
+        /**
+         * All-time profit and loss.
+         * @pattern ^-?[0-9]+(\.[0-9]+)?$
+         */
+        allTimePnl: string;
+        /** Subscription duration in days. */
+        daysFollowing: number;
+        /** Vault entry timestamp. */
+        vaultEntryTime: number;
+        /** Timestamp when funds become unlocked. */
+        lockupUntil: number;
+    }[];
+    /** Maximum distributable amount. */
+    maxDistributable: number;
+    /** Maximum withdrawable amount. */
+    maxWithdrawable: number;
+    /** Vault closure status. */
+    isClosed: boolean;
+    /** Vault relationship type. */
+    relationship: VaultRelationshipSchema;
+    /** Deposit permission status. */
+    allowDeposits: boolean;
+    /** Position closure policy on withdrawal. */
+    alwaysCloseOnWithdraw: boolean;
+};
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode vaultDetails} function. */
+export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsRequest>, "type">;
+/**
+ * Request details of a vault.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Details of a vault or null if the vault does not exist.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { vaultDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await vaultDetails(
+ *   { transport },
+ *   { vaultAddress: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+export declare function vaultDetails(config: InfoConfig, params: VaultDetailsParameters, signal?: AbortSignal): Promise<VaultDetailsResponse>;
+//# sourceMappingURL=vaultDetails.d.ts.map

package/esm/api/info/_methods/vaultDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultDetails.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/vaultDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAO7B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAE5B,uBAAuB;;IAEvB,qBAAqB;;IAErB,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B;;;OAGG;IACH,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,SAAS,EAAE,iBAAiB,CAAC;IAC7B,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,aAAa,EAAE;QACb;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB,qCAAqC;QACrC,aAAa,EAAE,MAAM,CAAC;QACtB,6BAA6B;QAC7B,cAAc,EAAE,MAAM,CAAC;QACvB,4CAA4C;QAC5C,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,IAAI,CAAC;IACT,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,SAAS,EAAE;QACT;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,GAAG,QAAQ,CAAC;QAC/B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB,qCAAqC;QACrC,aAAa,EAAE,MAAM,CAAC;QACtB,6BAA6B;QAC7B,cAAc,EAAE,MAAM,CAAC;QACvB,4CAA4C;QAC5C,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;IACJ,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,uBAAuB,CAAC;IACtC,iCAAiC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,6CAA6C;IAC7C,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAOF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,sBAAsB,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAM/B"}

package/esm/api/info/_methods/vaultDetails.js

@@ -0,0 +1,57 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } from "../../_schemas.js";
+/**
+ * Request details of a vault.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+export const VaultDetailsRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("vaultDetails"),
+        /** Vault address. */
+        vaultAddress: Address,
+        /** User address. */
+        user: v.nullish(Address),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Request details of a vault.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Details of a vault or null if the vault does not exist.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { vaultDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await vaultDetails(
+ *   { transport },
+ *   { vaultAddress: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+export function vaultDetails(config, params, signal) {
+    const request = parse(VaultDetailsRequest, {
+        type: "vaultDetails",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=vaultDetails.js.map

package/esm/api/info/_methods/vaultDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultDetails.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/vaultDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI5C;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;QAC/B,qBAAqB;QACrB,YAAY,EAAE,OAAO;QACrB,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACzB,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAsGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAkB,EAClB,MAA8B,EAC9B,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,mBAAmB,EAAE;QACzC,IAAI,EAAE,cAAc;QACpB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/api/info/_methods/vaultSummaries.d.ts

@@ -0,0 +1,65 @@
+import * as v from "valibot";
+import type { VaultRelationshipSchema } from "./_base/commonSchemas.js";
+/**
+ * Request a list of vaults less than 2 hours old.
+ * @see null
+ */
+export declare const VaultSummariesRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"vaultSummaries", undefined>;
+}, undefined>;
+export type VaultSummariesRequest = v.InferOutput<typeof VaultSummariesRequest>;
+/**
+ * Array of vaults less than 2 hours old.
+ * @see null
+ */
+export type VaultSummariesResponse = {
+    /** Vault name. */
+    name: string;
+    /**
+     * Vault address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    vaultAddress: `0x${string}`;
+    /**
+     * Leader address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    leader: `0x${string}`;
+    /**
+     * Total value locked.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    tvl: string;
+    /** Vault closure status. */
+    isClosed: boolean;
+    /** Vault relationship type. */
+    relationship: VaultRelationshipSchema;
+    /** Creation timestamp. */
+    createTimeMillis: number;
+}[];
+import type { InfoConfig } from "./_base/types.js";
+/**
+ * Request a list of vaults less than 2 hours old.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of vaults less than 2 hours old.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { vaultSummaries } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await vaultSummaries({ transport });
+ * ```
+ *
+ * @see null
+ */
+export declare function vaultSummaries(config: InfoConfig, signal?: AbortSignal): Promise<VaultSummariesResponse>;
+//# sourceMappingURL=vaultSummaries.d.ts.map

package/esm/api/info/_methods/vaultSummaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultSummaries.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/vaultSummaries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAE9B,uBAAuB;;aAGvB,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B;;;OAGG;IACH,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,uBAAuB,CAAC;IACtC,0BAA0B;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,EAAE,CAAC;AAOJ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,UAAU,EAClB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,sBAAsB,CAAC,CAKjC"}

package/esm/api/info/_methods/vaultSummaries.js

@@ -0,0 +1,44 @@
+import * as v from "valibot";
+/**
+ * Request a list of vaults less than 2 hours old.
+ * @see null
+ */
+export const VaultSummariesRequest = /* @__PURE__ */ (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("vaultSummaries"),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * Request a list of vaults less than 2 hours old.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of vaults less than 2 hours old.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { vaultSummaries } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await vaultSummaries({ transport });
+ * ```
+ *
+ * @see null
+ */
+export function vaultSummaries(config, signal) {
+    const request = parse(VaultSummariesRequest, {
+        type: "vaultSummaries",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=vaultSummaries.js.map

package/esm/api/info/_methods/vaultSummaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultSummaries.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/vaultSummaries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACzD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAiCL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAkB,EAClB,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,qBAAqB,EAAE;QAC3C,IAAI,EAAE,gBAAgB;KACvB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/api/info/_methods/webData2.d.ts

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+import type { PerpAssetCtxSchema, SpotAssetCtxSchema, TwapStateSchema } from "./_base/commonSchemas.js";
+import type { ClearinghouseStateResponse } from "./clearinghouseState.js";
+import type { FrontendOpenOrdersResponse } from "./frontendOpenOrders.js";
+import type { LeadingVaultsResponse } from "./leadingVaults.js";
+import type { MetaResponse } from "./meta.js";
+import type { PerpsAtOpenInterestCapResponse } from "./perpsAtOpenInterestCap.js";
+import type { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
+/**
+ * Request comprehensive user and market data.
+ * @see null
+ */
+export declare const WebData2Request: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"webData2", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+}, undefined>;
+export type WebData2Request = v.InferOutput<typeof WebData2Request>;
+/**
+ * Comprehensive user and market data.
+ * @see null
+ */
+export type WebData2Response = {
+    /** Account summary for perpetual trading. */
+    clearinghouseState: ClearinghouseStateResponse;
+    /** Array of leading vaults for a user. */
+    leadingVaults: LeadingVaultsResponse;
+    /**
+     * Total equity in vaults.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    totalVaultEquity: string;
+    /** Array of open orders with additional display information. */
+    openOrders: FrontendOpenOrdersResponse;
+    /**
+     * Agent address if one exists.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    agentAddress: `0x${string}` | null;
+    /** Timestamp until which the agent is valid. */
+    agentValidUntil: number | null;
+    /**
+     * Cumulative ledger value.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    cumLedger: string;
+    /** Metadata for perpetual assets. */
+    meta: MetaResponse;
+    /** Array of contexts for each perpetual asset. */
+    assetCtxs: PerpAssetCtxSchema[];
+    /** Server timestamp (in ms since epoch). */
+    serverTime: number;
+    /** Whether this account is a vault. */
+    isVault: boolean;
+    /**
+     * User address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    user: `0x${string}`;
+    /** Array of tuples containing TWAP order ID and its state. */
+    twapStates: [id: number, state: TwapStateSchema][];
+    /** Account summary for spot trading. */
+    spotState?: SpotClearinghouseStateResponse;
+    /** Asset context for each spot asset. */
+    spotAssetCtxs: SpotAssetCtxSchema[];
+    /** Whether the user has opted out of spot dusting. */
+    optOutOfSpotDusting?: true;
+    /** Assets currently at their open interest cap. */
+    perpsAtOpenInterestCap?: PerpsAtOpenInterestCapResponse;
+};
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode webData2} function. */
+export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "type">;
+/**
+ * Request comprehensive user and market data.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Comprehensive user and market data.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { webData2 } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await webData2(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see null
+ */
+export declare function webData2(config: InfoConfig, params: WebData2Parameters, signal?: AbortSignal): Promise<WebData2Response>;
+//# sourceMappingURL=webData2.d.ts.map

package/esm/api/info/_methods/webData2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webData2.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/webData2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAO7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACxG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,6BAA6B,CAAC;AAClF,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,6BAA6B,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,eAAe;IAExB,uBAAuB;;IAEvB,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6CAA6C;IAC7C,kBAAkB,EAAE,0BAA0B,CAAC;IAC/C,0CAA0C;IAC1C,aAAa,EAAE,qBAAqB,CAAC;IACrC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,UAAU,EAAE,0BAA0B,CAAC;IACvC;;;OAGG;IACH,YAAY,EAAE,KAAK,MAAM,EAAE,GAAG,IAAI,CAAC;IACnC,gDAAgD;IAChD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,kDAAkD;IAClD,SAAS,EAAE,kBAAkB,EAAE,CAAC;IAChC,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,8DAA8D;IAC9D,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC;IACnD,wCAAwC;IACxC,SAAS,CAAC,EAAE,8BAA8B,CAAC;IAC3C,yCAAyC;IACzC,aAAa,EAAE,kBAAkB,EAAE,CAAC;IACpC,sDAAsD;IACtD,mBAAmB,CAAC,EAAE,IAAI,CAAC;IAC3B,mDAAmD;IACnD,sBAAsB,CAAC,EAAE,8BAA8B,CAAC;CACzD,CAAC;AAOF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}