Skip to content

chore(keyring-controller): deprecate QR Keyring methods - #4365

Merged
mikesposito merged 9 commits into
mainfrom
chore/deprecate-qr-methods
Jun 11, 2024
Merged

mikesposito merged 9 commits into
mainfrom
chore/deprecate-qr-methods

Conversation

@mikesposito

Copy link
Copy Markdown
Member

Explanation

With the introduction of withKeyring, KeyringController provides a solid alternative to QR-specific methods. This is a good chance to start moving away from them.

This PR deprecates all QR-specific methods, to discourage further usage in clients and promotes withKeyring.

References

Related to #3786

Changelog

@metamask/keyring-controller

  • DEPRECATED: Deprecated QRKeyring-specific methods from KeyringController

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

@mikesposito
mikesposito requested review from a team, Gudahtt and gantunesr June 4, 2024 12:26
mcmire
mcmire previously approved these changes Jun 4, 2024

@mcmire mcmire left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, great news!

@ccharly ccharly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: Mostly cosmetic suggestions to match with other comments (feel free to ignore them!) 😃

Comment thread packages/keyring-controller/src/KeyringController.ts Outdated
Comment thread packages/keyring-controller/src/KeyringController.ts Outdated
@ccharly

ccharly commented Jun 5, 2024

Copy link
Copy Markdown
Contributor

Nitpick (again 🙈): The title could probably be named differently to match conv commits, something like deprecate(keyring-controller): deprecates QR keyring specific methods, or maybe use of chore instead of deprecate, WDYT?

mikesposito and others added 2 commits June 10, 2024 15:18
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
@mikesposito mikesposito changed the title [keyring-controller] Deprecate QRKeyring-specific methods chore(keyring-controller): deprecate QR Keyring methods Jun 10, 2024
@mikesposito
mikesposito requested a review from ccharly June 10, 2024 14:02
@mikesposito
mikesposito merged commit 3087bec into main Jun 11, 2024
@mikesposito
mikesposito deleted the chore/deprecate-qr-methods branch June 11, 2024 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants