@cardano-sdk/e2e 0.24.0 → 0.26.0

package/docker-compose.yml

@@ -57,6 +57,10 @@ services:
     volumes:
       - ./local-network/config/network:/config
 
+  cardano-submit-api:
+    volumes:
+      - ./local-network/config/network:/config
+
   handle-projector:
     environment:
       HANDLE_POLICY_IDS_FILE: /sdk-ipc/handle_policy_ids

package/jest.config.js

@@ -26,7 +26,6 @@ const realAdaTestFileNames = [
 module.exports = {
   projects: [
     { ...project('blockfrost'), globalSetup: './test/blockfrost/setup.ts' },
-    project('load-testing'),
     project('local-network'),
     project('long-running'),
     project('ogmios'),

package/local-network/scripts/common.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+wait_tx_complete() {
+  utxo_to_check="$1"
+  timeout=0
+  max_timeout=30
+  while [ $timeout -lt $max_timeout ]; do
+    output=$(cardano-cli query utxo --tx-in "${utxo_to_check}" --testnet-magic 888)
+    line_count=$(echo "$output" | awk 'END {print NR}')
+    if [ $line_count -eq 2 ]; then
+      echo "Transaction completed"
+      return 0
+    fi
+    timeout=$((timeout + 1))
+    sleep 1
+  done
+  echo "Timeout: Transaction not completed in $max_timeout sec."
+  return 1
+}

package/local-network/scripts/make-babbage.sh

@@ -266,12 +266,13 @@ $SED -i -E "s/AlonzoGenesisHash: '.*'/AlonzoGenesisHash: '${alonzoGenesisHash}'/
 # Create config folder
 rm -rf ./config/*
 mkdir -p ./config/network/cardano-db-sync/
-mkdir -p ./config/network/cardano-db-sync/
 mkdir -p ./config/network/cardano-node/genesis/
+mkdir -p ./config/network/cardano-submit-api/
 mkdir -p ./config/network/genesis/
 
 cp ./templates/babbage/db-sync-config.json ./config/network/cardano-db-sync/config.json
 cp ./templates/babbage/node-config.json ./config/network/cardano-node/config.json
+cp ./templates/babbage/submit-api-config.json ./config/network/cardano-submit-api/config.json
 
 $SED -i -E "s/\"ByronGenesisHash\": \".*\"/\"ByronGenesisHash\": \"${byronGenesisHash}\"/" ./config/network/cardano-node/config.json
 $SED -i -E "s/\"ShelleyGenesisHash\": \".*\"/\"ShelleyGenesisHash\": \"${shelleyGenesisHash}\"/" ./config/network/cardano-node/config.json

package/local-network/scripts/mint-handles.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+source $(dirname $0)/common.sh
+
 handleNames=("HelloHandle" "TestHandle" "DoubleHandle")
 handleHexes=("48656c6c6f48616e646c65" "5465737448616e646c65" "446f75626c6548616e646c65")
 
@@ -46,24 +48,6 @@ cat >network-files/utxo-keys/handles-metadata.json <<EOL
 }}
 EOL
 
-wait_tx_complete() {
-  utxo_to_check="$1"
-  timeout=0
-  max_timeout=10
-  while [ $timeout -lt $max_timeout ]; do
-    output=$(cardano-cli query utxo --tx-in "${utxo_to_check}" --testnet-magic 888)
-    line_count=$(echo "$output" | awk 'END {print NR}')
-    if [ $line_count -eq 2 ]; then
-      echo "Transaction completed"
-      return 0
-    fi
-    timeout=$((timeout + 1))
-    sleep 1
-  done
-  echo "Timeout: Transaction not completed in 10 sec."
-  return 1
-}
-
 echo $policyid >/sdk-ipc/handle_policy_ids
 destAddr="addr_test1qr0c3frkem9cqn5f73dnvqpena27k2fgqew6wct9eaka03agfwkvzr0zyq7nqvcj24zehrshx63zzdxv24x3a4tcnfeq9zwmn7"
 utxo=$(cardano-cli query utxo --address "$addr" --testnet-magic 888 | awk 'NR == 3 {printf("%s#%s", $1, $2)}')

package/local-network/scripts/mint-tokens.sh

@@ -3,6 +3,8 @@
 # This script mint native tokens to genesis address
 set -euo pipefail
 
+source $(dirname $0)/common.sh
+
 here="$(cd "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
 root="$(cd "$here/.." && pwd)"
 cd "$root"
@@ -23,24 +25,6 @@ while [ ! -S "$CARDANO_NODE_SOCKET_PATH" ]; do
   sleep 2
 done
 
-wait_tx_complete() {
-  utxo_to_check="$1"
-  timeout=0
-  max_timeout=10
-  while [ $timeout -lt $max_timeout ]; do
-    output=$(cardano-cli query utxo --tx-in "${utxo_to_check}" --testnet-magic 888)
-    line_count=$(echo "$output" | awk 'END {print NR}')
-    if [ $line_count -eq 2 ]; then
-      echo "Transaction completed"
-      return 0
-    fi
-    timeout=$((timeout + 1))
-    sleep 1
-  done
-  echo "Timeout: Transaction not completed in 10 sec."
-  return 1
-}
-
 echo "Create Mary-era minting policy"
 cat >network-files/utxo-keys/minting-policy.json <<EOL
 {

package/local-network/scripts/setup-wallets.sh

@@ -3,6 +3,8 @@
 # This funds a set of fixed addresses to be used during testing.
 set -euo pipefail
 
+source $(dirname $0)/common.sh
+
 here="$(cd "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
 root="$(cd "$here/.." && pwd)"
 cd "$root"
@@ -23,23 +25,6 @@ while [ ! -S "$CARDANO_NODE_SOCKET_PATH" ]; do
   sleep 2
 done
 
-wait_tx_complete() {
-  utxo_to_check="$1"
-  timeout=0
-  max_timeout=10
-  while [ $timeout -lt $max_timeout ]; do
-    output=$(cardano-cli query utxo --tx-in "${utxo_to_check}" --testnet-magic 888)
-    line_count=$(echo "$output" | awk 'END {print NR}')
-    if [ $line_count -eq 2 ]; then
-      echo "Transaction completed"
-      return 0
-    fi
-    timeout=$((timeout + 1))
-    sleep 1
-  done
-  echo "Timeout: Transaction not completed in 10 sec."
-  return 1
-}
 genesisAddr=$(cardano-cli address build --payment-verification-key-file network-files/utxo-keys/utxo3.vkey --testnet-magic 888)
 
 walletAddr1="addr_test1qpw0djgj0x59ngrjvqthn7enhvruxnsavsw5th63la3mjel3tkc974sr23jmlzgq5zda4gtv8k9cy38756r9y3qgmkqqjz6aa7"

package/local-network/templates/babbage/submit-api-config.json

@@ -0,0 +1,115 @@
+{
+  "ByronGenesisFile": "genesis/byron.json",
+  "ShelleyGenesisFile": "genesis/shelley.json",
+  "AlonzoGenesisFile": "genesis/alonzo.json",
+  "ByronGenesisHash": "a300c7ae1b124f53a80d86c6e43ff28c8d0369d7aa5512d5a3328a668b0e15e8",
+  "ShelleyGenesisHash": "6baf33f913dffe311033bd7a7199060cb421234bf12cb99ef448bfd4fe47e305",
+  "AlonzoGenesisHash": "eaa32942a4f2b3028928cb47be679bb36fa128f6d7dddc04ae592d27f2818c16",
+  "MaxConcurrencyBulkSync": 1,
+  "MaxConcurrencyDeadline": 2,
+  "Protocol": "Cardano",
+  "RequiresNetworkMagic": "RequiresMagic",
+  "LastKnownBlockVersion-Major": 6,
+  "LastKnownBlockVersion-Minor": 0,
+  "LastKnownBlockVersion-Alt": 0,
+  "ApplicationName": "cardano-sl",
+  "ApplicationVersion": 1,
+  "TurnOnLogging": true,
+  "TurnOnLogMetrics": true,
+  "minSeverity": "Info",
+  "TracingVerbosity": "MinimalVerbosity",
+  "setupBackends": [
+    "KatipBK"
+  ],
+  "defaultBackends": [
+    "KatipBK"
+  ],
+  "setupScribes": [
+    {
+      "scKind": "FileSK",
+      "scName": "logs/testnet.log",
+      "scFormat": "ScText"
+    },
+    {
+      "scKind": "StdoutSK",
+      "scName": "stdout",
+      "scFormat": "ScText"
+    }
+  ],
+  "defaultScribes": [
+    [
+      "FileSK",
+      "logs/testnet.log"
+    ],
+    [
+      "StdoutSK",
+      "stdout"
+    ]
+  ],
+  "rotation": {
+    "rpLogLimitBytes": 5000000,
+    "rpKeepFilesNum": 3,
+    "rpMaxAgeHours": 24
+  },
+  "TraceBlockFetchClient": false,
+  "TraceBlockFetchDecisions": false,
+  "TraceBlockFetchProtocol": false,
+  "TraceBlockFetchProtocolSerialised": false,
+  "TraceBlockFetchServer": false,
+  "TraceBlockchainTime": false,
+  "TraceChainDb": true,
+  "TraceChainSyncClient": false,
+  "TraceChainSyncBlockServer": false,
+  "TraceChainSyncHeaderServer": false,
+  "TraceChainSyncProtocol": false,
+  "TraceDNSResolver": true,
+  "TraceDNSSubscription": true,
+  "TraceErrorPolicy": true,
+  "TraceLocalErrorPolicy": true,
+  "TraceForge": false,
+  "TraceHandshake": false,
+  "TraceIpSubscription": true,
+  "TraceLocalRootPeers": true,
+  "TracePublicRootPeers": true,
+  "TracePeerSelection": true,
+  "TraceDebugPeerSelection": false,
+  "TracePeerSelectionActions": true,
+  "TraceConnectionManager": true,
+  "TraceServer": true,
+  "TraceLocalConnectionManager": false,
+  "TraceLocalServer": false,
+  "TraceLocalChainSyncProtocol": false,
+  "TraceLocalHandshake": false,
+  "TraceLocalTxSubmissionProtocol": false,
+  "TraceLocalTxSubmissionServer": false,
+  "TraceMempool": true,
+  "TraceMux": false,
+  "TraceTxInbound": false,
+  "TraceTxOutbound": false,
+  "TraceTxSubmissionProtocol": false,
+  "options": {
+    "mapBackends": {
+      "cardano.node.metrics": [
+        "EKGViewBK"
+      ]
+    },
+    "mapScribes": {
+      "cardano.node.metrics": [
+        "FileSK::logs/testnet.log"
+      ]
+    },
+    "mapSeverity": {
+      "cardano.node.ChainDB": "Notice",
+      "cardano.node.DnsSubscription": "Debug"
+    }
+  },
+  "PBftSignatureThreshold": 0.6,
+  "TestShelleyHardForkAtEpoch": 0,
+  "TestAllegraHardForkAtEpoch": 0,
+  "TestMaryHardForkAtEpoch": 0,
+  "TestAlonzoHardForkAtEpoch": 0,
+  "TestBabbageHardForkAtEpoch": 0,
+  "TestEnableDevelopmentNetworkProtocols": true,
+  "EnableLogMetrics": false,
+  "EnableLogging": true
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cardano-sdk/e2e",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "description": "End to end tests for the cardano-js-sdk packages.",
   "engines": {
     "node": ">=16.20.2"
@@ -22,10 +22,9 @@
     "load-test-custom:stake-pool-query": "ts-node test/load-test-custom/stake-pool-search/stake-pool-search.test.ts",
     "load-test-custom:wallet-init": "ts-node test/load-test-custom/wallet-init/wallet-init.test.ts",
     "load-test-custom:wallet-restoration": "ts-node test/load-test-custom/wallet-restoration/wallet-restoration.test.ts",
-    "test": "shx echo 'test' command not implemented yet",
+    "test": "echo 'test' command not implemented yet",
     "test:blockfrost": "jest -c jest.config.js --forceExit --selectProjects blockfrost --runInBand --verbose",
     "test:utils": "jest -c jest.config.js --forceExit --selectProjects utils --verbose",
-    "test:load-testing": "jest -c jest.config.js --forceExit --selectProjects load-testing --runInBand --verbose",
     "test:long-running": "jest -c jest.config.js --forceExit --selectProjects long-running --runInBand --verbose",
     "test:local-network": "jest -c jest.config.js --forceExit --selectProjects local-network --runInBand --verbose",
     "test:projection": "jest -c jest.config.js --forceExit --selectProjects projection --runInBand --verbose",
@@ -45,7 +44,7 @@
     "test:web-extension:watch:run": "yarn test:web-extension:run --watch",
     "test:web-extension:watch": "run-s test:web-extension:build test:web-extension:watch:bg",
     "test:web-extension:watch:bg": "run-p test:web-extension:watch:build test:web-extension:watch:run",
-    "local-network:common": "DISABLE_DB_CACHE=${DISABLE_DB_CACHE:-true} USE_BLOCKFROST=false docker compose -p local-network-e2e -f docker-compose.yml -f ../../compose/common.yml $FILES up",
+    "local-network:common": "DISABLE_DB_CACHE=${DISABLE_DB_CACHE:-true} SUBMIT_API_ARGS='--testnet-magic 888' USE_BLOCKFROST=false docker compose -p local-network-e2e -f docker-compose.yml -f ../../compose/common.yml $FILES up",
     "local-network:up": "FILES='' yarn local-network:common",
     "local-network:dev": "FILES='-f ../../compose/dev.yml' yarn local-network:common",
     "local-network:profile:up": "FILES='-f ../../compose/pg-agent.yml' yarn local-network:common",
@@ -57,12 +56,12 @@
     "build:esm": "tsc -p src/tsconfig.json --outDir ./dist/esm --module es2020",
     "build:cjs": "tsc --build src",
     "build": "run-s build:cjs build:esm module-fixup",
-    "module-fixup": "shx cp ../../build/cjs-package.json ./dist/cjs/package.json && cp ../../build/esm-package.json ./dist/esm/package.json",
-    "tscNoEmit": "shx echo typescript --noEmit command not implemented yet",
-    "cleanup:dist": "shx rm -rf dist",
-    "cleanup:nm": "shx rm -rf node_modules",
+    "module-fixup": "cp ../../build/cjs-package.json ./dist/cjs/package.json && cp ../../build/esm-package.json ./dist/esm/package.json",
+    "tscNoEmit": "echo typescript --noEmit command not implemented yet",
+    "cleanup:dist": "rm -rf dist",
+    "cleanup:nm": "rm -rf node_modules",
     "cleanup": "run-s cleanup:dist cleanup:nm",
-    "coverage": "yarn test --coverage",
+    "coverage": "yarn test --coverage || true",
     "lint": "eslint --ignore-path ../../.eslintignore \"**/*.ts\"",
     "lint:fix": "eslint --fix --ignore-path ../../.eslintignore \"**/*.ts\"",
     "prepack": "yarn build",
@@ -81,20 +80,20 @@
   "dependencies": {
     "@cardano-foundation/ledgerjs-hw-app-cardano": "^6.0.0",
     "@cardano-ogmios/client": "5.6.0",
-    "@cardano-sdk/cardano-services": "~0.21.1",
-    "@cardano-sdk/cardano-services-client": "~0.14.3",
-    "@cardano-sdk/core": "~0.21.0",
-    "@cardano-sdk/crypto": "~0.1.15",
-    "@cardano-sdk/hardware-ledger": "~0.6.0",
-    "@cardano-sdk/hardware-trezor": "~0.2.0",
-    "@cardano-sdk/input-selection": "~0.12.3",
-    "@cardano-sdk/key-management": "~0.14.0",
-    "@cardano-sdk/ogmios": "~0.13.3",
-    "@cardano-sdk/tx-construction": "~0.14.1",
-    "@cardano-sdk/util": "~0.14.2",
-    "@cardano-sdk/util-dev": "~0.17.2",
-    "@cardano-sdk/util-rxjs": "~0.5.14",
-    "@cardano-sdk/wallet": "~0.25.0",
+    "@cardano-sdk/cardano-services": "~0.23.0",
+    "@cardano-sdk/cardano-services-client": "~0.15.0",
+    "@cardano-sdk/core": "~0.22.0",
+    "@cardano-sdk/crypto": "~0.1.16",
+    "@cardano-sdk/hardware-ledger": "~0.7.0",
+    "@cardano-sdk/hardware-trezor": "~0.3.0",
+    "@cardano-sdk/input-selection": "~0.12.5",
+    "@cardano-sdk/key-management": "~0.15.0",
+    "@cardano-sdk/ogmios": "~0.15.0",
+    "@cardano-sdk/tx-construction": "~0.15.0",
+    "@cardano-sdk/util": "~0.14.3",
+    "@cardano-sdk/util-dev": "~0.18.0",
+    "@cardano-sdk/util-rxjs": "~0.6.1",
+    "@cardano-sdk/wallet": "~0.26.0",
     "@dcspark/cardano-multiplatform-lib-nodejs": "^3.1.1",
     "@vespaiach/axios-fetch-adapter": "^0.3.0",
     "axios": "^0.27.2",
@@ -124,10 +123,10 @@
     "@babel/core": "^7.18.2",
     "@babel/preset-env": "^7.18.2",
     "@babel/preset-typescript": "^7.17.12",
-    "@cardano-sdk/dapp-connector": "~0.11.1",
-    "@cardano-sdk/projection": "~0.8.3",
-    "@cardano-sdk/projection-typeorm": "~0.5.3",
-    "@cardano-sdk/web-extension": "~0.16.2",
+    "@cardano-sdk/dapp-connector": "~0.11.2",
+    "@cardano-sdk/projection": "~0.10.0",
+    "@cardano-sdk/projection-typeorm": "~0.7.0",
+    "@cardano-sdk/web-extension": "~0.16.4",
     "@dcspark/cardano-multiplatform-lib-browser": "^3.1.1",
     "@emurgo/cardano-message-signing-asmjs": "^1.0.1",
     "@types/bunyan": "^1.8.8",
@@ -166,7 +165,6 @@
     "npm-run-all": "^4.1.5",
     "null-loader": "^4.0.1",
     "readable-stream": "^3.6.0",
-    "shx": "^0.3.3",
     "source-map-loader": "^4.0.1",
     "ts-jest": "^28.0.7",
     "typeorm": "^0.3.15",
@@ -180,5 +178,5 @@
     "webpack-cli": "^4.9.2",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "24b31813bb58d99263bdd13e881260089235f071"
+  "gitHead": "02a0eff7b7b7a3b98b42fd19b2ae85cfc4e7d87f"
 }

package/src/environment.ts

@@ -75,9 +75,7 @@ const providerParams = makeValidator((value) => {
   return validated;
 });
 
-/**
- * Shared across all tests
- */
+/** Shared across all tests */
 const validators = {
   ADDRESS_DISCOVERY: str({ default: 'HDSequentialDiscovery' }),
   ARRIVAL_PHASE_DURATION_IN_SECS: num(),
@@ -139,9 +137,7 @@ export const getEnv = <V extends readonly Validator[]>(
     [v in V[number]]: Validators[v] extends ValidatorSpec<infer T> ? T : never;
   };
 
-/**
- * Collection of all the configuration variables required by `getWallet`
- */
+/** Collection of all the configuration variables required by `getWallet` */
 export const walletVariables = [
   'ASSET_PROVIDER',
   'ASSET_PROVIDER_PARAMS',

package/src/factories.ts

@@ -284,10 +284,7 @@ export type GetWalletProps = {
   keyAgent?: AsyncKeyAgent;
 };
 
-/**
- * Delays initializing tx when nearing the epoch boundary.
- * Relies on system clock being accurate.
- */
+/** Delays initializing tx when nearing the epoch boundary. Relies on system clock being accurate. */
 const patchInitializeTxToRespectEpochBoundary = <T extends ObservableWallet>(
   wallet: T,
   maxPollInterval: Milliseconds
@@ -358,7 +355,16 @@ export const getWallet = async (props: GetWalletProps) => {
       ? () => Promise.resolve(keyAgent)
       : await keyManagementFactory.create(env.KEY_MANAGEMENT_PROVIDER, keyManagementParams, logger),
     createWallet: async (asyncKeyAgent: AsyncKeyAgent) =>
-      new PersonalWallet({ name, polling }, { ...providers, keyAgent: asyncKeyAgent, logger, stores }),
+      new PersonalWallet(
+        { name, polling },
+        {
+          ...providers,
+          addressManager: util.createBip32Ed25519AddressManager(asyncKeyAgent),
+          logger,
+          stores,
+          witnesser: util.createBip32Ed25519Witnesser(asyncKeyAgent)
+        }
+      ),
     logger
   });
 

package/src/measurement-util.ts

@@ -28,10 +28,7 @@ export type MeasurementResults<T extends string> = Record<T, MeasurementData>;
 export class MeasurementUtil<T extends string> {
   #performanceObserver: PerformanceObserver;
 
-  /**
-   * Starts observing performance measurements.
-   * Must be called before adding markers.
-   */
+  /** Starts observing performance measurements. Must be called before adding markers. */
   start(): void {
     this.#performanceObserver = new PerformanceObserver(() => {
       /* just an empty callback because we don't want to do anything when markers are added */

package/src/scripts/is-local-network-ready.ts

@@ -3,9 +3,7 @@ import { Pool, QueryResult } from 'pg';
 
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
-/**
- * Waits until the local network is ready or the wait time expires.
- */
+/** Waits until the local network is ready or the wait time expires. */
 (async () => {
   const { DB_SYNC_CONNECTION_STRING, LOCAL_NETWORK_READY_WAIT_TIME } = process.env;
 

package/src/scripts/mnemonic.ts

@@ -4,9 +4,7 @@ import * as Crypto from '@cardano-sdk/crypto';
 import { AddressType, InMemoryKeyAgent, util } from '@cardano-sdk/key-management';
 import { localNetworkChainId } from '../util';
 
-/**
- * Generates a new set of Mnemonic words and prints them to the console.
- */
+/** Generates a new set of Mnemonic words and prints them to the console. */
 (async () => {
   let mnemonic = '';
   const mnemonicArray = util.generateMnemonicWords();

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

@@ -6,9 +6,7 @@ export enum Paths {
   WalletUtxos = 'utxos'
 }
 
-/**
- * Functions to create/delete and read/write files and folders.
- */
+/** Functions to create/delete and read/write files and folders. */
 export const Files = {
   /**
    * This method is intended to concatenate individual strings into a single string that represents a file path.

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

@@ -2,9 +2,7 @@ import chalk from 'chalk';
 import cliSpinners from 'cli-spinners';
 import ora from 'ora';
 
-/**
- * The task result.
- */
+/** The task result. */
 export enum TaskResult {
   Success = 0,
   Fail = 1,
@@ -13,9 +11,7 @@ export enum TaskResult {
   None = 4
 }
 
-/**
- * Tracks progress of tasks in the terminal.
- */
+/** Tracks progress of tasks in the terminal. */
 export class TerminalProgressMonitor {
   #currentTask: ora.Ora | null = null;
 

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

@@ -249,9 +249,7 @@ export const logState = async (
  */
 export const randomFromInterval = (min: number, max: number) => Math.floor(Math.random() * (max - min + 1) + min);
 
-/**
- * Creates a folder name using a timestamp.
- */
+/** Creates a folder name using a timestamp. */
 export const getOutputPathName = () =>
   new Date().toISOString().replace(/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).*/, '$1_$2_$3_$4_$5_$6');
 

package/test/artillery/StakePoolSearch.ts

@@ -9,19 +9,13 @@ import { stakePoolHttpProvider } from '@cardano-sdk/cardano-services-client';
  * Hooks must record here the state of the session of current artillery virtual user
  */
 interface StakePoolSearchVars extends Paginated<Cardano.StakePool> {
-  /**
-   * The arguments used for the query; to repeat the same query, but next page, on next iteration
-   */
+  /** The arguments used for the query; to repeat the same query, but next page, on next iteration */
   args: QueryStakePoolsArgs;
 
-  /**
-   * `performQuery()` stores here if it gets an error from the query to let `moreResults()` knows when exit on error
-   */
+  /** `performQuery()` stores here if it gets an error from the query to let `moreResults()` knows when exit on error */
   gotError?: boolean;
 
-  /**
-   * The result of the health check performed at the beginning of virtual user session
-   */
+  /** The result of the health check performed at the beginning of virtual user session */
   healthCheckResult: boolean;
 }
 
@@ -30,15 +24,10 @@ const provider = stakePoolHttpProvider({ baseUrl: env.STAKE_POOL_PROVIDER_URL, l
 
 const PAGE_SIZE = 20;
 
-/**
- * The set of pools id found while getting results
- */
+/** The set of pools id found while getting results */
 const poolIds: Cardano.PoolId[] = [];
 
-/**
- * The artillery uid of the first artillery virtual user.
- * Used to track time of first request to measure cache efficiency
- */
+/** The artillery uid of the first artillery virtual user. Used to track time of first request to measure cache efficiency */
 let firstUser = '';
 
 /**