KeyringController: select only supported properties in fullUpdate#1710
Merged
mikesposito merged 1 commit intomainfrom Sep 27, 2023
Merged
KeyringController: select only supported properties in fullUpdate#1710mikesposito merged 1 commit intomainfrom
KeyringController: select only supported properties in fullUpdate#1710mikesposito merged 1 commit intomainfrom
Conversation
mikesposito
changed the title
KeyringController: select only supported properties in fullUpdate
8 tasks
mikesposito
force-pushed
the
fix/keyring-controller-keyring-types
branch
from
7aea835 to
b8e8092
Compare
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
…#1710) ## Explanation The property `keyringTypes` has been removed from `KeyringController`'s store, but as `EthKeyringController` still has this property in its `memStore`, and as in the `KeyringController.#fullUpdate` we destructure the entire object, we also carry over `keyringTypes` - a property we don't have metadata for. This PR changes the `#fullUpdate` internal method to only take these properties from `EthKeyringController` stores: - `vault` - `keyrings` - `isUnlocked` - `encryptionKey` - `encryptionSalt` <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> ## References <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? For example: * Fixes #12345 * Related to #67890 --> ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> ### `@metamask/keyring-controller` - **FIXED**: Removed `keyringTypes` from updated properties from `EthKeyringController` stores ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
…#1710) ## Explanation The property `keyringTypes` has been removed from `KeyringController`'s store, but as `EthKeyringController` still has this property in its `memStore`, and as in the `KeyringController.#fullUpdate` we destructure the entire object, we also carry over `keyringTypes` - a property we don't have metadata for. This PR changes the `#fullUpdate` internal method to only take these properties from `EthKeyringController` stores: - `vault` - `keyrings` - `isUnlocked` - `encryptionKey` - `encryptionSalt` <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> ## References <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? For example: * Fixes #12345 * Related to #67890 --> ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> ### `@metamask/keyring-controller` - **FIXED**: Removed `keyringTypes` from updated properties from `EthKeyringController` stores ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
The property
keyringTypeshas been removed fromKeyringController's store, but asEthKeyringControllerstill has this property in itsmemStore, and as in theKeyringController.#fullUpdatewe destructure the entire object, we also carry overkeyringTypes- a property we don't have metadata for.This PR changes the
#fullUpdateinternal method to only take these properties fromEthKeyringControllerstores:vaultkeyringsisUnlockedencryptionKeyencryptionSaltReferences
Changelog
@metamask/keyring-controllerkeyringTypesfrom updated properties fromEthKeyringControllerstoresChecklist