@metamask/ramps-controller 8.1.0 → 10.0.0

package/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [10.0.0]
+
+### Changed
+
+- **BREAKING:** Remove `state.quotes` and `state.widgetUrl` from RampsController state. Quote and widget URL data are now managed by consuming components ([#8013](https://github.com/MetaMask/core/pull/8013))
+- **BREAKING:** Remove `fetchQuotesForSelection()` and `setSelectedQuote()`. Components call `getQuotes()` directly and manage selection locally ([#8013](https://github.com/MetaMask/core/pull/8013))
+- Simplify `getWidgetUrl()` to a pure fetch-and-return API; it no longer reads or writes controller state ([#8013](https://github.com/MetaMask/core/pull/8013))
+- 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))
+
+### Fixed
+
+- Fix RampsController flaky test ([#8018](https://github.com/MetaMask/core/pull/8018))
+
+## [9.0.0]
+
+### Added
+
+- Add `getOrder` and `getOrderFromCallback` methods to `RampsService` and `RampsController` for V2 unified order polling, along with new `RampsOrder`, `RampsOrderFiatCurrency`, `RampsOrderCryptoCurrency`, `RampsOrderPaymentMethod`, and `RampsOrderStatus` types ([#7934](https://github.com/MetaMask/core/pull/7934))
+
+### Changed
+
+- **BREAKING:** Use concrete types in `RampsOrder` instead of `string | Object` unions for `provider`, `cryptoCurrency`, `fiatCurrency`, `paymentMethod`, and `network` fields ([#8000](https://github.com/MetaMask/core/pull/8000))
+- Bump `@metamask/controller-utils` from `^11.18.0` to `^11.19.0` ([#7995](https://github.com/MetaMask/core/pull/7995))
+
 ## [8.1.0]
 
 ### Added
@@ -153,7 +183,9 @@ 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@8.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@10.0.0...HEAD
+[10.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@9.0.0...@metamask/ramps-controller@10.0.0
+[9.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@8.1.0...@metamask/ramps-controller@9.0.0
 [8.1.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@8.0.0...@metamask/ramps-controller@8.1.0
 [8.0.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@7.1.0...@metamask/ramps-controller@8.0.0
 [7.1.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@7.0.0...@metamask/ramps-controller@7.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_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;
+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_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");
@@ -35,6 +35,8 @@ exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = [
     'RampsService:getPaymentMethods',
     'RampsService:getQuotes',
     'RampsService:getBuyWidgetUrl',
+    'RampsService:getOrder',
+    'RampsService:getOrderFromCallback',
     'TransakService:setApiKey',
     'TransakService:setAccessToken',
     'TransakService:clearAccessToken',
@@ -99,18 +101,6 @@ const rampsControllerMetadata = {
         includeInStateLogs: true,
         usedInUi: true,
     },
-    quotes: {
-        persist: false,
-        includeInDebugSnapshot: true,
-        includeInStateLogs: false,
-        usedInUi: true,
-    },
-    widgetUrl: {
-        persist: false,
-        includeInDebugSnapshot: true,
-        includeInStateLogs: false,
-        usedInUi: true,
-    },
     requests: {
         persist: false,
         includeInDebugSnapshot: true,
@@ -156,8 +146,6 @@ function getDefaultRampsControllerState() {
         providers: createDefaultResourceState([], null),
         tokens: createDefaultResourceState(null, null),
         paymentMethods: createDefaultResourceState([], null),
-        quotes: createDefaultResourceState(null, null),
-        widgetUrl: createDefaultResourceState(null),
         requests: {},
         nativeProviders: {
             transak: {
@@ -174,7 +162,6 @@ const DEPENDENT_RESOURCE_KEYS = [
     'providers',
     'tokens',
     'paymentMethods',
-    'quotes',
 ];
 const DEPENDENT_RESOURCE_KEYS_SET = new Set(DEPENDENT_RESOURCE_KEYS);
 function resetResource(state, resourceType, defaultResource) {
@@ -186,20 +173,7 @@ function resetResource(state, resourceType, defaultResource) {
     resource.error = def.error;
 }
 /**
- * Resets the widgetUrl resource to its default state.
- * Mutates state in place; use from within controller update() for atomic updates.
- *
- * @param state - The state object to mutate.
- */
-function resetWidgetUrl(state) {
-    const def = getDefaultRampsControllerState().widgetUrl;
-    state.widgetUrl.data = def.data;
-    state.widgetUrl.selected = def.selected;
-    state.widgetUrl.isLoading = def.isLoading;
-    state.widgetUrl.error = def.error;
-}
-/**
- * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods, quotes).
+ * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods).
  * Mutates state in place; use from within controller update() for atomic updates.
  *
  * @param state - The state object to mutate.
@@ -214,7 +188,6 @@ function resetDependentResources(state, options) {
     for (const key of DEPENDENT_RESOURCE_KEYS) {
         resetResource(state, key, defaultState[key]);
     }
-    resetWidgetUrl(state);
 }
 // === HELPER FUNCTIONS ===
 /**
@@ -324,16 +297,6 @@ 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");
     }
@@ -504,7 +467,6 @@ 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) {
@@ -541,7 +503,6 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedProvider(providerId) {
         if (providerId === null) {
-            this.stopQuotePolling();
             this.update((state) => {
                 state.providers.selected = null;
                 resetResource(state, 'paymentMethods');
@@ -560,14 +521,8 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.providers.selected = provider;
             resetResource(state, 'paymentMethods');
-            state.quotes.selected = null;
-            resetWidgetUrl(state);
         });
-        __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;
-        }));
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { provider: provider.id }));
     }
     /**
      * Initializes the controller by fetching the user's region from geolocation.
@@ -656,7 +611,6 @@ class RampsController extends base_controller_1.BaseController {
      */
     setSelectedToken(assetId) {
         if (!assetId) {
-            this.stopQuotePolling();
             this.update((state) => {
                 state.tokens.selected = null;
                 resetResource(state, 'paymentMethods');
@@ -676,13 +630,8 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.tokens.selected = token;
             resetResource(state, 'paymentMethods');
-            state.quotes.selected = null;
-            resetWidgetUrl(state);
         });
-        __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;
-        }));
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { assetId: token.assetId }));
     }
     /**
      * Fetches the list of providers for a given region.
@@ -814,12 +763,10 @@ 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.
-     * The quotes are saved in the controller state once fetched.
+     * Uses the controller's request cache; callers manage the response in local state.
      *
      * @param options - The parameters for fetching quotes.
      * @param options.region - User's region code. If not provided, uses userRegion from state.
@@ -888,135 +835,27 @@ class RampsController extends base_controller_1.BaseController {
             redirectUrl: options.redirectUrl,
             action,
         };
-        const response = await this.executeRequest(cacheKey, async () => {
+        return this.executeRequest(cacheKey, async () => {
             return this.messenger.call('RampsService:getQuotes', params);
         }, {
             forceRefresh: options.forceRefresh,
             ttl: options.ttl ?? DEFAULT_QUOTES_TTL,
-            resourceType: 'quotes',
-            isResultCurrent: () => __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_isRegionCurrent).call(this, normalizedRegion),
-        });
-        this.update((state) => {
-            const userRegionCode = state.userRegion?.regionCode;
-            if (userRegionCode === undefined || userRegionCode === normalizedRegion) {
-                state.quotes.data = response;
-            }
-        });
-        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.
-     *
-     * Returns early (no-op) if the selected payment method is not yet set,
-     * allowing callers to invoke this before payment-method selection is finalized.
-     *
-     * @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) are not set.
-     */
-    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 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) {
-            return;
-        }
-        // 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;
-                    }
-                    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.
-     * Automatically triggers a widget URL fetch for the new quote.
-     *
-     * @param quote - The quote to select, or null to clear the selection.
-     */
-    setSelectedQuote(quote) {
-        this.update((state) => {
-            state.quotes.selected = quote;
         });
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncWidgetUrl).call(this, 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();
     }
     /**
      * Fetches the widget URL from a quote for redirect providers.
      * Makes a request to the buyURL endpoint via the RampsService to get the
-     * actual provider widget URL, using the injected fetch and retry policy.
+     * actual provider widget URL.
      *
      * @param quote - The quote to fetch the widget URL from.
      * @returns Promise resolving to the widget URL string, or null if not available.
-     * @deprecated Read `state.widgetUrl` instead. The widget URL is now automatically
-     * fetched and stored in state whenever the selected quote changes.
      */
     async getWidgetUrl(quote) {
         const buyUrl = quote.quote?.buyURL;
@@ -1031,6 +870,32 @@ class RampsController extends base_controller_1.BaseController {
             return null;
         }
     }
+    /**
+     * Fetches an order from the unified V2 API endpoint.
+     * Returns a normalized RampsOrder for all provider types (aggregator and native).
+     *
+     * @param providerCode - The provider code (e.g., "transak", "transak-native", "moonpay").
+     * @param orderCode - The order identifier.
+     * @param wallet - The wallet address associated with the order.
+     * @returns The unified order data.
+     */
+    async getOrder(providerCode, orderCode, wallet) {
+        return await this.messenger.call('RampsService:getOrder', providerCode, orderCode, wallet);
+    }
+    /**
+     * Extracts an order from a provider callback URL.
+     * Sends the callback URL to the V2 backend for provider-specific parsing,
+     * then fetches the full order. This is the V2 equivalent of the aggregator
+     * SDK's `getOrderFromCallback`.
+     *
+     * @param providerCode - The provider code (e.g., "transak", "moonpay").
+     * @param callbackUrl - The full callback URL the provider redirected to.
+     * @param wallet - The wallet address associated with the order.
+     * @returns The unified order data.
+     */
+    async getOrderFromCallback(providerCode, callbackUrl, wallet) {
+        return await this.messenger.call('RampsService:getOrderFromCallback', providerCode, callbackUrl, wallet);
+    }
     /**
      * Sets the Transak API key used for all Transak API requests.
      *
@@ -1427,7 +1292,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_quotePollingInterval = new WeakMap(), _RampsController_quotePollingOptions = 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_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
     for (const resourceType of DEPENDENT_RESOURCE_KEYS) {
         __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
     }
@@ -1450,24 +1315,11 @@ _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) {
@@ -1523,39 +1375,6 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
             }
         }
     });
-}, _RampsController_syncWidgetUrl = function _RampsController_syncWidgetUrl(quote) {
-    const buyUrl = quote?.quote?.buyURL;
-    if (!buyUrl) {
-        this.update((state) => {
-            resetWidgetUrl(state);
-        });
-        return;
-    }
-    if (this.state.widgetUrl.data === null) {
-        this.update((state) => {
-            state.widgetUrl.isLoading = true;
-            state.widgetUrl.error = null;
-        });
-    }
-    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.messenger
-        .call('RampsService:getBuyWidgetUrl', buyUrl)
-        .then((buyWidget) => {
-        this.update((state) => {
-            state.widgetUrl.data = buyWidget;
-            state.widgetUrl.isLoading = false;
-            state.widgetUrl.error = null;
-        });
-        return undefined;
-    })
-        .catch((error) => {
-        this.update((state) => {
-            state.widgetUrl.isLoading = false;
-            state.widgetUrl.error =
-                error instanceof Error
-                    ? error.message
-                    : 'Failed to fetch widget URL';
-        });
-    }));
 }, _RampsController_syncTransakAuthOnError = function _RampsController_syncTransakAuthOnError(error) {
     if (error instanceof Error &&
         'httpStatus' in error &&