bip0039 0.10.0

Another Rust implementation of BIP-0039 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

# bip0039

[![ga-svg]][ga-url]
[![crates-svg]][crates-url]
[![docs-svg]][docs-url]
[![msrv-svg]][msrv-url]
[![codecov-svg]][codecov-url]
[![deps-svg]][deps-url]

[ga-svg]: https://github.com/koushiro/bip0039/workflows/test/badge.svg
[ga-url]: https://github.com/koushiro/bip0039/actions
[crates-svg]: https://img.shields.io/crates/v/bip0039
[crates-url]: https://crates.io/crates/bip0039
[docs-svg]: https://docs.rs/bip0039/badge.svg
[docs-url]: https://docs.rs/bip0039
[msrv-svg]: https://img.shields.io/badge/rustc-1.56+-blue.svg
[msrv-url]: https://blog.rust-lang.org/2021/10/21/Rust-1.56.0.html
[codecov-svg]: https://img.shields.io/codecov/c/github/koushiro/bip0039
[codecov-url]: https://codecov.io/gh/koushiro/bip0039
[deps-svg]: https://deps.rs/repo/github/koushiro/bip0039/status.svg
[deps-url]: https://deps.rs/repo/github/koushiro/bip0039

Another Rust implementation of [BIP-0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) standard.

## Usage

- Add the `bip0039` into the `Cargo.toml`.

  ```toml
  [dependencies]
  bip0039 = "0.9"
  ```

- Generate a random BIP-0039 mnemonic in English.
  ```rust
  use bip0039::{Count, Mnemonic};

  /// Generates an English mnemonic with 12 words randomly
  let mnemonic = Mnemonic::generate(Count::Words12);
  /// Gets the phrase
  let phrase = mnemonic.phrase();
  /// Generates the HD wallet seed from the mnemonic and the passphrase.
  let seed = mnemonic.to_seed("");
  ```

## Documentation

See documentation and examples at https://docs.rs/bip0039.

## Features

- [x] Support all languages in the [BIP-0039 Word Lists](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md)
  - [x] English
  - [x] Japanese
  - [x] Korean
  - [x] Spanish
  - [x] Chinese (Simplified)
  - [x] Chinese (Traditional)
  - [x] French
  - [x] Italian
  - [x] Czech
  - [x] Portuguese
- [x] Support `no_std` environment

## Alternatives

- [bip39](https://github.com/rust-bitcoin/rust-bip39)
- [tiny-bip39](https://github.com/maciejhirsz/tiny-bip39)

## License

Licensed under either of

- [Apache License, Version 2.0](LICENSE-APACHE)
- [MIT License](LICENSE-MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.