address comments

Co-authored-by: Toralf Wittner <[email protected]>

Author: alxiong

Cargo.lock

@@ -136,31 +136,4 @@ test-individually:
   done
 
 test-contract-deploy:
-  #!/bin/bash
-  set -exo pipefail
-
-  # Kill any existing anvil processes to avoid port conflicts
-  pkill anvil || true
-  sleep 1
-
-  # Start anvil in background
-  anvil --port 8545 > anvil.log 2>&1 &
-  ANVIL_PID=$!
-  echo $ANVIL_PID > .anvil.pid
-
-  # Set up cleanup function
-  cleanup() {
-    if [ -n "$ANVIL_PID" ]; then
-      kill $ANVIL_PID 2>/dev/null || true
-    fi
-    rm -f .anvil.pid anvil.log
-  }
-
-  # Ensure cleanup happens on exit
-  trap cleanup EXIT
-
-  # Wait for anvil to start
-  sleep 1
-
-  # Run the deploy command
-  RUST_LOG=info cargo run --bin deploy --config ./test-configs/keymanager.toml
+  ./scripts/test-contract-deploy

justfile

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -emuo pipefail
+
+cleanup() {
+    trap - EXIT TERM
+    if [ -n "$ANVIL_PID" ]; then
+        kill "$ANVIL_PID" 2>/dev/null || true
+    fi
+    rm -f .anvil.pid anvil.log
+}
+
+trap cleanup EXIT TERM INT
+
+# Kill any existing anvil processes to avoid port conflicts
+pkill anvil || true
+sleep 1
+
+# Start anvil in background
+anvil --port 8545 >anvil.log 2>&1 &
+ANVIL_PID=$!
+echo $ANVIL_PID >.anvil.pid
+
+# Wait for anvil to start
+sleep 1
+
+# Run the deploy command
+MANAGER_MNEMONIC="test test test test test test test test test test test junk"
+MANAGER_ACCOUNT_INDEX=0
+URL="http://localhost:8545"
+RUST_LOG=info cargo run --bin deploy -- -m "$MANAGER_MNEMONIC" -i "$MANAGER_ACCOUNT_INDEX" -u "$URL"

scripts/test-contract-deploy

@@ -15,8 +15,6 @@ serde = { workspace = true }
 timeboost-utils = { path = "../timeboost-utils" }
 tokio = { workspace = true }
 toml = { workspace = true }
-toml_edit = { workspace = true }
-tracing-subscriber = { workspace = true }
 url = { workspace = true }
 
 [build-dependencies]

test-configs/keymanager.toml

@@ -1,39 +1,57 @@
 //! CLI for contract deployment
 //!
+//! # Usage
+//!
+//! ```
+//! # Write config to stdout
+//! cargo run --bin deploy -- -m "your mnemonic here" -i 0 -u http://localhost:8545
+//!
+//! # Write config to a file
+//! cargo run --bin deploy -- -m "your mnemonic here" -i 0 -u http://localhost:8545 -o output.toml
+//! ```
+//!
 //! # Local test
 //! Run `just test-contract-deploy`
 use alloy::{primitives::Address, providers::WalletProvider};
 use anyhow::{Context, Result};
 use clap::Parser;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 use std::{fs, path::PathBuf};
 use timeboost_contract::provider::build_provider;
 use timeboost_utils::types::logging;
