Skip to content

feat(cast): display public_key on wallet creation with "new" and "new-mnemonic" sub-commands #10600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(cast): display public_key on wallet creation with "new" and "new-mnemonic" sub-commands #10600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffeefa2
feat(cast): display public_key on wallet creation with "new" and "new…
mablr May 23, 2025
98df0ad
Merge branch 'master' into feature/cast-wallet-display-pubkey
grandizzy Jun 3, 2025
7acd7d8
Display pubkey only when verbosity level >0
mablr Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 69 additions & 13 deletions crates/cast/src/cmd/wallet/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,17 +305,36 @@ impl WalletSubcommands {
)?;
let identifier = account_name_ref.as_deref().unwrap_or(&uuid);

let public_key = hex::encode(
&SecretKey::from_slice(&wallet.credential().to_bytes())
.map_err(|e| eyre::eyre!("Invalid private key: {}", e))?
.public_key()
.to_encoded_point(false)
.as_bytes()[1..],
);

if let Some(json) = json_values.as_mut() {
json.push(json!({
"address": wallet.address().to_checksum(None),
"path": format!("{}", path.join(identifier).display()),
}));
json.push(if shell::verbosity() > 0 {
json!({
"address": wallet.address().to_checksum(None),
"public_key": format!("0x{}", public_key),
"path": format!("{}", path.join(identifier).display()),
})
} else {
json!({
"address": wallet.address().to_checksum(None),
"path": format!("{}", path.join(identifier).display()),
})
});
} else {
sh_println!(
"Created new encrypted keystore file: {}",
path.join(identifier).display()
)?;
sh_println!("Address: {}", wallet.address().to_checksum(None))?;
sh_println!("Address: {}", wallet.address().to_checksum(None))?;
if shell::verbosity() > 0 {
sh_println!("Public key: 0x{}", public_key)?;
}
}
}

