mirror of https://github.com/status-im/bip39.git
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# BIP39
|
|
|
|
[](https://travis-ci.org/bitcoinjs/bip39)
|
|
[](https://www.npmjs.org/package/bip39)
|
|
|
|
[](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`
|
|
|
|
|
|
## Examples
|
|
``` js
|
|
// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy
|
|
var mnemonic = bip39.generateMnemonic()
|
|
// => 'seed sock milk update focus rotate barely fade car face mechanic mercy'
|
|
|
|
bip39.mnemonicToSeedHex('basket actual')
|
|
// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'
|
|
|
|
bip39.mnemonicToSeed('basket actual')
|
|
// => <Buffer 5c f2 d4 a8 b0 35 5e 90 29 5b df c5 65 a0 22 a4 09 af 06 3d 53 65 bb 57 bf 74 d9 52 8f 49 4b fa 44 00 f5 3d 83 49 b8 0f da e4 40 82 d7 f9 54 1e 1d ba 2b ...>
|
|
|
|
bip39.validateMnemonic(mnemonic)
|
|
// => true
|
|
|
|
bip39.validateMnemonic('basket actual')
|
|
// => false
|
|
```
|
|
|
|
|
|
``` js
|
|
var bip39 = require('bip39')
|
|
|
|
// defaults to BIP39 English word list
|
|
// uses HEX strings for entropy
|
|
var mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')
|
|
// => zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong
|
|
|
|
// reversible
|
|
bip39.mnemonicToEntropy(mnemonic)
|
|
// => '133755ff'
|
|
```
|