pqbip39 0.2.0

A no_std compatible implementation of the BIP39 mnemonic code standard.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# pqbip39

A no_std compatible Rust implementation of the BIP-39 mnemonic code standard for generating and validating mnemonic phrases used in cryptocurrency wallets.

## Features

- Supports 12 to 33-word mnemonic phrases
- Generates seeds from mnemonics using PBKDF2
- Validates checksums and word counts
- Converts between entropy and mnemonic phrases
- Compatible with `no_std` environments
- Optional `std` and `zeroize` features
- Full mnemonic secret protection via `secrecy` crate — phrases, seeds, and entropy are wrapped in `SecretString`/`SecretBox`/`SecretSlice`

## Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
pqbip39 = "0.2.0"
```

## Usage

### Generating a Mnemonic

```rust
use pqbip39::{Mnemonic, rng::Rng};
use rand::rngs::OsRng;

const EN_WORDS: [&str; 2048] = [/* English BIP-39 wordlist */];

let mut rng = OsRng;
let mnemonic = Mnemonic::generate(&mut rng, &EN_WORDS, 12).unwrap();
let phrase = mnemonic.to_phrase(); // SecretString
println!("{:?}", phrase.expose_secret());
```

### Parsing a Mnemonic

```rust
use pqbip39::Mnemonic;
use secrecy::SecretString;

const EN_WORDS: [&str; 2048] = [/* English BIP-39 wordlist */];

let phrase = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
let mnemonic = Mnemonic::parse_str(&EN_WORDS, &SecretString::from(phrase)).unwrap();
```

### Parsing without Checksum Validation

```rust
let mnemonic = Mnemonic::parse_str_without_checksum(&EN_WORDS, &SecretString::from(phrase)).unwrap();
```

### Converting to Seed

```rust
let seed = mnemonic.to_seed(&SecretString::from("TREZOR")).unwrap();
// seed is SecretBox<[u8; 64]>, access via .expose_secret()
```

### Converting to Entropy

```rust
let entropy = mnemonic.to_entropy(); // SecretSlice<u8>
let bytes = entropy.expose_secret();
```

### Converting from Entropy

```rust
let mnemonic = Mnemonic::from_entropy(&EN_WORDS, &entropy_bytes).unwrap();
```

### Getting the Checksum

```rust
let checksum: u8 = mnemonic.checksum();
```

### Iterating Words

```rust
for word in mnemonic.words() { // yields SecretString
    println!("{:?}", word.expose_secret());
}
```

## Features

- `std` (default): Enables Unicode normalization via `unicode-normalization`.
- `zeroize`: Adds secure zeroing of sensitive data via the `zeroize` crate.

To disable `std` (for `no_std`):

```toml
[dependencies]
pqbip39 = { version = "0.2.0", default-features = false }
```

## Testing

Run tests with:

```bash
cargo test
```

The library includes comprehensive tests for English and Japanese wordlists, entropy conversion, checksum validation, and PBKDF2 seed generation, including BIP-39 test vectors.

## License

MIT

## Repository

[https://github.com/openzebra/pq_bip39.rs](https://github.com/openzebra/pq_bip39.rs)