@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/script/src/api/info/predictedFundings.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.PredictedFundingsResponse = exports.PredictedFundingsRequest = void 0;
+exports.predictedFundings = predictedFundings;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _base_js_1 = require("../_base.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
+ */
+exports.PredictedFundingsRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("predictedFundings"), v.description("Type of request.")),
+    }), v.description("Request predicted funding rates."));
+})();
+/**
+ * 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
+ */
+exports.PredictedFundingsResponse = (() => {
+    return v.pipe(v.array(
+    /** Tuple of asset symbol and its predicted funding data. */
+    v.pipe(v.tuple([
+        /** Asset symbol. */
+        v.pipe(v.string(), v.description("Asset symbol.")),
+        /** Array of predicted funding data for each exchange. */
+        v.pipe(v.array(
+        /** Tuple of exchange symbol and predicted funding data. */
+        v.pipe(v.tuple([
+            /** Exchange symbol. */
+            v.pipe(v.string(), v.description("Exchange symbol.")),
+            /** Predicted funding data. */
+            v.pipe(v.nullable(v.object({
+                /** Predicted funding rate. */
+                fundingRate: v.pipe(_base_js_1.Decimal, v.description("Predicted funding rate.")),
+                /** Next funding time (ms since epoch). */
+                nextFundingTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Next funding time (ms since epoch).")),
+                /** Funding interval in hours. */
+                fundingIntervalHours: v.pipe(v.optional(_base_js_1.UnsignedInteger), v.description("Funding interval in hours.")),
+            })), v.description("Predicted funding data.")),
+        ]), v.description("Tuple of exchange symbol and predicted funding data."))), v.description("Array of predicted funding data for each exchange.")),
+    ]), v.description("Tuple of asset symbol and its predicted funding data."))), v.description("Array of predicted funding rates."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_2 = require("../_base.js");
+/**
+ * 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 });
+ * ```
+ */
+function predictedFundings(config, signal) {
+    const request = (0, _base_js_2.parser)(exports.PredictedFundingsRequest)({
+        type: "predictedFundings",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=predictedFundings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"predictedFundings.js","sourceRoot":"","sources":["../../../../src/src/api/info/predictedFundings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmHA,8CAQC;AA3HD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,0CAAuD;AAEvD;;;GAGG;AACU,QAAA,wBAAwB,GAAmB,CAAC,GAAG,EAAE;IAC5D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAC9B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,yBAAyB,GAAmB,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,4DAA4D;IAC5D,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,KAAK,CAAC;QACN,oBAAoB;QACpB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,yDAAyD;QACzD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,KAAK;QACL,2DAA2D;QAC3D,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,KAAK,CAAC;YACN,uBAAuB;YACvB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;YACD,8BAA8B;YAC9B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;gBACP,8BAA8B;gBAC9B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;gBACD,0CAA0C;gBAC1C,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;gBACD,iCAAiC;gBACjC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAC1B,CAAC,CAAC,QAAQ,CAAC,0BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;aACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,0CAAqC;AAGrC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,iBAAiB,CAC/B,MAAyB,EACzB,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,gCAAwB,CAAC,CAAC;QAC/C,IAAI,EAAE,mBAAmB;KAC1B,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,84 @@
+import * as v from "valibot";
+/**
+ * Request recent trades.
+ * @see null
+ */
+export declare const RecentTradesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"recentTrades", undefined>, v.DescriptionAction<"recentTrades", "Type of request.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "recentTrades";
+    coin: string;
+}, "Request recent trades.">]>;
+export type RecentTradesRequest = v.InferOutput<typeof RecentTradesRequest>;
+/**
+ * Array of recent trades.
+ * @see null
+ */
+export declare const RecentTradesResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    readonly side: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "Trade side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+    /** Trade price. */
+    readonly px: 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, "Trade price.">]>;
+    /** Trade size. */
+    readonly sz: 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, "Trade size.">]>;
+    /** Trade timestamp (in ms since epoch). */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Trade timestamp (in ms since epoch).">]>;
+    /** Transaction hash. */
+    readonly hash: 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}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
+    /** Trade ID. */
+    readonly tid: 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, "Trade ID.">]>;
+    /** Addresses of users involved in the trade [Maker, Taker]. */
+    readonly users: v.SchemaWithPipe<readonly [v.TupleSchema<[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.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}`, `0x${string}`], "Addresses of users involved in the trade [Maker, Taker].">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    side: "B" | "A";
+    px: string;
+    sz: string;
+    time: number;
+    hash: `0x${string}`;
+    tid: number;
+    users: [`0x${string}`, `0x${string}`];
+}, "Trade for a specific asset.">]>, undefined>, v.DescriptionAction<{
+    coin: string;
+    side: "B" | "A";
+    px: string;
+    sz: string;
+    time: number;
+    hash: `0x${string}`;
+    tid: number;
+    users: [`0x${string}`, `0x${string}`];
+}[], "Array of recent trades.">]>;
+export type RecentTradesResponse = v.InferOutput<typeof RecentTradesResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** Request parameters for the {@linkcode recentTrades} function. */
+export type RecentTradesParameters = Omit<v.InferInput<typeof RecentTradesRequest>, "type">;
+/**
+ * Request recent trades.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of recent trades.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { recentTrades } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await recentTrades(
+ *   { transport },
+ *   { coin: "ETH" },
+ * );
+ * ```
+ */
+export declare function recentTrades(config: InfoRequestConfig, params: DeepImmutable<RecentTradesParameters>, signal?: AbortSignal): Promise<RecentTradesResponse>;
+//# sourceMappingURL=recentTrades.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recentTrades.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/recentTrades.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAG1B,uBAAuB;;IAKvB,gCAAgC;;;;;8BAQlC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAMvB,gCAAgC;;IAKhC,kDAAkD;;IAKlD,mBAAmB;;IAKnB,kBAAkB;;IAKlB,2CAA2C;;IAK3C,wBAAwB;;IAKxB,gBAAgB;;IAKhB,+DAA+D;;;;;;;;;;;;;;;;;;;;iCAWrE,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/script/src/api/info/recentTrades.js

@@ -0,0 +1,114 @@
+"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.RecentTradesResponse = exports.RecentTradesRequest = void 0;
+exports.recentTrades = recentTrades;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _base_js_1 = require("../_base.js");
+/**
+ * Request recent trades.
+ * @see null
+ */
+exports.RecentTradesRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("recentTrades"), v.description("Type of request.")),
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+    }), v.description("Request recent trades."));
+})();
+/**
+ * Array of recent trades.
+ * @see null
+ */
+exports.RecentTradesResponse = (() => {
+    return v.pipe(v.array(
+    /** Trade for a specific asset. */
+    v.pipe(v.object({
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+        /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+        side: v.pipe(v.union([v.literal("B"), v.literal("A")]), v.description('Trade side ("B" = Bid/Buy, "A" = Ask/Sell).')),
+        /** Trade price. */
+        px: v.pipe(_base_js_1.UnsignedDecimal, v.description("Trade price.")),
+        /** Trade size. */
+        sz: v.pipe(_base_js_1.UnsignedDecimal, v.description("Trade size.")),
+        /** Trade timestamp (in ms since epoch). */
+        time: v.pipe(_base_js_1.UnsignedInteger, v.description("Trade timestamp (in ms since epoch).")),
+        /** Transaction hash. */
+        hash: v.pipe(v.pipe(_base_js_1.Hex, v.length(66)), v.description("Transaction hash.")),
+        /** Trade ID. */
+        tid: v.pipe(_base_js_1.UnsignedInteger, v.description("Trade ID.")),
+        /** Addresses of users involved in the trade [Maker, Taker]. */
+        users: v.pipe(v.tuple([_base_js_1.Address, _base_js_1.Address]), v.description("Addresses of users involved in the trade [Maker, Taker].")),
+    }), v.description("Trade for a specific asset."))), v.description("Array of recent trades."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_2 = require("../_base.js");
+/**
+ * Request recent trades.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of recent trades.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { recentTrades } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await recentTrades(
+ *   { transport },
+ *   { coin: "ETH" },
+ * );
+ * ```
+ */
+function recentTrades(config, params, signal) {
+    const request = (0, _base_js_2.parser)(exports.RecentTradesRequest)({
+        type: "recentTrades",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=recentTrades.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recentTrades.js","sourceRoot":"","sources":["../../../../src/src/api/info/recentTrades.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0HA,oCAUC;AApID,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,0CAA6E;AAE7E;;;GAGG;AACU,QAAA,mBAAmB,GAAmB,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,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,kCAAkC;IAClC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kDAAkD;QAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,mBAAmB;QACnB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;QACD,kBAAkB;QAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,2CAA2C;QAC3C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;QACD,wBAAwB;QACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,cAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,gBAAgB;QAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;QACD,+DAA+D;QAC/D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAO,EAAE,kBAAO,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CACF,EACD,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,0CAAyD;AAMzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,YAAY,CAC1B,MAAyB,EACzB,MAA6C,EAC7C,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,2BAAmB,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"}

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

@@ -0,0 +1,274 @@
+import * as v from "valibot";
+/**
+ * Request user referral.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+export declare const ReferralRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"referral", undefined>, v.DescriptionAction<"referral", "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: "referral";
+    user: `0x${string}`;
+}, "Request user referral.">]>;
+export type ReferralRequest = v.InferOutput<typeof ReferralRequest>;
+/**
+ * Referral details for a user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+export declare const ReferralResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Referrer details. */
+    readonly referredBy: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+        /** Referrer address. */
+        readonly referrer: 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}`, "Referrer address.">]>;
+        /** Referral code used. */
+        readonly code: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.DescriptionAction<string, "Referral code used.">]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        referrer: `0x${string}`;
+        code: string;
+    } | null, "Referrer details.">]>;
+    /** Cumulative traded volume. */
+    readonly cumVlm: 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, "Cumulative traded volume.">]>;
+    /** Rewards earned but not yet claimed. */
+    readonly unclaimedRewards: 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, "Rewards earned but not yet claimed.">]>;
+    /** Rewards that have been claimed. */
+    readonly claimedRewards: 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, "Rewards that have been claimed.">]>;
+    /** Builder reward amount. */
+    readonly builderRewards: 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, "Builder reward amount.">]>;
+    /** Current state of the referrer. */
+    readonly referrerState: v.SchemaWithPipe<readonly [v.VariantSchema<"stage", [v.ObjectSchema<{
+        /** Referrer is ready to receive rewards. */
+        readonly stage: v.SchemaWithPipe<readonly [v.LiteralSchema<"ready", undefined>, v.DescriptionAction<"ready", "Referrer is ready to receive rewards.">]>;
+        /** Referral program details. */
+        readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Assigned referral code. */
+            readonly code: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.DescriptionAction<string, "Assigned referral code.">]>;
+            /** Total number of referrals. */
+            readonly nReferrals: 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, "Total number of referrals.">]>;
+            /** Summary of each referral state. */
+            readonly referralStates: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Cumulative traded volume. */
+                readonly cumVlm: 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, "Cumulative traded volume.">]>;
+                /** Total fees rewarded to the referred user since referral. */
+                readonly cumRewardedFeesSinceReferred: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total fees rewarded to the referred user since referral.">]>;
+                /** Total fees rewarded to the referrer from referred trades. */
+                readonly cumFeesRewardedToReferrer: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total fees rewarded to the referrer from referred trades.">]>;
+                /** Timestamp when the referred user joined (in ms since epoch). */
+                readonly timeJoined: 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 the referred user joined (in ms since epoch).">]>;
+                /** Address of the referred user. */
+                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}`, "Address of the referred user.">]>;
+                /** Mapping of token IDs to referral reward states. */
+                readonly tokenToState: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [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.ObjectSchema<{
+                    /** Cumulative traded volume. */
+                    readonly cumVlm: 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, "Cumulative traded volume.">]>;
+                    /** Total fees rewarded to the referred user since referral. */
+                    readonly cumRewardedFeesSinceReferred: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total fees rewarded to the referred user since referral.">]>;
+                    /** Total fees rewarded to the referrer from referred trades. */
+                    readonly cumFeesRewardedToReferrer: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total fees rewarded to the referrer from referred trades.">]>;
+                }, undefined>], undefined>, v.DescriptionAction<[number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }], "Tuple of token ID and its referral reward state.">]>, undefined>, v.DescriptionAction<[number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][], "Mapping of token IDs to referral reward states.">]>;
+            }, undefined>, v.DescriptionAction<{
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: `0x${string}`;
+                tokenToState: [number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][];
+            }, "Referral state for a referred user.">]>, undefined>, v.DescriptionAction<{
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: `0x${string}`;
+                tokenToState: [number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][];
+            }[], "Summary of each referral state.">]>;
+        }, undefined>, v.DescriptionAction<{
+            code: string;
+            nReferrals: number;
+            referralStates: {
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: `0x${string}`;
+                tokenToState: [number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][];
+            }[];
+        }, "Referral program details.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Referrer needs to create a referral code. */
+        readonly stage: v.SchemaWithPipe<readonly [v.LiteralSchema<"needToCreateCode", undefined>, v.DescriptionAction<"needToCreateCode", "Referrer needs to create a referral code.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Referrer must complete a trade before earning rewards. */
+        readonly stage: v.SchemaWithPipe<readonly [v.LiteralSchema<"needToTrade", undefined>, v.DescriptionAction<"needToTrade", "Referrer must complete a trade before earning rewards.">]>;
+        /** Required trading volume details for activation. */
+        readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Required trading volume. */
+            readonly required: 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, "Required trading volume.">]>;
+        }, undefined>, v.DescriptionAction<{
+            required: string;
+        }, "Required trading volume details for activation.">]>;
+    }, undefined>], undefined>, v.DescriptionAction<{
+        stage: "ready";
+        data: {
+            code: string;
+            nReferrals: number;
+            referralStates: {
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: `0x${string}`;
+                tokenToState: [number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][];
+            }[];
+        };
+    } | {
+        stage: "needToCreateCode";
+    } | {
+        stage: "needToTrade";
+        data: {
+            required: string;
+        };
+    }, "Current state of the referrer.">]>;
+    /** History of referral rewards. */
+    readonly rewardHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Amount of earned rewards. */
+        readonly earned: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount of earned rewards.">]>;
+        /** Traded volume at the time of reward. */
+        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, "Traded volume at the time of reward.">]>;
+        /** Traded volume via referrals. */
+        readonly referralVlm: 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, "Traded volume via referrals.">]>;
+        /** Timestamp when the reward was earned (in ms since epoch). */
+        readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when the reward was earned (in ms since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        earned: string;
+        vlm: string;
+        referralVlm: string;
+        time: number;
+    }, "Referral reward entry.">]>, undefined>, v.DescriptionAction<{
+        earned: string;
+        vlm: string;
+        referralVlm: string;
+        time: number;
+    }[], "History of referral rewards.">]>;
+    /** Mapping of token IDs to referral reward states. */
+    readonly tokenToState: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [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.ObjectSchema<{
+        /** Cumulative traded volume. */
+        readonly cumVlm: 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, "Cumulative traded volume.">]>;
+        /** Rewards earned but not yet claimed. */
+        readonly unclaimedRewards: 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, "Rewards earned but not yet claimed.">]>;
+        /** Rewards that have been claimed. */
+        readonly claimedRewards: 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, "Rewards that have been claimed.">]>;
+        /** Builder reward amount. */
+        readonly builderRewards: 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, "Builder reward amount.">]>;
+    }, undefined>], undefined>, v.DescriptionAction<[number, {
+        cumVlm: string;
+        unclaimedRewards: string;
+        claimedRewards: string;
+        builderRewards: string;
+    }], "Tuple of token ID and its referral reward state.">]>, undefined>, v.DescriptionAction<[number, {
+        cumVlm: string;
+        unclaimedRewards: string;
+        claimedRewards: string;
+        builderRewards: string;
+    }][], "Mapping of token IDs to referral reward states.">]>;
+}, undefined>, v.DescriptionAction<{
+    referredBy: {
+        referrer: `0x${string}`;
+        code: string;
+    } | null;
+    cumVlm: string;
+    unclaimedRewards: string;
+    claimedRewards: string;
+    builderRewards: string;
+    referrerState: {
+        stage: "ready";
+        data: {
+            code: string;
+            nReferrals: number;
+            referralStates: {
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: `0x${string}`;
+                tokenToState: [number, {
+                    cumVlm: string;
+                    cumRewardedFeesSinceReferred: string;
+                    cumFeesRewardedToReferrer: string;
+                }][];
+            }[];
+        };
+    } | {
+        stage: "needToCreateCode";
+    } | {
+        stage: "needToTrade";
+        data: {
+            required: string;
+        };
+    };
+    rewardHistory: {
+        earned: string;
+        vlm: string;
+        referralVlm: string;
+        time: number;
+    }[];
+    tokenToState: [number, {
+        cumVlm: string;
+        unclaimedRewards: string;
+        claimedRewards: string;
+        builderRewards: string;
+    }][];
+}, "Referral details for a user.">]>;
+export type ReferralResponse = v.InferOutput<typeof ReferralResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** Request parameters for the {@linkcode referral} function. */
+export type ReferralParameters = Omit<v.InferInput<typeof ReferralRequest>, "type">;
+/**
+ * Request user referral.
+ * @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 Referral details for a user.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { referral } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await referral(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function referral(config: InfoRequestConfig, params: DeepImmutable<ReferralParameters>, signal?: AbortSignal): Promise<ReferralResponse>;
+//# sourceMappingURL=referral.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/referral.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,uBAAuB;;IAKvB,oBAAoB;;;;;8BAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,wBAAwB;;QAIlB,wBAAwB;;QAKxB,0BAA0B;;;;;;IAUhC,gCAAgC;;IAKhC,0CAA0C;;IAK1C,sCAAsC;;IAKtC,6BAA6B;;IAK7B,qCAAqC;;QAI/B,4CAA4C;;QAK5C,gCAAgC;;YAG5B,8BAA8B;;YAM9B,iCAAiC;;YAKjC,sCAAsC;;gBAM9B,gCAAgC;;gBAKhC,+DAA+D;;gBAK/D,gEAAgE;;gBAKhE,mEAAmE;;gBAOnE,oCAAoC;;gBAKpC,sDAAsD;;oBAQ5C,gCAAgC;;oBAKhC,+DAA+D;;oBAO/D,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAyBtF,gDAAgD;;;QAOhD,6DAA6D;;QAK7D,sDAAsD;;YAGlD,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAYzC,mCAAmC;;QAM3B,gCAAgC;;QAKhC,2CAA2C;;QAK3C,mCAAmC;;QAKnC,gEAAgE;;;;;;;;;;;;;IAWxE,sDAAsD;;QAQ5C,gCAAgC;;QAKhC,0CAA0C;;QAK1C,sCAAsC;;QAKtC,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAezC,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACzC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}