@metamask/ramps-controller 18.0.1 → 20.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_getDefaultRedirectUrl, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_resolveAllProvidersFlag, _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_pickWidenedQuote, _RampsController_getSupportingProvidersForRegion, _RampsController_filterProviderIdsBySupport, _RampsController_resolveProviderIdsForQuote, _RampsController_getPreferredProviderIdsFromOrders, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
+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_resolveAllProvidersFlag, _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_pickWidenedQuote, _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.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -33,6 +33,7 @@ exports.controllerName = 'RampsController';
  * these actions from the root messenger so the controller can function.
  */
 exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = [
+    'RampsService:getDefaultRedirectCallbackUrl',
     'RampsService:getGeolocation',
     'RampsService:getCountries',
     'RampsService:getTokens',
@@ -375,6 +376,7 @@ const MESSENGER_EXPOSED_METHODS = [
     'getRequestState',
     'setUserRegion',
     'setSelectedProvider',
+    'setSelectedProviderForAsset',
     'init',
     'getCountries',
     'getTokens',
@@ -441,11 +443,8 @@ 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.getDefaultRedirectUrl - Optional callback returning the default
-     * redirect URL used for the widened quote fetch when the caller omits
-     * `redirectUrl`. Defaults to a callback returning `undefined`.
      */
-    constructor({ messenger, state = {}, requestCacheTTL = RequestCache_js_1.DEFAULT_REQUEST_CACHE_TTL, requestCacheMaxSize = RequestCache_js_1.DEFAULT_REQUEST_CACHE_MAX_SIZE, getDefaultRedirectUrl, }) {
+    constructor({ messenger, state = {}, requestCacheTTL = RequestCache_js_1.DEFAULT_REQUEST_CACHE_TTL, requestCacheMaxSize = RequestCache_js_1.DEFAULT_REQUEST_CACHE_MAX_SIZE, }) {
         super({
             messenger,
             metadata: rampsControllerMetadata,
@@ -466,12 +465,6 @@ class RampsController extends base_controller_1.BaseController {
          * Maximum number of entries in the request cache.
          */
         _RampsController_requestCacheMaxSize.set(this, void 0);
-        /**
-         * Resolves the default redirect URL for the widened 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.
@@ -493,7 +486,6 @@ 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_getDefaultRedirectUrl, getDefaultRedirectUrl ?? (() => undefined), "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
@@ -726,6 +718,52 @@ class RampsController extends base_controller_1.BaseController {
             });
         }
     }
+    /**
+     * Switches to the first provider in state that serves the given asset,
+     * when the currently selected provider does not.
+     *
+     * This is the controller-level equivalent of UB2's BuildQuote tier-1
+     * silent-switch effect and MMPay's `useEnsureCompatibleProvider` hook: it
+     * keeps provider-asset compatibility logic in one place rather than
+     * duplicating `providerServesAsset` + find-and-switch across multiple UI
+     * layers.
+     *
+     * The compatibility check prefers the current provider's entry in
+     * `providers.data` over the `providers.selected` copy, which can be stale
+     * once a fresh providers list arrives.
+     *
+     * No-op when:
+     * - `providers.data` is empty (providers not yet loaded)
+     * - the currently selected provider already serves the asset
+     * - no provider in the list serves the asset (no safe fallback)
+     *
+     * @param assetId - CAIP-19 asset id of the deposit asset.
+     * @param options - Optional settings forwarded to `setSelectedProvider`.
+     * @param options.autoSelected - When true, marks the new selection as
+     *   system-guessed (soft selection). Defaults to true.
+     * @returns `true` if the selected provider was changed, `false` otherwise.
+     */
+    setSelectedProviderForAsset(assetId, options) {
+        const providers = this.state.providers.data;
+        if (!providers?.length) {
+            return false;
+        }
+        const selectedId = this.state.providers.selected?.id;
+        const currentProvider = providers.find((provider) => provider.id === selectedId) ??
+            this.state.providers.selected;
+        if (currentProvider && (0, providerAvailability_js_1.providerServesAsset)(currentProvider, assetId)) {
+            return false;
+        }
+        const compatible = providers.find((provider) => provider.id !== selectedId && (0, providerAvailability_js_1.providerServesAsset)(provider, assetId));
+        if (!compatible) {
+            return false;
+        }
+        this.setSelectedProvider(compatible, {
+            autoSelected: true,
+            ...options,
+        });
+        return true;
+    }
     /**
      * Initializes the controller by fetching the user's region from geolocation.
      * This should be called once at app startup to set up the initial region.
@@ -1088,12 +1126,16 @@ class RampsController extends base_controller_1.BaseController {
         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 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 the native-only path
-        // (flag off) never injects.
+        // present, so on the widened path (where MM Pay omits one) ask the service
+        // for the callback URL of the environment it is configured with, so
+        // aggregator quotes carry a usable widget URL that always matches the
+        // environment the quotes came from. An explicit caller `redirectUrl`
+        // always wins, and the native-only path (flag off) never injects, so
+        // neither reaches the service.
         const effectiveRedirectUrl = options.redirectUrl ??
-            (widenToAllProviders ? __classPrivateFieldGet(this, _RampsController_getDefaultRedirectUrl, "f").call(this) : undefined);
+            (widenToAllProviders
+                ? this.messenger.call('RampsService:getDefaultRedirectCallbackUrl')
+                : undefined);
         const cacheKey = (0, RequestCache_js_1.createCacheKey)('getQuotes', [
             normalizedRegion,
             normalizedFiat,
@@ -1252,7 +1294,7 @@ class RampsController extends base_controller_1.BaseController {
      * @param params.orderId - Full order ID (e.g. "/providers/paypal/orders/abc123") or order code.
      * @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.
+     * @param params.chainId - Chain ID for the order (decimal, hex, or CAIP-2). Must be non-empty.
      */
     addPrecreatedOrder(params) {
         const { orderId, providerCode, walletAddress, chainId } = params;
@@ -1260,6 +1302,9 @@ class RampsController extends base_controller_1.BaseController {
         if (!orderCode?.trim()) {
             return;
         }
+        if (!chainId.trim()) {
+            return;
+        }
         const stubOrder = {
             providerOrderId: orderCode,
             provider: {
@@ -1282,7 +1327,7 @@ class RampsController extends base_controller_1.BaseController {
             providerOrderLink: '',
             totalFeesFiat: 0,
             txHash: '',
-            network: chainId ? { chainId, name: '' } : { chainId: '', name: '' },
+            network: { chainId, name: '' },
             canBeUpdated: true,
             idHasExpired: false,
             excludeFromPurchases: false,
@@ -1786,7 +1831,7 @@ class RampsController extends base_controller_1.BaseController {
     }
 }
 exports.RampsController = RampsController;
-_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = 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() {
+_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;