Rename 'ROOT' to 'ARTIFACTS_DIR' in devnet

Author: jpraynaud

mithril-test-lab/mithril-devnet/README.md

@@ -90,39 +90,39 @@ NODES=mithril ./devnet-query.sh
 
 ```bash
 # Run devnet with 2 BFT nodes and 5 SPO nodes
-ROOT=artifacts NUM_BFT_NODES=2 NUM_POOL_NODES=5 ./devnet-run.sh
+ARTIFACTS_DIR=artifacts NUM_BFT_NODES=2 NUM_POOL_NODES=5 ./devnet-run.sh
 
 # Run devnet custom slot length (0.5s) and custom epoch length (120s)
 # Slot length: the duration of a Cardano Eslot (can help modulate the immutables creation rate)
 # Epoch Length: the duration of a Cardano Epoch
-ROOT=artifacts SLOT_LENGTH=0.5 EPOCH_LENGTH=120 ./devnet-run.sh
+ARTIFACTS_DIR=artifacts SLOT_LENGTH=0.5 EPOCH_LENGTH=120 ./devnet-run.sh
 
 # Logs devnet
-ROOT=artifacts LINES=10 ./devnet-log.sh
+ARTIFACTS_DIR=artifacts LINES=10 ./devnet-log.sh
 
 # Query devnet
-ROOT=artifacts ./devnet-query.sh
+ARTIFACTS_DIR=artifacts ./devnet-query.sh
 
 # Stop devnet
-ROOT=artifacts ./devnet-stop.sh
+ARTIFACTS_DIR=artifacts ./devnet-stop.sh
 
 # Visualize devnet
-ROOT=artifacts ./devnet-visualize.sh
+ARTIFACTS_DIR=artifacts ./devnet-visualize.sh
 ```
 
 ## Step by step run with custom configuration
 
 ```bash
 # Parameters
-ROOT=artifacts # Directory where artifacts are produced
+ARTIFACTS_DIR=artifacts # Directory where artifacts are produced
 NUM_BFT_NODES=1 # Number of Cardano BFT nodes
 NUM_POOL_NODES=3 # Number of Cardano SPO nodes
 
 # Bootstrap devnet with 1 BFT nodes and 3 SPO nodes
-rm -rf ${ROOT} && ./devnet-mkfiles.sh ${ROOT} ${NUM_BFT_NODES} ${NUM_POOL_NODES}
+rm -rf ${ARTIFACTS_DIR} && ./devnet-mkfiles.sh ${ARTIFACTS_DIR} ${NUM_BFT_NODES} ${NUM_POOL_NODES}
 
 # Change directory
-cd ${ROOT}
+cd ${ARTIFACTS_DIR}
 
 # Start devnet Cardano nodes
 ./start-cardano.sh

mithril-test-lab/mithril-devnet/devnet-log.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
 # Default values
-if [ -z "${ROOT}" ]; then 
-  ROOT="artifacts"
+if [ -z "${ARTIFACTS_DIR}" ]; then 
+  ARTIFACTS_DIR="artifacts"
 fi
 if [ -z "${LINES}" ]; then 
   LINES="10"
@@ -12,7 +12,7 @@ if [ -z "${NODES}" ]; then
 fi
 
 # Change directory
-cd ${ROOT}
+cd ${ARTIFACTS_DIR}
 
 # Logs devnet
 echo "====================================================================="

mithril-test-lab/mithril-devnet/devnet-query.sh

@@ -1,15 +1,15 @@
 #!/usr/bin/env bash
 
 # Default values
-if [ -z "${ROOT}" ]; then 
-  ROOT="artifacts"
+if [ -z "${ARTIFACTS_DIR}" ]; then 
+  ARTIFACTS_DIR="artifacts"
 fi
 if [ -z "${NODES}" ]; then 
   NODES="*"
 fi
 
 # Change directory
-cd ${ROOT}
+cd ${ARTIFACTS_DIR}
 
 # Query devnet
 echo "====================================================================="

mithril-test-lab/mithril-devnet/devnet-run.sh

@@ -5,11 +5,11 @@ set -e
 if [ -z "${NODES}" ]; then 
   NODES="*"
 fi
-if [ -z "${ROOT}" ]; then 
-  ROOT="artifacts"
+if [ -z "${ARTIFACTS_DIR}" ]; then 
+  ARTIFACTS_DIR="artifacts"
 fi
-if [ -z "${FORCE_DELETE_ROOT_DIRECTORY}" ]; then 
-  FORCE_DELETE_ROOT_DIRECTORY="true"
+if [ -z "${FORCE_DELETE_ARTIFACTS_DIR}" ]; then 
+  FORCE_DELETE_ARTIFACTS_DIR="true"
 fi
 if [ -z "${DELEGATE_PERIOD}" ]; then 
   DELEGATE_PERIOD="180"
@@ -21,15 +21,15 @@ echo "====================================================================="
 echo " Bootstrap Mithril/Cardano devnet"
 echo "====================================================================="
 echo
-if [[ "$FORCE_DELETE_ROOT_DIRECTORY" == "true" ]]; then
-  echo ">> The ${ROOT} directory was force deleted"
-  rm -rf ${ROOT} > /dev/null
+if [[ "$FORCE_DELETE_ARTIFACTS_DIR" == "true" ]]; then
+  echo ">> The ${ARTIFACTS_DIR} directory was force deleted"
+  rm -rf ${ARTIFACTS_DIR} > /dev/null
 fi
-ROOT=${ROOT} $(pwd)/devnet-mkfiles.sh
+ARTIFACTS_DIR=${ARTIFACTS_DIR} $(pwd)/devnet-mkfiles.sh
 echo
 
 # Change directory
-pushd ${ROOT} > /dev/null
+pushd ${ARTIFACTS_DIR} > /dev/null
 
 # Start devnet Cardano nodes
 if [ "${NODES}" = "cardano" ] || [ "${NODES}" = "*" ]; then 

mithril-test-lab/mithril-devnet/devnet-stop.sh

@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 
 # Default values
-if [ -z "${ROOT}" ]; then 
-  ROOT="artifacts"
+if [ -z "${ARTIFACTS_DIR}" ]; then 
+  ARTIFACTS_DIR="artifacts"
 fi
 
 # Change directory
-cd ${ROOT}
+cd ${ARTIFACTS_DIR}
 
 # Stop devnet
 echo "====================================================================="

mithril-test-lab/mithril-devnet/devnet-visualize.sh

@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 
 # Default values
-if [ -z "${ROOT}" ]; then 
-  ROOT="artifacts"
+if [ -z "${ARTIFACTS_DIR}" ]; then 
+  ARTIFACTS_DIR="artifacts"
 fi
 
 # Change directory
-cd ${ROOT}
+cd ${ARTIFACTS_DIR}
 
 # Stop devnet
 echo "====================================================================="

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-cardano.sh

@@ -1,5 +1,5 @@
-ROOT_TEMP=./temp
-mkdir -p ${ROOT_TEMP}
+ARTIFACTS_DIR_TEMP=./temp
+mkdir -p ${ARTIFACTS_DIR_TEMP}
 
 # Step 1: Bootstrap the devnet artifacts
 # Adapted from https://github.com/IntersectMBO/cardano-node/blob/master/scripts/babbage/mkfiles.sh
@@ -29,7 +29,7 @@ START_GENESIS_DELAY=1
 
 START_TIME="$(${DATE} -d "now + ${START_GENESIS_DELAY} seconds" +%s)"
 
-cat > "${ROOT_TEMP}/byron.genesis.spec.json" <<EOF
+cat > "${ARTIFACTS_DIR_TEMP}/byron.genesis.spec.json" <<EOF
 {
   "heavyDelThd":     "300000000000",
   "maxBlockSize":    "2000000",
@@ -65,17 +65,17 @@ $CARDANO_CLI byron genesis genesis \
   --delegate-share 1 \
   --avvm-entry-count 0 \
   --avvm-entry-balance 0 \
-  --protocol-parameters-file "${ROOT_TEMP}/byron.genesis.spec.json" \
-  --genesis-output-dir "${ROOT_TEMP}/byron-gen-command"
+  --protocol-parameters-file "${ARTIFACTS_DIR_TEMP}/byron.genesis.spec.json" \
+  --genesis-output-dir "${ARTIFACTS_DIR_TEMP}/byron-gen-command"
 
-cp $SCRIPT_DIRECTORY/configuration/babbage/alonzo-babbage-test-genesis.json "${ROOT_TEMP}/genesis.alonzo.spec.json"
-cp $SCRIPT_DIRECTORY/configuration/babbage/conway-babbage-test-genesis.json "${ROOT_TEMP}/genesis.conway.spec.json"
+cp $SCRIPT_DIRECTORY/configuration/babbage/alonzo-babbage-test-genesis.json "${ARTIFACTS_DIR_TEMP}/genesis.alonzo.spec.json"
+cp $SCRIPT_DIRECTORY/configuration/babbage/conway-babbage-test-genesis.json "${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json"
 
 # Fix 8.1.2, to avoid the following error: 'Command failed: genesis create-staked  Error: Error while decoding Shelley genesis at: example/genesis.conway.spec.json Error: Error in $: key "genDelegs" not found'
-mv ${ROOT_TEMP}/genesis.conway.spec.json ${ROOT_TEMP}/genesis.conway.spec.json.tmp && cat ${ROOT_TEMP}/genesis.conway.spec.json.tmp | jq '. += {"genDelegs":{}}' > ${ROOT_TEMP}/genesis.conway.spec.json && rm ${ROOT_TEMP}/genesis.conway.spec.json.tmp
+mv ${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json ${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json.tmp && cat ${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json.tmp | jq '. += {"genDelegs":{}}' > ${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json && rm ${ARTIFACTS_DIR_TEMP}/genesis.conway.spec.json.tmp
 
-cp $SCRIPT_DIRECTORY/configuration/byron/configuration.yaml "${ROOT_TEMP}/"
-$SED -i "${ROOT_TEMP}/configuration.yaml" \
+cp $SCRIPT_DIRECTORY/configuration/byron/configuration.yaml "${ARTIFACTS_DIR_TEMP}/"
+$SED -i "${ARTIFACTS_DIR_TEMP}/configuration.yaml" \
      -e 's/Protocol: RealPBFT/Protocol: Cardano/' \
      -e '/Protocol/ aPBftSignatureThreshold: 0.6' \
      -e 's/minSeverity: Info/minSeverity: Info/' \
@@ -94,15 +94,15 @@ $SED -i "${ROOT_TEMP}/configuration.yaml" \
      -e 's/LastKnownBlockVersion-Major: 0/LastKnownBlockVersion-Major: 6/' \
      -e 's/LastKnownBlockVersion-Minor: 2/LastKnownBlockVersion-Minor: 0/'
 
-echo "TestShelleyHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "TestAllegraHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "TestMaryHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "TestAlonzoHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "TestBabbageHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "TestConwayHardForkAtEpoch: 0" >> "${ROOT_TEMP}/configuration.yaml"
-echo "ExperimentalProtocolsEnabled: True" >> "${ROOT_TEMP}/configuration.yaml"
+echo "TestShelleyHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "TestAllegraHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "TestMaryHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "TestAlonzoHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "TestBabbageHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "TestConwayHardForkAtEpoch: 0" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
+echo "ExperimentalProtocolsEnabled: True" >> "${ARTIFACTS_DIR_TEMP}/configuration.yaml"
 
-$CARDANO_CLI genesis create-staked --genesis-dir "${ROOT_TEMP}" \
+$CARDANO_CLI genesis create-staked --genesis-dir "${ARTIFACTS_DIR_TEMP}" \
   --testnet-magic "${NETWORK_MAGIC}" \
   --gen-pools ${NUM_SPO_NODES} \
   --supply ${TOTAL_SUPPLY} \
@@ -111,42 +111,42 @@ $CARDANO_CLI genesis create-staked --genesis-dir "${ROOT_TEMP}" \
   --gen-utxo-keys ${NUM_SPO_NODES}
 
 ## Customize the Shelley genesis file
-cat ${ROOT_TEMP}/genesis.json | jq --argjson slot_length ${SLOT_LENGTH} --argjson epoch_length ${EPOCH_LENGTH} --argjson security_param ${SECURITY_PARAM} '. + {slotLength: $slot_length, activeSlotsCoeff: 0.50, securityParam: $security_param, epochLength: $epoch_length, maxLovelaceSupply: 10000000000000, updateQuorum: 2}' > ${ROOT_TEMP}/genesis.json.tmp
-cat ${ROOT_TEMP}/genesis.json.tmp | jq --raw-output '.protocolParams.protocolVersion.major = 7 | .protocolParams.minFeeA = 44 | .protocolParams.minFeeB = 155381 | .protocolParams.minUTxOValue = 1000000 | .protocolParams.decentralisationParam = 0.7 | .protocolParams.rho = 0.1 | .protocolParams.tau = 0.1'  > ${ROOT_TEMP}/genesis.json
-rm ${ROOT_TEMP}/genesis.json.tmp
+cat ${ARTIFACTS_DIR_TEMP}/genesis.json | jq --argjson slot_length ${SLOT_LENGTH} --argjson epoch_length ${EPOCH_LENGTH} --argjson security_param ${SECURITY_PARAM} '. + {slotLength: $slot_length, activeSlotsCoeff: 0.50, securityParam: $security_param, epochLength: $epoch_length, maxLovelaceSupply: 10000000000000, updateQuorum: 2}' > ${ARTIFACTS_DIR_TEMP}/genesis.json.tmp
+cat ${ARTIFACTS_DIR_TEMP}/genesis.json.tmp | jq --raw-output '.protocolParams.protocolVersion.major = 7 | .protocolParams.minFeeA = 44 | .protocolParams.minFeeB = 155381 | .protocolParams.minUTxOValue = 1000000 | .protocolParams.decentralisationParam = 0.7 | .protocolParams.rho = 0.1 | .protocolParams.tau = 0.1'  > ${ARTIFACTS_DIR_TEMP}/genesis.json
+rm ${ARTIFACTS_DIR_TEMP}/genesis.json.tmp
 
 # Step 2: Dispatch artifacts in the correct directories
 
 ## Copy the configuration files
 for NODE in ${ALL_NODES}; do
-  cp ${ROOT_TEMP}/configuration.yaml ${NODE}/
+  cp ${ARTIFACTS_DIR_TEMP}/configuration.yaml ${NODE}/
 done
 
 ## Copy the Byron genesis files
 for NODE in ${ALL_NODES}; do
-  cp ${ROOT_TEMP}/byron-gen-command/genesis.json ${NODE}/byron/
-  cp ${ROOT_TEMP}/genesis.spec.json ${NODE}/byron/
+  cp ${ARTIFACTS_DIR_TEMP}/byron-gen-command/genesis.json ${NODE}/byron/
+  cp ${ARTIFACTS_DIR_TEMP}/genesis.spec.json ${NODE}/byron/
 done
 
 ## Copy the Byron delegation artifacts
 for N in ${POOL_NODES_N}; do
-  cp ${ROOT_TEMP}/byron-gen-command/delegate-keys.00$((${N} - 1)).key node-pool${N}/byron/delegate.key
-  cp ${ROOT_TEMP}/byron-gen-command/delegation-cert.00$((${N} - 1)).json node-pool${N}/byron/delegate.cert
+  cp ${ARTIFACTS_DIR_TEMP}/byron-gen-command/delegate-keys.00$((${N} - 1)).key node-pool${N}/byron/delegate.key
+  cp ${ARTIFACTS_DIR_TEMP}/byron-gen-command/delegation-cert.00$((${N} - 1)).json node-pool${N}/byron/delegate.cert
 done
 
 ## Copy the Shelley genesis files
 for NODE in ${ALL_NODES}; do
-  cp ${ROOT_TEMP}/genesis*.json ${NODE}/shelley/
+  cp ${ARTIFACTS_DIR_TEMP}/genesis*.json ${NODE}/shelley/
 done
 
 ## Copy the SPO artifacts
 for N in ${POOL_NODES_N}; do
-  cp ${ROOT_TEMP}/pools/vrf${N}.skey node-pool${N}/shelley/vrf.skey
-  cp ${ROOT_TEMP}/pools/vrf${N}.vkey node-pool${N}/shelley/vrf.vkey
-  cp ${ROOT_TEMP}/pools/cold${N}.skey node-pool${N}/shelley/cold.skey
-  cp ${ROOT_TEMP}/pools/cold${N}.vkey node-pool${N}/shelley/cold.vkey
-  cp ${ROOT_TEMP}/pools/kes${N}.skey node-pool${N}/shelley/kes.skey
-  cp ${ROOT_TEMP}/pools/kes${N}.vkey node-pool${N}/shelley/kes.vkey
-  cp ${ROOT_TEMP}/pools/opcert${N}.counter node-pool${N}/shelley/opcert.counter  
-  cp ${ROOT_TEMP}/pools/opcert${N}.cert node-pool${N}/shelley/opcert.cert  
+  cp ${ARTIFACTS_DIR_TEMP}/pools/vrf${N}.skey node-pool${N}/shelley/vrf.skey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/vrf${N}.vkey node-pool${N}/shelley/vrf.vkey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/cold${N}.skey node-pool${N}/shelley/cold.skey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/cold${N}.vkey node-pool${N}/shelley/cold.vkey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/kes${N}.skey node-pool${N}/shelley/kes.skey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/kes${N}.vkey node-pool${N}/shelley/kes.vkey
+  cp ${ARTIFACTS_DIR_TEMP}/pools/opcert${N}.counter node-pool${N}/shelley/opcert.counter  
+  cp ${ARTIFACTS_DIR_TEMP}/pools/opcert${N}.cert node-pool${N}/shelley/opcert.cert  
 done

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-init.sh

@@ -25,8 +25,7 @@ if [ -z "${LISTENING_ADDR}" ]; then
 fi
 
 # Display configuration summary
-echo ">> Directory: ${ROOT}"
-echo ">> Nodes: ${NODES}"
+echo ">> Artifacts Directory: ${ARTIFACTS_DIR}"
 echo ">> Cardano Node Version: ${CARDANO_NODE_VERSION}"
 echo ">> Cardano Network Magic: ${NETWORK_MAGIC}"
 echo ">> Cardano BFT nodes: ${NUM_BFT_NODES}"
@@ -37,8 +36,8 @@ echo ">> Cardano Delegation Period: ${DELEGATE_PERIOD}s"
 echo ">> Cardano Listening Address: ${LISTENING_ADDR}"
 
 # Check if root directory already exists
-if ! mkdir -p "${ROOT}"; then
-  echo ">> The ${ROOT} directory already exists, please move or remove it"
+if ! mkdir -p "${ARTIFACTS_DIR}"; then
+  echo "The ${ARTIFACTS_DIR} directory already exists, please move or remove it"
   exit
 fi
 
@@ -51,7 +50,7 @@ if [[ "$SKIP_CARDANO_BIN_DOWNLOAD" != "true" ]]; then
 fi
 
 # And copy cardano-cli & cardano-node
-cp cardano-cli ${ROOT}/cardano-cli
-cp cardano-node ${ROOT}/cardano-node
+cp cardano-cli ${ARTIFACTS_DIR}/cardano-cli
+cp cardano-node ${ARTIFACTS_DIR}/cardano-node
 
-pushd ${ROOT} > /dev/null
+pushd ${ARTIFACTS_DIR} > /dev/null