@metamask-previews/ramps-controller 9.0.0-preview-e117c8109 → 9.0.0-preview-32ed9958c

package/CHANGELOG.md

@@ -7,16 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Changed
-
-- Improve `TransakService` error handling ([#8010](https://github.com/MetaMask/core/pull/8010))
-- **BREAKING:** Replace `startQuotePolling()`/`stopQuotePolling()` with `fetchQuotesForSelection()` — quotes are now fetched once per call instead of polling on a 15-second interval ([#7999](https://github.com/MetaMask/core/pull/7999))
-
-### Removed
-
-- Remove `stopQuotePolling()` method (no interval to stop) ([#7999](https://github.com/MetaMask/core/pull/7999))
-- Remove internal polling restart logic (`#restartPollingIfActive`) from `setSelectedProvider`, `setSelectedToken`, and `setSelectedPaymentMethod` ([#7999](https://github.com/MetaMask/core/pull/7999))
-
 ## [9.0.0]
 
 ### Added

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_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_syncWidgetUrl, _RampsController_syncTransakAuthOnError;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_quotePollingInterval, _RampsController_quotePollingOptions, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_restartPollingIfActive, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_syncWidgetUrl, _RampsController_syncTransakAuthOnError;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RampsController = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -326,6 +326,16 @@ 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());
+        /**
+         * Interval ID for automatic quote polling.
+         * Set when startQuotePolling() is called, cleared when stopQuotePolling() is called.
+         */
+        _RampsController_quotePollingInterval.set(this, null);
+        /**
+         * Options used for quote polling (walletAddress, amount, redirectUrl).
+         * Stored so polling can be restarted when dependencies change.
+         */
+        _RampsController_quotePollingOptions.set(this, null);
         __classPrivateFieldSet(this, _RampsController_requestCacheTTL, requestCacheTTL, "f");
         __classPrivateFieldSet(this, _RampsController_requestCacheMaxSize, requestCacheMaxSize, "f");
     }
@@ -496,6 +506,7 @@ class RampsController extends base_controller_1.BaseController {
             if (regionChanged) {
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_abortDependentRequests).call(this);
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_clearPendingResourceCountForDependentResources).call(this);
+                this.stopQuotePolling();
             }
             this.update((state) => {
                 if (regionChanged) {
@@ -532,6 +543,7 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedProvider(providerId) {
         if (providerId === null) {
+            this.stopQuotePolling();
             this.update((state) => {
                 state.providers.selected = null;
                 resetResource(state, 'paymentMethods');
@@ -553,7 +565,11 @@ class RampsController extends base_controller_1.BaseController {
             state.quotes.selected = null;
             resetWidgetUrl(state);
         });
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { provider: provider.id }));
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { provider: provider.id }).then(() => {
+            // Restart quote polling after payment methods are fetched
+            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_restartPollingIfActive).call(this);
+            return undefined;
+        }));
     }
     /**
      * Initializes the controller by fetching the user's region from geolocation.
@@ -642,6 +658,7 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedToken(assetId) {
         if (!assetId) {
+            this.stopQuotePolling();
             this.update((state) => {
                 state.tokens.selected = null;
                 resetResource(state, 'paymentMethods');
@@ -664,7 +681,10 @@ class RampsController extends base_controller_1.BaseController {
             state.quotes.selected = null;
             resetWidgetUrl(state);
         });
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { assetId: token.assetId }));
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { assetId: token.assetId }).then(() => {
+            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_restartPollingIfActive).call(this);
+            return undefined;
+        }));
     }
     /**
      * Fetches the list of providers for a given region.
@@ -796,6 +816,8 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.paymentMethods.selected = paymentMethod;
         });
+        // Restart quote polling if active
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_restartPollingIfActive).call(this);
     }
     /**
      * Fetches quotes from all providers for a given set of parameters.
@@ -885,7 +907,8 @@ class RampsController extends base_controller_1.BaseController {
         return response;
     }
     /**
-     * Fetches quotes for the currently selected token, provider, and payment method.
+     * Starts automatic quote polling with a 15-second refresh interval.
+     * Fetches quotes immediately and then every 15 seconds.
      * If the response contains exactly one quote, it is auto-selected.
      * If multiple quotes are returned, the existing selection is preserved if still valid.
      *
@@ -898,49 +921,73 @@ class RampsController extends base_controller_1.BaseController {
      * @param options.redirectUrl - Optional redirect URL after order completion.
      * @throws If required dependencies (region, token, provider) are not set.
      */
-    fetchQuotesForSelection(options) {
+    startQuotePolling(options) {
         __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_requireRegion).call(this);
         const token = this.state.tokens.selected;
         const provider = this.state.providers.selected;
         const paymentMethod = this.state.paymentMethods.selected;
         if (!token) {
-            throw new Error('Token is required. Cannot fetch quotes without a selected token.');
+            throw new Error('Token is required. Cannot start quote polling without a selected token.');
         }
         if (!provider) {
-            throw new Error('Provider is required. Cannot fetch quotes without a selected provider.');
+            throw new Error('Provider is required. Cannot start quote polling without a selected provider.');
         }
         if (!paymentMethod) {
             return;
         }
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getQuotes({
-            assetId: token.assetId,
-            amount: options.amount,
-            walletAddress: options.walletAddress,
-            redirectUrl: options.redirectUrl,
-            paymentMethods: [paymentMethod.id],
-            providers: [provider.id],
-            forceRefresh: true,
-        }).then((response) => {
-            let newSelectedQuote = null;
-            this.update((state) => {
-                if (response.success.length === 1) {
-                    newSelectedQuote = response.success[0];
-                    state.quotes.selected = newSelectedQuote;
-                }
-                else {
-                    const currentSelection = state.quotes.selected;
-                    if (currentSelection) {
-                        const freshQuote = response.success.find((quote) => quote.provider === currentSelection.provider &&
-                            quote.quote.paymentMethod ===
-                                currentSelection.quote.paymentMethod);
-                        newSelectedQuote = freshQuote ?? null;
+        // Stop any existing polling first
+        this.stopQuotePolling();
+        // Store options for restarts (must be after stop to avoid being cleared)
+        __classPrivateFieldSet(this, _RampsController_quotePollingOptions, options, "f");
+        // Define the fetch function
+        const fetchQuotes = () => {
+            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getQuotes({
+                assetId: token.assetId,
+                amount: options.amount,
+                walletAddress: options.walletAddress,
+                redirectUrl: options.redirectUrl,
+                paymentMethods: [paymentMethod.id],
+                providers: [provider.id],
+                forceRefresh: true,
+            }).then((response) => {
+                let newSelectedQuote = null;
+                // Auto-select logic: only when exactly one quote is returned
+                this.update((state) => {
+                    if (response.success.length === 1) {
+                        newSelectedQuote = response.success[0];
                         state.quotes.selected = newSelectedQuote;
                     }
-                }
-            });
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncWidgetUrl).call(this, newSelectedQuote);
-            return undefined;
-        }));
+                    else {
+                        // Keep existing selection if still valid, but update with fresh data
+                        const currentSelection = state.quotes.selected;
+                        if (currentSelection) {
+                            const freshQuote = response.success.find((quote) => quote.provider === currentSelection.provider &&
+                                quote.quote.paymentMethod ===
+                                    currentSelection.quote.paymentMethod);
+                            newSelectedQuote = freshQuote ?? null;
+                            state.quotes.selected = newSelectedQuote;
+                        }
+                    }
+                });
+                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncWidgetUrl).call(this, newSelectedQuote);
+                return undefined;
+            }));
+        };
+        // Fetch immediately
+        fetchQuotes();
+        // Set up 15-second polling
+        __classPrivateFieldSet(this, _RampsController_quotePollingInterval, setInterval(fetchQuotes, 15000), "f");
+    }
+    /**
+     * Stops automatic quote polling.
+     * Does not clear quotes data or selection, only stops the interval.
+     */
+    stopQuotePolling() {
+        if (__classPrivateFieldGet(this, _RampsController_quotePollingInterval, "f") !== null) {
+            clearInterval(__classPrivateFieldGet(this, _RampsController_quotePollingInterval, "f"));
+            __classPrivateFieldSet(this, _RampsController_quotePollingInterval, null, "f");
+        }
+        __classPrivateFieldSet(this, _RampsController_quotePollingOptions, null, "f");
     }
     /**
      * Manually sets the selected quote.
@@ -956,9 +1003,11 @@ class RampsController extends base_controller_1.BaseController {
     }
     /**
      * Cleans up controller resources.
+     * Stops any active quote polling to prevent memory leaks.
      * Should be called when the controller is no longer needed.
      */
     destroy() {
+        this.stopQuotePolling();
         super.destroy();
     }
     /**
@@ -1406,7 +1455,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_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_quotePollingInterval = new WeakMap(), _RampsController_quotePollingOptions = 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);
     }
@@ -1429,11 +1478,24 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
         delete requests[cacheKey];
     });
 }, _RampsController_cleanupState = function _RampsController_cleanupState() {
+    this.stopQuotePolling();
     __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_restartPollingIfActive = function _RampsController_restartPollingIfActive() {
+    if (__classPrivateFieldGet(this, _RampsController_quotePollingInterval, "f") !== null && __classPrivateFieldGet(this, _RampsController_quotePollingOptions, "f")) {
+        const options = __classPrivateFieldGet(this, _RampsController_quotePollingOptions, "f");
+        this.stopQuotePolling();
+        try {
+            this.startQuotePolling(options);
+        }
+        catch {
+            // Dependencies not met yet, polling will need to be manually restarted
+            // when dependencies are available
+        }
+    }
 }, _RampsController_requireRegion = function _RampsController_requireRegion() {
     const regionCode = this.state.userRegion?.regionCode;
     if (!regionCode) {