feat: implement cmd/createenr (#115)

* feat: implement cmd/create/enr

* fix: run fmt

* fix: address comments

Author: iamquang95

crates/charon-cli/src/cli.rs

@@ -2,7 +2,7 @@
 
 use clap::{Parser, Subcommand};
 
-use crate::commands::{enr::EnrArgs, version::VersionArgs};
+use crate::commands::{create_enr::CreateEnrArgs, enr::EnrArgs, version::VersionArgs};
 
 /// Pluto - Proof of Stake Ethereum Distributed Validator Client
 #[derive(Parser)]
@@ -27,9 +27,29 @@ pub enum Commands {
     )]
     Enr(EnrArgs),
 
+    #[command(
+        about = "Create artifacts for a distributed validator cluster",
+        long_about = "Create artifacts for a distributed validator cluster. These commands can be used to facilitate the creation of a distributed validator cluster between a group of operators by performing a distributed key generation ceremony, or they can be used to create a local cluster for single operator use cases."
+    )]
+    Create(CreateArgs),
+
     #[command(about = "Print version and exit", long_about = "Output version info")]
     Version(VersionArgs),
     // Future commands will be added here:
     // Run(RunArgs),
-    // Create(CreateArgs),
+}
+
+/// Arguments for the create command
+#[derive(clap::Args)]
+pub struct CreateArgs {
+    #[command(subcommand)]
+    pub command: CreateCommands,
+}
+
+/// Create subcommands
+#[derive(Subcommand)]
+pub enum CreateCommands {
+    /// Create an Ethereum Node Record (ENR) private key to identify this charon
+    /// client
+    Enr(CreateEnrArgs),
 }

crates/charon-cli/src/commands/create_enr.rs

@@ -0,0 +1,73 @@
+//! Create ENR command implementation.
+//!
+//! This module implements the `pluto create enr` command, which generates a new
+//! Ethereum Node Record (ENR) private key and stores it securely on disk.
+
+use std::{
+    io::{self, Write},
+    path::{Path, PathBuf},
+};
+
+use charon_eth2::enr::Record;
+use charon_p2p::k1;
+
+use crate::error::{CliError, Result};
+
+/// Arguments for the create enr command
+#[derive(clap::Args)]
+pub struct CreateEnrArgs {
+    #[arg(
+        long = "data-dir",
+        env = "CHARON_DATA_DIR",
+        default_value = ".charon",
+        help = "The directory where pluto will store all its internal data."
+    )]
+    pub data_dir: PathBuf,
+}
+
+/// Runs the create enr command
+///
+/// Stores a new charon-enr-private-key to disk and prints the ENR for the
+/// provided config. It returns an error if the key already exists.
+pub fn run(args: CreateEnrArgs) -> Result<()> {
+    if k1::load_priv_key(&args.data_dir).is_ok() {
+        let enr_path = k1::key_path(&args.data_dir);
+        return Err(CliError::PrivateKeyAlreadyExists { enr_path });
+    }
+
+    let key = k1::new_saved_priv_key(&args.data_dir)?;
+
+    let record = Record::new(key, Vec::new())?;
+    let key_path = k1::key_path(&args.data_dir);
+
+    let mut writer = io::stdout();
+    writeln!(writer, "Created ENR private key: {}", key_path.display())?;
+    writeln!(writer, "{}", record)?;
+    write_enr_warning(&mut writer, &key_path)?;
+
+    Ok(())
+}
+
+/// Writes backup key warning to the terminal
+fn write_enr_warning(w: &mut dyn Write, key_path: &Path) -> Result<()> {
+    writeln!(w)?;
+    writeln!(
+        w,
+        "***************** WARNING: Backup key **********************"
+    )?;
+    writeln!(
+        w,
+        " PLEASE BACKUP YOUR KEY IMMEDIATELY! IF YOU LOSE YOUR KEY,"
+    )?;
+    writeln!(
+        w,
+        " YOU WON'T BE ABLE TO PARTICIPATE IN RUNNING A CHARON CLUSTER.\n"
+    )?;
+    writeln!(w, " YOU CAN FIND YOUR KEY IN {}", key_path.display())?;
+    writeln!(
+        w,
+        "****************************************************************"
+    )?;
+    writeln!(w)?;
+    Ok(())
+}

crates/charon-cli/src/commands/enr.rs

@@ -18,16 +18,19 @@ use crate::error::{CliError, Result};
 /// Arguments for the ENR command.
 #[derive(clap::Args)]
 pub struct EnrArgs {
-    /// The directory where pluto will store all its internal data.
-    #[arg(long = "data-dir", env = "CHARON_DATA_DIR", default_value = ".charon")]
+    #[arg(
+        long = "data-dir",
+        env = "CHARON_DATA_DIR",
+        default_value = ".charon",
+        help = "The directory where pluto will store all its internal data."
+    )]
     pub data_dir: PathBuf,
 
-    /// Prints the expanded form of ENR.
-    #[arg(long, short = 'v')]
+    #[arg(long, help = "Prints the expanded form of ENR.")]
     pub verbose: bool,
 }
 
-/// loads the p2pkey from disk and prints the ENR for the provided config.
+/// Loads the p2pkey from disk and prints the ENR for the provided config.
 pub fn run(args: EnrArgs) -> Result<()> {
     let mut writer = io::stdout();
 
@@ -40,11 +43,8 @@ pub fn run(args: EnrArgs) -> Result<()> {
             let enr_path = k1::key_path(&args.data_dir);
             return Err(CliError::PrivateKeyNotFound { enr_path });
         }
-        Err(k1::K1Error::K1UtilError(e)) => {
-            return Err(CliError::KeyLoadError(e.to_string()));
-        }
-        Err(k1::K1Error::IoError(e)) => {
-            return Err(CliError::IoError(e));
+        Err(e) => {
+            return Err(CliError::KeyLoadError(e));
         }
     };
 

crates/charon-cli/src/commands/mod.rs

@@ -1,2 +1,3 @@
+pub mod create_enr;
 pub mod enr;
 pub mod version;

crates/charon-cli/src/commands/version.rs

@@ -6,7 +6,7 @@ use crate::error::Result;
 #[derive(clap::Args)]
 pub struct VersionArgs {
     #[arg(
-        long = "verbose",
+        long,
         help = "Includes detailed module version info and supported protocols."
     )]
     pub verbose: bool,

crates/charon-cli/src/error.rs

@@ -18,9 +18,16 @@ pub(crate) enum CliError {
         enr_path: PathBuf,
     },
 
+    /// Private key already exists.
+    #[error("charon-enr-private-key already exists")]
+    PrivateKeyAlreadyExists {
+        /// Path where the ENR private key exists.
+        enr_path: PathBuf,
+    },
+
     /// Failed to load private key.
     #[error("Failed to load private key: {0}")]
-    KeyLoadError(String),
+    KeyLoadError(#[from] charon_p2p::k1::K1Error),
 
     /// ENR generation failed.
     #[error("ENR generation failed: {0}")]

crates/charon-cli/src/main.rs

@@ -10,13 +10,16 @@ mod cli;
 mod commands;
 mod error;
 
-use cli::{Cli, Commands};
+use cli::{Cli, Commands, CreateCommands};
 use error::Result;
 
 fn main() -> Result<()> {
     let cli = Cli::parse();
 
     match cli.command {
+        Commands::Create(args) => match args.command {
+            CreateCommands::Enr(args) => commands::create_enr::run(args),
+        },
         Commands::Enr(args) => commands::enr::run(args),
         Commands::Version(args) => commands::version::run(args),
     }