@metamask/ramps-controller 15.0.0 → 16.0.0

package/dist/RampsController.cjs

@@ -10,9 +10,9 @@ 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_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_getSupportingProvidersForRegion, _RampsController_filterProviderIdsBySupport, _RampsController_resolveProviderIdsForQuote, _RampsController_getPreferredProviderIdsFromOrders, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_getProviderScope, _RampsController_getDefaultRedirectUrl, _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_syncUserRegionFromCountriesCatalog, _RampsController_pickInAppQuote, _RampsController_getSupportingProvidersForRegion, _RampsController_filterProviderIdsBySupport, _RampsController_resolveProviderIdsForQuote, _RampsController_getPreferredProviderIdsFromOrders, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RampsController = exports.getInternalOrderCode = exports.normalizeProviderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
+exports.RampsController = exports.getInternalOrderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const rampsErrorCodes_1 = require("./rampsErrorCodes.cjs");
@@ -135,7 +135,7 @@ const rampsControllerMetadata = {
         usedInUi: true,
     },
     countries: {
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         includeInStateLogs: true,
         usedInUi: true,
@@ -329,10 +329,6 @@ function findRegionFromCode(regionCode, countries) {
         regionCode: normalizedCode,
     };
 }
-function normalizeProviderCode(providerCode) {
-    return providerCode.replace(/^\/providers\//u, '');
-}
-exports.normalizeProviderCode = normalizeProviderCode;
 /**
  * Returns the internal MetaMask order code used for state lookups and polling.
  * Prefers the code embedded in the canonical order `id` path over `providerOrderId`,
@@ -441,8 +437,13 @@ class RampsController extends base_controller_1.BaseController {
      * controller. Missing properties will be filled in with defaults.
      * @param args.requestCacheTTL - Time to live for cached requests in milliseconds.
      * @param args.requestCacheMaxSize - Maximum number of entries in the request cache.
+     * @param args.getProviderScope - Optional callback returning the current
+     * provider-class scope for fiat quote widening. Defaults to `off`.
+     * @param args.getDefaultRedirectUrl - Optional callback returning the default
+     * redirect URL used for the widened in-app quote fetch when the caller omits
+     * `redirectUrl`. Defaults to a callback returning `undefined`.
      */
-    constructor({ messenger, state = {}, requestCacheTTL = RequestCache_1.DEFAULT_REQUEST_CACHE_TTL, requestCacheMaxSize = RequestCache_1.DEFAULT_REQUEST_CACHE_MAX_SIZE, }) {
+    constructor({ messenger, state = {}, requestCacheTTL = RequestCache_1.DEFAULT_REQUEST_CACHE_TTL, requestCacheMaxSize = RequestCache_1.DEFAULT_REQUEST_CACHE_MAX_SIZE, getProviderScope, getDefaultRedirectUrl, }) {
         super({
             messenger,
             metadata: rampsControllerMetadata,
@@ -463,6 +464,17 @@ class RampsController extends base_controller_1.BaseController {
          * Maximum number of entries in the request cache.
          */
         _RampsController_requestCacheMaxSize.set(this, void 0);
+        /**
+         * Resolves the current provider-class scope for fiat quote widening. Defaults
+         * to `() => 'off'` (native-only) when no callback is injected.
+         */
+        _RampsController_getProviderScope.set(this, void 0);
+        /**
+         * Resolves the default redirect URL for the widened in-app quote fetch when
+         * the caller omits `redirectUrl`. Defaults to `() => undefined` when no
+         * callback is injected.
+         */
+        _RampsController_getDefaultRedirectUrl.set(this, void 0);
         /**
          * Map of pending requests for deduplication.
          * Key is the cache key, value is the pending request with abort controller.
@@ -484,6 +496,8 @@ class RampsController extends base_controller_1.BaseController {
         _RampsController_initPromise.set(this, null);
         __classPrivateFieldSet(this, _RampsController_requestCacheTTL, requestCacheTTL, "f");
         __classPrivateFieldSet(this, _RampsController_requestCacheMaxSize, requestCacheMaxSize, "f");
+        __classPrivateFieldSet(this, _RampsController_getProviderScope, getProviderScope ?? (() => 'off'), "f");
+        __classPrivateFieldSet(this, _RampsController_getDefaultRedirectUrl, getDefaultRedirectUrl ?? (() => undefined), "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
@@ -721,8 +735,10 @@ class RampsController extends base_controller_1.BaseController {
      * This should be called once at app startup to set up the initial region.
      *
      * Idempotent: subsequent calls return the same promise unless forceRefresh is set.
-     * Skips getCountries when countries are already loaded; skips geolocation when
-     * userRegion already exists.
+     * Force-refetches the countries catalog on startup (bypassing the in-session
+     * request cache) so region preset amounts stay current. The catalog is not
+     * persisted, so a cold start always re-fetches it regardless. Skips
+     * geolocation when userRegion already exists.
      *
      * @param options - Options for cache behavior. forceRefresh bypasses idempotency and re-runs the full flow.
      * @returns Promise that resolves when initialization is complete.
@@ -759,6 +775,7 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.countries.data = Array.isArray(countries) ? [...countries] : [];
         });
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncUserRegionFromCountriesCatalog).call(this);
         return countries;
     }
     /**
@@ -995,7 +1012,19 @@ class RampsController extends base_controller_1.BaseController {
         if (normalizedAssetIdForValidation === '') {
             throw new Error('assetId is required.');
         }
+        // When a non-`off` provider scope is active, widen the native-only
+        // auto-selection path to every supporting provider and pick the best in-app
+        // quote from the results (in-app vs external is only knowable per-quote via
+        // `buyWidget.browser`). Only the auto-select/restrict path that MM Pay's
+        // `getRampsQuote` uses is affected; explicit-`providers` callers and the
+        // plain all-provider path are untouched.
+        const providerScope = __classPrivateFieldGet(this, _RampsController_getProviderScope, "f").call(this);
+        const widenToInAppProviders = providerScope !== 'off' &&
+            !options.providers &&
+            (options.autoSelectProvider === true ||
+                options.restrictToKnownOrNativeProviders === true);
         let providersToUse;
+        let inAppProviderCatalog = this.state.providers.data;
         if (options.providers) {
             providersToUse = options.restrictToKnownOrNativeProviders
                 ? await __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_filterProviderIdsBySupport).call(this, {
@@ -1005,6 +1034,17 @@ class RampsController extends base_controller_1.BaseController {
                 })
                 : options.providers;
         }
+        else if (widenToInAppProviders) {
+            // `#getSupportingProvidersForRegion` also hydrates the provider catalog
+            // when controller state is empty, so all-provider quoting cannot silently
+            // return zero providers here.
+            const { supporting } = await __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getSupportingProvidersForRegion).call(this, {
+                assetId: normalizedAssetIdForValidation,
+                region: regionToUse,
+            });
+            inAppProviderCatalog = supporting;
+            providersToUse = supporting.map((provider) => provider.id);
+        }
         else if (options.autoSelectProvider ||
             options.restrictToKnownOrNativeProviders) {
             // The restriction flag implies resolution: it must narrow the provider
@@ -1034,8 +1074,12 @@ class RampsController extends base_controller_1.BaseController {
         // Under headless-buy gating, an empty resolved provider list means no
         // eligible (native/supporting) provider exists. Return an empty response
         // rather than passing `[]` to the service, which omits the provider filter
-        // and would quote every provider.
-        if (options.restrictToKnownOrNativeProviders &&
+        // and would quote every provider. This also guards the widened in-app path:
+        // a caller may trigger widening with `autoSelectProvider` alone (no
+        // `restrictToKnownOrNativeProviders`), and an empty supporting set must not
+        // fall through to unfiltered quotes from providers that do not support the
+        // asset.
+        if ((options.restrictToKnownOrNativeProviders || widenToInAppProviders) &&
             providersToUse.length === 0) {
             return { success: [], sorted: [], error: [], customActions: [] };
         }
@@ -1043,6 +1087,12 @@ class RampsController extends base_controller_1.BaseController {
         const normalizedFiat = fiatToUse.toLowerCase().trim();
         const normalizedAssetId = normalizedAssetIdForValidation;
         const normalizedWalletAddress = options.walletAddress.trim();
+        // The quotes API only embeds a `buyURL`/`buyWidget` when a `redirectUrl` is
+        // present, so on the widened in-app path (where MM Pay omits one) supply the
+        // injected default so aggregator quotes carry a usable widget URL. An
+        // explicit caller `redirectUrl` always wins, and scope `off` never injects.
+        const effectiveRedirectUrl = options.redirectUrl ??
+            (widenToInAppProviders ? __classPrivateFieldGet(this, _RampsController_getDefaultRedirectUrl, "f").call(this) : undefined);
         const cacheKey = (0, RequestCache_1.createCacheKey)('getQuotes', [
             normalizedRegion,
             normalizedFiat,
@@ -1051,7 +1101,7 @@ class RampsController extends base_controller_1.BaseController {
             normalizedWalletAddress,
             [...paymentMethodsToUse].sort().join(','),
             [...providersToUse].sort().join(','),
-            options.redirectUrl,
+            effectiveRedirectUrl,
             action,
         ]);
         const params = {
@@ -1062,15 +1112,45 @@ class RampsController extends base_controller_1.BaseController {
             walletAddress: normalizedWalletAddress,
             paymentMethods: paymentMethodsToUse,
             providers: providersToUse,
-            redirectUrl: options.redirectUrl,
+            redirectUrl: effectiveRedirectUrl,
             action,
         };
-        return this.executeRequest(cacheKey, async () => {
+        const response = await this.executeRequest(cacheKey, async () => {
             return this.messenger.call('RampsService:getQuotes', params);
         }, {
             forceRefresh: options.forceRefresh,
             ttl: options.ttl ?? DEFAULT_QUOTES_TTL,
         });
+        if (!widenToInAppProviders) {
+            return response;
+        }
+        // Reduce the widened multi-provider result to the single best in-app quote
+        // and place it at `success[0]`, since single-pick consumers
+        // (`getRampsQuote` -> `success?.[0]`) rely on index 0 while `success[]`
+        // order is server-defined rather than ranked.
+        const selectedQuote = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_pickInAppQuote).call(this, response, {
+            scope: providerScope,
+            amount: options.amount,
+            fiat: normalizedFiat,
+            providers: inAppProviderCatalog,
+        });
+        if (!selectedQuote) {
+            // No usable in-app quote: surface "no quote" rather than leaking an
+            // external/custom quote to the single-pick consumer.
+            return {
+                success: [],
+                sorted: response.sorted,
+                error: response.error,
+                customActions: response.customActions,
+            };
+        }
+        return {
+            ...response,
+            success: [
+                selectedQuote,
+                ...response.success.filter((quote) => quote !== selectedQuote),
+            ],
+        };
     }
     // === ORDER MANAGEMENT ===
     /**
@@ -1169,7 +1249,7 @@ class RampsController extends base_controller_1.BaseController {
      *
      * @param params - Object containing order identifiers and wallet info.
      * @param params.orderId - Full order ID (e.g. "/providers/paypal/orders/abc123") or order code.
-     * @param params.providerCode - Provider code (e.g. "paypal", "transak"), with or without /providers/ prefix.
+     * @param params.providerCode - Canonical provider code (e.g. "paypal", "transak").
      * @param params.walletAddress - Wallet address for the order.
      * @param params.chainId - Optional chain ID for the order.
      */
@@ -1179,11 +1259,10 @@ class RampsController extends base_controller_1.BaseController {
         if (!orderCode?.trim()) {
             return;
         }
-        const normalizedProviderCode = normalizeProviderCode(providerCode);
         const stubOrder = {
             providerOrderId: orderCode,
             provider: {
-                id: `/providers/${normalizedProviderCode}`,
+                id: providerCode,
                 name: '',
                 environmentType: '',
                 description: '',
@@ -1687,7 +1766,7 @@ 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_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() {
+_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_getProviderScope = new WeakMap(), _RampsController_getDefaultRedirectUrl = 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;
@@ -1773,20 +1852,100 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
         }
     });
 }, _RampsController_runInit = async function _RampsController_runInit(options) {
-    const forceRefresh = options?.forceRefresh === true;
-    const hasCountries = this.state.countries.data.length > 0;
-    if (forceRefresh || !hasCountries) {
-        await this.getCountries(options);
-    }
+    // Force-refetch the catalog on startup so region preset amounts stay
+    // current, bypassing the in-session request cache. The catalog is not
+    // persisted, so a cold start always re-fetches it regardless.
+    await this.getCountries({ ...options, forceRefresh: true });
     // 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'));
+    const persistedRegionCode = this.state.userRegion?.regionCode;
+    const regionCode = persistedRegionCode ??
+        (await this.messenger.call('RampsService:getGeolocation'));
     if (!regionCode) {
         throw new Error('Failed to fetch geolocation. Cannot initialize controller without valid region information.');
     }
+    // For an already-persisted region, getCountries() has already re-synced it
+    // from the fresh catalog (see #syncUserRegionFromCountriesCatalog). Calling
+    // setUserRegion here would re-validate against that catalog and, if it is
+    // momentarily empty or no longer lists the region (e.g. a transient/partial
+    // catalog response or a region with no current provider coverage), throw and
+    // wipe the persisted region via #cleanupState. Preserve the existing region
+    // instead; only resolve a brand-new region (from geolocation) strictly.
+    if (persistedRegionCode) {
+        return;
+    }
     await this.setUserRegion(regionCode, options);
+}, _RampsController_syncUserRegionFromCountriesCatalog = function _RampsController_syncUserRegionFromCountriesCatalog() {
+    const regionCode = this.state.userRegion?.regionCode;
+    if (!regionCode) {
+        return;
+    }
+    const countriesData = this.state.countries.data;
+    if (!countriesData.length) {
+        return;
+    }
+    const userRegion = findRegionFromCode(regionCode, countriesData);
+    if (!userRegion) {
+        return;
+    }
+    this.update((state) => {
+        state.userRegion = userRegion;
+    });
+}, _RampsController_pickInAppQuote = function _RampsController_pickInAppQuote(response, { scope, amount, fiat, providers, }) {
+    const providerByCode = new Map(providers.map((provider) => [provider.id, provider]));
+    const customActionProviderCodes = new Set(response.customActions.map((action) => action.buy.providerId));
+    const fitsProviderLimits = (quote) => {
+        const provider = providerByCode.get(quote.provider);
+        const limit = provider?.limits?.fiat?.[fiat]?.[quote.quote.paymentMethod];
+        if (!limit) {
+            // No published limits for this provider/payment method: treat as
+            // eligible and let the provider enforce limits at checkout.
+            return true;
+        }
+        return amount >= limit.minAmount && amount <= limit.maxAmount;
+    };
+    const isEligible = (quote) => {
+        // `all` (Phase 2) skips the in-app-only exclusions; both scopes still
+        // enforce provider limits up front.
+        if (scope !== 'all') {
+            const providerCode = quote.provider;
+            if (customActionProviderCodes.has(providerCode)) {
+                return false;
+            }
+            // Defensive: the wire may carry an inline `isCustomAction` flag that is
+            // absent from the published `Quote` type.
+            if (quote.quote.isCustomAction === true) {
+                return false;
+            }
+            if (quote.quote.buyWidget?.browser === 'IN_APP_OS_BROWSER') {
+                return false;
+            }
+        }
+        return fitsProviderLimits(quote);
+    };
+    const candidates = response.success.filter(isEligible);
+    if (candidates.length === 0) {
+        return undefined;
+    }
+    const candidateByCode = new Map(candidates.map((quote) => [quote.provider, quote]));
+    const pickBySortOrder = (sortBy) => {
+        const order = response.sorted.find((entry) => entry.sortBy === sortBy)?.ids;
+        if (!order) {
+            return undefined;
+        }
+        for (const providerId of order) {
+            const match = candidateByCode.get(providerId);
+            if (match) {
+                return match;
+            }
+        }
+        return undefined;
+    };
+    // Reliability first, then price, then the first surviving candidate.
+    return (pickBySortOrder('reliability') ??
+        pickBySortOrder('price') ??
+        candidates[0]);
 }, _RampsController_getSupportingProvidersForRegion = 
 /**
  * Returns the region's providers that support the given asset, plus the full