@metamask/ramps-controller 12.0.1 → 13.0.0

package/dist/RampsController.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 _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RampsController = exports.normalizeProviderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -85,13 +85,13 @@ const rampsControllerMetadata = {
         usedInUi: true,
     },
     providers: {
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         includeInStateLogs: true,
         usedInUi: true,
     },
     tokens: {
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         includeInStateLogs: true,
         usedInUi: true,
@@ -120,6 +120,12 @@ const rampsControllerMetadata = {
         includeInStateLogs: true,
         usedInUi: true,
     },
+    providerAutoSelected: {
+        persist: true,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
 };
 /**
  * Creates a default resource state object.
@@ -163,6 +169,7 @@ function getDefaultRampsControllerState() {
             },
         },
         orders: [],
+        providerAutoSelected: false,
     };
 }
 exports.getDefaultRampsControllerState = getDefaultRampsControllerState;
@@ -173,12 +180,11 @@ const DEPENDENT_RESOURCE_KEYS = [
 ];
 const DEPENDENT_RESOURCE_KEYS_SET = new Set(DEPENDENT_RESOURCE_KEYS);
 function resetResource(state, resourceType, defaultResource) {
-    const def = defaultResource ?? getDefaultRampsControllerState()[resourceType];
     const resource = state[resourceType];
-    resource.data = def.data;
-    resource.selected = def.selected;
-    resource.isLoading = def.isLoading;
-    resource.error = def.error;
+    resource.data = defaultResource.data;
+    resource.selected = defaultResource.selected;
+    resource.isLoading = defaultResource.isLoading;
+    resource.error = defaultResource.error;
 }
 /**
  * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods).
@@ -196,6 +202,7 @@ function resetDependentResources(state, options) {
     for (const key of DEPENDENT_RESOURCE_KEYS) {
         resetResource(state, key, defaultState[key]);
     }
+    state.providerAutoSelected = false;
 }
 // === HELPER FUNCTIONS ===
 /**
@@ -373,6 +380,11 @@ class RampsController extends base_controller_1.BaseController {
          * Used so isLoading is only cleared when the last request for that resource finishes.
          */
         _RampsController_pendingResourceCount.set(this, new Map());
+        /**
+         * Monotonic generation per resource type used to invalidate stale in-flight
+         * requests after region/token/provider dependent-resource resets.
+         */
+        _RampsController_pendingResourceGeneration.set(this, new Map());
         _RampsController_orderPollingMeta.set(this, new Map());
         _RampsController_orderPollingTimer.set(this, null);
         _RampsController_isPolling.set(this, false);
@@ -428,6 +440,9 @@ class RampsController extends base_controller_1.BaseController {
         const abortController = new AbortController();
         const lastFetchedAt = Date.now();
         const { resourceType } = options ?? {};
+        const resourceGeneration = resourceType
+            ? (__classPrivateFieldGet(this, _RampsController_pendingResourceGeneration, "f").get(resourceType) ?? 0)
+            : undefined;
         // Update state to loading
         __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateRequestState).call(this, cacheKey, (0, RequestCache_1.createLoadingState)());
         // Set resource-level loading state (only on cache miss). Ref-count so concurrent
@@ -476,14 +491,17 @@ class RampsController extends base_controller_1.BaseController {
                 }
                 // Clear resource-level loading state only when no requests for this resource remain
                 if (resourceType && !abortController.signal.aborted) {
-                    const count = __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").get(resourceType) ?? 0;
-                    const next = Math.max(0, count - 1);
-                    if (next === 0) {
-                        __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
-                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, resourceType, false);
-                    }
-                    else {
-                        __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").set(resourceType, next);
+                    const currentGeneration = __classPrivateFieldGet(this, _RampsController_pendingResourceGeneration, "f").get(resourceType) ?? 0;
+                    if (currentGeneration === resourceGeneration) {
+                        const count = __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").get(resourceType) ?? 0;
+                        const next = Math.max(0, count - 1);
+                        if (next === 0) {
+                            __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
+                            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, resourceType, false);
+                        }
+                        else {
+                            __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").set(resourceType, next);
+                        }
                     }
                 }
             }