Expand All @@ -326,14 +345,33 @@ impl WalletSubcommands {
for _ in 0..number {
let wallet = PrivateKeySigner::random_with(&mut rng);

let public_key = hex::encode(
&SecretKey::from_slice(&wallet.credential().to_bytes())
.map_err(|e| eyre::eyre!("Invalid private key: {}", e))?
.public_key()
.to_encoded_point(false)
.as_bytes()[1..],
);

if let Some(json) = json_values.as_mut() {
json.push(json!({
"address": wallet.address().to_checksum(None),
"private_key": format!("0x{}", hex::encode(wallet.credential().to_bytes())),
}))
json.push(if shell::verbosity() > 0 {
json!({
"address": wallet.address().to_checksum(None),
"public_key": format!("0x{}", public_key),
"private_key": format!("0x{}", hex::encode(wallet.credential().to_bytes())),
})
} else {
json!({
"address": wallet.address().to_checksum(None),
"private_key": format!("0x{}", hex::encode(wallet.credential().to_bytes())),
})
});
} else {
sh_println!("Successfully created new keypair.")?;
sh_println!("Address: {}", wallet.address().to_checksum(None))?;
if shell::verbosity() > 0 {
sh_println!("Public key: 0x{}", public_key)?;
}
sh_println!(
"Private key: 0x{}",
hex::encode(wallet.credential().to_bytes())
Expand Down Expand Up @@ -377,15 +415,33 @@ impl WalletSubcommands {

let mut accounts = json!([]);
for (i, wallet) in wallets.iter().enumerate() {
let public_key = hex::encode(
&SecretKey::from_slice(&wallet.credential().to_bytes())
.map_err(|e| eyre::eyre!("Invalid private key: {}", e))?
.public_key()
.to_encoded_point(false)
.as_bytes()[1..],
);
let private_key = hex::encode(wallet.credential().to_bytes());
if format_json {
accounts.as_array_mut().unwrap().push(json!({
"address": format!("{}", wallet.address()),
"private_key": format!("0x{}", private_key),
}));
accounts.as_array_mut().unwrap().push(if shell::verbosity() > 0 {
json!({
"address": format!("{}", wallet.address()),
"public_key": format!("0x{}", public_key),
"private_key": format!("0x{}", private_key),
})
} else {
json!({
"address": format!("{}", wallet.address()),
"private_key": format!("0x{}", private_key),
})
});
} else {
sh_println!("- Account {i}:")?;
sh_println!("Address: {}", wallet.address())?;
if shell::verbosity() > 0 {
sh_println!("Public key: 0x{}", public_key)?;
}
sh_println!("Private key: 0x{private_key}\n")?;
}
}
Expand Down
153 changes: 151 additions & 2 deletions crates/cast/tests/cli/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use foundry_test_utils::{
next_etherscan_api_key, next_http_archive_rpc_url, next_http_rpc_endpoint,
next_rpc_endpoint, next_ws_rpc_endpoint,
},
snapbox::IntoData as _,
str,
util::OutputExt,
};
Expand Down Expand Up @@ -157,6 +158,60 @@ casttest!(finds_block, |_prj, cmd| {
"#]]);
});

// tests that we can create a new wallet
casttest!(new_wallet, |_prj, cmd| {
cmd.args(["wallet", "new"]).assert_success().stdout_eq(str![[r#"
Successfully created new keypair.
[ADDRESS]
[PRIVATE_KEY]

"#]]);
});

// tests that we can create a new wallet (verbose variant)
casttest!(new_wallet_verbose, |_prj, cmd| {
cmd.args(["wallet", "new", "-v"]).assert_success().stdout_eq(str![[r#"
Successfully created new keypair.
[ADDRESS]
[PUBLIC_KEY]
[PRIVATE_KEY]

"#]]);
});

// tests that we can create a new wallet with json output
casttest!(new_wallet_json, |_prj, cmd| {
cmd.args(["wallet", "new", "--json"]).assert_success().stdout_eq(
str![[r#"
[
{
"address": "{...}",
"private_key": "{...}"
}
]

"#]]
.is_json(),
);
});

// tests that we can create a new wallet with json output (verbose variant)
casttest!(new_wallet_json_verbose, |_prj, cmd| {
cmd.args(["wallet", "new", "--json", "-v"]).assert_success().stdout_eq(
str![[r#"
[
{
"address": "{...}",
"public_key": "{...}",
"private_key": "{...}"
}
]

"#]]
.is_json(),
);
});

// tests that we can create a new wallet with keystore
casttest!(new_wallet_keystore_with_password, |_prj, cmd| {
cmd.args(["wallet", "new", ".", "test-account", "--unsafe-password", "test"])
Expand All @@ -168,6 +223,18 @@ Created new encrypted keystore file: [..]
"#]]);
});

// tests that we can create a new wallet with keystore (verbose variant)
casttest!(new_wallet_keystore_with_password_verbose, |_prj, cmd| {
cmd.args(["wallet", "new", ".", "test-account", "--unsafe-password", "test", "-v"])
.assert_success()
.stdout_eq(str![[r#"
Created new encrypted keystore file: [..]
[ADDRESS]
[PUBLIC_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");
Expand Down Expand Up @@ -473,7 +540,8 @@ casttest!(wallet_mnemonic_from_entropy, |_prj, cmd| {
"0xdf9bf37e6fcdf9bf37e6fcdf9bf37e3c",
])
.assert_success()
.stdout_eq(str![[r#"
.stdout_eq(
str![[r#"
Generating mnemonic from provided entropy...
Successfully generated a new mnemonic.
Phrase:
Expand All @@ -493,7 +561,50 @@ Address: 0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC
Private key: 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a


"#]]);
"#]]
.raw(),
);
});

// tests that `cast wallet new-mnemonic --entropy` outputs the expected mnemonic (verbose variant)
casttest!(wallet_mnemonic_from_entropy_verbose, |_prj, cmd| {
cmd.args([
"wallet",
"new-mnemonic",
"--accounts",
"3",
"--entropy",
"0xdf9bf37e6fcdf9bf37e6fcdf9bf37e3c",
"-v",
])
.assert_success()
.stdout_eq(
str![[r#"
Generating mnemonic from provided entropy...
Successfully generated a new mnemonic.
Phrase:
test test test test test test test test test test test junk

Accounts:
- Account 0:
Address: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
Public key: 0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5
Private key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

- Account 1:
Address: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8
Public key: 0xba5734d8f7091719471e7f7ed6b9df170dc70cc661ca05e688601ad984f068b0d67351e5f06073092499336ab0839ef8a521afd334e53807205fa2f08eec74f4
Private key: 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d

- Account 2:
Address: 0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC
Public key: 0x9d9031e97dd78ff8c15aa86939de9b1e791066a0224e331bc962a2099a7b1f0464b8bbafe1535f2301c72c2cb3535b172da30b02686ab0393d348614f157fbdb
Private key: 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a


"#]]
.raw(),
);
});

// tests that `cast wallet new-mnemonic --json` outputs the expected mnemonic
Expand Down Expand Up @@ -530,6 +641,44 @@ casttest!(wallet_mnemonic_from_entropy_json, |_prj, cmd| {
"#]]);
});

// tests that `cast wallet new-mnemonic --json` outputs the expected mnemonic (verbose variant)
casttest!(wallet_mnemonic_from_entropy_json_verbose, |_prj, cmd| {
cmd.args([
"wallet",
"new-mnemonic",
"--accounts",
"3",
"--entropy",
"0xdf9bf37e6fcdf9bf37e6fcdf9bf37e3c",
"--json",
"-v",
])
.assert_success()
.stdout_eq(str![[r#"
{
"mnemonic": "test test test test test test test test test test test junk",
"accounts": [
{
"address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
"public_key": "0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5",
"private_key": "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
},
{
"address": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"public_key": "0xba5734d8f7091719471e7f7ed6b9df170dc70cc661ca05e688601ad984f068b0d67351e5f06073092499336ab0839ef8a521afd334e53807205fa2f08eec74f4",
"private_key": "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d"
},
{
"address": "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
"public_key": "0x9d9031e97dd78ff8c15aa86939de9b1e791066a0224e331bc962a2099a7b1f0464b8bbafe1535f2301c72c2cb3535b172da30b02686ab0393d348614f157fbdb",
"private_key": "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a"
}
]
}

"#]]);
});

// tests that `cast wallet private-key` with arguments outputs the private key
casttest!(wallet_private_key_from_mnemonic_arg, |_prj, cmd| {
cmd.args([
Expand Down
4 changes: 3 additions & 1 deletion crates/test-utils/src/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,7 +1015,9 @@ fn test_redactions() -> snapbox::Redactions {
("[FILE]", r"Location(.|\n)*\.rs(.|\n)*Backtrace"),
("[COMPILING_FILES]", r"Compiling \d+ files?"),
("[TX_HASH]", r"Transaction hash: 0x[0-9A-Fa-f]{64}"),
("[ADDRESS]", r"Address: 0x[0-9A-Fa-f]{40}"),
("[ADDRESS]", r"Address: +0x[0-9A-Fa-f]{40}"),
("[PUBLIC_KEY]", r"Public key: +0x[0-9A-Fa-f]{128}"),
("[PRIVATE_KEY]", r"Private key: +0x[0-9A-Fa-f]{64}"),
("[UPDATING_DEPENDENCIES]", r"Updating dependencies in .*"),
("[SAVED_TRANSACTIONS]", r"Transactions saved to: .*\.json"),
("[SAVED_SENSITIVE_VALUES]", r"Sensitive values saved to: .*\.json"),
Expand Down