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

//!
//! This is a Rust implementation of the [bip0039][bip0039-standard] standard for Bitcoin HD wallet
//! mnemonic phrases.
//!
//!
//! [bip0039-standard]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
//!
//! ## Quickstart
//!
//! ```rust
//! use bip0039::{Mnemonic, MnemonicType, Language, Seed};
//!
//! /// create a new randomly generated mnemonic phrase
//! let mnemonic = Mnemonic::new(MnemonicType::Words12, Language::English);
//!
//! /// get the phrase
//! let phrase: &str = mnemonic.phrase();
//! println!("phrase: {}", phrase);
//!
//! /// get the HD wallet seed
//! let seed = Seed::new(&mnemonic, "");
//!
//! // get the HD wallet seed as raw bytes
//! let seed_bytes: &[u8] = seed.as_bytes();
//!
//! // print the HD wallet seed as a hex string
//! println!("{:X}", seed);
//! ```
//!

#![deny(missing_docs, unused)]

mod crypto;
mod error;
mod language;
mod mnemonic;
mod mnemonic_type;
mod seed;
mod util;

pub use self::error::{Error, Result};
pub use self::language::Language;
pub use self::mnemonic::Mnemonic;
pub use self::mnemonic_type::MnemonicType;
pub use self::seed::Seed;