-use toml_edit::{DocumentMut, value};
+use tracing::info;
 use url::Url;
 
 #[derive(Clone, Debug, Parser)]
 struct Args {
-    /// Config file storing `KeyManagerConfig`
-    #[clap(short, long, default_value = "./test-configs/keymanager.toml")]
-    config: PathBuf,
+    #[clap(short, long)]
+    mnemonic: String,
+
+    #[clap(short, long)]
+    index: u32,
+
+    #[clap(short, long)]
+    url: Url,
+
+    #[clap(short, long)]
+    output: Option<PathBuf>,
 }
 
 /// Config type for the key manager who has the permission to update the KeyManager contract
 /// See `test-configs/keymanager.toml` for an example
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 struct KeyManagerConfig {
     wallet: LocalWalletConfig,
     deployments: Deployments,
 }
 
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 struct LocalWalletConfig {
     mnemonic: String,
     account_index: u32,
 }
 
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 #[allow(dead_code)]
 struct Deployments {
     /// RPC endpoint of the target chain
@@ -47,49 +65,48 @@ async fn main() -> Result<()> {
     logging::init_logging();
 
     let args = Args::parse();
-    let config_path = args.config;
 
-    tracing::info!(
-        "Starting contract deployment with config: {:?}",
-        config_path
-    );
+    info!("Starting contract deployment");
 
-    // Read and parse config file
-    let config_content = fs::read_to_string(&config_path)
-        .with_context(|| format!("Failed to read config file: {config_path:?}"))?;
-    let config: KeyManagerConfig = toml::from_str(&config_content)
-        .with_context(|| format!("Failed to parse config file: {config_path:?}"))?;
-    tracing::info!("Config loaded successfully");
+    // Construct the config from command-line arguments
+    let mut cfg = KeyManagerConfig {
+        wallet: LocalWalletConfig {
+            mnemonic: args.mnemonic,
+            account_index: args.index,
+        },
+        deployments: Deployments {
+            chain_url: args.url,
+            key_manager: None,
+        },
+    };
 
     // Build provider
     let provider = build_provider(
-        config.wallet.mnemonic,
-        config.wallet.account_index,
-        config.deployments.chain_url,
+        cfg.wallet.mnemonic.clone(),
+        cfg.wallet.account_index,
+        cfg.deployments.chain_url.clone(),
     );
 
     let manager = provider.default_signer_address();
-    tracing::info!("Deploying with maanger address: {manager:#x}");
+    info!("Deploying with manager address: {manager:#x}");
 
     // Deploy the KeyManager contract
     let km_addr = timeboost_contract::deployer::deploy_key_manager_contract(&provider, manager)
         .await
         .context("Failed to deploy KeyManager contract")?;
-    tracing::info!("KeyManager deployed successfully at: {km_addr:#x}");
-
-    // Update the config file with the deployed address
-    let mut doc = config_content
-        .parse::<DocumentMut>()
-        .with_context(|| format!("Failed to parse TOML in config file: {config_path:?}"))?;
-
-    // Set the key_manager address in the deployments section
-    doc["deployments"]["key_manager"] = value(format!("{km_addr:#x}"));
-
-    // Write back to file
-    fs::write(&config_path, doc.to_string())
-        .with_context(|| format!("Failed to write updated config file: {config_path:?}"))?;
-
-    tracing::info!("Config file updated with KeyManager address: {km_addr:#x}");
+    info!("KeyManager deployed successfully at: {km_addr:#x}");
+
+    // Update the address and deliver the final config
+    cfg.deployments.key_manager = Some(km_addr);
+    let toml = toml::to_string_pretty(&cfg)?;
+
+    if let Some(out) = &args.output {
+        fs::write(out, &toml)?;
+        info!(file=?out, "Config written to file");
+    } else {
+        println!("===== OUTPUT ======");
+        println!("{toml}");
+    }
 
     Ok(())
 }

timeboost-contract/Cargo.toml

@@ -18,7 +18,8 @@ mod sol_types;
 use provider::TestProviderWithWallet;
 pub use sol_types::*;
 
-/// Similar to [`init_chain()`] but spawn a local test chain and deploy contracts there instead.
+/// Spawn a local test blockchain and deploy KeyManager contract.
+/// Returns a WalletProvider to the chain and the deployed contract address.
 pub async fn init_test_chain() -> Result<(TestProviderWithWallet, Address)> {
     // this provider wraps both the test chain instance (exit on drop), and the wallet provider
     let provider = ProviderBuilder::new().connect_anvil_with_wallet();

timeboost-contract/src/binaries/deploy.rs

@@ -1,8 +1,5 @@
 //! Solidity types for contract interaction
 
-use alloy::primitives::Bytes;
-use rand::prelude::*;
-
 // We manually re-export the type here carefully due to alloy's lack of shared type:
 // tracking issue: https://github.com/foundry-rs/foundry/issues/10153
 pub use crate::bindings::{
@@ -12,7 +9,11 @@ pub use crate::bindings::{
 };
 
 impl CommitteeMemberSol {
+    #[cfg(test)]
     pub fn random() -> Self {
+        use alloy::primitives::Bytes;
+        use rand::prelude::*;
+
         let mut rng = rand::rng();
         CommitteeMemberSol {
             sigKey: Bytes::from(rng.random::<[u8; 32]>()),