refactor!: make Bip32Account methods synchronous

implementation of those methods no longer requires them to be async

Author: mkazlauskas

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

@@ -82,21 +82,19 @@ describe('local-network/register-pool', () => {
 
     await unDelegateWallet(wallet);
 
-    const poolPubKey = await wallet1.bip32Account.derivePublicKey({
+    const poolPubKey = wallet1.bip32Account.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
     const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
-    const poolRewardAccount = (
-      await wallet1.bip32Account.deriveAddress(
-        {
-          index: 0,
-          type: AddressType.External
-        },
-        0
-      )
+    const poolRewardAccount = wallet1.bip32Account.deriveAddress(
+      {
+        index: 0,
+        type: AddressType.External
+      },
+      0
     ).rewardAccount;
 
     const registrationCert: Cardano.PoolRegistrationCertificate = {
@@ -169,21 +167,19 @@ describe('local-network/register-pool', () => {
     await walletReady(wallet);
     await unDelegateWallet(wallet);
 
-    const poolPubKey = await wallet2.bip32Account.derivePublicKey({
+    const poolPubKey = wallet2.bip32Account.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
     const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
-    const poolRewardAccount = (
-      await wallet2.bip32Account.deriveAddress(
-        {
-          index: 0,
-          type: AddressType.External
-        },
-        0
-      )
+    const poolRewardAccount = wallet2.bip32Account.deriveAddress(
+      {
+        index: 0,
+        type: AddressType.External
+      },
+      0
     ).rewardAccount;
 
     const registrationCert: Cardano.PoolRegistrationCertificate = {

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

@@ -107,21 +107,19 @@ describe('cache invalidation', () => {
 
     await walletReady(wallet);
 
-    const poolPubKey = await wallet1.bip32Account.derivePublicKey({
+    const poolPubKey = wallet1.bip32Account.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
     const poolKeyHash = bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
-    const poolRewardAccount = (
-      await wallet1.bip32Account.deriveAddress(
-        {
-          index: 0,
-          type: AddressType.External
-        },
-        0
-      )
+    const poolRewardAccount = wallet1.bip32Account.deriveAddress(
+      {
+        index: 0,
+        type: AddressType.External
+      },
+      0
     ).rewardAccount;
 
     const registrationCert: Cardano.PoolRegistrationCertificate = {

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 = bip32Account.derivePublicKey({ index, role: KeyRole.External });
+    const paymentKeyHex = await 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 = bip32Account.derivePublicKey({ index, role: KeyRole.External });
+    const paymentKeyHex = await 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 = bip32Account.derivePublicKey({ index, role: KeyRole.Stake });
+    const stakeKeyHex = await 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 = bip32Account.derivePublicKey({ index, role: KeyRole.Stake });
+    const stakeKeyHex = await bip32Account.derivePublicKey({ index, role: KeyRole.Stake });
 
     const signature = await walletApi.signData(
       { sender: '' } as unknown as SenderContext,

packages/key-management/src/Bip32Account.ts

@@ -47,31 +47,31 @@ export class Bip32Account {
     this.accountIndex = accountIndex;
   }
 
-  async derivePublicKey(derivationPath: AccountKeyDerivationPath) {
+  derivePublicKey(derivationPath: AccountKeyDerivationPath) {
     const extendedKey = this.#bip32Ed25519.derivePublicKey(this.extendedAccountPublicKeyHex, [
       derivationPath.role,
       derivationPath.index
     ]);
     return Ed25519PublicKeyHex.fromBip32PublicKey(extendedKey);
   }
 
-  async deriveAddress(
+  deriveAddress(
     paymentKeyDerivationPath: AccountAddressDerivationPath,
     stakeKeyDerivationIndex: number
-  ): Promise<GroupedAddress> {
+  ): GroupedAddress {
     const stakeKeyDerivationPath = {
       index: stakeKeyDerivationIndex,
       role: KeyRole.Stake
     };
 
-    const derivedPublicPaymentKey = await this.derivePublicKey({
+    const derivedPublicPaymentKey = this.derivePublicKey({
       index: paymentKeyDerivationPath.index,
       role: Number(paymentKeyDerivationPath.type)
     });
 
     const derivedPublicPaymentKeyHash = this.#blake2b.hash(derivedPublicPaymentKey, BIP32_PUBLIC_KEY_HASH_LENGTH);
 
-    const publicStakeKey = await this.derivePublicKey(stakeKeyDerivationPath);
+    const publicStakeKey = this.derivePublicKey(stakeKeyDerivationPath);
     const publicStakeKeyHash = this.#blake2b.hash(publicStakeKey, BIP32_PUBLIC_KEY_HASH_LENGTH);
 
     const stakeCredential = { hash: publicStakeKeyHash, type: Cardano.CredentialType.KeyHash };

packages/key-management/test/Bip32Account.test.ts

@@ -83,7 +83,7 @@ describe('Bip32Account', () => {
         [4, '4444444444444444444444444444444444444444444444444444444444444444']
       ]);
 
-      testnetAccount.derivePublicKey = jest.fn(async (x: AccountKeyDerivationPath) =>
+      testnetAccount.derivePublicKey = jest.fn((x: AccountKeyDerivationPath) =>
         Crypto.Ed25519PublicKeyHex(keyMap.get(x.index)!)
       );
 

packages/tx-construction/src/tx-builder/initializeTx.ts

@@ -12,9 +12,7 @@ import { hasCorrectVoteDelegation } from './hasCorrectVoteDelegation';
 
 const dRepPublicKeyHash = async (addressManager?: Bip32Account): Promise<Ed25519KeyHashHex | undefined> =>
   addressManager &&
-  Ed25519PublicKey.fromHex(await addressManager.derivePublicKey(util.DREP_KEY_DERIVATION_PATH))
-    .hash()
-    .hex();
+  Ed25519PublicKey.fromHex(addressManager.derivePublicKey(util.DREP_KEY_DERIVATION_PATH)).hash().hex();
 
 const DREP_REG_REQUIRED_PROTOCOL_VERSION = 10;
 

packages/wallet/src/services/PublicStakeKeysTracker.ts

@@ -1,7 +1,7 @@
 import { AccountKeyDerivationPath, Bip32Account, GroupedAddress } from '@cardano-sdk/key-management';
 import { Cardano } from '@cardano-sdk/core';
 import { Ed25519PublicKeyHex } from '@cardano-sdk/crypto';
-import { Observable, defaultIfEmpty, distinctUntilChanged, forkJoin, from, map, mergeMap, switchMap } from 'rxjs';
+import { Observable, distinctUntilChanged, map, switchMap } from 'rxjs';
 import { TrackerSubject } from '@cardano-sdk/util-rxjs';
 import { deepEquals } from '@cardano-sdk/util';
 
@@ -48,14 +48,11 @@ export const createPublicStakeKeysTracker = ({
   new TrackerSubject(
     rewardAccounts$.pipe(
       withStakeKeyDerivationPaths(addresses$),
-      mergeMap((derivationPathsAndStatus) =>
-        forkJoin(
-          derivationPathsAndStatus.map(({ stakeKeyDerivationPath, credentialStatus }) =>
-            from(addressManager.derivePublicKey(stakeKeyDerivationPath)).pipe(
-              map((publicStakeKey) => ({ credentialStatus, publicStakeKey }))
-            )
-          )
-        ).pipe(defaultIfEmpty([]))
+      map((derivationPathsAndStatus) =>
+        derivationPathsAndStatus.map(({ stakeKeyDerivationPath, credentialStatus }) => ({
+          credentialStatus,
+          publicStakeKey: addressManager.derivePublicKey(stakeKeyDerivationPath)
+        }))
       ),
       distinctUntilChanged(deepEquals)
     )

packages/wallet/test/PersonalWallet/methods.test.ts

@@ -105,7 +105,7 @@ describe('BaseWallet methods', () => {
 
     const asyncKeyAgent = await testAsyncKeyAgent();
     bip32Account = await Bip32Account.fromAsyncKeyAgent(asyncKeyAgent);
-    bip32Account.deriveAddress = jest.fn().mockResolvedValue(groupedAddress);
+    bip32Account.deriveAddress = jest.fn().mockReturnValue(groupedAddress);
     witnesser = util.createBip32Ed25519Witnesser(asyncKeyAgent);
     wallet = createPersonalWallet(
       { name: 'Test Wallet' },
@@ -611,8 +611,10 @@ describe('BaseWallet methods', () => {
     wallet.shutdown();
     bip32Account.derivePublicKey = jest
       .fn()
-      .mockRejectedValueOnce('error')
-      .mockResolvedValue({ hex: () => 'string' });
+      .mockImplementationOnce(() => {
+        throw new Error('error');
+      })
+      .mockReturnValue('string');
     wallet = createPersonalWallet(
       { name: 'Test Wallet' },
       {
@@ -755,7 +757,7 @@ describe('BaseWallet methods', () => {
     beforeEach(() => {
       wallet.shutdown();
 
-      bip32Account.deriveAddress = jest.fn(async (args) => {
+      bip32Account.deriveAddress = jest.fn((args) => {
         if (args.index === 0) {
           return groupedAddress;
         }

packages/wallet/test/services/PublicStakeKeysTracker.test.ts

@@ -2,7 +2,7 @@ import { AccountKeyDerivationPath, Bip32Account, GroupedAddress, KeyRole } from
 import { Cardano } from '@cardano-sdk/core';
 import { ObservableWallet } from '../../src';
 import { PubStakeKeyAndStatus, createPublicStakeKeysTracker } from '../../src/services/PublicStakeKeysTracker';
-import { firstValueFrom, from, lastValueFrom, of, shareReplay, toArray } from 'rxjs';
+import { delay, firstValueFrom, from, lastValueFrom, of, shareReplay, toArray } from 'rxjs';
 import { mockProviders as mocks } from '@cardano-sdk/util-dev';
 
 describe('PublicStakeKeysTracker', () => {
@@ -135,7 +135,7 @@ describe('PublicStakeKeysTracker', () => {
 
   it('emits when reward accounts change', async () => {
     const addresses$ = of(addresses);
-    const rewardAccounts$ = from([[rewardAccounts[0]], rewardAccounts]);
+    const rewardAccounts$ = from([[rewardAccounts[0]], rewardAccounts]).pipe(delay(1));
 
     const stakePubKeys$ = createPublicStakeKeysTracker({
       addresses$,
@@ -155,7 +155,7 @@ describe('PublicStakeKeysTracker', () => {
   });
 
   it('emits when addresses change', async () => {
-    const addresses$ = from([[addresses[0]], addresses]);
+    const addresses$ = from([[addresses[0]], addresses]).pipe(delay(1));
     const rewardAccounts$ = of(rewardAccounts);
 
     const stakePubKeys$ = createPublicStakeKeysTracker({
@@ -176,8 +176,9 @@ describe('PublicStakeKeysTracker', () => {
   });
 
   it('does not emit duplicates', async () => {
-    const rewardAccounts$ = from([rewardAccounts, rewardAccounts]);
+    const rewardAccounts$ = from([rewardAccounts, rewardAccounts]).pipe(delay(1));
     const addresses$ = from([[addresses[0]], addresses, addresses]).pipe(
+      delay(1),
       shareReplay({ bufferSize: 1, refCount: true })
     );