feat: add file-based input and output to faucet commands (tari-projec…

…t#6405)

Description
---
In this PR the following functionality were implemented:
- Added file-based I/O to faucet commands
- Combined faucet script and metadata signature generation steps
- Safe-guarded faucet commands:
  - wallet will exit immediately afterwards;
  - faucet commands will only be allowed in command mode.

The screen output running the m-of-n spend scenario is shown below.

**Step 1 - FaucetGenerateSessionInfo**
```
faucet-generate-session-info --fee-per-gram 5 --commitment b8b0ad44a4ac05d7c383ac6615c0ed7b14d0f25de42210e89f3191e605865361 
--output-hash 7018f30e8d6bbdce7d79709db9854589b0b645ed25624bc7a6b1be43a2eded26 
--recipient-address f48yg4or3d7AsKhVD5124wSzjEE7A1ZbANhyCsJJdmKF8jcfZCcoWiGRxeyauriwPPTMswxnpdUfdWtQ4qkaDgwPrsk 
--verify-unspent-outputs
Initializing logging according to "node_04\\config\\log4rs_console_wallet.yml"
Minotari Console Wallet running... (Command mode started)
==============
Command Runner
==============

1. FaucetGenerateSessionInfo(FaucetGenerateSessionInfoArgs { fee_per_gram: MicroMinotari(5), commitment: 
"b8b0ad44a4ac05d7c383ac6615c0ed7b14d0f25de42210e89f3191e605865361", output_hash: 
"7018f30e8d6bbdce7d79709db9854589b0b645ed25624bc7a6b1be43a2eded26", recipient_address: 
Dual(DualAddress { network: Esmeralda, features: TariAddressFeatures(3), public_view_key: 
5a658abfa39fb6828b3c267fdfabc4b764aab155d816dfac774649a83649071e, public_spend_key: 
7cf45a38904b23ca76ecd95aee5c1742fc1bf6fc0ef8cd6ee2ee28540f9edb40 }), verify_unspent_outputs: true })


Concluded step 1 'faucet-generate-session-info'
Your session ID is:                 'MakczWU9X2RgPXdz'
Your session's output directory is: '<user>\AppData\Local\tari_faucets\MakczWU9X2RgPXdz'
Session info saved to:              '<user>\AppData\Local\tari_faucets\MakczWU9X2RgPXdz\step_1_session_info.json'
Send 'step_1_session_info.json' to parties for step 2

Minotari Console Wallet running... (Command mode completed)

Shutting down wallet... Done.
```
**Step 2 - FaucetCreatePartyDetails**
```
faucet-create-party-details --input-file "<user>\AppData\Local\tari_faucets\step_1_session_info.json" --alias alice
Initializing logging according to "node_02\\config\\log4rs_console_wallet.yml"
Minotari Console Wallet running... (Command mode started)
==============
Command Runner
==============

1. FaucetCreatePartyDetails(FaucetCreatePartyDetailsArgs { session_id: "MakczWU9X2RgPXdz", input_file: "
<user>\\AppData\\Local\\tari_faucets\\step_1_session_info.json", alias: "alice" })


Concluded step 2 'faucet-create-party-details'
Your session's output directory is <user>\AppData\Local\tari_faucets\MakczWU9X2RgPXdz'
Session info file '<user>\AppData\Local\tari_faucets\step_1_session_info.json' moved to '<user>\AppData\Local\tari_faucets\MakczWU9X2RgPXdz\step_1_session_info.json'
Send 'step_2_for_leader_from_alice.json' to leader for step 3

Minotari Console Wallet running... (Command mode completed)

Shutting down wallet... Done.
```
**Step 3 - FaucetEncumberAggregateUtxo**
```
faucet-encumber-aggregate-utxo --session-id MakczWU9X2RgPXdz --input-file-names=step_2_for_leader_from_alice.json
Initializing logging according to "node_04\\config\\log4rs_console_wallet.yml"
Minotari Console Wallet running... (Command mode started)
==============
Command Runner
==============

1. FaucetEncumberAggregateUtxo(FaucetEncumberAggregateUtxoArgs { session_id: "MakczWU9X2RgPXdz", input_file_names: ["step_2_for_leader_from_alice.json"] })


Concluded step 3 'faucet-encumber-aggregate-utxo'
Send 'step_3_for_parties.json' to parties for step 4

Minotari Console Wallet running... (Command mode completed)

Shutting down wallet... Done.
```
**Step 4 - FaucetCreateInputOutputSigs**
```
faucet-create-input-output-sigs --session-id MakczWU9X2RgPXdz
Initializing logging according to "node_02\\config\\log4rs_console_wallet.yml"
Minotari Console Wallet running... (Command mode started)
==============
Command Runner
==============

1. FaucetCreateInputOutputSigs(FaucetCreateInputOutputSigArgs { session_id: "MakczWU9X2RgPXdz" })


Concluded step 4 'faucet-create-input-output-sigs'
Send 'step_4_for_leader_from_alice.json' to leader for step 5

Minotari Console Wallet running... (Command mode completed)

Shutting down wallet... Done.
```
**Step 5 - FaucetSpendAggregateUtxo**
```
faucet-spend-aggregate-utxo --session-id MakczWU9X2RgPXdz --input-file-names=step_4_for_leader_from_alice.json
Initializing logging according to "node_04\\config\\log4rs_console_wallet.yml"
Minotari Console Wallet running... (Command mode started)
==============
Command Runner
==============

1. FaucetSpendAggregateUtxo(FaucetSpendAggregateUtxoArgs { session_id: "MakczWU9X2RgPXdz", input_file_names: ["step_4_for_leader_from_alice.json"] })


Concluded step 5 'faucet-spend-aggregate-utxo'

Minotari Console Wallet running... (Command mode completed)

Shutting down wallet... Done.
```

Motivation and Context
---
Manual inputs are cumbersome and prone to errors.

How Has This Been Tested?
---
System-level testing

What process can a PR reviewer use to test or verify this change?
---
Review code changes
Perform system-level testing

<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->

applications/minotari_console_wallet/Cargo.toml

@@ -38,6 +38,7 @@ clap = { version = "3.2", features = ["derive", "env"] }
 config = "0.14.0"
 crossterm = { version = "0.25.0" }
 digest = "0.10"
+dirs = "5.0"
 futures = { version = "^0.3.16", default-features = false, features = [
     "alloc",
 ] }

applications/minotari_console_wallet/src/automation/mod.rs

@@ -22,5 +22,80 @@
 
 pub mod commands;
 pub mod error;
+mod utils;
 // removed temporarily add back in when used.
 // mod prompt;
+
+use serde::{Deserialize, Serialize};
+use tari_common_types::{
+    tari_address::TariAddress,
+    transaction::TxId,
+    types::{Commitment, PrivateKey, PublicKey, Signature},
+};
+use tari_core::transactions::{
+    key_manager::TariKeyId,
+    tari_amount::MicroMinotari,
+    transaction_components::{EncryptedData, OutputFeatures},
+};
+use tari_script::{CheckSigSchnorrSignature, ExecutionStack, TariScript};
+
+// Outputs for self with `FaucetCreatePartyDetails`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step1SessionInfo {
+    session_id: String,
+    fee_per_gram: MicroMinotari,
+    commitment_to_spend: String,
+    output_hash: String,
+    recipient_address: TariAddress,
+}
+
+// Outputs for self with `FaucetCreatePartyDetails`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step2OutputsForSelf {
+    alias: String,
+    wallet_spend_key_id: TariKeyId,
+    script_nonce_key_id: TariKeyId,
+    sender_offset_key_id: TariKeyId,
+    sender_offset_nonce_key_id: TariKeyId,
+}
+
+// Outputs for leader with `FaucetCreatePartyDetails`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step2OutputsForLeader {
+    script_input_signature: CheckSigSchnorrSignature,
+    wallet_public_spend_key: PublicKey,
+    public_script_nonce_key: PublicKey,
+    public_sender_offset_key: PublicKey,
+    public_sender_offset_nonce_key: PublicKey,
+    dh_shared_secret_public_key: PublicKey,
+}
+
+// Outputs for self with `FaucetEncumberAggregateUtxo`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step3OutputsForSelf {
+    tx_id: TxId,
+}
+
+// Outputs for parties with `FaucetEncumberAggregateUtxo`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step3OutputsForParties {
+    input_stack: ExecutionStack,
+    input_script: TariScript,
+    total_script_key: PublicKey,
+    script_signature_ephemeral_commitment: Commitment,
+    script_signature_ephemeral_pubkey: PublicKey,
+    output_commitment: Commitment,
+    sender_offset_pubkey: PublicKey,
+    metadata_signature_ephemeral_commitment: Commitment,
+    metadata_signature_ephemeral_pubkey: PublicKey,
+    encrypted_data: EncryptedData,
+    output_features: OutputFeatures,
+}
+
+// Outputs for leader with `FaucetCreateScriptSig` and `FaucetCreateMetaSig`
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
+struct Step4OutputsForLeader {
+    script_signature: Signature,
+    metadata_signature: Signature,
+    script_offset: PrivateKey,
+}

