Skip to content

Refactor the QRKeyring to use the Keyring interface #3786

Open

Description

@gantunesr

Description

The current QRKeyring from @keystonehq/metamask-airgapped-keyring has a custom interface that is not compatible with our current implementation. This work is aimed to align the QRKeyring to use our Keyring interface.

Consider starting a new repository to fully own the QRKeyring package.

References

Activity

  1. changed the title [-]Extract QR hardware wallet logic from the `keyring-controller`[/-] [+]Refactor the `QRKeyring` to use the `Keyring` interface[/+] on Jan 16, 2024
  2. mikesposito commented on Jun 4, 2024

    @mikesposito
    Member

    The approach used in this PR to pair a QRKeyring shows how we could extract the QR scan process from the QRKeyring, and submit the scan result directly.

    Currently, the client modals are controlled by an event emitted by the QRKeyring. But since the connection between the devices is stateless, and only uses qr codes, there is no reason why we should do this.

    if we could:

    • Move the QRKeyring to an owned repo
    • Implement the Keyring<Json>'s main methods
    • Implement what currently submitCryptoHDKey and submitCryptoAccount do in a initialize method instead, so that it is compatible with our types

    Then we would probably be able to have a fully compatible QRKeyring, except for methods related to pagination, e.g.:

    • getPreviousPage
    • getNextPage

    Since we also need these in other hardware keyrings, we could take this chance to add those to our Keyring<Json> type, or perhaps to a separate PaginatedKeyring type to prefer composability over inheritance.

    The eventual remaining methods would be then accessible through KeyringController.withKeyring

    cc @Gudahtt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions