@metamask-previews/ramps-controller 20.2.0-preview-e12b5ece6 → 20.2.0-preview-e0510042f

package/dist/RampsController.cjs

@@ -10,22 +10,18 @@ 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_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_resolveAllProvidersFlag, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _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_applyAutorampRemoteSnapshot, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_resolveAllProvidersFlag, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _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;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RampsController = exports.getInternalOrderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_CONTROLLER_ACTIONS = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
+exports.RampsController = exports.getInternalOrderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
-const autorampAccount_js_1 = require("./autorampAccount.cjs");
 const featureFlags_js_1 = require("./featureFlags.cjs");
 const orderStatus_js_1 = require("./orderStatus.cjs");
-const ownership_message_js_1 = require("./ownership-message.cjs");
 const paymentMethodMerge_js_1 = require("./paymentMethodMerge.cjs");
 const providerAvailability_js_1 = require("./providerAvailability.cjs");
 const rampsErrorCodes_js_1 = require("./rampsErrorCodes.cjs");
 const RampsService_js_1 = require("./RampsService.cjs");
 const RequestCache_js_1 = require("./RequestCache.cjs");
-const wallet_registration_machine_js_1 = require("./wallet-registration-machine.cjs");
-const wallet_registration_service_js_1 = require("./wallet-registration-service.cjs");
 // === GENERAL ===
 /**
  * The name of the {@link RampsController}, used to namespace the
@@ -74,36 +70,7 @@ exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = [
     'TransakService:cancelOrder',
     'TransakService:cancelAllActiveOrders',
     'TransakService:getActiveOrders',
-    'NeoBankService:getAutoramp',
-    'NeoBankService:createAutoramp',
-    'NeoBankService:getCustomerByExternalId',
-    'NeoBankService:getWalletRegistrationStatus',
-    'NeoBankService:registerSelfHostedWallet',
 ];
-/**
- * Every external controller action RampsController calls via the messenger,
- * which hosts must delegate from the root messenger.
- * `AuthenticationController:getSessionProfile` resolves the vendor customer
- * identity from Profile Sync, and `KeyringController:signPersonalMessage` signs
- * the EIP-191 ownership proof for Money Account self-hosted wallet
- * registration; both are only exercised by the autoramp paths.
- */
-exports.RAMPS_CONTROLLER_REQUIRED_CONTROLLER_ACTIONS = [
-    'AuthenticationController:getSessionProfile',
-    'KeyringController:signPersonalMessage',
-    'RemoteFeatureFlagController:getState',
-];
-/**
- * Distinguishes an already-materialized {@link AutorampAccount} from the
- * create-fields shape accepted by {@link RampsController.addAutoramp}.
- *
- * @param value - Full account or create fields.
- * @returns Whether the value already carries the derived account fields.
- */
-function isFullAutorampAccount(value) {
-    return (typeof value.updatedAt === 'number' &&
-        value.lastSeenStatus !== undefined);
-}
 /**
  * Default TTL for quotes requests (15 seconds).
  * Quotes are time-sensitive and should have a shorter cache duration.
@@ -215,12 +182,6 @@ const rampsControllerMetadata = {
         includeInStateLogs: true,
         usedInUi: true,
     },
-    autoramps: {
-        persist: true,
-        includeInDebugSnapshot: true,
-        includeInStateLogs: true,
-        usedInUi: true,
-    },
     providerAutoSelected: {
         persist: true,
         includeInDebugSnapshot: true,
@@ -270,7 +231,6 @@ function getDefaultRampsControllerState() {
             },
         },
         orders: [],
-        autoramps: [],
         providerAutoSelected: false,
     };
 }
@@ -418,14 +378,6 @@ const MESSENGER_EXPOSED_METHODS = [
     'getQuotes',
     'addOrder',
     'removeOrder',
-    'addAutoramp',
-    'createAutoramp',
-    'removeAutoramp',
-    'registerMoneyAccountWallet',
-    'markAutorampAsNotified',
-    'applyAutorampStatusFromPush',
-    'refreshAutoramp',
-    'refreshAutoramps',
     'startOrderPolling',
     'stopOrderPolling',
     'getBuyWidgetData',
@@ -1227,6 +1179,12 @@ class RampsController extends base_controller_1.BaseController {
      * @param options.action - The ramp action type. Defaults to 'buy'.
      * @param options.forceRefresh - Whether to bypass cache.
      * @param options.ttl - Custom TTL for this request.
+     * @param options.isFeeExcludedFromFiat - When true, requests quotes whose
+     *   fees are charged on top of `amount` rather than taken out of it, so
+     *   `amountOut` is what `amount` buys before fees. The ramps API honours it
+     *   only when the request names exactly one provider, because a fee-on-top
+     *   `amountOut` cannot be ranked against fee-inclusive ones. Defaults to the
+     *   existing fee-inclusive behaviour.
      * @returns The quotes response containing success, sorted, error, and customActions.
      */
     async getQuotes(options) {
@@ -1257,7 +1215,12 @@ class RampsController extends base_controller_1.BaseController {
         const { enabled: allProvidersEnabled, allowlist: providerAllowlist } = wantsAutoSelection
             ? __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_resolveAllProvidersFlag).call(this)
             : { enabled: false, allowlist: undefined };
-        const widenToAllProviders = wantsAutoSelection && allProvidersEnabled;
+        // Fee-on-top quotes cannot be ranked against fee-inclusive quotes because
+        // their amountOut values have different meanings. Keep this request on the
+        // single-provider resolver even when all-provider widening is enabled.
+        const widenToAllProviders = wantsAutoSelection &&
+            allProvidersEnabled &&
+            options.isFeeExcludedFromFiat !== true;
         let providersToUse;
         let widenedProviderCatalog = this.state.providers.data;
         if (options.providers) {
@@ -1333,6 +1296,7 @@ class RampsController extends base_controller_1.BaseController {
             (widenToAllProviders
                 ? this.messenger.call('RampsService:getDefaultRedirectCallbackUrl')
                 : undefined);
+        const isFeeExcludedFromFiat = options.isFeeExcludedFromFiat === true;
         const cacheKey = (0, RequestCache_js_1.createCacheKey)('getQuotes', [
             normalizedRegion,
             normalizedFiat,
@@ -1343,6 +1307,7 @@ class RampsController extends base_controller_1.BaseController {
             [...providersToUse].sort().join(','),
             effectiveRedirectUrl,
             action,
+            isFeeExcludedFromFiat,
         ]);
         const params = {
             region: normalizedRegion,
@@ -1354,6 +1319,7 @@ class RampsController extends base_controller_1.BaseController {
             providers: providersToUse,
             redirectUrl: effectiveRedirectUrl,
             action,
+            isFeeExcludedFromFiat,
         };
         const response = await this.executeRequest(cacheKey, async () => {
             return this.messenger.call('RampsService:getQuotes', params);
@@ -1431,304 +1397,6 @@ class RampsController extends base_controller_1.BaseController {
         });
         __classPrivateFieldGet(this, _RampsController_orderPollingMeta, "f").delete(providerOrderId);
     }
-    /**
-     * Adds or updates a local autoramp last-seen cursor (e.g. after create).
-     *
-     * @param accountOrInput - Full account or create fields.
-     * @returns The upserted {@link AutorampAccount}.
-     */
-    addAutoramp(accountOrInput) {
-        const account = isFullAutorampAccount(accountOrInput)
-            ? accountOrInput
-            : (0, autorampAccount_js_1.createAutorampAccount)(accountOrInput);
-        this.update((state) => {
-            const idx = state.autoramps.findIndex((existing) => existing.id === account.id);
-            if (idx === -1) {
-                state.autoramps.push(account);
-            }
-            else {
-                state.autoramps[idx] = {
-                    ...state.autoramps[idx],
-                    ...account,
-                };
-            }
-        });
-        return (this.state.autoramps.find((existing) => existing.id === account.id) ??
-            account);
-    }
-    /**
-     * Creates an autoramp via the neo-bank proxy and applies the returned
-     * snapshot as the local last-seen cursor.
-     *
-     * The vendor `customer_id` is resolved via
-     * {@link RampsController.resolveAutorampCustomerId} and injected into the
-     * request (any caller-supplied `customer_id` is overwritten).
-     *
-     * @param request - CreateAutoramp payload.
-     * @param options - Optional idempotency key forwarded to the proxy.
-     * @param options.idempotencyKey - Value sent as `Idempotency-Key`.
-     * @returns The created/updated local {@link AutorampAccount}.
-     */
-    async createAutoramp(request, options = {}) {
-        const customerId = await this.resolveAutorampCustomerId();
-        const body = { ...request, customer_id: customerId };
-        const remote = await this.messenger.call('NeoBankService:createAutoramp', body, options);
-        return __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_applyAutorampRemoteSnapshot).call(this, remote);
-    }
-    /**
-     * Resolves the vendor `customer_id` for autoramp / Money Account operations.
-     *
-     * Maps the wallet's Profile Sync id (the partner `external_id`) to the
-     * vendor customer via `GET /neobank/customers/{external_id}/external`.
-     *
-     * @returns The vendor customer id.
-     */
-    async resolveAutorampCustomerId() {
-        const profile = await this.messenger.call('AuthenticationController:getSessionProfile');
-        const canonical = profile?.canonicalProfileId;
-        const externalId = typeof canonical === 'string' && canonical.length > 0
-            ? canonical
-            : profile?.profileId;
-        if (typeof externalId !== 'string' || externalId.length === 0) {
-            throw new Error('Cannot resolve MoonPay customer id: wallet is not signed in to Profile Sync.');
-        }
-        const customer = await this.messenger.call('NeoBankService:getCustomerByExternalId', externalId);
-        const customerId = customer &&
-            typeof customer === 'object' &&
-            typeof customer.id === 'string'
-            ? customer.id
-            : null;
-        if (!customerId) {
-            throw new Error(`Cannot resolve MoonPay customer id: no MoonPay customer is mapped to external id "${externalId}".`);
-        }
-        return customerId;
-    }
-    /**
-     * Registers a Money Account wallet with MoonPay Iron via neobank-proxy.
-     *
-     * @param params - Money Account wallet registration parameters.
-     * @param params.address - Monad Money Account address.
-     * @returns The registration state, or `{ type: 'lookupUnavailable' }` when
-     * the address-list lookup fails (never treated as unregistered).
-     */
-    async registerMoneyAccountWallet({ address, }) {
-        let machine = (0, wallet_registration_machine_js_1.transition)((0, wallet_registration_machine_js_1.createInitialState)(), { type: 'START' });
-        const toExistingResult = (status) => {
-            if (status.type === 'active') {
-                return { type: 'alreadyRegistered', registration: status.registration };
-            }
-            if (status.type === 'disabled') {
-                return {
-                    type: 'registeredDisabled',
-                    registration: status.registration,
-                };
-            }
-            return undefined;
-        };
-        const customerId = await this.resolveAutorampCustomerId();
-        const toLookupUnavailableResult = (error) => {
-            machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                type: 'LOOKUP_FAILED',
-            });
-            return {
-                type: 'lookupUnavailable',
-                error: error instanceof wallet_registration_service_js_1.WalletRegistrationError
-                    ? error
-                    : new wallet_registration_service_js_1.WalletRegistrationError('lookupUnavailable', {
-                        message: 'self-hosted address lookup failed',
-                        body: error instanceof Error ? error.message : undefined,
-                    }),
-            };
-        };
-        const lookup = async () => {
-            try {
-                return await this.messenger.call('NeoBankService:getWalletRegistrationStatus', { customerId, address });
-            }
-            catch (error) {
-                return toLookupUnavailableResult(error);
-            }
-        };
-        const applyLookup = (status) => {
-            let eventType = 'LOOKUP_ABSENT';
-            if (status.type === 'active') {
-                eventType = 'LOOKUP_ACTIVE';
-            }
-            else if (status.type === 'disabled') {
-                eventType = 'LOOKUP_DISABLED';
-            }
-            machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                type: eventType,
-            });
-            return toExistingResult(status);
-        };
-        const resolveLookup = async () => {
-            const status = await lookup();
-            if (status.type === 'lookupUnavailable') {
-                return status;
-            }
-            return applyLookup(status);
-        };
-        const existingResult = await resolveLookup();
-        if (existingResult) {
-            return existingResult;
-        }
-        let idempotencyKey = (0, wallet_registration_service_js_1.createIdempotencyKey)();
-        let lastMessage;
-        while (true) {
-            const message = (0, ownership_message_js_1.buildOwnershipMessage)({
-                address,
-                customerId,
-                now: new Date(),
-            });
-            if (lastMessage !== undefined && message !== lastMessage) {
-                idempotencyKey = (0, wallet_registration_service_js_1.createIdempotencyKey)();
-            }
-            lastMessage = message;
-            let signature;
-            try {
-                signature = await this.messenger.call('KeyringController:signPersonalMessage', { data: message, from: address });
-                machine = (0, wallet_registration_machine_js_1.transition)(machine, { type: 'SIGN_OK' });
-            }
-            catch (error) {
-                machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                    type: 'SIGN_FAILED',
-                    retryable: false,
-                });
-                throw error;
-            }
-            try {
-                const result = await this.messenger.call('NeoBankService:registerSelfHostedWallet', {
-                    address,
-                    customerId,
-                    message,
-                    signature,
-                    idempotencyKey,
-                });
-                machine = (0, wallet_registration_machine_js_1.transition)(machine, { type: 'SUBMIT_OK' });
-                return result;
-            }
-            catch (error) {
-                if (!(error instanceof wallet_registration_service_js_1.WalletRegistrationError)) {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_TERMINAL',
-                    });
-                    throw error;
-                }
-                if (error.kind === 'conflict') {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_CONFLICT',
-                    });
-                }
-                else if (error.kind === 'transient') {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_TRANSIENT',
-                    });
-                }
-                else if (error.kind === 'validation') {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_VALIDATION',
-                        utcRollover: (0, ownership_message_js_1.buildOwnershipMessage)({
-                            address,
-                            customerId,
-                            now: new Date(),
-                        }) !== message,
-                    });
-                }
-                else if (error.kind === 'rateLimited') {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_RATE_LIMITED',
-                    });
-                }
-                else {
-                    machine = (0, wallet_registration_machine_js_1.transition)(machine, {
-                        type: 'SUBMIT_TERMINAL',
-                    });
-                }
-                if (machine.status === 'disambiguate409' ||
-                    machine.status === 'checkThenRetry') {
-                    const reconciledResult = await resolveLookup();
-                    if (reconciledResult) {
-                        return reconciledResult;
-                    }
-                }
-                if (machine.status !== 'signing') {
-                    throw error;
-                }
-            }
-        }
-    }
-    /**
-     * Removes a local autoramp last-seen cursor by id.
-     *
-     * @param autorampId - MoonPay autoramp id.
-     */
-    removeAutoramp(autorampId) {
-        this.update((state) => {
-            state.autoramps = state.autoramps.filter((autoramp) => autoramp.id !== autorampId);
-        });
-    }
-    /**
-     * Marks that the UI has already notified for the autoramp's current status.
-     *
-     * @param autorampId - MoonPay autoramp id.
-     */
-    markAutorampAsNotified(autorampId) {
-        const existing = this.state.autoramps.find((autoramp) => autoramp.id === autorampId);
-        if (!existing) {
-            return;
-        }
-        const notified = (0, autorampAccount_js_1.markAutorampNotified)(existing);
-        this.update((state) => {
-            const idx = state.autoramps.findIndex((autoramp) => autoramp.id === autorampId);
-            if (idx !== -1) {
-                state.autoramps[idx] = notified;
-            }
-        });
-    }
-    /**
-     * Applies a remote autoramp snapshot from a websocket / webhook push.
-     *
-     * @param remote - Remote autoramp snapshot.
-     * @returns The updated local account.
-     */
-    applyAutorampStatusFromPush(remote) {
-        return __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_applyAutorampRemoteSnapshot).call(this, remote);
-    }
-    /**
-     * Fetches one autoramp from the neo-bank proxy and applies it to the
-     * last-seen cursor. Does not recreate a cursor that was removed while the
-     * request was in flight.
-     *
-     * @param autorampId - MoonPay autoramp id.
-     * @returns The updated local account, or an unpersisted snapshot if the
-     * cursor was removed during the fetch.
-     */
-    async refreshAutoramp(autorampId) {
-        const remote = await this.messenger.call('NeoBankService:getAutoramp', autorampId);
-        return __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_applyAutorampRemoteSnapshot).call(this, remote, { allowInsert: false });
-    }
-    /**
-     * Refreshes all known local autoramps from MoonPay.
-     * Intended for app resume / unlock catch-up when webhooks were missed.
-     *
-     * @returns Updated autoramp accounts (failed fetches are skipped).
-     */
-    async refreshAutoramps() {
-        const ids = this.state.autoramps.map((autoramp) => autoramp.id);
-        const updated = [];
-        for (const id of ids) {
-            try {
-                const account = await this.refreshAutoramp(id);
-                if (this.state.autoramps.some((autoramp) => autoramp.id === account.id)) {
-                    updated.push(account);
-                }
-            }
-            catch {
-                // Keep local cursor for this id; continue remaining refreshes.
-            }
-        }
-        return updated;
-    }
     /**
      * Starts polling all pending V2 orders at a fixed interval.
      * Each poll cycle iterates orders with non-terminal statuses,
@@ -2018,16 +1686,17 @@ class RampsController extends base_controller_1.BaseController {
      * @param network - The blockchain network identifier.
      * @param paymentMethod - The payment method identifier.
      * @param fiatAmount - The fiat amount as a string.
+     * @param isFeeExcludedFromFiat - Whether Transak charges fees on top.
      * @returns The buy quote with pricing and fee details.
      */
