Merge pull request #1431 from input-output-hk/jpraynaud/1428-use-cardano-chain-era-reader-devnet

Use `CardanoChain` era reader in end to end test

Author: jpraynaud

Cargo.lock

@@ -49,7 +49,7 @@ $ TX_IN=f0c0345f151f9365fbbb4e7afa217e56b987d9e91fd754ca609d9dfec97275c7#0
 
 Create the initial datum file:
 ```bash
-$ ./mithril-aggregator era generate-tx-datum --current-era-epoch 1 --era-markers-secret-key $ERA_ACTIVATION_SECRET_KEY > $ASSETS_PATH/mithril-era-datum-1.json
+$ ./mithril-aggregator era generate-tx-datum --current-era-epoch 1 --era-markers-secret-key $ERA_ACTIVATION_SECRET_KEY --target-path $ASSETS_PATH/mithril-era-datum-1.json
 ```
 
 Now create the bootstrap transaction with datum:
@@ -150,7 +150,7 @@ Create the updated datum file:
 :warning: The options provided in the following command are for example only, you need to use adequately the options of the `era generate-tx-datum` command, which will depend on the operation you want to execute: announce an upcoming era or activate an upcoming era. This operation should be done very cautiously as a misconfiguration can lead to disturbed service of the network.
 
 ```bash
-$ ./mithril-aggregator era generate-tx-datum --current-era-epoch 1 --era-markers-secret-key $ERA_ACTIVATION_SECRET_KEY > $ASSETS_PATH/mithril-era-datum-2.json
+$ ./mithril-aggregator era generate-tx-datum --current-era-epoch 1 --era-markers-secret-key $ERA_ACTIVATION_SECRET_KEY --target-path $ASSETS_PATH/mithril-era-datum-2.json
 ```
 
 Now create the update transaction with datum:

docs/runbook/era-markers/README.md

@@ -300,7 +300,7 @@ You can run 'era generate-tx-datum' to create the transaction datum file that wi
 **Case 1**: If there is only one supported era in the code, create the datum file:
 
 ```bash
-./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY**
+./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY** --target-path **TARGET_PATH**
 ```
 
 You should see something like:
@@ -312,13 +312,13 @@ You should see something like:
 **Case 2**: If there are two supported eras in the code and the activation epoch of the upcoming era is not yet known, run the command:
 
 ```bash
-./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY**
+./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY** --target-path **TARGET_PATH**
 ```
 
 **Case 3**: If there are two supported eras in the code and the activation epoch of the era switch is known to be at the following epoch, run the command:
 
 ```bash
-./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --next-era-epoch **EPOCH_AT_WHICH_NEXT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY**
+./mithril-aggregator era generate-tx-datum --current-era-epoch **EPOCH_AT_WHICH_CURRENT_ERA_STARTS** --next-era-epoch **EPOCH_AT_WHICH_NEXT_ERA_STARTS** --era-markers-secret-key **YOUR_ERA_ACTIVATION_SECRET_KEY** --target-path **TARGET_PATH**
 ```
 
 ## Release the build and run the binary 'tools' command
@@ -485,5 +485,6 @@ Here is a list of the available parameters:
 | `current_era_epoch` | `--current-era-epoch` | - | `CURRENT_ERA_EPOCH` | Epoch at which current era starts. | - | - | - | :heavy_check_mark: |
 | `next_era_epoch` | `--next-era-epoch` | - | `NEXT_ERA_EPOCH` | Epoch at which the next era starts. If not specified and an upcoming era is available, it will announce the next era. If specified, it must be strictly greater than `current-epoch-era` | - | - | - | - |
 | `era_markers_secret_key` | `--era-markers-secret-key` | - | `ERA_MARKERS_SECRET_KEY` | Era markers secret key that is used to verify the authenticity of the era markers on the chain. | - | - | - | :heavy_check_mark: |
+| `target_path` | `--target-path` | - | - | Path of the file to export the payload to. | - | - | - | - |
 
 The `tools recompute-certificates-hash` command has no dedicated parameters. 

docs/website/root/manual/developer-docs/nodes/mithril-aggregator.md

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.4.25"
+version = "0.4.26"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -1,3 +1,5 @@
+use std::{fs::File, io::Write, path::PathBuf};
+
 use anyhow::Context;
 use clap::{Parser, Subcommand};
 use config::{builder::DefaultState, ConfigBuilder};
