Adds OAuth Controller required for seedless onboarding #14889
+1,902
−8
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import { seedlessOnboardingControllerInit } from '.'; | ||
| import { ExtendedControllerMessenger } from '../../../ExtendedControllerMessenger'; | ||
| import { buildControllerInitRequestMock } from '../../utils/test-utils'; | ||
| import { ControllerInitRequest } from '../../types'; | ||
| import { | ||
| SeedlessOnboardingController, | ||
| SeedlessOnboardingControllerMessenger, | ||
| SeedlessOnboardingControllerState, | ||
| } from '@metamask/seedless-onboarding-controller'; | ||
|
|
||
| jest.mock('@metamask/seedless-onboarding-controller', () => { | ||
| const actualSeedlessOnboardingController = jest.requireActual( | ||
| '@metamask/seedless-onboarding-controller', | ||
| ); | ||
| return { | ||
| controllerName: actualSeedlessOnboardingController.controllerName, | ||
| getDefaultSeedlessOnboardingControllerState: | ||
| actualSeedlessOnboardingController.getDefaultSeedlessOnboardingControllerState, | ||
| SeedlessOnboardingController: jest.fn(), | ||
| Web3AuthNetwork: actualSeedlessOnboardingController.Web3AuthNetwork, | ||
| }; | ||
| }); | ||
|
|
||
| describe('seedless onboarding controller init', () => { | ||
| const seedlessOnboardingControllerClassMock = jest.mocked( | ||
| SeedlessOnboardingController, | ||
| ); | ||
| let initRequestMock: jest.Mocked< | ||
| ControllerInitRequest<SeedlessOnboardingControllerMessenger> | ||
| >; | ||
|
|
||
| beforeEach(() => { | ||
| jest.resetAllMocks(); | ||
| const baseControllerMessenger = new ExtendedControllerMessenger(); | ||
| // Create controller init request mock | ||
| initRequestMock = buildControllerInitRequestMock(baseControllerMessenger); | ||
| }); | ||
|
|
||
| it('returns controller instance', () => { | ||
| expect( | ||
| seedlessOnboardingControllerInit(initRequestMock).controller, | ||
| ).toBeInstanceOf(SeedlessOnboardingController); | ||
| }); | ||
|
|
||
| it('controller state should be default state when no initial state is passed in', () => { | ||
| const defaultSeedlessOnboardingControllerState = jest | ||
| .requireActual('@metamask/seedless-onboarding-controller') | ||
| .getDefaultSeedlessOnboardingControllerState(); | ||
|
|
||
| seedlessOnboardingControllerInit(initRequestMock); | ||
|
|
||
| const seedlessOnboardingControllerState = | ||
| seedlessOnboardingControllerClassMock.mock.calls[0][0].state; | ||
|
|
||
| expect(seedlessOnboardingControllerState).toEqual( | ||
| defaultSeedlessOnboardingControllerState, | ||
| ); | ||
| }); | ||
|
|
||
| it('controller state should be initial state when initial state is passed in', () => { | ||
| const initialSeedlessOnboardingControllerState: Partial<SeedlessOnboardingControllerState> = | ||
| { | ||
| vault: undefined, | ||
| nodeAuthTokens: undefined, | ||
| }; | ||
|
|
||
| initRequestMock.persistedState = { | ||
| ...initRequestMock.persistedState, | ||
| SeedlessOnboardingController: initialSeedlessOnboardingControllerState, | ||
| }; | ||
|
|
||
| seedlessOnboardingControllerInit(initRequestMock); | ||
|
|
||
| const seedlessOnboardingControllerState = | ||
| seedlessOnboardingControllerClassMock.mock.calls[0][0].state; | ||
|
|
||
| expect(seedlessOnboardingControllerState).toStrictEqual( | ||
| initialSeedlessOnboardingControllerState, | ||
| ); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,46 @@ | ||||||
| import type { ControllerInitFunction } from '../../types'; | ||||||
| import { | ||||||
| SeedlessOnboardingController, | ||||||
| SeedlessOnboardingControllerState, | ||||||
| Web3AuthNetwork, | ||||||
| getDefaultSeedlessOnboardingControllerState, | ||||||
| type SeedlessOnboardingControllerMessenger, | ||||||
| } from '@metamask/seedless-onboarding-controller'; | ||||||
| import { Encryptor, LEGACY_DERIVATION_OPTIONS } from '../../../Encryptor'; | ||||||
|
|
||||||
| export const web3AuthNetwork = process.env.Web3AuthNetwork as Web3AuthNetwork; | ||||||
|
|
||||||
| if (!web3AuthNetwork) { | ||||||
| throw new Error('Missing environment variables'); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| const encryptor = new Encryptor({ | ||||||
| keyDerivationOptions: LEGACY_DERIVATION_OPTIONS, | ||||||
|
There was a problem hiding this comment. I'm not familiar with the different types of derivation options but I know we're using it in many places. @ccharly Can you take a look at this if it's fine? |
||||||
| }); | ||||||
|
|
||||||
| /** | ||||||
| * Initialize the SeedlessOnboardingController. | ||||||
| * | ||||||
| * @param request - The request object. | ||||||
| * @returns The SeedlessOnboardingController. | ||||||
| */ | ||||||
| export const seedlessOnboardingControllerInit: ControllerInitFunction< | ||||||
| SeedlessOnboardingController, | ||||||
| SeedlessOnboardingControllerMessenger | ||||||
| > = (request) => { | ||||||
| const { controllerMessenger, persistedState } = request; | ||||||
|
|
||||||
| const seedlessOnboardingControllerState = | ||||||
| persistedState.SeedlessOnboardingController ?? | ||||||
| getDefaultSeedlessOnboardingControllerState(); | ||||||
|
|
||||||
| const controller = new SeedlessOnboardingController({ | ||||||
| messenger: controllerMessenger, | ||||||
| state: | ||||||
| seedlessOnboardingControllerState as SeedlessOnboardingControllerState, | ||||||
| encryptor, | ||||||
| network: web3AuthNetwork, | ||||||
| }); | ||||||
|
|
||||||
| return { controller }; | ||||||
| }; | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import { BaseControllerMessenger } from '../../types'; | ||
|
|
||
| export type SeedlessOnboardingControllerMessenger = ReturnType< | ||
| typeof getSeedlessOnboardingControllerMessenger | ||
| >; | ||
|
|
||
| /** | ||
| * Get the SeedlessOnboardingControllerMessenger for the SeedlessOnboardingController. | ||
| * | ||
| * @param baseControllerMessenger - The base controller messenger. | ||
| * @returns The SeedlessOnboardingControllerMessenger. | ||
| */ | ||
| export function getSeedlessOnboardingControllerMessenger( | ||
| baseControllerMessenger: BaseControllerMessenger, | ||
| ) { | ||
| return baseControllerMessenger.getRestricted({ | ||
| name: 'SeedlessOnboardingController', | ||
| allowedEvents: [], | ||
|
There was a problem hiding this comment. I don't have visibility to the seedless onboarding controller. Does the controller use actions or events of other controllers? |
||
| allowedActions: [], | ||
| }); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, should this be moved into a constants file or just use the env var inline