Migrate MetaMask Connector to use new SDK (MMConnect) by adonesky1 · Pull Request #2326 · Web3Auth/web3auth-web

adonesky1 · 2026-01-07T22:37:30Z

Summary

Migrate MetaMask integration from @metamask/sdk to @metamask/connect-evm for improved connection handling
Refactor MetaMaskConnector to use the new SDK's createEVMClient() API with built-in event handlers and automatic chain management
Remove manual chain addition logic as the new SDK handles this internally during switchChain()
Update connector settings interface to align with the new SDK's configuration options

Videos

Extension:
https://drive.google.com/file/d/1r_lDBvwHWQhP-J4yFfqVHsqRR7bIS6Z1/view?usp=sharing

Mobile (native browser):
https://drive.google.com/file/d/1XECLgCOqa9VEeIK4gp1nUf0cs6RRg2V1/view?usp=sharing

Note

Medium Risk
Replaces the MetaMask connection stack and chain switching flow, which can affect wallet connection/rehydration behavior across EVM and Solana. Also adds new auth-token signing paths via EVM personal_sign and Solana wallet-standard signing, which may break login/authorization if provider behaviors differ.

Overview
Migrates the MetaMaskConnector from @metamask/sdk to the MetaMask Connect stack (@metamask/connect-multichain, @metamask/connect-evm, @metamask/connect-solana), changing it to a multichain connector that can surface both an EVM provider and a Solana wallet from one connection.

Updates initialization/connection/disconnection to use the multichain client (including display_uri handling for QR flows), revises connector configuration to a new MetaMaskConnectorSettings shape (dapp, ui, debug), and changes switchChain to use the new EVM client (dropping the old manual add-chain logic and disallowing switchChain when multiple namespaces are configured).

Adds a connector-level getAuthTokenInfo() implementation that creates a challenge and signs it via EVM personal_sign or Solana walletSignMessage depending on the active chain.

Demo/package updates: adjusts no-modal dependencies and lockfiles accordingly, tweaks noModal.ts to pass ui.headless, and enables server.host in the Vue demo Vite config.

^{Reviewed by Cursor Bugbot for commit 8e26a9a. Bugbot is set up for automated code reviews on this repo. Configure here.}

vercel · 2026-01-07T22:37:35Z

@adonesky1 is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

demo/vue-app-new/src/services/ethHandlers.ts

demo/vue-app-new/src/utils/constants.ts

jiexi · 2026-01-20T21:51:17Z

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

+      this.metamaskInstance = await this.metamaskPromise;
+      // TODO: Remove this hack
+      // Hack to ensure the ConnectEvm instance has fully resumed the connection
+      await new Promise((resolve) => setTimeout(resolve, 2000));


Note this awful delay to ensure that this async call in the ConnectEvm constructor has fully resolved. We need to fix this on the connect-monorepo side

What is your understanding of how we resolve this on the connect-evm side of things?

Ticket to resolve this here: https://consensyssoftware.atlassian.net/browse/WAPI-1035?atlOrigin=eyJpIjoiMjk1OGRjZjE3MjcwNDQyMzhjODdmMjU3MTMyMDdhMmEiLCJwIjoiaiJ9

we need to release connect-evm again, bump the version in web3auth, and then remove this setTimeout

jiexi · 2026-01-20T21:52:15Z

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

+      // if (options.autoConnect) {
+      //   this.rehydrated = false;
+      //   this.emit(CONNECTOR_EVENTS.REHYDRATION_ERROR, new Error("Failed to resume existing MetaMask Connect session.") as Web3AuthError);
+      // } else {


i think this commented code can be dropped?.. Not sure if it's more appropriate to throw an error if we fail to resume a previous session OR if we just say the connector is ready for new connections

I would think it makes more sense to just say the connector is ready for new connections. But perhaps we should speak with @chaitanyapotti to see what patterns they recommend for their connectors

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

jiexi · 2026-01-20T22:29:09Z

Need: MetaMask/connect-monorepo#124

jiexi · 2026-01-27T22:05:58Z

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

