Skip to content
This repository was archived by the owner on Oct 7, 2024. It is now read-only.

Conversation

@Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Jul 18, 2023

Description

The addNewKeyring method has been updated to support non-object keyring serialized state, which had been supported already on versions prior to v11.

This allows us to remove a special-case for the simple keyring, which requires a JSON array as its serialized keyring state.

When constructing a simple keyring, the method addNewKeying now expects the second parameter (opts) to be an array of private keys rather than an object with a privateKeys property. This is how it worked prior to v11.

Changes

  • BREAKING: When constructing a simple keyring with addNewKeying, the second parameter (opts) is now expected to be an array of private keys rather than an object with a privateKeys property
    • This is how it worked prior to v11
  • Changed: Restored support for keyrings with non-object serialized state
    • This was supported prior to v11

References

None

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

@Gudahtt

This comment was marked as resolved.

@Gudahtt Gudahtt force-pushed the fix-qr-keyring-compatibility branch from 9ebdc0f to 836b5a4 Compare July 18, 2023 12:09
Base automatically changed from fix-qr-keyring-compatibility to main July 18, 2023 12:20
The `addNewKeyring` method has been updated to support non-object
keyring serialized state, which had been supported already on versions
prior to v11.

This allows us to remove a special-case for the simple keyring, which
requires a JSON array as its serialized keyring state.

When constructing a simple keyring, the method `addNewKeying` now
expects the second parameter (`opts`) to be an array of private keys
rather than an object with a `privateKeys` property. This is how it
worked prior to v11.
@Gudahtt Gudahtt force-pushed the simplify-add-keyring-method branch from cf828cd to a1f4ca1 Compare July 18, 2023 12:21
@Gudahtt Gudahtt marked this pull request as ready for review July 18, 2023 12:21
@Gudahtt Gudahtt requested a review from a team as a code owner July 18, 2023 12:21
Copy link
Member

@mikesposito mikesposito left a comment

Choose a reason for hiding this comment

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

LGTM!

@Gudahtt Gudahtt merged commit 8699ccd into main Jul 18, 2023
@Gudahtt Gudahtt deleted the simplify-add-keyring-method branch July 18, 2023 12:54
@legobeat legobeat mentioned this pull request Jul 18, 2023
mikesposito added a commit that referenced this pull request Jul 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants