@metamask-previews/ramps-controller 20.0.0-preview-12019cffe → 20.0.0-preview-a2a428472

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -14,7 +14,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
14
14
  - Request-only by default (`updateState` unset/false): does not mutate Buy `paymentMethods.data` / `.selected`.
15
15
  - Fans out per contributing provider, dedupes by canonical payment id, and merges collision metadata (conservative delay, best score, deterministic name/icon).
16
16
  - Returns a single provider's payment-method list unchanged; collision merging applies only to multi-provider fan-out.
17
+ - Normalizes stored region codes before stateful context writes while keeping missing-region checks fail-closed.
17
18
  - Partial provider failures still return methods from successful fetches.
19
+ - Restores an older pending same-context request as the state-write candidate when a newer stateful request fails, while successful newer requests still take precedence.
18
20
  - Export `TERMINAL_ORDER_STATUSES` and `isTerminalOrderStatus()` so consuming clients can share the controller's terminal order status set instead of maintaining duplicate copies. ([#9679](https://github.com/MetaMask/core/pull/9679))
19
21
 
20
22
  ## [20.0.0]
@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
10
10
  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");
11
11
  return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
12
  };
13
- var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_paymentMethodsContextSequence, _RampsController_latestPaymentMethodsContextSequence, _RampsController_pendingPaymentMethodsContextCount, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_resolveAllProvidersFlag, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_beginPaymentMethodsContextRequest, _RampsController_isLatestPaymentMethodsContextRequest, _RampsController_finishPaymentMethodsContextRequest, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_syncUserRegionFromCountriesCatalog, _RampsController_pickWidenedQuote, _RampsController_getSupportingProvidersForRegion, _RampsController_filterProviderIdsBySupport, _RampsController_resolveProviderIdsForQuote, _RampsController_resolveProviderIdsForPaymentMethods, _RampsController_getPreferredProviderIdsFromOrders, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
13
+ var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_paymentMethodsContextSequence, _RampsController_latestPaymentMethodsContextSequence, _RampsController_pendingPaymentMethodsContextSequences, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_resolveAllProvidersFlag, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_beginPaymentMethodsContextRequest, _RampsController_isLatestPaymentMethodsContextRequest, _RampsController_failPaymentMethodsContextRequest, _RampsController_finishPaymentMethodsContextRequest, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_syncUserRegionFromCountriesCatalog, _RampsController_pickWidenedQuote, _RampsController_getSupportingProvidersForRegion, _RampsController_filterProviderIdsBySupport, _RampsController_resolveProviderIdsForQuote, _RampsController_resolveProviderIdsForPaymentMethods, _RampsController_getPreferredProviderIdsFromOrders, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.RampsController = exports.getInternalOrderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
16
16
  const base_controller_1 = require("@metamask/base-controller");
