@nktkas/hyperliquid 0.24.3 → 0.25.0-beta.2

package/script/src/schemas/info/requests.js

@@ -0,0 +1,724 @@
+"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.UserTwapSliceFillsByTimeRequest = exports.UserTwapSliceFillsRequest = exports.UserToMultiSigSignersRequest = exports.UserRoleRequest = exports.UserRateLimitRequest = exports.UserNonFundingLedgerUpdatesRequest = exports.UserFundingRequest = exports.UserFillsByTimeRequest = exports.UserFillsRequest = exports.UserFeesRequest = exports.TwapHistoryRequest = exports.TokenDetailsRequest = exports.SubAccountsRequest = exports.SpotPairDeployAuctionStatusRequest = exports.SpotMetaAndAssetCtxsRequest = exports.SpotMetaRequest = exports.SpotDeployStateRequest = exports.SpotClearinghouseStateRequest = exports.ReferralRequest = exports.PreTransferCheckRequest = exports.PredictedFundingsRequest = exports.PortfolioRequest = exports.PerpsAtOpenInterestCapRequest = exports.PerpDexsRequest = exports.PerpDeployAuctionStatusRequest = exports.OrderStatusRequest = exports.OpenOrdersRequest = exports.MetaAndAssetCtxsRequest = exports.MetaRequest = exports.MaxMarketOrderNtlsRequest = exports.MaxBuilderFeeRequest = exports.MarginTableRequest = exports.LiquidatableRequest = exports.LegalCheckRequest = exports.LeadingVaultsRequest = exports.L2BookRequest = exports.IsVipRequest = exports.HistoricalOrdersRequest = exports.FundingHistoryRequest = exports.FrontendOpenOrdersRequest = exports.ExtraAgentsRequest = exports.ExchangeStatusRequest = exports.DelegatorSummaryRequest = exports.DelegatorRewardsRequest = exports.DelegatorHistoryRequest = exports.DelegationsRequest = exports.ClearinghouseStateRequest = exports.CandleSnapshotRequest = exports.AllMidsRequest = exports.ActiveAssetDataRequest = void 0;
+exports.PerpDexLimitsRequest = exports.RecentTradesRequest = exports.GossipRootIpsRequest = exports.VaultSummariesRequest = exports.VaultDetailsRequest = exports.ValidatorSummariesRequest = exports.ValidatorL1VotesRequest = exports.UserVaultEquitiesRequest = void 0;
+const v = __importStar(require("valibot"));
+const _base_js_1 = require("../_base.js");
+/**
+ * Request user active asset data.
+ * @returns {ActiveAssetData}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+ */
+exports.ActiveAssetDataRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("activeAssetData"), v.description("Type of request.")),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user active asset data."));
+/**
+ * Request mid coin prices.
+ * @returns {AllMids}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ */
+exports.AllMidsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("allMids"), v.description("Type of request.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request mid coin prices."));
+/**
+ * Request candlestick snapshots.
+ * @returns {Candle[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+ */
+exports.CandleSnapshotRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("candleSnapshot"), v.description("Type of request.")),
+    /** Request parameters. */
+    req: v.pipe(v.object({
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+        /** Time interval. */
+        interval: v.pipe(v.union([
+            v.literal("1m"),
+            v.literal("3m"),
+            v.literal("5m"),
+            v.literal("15m"),
+            v.literal("30m"),
+            v.literal("1h"),
+            v.literal("2h"),
+            v.literal("4h"),
+            v.literal("8h"),
+            v.literal("12h"),
+            v.literal("1d"),
+            v.literal("3d"),
+            v.literal("1w"),
+            v.literal("1M"),
+        ]), v.description("Time interval.")),
+        /** Start time (in ms since epoch). */
+        startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+        /** End time (in ms since epoch). */
+        endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+    }), v.description("Request parameters.")),
+}), v.description("Request candlestick snapshots."));
+/**
+ * Request clearinghouse state.
+ * @returns {PerpsClearinghouseState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+exports.ClearinghouseStateRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("clearinghouseState"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request clearinghouse state."));
+/**
+ * Request user staking delegations.
+ * @returns {Delegation[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
+ */
+exports.DelegationsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("delegations"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user staking delegations."));
+/**
+ * Request user staking history.
+ * @returns {DelegatorUpdate[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
+ */
+exports.DelegatorHistoryRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("delegatorHistory"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user staking history."));
+/**
+ * Request user staking rewards.
+ * @returns {DelegatorReward[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
+ */
+exports.DelegatorRewardsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("delegatorRewards"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user staking rewards."));
+/**
+ * Request user staking summary.
+ * @returns {DelegatorSummary}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
+ */
+exports.DelegatorSummaryRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("delegatorSummary"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user staking summary."));
+/**
+ * Request exchange status information.
+ * @returns {ExchangeStatus}
+ * @see null
+ */
+exports.ExchangeStatusRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("exchangeStatus"), v.description("Type of request.")),
+}), v.description("Request exchange status information."));
+/**
+ * Request user extra agents.
+ * @returns {ExtraAgent[]}
+ * @see null
+ */
+exports.ExtraAgentsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("extraAgents"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user extra agents."));
+/**
+ * Request frontend open orders.
+ * @returns {FrontendOrder[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
+ */
+exports.FrontendOpenOrdersRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("frontendOpenOrders"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request frontend open orders."));
+/**
+ * Request funding history.
+ * @returns {FundingHistory[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
+ */
+exports.FundingHistoryRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("fundingHistory"), v.description("Type of request.")),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+    /** Start time (in ms since epoch). */
+    startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+    /** End time (in ms since epoch). */
+    endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+}), v.description("Request funding history."));
+/**
+ * Request user historical orders.
+ * @returns {FrontendOrderStatus[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
+ */
+exports.HistoricalOrdersRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("historicalOrders"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user historical orders."));
+/**
+ * Request to check if a user is a VIP.
+ * @returns {boolean | null}
+ * @see null
+ */
+exports.IsVipRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("isVip"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request to check if a user is a VIP."));
+/**
+ * Request L2 order book.
+ * @returns {Book}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+ */
+exports.L2BookRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("l2Book"), v.description("Type of request.")),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+    /** Number of significant figures. */
+    nSigFigs: v.pipe(v.nullish(v.union([v.literal(2), v.literal(3), v.literal(4), v.literal(5)])), v.description("Number of significant figures.")),
+    /** Mantissa for aggregation (if `nSigFigs` is 5). */
+    mantissa: v.pipe(v.nullish(v.union([v.literal(2), v.literal(5)])), v.description("Mantissa for aggregation (if `nSigFigs` is 5).")),
+}), v.description("Request L2 order book."));
+/**
+ * Request leading vaults for a user.
+ * @returns {VaultLeading[]}
+ * @see null
+ */
+exports.LeadingVaultsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("leadingVaults"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request leading vaults for a user."));
+/**
+ * Request legal verification status of a user.
+ * @returns {LegalCheck}
+ * @see null
+ */
+exports.LegalCheckRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("legalCheck"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request legal verification status of a user."));
+/**
+ * Request liquidatable.
+ * @returns {unknown[]} FIXME: Define the return type
+ * @see null
+ */
+exports.LiquidatableRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("liquidatable"), v.description("Type of request.")),
+}), v.description("Request liquidatable."));
+/**
+ * Request margin table data.
+ * @returns {MarginTable}
+ * @see null
+ */
+exports.MarginTableRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("marginTable"), v.description("Type of request.")),
+    /** Margin requirements table. */
+    id: v.pipe(_base_js_1.UnsignedInteger, v.description("Margin requirements table.")),
+}), v.description("Request margin table data."));
+/**
+ * Request builder fee approval.
+ * @returns {number}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
+ */
+exports.MaxBuilderFeeRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("maxBuilderFee"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Builder address. */
+    builder: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Builder address.")),
+}), v.description("Request builder fee approval."));
+/**
+ * Request maximum market order notionals.
+ * @returns {[number, string][]}
+ * @see null
+ */
+exports.MaxMarketOrderNtlsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("maxMarketOrderNtls"), v.description("Type of request.")),
+}), v.description("Request maximum market order notionals."));
+/**
+ * Request trading metadata.
+ * @returns {PerpsMeta}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
+ */
+exports.MetaRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("meta"), v.description("Type of request.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request trading metadata."));
+/**
+ * Request metadata and asset contexts.
+ * @returns {PerpsMetaAndAssetCtxs}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
+ */
+exports.MetaAndAssetCtxsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("metaAndAssetCtxs"), v.description("Type of request.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request metadata and asset contexts."));
+/**
+ * Request open orders.
+ * @returns {Order[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
+ */
+exports.OpenOrdersRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("openOrders"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request open orders."));
+/**
+ * Request order status.
+ * @returns {OrderLookup}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+ */
+exports.OrderStatusRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("orderStatus"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Order ID or Client Order ID. */
+    oid: v.pipe(v.union([_base_js_1.UnsignedInteger, v.pipe(_base_js_1.Hex, v.length(34))]), v.description("Order ID or Client Order ID.")),
+}), v.description("Request order status."));
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @returns {DeployAuctionStatus}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+exports.PerpDeployAuctionStatusRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("perpDeployAuctionStatus"), v.description("Type of request.")),
+}), v.description("Request for the status of the perpetual deploy auction."));
+/**
+ * Request all perpetual dexs.
+ * @returns {PerpDexs}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+exports.PerpDexsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("perpDexs"), v.description("Type of request.")),
+}), v.description("Request all perpetual dexs."));
+/**
+ * Request perpetuals at open interest cap.
+ * @returns {string[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ */
+exports.PerpsAtOpenInterestCapRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("perpsAtOpenInterestCap"), v.description("Type of request.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request perpetuals at open interest cap."));
+/**
+ * Request user portfolio.
+ * @returns {PortfolioPeriods}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+exports.PortfolioRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("portfolio"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user portfolio."));
+/**
+ * Request predicted funding rates.
+ * @returns {PredictedFunding[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+ */
+exports.PredictedFundingsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("predictedFundings"), v.description("Type of request.")),
+}), v.description("Request predicted funding rates."));
+/**
+ * Request user existence check before transfer.
+ * @returns {PreTransferCheck}
+ * @see null
+ */
+exports.PreTransferCheckRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("preTransferCheck"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Source address. */
+    source: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Source address.")),
+}), v.description("Request user existence check before transfer."));
+/**
+ * Request user referral.
+ * @returns {Referral}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+ */
+exports.ReferralRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("referral"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user referral."));
+/**
+ * Request spot clearinghouse state.
+ * @returns {SpotClearinghouseState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+exports.SpotClearinghouseStateRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("spotClearinghouseState"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request spot clearinghouse state."));
+/**
+ * Request spot deploy state.
+ * @returns {SpotDeployState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ */
+exports.SpotDeployStateRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("spotDeployState"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request spot deploy state."));
+/**
+ * Request spot trading metadata.
+ * @returns {SpotMeta}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ */
+exports.SpotMetaRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("spotMeta"), v.description("Type of request.")),
+}), v.description("Request spot trading metadata."));
+/**
+ * Request spot metadata and asset contexts.
+ * @returns {SpotMetaAndAssetCtxs}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
+ */
+exports.SpotMetaAndAssetCtxsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("spotMetaAndAssetCtxs"), v.description("Type of request.")),
+}), v.description("Request spot metadata and asset contexts."));
+/**
+ * Request for the status of the spot deploy auction.
+ * @returns {DeployAuctionStatus}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
+ */
+exports.SpotPairDeployAuctionStatusRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("spotPairDeployAuctionStatus"), v.description("Type of request.")),
+}), v.description("Request for the status of the spot deploy auction."));
+/**
+ * Request user sub-accounts.
+ * @returns {SubAccount[] | null}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+ */
+exports.SubAccountsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("subAccounts"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user sub-accounts."));
+/**
+ * Request token details.
+ * @returns {TokenDetails}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+exports.TokenDetailsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("tokenDetails"), v.description("Type of request.")),
+    /** Token ID. */
+    tokenId: v.pipe(v.pipe(_base_js_1.Hex, v.length(34)), v.description("Token ID.")),
+}), v.description("Request token details."));
+/**
+ * Request twap history of a user.
+ * @returns {TwapHistory[]}
+ * @see null
+ */
+exports.TwapHistoryRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("twapHistory"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request twap history of a user."));
+/**
+ * Request user fees.
+ * @returns {UserFees}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+ */
+exports.UserFeesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userFees"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user fees."));
+/**
+ * Request user fills.
+ * @returns {Fill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
+ */
+exports.UserFillsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userFills"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
+}), v.description("Request user fills."));
+/**
+ * Request user fills by time.
+ * @returns {Fill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
+ */
+exports.UserFillsByTimeRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userFillsByTime"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Start time (in ms since epoch). */
+    startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+    /** End time (in ms since epoch). */
+    endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
+}), v.description("Request user fills by time."));
+/**
+ * Request user funding.
+ * @returns {UserFundingUpdate[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ */
+exports.UserFundingRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userFunding"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Start time (in ms since epoch). */
+    startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+    /** End time (in ms since epoch). */
+    endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+}), v.description("Request user funding."));
+/**
+ * Request user non-funding ledger updates.
+ * @returns {UserNonFundingLedgerUpdate[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ */
+exports.UserNonFundingLedgerUpdatesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userNonFundingLedgerUpdates"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Start time (in ms since epoch). */
+    startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+    /** End time (in ms since epoch). */
+    endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+}), v.description("Request user non-funding ledger updates."));
+/**
+ * Request user rate limits.
+ * @returns {UserRateLimit}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+exports.UserRateLimitRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userRateLimit"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user rate limits."));
+/**
+ * Request user role.
+ * @returns {UserRole}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+exports.UserRoleRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userRole"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user role."));
+/**
+ * Request multi-sig signers for a user.
+ * @returns {MultiSigSigners | null}
+ * @see null
+ */
+exports.UserToMultiSigSignersRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userToMultiSigSigners"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request multi-sig signers for a user."));
+/**
+ * Request user TWAP slice fills.
+ * @returns {TwapSliceFill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
+ */
+exports.UserTwapSliceFillsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userTwapSliceFills"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user TWAP slice fills."));
+/**
+ * Request user TWAP slice fills by time.
+ * @returns {TwapSliceFill[]}
+ * @see null
+ */
+exports.UserTwapSliceFillsByTimeRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userTwapSliceFillsByTime"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Start time (in ms since epoch). */
+    startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
+    /** End time (in ms since epoch). */
+    endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
+}), v.description("Request user TWAP slice fills by time."));
+/**
+ * Request user vault deposits.
+ * @returns {VaultEquity[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
+ */
+exports.UserVaultEquitiesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("userVaultEquities"), v.description("Type of request.")),
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+}), v.description("Request user vault deposits."));
+/**
+ * Request validator L1 votes.
+ * @returns {unknown[]} FIXME: Define the return type
+ * @see null
+ */
+exports.ValidatorL1VotesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("validatorL1Votes"), v.description("Type of request.")),
+}), v.description("Request validator L1 votes."));
+/**
+ * Request validator summaries.
+ * @returns {ValidatorSummary[]}
+ * @see null
+ */
+exports.ValidatorSummariesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("validatorSummaries"), v.description("Type of request.")),
+}), v.description("Request validator summaries."));
+/**
+ * Request details of a vault.
+ * @returns {VaultDetails | null}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+ */
+exports.VaultDetailsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("vaultDetails"), v.description("Type of request.")),
+    /** Vault address. */
+    vaultAddress: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Vault address.")),
+    /** User address. */
+    user: v.pipe(v.nullish(v.pipe(_base_js_1.Hex, v.length(42))), v.description("User address.")),
+}), v.description("Request details of a vault."));
+/**
+ * Request a list of vaults less than 2 hours old.
+ * @returns {VaultSummary[]}
+ * @see null
+ */
+exports.VaultSummariesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("vaultSummaries"), v.description("Type of request.")),
+}), v.description("Request a list of vaults less than 2 hours old."));
+/**
+ * Request gossip root IPs.
+ * @returns {GossipRootIps[]}
+ * @see null
+ */
+exports.GossipRootIpsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("gossipRootIps"), v.description("Type of request.")),
+}), v.description("Request gossip root IPs."));
+/**
+ * Request recent trades.
+ * @returns {Trade[]}
+ * @see null
+ */
+exports.RecentTradesRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("recentTrades"), v.description("Type of request.")),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+}), v.description("Request recent trades."));
+/**
+ * Request builder deployed perpetual market limits.
+ * @returns {PerpDexLimits}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+exports.PerpDexLimitsRequest = v.pipe(v.object({
+    /** Type of request. */
+    type: v.pipe(v.literal("perpDexLimits"), v.description("Type of request.")),
+    /** DEX name (empty string for main dex). */
+    dex: v.pipe(v.string(), v.description("DEX name (empty string for main dex).")),
+}), v.description("Request perpetual DEX limits."));
+//# sourceMappingURL=requests.js.map