Adds OAuth Controller required for seedless onboarding #14889

ieow · 2025-04-25T12:04:03Z

Description

Integration the following social login via the OAuth Service and SeedlessController,

Google
Apple

Proposed Authentication Flow using seedless onboarding

This PR mainly integrate the Seedless Controller and the OAuthServices into Metamask.
It does not include the Login UI Flow.
The Login UI Flow will be added on top of the new SRP UI Flow

Related issues

Fixes:

Manual testing steps

Go to this page...

Screenshots/Recordings

Before

After

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

fix typo on folder name

fix baseHandler private methods

Co-authored-by: himanshuchawla009 <[email protected]>

remove unused test

github-actions · 2025-04-25T12:04:16Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

ieow · 2025-04-28T08:07:28Z

I have read the CLA Document and I hereby sign the CLA

sethkfman · 2025-04-29T15:21:13Z

app/core/OAuthService/OAuthInterface.ts

@@ -0,0 +1,80 @@
+import { AuthSessionResult } from 'expo-auth-session';


@chaitanyapotti I would recommend that you add these directories to the .github/CODEOWNERS file.

Cal-L

Left some comments

Cal-L · 2025-04-30T18:58:09Z

app/core/Engine/controllers/seedless-onboarding-controller/index.ts

+} from '@metamask/seedless-onboarding-controller';
+import { Encryptor, LEGACY_DERIVATION_OPTIONS } from '../../../Encryptor';
+
+export const web3AuthNetwork = process.env.Web3AuthNetwork as Web3AuthNetwork;


Suggested change

export const web3AuthNetwork = process.env.Web3AuthNetwork as Web3AuthNetwork;

export const web3AuthNetwork = process.env.WEB3_AUTH_NETWORK as Web3AuthNetwork;

Also, should this be moved into a constants file or just use the env var inline

Cal-L · 2025-04-30T18:58:33Z

app/core/Engine/controllers/seedless-onboarding-controller/index.ts

