@metamask-previews/kyc-controller 0.0.0-preview-e0510042f → 0.0.0-preview-fe4b3be11

package/CHANGELOG.md

@@ -30,6 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Add `KycService.fetchDisclaimersCatalog` / `KycService:fetchDisclaimersCatalog` (`GET /disclaimers?country=`, ISO 3166-1 alpha-3) for the pre-session idOS + KYC-provider catalog, plus the `KycDisclaimersCatalog` type (no `credentialReusabilityConsentGiven`). `fetchSessionDisclaimers` remains session-scoped (`GET /sessions/{sessionId}/disclaimers` → `KycSessionDisclaimers`). ([#10011](https://github.com/MetaMask/core/pull/10011))
+- **BREAKING:** Rename `KycService.fetchDisclaimers` / `KycService:fetchDisclaimers` / `KycServiceFetchDisclaimersAction` to `fetchVendorDisclaimers` / `KycService:fetchVendorDisclaimers` / `KycServiceFetchVendorDisclaimersAction`. ([#10011](https://github.com/MetaMask/core/pull/10011))
 - **BREAKING:** Rename `fractalEncryptionBaseUrl` to `idosEnclaveBaseUrl`, `KycService.fetchJwks` / `KycService:fetchJwks` / `KycServiceFetchJwksAction` to `fetchIdosEnclaveJwks` / `KycService:fetchIdosEnclaveJwks` / `KycServiceFetchIdosEnclaveJwksAction`, and related Fractal encryption naming to idOS enclave. ([#10008](https://github.com/MetaMask/core/pull/10008))
 - **BREAKING:** Verify `encryptionDataKey` against idOS enclave JWKS (`KycService:fetchIdosEnclaveJwks` / `idosEnclaveBaseUrl`) and `ukycCapabilityToken` against idOS relay JWKS (`KycService:fetchIdosRelayJwks` / `idosRelayBaseUrl`) when wrapping UKYC authorizations, instead of validating both schemas against Fractal. Hosts must supply `idosRelayBaseUrl` on `KycService` construction (same class of requirement as `idosEnclaveBaseUrl`). ([#10008](https://github.com/MetaMask/core/pull/10008))
 - **BREAKING:** Require `sessionClientPublicKey` (unpadded base64url X25519 public key) and `residenceCountry` (ISO 3166-1 alpha-3) on `KycService.createUkycSession` (`POST /sessions`). The controller generates the per-session keypair before creating the session and uses the private half to wrap authorizations; residence country is taken from the resolved geo country. ([#9993](https://github.com/MetaMask/core/pull/9993))
@@ -40,9 +42,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **BREAKING:** Require `sumsubTncSigned` and `idosTncSigned` on `acceptTermsAndStartSession` for every vendor, so callers explicitly declare T&C2 acceptance. Zero-argument calls and omitted flags fail instead of defaulting to `true`. ([#9908](https://github.com/MetaMask/core/pull/9908))
 - Rename `CreateUkycSessionParams.vendorId` to `vendor` for consistency with other service methods. ([#9908](https://github.com/MetaMask/core/pull/9908))
 - Bump `@metamask/base-data-service` from `^0.1.3` to `^1.0.0` ([#9972](https://github.com/MetaMask/core/pull/9972))
+- Replace `KycController` `console.error` tracing with the `@metamask/utils` debug logger (`createProjectLogger` / `createModuleLogger`), so flow diagnostics are opt-in via `DEBUG=kyc-controller*` instead of always printing to the console. ([#10054](https://github.com/MetaMask/core/pull/10054))
 
 ### Fixed
 
+- Stop routing `KycService` write endpoints through the query cache. Every `POST` (`createSession`, `checkKycRequired`, `createVendorCustomer`, `submitVendorDisclaimers`, `submitSessionDisclaimers`, `createUkycSession`, `setAuthorizations`, `createJourney`) now issues its request directly instead of via `fetchQuery`. Previously these were modelled as queries, so two overlapping calls sharing a `queryKey` were deduplicated into a single request — a second `createVendorCustomer` while the first was in flight never reached the API — and their responses were retained in the cache and published on the messenger as `cacheUpdated` payloads, which for these endpoints include session tokens and applicant access tokens. Writes are also no longer retried by the service policy, so a failed non-idempotent request cannot create duplicate records server-side. ([#10007](https://github.com/MetaMask/core/pull/10007))
+- Stop incorrectly prefixing the session client public key onto wrapped `encryptionDataKey` and `ukycCapabilityToken` values from `wrapEncryptionKey`. `data` is now ciphertext+tag only; the server already has the client public key from session creation. ([#10036](https://github.com/MetaMask/core/pull/10036))
 - Clear leftover MoonPay `sessionToken`, `accessToken`, and Check/Auth frame credentials when `initialize` or `createVendorCustomer` switches to another vendor, so `buildCheckFrameUrl` cannot return a MoonPay URL for a consents-path session. ([#9908](https://github.com/MetaMask/core/pull/9908))
 - Rewind the consents path when SumSub fails before completion (thrown step or SDK close without `Completed`), instead of refreshing user status and forcing `phase` to `done`. A terminal UKYC rejection after the SDK completed still finishes as `done` so the decision can be reflected in user status. ([#9908](https://github.com/MetaMask/core/pull/9908))
 - Make `createVendorCustomer` a no-op during in-progress phases (matching `initialize`), so a vendor switch cannot leave Check/Auth frames attached to the wrong vendor. ([#9908](https://github.com/MetaMask/core/pull/9908))

package/dist/KycController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _KycController_instances, _KycController_sumsubLauncher, _KycController_keypair, _KycController_authClientToken, _KycController_generation, _KycController_sessionStatusPollIntervalMs, _KycController_pollTimer, _KycController_pollToken, _KycController_userStatusPollIntervalMs, _KycController_userStatusPollTimer, _KycController_userStatusPolling, _KycController_userStatusPollToken, _KycController_localUserSecretStore, _KycController_startConsentsSession, _KycController_recordSessionDisclaimers, _KycController_createSession, _KycController_clearAcceptedTerms, _KycController_clearMoonPaySession, _KycController_dropTermsUnlessForVendor, _KycController_hasTermsForVendor, _KycController_handleCheckOutcome, _KycController_handleAuthOutcome, _KycController_continueAfterAuthentication, _KycController_requireTermsReacceptance, _KycController_buildUkycSessionVendorFields, _KycController_createUkycSession, _KycController_fetchAndApplyUserStatus, _KycController_applyUserStatus, _KycController_ensureUserStatusPolling, _KycController_stopUserStatusPolling, _KycController_startSessionStatusPolling, _KycController_pollSessionStatusOnce, _KycController_stopPolling, _KycController_cancelPendingSession, _KycController_updateIfCurrent, _KycController_applyUpdate, _KycController_assertAttestedServerPublicKey, _KycController_fail;
+var _KycController_instances, _KycController_sumsubLauncher, _KycController_moonpayFrameKeypair, _KycController_authClientToken, _KycController_generation, _KycController_sessionStatusPollIntervalMs, _KycController_pollTimer, _KycController_pollToken, _KycController_userStatusPollIntervalMs, _KycController_userStatusPollTimer, _KycController_userStatusPolling, _KycController_userStatusPollToken, _KycController_localUserSecretStore, _KycController_startConsentsSession, _KycController_recordSessionDisclaimers, _KycController_createSession, _KycController_clearAcceptedTerms, _KycController_clearMoonPaySession, _KycController_dropTermsUnlessForVendor, _KycController_hasTermsForVendor, _KycController_handleCheckOutcome, _KycController_handleAuthOutcome, _KycController_continueAfterAuthentication, _KycController_requireTermsReacceptance, _KycController_buildUkycSessionVendorFields, _KycController_createUkycSession, _KycController_fetchAndApplyUserStatus, _KycController_applyUserStatus, _KycController_ensureUserStatusPolling, _KycController_stopUserStatusPolling, _KycController_startSessionStatusPolling, _KycController_pollSessionStatusOnce, _KycController_stopPolling, _KycController_cancelPendingSession, _KycController_updateIfCurrent, _KycController_applyUpdate, _KycController_assertAttestedServerPublicKey, _KycController_fail;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KycController = exports.getDefaultKycControllerState = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -18,6 +18,7 @@ const utils_1 = require("@metamask/utils");
 const ed25519_1 = require("@noble/curves/ed25519");
 const crypto_js_1 = require("./crypto.cjs");
 const encoding_js_1 = require("./encoding.cjs");
+const logger_js_1 = require("./logger.cjs");
 const deriveClientMaterial_js_1 = require("./ukyc/deriveClientMaterial.cjs");
 const jwtChain_js_1 = require("./ukyc/jwtChain.cjs");
 const localUserSecret_js_1 = require("./ukyc/localUserSecret.cjs");
@@ -413,8 +414,8 @@ class KycController extends base_controller_1.BaseController {
         });
         _KycController_instances.add(this);
         _KycController_sumsubLauncher.set(this, void 0);
-        /** Ephemeral X25519 keypair for the frame key exchange (never persisted). */
-        _KycController_keypair.set(this, void 0);
+        /** MoonPay Check/Auth frame X25519 keypair (never persisted). */
+        _KycController_moonpayFrameKeypair.set(this, null);
         /** Auth-frame client token, kept out of state. */
         _KycController_authClientToken.set(this, null);
         /**
@@ -453,7 +454,6 @@ class KycController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _KycController_sumsubLauncher, sumsubLauncher, "f");
         __classPrivateFieldSet(this, _KycController_sessionStatusPollIntervalMs, sessionStatusPollIntervalMs, "f");
         __classPrivateFieldSet(this, _KycController_userStatusPollIntervalMs, userStatusPollIntervalMs, "f");
-        __classPrivateFieldSet(this, _KycController_keypair, (0, crypto_js_1.generateKeyPair)(), "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
@@ -476,10 +476,19 @@ class KycController extends base_controller_1.BaseController {
         // forces `phase` back through `session`/`check`, breaking an in-flight
         // Check/Auth frame flow. Leave the active flow untouched and let the
         // consumer drive it (or call `reset` first to start over).
+        const vendor = params?.vendor ?? 'moonpay';
         if (IN_PROGRESS_PHASES.includes(this.state.phase)) {
+            if (vendor === 'moonpay' && !__classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f")) {
+                __classPrivateFieldSet(this, _KycController_moonpayFrameKeypair, (0, crypto_js_1.generateKeyPair)(), "f");
+            }
             return;
         }
-        const vendor = params?.vendor ?? 'moonpay';
+        if (vendor === 'moonpay') {
+            __classPrivateFieldSet(this, _KycController_moonpayFrameKeypair, (0, crypto_js_1.generateKeyPair)(), "f");
+        }
+        else {
+            __classPrivateFieldSet(this, _KycController_moonpayFrameKeypair, null, "f");
+        }
         // `initialize` starts a fresh flow, so `activeProduct` is always reset to
         // this call's product (or `null`). Otherwise a prior run's product could
         // linger and cause `#continueAfterAuthentication` to auto-run the check /
@@ -602,6 +611,7 @@ class KycController extends base_controller_1.BaseController {
             state.activeVendor = params.vendor;
             if (params.vendor !== 'moonpay') {
                 __classPrivateFieldSet(this, _KycController_authClientToken, null, "f");
+                __classPrivateFieldSet(this, _KycController_moonpayFrameKeypair, null, "f");
                 __classPrivateFieldGet(this, _KycController_instances, "m", _KycController_clearMoonPaySession).call(this, state);
             }
         });
@@ -643,7 +653,7 @@ class KycController extends base_controller_1.BaseController {
                     state.geoCountry = country;
                 });
             }
-            const disclaimers = await this.messenger.call('KycService:fetchDisclaimers', {
+            const disclaimers = await this.messenger.call('KycService:fetchVendorDisclaimers', {
                 vendor: this.state.activeVendor,
                 country,
             });
@@ -774,9 +784,9 @@ class KycController extends base_controller_1.BaseController {
         }
         let accessToken;
         let clientToken;
-        if (credsEnvelope) {
+        if (credsEnvelope && __classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f")) {
             try {
-                const { credentials } = (0, crypto_js_1.decryptCredentials)(credsEnvelope, __classPrivateFieldGet(this, _KycController_keypair, "f").privateKey);
+                const { credentials } = (0, crypto_js_1.decryptCredentials)(credsEnvelope, __classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f").privateKey);
                 accessToken = credentials.accessToken;
                 clientToken = credentials.clientToken;
             }
@@ -799,12 +809,14 @@ class KycController extends base_controller_1.BaseController {
      * @returns The Check-frame URL or `null`.
      */
     buildCheckFrameUrl() {
-        if (this.state.activeVendor !== 'moonpay' || !this.state.sessionToken) {
+        if (this.state.activeVendor !== 'moonpay' ||
+            !this.state.sessionToken ||
+            !__classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f")) {
             return null;
         }
         const url = new URL(`${FRAMES_BASE_URL}/check-connection`);
         url.searchParams.set('sessionToken', this.state.sessionToken);
-        url.searchParams.set('publicKey', __classPrivateFieldGet(this, _KycController_keypair, "f").publicKeyHex);
+        url.searchParams.set('publicKey', __classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f").publicKeyHex);
         url.searchParams.set('channelId', CHANNEL_CHECK);
         url.searchParams.set('skipKyc', 'true');
         return url.toString();
@@ -815,12 +827,14 @@ class KycController extends base_controller_1.BaseController {
      * @returns The Auth-frame URL or `null`.
      */
     buildAuthFrameUrl() {
-        if (this.state.activeVendor !== 'moonpay' || !__classPrivateFieldGet(this, _KycController_authClientToken, "f")) {
+        if (this.state.activeVendor !== 'moonpay' ||
+            !__classPrivateFieldGet(this, _KycController_authClientToken, "f") ||
+            !__classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f")) {
             return null;
         }
         const url = new URL(`${FRAMES_BASE_URL}/auth`);
         url.searchParams.set('clientToken', __classPrivateFieldGet(this, _KycController_authClientToken, "f"));
-        url.searchParams.set('publicKey', __classPrivateFieldGet(this, _KycController_keypair, "f").publicKeyHex);
+        url.searchParams.set('publicKey', __classPrivateFieldGet(this, _KycController_moonpayFrameKeypair, "f").publicKeyHex);
         url.searchParams.set('channelId', CHANNEL_AUTH);
         return url.toString();
     }
@@ -1180,7 +1194,7 @@ class KycController extends base_controller_1.BaseController {
     }
 }
 exports.KycController = KycController;
-_KycController_sumsubLauncher = new WeakMap(), _KycController_keypair = new WeakMap(), _KycController_authClientToken = new WeakMap(), _KycController_generation = new WeakMap(), _KycController_sessionStatusPollIntervalMs = new WeakMap(), _KycController_pollTimer = new WeakMap(), _KycController_pollToken = new WeakMap(), _KycController_userStatusPollIntervalMs = new WeakMap(), _KycController_userStatusPollTimer = new WeakMap(), _KycController_userStatusPolling = new WeakMap(), _KycController_userStatusPollToken = new WeakMap(), _KycController_instances = new WeakSet(), _KycController_localUserSecretStore = function _KycController_localUserSecretStore() {
+_KycController_sumsubLauncher = new WeakMap(), _KycController_moonpayFrameKeypair = new WeakMap(), _KycController_authClientToken = new WeakMap(), _KycController_generation = new WeakMap(), _KycController_sessionStatusPollIntervalMs = new WeakMap(), _KycController_pollTimer = new WeakMap(), _KycController_pollToken = new WeakMap(), _KycController_userStatusPollIntervalMs = new WeakMap(), _KycController_userStatusPollTimer = new WeakMap(), _KycController_userStatusPolling = new WeakMap(), _KycController_userStatusPollToken = new WeakMap(), _KycController_instances = new WeakSet(), _KycController_localUserSecretStore = function _KycController_localUserSecretStore() {
     return {
         get: async (path, entropySourceId) => this.messenger.call('UserStorageController:performGetStorage', path, entropySourceId),
         set: async (path, value, entropySourceId) => this.messenger.call('UserStorageController:performSetStorage', path, value, entropySourceId),
@@ -1242,7 +1256,7 @@ async function _KycController_startConsentsSession(consents) {
                 await this.refreshKycStatus();
             }
             catch (statusError) {
-                console.error('KYC status refresh failed:', statusError);
+                (0, logger_js_1.controllerLog)('KYC status refresh failed:', statusError);
             }
             __classPrivateFieldGet(this, _KycController_instances, "m", _KycController_updateIfCurrent).call(this, generation, (state) => {
                 state.phase = 'done';
@@ -1278,7 +1292,7 @@ async function _KycController_startConsentsSession(consents) {
             await this.refreshKycStatus();
         }
         catch (statusError) {
-            console.error('KYC status refresh failed:', statusError);
+            (0, logger_js_1.controllerLog)('KYC status refresh failed:', statusError);
         }
         __classPrivateFieldGet(this, _KycController_instances, "m", _KycController_updateIfCurrent).call(this, generation, (state) => {
             if (state.phase !== 'error' && state.phase !== 'done') {
@@ -1306,7 +1320,7 @@ async function _KycController_startConsentsSession(consents) {
             });
             return;
         }
-        console.error('Consents session failed:', error);
+        (0, logger_js_1.controllerLog)('Consents session failed:', error);
         if (__classPrivateFieldGet(this, _KycController_generation, "f") !== generation) {
             return;
         }
@@ -1437,7 +1451,7 @@ async function _KycController_createSession() {
         });
     }
     catch (error) {
-        console.error('Session creation failed:', error);
+        (0, logger_js_1.controllerLog)('Session creation failed:', error);
         // A reset() superseded this flow while the request was in flight; leave
         // the idle controller alone rather than forcing it back to `terms`.
         if (__classPrivateFieldGet(this, _KycController_generation, "f") !== generation) {