@metamask-previews/perps-controller 0.0.0-preview-e4aa1532 → 0.0.0-preview-6dfa4aeba

package/dist/types/index.d.mts

@@ -1,1153 +0,0 @@
-import type { CaipAccountId, CaipChainId, CaipAssetId, Hex } from "@metamask/utils";
-import type { CandleData } from "./chart.mjs";
-import type { CandlePeriod, TimeDuration } from "./chart.mjs";
-export type * from "./chart.mjs";
-export type * from "./hyperliquid-types.mjs";
-export * from "./transactionTypes.mjs";
-/**
- * Stream channel keys for pausing/resuming WebSocket streams
- * Platform-specific implementations map their channels to these keys
- */
-export type PerpsStreamChannelKey = 'prices' | 'positions' | 'orders' | 'orderFills' | 'account' | 'orderBook' | 'candles' | 'oiCaps';
-/**
- * WebSocket connection states for real-time data management
- */
-export declare enum WebSocketConnectionState {
-    Disconnected = "disconnected",
-    Connecting = "connecting",
-    Connected = "connected",
-    Disconnecting = "disconnecting"
-}
-/**
- * Raw HyperLiquid ledger update structure from SDK
- * This matches the actual SDK types for userNonFundingLedgerUpdates
- */
-export type RawHyperLiquidLedgerUpdate = {
-    hash: string;
-    time: number;
-    delta: {
-        type: string;
-        usdc?: string;
-        coin?: string;
-    };
-};
-export type UserHistoryItem = {
-    id: string;
-    timestamp: number;
-    type: 'deposit' | 'withdrawal';
-    amount: string;
-    asset: string;
-    txHash: string;
-    status: 'completed' | 'failed' | 'pending';
-    details: {
-        source: string;
-        bridgeContract?: string;
-        recipient?: string;
-        blockNumber?: string;
-        chainId?: string;
-        synthetic?: boolean;
-    };
-};
-export type GetUserHistoryParams = {
-    startTime?: number;
-    endTime?: number;
-    accountId?: CaipAccountId;
-};
-export type TradeConfiguration = {
-    leverage?: number;
-    pendingConfig?: {
-        amount?: string;
-        leverage?: number;
-        takeProfitPrice?: string;
-        stopLossPrice?: string;
-        limitPrice?: string;
-        orderType?: OrderType;
-        timestamp: number;
-    };
-};
-export type OrderType = 'market' | 'limit';
-export type MarketType = 'crypto' | 'equity' | 'commodity' | 'forex';
-export type MarketTypeFilter = MarketType | 'all' | 'stocks_and_commodities';
-export type BadgeType = MarketType | 'experimental' | 'dex';
-export type InputMethod = 'default' | 'slider' | 'keypad' | 'percentage' | 'max';
-export type TradeAction = 'create_position' | 'increase_exposure';
-export type TrackingData = {
-    totalFee: number;
-    marketPrice: number;
-    metamaskFee?: number;
-    metamaskFeeRate?: number;
-    feeDiscountPercentage?: number;
-    estimatedPoints?: number;
-    marginUsed?: number;
-    inputMethod?: InputMethod;
-    tradeAction?: TradeAction;
-    receivedAmount?: number;
-    realizedPnl?: number;
-    source?: string;
-};
-export type TPSLTrackingData = {
-    direction: 'long' | 'short';
-    source: string;
-    positionSize: number;
-    takeProfitPercentage?: number;
-    stopLossPercentage?: number;
-    isEditingExistingPosition?: boolean;
-    entryPrice?: number;
-};
-export type OrderParams = {
-    symbol: string;
-    isBuy: boolean;
-    size: string;
-    orderType: OrderType;
-    price?: string;
-    reduceOnly?: boolean;
-    isFullClose?: boolean;
-    timeInForce?: 'GTC' | 'IOC' | 'ALO';
-    usdAmount?: string;
-    priceAtCalculation?: number;
-    maxSlippageBps?: number;
-    takeProfitPrice?: string;
-    stopLossPrice?: string;
-    clientOrderId?: string;
-    slippage?: number;
-    grouping?: 'na' | 'normalTpsl' | 'positionTpsl';
-    currentPrice?: number;
-    leverage?: number;
-    existingPositionLeverage?: number;
-    trackingData?: TrackingData;
-    providerId?: PerpsProviderType;
-};
-export type OrderResult = {
-    success?: boolean;
-    orderId?: string;
-    error?: string;
-    filledSize?: string;
-    averagePrice?: string;
-    providerId?: PerpsProviderType;
-};
-export type Position = {
-    symbol: string;
-    size: string;
-    entryPrice: string;
-    positionValue: string;
-    unrealizedPnl: string;
-    marginUsed: string;
-    leverage: {
-        type: 'isolated' | 'cross';
-        value: number;
-        rawUsd?: string;
-    };
-    liquidationPrice: string | null;
-    maxLeverage: number;
-    returnOnEquity: string;
-    cumulativeFunding: {
-        allTime: string;
-        sinceOpen: string;
-        sinceChange: string;
-    };
-    takeProfitPrice?: string;
-    stopLossPrice?: string;
-    takeProfitCount: number;
-    stopLossCount: number;
-    providerId?: PerpsProviderType;
-};
-export type AccountState = {
-    availableBalance: string;
-    totalBalance: string;
-    marginUsed: string;
-    unrealizedPnl: string;
-    returnOnEquity: string;
-    /**
-     * Per-sub-account balance breakdown (protocol-specific, optional)
-     * Maps sub-account identifier to its balance details.
-     *
-     * Protocol examples:
-     * - HyperLiquid HIP-3: '' or 'main' (main DEX), 'xyz' (HIP-3 builder DEX)
-     * - dYdX: Sub-account numbers (e.g., '0', '1', '2')
-     * - Other protocols: Vault IDs, pool IDs, margin account IDs, etc.
-     *
-     * Key: Sub-account identifier (protocol-specific string)
-     * Value: Balance details for that sub-account
-     */
-    subAccountBreakdown?: Record<string, {
-        availableBalance: string;
-        totalBalance: string;
-    }>;
-    providerId?: PerpsProviderType;
-};
-export type ClosePositionParams = {
-    symbol: string;
-    size?: string;
-    orderType?: OrderType;
-    price?: string;
-    currentPrice?: number;
-    usdAmount?: string;
-    priceAtCalculation?: number;
-    maxSlippageBps?: number;
-    trackingData?: TrackingData;
-    providerId?: PerpsProviderType;
-};
-export type ClosePositionsParams = {
-    symbols?: string[];
-    closeAll?: boolean;
-};
-export type ClosePositionsResult = {
-    success: boolean;
-    successCount: number;
-    failureCount: number;
-    results: {
-        symbol: string;
-        success: boolean;
-        error?: string;
-    }[];
-};
-export type UpdateMarginParams = {
-    symbol: string;
-    amount: string;
-    providerId?: PerpsProviderType;
-};
-export type MarginResult = {
-    success: boolean;
-    error?: string;
-};
-export type FlipPositionParams = {
-    symbol: string;
-    position: Position;
-};
-export type InitializeResult = {
-    success: boolean;
-    error?: string;
-    chainId?: string;
-};
-export type ReadyToTradeResult = {
-    ready: boolean;
-    error?: string;
-    walletConnected?: boolean;
-    networkSupported?: boolean;
-};
-export type DisconnectResult = {
-    success: boolean;
-    error?: string;
-};
-export type MarketInfo = {
-    name: string;
-    szDecimals: number;
-    maxLeverage: number;
-    marginTableId: number;
-    onlyIsolated?: true;
-    isDelisted?: true;
-    minimumOrderSize?: number;
-    providerId?: PerpsProviderType;
-};
-/**
- * Market data with prices for UI display
- * Protocol-agnostic interface for market information with formatted values
- */
-export type PerpsMarketData = {
-    /**
-     * Token symbol (e.g., 'BTC', 'ETH')
-     */
-    symbol: string;
-    /**
-     * Full token name (e.g., 'Bitcoin', 'Ethereum')
-     */
-    name: string;
-    /**
-     * Maximum leverage available as formatted string (e.g., '40x', '25x')
-     */
-    maxLeverage: string;
-    /**
-     * Current price as formatted string (e.g., '$50,000.00')
-     */
-    price: string;
-    /**
-     * 24h price change as formatted string (e.g., '+$1,250.00', '-$850.50')
-     */
-    change24h: string;
-    /**
-     * 24h price change percentage as formatted string (e.g., '+2.5%', '-1.8%')
-     */
-    change24hPercent: string;
-    /**
-     * Trading volume as formatted string (e.g., '$1.2B', '$850M')
-     */
-    volume: string;
-    /**
-     * Open interest as formatted string (e.g., '$24.5M', '$1.2B')
-     */
-    openInterest?: string;
-    /**
-     * Next funding time in milliseconds since epoch (optional, market-specific)
-     */
-    nextFundingTime?: number;
-    /**
-     * Funding interval in hours (optional, market-specific)
-     */
-    fundingIntervalHours?: number;
-    /**
-     * Current funding rate as decimal (optional, from predictedFundings API)
-     */
-    fundingRate?: number;
-    /**
-     * Market source DEX identifier (HIP-3 support)
-     * - null or undefined: Main validator DEX
-     * - "xyz", "abc", etc: HIP-3 builder-deployed DEX
-     */
-    marketSource?: string | null;
-    /**
-     * Market asset type classification (optional)
-     * - crypto: Cryptocurrency (default for most markets)
-     * - equity: Stock/equity markets (HIP-3)
-     * - commodity: Commodity markets (HIP-3)
-     * - forex: Foreign exchange pairs (HIP-3)
-     */
-    marketType?: MarketType;
-    /**
-     * Multi-provider: which provider this market data comes from (injected by aggregator)
-     */
-    providerId?: PerpsProviderType;
-};
-export type ToggleTestnetResult = {
-    success: boolean;
-    isTestnet: boolean;
-    error?: string;
-};
-export type AssetRoute = {
-    assetId: CaipAssetId;
-    chainId: CaipChainId;
-    contractAddress: Hex;
-    constraints?: {
-        minAmount?: string;
-        maxAmount?: string;
-        estimatedTime?: string;
-        estimatedMinutes?: number;
-        fees?: {
-            fixed?: number;
-            percentage?: number;
-            token?: string;
-        };
-    };
-};
-export type SwitchProviderResult = {
-    success: boolean;
-    providerId: PerpsActiveProviderMode;
-    error?: string;
-};
-export type CancelOrderParams = {
-    orderId: string;
-    symbol: string;
-    providerId?: PerpsProviderType;
-};
-export type CancelOrderResult = {
-    success: boolean;
-    orderId?: string;
-    error?: string;
-    providerId?: PerpsProviderType;
-};
-export type BatchCancelOrdersParams = {
-    orderId: string;
-    symbol: string;
-}[];
-export type CancelOrdersParams = {
-    symbols?: string[];
-    orderIds?: string[];
-    cancelAll?: boolean;
-};
-export type CancelOrdersResult = {
-    success: boolean;
-    successCount: number;
-    failureCount: number;
-    results: {
-        orderId: string;
-        symbol: string;
-        success: boolean;
-        error?: string;
-    }[];
-};
-export type EditOrderParams = {
-    orderId: string | number;
-    newOrder: OrderParams;
-};
-export type DepositParams = {
-    amount: string;
-    assetId: CaipAssetId;
-    fromChainId?: CaipChainId;
-    toChainId?: CaipChainId;
-    recipient?: Hex;
-};
-export type DepositResult = {
-    success: boolean;
-    txHash?: string;
-    error?: string;
-};
-export type DepositStatus = 'idle' | 'preparing' | 'swapping' | 'bridging' | 'depositing' | 'success' | 'error';
-export type DepositFlowType = 'direct' | 'swap' | 'bridge' | 'swap_bridge';
-export type DepositStepInfo = {
-    totalSteps: number;
-    currentStep: number;
-    stepNames: string[];
-    stepTxHashes?: string[];
-};
-export type WithdrawParams = {
-    amount: string;
-    destination?: Hex;
-    assetId?: CaipAssetId;
-    providerId?: PerpsProviderType;
-};
-export type WithdrawResult = {
-    success: boolean;
-    txHash?: string;
-    error?: string;
-    withdrawalId?: string;
-    estimatedArrivalTime?: number;
-};
-export type TransferBetweenDexsParams = {
-    sourceDex: string;
-    destinationDex: string;
-    amount: string;
-};
-export type TransferBetweenDexsResult = {
-    success: boolean;
-    txHash?: string;
-    error?: string;
-};
-export type GetHistoricalPortfolioParams = {
-    accountId?: CaipAccountId;
-};
-export type HistoricalPortfolioResult = {
-    accountValue1dAgo: string;
-    timestamp: number;
-};
-export type LiveDataConfig = {
-    priceThrottleMs?: number;
-    positionThrottleMs?: number;
-    maxUpdatesPerSecond?: number;
-};
-export type PerpsControllerConfig = {
-    /**
-     * Fallback blocked regions to use when RemoteFeatureFlagController fails to fetch.
-     * The fallback is set by default if defined and replaced with remote block list once available.
-     */
-    fallbackBlockedRegions?: string[];
-    /**
-     * Fallback HIP-3 equity perps master switch to use when RemoteFeatureFlagController fails to fetch.
-     * Controls whether HIP-3 (builder-deployed) DEXs are enabled.
-     * The fallback is set by default if defined and replaced with remote feature flag once available.
-     */
-    fallbackHip3Enabled?: boolean;
-    /**
-     * Fallback HIP-3 market allowlist to use when RemoteFeatureFlagController fails to fetch.
-     * Empty array = enable all markets (discovery mode), non-empty = allowlist specific markets.
-     * Supports wildcards: "xyz:*" (all xyz markets), "xyz" (shorthand for "xyz:*"), "BTC" (main DEX market).
-     * Only applies when HIP-3 is enabled.
-     * The fallback is set by default if defined and replaced with remote feature flag once available.
-     */
-    fallbackHip3AllowlistMarkets?: string[];
-    /**
-     * Fallback HIP-3 market blocklist to use when RemoteFeatureFlagController fails to fetch.
-     * Empty array = no blocking, non-empty = block specific markets.
-     * Supports wildcards: "xyz:*" (block all xyz markets), "xyz" (shorthand for "xyz:*"), "BTC" (block main DEX market).
-     * Always applied regardless of HIP-3 enabled state.
-     * The fallback is set by default if defined and replaced with remote feature flag once available.
-     */
-    fallbackHip3BlocklistMarkets?: string[];
-};
-export type PriceUpdate = {
-    symbol: string;
-    price: string;
-    timestamp: number;
-    percentChange24h?: string;
-    bestBid?: string;
-    bestAsk?: string;
-    spread?: string;
-    markPrice?: string;
-    funding?: number;
-    openInterest?: number;
-    volume24h?: number;
-    providerId?: PerpsProviderType;
-};
-export type OrderFill = {
-    orderId: string;
-    symbol: string;
-    side: string;
-    size: string;
-    price: string;
-    pnl: string;
-    direction: string;
-    fee: string;
-    feeToken: string;
-    timestamp: number;
-    startPosition?: string;
-    success?: boolean;
-    liquidation?: {
-        liquidatedUser: string;
-        markPx: string;
-        method: string;
-    };
-    orderType?: 'take_profit' | 'stop_loss' | 'liquidation' | 'regular';
-    detailedOrderType?: string;
-    providerId?: PerpsProviderType;
-};
-export type GetPositionsParams = {
-    accountId?: CaipAccountId;
-    includeHistory?: boolean;
-    skipCache?: boolean;
-};
-export type GetAccountStateParams = {
-    accountId?: CaipAccountId;
-    source?: string;
-};
-export type GetOrderFillsParams = {
-    accountId?: CaipAccountId;
-    user?: Hex;
-    startTime?: number;
-    endTime?: number;
-    limit?: number;
-    aggregateByTime?: boolean;
-};
-export type GetOrdersParams = {
-    accountId?: CaipAccountId;
-    startTime?: number;
-    endTime?: number;
-    limit?: number;
-    offset?: number;
-    skipCache?: boolean;
-};
-export type GetFundingParams = {
-    accountId?: CaipAccountId;
-    startTime?: number;
-    endTime?: number;
-    limit?: number;
-    offset?: number;
-};
-export type GetSupportedPathsParams = {
-    isTestnet?: boolean;
-    assetId?: CaipAssetId;
-    symbol?: string;
-    chainId?: CaipChainId;
-};
-export type GetAvailableDexsParams = {};
-export type GetMarketsParams = {
-    symbols?: string[];
-    dex?: string;
-    skipFilters?: boolean;
-    readOnly?: boolean;
-};
-export type SubscribePricesParams = {
-    symbols: string[];
-    callback: (prices: PriceUpdate[]) => void;
-    throttleMs?: number;
-    includeOrderBook?: boolean;
-    includeMarketData?: boolean;
-};
-export type SubscribePositionsParams = {
-    callback: (positions: Position[]) => void;
-    accountId?: CaipAccountId;
-    includeHistory?: boolean;
-};
-export type SubscribeOrderFillsParams = {
-    callback: (fills: OrderFill[], isSnapshot?: boolean) => void;
-    accountId?: CaipAccountId;
-    since?: number;
-};
-export type SubscribeOrdersParams = {
-    callback: (orders: Order[]) => void;
-    accountId?: CaipAccountId;
-    includeHistory?: boolean;
-};
-export type SubscribeAccountParams = {
-    callback: (account: AccountState) => void;
-    accountId?: CaipAccountId;
-};
-export type SubscribeOICapsParams = {
-    callback: (caps: string[]) => void;
-    accountId?: CaipAccountId;
-};
-export type SubscribeCandlesParams = {
-    symbol: string;
-    interval: CandlePeriod;
-    duration?: TimeDuration;
-    callback: (data: CandleData) => void;
-    onError?: (error: Error) => void;
-};
-/**
- * Single price level in the order book
- */
-export type OrderBookLevel = {
-    /** Price at this level */
-    price: string;
-    /** Size at this level (in base asset) */
-    size: string;
-    /** Cumulative size up to and including this level */
-    total: string;
-    /** Notional value in USD */
-    notional: string;
-    /** Cumulative notional up to and including this level */
-    totalNotional: string;
-};
-/**
- * Full order book data with multiple price levels
- */
-export type OrderBookData = {
-    /** Bid levels (buy orders) - highest price first */
-    bids: OrderBookLevel[];
-    /** Ask levels (sell orders) - lowest price first */
-    asks: OrderBookLevel[];
-    /** Spread between best bid and best ask */
-    spread: string;
-    /** Spread as a percentage of mid price */
-    spreadPercentage: string;
-    /** Mid price (average of best bid and best ask) */
-    midPrice: string;
-    /** Timestamp of last update */
-    lastUpdated: number;
-    /** Maximum total size across all levels (for scaling depth bars) */
-    maxTotal: string;
-};
-export type SubscribeOrderBookParams = {
-    /** Symbol to subscribe to (e.g., 'BTC', 'ETH') */
-    symbol: string;
-    /** Number of levels to return per side (default: 10) */
-    levels?: number;
-    /** Price aggregation significant figures (2-5, default: 5). Higher = finer granularity */
-    nSigFigs?: 2 | 3 | 4 | 5;
-    /** Mantissa for aggregation when nSigFigs is 5 (2 or 5). Controls finest price increments */
-    mantissa?: 2 | 5;
-    /** Callback function receiving order book updates */
-    callback: (orderBook: OrderBookData) => void;
-    /** Callback for errors */
-    onError?: (error: Error) => void;
-};
-export type LiquidationPriceParams = {
-    entryPrice: number;
-    leverage: number;
-    direction: 'long' | 'short';
-    positionSize?: number;
-    marginType?: 'isolated' | 'cross';
-    asset?: string;
-};
-export type MaintenanceMarginParams = {
-    asset: string;
-    positionSize?: number;
-};
-export type FeeCalculationParams = {
-    orderType: 'market' | 'limit';
-    isMaker?: boolean;
-    amount?: string;
-    symbol: string;
-};
-export type FeeCalculationResult = {
-    feeRate?: number;
-    feeAmount?: number;
-    protocolFeeRate?: number;
-    protocolFeeAmount?: number;
-    metamaskFeeRate?: number;
-    metamaskFeeAmount?: number;
-    breakdown?: {
-        baseFeeRate: number;
-        volumeTier?: string;
-        volumeDiscount?: number;
-        stakingDiscount?: number;
-    };
-};
-export type UpdatePositionTPSLParams = {
-    symbol: string;
-    takeProfitPrice?: string;
-    stopLossPrice?: string;
-    trackingData?: TPSLTrackingData;
-    providerId?: PerpsProviderType;
-};
-export type Order = {
-    orderId: string;
-    symbol: string;
-    side: 'buy' | 'sell';
-    orderType: OrderType;
-    size: string;
-    originalSize: string;
-    price: string;
-    filledSize: string;
-    remainingSize: string;
-    status: 'open' | 'filled' | 'canceled' | 'rejected' | 'triggered' | 'queued';
-    timestamp: number;
-    lastUpdated?: number;
-    takeProfitPrice?: string;
-    stopLossPrice?: string;
-    stopLossOrderId?: string;
-    takeProfitOrderId?: string;
-    detailedOrderType?: string;
-    isTrigger?: boolean;
-    reduceOnly?: boolean;
-    triggerPrice?: string;
-    providerId?: PerpsProviderType;
-};
-export type Funding = {
-    symbol: string;
-    amountUsd: string;
-    rate: string;
-    timestamp: number;
-    transactionHash?: string;
-};
-export type PerpsProvider = {
-    readonly protocolId: string;
-    getDepositRoutes(params?: GetSupportedPathsParams): AssetRoute[];
-    getWithdrawalRoutes(params?: GetSupportedPathsParams): AssetRoute[];
-    placeOrder(params: OrderParams): Promise<OrderResult>;
-    editOrder(params: EditOrderParams): Promise<OrderResult>;
-    cancelOrder(params: CancelOrderParams): Promise<CancelOrderResult>;
-    cancelOrders?(params: BatchCancelOrdersParams): Promise<CancelOrdersResult>;
-    closePosition(params: ClosePositionParams): Promise<OrderResult>;
-    closePositions?(params: ClosePositionsParams): Promise<ClosePositionsResult>;
-    updatePositionTPSL(params: UpdatePositionTPSLParams): Promise<OrderResult>;
-    updateMargin(params: UpdateMarginParams): Promise<MarginResult>;
-    getPositions(params?: GetPositionsParams): Promise<Position[]>;
-    getAccountState(params?: GetAccountStateParams): Promise<AccountState>;
-    getMarkets(params?: GetMarketsParams): Promise<MarketInfo[]>;
-    getMarketDataWithPrices(): Promise<PerpsMarketData[]>;
-    withdraw(params: WithdrawParams): Promise<WithdrawResult>;
-    validateDeposit(params: DepositParams): Promise<{
-        isValid: boolean;
-        error?: string;
-    }>;
-    validateOrder(params: OrderParams): Promise<{
-        isValid: boolean;
-        error?: string;
-    }>;
-    validateClosePosition(params: ClosePositionParams): Promise<{
-        isValid: boolean;
-        error?: string;
-    }>;
-    validateWithdrawal(params: WithdrawParams): Promise<{
-        isValid: boolean;
-        error?: string;
-    }>;
-    /**
-     * Historical trade fills - actual executed trades with exact prices and fees.
-     * Purpose: Track what actually happened when orders were executed.
-     * Example: Market long 1 ETH @ $50,000 → OrderFill with exact execution price and fees
-     */
-    getOrderFills(params?: GetOrderFillsParams): Promise<OrderFill[]>;
-    /**
-     * Get historical portfolio data.
-     * Purpose: Retrieve account value from previous periods for PnL tracking
-     * Example: Get account value from yesterday to calculate 24h percentage change
-     *
-     * @param params - Optional parameters for historical portfolio retrieval
-     */
-    getHistoricalPortfolio(params?: GetHistoricalPortfolioParams): Promise<HistoricalPortfolioResult>;
-    /**
-     * Historical order lifecycle - order placement, modifications, and status changes.
-     * Purpose: Track the complete journey of orders from request to completion.
-     * Example: Limit buy 1 ETH @ $48,000 → Order with status 'open' → 'filled' when executed
-     */
-    getOrders(params?: GetOrdersParams): Promise<Order[]>;
-    /**
-     * Currently active open orders (real-time status).
-     * Purpose: Show orders that are currently open/pending execution (not historical states).
-     * Different from getOrders() which returns complete historical order lifecycle.
-     * Example: Shows only orders that are actually open right now in the exchange.
-     */
-    getOpenOrders(params?: GetOrdersParams): Promise<Order[]>;
-    /**
-     * Historical funding payments - periodic costs/rewards for holding positions.
-     * Purpose: Track ongoing expenses and income from position maintenance.
-     * Example: Holding long ETH position → Funding payment of -$5.00 (you pay the funding)
-     */
-    getFunding(params?: GetFundingParams): Promise<Funding[]>;
-    /**
-     * Get user non-funding ledger updates (deposits, transfers, withdrawals)
-     */
-    getUserNonFundingLedgerUpdates(params?: {
-        accountId?: string;
-        startTime?: number;
-        endTime?: number;
-    }): Promise<RawHyperLiquidLedgerUpdate[]>;
-    /**
-     * Get user history (deposits, withdrawals, transfers)
-     */
-    getUserHistory(params?: {
-        accountId?: CaipAccountId;
-        startTime?: number;
-        endTime?: number;
-    }): Promise<UserHistoryItem[]>;
-    calculateLiquidationPrice(params: LiquidationPriceParams): Promise<string>;
-    calculateMaintenanceMargin(params: MaintenanceMarginParams): Promise<number>;
-    getMaxLeverage(asset: string): Promise<number>;
-    calculateFees(params: FeeCalculationParams): Promise<FeeCalculationResult>;
-    subscribeToPrices(params: SubscribePricesParams): () => void;
-    subscribeToPositions(params: SubscribePositionsParams): () => void;
-    subscribeToOrderFills(params: SubscribeOrderFillsParams): () => void;
-    subscribeToOrders(params: SubscribeOrdersParams): () => void;
-    subscribeToAccount(params: SubscribeAccountParams): () => void;
-    subscribeToOICaps(params: SubscribeOICapsParams): () => void;
-    subscribeToCandles(params: SubscribeCandlesParams): () => void;
-    subscribeToOrderBook(params: SubscribeOrderBookParams): () => void;
-    setLiveDataConfig(config: Partial<LiveDataConfig>): void;
-    toggleTestnet(): Promise<ToggleTestnetResult>;
-    initialize(): Promise<InitializeResult>;
-    isReadyToTrade(): Promise<ReadyToTradeResult>;
-    disconnect(): Promise<DisconnectResult>;
-    ping(timeoutMs?: number): Promise<void>;
-    getWebSocketConnectionState?(): WebSocketConnectionState;
-    subscribeToConnectionState?(listener: (state: WebSocketConnectionState, reconnectionAttempt: number) => void): () => void;
-    reconnect?(): Promise<void>;
-    getBlockExplorerUrl(address?: string): string;
-    setUserFeeDiscount?(discountBips: number | undefined): void;
-    /**
-     * Get list of available HIP-3 builder-deployed DEXs.
-     *
-     * @param params - Optional parameters (reserved for future filters/pagination)
-     * @returns Array of DEX names (empty string '' represents main DEX)
-     */
-    getAvailableDexs?(params?: GetAvailableDexsParams): Promise<string[]>;
-};
-/**
- * Provider identifier type for multi-provider support.
- * Add new providers here as they are implemented.
- */
-export type PerpsProviderType = 'hyperliquid' | 'myx';
-/**
- * Active provider mode for PerpsController state.
- * - Direct providers: 'hyperliquid', 'myx'
- * - 'aggregated': Multi-provider aggregation mode
- */
-export type PerpsActiveProviderMode = PerpsProviderType | 'aggregated';
-/**
- * Aggregation mode for read operations.
- * - 'all': Aggregate data from all registered providers
- * - 'active': Only aggregate from providers with active connections
- * - 'specific': Aggregate from a specific subset of providers
- */
-export type AggregationMode = 'all' | 'active' | 'specific';
-/**
- * Routing strategy for write operations.
- * Phase 1 only supports 'default_provider' - advanced strategies deferred to Phase 3.
- */
-export type RoutingStrategy = 'default_provider';
-/**
- * Configuration for AggregatedPerpsProvider
- */
-export type AggregatedProviderConfig = {
-    /** Map of provider ID to provider instance */
-    providers: Map<PerpsProviderType, PerpsProvider>;
-    /** Default provider for write operations when providerId not specified */
-    defaultProvider: PerpsProviderType;
-    /** Aggregation mode for read operations (default: 'all') */
-    aggregationMode?: AggregationMode;
-    /** Platform dependencies for logging, metrics, etc. */
-    infrastructure: PerpsPlatformDependencies;
-};
-/**
- * Provider-specific error with context for multi-provider error handling
- */
-export type ProviderError = {
-    /** Which provider the error originated from */
-    providerId: PerpsProviderType;
-    /** Human-readable error message */
-    message: string;
-    /** Original error object if available */
-    originalError?: Error;
-    /** Whether the operation can be retried */
-    isRetryable?: boolean;
-};
-/**
- * Aggregated account state combining data from multiple providers
- */
-export type AggregatedAccountState = {
-    /** Combined totals across all providers */
-    total: AccountState;
-    /** Per-provider breakdown */
-    byProvider: Map<PerpsProviderType, AccountState>;
-};
-/**
- * Injectable logger interface for error reporting.
- * Allows core package to be platform-agnostic (mobile: Sentry, extension: different impl)
- */
-export type PerpsLogger = {
-    error(error: Error, options?: {
-        tags?: Record<string, string | number>;
-        context?: {
-            name: string;
-            data: Record<string, unknown>;
-        };
-        extras?: Record<string, unknown>;
-    }): void;
-};
-/**
- * Analytics events specific to Perps feature.
- * These are the actual event names sent to analytics backend.
- * Values must match the corresponding MetaMetricsEvents values in mobile for compatibility.
- *
- * When migrating to core monorepo, this enum travels with PerpsController.
- */
-export declare enum PerpsAnalyticsEvent {
-    WithdrawalTransaction = "Perp Withdrawal Transaction",
-    TradeTransaction = "Perp Trade Transaction",
-    PositionCloseTransaction = "Perp Position Close Transaction",
-    OrderCancelTransaction = "Perp Order Cancel Transaction",
-    ScreenViewed = "Perp Screen Viewed",
-    UiInteraction = "Perp UI Interaction",
-    RiskManagement = "Perp Risk Management",
-    PerpsError = "Perp Error"
-}
-/**
- * Perps-specific trace names. These must match TraceName enum values in mobile.
- * When in core monorepo, this defines the valid trace names for Perps operations.
- */
-export type PerpsTraceName = 'Perps Open Position' | 'Perps Close Position' | 'Perps Deposit' | 'Perps Withdraw' | 'Perps Place Order' | 'Perps Edit Order' | 'Perps Cancel Order' | 'Perps Update TP/SL' | 'Perps Update Margin' | 'Perps Flip Position' | 'Perps Order Submission Toast' | 'Perps Market Data Update' | 'Perps Order View' | 'Perps Tab View' | 'Perps Market List View' | 'Perps Position Details View' | 'Perps Adjust Margin View' | 'Perps Order Details View' | 'Perps Order Book View' | 'Perps Flip Position Sheet' | 'Perps Transactions View' | 'Perps Order Fills Fetch' | 'Perps Orders Fetch' | 'Perps Funding Fetch' | 'Perps Get Positions' | 'Perps Get Account State' | 'Perps Get Historical Portfolio' | 'Perps Get Markets' | 'Perps Fetch Historical Candles' | 'Perps WebSocket Connected' | 'Perps WebSocket Disconnected' | 'Perps WebSocket First Positions' | 'Perps WebSocket First Orders' | 'Perps WebSocket First Account' | 'Perps Data Lake Report' | 'Perps Rewards API Call' | 'Perps Close Position View' | 'Perps Withdraw View' | 'Perps Connection Establishment' | 'Perps Account Switch Reconnection';
-/**
- * Perps trace name constants. Values match TraceName enum in mobile.
- * When in core, these ARE the source of truth - mobile will re-export from core.
- */
-export declare const PerpsTraceNames: {
-    readonly PlaceOrder: "Perps Place Order";
-    readonly EditOrder: "Perps Edit Order";
-    readonly CancelOrder: "Perps Cancel Order";
-    readonly ClosePosition: "Perps Close Position";
-    readonly UpdateTpsl: "Perps Update TP/SL";
-    readonly UpdateMargin: "Perps Update Margin";
-    readonly FlipPosition: "Perps Flip Position";
-    readonly Withdraw: "Perps Withdraw";
-    readonly Deposit: "Perps Deposit";
-    readonly GetPositions: "Perps Get Positions";
-    readonly GetAccountState: "Perps Get Account State";
-    readonly GetMarkets: "Perps Get Markets";
-    readonly OrderFillsFetch: "Perps Order Fills Fetch";
-    readonly OrdersFetch: "Perps Orders Fetch";
-    readonly FundingFetch: "Perps Funding Fetch";
-    readonly GetHistoricalPortfolio: "Perps Get Historical Portfolio";
-    readonly FetchHistoricalCandles: "Perps Fetch Historical Candles";
-    readonly DataLakeReport: "Perps Data Lake Report";
-    readonly WebsocketConnected: "Perps WebSocket Connected";
-    readonly WebsocketDisconnected: "Perps WebSocket Disconnected";
-    readonly WebsocketFirstPositions: "Perps WebSocket First Positions";
-    readonly WebsocketFirstOrders: "Perps WebSocket First Orders";
-    readonly WebsocketFirstAccount: "Perps WebSocket First Account";
-    readonly RewardsApiCall: "Perps Rewards API Call";
-    readonly ConnectionEstablishment: "Perps Connection Establishment";
-    readonly AccountSwitchReconnection: "Perps Account Switch Reconnection";
-};
-/**
- * Perps trace operation constants. Values match TraceOperation enum in mobile.
- * These categorize traces by type of operation for Sentry/observability filtering.
- */
-export declare const PerpsTraceOperations: {
-    readonly Operation: "perps.operation";
-    readonly OrderSubmission: "perps.order_submission";
-    readonly PositionManagement: "perps.position_management";
-    readonly MarketData: "perps.market_data";
-};
-/**
- * Values allowed in trace data/tags. Matches Sentry's TraceValue type.
- */
-export type PerpsTraceValue = string | number | boolean;
-/**
- * Properties allowed in analytics events. More constrained than unknown.
- * Named PerpsAnalyticsProperties to avoid conflict with PerpsEventProperties
- * constant object from eventNames.ts (which contains property key names).
- */
-export type PerpsAnalyticsProperties = Record<string, string | number | boolean | null | undefined>;
-/**
- * Injectable metrics interface for analytics.
- * Allows core package to work with different analytics backends.
- */
-export type PerpsMetrics = {
-    isEnabled(): boolean;
-    /**
-     * Track a Perps-specific analytics event with properties.
-     * This abstracts away the MetricsEventBuilder pattern used in mobile.
-     *
-     * @param event - The Perps analytics event type (enum with actual event name values)
-     * @param properties - Type-safe key-value properties to attach to the event
-     */
-    trackPerpsEvent(event: PerpsAnalyticsEvent, properties: PerpsAnalyticsProperties): void;
-};
-/**
- * Injectable debug logger for development logging.
- * Only logs in development mode.
- * Accepts `unknown` to allow logging error objects from catch blocks.
- */
-export type PerpsDebugLogger = {
-    log(...args: unknown[]): void;
-};
-/**
- * Injectable stream manager interface for pause/resume during critical operations.
- *
- * WHY THIS IS NEEDED:
- * PerpsStreamManager is a React-based mobile-specific singleton that:
- * - Uses React Context for subscription management
- * - Uses react-native-performance for tracing
- * - Directly accesses Engine.context (mobile singleton pattern)
- * - Manages WebSocket connections with throttling/caching
- *
- * PerpsController only needs pause/resume during critical operations (withStreamPause method)
- * to prevent stale UI updates during batch operations. The minimal interface allows:
- * - Mobile: Wrap existing singleton (streamManager[channel].pause())
- * - Extension: Implement with whatever streaming solution they use
- */
-export type PerpsStreamManager = {
-    pauseChannel(channel: string): void;
-    resumeChannel(channel: string): void;
-    clearAllChannels(): void;
-};
-/**
- * Injectable performance monitor interface.
- * Wraps react-native-performance or browser Performance API.
- */
-export type PerpsPerformance = {
-    now(): number;
-};
-/**
- * Injectable tracer interface for Sentry/observability tracing.
- * Services use this to create spans and measure operation durations.
- *
- * Note: trace() returns void because services use name/id pairs to identify traces.
- * The actual span management is handled internally by the platform adapter.
- */
-export type PerpsTracer = {
-    trace(params: {
-        name: PerpsTraceName;
-        id: string;
-        op: string;
-        tags?: Record<string, PerpsTraceValue>;
-        data?: Record<string, PerpsTraceValue>;
-    }): void;
-    endTrace(params: {
-        name: PerpsTraceName;
-        id: string;
-        data?: Record<string, PerpsTraceValue>;
-    }): void;
-    setMeasurement(name: string, value: number, unit: string): void;
-};
-/**
- * Injectable keyring controller interface for signing operations.
- * Allows services to sign typed messages without directly accessing Engine.
- */
-export type PerpsKeyringController = {
-    signTypedMessage(msgParams: {
-        from: string;
-        data: unknown;
-    }, version: string): Promise<string>;
-};
-/**
- * Injectable account utilities interface.
- * Provides access to selected account without coupling to Engine singleton.
- */
-export type PerpsAccountUtils = {
-    getSelectedEvmAccount(): {
-        address: string;
-    } | undefined;
-    formatAccountToCaipId(address: string, chainId: string): string | null;
-};
-/**
- * Network controller operations required by Perps.
- * Provides chain ID lookups and network client identification.
- */
-export type PerpsNetworkOperations = {
-    /**
-     * Get the chain ID for a given network client.
-     */
-    getChainIdForNetwork(networkClientId: string): Hex;
-    /**
-     * Find the network client ID for a given chain.
-     */
-    findNetworkClientIdForChain(chainId: Hex): string | undefined;
-    /**
-     * Get the currently selected network client ID.
-     */
-    getSelectedNetworkClientId(): string;
-};
-/**
- * Transaction controller operations required by Perps.
- * Provides transaction submission capabilities.
- */
-export type PerpsTransactionOperations = {
-    /**
-     * Submit a transaction to the blockchain.
-     * Returns the result promise and transaction metadata.
-     */
-    submit(txParams: {
-        from: string;
-        to?: string;
-        value?: string;
-        data?: string;
-    }, options: {
-        networkClientId: string;
-        origin?: string;
-        type?: string;
-        skipInitialGasEstimate?: boolean;
-        gasFeeToken?: Hex;
-    }): Promise<{
-        result: Promise<string>;
-        transactionMeta: {
-            id: string;
-            hash?: string;
-        };
-    }>;
-};
-/**
- * Rewards controller operations required by Perps (optional).
- * Provides fee discount capabilities for MetaMask rewards program.
- */
-export type PerpsRewardsOperations = {
-    /**
-     * Get fee discount for an account.
-     * Returns discount in basis points (e.g., 6500 = 65% discount)
-     */
-    getFeeDiscount(caipAccountId: `${string}:${string}:${string}`): Promise<number>;
-};
-/**
- * Authentication controller operations required by Perps (optional).
- * Provides bearer token access for authenticated API calls.
- */
-export type PerpsAuthenticationOperations = {
-    /**
-     * Get a bearer token for authenticated API requests.
-     */
-    getBearerToken(): Promise<string>;
-};
-/**
- * Consolidated controller access interface.
- * Groups ALL controller dependencies in one place for clarity.
- *
- * Benefits:
- * 1. Clear separation: observability utilities vs controller access
- * 2. Consistent pattern: all controllers accessed via deps.controllers.*
- * 3. Mockable: test can mock entire controllers object
- * 4. Future-proof: add new controller access without bloating top-level
- */
-export type PerpsControllerAccess = {
-    /** Account utilities - wraps AccountsController access */
-    accounts: PerpsAccountUtils;
-    /** Keyring operations - wraps KeyringController for signing */
-    keyring: PerpsKeyringController;
-    /** Network operations - wraps NetworkController for chain lookups */
-    network: PerpsNetworkOperations;
-    /** Transaction operations - wraps TransactionController for TX submission */
-    transaction: PerpsTransactionOperations;
-    /** Rewards operations - wraps RewardsController for fee discounts */
-    rewards: PerpsRewardsOperations;
-    /** Authentication operations - wraps AuthenticationController for bearer tokens */
-    authentication: PerpsAuthenticationOperations;
-};
-/**
- * Combined platform dependencies for PerpsController and services.
- * All platform-specific dependencies are bundled here for easy injection.
- *
- * Architecture:
- * - Observability: logger, debugLogger, metrics, performance, tracer (stateless utilities)
- * - Platform: streamManager (mobile/extension specific capabilities)
- * - Controllers: consolidated access to all external controllers
- *
- * This interface enables dependency injection for platform-specific services,
- * allowing PerpsController to be moved to core without mobile-specific imports.
- */
-export type PerpsPlatformDependencies = {
-    logger: PerpsLogger;
-    debugLogger: PerpsDebugLogger;
-    metrics: PerpsMetrics;
-    performance: PerpsPerformance;
-    tracer: PerpsTracer;
-    streamManager: PerpsStreamManager;
-    controllers: PerpsControllerAccess;
-};
-//# sourceMappingURL=index.d.mts.map