feat: add support for injecting crypto functions for Bip32Account

our libsodium-based key derivation performs poorly when running in mobile

BREAKING CHANGE: add a new 'dependencies' parameter in Bip32Account ctor

Author: mkazlauskas

packages/crypto/src/Bip32/Bip32PublicKey.ts

@@ -1,6 +1,11 @@
 import * as Bip32KeyDerivation from './Bip32KeyDerivation';
-import { BIP32_PUBLIC_KEY_HASH_LENGTH, Bip32PublicKeyHashHex, Bip32PublicKeyHex } from '../hexTypes';
-import { ED25519_PUBLIC_KEY_LENGTH, Ed25519PublicKey } from '../Ed25519e';
+import {
+  BIP32_PUBLIC_KEY_HASH_LENGTH,
+  Bip32PublicKeyHashHex,
+  Bip32PublicKeyHex,
+  ED25519_PUBLIC_KEY_LENGTH
+} from '../hexTypes';
+import { Ed25519PublicKey } from '../Ed25519e';
 import { InvalidArgumentError } from '@cardano-sdk/util';
 import sodium from 'libsodium-wrappers-sumo';
 

packages/crypto/src/Ed25519e/Ed25519PublicKey.ts

@@ -1,11 +1,9 @@
 import { ED25519_PUBLIC_KEY_HASH_LENGTH, Ed25519KeyHash } from './Ed25519KeyHash';
-import { Ed25519PublicKeyHex } from '../hexTypes';
+import { ED25519_PUBLIC_KEY_LENGTH, Ed25519PublicKeyHex } from '../hexTypes';
 import { Ed25519Signature } from './Ed25519Signature';
 import { HexBlob, InvalidArgumentError } from '@cardano-sdk/util';
 import sodium from 'libsodium-wrappers-sumo';
 
-export const ED25519_PUBLIC_KEY_LENGTH = 32;
-
 /**
  * Ed25519 raw public key. This key can be used for cryptographically verifying messages
  * previously signed with the matching Ed25519 raw private key.

packages/crypto/src/hexTypes.ts

@@ -1,6 +1,7 @@
 import { HexBlob, OpaqueString, castHexBlob, typedHex } from '@cardano-sdk/util';
 
 export const BIP32_PUBLIC_KEY_HASH_LENGTH = 28;
+export const ED25519_PUBLIC_KEY_LENGTH = 32;
 
 /** 28 byte hash as hex string */
 export type Hash28ByteBase16 = OpaqueString<'Hash28ByteBase16'> & HexBlob;
@@ -33,7 +34,10 @@ export const Bip32PrivateKeyHex = (key: string): Bip32PrivateKeyHex => typedHex(
 
 /** Ed25519 public key as hex string */
 export type Ed25519PublicKeyHex = OpaqueString<'Ed25519PublicKeyHex'> & HexBlob;
-export const Ed25519PublicKeyHex = (value: string): Ed25519PublicKeyHex => typedHex(value, 64);
+export const Ed25519PublicKeyHex = (value: string): Ed25519PublicKeyHex =>
+  typedHex(value, ED25519_PUBLIC_KEY_LENGTH * HexBlob.CHARS_PER_BYTE);
+Ed25519PublicKeyHex.fromBip32PublicKey = (bip32PublicKey: Bip32PublicKeyHex): Ed25519PublicKeyHex =>
+  bip32PublicKey.slice(0, ED25519_PUBLIC_KEY_LENGTH * HexBlob.CHARS_PER_BYTE) as Ed25519PublicKeyHex;
 
 /** Ed25519 private extended key as hex string */
 export type Ed25519PrivateExtendedKeyHex = OpaqueString<'Ed25519PrivateKeyHex'> & HexBlob;
@@ -50,4 +54,4 @@ export const Ed25519KeyHashHex = (value: string): Ed25519KeyHashHex => typedHex(
 /** 28 byte BIP32 public key hash as hex string */
 export type Bip32PublicKeyHashHex = OpaqueString<'Bip32PublicKeyHashHex'> & HexBlob;
 export const Bip32PublicKeyHashHex = (value: string): Bip32PublicKeyHashHex =>
-  typedHex(value, BIP32_PUBLIC_KEY_HASH_LENGTH * 2);
+  typedHex(value, BIP32_PUBLIC_KEY_HASH_LENGTH * HexBlob.CHARS_PER_BYTE);

packages/e2e/src/factories.ts

@@ -62,6 +62,7 @@ import { Logger } from 'ts-log';
 import { NoCache, NodeTxSubmitProvider } from '@cardano-sdk/cardano-services';
 import { OgmiosObservableCardanoNode } from '@cardano-sdk/ogmios';
 import { TrezorKeyAgent } from '@cardano-sdk/hardware-trezor';
+import { blake2b } from '@cardano-sdk/crypto';
 import { createStubHandleProvider, createStubStakePoolProvider } from '@cardano-sdk/util-dev';
 import { filter, firstValueFrom, of } from 'rxjs';
 import { getEnv, walletVariables } from './environment';
@@ -619,7 +620,7 @@ export const getWallet = async (props: GetWalletProps) => {
       bip32Ed25519,
       logger
     }));
