Class: Mnemonic

Mnemonic

new Mnemonic(options)

HD Mnemonic

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Description
bit Number <nullable>

Bits of entropy (Must be a multiple of 8) (default=128).
entropy Buffer <nullable>

Entropy bytes. Will be generated with options.bits bits of entropy if not present.
phrase String <nullable>

Mnemonic phrase (will be generated if not present).
passphrase String <nullable>

Optional salt for key stretching (empty string if not present).
language String <nullable>

Language.
Source:

Methods

(static) getWordlist(language) → {Array.<String>}

Retrieve the wordlist for a language.

Parameters:
Name Type Description
language String
Source:
Returns:
Type
Array.<String>

(static) isMnemonic(obj) → {Boolean}

Test whether an object is a Mnemonic.

Parameters:
Name Type Description
obj Object
Source:
Returns:
Type
Boolean

createMnemonic() → {String}

Generate a mnemonic phrase from chosen language.

Source:
Returns:
Type
String

toSeed() → {Buffer}

Generate the seed.

Source:
Returns:

pbkdf2 seed.

Type
Buffer