feat(backup & sync): use entropySourceId to sync accounts for Multi-SRP #5753
Conversation
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
…art 1 This is a first pass at syncing account data for each SRP. This commit adds an entropySourceId param to all methods that might use it.
7 tasks
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
7 tasks
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
duplicate getIdentifier call
…in e2e environments
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
4 tasks
mirceanis
added a commit
that referenced
this pull request
May 22, 2025
…t` (#5841) ## Explanation `AccountsController:accountAdded` events were missing the `.options.entropySource` property, causing account syncing to misbehave, registering new accounts to the primary SRP instead of the actual SRP used to add the account. We now add the `entropySource` to these new `InternalAccount`s based on the `keyring` that was used to create them. ## References Relates to #5618 Relates to #5725 Relates to #5753
|
@metamaskbot publish-preview |
mirceanis
commented
May 22, 2025
There was a problem hiding this comment.
@mathieuartu I added a bunch of notes and questions. Please take a look 🙏
packages/profile-sync-controller/src/controllers/authentication/AuthenticationController.ts
Show resolved
Hide resolved
packages/profile-sync-controller/src/controllers/authentication/AuthenticationController.ts
Show resolved
Hide resolved
packages/profile-sync-controller/src/controllers/user-storage/UserStorageController.ts
Show resolved
Hide resolved
...ofile-sync-controller/src/controllers/user-storage/account-syncing/controller-integration.ts
Outdated
Show resolved
Hide resolved
packages/profile-sync-controller/src/controllers/user-storage/UserStorageController.ts
Outdated
Show resolved
Hide resolved
...ofile-sync-controller/src/controllers/user-storage/account-syncing/controller-integration.ts
Outdated
Show resolved
Hide resolved
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
mirceanis
added
team-identity
Prithpal-Sooriya
approved these changes
Jun 3, 2025
mathieuartu
approved these changes
Jun 3, 2025
There was a problem hiding this comment.
Approving @mirceanis changes, while also approving my changes on behalf of @mirceanis
github-merge-queue bot
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 11, 2025
## **Description** This PR implements the core changes seen in [this PR](MetaMask/core#5753). In short, this changes the implementation of `AuthenticationController` so that it can manage parallel sessions based on `entropySource`. In turn, this addition permits `UserStorageController` to scope user storage requests to a specific `entropySource`. Using all those changes, account syncing now iterates over each `entropySource` present in the client and syncs accounts in consequence. This will ensure that each SRP has its own data, that can be synced independently of the context (e.g Device 1 (SRP 1 + SRP 2), Device 2 (SRP 2 only) will bi-directionally sync). [](https://codespaces.new/MetaMask/metamask-extension/pull/32951?quickstart=1) ## **Related issues** Fixes: - https://consensyssoftware.atlassian.net/browse/IDENTITY-43 - https://consensyssoftware.atlassian.net/browse/IDENTITY-102 ## **Manual testing steps** 1. Import or create an SRP, complete onboarding, add and rename an EVM account 2. Import a second SRP, add and rename an EVM account 3. Uninstall and reinstall extension, onboard with one or both previous SRPs 4. Verify that EVM accounts are restored ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <!-- [screenshots/recordings] --> ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] 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. --------- Co-authored-by: MetaMask Bot <[email protected]>
](https://codespaces.new/MetaMask/metamask-extension/pull/32951?quickstart=1){kind=link}
github-merge-queue bot
pushed a commit
to MetaMask/metamask-mobile
that referenced
this pull request
Jun 12, 2025
## **Description** This PR implements the core changes seen in [this PR](MetaMask/core#5753). In short, this changes the implementation of `AuthenticationController` so that it can manage parallel sessions based on `entropySource`. In turn, this addition permits `UserStorageController` to scope user storage requests to a specific `entropySource`. Using all those changes, account syncing now iterates over each `entropySource` present in the client and syncs accounts in consequence. This will ensure that each SRP has its own data, that can be synced independently of the context (e.g Device 1 (SRP 1 + SRP 2), Device 2 (SRP 2 only) will bi-directionally sync). ## **Related issues** Fixes: - https://consensyssoftware.atlassian.net/browse/IDENTITY-43 - https://consensyssoftware.atlassian.net/browse/IDENTITY-102 ## **Manual testing steps** 1. Import or create an SRP, complete onboarding, add and rename an EVM account 2. Import a second SRP, add and rename an EVM account 3. Uninstall and reinstall extension, onboard with one or both previous SRPs 4. Verify that EVM accounts are restored ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <!-- [screenshots/recordings] --> ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation
This is a first pass at syncing account data for each SRP.
This PR adds an optional
entropySourceIdparam to all methods that might use it, and then uses it for account-syncing.Following #5618 we have extra
optionsavailable onInternalAccountobjects;entropySourceandderivationPath.We can use these to properly segregate account data for multi-SRP.
This PR does not introduce breaking changes to the API, but to be able to get the benefits we still need the clients to cooperate, so some changes are needed there too.
entropySourceIdparams in the user-storage sdk/controller with multiplethis.config.authinstances, or something along those lines.entropySourceIdinstead of needing an update to all method paramsentropySourceIdparametersSubtasks
performSignIn, list entropy sources, login for eachgetIdentifiercallsessionDataand usesrpSessionDatainsteadupdateAccountsbefore each sync to refreshentropySourcewhen missinglistAccountsto get accounts by entropySourceIdReferences
Fixes:
Related to:
Changelog
Checklist