@continuumdao/ctm-mpc-defi 0.2.9 → 0.2.10

package/dist/protocols/evm/hyperliquid/index.d.ts

@@ -10,6 +10,8 @@ declare function hyperliquidApiBaseUrl(chainId: number): string;
 /** Stats feed used by app.hyperliquid.xyz/vaults (official vaultSummaries returns []). */
 declare function hyperliquidVaultStatsUrl(chainId: number): string | null;
 declare const HYPERLIQUID_HLP_VAULT_ADDRESS = "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303";
+/** HIP-3 coins use `{dex}:{symbol}` (e.g. `xyz:AAPL`). Returns dex segment when present. */
+declare function hyperliquidInferDexFromCoin(coin: string): string | undefined;
 
 /** CoreWriter system contract on HyperEVM — sends actions to HyperCore. */
 declare const HYPERLIQUID_CORE_WRITER_ADDRESS: "0x3333333333333333333333333333333333333333";
@@ -23,6 +25,15 @@ declare const HYPERLIQUID_TIF: {
     readonly ioc: 3;
 };
 type HyperliquidTifKey = keyof typeof HYPERLIQUID_TIF;
+/** Approximate bar duration in ms for candle window sizing. */
+declare const HYPERLIQUID_INTERVAL_MS: Record<string, number>;
+declare const HYPERLIQUID_DEFAULT_OHLCV_INTERVAL: "15m";
+declare const HYPERLIQUID_DEFAULT_CANDLE_LIMIT = 48;
+declare const HYPERLIQUID_MAX_CANDLE_LIMIT = 200;
+/** Max bars for dedicated OHLCV range requests (e.g. 7d @ 15m ≈ 672). */
+declare const HYPERLIQUID_MAX_OHLCV_BARS = 2000;
+declare const HYPERLIQUID_DEFAULT_LOOKBACK_DAYS = 1;
+declare const HYPERLIQUID_MAX_LOOKBACK_DAYS = 90;
 
 type HyperliquidPerpMarket = {
     name: string;
@@ -30,6 +41,8 @@ type HyperliquidPerpMarket = {
     szDecimals: number;
     maxLeverage: number;
     onlyIsolated?: boolean;
+    /** HIP-3 builder dex; omitted for native Hyperliquid perps. */
+    dex?: string;
 };
 type HyperliquidPerpDex = {
     name: string;
@@ -50,6 +63,39 @@ type HyperliquidOhlcvCandle = {
     close: string;
     volume: string;
 };
+type HyperliquidLivePrice = {
+    markPx: string | null;
+    midPx: string | null;
+    oraclePx: string | null;
+    prevDayPx: string | null;
+    /** Best available live tradable price (midPx, else markPx, else allMids). */
+    midUsd: string;
+    source: 'midPx' | 'markPx' | 'allMids';
+};
+type HyperliquidMarketSnapshot = {
+    coin: string;
+    dex: string | null;
+    livePrice: HyperliquidLivePrice;
+    /** @deprecated Prefer livePrice.midUsd */
+    midUsd: string;
+    fetchedAtMs: number;
+    interval: HyperliquidOhlcvInterval;
+    latestCandle: HyperliquidOhlcvCandle | null;
+    candles: HyperliquidOhlcvCandle[];
+    candleCount: number;
+};
+type HyperliquidOhlcvRange = {
+    coin: string;
+    dex: string | null;
+    interval: HyperliquidOhlcvInterval;
+    startTimeMs: number;
+    endTimeMs: number;
+    expectedBars: number;
+    candleCount: number;
+    latestCandle: HyperliquidOhlcvCandle | null;
+    candles: HyperliquidOhlcvCandle[];
+    fetchedAtMs: number;
+};
 declare function hyperliquidFetchPerpMeta(args: {
     chainId: number;
     dex?: string;
@@ -67,27 +113,60 @@ declare function hyperliquidFetchAllMids(args: {
 }): Promise<{
     mids: Record<string, string>;
 }>;
+/** Resolve OHLCV window from lookback or explicit timestamps. */
+declare function hyperliquidResolveOhlcvWindow(args: {
+    interval: HyperliquidOhlcvInterval;
+    lookbackDays?: number;
+    lookbackHours?: number;
+    startTimeMs?: number;
+    endTimeMs?: number;
+}): {
+    startTimeMs: number;
+    endTimeMs: number;
+    expectedBars: number;
+};
+/** Short recent window for market snapshot (default 48 bars). */
 declare function hyperliquidFetchCandles(args: {
     chainId: number;
     coin: string;
     interval: HyperliquidOhlcvInterval;
     startTimeMs?: number;
     endTimeMs?: number;
+    limit?: number;
 }): Promise<{
     candles: HyperliquidOhlcvCandle[];
 }>;
-declare function hyperliquidFetchMarketSnapshot(args: {
+/** OHLCV for an explicit time range — requests only that window from Hyperliquid (no over-fetch + filter). */
+declare function hyperliquidFetchOhlcvRange(args: {
     chainId: number;
     coin: string;
     interval?: HyperliquidOhlcvInterval;
     dex?: string;
-}): Promise<{
+    lookbackDays?: number;
+    lookbackHours?: number;
+    startTimeMs?: number;
+    endTimeMs?: number;
+}): Promise<HyperliquidOhlcvRange>;
+/** Live mark/mid/oracle from metaAndAssetCtxs — authoritative for HIP-3 and native perps. */
+declare function hyperliquidFetchPerpAssetContext(args: {
+    chainId: number;
     coin: string;
-    midUsd: string | null;
-    fetchedAtMs: number;
-    interval: HyperliquidOhlcvInterval;
-    candles: HyperliquidOhlcvCandle[];
+    dex?: string;
+}): Promise<{
+    markPx: string | null;
+    midPx: string | null;
+    oraclePx: string | null;
+    prevDayPx: string | null;
+    funding: string | null;
+    openInterest: string | null;
 }>;
+declare function hyperliquidFetchMarketSnapshot(args: {
+    chainId: number;
+    coin: string;
+    interval?: HyperliquidOhlcvInterval;
+    dex?: string;
+    candleLimit?: number;
+}): Promise<HyperliquidMarketSnapshot>;
 type ClearinghouseState = {
     assetPositions?: Array<{
         position?: {
@@ -192,6 +271,15 @@ declare function hyperliquidFetchDexList(args: {
 }): Promise<{
     dexes: HyperliquidPerpDex[];
 }>;
+type HyperliquidPerpConciseAnnotation = {
+    category?: string;
+    displayName?: string;
+    keywords?: string[];
+};
+/** Bulk metadata for HIP-3 / annotated perps (display names, keywords like "apple" for AAPL). */
+declare function hyperliquidFetchPerpConciseAnnotations(args: {
+    chainId: number;
+}): Promise<Map<string, HyperliquidPerpConciseAnnotation>>;
 declare function hyperliquidFetchDelegations(args: {
     chainId: number;
     user: string;
@@ -237,6 +325,50 @@ declare function hyperliquidResolveAsset(args: {
 }>;
 declare function hyperliquidIsSpotAssetId(asset: number): boolean;
 
+type HyperliquidPerpAnnotation = {
+    category?: string;
+    displayName?: string;
+    keywords?: string[];
+};
+type HyperliquidMarketSearchHit = {
+    coin: string;
+    symbol: string;
+    dex?: string;
+    asset: number;
+    szDecimals: number;
+    maxLeverage: number;
+    onlyIsolated?: boolean;
+    displayName?: string;
+    category?: string;
+    keywords?: string[];
+    matchScore: number;
+    matchReason: string;
+};
+declare function hyperliquidMarketSymbol(coin: string): string;
+declare function hyperliquidCollectAllPerpMarkets(args: {
+    chainId: number;
+    dex?: string;
+}): Promise<{
+    markets: HyperliquidPerpMarket[];
+    dexes: Awaited<ReturnType<typeof hyperliquidFetchDexList>>['dexes'];
+}>;
+declare function hyperliquidSearchMarkets(args: {
+    chainId: number;
+    query: string;
+    dex?: string;
+    limit?: number;
+}): Promise<{
+    matches: HyperliquidMarketSearchHit[];
+}>;
+/** Resolve a user ticker/name to a single canonical Hyperliquid coin across all dexes. */
+declare function hyperliquidResolvePerpMarket(args: {
+    chainId: number;
+    coin: string;
+    dex?: string;
+}): Promise<HyperliquidPerpMarket & {
+    symbol: string;
+}>;
+
 type HyperliquidUsdClassBalances = {
     spotUsdcAvailable: string;
     perpWithdrawable: string;
@@ -292,7 +424,7 @@ declare function hyperliquidFetchOrdersForExecutor(args: {
 }): Promise<{
     orders: HyperliquidOpenOrder[];
 }>;
-/** MCP: perp markets + HIP-3 dex list. */
+/** MCP: perp markets + HIP-3 dex list. When dex is omitted, returns native + all HIP-3 dex markets. */
 declare function hyperliquidFetchMarketsSummary(args: {
     chainId: number;
     dex?: string;
@@ -300,6 +432,15 @@ declare function hyperliquidFetchMarketsSummary(args: {
     markets: HyperliquidPerpMarket[];
     dexes: HyperliquidPerpDex[];
 }>;
+/** MCP: search markets across all dexes by ticker or name (case-insensitive). */
+declare function hyperliquidSearchMarketsSummary(args: {
+    chainId: number;
+    query: string;
+    dex?: string;
+    limit?: number;
+}): Promise<{
+    matches: HyperliquidMarketSearchHit[];
+}>;
 /** MCP: open positions for executor. */
 declare function hyperliquidFetchPositionsForExecutor(args: {
     chainId: number;
@@ -372,14 +513,26 @@ declare function hyperliquidFetchMarketSnapshotSummary(args: {
     coin: string;
     interval?: HyperliquidOhlcvInterval;
     dex?: string;
+    candleLimit?: number;
 }): Promise<{
-    snapshot: {
-        coin: string;
-        midUsd: string | null;
-        fetchedAtMs: number;
-        interval: HyperliquidOhlcvInterval;
-        candles: HyperliquidOhlcvCandle[];
-    };
+    snapshot: HyperliquidMarketSnapshot;
+    resolvedCoin: string;
+    dex: string | null;
+}>;
+/** MCP: OHLCV history for an explicit lookback or time range. */
+declare function hyperliquidFetchOhlcvSummary(args: {
+    chainId: number;
+    coin: string;
+    interval?: HyperliquidOhlcvInterval;
+    dex?: string;
+    lookbackDays?: number;
+    lookbackHours?: number;
+    startTimeMs?: number;
+    endTimeMs?: number;
+}): Promise<{
+    ohlcv: HyperliquidOhlcvRange;
+    resolvedCoin: string;
+    dex: string | null;
 }>;
 
 /** Hyperliquid CoreWriter uses 1e8 fixed-point for prices and sizes. */
@@ -512,4 +665,4 @@ declare function buildEvmMultisignBodyHyperliquidUndelegateBatch(args: Omit<Hype
 declare const HYPERLIQUID_PROTOCOL_ID = "hyperliquid";
 declare const hyperliquidProtocolModule: ProtocolModule;
 
-export { HYPERLIQUID_CORE_WRITER_ADDRESS, HYPERLIQUID_CORE_WRITER_GAS_FALLBACK, HYPERLIQUID_HLP_VAULT_ADDRESS, HYPERLIQUID_PROTOCOL_ID, HYPERLIQUID_SPOT_ASSET_OFFSET, HYPERLIQUID_SUPPORTED_CHAIN_IDS, HYPERLIQUID_TIF, type HyperliquidActiveAssetContext, type HyperliquidCancelOrderArgs, type HyperliquidCloseOrderArgs, type HyperliquidDelegateArgs, type HyperliquidLimitOrderArgs, type HyperliquidOhlcvCandle, type HyperliquidOhlcvInterval, type HyperliquidOpenMarketContext, type HyperliquidOpenOrder, type HyperliquidPerpAccountSummary, type HyperliquidPerpDex, type HyperliquidPerpMarket, type HyperliquidPositionDisplayRow, type HyperliquidSpotMarket, type HyperliquidSupportedChainId, type HyperliquidTifKey, type HyperliquidUsdClassBalances, type HyperliquidUsdClassTransferArgs, type HyperliquidVaultDepositArgs, type HyperliquidVaultEquity, type HyperliquidVaultSummary, type HyperliquidVaultWithdrawArgs, buildCoreWriterCancelByCloidCalldata, buildCoreWriterCancelByOidCalldata, buildCoreWriterLimitOrderCalldata, buildCoreWriterStakingDepositCalldata, buildCoreWriterStakingWithdrawCalldata, buildCoreWriterTokenDelegateCalldata, buildCoreWriterUsdClassTransferCalldata, buildCoreWriterVaultTransferCalldata, buildEvmMultisignBodyHyperliquidCancelBatch, buildEvmMultisignBodyHyperliquidCloseBatch, buildEvmMultisignBodyHyperliquidDelegateBatch, buildEvmMultisignBodyHyperliquidDelegateOnlyBatch, buildEvmMultisignBodyHyperliquidLimitOrderBatch, buildEvmMultisignBodyHyperliquidStakeDepositBatch, buildEvmMultisignBodyHyperliquidStakeWithdrawBatch, buildEvmMultisignBodyHyperliquidUndelegateBatch, buildEvmMultisignBodyHyperliquidUsdClassTransferBatch, buildEvmMultisignBodyHyperliquidVaultDepositBatch, buildEvmMultisignBodyHyperliquidVaultWithdrawBatch, coreWriterStep, hyperliquidApiBaseUrl, hyperliquidEncodePx8, hyperliquidEncodeUsd6, hyperliquidEncodeWei8, hyperliquidFetchActiveAssetData, hyperliquidFetchAllMids, hyperliquidFetchCandles, hyperliquidFetchClearinghouseState, hyperliquidFetchDelegations, hyperliquidFetchDelegationsForExecutor, hyperliquidFetchDexList, hyperliquidFetchMarketSnapshot, hyperliquidFetchMarketSnapshotSummary, hyperliquidFetchMarketsSummary, hyperliquidFetchOpenContextSummary, hyperliquidFetchOpenMarketContext, hyperliquidFetchOpenOrders, hyperliquidFetchOpenOrdersSummary, hyperliquidFetchOrdersForExecutor, hyperliquidFetchPerpMeta, hyperliquidFetchPositionDisplayRows, hyperliquidFetchPositionsForExecutor, hyperliquidFetchSpotClearinghouseState, hyperliquidFetchSpotMeta, hyperliquidFetchStakingSummary, hyperliquidFetchStakingSummaryForExecutor, hyperliquidFetchUsdClassBalances, hyperliquidFetchUsdClassBalancesSummary, hyperliquidFetchUserVaultEquities, hyperliquidFetchUserVaultEquitiesSummary, hyperliquidFetchVaultCatalogSummary, hyperliquidFetchVaultSummaries, hyperliquidIsSpotAssetId, hyperliquidProtocolModule, hyperliquidResolveAsset, hyperliquidResolvePerpAsset, hyperliquidResolveSpotAsset, hyperliquidResolveTif, hyperliquidVaultStatsUrl, isHyperliquidChainSupported };
+export { HYPERLIQUID_CORE_WRITER_ADDRESS, HYPERLIQUID_CORE_WRITER_GAS_FALLBACK, HYPERLIQUID_DEFAULT_CANDLE_LIMIT, HYPERLIQUID_DEFAULT_LOOKBACK_DAYS, HYPERLIQUID_DEFAULT_OHLCV_INTERVAL, HYPERLIQUID_HLP_VAULT_ADDRESS, HYPERLIQUID_INTERVAL_MS, HYPERLIQUID_MAX_CANDLE_LIMIT, HYPERLIQUID_MAX_LOOKBACK_DAYS, HYPERLIQUID_MAX_OHLCV_BARS, HYPERLIQUID_PROTOCOL_ID, HYPERLIQUID_SPOT_ASSET_OFFSET, HYPERLIQUID_SUPPORTED_CHAIN_IDS, HYPERLIQUID_TIF, type HyperliquidActiveAssetContext, type HyperliquidCancelOrderArgs, type HyperliquidCloseOrderArgs, type HyperliquidDelegateArgs, type HyperliquidLimitOrderArgs, type HyperliquidLivePrice, type HyperliquidMarketSearchHit, type HyperliquidMarketSnapshot, type HyperliquidOhlcvCandle, type HyperliquidOhlcvInterval, type HyperliquidOhlcvRange, type HyperliquidOpenMarketContext, type HyperliquidOpenOrder, type HyperliquidPerpAccountSummary, type HyperliquidPerpAnnotation, type HyperliquidPerpConciseAnnotation, type HyperliquidPerpDex, type HyperliquidPerpMarket, type HyperliquidPositionDisplayRow, type HyperliquidSpotMarket, type HyperliquidSupportedChainId, type HyperliquidTifKey, type HyperliquidUsdClassBalances, type HyperliquidUsdClassTransferArgs, type HyperliquidVaultDepositArgs, type HyperliquidVaultEquity, type HyperliquidVaultSummary, type HyperliquidVaultWithdrawArgs, buildCoreWriterCancelByCloidCalldata, buildCoreWriterCancelByOidCalldata, buildCoreWriterLimitOrderCalldata, buildCoreWriterStakingDepositCalldata, buildCoreWriterStakingWithdrawCalldata, buildCoreWriterTokenDelegateCalldata, buildCoreWriterUsdClassTransferCalldata, buildCoreWriterVaultTransferCalldata, buildEvmMultisignBodyHyperliquidCancelBatch, buildEvmMultisignBodyHyperliquidCloseBatch, buildEvmMultisignBodyHyperliquidDelegateBatch, buildEvmMultisignBodyHyperliquidDelegateOnlyBatch, buildEvmMultisignBodyHyperliquidLimitOrderBatch, buildEvmMultisignBodyHyperliquidStakeDepositBatch, buildEvmMultisignBodyHyperliquidStakeWithdrawBatch, buildEvmMultisignBodyHyperliquidUndelegateBatch, buildEvmMultisignBodyHyperliquidUsdClassTransferBatch, buildEvmMultisignBodyHyperliquidVaultDepositBatch, buildEvmMultisignBodyHyperliquidVaultWithdrawBatch, coreWriterStep, hyperliquidApiBaseUrl, hyperliquidCollectAllPerpMarkets, hyperliquidEncodePx8, hyperliquidEncodeUsd6, hyperliquidEncodeWei8, hyperliquidFetchActiveAssetData, hyperliquidFetchAllMids, hyperliquidFetchCandles, hyperliquidFetchClearinghouseState, hyperliquidFetchDelegations, hyperliquidFetchDelegationsForExecutor, hyperliquidFetchDexList, hyperliquidFetchMarketSnapshot, hyperliquidFetchMarketSnapshotSummary, hyperliquidFetchMarketsSummary, hyperliquidFetchOhlcvRange, hyperliquidFetchOhlcvSummary, hyperliquidFetchOpenContextSummary, hyperliquidFetchOpenMarketContext, hyperliquidFetchOpenOrders, hyperliquidFetchOpenOrdersSummary, hyperliquidFetchOrdersForExecutor, hyperliquidFetchPerpAssetContext, hyperliquidFetchPerpConciseAnnotations, hyperliquidFetchPerpMeta, hyperliquidFetchPositionDisplayRows, hyperliquidFetchPositionsForExecutor, hyperliquidFetchSpotClearinghouseState, hyperliquidFetchSpotMeta, hyperliquidFetchStakingSummary, hyperliquidFetchStakingSummaryForExecutor, hyperliquidFetchUsdClassBalances, hyperliquidFetchUsdClassBalancesSummary, hyperliquidFetchUserVaultEquities, hyperliquidFetchUserVaultEquitiesSummary, hyperliquidFetchVaultCatalogSummary, hyperliquidFetchVaultSummaries, hyperliquidInferDexFromCoin, hyperliquidIsSpotAssetId, hyperliquidMarketSymbol, hyperliquidProtocolModule, hyperliquidResolveAsset, hyperliquidResolveOhlcvWindow, hyperliquidResolvePerpAsset, hyperliquidResolvePerpMarket, hyperliquidResolveSpotAsset, hyperliquidResolveTif, hyperliquidSearchMarkets, hyperliquidSearchMarketsSummary, hyperliquidVaultStatsUrl, isHyperliquidChainSupported };