feat: use default keystore flag

crates/cast/Cargo.toml

@@ -70,6 +70,7 @@ foundry-cli.workspace = true
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
 clap_complete = "4"
 clap_complete_fig = "4"
+dirs = "5"
 comfy-table.workspace = true
 dunce.workspace = true
 indicatif = "0.17"

crates/cast/bin/cmd/wallet/mod.rs

@@ -43,7 +43,7 @@ pub enum WalletSubcommands {
         /// Password for the JSON keystore in cleartext.
         ///
         /// This is UNSAFE to use and we recommend using the --password.
-        #[arg(long, requires = "path", env = "CAST_PASSWORD", value_name = "PASSWORD")]
+        #[arg(long, env = "CAST_PASSWORD", value_name = "PASSWORD")]
         unsafe_password: Option<String>,
 
         /// Number of wallets to generate.
@@ -53,6 +53,10 @@ pub enum WalletSubcommands {
         /// Output generated wallets as JSON.
         #[arg(long, short, default_value = "false")]
         json: bool,
+
+        /// Use default keystore location (~/.foundry/keystores)
+        #[arg(long, short, conflicts_with = "path", default_value = "false")]
+        default_keystore: bool,
     },
 
     /// Generates a random BIP39 mnemonic phrase
@@ -219,7 +223,7 @@ pub enum WalletSubcommands {
 impl WalletSubcommands {
     pub async fn run(self) -> Result<()> {
         match self {
-            Self::New { path, unsafe_password, number, json, .. } => {
+            Self::New { path, unsafe_password, number, json, default_keystore, .. } => {
                 let mut rng = thread_rng();
 
                 let mut json_values = if json { Some(vec![]) } else { None };
@@ -270,6 +274,40 @@ impl WalletSubcommands {
                     if let Some(json) = json_values.as_ref() {
                         sh_println!("{}", serde_json::to_string_pretty(json)?)?;
                     }
+                } else if default_keystore {
+                    let path = Config::foundry_keystores_dir().ok_or_else(|| {
+                        eyre::eyre!("Could not find the default keystore directory.")
+                    })?;
+                    fs::create_dir_all(&path)?;
+
+                    let password = if let Some(password) = unsafe_password {
+                        password
+                    } else {
+                        // if no --unsafe-password was provided read via stdin
+                        rpassword::prompt_password("Enter secret: ")?
+                    };
+
+                    for _ in 0..number {
+                        let (wallet, uuid) = PrivateKeySigner::new_keystore(
+                            &path,
+                            &mut rng,
+                            password.clone(),
+                            None,
+                        )?;
+
+                        if let Some(json) = json_values.as_mut() {
+                            json.push(json!({
+                                "address": wallet.address().to_checksum(None),
+                                "path": format!("{}", path.join(uuid).display()),
+                            }));
+                        } else {
+                            sh_println!(
+                                "Created new encrypted keystore file: {}",
+                                path.join(uuid).display()
+                            )?;
+                            sh_println!("Address: {}", wallet.address().to_checksum(None))?;
+                        }
+                    }
                 } else {
                     for _ in 0..number {
                         let wallet = PrivateKeySigner::random_with(&mut rng);

crates/cast/tests/cli/main.rs

@@ -125,6 +125,35 @@ Created new encrypted keystore file: [..]
     ]);
 });
 
+// tests that we can create a new wallet with default keystore location
+casttest!(new_wallet_default_keystore, |_prj, cmd| {
+    cmd.args(["wallet", "new", "--unsafe-password", "test", "--default-keystore"])
+        .assert_success()
+        .stdout_eq(str![[r#"
+Created new encrypted keystore file: [..]
+[ADDRESS]
+
+"#]]);
+
+    // Verify the default keystore directory was created
+    let keystore_path = dirs::home_dir().unwrap().join(".foundry").join("keystores");
+    assert!(keystore_path.exists());
+    assert!(keystore_path.is_dir());
+});
+
+// tests that we can outputting multiple keys without a keystore path
+casttest!(new_wallet_multiple_keys, |_prj, cmd| {
+    cmd.args(["wallet", "new", "-n", "2"]).assert_success().stdout_eq(str![[r#"
+Successfully created new keypair.
+Address:     [..]
+Private key: [..]
+Successfully created new keypair.
+Address:     [..]
+Private key: [..]
+
+"#]]);
+});
+
 // tests that we can get the address of a keystore file
 casttest!(wallet_address_keystore_with_password_file, |_prj, cmd| {
     let keystore_dir = Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/keystore");