Documentation

Wordlists

A Wordlist is a set of 2048 words used to encode private keys (or other binary data) that is easier for humans to write down, transcribe and dictate.

The BIP-39 standard includes several checksum bits, depending on the size of the mnemonic phrase.

A mnemonic phrase may be 12, 15, 18, 21 or 24 words long. For most purposes 12 word mnemonics should be used, as including additional words increases the difficulty and potential for mistakes and does not offer any effective improvement on security.

There are a variety of BIP-39 Wordlists for different languages, but for maximal compatibility, the English Wordlist is recommended.

CONSTANTS

<src>wordlists⇒ Record< string, Wordlist >

The available Wordlists by their ISO 639-1 Language Code.

(i.e. cz, en, es, fr, ja, ko, it, pt, zh_cn, zh_tw)

The dist files (in the /dist folder) have had all languages except English stripped out, which reduces the library size by about 80kb. If required, they are available by importing the included wordlists-extra.min.js file.

class LangCz

inherits from WordlistOwl, Wordlist

The Czech wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangCz.wordlist()⇒ LangCz

Returns a singleton instance of a LangCz, creating it if this is the first time being called.

class LangEn

inherits from WordlistOwl, Wordlist

The English wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangEn.wordlist()⇒ LangEn

Returns a singleton instance of a LangEn, creating it if this is the first time being called.

class LangEs

inherits from WordlistOwlA, WordlistOwl

The Spanish wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangEs.wordlist()⇒ LangEs

Returns a singleton instance of a LangEs, creating it if this is the first time being called.

class LangFr

inherits from WordlistOwlA, WordlistOwl

The French wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangFr.wordlist()⇒ LangFr

Returns a singleton instance of a LangFr, creating it if this is the first time being called.

class LangIt

inherits from WordlistOwl, Wordlist

The Italian wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangIt.wordlist()⇒ LangIt

Returns a singleton instance of a LangIt, creating it if this is the first time being called.

class LangJa

inherits from Wordlist

The Japanese wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangJa.wordlist()⇒ LangJa

Returns a singleton instance of a LangJa, creating it if this is the first time being called.

METHODS

<src>langJa.getWord(index: number)⇒ string

<src>langJa.getWordIndex(word: string)⇒ number

<src>langJa.join(words: Array< string >)⇒ string

<src>langJa.split(phrase: string)⇒ Array< string >

class LangKo

inherits from Wordlist

The Korean wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangKo.wordlist()⇒ LangKo

Returns a singleton instance of a LangKo, creating it if this is the first time being called.

METHODS

<src>langKo.getWord(index: number)⇒ string

<src>langKo.getWordIndex(word: string)⇒ number

class LangPt

inherits from WordlistOwl, Wordlist

The Portuguese wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangPt.wordlist()⇒ LangPt

Returns a singleton instance of a LangPt, creating it if this is the first time being called.

class LangZh

inherits from Wordlist

The Simplified Chinese wordlist and Tradional Chinese wordlist for mnemonic phrases.

CREATING INSTANCES

<src>LangZh.wordlist(dialect: string)⇒ LangZh

Returns a singleton instance of a LangZh for dialect, creating it if this is the first time being called.

Use the dialect "cn" or "tw" for simplified or traditional, respectively.

METHODS

<src>langZh.getWord(index: number)⇒ string

<src>langZh.getWordIndex(word: string)⇒ number

<src>langZh.split(phrase: string)⇒ Array< string >

abstract class Wordlist

A Wordlist represents a collection of language-specific words used to encode and devoce BIP-39 encoded data by mapping words to 11-bit values and vice versa.

PROPERTIES

<src>wordlist.locale⇒ string

CREATING INSTANCES

<src>new Wordlist(locale: string)

Creates a new Wordlist instance.

Sub-classes MUST call this if they provide their own constructor, passing in the locale string of the language.

Generally there is no need to create instances of a Wordlist, since each language-specific Wordlist creates an instance and there is no state kept internally, so they are safe to share.

METHODS

<src>wordlist.getWord(index: number)⇒ stringabstract

Maps an 11-bit value into its coresponding word in the list.

Sub-classes MUST override this.

<src>wordlist.getWordIndex(word: string)⇒ numberabstract

Maps a word to its corresponding 11-bit value.

Sub-classes MUST override this.

<src>wordlist.join(words: Array< string >)⇒ string

Sub-classes may override this to provider a language-specific method for joining words into a phrase.

By default, words are joined by a single space.

<src>wordlist.split(phrase: string)⇒ Array< string >

Sub-classes may override this to provide a language-specific method for spliting phrase into individual words.

By default, phrase is split using any sequences of white-space as defined by regular expressions (i.e. /s+/).

class WordlistOwl

inherits from Wordlist

An OWL format Wordlist is an encoding method that exploits the general locality of alphabetically sorted words to achieve a simple but effective means of compression.

This class is generally not useful to most developers as it is used mainly internally to keep Wordlists for languages based on ASCII-7 small.

If necessary, there are tools within the generation/ folder to create these necessary data.

PROPERTIES

<src>wordlistOwl._data⇒ stringread-only

CREATING INSTANCES

<src>new WordlistOwl(locale: string, data: string, checksum: string)

Creates a new Wordlist for locale using the OWL data and validated against the checksum.

METHODS

<src>wordlistOwl._decodeWords()⇒ Array< string >

<src>wordlistOwl.getWord(index: number)⇒ string

<src>wordlistOwl.getWordIndex(word: string)⇒ number

class WordlistOwlA

inherits from WordlistOwl, Wordlist

An OWL-A format Wordlist extends the OWL format to add an overlay onto an OWL format Wordlist to support diacritic marks.

This class is generally not useful to most developers as it is used mainly internally to keep Wordlists for languages based on latin-1 small.

If necessary, there are tools within the generation/ folder to create these necessary data.

PROPERTIES

<src>wordlistOwlA._accent⇒ stringread-only

CREATING INSTANCES

<src>new WordlistOwlA(locale: string, data: string, accent: string, checksum: string)

METHODS

<src>wordlistOwlA._decodeWords()⇒ Array< string >