feat: Initial version of a key generation utility for ream (#757)

* Feat: Adding message_types.rs

* feat: parallelise key generation

* feat: amended generate_keys function to create multiple keys based on index

* fix: resolved udeps error

* feat: Added struct definitions for post quantum keystore

* feat: Saving to QsKeystore

* feat: Added passphrase parameter to account_manager command

* fix: review comments

* fix: fixed cargo fmt issue

* fix: removed ascii art

* fix: fixed review comments

* Fix: addressed review comments.

* Fix: review comment fixes

* fix: linting errors

* Fix: Update bin/ream/src/main.rs

Co-authored-by: Jun Song <[email protected]>

* Fix: Update crates/common/account_manager/src/keystore.rs

Co-authored-by: Jun Song <[email protected]>

* Fix: Update crates/common/account_manager/src/keystore.rs

Co-authored-by: Jun Song <[email protected]>

* Fix: review comment fixes

* fix: fixed issues with build and removed redundant code

* Fix: review comment fixes

* fix: Update bin/ream/src/cli/account_manager.rs

Co-authored-by: Kolby Moroz Liebl <[email protected]>

* Fix: Update bin/ream/src/cli/account_manager.rs

Co-authored-by: Kolby Moroz Liebl <[email protected]>

* fix: Update crates/common/account_manager/src/lib.rs

Co-authored-by: Kolby Moroz Liebl <[email protected]>

* Fix: Update crates/common/account_manager/src/message_types.rs

Co-authored-by: Kolby Moroz Liebl <[email protected]>

* Fix: updated code to address comments

* fix: review comment fixes

* fix: Removed parallel processing.

* Fix: Removed rayon from Cargo.toml

* Fix: addressed review comments

* fix: renamed functions

* fix: changed the default keystore path

---------

Co-authored-by: Jun Song <[email protected]>
Co-authored-by: Kolby Moroz Liebl <[email protected]>

Author: 3 people

.gitignore

@@ -27,3 +27,6 @@ testing/ef-tests/mainnet/*
 
 # DS_Store: Desktop Services Store
 .DS_Store
+
+# keystore
+.keystore

Cargo.lock

@@ -72,7 +72,7 @@ alloy-rpc-types-beacon = "1.0.8"
 alloy-rpc-types-eth = "1.0.7"
 anyhow = "1.0"
 async-trait = "0.1.86"
-bip32 = "0.5.3"
+bip39 = "2.2.0"
 clap = "4"
 delay_map = "0.4.1"
 directories = { version = "6.0.0" }
@@ -86,6 +86,7 @@ eventsource-client = "0.15.0"
 futures = "0.3"
 hashbrown = "0.15.3"
 hashsig = { git = "https://github.com/b-wagn/hash-sig", rev = "287517a763edba7e518b0c1ee5beb868f26f1f66" }
+hex = "0.4"
 itertools = "0.14"
 jsonwebtoken = "9.3.1"
 kzg = { git = "https://github.com/grandinetech/rust-kzg" }

Cargo.toml

@@ -17,13 +17,15 @@ path = "src/main.rs"
 [dependencies]
 alloy-primitives.workspace = true
 anyhow.workspace = true
+bip39.workspace = true
 clap = { workspace = true, features = ["derive", "env"] }
 discv5.workspace = true
 hashbrown.workspace = true
 libp2p-identity.workspace = true
 prometheus_exporter.workspace = true
 rand.workspace = true
 rand_chacha.workspace = true
+serde_json.workspace = true
 tokio.workspace = true
 tracing = { workspace = true, features = ["log"] }
 tracing-subscriber = { workspace = true, features = ["env-filter"] }

bin/ream/Cargo.toml

@@ -1,10 +1,12 @@
 use anyhow::ensure;
+use bip39::Mnemonic;
 use clap::Parser;
+use tracing::info;
 
-const MIN_CHUNK_SIZE: u64 = 4;
-const MIN_LIFETIME: u64 = 18;
-const DEFAULT_ACTIVATION_EPOCH: usize = 0;
-const DEFAULT_NUM_ACTIVE_EPOCHS: usize = 1 << 18;
+const MIN_CHUNK_SIZE: u32 = 4;
+const MIN_LIFETIME: u32 = 18;
+const DEFAULT_ACTIVATION_EPOCH: u32 = 0;
+const DEFAULT_NUM_ACTIVE_EPOCHS: u32 = 1 << 18;
 
 #[derive(Debug, Parser)]
 pub struct AccountManagerConfig {
@@ -14,23 +16,31 @@ pub struct AccountManagerConfig {
 
     /// Account lifetime in 2 ** lifetime slots
     #[arg(short, long, default_value_t = 18)]
-    pub lifetime: u64,
+    pub lifetime: u32,
 
     /// Chunk size for messages
     #[arg(short, long, default_value_t = 5)]
-    pub chunk_size: u64,
+    pub chunk_size: u32,
 
     /// Seed phrase for key generation
     #[arg(short, long)]
     pub seed_phrase: Option<String>,
 
+    /// Optional BIP39 passphrase used with the seed phrase
+    #[arg(long)]
+    pub passphrase: Option<String>,
+
     /// Activation epoch for the validator
     #[arg(long, default_value_t = DEFAULT_ACTIVATION_EPOCH)]
-    pub activation_epoch: usize,
+    pub activation_epoch: u32,
 
     /// Number of active epochs
     #[arg(long, default_value_t = DEFAULT_NUM_ACTIVE_EPOCHS)]
-    pub num_active_epochs: usize,
+    pub num_active_epochs: u32,
+
+    /// Path for keystore directory (relative to data-dir if not absolute)
+    #[arg(long)]
+    pub keystore_path: Option<String>,
 }
 
 impl Default for AccountManagerConfig {
@@ -40,8 +50,10 @@ impl Default for AccountManagerConfig {
             lifetime: 18,
             chunk_size: 5,
             seed_phrase: None,
+            passphrase: None,
             activation_epoch: DEFAULT_ACTIVATION_EPOCH,
             num_active_epochs: DEFAULT_NUM_ACTIVE_EPOCHS,
+            keystore_path: None,
         }
     }
 }
@@ -60,14 +72,22 @@ impl AccountManagerConfig {
             self.lifetime >= MIN_LIFETIME,
             "Lifetime must be at least {MIN_LIFETIME}"
         );
+
         Ok(())
     }
 
     pub fn get_seed_phrase(&self) -> String {
         if let Some(phrase) = &self.seed_phrase {
             phrase.clone()
         } else {
-            "default_seed_phrase".to_string()
+            // Generate a new BIP39 mnemonic with 24 words (256 bits of entropy)
+            let entropy: [u8; 32] = rand::random();
+            let mnemonic = Mnemonic::from_entropy(&entropy).expect("Failed to generate mnemonic");
+            let phrase = mnemonic.words().collect::<Vec<_>>().join(" ");
+            info!("{}", "=".repeat(89));
+            info!("Generated new seed phrase (KEEP SAFE): {phrase}");
+            info!("{}", "=".repeat(89));
+            phrase
         }
     }
 }