@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,359 @@
+import * as v from "valibot";
+/**
+ * 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.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"vaultDetails", undefined>, v.DescriptionAction<"vaultDetails", "Type of request.">]>;
+    /** Vault address. */
+    readonly vaultAddress: 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}`, "Vault address.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [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>, v.DescriptionAction<`0x${string}` | null | undefined, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "vaultDetails";
+    vaultAddress: `0x${string}`;
+    user?: `0x${string}` | null | undefined;
+}, "Request details of a vault.">]>;
+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 declare const VaultDetailsResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Vault name. */
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Vault name.">]>;
+    /** Vault address. */
+    readonly vaultAddress: 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}`, "Vault address.">]>;
+    /** Leader address. */
+    readonly leader: 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}`, "Leader address.">]>;
+    /** Vault description. */
+    readonly description: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Vault description.">]>;
+    /** Vault portfolio metrics grouped by time periods. */
+    readonly portfolio: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.TupleSchema<[v.TupleSchema<[v.LiteralSchema<"day", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"week", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"month", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"allTime", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpDay", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpWeek", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpMonth", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpAllTime", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+        readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+        readonly vlm: 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, "Volume metric for the portfolio.">]>;
+    }, undefined>, v.DescriptionAction<{
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }, "Portfolio metrics snapshot.">]>], undefined>], undefined>, v.DescriptionAction<[["day", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["week", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["month", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["allTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpDay", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpWeek", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpMonth", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpAllTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }]], "Portfolio metrics grouped by time periods.">]>, v.DescriptionAction<[["day", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["week", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["month", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["allTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpDay", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpWeek", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpMonth", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpAllTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }]], "Vault portfolio metrics grouped by time periods.">]>;
+    /** Annual percentage rate. */
+    readonly apr: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.DescriptionAction<number, "Annual percentage rate.">]>;
+    /** Current user follower state */
+    readonly followerState: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+        /** Follower 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}`, "Follower address.">]>;
+        /** Follower vault equity. */
+        readonly vaultEquity: 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, "Follower vault equity.">]>;
+        /** Current profit and loss. */
+        readonly pnl: 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, "Current profit and loss.">]>;
+        /** All-time profit and loss. */
+        readonly allTimePnl: 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, "All-time profit and loss.">]>;
+        /** Subscription duration in days. */
+        readonly daysFollowing: 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, "Subscription duration in days.">]>;
+        /** Vault entry timestamp. */
+        readonly vaultEntryTime: 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, "Vault entry timestamp.">]>;
+        /** Timestamp when funds become unlocked. */
+        readonly lockupUntil: 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 funds become unlocked.">]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        user: `0x${string}`;
+        vaultEquity: string;
+        pnl: string;
+        allTimePnl: string;
+        daysFollowing: number;
+        vaultEntryTime: number;
+        lockupUntil: number;
+    } | null, "Current user follower state">]>;
+    /** Ownership percentage held by leader. */
+    readonly leaderFraction: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.DescriptionAction<number, "Ownership percentage held by leader.">]>;
+    /** Leader commission percentage. */
+    readonly leaderCommission: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.DescriptionAction<number, "Leader commission percentage.">]>;
+    /** Array of vault followers. */
+    readonly followers: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Follower address or Leader. */
+        readonly user: v.SchemaWithPipe<readonly [v.UnionSchema<[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.LiteralSchema<"Leader", undefined>], undefined>, v.DescriptionAction<`0x${string}` | "Leader", "Follower address or Leader.">]>;
+        /** Follower vault equity. */
+        readonly vaultEquity: 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, "Follower vault equity.">]>;
+        /** Current profit and loss. */
+        readonly pnl: 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, "Current profit and loss.">]>;
+        /** All-time profit and loss. */
+        readonly allTimePnl: 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, "All-time profit and loss.">]>;
+        /** Subscription duration in days. */
+        readonly daysFollowing: 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, "Subscription duration in days.">]>;
+        /** Vault entry timestamp. */
+        readonly vaultEntryTime: 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, "Vault entry timestamp.">]>;
+        /** Timestamp when funds become unlocked. */
+        readonly lockupUntil: 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 funds become unlocked.">]>;
+    }, undefined>, v.DescriptionAction<{
+        user: `0x${string}` | "Leader";
+        vaultEquity: string;
+        pnl: string;
+        allTimePnl: string;
+        daysFollowing: number;
+        vaultEntryTime: number;
+        lockupUntil: number;
+    }, "Vault follower state.">]>, undefined>, v.DescriptionAction<{
+        user: `0x${string}` | "Leader";
+        vaultEquity: string;
+        pnl: string;
+        allTimePnl: string;
+        daysFollowing: number;
+        vaultEntryTime: number;
+        lockupUntil: number;
+    }[], "Array of vault followers.">]>;
+    /** Maximum distributable amount. */
+    readonly maxDistributable: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.DescriptionAction<number, "Maximum distributable amount.">]>;
+    /** Maximum withdrawable amount. */
+    readonly maxWithdrawable: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.DescriptionAction<number, "Maximum withdrawable amount.">]>;
+    /** Vault closure status. */
+    readonly isClosed: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Vault closure status.">]>;
+    /** Vault relationship type. */
+    readonly relationship: v.SchemaWithPipe<readonly [v.VariantSchema<"type", [v.ObjectSchema<{
+        /** Relationship type. */
+        readonly type: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"normal", undefined>, v.LiteralSchema<"child", undefined>], undefined>, v.DescriptionAction<"normal" | "child", "Relationship type.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Relationship type. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"parent", undefined>, v.DescriptionAction<"parent", "Relationship type.">]>;
+        /** Child vault information. */
+        readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Child vault addresses. */
+            readonly childAddresses: v.SchemaWithPipe<readonly [v.ArraySchema<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>, v.DescriptionAction<`0x${string}`[], "Child vault addresses.">]>;
+        }, undefined>, v.DescriptionAction<{
+            childAddresses: `0x${string}`[];
+        }, "Child vault information.">]>;
+    }, undefined>], undefined>, v.DescriptionAction<{
+        type: "normal" | "child";
+    } | {
+        type: "parent";
+        data: {
+            childAddresses: `0x${string}`[];
+        };
+    }, "Vault relationship type.">]>;
+    /** Deposit permission status. */
+    readonly allowDeposits: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Deposit permission status.">]>;
+    /** Position closure policy on withdrawal. */
+    readonly alwaysCloseOnWithdraw: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Position closure policy on withdrawal.">]>;
+}, undefined>, v.DescriptionAction<{
+    name: string;
+    vaultAddress: `0x${string}`;
+    leader: `0x${string}`;
+    description: string;
+    portfolio: [["day", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["week", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["month", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["allTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpDay", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpWeek", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpMonth", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }], ["perpAllTime", {
+        accountValueHistory: [number, string][];
+        pnlHistory: [number, string][];
+        vlm: string;
+    }]];
+    apr: number;
+    followerState: {
+        user: `0x${string}`;
+        vaultEquity: string;
+        pnl: string;
+        allTimePnl: string;
+        daysFollowing: number;
+        vaultEntryTime: number;
+        lockupUntil: number;
+    } | null;
+    leaderFraction: number;
+    leaderCommission: number;
+    followers: {
+        user: `0x${string}` | "Leader";
+        vaultEquity: string;
+        pnl: string;
+        allTimePnl: string;
+        daysFollowing: number;
+        vaultEntryTime: number;
+        lockupUntil: number;
+    }[];
+    maxDistributable: number;
+    maxWithdrawable: number;
+    isClosed: boolean;
+    relationship: {
+        type: "normal" | "child";
+    } | {
+        type: "parent";
+        data: {
+            childAddresses: `0x${string}`[];
+        };
+    };
+    allowDeposits: boolean;
+    alwaysCloseOnWithdraw: boolean;
+}, "Details of a vault or null if the vault does not exist.">]>;
+export type VaultDetailsResponse = v.InferOutput<typeof VaultDetailsResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_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 - 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 Details of a vault or null if the vault does not exist.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ * @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..." },
+ * );
+ * ```
+ */
+export declare function vaultDetails(config: InfoRequestConfig, params: DeepImmutable<VaultDetailsParameters>, signal?: AbortSignal): Promise<VaultDetailsResponse>;
+//# sourceMappingURL=vaultDetails.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vaultDetails.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/vaultDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAG1B,uBAAuB;;IAKvB,qBAAqB;;IAKrB,oBAAoB;;;;;;mCAQtB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,kBAAkB;;IAKlB,qBAAqB;;IAKrB,sBAAsB;;IAKtB,yBAAyB;;IAKzB,uDAAuD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAKvD,8BAA8B;;IAK9B,kCAAkC;;QAI5B,wBAAwB;;QAKxB,6BAA6B;;QAK7B,+BAA+B;;QAK/B,gCAAgC;;QAKhC,qCAAqC;;QAKrC,6BAA6B;;QAK7B,4CAA4C;;;;;;;;;;;IASlD,2CAA2C;;IAK3C,oCAAoC;;IAKpC,gCAAgC;;QAMxB,kCAAkC;;QAKlC,6BAA6B;;QAK7B,+BAA+B;;QAK/B,gCAAgC;;QAKhC,qCAAqC;;QAKrC,6BAA6B;;QAK7B,4CAA4C;;;;;;;;;;;;;;;;;;;IAWpD,oCAAoC;;IAKpC,mCAAmC;;IAKnC,4BAA4B;;IAK5B,+BAA+B;;QAIzB,yBAAyB;;;QAOzB,yBAAyB;;QAKzB,+BAA+B;;YAG3B,6BAA6B;;;;;;;;;;;;;IAYvC,iCAAiC;;IAKjC,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+DAQ/C,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAM9E,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAM/B"}

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

@@ -0,0 +1,140 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Decimal, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { 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 const VaultDetailsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("vaultDetails"), v.description("Type of request.")),
+        /** Vault address. */
+        vaultAddress: v.pipe(Address, v.description("Vault address.")),
+        /** User address. */
+        user: v.pipe(v.nullish(Address), v.description("User address.")),
+    }), v.description("Request details of a vault."));
+})();
+/**
+ * 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 const VaultDetailsResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Vault name. */
+        name: v.pipe(v.string(), v.description("Vault name.")),
+        /** Vault address. */
+        vaultAddress: v.pipe(Address, v.description("Vault address.")),
+        /** Leader address. */
+        leader: v.pipe(Address, v.description("Leader address.")),
+        /** Vault description. */
+        description: v.pipe(v.string(), v.description("Vault description.")),
+        /** Vault portfolio metrics grouped by time periods. */
+        portfolio: v.pipe(PortfolioResponse, v.description("Vault portfolio metrics grouped by time periods.")),
+        /** Annual percentage rate. */
+        apr: v.pipe(v.number(), v.description("Annual percentage rate.")),
+        /** Current user follower state */
+        followerState: v.pipe(v.nullable(v.object({
+            /** Follower address. */
+            user: v.pipe(Address, v.description("Follower address.")),
+            /** Follower vault equity. */
+            vaultEquity: v.pipe(UnsignedDecimal, v.description("Follower vault equity.")),
+            /** Current profit and loss. */
+            pnl: v.pipe(Decimal, v.description("Current profit and loss.")),
+            /** All-time profit and loss. */
+            allTimePnl: v.pipe(Decimal, v.description("All-time profit and loss.")),
+            /** Subscription duration in days. */
+            daysFollowing: v.pipe(UnsignedInteger, v.description("Subscription duration in days.")),
+            /** Vault entry timestamp. */
+            vaultEntryTime: v.pipe(UnsignedInteger, v.description("Vault entry timestamp.")),
+            /** Timestamp when funds become unlocked. */
+            lockupUntil: v.pipe(UnsignedInteger, v.description("Timestamp when funds become unlocked.")),
+        })), v.description("Current user follower state")),
+        /** Ownership percentage held by leader. */
+        leaderFraction: v.pipe(v.number(), v.description("Ownership percentage held by leader.")),
+        /** Leader commission percentage. */
+        leaderCommission: v.pipe(v.number(), v.description("Leader commission percentage.")),
+        /** Array of vault followers. */
+        followers: v.pipe(v.array(
+        /** Vault follower state. */
+        v.pipe(v.object({
+            /** Follower address or Leader. */
+            user: v.pipe(v.union([Address, v.literal("Leader")]), v.description("Follower address or Leader.")),
+            /** Follower vault equity. */
+            vaultEquity: v.pipe(UnsignedDecimal, v.description("Follower vault equity.")),
+            /** Current profit and loss. */
+            pnl: v.pipe(Decimal, v.description("Current profit and loss.")),
+            /** All-time profit and loss. */
+            allTimePnl: v.pipe(Decimal, v.description("All-time profit and loss.")),
+            /** Subscription duration in days. */
+            daysFollowing: v.pipe(UnsignedInteger, v.description("Subscription duration in days.")),
+            /** Vault entry timestamp. */
+            vaultEntryTime: v.pipe(UnsignedInteger, v.description("Vault entry timestamp.")),
+            /** Timestamp when funds become unlocked. */
+            lockupUntil: v.pipe(UnsignedInteger, v.description("Timestamp when funds become unlocked.")),
+        }), v.description("Vault follower state."))), v.description("Array of vault followers.")),
+        /** Maximum distributable amount. */
+        maxDistributable: v.pipe(v.number(), v.description("Maximum distributable amount.")),
+        /** Maximum withdrawable amount. */
+        maxWithdrawable: v.pipe(v.number(), v.description("Maximum withdrawable amount.")),
+        /** Vault closure status. */
+        isClosed: v.pipe(v.boolean(), v.description("Vault closure status.")),
+        /** Vault relationship type. */
+        relationship: v.pipe(v.variant("type", [
+            v.object({
+                /** Relationship type. */
+                type: v.pipe(v.union([v.literal("normal"), v.literal("child")]), v.description("Relationship type.")),
+            }),
+            v.object({
+                /** Relationship type. */
+                type: v.pipe(v.literal("parent"), v.description("Relationship type.")),
+                /** Child vault information. */
+                data: v.pipe(v.object({
+                    /** Child vault addresses. */
+                    childAddresses: v.pipe(v.array(Address), v.description("Child vault addresses.")),
+                }), v.description("Child vault information.")),
+            }),
+        ]), v.description("Vault relationship type.")),
+        /** Deposit permission status. */
+        allowDeposits: v.pipe(v.boolean(), v.description("Deposit permission status.")),
+        /** Position closure policy on withdrawal. */
+        alwaysCloseOnWithdraw: v.pipe(v.boolean(), v.description("Position closure policy on withdrawal.")),
+    }), v.description("Details of a vault or null if the vault does not exist."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parser } 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 - 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 Details of a vault or null if the vault does not exist.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ * @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..." },
+ * );
+ * ```
+ */
+export function vaultDetails(config, params, signal) {
+    const request = parser(VaultDetailsRequest)({
+        type: "vaultDetails",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=vaultDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vaultDetails.js","sourceRoot":"","sources":["../../../../src/src/api/info/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,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;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,qBAAqB;QACrB,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,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,kBAAkB;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,qBAAqB;QACrB,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,sBAAsB;QACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;QACD,yBAAyB;QACzB,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,uDAAuD;QACvD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,iBAAiB,EACjB,CAAC,CAAC,WAAW,CAAC,kDAAkD,CAAC,CAClE;QACD,8BAA8B;QAC9B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;QACD,kCAAkC;QAClC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,6BAA6B;YAC7B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,+BAA+B;YAC/B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,gCAAgC;YAChC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,qCAAqC;YACrC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;YACD,6BAA6B;YAC7B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,4CAA4C;YAC5C,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;QACD,2CAA2C;QAC3C,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;QACD,oCAAoC;QACpC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,gCAAgC;QAChC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,KAAK;QACL,4BAA4B;QAC5B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,kCAAkC;YAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EACvC,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;YACD,6BAA6B;YAC7B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,+BAA+B;YAC/B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,gCAAgC;YAChC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,qCAAqC;YACrC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;YACD,6BAA6B;YAC7B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,4CAA4C;YAC5C,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,oCAAoC;QACpC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,mCAAmC;QACnC,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,4BAA4B;QAC5B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,+BAA+B;QAC/B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE;YAChB,CAAC,CAAC,MAAM,CAAC;gBACP,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAClD,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;aACF,CAAC;YACF,CAAC,CAAC,MAAM,CAAC;gBACP,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,+BAA+B;gBAC/B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;oBACP,6BAA6B;oBAC7B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAChB,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;aACF,CAAC;SACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,iCAAiC;QACjC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;QACD,6CAA6C;QAC7C,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAC3B,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yDAAyD,CAAC,CACzE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AAMzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAyB,EACzB,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,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}