Repository navigation
Description
Describe the bug
key generate accepts any integer for --entropy but only distinguishes 12 from everything else. The match arm is:
let mnemonic_type = match self.word_count {
12 => WordCount::Words12,
_ => WordCount::Words24,
};So --entropy 15 produces a 24-word mnemonic, --entropy 0 produces a 24-word mnemonic, and --entropy 999 produces a 24-word mnemonic. No error, no warning, no indication that the requested value was ignored. BIP39 defines five valid lengths: 12, 15, 18, 21, 24 and bdk_wallet::keys::bip39 WordCount already support all five, so the restriction is purely in the CLI's argument handling.
To Reproduce
- Request a 15-word mnemonic:
bdk-cli key generate --entropy 15
- Count the words in the output: it is 24, not 15.
- Confirm nonsense values are also accepted without error:
This also produces 24 words.
bdk-cli key generate --entropy 0
Expected behavior
--entropy 15 should produce a 15-word mnemonic, since the library supports it. Invalid values such as 0, 13, or 999 should be rejected at parse time with a message listing the valid options, not silently coerced. PossibleValuesParser or a custom value_parser handles both:
#[arg(
long = "entropy",
short = 'w',
default_value = "WordCount::Words12",
value_parser = word_count_parser
)]
pub word_count: WordCount,in the word_count_parser:
let word_count = match word_count {
"12" => WordCount::Words12,
"15" => WordCount::Words15,
"18" => WordCount::Words18,
"21" => WordCount::Words21,
"24" => WordCount::Words24,
_ => return(Error::Generic("...")),
};The change is confined to KeySubCommand::Generate; no library or API changes are needed.
Build environment
· BDK-CLI tag/commit: main
· OS+version: macOS 12.7.6 (Monterey)
· Rust/Cargo version: rustc --version output
· Rust/Cargo target: x86_64-apple-darwin
Additional context
The silent coercion means a user's request is never honoured unless it happens to be exactly 12, and the failure mode is invisible. The command just succeeds and returns a valid mnemonic of the wrong length. Since usize parsing already rejects negative values, the only way to reach the match arm with an unintended value is a typo or an unsupported length, and both currently produce 24 words with no diagnostic. Validating at the clap boundary fixes both the missing lengths and the silent acceptance in a single change.
Metadata
Metadata
Assignees
Labels
Type
Projects
- StatusShow more project fieldsDone
Activity
Olorunshogo commentedon Oct 24, 2026
I would like to work on this and I intend to do it in the following ways:
WordCountusingPossibleValuesParserrestricted to 12/15/18/21/24, so invalid values fail at parse time and--helplists the optionsHappy to adjust if you would prefer a different approach.
emma31-dev commentedon Oct 24, 2026
@Olorunshogo I initially planned to work on this but sure you can proceed. I'll review your changes later.
Olorunshogo commentedon Oct 24, 2026
Implemented this according to plan and this fix now accepts all five BIP39 lengths (12, 15, 18, 21, 24) and rejects anything else at parse time with the valid options listed. The flag name, env var and default are unchanged.
Ready for review.
vadim-anfv commentedon Nov 3, 2026
Good catch!
One thing to fix in the description: it uses
--word-count, but the code currently has--entropy(WORD_COUNTis only the env var name), so the commands as written fail witherror: unexpected argument '--word-count' found.Could you update it so the description matches the code? I do agree
--word-countis the better name, and I'll open a separate issue for the rename once #366 is merged, I have a couple of other thoughts on this code to put in it.Reproduced locally on master, got 24 words for all commands:
emma31-dev commentedon Nov 3, 2026
I'll update it. I forgot to do so earlier.
Merge bitcoindevkit#366: fix(key): reject word counts other than 12 a…