@@ -541,12 +559,14 @@ class RampsController extends base_controller_1.BaseController {
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_cleanupState).call(this);
                 throw new Error(`Region "${normalizedRegion}" not found in countries data. Cannot set user region without valid country information.`);
             }
-            const regionChanged = normalizedRegion !== this.state.userRegion?.regionCode;
-            const needsRefetch = regionChanged ||
-                !this.state.tokens.data ||
-                this.state.providers.data.length === 0;
+            const regionChanged = Boolean(options?.forceRefresh) ||
+                normalizedRegion !== this.state.userRegion?.regionCode;
             if (regionChanged) {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_abortDependentRequests).call(this);
+                // Note: we intentionally do NOT abort in-flight requests here.
+                // Aborting causes data loss during rapid region switching (e.g.
+                // user taps France → Finland → France quickly). Instead we let
+                // old requests complete naturally; isResultCurrent guards in
+                // getProviders/getPaymentMethods discard stale results.
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_clearPendingResourceCountForDependentResources).call(this);
             }
             this.update((state) => {
@@ -555,18 +575,6 @@ class RampsController extends base_controller_1.BaseController {
                 }
                 state.userRegion = userRegion;
             });
-            if (needsRefetch) {
-                const refetchPromises = [];
-                if (regionChanged || !this.state.tokens.data) {
-                    refetchPromises.push(this.getTokens(userRegion.regionCode, 'buy', options));
-                }
-                if (regionChanged || this.state.providers.data.length === 0) {
-                    refetchPromises.push(this.getProviders(userRegion.regionCode, options));
-                }
-                if (refetchPromises.length > 0) {
-                    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, Promise.all(refetchPromises));
-                }
-            }
             return userRegion;
         }
         catch (error) {
@@ -575,44 +583,44 @@ class RampsController extends base_controller_1.BaseController {
         }
     }
     /**
-     * Sets the user's selected provider by ID, or clears the selection.
-     * Looks up the provider from the current providers in state and automatically
-     * fetches payment methods for that provider.
+     * Sets the user's selected provider.
+     *
+     * Accepts either a Provider object (stored directly) or a provider ID
+     * string (looked up from state). The object form is preferred when the
+     * caller already has the full data (e.g. from React Query cache).
      *
-     * @param providerId - The provider ID (e.g., "/providers/moonpay"), or null to clear.
-     * @throws If region is not set, providers are not loaded, or provider is not found.
+     * @param providerOrId - A Provider object, a provider ID string (e.g., "/providers/moonpay"), or null to clear.
+     * @param options - Optional settings for the selection.
+     * @param options.autoSelected - When true, marks the provider as system-guessed
+     *   (soft selection). The UI will silently auto-switch on token conflict instead
+     *   of showing the "Token Not Available" modal. Defaults to false.
      */
