feat: remove async from crypto API #1558
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mkazlauskas
requested changes
Jan 14, 2025
mkazlauskas
reviewed
Jan 14, 2025
mkazlauskas
reviewed
Jan 14, 2025
mirceahasegan
previously approved these changes
Jan 14, 2025
AngelCastilloB
force-pushed
the
feat/lw-12104-remove-async-from-crypto-interfaces
branch
from
f122c41 to
dfc1811
Compare
AngelCastilloB
dismissed stale reviews from mkazlauskas and mirceahasegan
via
0d664a6
mkazlauskas
previously approved these changes
Jan 15, 2025
mkazlauskas
approved these changes
Jan 15, 2025
BREAKING CHANGE: The package now exports an async `ready` function that must be called before any of crypto related functions can be called - Bip32PrivateKe async functions are all now sync - Bip32PublicKey class async functions are all now sync - Ed25519PrivateKey class async functions are all now sync - Ed25519PublicKey class async functions are all now sync - Bip32Ed25519 interface async functions are all now sync - SodiumBip32Ed25519 cosntructor is now private - SodiumBip32Ed25519 now has a new async factory method create
AngelCastilloB
force-pushed
the
feat/lw-12104-remove-async-from-crypto-interfaces
branch
from
1719108 to
91b7fa2
Compare
mirceahasegan
approved these changes
Jan 15, 2025
AngelCastilloB
deleted the
feat/lw-12104-remove-async-from-crypto-interfaces
branch
mkazlauskas
added a commit
that referenced
this pull request
Jan 21, 2025
Bip32Ed25519 was refactored to synchronous methods by hoisting sodium await to top level in #1558, which makes it difficult to use SigningCoordinator without top level await
mkazlauskas
added a commit
that referenced
this pull request
Jan 21, 2025
Bip32Ed25519 was refactored to synchronous methods by hoisting sodium await to top level in #1558, which makes it difficult to use SigningCoordinator without top level await
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
The crypto interface currently is async because it uses libsodium underneath which requires an async call to sodium.ready. We can remove the async from the interface and hoist it to the strategy constructor or a global method async Crypto.ready, that can be called by the client code at their convenience.
Resolves #1529