Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core.Keyring's API could be better #468

Open
mrnerdhair opened this issue Mar 14, 2022 · 0 comments
Open

core.Keyring's API could be better #468

mrnerdhair opened this issue Mar 14, 2022 · 0 comments
Labels
tech-debt A suboptimality that existed in code when it was written.
Milestone

Comments

@mrnerdhair
Copy link
Contributor

core.Keyring's API has some room for improvement:

  • The API doesn't align with the interface a developers might expect for a standard collection
  • The API contains some unused functionality (like .exec())
  • The event emitting functionality isn't well-encapsulated or documented
    • Some wallet implementations mutate the keyring and then emit events like connect/disconnect; some don't
    • From a type perspective, the keyring should in principle be able to tell you what types of events it will emit or its API isn't well-defined

AC:

  • core.Keyring's API should mirror the standard Set interface
  • core.Keyring should emit its own connect/disconnect events, consistently, when adding/removing a wallet

Fixed by #436.

@mrnerdhair mrnerdhair added the tech-debt A suboptimality that existed in code when it was written. label Mar 14, 2022
@mrnerdhair mrnerdhair linked a pull request Mar 17, 2022 that will close this issue
@mrnerdhair mrnerdhair added this to the hdwallet++ milestone Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-debt A suboptimality that existed in code when it was written.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant