Adapt end-to-end test for on-chain configuration parameters

mithril-test-lab/cardano-devnet/VERSION

@@ -1,2 +1,2 @@
-0.4.39
+0.4.40
 

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

@@ -37,6 +37,9 @@ SCRIPT_DIRECTORY=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd -P)
 # Generate the Mithril era scripts
 . ${SCRIPT_DIRECTORY}/mkfiles/mkfiles-mithril-era.sh
 
+# Generate the protocol configuration scripts
+. ${SCRIPT_DIRECTORY}/mkfiles/mkfiles-protocol-configuration.sh
+
 # Generate the Mithril payment scripts
 . ${SCRIPT_DIRECTORY}/mkfiles/mkfiles-mithril-payment.sh
 

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

@@ -0,0 +1,237 @@
+# Create Mithril protocol configuration keypair and address
+ADDR=protocol-config
+
+## Payment address keys
+$CARDANO_CLI "$CARDANO_CLI_ERA" address key-gen \
+    --verification-key-file addresses/${ADDR}.vkey \
+    --signing-key-file      addresses/${ADDR}.skey
+
+## Payment addresses
+$CARDANO_CLI "$CARDANO_CLI_ERA" address build \
+    --payment-verification-key-file addresses/${ADDR}.vkey \
+    --testnet-magic "${NETWORK_MAGIC}" \
+    --out-file addresses/${ADDR}.addr
+
+## Write datums for protocol configuration address
+N=1
+SCRIPT_TX_VALUE=7200000
+AMOUNT_TRANSFERRED=$(( SCRIPT_TX_VALUE * 10 ))
+MITHRIL_PROTOCOL_CONFIG_ERROR_FILE=./protocol-config-error
+cat >> protocol-configuration.sh <<EOF
+#!/usr/bin/env bash
+set -e
+
+# Wait for a number of blocks has elapsed
+function wait_for_elapsed_blocks {
+    CARDANO_BLOCK_OFFSET=\$1
+    CARDANO_NEXT_BLOCK_WAIT_ROUNDS_MAX=30
+    CARDANO_NEXT_BLOCK_WAIT_ROUNDS=1
+    CARDANO_NEXT_BLOCK_WAIT_ROUND_DELAY=2
+    CURRENT_CARDANO_BLOCK=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI $CARDANO_CLI_ERA query tip \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        | jq  -r '.block')
+    while true
+    do
+        CARDANO_BLOCK_TARGET=\$(( \${CURRENT_CARDANO_BLOCK} + \${CARDANO_BLOCK_OFFSET} ))
+        CARDANO_BLOCK=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI $CARDANO_CLI_ERA query tip \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        | jq  -r '.block')
+        if [ \$CARDANO_BLOCK -lt \$CARDANO_BLOCK_TARGET ] ; then
+            echo ">>>> Cardano target block not reached yet... [current: \$CARDANO_BLOCK, target: \$CARDANO_BLOCK_TARGET] [attempt \$CARDANO_NEXT_BLOCK_WAIT_ROUNDS]"
+            sleep \$CARDANO_NEXT_BLOCK_WAIT_ROUND_DELAY
+        else
+            echo ">>>> Cardano target block is reached [current: \$CARDANO_BLOCK, target: \$CARDANO_BLOCK_TARGET] [attempt \$CARDANO_NEXT_BLOCK_WAIT_ROUNDS]"
+            break
+        fi
+        CARDANO_NEXT_BLOCK_WAIT_ROUNDS=\$(( \$CARDANO_NEXT_BLOCK_WAIT_ROUNDS + 1 ))
+        if [ "\$CARDANO_NEXT_BLOCK_WAIT_ROUNDS" -gt "\$CARDANO_NEXT_BLOCK_WAIT_ROUNDS_MAX" ] ; then
+            echo ">>>> Timeout: Cardano target block was not reached within \$CARDANO_NEXT_BLOCK_WAIT_ROUNDS_MAX attempts"
+            exit 1
+        fi
+    done
+}
+
+# Send funds to protocol configuration address
+function send_funds_to_protocol_config_address {
+    # Remove if exists previous error file
+    rm -f ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE}
+
+    # Get current Cardano era
+    CURRENT_CARDANO_ERA=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI $CARDANO_CLI_ERA query tip \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        | jq  -r '.era |= ascii_downcase | .era')
+    echo ">>>> Current Cardano Era: \${CURRENT_CARDANO_ERA}"
+
+    # Get current Cardano block
+    CURRENT_CARDANO_BLOCK=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI $CARDANO_CLI_ERA query tip \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        | jq  -r '.block')
+    echo ">>>> Current Cardano Block: \${CURRENT_CARDANO_BLOCK}"
+
+    # Send funds to protocol configuration address
+    ## Get the UTxO of utxo${N}
+    TX_IN=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} query utxo \\
+        --testnet-magic ${NETWORK_MAGIC} --address \$(cat addresses/utxo${N}.addr) --out-file /dev/stdout \\
+        | jq  -r 'to_entries | [last] | .[0].key')
+
+    ## Build the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction build \\
+        --tx-in \${TX_IN} \\
+        --tx-out \$(cat addresses/${ADDR}.addr)+${AMOUNT_TRANSFERRED} \\
+        --change-address \$(cat addresses/utxo${N}.addr) \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --invalid-hereafter 100000 \\
+        --out-file node-pool${N}/tx/tx${N}-protocol-config-funds.txbody
+
+    ## Sign the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction sign \\
+        --signing-key-file addresses/utxo${N}.skey \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --tx-body-file  node-pool${N}/tx/tx${N}-protocol-config-funds.txbody \\
+        --out-file      node-pool${N}/tx/tx${N}-protocol-config-funds.tx
+
+    ## Submit the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction submit \\
+        --tx-file node-pool${N}/tx/tx${N}-protocol-config-funds.tx \\
+        --testnet-magic ${NETWORK_MAGIC}
+
+    ## Compute the submitted transaction id
+    TX_ID_SUBMITTED=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction txid --tx-file node-pool${N}/tx/tx${N}-protocol-config-funds.tx)
+    if [[ "\${TX_ID_SUBMITTED}" =~ txhash ]]; then
+        TX_ID_SUBMITTED=\$(echo \$TX_ID_SUBMITTED | jq -r '.txhash')
+    fi
+
+    ## Wait at least for 10 blocks so that the transaction is confirmed
+    wait_for_elapsed_blocks 10
+
+    ## Wait for all pool nodes to see the new transaction
+    for (( i=1; i<=${NUM_POOL_NODES}; i++ )); do
+        TOTAL_UTXOS_FOR_TX_ID=\$(CARDANO_NODE_SOCKET_PATH=node-pool\${i}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} query utxo \\
+        --testnet-magic ${NETWORK_MAGIC} --address \$(cat addresses/${ADDR}.addr) --out-file /dev/stdout \\
+        | jq '. | with_entries(select(.key | startswith("${TX_ID_SUBMITTED}"))) | length')
+        echo ">>>>>> Protocol configuration address funds retrieved on node-pool\${i}: \${TOTAL_UTXOS_FOR_TX_ID}"
+        if [ "\${TOTAL_UTXOS_FOR_TX_ID}" == "0" ]; then
+            touch ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE}
+            break
+        fi
+    done
+}
+
+# Try to send funds to protocol configuration address
+function try_send_funds_to_protocol_config_address {
+    SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX=10
+    SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS=1
+    SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUND_DELAY=2
+    while true
+    do
+        send_funds_to_protocol_config_address
+        if [ -f ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE} ]; then
+            echo ">>>> Funds not transferred successfully to protocol configuration address, a rollback has happened [attempt \$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS]!"
+            sleep \$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUND_DELAY
+        else
+            echo ">>>> Funds transferred successfully to protocol configuration address [attempt \$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS]!"
+            break
+        fi
+        SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS=\$(( \$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS + 1 ))
+        if [ "\$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS" -gt "\$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX" ] ; then
+            echo ">>>> Timeout: Funds were not transferred successfully to protocol configuration address within \$SEND_FUNDS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX attempts"
+            exit 1
+        fi
+    done
+}
+
+# Write datums for protocol configuration address
+function write_datums_for_protocol_config_address {
+    # Remove if exists previous error file
+    rm -f ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE}
+
+    # Fetch transactions from UTxOs of the protocol configuration address
+    TX_IN_DATUM=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} query utxo \\
+        --testnet-magic ${NETWORK_MAGIC} --address \$(cat addresses/${ADDR}.addr) --out-file /dev/stdout \\
+        | jq -r 'to_entries | map({utxo: .key} + .value) | . [] | select(.inlineDatum | . != null and . != "") | .utxo')
+    TX_IN_NO_DATUM=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} query utxo \\
+        --testnet-magic ${NETWORK_MAGIC} --address \$(cat addresses/${ADDR}.addr) --out-file /dev/stdout \\
+        | jq  -r 'to_entries | [last] | .[0].key')
+
+    ## Build the transaction
+    if [ "\${TX_IN_DATUM}" == "" ]; then
+        CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction build \\
+            --tx-in \${TX_IN_NO_DATUM} \\
+            --tx-out \$(cat addresses/${ADDR}.addr)+${SCRIPT_TX_VALUE} \\
+            --tx-out-inline-datum-file \${PROTOCOL_CONFIG_DATUM_FILE} \\
+            --change-address \$(cat addresses/${ADDR}.addr) \\
+            --testnet-magic ${NETWORK_MAGIC} \\
+            --invalid-hereafter 100000 \\
+            --out-file node-pool${N}/tx/tx${N}-protocol-configuration-datum.txbody
+    else
+        CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction build \\
+            --tx-in \${TX_IN_DATUM} \\
+            --tx-in \${TX_IN_NO_DATUM} \\
+            --tx-out \$(cat addresses/${ADDR}.addr)+${SCRIPT_TX_VALUE} \\
+            --tx-out-inline-datum-file \${PROTOCOL_CONFIG_DATUM_FILE} \\
+            --change-address \$(cat addresses/${ADDR}.addr) \\
+            --testnet-magic ${NETWORK_MAGIC} \\
+            --invalid-hereafter 100000 \\
+            --out-file node-pool${N}/tx/tx${N}-protocol-configuration-datum.txbody
+    fi
+
+    ## Sign the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction sign \\
+        --signing-key-file addresses/${ADDR}.skey \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --tx-body-file  node-pool${N}/tx/tx${N}-protocol-configuration-datum.txbody \\
+        --out-file      node-pool${N}/tx/tx${N}-protocol-configuration-datum.tx
+
+    ## Submit the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} transaction submit \\
+        --tx-file node-pool${N}/tx/tx${N}-protocol-configuration-datum.tx \\
+        --testnet-magic ${NETWORK_MAGIC}
+
+    ## Wait at least for 10 blocks so that the transaction is confirmed
+    wait_for_elapsed_blocks 10
+
+    ## Wait for all pool nodes to see the new protocol configuration datum
+    for (( i=1; i<=${NUM_POOL_NODES}; i++ )); do
+        INLINE_DATUM=\$(CARDANO_NODE_SOCKET_PATH=node-pool\${i}/ipc/node.sock $CARDANO_CLI \${CURRENT_CARDANO_ERA} query utxo \\
+        --testnet-magic ${NETWORK_MAGIC} --address \$(cat addresses/${ADDR}.addr) --out-file /dev/stdout \\
+        | jq  -r '. [] | select(.inlineDatum | . != null and . != "") | .inlineDatum.fields[].bytes' | xxd -r -p | jq)
+        echo ">>>>>> Protocol configuration address inline datum retrieved on node-pool\${i}: \${INLINE_DATUM}"
+        if [ "\${INLINE_DATUM}" == "" ]; then
+            touch ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE}
+            break
+        fi
+    done
+}
+
+# Try to write datums for protocol configuration address
+function try_write_datums_for_protocol_config_address {
+    WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX=10
+    WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS=1
+    WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUND_DELAY=2
+    while true
+    do
+        write_datums_for_protocol_config_address
+        if [ -f ${MITHRIL_PROTOCOL_CONFIG_ERROR_FILE} ]; then
+            echo ">>>> Datums not written successfully for protocol configuration address, a rollback has happened [attempt \$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS]!"
+            sleep \$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUND_DELAY
+        else
+            echo ">>>> Datums successfully written for protocol configuration address [attempt \$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS]!"
+            break
+        fi
+        WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS=\$(( \$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS + 1 ))
+        if [ "\$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS" -gt "\$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX" ] ; then
+            echo ">>>> Timeout: Datums were not written successfully for protocol configuration address within \$WRITE_DATUMS_PROTOCOL_CONFIG_ADDRESS_WAIT_ROUNDS_MAX attempts"
+            exit 1
+        fi
+    done
+}
+
+# Try to send funds to protocol configuration address
+try_send_funds_to_protocol_config_address
+
+# Try to write datums for protocol configuration address
+try_write_datums_for_protocol_config_address
+
+EOF
+
+chmod u+x protocol-configuration.sh

