scure-bip39
Secure, audited & minimal implementation of BIP39 mnemonic phrases.
Compared to popular bip39
package, scure-bip39:
- Is 491KB all-bundled instead of 1.3MB
- Uses 2 dependencies instead of 15
- Wordlists are 157KB instead of 315KB
- Had an external security audit by Cure53 on Jan 5, 2022
Check out scure-bip32 if you need
hierarchical deterministic wallets ("HD Wallets").
This library belongs to scure
scure — secure, independently audited packages for every use case.
Usage
npm install @scure/bip39
Or
yarn add @scure/bip39
import * as bip39 from '@scure/bip39';
import { wordlist } from '@scure/bip39/wordlists/english';
const mn = bip39.generateMnemonic(wordlist);
console.log(mn);
const ent = bip39.mnemonicToEntropy(mn, wordlist)
bip39.entropyToMnemonic(ent, wordlist);
bip39.validateMnemonic(mn, wordlist);
await bip39.mnemonicToSeed(mn, 'password');
bip39.mnemonicToSeedSync(mn, 'password');
This submodule contains the word lists defined by BIP39 for Czech, English, French, Italian, Japanese, Korean, Simplified and Traditional Chinese, and Spanish. These are not imported by default, as that would increase bundle sizes too much. Instead, you should import and use them explicitly.
function generateMnemonic(wordlist: string[], strength?: number): string;
function mnemonicToEntropy(mnemonic: string, wordlist: string[]): Uint8Array;
function entropyToMnemonic(entropy: Uint8Array, wordlist: string[]): string;
function validateMnemonic(mnemonic: string, wordlist: string[]): boolean;
function mnemonicToSeed(mnemonic: string, passphrase?: string): Promise<Uint8Array>;
function mnemonicToSeedSync(mnemonic: string, passphrase?: string): Uint8Array;
All wordlists:
import { wordlist } from '@scure/bip39/wordlists/czech';
import { wordlist } from '@scure/bip39/wordlists/english';
import { wordlist } from '@scure/bip39/wordlists/french';
import { wordlist } from '@scure/bip39/wordlists/italian';
import { wordlist } from '@scure/bip39/wordlists/japanese';
import { wordlist } from '@scure/bip39/wordlists/korean';
import { wordlist } from '@scure/bip39/wordlists/simplified-chinese';
import { wordlist } from '@scure/bip39/wordlists/spanish';
import { wordlist } from '@scure/bip39/wordlists/traditional-chinese';
Security
The library has been audited by Cure53 on Jan 5, 2022. Check out the audit PDF & URL. See changes since audit.
- The library was initially developed for js-ethereum-cryptography
- At commit ae00e6d7, it
was extracted to a separate package called
micro-bip39
- After the audit we've decided to use NPM namespace for security. Since
@micro
namespace was taken, we've renamed the package to @scure/bip39
License
MIT License
Copyright (c) 2022 Patricio Palladino, Paul Miller (paulmillr.com)