@metamask-previews/ramps-controller 9.0.0-preview-d1f62d044 → 9.0.0-preview-56789ec91

package/CHANGELOG.md

@@ -9,9 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.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))
 

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_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_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");
@@ -101,6 +101,18 @@ 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,
@@ -146,6 +158,8 @@ function getDefaultRampsControllerState() {
         providers: createDefaultResourceState([], null),
         tokens: createDefaultResourceState(null, null),
         paymentMethods: createDefaultResourceState([], null),
+        quotes: createDefaultResourceState(null, null),
+        widgetUrl: createDefaultResourceState(null),
         requests: {},
         nativeProviders: {
             transak: {
@@ -162,6 +176,7 @@ const DEPENDENT_RESOURCE_KEYS = [
     'providers',
     'tokens',
     'paymentMethods',
+    'quotes',
 ];
 const DEPENDENT_RESOURCE_KEYS_SET = new Set(DEPENDENT_RESOURCE_KEYS);
 function resetResource(state, resourceType, defaultResource) {
@@ -173,7 +188,20 @@ function resetResource(state, resourceType, defaultResource) {
     resource.error = def.error;
 }
 /**
- * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods).
+ * 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).
  * Mutates state in place; use from within controller update() for atomic updates.
  *
  * @param state - The state object to mutate.
@@ -188,6 +216,7 @@ function resetDependentResources(state, options) {
     for (const key of DEPENDENT_RESOURCE_KEYS) {
         resetResource(state, key, defaultState[key]);
     }
+    resetWidgetUrl(state);
 }
 // === HELPER FUNCTIONS ===
 /**
@@ -521,6 +550,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 }));
     }
@@ -630,6 +661,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 }));
     }
@@ -766,7 +799,7 @@ class RampsController extends base_controller_1.BaseController {
     }
     /**
      * Fetches quotes from all providers for a given set of parameters.
-     * Uses the controller's request cache; callers manage the response in local state.
+     * The quotes are saved in the controller state once fetched.
      *
      * @param options - The parameters for fetching quotes.
      * @param options.region - User's region code. If not provided, uses userRegion from state.
@@ -835,12 +868,91 @@ class RampsController extends base_controller_1.BaseController {
             redirectUrl: options.redirectUrl,
             action,
         };
-        return this.executeRequest(cacheKey, async () => {
+        const response = await 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;
+    }
+    /**
+     * Fetches quotes for the currently selected token, provider, and payment method.
+     * 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.
+     */
+    fetchQuotesForSelection(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.');
+        }
+        if (!provider) {
+            throw new Error('Provider is required. Cannot fetch quotes 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;
+                        state.quotes.selected = newSelectedQuote;
+                    }
+                }
+            });
+            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncWidgetUrl).call(this, newSelectedQuote);
+            return undefined;
+        }));
+    }
+    /**
+     * 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.
@@ -852,10 +964,12 @@ class RampsController extends base_controller_1.BaseController {
     /**
      * 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.
+     * actual provider widget URL, using the injected fetch and retry policy.
      *
      * @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;
@@ -1375,6 +1489,39 @@ _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 &&