@nktkas/hyperliquid 0.13.0 → 0.13.2

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

@@ -0,0 +1,445 @@
+import type { Hex } from "../common.js";
+/**
+ * Request mid coin prices.
+ * @returns {AllMids} Mid coin prices.
+ * @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";
+}
+/**
+ * Request candlestick snapshots.
+ * @returns {Candle[]} Array of candlestick data points.
+ * @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. */
+        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 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: Hex;
+}
+/**
+ * Request user staking delegations.
+ * @returns {Delegation[]} Array of user's staking delegations.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-delegations
+ */
+export interface DelegationsRequest {
+    /** Type of request. */
+    type: "delegations";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user staking history.
+ * @returns {DelegatorUpdate[]} Array of user's staking history.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-history
+ */
+export interface DelegatorHistoryRequest {
+    /** Type of request. */
+    type: "delegatorHistory";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user staking rewards.
+ * @returns {DelegatorReward[]} Array of user's staking rewards.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-rewards
+ */
+export interface DelegatorRewardsRequest {
+    /** Type of request. */
+    type: "delegatorRewards";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user staking summary.
+ * @returns {DelegatorSummary} Summary of a user's staking.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-summary
+ */
+export interface DelegatorSummaryRequest {
+    /** Type of request. */
+    type: "delegatorSummary";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user's extra agents.
+ * @returns {ExtraAgent[]} The extra agents of a user.
+ * @see null - no documentation
+ */
+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 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: Hex;
+}
+/**
+ * Request funding history.
+ * @returns {FundingHistory[]} Array of historical funding rate data for an asset.
+ * @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. */
+    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 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: Hex;
+}
+/**
+ * Request L2 order book ({@link L2Book}).
+ * @returns {Book} L2 order book snapshot.
+ * @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. */
+    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 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: Hex;
+    /** Builder address. */
+    builder: Hex;
+}
+/**
+ * Request open orders.
+ * @returns {Order[]} Array of open orders.
+ * @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: Hex;
+}
+/**
+ * Request order status.
+ * @returns {OrderLookup} Result of an order status lookup.
+ * @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: Hex;
+    /** Order ID or client order ID. */
+    oid: number | Hex;
+}
+/**
+ * Request user portfolio.
+ * @returns {Portfolio} User's portfolio.
+ * @see null - no documentation
+ */
+export interface PortfolioRequest {
+    /** Type of request. */
+    type: "portfolio";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request perpetuals at open interest cap.
+ * @returns {string[]} Array of perpetuals at open interest caps.
+ * @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. */
+    type: "perpsAtOpenInterestCap";
+}
+/**
+ * Request predicted funding rates.
+ * @returns {PredictedFunding[]} Array of predicted funding rates.
+ * @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 referral.
+ * @returns {Referral} Referral information for a user.
+ * @see null - no documentation
+ */
+export interface ReferralRequest {
+    /** Type of request. */
+    type: "referral";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request spot clearinghouse state.
+ * @returns {SpotClearinghouseState} Balances for spot tokens.
+ * @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: Hex;
+}
+/**
+ * Request spot deploy state.
+ * @returns {SpotDeployState} The deploy state of a user.
+ * @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: Hex;
+}
+/**
+ * Request spot metadata and asset contexts.
+ * @returns {SpotMetaAndAssetCtxs} Metadata and context information for each spot asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
+ */
+export interface SpotMetaAndAssetCtxsRequest {
+    /** Type of request. */
+    type: "spotMetaAndAssetCtxs";
+}
+/**
+ * Request spot trading metadata.
+ * @returns {SpotMeta} Metadata for spot assets.
+ * @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 user sub-accounts.
+ * @returns {SubAccount[]} Array of user sub-accounts.
+ * @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: Hex;
+}
+/**
+ * Request token details.
+ * @returns {TokenDetails} The details of a token.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export interface TokenDetailsRequest {
+    /** Type of request. */
+    type: "tokenDetails";
+    /** Token ID. */
+    tokenId: Hex;
+}
+/**
+ * Request TWAP history.
+ * @returns {TwapHistory[]} The TWAP history of a user.
+ * @see null - no documentation
+ */
+export interface TwapHistoryRequest {
+    /** Type of request. */
+    type: "twapHistory";
+    /** User's address. */
+    user: Hex;
+}
+/**
+ * Request user fees.
+ * @returns {UserFees} User fees.
+ * @see null - no documentation
+ */
+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 fills.
+ * @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: Hex;
+    /** Start time (in ms since epoch). */
+    startTime: number;
+    /** End time (in ms since epoch). */
+    endTime?: number | null;
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime?: boolean;
+}
+/**
+ * Request user fills.
+ * @returns {Fill[]} Array of user's trade fills.
+ * @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: Hex;
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime?: boolean;
+}
+/**
+ * Request user funding.
+ * @returns {UserFundingUpdate[]} Array of user's funding ledger updates.
+ * @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: 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 {UserNonFundingLedgerUpdate[]} Array of user's non-funding ledger updates.
+ * @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: 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 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: Hex;
+}
+/**
+ * Request user role.
+ * @returns {UserRole} User role.
+ * @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: Hex;
+}
+/**
+ * Request user TWAP slice fills.
+ * @returns {TwapSliceFill[]} Array of user's TWAP slice fills.
+ * @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: Hex;
+}
+/**
+ * Request user vault deposits.
+ * @returns {VaultEquity[]} Array of user's vault deposits.
+ * @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: Hex;
+}
+/**
+ * Request validator summaries.
+ * @returns {ValidatorSummary[]} Array of validator summaries.
+ * @see null - no documentation
+ */
+export interface ValidatorSummariesRequest {
+    /** Type of request. */
+    type: "validatorSummaries";
+}
+/**
+ * Request details of a vault.
+ * @returns {VaultDetails} Details of a vault.
+ * @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?: Hex | null;
+}
+/**
+ * Request a list of vaults less than 2 hours old.
+ * @returns {VaultSummary[]} Array of vault summaries.
+ * @see null - no documentation
+ */
+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;;;;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,uBAAuB;IACpC,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;IACzB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;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,uBAAuB;IACpC,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;IACzB,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;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,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,mCAAmC;IACnC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,uBAAuB;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,sBAAsB;IACtB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C,uBAAuB;IACvB,IAAI,EAAE,wBAAwB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,uBAAuB;IACvB,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;;GAIG;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;;;;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,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,iGAAiG;IACjG,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,iGAAiG;IACjG,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,eAAe;IAC5B,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,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,yBAAyB;IACtC,uBAAuB;IACvB,IAAI,EAAE,oBAAoB,CAAC;CAC9B;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;;;;GAIG;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,90 @@
+import type { Hex } from "../common.js";
+import type { PortfolioPeriods } from "./accounts.js";
+/** Details about a vault. */
+export interface VaultDetails {
+    /** Vault name. */
+    name: string;
+    /** Vault address. */
+    vaultAddress: Hex;
+    /** Leader address. */
+    leader: Hex;
+    /** Vault description. */
+    description: string;
+    /** Vault portfolio metrics grouped by time periods. */
+    portfolio: PortfolioPeriods;
+    /** Annual percentage rate. */
+    apr: number;
+    /** unknown */
+    followerState: unknown | null;
+    /** Ownership percentage held by leader. */
+    leaderFraction: number;
+    /** Leader's commission percentage. */
+    leaderCommission: number;
+    /** Vault followers list. */
+    followers: {
+        /** Follower address or "Leader". */
+        user: Hex | "Leader";
+        /** Follower's vault equity. */
+        vaultEquity: string;
+        /** Current profit and loss. */
+        pnl: string;
+        /** All-time profit and loss. */
+        allTimePnl: string;
+        /** Subscription duration in days. */
+        daysFollowing: number;
+        /** Vault entry timestamp. */
+        vaultEntryTime: number;
+        /** Timestamp when funds become unlocked. */
+        lockupUntil: number;
+    }[];
+    /** Maximum distributable amount. */
+    maxDistributable: number;
+    /** Maximum withdrawable amount. */
+    maxWithdrawable: number;
+    /** Vault closure status. */
+    isClosed: boolean;
+    /** Vault relationship type. */
+    relationship: VaultRelationship;
+    /** Deposit permission status. */
+    allowDeposits: boolean;
+    /** Position closure policy on withdrawal. */
+    alwaysCloseOnWithdraw: boolean;
+}
+/** User's vault equity details. */
+export interface VaultEquity {
+    /** Vault address. */
+    vaultAddress: Hex;
+    /** User's deposited equity. */
+    equity: string;
+}
+/** Vault relationship configuration. */
+export type VaultRelationship = {
+    /** Relationship type. */
+    type: "normal" | "child";
+} | {
+    /** Relationship type. */
+    type: "parent";
+    /** Child vault information. */
+    data: {
+        /** Child vault addresses. */
+        childAddresses: Hex[];
+    };
+};
+/** Summary of a vault. */
+export interface VaultSummary {
+    /** Vault name. */
+    name: string;
+    /** Vault address. */
+    vaultAddress: Hex;
+    /** Leader address. */
+    leader: Hex;
+    /** Total value locked. */
+    tvl: string;
+    /** Vault closure status. */
+    isClosed: boolean;
+    /** Vault relationship type. */
+    relationship: VaultRelationship;
+    /** Creation timestamp. */
+    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;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,sBAAsB;IACtB,MAAM,EAAE,GAAG,CAAC;IACZ,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,SAAS,EAAE,gBAAgB,CAAC;IAC5B,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc;IAEd,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,4BAA4B;IAC5B,SAAS,EAAE;QACP,oCAAoC;QACpC,IAAI,EAAE,GAAG,GAAG,QAAQ,CAAC;QACrB,+BAA+B;QAC/B,WAAW,EAAE,MAAM,CAAC;QACpB,+BAA+B;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,gCAAgC;QAChC,UAAU,EAAE,MAAM,CAAC;QACnB,qCAAqC;QACrC,aAAa,EAAE,MAAM,CAAC;QACtB,6BAA6B;QAC7B,cAAc,EAAE,MAAM,CAAC;QACvB,4CAA4C;QAC5C,WAAW,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,iBAAiB,CAAC;IAChC,iCAAiC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,6CAA6C;IAC7C,qBAAqB,EAAE,OAAO,CAAC;CAClC;AAED,mCAAmC;AACnC,MAAM,WAAW,WAAW;IACxB,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,MAAM,iBAAiB,GACvB;IACE,yBAAyB;IACzB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;CAC5B,GACC;IACE,yBAAyB;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,+BAA+B;IAC/B,IAAI,EAAE;QACF,6BAA6B;QAC7B,cAAc,EAAE,GAAG,EAAE,CAAC;KACzB,CAAC;CACL,CAAC;AAEN,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,sBAAsB;IACtB,MAAM,EAAE,GAAG,CAAC;IACZ,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,iBAAiB,CAAC;IAChC,0BAA0B;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC5B"}

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

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