@metamask-previews/ramps-controller 10.1.0-preview-968b2b4f4 → 10.2.0-preview-93519965c

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `status` field to `ResourceState` to distinguish between uninitialized and empty-fetched states ([#8116](https://github.com/MetaMask/core/pull/8116))
+
+## [10.2.0]
+
+### Fixed
+
+- `setSelectedProvider` no longer fetches payment methods when the selected token is explicitly not supported by the new provider, preventing empty payment method state with no user feedback ([#8103](https://github.com/MetaMask/core/pull/8103))
+
 ## [10.1.0]
 
 ### Added
@@ -192,7 +202,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@10.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@10.2.0...HEAD
+[10.2.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@10.1.0...@metamask/ramps-controller@10.2.0
 [10.1.0]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@10.0.0...@metamask/ramps-controller@10.1.0
 [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

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_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_registerActionHandlers, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceFields, _RampsController_setResourceError, _RampsController_setResourceLoadingAndStatus, _RampsController_updateRequestState, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _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");
@@ -136,6 +136,7 @@ function createDefaultResourceState(data, selected = null) {
         selected,
         isLoading: false,
         error: null,
+        status: RequestCache_1.RequestStatus.IDLE,
     };
 }
 /**
@@ -179,6 +180,7 @@ function resetResource(state, resourceType, defaultResource) {
     resource.selected = def.selected;
     resource.isLoading = def.isLoading;
     resource.error = def.error;
+    resource.status = def.status;
 }
 /**
  * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods).
@@ -382,11 +384,12 @@ class RampsController extends base_controller_1.BaseController {
             const count = __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").get(resourceType) ?? 0;
             __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").set(resourceType, count + 1);
             if (count === 0) {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, resourceType, true);
+                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoadingAndStatus).call(this, resourceType, true, RequestCache_1.RequestStatus.LOADING);
             }
         }
         // Create the fetch promise
         const promise = (async () => {
+            let terminalStatus;
             try {
                 const data = await fetcher(abortController.signal);
                 if (abortController.signal.aborted) {
@@ -397,6 +400,7 @@ class RampsController extends base_controller_1.BaseController {
                     const isCurrent = !options?.isResultCurrent || options.isResultCurrent();
                     if (isCurrent) {
                         __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, resourceType, null);
+                        terminalStatus = RequestCache_1.RequestStatus.SUCCESS;
                     }
                 }
                 return data;
@@ -411,6 +415,7 @@ class RampsController extends base_controller_1.BaseController {
                     const isCurrent = !options?.isResultCurrent || options.isResultCurrent();
                     if (isCurrent) {
                         __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, resourceType, errorMessage);
+                        terminalStatus = RequestCache_1.RequestStatus.ERROR;
                     }
                 }
                 throw error;
@@ -426,7 +431,7 @@ class RampsController extends base_controller_1.BaseController {
                     const next = Math.max(0, count - 1);
                     if (next === 0) {
                         __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
-                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, resourceType, false);
+                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoadingAndStatus).call(this, resourceType, false, terminalStatus ?? RequestCache_1.RequestStatus.IDLE);
                     }
                     else {
                         __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").set(resourceType, next);
@@ -545,11 +550,21 @@ class RampsController extends base_controller_1.BaseController {
         if (!provider) {
             throw new Error(`Provider with ID "${providerId}" not found in available providers.`);
         }
+        const selectedToken = this.state.tokens.selected;
+        const supportedCryptos = provider.supportedCryptoCurrencies;
+        // Only fetch payment methods if the selected token is supported by the new
+        // provider. If it isn't, the payment methods request would fail or return
+        // empty for the wrong reason; the UI will show the Token Not Available modal
+        // so the user can change token or pick a different provider.
+        const assetId = selectedToken?.assetId;
+        const tokenSupportedByProvider = !(assetId && supportedCryptos?.[assetId] === false);
         this.update((state) => {
             state.providers.selected = provider;
             resetResource(state, 'paymentMethods');
         });
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, this.getPaymentMethods(regionCode, { provider: provider.id }));
+        if (tokenSupportedByProvider) {
+            __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.
@@ -949,7 +964,7 @@ class RampsController extends base_controller_1.BaseController {
         }
         try {
             const buyWidget = await this.messenger.call('RampsService:getBuyWidgetUrl', buyUrl);
-            return buyWidget.url ?? null;
+            return buyWidget.url;
         }
         catch {
             return null;
@@ -1434,17 +1449,19 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
 }, _RampsController_isProviderCurrent = function _RampsController_isProviderCurrent(normalizedProviderId) {
     const current = this.state.providers.selected?.id ?? '';
     return current === normalizedProviderId;
-}, _RampsController_updateResourceField = function _RampsController_updateResourceField(resourceType, field, value) {
+}, _RampsController_updateResourceFields = function _RampsController_updateResourceFields(resourceType, fields) {
     this.update((state) => {
         const resource = state[resourceType];
         if (resource) {
-            resource[field] = value;
+            for (const [field, value] of Object.entries(fields)) {
+                resource[field] = value;
+            }
         }
     });
-}, _RampsController_setResourceLoading = function _RampsController_setResourceLoading(resourceType, loading) {
-    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceField).call(this, resourceType, 'isLoading', loading);
 }, _RampsController_setResourceError = function _RampsController_setResourceError(resourceType, error) {
-    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceField).call(this, resourceType, 'error', error);
+    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceFields).call(this, resourceType, { error });
+}, _RampsController_setResourceLoadingAndStatus = function _RampsController_setResourceLoadingAndStatus(resourceType, loading, status) {
+    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceFields).call(this, resourceType, { isLoading: loading, status });
 }, _RampsController_updateRequestState = function _RampsController_updateRequestState(cacheKey, requestState) {
     const maxSize = __classPrivateFieldGet(this, _RampsController_requestCacheMaxSize, "f");
     const ttl = __classPrivateFieldGet(this, _RampsController_requestCacheTTL, "f");