feat(wallet): Add SeedlessOnboardingController and PasskeyController

.github/CODEOWNERS

@@ -151,7 +151,9 @@
 /packages/wallet/src/initialization/instances/approval-controller/               @MetaMask/confirmations
 /packages/wallet/src/initialization/instances/connectivity-controller/           @MetaMask/core-platform
 /packages/wallet/src/initialization/instances/keyring-controller/                @MetaMask/accounts-engineers @MetaMask/core-platform
+/packages/wallet/src/initialization/instances/passkey-controller/                @MetaMask/web3auth
 /packages/wallet/src/initialization/instances/remote-feature-flag-controller/    @MetaMask/extension-platform @MetaMask/mobile-platform @MetaMask/core-platform
+/packages/wallet/src/initialization/instances/seedless-onboarding-controller/    @MetaMask/web3auth
 /packages/wallet/src/initialization/instances/storage-service/                   @MetaMask/extension-platform @MetaMask/mobile-platform @MetaMask/core-platform
 /packages/wallet/src/initialization/instances/transaction-controller/            @MetaMask/confirmations
 

README.md

@@ -652,7 +652,9 @@ linkStyle default opacity:0.5
   wallet --> keyring_controller;
   wallet --> messenger;
   wallet --> network_controller;
+  wallet --> passkey_controller;
   wallet --> remote_feature_flag_controller;
+  wallet --> seedless_onboarding_controller;
   wallet --> storage_service;
   wallet --> transaction_controller;
   wallet_cli --> base_controller;

codeowners.ts