-    async transakGetBuyQuote(fiatCurrency, cryptoCurrency, network, paymentMethod, fiatAmount) {
+    async transakGetBuyQuote(fiatCurrency, cryptoCurrency, network, paymentMethod, fiatAmount, isFeeExcludedFromFiat = false) {
         this.update((state) => {
             state.nativeProviders.transak.buyQuote.isLoading = true;
             state.nativeProviders.transak.buyQuote.error = null;
             delete state.nativeProviders.transak.buyQuote.errorKey;
         });
         try {
-            const quote = await this.messenger.call('TransakService:getBuyQuote', fiatCurrency, cryptoCurrency, network, paymentMethod, fiatAmount);
+            const quote = await this.messenger.call('TransakService:getBuyQuote', fiatCurrency, cryptoCurrency, network, paymentMethod, fiatAmount, isFeeExcludedFromFiat);
             this.update((state) => {
                 state.nativeProviders.transak.buyQuote.data = quote;
                 state.nativeProviders.transak.buyQuote.isLoading = false;
@@ -2688,30 +2357,6 @@ async function _RampsController_resolveProviderIdsForPaymentMethods({ assetId, r
         }
     }
     return orderedIds;
-}, _RampsController_applyAutorampRemoteSnapshot = function _RampsController_applyAutorampRemoteSnapshot(remote, { allowInsert = true } = {}) {
-    const local = this.state.autoramps.find((autoramp) => autoramp.id === remote.id) ??
-        null;
-    if (local === null && !allowInsert) {
-        return (0, autorampAccount_js_1.applyAutorampRemoteStatus)(null, remote).account;
-    }
-    const result = (0, autorampAccount_js_1.applyAutorampRemoteStatus)(local, remote);
-    this.update((state) => {
-        const idx = state.autoramps.findIndex((autoramp) => autoramp.id === result.account.id);
-        if (idx === -1) {
-            state.autoramps.push(result.account);
-        }
-        else {
-            state.autoramps[idx] = result.account;
-        }
-    });
-    if (result.statusChanged) {
-        this.messenger.publish('RampsController:autorampStatusChanged', {
-            autoramp: result.account,
-            previousStatus: result.previousStatus,
-            shouldNotify: result.shouldNotify,
-        });
-    }
-    return (this.state.autoramps.find((autoramp) => autoramp.id === result.account.id) ?? result.account);
 }, _RampsController_refreshOrder = 
 /**
  * Refreshes a single order via the V2 API and updates it in state.