-  const bip32Account = await Bip32Account.fromAsyncKeyAgent(asyncKeyAgent);
+  const bip32Account = await Bip32Account.fromAsyncKeyAgent(asyncKeyAgent, { bip32Ed25519, blake2b });
   if (!polling?.interval && env.NETWORK_SPEED === 'fast') {
     polling = { ...polling, interval: 50 };
   }

packages/e2e/test/load-test-custom/wallet-init/wallet-init.test.ts

@@ -10,7 +10,7 @@ import { Logger } from 'ts-log';
 import { bufferCount, bufferTime, from, mergeAll, tap } from 'rxjs';
 import { logger } from '@cardano-sdk/util-dev';
 
-import { Bip32Account, util } from '@cardano-sdk/key-management';
+import { Bip32Account, KeyAgentDependencies, util } from '@cardano-sdk/key-management';
 import {
   MeasurementUtil,
   assetProviderFactory,
@@ -29,6 +29,7 @@ import {
   waitForWalletStateSettle,
   walletVariables
 } from '../../../src';
+import { blake2b } from '@cardano-sdk/crypto';
 
 // Example call that creates 5000 wallets in 10 minutes:
 // VIRTUAL_USERS_GENERATE_DURATION=600 VIRTUAL_USERS_COUNT=5000 yarn load-test-custom:wallet-init
@@ -94,37 +95,39 @@ const getProviders = async () => ({
   )
 });
 
-const getKeyAgent = async (accountIndex: number) => {
+const getKeyAgent = async (accountIndex: number, dependencies: KeyAgentDependencies) => {
   const createKeyAgent = await keyManagementFactory.create(
     env.KEY_MANAGEMENT_PROVIDER,
     { ...env.KEY_MANAGEMENT_PARAMS, accountIndex },
     logger
   );
-  const bip32Ed25519 = await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger);
-  const keyAgent = await createKeyAgent({ bip32Ed25519, logger });
+
+  const keyAgent = await createKeyAgent(dependencies);
   return { keyAgent };
 };
 