-    setSelectedProvider(providerId) {
-        if (providerId === null) {
+    setSelectedProvider(providerOrId, options) {
+        if (providerOrId === null) {
             this.update((state) => {
                 state.providers.selected = null;
-                resetResource(state, 'paymentMethods');
+                state.providerAutoSelected = false;
             });
             return;
         }
-        const regionCode = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
+        // If a full Provider object is passed, store it directly (avoids
+        // depending on state.providers.data being populated).
+        if (typeof providerOrId !== 'string') {
+            this.update((state) => {
+                state.providers.selected = providerOrId;
+                state.providerAutoSelected = options?.autoSelected ?? false;
+            });
+            return;
+        }
+        // ID string: look up from state
         const providers = this.state.providers.data;
-        if (!providers || providers.length === 0) {
-            throw new Error('Providers not loaded. Cannot set selected provider before providers are fetched.');
-        }
-        const provider = providers.find((prov) => prov.id === providerId);
-        if (!provider) {
-            throw new Error(`Provider with ID "${providerId}" not found in available providers.`);
-        }
-        const selectedToken = this.state.tokens.selected;
-        const supportedCryptos = provider.supportedCryptoCurrencies;
-        // Only fetch payment methods if the selected token is supported by the new
-        // provider. If it isn't, the payment methods request would fail or return
-        // empty for the wrong reason; the UI will show the Token Not Available modal
-        // so the user can change token or pick a different provider.
-        const assetId = selectedToken?.assetId;
-        const tokenSupportedByProvider = !(assetId && supportedCryptos?.[assetId] === false);
-        this.update((state) => {
-            state.providers.selected = provider;
-            resetResource(state, 'paymentMethods');
-        });
-        if (tokenSupportedByProvider) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { provider: provider.id }));
+        const provider = providers?.find((prov) => prov.id === providerOrId);
+        if (provider) {
+            this.update((state) => {
+                state.providers.selected = provider;
+                state.providerAutoSelected = options?.autoSelected ?? false;
+            });
         }
     }
     /**
@@ -707,11 +715,10 @@ class RampsController extends base_controller_1.BaseController {
         if (!assetId) {
             this.update((state) => {
                 state.tokens.selected = null;
-                resetResource(state, 'paymentMethods');
             });
             return;
         }
-        const regionCode = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
         const tokens = this.state.tokens.data;
         if (!tokens) {
             throw new Error('Tokens not loaded. Cannot set selected token before tokens are fetched.');
@@ -723,9 +730,7 @@ class RampsController extends base_controller_1.BaseController {
         }
         this.update((state) => {
             state.tokens.selected = token;
-            resetResource(state, 'paymentMethods');
         });
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { assetId: token.assetId }));
     }
     /**
      * Fetches the list of providers for a given region.
@@ -833,29 +838,35 @@ class RampsController extends base_controller_1.BaseController {
         return response;
     }
     /**
-     * Sets the user's selected payment method by ID.
-     * Looks up the payment method from the current payment methods in state.
+     * Sets the user's selected payment method.
+     *
+     * Accepts either a payment method ID (looked up from state) or a full
+     * PaymentMethod object (stored directly). The object form is preferred
+     * when the caller already has the full data (e.g. from React Query cache),
+     * as it avoids depending on controller state being populated.
      *
-     * @param paymentMethodId - The payment method ID (e.g., "/payments/debit-credit-card"), or null to clear.
-     * @throws If payment methods are not loaded or payment method is not found.
+     * @param paymentMethodOrId - A PaymentMethod object, a payment method ID string, or undefined/null to clear.
      */
