fix: serialized keyring comparison when updating the vault #5928
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
mikesposito
commented
Jun 5, 2025
cryptodev-2s
previously approved these changes
Jun 5, 2025
This reverts commit ec3d6cd.
github-merge-queue bot
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
github-merge-queue bot
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
DDDDDanica
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
runway-github bot
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 2025
](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1){kind=link}
<!-- 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
runway-github bot
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
runway-github bot
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 2025
…o `^22.0.2` (#33513) <!-- 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
runway-github bot
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
runway-github bot
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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.
DDDDDanica
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 2025
- fix: bump `@metamask/keyring-controller` to `^22.0.2` (#33513) <!-- 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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. [fd2d065](fd2d065) Co-authored-by: Michele Esposito <[email protected]>
DDDDDanica
pushed a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 10, 2025
…o `^22.0.2` cp-12.20.0 (#33567) - fix: bump `@metamask/keyring-controller` to `^22.0.2` (#33513) <!-- 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? --> See changelog for details: ```markdown ## [22.0.2] ### Fixed - Fixed serialized keyring comparison when establishing whether a vault update is needed ([#5928](MetaMask/core#5928)) - The vault update was being skipped when a keyring class returns an object shallow copy through `.serialize()`. ``` [](https://codespaces.new/MetaMask/metamask-extension/pull/33513?quickstart=1) ## **Related issues** * Fixes: #33232 ## **Manual testing steps** 1. Pair new Lattice device 2. Check the pairing step works as expected, and that a new Lattice account has been added ## **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. [fd2d065](fd2d065) Co-authored-by: Michele Esposito <[email protected]>
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
As a performance improvement (#5732), we want to check if a keyring has been updated after an operation, to establish whether a vault update is needed.
Though this comparison returns false negatives when the keyring returns a shallow copy of one of its internal variables through
.serialize(), like Lattice keyring is currently doing (see https://github.com/GridPlus/eth-lattice-keyring/blob/9cd87d16522ef78a9bdb740b5c18b0fd93c67683/index.js#L58)We can change how session states are compared to protect us against these cases, by stringifying the value returned by
#getSessionState.References
Changelog
Checklist