@nktkas/hyperliquid 0.23.1 → 0.24.1

package/script/src/types/info/requests.d.ts

@@ -1,24 +1,39 @@
-import type { Hex } from "../../base.js";
+import type { Hex } from "../mod.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
+ */
+export interface ActiveAssetDataRequest {
+    /** Type of request. */
+    type: "activeAssetData";
+    /** Asset symbol (e.g., BTC). */
+    coin: string;
+    /** User address. */
+    user: Hex;
+}
 /**
  * Request mid coin prices.
  * @returns {AllMids}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
  */
 export interface AllMidsRequest {
     /** Type of request. */
     type: "allMids";
-    /** Name of perp dex. */
+    /** DEX name (empty string for main dex). */
     dex?: string;
 }
 /**
  * Request candlestick snapshots.
  * @returns {Candle[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
  */
 export interface CandleSnapshotRequest {
     /** Type of request. */
     type: "candleSnapshot";
     /** Request parameters. */
     req: {
-        /** Asset symbol. */
+        /** Asset symbol (e.g., BTC). */
         coin: string;
         /** Time interval. */
         interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
@@ -31,91 +46,100 @@ export interface CandleSnapshotRequest {
 /**
  * Request clearinghouse state.
  * @returns {PerpsClearinghouseState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
  */
 export interface ClearinghouseStateRequest {
     /** Type of request. */
     type: "clearinghouseState";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user staking delegations.
  * @returns {Delegation[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
  */
 export interface DelegationsRequest {
     /** Type of request. */
     type: "delegations";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user staking history.
  * @returns {DelegatorUpdate[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
  */
 export interface DelegatorHistoryRequest {
     /** Type of request. */
     type: "delegatorHistory";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user staking rewards.
  * @returns {DelegatorReward[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
  */
 export interface DelegatorRewardsRequest {
     /** Type of request. */
     type: "delegatorRewards";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user staking summary.
  * @returns {DelegatorSummary}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
  */
 export interface DelegatorSummaryRequest {
     /** Type of request. */
     type: "delegatorSummary";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request exchange status information.
  * @returns {ExchangeStatus}
+ * @see null
  */
 export interface ExchangeStatusRequest {
     /** Type of request. */
     type: "exchangeStatus";
 }
 /**
- * Request user's extra agents.
+ * Request user extra agents.
  * @returns {ExtraAgent[]}
+ * @see null
  */
 export interface ExtraAgentsRequest {
     /** Type of request. */
     type: "extraAgents";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * 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
  */
 export interface FrontendOpenOrdersRequest {
     /** Type of request. */
     type: "frontendOpenOrders";
-    /** User's address. */
+    /** User address. */
     user: Hex;
-    /** Name of perp dex. */
+    /** DEX name (empty string for main dex). */
     dex?: string;
 }
 /**
  * Request funding history.
  * @returns {FundingHistory[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
  */
 export interface FundingHistoryRequest {
     /** Type of request. */
     type: "fundingHistory";
-    /** Asset symbol. */
+    /** Asset symbol (e.g., BTC). */
     coin: string;
     /** Start time (in ms since epoch). */
     startTime: number;
@@ -123,33 +147,36 @@ export interface FundingHistoryRequest {
     endTime?: number | null;
 }
 /**
- * Request user's historical orders.
+ * Request user historical orders.
  * @returns {OrderStatus<FrontendOrder>[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
  */
 export interface HistoricalOrdersRequest {
     /** Type of request. */
     type: "historicalOrders";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request to check if a user is a VIP.
- * @returns {boolean}
+ * @returns {boolean | null}
+ * @see null
  */
 export interface IsVipRequest {
     /** Type of request. */
     type: "isVip";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request L2 order book.
  * @returns {Book}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
  */
 export interface L2BookRequest {
     /** Type of request. */
     type: "l2Book";
-    /** Asset symbol. */
+    /** Asset symbol (e.g., BTC). */
     coin: string;
     /** Number of significant figures. */
     nSigFigs?: 2 | 3 | 4 | 5 | null;
@@ -159,26 +186,29 @@ export interface L2BookRequest {
 /**
  * Request leading vaults for a user.
  * @returns {VaultLeading[]}
+ * @see null
  */
 export interface LeadingVaultsRequest {
     /** Type of request. */
     type: "leadingVaults";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request legal verification status of a user.
  * @returns {LegalCheck}
+ * @see null
  */
 export interface LegalCheckRequest {
     /** Type of request. */
     type: "legalCheck";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
- * Request liquidatable (unknown).
- * @returns {unknown[]}
+ * Request liquidatable.
+ * @returns {unknown[]} FIXME: Define the return type
+ * @see null
  */
 export interface LiquidatableRequest {
     /** Type of request. */
@@ -187,21 +217,23 @@ export interface LiquidatableRequest {
 /**
  * Request margin table data.
  * @returns {MarginTable}
+ * @see null
  */
 export interface MarginTableRequest {
     /** Type of request. */
     type: "marginTable";
-    /** Unique identifier for the margin requirements table. */
+    /** Margin requirements table. */
     id: number;
 }
 /**
  * Request builder fee approval.
  * @returns {number}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
  */
 export interface MaxBuilderFeeRequest {
     /** Type of request. */
     type: "maxBuilderFee";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** Builder address. */
     builder: Hex;
@@ -209,6 +241,7 @@ export interface MaxBuilderFeeRequest {
 /**
  * Request maximum market order notionals.
  * @returns {[number, string][]}
+ * @see null
  */
 export interface MaxMarketOrderNtlsRequest {
     /** Type of request. */
@@ -217,16 +250,18 @@ export interface MaxMarketOrderNtlsRequest {
 /**
  * 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
  */
 export interface MetaRequest {
     /** Type of request. */
     type: "meta";
-    /** Name of perp dex. */
+    /** DEX name (empty string for main dex). */
     dex?: string;
 }
 /**
  * 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
  */
 export interface MetaAndAssetCtxsRequest {
     /** Type of request. */
@@ -235,30 +270,33 @@ export interface MetaAndAssetCtxsRequest {
 /**
  * Request open orders.
  * @returns {Order[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
  */
 export interface OpenOrdersRequest {
     /** Type of request. */
     type: "openOrders";
-    /** User's address. */
+    /** User address. */
     user: Hex;
-    /** Name of perp dex. */
+    /** DEX name (empty string for main dex). */
     dex?: string;
 }
 /**
  * Request order status.
  * @returns {OrderLookup}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
  */
 export interface OrderStatusRequest {
     /** Type of request. */
     type: "orderStatus";
-    /** User's address. */
+    /** User address. */
     user: Hex;
-    /** Order ID or client order ID. */
+    /** Order ID or Client Order ID. */
     oid: number | Hex;
 }
 /**
  * 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
  */
 export interface PerpDeployAuctionStatusRequest {
     /** Type of request. */
@@ -267,6 +305,7 @@ export interface PerpDeployAuctionStatusRequest {
 /**
  * Request all perpetual dexs.
  * @returns {PerpDexs}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
  */
 export interface PerpDexsRequest {
     /** Type of request. */
@@ -275,6 +314,7 @@ export interface PerpDexsRequest {
 /**
  * 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
  */
 export interface PerpsAtOpenInterestCapRequest {
     /** Type of request. */
@@ -283,29 +323,32 @@ export interface PerpsAtOpenInterestCapRequest {
 /**
  * Request user portfolio.
  * @returns {PortfolioPeriods}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
  */
 export interface PortfolioRequest {
     /** Type of request. */
     type: "portfolio";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * 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
  */
 export interface PredictedFundingsRequest {
     /** Type of request. */
     type: "predictedFundings";
 }
 /**
- * Request user's existence check before transfer.
+ * Request user existence check before transfer.
  * @returns {PreTransferCheck}
+ * @see null
  */
 export interface PreTransferCheckRequest {
     /** Type of request. */
     type: "preTransferCheck";
-    /** Destination address. */
+    /** User address. */
     user: Hex;
     /** Source address. */
     source: Hex;
@@ -313,46 +356,60 @@ export interface PreTransferCheckRequest {
 /**
  * Request user referral.
  * @returns {Referral}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
  */
 export interface ReferralRequest {
     /** Type of request. */
     type: "referral";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request spot clearinghouse state.
  * @returns {SpotClearinghouseState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
  */
 export interface SpotClearinghouseStateRequest {
     /** Type of request. */
     type: "spotClearinghouseState";
-    /** User's address. */
+    /** User address. */
     user: Hex;
-    /** Name of perp dex. */
+    /** DEX name (empty string for main dex). */
     dex?: string;
 }
 /**
  * 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
  */
 export interface SpotDeployStateRequest {
     /** Type of request. */
     type: "spotDeployState";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request spot trading metadata.
  * @returns {SpotMeta}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
  */
 export interface SpotMetaRequest {
     /** Type of request. */
     type: "spotMeta";
 }
+/**
+ * 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
+ */
+export interface SpotPairDeployAuctionStatusRequest {
+    /** Type of request. */
+    type: "spotPairDeployAuctionStatus";
+}
 /**
  * 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
  */
 export interface SpotMetaAndAssetCtxsRequest {
     /** Type of request. */
@@ -361,16 +418,18 @@ export interface SpotMetaAndAssetCtxsRequest {
 /**
  * Request user sub-accounts.
  * @returns {SubAccount[] | null}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
  */
 export interface SubAccountsRequest {
     /** Type of request. */
     type: "subAccounts";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request token details.
  * @returns {TokenDetails}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
  */
 export interface TokenDetailsRequest {
     /** Type of request. */
@@ -381,31 +440,34 @@ export interface TokenDetailsRequest {
 /**
  * Request twap history of a user.
  * @returns {TwapHistory[]}
+ * @see null
  */
 export interface TwapHistoryRequest {
     /** Type of request. */
     type: "twapHistory";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user fees.
  * @returns {UserFees}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
  */
 export interface UserFeesRequest {
     /** Type of request. */
     type: "userFees";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user fills.
  * @returns {Fill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
  */
 export interface UserFillsRequest {
     /** Type of request. */
     type: "userFills";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
     aggregateByTime?: boolean;
@@ -413,11 +475,12 @@ export interface UserFillsRequest {
 /**
  * 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
  */
 export interface UserFillsByTimeRequest {
     /** Type of request. */
     type: "userFillsByTime";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** Start time (in ms since epoch). */
     startTime: number;
@@ -429,11 +492,12 @@ export interface UserFillsByTimeRequest {
 /**
  * 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
  */
 export interface UserFundingRequest {
     /** Type of request. */
     type: "userFunding";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** Start time (in ms since epoch). */
     startTime: number;
@@ -443,11 +507,12 @@ export interface UserFundingRequest {
 /**
  * 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
  */
 export interface UserNonFundingLedgerUpdatesRequest {
     /** Type of request. */
     type: "userNonFundingLedgerUpdates";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** Start time (in ms since epoch). */
     startTime: number;
@@ -457,51 +522,56 @@ export interface UserNonFundingLedgerUpdatesRequest {
 /**
  * Request user rate limits.
  * @returns {UserRateLimit}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
  */
 export interface UserRateLimitRequest {
     /** Type of request. */
     type: "userRateLimit";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user role.
  * @returns {UserRole}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
  */
 export interface UserRoleRequest {
     /** Type of request. */
     type: "userRole";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request multi-sig signers for a user.
  * @returns {MultiSigSigners | null}
+ * @see null
  */
 export interface UserToMultiSigSignersRequest {
     /** Type of request. */
     type: "userToMultiSigSigners";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * 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
  */
 export interface UserTwapSliceFillsRequest {
     /** Type of request. */
     type: "userTwapSliceFills";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request user TWAP slice fills by time.
  * @returns {TwapSliceFill[]}
+ * @see null
  */
 export interface UserTwapSliceFillsByTimeRequest {
     /** Type of request. */
     type: "userTwapSliceFillsByTime";
-    /** User's address. */
+    /** User address. */
     user: Hex;
     /** Start time (in ms since epoch). */
     startTime: number;
@@ -513,16 +583,18 @@ export interface UserTwapSliceFillsByTimeRequest {
 /**
  * Request user vault deposits.
  * @returns {VaultEquity[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
  */
 export interface UserVaultEquitiesRequest {
     /** Type of request. */
     type: "userVaultEquities";
-    /** User's address. */
+    /** User address. */
     user: Hex;
 }
 /**
  * Request validator L1 votes.
- * @returns {unknown[]}
+ * @returns {unknown[]} FIXME: Define the return type
+ * @see null
  */
 export interface ValidatorL1VotesRequest {
     /** Type of request. */
@@ -531,6 +603,7 @@ export interface ValidatorL1VotesRequest {
 /**
  * Request validator summaries.
  * @returns {ValidatorSummary[]}
+ * @see null
  */
 export interface ValidatorSummariesRequest {
     /** Type of request. */
@@ -539,18 +612,20 @@ export interface ValidatorSummariesRequest {
 /**
  * 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
  */
 export interface VaultDetailsRequest {
     /** Type of request. */
     type: "vaultDetails";
     /** Vault address. */
     vaultAddress: Hex;
-    /** User's address. */
+    /** User address. */
     user?: Hex | null;
 }
 /**
  * Request a list of vaults less than 2 hours old.
  * @returns {VaultSummary[]}
+ * @see null
  */
 export interface VaultSummariesRequest {
     /** Type of request. */