2.0.2 • Published 10 months ago

@keeex/js-bip39 v2.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

@keeex/js-bip39

Expose basic BIP39 features (move between entropy and mnemonic, and generate seed).

This is heavily based on the bitcoinjs/bip39 project but made compatible with more environment than node/browser.

BIP39 basics

Standard: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki

BIP39 allows producing a "seed" using a list of mnemonics (words). To generate a new random key, the workflow is: generate a random "entropy" value (between 16 and 32 bytes), convert it into a list of mnemonics, then use that list of mnemonics to derive a seed. The seed can then be used in any deterministic ways to create cryptographic objects. (common usecase is to use it as a BIP32 seed).

This library exposes functions to move back and forth between entropy and mnemonics, and forward from mnemonics to seed.

It also provide a single-call function to produce a random seed/mnemonic pair.

Usage

Since this library uses @keeex/crypto it is needed to import a crypto provider before using any other functions.

Import @keeex/js-bip39/lib/bip39.js to get all functions.