chore: fix lint warnings in KeyringController
#5170
Merged
Conversation
This file contains 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
4 tasks
mcmire
reviewed
Jan 17, 2025
Gudahtt
reviewed
Jan 29, 2025
Gudahtt
reviewed
Jan 29, 2025
@mcmire I updated the file, but now |
|
@mikesposito Hmm. I am able to replicate the error that CI shows. Maybe your ESLint cache is out of date? Try running: |
mcmire
reviewed
Jan 30, 2025
Co-authored-by: Elliot Winkler <[email protected]>
ccharly
approved these changes
Feb 3, 2025
| @@ -2201,9 +2194,6 @@ export class KeyringController extends BaseController< | |||
| // NOTE: Not all keyrings implement this method in a asynchronous-way. Using `await` for | |||
| // non-thenable will still be valid (despite not being really useful). It allows us to cover both | |||
| // cases and allow retro-compatibility too. | |||
| // FIXME: For some reason, it seems that eslint is complaining about this call being non-thenable | |||
| // even though it is... For now, we just disable it: | |||
| // eslint-disable-next-line @typescript-eslint/await-thenable | |||
There was a problem hiding this comment.
Ah, thanks for fixing/removing this one 😄 This drove me crazy last time! Might have been a false-positive and the eslint update fixed it!
mikesposito
added a commit
that referenced
this pull request
Feb 11, 2025
Blocked by: - #5170 ## Explanation <!-- 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? --> No specific error is thrown when an operation that requires an unlocked vault is attempted while `KeyringController.state.isUnlocked` is false. This doesn't make the operations possible, but it doesn't give a clear error message either. This PR adds an assertion on almost all `KeyringController` methods to check if the controller is unlocked and to throw an error when it isn't. ## 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? Are there client or consumer pull requests to adopt any breaking changes? For example: * Fixes #12345 * Related to #67890 --> * Fixes #5171 ## 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` - **CHANGED**: A specific error message is thrown when any operation is attempted while the controller is locked ## 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 - [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes
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
Lint warnings in the
KeyringControllerpackage have been fixedReferences
N/A
Changelog
No consumer-facing changes
Checklist