+export const web3AuthNetwork = process.env.Web3AuthNetwork as Web3AuthNetwork;
+
+if (!web3AuthNetwork) {
+  throw new Error('Missing environment variables');


Suggested change

throw new Error('Missing environment variables');

throw new Error('Missing environment variable WEB3_AUTH_NETWORK');

Cal-L · 2025-04-30T19:01:17Z

app/core/Engine/controllers/seedless-onboarding-controller/index.ts

+}
+
+const encryptor = new Encryptor({
+  keyDerivationOptions: LEGACY_DERIVATION_OPTIONS,


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?

Cal-L · 2025-04-30T19:03:33Z

app/core/Engine/messengers/seedless-onboarding-controller-messenger/index.ts

+) {
+  return baseControllerMessenger.getRestricted({
+    name: 'SeedlessOnboardingController',
+    allowedEvents: [],


I don't have visibility to the seedless onboarding controller. Does the controller use actions or events of other controllers?

Cal-L · 2025-04-30T19:06:59Z

app/util/test/initial-background-state.json

@@ -485,5 +485,8 @@
        }
      ]
    }
+  },
+  "SeedlessOnboardingController": {


To be safe, let's also create a new migration to prepopulate the controller with this state

Cal-L · 2025-04-30T19:11:07Z

package.json

@@ -332,6 +340,7 @@
    "react-native-fs": "^2.20.0",
    "react-native-gesture-handler": "^1.10.3",
    "react-native-get-random-values": "^1.8.0",
+    "react-native-google-acm": "git+https://github.com/Web3Auth/react-native-google-acm.git#edf4e52397f766d56d1644d908246e358f3cf774",


Did we bypass the paid version by forking our own and adding our own implementation?

Cal-L · 2025-04-30T19:16:07Z

app/core/OAuthService/OAuthService.ts

+}
+
+export class OAuthService {
+  public localState: {


Extract types

Cal-L · 2025-04-30T19:49:09Z

app/core/OAuthService/OAuthService.ts

+    ReduxService.store.dispatch({
+      type: UserActionType.LOADING_SET,
+      payload: {
+        loadingMsg: 'Logging in...',


Probably not necessary to pass in payload since this is static. We can just set it in the reducer itself

Cal-L · 2025-04-30T19:50:00Z

app/core/OAuthService/OAuthService.ts

+    data: AuthResponse,
+    authConnection: AuthConnection,
+  ): Promise<{
+    type: 'success' | 'error';


Extract into enum

Cal-L · 2025-04-30T19:52:09Z

app/core/OAuthService/OAuthService.ts

+}
+
+if (!AuthServerUrl || !AuthConnectionId || !GroupedAuthConnectionId) {
+  throw new Error('Missing environment variables');


Let's move this condition to the top of the file below imports and specify explicitly, which env vars are missing

ieow and others added 30 commits April 23, 2025 13:27

feat: initial commit seedless integration

8051e3b

fix: add patch

af381bc

fix typo on folder name

fix: getting seedless controller initial test pass

664ac70

feat: simple tests

6143a4a

rename: to authConnection

53c367d

update: upload seedless controller package

7ad5fd4

fix: update with seedless contorller

ac5607e

fix: lint

c6f4590

fix: update comment

f8952b1

fix: use baseHandler

cef712b

fix: seedless

ab32e19

fix: use env

3833daf

working review

ef332ad

fix: use env for AuthConnectionId

de8f5ac

fix: update env constant

1c1e958

fix: fomatting

14ab169

fix: redux state for seedless controller

3599963

fix: add env to test

db56659

fix baseHandler private methods

fix: add Error class for oauth2login

5824e0c

fix: apple login

a5c3b42

fix: add JsDoc

adea362

fix: tests

563849e

fix: rename file

9c7b458

fix: rename to OAuthService

c8e5b1a

fix: rename oauth2 to oauth

d3bdd54

Update app/core/OAuthService/OAuthLoginHandlers/androidHandlers/apple.ts

e4f0af6

Co-authored-by: himanshuchawla009 <[email protected]>

Update app/core/OAuthService/OAuthLoginHandlers/baseHandler.ts

d49a2fc

Co-authored-by: himanshuchawla009 <[email protected]>

fix: update AuthResponse data type

0fd98b5

fix: fix engine test

31f3725

remove unused test

fix: address comment

f52172f

ieow added 5 commits April 25, 2025 23:52

fix: renable test and format document

b2b2511

fix: tests and error constructor

28d92de

fix: remove from redux state

2f4b52e

fix: add feature flag

fa26464

fix: better type handling

3fdaafc

chaitanyapotti added this to PR review queue Apr 28, 2025

github-project-automation bot moved this to Needs dev review in PR review queue Apr 28, 2025

chaitanyapotti added team-web3auth area-onboarding labels Apr 28, 2025

chaitanyapotti assigned ieow Apr 28, 2025

Merge branch 'main' into feat/main-seedless-onboarding

5ed2216

chaitanyapotti added the No QA Needed Apply this label when your PR does not need any QA effort. label Apr 28, 2025

fix: update snapshot for engine initialState

098d6cf

chaitanyapotti marked this pull request as ready for review April 29, 2025 09:17

chaitanyapotti requested review from a team as code owners April 29, 2025 09:17

chaitanyapotti changed the title ~~Feat/main seedless onboarding controller integration~~ Adds OAuth Controller required for seedless onboarding Apr 29, 2025

sethkfman reviewed Apr 29, 2025

View reviewed changes

ieow mentioned this pull request Apr 30, 2025

Feat/main seedless onboarding UI toprf #14999

Draft

7 tasks

Cal-L reviewed Apr 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds OAuth Controller required for seedless onboarding #14889

Adds OAuth Controller required for seedless onboarding #14889

ieow commented Apr 25, 2025 •

edited

Loading

github-actions bot commented Apr 25, 2025 •

edited

Loading

ieow commented Apr 28, 2025

sethkfman Apr 29, 2025

Cal-L left a comment

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

Cal-L Apr 30, 2025

		@@ -0,0 +1,80 @@
		import { AuthSessionResult } from 'expo-auth-session';

	export const web3AuthNetwork = process.env.Web3AuthNetwork as Web3AuthNetwork;
	export const web3AuthNetwork = process.env.WEB3_AUTH_NETWORK as Web3AuthNetwork;

	throw new Error('Missing environment variables');
	throw new Error('Missing environment variable WEB3_AUTH_NETWORK');

Adds OAuth Controller required for seedless onboarding #14889

Are you sure you want to change the base?

Adds OAuth Controller required for seedless onboarding #14889

Conversation

ieow commented Apr 25, 2025 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Apr 25, 2025 • edited Loading

ieow commented Apr 28, 2025

Choose a reason for hiding this comment

Cal-L left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ieow commented Apr 25, 2025 •

edited

Loading

github-actions bot commented Apr 25, 2025 •

edited

Loading