feat!: create new vault with any keyring

[gantunesr]

Description

This change updates the logic inside the eth-keyring-controller to allow the creation of a vault with any keyring. This removes the hardcoded HD Keyring from the code and allow the client to pass the parameters to instantiate any keyring that is accepted by the controller.

Changes

• BREAKING: Unify createNewVaultAndKeychain and createNewVaultAndRestore into new method createNewVaultWithKeyring. createNewVaultWithKeyring accepts a password and a keyring object provided by the client and returns the KeyringControllerState

References

No references

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation for new or updated code as appropriate (note: this will usually be JSDoc)
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[owencraston]

is there now better way we can type the options here? I see in the tests we are using KeyringType?

[owencraston]

should we default to HD if one is not passed in?

[gantunesr]

is there now better way we can type the options here? I see in the tests we are using KeyringType?

No, some keyrings are passed from the outside (QRKeyring, LedgerLeyring, SnapKeyring, etc) and there isn't a way to know what they would be unless we enforce it and I'm not sure if that's the right decision since other projects can be using this package with keyrings that are unknown to us, for the moment having them as string and unknown and letting the keyring itself handle it is the best choice.

should we default to HD if one is not passed in?

I don't see the benefit of it at least inside this package, the clients should handle it

[legobeat]

@gantunesr Do you think we can get in #314 and release #304 prior to merging this? Seems desirable to sync the branches and get the fixes out separately from this breaking feature?

[mikesposito]

Looks good!

Question: will this be done in @metamask/keyring-controller too?

[gantunesr]

@mikesposito Yes! I'll have this done in @metamask/keyring-controller too