status-im/bip39
2
0
Fork 0
mirror of https://github.com/status-im/bip39.git synced 2025-02-16 22:46:39 +00:00
Code Issues Projects Releases Wiki Activity

README: rework examples and formatting

Browse Source
This commit is contained in:
Daniel Cousens 2016-10-06 01:08:45 +11:00
parent 60dd3ee035
commit e051671a63
1 changed files with 19 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -16,41 +16,36 @@ When a checksum is invalid, warn the user that the phrase is not something gener
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`
## Usage
`npm install bip39`
```javascript
var bip39 = require('bip39')
var mnemonic = bip39.entropyToMnemonic('133755ff') // hex input, defaults to BIP39 English word list
// 'basket rival lemon'
bip39.mnemonicToEntropy(mnemonic) // hex input, defaults to BIP39 English word list
// '133755ff'
// Generate a random mnemonic using crypto.randomBytes
mnemonic = bip39.generateMnemonic() // strength defaults to 128 bits
// 'seed sock milk update focus rotate barely fade car face mechanic mercy'
## 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'
// => '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 ...>
// => <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
// => true
bip39.validateMnemonic('basket actual')
// false
// => false
```
### Browser
Compile `bip39.js` with the following command:
``` js
var bip39 = require('bip39')
$ npm run compile
// defaults to BIP39 English word list
// uses HEX strings for entropy
var mnemonic = bip39.entropyToMnemonic('133755ff')
// => basket rival lemon
After loading this file in your browser, you will be able to use the global `bip39` object.
// reversible
bip39.mnemonicToEntropy(mnemonic)
// => '133755ff'
```