@cardano-sdk/e2e 0.16.6-patch.0 → 0.16.6

package/src/tools/multi-delegation-data-gen/index.ts

@@ -5,9 +5,7 @@ import {
   TaskResult,
   TerminalProgressMonitor,
   createDelegationWallet,
-  delegateToMultiplePools,
   distributeStake,
-  generateStakeAddresses,
   getOutputPathName,
   loadConfiguration,
   logState,
@@ -18,7 +16,8 @@ import {
 } from './utils';
 
 import { Cardano } from '@cardano-sdk/core';
-import { PersonalWallet } from '@cardano-sdk/wallet';
+import { DynamicChangeAddressResolver, PersonalWallet } from '@cardano-sdk/wallet';
+import { roundRobinRandomImprove } from '@cardano-sdk/input-selection';
 import { walletReady } from '../../';
 import chalk from 'chalk';
 
@@ -69,11 +68,7 @@ const monitor = new TerminalProgressMonitor();
 
     monitor.endTask('Delegation wallet ready.', TaskResult.Success);
 
-    const stakeAddresses = await generateStakeAddresses(delegationWallet, config.stakeDistribution.length, monitor);
-
-    await delegateToMultiplePools(delegationWallet, stakeAddresses, monitor);
-
-    await distributeStake(delegationWallet, config.startingFunds, config.stakeDistribution, stakeAddresses, monitor);
+    const portfolio = await distributeStake(delegationWallet, config.stakeDistribution, monitor);
 
     monitor.startTask('Waiting for delegation to be updated on the wallet.');
     await rewardAccountStatuses(delegationWallet.delegation.rewardAccounts$, [
@@ -82,6 +77,21 @@ const monitor = new TerminalProgressMonitor();
     ]);
     monitor.endTask('Delegation updated.', TaskResult.Success);
 
+    if (config.changeAddressResolver === 'dynamic') {
+      monitor.logInfo(`Using dynamic change address resolution: Portfolio: ${JSON.stringify(portfolio)}`);
+      const selector = roundRobinRandomImprove({
+        changeAddressResolver: new DynamicChangeAddressResolver(
+          delegationWallet.addresses$,
+          delegationWallet.delegation.distribution$,
+          async () => portfolio,
+          console
+        )
+      });
+      delegationWallet.setInputSelector(selector);
+    } else {
+      monitor.logInfo('Using static change address resolution');
+    }
+
     monitor.logInfo('Setup phase ended. Starting interactions...');
 
     // Initial setup done, log starting state.

package/src/tools/multi-delegation-data-gen/utils/config.ts

@@ -23,6 +23,14 @@ convict.addFormat({
   }
 });
 
