bip39/lib.rs
1//!
2//! This is a Rust implementation of the [bip39][bip39-standard] standard for Bitcoin HD wallet
3//! mnemonic phrases.
4//!
5//!
6//! [bip39-standard]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
7//!
8//! ## Quickstart
9//!
10//! ```rust
11//! use bip39::{Mnemonic, MnemonicType, Language, Seed};
12//!
13//! /// create a new randomly generated mnemonic phrase
14//! let mnemonic = Mnemonic::new(MnemonicType::Words12, Language::English);
15//!
16//! /// get the phrase
17//! let phrase: &str = mnemonic.phrase();
18//! println!("phrase: {}", phrase);
19//!
20//! /// get the HD wallet seed
21//! let seed = Seed::new(&mnemonic, "");
22//!
23//! // get the HD wallet seed as raw bytes
24//! let seed_bytes: &[u8] = seed.as_bytes();
25//!
26//! // print the HD wallet seed as a hex string
27//! println!("{:X}", seed);
28//! ```
29//!
30mod error;
31mod language;
32mod mnemonic;
33mod mnemonic_type;
34mod seed;
35mod util;
36
37mod crypto;
38
39pub use error::ErrorKind;
40pub use language::Language;
41pub use mnemonic::Mnemonic;
42pub use mnemonic_type::MnemonicType;
43pub use seed::Seed;