@ethersproject/wordlists

What is @ethersproject/wordlists?

@ethersproject/wordlists is a part of the ethers.js library, which provides utilities for working with wordlists, such as those used in mnemonic phrases for cryptocurrency wallets. It supports multiple languages and allows for encoding and decoding of mnemonic phrases.

What are @ethersproject/wordlists's main functionalities?

Get Wordlist

This feature allows you to retrieve a specific wordlist, such as the English wordlist, and access individual words by their index.

const { wordlists } = require('@ethersproject/wordlists');
const englishWordlist = wordlists.en;
console.log(englishWordlist.getWord(0)); // 'abandon'

Get Wordlist Language

This feature allows you to get the language/locale of a specific wordlist.

const { wordlists } = require('@ethersproject/wordlists');
const englishWordlist = wordlists.en;
console.log(englishWordlist.locale); // 'en'

Get Word Index

This feature allows you to get the index of a specific word in the wordlist.

const { wordlists } = require('@ethersproject/wordlists');
const englishWordlist = wordlists.en;
console.log(englishWordlist.getWordIndex('abandon')); // 0

Other packages similar to @ethersproject/wordlists

bip39

The bip39 package provides similar functionality for working with mnemonic phrases, including generating and validating mnemonic phrases. It also supports multiple languages. Compared to @ethersproject/wordlists, bip39 is more focused on the BIP-39 standard for mnemonic phrases.

mnemonic

The mnemonic package is another library for generating and validating mnemonic phrases. It supports multiple languages and provides utilities for working with mnemonic phrases. It is similar to @ethersproject/wordlists but is more focused on mnemonic phrase generation and validation.

README

BIP39 Wordlists

EXPERIMENTAL

Supported Languages:

• en - English
• es - Spanish
• fr - French
• it - Italian
• ja - Japanese
• ko - Korean
• zh_cn - Chinese (simplified)
• zh_tw - Chinese (traditional)

Please see the ethers repository for more informations.

API

@TODO

Browser

In the browser distribution file, only the English word list is included in the root ethers pacakge. To include additional word lists, they must be added using additional <script> tags, after the root ethers library has been included.

@TODO: Examples and links to wordlists

License

MIT License