@metamask/ramps-controller 6.0.0 → 7.0.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0]
+
+### Added
+
+- Update payment method delay type to match API response structure ([#7845](https://github.com/MetaMask/core/pull/7845))
+- Add automatic quote polling with `startQuotePolling()`, `stopQuotePolling()`, and `setSelectedQuote()` methods, with auto-selection when a single quote is returned ([#7824](https://github.com/MetaMask/core/pull/7824))
+
+### Changed
+
+- **BREAKING:** Require provider selection for quote polling and update quotes API endpoint to `/v2/quotes` ([#7846](https://github.com/MetaMask/core/pull/7846))
+
 ## [6.0.0]
 
 ### Changed
@@ -46,14 +57,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add sync trigger methods to RampsController ([#7662](https://github.com/MetaMask/core/pull/7662))
-
 - Export `RampAction` type for `'buy' | 'sell'` ramp actions ([#7663](https://github.com/MetaMask/core/pull/7663))
 - Add payment methods support with `getPaymentMethods()` method, `paymentMethods` and `selectedPaymentMethod` state ([#7665](https://github.com/MetaMask/core/pull/7665))
 
 ### Changed
 
 - Evict expired cache entries based on TTL in addition to size-based eviction ([#7674](https://github.com/MetaMask/core/pull/7674))
-
 - Update `getTokens()` to use v2 API endpoint and support optional provider parameter ([#7664](https://github.com/MetaMask/core/pull/7664))
 
 ## [4.0.0]
@@ -61,19 +70,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add `preferredProvider` state and `setPreferredProvider()` method to RampsController ([#7617](https://github.com/MetaMask/core/pull/7617))
-
 - Export `UserRegion` type ([#7646](https://github.com/MetaMask/core/pull/7646))
-
 - Add `defaultAmount` and `quickAmounts` fields to the `Country` type ([#7645](https://github.com/MetaMask/core/pull/7645))
-
 - Add `providers` state and `getProviders()` method to RampsController. Providers are automatically fetched on init and when the region changes ([#7652](https://github.com/MetaMask/core/pull/7652))
 
 ### Changed
 
 - **BREAKING:** Change `userRegion` from `string | null` to `UserRegion | null`. Access region code via `userRegion.regionCode`. ([#7646](https://github.com/MetaMask/core/pull/7646))
-
 - Update `getCountries()` endpoint to use v2 API (`v2/regions/countries`) ([#7645](https://github.com/MetaMask/core/pull/7645))
-
 - Add `getApiPath()` helper function for versioned API paths with v2 default ([#7645](https://github.com/MetaMask/core/pull/7645))
 
 ### Removed
@@ -89,7 +93,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - **BREAKING:** Rename `geolocation` to `userRegion` and `updateGeolocation()` to `updateUserRegion()` in RampsController ([#7563](https://github.com/MetaMask/core/pull/7563))
-
 - Bump `@metamask/controller-utils` from `^11.17.0` to `^11.18.0` ([#7583](https://github.com/MetaMask/core/pull/7583))
 
 ## [2.1.0]
@@ -97,11 +100,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add eligibility state ([#7539](https://github.com/MetaMask/core/pull/7539))
-
 - Add `createRequestSelector` utility function for creating memoized selectors for RampsController request states ([#7554](https://github.com/MetaMask/core/pull/7554))
-
 - Add request caching infrastructure with TTL, deduplication, and abort support ([#7536](https://github.com/MetaMask/core/pull/7536))
-
 - Add `init()` and `setUserRegion()` methods to RampsController ([#7563](https://github.com/MetaMask/core/pull/7563))
 
 ### Changed
@@ -128,7 +128,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Add `OnRampService` for interacting with the OnRamp API
   - Add geolocation detection via IP address lookup
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@6.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@7.0.0...HEAD
+[7.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@6.0.0...@metamask/ramps-controller@7.0.0
 [6.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@5.1.0...@metamask/ramps-controller@6.0.0
 [5.1.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@5.0.0...@metamask/ramps-controller@5.1.0
 [5.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@4.1.0...@metamask/ramps-controller@5.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_pendingRequests, _RampsController_pendingResourceCount, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_quotePollingInterval, _RampsController_quotePollingOptions, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_restartPollingIfActive, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState;
 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");
@@ -119,7 +119,7 @@ function getDefaultRampsControllerState() {
         providers: createDefaultResourceState([], null),
         tokens: createDefaultResourceState(null, null),
         paymentMethods: createDefaultResourceState([], null),
-        quotes: createDefaultResourceState(null),
+        quotes: createDefaultResourceState(null, null),
         requests: {},
     };
 }
@@ -149,6 +149,7 @@ function resetDependentResources(state, options) {
     state.paymentMethods.isLoading = false;
     state.paymentMethods.error = null;
     state.quotes.data = null;
+    state.quotes.selected = null;
     state.quotes.isLoading = false;
     state.quotes.error = null;
 }
@@ -260,6 +261,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");
     }
@@ -415,6 +426,9 @@ class RampsController extends base_controller_1.BaseController {
             if (regionChanged) {
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_clearPendingResourceCountForDependentResources).call(this);
             }
+            if (regionChanged) {
+                this.stopQuotePolling();
+            }
             this.update((state) => {
                 if (regionChanged) {
                     resetDependentResources(state);
@@ -450,6 +464,7 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedProvider(providerId) {
         if (providerId === null) {
+            this.stopQuotePolling();
             this.update((state) => {
                 state.providers.selected = null;
                 state.paymentMethods.data = [];
@@ -473,8 +488,13 @@ class RampsController extends base_controller_1.BaseController {
             state.providers.selected = provider;
             state.paymentMethods.data = [];
             state.paymentMethods.selected = null;
+            state.quotes.selected = null;
         });
-        __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.
@@ -570,6 +590,7 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedToken(assetId) {
         if (!assetId) {
+            this.stopQuotePolling();
             this.update((state) => {
                 state.tokens.selected = null;
                 state.paymentMethods.data = [];
@@ -594,8 +615,13 @@ class RampsController extends base_controller_1.BaseController {
             state.tokens.selected = token;
             state.paymentMethods.data = [];
             state.paymentMethods.selected = null;
+            state.quotes.selected = null;
         });
-        __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(() => {
+            // Restart quote polling after payment methods are fetched
+            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_restartPollingIfActive).call(this);
+            return undefined;
+        }));
     }
     /**
      * Fetches the list of providers for a given region.
@@ -735,6 +761,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.
@@ -821,6 +849,106 @@ class RampsController extends base_controller_1.BaseController {
         });
         return response;
     }
+    /**
+     * 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.
+     *
+     * @param options - Parameters for fetching quotes.
+     * @param options.walletAddress - The destination wallet address.
+     * @param options.amount - The amount (in fiat for buy, crypto for sell).
+     * @param options.redirectUrl - Optional redirect URL after order completion.
+     * @throws If required dependencies (region, token, provider, payment method) are not set.
+     */
+    startQuotePolling(options) {
+        // Validate required dependencies
+        const regionCode = this.state.userRegion?.regionCode;
+        const token = this.state.tokens.selected;
+        const provider = this.state.providers.selected;
+        const paymentMethod = this.state.paymentMethods.selected;
+        if (!regionCode) {
+            throw new Error('Region is required. Cannot start quote polling without valid region information.');
+        }
+        if (!token) {
+            throw new Error('Token is required. Cannot start quote polling without a selected token.');
+        }
+        if (!provider) {
+            throw new Error('Provider is required. Cannot start quote polling without a selected provider.');
+        }
+        if (!paymentMethod) {
+            throw new Error('Payment method is required. Cannot start quote polling without a selected payment method.');
+        }
+        // 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],
+                provider: provider.id,
+                forceRefresh: true,
+            }).then((response) => {
+                // Auto-select logic: only when exactly one quote is returned
+                this.update((state) => {
+                    if (response.success.length === 1) {
+                        state.quotes.selected = response.success[0];
+                    }
+                    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);
+                            // Update with fresh quote data, or clear if no longer valid
+                            state.quotes.selected = freshQuote ?? null;
+                        }
+                    }
+                });
+                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.
+     *
+     * @param quote - The quote to select, or null to clear the selection.
+     */
+    setSelectedQuote(quote) {
+        this.update((state) => {
+            state.quotes.selected = quote;
+        });
+    }
+    /**
+     * 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();
+    }
     /**
      * Extracts the widget URL from a quote for redirect providers.
      * Returns the widget URL if available, or null if the quote doesn't have one.
@@ -833,7 +961,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() {
     const types = [
         'providers',
         'tokens',
@@ -849,12 +977,25 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
         delete requests[cacheKey];
     });
 }, _RampsController_cleanupState = function _RampsController_cleanupState() {
+    this.stopQuotePolling();
     __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_updateResourceField = function _RampsController_updateResourceField(resourceType, field, value) {
     this.update((state) => {
         const resource = state[resourceType];