chore: add metadata to account controller options for EVM HD accounts #5618
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
…o normal-account-options
Member
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
# Conflicts: # packages/accounts-controller/CHANGELOG.md
This was referenced Apr 30, 2025
Closed
ccharly
reviewed
Apr 30, 2025
ccharly
reviewed
Apr 30, 2025
ccharly
reviewed
Apr 30, 2025
Co-authored-by: Michele Esposito <[email protected]>
ccharly
reviewed
Apr 30, 2025
…e properties Co-authored-by: Charly Chevalier <[email protected]>
mirceanis
added
the
team-identity
mikesposito
approved these changes
Apr 30, 2025
ccharly
approved these changes
Apr 30, 2025
mirceanis
approved these changes
Apr 30, 2025
rerunning jobs did not work and merging the PR is blocked
23 tasks
7 tasks
github-merge-queue bot
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
May 15, 2025
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** <!-- Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions: 1. What is the reason for the change? 2. What is the improvement/solution? --> Updating `@metamask/keyring-controller` to `^22.0.0`: ```markdown ## [22.0.0] ### Changed - **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725)) - The metadata is now stored in each keyring object in the `state.keyrings` array. - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update. ### Fixed - Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775)) ## [21.0.6] ### Changed - Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732)) ``` and `@metamask/accounts-controller` to `^29.0.0`: ```markdown ## [29.0.0] ### Changed - **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802)) ## [28.0.0] ### Added - Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714)) - Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618)) ### Changed - **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639)) - **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722)) - Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565)) - Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565)) - Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565)) ### Fixed - Do not fire events during `update` blocks ([#5555](MetaMask/core#5555)) - Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735)) ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1) ## **Related issues** Fixes: #32935 ## **Manual testing steps** ### 1. Add duplicate to the wallet state 1.1. Switch to the `v11.7.3` branch, build locally, and install the extension from `chrome://extensions` 1.2. Onboard with an SRP of which we know the second account (`child guilt hollow arrive average popular nasty soon summer like scheme diary pill country rapid`) 1.3. Import an account that is part of the mnemonic ( `0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b` which is the account at index 2 of the above SRP) 1.4. Add a new account on the main HD 1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in `chrome://extensions` 1.6. Unlock the wallet, you should see duplicates in your accounts list and you won't be able to add new accounts ### 2. Test the fix 2.1. Switch to this branch, build locally, and refresh the extension in `chrome://extensions` 2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and you should be able to add new accounts ## **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** - [ ] 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). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] 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** - [ ] 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. --------- Co-authored-by: Mark Stacey <[email protected]>
DDDDDanica
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
May 15, 2025
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> <!-- Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions: 1. What is the reason for the change? 2. What is the improvement/solution? --> Updating `@metamask/keyring-controller` to `^22.0.0`: ```markdown - **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725)) - The metadata is now stored in each keyring object in the `state.keyrings` array. - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update. - Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775)) - Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732)) ``` and `@metamask/accounts-controller` to `^29.0.0`: ```markdown - **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802)) - Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714)) - Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618)) - **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639)) - **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722)) - Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639)) - Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565)) - Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565)) - Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565)) - Do not fire events during `update` blocks ([#5555](MetaMask/core#5555)) - Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735)) ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1) Fixes: #32935 1.1. Switch to the `v11.7.3` branch, build locally, and install the extension from `chrome://extensions` 1.2. Onboard with an SRP of which we know the second account (`child guilt hollow arrive average popular nasty soon summer like scheme diary pill country rapid`) 1.3. Import an account that is part of the mnemonic ( `0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b` which is the account at index 2 of the above SRP) 1.4. Add a new account on the main HD 1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in `chrome://extensions` 1.6. Unlock the wallet, you should see duplicates in your accounts list and you won't be able to add new accounts 2.1. Switch to this branch, build locally, and refresh the extension in `chrome://extensions` 2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and you should be able to add new accounts <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> <!-- [screenshots/recordings] --> <!-- [screenshots/recordings] --> - [ ] 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). - [ ] 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](https://jsdoc.app/) format if applicable - [ ] 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. - [ ] 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. --------- Co-authored-by: Mark Stacey <[email protected]>
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
mathieuartu
added a commit
that referenced
this pull request
Jun 3, 2025
…RP (#5753) ## Explanation This is a first pass at syncing account data for each SRP. This PR adds an optional `entropySourceId` param to all methods that might use it, and then uses it for account-syncing. Following #5618 we have extra `options` available on `InternalAccount` objects; `entropySource` and `derivationPath`. 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. * Proposal for a later PR: it might be easier to replace the spray of `entropySourceId` params in the user-storage sdk/controller with multiple `this.config.auth` instances, or something along those lines. * the SRP JWT bearer authenticator can have multiple instances; each instance could use a class member `entropySourceId` instead of needing an update to all method params * the Auth controller is a singleton, this means its methods will need to accept `entropySourceId` parameters * not sure yet if these can be reconciled; perhaps the controller can maintain multiple instances of the SDK authenticators * will solve these in later passes --- ### Subtasks - [x] (EXTENSION) on `performSignIn`, list entropy sources, login for each - [x] (EXTENSION) Hook to the srp added event to create another auth session and bind it to the srp id - [x] (EXTENSION) Fix conflict for first account being renamed when importing a new SRP - [x] (EXTENSION + CORE) Implement working multi-auth management - [x] (EXTENSION + CORE) Implement working multi-SRP account syncing - [x] Remove duplicate `getIdentifier` call - [x] Deprecate `sessionData` and use `srpSessionData` instead - [x] Add calls to `updateAccounts` before each sync to refresh `entropySource` when missing - [x] filter `listAccounts` to get accounts by entropySourceId - [x] Implement entropySourceId based big sync (multiple sequential big syncs) - [x] Fix fixtures and CI - [x] Add new tests to cover multi SRP auth - [x] Add new tests to cover multi SRP account syncing - [ ] Verify with smart accounts? (not especially relevant to multi-SRP though) - [x] Enhance auth mockResponses for client E2E environments to support mocked multi-SRP auth & storage - [x] (EXTENSION) Add new E2E framework that support multi-auth/SRP - [x] (EXTENSION) Add multi SRP account syncing E2E test case - [x] (MOBILE) Add new E2E framework that support multi-auth/SRP - [x] (MOBILE) Add multi SRP account syncing E2E test case ## References Fixes: - https://consensyssoftware.atlassian.net/browse/IDENTITY-42 - https://consensyssoftware.atlassian.net/browse/IDENTITY-91 Related to: - https://consensyssoftware.atlassian.net/browse/IDENTITY-43 - https://consensyssoftware.atlassian.net/browse/IDENTITY-102 ## Changelog ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [X] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes. Test drive PRs: - ✅ Extension: MetaMask/metamask-extension#32951 - ✅ Mobile: MetaMask/metamask-mobile#15357 --------- Co-authored-by: Mathieu Artu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1){kind=link}
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
In the multi-SRP context, we need to bubble up the Account metadata such that it is available in interactions with the AccountsController.
This metadata will be used by the Backup & Sync feature to determine how to reconstruct the account when restoring from backup.
References
Fixes Identity-90
Changelog
Checklist