@@ -483,7 +483,7 @@ class RampsController extends base_controller_1.BaseController {
483
483
  _RampsController_initPromise.set(this, null);
484
484
  _RampsController_paymentMethodsContextSequence.set(this, 0);
485
485
  _RampsController_latestPaymentMethodsContextSequence.set(this, new Map());
486
- _RampsController_pendingPaymentMethodsContextCount.set(this, new Map());
486
+ _RampsController_pendingPaymentMethodsContextSequences.set(this, new Map());
487
487
  __classPrivateFieldSet(this, _RampsController_requestCacheTTL, requestCacheTTL, "f");
488
488
  __classPrivateFieldSet(this, _RampsController_requestCacheMaxSize, requestCacheMaxSize, "f");
489
489
  this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
@@ -1039,7 +1039,8 @@ class RampsController extends base_controller_1.BaseController {
1039
1039
  if (providerIds.length === 0) {
1040
1040
  if (updateState) {
1041
1041
  this.update((state) => {
1042
- const regionMatches = state.userRegion?.regionCode === normalizedRegion;
1042
+ const regionMatches = state.userRegion?.regionCode?.trim().toLowerCase() ===
1043
+ normalizedRegion;
1043
1044
  const assetMatches = normalizeAssetIdForContext(state.tokens.selected?.assetId ?? '') === normalizedAssetContext;
1044
1045
  const providerMatches = (state.providers.selected?.id.trim() ?? '') ===
1045
1046
  providerIdForState;
@@ -1101,7 +1102,8 @@ class RampsController extends base_controller_1.BaseController {
1101
1102
  null;
1102
1103
  if (updateState) {
1103
1104
  this.update((state) => {
1104
- const regionMatches = state.userRegion?.regionCode === normalizedRegion;
1105
+ const regionMatches = state.userRegion?.regionCode?.trim().toLowerCase() ===
1106
+ normalizedRegion;
1105
1107
  const assetMatches = normalizeAssetIdForContext(state.tokens.selected?.assetId ?? '') ===
1106
1108
  normalizedAssetContext;
1107
1109
  const providerMatches = (state.providers.selected?.id.trim() ?? '') === providerIdForState;
@@ -1129,9 +1131,15 @@ class RampsController extends base_controller_1.BaseController {
1129
1131
  }
1130
1132
  return { methods, selected, providerIds };
1131
1133
  }
1134
+ catch (error) {
1135
+ if (requestSequence !== null) {
1136
+ __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_failPaymentMethodsContextRequest).call(this, stateContextKey, requestSequence);
1137
+ }
1138
+ throw error;
1139
+ }
1132
1140
  finally {
1133
1141
  if (requestSequence !== null) {
1134
- __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_finishPaymentMethodsContextRequest).call(this, stateContextKey);
1142
+ __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_finishPaymentMethodsContextRequest).call(this, stateContextKey, requestSequence);
1135
1143
  }
1136
1144
  }
1137
1145
  }
@@ -1996,7 +2004,7 @@ class RampsController extends base_controller_1.BaseController {
1996
2004
  }
1997
2005
  }
1998
2006
  exports.RampsController = RampsController;
1999
- _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_pendingResourceGeneration = new WeakMap(), _RampsController_orderPollingMeta = new WeakMap(), _RampsController_orderPollingTimer = new WeakMap(), _RampsController_isPolling = new WeakMap(), _RampsController_initPromise = new WeakMap(), _RampsController_paymentMethodsContextSequence = new WeakMap(), _RampsController_latestPaymentMethodsContextSequence = new WeakMap(), _RampsController_pendingPaymentMethodsContextCount = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
2007
+ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_pendingResourceGeneration = new WeakMap(), _RampsController_orderPollingMeta = new WeakMap(), _RampsController_orderPollingTimer = new WeakMap(), _RampsController_isPolling = new WeakMap(), _RampsController_initPromise = new WeakMap(), _RampsController_paymentMethodsContextSequence = new WeakMap(), _RampsController_latestPaymentMethodsContextSequence = new WeakMap(), _RampsController_pendingPaymentMethodsContextSequences = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
2000
2008
  for (const resourceType of DEPENDENT_RESOURCE_KEYS) {
2001
2009
  __classPrivateFieldGet(this, _RampsController_pendingResourceCount, "f").delete(resourceType);
2002
2010
  const generation = __classPrivateFieldGet(this, _RampsController_pendingResourceGeneration, "f").get(resourceType) ?? 0;
@@ -2054,19 +2062,38 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
2054
2062
  __classPrivateFieldSet(this, _RampsController_paymentMethodsContextSequence, __classPrivateFieldGet(this, _RampsController_paymentMethodsContextSequence, "f") + 1, "f");
2055
2063
  const sequence = __classPrivateFieldGet(this, _RampsController_paymentMethodsContextSequence, "f");
2056
2064
  __classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").set(contextKey, sequence);
2057
- const pendingCount = __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextCount, "f").get(contextKey) ?? 0;
2058
- __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextCount, "f").set(contextKey, pendingCount + 1);
2065
+ const pendingSequences = __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextSequences, "f").get(contextKey) ?? new Set();
2066
+ pendingSequences.add(sequence);
2067
+ __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextSequences, "f").set(contextKey, pendingSequences);
2059
2068
  return sequence;
2060
2069
  }, _RampsController_isLatestPaymentMethodsContextRequest = function _RampsController_isLatestPaymentMethodsContextRequest(contextKey, sequence) {
2061
2070
  return (__classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").get(contextKey) === sequence);
2062
- }, _RampsController_finishPaymentMethodsContextRequest = function _RampsController_finishPaymentMethodsContextRequest(contextKey) {
2063
- const pendingCount = __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextCount, "f").get(contextKey) ?? 0;
2064
- if (pendingCount <= 1) {
2065
- __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextCount, "f").delete(contextKey);
2066
- __classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").delete(contextKey);
2071
+ }, _RampsController_failPaymentMethodsContextRequest = function _RampsController_failPaymentMethodsContextRequest(contextKey, sequence) {
2072
+ if (__classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").get(contextKey) !== sequence) {
2067
2073
  return;
2068
2074
  }
2069
- __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextCount, "f").set(contextKey, pendingCount - 1);
2075
+ const pendingSequences = __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextSequences, "f").get(contextKey);
2076
+ let latestEarlierSequence;
2077
+ for (const pendingSequence of pendingSequences ?? []) {
2078
+ if (pendingSequence < sequence &&
2079
+ (latestEarlierSequence === undefined ||
2080
+ pendingSequence > latestEarlierSequence)) {
2081
+ latestEarlierSequence = pendingSequence;
2082
+ }
2083
+ }
2084
+ if (latestEarlierSequence === undefined) {
2085
+ __classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").delete(contextKey);
2086
+ }
2087
+ else {
2088
+ __classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").set(contextKey, latestEarlierSequence);
2089
+ }
2090
+ }, _RampsController_finishPaymentMethodsContextRequest = function _RampsController_finishPaymentMethodsContextRequest(contextKey, sequence) {
2091
+ const pendingSequences = __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextSequences, "f").get(contextKey);
2092
+ pendingSequences?.delete(sequence);
2093
+ if (!pendingSequences || pendingSequences.size === 0) {
2094
+ __classPrivateFieldGet(this, _RampsController_pendingPaymentMethodsContextSequences, "f").delete(contextKey);
2095
+ __classPrivateFieldGet(this, _RampsController_latestPaymentMethodsContextSequence, "f").delete(contextKey);
2096
+ }
2070
2097
  }, _RampsController_updateResourceField = function _RampsController_updateResourceField(resourceType, field, value) {
2071
2098
  this.update((state) => {
2072
2099
  const resource = getResourceState(state, resourceType);