@metamask-previews/perps-controller 1.0.1-preview-4183330c3 → 1.1.0-preview-efc1fb7

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0]
+
+### Added
+
+- feat: defer eligibility to allow for onboarding to proceed without le… ([#8197](https://github.com/MetaMask/core/pull/8197))
+
 ## [1.0.1]
 
 ### Changed
@@ -49,6 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bump `@metamask/controller-utils` from `^11.18.0` to `^11.19.0` ([#7995](https://github.com/MetaMask/core/pull/7995))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/perps-controller@1.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/perps-controller@1.1.0...HEAD
+[1.1.0]: https://github.com/MetaMask/core/compare/@metamask/perps-controller@1.0.1...@metamask/perps-controller@1.1.0
 [1.0.1]: https://github.com/MetaMask/core/compare/@metamask/perps-controller@1.0.0...@metamask/perps-controller@1.0.1
 [1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/perps-controller@1.0.0

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_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _PerpsController_standaloneProviderIsTestnet, _PerpsController_standaloneProviderHip3Version, _PerpsController_options, _PerpsController_tradingService, _PerpsController_marketDataService, _PerpsController_accountService, _PerpsController_eligibilityService, _PerpsController_dataLakeService, _PerpsController_depositService, _PerpsController_featureFlagConfigurationService, _PerpsController_rewardsIntegrationService, _PerpsController_logError, _PerpsController_debugLog, _PerpsController_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _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_performMarketDataPreload, _PerpsController_performUserDataPreload;
+var _PerpsController_instances, _a, _PerpsController_initializationPromise, _PerpsController_isReinitializing, _PerpsController_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _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_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _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_performMarketDataPreload, _PerpsController_performUserDataPreload;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PerpsController = exports.getDefaultPerpsControllerState = exports.InitializationState = exports.PERPS_ERROR_CODES = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -347,6 +347,8 @@ const MESSENGER_EXPOSED_METHODS = [
     'saveOrderBookGrouping',
     'setSelectedPaymentToken',
     'resetSelectedPaymentToken',
+    'startEligibilityMonitoring',
+    'stopEligibilityMonitoring',
 ];
 /**
  * PerpsController - Protocol-agnostic perpetuals trading controller
@@ -357,7 +359,7 @@ const MESSENGER_EXPOSED_METHODS = [
  * - Live data uses direct callbacks for maximum performance
  */
 class PerpsController extends base_controller_1.BaseController {
-    constructor({ messenger, state = {}, clientConfig = {}, infrastructure, }) {
+    constructor({ messenger, state = {}, clientConfig = {}, infrastructure, deferEligibilityCheck = false, }) {
         super({
             name: 'PerpsController',
             metadata,
@@ -398,6 +400,7 @@ class PerpsController extends base_controller_1.BaseController {
         _PerpsController_standaloneProvider.set(this, null);
         _PerpsController_standaloneProviderIsTestnet.set(this, null);
         _PerpsController_standaloneProviderHip3Version.set(this, null);
+        _PerpsController_eligibilityCheckDeferred.set(this, void 0);
         // Store options for dependency injection (allows core package to inject platform-specific services)
         _PerpsController_options.set(this, void 0);
         // Service instances (instantiated with platform dependencies)
@@ -416,6 +419,7 @@ class PerpsController extends base_controller_1.BaseController {
         _PerpsController_accountChangeUnsubscribe.set(this, null);
         _PerpsController_previousIsTestnet.set(this, null);
         _PerpsController_previousHip3ConfigVersion.set(this, null);
+        __classPrivateFieldSet(this, _PerpsController_eligibilityCheckDeferred, deferEligibilityCheck, "f");
         // Store options for dependency injection
         __classPrivateFieldSet(this, _PerpsController_options, {
             messenger,
@@ -2084,15 +2088,43 @@ class PerpsController extends base_controller_1.BaseController {
      * Eligibility (Geo-Blocking)
      */
     /**
-     * Fetch geo location
+     * Activates geo-blocking eligibility monitoring.
+     * Call this after onboarding is complete when the controller was constructed
+     * with `deferEligibilityCheck: true`.
      *
-     * Returned in Country or Country-Region format
-     * Example: FR, DE, US-MI, CA-ON
+     * Reads the current RemoteFeatureFlagController state, performs the initial
+     * eligibility check, and unblocks the existing stateChange subscription so
+     * future feature-flag updates flow through normally.
+     * Safe to call multiple times; subsequent calls simply re-check eligibility.
      */
+    startEligibilityMonitoring() {
+        __classPrivateFieldSet(this, _PerpsController_eligibilityCheckDeferred, false, "f");
+        try {
+            const currentState = this.messenger.call('RemoteFeatureFlagController:getState');
+            this.refreshEligibilityOnFeatureFlagChange(currentState);
+        }
+        catch (error) {
+            __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_logError).call(this, (0, errorUtils_1.ensureError)(error, 'PerpsController.startEligibilityMonitoring'), __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getErrorContext).call(this, 'startEligibilityMonitoring', {
+                operation: 'readRemoteFeatureFlags',
+            }));
+        }
+    }
+    /**
+     * 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.
+     */
+    stopEligibilityMonitoring() {
+        __classPrivateFieldSet(this, _PerpsController_eligibilityCheckDeferred, true, "f");
+    }
     /**
      * Refresh eligibility status
      */
     async refreshEligibility() {
+        if (__classPrivateFieldGet(this, _PerpsController_eligibilityCheckDeferred, "f")) {
+            return;
+        }
         // Capture the current version before starting the async operation.
         // This prevents race conditions where stale eligibility checks
         // (started with fallback config) overwrite results from newer checks
@@ -2585,7 +2617,7 @@ class PerpsController extends base_controller_1.BaseController {
     }
 }
 exports.PerpsController = PerpsController;
-_a = PerpsController, _PerpsController_initializationPromise = new WeakMap(), _PerpsController_isReinitializing = 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_standaloneProviderIsTestnet = new WeakMap(), _PerpsController_standaloneProviderHip3Version = 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_blockedRegionListVersion = new WeakMap(), _PerpsController_hip3Enabled = new WeakMap(), _PerpsController_hip3AllowlistMarkets = new WeakMap(), _PerpsController_hip3BlocklistMarkets = new WeakMap(), _PerpsController_hip3ConfigSource = new WeakMap(), _PerpsController_standaloneProvider = 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 getLocalFlag = () => typeof globalThis.process !== 'undefined' &&
         globalThis.process.env?.MM_PERPS_MYX_PROVIDER_ENABLED === 'true';
     try {