+convict.addFormat({
+  name: 'changeAddressResolver',
+  validate(val) {
+    if (val !== 'static' && val !== 'dynamic')
+      throw new TypeError('changeAddressResolver must be set to either static or dynamic');
+  }
+});
+
 export type ValueTransferConfig = {
   amount: { max: number; min: number };
   count: { max: number; min: number };
@@ -30,6 +38,11 @@ export type ValueTransferConfig = {
 };
 
 export const configLoader = convict({
+  changeAddressResolver: {
+    default: 'static',
+    doc: 'Whether to use the static or dynamic strategy to resolve change addresses.',
+    format: 'changeAddressResolver'
+  },
   iterations: {
     default: 10,
     doc: 'How many iterations will be executed before stopping the test.',

package/src/tools/multi-delegation-data-gen/utils/utils.ts

@@ -1,7 +1,6 @@
 /* eslint-disable no-console, max-statements, max-params, @typescript-eslint/no-floating-promises */
 import { ValueTransferConfig, configLoader } from './config';
 
-import { AddressType, AsyncKeyAgent, GroupedAddress, util } from '@cardano-sdk/key-management';
 import { Cardano } from '@cardano-sdk/core';
 import { Files, Paths } from './files';
 import {
@@ -18,35 +17,9 @@ import { Observable, filter, firstValueFrom, map } from 'rxjs';
 import { PersonalWallet } from '@cardano-sdk/wallet';
 import { TaskResult, TerminalProgressMonitor } from './terminal-progress-monitor';
 import { logger } from '@cardano-sdk/util-dev';
+import { util } from '@cardano-sdk/key-management';
 import chalk from 'chalk';
 
-/**
- * Gets grouped addresses with increasing stake key index.
- *
- * @param keyAgent The key agent to be used to generate the addresses.
- * @param addressCount Number of addresses to be generated.
- */
-export const getStakeAddresses = async (
-  keyAgent: AsyncKeyAgent,
-  addressCount: number
-): Promise<Array<GroupedAddress>> => {
-  const addresses = new Array<GroupedAddress>();
-
-  for (let i = 0; i < addressCount; ++i) {
-    const address = await keyAgent.deriveAddress(
-      {
-        index: 0,
-        type: AddressType.External
-      },
-      i
-    );
-
-    addresses.push(address);
-  }
-
-  return addresses;
-};
-
 /**
  * Gets a list of the available pool.
  *
@@ -83,43 +56,6 @@ export const rewardAccountStatuses = async (
     timeout
   );
 
-/**
- * Registers and delegates reward accounts to different pools.
- */
-export const delegateToMultiplePools = async (
-  fundingWallet: PersonalWallet,
-  rewardAccounts: GroupedAddress[],
-  monitor: TerminalProgressMonitor
-) => {
-  const stakeKeyRegCertificates = rewardAccounts.map(({ rewardAccount }) =>
-    Cardano.createStakeKeyRegistrationCert(rewardAccount)
-  );
-  const poolIds = await getPoolIds(fundingWallet, rewardAccounts.length);
-  const delegationCertificates = rewardAccounts.map((account) =>
-    Cardano.createDelegationCert(account.rewardAccount, poolIds[account.stakeKeyDerivationPath!.index].id)
-  );
-
-  monitor.logInfo(
-    `Registering accounts: [${chalk.green(rewardAccounts.map(({ rewardAccount }) => rewardAccount).join(', '))}]`
-  );
-
-  monitor.startTask(
-    `Delegating to pools [${chalk.green(poolIds.map(({ id }) => id).join(', '))}] and registering ${chalk.green(
-      stakeKeyRegCertificates.length
-    )} stake keys`
-  );
-
-  const txBuilder = fundingWallet.createTxBuilder();
-
-  txBuilder.partialTxBody.certificates = [...stakeKeyRegCertificates, ...delegationCertificates];
-  const { tx } = await txBuilder.build().sign();
-  await submitAndConfirm(fundingWallet, tx);
-
-  monitor.endTask('Stake keys delegated', TaskResult.Success);
-
-  return poolIds;
-};
-
 const env = getEnv(walletVariables);
 
 /**
@@ -231,66 +167,33 @@ export const transferStartingFunds = async (
   monitor.endTask('Funds transferred', TaskResult.Success);
 };
 
-/**
- * Generates a list of stake addresses.
- *
- * @param delegationWallet The delegation wallets.
- * @param stakeKeyCount The number of stake keys to use in the generation of the addresses.
- * @param monitor The progress monitor.
- */
-export const generateStakeAddresses = async (
-  delegationWallet: PersonalWallet,
-  stakeKeyCount: number,
-  monitor: TerminalProgressMonitor
-) => {
-  monitor.startTask('Generating stake addresses.');
-
-  const stakeAddresses = await getStakeAddresses(delegationWallet.keyAgent, stakeKeyCount);
-
-  monitor.endTask(
-    `Stake addresses generated: [${chalk.green!(stakeAddresses.map(({ rewardAccount }) => rewardAccount).join(', '))}]`,
-    TaskResult.Success
-  );
-
-  return stakeAddresses;
-};
-
 /**
  * Distribute the stake among different addresses.
  *
  * @param delegationWallet The delegation wallets.
- * @param startingFunds The total starting funds.
  * @param stakeDistribution The stake distribution to be followed.
- * @param stakeAddresses The list of stake addresses.
  * @param monitor The progress monitor.
  */
 export const distributeStake = async (
   delegationWallet: PersonalWallet,
-  startingFunds: number,
   stakeDistribution: Array<number>,
-  stakeAddresses: Array<GroupedAddress>,
   monitor: TerminalProgressMonitor
-) => {
-  // TODO: Replace with delegatePortfolio once LW-6702 is merged.
-  const totalWeight = stakeDistribution.reduce((sum, current) => sum + current, 0);
-  const stakeDistributionSsPercent = stakeDistribution.map((value) => value / totalWeight);
-  monitor.startTask(`Distribute ${startingFunds} among stake addresses [${stakeDistribution.join(', ')}].`);
-
-  const txBuilder = delegationWallet.createTxBuilder();
-
-  let i = 0;
-  const startingFundsMinusFee = startingFunds - 5_000_000;
-  for (const { address } of stakeAddresses) {
-    const coinsToBeDeposited = stakeDistributionSsPercent[i] * startingFundsMinusFee;
-    txBuilder.addOutput(txBuilder.buildOutput().address(address).coin(BigInt(coinsToBeDeposited)).toTxOut());
-    ++i;
-  }
+): Promise<Cardano.Cip17DelegationPortfolio> => {
+  const pools = await getPoolIds(delegationWallet, stakeDistribution.length);
 
-  const { tx: signedTx } = await txBuilder.build().sign();
+  const portfolio: Cardano.Cip17DelegationPortfolio = {
+    name: 'Portfolio',
+    pools: pools.map((pool, index) => ({ id: pool.hexId, weight: stakeDistribution[index] }))
+  };
 
-  await submitAndConfirm(delegationWallet, signedTx);
+  logger.debug('Delegating portfolio', portfolio);
+
+  const { tx } = await delegationWallet.createTxBuilder().delegatePortfolio(portfolio).build().sign();
+  await submitAndConfirm(delegationWallet, tx);
 
   monitor.endTask('Funds distributed', TaskResult.Success);
+
+  return portfolio;
 };
 
 /**

package/src/util/util.ts

@@ -1,11 +1,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import * as Crypto from '@cardano-sdk/crypto';
-import * as envalid from 'envalid';
 import { Cardano, createSlotEpochCalc } from '@cardano-sdk/core';
 import {
   EMPTY,
   Observable,
-  catchError,
   combineLatest,
   distinctUntilChanged,
   filter,
@@ -22,7 +20,7 @@ import { FAST_OPERATION_TIMEOUT_DEFAULT, SYNC_TIMEOUT_DEFAULT } from '../default
 import { FinalizeTxProps, ObservableWallet, PersonalWallet } from '@cardano-sdk/wallet';
 import { InMemoryKeyAgent, TransactionSigner } from '@cardano-sdk/key-management';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
-import { TestWallet, faucetProviderFactory, networkInfoProviderFactory } from '../factories';
+import { TestWallet, networkInfoProviderFactory } from '../factories';
 import { getEnv, walletVariables } from '../environment';
 import { logger } from '@cardano-sdk/util-dev';
 import sortBy from 'lodash/sortBy';
@@ -35,10 +33,7 @@ export const firstValueFromTimed = <T>(
   timeoutAfter = FAST_OPERATION_TIMEOUT_DEFAULT
 ) =>
   firstValueFrom(
-    observable$.pipe(
-      timeout(timeoutAfter),
-      catchError(() => throwError(() => new Error(timeoutMessage)))
-    )
+    observable$.pipe(timeout({ each: timeoutAfter, with: () => throwError(() => new Error(timeoutMessage)) }))
   );
 
 export const waitForWalletStateSettle = (wallet: ObservableWallet, syncTimeout: number = SYNC_TIMEOUT_DEFAULT) =>
@@ -136,28 +131,6 @@ export type RequestCoinsProps = {
   coins: Cardano.Lovelace;
 };
 
-export const requestCoins = async ({ coins, wallet }: RequestCoinsProps) => {
-  const [{ address }] = await firstValueFrom(wallet.addresses$);
-  logger.info(`Address ${address} will be funded with ${coins} tLovelace.`);
-
-  const { FAUCET_PROVIDER, FAUCET_PROVIDER_PARAMS } = envalid.cleanEnv(process.env, {
-    FAUCET_PROVIDER: envalid.str(),
-    FAUCET_PROVIDER_PARAMS: envalid.json({ default: {} })
-  });
-
-  const faucetProvider = await faucetProviderFactory.create(FAUCET_PROVIDER, FAUCET_PROVIDER_PARAMS, logger);
-  await faucetProvider.start();
-  const healthCheck = await faucetProvider.healthCheck();
-  if (!healthCheck.ok) throw new Error('Faucet provider could not be started.');
-  // Request coins from faucet. This will block until the transaction is in the ledger,
-  // and has the given amount of confirmation, which means the funds can be used immediately after
-  // this call.
-  // TODO: change FaucetProvider signature to accept Cardano.Lovelace
-  const requestResult = await faucetProvider.request(address, Number.parseInt(coins.toString()), 3, 30_000);
-  await txConfirmed(wallet, requestResult);
-  await faucetProvider.close();
-};
-
 export type TransferCoinsProps = {
   fromWallet: ObservableWallet;
   toWallet: ObservableWallet;

package/test/k6/endpoints/asset/get-asset.test.js

@@ -1,22 +1,23 @@
 import http from 'k6/http';
 
+// eslint-disable-next-line no-undef
 const PROVIDER_SERVER_URL = __ENV.PROVIDER_SERVER_URL;
 
 export const options = {
-    thresholds: {
-        http_req_failed: ['rate<0.01'],
-        http_req_duration: ['p(95)<500'],
-    },
+  thresholds: {
+    http_req_duration: ['p(95)<500'],
+    http_req_failed: ['rate<0.01']
+  }
 };
 
 export default function () {
-    const body = JSON.stringify({
-        assetId: "0645beb92789851be85bfad30a6a9d9a0a98e0e8d41cff86727efb9f317374326c616365",
-        extraData: {nftMetadata: true, tokenMetadata: true}
-    })
-    http.post(`${PROVIDER_SERVER_URL}/asset/get-asset`, body, {
-        headers: {
-            'content-type': 'application/json',
-        },
-    });
-}
+  const body = JSON.stringify({
+    assetId: '0645beb92789851be85bfad30a6a9d9a0a98e0e8d41cff86727efb9f317374326c616365',
+    extraData: { nftMetadata: true, tokenMetadata: true }
+  });
+  http.post(`${PROVIDER_SERVER_URL}/asset/get-asset`, body, {
+    headers: {
+      'content-type': 'application/json'
+    }
+  });
+}