@@ -248,6 +248,7 @@ const PACKAGES: Record<string, PackageInfo> = {
   },
   'passkey-controller': {
     teams: ['@MetaMask/web3auth'],
+    initializationPath: 'passkey-controller',
   },
   'permission-controller': {
     teams: ['@MetaMask/core-platform'],
@@ -298,6 +299,7 @@ const PACKAGES: Record<string, PackageInfo> = {
   },
   'seedless-onboarding-controller': {
     teams: ['@MetaMask/web3auth'],
+    initializationPath: 'seedless-onboarding-controller',
   },
   'selected-network-controller': {
     teams: ['@MetaMask/core-platform'],

packages/wallet/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING** Wire `SeedlessOnboardingController` and `PasskeyController` into the default wallet initialization ([#9533](https://github.com/MetaMask/core/pull/9533))
+
 ### Changed
 
 - Bump `@metamask/transaction-controller` from `^69.0.0` to `^69.1.0` ([#9568](https://github.com/MetaMask/core/pull/9568))

packages/wallet/package.json

@@ -65,8 +65,10 @@
     "@metamask/keyring-controller": "^27.1.0",
     "@metamask/messenger": "^2.0.0",
     "@metamask/network-controller": "^34.0.0",
+    "@metamask/passkey-controller": "^3.0.0",
     "@metamask/remote-feature-flag-controller": "^4.2.2",
     "@metamask/scure-bip39": "^2.1.1",
+    "@metamask/seedless-onboarding-controller": "^10.0.3",
     "@metamask/storage-service": "^1.0.2",
     "@metamask/transaction-controller": "^69.1.0",
     "@metamask/utils": "^11.11.0"

packages/wallet/src/initialization/instances/index.ts

@@ -4,6 +4,8 @@ export { approvalController } from './approval-controller/approval-controller.js
 export { connectivityController } from './connectivity-controller/connectivity-controller.js';
 export { keyringController } from './keyring-controller/keyring-controller.js';
 export { networkController } from './network-controller/network-controller.js';
+export { passkeyController } from './passkey-controller/passkey-controller.js';
 export { remoteFeatureFlagController } from './remote-feature-flag-controller/remote-feature-flag-controller.js';
+export { seedlessOnboardingController } from './seedless-onboarding-controller/seedless-onboarding-controller.js';
 export { storageService } from './storage-service/storage-service.js';
 export { transactionController } from './transaction-controller/transaction-controller.js';

packages/wallet/src/initialization/instances/passkey-controller/passkey-controller.test.ts

@@ -0,0 +1,177 @@
+import { Messenger } from '@metamask/messenger';
+import {
+  PasskeyController,
+  PasskeyControllerErrorCode,
+  getDefaultPasskeyControllerState,
+} from '@metamask/passkey-controller';
+import type {
+  PasskeyAuthenticationResponse,
+  PasskeyRecord,
+  PasskeyRegistrationResponse,
+} from '@metamask/passkey-controller';
+
+import { defaultConfigurations } from '../../defaults.js';
+import type {
+  DefaultActions,
+  DefaultEvents,
+  RootMessenger,
+} from '../../defaults.js';
+import { passkeyController } from './passkey-controller.js';
+import type { PasskeyControllerInstanceOptions } from './types.js';
+
+const REQUIRED_OPTIONS: PasskeyControllerInstanceOptions = {
+  expectedRPID: 'extension-id',
+  expectedOrigin: 'https://extension.origin',
+  rpName: 'MetaMask',
+  getIsOnboardingCompleted: () => false,
+};
+
+/**
+ * Creates a root messenger for use in tests.
+ *
+ * @returns A root messenger.
+ */
+function getRootMessenger(): RootMessenger<DefaultActions, DefaultEvents> {
+  return new Messenger({ namespace: 'Root' });
+}
+
+describe('passkeyController', () => {
+  it('is registered as a default initialization configuration', () => {
+    // Proves the controller is part of the default ensemble that `initialize()`
+    // wires, without constructing a `Wallet` (which keeps this PR independent of
+    // the constructor-options shape).
+    expect(Object.values(defaultConfigurations)).toContain(passkeyController);
+  });
+
+  it('initializes a PasskeyController with default state', () => {
+    const messenger = passkeyController.getMessenger(getRootMessenger());
+
+    const instance = passkeyController.init({
+      state: undefined,
+      messenger,
+      options: REQUIRED_OPTIONS,
+    });
+
+    expect(instance).toBeInstanceOf(PasskeyController);
+    expect(instance.state).toStrictEqual(getDefaultPasskeyControllerState());
+  });
+
+  it('forwards the provided state to the controller', () => {
+    const messenger = passkeyController.getMessenger(getRootMessenger());
+
+    const passkeyRecord: PasskeyRecord = {
+      credential: {
+        id: 'credential-id',
+        publicKey: 'public-key',
+        counter: 0,
+        transports: ['internal'],
+        aaguid: '00000000-0000-0000-0000-000000000000',
+      },
+      encryptedVaultKey: {
+        ciphertext: 'YQ==',
+        iv: 'YWFhYWFhYWFhYQ==',
+      },
+      keyDerivation: { method: 'userHandle' },
+    };
+
+    const instance = passkeyController.init({
+      state: { passkeyRecord },
+      messenger,
+      options: REQUIRED_OPTIONS,
+    });
+
+    expect(instance.state.passkeyRecord).toStrictEqual(passkeyRecord);
+  });
+
+  it('defaults userName and userDisplayName to rpName when omitted', () => {
+    const messenger = passkeyController.getMessenger(getRootMessenger());
+
+    const instance = passkeyController.init({
+      state: undefined,
+      messenger,
+      options: REQUIRED_OPTIONS,
+    });
+
+    const options = instance.generateRegistrationOptions({
+      prfAvailable: false,
+    });
+
+    expect(options.user).toStrictEqual({
+      id: expect.any(String),
+      name: 'MetaMask',
+      displayName: 'MetaMask',
+    });
+  });
+
+  it('uses custom passkey configuration options', () => {
+    const messenger = passkeyController.getMessenger(getRootMessenger());
+
+    const instance = passkeyController.init({
+      state: undefined,
+      messenger,
+      options: {
+        ...REQUIRED_OPTIONS,
+        expectedRPID: ['extension-id', 'other-id'],
+        expectedOrigin: ['https://a.example', 'https://b.example'],
+        rpId: 'rp-id',
+        rpName: 'Custom RP',
+        userName: 'custom-user',
+        userDisplayName: 'Custom Display Name',
+      },
+    });
+
+    const options = instance.generateRegistrationOptions({
+      prfAvailable: false,
+    });
+
+    expect(options.rp).toStrictEqual({
+      name: 'Custom RP',
+      id: 'rp-id',
+    });
+    expect(options.user).toStrictEqual({
+      id: expect.any(String),
+      name: 'custom-user',
+      displayName: 'Custom Display Name',
+    });
+  });
+
+  it('uses the provided getIsOnboardingCompleted callback', async () => {
+    const messenger = passkeyController.getMessenger(getRootMessenger());
+    const getIsOnboardingCompleted = jest.fn().mockReturnValue(true);
+
+    const instance = passkeyController.init({
+      state: undefined,
+      messenger,
+      options: {
+        ...REQUIRED_OPTIONS,
+        getIsOnboardingCompleted,
+      },
+    });
+
+    await expect(
+      instance.protectVaultKeyWithPasskey({
+        registrationResponse: {} as PasskeyRegistrationResponse,
+        authenticationResponse: {} as PasskeyAuthenticationResponse,
+      }),
+    ).rejects.toMatchObject({
+      code: PasskeyControllerErrorCode.EnrollmentPasswordRequired,
+    });
+
+    expect(getIsOnboardingCompleted).toHaveBeenCalled();
+  });
+
+  it('exposes its state through the root messenger', () => {
+    const rootMessenger = getRootMessenger();
+    const messenger = passkeyController.getMessenger(rootMessenger);
+
+    passkeyController.init({
+      state: undefined,
+      messenger,
+      options: REQUIRED_OPTIONS,
+    });
+
+    expect(rootMessenger.call('PasskeyController:getState')).toStrictEqual(
+      getDefaultPasskeyControllerState(),
+    );
+  });
+});

packages/wallet/src/initialization/instances/passkey-controller/passkey-controller.ts

@@ -0,0 +1,47 @@
+import { Messenger } from '@metamask/messenger';
+import {
+  PasskeyController,
+  PasskeyControllerMessenger,
+} from '@metamask/passkey-controller';
+
+import type {
+  DefaultActions,
+  DefaultEvents,
+  RootMessenger,
+} from '../../defaults.js';
+import { InitializationConfiguration } from '../../types.js';
+
+export const passkeyController: InitializationConfiguration<
+  PasskeyController,
+  PasskeyControllerMessenger
+> = {
+  name: 'PasskeyController',
+  init: ({ state, messenger, options }) =>
+    new PasskeyController({
+      ...options,
+      messenger,
+      state,
+    }),
+  getMessenger: (parent: RootMessenger<DefaultActions, DefaultEvents>) => {
+    const passkeyControllerMessenger: PasskeyControllerMessenger =
+      new Messenger({
+        namespace: 'PasskeyController',
+        parent,
+      });
+
+    parent.delegate({
+      messenger: passkeyControllerMessenger,
+      actions: [
+        'KeyringController:verifyPassword',
+        'KeyringController:exportEncryptionKey',
+        'KeyringController:submitEncryptionKey',
+        'KeyringController:changePassword',
+        'KeyringController:exportSeedPhrase',
+        'KeyringController:exportAccount',
+      ],
+      events: [],
+    });
+
+    return passkeyControllerMessenger;
+  },
+};

packages/wallet/src/initialization/instances/passkey-controller/types.ts

@@ -0,0 +1,6 @@
+import type { PasskeyControllerOptions } from '@metamask/passkey-controller';
+
+export type PasskeyControllerInstanceOptions = Omit<
+  PasskeyControllerOptions,
+  'messenger' | 'state'
+>;