Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bitcoinjs/bip39

JavaScript implementation of Bitcoin BIP39: Mnemonic code for generating deterministic keys
https://github.com/bitcoinjs/bip39

bip bip39 bitcoin bitcoinjs javascript mnemonic

Last synced: 10 days ago
JSON representation

JavaScript implementation of Bitcoin BIP39: Mnemonic code for generating deterministic keys

Lists

README 

        
# BIP39



[![Build Status](https://travis-ci.org/bitcoinjs/bip39.png?branch=master)](https://travis-ci.org/bitcoinjs/bip39)

[![NPM](https://img.shields.io/npm/v/bip39.svg)](https://www.npmjs.org/package/bip39)



[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)



JavaScript implementation of [Bitcoin BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki): Mnemonic code for generating deterministic keys



## Reminder for developers



***Please remember to allow recovery from mnemonic phrases that have invalid checksums (or that you don't have the wordlist)***



When a checksum is invalid, warn the user that the phrase is not something generated by your app, and ask if they would like to use it anyway. This way, your app only needs to hold the wordlists for your supported languages, but you can recover phrases made by other apps in other languages.



However, there should be other checks in place, such as checking to make sure the user is inputting 12 words or more separated by a space. ie. `phrase.trim().split(/\s+/g).length >= 12`



## Removing wordlists from webpack/browserify



 Browserify/Webpack bundles can get very large if you include all the wordlists, so you can now exclude wordlists to make your bundle lighter.



 For example, if we want to exclude all wordlists besides chinese_simplified, you could build using the browserify command below.



 ```bash

$ browserify -r bip39 -s bip39 \

  --exclude=./wordlists/english.json \

  --exclude=./wordlists/japanese.json \

  --exclude=./wordlists/spanish.json \

  --exclude=./wordlists/italian.json \

  --exclude=./wordlists/french.json \

  --exclude=./wordlists/korean.json \

  --exclude=./wordlists/czech.json \

  --exclude=./wordlists/portuguese.json \

  --exclude=./wordlists/chinese_traditional.json \

   > bip39.browser.js

```



 This will create a bundle that only contains the chinese_simplified wordlist, and it will be the default wordlist for all calls without explicit wordlists.



 You can also do this in Webpack 5 using the `IgnorePlugin`. Here is an example of excluding all non-English wordlists



 ```javascript

 ...

 plugins: [

   new webpack.IgnorePlugin({

      checkResource(resource) {

        return /.*\/wordlists\/(?!english).*\.json/.test(resource)

      }

    }),

 ],

 ...

 ```



 This is how it will look in the browser console.



 ```javascript

> bip39.entropyToMnemonic('00000000000000000000000000000000')

"的 的 的 的 的 的 的 的 的 的 的 在"

> bip39.wordlists.chinese_simplified

Array(2048) [ "的", "一", "是", "在", "不", "了", "有", "和", "人", "这", … ]

> bip39.wordlists.english

undefined

> bip39.wordlists.japanese

undefined

> bip39.wordlists.spanish

undefined

> bip39.wordlists.italian

undefined

> bip39.wordlists.french

undefined

> bip39.wordlists.korean

undefined

> bip39.wordlists.czech

undefined

> bip39.wordlists.portuguese

undefined

> bip39.wordlists.chinese_traditional

undefined

```



 For a list of supported wordlists check the wordlists folder. The name of the json file (minus the extension) is the name of the key to access the wordlist.



 You can also change the default wordlist at runtime if you dislike the wordlist you were given as default.



 ```javascript

> bip39.entropyToMnemonic('00000000000000000000000000000fff')

"あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あいこくしん　あまい　ろんり"

> bip39.setDefaultWordlist('italian')

undefined

> bip39.entropyToMnemonic('00000000000000000000000000000fff')

"abaco abaco abaco abaco abaco abaco abaco abaco abaco abaco aforisma zibetto"

```



## Installation

``` bash

npm install bip39

```



## Examples

``` js

// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy

const mnemonic = bip39.generateMnemonic()

// => 'seed sock milk update focus rotate barely fade car face mechanic mercy'



bip39.mnemonicToSeedSync('basket actual').toString('hex')

// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'



bip39.mnemonicToSeedSync('basket actual')

// => 



// mnemonicToSeed has an synchronous version

// mnemonicToSeedSync is less performance oriented

bip39.mnemonicToSeed('basket actual').then(console.log)

// => 



bip39.mnemonicToSeed('basket actual').then(bytes => bytes.toString('hex')).then(console.log)

// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'



bip39.mnemonicToSeedSync('basket actual', 'a password')

// => 



bip39.validateMnemonic(mnemonic)

// => true



bip39.validateMnemonic('basket actual')

// => false

```



``` js

const bip39 = require('bip39')



// defaults to BIP39 English word list

// uses HEX strings for entropy

const mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')

// => abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about



// reversible

bip39.mnemonicToEntropy(mnemonic)

// => '00000000000000000000000000000000'

```