@nktkas/hyperliquid 0.13.0 → 0.13.1

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

@@ -0,0 +1,380 @@
+import type { Hex } from "../common.js";
+/**
+ * Request mid coin prices.
+ * @returns {AllMids} Mid coin prices.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins | Hyperliquid GitBook}
+ */
+export interface AllMidsRequest {
+    /** Type of request. */
+    type: "allMids";
+}
+/**
+ * Request candlestick snapshots.
+ * @returns {Candle[]} Array of candlestick data points.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot | Hyperliquid GitBook}
+ */
+export interface CandleSnapshotRequest {
+    /** Type of request. */
+    type: "candleSnapshot";
+    /** Request parameters. */
+    req: {
+        /** Asset symbol. */
+        coin: string;
+        /** Time interval (e.g., "15m"). */
+        interval: string;
+        /** Start time (in ms since epoch). */
+        startTime: number;
+        /** End time (in ms since epoch). */
+        endTime?: number | null;
+    };
+}
+/**
+ * Request clearinghouse state.
+ * @returns {PerpsClearinghouseState} Account summary for perpetual trading.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary | Hyperliquid GitBook}
+ */
+export interface ClearinghouseStateRequest {
+    /** Type of request. */
+    type: "clearinghouseState";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user's extra agents.
+ * @returns {ExtraAgent[]} The extra agents of a user.
+ */
+export interface ExtraAgentsRequest {
+    /** Type of request. */
+    type: "extraAgents";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request frontend open orders.
+ * @returns {FrontendOrder[]} Array of open orders with additional frontend information.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info | Hyperliquid GitBook}
+ */
+export interface FrontendOpenOrdersRequest {
+    /** Type of request. */
+    type: "frontendOpenOrders";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request funding history.
+ * @returns {FundingHistory[]} Array of historical funding rate data for an asset.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates | Hyperliquid GitBook}
+ */
+export interface FundingHistoryRequest {
+    /** Type of request. */
+    type: "fundingHistory";
+    /** Asset symbol. */
+    coin: string;
+    /** Start time (in ms since epoch). */
+    startTime: number;
+    /** End time (in ms since epoch). */
+    endTime?: number | null;
+}
+/**
+ * Request user historical orders.
+ * @returns {OrderStatus[]} Array of user's historical orders.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders | Hyperliquid GitBook}
+ */
+export interface HistoricalOrdersRequest {
+    /** Type of request. */
+    type: "historicalOrders";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request L2 order book ({@link L2Book}).
+ * @returns {Book} L2 order book snapshot.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot | Hyperliquid GitBook}
+ */
+export interface L2BookRequest {
+    /** Type of request. */
+    type: "l2Book";
+    /** Asset symbol. */
+    coin: string;
+    /** Number of significant figures. */
+    nSigFigs?: 2 | 3 | 4 | 5 | null;
+    /** Mantissa for aggregation (if {@linkcode nSigFigs} is 5). */
+    mantissa?: 2 | 5 | null;
+}
+/**
+ * Request builder fee approval.
+ * @returns {number} 1 (means 0.001%)
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval | Hyperliquid GitBook}
+ */
+export interface MaxBuilderFeeRequest {
+    /** Type of request. */
+    type: "maxBuilderFee";
+    /** User's address. */
+    user: Hex;
+    /** Builder address. */
+    builder: Hex;
+}
+/**
+ * Request metadata and asset contexts.
+ * @returns {PerpsMetaAndAssetCtxs} Metadata and context information for each perpetual asset.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc | Hyperliquid GitBook}
+ */
+export interface MetaAndAssetCtxsRequest {
+    /** Type of request. */
+    type: "metaAndAssetCtxs";
+}
+/**
+ * Request trading metadata.
+ * @returns {PerpsMeta} Metadata for perpetual assets.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata | Hyperliquid GitBook}
+ */
+export interface MetaRequest {
+    /** Type of request. */
+    type: "meta";
+}
+/**
+ * Request open orders.
+ * @returns {Order[]} Array of open order.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders | Hyperliquid GitBook}
+ */
+export interface OpenOrdersRequest {
+    /** Type of request. */
+    type: "openOrders";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request order status.
+ * @returns {OrderLookup} Result of an order status lookup.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid | Hyperliquid GitBook}
+ */
+export interface OrderStatusRequest {
+    /** Type of request. */
+    type: "orderStatus";
+    /** User's address. */
+    user: Hex;
+    /** oid (order id) or cloid (client order id). */
+    oid: number | Hex;
+}
+/**
+ * Request predicted funding rates.
+ * @returns {PredictedFunding[]} Array of predicted funding rates.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues | Hyperliquid GitBook}
+ */
+export interface PredictedFundingsRequest {
+    /** Type of request. */
+    type: "predictedFundings";
+}
+/**
+ * Request user referral.
+ * @returns {Referral} Referral information for a user.
+ */
+export interface ReferralRequest {
+    /** Type of request. */
+    type: "referral";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request spot clearinghouse state.
+ * @returns {SpotClearinghouseState} Balances for spot tokens.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances | Hyperliquid GitBook}
+ */
+export interface SpotClearinghouseStateRequest {
+    /** Type of request. */
+    type: "spotClearinghouseState";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request spot deploy state.
+ * @returns {SpotDeployState} The deploy state of a user.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction | Hyperliquid GitBook}
+ */
+export interface SpotDeployStateRequest {
+    /** Type of request. */
+    type: "spotDeployState";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request spot metadata and asset contexts.
+ * @returns {SpotMetaAndAssetCtxs} Metadata and context information for each spot asset.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts | Hyperliquid GitBook}
+ */
+export interface SpotMetaAndAssetCtxsRequest {
+    /** Type of request. */
+    type: "spotMetaAndAssetCtxs";
+}
+/**
+ * Request spot trading metadata.
+ * @returns {SpotMeta} Metadata for spot assets.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata | Hyperliquid GitBook}
+ */
+export interface SpotMetaRequest {
+    /** Type of request. */
+    type: "spotMeta";
+}
+/**
+ * Request user sub-accounts.
+ * @returns {SubAccount[]} Array of user sub-account.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts | Hyperliquid GitBook}
+ */
+export interface SubAccountsRequest {
+    /** Type of request. */
+    type: "subAccounts";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * The request to get the details of a token.
+ * @returns {TokenDetails} The details of a token.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token | Hyperliquid GitBook}
+ */
+export interface TokenDetailsRequest {
+    /** Type of request. */
+    type: "tokenDetails";
+    /** Token ID. */
+    tokenId: Hex;
+}
+/**
+ * Request twap history.
+ * @returns {TwapHistory[]} The twap history of a user.
+ */
+export interface TwapHistoryRequest {
+    /** Type of request. */
+    type: "twapHistory";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user fees.
+ * @returns {UserFees} User fees.
+ */
+export interface UserFeesRequest {
+    /** Type of request. */
+    type: "userFees";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user fills by time.
+ * @returns {Fill[]} Array of user's trade fill.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time | Hyperliquid GitBook}
+ */
+export interface UserFillsByTimeRequest {
+    /** Type of request. */
+    type: "userFillsByTime";
+    /** User's address. */
+    user: Hex;
+    /** Start time (in ms since epoch). */
+    startTime: number;
+    /** End time (in ms since epoch). */
+    endTime?: number | null;
+    /**
+     * When `true`, partial fills are combined when a crossing order gets filled by multiple different resting orders.
+     * Resting orders filled by multiple crossing orders will not be aggregated.
+     */
+    aggregateByTime?: boolean;
+}
+/**
+ * Request user fills.
+ * @returns {Fill[]} Array of user's trade fill.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills | Hyperliquid GitBook}
+ */
+export interface UserFillsRequest {
+    /** Type of request. */
+    type: "userFills";
+    /** User's address. */
+    user: Hex;
+    /**
+     * When `true`, partial fills are combined when a crossing order gets filled by multiple different resting orders.
+     * Resting orders filled by multiple crossing orders will not be aggregated.
+     */
+    aggregateByTime?: boolean;
+}
+/**
+ * Request user funding.
+ * @returns {UserFundingUpdate[]} Array of user's funding ledger update.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates | Hyperliquid GitBook}
+ */
+export interface UserFundingRequest {
+    /** Type of request. */
+    type: "userFunding";
+    /** User's address. */
+    user: Hex;
+    /** Start time (in ms since epoch). */
+    startTime: number;
+    /** End time (in ms since epoch). */
+    endTime?: number | null;
+}
+/**
+ * Request user non-funding ledger updates.
+ * @returns {UserNonFundingLedgerUpdates[]} Array of user's non-funding ledger update.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates | Hyperliquid GitBook}
+ */
+export interface UserNonFundingLedgerUpdatesRequest {
+    /** Type of request. */
+    type: "userNonFundingLedgerUpdates";
+    /** User's address. */
+    user: Hex;
+    /** Start time (in ms since epoch). */
+    startTime: number;
+    /** End time (in ms since epoch). */
+    endTime?: number | null;
+}
+/**
+ * Request user rate limits.
+ * @returns {UserRateLimit} User's rate limits.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits | Hyperliquid GitBook}
+ */
+export interface UserRateLimitRequest {
+    /** Type of request. */
+    type: "userRateLimit";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user twap slice fills.
+ * @returns {TwapSliceFill[]} Array of user's twap slice fills.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills | Hyperliquid GitBook}
+ */
+export interface UserTwapSliceFillsRequest {
+    /** Type of request. */
+    type: "userTwapSliceFills";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user vault deposits.
+ * @returns {VaultEquity[]} Array of user's vault deposits.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits | Hyperliquid GitBook}
+ */
+export interface UserVaultEquitiesRequest {
+    /** Type of request. */
+    type: "userVaultEquities";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request details of a vault.
+ * @returns {VaultDetails} Details of a vault.
+ * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault | Hyperliquid GitBook}
+ */
+export interface VaultDetailsRequest {
+    /** Type of request. */
+    type: "vaultDetails";
+    /** Vault address. */
+    vaultAddress: Hex;
+    /** User's address. */
+    user?: Hex | null;
+}
+/**
+ * Request a list of vaults less than 2 hours old.
+ * @returns {VaultSummary[]} Array of vault summaries.
+ */
+export interface VaultSummariesRequest {
+    /** Type of request. */
+    type: "vaultSummaries";
+}
+//# sourceMappingURL=requests.d.ts.map

package/esm/src/types/info/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,uBAAuB;IACvB,IAAI,EAAE,SAAS,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IACvB,0BAA0B;IAC1B,GAAG,EAAE;QACD,oBAAoB;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,mCAAmC;QACnC,QAAQ,EAAE,MAAM,CAAC;QACjB,sCAAsC;QACtC,SAAS,EAAE,MAAM,CAAC;QAClB,oCAAoC;QACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,uBAAuB;IACvB,IAAI,EAAE,oBAAoB,CAAC;IAC3B,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,uBAAuB;IACvB,IAAI,EAAE,oBAAoB,CAAC;IAC3B,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IACvB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;IACzB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,uBAAuB;IACvB,IAAI,EAAE,QAAQ,CAAC;IACf,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,uBAAuB;IACvB,IAAI,EAAE,eAAe,CAAC;IACtB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV,uBAAuB;IACvB,OAAO,EAAE,GAAG,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uBAAuB;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV,iDAAiD;IACjD,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,uBAAuB;IACvB,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C,uBAAuB;IACvB,IAAI,EAAE,wBAAwB,CAAC;IAC/B,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,uBAAuB;IACvB,IAAI,EAAE,iBAAiB,CAAC;IACxB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC,uBAAuB;IACvB,IAAI,EAAE,sBAAsB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,uBAAuB;IACvB,IAAI,EAAE,cAAc,CAAC;IACrB,gBAAgB;IAChB,OAAO,EAAE,GAAG,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,uBAAuB;IACvB,IAAI,EAAE,iBAAiB,CAAC;IACxB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,uBAAuB;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IAC/C,uBAAuB;IACvB,IAAI,EAAE,6BAA6B,CAAC;IACpC,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;IACV,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,uBAAuB;IACvB,IAAI,EAAE,eAAe,CAAC;IACtB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC,uBAAuB;IACvB,IAAI,EAAE,oBAAoB,CAAC;IAC3B,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,uBAAuB;IACvB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,uBAAuB;IACvB,IAAI,EAAE,cAAc,CAAC;IACrB,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,sBAAsB;IACtB,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;CAC1B"}

package/esm/src/types/info/requests.js

@@ -0,0 +1 @@
+export {};

package/esm/src/types/info/vaults.d.ts

@@ -0,0 +1,133 @@
+import type { Hex } from "../common.js";
+/** Details about a vault. */
+export interface VaultDetails {
+    /** The name of the vault. */
+    name: string;
+    /** The address of the vault. */
+    vaultAddress: Hex;
+    /** The address of the leader. */
+    leader: Hex;
+    /** The description of the vault. */
+    description: string;
+    /** The portfolio of the vault. */
+    portfolio: [
+        [
+            "day",
+            VaultMetrics
+        ],
+        [
+            "week",
+            VaultMetrics
+        ],
+        [
+            "month",
+            VaultMetrics
+        ],
+        [
+            "allTime",
+            VaultMetrics
+        ],
+        [
+            "perpDay",
+            VaultMetrics
+        ],
+        [
+            "perpWeek",
+            VaultMetrics
+        ],
+        [
+            "perpMonth",
+            VaultMetrics
+        ],
+        [
+            "perpAllTime",
+            VaultMetrics
+        ]
+    ];
+    /** The annual percentage rate (APR) of the vault. */
+    apr: number;
+    followerState: unknown | null;
+    /** The fraction of the vault owned by the leader. */
+    leaderFraction: number;
+    /** The commission percentage taken by the leader. */
+    leaderCommission: number;
+    /** The followers of the vault. */
+    followers: {
+        /** The address of the follower or "Leader" for the leader. */
+        user: Hex | "Leader";
+        /** The equity of the follower in the vault. */
+        vaultEquity: string;
+        /** The current profit and loss (PnL) of the follower. */
+        pnl: string;
+        /** The all-time profit and loss (PnL) of the follower. */
+        allTimePnl: string;
+        /** The number of days the follower has been subscribed. */
+        daysFollowing: number;
+        /** The timestamp when the follower joined the vault. */
+        vaultEntryTime: number;
+        /** The timestamp until which the funds are locked. */
+        lockupUntil: number;
+    }[];
+    /** The maximum amount that can be distributed from the vault. */
+    maxDistributable: number;
+    /** The maximum amount that can be withdrawn from the vault. */
+    maxWithdrawable: number;
+    /** Indicates if the vault is closed. */
+    isClosed: boolean;
+    /** The type of relationship between vaults. */
+    relationship: VaultRelationship;
+    /** Indicates whether deposits are allowed. */
+    allowDeposits: boolean;
+    /** Indicates whether to always close positions on withdrawal. */
+    alwaysCloseOnWithdraw: boolean;
+}
+/** The equity of a user in a vault. */
+export interface VaultEquity {
+    /** The address of the vault. */
+    vaultAddress: Hex;
+    /** The user's deposited equity in the vault. */
+    equity: string;
+}
+/** Metrics data for a vault */
+export interface VaultMetrics {
+    /** The account value history as [timestamp, value]. */
+    accountValueHistory: [number, string][];
+    /** The profit and loss (PnL) history as [timestamp, value]. */
+    pnlHistory: [number, string][];
+    /** The volume or related metric of the portfolio. */
+    vlm: string;
+}
+/** The type of relationship between vaults. */
+export type VaultRelationship = {
+    /** The type of relationship. */
+    type: "normal";
+} | {
+    /** The type of relationship. */
+    type: "parent";
+    /** Data about child vault addresses. */
+    data: {
+        /** List of child vault addresses. */
+        childAddresses: Hex[];
+    };
+} | {
+    /** The type of relationship. */
+    type: "child";
+};
+/** Summary of a vault. */
+export interface VaultSummary {
+    /** The name of the vault. */
+    name: string;
+    /** The address of the vault. */
+    vaultAddress: Hex;
+    /** The address of the leader. */
+    leader: Hex;
+    /** The total value locked (TVL) in the vault. */
+    tvl: string;
+    /** Indicates if the vault is closed. */
+    isClosed: boolean;
+    /** The type of relationship between vaults. */
+    relationship: VaultRelationship;
+    /** The timestamp when the vault was created. */
+    createTimeMillis: number;
+}
+//# sourceMappingURL=vaults.d.ts.map

package/esm/src/types/info/vaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/vaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IACzB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,YAAY,EAAE,GAAG,CAAC;IAElB,iCAAiC;IACjC,MAAM,EAAE,GAAG,CAAC;IAEZ,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB,kCAAkC;IAClC,SAAS,EAAE;QACP;YAAC,KAAK;YAAE,YAAY;SAAC;QACrB;YAAC,MAAM;YAAE,YAAY;SAAC;QACtB;YAAC,OAAO;YAAE,YAAY;SAAC;QACvB;YAAC,SAAS;YAAE,YAAY;SAAC;QACzB;YAAC,SAAS;YAAE,YAAY;SAAC;QACzB;YAAC,UAAU;YAAE,YAAY;SAAC;QAC1B;YAAC,WAAW;YAAE,YAAY;SAAC;QAC3B;YAAC,aAAa;YAAE,YAAY;SAAC;KAChC,CAAC;IAEF,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IAEZ,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IAEvB,qDAAqD;IACrD,gBAAgB,EAAE,MAAM,CAAC;IAEzB,kCAAkC;IAClC,SAAS,EAAE;QACP,8DAA8D;QAC9D,IAAI,EAAE,GAAG,GAAG,QAAQ,CAAC;QAErB,+CAA+C;QAC/C,WAAW,EAAE,MAAM,CAAC;QAEpB,yDAAyD;QACzD,GAAG,EAAE,MAAM,CAAC;QAEZ,0DAA0D;QAC1D,UAAU,EAAE,MAAM,CAAC;QAEnB,2DAA2D;QAC3D,aAAa,EAAE,MAAM,CAAC;QAEtB,wDAAwD;QACxD,cAAc,EAAE,MAAM,CAAC;QAEvB,sDAAsD;QACtD,WAAW,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IAEJ,iEAAiE;IACjE,gBAAgB,EAAE,MAAM,CAAC;IAEzB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAC;IAExB,wCAAwC;IACxC,QAAQ,EAAE,OAAO,CAAC;IAElB,+CAA+C;IAC/C,YAAY,EAAE,iBAAiB,CAAC;IAEhC,8CAA8C;IAC9C,aAAa,EAAE,OAAO,CAAC;IAEvB,iEAAiE;IACjE,qBAAqB,EAAE,OAAO,CAAC;CAClC;AAED,uCAAuC;AACvC,MAAM,WAAW,WAAW;IACxB,gCAAgC;IAChC,YAAY,EAAE,GAAG,CAAC;IAElB,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,+BAA+B;AAC/B,MAAM,WAAW,YAAY;IACzB,uDAAuD;IACvD,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IACxC,+DAA+D;IAC/D,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC/B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;CACf;AAED,+CAA+C;AAC/C,MAAM,MAAM,iBAAiB,GACvB;IACE,gCAAgC;IAChC,IAAI,EAAE,QAAQ,CAAC;CAClB,GACC;IACE,gCAAgC;IAChC,IAAI,EAAE,QAAQ,CAAC;IAEf,wCAAwC;IACxC,IAAI,EAAE;QACF,qCAAqC;QACrC,cAAc,EAAE,GAAG,EAAE,CAAC;KACzB,CAAC;CACL,GACC;IACE,gCAAgC;IAChC,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEN,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IACzB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,YAAY,EAAE,GAAG,CAAC;IAElB,iCAAiC;IACjC,MAAM,EAAE,GAAG,CAAC;IAEZ,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IAEZ,wCAAwC;IACxC,QAAQ,EAAE,OAAO,CAAC;IAElB,+CAA+C;IAC/C,YAAY,EAAE,iBAAiB,CAAC;IAEhC,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAC;CAC5B"}

package/esm/src/types/info/vaults.js

@@ -0,0 +1 @@
+export {};