Merge pull request #800 from input-output-hk/fix/lw-7350-hd-wallet-discovery-first-internal-address

fix(wallet): discovery should search for 1/0 too

Author: mkazlauskas

packages/e2e/test/wallet/PersonalWallet/multiAddress.test.ts

@@ -17,7 +17,8 @@ import { isNotNil } from '@cardano-sdk/util';
 
 const env = getEnv(walletVariables);
 const logger = createLogger();
-const PAYMENT_ADDRESSES_TO_GENERATE = 60;
+const PAYMENT_INDICES_TO_GENERATE = 30;
+const PAYMENT_ADDRESSES_TO_GENERATE = PAYMENT_INDICES_TO_GENERATE * 2; // External + Internal address for each payment derivation index
 const COINS_PER_ADDRESS = 3_000_000n;
 
 describe('PersonalWallet/multiAddress', () => {
@@ -49,17 +50,28 @@ describe('PersonalWallet/multiAddress', () => {
     const addressesToBeDiscovered = new Array<GroupedAddress>();
 
     // Deposit some tADA at some generated addresses from the previously generated mnemonics.
-    for (let i = 0; i < PAYMENT_ADDRESSES_TO_GENERATE; ++i) {
-      const address = await multiAddressKeyAgent.deriveAddress(
-        {
-          index: i,
-          type: AddressType.External
-        },
-        0
-      );
-
-      addressesToBeDiscovered.push(address);
-      txBuilder.addOutput(txBuilder.buildOutput().address(address.address).coin(3_000_000n).toTxOut());
+    for (let i = 0; i < PAYMENT_INDICES_TO_GENERATE; ++i) {
+      const [addressExternal, addressInternal] = await Promise.all([
+        multiAddressKeyAgent.deriveAddress(
+          {
+            index: i,
+            type: AddressType.External
+          },
+          0
+        ),
+        multiAddressKeyAgent.deriveAddress(
+          {
+            index: i,
+            type: AddressType.Internal
+          },
+          0
+        )
+      ]);
+
+      addressesToBeDiscovered.push(addressExternal, addressInternal);
+
+      txBuilder.addOutput(txBuilder.buildOutput().address(addressExternal.address).coin(3_000_000n).toTxOut());
+      txBuilder.addOutput(txBuilder.buildOutput().address(addressInternal.address).coin(3_000_000n).toTxOut());
     }
 
     const { tx: signedTx } = await txBuilder.build().sign();

packages/wallet/src/services/AddressDiscovery/HDSequentialDiscovery.ts

@@ -115,7 +115,11 @@ export class HDSequentialDiscovery implements AddressDiscovery {
    * @returns A promise that will be resolved into a GroupedAddress list containing the discovered addresses.
    */
   public async discover(keyAgent: AsyncKeyAgent): Promise<GroupedAddress[]> {
-    const firstAddress = await keyAgent.deriveAddress({ index: 0, type: AddressType.External }, 0, true);
+    const firstAddresses = [await keyAgent.deriveAddress({ index: 0, type: AddressType.External }, 0, true)];
+    const firstInternalAddress = await keyAgent.deriveAddress({ index: 0, type: AddressType.Internal }, 0, true);
+    if (await addressHasTx(firstInternalAddress, this.#chainHistoryProvider)) {
+      firstAddresses.push(firstInternalAddress);
+    }
 
     const stakeKeyAddresses = await discoverAddresses(
       keyAgent,
@@ -145,7 +149,7 @@ export class HDSequentialDiscovery implements AddressDiscovery {
       })
     );
 
-    const addresses = uniqBy([firstAddress, ...stakeKeyAddresses, ...paymentKeyAddresses], 'address');
+    const addresses = uniqBy([...firstAddresses, ...stakeKeyAddresses, ...paymentKeyAddresses], 'address');
 
     // We need to make sure the addresses are sorted since the wallet assumes that the first address
     // in the list is the change address (payment cred 0 and stake cred 0).

packages/wallet/test/integration/withdrawal.test.ts

@@ -3,6 +3,7 @@ import { PersonalWallet, TransactionFailure } from '../../src';
 import { createWallet } from './util';
 import { firstValueFrom, of } from 'rxjs';
 import { mockProviders as mocks } from '@cardano-sdk/util-dev';
+import uniq from 'lodash/uniq';
 
 describe('integration/withdrawal', () => {
   let wallet: PersonalWallet;
@@ -77,7 +78,7 @@ describe('integration/withdrawal', () => {
 
   it('can submit transaction', async () => {
     const availableRewards = await firstValueFrom(wallet.balance.rewardAccounts.rewards$);
-    const accounts = (await firstValueFrom(wallet.addresses$)).map((address) => address.rewardAccount);
+    const accounts = uniq((await firstValueFrom(wallet.addresses$)).map((address) => address.rewardAccount));
     const txInternals = await wallet.initializeTx({
       certificates: [
         {

packages/wallet/test/services/addressDiscovery/HDSequentialDiscovery.test.ts

@@ -24,6 +24,7 @@ describe('HDSequentialDiscovery', () => {
       createMockChainHistoryProvider(
         new Map([
           [asPaymentAddress('testAddress_0_0_0'), 1],
+          [asPaymentAddress('testAddress_0_0_1'), 1],
           [asPaymentAddress('testAddress_1_0_0'), 1],
           [asPaymentAddress('testAddress_1_0_1'), 1],
           [asPaymentAddress('testAddress_2_0_0'), 1]
@@ -34,7 +35,7 @@ describe('HDSequentialDiscovery', () => {
 
     const addresses = await discovery.discover(mockKeyAgent);
 
-    expect(addresses.length).toEqual(4);
+    expect(addresses.length).toEqual(5);
     expect(addresses[0]).toEqual({
       accountIndex: 0,
       address: 'testAddress_0_0_0',
@@ -48,6 +49,18 @@ describe('HDSequentialDiscovery', () => {
       type: AddressType.External
     });
     expect(addresses[1]).toEqual({
+      accountIndex: 0,
+      address: 'testAddress_0_0_1',
+      index: 0,
+      networkId: 0,
+      rewardAccount: 'testStakeAddress_0',
+      stakeKeyDerivationPath: {
+        index: 0,
+        role: KeyRole.Stake
+      },
+      type: AddressType.Internal
+    });
+    expect(addresses[2]).toEqual({
       accountIndex: 0,
       address: 'testAddress_1_0_0',
       index: 1,
@@ -59,7 +72,7 @@ describe('HDSequentialDiscovery', () => {
       },
       type: AddressType.External
     });
-    expect(addresses[2]).toEqual({
+    expect(addresses[3]).toEqual({
       accountIndex: 0,
       address: 'testAddress_1_0_1',
       index: 1,
@@ -71,7 +84,7 @@ describe('HDSequentialDiscovery', () => {
       },
       type: AddressType.Internal
     });
-    expect(addresses[3]).toEqual({
+    expect(addresses[4]).toEqual({
       accountIndex: 0,
       address: 'testAddress_2_0_0',
       index: 2,