@metamask/ramps-controller 11.0.0 → 12.0.1

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_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_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");
@@ -270,6 +270,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.
  */
@@ -327,9 +376,10 @@ class RampsController extends base_controller_1.BaseController {
         _RampsController_orderPollingMeta.set(this, new Map());
         _RampsController_orderPollingTimer.set(this, null);
         _RampsController_isPolling.set(this, false);
+        _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
@@ -569,25 +619,28 @@ class RampsController extends base_controller_1.BaseController {
      * 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.
      *
-     * If a userRegion already exists (from persistence or manual selection),
-     * this method will skip geolocation fetch and use the existing 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.
      *
-     * @param options - Options for cache behavior.
+     * @param options - Options for cache behavior. forceRefresh bypasses idempotency and re-runs the full flow.
      * @returns Promise that resolves when initialization is complete.
      */
     async init(options) {
-        await this.getCountries(options);
-        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.');
+        if (!options?.forceRefresh && __classPrivateFieldGet(this, _RampsController_initPromise, "f") !== null) {
+            return __classPrivateFieldGet(this, _RampsController_initPromise, "f");
         }
-        await this.setUserRegion(regionCode, options);
-    }
-    hydrateState(options) {
-        const regionCode = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getTokens(regionCode, 'buy', options));
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getProviders(regionCode, options));
+        if (options?.forceRefresh) {
+            __classPrivateFieldSet(this, _RampsController_initPromise, null, "f");
+        }
+        const initPromise = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_runInit).call(this, options).then(() => undefined, (error) => {
+            if (__classPrivateFieldGet(this, _RampsController_initPromise, "f") === initPromise) {
+                __classPrivateFieldSet(this, _RampsController_initPromise, null, "f");
+            }
+            throw error;
+        });
+        __classPrivateFieldSet(this, _RampsController_initPromise, initPromise, "f");
+        return initPromise;
     }
     /**
      * Fetches the list of supported countries.
@@ -1029,23 +1082,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.
@@ -1457,7 +1512,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_orderPollingMeta = new WeakMap(), _RampsController_orderPollingTimer = new WeakMap(), _RampsController_isPolling = 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_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);
     }
@@ -1470,10 +1525,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;
@@ -1544,6 +1595,24 @@ _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);
+    }
+    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'));
+    }
+    if (!regionCode) {
+        throw new Error('Failed to fetch geolocation. Cannot initialize controller without valid region information.');
+    }
+    await this.setUserRegion(regionCode, options);
 }, _RampsController_refreshOrder = 
 /**
  * Refreshes a single order via the V2 API and updates it in state.