@hfunlabs/hyperliquid 0.27.1-hfunlabs.5 → 0.29.1-hfunlabs.1

package/script/src/api/info/_methods/userFees.d.ts

@@ -0,0 +1,273 @@
+import * as v from "valibot";
+/**
+ * Request user fees.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+export declare const UserFeesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFees", undefined>, v.DescriptionAction<"userFees", "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: "userFees";
+    user: `0x${string}`;
+}, "Request user fees.">]>;
+export type UserFeesRequest = v.InferOutput<typeof UserFeesRequest>;
+/**
+ * User fees.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+export declare const UserFeesResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Daily user volume metrics. */
+    readonly dailyUserVlm: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Date in YYYY-M-D format. */
+        readonly date: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoDateAction<string, undefined>, v.DescriptionAction<string, "Date in YYYY-M-D format.">]>;
+        /** User cross-trade volume. */
+        readonly userCross: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User cross-trade volume.">]>;
+        /** User add-liquidity volume. */
+        readonly userAdd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User add-liquidity volume.">]>;
+        /** Exchange total volume. */
+        readonly exchange: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Exchange total volume.">]>;
+    }, undefined>, v.DescriptionAction<{
+        date: string;
+        userCross: string;
+        userAdd: string;
+        exchange: string;
+    }, "Daily user volume metrics record.">]>, undefined>, v.DescriptionAction<{
+        date: string;
+        userCross: string;
+        userAdd: string;
+        exchange: string;
+    }[], "Daily user volume metrics.">]>;
+    /** Fee schedule information. */
+    readonly feeSchedule: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Cross-trade fee rate. */
+        readonly cross: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Cross-trade fee rate.">]>;
+        /** Add-liquidity fee rate. */
+        readonly add: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Add-liquidity fee rate.">]>;
+        /** Spot cross-trade fee rate. */
+        readonly spotCross: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Spot cross-trade fee rate.">]>;
+        /** Spot add-liquidity fee rate. */
+        readonly spotAdd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Spot add-liquidity fee rate.">]>;
+        /** Fee tiers details. */
+        readonly tiers: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Array of VIP fee tiers. */
+            readonly vip: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Notional volume cutoff. */
+                readonly ntlCutoff: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Notional volume cutoff.">]>;
+                /** Cross-trade fee rate. */
+                readonly cross: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Cross-trade fee rate.">]>;
+                /** Add-liquidity fee rate. */
+                readonly add: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Add-liquidity fee rate.">]>;
+                /** Spot cross-trade fee rate. */
+                readonly spotCross: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Spot cross-trade fee rate.">]>;
+                /** Spot add-liquidity fee rate. */
+                readonly spotAdd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Spot add-liquidity fee rate.">]>;
+            }, undefined>, v.DescriptionAction<{
+                ntlCutoff: string;
+                cross: string;
+                add: string;
+                spotCross: string;
+                spotAdd: string;
+            }, "VIP fee tier.">]>, undefined>, v.DescriptionAction<{
+                ntlCutoff: string;
+                cross: string;
+                add: string;
+                spotCross: string;
+                spotAdd: string;
+            }[], "Array of VIP fee tiers.">]>;
+            /** Array of market maker fee tiers. */
+            readonly mm: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Maker fraction cutoff. */
+                readonly makerFractionCutoff: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Maker fraction cutoff.">]>;
+                /** Add-liquidity fee rate. */
+                readonly add: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Add-liquidity fee rate.">]>;
+            }, undefined>, v.DescriptionAction<{
+                makerFractionCutoff: string;
+                add: string;
+            }, "Market maker fee tier.">]>, undefined>, v.DescriptionAction<{
+                makerFractionCutoff: string;
+                add: string;
+            }[], "Array of market maker fee tiers.">]>;
+        }, undefined>, v.DescriptionAction<{
+            vip: {
+                ntlCutoff: string;
+                cross: string;
+                add: string;
+                spotCross: string;
+                spotAdd: string;
+            }[];
+            mm: {
+                makerFractionCutoff: string;
+                add: string;
+            }[];
+        }, "Fee tiers details.">]>;
+        /** Referral discount rate. */
+        readonly referralDiscount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Referral discount rate.">]>;
+        /** Array of staking discount tiers. */
+        readonly stakingDiscountTiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Basis points of maximum supply. */
+            readonly bpsOfMaxSupply: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Basis points of maximum supply.">]>;
+            /** Discount rate applied. */
+            readonly discount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Discount rate applied.">]>;
+        }, undefined>, v.DescriptionAction<{
+            bpsOfMaxSupply: string;
+            discount: string;
+        }, "Staking discount tier.">]>, undefined>, v.DescriptionAction<{
+            bpsOfMaxSupply: string;
+            discount: string;
+        }[], "Staking discount tiers details.">]>;
+    }, undefined>, v.DescriptionAction<{
+        cross: string;
+        add: string;
+        spotCross: string;
+        spotAdd: string;
+        tiers: {
+            vip: {
+                ntlCutoff: string;
+                cross: string;
+                add: string;
+                spotCross: string;
+                spotAdd: string;
+            }[];
+            mm: {
+                makerFractionCutoff: string;
+                add: string;
+            }[];
+        };
+        referralDiscount: string;
+        stakingDiscountTiers: {
+            bpsOfMaxSupply: string;
+            discount: string;
+        }[];
+    }, "Array of staking discount tiers.">]>;
+    /** User cross-trade rate. */
+    readonly userCrossRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User cross-trade rate.">]>;
+    /** User add-liquidity rate. */
+    readonly userAddRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User add-liquidity rate.">]>;
+    /** User spot cross-trade rate. */
+    readonly userSpotCrossRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User spot cross-trade rate.">]>;
+    /** User spot add-liquidity rate. */
+    readonly userSpotAddRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "User spot add-liquidity rate.">]>;
+    /** Active referral discount rate. */
+    readonly activeReferralDiscount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Active referral discount rate.">]>;
+    /** Trial details. */
+    readonly trial: v.SchemaWithPipe<readonly [v.NullableSchema<v.UnknownSchema, undefined>, v.DescriptionAction<unknown, "Trial details.">]>;
+    /** Fee trial escrow amount. */
+    readonly feeTrialEscrow: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Fee trial escrow amount.">]>;
+    /** Timestamp when next trial becomes available. */
+    readonly nextTrialAvailableTimestamp: v.SchemaWithPipe<readonly [v.NullableSchema<v.UnknownSchema, undefined>, v.DescriptionAction<unknown, "Timestamp when next trial becomes available.">]>;
+    /**
+     * Permanent link between staking and trading accounts.
+     * Staking user gains full control of trading account funds.
+     * Staking user forfeits own fee discounts.
+     */
+    readonly stakingLink: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+        /**
+         * Linked account address:
+         * - When queried by staking account: contains trading account address.
+         * - When queried by trading account: contains staking account address.
+         */
+        readonly stakingUser: 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}`, string>]>;
+        /**
+         * Link status:
+         * - `requested` = link initiated by trading user, awaiting staking user confirmation.
+         * - `stakingUser` = response queried by staking account.
+         * - `tradingUser` = response queried by trading account.
+         */
+        readonly type: v.SchemaWithPipe<readonly [v.PicklistSchema<["requested", "stakingUser", "tradingUser"], undefined>, v.DescriptionAction<"stakingUser" | "requested" | "tradingUser", string>]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        stakingUser: `0x${string}`;
+        type: "stakingUser" | "requested" | "tradingUser";
+    } | null, "Permanent link between staking and trading accounts. Staking user gains full control of trading account funds. Staking user forfeits own fee discounts.">]>;
+    /** Active staking discount details. */
+    readonly activeStakingDiscount: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Basis points of maximum supply. */
+        readonly bpsOfMaxSupply: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Basis points of maximum supply.">]>;
+        /** Discount rate applied. */
+        readonly discount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Discount rate applied.">]>;
+    }, undefined>, v.DescriptionAction<{
+        bpsOfMaxSupply: string;
+        discount: string;
+    }, "Active staking discount details.">]>;
+}, undefined>, v.DescriptionAction<{
+    dailyUserVlm: {
+        date: string;
+        userCross: string;
+        userAdd: string;
+        exchange: string;
+    }[];
+    feeSchedule: {
+        cross: string;
+        add: string;
+        spotCross: string;
+        spotAdd: string;
+        tiers: {
+            vip: {
+                ntlCutoff: string;
+                cross: string;
+                add: string;
+                spotCross: string;
+                spotAdd: string;
+            }[];
+            mm: {
+                makerFractionCutoff: string;
+                add: string;
+            }[];
+        };
+        referralDiscount: string;
+        stakingDiscountTiers: {
+            bpsOfMaxSupply: string;
+            discount: string;
+        }[];
+    };
+    userCrossRate: string;
+    userAddRate: string;
+    userSpotCrossRate: string;
+    userSpotAddRate: string;
+    activeReferralDiscount: string;
+    trial: unknown;
+    feeTrialEscrow: string;
+    nextTrialAvailableTimestamp: unknown;
+    stakingLink: {
+        stakingUser: `0x${string}`;
+        type: "stakingUser" | "requested" | "tradingUser";
+    } | null;
+    activeStakingDiscount: {
+        bpsOfMaxSupply: string;
+        discount: string;
+    };
+}, "User fees.">]>;
+export type UserFeesResponse = v.InferOutput<typeof UserFeesResponse>;
+import type { InfoConfig } from "./_types.js";
+/** Request parameters for the {@linkcode userFees} function. */
+export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "type">;
+/**
+ * Request user fees.
+ *
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ *
+ * @returns User fees.
+ *
+ * @throws {ValiError} 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 { userFees } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userFees(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+export declare function userFees(config: InfoConfig, params: UserFeesParameters, signal?: AbortSignal): Promise<UserFeesResponse>;
+//# sourceMappingURL=userFees.d.ts.map

package/script/src/api/info/_methods/userFees.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFees.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userFees.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,uBAAuB;;IAKvB,oBAAoB;;;;;0BAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,iCAAiC;;QAMzB,+BAA+B;;QAM/B,+BAA+B;;QAK/B,iCAAiC;;QAKjC,6BAA6B;;;;;;;;;;;;;IAWrC,gCAAgC;;QAG5B,4BAA4B;;QAK5B,8BAA8B;;QAK9B,iCAAiC;;QAKjC,mCAAmC;;QAKnC,yBAAyB;;YAGrB,8BAA8B;;gBAMtB,8BAA8B;;gBAK9B,4BAA4B;;gBAK5B,8BAA8B;;gBAK9B,iCAAiC;;gBAKjC,mCAAmC;;;;;;;;;;;;;;;YAW3C,uCAAuC;;gBAM/B,6BAA6B;;gBAK7B,8BAA8B;;;;;;;;;;;;;;;;;;;;;;QAc1C,8BAA8B;;QAK9B,uCAAuC;;YAM/B,sCAAsC;;YAKtC,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAczC,6BAA6B;;IAK7B,+BAA+B;;IAK/B,kCAAkC;;IAKlC,oCAAoC;;IAKpC,qCAAqC;;IAKrC,qBAAqB;;IAKrB,+BAA+B;;IAK/B,mDAAmD;;IAKnD;;;;OAIG;;QAIG;;;;WAIG;;QASH;;;;;WAKG;;;;;;IAgBT,uCAAuC;;QAGnC,sCAAsC;;QAKtC,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAWnC,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}

package/script/src/api/info/_methods/userFees.js

@@ -0,0 +1,207 @@
+"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.UserFeesResponse = exports.UserFeesRequest = void 0;
+exports.userFees = userFees;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _schemas_js_1 = require("../../_schemas.js");
+/**
+ * Request user fees.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+exports.UserFeesRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userFees"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(_schemas_js_1.Address, v.description("User address.")),
+    }), v.description("Request user fees."));
+})();
+/**
+ * User fees.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+exports.UserFeesResponse = (() => {
+    return v.pipe(v.object({
+        /** Daily user volume metrics. */
+        dailyUserVlm: v.pipe(v.array(
+        /** Daily user volume metrics record. */
+        v.pipe(v.object({
+            /** Date in YYYY-M-D format. */
+            date: v.pipe(v.string(), v.isoDate(), v.description("Date in YYYY-M-D format.")),
+            /** User cross-trade volume. */
+            userCross: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User cross-trade volume.")),
+            /** User add-liquidity volume. */
+            userAdd: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User add-liquidity volume.")),
+            /** Exchange total volume. */
+            exchange: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Exchange total volume.")),
+        }), v.description("Daily user volume metrics record."))), v.description("Daily user volume metrics.")),
+        /** Fee schedule information. */
+        feeSchedule: v.pipe(v.object({
+            /** Cross-trade fee rate. */
+            cross: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Cross-trade fee rate.")),
+            /** Add-liquidity fee rate. */
+            add: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Add-liquidity fee rate.")),
+            /** Spot cross-trade fee rate. */
+            spotCross: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Spot cross-trade fee rate.")),
+            /** Spot add-liquidity fee rate. */
+            spotAdd: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Spot add-liquidity fee rate.")),
+            /** Fee tiers details. */
+            tiers: v.pipe(v.object({
+                /** Array of VIP fee tiers. */
+                vip: v.pipe(v.array(
+                /** VIP fee tier. */
+                v.pipe(v.object({
+                    /** Notional volume cutoff. */
+                    ntlCutoff: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Notional volume cutoff.")),
+                    /** Cross-trade fee rate. */
+                    cross: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Cross-trade fee rate.")),
+                    /** Add-liquidity fee rate. */
+                    add: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Add-liquidity fee rate.")),
+                    /** Spot cross-trade fee rate. */
+                    spotCross: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Spot cross-trade fee rate.")),
+                    /** Spot add-liquidity fee rate. */
+                    spotAdd: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Spot add-liquidity fee rate.")),
+                }), v.description("VIP fee tier."))), v.description("Array of VIP fee tiers.")),
+                /** Array of market maker fee tiers. */
+                mm: v.pipe(v.array(
+                /** Market maker fee tier. */
+                v.pipe(v.object({
+                    /** Maker fraction cutoff. */
+                    makerFractionCutoff: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Maker fraction cutoff.")),
+                    /** Add-liquidity fee rate. */
+                    add: v.pipe(_schemas_js_1.Decimal, v.description("Add-liquidity fee rate.")),
+                }), v.description("Market maker fee tier."))), v.description("Array of market maker fee tiers.")),
+            }), v.description("Fee tiers details.")),
+            /** Referral discount rate. */
+            referralDiscount: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Referral discount rate.")),
+            /** Array of staking discount tiers. */
+            stakingDiscountTiers: v.pipe(v.array(
+            /** Staking discount tier. */
+            v.pipe(v.object({
+                /** Basis points of maximum supply. */
+                bpsOfMaxSupply: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Basis points of maximum supply.")),
+                /** Discount rate applied. */
+                discount: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Discount rate applied.")),
+            }), v.description("Staking discount tier."))), v.description("Staking discount tiers details.")),
+        }), v.description("Array of staking discount tiers.")),
+        /** User cross-trade rate. */
+        userCrossRate: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User cross-trade rate.")),
+        /** User add-liquidity rate. */
+        userAddRate: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User add-liquidity rate.")),
+        /** User spot cross-trade rate. */
+        userSpotCrossRate: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User spot cross-trade rate.")),
+        /** User spot add-liquidity rate. */
+        userSpotAddRate: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("User spot add-liquidity rate.")),
+        /** Active referral discount rate. */
+        activeReferralDiscount: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Active referral discount rate.")),
+        /** Trial details. */
+        trial: v.pipe(v.nullable(v.unknown()), v.description("Trial details.")),
+        /** Fee trial escrow amount. */
+        feeTrialEscrow: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Fee trial escrow amount.")),
+        /** Timestamp when next trial becomes available. */
+        nextTrialAvailableTimestamp: v.pipe(v.nullable(v.unknown()), v.description("Timestamp when next trial becomes available.")),
+        /**
+         * Permanent link between staking and trading accounts.
+         * Staking user gains full control of trading account funds.
+         * Staking user forfeits own fee discounts.
+         */
+        stakingLink: v.pipe(v.nullable(v.object({
+            /**
+             * Linked account address:
+             * - When queried by staking account: contains trading account address.
+             * - When queried by trading account: contains staking account address.
+             */
+            stakingUser: v.pipe(_schemas_js_1.Address, v.description("Linked account address:" +
+                "\n- When queried by staking account: contains trading account address." +
+                "\n- When queried by trading account: contains staking account address.")),
+            /**
+             * Link status:
+             * - `requested` = link initiated by trading user, awaiting staking user confirmation.
+             * - `stakingUser` = response queried by staking account.
+             * - `tradingUser` = response queried by trading account.
+             */
+            type: v.pipe(v.picklist(["requested", "stakingUser", "tradingUser"]), v.description("Link status:" +
+                "\n- `requested` = link initiated by trading user, awaiting staking user confirmation" +
+                "\n- `stakingUser` = response queried by staking account" +
+                "\n- `tradingUser` = response queried by trading account")),
+        })), v.description("Permanent link between staking and trading accounts. Staking user gains full control of trading account funds. Staking user forfeits own fee discounts.")),
+        /** Active staking discount details. */
+        activeStakingDiscount: v.pipe(v.object({
+            /** Basis points of maximum supply. */
+            bpsOfMaxSupply: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Basis points of maximum supply.")),
+            /** Discount rate applied. */
+            discount: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Discount rate applied.")),
+        }), v.description("Active staking discount details.")),
+    }), v.description("User fees."));
+})();
+/**
+ * Request user fees.
+ *
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ *
+ * @returns User fees.
+ *
+ * @throws {ValiError} 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 { userFees } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userFees(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+function userFees(config, params, signal) {
+    const request = v.parse(exports.UserFeesRequest, {
+        type: "userFees",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userFees.js.map

package/script/src/api/info/_methods/userFees.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFees.js","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userFees.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyUA,4BAUC;AAnVD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,mDAAsE;AAEtE;;;GAGG;AACU,QAAA,eAAe,GAAmB,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,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,gBAAgB,GAAmB,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,iCAAiC;QACjC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,KAAK;QACL,wCAAwC;QACxC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,+BAA+B;YAC/B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,+BAA+B;YAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,iCAAiC;YACjC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;YACD,6BAA6B;YAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;QACD,gCAAgC;QAChC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,CAAC;YACP,4BAA4B;YAC5B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,8BAA8B;YAC9B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,iCAAiC;YACjC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;YACD,mCAAmC;YACnC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,yBAAyB;YACzB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;gBACP,8BAA8B;gBAC9B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,KAAK;gBACL,oBAAoB;gBACpB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;oBACP,8BAA8B;oBAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;oBACD,4BAA4B;oBAC5B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;oBACD,8BAA8B;oBAC9B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;oBACD,iCAAiC;oBACjC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;oBACD,mCAAmC;oBACnC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B,CACF,EACD,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;gBACD,uCAAuC;gBACvC,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,CAAC,CAAC,KAAK;gBACL,6BAA6B;gBAC7B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;oBACP,6BAA6B;oBAC7B,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;oBACD,8BAA8B;oBAC9B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,qBAAO,EACP,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;iBACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;YACD,8BAA8B;YAC9B,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,uCAAuC;YACvC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAC1B,CAAC,CAAC,KAAK;YACL,6BAA6B;YAC7B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;gBACP,sCAAsC;gBACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;gBACD,6BAA6B;gBAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,6BAA6B;QAC7B,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;QACD,+BAA+B;QAC/B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,kCAAkC;QAClC,iBAAiB,EAAE,CAAC,CAAC,IAAI,CACvB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;QACD,oCAAoC;QACpC,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,qCAAqC;QACrC,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAC5B,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;QACD,qBAAqB;QACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD,+BAA+B;QAC/B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,mDAAmD;QACnD,2BAA2B,EAAE,CAAC,CAAC,IAAI,CACjC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;QACD;;;;WAIG;QACH,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;YACP;;;;eAIG;YACH,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,qBAAO,EACP,CAAC,CAAC,WAAW,CACX,yBAAyB;gBACvB,wEAAwE;gBACxE,wEAAwE,CAC3E,CACF;YACD;;;;;eAKG;YACH,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC,EACvD,CAAC,CAAC,WAAW,CACX,cAAc;gBACZ,sFAAsF;gBACtF,yDAAyD;gBACzD,yDAAyD,CAC5D,CACF;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CACX,yJAAyJ,CAC1J,CACF;QACD,uCAAuC;QACvC,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAC3B,CAAC,CAAC,MAAM,CAAC;YACP,sCAAsC;YACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;YACD,6BAA6B;YAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,6BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAYL;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,QAAQ,CACtB,MAAkB,EAClB,MAA0B,EAC1B,MAAoB;IAEpB,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,uBAAe,EAAE;QACvC,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"}