+/**
+ * Configuration options for the MetaMask connector using @metamask/connect-evm
+ */
+export interface MetaMaskConnectorSettings {
+  /** Dapp identification and branding settings */
+  dapp?: {
+    name?: string;
+    url?: string;
+  };
+  /** Enable debug logging for the MetaMask SDK */
+  debug?: boolean;
+}

 export interface MetaMaskConnectorOptions extends BaseConnectorSettings {
-  connectorSettings?: Partial<MetaMaskSDKOptions>;
+  connectorSettings?: MetaMaskConnectorSettings;


reminder to document this breaking change and include migration instructions where appropriate

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

demo/vue-app-new/src/utils/constants.ts

jiexi · 2026-03-16T22:29:35Z

demo/vue-app-new/src/utils/constants.ts

this needs to be undone before merge again

jiexi · 2026-03-16T22:29:47Z

demo/vue-app-new/vite.config.mts

this needs to be undone before merge again

…-connector # Conflicts: # demo/react-app-no-modal/package-lock.json # demo/vue-app-new/package-lock.json # package-lock.json # packages/no-modal/package.json # packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

…-connector

cursor · 2026-04-10T20:17:05Z

demo/vue-app-new/vite.config.mts

    mode,
    server: {
      port: 8080,
+      host: true,


Dev server exposed on all network interfaces

Low Severity

host: true exposes the Vite dev server on all network interfaces (0.0.0.0), which is inconsistent with every other demo app in the repo. This was likely added temporarily to enable mobile device testing (the PR shows mobile browser testing videos) and appears to be one of the items @jiexi flagged as needing to be "undone before merge again."

^{Reviewed by Cursor Bugbot for commit 60f3609. Configure here.}

demo/react-app-no-modal/package-lock.json

cursor

Cursor Bugbot has reviewed your changes and found 3 potential issues.

There are 4 total unresolved issues (including 1 from previous review).

^{Reviewed by Cursor Bugbot for commit 8e26a9a. Configure here.}

cursor · 2026-04-13T17:01:33Z

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

    } catch (error) {
-      this.emit(CONNECTOR_EVENTS.REHYDRATION_ERROR, error as Web3AuthError);
+      initReject(WalletLoginError.connectionError("Failed to initialize MetaMask Connect SDK", error));
+    }


Partial init failure leaves connector falsely ready

High Severity

When createMultichainClient succeeds but createEVMClient or createSolanaClient throws, initReject rejects initializationPromise but execution continues past the catch block. Since this.multichainClient is non-null, the null guard at line 266 passes and the connector status is set to READY based on multichainClient.status. The connector now appears ready to consumers, but any call to connect() will always fail because ensureInitialized() awaits the already-rejected initializationPromise.

Additional Locations (1)

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts#L265-L270

^{Reviewed by Cursor Bugbot for commit 8e26a9a. Configure here.}

cursor · 2026-04-13T17:01:33Z

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts

+      //   if (currentChainId !== chainId) {
+      //     await this.switchChain(chainConfig, true);
+      //   }
+      // }


Commented-out chain switching skips requested chain selection

Medium Severity

The EVM chain-switching logic after connect is entirely commented out. After connecting via the multichain client, the connector never switches to the chainId the caller requested. If the wallet is on a different EVM chain than expected, users will silently operate on the wrong chain.

^{Reviewed by Cursor Bugbot for commit 8e26a9a. Configure here.}

cursor · 2026-04-13T17:01:33Z

demo/vue-app-new/package-lock.json

    "node_modules/ox": {
      "version": "0.11.3",
-      "resolved": "https://registry.npmjs.org/ox/-/ox-0.11.3.tgz",
+      "resolved": "https://consensys.jfrog.io/artifactory/api/npm/npm/ox/-/ox-0.11.3.tgz",


Package lock resolves from private Artifactory registry

Medium Severity

Third-party packages ox, @adraffy/ens-normalize, and @noble/curves have their resolved URLs changed from the public npm registry to consensys.jfrog.io. This is a private Artifactory proxy that other contributors and CI won't have access to, and is flagged in the PR discussion as needing to be undone before merge.

Additional Locations (2)

demo/vue-app-new/package-lock.json#L8624-L8626

demo/vue-app-new/package-lock.json#L8630-L8632

^{Reviewed by Cursor Bugbot for commit 8e26a9a. Configure here.}

adonesky1 added 3 commits January 7, 2026 16:04

migrate metamask connector to new sdk

6fbe545

package update

159a350

wip

67013a6

adonesky1 marked this pull request as draft January 7, 2026 23:03

adonesky1 and others added 3 commits January 8, 2026 14:52

more working

8d67eaf

more working

52bafcb

Fix metamask connector

288a667

jiexi mentioned this pull request Jan 20, 2026

fix: Fix eth_chainId not being resolved from cache when using EIP-1193 Provider MetaMask/connect-monorepo#124

Merged

4 tasks

jiexi reviewed Jan 20, 2026

View reviewed changes

demo/vue-app-new/src/services/ethHandlers.ts Outdated Show resolved Hide resolved

jiexi reviewed Jan 20, 2026

View reviewed changes

demo/vue-app-new/src/utils/constants.ts Outdated Show resolved Hide resolved

jiexi reviewed Jan 20, 2026

View reviewed changes

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts Outdated Show resolved Hide resolved

jiexi and others added 10 commits January 22, 2026 12:44

use connect-evm 0.3.0

114cfbd

fix package lock

17e1c44

adopt ConnectEvm.status change

054ad3f

Merge remote-tracking branch 'origin' into ad/migrate-metamask-connector

f3ce613

update package-lock.json

ea7e070

connect-evm bump

dda7b97

package-lock

8e4a2c8

Merge remote-tracking branch 'origin' into ad/migrate-metamask-connector

0eac6bb

cleanup

b9c977a

more cleanup

24e210d

adonesky1 changed the title ~~Update metamask connector WIP~~ Migrate MetaMask Connector to use new SDK (MMConnect) Jan 23, 2026

adonesky1 marked this pull request as ready for review January 23, 2026 22:34

jiexi reviewed Jan 27, 2026

View reviewed changes

jiexi added 2 commits January 27, 2026 15:20

bump connect-evm 0.4.1

5379c92

remove timeout hack

87da4b7

jiexi added 2 commits March 4, 2026 12:58

expose UI options

b2dacdf

add display_uri

76625eb

cursor bot reviewed Mar 4, 2026

View reviewed changes

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts Show resolved Hide resolved

packages/no-modal/src/connectors/metamask-connector/metamaskConnector.ts Show resolved Hide resolved

jiexi added 2 commits March 4, 2026 13:14

make sure no UI is shown

efd18ff

revert this before merge

36479eb

cursor bot reviewed Mar 4, 2026

View reviewed changes

demo/vue-app-new/src/utils/constants.ts Outdated Show resolved Hide resolved

bump to connect-evm 0.8.0

0ba1302

jiexi reviewed Mar 16, 2026

View reviewed changes

demo/vue-app-new/src/utils/constants.ts

Copy link
Copy Markdown

jiexi Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needs to be undone before merge again

jiexi reviewed Mar 16, 2026

View reviewed changes

demo/vue-app-new/vite.config.mts

Copy link
Copy Markdown

jiexi Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needs to be undone before merge again

jiexi added 2 commits March 16, 2026 15:44

restore modalMode

42f1f7f

jiexi requested review from a team as code owners March 31, 2026 20:41

jiexi added 7 commits March 31, 2026 14:24

fix build issue

ed384ca

Merge remote-tracking branch 'origin/master' into ad/migrate-metamask…

d292028

…-connector

add connect-solana

662cac5

add connect-multichain

648f8b8

fix constants

f4ad5df

use multichain client to connect/disconnect. Fix display_uri

85e251b

rename cleanup

60f3609

cursor bot reviewed Apr 10, 2026

View reviewed changes

jiexi added 3 commits April 10, 2026 13:56

cleanup init

e955d9a

add solana client and provider

538d1e5

expose solana provider. Fix solana chainId on connect

c465f54

cursor bot reviewed Apr 10, 2026

View reviewed changes

demo/react-app-no-modal/package-lock.json Outdated Show resolved Hide resolved

tanguyenvn changed the base branch from master to feat/metamask-connect April 13, 2026 16:54

Merge branch 'feat/metamask-connect' into ad/migrate-metamask-connector

8e26a9a

tanguyenvn approved these changes Apr 13, 2026

View reviewed changes

tanguyenvn merged commit 595e646 into Web3Auth:feat/metamask-connect Apr 13, 2026
1 of 2 checks passed

cursor bot reviewed Apr 13, 2026

View reviewed changes

Conversation

adonesky1 commented Jan 7, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Videos

Uh oh!

vercel bot commented Jan 7, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jiexi commented Jan 20, 2026

Uh oh!

jiexi Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot Apr 10, 2026

Choose a reason for hiding this comment

Dev server exposed on all network interfaces

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Apr 13, 2026

Choose a reason for hiding this comment

Partial init failure leaves connector falsely ready

Uh oh!

cursor bot Apr 13, 2026

Choose a reason for hiding this comment

Commented-out chain switching skips requested chain selection

Uh oh!

cursor bot Apr 13, 2026

Choose a reason for hiding this comment

Package lock resolves from private Artifactory registry

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adonesky1 commented Jan 7, 2026 •

edited by cursor bot

Loading

jiexi Jan 27, 2026 •

edited

Loading