refactor!: addNewKeyring returns metadata instead of keyring

[mikesposito]

Explanation

This PR changes the return type of addNewKeyring to return a promise resolving in KeyringMetadata instead of the keyring instance. The reason is that accessing keyring instances outside of KeyringController safeguards is considered unsafe.

The withKeyring method signature has also been changed: the operation callback now will be called with {keyring: SelectedKeyring; metadata: KeyringMetadata } instead of SelectedKeyring

References

• Fixes KeyringController addNewKeyring should not return the keyring instance #5371

Changelog

@metamask/keyring-controller

• BREAKING: addNewKeyring method now returns Promise<KeyringMetadata> instead of Promise<unknown> (#5372)
  • Consumers can use the returned KeyringMetadata.id to access the created keyring instance via withKeyring.
• BREAKING: withKeyring method now requires a callback argument of type ({ keyring: SelectedKeyring; metadata: KeyringMetadata }) => Promise<CallbackResult> (#5372)

@metamask/profile-sync-controller

• No consumer-facing changes

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

[mathieuartu]

Owned files LGTM, thanks!

[mikesposito]

I'm keeping this method as internal because consumers are not supposed to carry keyring instances around