@metamask-previews/perps-controller 13.1.0-preview-8c2a2eeb2 → 13.1.0-preview-4f4c98e

package/dist/PerpsController-method-action-types.d.cts

@@ -1,1163 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-import type { PerpsController } from "./PerpsController.cjs";
-/**
- * Read cached market data for the currently active provider (or aggregated).
- * Returns null when no valid cache exists or when cache has expired.
- *
- * @param options - Optional settings.
- * @param options.skipTTL - When true, bypass the 5-minute TTL check.
- * Used during initial render so disk-hydrated structural data (with
- * placeholder prices) is returned regardless of age.
- * @returns The cached market data array, or null if no valid cache.
- */
-export type PerpsControllerGetCachedMarketDataForActiveProviderAction = {
-    type: `PerpsController:getCachedMarketDataForActiveProvider`;
-    handler: PerpsController['getCachedMarketDataForActiveProvider'];
-};
-/**
- * Read cached user data for the currently active provider (or aggregated).
- * Returns null when no valid cache exists, cache has expired, or address
- * does not match the currently selected EVM account.
- *
- * @param options - Optional settings.
- * @param options.skipTTL - When true, bypass the 60s staleness check.
- * Used during initial render so disk-hydrated user data (positions/orders)
- * is returned regardless of age, avoiding a skeleton flash.
- * @returns The cached user data, or null if no valid cache.
- */
-export type PerpsControllerGetCachedUserDataForActiveProviderAction = {
-    type: `PerpsController:getCachedUserDataForActiveProvider`;
-    handler: PerpsController['getCachedUserDataForActiveProvider'];
-};
-/**
- * Fetch, validate, and atomically cache a complete user-data snapshot.
- * This remains callable after mount so consumers can seed their live channel
- * from one coherent positions/orders/account result.
- *
- * @returns The accepted user-data snapshot.
- */
-export type PerpsControllerGetUserDataSnapshotAction = {
-    type: `PerpsController:getUserDataSnapshot`;
-    handler: PerpsController['getUserDataSnapshot'];
-};
-/**
- * Initialize the PerpsController providers
- * Must be called before using any other methods
- * Prevents double initialization with promise caching
- *
- * @returns A promise that resolves when the operation completes.
- */
-export type PerpsControllerInitAction = {
-    type: `PerpsController:init`;
-    handler: PerpsController['init'];
-};
-/**
- * Get the currently active provider.
- * In aggregated mode, returns AggregatedPerpsProvider which routes to underlying providers.
- * In single provider mode, returns HyperLiquidProvider directly.
- *
- * @returns The active provider (aggregated wrapper or direct provider based on mode)
- * @throws Error if provider is not initialized or reinitializing
- */
-export type PerpsControllerGetActiveProviderAction = {
-    type: `PerpsController:getActiveProvider`;
-    handler: PerpsController['getActiveProvider'];
-};
-/**
- * Get the currently active provider, returning null if not available
- * Use this method when the caller can gracefully handle a missing provider
- * (e.g., UI components during initialization or reconnection)
- *
- * @returns The active provider, or null if not initialized/reinitializing
- */
-export type PerpsControllerGetActiveProviderOrNullAction = {
-    type: `PerpsController:getActiveProviderOrNull`;
-    handler: PerpsController['getActiveProviderOrNull'];
-};
-/**
- * Get strategy capabilities through the active provider route used by order
- * placement. The query waits for in-flight initialization and reports an
- * explicit unavailable status when no provider route can answer reliably.
- *
- * @param params - Market and optional provider route.
- * @returns Provider-owned order capabilities.
- */
-export type PerpsControllerGetOrderCapabilitiesAction = {
-    type: `PerpsController:getOrderCapabilities`;
-    handler: PerpsController['getOrderCapabilities'];
-};
-/**
- * Place a new order
- * Thin delegation to TradingService
- *
- * @param params - The operation parameters.
- * @returns The order result with order ID and status.
- */
-export type PerpsControllerPlaceOrderAction = {
-    type: `PerpsController:placeOrder`;
-    handler: PerpsController['placeOrder'];
-};
-/**
- * Edit an existing order
- * Thin delegation to TradingService
- *
- * @param params - The operation parameters.
- * @returns The updated order result with order ID and status.
- */
-export type PerpsControllerEditOrderAction = {
-    type: `PerpsController:editOrder`;
-    handler: PerpsController['editOrder'];
-};
-/**
- * Cancel an existing order
- *
- * @param params - The operation parameters.
- * @returns The cancellation result with status.
- */
-export type PerpsControllerCancelOrderAction = {
-    type: `PerpsController:cancelOrder`;
-    handler: PerpsController['cancelOrder'];
-};
-/**
- * Read venue-backed TWAP lifecycle records through the active provider.
- * Providers without native TWAP history return an empty list.
- *
- * @returns Current and terminal TWAP schedules with slice fills.
- */
-export type PerpsControllerGetTwapOrdersAction = {
-    type: `PerpsController:getTwapOrders`;
-    handler: PerpsController['getTwapOrders'];
-};
-/**
- * Read the active provider's retained Chase lifecycle snapshots.
- * Providers without an emulated Chase implementation return an empty list.
- *
- * @returns Current Chase session snapshots.
- */
-export type PerpsControllerGetChaseOrdersAction = {
-    type: `PerpsController:getChaseOrders`;
-    handler: PerpsController['getChaseOrders'];
-};
-/**
- * Stop Chase repricing for app backgrounding without cancelling the current
- * resting children.
- *
- * @returns Chase snapshots after suspension.
- * @throws If an aggregated provider cannot suspend every active venue. Other
- * providers may already be suspended; callers can retry to reconcile them.
- */
-export type PerpsControllerSuspendChaseOrdersAction = {
-    type: `PerpsController:suspendChaseOrders`;
-    handler: PerpsController['suspendChaseOrders'];
-};
-/**
- * Cancel multiple orders in parallel
- * Batch version of cancelOrder() that cancels multiple orders simultaneously
- *
- * @param params - The operation parameters.
- * @returns The batch cancellation results for each order.
- */
-export type PerpsControllerCancelOrdersAction = {
-    type: `PerpsController:cancelOrders`;
-    handler: PerpsController['cancelOrders'];
-};
-/**
- * Close a position (partial or full)
- * Thin delegation to TradingService
- *
- * @param params - The operation parameters.
- * @returns The order result from the close position request.
- */
-export type PerpsControllerClosePositionAction = {
-    type: `PerpsController:closePosition`;
-    handler: PerpsController['closePosition'];
-};
-/**
- * Close multiple positions in parallel
- * Batch version of closePosition() that closes multiple positions simultaneously
- *
- * @param params - The operation parameters.
- * @returns The batch close results for each position.
- */
-export type PerpsControllerClosePositionsAction = {
-    type: `PerpsController:closePositions`;
-    handler: PerpsController['closePositions'];
-};
-/**
- * Update TP/SL for an existing position
- *
- * @param params - The operation parameters.
- * @returns The order result from the TP/SL update.
- */
-export type PerpsControllerUpdatePositionTPSLAction = {
-    type: `PerpsController:updatePositionTPSL`;
-    handler: PerpsController['updatePositionTPSL'];
-};
-/**
- * Update margin for an existing position (add or remove)
- *
- * @param params - The operation parameters.
- * @returns The margin update result.
- */
-export type PerpsControllerUpdateMarginAction = {
-    type: `PerpsController:updateMargin`;
-    handler: PerpsController['updateMargin'];
-};
-/**
- * Flip position (reverse direction while keeping size and leverage)
- *
- * @param params - The operation parameters.
- * @returns The order result from the position flip.
- */
-export type PerpsControllerFlipPositionAction = {
-    type: `PerpsController:flipPosition`;
-    handler: PerpsController['flipPosition'];
-};
-/**
- * Simplified deposit method that prepares transaction for confirmation screen
- * No complex state tracking - just sets a loading flag
- *
- * @param params - Parameters for the deposit flow
- * @param params.amount - Optional deposit amount
- * @param params.placeOrder - If true, uses addTransaction instead of submit to avoid navigation
- * @returns An object containing a promise that resolves to the transaction hash.
- */
-export type PerpsControllerDepositWithConfirmationAction = {
-    type: `PerpsController:depositWithConfirmation`;
-    handler: PerpsController['depositWithConfirmation'];
-};
-/**
- * Same as depositWithConfirmation - prepares transaction for confirmation screen.
- *
- * @returns A promise that resolves to the string result.
- */
-export type PerpsControllerDepositWithOrderAction = {
-    type: `PerpsController:depositWithOrder`;
-    handler: PerpsController['depositWithOrder'];
-};
-/**
- * Clear the last deposit result after it has been shown to the user
- */
-export type PerpsControllerClearDepositResultAction = {
-    type: `PerpsController:clearDepositResult`;
-    handler: PerpsController['clearDepositResult'];
-};
-export type PerpsControllerClearWithdrawResultAction = {
-    type: `PerpsController:clearWithdrawResult`;
-    handler: PerpsController['clearWithdrawResult'];
-};
-/**
- * Update withdrawal request status when it completes, or remove it on failure.
- * This is called when a withdrawal is matched with a completed withdrawal from the API.
- * When status is `failed`, the request is removed from the queue (not retained).
- *
- * @param withdrawalId - The withdrawal transaction ID.
- * @param status - The current status.
- * @param txHash - The transaction hash.
- */
-export type PerpsControllerUpdateWithdrawalStatusAction = {
-    type: `PerpsController:updateWithdrawalStatus`;
-    handler: PerpsController['updateWithdrawalStatus'];
-};
-/**
- * Complete a specific withdrawal detected via transaction history polling (FIFO queue).
- * Called when a completed withdrawal appears in the transaction history matching a pending request.
- *
- * Uses FIFO matching: oldest pending withdrawal is matched with first completed withdrawal
- * in history that happened after its submission time.
- *
- * @param withdrawalRequestId - The ID of the pending withdrawal request to mark as complete.
- * @param completedWithdrawal - The completed withdrawal data from the history API.
- * @param completedWithdrawal.txHash - The on-chain transaction hash.
- * @param completedWithdrawal.amount - The withdrawal amount.
- * @param completedWithdrawal.timestamp - The completion timestamp from the history API.
- * @param completedWithdrawal.asset - The asset symbol (e.g. USDC).
- */
-export type PerpsControllerCompleteWithdrawalFromHistoryAction = {
-    type: `PerpsController:completeWithdrawalFromHistory`;
-    handler: PerpsController['completeWithdrawalFromHistory'];
-};
-/**
- * Update withdrawal progress (persistent across navigation)
- *
- * @param progress - The progress indicator.
- * @param activeWithdrawalId - The active withdrawal ID.
- */
-export type PerpsControllerUpdateWithdrawalProgressAction = {
-    type: `PerpsController:updateWithdrawalProgress`;
-    handler: PerpsController['updateWithdrawalProgress'];
-};
-/**
- * Get current withdrawal progress
- *
- * @returns The withdrawal progress, last update timestamp, and active withdrawal ID.
- */
-export type PerpsControllerGetWithdrawalProgressAction = {
-    type: `PerpsController:getWithdrawalProgress`;
-    handler: PerpsController['getWithdrawalProgress'];
-};
-/**
- * Withdraw funds from trading account
- *
- * The withdrawal process varies by provider and may involve:
- * - Direct on-chain transfers
- * - Bridge operations
- * - Multi-step validation processes
- *
- * Check the specific provider documentation for detailed withdrawal flows.
- *
- * @param params Withdrawal parameters
- * @returns WithdrawResult with withdrawal ID and tracking info
- */
-export type PerpsControllerWithdrawAction = {
-    type: `PerpsController:withdraw`;
-    handler: PerpsController['withdraw'];
-};
-/**
- * Get current positions
- * Thin delegation to MarketDataService
- *
- * For standalone mode, bypasses getActiveProvider() to allow position queries
- * without full perps initialization (e.g., for showing positions on token details page)
- *
- * @param params - The operation parameters.
- * @returns Array of open positions for the active provider.
- */
-export type PerpsControllerGetPositionsAction = {
-    type: `PerpsController:getPositions`;
-    handler: PerpsController['getPositions'];
-};
-/**
- * Get historical user fills (trade executions)
- * Thin delegation to MarketDataService
- *
- * @param params - The operation parameters.
- * @param options - Optional call modifiers.
- * @param options.forceRefresh - Bypass the request-coalesce cache
- * end-to-end (user-initiated refresh).
- * @returns Array of historical trade executions (fills).
- */
-export type PerpsControllerGetOrderFillsAction = {
-    type: `PerpsController:getOrderFills`;
-    handler: PerpsController['getOrderFills'];
-};
-/**
- * Get historical user orders (order lifecycle)
- * Thin delegation to MarketDataService
- *
- * @param params - The operation parameters.
- * @param options - Optional call modifiers.
- * @param options.forceRefresh - Bypass the request-coalesce cache
- * end-to-end (user-initiated refresh).
- * @returns Array of historical orders.
- */
-export type PerpsControllerGetOrdersAction = {
-    type: `PerpsController:getOrders`;
-    handler: PerpsController['getOrders'];
-};
-/**
- * Get currently open orders (real-time status)
- * Thin delegation to MarketDataService
- *
- * For standalone mode, bypasses getActiveProvider() to allow open order queries
- * without full perps initialization (e.g., for background preloading)
- *
- * @param params - The operation parameters.
- * @returns A promise that resolves to the result.
- */
-export type PerpsControllerGetOpenOrdersAction = {
-    type: `PerpsController:getOpenOrders`;
-    handler: PerpsController['getOpenOrders'];
-};
-/**
- * Get historical user funding history (funding payments)
- * Thin delegation to MarketDataService
- *
- * @param params - The operation parameters.
- * @param options - Optional call modifiers.
- * @param options.forceRefresh - Bypass the request-coalesce cache
- * end-to-end (user-initiated refresh).
- * @returns Array of historical funding payments.
- */
-export type PerpsControllerGetFundingAction = {
-    type: `PerpsController:getFunding`;
-    handler: PerpsController['getFunding'];
-};
-/**
- * Get account state (balances, etc.)
- * Thin delegation to MarketDataService
- *
- * For standalone mode, bypasses getActiveProvider() to allow account state queries
- * without full perps initialization (e.g., for checking if user has perps funds)
- *
- * @param params - The operation parameters.
- * @returns A promise that resolves to the result.
- */
-export type PerpsControllerGetAccountStateAction = {
-    type: `PerpsController:getAccountState`;
-    handler: PerpsController['getAccountState'];
-};
-/**
- * Get historical portfolio data
- * Thin delegation to MarketDataService
- *
- * @param params - The operation parameters.
- * @returns The historical portfolio data points.
- */
-export type PerpsControllerGetHistoricalPortfolioAction = {
-    type: `PerpsController:getHistoricalPortfolio`;
-    handler: PerpsController['getHistoricalPortfolio'];
-};
-/**
- * Get available markets with optional filtering
- * Thin delegation to MarketDataService
- *
- * For standalone mode, bypasses getActiveProvider() to allow market discovery
- * without full perps initialization (e.g., for discovery banners on spot screens)
- *
- * @param params - The operation parameters.
- * @returns Array of available markets matching the filter criteria.
- */
-export type PerpsControllerGetMarketsAction = {
-    type: `PerpsController:getMarkets`;
-    handler: PerpsController['getMarkets'];
-};
-/**
- * Get market data with prices (includes price, volume, 24h change).
- * Optionally filter by category, sort, and limit the results.
- *
- * For standalone mode, bypasses getActiveProvider() to allow market data queries
- * without full perps initialization (e.g., for background preloading on app start)
- *
- * @param params - The operation parameters.
- * @param params.standalone - Whether to use standalone mode.
- * @param params.categories - Filter to markets matching any of these categories.
- * @param params.sortBy - Sort results by this field.
- * @param params.direction - Sort direction (default: desc).
- * @param params.limit - Maximum number of results to return.
- * @returns A promise that resolves to the market data.
- */
-export type PerpsControllerGetMarketDataWithPricesAction = {
-    type: `PerpsController:getMarketDataWithPrices`;
-    handler: PerpsController['getMarketDataWithPrices'];
-};
-/**
- * Start background market data preloading.
- * Fetches market data immediately and refreshes every 5 minutes.
- * Watches for isTestnet and hip3ConfigVersion changes to re-preload.
- */
-export type PerpsControllerStartMarketDataPreloadAction = {
-    type: `PerpsController:startMarketDataPreload`;
-    handler: PerpsController['startMarketDataPreload'];
-};
-/**
- * Stop background market data preloading.
- */
-export type PerpsControllerStopMarketDataPreloadAction = {
-    type: `PerpsController:stopMarketDataPreload`;
-    handler: PerpsController['stopMarketDataPreload'];
-};
-/**
- * Get list of available HIP-3 builder-deployed DEXs
- *
- * @param params - Optional parameters for filtering
- * @returns Array of DEX names
- */
-export type PerpsControllerGetAvailableDexsAction = {
-    type: `PerpsController:getAvailableDexs`;
-    handler: PerpsController['getAvailableDexs'];
-};
-/**
- * Fetch historical candle data
- * Thin delegation to MarketDataService
- *
- * @param options - The configuration options.
- * @param options.symbol - The trading pair symbol.
- * @param options.interval - The candle interval period.
- * @param options.limit - Maximum number of items to fetch.
- * @param options.endTime - End timestamp in milliseconds.
- * @returns The historical candle data for the requested symbol and interval.
- */
-export type PerpsControllerFetchHistoricalCandlesAction = {
-    type: `PerpsController:fetchHistoricalCandles`;
-    handler: PerpsController['fetchHistoricalCandles'];
-};
-/**
- * Calculate liquidation price for a position
- * Uses provider-specific formulas based on protocol rules
- *
- * @param params - The operation parameters.
- * @returns A promise that resolves to the string result.
- */
-export type PerpsControllerCalculateLiquidationPriceAction = {
-    type: `PerpsController:calculateLiquidationPrice`;
-    handler: PerpsController['calculateLiquidationPrice'];
-};
-/**
- * Calculate maintenance margin for a specific asset
- * Returns a percentage (e.g., 0.0125 for 1.25%)
- *
- * @param params - The operation parameters.
- * @returns A promise that resolves to the numeric result.
- */
-export type PerpsControllerCalculateMaintenanceMarginAction = {
-    type: `PerpsController:calculateMaintenanceMargin`;
-    handler: PerpsController['calculateMaintenanceMargin'];
-};
-/**
- * Get maximum leverage allowed for an asset
- *
- * @param asset - The asset identifier.
- * @returns A promise that resolves to the numeric result.
- */
-export type PerpsControllerGetMaxLeverageAction = {
-    type: `PerpsController:getMaxLeverage`;
-    handler: PerpsController['getMaxLeverage'];
-};
-/**
- * Validate order parameters according to protocol-specific rules
- *
- * @param params - The operation parameters.
- * @returns True if the condition is met.
- */
-export type PerpsControllerValidateOrderAction = {
-    type: `PerpsController:validateOrder`;
-    handler: PerpsController['validateOrder'];
-};
-/**
- * Validate close position parameters according to protocol-specific rules
- *
- * @param params - The operation parameters.
- * @returns A promise that resolves to the result.
- */
-export type PerpsControllerValidateClosePositionAction = {
-    type: `PerpsController:validateClosePosition`;
-    handler: PerpsController['validateClosePosition'];
-};
-/**
- * Validate withdrawal parameters according to protocol-specific rules
- *
- * @param params - The operation parameters.
- * @returns True if the condition is met.
- */
-export type PerpsControllerValidateWithdrawalAction = {
-    type: `PerpsController:validateWithdrawal`;
-    handler: PerpsController['validateWithdrawal'];
-};
-/**
- * Get supported withdrawal routes - returns complete asset and routing information
- *
- * @returns Array of supported asset routes for withdrawals.
- */
-export type PerpsControllerGetWithdrawalRoutesAction = {
-    type: `PerpsController:getWithdrawalRoutes`;
-    handler: PerpsController['getWithdrawalRoutes'];
-};
-/**
- * Set the transient UTM / discovery attribution context.
- * Replaces any previously set context. Held in-memory only — not persisted.
- *
- * @param context - The attribution context (UTM fields) to store.
- */
-export type PerpsControllerSetAttributionContextAction = {
-    type: `PerpsController:setAttributionContext`;
-    handler: PerpsController['setAttributionContext'];
-};
-/**
- * Get a copy of the current attribution context.
- *
- * @returns A shallow copy of the stored attribution context.
- */
-export type PerpsControllerGetAttributionContextAction = {
-    type: `PerpsController:getAttributionContext`;
-    handler: PerpsController['getAttributionContext'];
-};
-/**
- * Clear the stored attribution context.
- */
-export type PerpsControllerClearAttributionContextAction = {
-    type: `PerpsController:clearAttributionContext`;
-    handler: PerpsController['clearAttributionContext'];
-};
-/**
- * Toggle between testnet and mainnet
- *
- * @returns The toggle result with success status and current network mode.
- */
-export type PerpsControllerToggleTestnetAction = {
-    type: `PerpsController:toggleTestnet`;
-    handler: PerpsController['toggleTestnet'];
-};
-/**
- * Switch to a different provider
- * Uses a full reinit approach: disconnect() → update state → init()
- * This ensures complete state reset including WebSocket connections and caches.
- *
- * @param providerId - The provider identifier.
- * @returns The switch result with success status and active provider.
- */
-export type PerpsControllerSwitchProviderAction = {
-    type: `PerpsController:switchProvider`;
-    handler: PerpsController['switchProvider'];
-};
-/**
- * Get current network (mainnet/testnet)
- *
- * @returns Either 'mainnet' or 'testnet' based on the current configuration.
- */
-export type PerpsControllerGetCurrentNetworkAction = {
-    type: `PerpsController:getCurrentNetwork`;
-    handler: PerpsController['getCurrentNetwork'];
-};
-/**
- * Get the ordered list of all market categories for HIP-3 markets.
- * Returns a stable, explicitly ordered array so the UI can render
- * category filter tabs without deriving order from config insertion.
- *
- * @returns Ordered array of {@link MarketTypeFilter} values. Does not include the 'all' or 'new' sentinels — those are separate UI controls.
- */
-export type PerpsControllerGetMarketCategoriesAction = {
-    type: `PerpsController:getMarketCategories`;
-    handler: PerpsController['getMarketCategories'];
-};
-/**
- * Get the current WebSocket connection state from the active provider.
- * Used by the UI to monitor connection health and show notifications.
- *
- * @returns The current WebSocket connection state, or DISCONNECTED if not supported
- */
-export type PerpsControllerGetWebSocketConnectionStateAction = {
-    type: `PerpsController:getWebSocketConnectionState`;
-    handler: PerpsController['getWebSocketConnectionState'];
-};
-/**
- * Subscribe to WebSocket connection state changes from the active provider.
- * The listener will be called immediately with the current state and whenever the state changes.
- *
- * @param listener - Callback function that receives the new connection state and reconnection attempt
- * @returns Unsubscribe function to remove the listener, or no-op if not supported
- */
-export type PerpsControllerSubscribeToConnectionStateAction = {
-    type: `PerpsController:subscribeToConnectionState`;
-    handler: PerpsController['subscribeToConnectionState'];
-};
-/**
- * Manually trigger a WebSocket reconnection attempt.
- * Used by the UI retry button when connection is lost.
- */
-export type PerpsControllerReconnectAction = {
-    type: `PerpsController:reconnect`;
-    handler: PerpsController['reconnect'];
-};
-/**
- * Subscribe to live price updates
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToPricesAction = {
-    type: `PerpsController:subscribeToPrices`;
-    handler: PerpsController['subscribeToPrices'];
-};
-/**
- * Subscribe to live position updates
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToPositionsAction = {
-    type: `PerpsController:subscribeToPositions`;
-    handler: PerpsController['subscribeToPositions'];
-};
-/**
- * Subscribe to live order fill updates
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToOrderFillsAction = {
-    type: `PerpsController:subscribeToOrderFills`;
-    handler: PerpsController['subscribeToOrderFills'];
-};
-/**
- * Subscribe to live order updates
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToOrdersAction = {
-    type: `PerpsController:subscribeToOrders`;
-    handler: PerpsController['subscribeToOrders'];
-};
-/**
- * Subscribe to live account updates.
- * Updates controller state (Redux) when new account data arrives so consumers
- * like usePerpsBalanceTokenFilter (PayWithModal) see the latest balance.
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToAccountAction = {
-    type: `PerpsController:subscribeToAccount`;
-    handler: PerpsController['subscribeToAccount'];
-};
-/**
- * Subscribe to full order book updates with multiple depth levels
- * Creates a dedicated L2Book subscription for real-time order book data
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToOrderBookAction = {
-    type: `PerpsController:subscribeToOrderBook`;
-    handler: PerpsController['subscribeToOrderBook'];
-};
-/**
- * Subscribe to live candle updates
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToCandlesAction = {
-    type: `PerpsController:subscribeToCandles`;
-    handler: PerpsController['subscribeToCandles'];
-};
-/**
- * Subscribe to open interest cap updates
- * Zero additional network overhead - data comes from existing webData3 subscription
- *
- * @param params - The operation parameters.
- * @returns A cleanup function to remove the subscription.
- */
-export type PerpsControllerSubscribeToOICapsAction = {
-    type: `PerpsController:subscribeToOICaps`;
-    handler: PerpsController['subscribeToOICaps'];
-};
-/**
- * Configure live data throttling
- *
- * @param config - The configuration object.
- */
-export type PerpsControllerSetLiveDataConfigAction = {
-    type: `PerpsController:setLiveDataConfig`;
-    handler: PerpsController['setLiveDataConfig'];
-};
-/**
- * Calculate trading fees through the active provider route.
- * Each provider owns its fee policy. An explicit provider route overrides
- * the active/default provider used by placement.
- *
- * @param params - The operation parameters.
- * @returns The fee calculation result for the trade.
- */
-export type PerpsControllerCalculateFeesAction = {
-    type: `PerpsController:calculateFees`;
-    handler: PerpsController['calculateFees'];
-};
-/**
- * Approve the dedicated subscription builder outside order submission.
- * Until this succeeds, subscription waivers fall back to the ordinary
- * builder at the standard fee.
- *
- * @returns Whether the subscription builder is approved.
- */
-export type PerpsControllerApproveSubscriptionBuilderFeeAction = {
-    type: `PerpsController:approveSubscriptionBuilderFee`;
-    handler: PerpsController['approveSubscriptionBuilderFee'];
-};
-/**
- * Drop the cached subscription benefits snapshot.
- *
- * Call this when the identity behind the benefits changes — sign-out, or a
- * profile switch. The snapshot carries no profile identity of its own, so
- * without this it keeps answering for the previous profile until the next
- * successful refresh. The next fee resolution reports the waiver as
- * unavailable, so it is withheld until preview or lifecycle hydration.
- */
-export type PerpsControllerInvalidateSubscriptionBenefitsAction = {
-    type: `PerpsController:invalidateSubscriptionBenefits`;
-    handler: PerpsController['invalidateSubscriptionBenefits'];
-};
-/**
- * Disconnect provider and cleanup subscriptions
- * Call this when navigating away from Perps screens to prevent battery drain
- */
-export type PerpsControllerDisconnectAction = {
-    type: `PerpsController:disconnect`;
-    handler: PerpsController['disconnect'];
-};
-/**
- * Resume eligibility monitoring after onboarding completes.
- * Clears the deferred flag and triggers an immediate eligibility check
- * using the current remote feature flag state.
- */
-export type PerpsControllerStartEligibilityMonitoringAction = {
-    type: `PerpsController:startEligibilityMonitoring`;
-    handler: PerpsController['startEligibilityMonitoring'];
-};
-/**
- * Stops geo-blocking eligibility monitoring.
- * Call this when the user disables basic functionality (e.g. useExternalServices becomes false).
- * Prevents geolocation calls until startEligibilityMonitoring() is called again.
- * Safe to call multiple times.
- */
-export type PerpsControllerStopEligibilityMonitoringAction = {
-    type: `PerpsController:stopEligibilityMonitoring`;
-    handler: PerpsController['stopEligibilityMonitoring'];
-};
-export type PerpsControllerRefreshEligibilityAction = {
-    type: `PerpsController:refreshEligibility`;
-    handler: PerpsController['refreshEligibility'];
-};
-/**
- * Get block explorer URL for an address or just the base URL
- *
- * @param address - Optional address to append to the base URL
- * @returns Block explorer URL
- */
-export type PerpsControllerGetBlockExplorerUrlAction = {
-    type: `PerpsController:getBlockExplorerUrl`;
-    handler: PerpsController['getBlockExplorerUrl'];
-};
-/**
- * Check if user is first-time for the current network
- *
- * @returns True if the condition is met.
- */
-export type PerpsControllerIsFirstTimeUserOnCurrentNetworkAction = {
-    type: `PerpsController:isFirstTimeUserOnCurrentNetwork`;
-    handler: PerpsController['isFirstTimeUserOnCurrentNetwork'];
-};
-/**
- * Mark that the user has completed the tutorial/onboarding
- * This prevents the tutorial from showing again
- */
-export type PerpsControllerMarkTutorialCompletedAction = {
-    type: `PerpsController:markTutorialCompleted`;
-    handler: PerpsController['markTutorialCompleted'];
-};
-export type PerpsControllerMarkFirstOrderCompletedAction = {
-    type: `PerpsController:markFirstOrderCompleted`;
-    handler: PerpsController['markFirstOrderCompleted'];
-};
-/**
- * Reset first-time user state for both networks
- * This is useful for testing the tutorial flow
- * Called by Reset Account feature in settings
- */
-export type PerpsControllerResetFirstTimeUserStateAction = {
-    type: `PerpsController:resetFirstTimeUserState`;
-    handler: PerpsController['resetFirstTimeUserState'];
-};
-/**
- * Clear pending/bridging withdrawal and deposit requests
- * This is useful when users want to clear stuck pending indicators
- * Called by Reset Account feature in settings
- */
-export type PerpsControllerClearPendingTransactionRequestsAction = {
-    type: `PerpsController:clearPendingTransactionRequests`;
-    handler: PerpsController['clearPendingTransactionRequests'];
-};
-/**
- * Get saved trade configuration for a market
- *
- * @param symbol - The trading pair symbol.
- * @returns The resulting string value.
- */
-export type PerpsControllerGetTradeConfigurationAction = {
-    type: `PerpsController:getTradeConfiguration`;
-    handler: PerpsController['getTradeConfiguration'];
-};
-/**
- * Save trade configuration for a market
- *
- * @param symbol - Market symbol
- * @param leverage - Leverage value
- */
-export type PerpsControllerSaveTradeConfigurationAction = {
-    type: `PerpsController:saveTradeConfiguration`;
-    handler: PerpsController['saveTradeConfiguration'];
-};
-/**
- * Save pending trade configuration for a market
- * This is a temporary configuration that expires after 30 seconds.
- *
- * @param symbol - Market symbol
- * @param config - Pending trade configuration (includes optional selected payment token from Pay row)
- * @param config.amount - The amount value.
- * @param config.leverage - The leverage multiplier.
- * @param config.takeProfitPrice - The take profit price.
- * @param config.stopLossPrice - The stop loss price.
- * @param config.limitPrice - The limit price.
- * @param config.orderType - The order type.
- * @param config.reduceOnly - Whether the order may only reduce a position.
- * @param config.direction - Long or short.
- * @param config.selectedPaymentToken - The selected payment token.
- */
-export type PerpsControllerSavePendingTradeConfigurationAction = {
-    type: `PerpsController:savePendingTradeConfiguration`;
-    handler: PerpsController['savePendingTradeConfiguration'];
-};
-/**
- * Get pending trade configuration for a market
- * Returns undefined if config doesn't exist or has expired.
- *
- * @param symbol - Market symbol
- * @returns Pending trade configuration or undefined
- */
-export type PerpsControllerGetPendingTradeConfigurationAction = {
-    type: `PerpsController:getPendingTradeConfiguration`;
-    handler: PerpsController['getPendingTradeConfiguration'];
-};
-/**
- * Clear pending trade configuration for a market
- *
- * @param symbol - Market symbol
- */
-export type PerpsControllerClearPendingTradeConfigurationAction = {
-    type: `PerpsController:clearPendingTradeConfiguration`;
-    handler: PerpsController['clearPendingTradeConfiguration'];
-};
-/**
- * Get saved market filter preferences
- * Handles backward compatibility with legacy string format
- *
- * @returns The saved sort option ID and direction.
- */
-export type PerpsControllerGetMarketFilterPreferencesAction = {
-    type: `PerpsController:getMarketFilterPreferences`;
-    handler: PerpsController['getMarketFilterPreferences'];
-};
-/**
- * Save market filter preferences
- *
- * @param optionId - Sort/filter option ID
- * @param direction - Sort direction ('asc' or 'desc')
- */
-export type PerpsControllerSaveMarketFilterPreferencesAction = {
-    type: `PerpsController:saveMarketFilterPreferences`;
-    handler: PerpsController['saveMarketFilterPreferences'];
-};
-/**
- * Get the user's max slippage tolerance in basis points.
- *
- * @returns The configured max slippage bps, or undefined if never set (callers should default to 300 bps / 3%).
- */
-export type PerpsControllerGetMaxSlippageAction = {
-    type: `PerpsController:getMaxSlippage`;
-    handler: PerpsController['getMaxSlippage'];
-};
-/**
- * Set the user's max slippage tolerance in basis points.
- *
- * @param bps - Max slippage in basis points (e.g. 300 = 3%). Clamped to 10–1000, snapped to step of 10.
- */
-export type PerpsControllerSetMaxSlippageAction = {
-    type: `PerpsController:setMaxSlippage`;
-    handler: PerpsController['setMaxSlippage'];
-};
-/**
- * Get market-agnostic Pro order-book display preferences.
- *
- * @returns The current order-book display preferences.
- */
-export type PerpsControllerGetOrderBookPreferencesAction = {
-    type: `PerpsController:getOrderBookPreferences`;
-    handler: PerpsController['getOrderBookPreferences'];
-};
-/**
- * Update market-agnostic Pro order-book display preferences.
- *
- * @param patch - Partial order-book preferences to update.
- */
-export type PerpsControllerSetOrderBookPreferencesAction = {
-    type: `PerpsController:setOrderBookPreferences`;
-    handler: PerpsController['setOrderBookPreferences'];
-};
-/**
- * Get the selected order type shared by every market.
- *
- * @returns The selected order type.
- */
-export type PerpsControllerGetSelectedOrderTypeAction = {
-    type: `PerpsController:getSelectedOrderType`;
-    handler: PerpsController['getSelectedOrderType'];
-};
-/**
- * Set the selected order type shared by every market.
- *
- * @param orderType - The selected order type.
- */
-export type PerpsControllerSetSelectedOrderTypeAction = {
-    type: `PerpsController:setSelectedOrderType`;
-    handler: PerpsController['setSelectedOrderType'];
-};
-/**
- * Get the number of candles shown in Lite and Pro chart viewports.
- *
- * @returns The visible candle count.
- */
-export type PerpsControllerGetVisibleCandleCountAction = {
-    type: `PerpsController:getVisibleCandleCount`;
-    handler: PerpsController['getVisibleCandleCount'];
-};
-/**
- * Set the number of candles shown in Lite and Pro chart viewports.
- *
- * @param count - Requested visible candle count.
- */
-export type PerpsControllerSetVisibleCandleCountAction = {
-    type: `PerpsController:setVisibleCandleCount`;
-    handler: PerpsController['setVisibleCandleCount'];
-};
-/**
- * Get the user's pro-mode layout preferences (network-independent).
- *
- * @returns The current pro-mode layout preferences.
- */
-export type PerpsControllerGetProLayoutPreferencesAction = {
-    type: `PerpsController:getProLayoutPreferences`;
-    handler: PerpsController['getProLayoutPreferences'];
-};
-/**
- * Update the user's pro-mode layout preferences.
- *
- * Patch-style setter: only the provided fields are updated, the rest are
- * preserved. This keeps the signature stable as new layout fields are added.
- *
- * @param patch - Partial set of pro-mode layout preferences to update.
- */
-export type PerpsControllerSetProLayoutPreferencesAction = {
-    type: `PerpsController:setProLayoutPreferences`;
-    handler: PerpsController['setProLayoutPreferences'];
-};
-/**
- * Set the Perps interface mode (lite/pro).
- *
- * @param mode - The mode to switch to.
- */
-export type PerpsControllerSetPerpsModeAction = {
-    type: `PerpsController:setPerpsMode`;
-    handler: PerpsController['setPerpsMode'];
-};
-/**
- * Set the selected payment token for the Perps order/deposit flow.
- * Pass null or a token with description PERPS_CONSTANTS.PerpsBalanceTokenDescription to select Perps balance.
- * Only required fields (address, chainId) are stored in state; description and symbol are optional.
- *
- * @param token - The token identifier.
- */
-export type PerpsControllerSetSelectedPaymentTokenAction = {
-    type: `PerpsController:setSelectedPaymentToken`;
-    handler: PerpsController['setSelectedPaymentToken'];
-};
-/**
- * Reset the selected payment token to Perps balance (null).
- * Call when leaving the Perps order view so the next visit defaults to Perps balance.
- */
-export type PerpsControllerResetSelectedPaymentTokenAction = {
-    type: `PerpsController:resetSelectedPaymentToken`;
-    handler: PerpsController['resetSelectedPaymentToken'];
-};
-/**
- * Get saved order book grouping for a market
- *
- * @param symbol - Market symbol
- * @returns The saved grouping value or undefined if not set
- */
-export type PerpsControllerGetOrderBookGroupingAction = {
-    type: `PerpsController:getOrderBookGrouping`;
-    handler: PerpsController['getOrderBookGrouping'];
-};
-/**
- * Save order book grouping for a market
- *
- * @param symbol - Market symbol
- * @param grouping - Price grouping value
- */
-export type PerpsControllerSaveOrderBookGroupingAction = {
-    type: `PerpsController:saveOrderBookGrouping`;
-    handler: PerpsController['saveOrderBookGrouping'];
-};
-/**
- * Toggle watchlist status for a market.
- *
- * Updates local state immediately (optimistic UI) and then syncs the new
- * watchlist to AuthenticatedUserStorageService.  If the remote write fails,
- * the local state is reverted so it stays consistent with AUS.
- *
- * When the user is unauthenticated, or the active provider is not yet
- * supported by the AUS schema, the controller continues operating with
- * local-persisted state only — no error is surfaced to the caller.
- *
- * Watchlist markets are stored per network (testnet/mainnet).
- *
- * @param symbol - The trading pair symbol.
- */
-export type PerpsControllerToggleWatchlistMarketAction = {
-    type: `PerpsController:toggleWatchlistMarket`;
-    handler: PerpsController['toggleWatchlistMarket'];
-};
-/**
- * Check if a market is in the watchlist on the current network
- *
- * @param symbol - The trading pair symbol.
- * @returns True if the condition is met.
- */
-export type PerpsControllerIsWatchlistMarketAction = {
-    type: `PerpsController:isWatchlistMarket`;
-    handler: PerpsController['isWatchlistMarket'];
-};
-/**
- * Get all watchlist markets for the current network
- *
- * @returns The resulting string value.
- */
-export type PerpsControllerGetWatchlistMarketsAction = {
-    type: `PerpsController:getWatchlistMarkets`;
-    handler: PerpsController['getWatchlistMarkets'];
-};
-/**
- * Record that the user viewed a market.
- *
- * The symbol is prepended to the per-network recently-viewed list (newest-first).
- * Any existing entry for the same symbol is removed first so there are no
- * duplicates. The list is then capped at PERPS_CONSTANTS.RecentlyViewedMarketsLimit.
- *
- * @param symbol - The trading pair symbol (e.g. 'BTC', 'ETH', 'xyz:TSLA').
- */
-export type PerpsControllerRecordMarketViewedAction = {
-    type: `PerpsController:recordMarketViewed`;
-    handler: PerpsController['recordMarketViewed'];
-};
-/**
- * Get recently viewed markets for the current network.
- *
- * Returns up to PERPS_CONSTANTS.RecentlyViewedMarketsLimit symbols, ordered
- * newest-first, filtered to entries within the last
- * PERPS_CONSTANTS.RecentlyViewedMarketsTtlMs (24 hours). Returns an empty
- * array when no qualifying entries exist.
- *
- * @returns Ordered array of market symbols.
- */
-export type PerpsControllerGetRecentlyViewedMarketsAction = {
-    type: `PerpsController:getRecentlyViewedMarkets`;
-    handler: PerpsController['getRecentlyViewedMarkets'];
-};
-/**
- * Check if the controller is currently reinitializing
- *
- * @returns true if providers are being reinitialized
- */
-export type PerpsControllerIsCurrentlyReinitializingAction = {
-    type: `PerpsController:isCurrentlyReinitializing`;
-    handler: PerpsController['isCurrentlyReinitializing'];
-};
-/**
- * Union of all PerpsController action types.
- */
-export type PerpsControllerMethodActions = PerpsControllerGetCachedMarketDataForActiveProviderAction | PerpsControllerGetCachedUserDataForActiveProviderAction | PerpsControllerGetUserDataSnapshotAction | PerpsControllerInitAction | PerpsControllerGetActiveProviderAction | PerpsControllerGetActiveProviderOrNullAction | PerpsControllerGetOrderCapabilitiesAction | PerpsControllerPlaceOrderAction | PerpsControllerEditOrderAction | PerpsControllerCancelOrderAction | PerpsControllerGetTwapOrdersAction | PerpsControllerGetChaseOrdersAction | PerpsControllerSuspendChaseOrdersAction | PerpsControllerCancelOrdersAction | PerpsControllerClosePositionAction | PerpsControllerClosePositionsAction | PerpsControllerUpdatePositionTPSLAction | PerpsControllerUpdateMarginAction | PerpsControllerFlipPositionAction | PerpsControllerDepositWithConfirmationAction | PerpsControllerDepositWithOrderAction | PerpsControllerClearDepositResultAction | PerpsControllerClearWithdrawResultAction | PerpsControllerUpdateWithdrawalStatusAction | PerpsControllerCompleteWithdrawalFromHistoryAction | PerpsControllerUpdateWithdrawalProgressAction | PerpsControllerGetWithdrawalProgressAction | PerpsControllerWithdrawAction | PerpsControllerGetPositionsAction | PerpsControllerGetOrderFillsAction | PerpsControllerGetOrdersAction | PerpsControllerGetOpenOrdersAction | PerpsControllerGetFundingAction | PerpsControllerGetAccountStateAction | PerpsControllerGetHistoricalPortfolioAction | PerpsControllerGetMarketsAction | PerpsControllerGetMarketDataWithPricesAction | PerpsControllerStartMarketDataPreloadAction | PerpsControllerStopMarketDataPreloadAction | PerpsControllerGetAvailableDexsAction | PerpsControllerFetchHistoricalCandlesAction | PerpsControllerCalculateLiquidationPriceAction | PerpsControllerCalculateMaintenanceMarginAction | PerpsControllerGetMaxLeverageAction | PerpsControllerValidateOrderAction | PerpsControllerValidateClosePositionAction | PerpsControllerValidateWithdrawalAction | PerpsControllerGetWithdrawalRoutesAction | PerpsControllerSetAttributionContextAction | PerpsControllerGetAttributionContextAction | PerpsControllerClearAttributionContextAction | PerpsControllerToggleTestnetAction | PerpsControllerSwitchProviderAction | PerpsControllerGetCurrentNetworkAction | PerpsControllerGetMarketCategoriesAction | PerpsControllerGetWebSocketConnectionStateAction | PerpsControllerSubscribeToConnectionStateAction | PerpsControllerReconnectAction | PerpsControllerSubscribeToPricesAction | PerpsControllerSubscribeToPositionsAction | PerpsControllerSubscribeToOrderFillsAction | PerpsControllerSubscribeToOrdersAction | PerpsControllerSubscribeToAccountAction | PerpsControllerSubscribeToOrderBookAction | PerpsControllerSubscribeToCandlesAction | PerpsControllerSubscribeToOICapsAction | PerpsControllerSetLiveDataConfigAction | PerpsControllerCalculateFeesAction | PerpsControllerApproveSubscriptionBuilderFeeAction | PerpsControllerInvalidateSubscriptionBenefitsAction | PerpsControllerDisconnectAction | PerpsControllerStartEligibilityMonitoringAction | PerpsControllerStopEligibilityMonitoringAction | PerpsControllerRefreshEligibilityAction | PerpsControllerGetBlockExplorerUrlAction | PerpsControllerIsFirstTimeUserOnCurrentNetworkAction | PerpsControllerMarkTutorialCompletedAction | PerpsControllerMarkFirstOrderCompletedAction | PerpsControllerResetFirstTimeUserStateAction | PerpsControllerClearPendingTransactionRequestsAction | PerpsControllerGetTradeConfigurationAction | PerpsControllerSaveTradeConfigurationAction | PerpsControllerSavePendingTradeConfigurationAction | PerpsControllerGetPendingTradeConfigurationAction | PerpsControllerClearPendingTradeConfigurationAction | PerpsControllerGetMarketFilterPreferencesAction | PerpsControllerSaveMarketFilterPreferencesAction | PerpsControllerGetMaxSlippageAction | PerpsControllerSetMaxSlippageAction | PerpsControllerGetOrderBookPreferencesAction | PerpsControllerSetOrderBookPreferencesAction | PerpsControllerGetSelectedOrderTypeAction | PerpsControllerSetSelectedOrderTypeAction | PerpsControllerGetVisibleCandleCountAction | PerpsControllerSetVisibleCandleCountAction | PerpsControllerGetProLayoutPreferencesAction | PerpsControllerSetProLayoutPreferencesAction | PerpsControllerSetPerpsModeAction | PerpsControllerSetSelectedPaymentTokenAction | PerpsControllerResetSelectedPaymentTokenAction | PerpsControllerGetOrderBookGroupingAction | PerpsControllerSaveOrderBookGroupingAction | PerpsControllerToggleWatchlistMarketAction | PerpsControllerIsWatchlistMarketAction | PerpsControllerGetWatchlistMarketsAction | PerpsControllerRecordMarketViewedAction | PerpsControllerGetRecentlyViewedMarketsAction | PerpsControllerIsCurrentlyReinitializingAction;
-//# sourceMappingURL=PerpsController-method-action-types.d.cts.map