mithril-test-lab/mithril-end-to-end/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-end-to-end"
-version = "0.5.13"
+version = "0.5.14"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-test-lab/mithril-end-to-end/backward-compatibility.md

@@ -32,11 +32,13 @@ format is: `- **since 'X.Y.Z' (distribution version) [to 'X.Y.Z' (distribution v
 - **since `0.12.11` (2524.0)**: removal of `cardano-db-v2` replaced with `cardano-db [command] --backend [v1,v2]`
 - **since `0.11.14` (2517.0)**: addition of `--include-ancillary` flag to `cardano-db download`
 - **since `0.11.13` (2517.0)**: addition of global `--origin-tag` parameter
+- **since `1.2.0` (next to 2630.0)**: support of on cardano on-chain protocol parameters
 
 ### Mithril aggregator
 
 - **since `0.8.34`**: addition of `--mithril-era` flag to `genesis bootstrap` command
 - **since `0.7.94` (next to 2543.1)**: only the leader aggregator must be restarted when updating protocol parameters
+- **since `0.10.0` (next to 2630.0)**: support of on cardano on-chain protocol parameters
 
 ### Mithril signer
 

mithril-test-lab/mithril-end-to-end/src/devnet/runner.rs

@@ -199,6 +199,20 @@ impl Devnet {
             .with_context(|| "Failed to read mithril era marker address file")
     }
 
+    pub fn protocol_configuration_marker_address_path(&self) -> PathBuf {
+        self.artifacts_dir.join("addresses").join("protocol-config.addr")
+    }
+
+    pub fn protocol_configuration_marker_address(&self) -> StdResult<String> {
+        let mut marker_address_file =
+            File::open(self.protocol_configuration_marker_address_path())?;
+        let mut marker_address_buffer = Vec::new();
+        marker_address_file.read_to_end(&mut marker_address_buffer)?;
+
+        String::from_utf8(marker_address_buffer)
+            .with_context(|| "Failed to read protocol configuration marker address file")
+    }
+
     pub fn mithril_payments_transaction_hashes_path(&self) -> PathBuf {
         self.artifacts_dir.join("transaction-hashes.txt")
     }
@@ -371,6 +385,31 @@ impl Devnet {
         }
     }
 
+    pub async fn write_protocol_configuration_markers(&self, target_path: &Path) -> StdResult<()> {
+        let run_script = "protocol-configuration.sh";
+        let run_script_path = self.artifacts_dir.join(run_script);
+        let mut run_command = self.build_command(&run_script_path)?;
+        run_command.env("PROTOCOL_CONFIG_DATUM_FILE", target_path.to_str().unwrap());
+
+        info!("Writing protocol configuration markers on chain"; "script" => &run_script_path.display());
+
+        let status = run_command
+            .spawn()
+            .with_context(|| "Failed to write protocol configuration markers on chain")?
+            .wait_forwarding_output_to_slog_scope(run_script)
+            .await
+            .with_context(|| "Error while writing protocol configuration markers on chain")?;
+        match status.code() {
+            Some(0) => Ok(()),
+            Some(code) => Err(anyhow!(RetryableDevnetError(format!(
+                "Write protocol configuration markers on chain exited with status code: {code}"
+            )))),
+            None => Err(anyhow!(
+                "Write protocol configuration markers on chain terminated by signal"
+            )),
+        }
+    }
+
     pub async fn transfer_funds(&self) -> StdResult<()> {
         let run_script = "payment-mithril.sh";
         let run_script_path = self.artifacts_dir.join(run_script);