-const createWallet = async (accountIndex: number): Promise<BaseWallet> => {
+const createWallet = async (accountIndex: number, dependencies: KeyAgentDependencies): Promise<BaseWallet> => {
   measurementUtil.addStartMarker(MeasureTarget.keyAgent, accountIndex);
   const providers = await getProviders();
-  const { keyAgent } = await getKeyAgent(accountIndex);
+  const { keyAgent } = await getKeyAgent(accountIndex, dependencies);
   measurementUtil.addMeasureMarker(MeasureTarget.keyAgent, accountIndex);
 
   measurementUtil.addStartMarker(MeasureTarget.wallet, accountIndex);
   return createPersonalWallet(
     { name: `Wallet ${accountIndex}` },
     {
       ...providers,
-      bip32Account: await Bip32Account.fromAsyncKeyAgent(keyAgent),
+      bip32Account: await Bip32Account.fromAsyncKeyAgent(keyAgent, { ...dependencies, blake2b }),
       logger,
       witnesser: util.createBip32Ed25519Witnesser(keyAgent)
     }
   );
 };
 
 const initWallet = async (idx: number) => {
-  const wallet = await createWallet(idx);
+  const bip32Ed25519 = await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger);
+  const dependencies = { bip32Ed25519, logger };
+  const wallet = await createWallet(idx, dependencies);
   await waitForWalletStateSettle(wallet);
   measurementUtil.addMeasureMarker(MeasureTarget.wallet, idx);
   return wallet;

packages/e2e/test/local-network/register-pool.test.ts

@@ -87,7 +87,7 @@ describe('local-network/register-pool', () => {
       role: KeyRole.External
     });
 
-    const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey.hex());
+    const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
       await wallet1.bip32Account.deriveAddress(
@@ -174,7 +174,7 @@ describe('local-network/register-pool', () => {
       role: KeyRole.External
     });
 
-    const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey.hex());
+    const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
       await wallet2.bip32Account.deriveAddress(

packages/e2e/test/long-running/cache-invalidation.test.ts

@@ -112,7 +112,7 @@ describe('cache invalidation', () => {
       role: KeyRole.External
     });
 
-    const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey.hex());
+    const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
       await wallet1.bip32Account.deriveAddress(

packages/e2e/test/wallet_epoch_0/PersonalWallet/cip30WalletApi.test.ts

@@ -69,7 +69,7 @@ describe('PersonalWallet/cip30WalletApi', () => {
 
   it('can signData with bech32 base address', async () => {
     const [{ address, index }] = await firstValueFrom(wallet.addresses$);
-    const paymentKeyHex = (await bip32Account.derivePublicKey({ index, role: KeyRole.External })).hex();
+    const paymentKeyHex = bip32Account.derivePublicKey({ index, role: KeyRole.External });
 
     const signature = await walletApi.signData({ sender: '' } as unknown as SenderContext, address, HexBlob('abc123'));
 
@@ -79,7 +79,7 @@ describe('PersonalWallet/cip30WalletApi', () => {
   it('can signData with hex-encoded base address', async () => {
     const [{ address, index }] = await firstValueFrom(wallet.addresses$);
     const addressHex = Cardano.Address.fromBech32(address).toBytes();
-    const paymentKeyHex = (await bip32Account.derivePublicKey({ index, role: KeyRole.External })).hex();
+    const paymentKeyHex = bip32Account.derivePublicKey({ index, role: KeyRole.External });
 
     const signature = await walletApi.signData(
       { sender: '' } as unknown as SenderContext,
@@ -92,7 +92,7 @@ describe('PersonalWallet/cip30WalletApi', () => {
 
   it('can signData with bech32 base address', async () => {
     const [{ rewardAccount, index }] = await firstValueFrom(wallet.addresses$);
-    const stakeKeyHex = (await bip32Account.derivePublicKey({ index, role: KeyRole.Stake })).hex();
+    const stakeKeyHex = bip32Account.derivePublicKey({ index, role: KeyRole.Stake });
 
     const signature = await walletApi.signData(
       { sender: '' } as unknown as SenderContext,
@@ -106,7 +106,7 @@ describe('PersonalWallet/cip30WalletApi', () => {
   it('can signData with hex-encoded reward account', async () => {
     const [{ rewardAccount, index }] = await firstValueFrom(wallet.addresses$);
     const rewardAccountHex = Cardano.Address.fromBech32(rewardAccount).toBytes();
-    const stakeKeyHex = (await bip32Account.derivePublicKey({ index, role: KeyRole.Stake })).hex();
+    const stakeKeyHex = bip32Account.derivePublicKey({ index, role: KeyRole.Stake });
 
     const signature = await walletApi.signData(
       { sender: '' } as unknown as SenderContext,

packages/key-management/src/Bip32Account.ts

@@ -6,31 +6,53 @@ import {
   GroupedAddress,
   KeyRole
 } from './types';
+import {
+  BIP32_PUBLIC_KEY_HASH_LENGTH,
+  Bip32Ed25519,
+  Blake2b,
+  Ed25519PublicKeyHex,
+  SodiumBip32Ed25519,
+  blake2b
+} from '@cardano-sdk/crypto';
 import { Cardano } from '@cardano-sdk/core';
-import { Hash28ByteBase16 } from '@cardano-sdk/crypto';
 
 type Bip32AccountProps = {
   extendedAccountPublicKey: Crypto.Bip32PublicKeyHex;
   accountIndex: number;
   chainId: Cardano.ChainId;
 };
 
+type Bip32AccountDependencies = {
+  bip32Ed25519: Pick<Bip32Ed25519, 'derivePublicKey'>;
+  blake2b: Blake2b;
+};
+
 /** Derives public keys and addresses from a BIP32-ED25519 public key */
 export class Bip32Account {
-  readonly extendedAccountPublicKey: Crypto.Bip32PublicKey;
+  readonly extendedAccountPublicKeyHex: Crypto.Bip32PublicKeyHex;
   readonly chainId: Cardano.ChainId;
   readonly accountIndex: number;
+  readonly #bip32Ed25519: Bip32AccountDependencies['bip32Ed25519'];
+  readonly #blake2b: Blake2b;
 
   /** Initializes a new instance of the Bip32Ed25519AddressManager class. */
-  constructor({ extendedAccountPublicKey, chainId, accountIndex }: Bip32AccountProps) {
-    this.extendedAccountPublicKey = Crypto.Bip32PublicKey.fromHex(extendedAccountPublicKey);
+  constructor(
+    { extendedAccountPublicKey, chainId, accountIndex }: Bip32AccountProps,
+    dependencies: Bip32AccountDependencies
+  ) {
+    this.extendedAccountPublicKeyHex = extendedAccountPublicKey;
+    this.#bip32Ed25519 = dependencies.bip32Ed25519;
+    this.#blake2b = dependencies.blake2b;
     this.chainId = chainId;
     this.accountIndex = accountIndex;
   }
 
   async derivePublicKey(derivationPath: AccountKeyDerivationPath) {
-    const key = await this.extendedAccountPublicKey.derive([derivationPath.role, derivationPath.index]);
-    return key.toRawKey();
+    const extendedKey = this.#bip32Ed25519.derivePublicKey(this.extendedAccountPublicKeyHex, [
+      derivationPath.role,
+      derivationPath.index
+    ]);
+    return Ed25519PublicKeyHex.fromBip32PublicKey(extendedKey);
   }
 
   async deriveAddress(
@@ -47,16 +69,16 @@ export class Bip32Account {
       role: Number(paymentKeyDerivationPath.type)
     });
 
-    const derivedPublicPaymentKeyHash = await derivedPublicPaymentKey.hash();
+    const derivedPublicPaymentKeyHash = this.#blake2b.hash(derivedPublicPaymentKey, BIP32_PUBLIC_KEY_HASH_LENGTH);
 
     const publicStakeKey = await this.derivePublicKey(stakeKeyDerivationPath);
-    const publicStakeKeyHash = await publicStakeKey.hash();
+    const publicStakeKeyHash = this.#blake2b.hash(publicStakeKey, BIP32_PUBLIC_KEY_HASH_LENGTH);
 
-    const stakeCredential = { hash: Hash28ByteBase16(publicStakeKeyHash.hex()), type: Cardano.CredentialType.KeyHash };
+    const stakeCredential = { hash: publicStakeKeyHash, type: Cardano.CredentialType.KeyHash };
 
     const address = Cardano.BaseAddress.fromCredentials(
       this.chainId.networkId,
-      { hash: Hash28ByteBase16(derivedPublicPaymentKeyHash.hex()), type: Cardano.CredentialType.KeyHash },
+      { hash: derivedPublicPaymentKeyHash, type: Cardano.CredentialType.KeyHash },
       stakeCredential
     ).toAddress();
 
@@ -72,16 +94,30 @@ export class Bip32Account {
     };
   }
 
+  static async createDefaultDependencies(): Promise<Bip32AccountDependencies> {
+    return {
+      bip32Ed25519: await SodiumBip32Ed25519.create(),
+      blake2b
+    };
+  }
+
   /**
    * Creates a new instance of the Bip32Ed25519AddressManager class.
    *
    * @param keyAgent The key agent that will be used to derive addresses.
    */
-  static async fromAsyncKeyAgent(keyAgent: AsyncKeyAgent): Promise<Bip32Account> {
-    return new Bip32Account({
-      accountIndex: await keyAgent.getAccountIndex(),
-      chainId: await keyAgent.getChainId(),
-      extendedAccountPublicKey: await keyAgent.getExtendedAccountPublicKey()
-    });
+  static async fromAsyncKeyAgent(
+    keyAgent: AsyncKeyAgent,
+    dependencies?: Bip32AccountDependencies
+  ): Promise<Bip32Account> {
+    dependencies ||= await Bip32Account.createDefaultDependencies();
+    return new Bip32Account(
+      {
+        accountIndex: await keyAgent.getAccountIndex(),
+        chainId: await keyAgent.getChainId(),
+        extendedAccountPublicKey: await keyAgent.getExtendedAccountPublicKey()
+      },
+      dependencies
+    );
   }
 }

packages/key-management/src/KeyAgentBase.ts

@@ -16,6 +16,7 @@ import { Cardano, Serialization } from '@cardano-sdk/core';
 import { Cip30DataSignature } from '@cardano-sdk/dapp-connector';
 import { Cip8SignDataContext } from './cip8';
 import { HexBlob } from '@cardano-sdk/util';
+import { blake2b } from '@cardano-sdk/crypto';
 
 export abstract class KeyAgentBase implements KeyAgent {
   readonly #serializableData: SerializableKeyAgentData;
@@ -54,7 +55,7 @@ export abstract class KeyAgentBase implements KeyAgent {
   constructor(serializableData: SerializableKeyAgentData, { bip32Ed25519 }: KeyAgentDependencies) {
     this.#serializableData = serializableData;
     this.#bip32Ed25519 = bip32Ed25519;
-    this.#account = new Bip32Account(serializableData);
+    this.#account = new Bip32Account(serializableData, { bip32Ed25519, blake2b });
   }
 
   /** See https://github.com/cardano-foundation/CIPs/tree/master/CIP-1852#specification */
@@ -66,6 +67,6 @@ export abstract class KeyAgentBase implements KeyAgent {
   }
 
   async derivePublicKey(derivationPath: AccountKeyDerivationPath): Promise<Crypto.Ed25519PublicKeyHex> {
-    return (await this.#account.derivePublicKey(derivationPath)).hex();
+    return this.#account.derivePublicKey(derivationPath);
   }
 }