@nktkas/hyperliquid 0.31.0 → 0.32.0

package/script/api/info/_methods/predictedFundings.js

@@ -0,0 +1,84 @@
+"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.PredictedFundingsRequest = void 0;
+exports.predictedFundings = predictedFundings;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+/**
+ * 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.object({
+        /** Type of request. */
+        type: v.literal("predictedFundings"),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_1 = require("../../../_base.js");
+/**
+ * Request predicted funding rates.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of predicted funding rates.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { predictedFundings } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await predictedFundings({ transport });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+ */
+function predictedFundings(config, signal) {
+    const request = (0, _base_js_1.parse)(exports.PredictedFundingsRequest, {
+        type: "predictedFundings",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=predictedFundings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"predictedFundings.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/predictedFundings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyEA,8CAQC;AAjFD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;;GAGG;AACU,QAAA,wBAAwB,GAAmB,CAAC,GAAG,EAAE;IAC5D,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;KACrC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AA6BL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,gDAA0C;AAG1C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,iBAAiB,CAC/B,MAAkB,EAClB,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,gBAAK,EAAC,gCAAwB,EAAE;QAC9C,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/api/info/_methods/recentTrades.d.ts

@@ -0,0 +1,79 @@
+import * as v from "valibot";
+/**
+ * Request recent trades.
+ * @see null
+ */
+export declare const RecentTradesRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"recentTrades", undefined>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.StringSchema<undefined>;
+}, undefined>;
+export type RecentTradesRequest = v.InferOutput<typeof RecentTradesRequest>;
+/**
+ * Array of recent trades.
+ * @see null
+ */
+export type RecentTradesResponse = {
+    /** Asset symbol (e.g., BTC). */
+    coin: string;
+    /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    side: "B" | "A";
+    /**
+     * Trade price.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    px: string;
+    /**
+     * Trade size.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    sz: string;
+    /** Trade timestamp (in ms since epoch). */
+    time: number;
+    /**
+     * Transaction hash.
+     * @pattern ^0x[a-fA-F0-9]{64}$
+     */
+    hash: `0x${string}`;
+    /** Trade ID. */
+    tid: number;
+    /** Addresses of users involved in the trade [Maker, Taker]. */
+    users: [
+        /** @pattern ^0x[a-fA-F0-9]{40}$ */
+        maker: `0x${string}`,
+        /** @pattern ^0x[a-fA-F0-9]{40}$ */
+        taker: `0x${string}`
+    ];
+}[];
+import type { InfoConfig } from "./_base/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 {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of recent trades.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { recentTrades } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await recentTrades(
+ *   { transport },
+ *   { coin: "ETH" },
+ * );
+ * ```
+ *
+ * @see null
+ */
+export declare function recentTrades(config: InfoConfig, params: RecentTradesParameters, signal?: AbortSignal): Promise<RecentTradesResponse>;
+//# sourceMappingURL=recentTrades.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recentTrades.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/recentTrades.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAE5B,uBAAuB;;IAEvB,gCAAgC;;aAGhC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,KAAK,EAAE;QACL,mCAAmC;QACnC,KAAK,EAAE,KAAK,MAAM,EAAE;QACpB,mCAAmC;QACnC,KAAK,EAAE,KAAK,MAAM,EAAE;KACrB,CAAC;CACH,EAAE,CAAC;AAOJ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,sBAAsB,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAM/B"}

package/script/api/info/_methods/recentTrades.js

@@ -0,0 +1,91 @@
+"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.RecentTradesRequest = void 0;
+exports.recentTrades = recentTrades;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+/**
+ * Request recent trades.
+ * @see null
+ */
+exports.RecentTradesRequest = (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("recentTrades"),
+        /** Asset symbol (e.g., BTC). */
+        coin: v.string(),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_1 = require("../../../_base.js");
+/**
+ * Request recent trades.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of recent trades.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { recentTrades } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await recentTrades(
+ *   { transport },
+ *   { coin: "ETH" },
+ * );
+ * ```
+ *
+ * @see null
+ */
+function recentTrades(config, params, signal) {
+    const request = (0, _base_js_1.parse)(exports.RecentTradesRequest, {
+        type: "recentTrades",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=recentTrades.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recentTrades.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/recentTrades.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,oCAUC;AAvGD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;;GAGG;AACU,QAAA,mBAAmB,GAAmB,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;QAC/B,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAwCL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,gDAA0C;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,YAAY,CAC1B,MAAkB,EAClB,MAA8B,EAC9B,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,gBAAK,EAAC,2BAAmB,EAAE;QACzC,IAAI,EAAE,cAAc;QACpB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,197 @@
+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.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"referral", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+}, undefined>;
+export type 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 type ReferralResponse = {
+    /** Referrer details. */
+    referredBy: {
+        /**
+         * Referrer address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        referrer: `0x${string}`;
+        /** Referral code used. */
+        code: string;
+    } | null;
+    /**
+     * Cumulative traded volume.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    cumVlm: string;
+    /**
+     * Rewards earned but not yet claimed.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    unclaimedRewards: string;
+    /**
+     * Rewards that have been claimed.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    claimedRewards: string;
+    /**
+     * Builder reward amount.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    builderRewards: string;
+    /** Current state of the referrer. */
+    referrerState: {
+        /** Referrer is ready to receive rewards. */
+        stage: "ready";
+        /** Referral program details. */
+        data: {
+            /** Assigned referral code. */
+            code: string;
+            /** Total number of referrals. */
+            nReferrals: number;
+            /** Summary of each referral state. */
+            referralStates: {
+                /**
+                 * Cumulative traded volume.
+                 * @pattern ^[0-9]+(\.[0-9]+)?$
+                 */
+                cumVlm: string;
+                /**
+                 * Total fees rewarded to the referred user since referral.
+                 * @pattern ^[0-9]+(\.[0-9]+)?$
+                 */
+                cumRewardedFeesSinceReferred: string;
+                /**
+                 * Total fees rewarded to the referrer from referred trades.
+                 * @pattern ^[0-9]+(\.[0-9]+)?$
+                 */
+                cumFeesRewardedToReferrer: string;
+                /** Timestamp when the referred user joined (in ms since epoch). */
+                timeJoined: number;
+                /**
+                 * Address of the referred user.
+                 * @pattern ^0x[a-fA-F0-9]{40}$
+                 */
+                user: `0x${string}`;
+                /** Mapping of token IDs to referral reward states. */
+                tokenToState: [
+                    tokenId: number,
+                    state: {
+                        /**
+                         * Cumulative traded volume.
+                         * @pattern ^[0-9]+(\.[0-9]+)?$
+                         */
+                        cumVlm: string;
+                        /**
+                         * Total fees rewarded to the referred user since referral.
+                         * @pattern ^[0-9]+(\.[0-9]+)?$
+                         */
+                        cumRewardedFeesSinceReferred: string;
+                        /**
+                         * Total fees rewarded to the referrer from referred trades.
+                         * @pattern ^[0-9]+(\.[0-9]+)?$
+                         */
+                        cumFeesRewardedToReferrer: string;
+                    }
+                ][];
+            }[];
+        };
+    } | {
+        /** Referrer needs to create a referral code. */
+        stage: "needToCreateCode";
+    } | {
+        /** Referrer must complete a trade before earning rewards. */
+        stage: "needToTrade";
+        /** Required trading volume details for activation. */
+        data: {
+            /**
+             * Required trading volume.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            required: string;
+        };
+    };
+    /** History of referral rewards. */
+    rewardHistory: {
+        /**
+         * Amount of earned rewards.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        earned: string;
+        /**
+         * Traded volume at the time of reward.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        vlm: string;
+        /**
+         * Traded volume via referrals.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        referralVlm: string;
+        /** Timestamp when the reward was earned (in ms since epoch). */
+        time: number;
+    }[];
+    /** Mapping of token IDs to referral reward states. */
+    tokenToState: [
+        tokenId: number,
+        state: {
+            /**
+             * Cumulative traded volume.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            cumVlm: string;
+            /**
+             * Rewards earned but not yet claimed.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            unclaimedRewards: string;
+            /**
+             * Rewards that have been claimed.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            claimedRewards: string;
+            /**
+             * Builder reward amount.
+             * @pattern ^[0-9]+(\.[0-9]+)?$
+             */
+            builderRewards: string;
+        }
+    ][];
+};
+import type { InfoConfig } from "./_base/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 {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Referral details for a user.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { referral } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await referral(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+export declare function referral(config: InfoConfig, params: ReferralParameters, signal?: AbortSignal): Promise<ReferralResponse>;
+//# sourceMappingURL=referral.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/referral.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAExB,uBAAuB;;IAEvB,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wBAAwB;IACxB,UAAU,EAAE;QACV;;;WAGG;QACH,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;QACxB,0BAA0B;QAC1B,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,IAAI,CAAC;IACT;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,aAAa,EAAE;QACb,4CAA4C;QAC5C,KAAK,EAAE,OAAO,CAAC;QACf,gCAAgC;QAChC,IAAI,EAAE;YACJ,8BAA8B;YAC9B,IAAI,EAAE,MAAM,CAAC;YACb,iCAAiC;YACjC,UAAU,EAAE,MAAM,CAAC;YACnB,sCAAsC;YACtC,cAAc,EAAE;gBACd;;;mBAGG;gBACH,MAAM,EAAE,MAAM,CAAC;gBACf;;;mBAGG;gBACH,4BAA4B,EAAE,MAAM,CAAC;gBACrC;;;mBAGG;gBACH,yBAAyB,EAAE,MAAM,CAAC;gBAClC,mEAAmE;gBACnE,UAAU,EAAE,MAAM,CAAC;gBACnB;;;mBAGG;gBACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;gBACpB,sDAAsD;gBACtD,YAAY,EAAE;oBACZ,OAAO,EAAE,MAAM;oBACf,KAAK,EAAE;wBACL;;;2BAGG;wBACH,MAAM,EAAE,MAAM,CAAC;wBACf;;;2BAGG;wBACH,4BAA4B,EAAE,MAAM,CAAC;wBACrC;;;2BAGG;wBACH,yBAAyB,EAAE,MAAM,CAAC;qBACnC;iBACF,EAAE,CAAC;aACL,EAAE,CAAC;SACL,CAAC;KACH,GAAG;QACF,gDAAgD;QAChD,KAAK,EAAE,kBAAkB,CAAC;KAC3B,GAAG;QACF,6DAA6D;QAC7D,KAAK,EAAE,aAAa,CAAC;QACrB,sDAAsD;QACtD,IAAI,EAAE;YACJ;;;eAGG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;IACF,mCAAmC;IACnC,aAAa,EAAE;QACb;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB,gEAAgE;QAChE,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IACJ,sDAAsD;IACtD,YAAY,EAAE;QACZ,OAAO,EAAE,MAAM;QACf,KAAK,EAAE;YACL;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;;eAGG;YACH,gBAAgB,EAAE,MAAM,CAAC;YACzB;;;eAGG;YACH,cAAc,EAAE,MAAM,CAAC;YACvB;;;eAGG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;KACF,EAAE,CAAC;CACL,CAAC;AAOF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}

package/script/api/info/_methods/referral.js

@@ -0,0 +1,92 @@
+"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.ReferralRequest = void 0;
+exports.referral = referral;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _schemas_js_1 = require("../../_schemas.js");
+/**
+ * Request user referral.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+exports.ReferralRequest = (() => {
+    return v.object({
+        /** Type of request. */
+        type: v.literal("referral"),
+        /** User address. */
+        user: _schemas_js_1.Address,
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_1 = require("../../../_base.js");
+/**
+ * Request user referral.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Referral details for a user.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { referral } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await referral(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+function referral(config, params, signal) {
+    const request = (0, _base_js_1.parse)(exports.ReferralRequest, {
+        type: "referral",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=referral.js.map

package/script/api/info/_methods/referral.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral.js","sourceRoot":"","sources":["../../../../src/api/info/_methods/referral.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,4BAUC;AA/ND,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAA4C;AAE5C;;;GAGG;AACU,QAAA,eAAe,GAAmB,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3B,oBAAoB;QACpB,IAAI,EAAE,qBAAO;KACd,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AA8JL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,gDAA0C;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,QAAQ,CACtB,MAAkB,EAClB,MAA0B,EAC1B,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,gBAAK,EAAC,uBAAe,EAAE;QACrC,IAAI,EAAE,UAAU;QAChB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/script/api/info/_methods/spotClearinghouseState.d.ts

@@ -0,0 +1,85 @@
+import * as v from "valibot";
+/**
+ * Request spot clearinghouse state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+export declare const SpotClearinghouseStateRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"spotClearinghouseState", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;
+export type SpotClearinghouseStateRequest = v.InferOutput<typeof SpotClearinghouseStateRequest>;
+/**
+ * Account summary for spot trading.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+export type SpotClearinghouseStateResponse = {
+    /** Array of available token balances. */
+    balances: {
+        /** Asset symbol. */
+        coin: string;
+        /** Unique identifier for the token. */
+        token: number;
+        /**
+         * Total balance.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        total: string;
+        /**
+         * Amount on hold.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        hold: string;
+        /**
+         * Entry notional value.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        entryNtl: string;
+    }[];
+    /** Array of escrowed balances. */
+    evmEscrows?: {
+        /** Asset symbol. */
+        coin: string;
+        /** Unique identifier for the token. */
+        token: number;
+        /**
+         * Total balance.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        total: string;
+    }[];
+};
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode spotClearinghouseState} function. */
+export type SpotClearinghouseStateParameters = Omit<v.InferInput<typeof SpotClearinghouseStateRequest>, "type">;
+/**
+ * Request spot clearinghouse state.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Account summary for spot trading.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotClearinghouseState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await spotClearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+export declare function spotClearinghouseState(config: InfoConfig, params: SpotClearinghouseStateParameters, signal?: AbortSignal): Promise<SpotClearinghouseStateResponse>;
+//# sourceMappingURL=spotClearinghouseState.d.ts.map

package/script/api/info/_methods/spotClearinghouseState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotClearinghouseState.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/spotClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,6BAA6B;IAEtC,uBAAuB;;IAEvB,oBAAoB;;IAEpB,4CAA4C;;aAG5C,CAAC;AACL,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,yCAAyC;IACzC,QAAQ,EAAE;QACR,oBAAoB;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,uCAAuC;QACvC,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;IACJ,kCAAkC;IAClC,UAAU,CAAC,EAAE;QACX,oBAAoB;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,uCAAuC;QACvC,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC;AAOF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,8EAA8E;AAC9E,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,6BAA6B,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,gCAAgC,EACxC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,8BAA8B,CAAC,CAMzC"}