@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

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

@@ -0,0 +1,169 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request user portfolio.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export declare const PortfolioRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"portfolio", undefined>, v.DescriptionAction<"portfolio", "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: "portfolio";
+    user: `0x${string}`;
+}, "Request user portfolio.">]>;
+export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
+/**
+ * Portfolio metrics grouped by time periods.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export declare const PortfolioResponse: v.SchemaWithPipe<readonly [v.TupleSchema<[v.TupleSchema<[v.LiteralSchema<"day", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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<{
+    /** History entries for account value as [timestamp, value]. */
+    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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss 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.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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "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.">]>;
+export type PortfolioResponse = v.InferOutput<typeof PortfolioResponse>;
+/** Request parameters for the {@linkcode portfolio} function. */
+export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "type">;
+/**
+ * Request user portfolio.
+ * @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 Portfolio metrics grouped by time periods.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { portfolio } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await portfolio(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function portfolio(config: InfoRequestConfig, params: DeepImmutable<PortfolioParameters>, signal?: AbortSignal): Promise<PortfolioResponse>;
+//# sourceMappingURL=portfolio.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/portfolio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC/G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,uBAAuB;;IAKvB,oBAAoB;;;;;+BAQtB,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AA2BtE;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAzBxB,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oDA6BzC,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,iBAAiB,CAAC,CAM5B"}

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

@@ -0,0 +1,109 @@
+"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.PortfolioResponse = exports.PortfolioRequest = void 0;
+exports.portfolio = portfolio;
+const v = __importStar(require("valibot"));
+const _common_js_1 = require("../_common.js");
+// -------------------- Schemas --------------------
+/**
+ * Request user portfolio.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+exports.PortfolioRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("portfolio"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+    }), v.description("Request user portfolio."));
+})();
+/** Portfolio metrics snapshot. */
+const Portfolio = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** History entries for account value as [timestamp, value]. */
+        accountValueHistory: v.pipe(v.array(v.tuple([_common_js_1.UnsignedInteger, _common_js_1.UnsignedDecimal])), v.description("History entries for account value as [timestamp, value].")),
+        /** History entries for profit and loss as [timestamp, value]. */
+        pnlHistory: v.pipe(v.array(v.tuple([_common_js_1.UnsignedInteger, _common_js_1.Decimal])), v.description("History entries for profit and loss as [timestamp, value].")),
+        /** Volume metric for the portfolio. */
+        vlm: v.pipe(_common_js_1.UnsignedDecimal, v.description("Volume metric for the portfolio.")),
+    }), v.description("Portfolio metrics snapshot."));
+})();
+/**
+ * Portfolio metrics grouped by time periods.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+exports.PortfolioResponse = (() => {
+    return v.pipe(v.tuple([
+        v.tuple([v.literal("day"), Portfolio]),
+        v.tuple([v.literal("week"), Portfolio]),
+        v.tuple([v.literal("month"), Portfolio]),
+        v.tuple([v.literal("allTime"), Portfolio]),
+        v.tuple([v.literal("perpDay"), Portfolio]),
+        v.tuple([v.literal("perpWeek"), Portfolio]),
+        v.tuple([v.literal("perpMonth"), Portfolio]),
+        v.tuple([v.literal("perpAllTime"), Portfolio]),
+    ]), v.description("Portfolio metrics grouped by time periods."));
+})();
+/**
+ * Request user portfolio.
+ * @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 Portfolio metrics grouped by time periods.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { portfolio } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await portfolio(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+function portfolio(config, params, signal) {
+    const request = (0, _common_js_1.parser)(exports.PortfolioRequest)({
+        type: "portfolio",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=portfolio.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portfolio.js","sourceRoot":"","sources":["../../../../src/src/api/info/portfolio.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsGA,8BAUC;AAhHD,2CAA6B;AAC7B,8CAA+G;AAG/G,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,gBAAgB,GAAmB,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,kCAAkC;AAClC,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtC,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,+DAA+D;QAC/D,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,4BAAe,EAAE,4BAAe,CAAC,CAAC,CAAC,EACpD,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;QACD,iEAAiE;QACjE,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,4BAAe,EAAE,oBAAO,CAAC,CAAC,CAAC,EAC5C,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAC5E;QACD,uCAAuC;QACvC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,iBAAiB,GAAmB,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC;QACN,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,CAAC;QAC3C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC;QAC5C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,CAAC;KAC/C,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,SAAS,CACvB,MAAyB,EACzB,MAA0C,EAC1C,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,mBAAM,EAAC,wBAAgB,CAAC,CAAC;QACvC,IAAI,EAAE,WAAW;QACjB,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/preTransferCheck.d.ts

@@ -0,0 +1,66 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request user existence check before transfer.
+ * @see null
+ */
+export declare const PreTransferCheckRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"preTransferCheck", undefined>, v.DescriptionAction<"preTransferCheck", "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.">]>;
+    /** Source address. */
+    readonly source: 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}`, "Source address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "preTransferCheck";
+    user: `0x${string}`;
+    source: `0x${string}`;
+}, "Request user existence check before transfer.">]>;
+export type PreTransferCheckRequest = v.InferOutput<typeof PreTransferCheckRequest>;
+/**
+ * Pre-transfer user existence check result.
+ * @see null
+ */
+export declare const PreTransferCheckResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Activation fee. */
+    readonly fee: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Activation fee.">]>;
+    /** Whether the user is sanctioned. */
+    readonly isSanctioned: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether the user is sanctioned.">]>;
+    /** Whether the user exists. */
+    readonly userExists: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether the user exists.">]>;
+    /** Whether the user has sent a transaction. */
+    readonly userHasSentTx: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether the user has sent a transaction.">]>;
+}, undefined>, v.DescriptionAction<{
+    fee: string;
+    isSanctioned: boolean;
+    userExists: boolean;
+    userHasSentTx: boolean;
+}, "Pre-transfer user existence check result.">]>;
+export type PreTransferCheckResponse = v.InferOutput<typeof PreTransferCheckResponse>;
+/** Request parameters for the {@linkcode preTransferCheck} function. */
+export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferCheckRequest>, "type">;
+/**
+ * Request user existence check before transfer.
+ * @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 Pre-transfer user existence check result.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { preTransferCheck } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await preTransferCheck(
+ *   { transport },
+ *   { user: "0x...", source: "0x..." },
+ * );
+ * ```
+ */
+export declare function preTransferCheck(config: InfoRequestConfig, params: DeepImmutable<PreTransferCheckParameters>, signal?: AbortSignal): Promise<PreTransferCheckResponse>;
+//# sourceMappingURL=preTransferCheck.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preTransferCheck.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/preTransferCheck.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IAG9B,uBAAuB;;IAKvB,oBAAoB;;IAKpB,sBAAsB;;;;;;qDAQxB,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,wBAAwB;IAG/B,sBAAsB;;IAKtB,sCAAsC;;IAKtC,+BAA+B;;IAK/B,+CAA+C;;;;;;;iDAQjD,CAAC;AACL,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAItF,wEAAwE;AACxE,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpG;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,0BAA0B,CAAC,EACjD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAMnC"}

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

