[ADP-3486] Add a simple bash script to generate random deposit payments

scripts/buildkite/release/push-to-bump.sh

@@ -13,7 +13,7 @@ else
 fi
 
 
-npm install [email protected].2
+npm install [email protected].4
 
 export PATH=$PWD/node_modules/.bin:$PATH
 

scripts/tx-gen/gen-deposits.sh

@@ -0,0 +1,183 @@
+#!/usr/bin/env bash
+
+usage () {
+  cat <<'EOF'
+Usage: ./gen-deposits.sh <tx-in> <utxo value> <change-address> <signing key file> [<max amount>]
+
+A naive script to generate and sign deposit transactions to random accounts in a wallet.
+
+Arguments:
+* <tx-in>: A transaction input containing ₳ to distribute funds from
+* <utxo value>: The value locked at tx-in, in lovelaces
+* <change-address>: Address to return change to. This is expected to be the same address
+  than the one the tx-in points to
+* <signing key file>: the signing key used to sign the transaction.
+* (optional) <max amount>: limit the total number of payments to given lovelace amount,
+  but still use <utxo value> to correctly compute change
+
+This script will try to accumulate as many payment outputs to some random accounts for
+a wallet whose root private key is in file 'root.prv' in a single transaction, until
+either the funds of the input tx-in (plus fees) run out or the size of the transaction
+goes above current protocol parameters limit.
+
+## Requirements
+
+The deposit outputs are computed from a file `root.prv` which is expected to be a
+root master signing key, eg. restored from mnemonics for example:
+
+```
+% cardano-address key from-recovery-phrase Shelley  <<< "..." > root.prv
+```
+
+The script also requires a 'protocol-params.json' in the current directory, which can
+be retrieved directly from the network with
+
+```
+cardano-wallet % cardano-cli conway query protocol-parameters --socket-path databases/node.socket --testnet-magic 1 > protocol-params.json
+```
+
+## Examples
+
+Generating a transaction with lots of outputs, assuming input UTxO has enough value:
+
+```
+ ./gen-deposits.sh '5896d53c996f437874d5e9edd56213021bae49dab1ef86ec3908b148ad009f99#0' 1000000000000 addr_test1vpf26vappzgz5zvjv362pzaag27c4dg4tu7qq7n07e686dsy5669m txgen.sk
+...
+built transaction with 212 outputs (15909B)
+built transaction with 213 outputs (15983B)
+built transaction with 214 outputs (16057B)
+tx too large
+build transaction 0: 164972f37d3efcf156ca6ef968b89395f39dd886425b64737bce9361fa2e4412
+remaining ₳895184
+```
+
+Generating a transaction given an input with not much value:
+
+```
+% ./gen-deposits.sh '5896d53c996f437874d5e9edd56213021bae49dab1ef86ec3908b148ad009f99#0' 10000000000 addr_test1vpf26vappzgz5zvjv362pzaag27c4dg4tu7qq7n07e686dsy5669m txgen.sk
+...
+built transaction with 15 outputs (1395B)
+built transaction with 16 outputs (1469B)
+Command failed: transaction build-estimate  Error: The transaction does not balance in its use of ada. The net balance of the transaction is negative: -60191857 Lovelace. The usual solution is to provide more inputs, or inputs with more ada.
+failed to build txs with 17 outputs
+build transaction 0: 4b1ff833e358093f8dad9eb96f7bf34621fc183da3b0e06a398decf3133e6d38
+remaining ₳860
+```
+
+Unless the script fails at the very first output it tries to add, it should always
+generate a `tx.0.signed` transaction that can be submitted.
+
+```
+% cardano-cli conway transaction submit --tx-file tx.0.signed --testnet-magic 1 --socket-path node.socket
+```
+
+EOF
+}
+
+if [[ $# -lt 4 ]]; then
+  usage
+  exit 2
+fi
+
+# generate random 32-bit numbers
+random_u32=$(dd if=/dev/urandom count=1000 bs=4 2> /dev/null | od -t u4  | tr -s ' ' | cut -d ' ' -f2)
+
+# start from a single tx input
+current_tx_in=$1
+
+# can be extracted from
+# cardano-cli conway query utxo  --address ${change_address} --testnet-magic 1 --socket-path node.socket| tail -n 1 | tr -s ' ' | cut -d ' ' -f 3
+total_utxo_value=$2
+
+change_address=$3
+signing_key_file=$4
+
+if [[ $# -eq 4 ]]; then
+  max_amount=${total_utxo_value}
+else
+  max_amount=$5
+
+  [[ ${max_amount} -lt ${total_utxo_value} ]] || {
+    echo "maximum amount (${max_amount}) should be lower than total UTxO value (${total_utxo_value})"
+    usage
+    exit 2
+  }
+fi
+
+declare current_adas
+declare current_addresses
+
+MAX_TX_SIZE=$(jq .maxTxSize protocol-params.json)
+
+tx_num=0
+
+if ls tx.*.signed > /dev/null 2>&1 ; then
+  # shellcheck disable=SC2012
+  last_signed_tx=$(ls tx.*.signed | sort -r -n -t '.' -k2 | head -1)
+  tx_num=$(( $(expr "$last_signed_tx" : 'tx.\(.*\).signed') + 1 ))
+fi
+
+try_building_tx () {
+  raw=tx.${tx_num}.raw
+  tmp_raw=${raw}.tmp
+  signed=tx.${tx_num}.signed
+  accumulated_deposits=0
+
+  args="--protocol-params-file protocol-params.json --shelley-key-witnesses 1 --change-address ${change_address} --out-file ${tmp_raw} --tx-in ${current_tx_in}"
+
+  for i in "${!current_adas[@]}"; do
+    args+=" --tx-out ${current_addresses[$i]}+$(( ${current_adas[$i]} * 1000000 ))"
+    accumulated_deposits=$(( accumulated_deposits + (current_adas[i] * 1000000) ))
+  done
+
+  args+=" --total-utxo-value ${total_utxo_value}"
+
+  num_utxo=${#current_addresses[@]}
+
+  # shellcheck disable=SC2086
+  if ! cardano-cli conway transaction build-estimate $args; then
+    return ${num_utxo}
+  elif [[ ${accumulated_deposits} -gt ${max_amount} ]] ; then
+    return ${num_utxo}
+  else
+    # shellcheck disable=SC2012
+    tx_size=$(ls -l ${tmp_raw} | tr -s ' ' | cut -d ' ' -f 5)
+
+    # check the size of the raw transaction
+    if [[ tx_size -gt $((MAX_TX_SIZE - 300)) ]]; then
+      return ${num_utxo}
+    else
+      cp ${tmp_raw} ${raw}
+      cardano-cli conway transaction sign --tx-file ${raw} --signing-key-file "${signing_key_file}" --testnet-magic 1 --out-file ${signed}
+    fi
+
+  fi
+}
+
+for r in $random_u32; do
+  # account id between 0 and 100000
+  acct_id=$((r % 10 ))
+
+  # derive public address
+  account_address=$(cardano-address key child "1857H/1815H/0H/0/${acct_id}" < root.prv | cardano-address key public --with-chain-code | cardano-address address payment --network-tag preprod)
+
+  # generate an amount of ADAT between 5 and 1000
+  rand=$(dd if=/dev/urandom count=4 bs=1 2> /dev/null | od -t u4 | tr -s ' ' | cut -d ' ' -f2 | head -1)
+  adas=$(( 50 + rand % 500 ))
+
+  current_adas+=( "$adas" )
+  current_addresses+=( "$account_address" )
+
+  # try to construct a tx paying to all current addresses
+  try_building_tx
+  num_utxo=$?
+  if [[ $num_utxo -gt 0 ]] ; then
+    signed=tx.${tx_num}.signed
+    tx_id=$(cardano-cli conway transaction txid --tx-file ${signed})
+    tx_num=$(( tx_num + 1 ))
+    total_utxo_value=$(cardano-cli debug transaction view --tx-file ${signed} | jq ".outputs[] | select ( .address == \"${change_address}\") | .amount.lovelace")
+    echo "${tx_id}#$(( num_utxo -1 )) ${total_utxo_value}"
+    # need to retry
+    break
+  fi
+done

scripts/tx-gen/gen-multiple-txs.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+# Generate multiple deposit transactions
+#
+# This script will call gen-deposit.sh in a loop, reusing its output to generate
+# more txs until the initial amount is exhausted.
+
+set -e
+
+[[ $# -eq 5 ]] || {
+    echo "Usage: $0 <tx-in> <amount> <address> <key file> <increment> <interval>"
+    exit 1
+}
+
+tx_in=$1
+amount=$2
+address=$3
+keyfile=$4
+increment=$5
+
+# Mean interval in seconds
+mean_interval=$6
+
+generate_exponential() {
+    rate=$(echo "1 / $mean_interval" | bc -l)
+
+    # Generate a random number between 0 and 1 using /dev/urandom
+    n=$(od -An -N4 -tu4 </dev/urandom)
+
+    u=$(echo "$n /  4294967295" | bc -l)
+
+    # Compute the exponential interval using the inverse CDF formula
+    interval=$(echo "-l(1 - $u) / $rate" | bc -l)
+    echo "$interval"
+}
+
+while [[ $amount -gt 1000000000 ]]; do
+    # shellcheck disable=SC2207
+    latest_tx=($(./gen-deposits.sh "$tx_in" "$amount" "$address" "$keyfile" "$increment"))
+    amount=${latest_tx[1]}
+    tx_in=${latest_tx[0]}
+    # shellcheck disable=SC2012
+    last_signed_tx=$(ls -1 tx.*.signed | sort -r -n -t '.' -k2 | head -1)
+
+    if ! cardano-cli conway transaction submit --tx-file "${last_signed_tx}" --testnet-magic 1 --socket-path node.socket; then
+        echo "Failed to submit ${last_signed_tx}"
+        exit 1
+    else
+        echo "Submitted ${last_signed_tx} :" "${latest_tx[@]}"
+    fi
+
+    sleep "$(generate_exponential)"
+done