@cardano-sdk/e2e 0.36.5 → 0.36.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cardano-sdk/e2e",
-  "version": "0.36.5",
+  "version": "0.36.6",
   "description": "End to end tests for the cardano-js-sdk packages.",
   "engines": {
     "node": ">=16.20.2"
@@ -81,20 +81,20 @@
   "dependencies": {
     "@cardano-foundation/ledgerjs-hw-app-cardano": "^7.1.2",
     "@cardano-ogmios/client": "6.3.0",
-    "@cardano-sdk/cardano-services": "~0.28.10",
-    "@cardano-sdk/cardano-services-client": "~0.19.10",
-    "@cardano-sdk/core": "~0.35.0",
+    "@cardano-sdk/cardano-services": "~0.28.11",
+    "@cardano-sdk/cardano-services-client": "~0.19.11",
+    "@cardano-sdk/core": "~0.35.1",
     "@cardano-sdk/crypto": "~0.1.25",
-    "@cardano-sdk/hardware-ledger": "~0.9.11",
-    "@cardano-sdk/hardware-trezor": "~0.4.31",
-    "@cardano-sdk/input-selection": "~0.13.4",
-    "@cardano-sdk/key-management": "~0.20.9",
-    "@cardano-sdk/ogmios": "~0.15.31",
-    "@cardano-sdk/tx-construction": "~0.19.4",
+    "@cardano-sdk/hardware-ledger": "~0.9.12",
+    "@cardano-sdk/hardware-trezor": "~0.4.32",
+    "@cardano-sdk/input-selection": "~0.13.5",
+    "@cardano-sdk/key-management": "~0.20.10",
+    "@cardano-sdk/ogmios": "~0.15.32",
+    "@cardano-sdk/tx-construction": "~0.19.5",
     "@cardano-sdk/util": "~0.15.2",
-    "@cardano-sdk/util-dev": "~0.21.4",
+    "@cardano-sdk/util-dev": "~0.21.5",
     "@cardano-sdk/util-rxjs": "~0.7.18",
-    "@cardano-sdk/wallet": "~0.38.5",
+    "@cardano-sdk/wallet": "~0.38.6",
     "@dcspark/cardano-multiplatform-lib-nodejs": "^3.1.1",
     "@vespaiach/axios-fetch-adapter": "^0.3.0",
     "axios": "^0.28.0",
@@ -124,10 +124,10 @@
     "@babel/core": "^7.18.2",
     "@babel/preset-env": "^7.18.2",
     "@babel/preset-typescript": "^7.17.12",
-    "@cardano-sdk/dapp-connector": "~0.12.22",
-    "@cardano-sdk/projection": "~0.11.21",
-    "@cardano-sdk/projection-typeorm": "~0.8.23",
-    "@cardano-sdk/web-extension": "~0.29.5",
+    "@cardano-sdk/dapp-connector": "~0.12.23",
+    "@cardano-sdk/projection": "~0.11.22",
+    "@cardano-sdk/projection-typeorm": "~0.8.24",
+    "@cardano-sdk/web-extension": "~0.29.6",
     "@dcspark/cardano-multiplatform-lib-browser": "^3.1.1",
     "@emurgo/cardano-message-signing-asmjs": "^1.0.1",
     "@types/bunyan": "^1.8.8",
@@ -181,5 +181,5 @@
     "webpack-cli": "^4.9.2",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "f40478db084cb7692f95f99635ab7038eb398df3"
+  "gitHead": "56a83cdd04d017353fe9cfd402b293c6845fdcad"
 }

package/test/k6/scenarios/{wallet-restoration.test.js → wallets.test.js}

@@ -1,7 +1,9 @@
 /* eslint-disable no-console */
 /* eslint-disable func-style */
 import { Counter, Trend } from 'k6/metrics';
+import { SharedArray } from 'k6/data';
 import { check, sleep } from 'k6';
+import { apiVersion } from '../../../../cardano-services-client/src/version.ts';
 import http from 'k6/http';
 
 /**
@@ -34,20 +36,28 @@ const RunMode = {
   RestoreHD: 'RestoreHD'
 };
 /** Determines run mode: Restore or Onboard */
-const RUN_MODE = RunMode.Restore;
+const RUN_MODE = __ENV.RUN_MODE || RunMode.Restore;
 
 // eslint-disable-next-line no-undef
 const PROVIDER_SERVER_URL = __ENV.PROVIDER_SERVER_URL;
 
-/** URL of the JSON file containing the wallets */
-const WALLET_ADDRESSES_URL =
-  RUN_MODE === RunMode.Onboard
-    ? 'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/addresses/no-history-mainnet.json'
-    : 'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/addresses/mainnet.json';
+/** Wallet addresses extracted from the JSON dump file */
+const walletsOrig = new SharedArray('walletsData', function () {
+  const network = __ENV.TARGET_ENV == 'dev-mainnet' ? 'mainnet' : 'preprod';
+  const fileName = RUN_MODE === RunMode.Onboard ? `no-history-${network}.json` : `${network}.json`;
+  console.log(`Reading wallet addresses from ${fileName}`);
+  const walletAddresses = JSON.parse(open('../../dump/addresses/' + fileName));
+  return walletAddresses;
+});
 
-/** URL of the JSON file containing the stake pool addresses */
-const POOL_ADDRESSES_URL =
-  'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/pool_addresses/mainnet.json';
+
+/** Stake pool addresses from the JSON dump file */
+const poolAddresses = new SharedArray('poolsData', function () {
+  // There is no dump of preprod pools, but it is ok. Pool address is used only in "Restore" mode
+  // and it is used to do a stake pool search call, so any pool will do
+  const pools = JSON.parse(open('../../dump/pool_addresses/mainnet.json'));
+  return pools;
+});
 
 /**
  * Define the maximum number of virtual users to simulate
@@ -55,12 +65,12 @@ const POOL_ADDRESSES_URL =
  * For this reason, it's a good practice to configure MAX_VUs in multiples of 100 in order to maintain the desired distribution.
  * In `RunMode.RestoreHD`, each VU will have multiple addresses.
  */
-const MAX_VU = 10;
+const MAX_VU = __ENV.MAX_VU || 1;
 
 /** Time span during which all virtual users are started in a linear fashion */
-const RAMP_UP_DURATION = '10s';
+const RAMP_UP_DURATION = __ENV.RAMP_UP_DURATION || '1s';
 /** Time span during which synced wallets do tip queries */
-const STEADY_STATE_DURATION = '20s';
+const STEADY_STATE_DURATION = __ENV.STEADY_STATE_DURATION || '2s';
 
 /** Time to sleep between iterations. Simulates polling tip to keep wallet in sync */
 const ITERATION_SLEEP = 5;
@@ -68,9 +78,9 @@ const ITERATION_SLEEP = 5;
 /** HD wallet discovery. Used when RunMode is `RestoreHD` */
 const hdWalletParams = {
   /** HD wallet size. The number of addresses with transaction history per wallet. They are queried at discover time. */
-  activeAddrCount: 10,
+  activeAddrCount: __ENV.HD_ACTIVE_ADDR_COUNT || 1,
   /** Use only addresses with a transaction history up to this value */
-  maxTxHistory: 100,
+  maxTxHistory: __ENV.HD_MAX_TX_HISTORY || 1,
   /** number of payment addresses to search for. It will search both internal and external address, thus multiplied by 2 */
   paymentAddrSearchGap: 20 * 2,
   /** number of stake keys to search for. It will search both internal and external address, thus multiplied by 2 */
@@ -95,10 +105,7 @@ const chunkArray = (array, chunkSize) => {
   return chunked;
 };
 
-/**
- * Grab the wallets json file to be used by the scenario.
- * Group the addresses per wallet (single address or HD wallets).
- */
+/** Grab the wallets json file to be used by the scenario. Group the addresses per wallet (single address or HD wallets). */
 export function setup() {
   console.log(`Running in ${RUN_MODE} mode`);
   console.log(`Ramp-up: ${RAMP_UP_DURATION}; Sustain: ${STEADY_STATE_DURATION}; Iteration sleep: ${ITERATION_SLEEP}s`);
@@ -107,12 +114,6 @@ export function setup() {
     console.log('HD wallet params are:', hdWalletParams);
   }
 
-  // This call will be part of the statistics. There is no way around it so far: https://github.com/grafana/k6/issues/1321
-  const res = http.batch([WALLET_ADDRESSES_URL, POOL_ADDRESSES_URL]);
-  check(res, { 'get wallets and pools files': (r) => r.every(({ status }) => status >= 200 && status < 300) });
-
-  const [{ body: resBodyWallets }, { body: resBodyPools }] = res;
-  const walletsOrig = JSON.parse(resBodyWallets);
   const walletsOrigCount = walletsOrig ? walletsOrig.length : 0;
   check(walletsOrigCount, {
     'At least one wallet is required to run the test': (count) => count > 0
@@ -138,7 +139,6 @@ export function setup() {
     );
   }
 
-  const poolAddresses = JSON.parse(resBodyPools);
   check(poolAddresses, {
     'At least one stake pool address is required to run the test': (p) => p && p.length > 0
   });
@@ -178,9 +178,9 @@ export const options = {
 };
 
 /** Util functions for sending the http post requests to cardano-sdk services */
-const cardanoHttpPost = (url, body = {}) => {
+const cardanoHttpPost = (url, apiVer, body = {}) => {
   const opts = { headers: { 'content-type': 'application/json' } };
-  return http.post(`${PROVIDER_SERVER_URL}/${url}`, JSON.stringify(body), opts);
+  return http.post(`${PROVIDER_SERVER_URL}/v${apiVer}/${url}`, JSON.stringify(body), opts);
 };
 
 /**
@@ -196,7 +196,7 @@ const txsByAddress = (addresses, takeOne = false, pageSize = 25) => {
     let txCount = 0;
 
     do {
-      const resp = cardanoHttpPost('chain-history/txs/by-addresses', {
+      const resp = cardanoHttpPost('chain-history/txs/by-addresses', apiVersion.chainHistory, {
         addresses: chunk,
         blockRange: { lowerBound: { __type: 'undefined' } },
         pagination: { limit: pageSize, startAt }
@@ -218,13 +218,14 @@ const txsByAddress = (addresses, takeOne = false, pageSize = 25) => {
 const utxosByAddresses = (addresses) => {
   const addressChunks = chunkArray(addresses, 25);
   for (const chunk of addressChunks) {
-    cardanoHttpPost('utxo/utxo-by-addresses', { addresses: chunk });
+    cardanoHttpPost('utxo/utxo-by-addresses', apiVersion.utxo, { addresses: chunk });
   }
 };
 
-const rewardsAccBalance = (rewardAccount) => cardanoHttpPost('rewards/account-balance', { rewardAccount });
+const rewardsAccBalance = (rewardAccount) =>
+  cardanoHttpPost('rewards/account-balance', apiVersion.rewards, { rewardAccount });
 const stakePoolSearch = (poolAddress) =>
-  cardanoHttpPost('stake-pool/search', {
+  cardanoHttpPost('stake-pool/search', apiVersion.stakePool, {
     filters: { identifier: { values: [{ id: poolAddress }] } },
     pagination: { limit: 1, startAt: 0 }
   });
@@ -240,10 +241,7 @@ const getDummyAddr = (addr, idx, suffix = 'mh') => {
   return addr.slice(0, -3) + updateChars;
 };
 
-/**
- * Simulate http requests normally done in discovery mode.
- * `wallet` MUST have at least 2 elements
- */
+/** Simulate http requests normally done in discovery mode. `wallet` MUST have at least 2 elements */
 const walletDiscovery = (wallet) => {
   check(wallet, {
     'At least one address is required to run HD wallet discovery mode': (walletArray) =>
@@ -284,22 +282,22 @@ const syncWallet = ({ wallet, poolAddress }) => {
     walletDiscovery(wallet);
   }
 
-  cardanoHttpPost('network-info/era-summaries');
-  cardanoHttpPost(TIP_URL);
+  cardanoHttpPost('network-info/era-summaries', apiVersion.networkInfo);
+  cardanoHttpPost(TIP_URL, apiVersion.networkInfo);
   txsByAddress(addresses);
   utxosByAddresses(addresses);
-  cardanoHttpPost('network-info/era-summaries');
-  cardanoHttpPost('network-info/genesis-parameters');
-  cardanoHttpPost('network-info/protocol-parameters');
+  cardanoHttpPost('network-info/era-summaries', apiVersion.networkInfo);
+  cardanoHttpPost('network-info/genesis-parameters', apiVersion.networkInfo);
+  cardanoHttpPost('network-info/protocol-parameters', apiVersion.networkInfo);
   // Test restoring HD wallets with a single stake key
   rewardsAccBalance(wallet[0].stake_address);
-  cardanoHttpPost(TIP_URL);
-  cardanoHttpPost('network-info/lovelace-supply');
-  cardanoHttpPost('network-info/stake');
+  cardanoHttpPost(TIP_URL, apiVersion.networkInfo);
+  cardanoHttpPost('network-info/lovelace-supply', apiVersion.networkInfo);
+  cardanoHttpPost('network-info/stake', apiVersion.networkInfo);
   if (RUN_MODE === RunMode.Restore) {
     stakePoolSearch(poolAddress);
   }
-  cardanoHttpPost('stake-pool/stats');
+  cardanoHttpPost('stake-pool/stats', apiVersion.stakePool);
 
   // Consider the wallet synced by tracking its first address
   syncedWallets.add(addresses[0]);
@@ -307,11 +305,8 @@ const syncWallet = ({ wallet, poolAddress }) => {
   walletSyncCount.add(1);
 };
 
-/**
- * Simulate keeping wallet in sync
- * For now, just polling the tip
- */
-const emulateIdleClient = () => cardanoHttpPost(TIP_URL);
+/** Simulate keeping wallet in sync For now, just polling the tip */
+const emulateIdleClient = () => cardanoHttpPost(TIP_URL, apiVersion.networkInfo);
 
 /**
  * K6 default VU action function

package/test/k6/scenarios/wallet-creation.test.js

@@ -1,219 +0,0 @@
-/* eslint-disable no-console */
-/* eslint-disable func-style */
-import { Counter, Trend } from 'k6/metrics';
-import { check, sleep } from 'k6';
-import http from 'k6/http';
-
-/**
- * Script overall description:
- *  One wallet == one VU
- *  Configure RUN_MODE to have the test run with empty wallets (onboarding) or wallets with history (restoring)
- *  Configure MAX_VU: number of wallets to be synced (e.g. 100 wallets)
- *  Setup RAMP_UP_DURATION: ramp-up time to synced these wallets (e.g. 30s)
- *    - During this time, wallets start evenly distributed (e.g. ~3 wallets every second)
- *  Each wallet performs as many iterations as possible
- *    - 1st iteration: restoration steps .
- *    - Subsequent iterations will only query the tip
- *  ITERATION_SLEEP: Every iteration has a sleep of to simulate Lace tip polling interval
- *  During the STEADY_STATE_DURATION:
- *    - Synced wallets do tip queries.
- *    - Wallets not synced yet will wait for restoration to complete, then will also start tip queries
- *  No ramp-down is needed. We can simply stop the test as there is no point in sending fewer and fewer tip queries during ramp-down.
- *  wallet_sync: is a custom trend metric measuring the trend of wallet sync calls.
- *  wallet_sync_count: is a custom count metric measuring the number of wallets that were successfully synced.
- */
-
-const RunMode = {
-  Onboard: 'Onboard',
-  Restore: 'Restore'
-};
-/** Determines run mode: Restore or Onboard */
-const RUN_MODE = RunMode.Onboard;
-
-/**
- * True: Keep spinning on the restoring part
- * False: Once restored, just loop over ledger tip
- */
-const SPIN_ON_NEW_WALLETS = true;
-
-// eslint-disable-next-line no-undef
-const PROVIDER_SERVER_URL = __ENV.PROVIDER_SERVER_URL;
-
-/** URL of the JSON file containing the wallets */
-const WALLET_ADDRESSES_URL =
-  RUN_MODE === RunMode.Restore
-    ? 'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/addresses/mainnet.json'
-    : 'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/addresses/no-history-mainnet.json';
-
-/** URL of the JSON file containing the stake pool addresses */
-const POOL_ADDRESSES_URL =
-  'https://raw.githubusercontent.com/input-output-hk/cardano-js-sdk/master/packages/e2e/test/dump/pool_addresses/mainnet.json';
-
-/**
- * Define the maximum number of virtual users to simulate
- * The mainnet.json file contains wallets in chunks of 100, each chunk having the required distribution
- * For this reason, it's a good practice to configure MAX_VUs in multiples of 100 in order to maintain the desired distribution
- */
-const MAX_VU = 1;
-
-/** Time span during which all virtual users are started in a linear fashion */
-const RAMP_UP_DURATION = '10s';
-/** Time span during which synced wallets do tip queries */
-const STEADY_STATE_DURATION = '1m';
-
-/** Time to sleep between iterations. Simulates polling tip to keep wallet in sync */
-const ITERATION_SLEEP = 5;
-
-/** Custom trend statistic to measure trend to sync wallets */
-const walletSyncTrend = new Trend('wallet_sync', true);
-/** Custom count statistic to measure how many wallets were successfully syncd */
-const walletSyncCount = new Counter('wallet_sync_count');
-
-/** Repetitive entpoints */
-const TIP_URL = 'network-info/ledger-tip';
-
-/** Grab the wallets json file to be used by the scenario */
-export function setup() {
-  console.log(`Running in ${RUN_MODE} mode`);
-  // This call will be part of the statistics. There is no way around it so far: https://github.com/grafana/k6/issues/1321
-  const res = http.batch([WALLET_ADDRESSES_URL, POOL_ADDRESSES_URL]);
-  check(res, { 'get wallets and pools files': (r) => r.every(({ status }) => status >= 200 && status < 300) });
-
-  const [{ body: resBodyWallets }, { body: resBodyPools }] = res;
-  const wallets = JSON.parse(resBodyWallets);
-  const walletCount = wallets ? wallets.length : 0;
-  check(walletCount, {
-    'At least one wallet is required to run the test': (count) => count > 0
-  });
-  console.log(`Wallet addresses configuration file contains ${walletCount} wallets`);
-  if (walletCount < MAX_VU) {
-    console.warn(
-      `Requested VU count: (${MAX_VU}), is greater than the available walled addresses: ${walletCount}. Some addresses will be reused`
-    );
-  }
-
-  const poolAddresses = JSON.parse(resBodyPools);
-  check(poolAddresses, {
-    'At least one stake pool address is required to run the test': (p) => p && p.length > 0
-  });
-  return { poolAddresses, wallets: wallets.slice(0, MAX_VU) };
-}
-
-/** Keeps track of wallets that were successfully syncd to avoid restoring twice */
-const syncedWallets = new Set();
-
-export const options = {
-  ext: {
-    loadimpact: {
-      apm: [],
-      distribution: { 'amazon:us:portland': { loadZone: 'amazon:us:portland', percent: 100 } }
-    }
-  },
-  scenarios: {
-    SyncDifferentSizeWallets: {
-      executor: 'ramping-vus',
-      gracefulRampDown: '0s',
-      gracefulStop: '0s',
-      stages: [
-        { duration: RAMP_UP_DURATION, target: MAX_VU },
-        { duration: STEADY_STATE_DURATION, target: MAX_VU }
-      ],
-      startVUs: 1
-    }
-  },
-  thresholds: {
-    // All wallets should have syncd
-    // Use https://k6.io/docs/using-k6/thresholds/ to set more thresholds. E.g.:
-    // wallet_sync: ['p(95)<5000'], // 95% of wallets should sync in under 5 seconds
-    wallet_sync: [{ delayAbortEval: '5s', threshold: 'p(95) < 30000' }],
-
-    wallet_sync_count: [`count >= ${MAX_VU}`] // We get a nice graph if we enable thresholds. See this stat on a graph
-  }
-};
-
-/** Util functions for sending the http post requests to cardano-sdk services */
-const cardanoHttpPost = (url, body = {}) => {
-  const opts = { headers: { 'content-type': 'application/json' } };
-  return http.post(`${PROVIDER_SERVER_URL}/${url}`, JSON.stringify(body), opts);
-};
-const txsByAddress = (address) => {
-  let startAt = 0;
-  const pageSize = 25;
-  let txCount = 0;
-  do {
-    const resp = cardanoHttpPost('chain-history/txs/by-addresses', {
-      addresses: [address],
-      blockRange: { lowerBound: { __type: 'undefined' } },
-      pagination: { limit: pageSize, startAt }
-    });
-
-    if (resp.status !== 200) {
-      // No point in trying to get the other pages.
-      // Should we log this? it will show up as if the restoration was quicker since this wallet did not fetch all the pages
-      break;
-    }
-
-    const { pageResults } = JSON.parse(resp.body);
-    startAt += pageSize;
-    txCount = pageResults.length;
-  } while (txCount === pageSize);
-};
-const utxosByAddresses = (address) => cardanoHttpPost('utxo/utxo-by-addresses', { addresses: [address] });
-const rewardsAccBalance = (rewardAccount) => cardanoHttpPost('rewards/account-balance', { rewardAccount });
-const stakePoolSearch = (poolAddress) =>
-  cardanoHttpPost('stake-pool/search', {
-    filters: { identifier: { values: [{ id: poolAddress }] } },
-    pagination: { limit: 1, startAt: 0 }
-  });
-
-/** Simulation of requests performed by a wallet while restoring */
-const syncWallet = ({ wallet, poolAddress }) => {
-  const startTime = Date.now();
-  const { address, stake_address: rewardAccount } = wallet;
-  cardanoHttpPost('network-info/era-summaries');
-  cardanoHttpPost(TIP_URL);
-  txsByAddress(address);
-  utxosByAddresses(address);
-  cardanoHttpPost('network-info/era-summaries');
-  cardanoHttpPost('network-info/genesis-parameters');
-  cardanoHttpPost('network-info/protocol-parameters');
-  rewardsAccBalance(rewardAccount);
-  cardanoHttpPost(TIP_URL);
-  cardanoHttpPost('network-info/lovelace-supply');
-  cardanoHttpPost('network-info/stake');
-  if (RUN_MODE === RunMode.Restore) {
-    stakePoolSearch(poolAddress);
-  }
-  cardanoHttpPost('stake-pool/stats');
-
-  syncedWallets.add(address);
-  walletSyncTrend.add(Date.now() - startTime);
-  walletSyncCount.add(1);
-};
-
-function getRandomInt(max) {
-  return Math.floor(Math.random() * max);
-}
-
-/**
- * Simulate keeping wallet in sync
- * For now, just polling the tip
- */
-const emulateIdleClient = () => cardanoHttpPost(TIP_URL);
-
-export default function ({ wallets, poolAddresses }) {
-  // Pick a new wallet or reuse the same one?
-  // eslint-disable-next-line no-undef
-  const walletIdx = SPIN_ON_NEW_WALLETS ? getRandomInt(wallets.length) : __VU;
-
-  // Get the wallet for the current virtual user
-  const wallet = wallets[walletIdx % wallets.length];
-  const poolAddress = poolAddresses[walletIdx % poolAddresses.length];
-
-  if (SPIN_ON_NEW_WALLETS || !syncedWallets.has(wallet.address)) {
-    syncWallet({ poolAddress, wallet });
-  } else {
-    emulateIdleClient();
-    sleep(ITERATION_SLEEP);
-  }
-}