@@ -0,0 +1,100 @@
+"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.PreTransferCheckResponse = exports.PreTransferCheckRequest = void 0;
+exports.preTransferCheck = preTransferCheck;
+const v = __importStar(require("valibot"));
+const _common_js_1 = require("../_common.js");
+// -------------------- Schemas --------------------
+/**
+ * Request user existence check before transfer.
+ * @see null
+ */
+exports.PreTransferCheckRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("preTransferCheck"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+        /** Source address. */
+        source: v.pipe(_common_js_1.Address, v.description("Source address.")),
+    }), v.description("Request user existence check before transfer."));
+})();
+/**
+ * Pre-transfer user existence check result.
+ * @see null
+ */
+exports.PreTransferCheckResponse = (() => {
+    return v.pipe(v.object({
+        /** Activation fee. */
+        fee: v.pipe(_common_js_1.UnsignedDecimal, v.description("Activation fee.")),
+        /** Whether the user is sanctioned. */
+        isSanctioned: v.pipe(v.boolean(), v.description("Whether the user is sanctioned.")),
+        /** Whether the user exists. */
+        userExists: v.pipe(v.boolean(), v.description("Whether the user exists.")),
+        /** Whether the user has sent a transaction. */
+        userHasSentTx: v.pipe(v.boolean(), v.description("Whether the user has sent a transaction.")),
+    }), v.description("Pre-transfer user existence check result."));
+})();
+/**
+ * Request user existence check before transfer.
+ * @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 Pre-transfer user existence check result.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { preTransferCheck } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await preTransferCheck(
+ *   { transport },
+ *   { user: "0x...", source: "0x..." },
+ * );
+ * ```
+ */
+function preTransferCheck(config, params, signal) {
+    const request = (0, _common_js_1.parser)(exports.PreTransferCheckRequest)({
+        type: "preTransferCheck",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=preTransferCheck.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preTransferCheck.js","sourceRoot":"","sources":["../../../../src/src/api/info/preTransferCheck.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,4CAUC;AAxGD,2CAA6B;AAC7B,8CAAqF;AAGrF,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,uBAAuB,GAAmB,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,sBAAsB;QACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,wBAAwB,GAAmB,CAAC,GAAG,EAAE;IAC5D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,sBAAsB;QACtB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;QACD,sCAAsC;QACtC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;QACD,+BAA+B;QAC/B,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,+CAA+C;QAC/C,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,gBAAgB,CAC9B,MAAyB,EACzB,MAAiD,EACjD,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,mBAAM,EAAC,+BAAuB,CAAC,CAAC;QAC9C,IAAI,EAAE,kBAAkB;QACxB,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/predictedFundings.d.ts

@@ -0,0 +1,66 @@
+import * as v from "valibot";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request predicted funding rates.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+ */
+export declare const PredictedFundingsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"predictedFundings", undefined>, v.DescriptionAction<"predictedFundings", "Type of request.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "predictedFundings";
+}, "Request predicted funding rates.">]>;
+export type PredictedFundingsRequest = v.InferOutput<typeof PredictedFundingsRequest>;
+/**
+ * Array of predicted funding rates.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+ */
+export declare const PredictedFundingsResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.TupleSchema<[v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>, v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.TupleSchema<[v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Exchange symbol.">]>, v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+    /** Predicted funding rate. */
+    readonly fundingRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Predicted funding rate.">]>;
+    /** Next funding time (ms since epoch). */
+    readonly nextFundingTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Next funding time (ms since epoch).">]>;
+    /** Funding interval in hours. */
+    readonly fundingIntervalHours: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Funding interval in hours.">]>;
+}, undefined>, undefined>, v.DescriptionAction<{
+    fundingRate: string;
+    nextFundingTime: number;
+    fundingIntervalHours?: number | undefined;
+} | null, "Predicted funding data.">]>], undefined>, v.DescriptionAction<[string, {
+    fundingRate: string;
+    nextFundingTime: number;
+    fundingIntervalHours?: number | undefined;
+} | null], "Tuple of exchange symbol and predicted funding data.">]>, undefined>, v.DescriptionAction<[string, {
+    fundingRate: string;
+    nextFundingTime: number;
+    fundingIntervalHours?: number | undefined;
+} | null][], "Array of predicted funding data for each exchange.">]>], undefined>, v.DescriptionAction<[string, [string, {
+    fundingRate: string;
+    nextFundingTime: number;
+    fundingIntervalHours?: number | undefined;
+} | null][]], "Tuple of asset symbol and its predicted funding data.">]>, undefined>, v.DescriptionAction<[string, [string, {
+    fundingRate: string;
+    nextFundingTime: number;
+    fundingIntervalHours?: number | undefined;
+} | null][]][], "Array of predicted funding rates.">]>;
+export type PredictedFundingsResponse = v.InferOutput<typeof PredictedFundingsResponse>;
+/**
+ * Request predicted funding rates.
+ * @param config - General configuration for Info API requests.
+ * @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 predicted funding rates.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { predictedFundings } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await predictedFundings({ transport });
+ * ```
+ */
+export declare function predictedFundings(config: InfoRequestConfig, signal?: AbortSignal): Promise<PredictedFundingsResponse>;
+//# sourceMappingURL=predictedFundings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"predictedFundings.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/predictedFundings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,wBAAwB;IAG/B,uBAAuB;;;;wCAQzB,CAAC;AACL,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAEtF;;;GAGG;AACH,eAAO,MAAM,yBAAyB;IA0Bd,8BAA8B;;IAK9B,0CAA0C;;IAK1C,iCAAiC;;;;;;;;;;;;;;;;;;;;;;sDAqBrD,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAIxF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,yBAAyB,CAAC,CAKpC"}