@metamask/ramps-controller 12.0.0 → 12.1.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_registerActionHandlers, _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_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;
 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;
@@ -196,6 +203,7 @@ function resetDependentResources(state, options) {
     for (const key of DEPENDENT_RESOURCE_KEYS) {
         resetResource(state, key, defaultState[key]);
     }
+    state.providerAutoSelected = false;
 }
 // === HELPER FUNCTIONS ===
 /**
@@ -270,6 +278,55 @@ const PENDING_ORDER_STATUSES = new Set([
 const DEFAULT_POLLING_INTERVAL_MS = 30000;
 const MAX_ERROR_COUNT = 5;
 // === CONTROLLER DEFINITION ===
+const MESSENGER_EXPOSED_METHODS = [
+    'executeRequest',
+    'abortRequest',
+    'getRequestState',
+    'setUserRegion',
+    'setSelectedProvider',
+    'init',
+    'getCountries',
+    'getTokens',
+    'setSelectedToken',
+    'getProviders',
+    'getPaymentMethods',
+    'setSelectedPaymentMethod',
+    'getQuotes',
+    'addOrder',
+    'removeOrder',
+    'startOrderPolling',
+    'stopOrderPolling',
+    'getBuyWidgetData',
+    'addPrecreatedOrder',
+    'getOrder',
+    'getOrderFromCallback',
+    'transakSetApiKey',
+    'transakSetAccessToken',
+    'transakClearAccessToken',
+    'transakSetAuthenticated',
+    'transakResetState',
+    'transakSendUserOtp',
+    'transakVerifyUserOtp',
+    'transakLogout',
+    'transakGetUserDetails',
+    'transakGetBuyQuote',
+    'transakGetKycRequirement',
+    'transakGetAdditionalRequirements',
+    'transakCreateOrder',
+    'transakGetOrder',
+    'transakGetUserLimits',
+    'transakRequestOtt',
+    'transakGeneratePaymentWidgetUrl',
+    'transakSubmitPurposeOfUsageForm',
+    'transakPatchUser',
+    'transakSubmitSsnDetails',
+    'transakConfirmPayment',
+    'transakGetTranslation',
+    'transakGetIdProofStatus',
+    'transakCancelOrder',
+    'transakCancelAllActiveOrders',
+    'transakGetActiveOrders',
+];
 /**
  * Manages cryptocurrency on/off ramps functionality.
  */
@@ -330,7 +387,7 @@ class RampsController extends base_controller_1.BaseController {
         _RampsController_initPromise.set(this, null);
         __classPrivateFieldSet(this, _RampsController_requestCacheTTL, requestCacheTTL, "f");
         __classPrivateFieldSet(this, _RampsController_requestCacheMaxSize, requestCacheMaxSize, "f");
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_registerActionHandlers).call(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
      * Executes a request with caching, deduplication, and at most one in-flight
@@ -531,12 +588,17 @@ class RampsController extends base_controller_1.BaseController {
      * fetches payment methods for that provider.
      *
      * @param providerId - The provider ID (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.
      * @throws If region is not set, providers are not loaded, or provider is not found.
      */
-    setSelectedProvider(providerId) {
+    setSelectedProvider(providerId, options) {
         if (providerId === null) {
             this.update((state) => {
                 state.providers.selected = null;
+                state.providerAutoSelected = false;
                 resetResource(state, 'paymentMethods');
             });
             return;
@@ -560,6 +622,7 @@ class RampsController extends base_controller_1.BaseController {
         const tokenSupportedByProvider = !(assetId && supportedCryptos?.[assetId] === false);
         this.update((state) => {
             state.providers.selected = provider;
+            state.providerAutoSelected = options?.autoSelected ?? false;
             resetResource(state, 'paymentMethods');
         });
         if (tokenSupportedByProvider) {
@@ -1033,23 +1096,25 @@ class RampsController extends base_controller_1.BaseController {
      */
     async getOrder(providerCode, orderCode, wallet) {
         const order = await this.messenger.call('RampsService:getOrder', providerCode, orderCode, wallet);
+        const healedWalletAddress = order.walletAddress || wallet;
+        const healedOrder = {
+            ...order,
+            walletAddress: healedWalletAddress,
+            providerOrderId: orderCode,
+        };
         this.update((state) => {
             const idx = state.orders.findIndex((existing) => existing.providerOrderId === orderCode);
             if (idx === -1) {
-                state.orders.push({
-                    ...order,
-                    providerOrderId: orderCode,
-                });
+                state.orders.push(healedOrder);
             }
             else {
                 state.orders[idx] = {
                     ...state.orders[idx],
-                    ...order,
-                    providerOrderId: orderCode,
+                    ...healedOrder,
                 };
             }
         });
-        return order;
+        return healedOrder;
     }
     /**
      * Extracts an order from a provider callback URL.
@@ -1063,7 +1128,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.
@@ -1474,10 +1540,6 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
             __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_removeRequestState).call(this, cacheKey);
         }
     }
-}, _RampsController_registerActionHandlers = function _RampsController_registerActionHandlers() {
-    this.messenger.registerActionHandler('RampsController:getOrder', this.getOrder.bind(this));
-    this.messenger.registerActionHandler('RampsController:getQuotes', this.getQuotes.bind(this));
-    this.messenger.registerActionHandler('RampsController:setSelectedToken', this.setSelectedToken.bind(this));
 }, _RampsController_mutateRequests = function _RampsController_mutateRequests(fn) {
     this.update((state) => {
         const requests = state.requests;
@@ -1578,10 +1640,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,