applications/minotari_console_wallet/src/automation/utils.rs

@@ -0,0 +1,215 @@
+// Copyright 2020. The Tari Project
+//
+// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+// following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+// disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+// following disclaimer in the documentation and/or other materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+// products derived from this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+use std::{
+    fs,
+    fs::{File, OpenOptions},
+    io::{BufRead, BufReader, Write},
+    path::{Path, PathBuf},
+};
+
+use serde::{de::DeserializeOwned, Serialize};
+
+use crate::automation::{
+    commands::{FILE_EXTENSION, SESSION_INFO},
+    error::CommandError,
+    Step1SessionInfo,
+};
+
+#[derive(Debug)]
+pub(crate) struct PartialRead {
+    pub(crate) lines_to_read: usize,
+    pub(crate) lines_to_skip: usize,
+}
+
+/// Reads an entire file into a single JSON object
+pub(crate) fn json_from_file_single_object<P: AsRef<Path>, T: DeserializeOwned>(
+    path: P,
+    partial_read: Option<PartialRead>,
+) -> Result<T, CommandError> {
+    if let Some(val) = partial_read {
+        let lines = BufReader::new(
+            File::open(path.as_ref())
+                .map_err(|e| CommandError::JsonFile(format!("{e} '{}'", path.as_ref().display())))?,
+        )
+        .lines()
+        .take(val.lines_to_read)
+        .skip(val.lines_to_skip);
+        let mut json_str = String::new();
+        for line in lines {
+            let line = line.map_err(|e| CommandError::JsonFile(format!("{e} '{}'", path.as_ref().display())))?;
+            json_str.push_str(&line);
+        }
+        serde_json::from_str(&json_str)
+            .map_err(|e| CommandError::JsonFile(format!("{e} '{}'", path.as_ref().display())))
+    } else {
+        serde_json::from_reader(BufReader::new(
+            File::open(path.as_ref())
+                .map_err(|e| CommandError::JsonFile(format!("{e} '{}'", path.as_ref().display())))?,
+        ))
+        .map_err(|e| CommandError::JsonFile(format!("{e} '{}'", path.as_ref().display())))
+    }
+}
+
+/// Write a single JSON object to file as a single line
+pub(crate) fn write_json_object_to_file_as_line<T: Serialize>(
+    file: &Path,
+    reset_file: bool,
+    outputs: T,
+) -> Result<(), CommandError> {
+    if let Some(file_path) = file.parent() {
+        if !file_path.exists() {
+            fs::create_dir_all(file_path).map_err(|e| CommandError::JsonFile(format!("{} ({})", e, file.display())))?;
+        }
+    }
+    if reset_file && file.exists() {
+        fs::remove_file(file).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    }
+    append_json_line_to_file(file, outputs)?;
+    Ok(())
+}
+
+fn append_json_line_to_file<P: AsRef<Path>, T: Serialize>(file: P, output: T) -> Result<(), CommandError> {
+    fs::create_dir_all(file.as_ref().parent().unwrap()).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    let mut file_object = OpenOptions::new()
+        .create(true)
+        .append(true)
+        .open(file)
+        .map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    let json = serde_json::to_string(&output).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    writeln!(file_object, "{json}").map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    Ok(())
+}
+
+/// Write outputs to a JSON file
+pub(crate) fn write_to_json_file<T: Serialize>(file: &Path, reset_file: bool, data: T) -> Result<(), CommandError> {
+    if let Some(file_path) = file.parent() {
+        if !file_path.exists() {
+            fs::create_dir_all(file_path).map_err(|e| CommandError::JsonFile(format!("{} ({})", e, file.display())))?;
+        }
+    }
+    if reset_file && file.exists() {
+        fs::remove_file(file).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    }
+    append_to_json_file(file, data)?;
+    Ok(())
+}
+
+fn append_to_json_file<P: AsRef<Path>, T: Serialize>(file: P, data: T) -> Result<(), CommandError> {
+    fs::create_dir_all(file.as_ref().parent().unwrap()).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    let mut file_object = OpenOptions::new()
+        .create(true)
+        .append(true)
+        .open(file)
+        .map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    let json = serde_json::to_string_pretty(&data).map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    writeln!(file_object, "{json}").map_err(|e| CommandError::JsonFile(e.to_string()))?;
+    Ok(())
+}
+
+/// Return the output directory for the session
+pub(crate) fn out_dir(session_id: &str) -> Result<PathBuf, CommandError> {
+    let base_dir = dirs::cache_dir().ok_or(CommandError::InvalidArgument(
+        "Could not find cache directory".to_string(),
+    ))?;
+    Ok(base_dir.join("tari_faucets").join(session_id))
+}
+
+/// Move the session file to the session directory
+pub(crate) fn move_session_file_to_session_dir(session_id: &str, input_file: &PathBuf) -> Result<(), CommandError> {
+    let out_dir = out_dir(session_id)?;
+    let session_file = out_dir.join(get_file_name(SESSION_INFO, None));
+    if input_file != &session_file {
+        fs::copy(input_file.clone(), session_file.clone())?;
+        fs::remove_file(input_file.clone())?;
+        println!(
+            "Session info file '{}' moved to '{}'",
+            input_file.display(),
+            session_file.display()
+        );
+    }
+    Ok(())
+}
+
+/// Read the session info from the session directory and verify the supplied session ID
+pub(crate) fn read_verify_session_info(session_id: &str) -> Result<Step1SessionInfo, CommandError> {
+    let file_path = out_dir(session_id)?.join(get_file_name(SESSION_INFO, None));
+    let session_info = json_from_file_single_object::<_, Step1SessionInfo>(&file_path, None)?;
+    if session_info.session_id != session_id {
+        return Err(CommandError::InvalidArgument(format!(
+            "Session ID in session info file '{}' mismatch",
+            get_file_name(SESSION_INFO, None)
+        )));
+    }
+    Ok(session_info)
+}
+
+/// Read the session info from the session directory
+pub(crate) fn read_session_info(session_file: PathBuf) -> Result<Step1SessionInfo, CommandError> {
+    json_from_file_single_object::<_, Step1SessionInfo>(&session_file, None)
+}
+
+/// Read the inputs from the session directory and verify the header
+pub(crate) fn read_and_verify<T: DeserializeOwned>(
+    session_id: &str,
+    file_name: &str,
+    session_info: &Step1SessionInfo,
+) -> Result<T, CommandError> {
+    let out_dir = out_dir(session_id)?;
+    let header = json_from_file_single_object::<_, Step1SessionInfo>(
+        &out_dir.join(file_name),
+        Some(PartialRead {
+            lines_to_read: 1,
+            lines_to_skip: 0,
+        }),
+    )?;
+    if session_id != header.session_id {
+        return Err(CommandError::InvalidArgument(format!(
+            "Session ID in header for file '{}' mismatch",
+            file_name
+        )));
+    }
+    if session_info != &header {
+        return Err(CommandError::InvalidArgument(format!(
+            "Session info in header for file '{}' mismatch",
+            file_name
+        )));
+    }
+    json_from_file_single_object::<_, T>(
+        &out_dir.join(file_name),
+        Some(PartialRead {
+            lines_to_read: usize::MAX,
+            lines_to_skip: 1,
+        }),
+    )
+}
+
+/// Create the file name with the given stem and optional suffix
+pub(crate) fn get_file_name(stem: &str, suffix: Option<String>) -> String {
+    let mut file_name = stem.to_string();
+    if let Some(suffix) = suffix {
+        file_name.push_str(&suffix);
+    }
+    file_name.push('.');
+    file_name.push_str(FILE_EXTENSION);
+    file_name
+}