-    setSelectedPaymentMethod(paymentMethodId) {
-        if (!paymentMethodId) {
+    setSelectedPaymentMethod(paymentMethodOrId) {
+        if (!paymentMethodOrId) {
             this.update((state) => {
                 state.paymentMethods.selected = null;
             });
             return;
         }
-        const paymentMethods = this.state.paymentMethods.data;
-        if (!paymentMethods || paymentMethods.length === 0) {
-            throw new Error('Payment methods not loaded. Cannot set selected payment method before payment methods are fetched.');
-        }
-        const paymentMethod = paymentMethods.find((pm) => pm.id === paymentMethodId);
-        if (!paymentMethod) {
-            throw new Error(`Payment method with ID "${paymentMethodId}" not found in available payment methods.`);
+        // If a full object is passed, store it directly
+        if (typeof paymentMethodOrId !== 'string') {
+            this.update((state) => {
+                state.paymentMethods.selected = paymentMethodOrId;
+            });
+            return;
         }
+        // ID string: look up from state
+        const paymentMethodId = paymentMethodOrId;
+        const paymentMethods = this.state.paymentMethods.data;
+        const paymentMethod = paymentMethods?.find((pm) => pm.id === paymentMethodId);
         this.update((state) => {
-            state.paymentMethods.selected = paymentMethod;
+            state.paymentMethods.selected = paymentMethod ?? null;
         });
     }
     /**
@@ -1114,7 +1125,8 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The unified order data.
      */
     async getOrderFromCallback(providerCode, callbackUrl, wallet) {
-        return await this.messenger.call('RampsService:getOrderFromCallback', providerCode, callbackUrl, wallet);
+        const order = await this.messenger.call('RampsService:getOrderFromCallback', providerCode, callbackUrl, wallet);
+        return order;
     }
     /**
      * Sets the Transak API key used for all Transak API requests.
@@ -1512,9 +1524,11 @@ class RampsController extends base_controller_1.BaseController {
     }
 }
 exports.RampsController = RampsController;
-_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_orderPollingMeta = new WeakMap(), _RampsController_orderPollingTimer = new WeakMap(), _RampsController_isPolling = new WeakMap(), _RampsController_initPromise = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
+_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_pendingResourceGeneration = new WeakMap(), _RampsController_orderPollingMeta = new WeakMap(), _RampsController_orderPollingTimer = new WeakMap(), _RampsController_isPolling = new WeakMap(), _RampsController_initPromise = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
     for (const resourceType of DEPENDENT_RESOURCE_KEYS) {
         __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
+        const generation = __classPrivateFieldGet(this, _RampsController_pendingResourceGeneration, "f").get(resourceType) ?? 0;
+        __classPrivateFieldGet(this, _RampsController_pendingResourceGeneration, "f").set(resourceType, generation + 1);
     }
 }, _RampsController_abortDependentRequests = function _RampsController_abortDependentRequests() {
     for (const [cacheKey, pending] of __classPrivateFieldGet(this, _RampsController_pendingRequests, "f").entries()) {
@@ -1538,8 +1552,6 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
     __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_abortDependentRequests).call(this);
     __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_clearPendingResourceCountForDependentResources).call(this);
     this.update((state) => resetDependentResources(state, { clearUserRegionData: true }));
-}, _RampsController_fireAndForget = function _RampsController_fireAndForget(promise) {
-    promise.catch((_error) => undefined);
 }, _RampsController_requireRegion = function _RampsController_requireRegion() {
     const regionCode = this.state.userRegion?.regionCode;
     if (!regionCode) {
@@ -1601,14 +1613,11 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
     if (forceRefresh || !hasCountries) {
         await this.getCountries(options);
     }
-    let regionCode;
-    if (forceRefresh) {
-        regionCode = await this.messenger.call('RampsService:getGeolocation');
-    }
-    else {
-        regionCode = this.state.userRegion?.regionCode;
-        regionCode ?? (regionCode = await this.messenger.call('RampsService:getGeolocation'));
-    }
+    // Always prefer the user's persisted region. Geolocation is only used to
+    // seed the initial value; once the user (or a prior init) has set a region
+    // we must respect that choice — even on forceRefresh.
+    let regionCode = this.state.userRegion?.regionCode;
+    regionCode ?? (regionCode = await this.messenger.call('RampsService:getGeolocation'));
     if (!regionCode) {
         throw new Error('Failed to fetch geolocation. Cannot initialize controller without valid region information.');
     }
@@ -1625,10 +1634,9 @@ async function _RampsController_refreshOrder(order) {
     if (!providerCode || !order.providerOrderId || !order.walletAddress) {
         return;
     }
-    const providerCodeSegment = normalizeProviderCode(providerCode);
     const previousStatus = order.status;
     try {
-        const updatedOrder = await this.getOrder(providerCodeSegment, order.providerOrderId, order.walletAddress);
+        const updatedOrder = await this.getOrder(providerCode, order.providerOrderId, order.walletAddress);
         const meta = __classPrivateFieldGet(this, _RampsController_orderPollingMeta, "f").get(order.providerOrderId) ?? {
             lastTimeFetched: 0,
             errorCount: 0,