Description

When the "Selected networks for each site" toggle is enabled, the wallet API should use an origin-specific chain for all interactions. However this doesn't work correctly if the connection status has changed since the last refresh. If you grant permissions to a site or revoke them (i.e. connect to or disconnect from a site), the site does not work as expected until after the site is refreshed.

Expected behavior
The wallet API should always use the dapp-selected chain for sites with permissions, and should use the globally-selected chain for sites without permissions. This should apply even if the permissions have changed since the page loaded.

Solution

This PR introduces changes made to @metamask/selected-network-controller to resolve the issue described above:

Previously the SelectedNetworkController only constructed proxies for domains that had permissions. Other domains have no associated proxy and the getProviderAndBlockTracker method would throw an error. This was problematic because we grab the network client for an origin a single time when constructing an RPC pipeline for that origin in the MetaMask extension. We don't re-create the RPC pipeline when permissions change. That means that the pipeline is setup with the wrong network client and cannot be updated. The following changes ensure seamlessly proxying calls during sessions where a dapp connects/disconnects and provides a path for clients to prune inactive proxies.

This domainProxyMap param now passed into SelectedNetworkController allows the client to handle pruning inactive proxies while the SelectedNetworkController handles adding entries - it can't handle removal, as it doesn't know which connections are active.

The extension passes in an instance of a newly created WeakStringMap class which allows for garbage collection of its data once no longer referenced.

Related issues

Fixes: #23509

Manual testing steps

The problem presented itself in two scenarios: when granting site permissions, and when revoking all site permissions.

When granting permissions:

• Enable the "Selected networks for each site" toggle
• Open a site with no permissions in one tab, and the fullscreen wallet UI in another
• If the site was open already, hard-refresh before proceeding
• Call eth_requestAccounts on the site, asking for the eth_accounts permissions
• Approve the request
• Call eth_chainId from the site, and see that it matches the wallet selected chain
• Switch the selected chain in the fullscreen UI
• Call eth_chainId from the site, and see that it is still on the same chain the wallet was connected to before switching

When revoking permissions:

• Redo all the same steps for When granting permissions:
• Open the browser-action popup, click on the three-vertical-dots menu, click "Connected sites", then disconnect from the site
• Call eth_chainId from the site. See that the sites connected chain is now the same as the "globally selected chain" in the wallet

Screenshots/Recordings

Before

This recording shows both reproduction use cases (granting permissions, then revoking)

After

Pre-merge author checklist

• I’ve followed MetaMask Coding Standards.
• I've clearly explained what problem this PR is solving and how it is solved.
• I've linked related issues
• I've included manual testing steps
• I've included screenshots/recordings if applicable
• [x]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.
• I’ve properly set the pull request status:
  • In case it's not yet "ready for review", I've set it to "draft".
  • In case it's "ready for review", I've changed it from "draft" to "non-draft".

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.