Crate bip39_dict

BIP39 dictionary

This can be used to convert arbitrary binary to a sequence of words (from the BIP39 wordlist) with a user-chosen checksum.

The API can be used to generate the exact same procedure as BIP39 document, and can be used to generate a standard BIP39 hdwallet root secret key.

It also extends the available procedure to allow user to use an arbitrary number of words, chose different size checksum, and finally for seed making tweak the number of iteration and output size to the user need.

For more details about the BIP39 protocol, see Bitcoin Improvement Proposal 39

Rules of encoding

Each BIP39 word represent 11 bits, and the scheme can encode any byte size.

The data are all multiple of 8 bits, aka bytestream, and the number of words represent a multiple of 11 bits. The checksum is the difference of the two and thus the following relation need to hold for:

data.len() * 8 + checksum = words.len() * 11

The following are examples of valid encoding:

• 1 byte data (8 bits) + 3 bits checksum = 1 word (11 bits)
• 2 bytes data (16 bits) + 6 bits checksum = 2 words (22 bits)
• 2 bytes data (16 bits) + 17 bits checksum = 3 words (33 bits)

Example

Convert an arbitrary 48 bytes entropy value to mnemonics

use bip39_dict::{Entropy, ENGLISH, seed_from_mnemonics};
// Entropy is a 48-bytes value

// create a 36 words mnemonics with 12 bits checksum
let mnemonics = entropy.to_mnemonics::<36, 12>().unwrap();
let mnemonics_string = mnemonics.to_string(&ENGLISH);

To create a new HDWallet root secret key

use bip39_dict::{Entropy, ENGLISH, seed_from_mnemonics};

// first, you need to generate some entropy (dummy)
let entropy = Entropy::<16>::generate(|| 1);

// human readable mnemonics (in English) to retrieve the original entropy
// and eventually recover a HDWallet.
let mnemonics = entropy.to_mnemonics::<12, 4>().unwrap();

// The seed of the Wallet is generated from the mnemonic string
// in the associated language.
let seed: [u8; 64] = seed_from_mnemonics(&ENGLISH, &mnemonics, b"some password", 2048);

Structs

DefaultDictionary

Default Dictionary basic support for the different main languages. This dictionary expect the inputs to have been normalized (UTF-8 NFKD).

Entropy

Entropy is a random piece of data

MnemonicIndex

Safe representation of a valid mnemonic index (see MAX_MNEMONIC_VALUE).

Mnemonics

Language agnostic mnemonic phrase representation.

WordNotFound

Errors associated to a given language/dictionary

Enums

EntropyError

Possible error when trying to create entropy from the mnemonics

MnemonicError

Error during convertion from string

Constants

ENGLISH

default English dictionary as provided by the BIP39 standard

Traits

Language

trait to represent the the properties that needs to be associated to a given language and its dictionary of known mnemonic words.

Functions

seed_from_mnemonics

get the seed from the given Mnemonics and the given password.