feat: replace usize with WordCount enum for mnemonic generation#98
feat: replace usize with WordCount enum for mnemonic generation#98coreyphillips wants to merge 1 commit intorust-bitcoin:masterfrom
Conversation
- Add WordCount enum to restrict word counts to valid BIP39 values (12, 15, 18, 21 & 24) - Update generate(), generate_in(), and generate_in_with() to accept WordCount instead of usize - Update usage in comments and tests accordingly
caarloshenriq
left a comment
caarloshenriq
left a comment
There was a problem hiding this comment.
tACK
I tested the changes locally:
- Ran the full test suite (
cargo test) and all tests passed. - Performed manual tests by generating mnemonics with different
WordCountvariants (12, 18, and 24 words) usinggenerate,generate_in, andgenerate_in_with. - All generated mnemonics had the correct word count and the generation flow behaved as expected.
Everything worked as intended.
tnull
left a comment
tnull
left a comment
There was a problem hiding this comment.
Thanks for looking into this! While it's a nice API improvement, it's probably not super critical so I think we want to hold off on merging this until we have another, more critical change that would require breaking API anyways.
In the meantime, here are a few comments. Please also always disclose in the PR description and commit message if you utilized AI tooling. To this end, rewriting the PR description and commit messages to replace AI slop with concise descriptions would be appreciated. Thanks!
|
|
||
| impl WordCount { | ||
| /// Returns the word count as a usize value. | ||
| pub fn word_count(&self) -> usize { |
There was a problem hiding this comment.
Can we make this a impl From<WordCount> for usize?
| R: RngCore + CryptoRng, | ||
| { | ||
| let word_count = word_count.word_count(); | ||
| if is_invalid_word_count(word_count) { |
There was a problem hiding this comment.
I think we can remove this check now.
|
|
||
| let dbg = format!("{:?}", m); | ||
|
|
||
| assert!(dbg.starts_with("Mnemonic {") || dbg.starts_with("Mnemonic(") || dbg.contains("Mnemonic"), |
There was a problem hiding this comment.
These changes here seem unrelated? Please drop them.
3 participants
This PR:
WordCountenum to restrict word counts to valid BIP39 values (12,15,18,21&24)generate(),generate_in(), andgenerate_in_with()to acceptWordCountinstead ofusizeenum WordCount#97generate()now requires use of theWordCountenum for theword_countparameter.