@cardano-sdk/e2e 0.11.0 → 0.12.0

package/test/wallet/PersonalWallet/multiAddress.test.ts

@@ -0,0 +1,158 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+import { AddressType, GroupedAddress, util } from '@cardano-sdk/key-management';
+import { KeyAgentFactoryProps, getWallet } from '../../../src';
+import { PersonalWallet } from '@cardano-sdk/wallet';
+import { createLogger } from '@cardano-sdk/util-dev';
+import { createStandaloneKeyAgent, firstValueFromTimed, normalizeTxBody, walletReady } from '../../util';
+import { filter, map, take } from 'rxjs';
+import { getEnv, walletVariables } from '../../../src/environment';
+import { isNotNil } from '@cardano-sdk/util';
+
+const env = getEnv(walletVariables);
+const logger = createLogger();
+const PAYMENT_ADDRESSES_TO_GENERATE = 60;
+const COINS_PER_ADDRESS = 3_000_000n;
+
+describe('PersonalWallet/multiAddress', () => {
+  let wallet: PersonalWallet;
+
+  beforeAll(async () => {
+    wallet = (await getWallet({ env, idx: 0, logger, name: 'Wallet', polling: { interval: 50 } })).wallet;
+  });
+
+  afterAll(() => {
+    wallet.shutdown();
+  });
+
+  // eslint-disable-next-line max-statements
+  it('can discover and spend UTXOs from a multi address wallet', async () => {
+    await walletReady(wallet);
+    const genesis = await firstValueFromTimed(wallet.genesisParameters$);
+
+    // Create a random set of mnemonics for a brand-new wallet
+    const mnemonics = util.generateMnemonicWords();
+    const multiAddressKeyAgent = await createStandaloneKeyAgent(
+      mnemonics,
+      genesis,
+      await wallet.keyAgent.getBip32Ed25519()
+    );
+
+    let txBuilder = wallet.createTxBuilder();
+
+    let addressesToBeDiscovered = new Array<GroupedAddress>();
+
+    // Let's add the 5 stake keys.
+    for (let i = 0; i < 5; ++i) {
+      addressesToBeDiscovered.push(
+        await multiAddressKeyAgent.deriveAddress(
+          {
+            index: 0,
+            type: AddressType.External
+          },
+          i
+        )
+      );
+    }
+
+    // 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);
+
+      const txOutput = await txBuilder.buildOutput().address(address.address).coin(3_000_000n).build();
+      txBuilder.addOutput(txOutput);
+    }
+
+    // Remove duplicates
+    addressesToBeDiscovered = [...new Set(addressesToBeDiscovered)];
+
+    const unsignedTx = txBuilder.build();
+
+    const { tx: signedTx } = await unsignedTx.sign();
+
+    await wallet.submitTx(signedTx);
+
+    // Search chain history to see if the transaction is there.
+    const txFoundInHistory = await firstValueFromTimed(
+      wallet.transactions.history$.pipe(
+        map((txs) => txs.find((tx) => tx.id === signedTx.id)),
+        filter(isNotNil),
+        take(1)
+      )
+    );
+
+    expect(txFoundInHistory.id).toEqual(signedTx.id);
+    expect(normalizeTxBody(txFoundInHistory.body)).toEqual(normalizeTxBody(signedTx.body));
+
+    // Create a new wallet using the mnemonics previously generated.
+    const mnemonicString = mnemonics.join(' ');
+
+    const customKeyParams: KeyAgentFactoryProps = {
+      accountIndex: 0,
+      chainId: env.KEY_MANAGEMENT_PARAMS.chainId,
+      mnemonic: mnemonicString,
+      passphrase: 'some_passphrase'
+    };
+
+    const newWallet = await getWallet({
+      customKeyParams,
+      env,
+      idx: 0,
+      logger,
+      name: 'New Multi Address Wallet',
+      polling: { interval: 500 }
+    });
+
+    await walletReady(newWallet.wallet);
+    const walletAddresses = await firstValueFromTimed(newWallet.wallet.addresses$);
+
+    // Let's check if all addresses has been discovered.
+    expect(walletAddresses).toEqual(addressesToBeDiscovered);
+
+    const totalBalance = await firstValueFromTimed(newWallet.wallet.balance.utxo.total$);
+    const expectedAmount = PAYMENT_ADDRESSES_TO_GENERATE * Number(COINS_PER_ADDRESS);
+
+    expect(Number(totalBalance.coins)).toEqual(expectedAmount);
+
+    // Now lets see if the wallet can spend from all these addresses.
+    txBuilder = newWallet.wallet.createTxBuilder();
+
+    const fundingWalletAddresses = await firstValueFromTimed(wallet.addresses$);
+    const returnAdaOutput = await txBuilder
+      .buildOutput()
+      .address(fundingWalletAddresses[0].address)
+      .coin(totalBalance.coins - 1_500_000n) // Let's leave some behind for fees.
+      .build();
+
+    txBuilder.addOutput(returnAdaOutput);
+
+    const returnAdaUnsignedTx = await txBuilder.build();
+
+    const { tx: returnAdaSignedTx } = await returnAdaUnsignedTx.sign();
+    await newWallet.wallet.submitTx(returnAdaSignedTx);
+
+    // Search chain history to see if the transaction is there.
+    const returnAdaTxFoundInHistory = await firstValueFromTimed(
+      newWallet.wallet.transactions.history$.pipe(
+        map((txs) => txs.find((tx) => tx.id === returnAdaSignedTx.id)),
+        filter(isNotNil),
+        take(1)
+      )
+    );
+
+    expect(returnAdaTxFoundInHistory.id).toEqual(returnAdaSignedTx.id);
+    expect(normalizeTxBody(returnAdaTxFoundInHistory.body)).toEqual(normalizeTxBody(returnAdaSignedTx.body));
+
+    const endingBalance = await firstValueFromTimed(newWallet.wallet.balance.utxo.total$);
+    const expectedEndingBalance = 1_500_000n - returnAdaTxFoundInHistory.body.fee;
+
+    expect(endingBalance.coins).toEqual(expectedEndingBalance);
+  });
+});

