@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

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

@@ -0,0 +1,274 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * 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.UnionSchema<[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>, v.NullSchema<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.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.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.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.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.UnionSchema<[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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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>;
+/** 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/esm/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;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AACtG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;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;;;;;;IAWhC,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;AAItE,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"}

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

@@ -0,0 +1,156 @@
+import * as v from "valibot";
+import { Address, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request user referral.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+export const ReferralRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("referral"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Request user referral."));
+})();
+/**
+ * Referral details for a user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+export const ReferralResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Referrer details. */
+        referredBy: v.pipe(v.union([
+            v.object({
+                /** Referrer address. */
+                referrer: v.pipe(Address, v.description("Referrer address.")),
+                /** Referral code used. */
+                code: v.pipe(v.string(), v.minLength(1), v.description("Referral code used.")),
+            }),
+            v.null(),
+        ]), v.description("Referrer details.")),
+        /** Cumulative traded volume. */
+        cumVlm: v.pipe(UnsignedDecimal, v.description("Cumulative traded volume.")),
+        /** Rewards earned but not yet claimed. */
+        unclaimedRewards: v.pipe(UnsignedDecimal, v.description("Rewards earned but not yet claimed.")),
+        /** Rewards that have been claimed. */
+        claimedRewards: v.pipe(UnsignedDecimal, v.description("Rewards that have been claimed.")),
+        /** Builder reward amount. */
+        builderRewards: v.pipe(UnsignedDecimal, v.description("Builder reward amount.")),
+        /** Current state of the referrer. */
+        referrerState: v.pipe(v.union([
+            v.object({
+                /** Referrer is ready to receive rewards. */
+                stage: v.pipe(v.literal("ready"), v.description("Referrer is ready to receive rewards.")),
+                /** Referral program details. */
+                data: v.pipe(v.object({
+                    /** Assigned referral code. */
+                    code: v.pipe(v.string(), v.minLength(1), v.description("Assigned referral code.")),
+                    /** Total number of referrals. */
+                    nReferrals: v.pipe(UnsignedInteger, v.description("Total number of referrals.")),
+                    /** Summary of each referral state. */
+                    referralStates: v.pipe(v.array(
+                    /** Referral state for a referred user. */
+                    v.pipe(v.object({
+                        /** Cumulative traded volume. */
+                        cumVlm: v.pipe(UnsignedDecimal, v.description("Cumulative traded volume.")),
+                        /** Total fees rewarded to the referred user since referral. */
+                        cumRewardedFeesSinceReferred: v.pipe(UnsignedDecimal, v.description("Total fees rewarded to the referred user since referral.")),
+                        /** Total fees rewarded to the referrer from referred trades. */
+                        cumFeesRewardedToReferrer: v.pipe(UnsignedDecimal, v.description("Total fees rewarded to the referrer from referred trades.")),
+                        /** Timestamp when the referred user joined (in ms since epoch). */
+                        timeJoined: v.pipe(UnsignedInteger, v.description("Timestamp when the referred user joined (in ms since epoch).")),
+                        /** Address of the referred user. */
+                        user: v.pipe(Address, v.description("Address of the referred user.")),
+                        /** Mapping of token IDs to referral reward states. */
+                        tokenToState: v.pipe(v.array(
+                        /** Tuple of token ID and its referral reward state. */
+                        v.pipe(v.tuple([
+                            UnsignedInteger,
+                            v.object({
+                                /** Cumulative traded volume. */
+                                cumVlm: v.pipe(UnsignedDecimal, v.description("Cumulative traded volume.")),
+                                /** Total fees rewarded to the referred user since referral. */
+                                cumRewardedFeesSinceReferred: v.pipe(UnsignedDecimal, v.description("Total fees rewarded to the referred user since referral.")),
+                                /** Total fees rewarded to the referrer from referred trades. */
+                                cumFeesRewardedToReferrer: v.pipe(UnsignedDecimal, v.description("Total fees rewarded to the referrer from referred trades.")),
+                            }),
+                        ]), v.description("Tuple of token ID and its referral reward state."))), v.description("Mapping of token IDs to referral reward states.")),
+                    }), v.description("Referral state for a referred user."))), v.description("Summary of each referral state.")),
+                }), v.description("Referral program details.")),
+            }),
+            v.object({
+                /** Referrer needs to create a referral code. */
+                stage: v.pipe(v.literal("needToCreateCode"), v.description("Referrer needs to create a referral code.")),
+            }),
+            v.object({
+                /** Referrer must complete a trade before earning rewards. */
+                stage: v.pipe(v.literal("needToTrade"), v.description("Referrer must complete a trade before earning rewards.")),
+                /** Required trading volume details for activation. */
+                data: v.pipe(v.object({
+                    /** Required trading volume. */
+                    required: v.pipe(UnsignedDecimal, v.description("Required trading volume.")),
+                }), v.description("Required trading volume details for activation.")),
+            }),
+        ]), v.description("Current state of the referrer.")),
+        /** History of referral rewards. */
+        rewardHistory: v.pipe(v.array(
+        /** Referral reward entry. */
+        v.pipe(v.object({
+            /** Amount of earned rewards. */
+            earned: v.pipe(UnsignedDecimal, v.description("Amount of earned rewards.")),
+            /** Traded volume at the time of reward. */
+            vlm: v.pipe(UnsignedDecimal, v.description("Traded volume at the time of reward.")),
+            /** Traded volume via referrals. */
+            referralVlm: v.pipe(UnsignedDecimal, v.description("Traded volume via referrals.")),
+            /** Timestamp when the reward was earned (in ms since epoch). */
+            time: v.pipe(UnsignedInteger, v.description("Timestamp when the reward was earned (in ms since epoch).")),
+        }), v.description("Referral reward entry."))), v.description("History of referral rewards.")),
+        /** Mapping of token IDs to referral reward states. */
+        tokenToState: v.pipe(v.array(
+        /** Tuple of token ID and its referral reward state. */
+        v.pipe(v.tuple([
+            UnsignedInteger,
+            v.object({
+                /** Cumulative traded volume. */
+                cumVlm: v.pipe(UnsignedDecimal, v.description("Cumulative traded volume.")),
+                /** Rewards earned but not yet claimed. */
+                unclaimedRewards: v.pipe(UnsignedDecimal, v.description("Rewards earned but not yet claimed.")),
+                /** Rewards that have been claimed. */
+                claimedRewards: v.pipe(UnsignedDecimal, v.description("Rewards that have been claimed.")),
+                /** Builder reward amount. */
+                builderRewards: v.pipe(UnsignedDecimal, v.description("Builder reward amount.")),
+            }),
+        ]), v.description("Tuple of token ID and its referral reward state."))), v.description("Mapping of token IDs to referral reward states.")),
+    }), v.description("Referral details for a user."));
+})();
+/**
+ * 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 function referral(config, params, signal) {
+    const request = parser(ReferralRequest)({
+        type: "referral",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=referral.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"referral.js","sourceRoot":"","sources":["../../../../src/src/api/info/referral.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGtG,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,wBAAwB;QACxB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,MAAM,CAAC;gBACP,wBAAwB;gBACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,0BAA0B;gBAC1B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACd,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;aACF,CAAC;YACF,CAAC,CAAC,IAAI,EAAE;SACT,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,gCAAgC;QAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,0CAA0C;QAC1C,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;QACD,sCAAsC;QACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;QACD,6BAA6B;QAC7B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;QACD,qCAAqC;QACrC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,MAAM,CAAC;gBACP,4CAA4C;gBAC5C,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;gBACD,gCAAgC;gBAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;oBACP,8BAA8B;oBAC9B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACd,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;oBACD,iCAAiC;oBACjC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;oBACD,sCAAsC;oBACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK;oBACL,0CAA0C;oBAC1C,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;wBACP,gCAAgC;wBAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;wBACD,+DAA+D;wBAC/D,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAClC,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;wBACD,gEAAgE;wBAChE,yBAAyB,EAAE,CAAC,CAAC,IAAI,CAC/B,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAC3E;wBACD,mEAAmE;wBACnE,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CACX,8DAA8D,CAC/D,CACF;wBACD,oCAAoC;wBACpC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;wBACD,sDAAsD;wBACtD,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,KAAK;wBACL,uDAAuD;wBACvD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,KAAK,CAAC;4BACN,eAAe;4BACf,CAAC,CAAC,MAAM,CAAC;gCACP,gCAAgC;gCAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;gCACD,+DAA+D;gCAC/D,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAClC,eAAe,EACf,CAAC,CAAC,WAAW,CACX,0DAA0D,CAC3D,CACF;gCACD,gEAAgE;gCAChE,yBAAyB,EAAE,CAAC,CAAC,IAAI,CAC/B,eAAe,EACf,CAAC,CAAC,WAAW,CACX,2DAA2D,CAC5D,CACF;6BACF,CAAC;yBACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kDAAkD,CAAC,CAClE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE;qBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;aACF,CAAC;YACF,CAAC,CAAC,MAAM,CAAC;gBACP,gDAAgD;gBAChD,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;aACF,CAAC;YACF,CAAC,CAAC,MAAM,CAAC;gBACP,6DAA6D;gBAC7D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;gBACD,sDAAsD;gBACtD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;oBACP,+BAA+B;oBAC/B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE;aACF,CAAC;SACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;QACD,mCAAmC;QACnC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,KAAK;QACL,6BAA6B;QAC7B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,gCAAgC;YAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,2CAA2C;YAC3C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;YACD,mCAAmC;YACnC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,gEAAgE;YAChE,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAC3E;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,sDAAsD;QACtD,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,KAAK;QACL,uDAAuD;QACvD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,KAAK,CAAC;YACN,eAAe;YACf,CAAC,CAAC,MAAM,CAAC;gBACP,gCAAgC;gBAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;gBACD,0CAA0C;gBAC1C,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;gBACD,sCAAsC;gBACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;gBACD,6BAA6B;gBAC7B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;aACF,CAAC;SACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kDAAkD,CAAC,CAClE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CACjE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAyB,EACzB,MAAyC,EACzC,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;QACtC,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/esm/src/api/info/spotClearinghouseState.d.ts

@@ -0,0 +1,108 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * 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.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotClearinghouseState", undefined>, v.DescriptionAction<"spotClearinghouseState", "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.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "spotClearinghouseState";
+    user: `0x${string}`;
+    dex?: string | undefined;
+}, "Request spot clearinghouse state.">]>;
+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 declare const SpotClearinghouseStateResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Balance for each token. */
+    readonly balances: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Unique identifier for the token. */
+        readonly token: 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, "Unique identifier for the token.">]>;
+        /** Total balance. */
+        readonly total: 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, "Total balance.">]>;
+        /** Amount on hold. */
+        readonly hold: 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, "Amount on hold.">]>;
+        /** Entry notional value. */
+        readonly entryNtl: 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, "Entry notional value.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl: string;
+    }, "Balance for a specific spot token.">]>, undefined>, v.DescriptionAction<{
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl: string;
+    }[], "Balance for each token.">]>;
+    /** Escrowed balances. */
+    readonly evmEscrows: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Unique identifier for the token. */
+        readonly token: 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, "Unique identifier for the token.">]>;
+        /** Total balance. */
+        readonly total: 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, "Total balance.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        token: number;
+        total: string;
+    }, "Escrowed balance for a specific asset.">]>, undefined>, undefined>, v.DescriptionAction<{
+        coin: string;
+        token: number;
+        total: string;
+    }[] | undefined, "Escrowed balances.">]>;
+}, undefined>, v.DescriptionAction<{
+    balances: {
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl: string;
+    }[];
+    evmEscrows?: {
+        coin: string;
+        token: number;
+        total: string;
+    }[] | undefined;
+}, "Account summary for spot trading.">]>;
+export type SpotClearinghouseStateResponse = v.InferOutput<typeof SpotClearinghouseStateResponse>;
+/** 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 - 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 Account summary for spot trading.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ * @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..." },
+ * );
+ * ```
+ */
+export declare function spotClearinghouseState(config: InfoRequestConfig, params: DeepImmutable<SpotClearinghouseStateParameters>, signal?: AbortSignal): Promise<SpotClearinghouseStateResponse>;
+//# sourceMappingURL=spotClearinghouseState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spotClearinghouseState.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/spotClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AACtG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,6BAA6B;IAGpC,uBAAuB;;IAKvB,oBAAoB;;IAKpB,4CAA4C;;;;;;yCAQ9C,CAAC;AACL,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,8BAA8B;IAGrC,8BAA8B;;QAMtB,oBAAoB;;QAKpB,uCAAuC;;QAKvC,qBAAqB;;QAKrB,sBAAsB;;QAKtB,4BAA4B;;;;;;;;;;;;;;;IAWpC,yBAAyB;;QAOf,oBAAoB;;QAKpB,uCAAuC;;QAKvC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;yCAejC,CAAC;AACL,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAIlG,8EAA8E;AAC9E,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,6BAA6B,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,gCAAgC,CAAC,EACvD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,8BAA8B,CAAC,CAMzC"}