fixup! feat!: remove async from crypto API

Author: AngelCastilloB

packages/crypto/src/Bip32/Bip32PrivateKey.ts

@@ -71,6 +71,8 @@ export class Bip32PrivateKey {
    *   - 32 bytes: Ed25519 curve scalar from which few bits have been tweaked according to ED25519-BIP32
    *   - 32 bytes: Ed25519 binary blob used as IV for signing
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @param entropy Random stream of bytes generated from a BIP39 seed phrase.
    * @param password The second factor authentication password for the mnemonic phrase.
    * @returns The secret extended key.
@@ -123,6 +125,8 @@ export class Bip32PrivateKey {
    * This is why deriving the private key should not fail while deriving
    * the public key may fail (if the derivation index is invalid).
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @param derivationIndices The derivation indices.
    * @returns The child BIP-32 key.
    */
@@ -144,6 +148,8 @@ export class Bip32PrivateKey {
   /**
    * Computes the BIP-32 public key from this BIP-32 private key.
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @returns the public key.
    */
   toPublic(): Bip32PublicKey {

packages/crypto/src/Bip32/Bip32PublicKey.ts

@@ -53,6 +53,8 @@ export class Bip32PublicKey {
   /**
    * Given a set of indices, this function computes the corresponding child extended key.
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @param derivationIndices The list of derivation indices.
    * @returns The child extended private key.
    */
@@ -76,7 +78,7 @@ export class Bip32PublicKey {
     return Bip32PublicKeyHex(Buffer.from(this.#key).toString('hex'));
   }
 
-  /** Gets the blake2 hash of the key. */
+  /** Gets the blake2 hash of the key. NOTE: You must call `Crypto.ready()` at least once before calling this function. */
   hash(): Bip32PublicKeyHashHex {
     const hash = sodium.crypto_generichash(BIP32_PUBLIC_KEY_HASH_LENGTH, this.#key);
     return Bip32PublicKeyHashHex(Buffer.from(hash).toString('hex'));

packages/crypto/src/Ed25519e/Ed25519PrivateKey.ts

@@ -78,6 +78,8 @@ export class Ed25519PrivateKey {
   /**
    * Computes the raw public key from this raw private key.
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @returns the public key.
    */
   toPublic(): Ed25519PublicKey {
@@ -91,6 +93,8 @@ export class Ed25519PrivateKey {
   /**
    * Generates an Ed25519 signature.
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @param message The message to be signed.
    * @returns The Ed25519 digital signature.
    */

packages/crypto/src/Ed25519e/Ed25519PublicKey.ts

@@ -26,6 +26,8 @@ export class Ed25519PublicKey {
    * Verifies that the passed-in signature was generated with a private key that matches
    * the given public key.
    *
+   * NOTE: You must call `Crypto.ready()` at least once before calling this function.
+   *
    * @param signature The signature bytes to be verified.
    * @param message The original message the signature was computed from.
    * @returns true if the signature is valid; otherwise; false.
@@ -57,7 +59,7 @@ export class Ed25519PublicKey {
     return Ed25519PublicKey.fromBytes(Buffer.from(keyMaterial, 'hex'));
   }
 
-  /** Gets the blake2 hash of the key material. */
+  /** Gets the blake2 hash of the key material. NOTE: You must call `Crypto.ready()` at least once before calling this function. */
   hash(): Ed25519KeyHash {
     const hash = sodium.crypto_generichash(ED25519_PUBLIC_KEY_HASH_LENGTH, this.#keyMaterial);
     return Ed25519KeyHash.fromBytes(hash);

packages/crypto/src/index.ts

@@ -9,4 +9,5 @@ export * from './strategies';
 export * from './hexTypes';
 export * from './types';
 
+/** This function must be called before any other function in this module. it is safe to call this function multiple times. */
 export const ready = async (): Promise<void> => await sodium.ready;