package/test/wallet/{SingleAddressWallet → PersonalWallet}/multisignature.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 import { Cardano, nativeScriptPolicyId } from '@cardano-sdk/core';
-import { FinalizeTxProps, SingleAddressWallet } from '@cardano-sdk/wallet';
+import { FinalizeTxProps, PersonalWallet } from '@cardano-sdk/wallet';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { KeyRole, util } from '@cardano-sdk/key-management';
 import { burnTokens, createStandaloneKeyAgent, submitAndConfirm, walletReady } from '../../util';
@@ -11,8 +11,8 @@ import { getEnv, getWallet, walletVariables } from '../../../src';
 const env = getEnv(walletVariables);
 const logger = createLogger();
 
-describe('SingleAddressWallet/multisignature', () => {
-  let wallet: SingleAddressWallet;
+describe('PersonalWallet/multisignature', () => {
+  let wallet: PersonalWallet;
   const assetName = '3030303030';
 
   afterAll(() => {

package/test/wallet/{SingleAddressWallet → PersonalWallet}/nft.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 import { Asset, Cardano, metadatum, nativeScriptPolicyId } from '@cardano-sdk/core';
-import { Assets, FinalizeTxProps, SingleAddressWallet } from '@cardano-sdk/wallet';
+import { Assets, FinalizeTxProps, PersonalWallet } from '@cardano-sdk/wallet';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { KeyRole, TransactionSigner, util } from '@cardano-sdk/key-management';
 import { burnTokens, createStandaloneKeyAgent, firstValueFromTimed, submitAndConfirm, walletReady } from '../../util';
@@ -12,7 +12,7 @@ const env = getEnv(walletVariables);
 const logger = createLogger();
 
 // Returns [assets in wallet balance, assetInfos with nftMetadata for the assets in the balance]
-const walletBalanceAssetsAndNfts = (wallet: SingleAddressWallet) =>
+const walletBalanceAssetsAndNfts = (wallet: PersonalWallet) =>
   combineLatest([wallet.balance.utxo.total$, wallet.assetInfo$]).pipe(
     filter(([balance]) => !!balance.assets),
     map(([balance, assetInfos]): [Cardano.TokenMap, Assets] => [balance.assets!, assetInfos]),
@@ -27,12 +27,12 @@ const walletBalanceAssetsAndNfts = (wallet: SingleAddressWallet) =>
     ])
   );
 
-describe('SingleAddressWallet.assets/nft', () => {
+describe('PersonalWallet.assets/nft', () => {
   const TOKEN_METADATA_1_INDEX = 0;
   const TOKEN_METADATA_2_INDEX = 1;
   const TOKEN_BURN_INDEX = 2;
 
-  let wallet: SingleAddressWallet;
+  let wallet: PersonalWallet;
   let policySigner: TransactionSigner;
   let policyId: Cardano.PolicyId;
   let policyScript: Cardano.NativeScript;
@@ -198,6 +198,7 @@ describe('SingleAddressWallet.assets/nft', () => {
       policyId,
       // in case of repeated tests on the same network, total asset supply is not updated due to
       // the limitation that asset info is not refreshed on wallet balance changes
+      quantity: expect.anything(),
       supply: expect.anything(),
       tokenMetadata: null
     });
@@ -356,6 +357,7 @@ describe('SingleAddressWallet.assets/nft', () => {
             version: '1.0'
           },
           policyId,
+          quantity: expect.anything(),
           supply: expect.anything(),
           tokenMetadata: null
         });

package/test/wallet/{SingleAddressWallet → PersonalWallet}/phase2validation.test.ts

@@ -1,5 +1,5 @@
 import { Cardano } from '@cardano-sdk/core';
-import { FinalizeTxProps, SingleAddressWallet, TransactionFailure } from '@cardano-sdk/wallet';
+import { FinalizeTxProps, PersonalWallet, TransactionFailure } from '@cardano-sdk/wallet';
 import { Hash32ByteBase16 } from '@cardano-sdk/crypto';
 import { HexBlob, isNotNil } from '@cardano-sdk/util';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
@@ -17,7 +17,7 @@ const logger = createLogger();
  * @param wallet The wallet which will set the collateral.
  */
 const createCollateral = async (
-  wallet: SingleAddressWallet
+  wallet: PersonalWallet
 ): Promise<{ collateralInput: Cardano.TxIn; collateralCoinValue: bigint }> => {
   const txBuilder = wallet.createTxBuilder();
 
@@ -53,8 +53,8 @@ const createCollateral = async (
   return { collateralCoinValue: utxo[1].value.coins, collateralInput: utxo[0] };
 };
 
-describe('SingleAddressWallet/phase2validation', () => {
-  let wallet: SingleAddressWallet;
+describe('PersonalWallet/phase2validation', () => {
+  let wallet: PersonalWallet;
 
   afterAll(() => {
     wallet.shutdown();

package/test/wallet/{SingleAddressWallet → PersonalWallet}/pouchDbWalletStores.test.ts

@@ -7,7 +7,7 @@ import delay from 'delay';
 
 const env = getEnv(walletVariables);
 
-describe('SingleAddressWallet/pouchDbWalletStores', () => {
+describe('PersonalWallet/pouchDbWalletStores', () => {
   const walletName = 'DbTestWallet';
   let stores1: storage.WalletStores;
 
@@ -15,7 +15,7 @@ describe('SingleAddressWallet/pouchDbWalletStores', () => {
     stores1 = storage.createPouchDbWalletStores(walletName, { logger });
   });
 
-  it('stores and restores SingleAddressWallet, continues sync after initial load', async () => {
+  it('stores and restores PersonalWallet, continues sync after initial load', async () => {
     const wallet1 = (await getWallet({ env, logger, name: 'Test Wallet', stores: stores1 })).wallet;
 
     // wallet1 fetched all responses from wallet provider

package/test/wallet/{SingleAddressWallet → PersonalWallet}/txChainHistory.test.ts

@@ -1,4 +1,4 @@
-import { SingleAddressWallet } from '@cardano-sdk/wallet';
+import { PersonalWallet } from '@cardano-sdk/wallet';
 import { filter, firstValueFrom, map, take } from 'rxjs';
 import { getEnv, getWallet, walletVariables } from '../../../src';
 import { isNotNil } from '@cardano-sdk/util';
@@ -7,8 +7,8 @@ import { normalizeTxBody, walletReady } from '../../util';
 
 const env = getEnv(walletVariables);
 
-describe('SingleAddressWallet/txChainHistory', () => {
-  let wallet: SingleAddressWallet;
+describe('PersonalWallet/txChainHistory', () => {
+  let wallet: PersonalWallet;
 
   beforeEach(async () => {
     ({ wallet } = await getWallet({ env, logger, name: 'Sending Wallet', polling: { interval: 50 } }));

package/test/wallet/{SingleAddressWallet → PersonalWallet}/txChaining.test.ts

@@ -6,7 +6,7 @@ import { submitAndConfirm, walletReady } from '../../util';
 
 const env = getEnv(walletVariables);
 
-describe('SingleAddressWallet/txChaining', () => {
+describe('PersonalWallet/txChaining', () => {
   let wallet: ObservableWallet;
 
   beforeAll(async () => {

package/test/wallet/{SingleAddressWallet → PersonalWallet}/unspendableUtxos.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/no-duplicate-string */
-import { SingleAddressWallet, utxoEquals } from '@cardano-sdk/wallet';
+import { PersonalWallet, utxoEquals } from '@cardano-sdk/wallet';
 import { createLogger } from '@cardano-sdk/util-dev';
 import { filter, firstValueFrom, map, take } from 'rxjs';
 import { firstValueFromTimed, walletReady } from '../../util';
@@ -9,9 +9,9 @@ import { isNotNil } from '@cardano-sdk/util';
 const env = getEnv(walletVariables);
 const logger = createLogger();
 
-describe('SingleAddressWallet/unspendableUtxos', () => {
-  let wallet1: SingleAddressWallet;
-  let wallet2: SingleAddressWallet;
+describe('PersonalWallet/unspendableUtxos', () => {
+  let wallet1: PersonalWallet;
+  let wallet2: PersonalWallet;
 
   afterAll(() => {
     wallet1.shutdown();