@@ -82,6 +84,10 @@ pub struct GenerateTxDatumEraSubCommand {
     /// Era Markers Secret Key
     #[clap(long, env = "ERA_MARKERS_SECRET_KEY")]
     era_markers_secret_key: HexEncodedEraMarkersSecretKey,
+
+    /// Target Path
+    #[clap(long)]
+    target_path: PathBuf,
 }
 
 impl GenerateTxDatumEraSubCommand {
@@ -93,14 +99,14 @@ impl GenerateTxDatumEraSubCommand {
             EraMarkersVerifierSecretKey::from_json_hex(&self.era_markers_secret_key)
                 .with_context(|| "json hex decode of era markers secret key failure")?;
         let era_markers_signer = EraMarkersSigner::from_secret_key(era_markers_secret_key);
-        print!(
-            "{}",
-            era_tools.generate_tx_datum(
-                Epoch(self.current_era_epoch),
-                self.next_era_epoch.map(Epoch),
-                &era_markers_signer
-            )?
-        );
+        let tx_datum = era_tools.generate_tx_datum(
+            Epoch(self.current_era_epoch),
+            self.next_era_epoch.map(Epoch),
+            &era_markers_signer,
+        )?;
+
+        let mut target_file = File::create(&self.target_path)?;
+        target_file.write_all(tx_datum.as_bytes())?;
 
         Ok(())
     }

mithril-aggregator/src/commands/era_command.rs

@@ -1 +1 @@
-0.2.2
+0.2.3

mithril-test-lab/mithril-devnet/VERSION

@@ -25,6 +25,9 @@ SCRIPT_DIRECTORY=$(dirname $0)
 # Generate the pools scripts
 . ${SCRIPT_DIRECTORY}/mkfiles/mkfiles-pools.sh
 
+# Generate the Mithril era scripts
+. ${SCRIPT_DIRECTORY}/mkfiles/mkfiles-mithril.sh
+
 # Generate the query scripts
 . $SCRIPT_DIRECTORY/mkfiles/mkfiles-query.sh
 

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

@@ -0,0 +1,88 @@
+# Create Mithril era keypair and address
+ADDR=mithril-era
+
+## Payment address keys
+./cardano-cli address key-gen \
+    --verification-key-file addresses/${ADDR}.vkey \
+    --signing-key-file      addresses/${ADDR}.skey
+
+## Payment addresses
+./cardano-cli address build \
+    --payment-verification-key-file addresses/${ADDR}.vkey \
+    --testnet-magic ${NETWORK_MAGIC} \
+    --out-file addresses/${ADDR}.addr
+
+## Send funds to Mithril era address
+N=1
+SCRIPT_TX_VALUE=2000000
+AMOUNT_TRANSFERRED=$(( SCRIPT_TX_VALUE * 10 ))
+cat >> era-mithril.sh <<EOF
+#!/usr/bin/env bash
+set -e
+
+EOF
+
+cat >> era-mithril.sh <<EOF
+    # Send funds to Mithril era address
+    ## Get the UTxO of utxo${N}
+    TX_IN=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli 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 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}-era-funds.txbody
+
+    ## Sign the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli transaction sign \\
+        --signing-key-file addresses/utxo${N}.skey \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --tx-body-file  node-pool${N}/tx/tx${N}-era-funds.txbody \\
+        --out-file      node-pool${N}/tx/tx${N}-era-funds.tx
+
+    ## Submit the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli transaction submit \\
+        --tx-file node-pool${N}/tx/tx${N}-era-funds.tx \\
+        --testnet-magic ${NETWORK_MAGIC}
+
+    ## Wait for the transaction to be confirmed
+    sleep 1
+
+    # Write the era datum on chain
+    TX_IN=\$(CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli 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
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli transaction build \\
+        --tx-in \${TX_IN} \\
+        --tx-out \$(cat addresses/${ADDR}.addr)+${SCRIPT_TX_VALUE} \\
+        --tx-out-inline-datum-file \${DATUM_FILE} \\
+        --change-address \$(cat addresses/${ADDR}.addr) \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --invalid-hereafter 100000 \\
+        --out-file node-pool${N}/tx/tx${N}-era-datum.txbody
+
+    ## Sign the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli transaction sign \\
+        --signing-key-file addresses/${ADDR}.skey \\
+        --testnet-magic ${NETWORK_MAGIC} \\
+        --tx-body-file  node-pool${N}/tx/tx${N}-era-datum.txbody \\
+        --out-file      node-pool${N}/tx/tx${N}-era-datum.tx
+
+    ## Submit the transaction
+    CARDANO_NODE_SOCKET_PATH=node-pool${N}/ipc/node.sock ./cardano-cli transaction submit \\
+        --tx-file node-pool${N}/tx/tx${N}-era-datum.tx \\
+        --testnet-magic ${NETWORK_MAGIC}
+
+    ## Wait for the transaction to be confirmed
+    sleep 2
+    
+EOF
+
+chmod u+x era-mithril.sh

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

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

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

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 use crate::{Aggregator, Devnet};
 use mithril_common::entities::ProtocolParameters;
 use mithril_common::StdResult;
@@ -16,6 +18,27 @@ pub async fn bootstrap_genesis_certificate(aggregator: &mut Aggregator) -> StdRe
     Ok(())
 }
 
+pub async fn register_era_marker(
+    aggregator: &mut Aggregator,
+    devnet: &Devnet,
+    mithril_era: &str,
+) -> StdResult<()> {
+    info!("Register era marker");
+
+    info!("> generating era marker tx datum...");
+    let tx_datum_file_path = devnet
+        .artifacts_dir()
+        .join(PathBuf::from("era-tx-datum.txt".to_string()));
+    aggregator
+        .era_generate_tx_datum(&tx_datum_file_path, mithril_era)
+        .await?;
+
+    info!("> writing era marker on the Cardano chain...");
+    devnet.write_era_marker(&tx_datum_file_path).await?;
+
+    Ok(())
+}
+
 pub async fn delegate_stakes_to_pools(devnet: &Devnet, delegation_round: u16) -> StdResult<()> {
     info!("Delegate stakes to the cardano pools");