@metamask-previews/perps-controller 8.2.0-preview-b2742a2fc → 8.2.0-preview-ed0047684

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add Terminal API integration for market data, controlled via `useTerminalApi` parameter on `GetMarketsParams` / `GetMarketDataWithPricesParams` ([#9137](https://github.com/MetaMask/core/pull/9137))
+  - `TerminalMarketService` fetches structured market metadata from the injected `terminalApiUrl` with a 5-minute cache TTL.
+  - When enabled, `getMarkets()` attempts the Terminal API first; on failure or empty response, falls back silently to HyperLiquid. Terminal results respect the same allowlist/blocklist filtering as the provider path.
+  - `getMarketDataWithPrices()` enriches provider data with Terminal API metadata (name, keywords, tags, categories).
+  - `PerpsPlatformDependencies` gains an optional `terminalApiUrl?: string` field and an optional `terminalMarketService?: PerpsTerminalMarketService` field; clients can inject a pre-built service instance or let the controller create one from the URL.
+  - `PerpsMarketData` gains optional `keywords`, `tags`, and `categories` fields.
+  - Market search (`getMarketMatchRank`, `rankMarketsByQuery`) now indexes the `keywords` field for richer search results.
+  - `HYPERLIQUID_ASSET_NAMES` and `HIP3_ASSET_MARKET_TYPES` remain intact as fallback for assets absent from the Terminal API.
+- Surface per-market trading availability so clients can warn before placing an order that would be rejected ([#9205](https://github.com/MetaMask/core/pull/9205))
+  - Add an `isTradable` boolean to `PriceUpdate` that defaults to `true`. It is `false` when a market's mid price has drifted past the protocol's oracle-deviation limit (HyperLiquid rejects orders more than 95% away from the reference price, which most often affects HIP-3 markets); a provider with no such rule, or that cannot yet assess tradability, reports `true`.
+  - Add an optional, protocol-agnostic `fallbackPriceDeviationLimit` to `PerpsControllerConfig` so clients can tune the deviation threshold; each provider applies its own default when omitted.
+  - Export the pure `isMarketTradable` helper and add `HYPERLIQUID_CONFIG.OraclePriceDeviationLimit` (`0.95`, the HyperLiquid default).
+
 ### Changed
 
 - Bump `@metamask/controller-utils` from `^12.2.0` to `^12.3.0` ([#9218](https://github.com/MetaMask/core/pull/9218))

package/dist/PerpsController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _PerpsController_instances, _a, _PerpsController_initializationPromise, _PerpsController_isReinitializing, _PerpsController_myxRegistrationPromise, _PerpsController_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _PerpsController_handlersRegistered, _PerpsController_standaloneProviderIsTestnet, _PerpsController_standaloneProviderHip3Version, _PerpsController_eligibilityCheckDeferred, _PerpsController_options, _PerpsController_tradingService, _PerpsController_marketDataService, _PerpsController_accountService, _PerpsController_eligibilityService, _PerpsController_dataLakeService, _PerpsController_depositService, _PerpsController_featureFlagConfigurationService, _PerpsController_rewardsIntegrationService, _PerpsController_logError, _PerpsController_debugLog, _PerpsController_getAggregatedCacheProviderIds, _PerpsController_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _PerpsController_createProviders, _PerpsController_assignActiveProvider, _PerpsController_getErrorContext, _PerpsController_getControllerState, _PerpsController_createServiceContext, _PerpsController_ensureTradingServiceDeps, _PerpsController_preloadWatchedPaths, _PerpsController_preloadTimer, _PerpsController_isPreloading, _PerpsController_isPreloadingUserData, _PerpsController_preloadStateUnsubscribe, _PerpsController_accountChangeUnsubscribe, _PerpsController_previousIsTestnet, _PerpsController_previousHip3ConfigVersion, _PerpsController_preloadRefreshMs, _PerpsController_preloadGuardMs, _PerpsController_hydrateCacheFromDiskSync, _PerpsController_performMarketDataPreload, _PerpsController_performUserDataPreload;
+var _PerpsController_instances, _a, _PerpsController_initializationPromise, _PerpsController_isReinitializing, _PerpsController_myxRegistrationPromise, _PerpsController_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_priceDeviationLimit, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _PerpsController_handlersRegistered, _PerpsController_standaloneProviderIsTestnet, _PerpsController_standaloneProviderHip3Version, _PerpsController_eligibilityCheckDeferred, _PerpsController_options, _PerpsController_tradingService, _PerpsController_marketDataService, _PerpsController_accountService, _PerpsController_eligibilityService, _PerpsController_dataLakeService, _PerpsController_depositService, _PerpsController_featureFlagConfigurationService, _PerpsController_rewardsIntegrationService, _PerpsController_logError, _PerpsController_debugLog, _PerpsController_getAggregatedCacheProviderIds, _PerpsController_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _PerpsController_createProviders, _PerpsController_assignActiveProvider, _PerpsController_getErrorContext, _PerpsController_getControllerState, _PerpsController_buildMarketAllowedFilter, _PerpsController_compilePatternsSafely, _PerpsController_createServiceContext, _PerpsController_ensureTradingServiceDeps, _PerpsController_preloadWatchedPaths, _PerpsController_preloadTimer, _PerpsController_isPreloading, _PerpsController_isPreloadingUserData, _PerpsController_preloadStateUnsubscribe, _PerpsController_accountChangeUnsubscribe, _PerpsController_previousIsTestnet, _PerpsController_previousHip3ConfigVersion, _PerpsController_preloadRefreshMs, _PerpsController_preloadGuardMs, _PerpsController_hydrateCacheFromDiskSync, _PerpsController_performMarketDataPreload, _PerpsController_performUserDataPreload;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PerpsController = exports.getDefaultPerpsControllerState = exports.InitializationState = exports.PERPS_ERROR_CODES = exports.resolveMyxAuthConfig = exports.firstNonEmpty = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -31,11 +31,14 @@ const EligibilityService_1 = require("./services/EligibilityService.cjs");
 const FeatureFlagConfigurationService_1 = require("./services/FeatureFlagConfigurationService.cjs");
 const MarketDataService_1 = require("./services/MarketDataService.cjs");
 const RewardsIntegrationService_1 = require("./services/RewardsIntegrationService.cjs");
+const TerminalMarketService_1 = require("./services/TerminalMarketService.cjs");
 const TradingService_1 = require("./services/TradingService.cjs");
 // PerpsStreamChannelKey removed: using string for channel keys (PerpsStreamManager.pauseChannel takes string)
 const types_1 = require("./types/index.cjs");
 const accountUtils_1 = require("./utils/accountUtils.cjs");
 const errorUtils_1 = require("./utils/errorUtils.cjs");
+const hyperLiquidAdapter_1 = require("./utils/hyperLiquidAdapter.cjs");
+const marketUtils_1 = require("./utils/marketUtils.cjs");
 const perpsDiskPersistence_1 = require("./utils/perpsDiskPersistence.cjs");
 const wait_1 = require("./utils/wait.cjs");
 /**
@@ -457,6 +460,10 @@ class PerpsController extends base_controller_1.BaseController {
         _PerpsController_hip3AllowlistMarkets.set(this, void 0);
         _PerpsController_hip3BlocklistMarkets.set(this, void 0);
         _PerpsController_hip3ConfigSource.set(this, 'fallback');
+        // Optional client override for the max market-vs-oracle price deviation before a
+        // market is reported untradable (PriceUpdate.isTradable). Protocol-agnostic: passed
+        // through to each provider, which applies its own default when this is undefined.
+        _PerpsController_priceDeviationLimit.set(this, void 0);
         /**
          * Active provider instance for routing operations.
          * When activeProvider is 'hyperliquid' or 'myx': points to specific provider directly
@@ -502,7 +509,13 @@ class PerpsController extends base_controller_1.BaseController {
         // Instantiate services with platform dependencies
         // Services that need cross-controller access receive the messenger
         __classPrivateFieldSet(this, _PerpsController_tradingService, new TradingService_1.TradingService(infrastructure), "f");
-        __classPrivateFieldSet(this, _PerpsController_marketDataService, new MarketDataService_1.MarketDataService(infrastructure), "f");
+        __classPrivateFieldSet(this, _PerpsController_marketDataService, new MarketDataService_1.MarketDataService({
+            ...infrastructure,
+            terminalMarketService: infrastructure.terminalMarketService ??
+                (infrastructure.terminalApiUrl
+                    ? new TerminalMarketService_1.TerminalMarketService(infrastructure)
+                    : undefined),
+        }), "f");
         __classPrivateFieldSet(this, _PerpsController_accountService, new AccountService_1.AccountService(infrastructure, messenger), "f");
         __classPrivateFieldSet(this, _PerpsController_eligibilityService, new EligibilityService_1.EligibilityService(infrastructure), "f");
         __classPrivateFieldSet(this, _PerpsController_dataLakeService, new DataLakeService_1.DataLakeService(infrastructure, messenger), "f");
@@ -517,6 +530,7 @@ class PerpsController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _PerpsController_hip3BlocklistMarkets, [
             ...(clientConfig.fallbackHip3BlocklistMarkets ?? []),
         ], "f");
+        __classPrivateFieldSet(this, _PerpsController_priceDeviationLimit, clientConfig.fallbackPriceDeviationLimit, "f");
         // Immediately set the fallback region list since RemoteFeatureFlagController is empty by default and takes a moment to populate.
         this.setBlockedRegionList(clientConfig.fallbackBlockedRegions ?? [], 'fallback');
         /**
@@ -1592,19 +1606,22 @@ class PerpsController extends base_controller_1.BaseController {
      * @returns Array of available markets matching the filter criteria.
      */
     async getMarkets(params) {
-        // For standalone mode, access provider directly without initialization check
-        // This allows discovery use cases (checking if market exists) without full perps setup
+        const isMarketAllowed = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_buildMarketAllowedFilter).call(this);
         if (params?.standalone) {
-            // Use activeProviderInstance if available (respects provider abstraction)
-            // Fallback to cached standalone provider for pre-initialization discovery
             const provider = this.activeProviderInstance ?? __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getOrCreateStandaloneProvider).call(this);
-            return provider.getMarkets(params);
+            return __classPrivateFieldGet(this, _PerpsController_marketDataService, "f").getMarkets({
+                provider,
+                params,
+                context: __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_createServiceContext).call(this, 'getMarkets'),
+                isMarketAllowed,
+            });
         }
         const provider = this.getActiveProvider();
         return __classPrivateFieldGet(this, _PerpsController_marketDataService, "f").getMarkets({
             provider,
             params,
             context: __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_createServiceContext).call(this, 'getMarkets'),
+            isMarketAllowed,
         });
     }
     /**
@@ -1624,8 +1641,6 @@ class PerpsController extends base_controller_1.BaseController {
      */
     async getMarketDataWithPrices(params) {
         if (params?.standalone) {
-            // Use activeProviderInstance if available (respects provider abstraction)
-            // Fallback to cached standalone provider for pre-initialization discovery
             const provider = this.activeProviderInstance ?? __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getOrCreateStandaloneProvider).call(this);
             return __classPrivateFieldGet(this, _PerpsController_marketDataService, "f").getMarketDataWithPrices({
                 provider,
@@ -3011,7 +3026,7 @@ class PerpsController extends base_controller_1.BaseController {
     }
 }
 exports.PerpsController = PerpsController;
-_a = PerpsController, _PerpsController_initializationPromise = new WeakMap(), _PerpsController_isReinitializing = new WeakMap(), _PerpsController_myxRegistrationPromise = new WeakMap(), _PerpsController_blockedRegionListVersion = new WeakMap(), _PerpsController_hip3Enabled = new WeakMap(), _PerpsController_hip3AllowlistMarkets = new WeakMap(), _PerpsController_hip3BlocklistMarkets = new WeakMap(), _PerpsController_hip3ConfigSource = new WeakMap(), _PerpsController_standaloneProvider = new WeakMap(), _PerpsController_handlersRegistered = new WeakMap(), _PerpsController_standaloneProviderIsTestnet = new WeakMap(), _PerpsController_standaloneProviderHip3Version = new WeakMap(), _PerpsController_eligibilityCheckDeferred = new WeakMap(), _PerpsController_options = new WeakMap(), _PerpsController_tradingService = new WeakMap(), _PerpsController_marketDataService = new WeakMap(), _PerpsController_accountService = new WeakMap(), _PerpsController_eligibilityService = new WeakMap(), _PerpsController_dataLakeService = new WeakMap(), _PerpsController_depositService = new WeakMap(), _PerpsController_featureFlagConfigurationService = new WeakMap(), _PerpsController_rewardsIntegrationService = new WeakMap(), _PerpsController_preloadTimer = new WeakMap(), _PerpsController_isPreloading = new WeakMap(), _PerpsController_isPreloadingUserData = new WeakMap(), _PerpsController_preloadStateUnsubscribe = new WeakMap(), _PerpsController_accountChangeUnsubscribe = new WeakMap(), _PerpsController_previousIsTestnet = new WeakMap(), _PerpsController_previousHip3ConfigVersion = new WeakMap(), _PerpsController_instances = new WeakSet(), _PerpsController_isMYXProviderEnabled = function _PerpsController_isMYXProviderEnabled() {
+_a = PerpsController, _PerpsController_initializationPromise = new WeakMap(), _PerpsController_isReinitializing = new WeakMap(), _PerpsController_myxRegistrationPromise = new WeakMap(), _PerpsController_blockedRegionListVersion = new WeakMap(), _PerpsController_hip3Enabled = new WeakMap(), _PerpsController_hip3AllowlistMarkets = new WeakMap(), _PerpsController_hip3BlocklistMarkets = new WeakMap(), _PerpsController_hip3ConfigSource = new WeakMap(), _PerpsController_priceDeviationLimit = new WeakMap(), _PerpsController_standaloneProvider = new WeakMap(), _PerpsController_handlersRegistered = new WeakMap(), _PerpsController_standaloneProviderIsTestnet = new WeakMap(), _PerpsController_standaloneProviderHip3Version = new WeakMap(), _PerpsController_eligibilityCheckDeferred = new WeakMap(), _PerpsController_options = new WeakMap(), _PerpsController_tradingService = new WeakMap(), _PerpsController_marketDataService = new WeakMap(), _PerpsController_accountService = new WeakMap(), _PerpsController_eligibilityService = new WeakMap(), _PerpsController_dataLakeService = new WeakMap(), _PerpsController_depositService = new WeakMap(), _PerpsController_featureFlagConfigurationService = new WeakMap(), _PerpsController_rewardsIntegrationService = new WeakMap(), _PerpsController_preloadTimer = new WeakMap(), _PerpsController_isPreloading = new WeakMap(), _PerpsController_isPreloadingUserData = new WeakMap(), _PerpsController_preloadStateUnsubscribe = new WeakMap(), _PerpsController_accountChangeUnsubscribe = new WeakMap(), _PerpsController_previousIsTestnet = new WeakMap(), _PerpsController_previousHip3ConfigVersion = new WeakMap(), _PerpsController_instances = new WeakSet(), _PerpsController_isMYXProviderEnabled = function _PerpsController_isMYXProviderEnabled() {
     const myx = __classPrivateFieldGet(this, _PerpsController_options, "f").clientConfig?.providerCredentials?.myx;
     // Local env-var override (MM_PERPS_MYX_PROVIDER_ENABLED) always wins —
     // matches the UI selector (resolvePerpsMyxProviderEnabled) so controller
@@ -3084,6 +3099,7 @@ _a = PerpsController, _PerpsController_initializationPromise = new WeakMap(), _P
         hip3Enabled: __classPrivateFieldGet(this, _PerpsController_hip3Enabled, "f"),
         allowlistMarkets: __classPrivateFieldGet(this, _PerpsController_hip3AllowlistMarkets, "f"),
         blocklistMarkets: __classPrivateFieldGet(this, _PerpsController_hip3BlocklistMarkets, "f"),
+        priceDeviationLimit: __classPrivateFieldGet(this, _PerpsController_priceDeviationLimit, "f"),
         platformDependencies: __classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure,
         messenger: this.messenger,
         builderAddressTestnet: __classPrivateFieldGet(this, _PerpsController_options, "f").clientConfig?.providerCredentials?.hyperliquid
@@ -3315,6 +3331,7 @@ async function _PerpsController_performInitialization() {
         hip3Enabled: __classPrivateFieldGet(this, _PerpsController_hip3Enabled, "f"),
         allowlistMarkets: __classPrivateFieldGet(this, _PerpsController_hip3AllowlistMarkets, "f"),
         blocklistMarkets: __classPrivateFieldGet(this, _PerpsController_hip3BlocklistMarkets, "f"),
+        priceDeviationLimit: __classPrivateFieldGet(this, _PerpsController_priceDeviationLimit, "f"),
         platformDependencies: __classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure,
         messenger: this.messenger,
         builderAddressTestnet: __classPrivateFieldGet(this, _PerpsController_options, "f").clientConfig?.providerCredentials?.hyperliquid
@@ -3398,6 +3415,25 @@ async function _PerpsController_performInitialization() {
     };
 }, _PerpsController_getControllerState = function _PerpsController_getControllerState() {
     return this.state;
+}, _PerpsController_buildMarketAllowedFilter = function _PerpsController_buildMarketAllowedFilter() {
+    const hip3Enabled = __classPrivateFieldGet(this, _PerpsController_hip3Enabled, "f");
+    const compiledAllowlist = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_compilePatternsSafely).call(this, __classPrivateFieldGet(this, _PerpsController_hip3AllowlistMarkets, "f"));
+    const compiledBlocklist = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_compilePatternsSafely).call(this, __classPrivateFieldGet(this, _PerpsController_hip3BlocklistMarkets, "f"));
+    return (symbol) => {
+        const { dex } = (0, hyperLiquidAdapter_1.parseAssetName)(symbol);
+        return (0, marketUtils_1.shouldIncludeMarket)(symbol, dex, hip3Enabled, compiledAllowlist, compiledBlocklist);
+    };
+}, _PerpsController_compilePatternsSafely = function _PerpsController_compilePatternsSafely(patterns) {
+    const compiled = [];
+    for (const pattern of patterns) {
+        try {
+            compiled.push({ pattern, matcher: (0, marketUtils_1.compileMarketPattern)(pattern) });
+        }
+        catch {
+            // Invalid patterns silently skipped — logged at provider level.
+        }
+    }
+    return compiled;
 }, _PerpsController_createServiceContext = function _PerpsController_createServiceContext(method, additionalContext) {
     return {
         tracingContext: {