@metamask/ramps-controller 20.2.0 → 20.3.0

package/dist/RampsController.mjs

@@ -9,16 +9,20 @@ 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_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_applyAutorampRemoteSnapshot, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
 import { BaseController } from "@metamask/base-controller";
 import { BrokenCircuitError } from "@metamask/controller-utils";
+import { applyAutorampRemoteStatus, createAutorampAccount, markAutorampNotified } from "./autorampAccount.mjs";
 import { getHeadlessProviderAllowlist, isHeadlessAllProvidersEnabled, normalizeHeadlessProviderId } from "./featureFlags.mjs";
 import { PENDING_ORDER_STATUSES, TERMINAL_ORDER_STATUSES } from "./orderStatus.mjs";
+import { buildOwnershipMessage } from "./ownership-message.mjs";
 import { mergePaymentMethodsById, pickPaymentMethod } from "./paymentMethodMerge.mjs";
 import { getProvidersServingAsset, normalizeRampsAssetId, providerServesAsset } from "./providerAvailability.mjs";
 import { RAMPS_ERROR_CODES } from "./rampsErrorCodes.mjs";
 import { RampsOrderStatus } from "./RampsService.mjs";
 import { DEFAULT_REQUEST_CACHE_TTL, DEFAULT_REQUEST_CACHE_MAX_SIZE, createCacheKey, isCacheExpired, createLoadingState, createSuccessState, createErrorState, RequestStatus } from "./RequestCache.mjs";
+import { createInitialState as createInitialWalletRegistrationState, transition as transitionWalletRegistration } from "./wallet-registration-machine.mjs";
+import { createIdempotencyKey, WalletRegistrationError } from "./wallet-registration-service.mjs";
 // === GENERAL ===
 /**
  * The name of the {@link RampsController}, used to namespace the
@@ -67,7 +71,36 @@ export const 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.
+ */
+export const 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.
@@ -179,6 +212,12 @@ const rampsControllerMetadata = {
         includeInStateLogs: true,
         usedInUi: true,
     },
+    autoramps: {
+        persist: true,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
     providerAutoSelected: {
         persist: true,
         includeInDebugSnapshot: true,
@@ -228,6 +267,7 @@ export function getDefaultRampsControllerState() {
             },
         },
         orders: [],
+        autoramps: [],
         providerAutoSelected: false,
     };
 }
@@ -373,6 +413,14 @@ const MESSENGER_EXPOSED_METHODS = [
     'getQuotes',
     'addOrder',
     'removeOrder',
+    'addAutoramp',
+    'createAutoramp',
+    'removeAutoramp',
+    'registerMoneyAccountWallet',
+    'markAutorampAsNotified',
+    'applyAutorampStatusFromPush',
+    'refreshAutoramp',
+    'refreshAutoramps',
     'startOrderPolling',
     'stopOrderPolling',
     'getBuyWidgetData',
@@ -1378,6 +1426,304 @@ export class RampsController extends 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
+            : 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 = transitionWalletRegistration(createInitialWalletRegistrationState(), { 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 = transitionWalletRegistration(machine, {
+                type: 'LOOKUP_FAILED',
+            });
+            return {
+                type: 'lookupUnavailable',
+                error: error instanceof WalletRegistrationError
+                    ? error
+                    : new 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 = transitionWalletRegistration(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 = createIdempotencyKey();
+        let lastMessage;
+        while (true) {
+            const message = buildOwnershipMessage({
+                address,
+                customerId,
+                now: new Date(),
+            });
+            if (lastMessage !== undefined && message !== lastMessage) {
+                idempotencyKey = createIdempotencyKey();
+            }
+            lastMessage = message;
+            let signature;
+            try {
+                signature = await this.messenger.call('KeyringController:signPersonalMessage', { data: message, from: address });
+                machine = transitionWalletRegistration(machine, { type: 'SIGN_OK' });
+            }
+            catch (error) {
+                machine = transitionWalletRegistration(machine, {
+                    type: 'SIGN_FAILED',
+                    retryable: false,
+                });
+                throw error;
+            }
+            try {
+                const result = await this.messenger.call('NeoBankService:registerSelfHostedWallet', {
+                    address,
+                    customerId,
+                    message,
+                    signature,
+                    idempotencyKey,
+                });
+                machine = transitionWalletRegistration(machine, { type: 'SUBMIT_OK' });
+                return result;
+            }
+            catch (error) {
+                if (!(error instanceof WalletRegistrationError)) {
+                    machine = transitionWalletRegistration(machine, {
+                        type: 'SUBMIT_TERMINAL',
+                    });
+                    throw error;
+                }
+                if (error.kind === 'conflict') {
+                    machine = transitionWalletRegistration(machine, {
+                        type: 'SUBMIT_CONFLICT',
+                    });
+                }
+                else if (error.kind === 'transient') {
+                    machine = transitionWalletRegistration(machine, {
+                        type: 'SUBMIT_TRANSIENT',
+                    });
+                }
+                else if (error.kind === 'validation') {
+                    machine = transitionWalletRegistration(machine, {
+                        type: 'SUBMIT_VALIDATION',
+                        utcRollover: buildOwnershipMessage({
+                            address,
+                            customerId,
+                            now: new Date(),
+                        }) !== message,
+                    });
+                }
+                else if (error.kind === 'rateLimited') {
+                    machine = transitionWalletRegistration(machine, {
+                        type: 'SUBMIT_RATE_LIMITED',
+                    });
+                }
+                else {
+                    machine = transitionWalletRegistration(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 = 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,
@@ -2336,6 +2682,30 @@ 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 applyAutorampRemoteStatus(null, remote).account;
+    }
+    const result = 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.