Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@
/packages/wallet/src/initialization/instances/remote-feature-flag-controller/ @MetaMask/extension-platform @MetaMask/mobile-platform @MetaMask/core-platform
/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
/packages/wallet/src/initialization/instances/passkey-controller @MetaMask/web3auth
/packages/wallet/src/initialization/instances/seedless-onboarding-controller @MetaMask/web3auth

## Package Release related
/packages/account-tree-controller/package.json @MetaMask/accounts-engineers @MetaMask/core-platform
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,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;
Expand Down
5 changes: 0 additions & 5 deletions eslint-suppressions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2240,11 +2240,6 @@
"count": 2
}
},
"packages/transaction-pay-controller/src/strategy/bridge/bridge-submit.ts": {
"no-restricted-syntax": {
"count": 1
}
},
"packages/transaction-pay-controller/src/strategy/relay/hyperliquid-withdraw.ts": {
"no-restricted-syntax": {
"count": 1
Expand Down
4 changes: 4 additions & 0 deletions packages/wallet/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))

## [7.0.1]

### Changed
Expand Down
2 changes: 2 additions & 0 deletions packages/wallet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@
"@metamask/keyring-controller": "^27.1.0",
"@metamask/messenger": "^2.0.0",
"@metamask/network-controller": "^34.0.0",
"@metamask/passkey-controller": "^2.1.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.0.0",
"@metamask/utils": "^11.11.0"
Expand Down
2 changes: 2 additions & 0 deletions packages/wallet/src/initialization/instances/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ export { approvalController } from './approval-controller/approval-controller';
export { connectivityController } from './connectivity-controller/connectivity-controller';
export { keyringController } from './keyring-controller/keyring-controller';
export { networkController } from './network-controller/network-controller';
export { passkeyController } from './passkey-controller/passkey-controller';
export { remoteFeatureFlagController } from './remote-feature-flag-controller/remote-feature-flag-controller';
export { seedlessOnboardingController } from './seedless-onboarding-controller/seedless-onboarding-controller';
export { storageService } from './storage-service/storage-service';
export { transactionController } from './transaction-controller/transaction-controller';
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
import { Messenger } from '@metamask/messenger';
import {
PasskeyController,
getDefaultPasskeyControllerState,
} from '@metamask/passkey-controller';
import type { PasskeyRecord } from '@metamask/passkey-controller';

import { defaultConfigurations } from '../../defaults';
import type {
DefaultActions,
DefaultEvents,
RootMessenger,
} from '../../defaults';
import { passkeyController } from './passkey-controller';

const { PasskeyController: ActualPasskeyController } = jest.requireActual(
'@metamask/passkey-controller',
);

jest.mock('@metamask/passkey-controller', () => ({
...jest.requireActual('@metamask/passkey-controller'),
PasskeyController: jest.fn(),
}));

const REQUIRED_OPTIONS = {
expectedRPID: 'extension-id',
expectedOrigin: 'https://extension.origin',
rpName: 'MetaMask',
};

/**
* Creates a root messenger for use in tests.
*
* @returns A root messenger.
*/
function getRootMessenger(): RootMessenger<DefaultActions, DefaultEvents> {
return new Messenger({ namespace: 'Root' });
}

describe('passkeyController', () => {
beforeEach(() => {
jest.clearAllMocks();
(PasskeyController as jest.Mock).mockImplementation(
(...args: unknown[]) => new ActualPasskeyController(...args),
);
});

it('is registered as a default initialization configuration', () => {
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(ActualPasskeyController);
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('forwards custom passkey configuration options', () => {
const messenger = passkeyController.getMessenger(getRootMessenger());

passkeyController.init({
state: undefined,
messenger,
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',
},
});

expect(PasskeyController).toHaveBeenCalledWith(
expect.objectContaining({
rpId: 'rp-id',
rpName: 'Custom RP',
userName: 'custom-user',
userDisplayName: 'Custom Display Name',
expectedRPID: ['extension-id', 'other-id'],
expectedOrigin: ['https://a.example', 'https://b.example'],
}),
);
});

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(),
);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Messenger } from '@metamask/messenger';
import {
PasskeyController,
PasskeyControllerMessenger,
} from '@metamask/passkey-controller';

import { InitializationConfiguration } from '../../types';

export const passkeyController: InitializationConfiguration<
PasskeyController,
PasskeyControllerMessenger
> = {
name: 'PasskeyController',
init: ({ state, messenger, options }) =>
new PasskeyController({
...options,
Comment thread
lwin-kyaw marked this conversation as resolved.
messenger,
state,
}),
getMessenger: (parent) =>
new Messenger({
namespace: 'PasskeyController',
parent,
}),
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { PasskeyController } from '@metamask/passkey-controller';

export type PasskeyControllerInstanceOptions = Omit<
ConstructorParameters<typeof PasskeyController>[0],
'messenger' | 'state'
>;
Loading