bitcoinjs / bip39 Goto Github PK

[akegalj@notebook npm]$ npm i [email protected] --save
npm WARN saveError ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
/home/akegalj/projects/iohk/npm
└─┬ [email protected] 
  ├─┬ [email protected] 
  │ ├─┬ [email protected] 
  │ │ └── [email protected]  deduped
  │ ├── [email protected] 
  │ ├─┬ [email protected] 
  │ │ ├─┬ [email protected] 
  │ │ │ └── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ └─┬ [email protected] 
  │   └── [email protected]  deduped
  ├─┬ [email protected] 
  │ ├── [email protected]  deduped
  │ ├─┬ [email protected] 
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ ├── [email protected]  deduped
  │ ├── [email protected] 
  │ └── [email protected]  deduped
  ├── [email protected] 
  └── [email protected] 

npm WARN enoent ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
npm WARN npm No description
npm WARN npm No repository field.
npm WARN npm No README data
npm WARN npm No license field.
[akegalj@notebook npm]$ ls
node_modules
[akegalj@notebook npm]$ node
> var bip = require('bip39')
undefined
> bip.generateMnemonic()
'hair skate prison broken park great twin gauge cool jewel pear shy'
> bip.generateMnemonic(96)
'renew milk guide erode accuse opinion soda bus fold'

[akegalj@notebook npm]$ rm -rf node_modules/
[akegalj@notebook npm]$ npm i [email protected] --save
npm WARN saveError ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
/home/akegalj/projects/iohk/npm
└─┬ [email protected] 
  ├─┬ [email protected] 
  │ ├─┬ [email protected] 
  │ │ └── [email protected]  deduped
  │ ├── [email protected] 
  │ ├─┬ [email protected] 
  │ │ ├─┬ [email protected] 
  │ │ │ └── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ └─┬ [email protected] 
  │   └── [email protected]  deduped
  ├─┬ [email protected] 
  │ ├── [email protected]  deduped
  │ ├─┬ [email protected] 
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ ├── [email protected]  deduped
  │ ├── [email protected] 
  │ └── [email protected]  deduped
  ├── [email protected] 
  └── [email protected] 

npm WARN enoent ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
npm WARN npm No description
npm WARN npm No repository field.
npm WARN npm No README data
npm WARN npm No license field.
[akegalj@notebook npm]$ node
> var bip = require('bip39')
undefined
> bip.generateMnemonic()
'bracket what scene civil soldier master crop peace hub paddle cross comic'
> bip.generateMnemonic(96)
'oven need prosper kitten vessel offer stable wasp ready'

[akegalj@notebook npm]$ rm -rf node_modules/
[akegalj@notebook npm]$ npm i [email protected] --save
npm WARN saveError ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
/home/akegalj/projects/iohk/npm
└─┬ [email protected] 
  ├─┬ [email protected] 
  │ ├─┬ [email protected] 
  │ │ └── [email protected]  deduped
  │ ├── [email protected] 
  │ ├─┬ [email protected] 
  │ │ ├─┬ [email protected] 
  │ │ │ └── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ └─┬ [email protected] 
  │   └── [email protected]  deduped
  ├─┬ [email protected] 
  │ ├── [email protected]  deduped
  │ ├─┬ [email protected] 
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ ├── [email protected]  deduped
  │ │ └── [email protected]  deduped
  │ ├── [email protected]  deduped
  │ ├── [email protected]  deduped
  │ └── [email protected]  deduped
  ├── [email protected] 
  ├── [email protected] 
  └── [email protected] 

npm WARN enoent ENOENT: no such file or directory, open '/home/akegalj/projects/iohk/npm/package.json'
npm WARN npm No description
npm WARN npm No repository field.
npm WARN npm No README data
npm WARN npm No license field.
[akegalj@notebook npm]$ node
> var bip = require('bip39')
undefined
> bip.generateMnemonic()
'churn purse awful tent grid teach super target flash glance indoor warm'
> bip.generateMnemonic(96)
TypeError: Invalid entropy
    at entropyToMnemonic (/home/akegalj/projects/iohk/npm/node_modules/bip39/index.js:94:37)
    at Object.generateMnemonic (/home/akegalj/projects/iohk/npm/node_modules/bip39/index.js:120:10)
    at repl:1:5
    at ContextifyScript.Script.runInThisContext (vm.js:23:33)
    at REPLServer.defaultEval (repl.js:339:29)
    at bound (domain.js:280:14)
    at REPLServer.runBound [as eval] (domain.js:293:12)
    at REPLServer.onLine (repl.js:536:10)
    at emitOne (events.js:101:20)
    at REPLServer.emit (events.js:191:7)
> 

Hm, it looks to me its a breaking change. At least it broke our package :)

Don't you think this should be major change bump at least. I would even call this a breaking change and maybe bump to 3.0.0

https://github.com/bitcoin/bips/tree/master/bip-0039

I am creating a btc wallet in javascript with this this library to generate the seed.

In order to get a little more safe, and to avoid the typing soemthing like
npm install bip-39
add the command to add the bip 39 to the README.md.

Just as bitcoinlib-js:

(I didn't do the PR myself to not come as imposing, if everyone agrees, I will gladly do it).

It should probably additionally throw on empty string? But maybe someone has a use case there...

Additionally:

• enforce no duplicate whitespace
• enforce non-zero length
• enforce only printable characters

would you consider a smaller PR that adds ESM bundling and/or exports all functions in separate files to allow cherry picking imports?

@timhwang21 see #81 - maybe source is still too small to make bundling a reasonably important issue. Or maybe you meant about dependencies? By only importing, say, the encoding part, you would be able to skip all the generator-related stuff.

Excuse me! Is there any method to translate keystore / private key to mnemonic, or is it possible? Thank you!

I've Browserified the library using npm run compile and many other ways, but every time I do I get the same error of Buffer is not defined from the create-hash module (helpers.js, line 3). Have you gotten this issue before in the browser?

i use bitcoinjs\bip39 ,generate the word "futal" but not in your wordlist

To prevent accidental merging before tests pass, like in #33, branch protection has been enabled for all contributors and administrators.

Right now, if you want to import just one function in bip39 you must import the entire bundle. This can add unnecessary code to already large apps, making them larger. I propose that each function be written in their own files so that they can be imported independently of one another.

My specific concerns here are the the unorm dependency and words list files, which are quite large and not required for all of these utility functions.

Note: I plan to PR this repo with this change, but am open to thoughts in the meantime :)

I found a call to mnemonicToEntropy which isn't returning the correct entropy. To reproduce:

let entropy = "ea9d80e70b08bbfb6b7f2bca56c88ddb2c2d003e675a855779d81e11f3009346a";
let mnemonic = bip39.entropyToMnemonic(entropy);
// 'tunnel ugly degree bid merry world pupil tornado ski rent casino rent security length wet twice luxury rookie invite destroy busy leopard escape shoe'

let rand = bip39.mnemonicToEntropy(mnemonic);
// 'ea9d80e70b08bbfb6b7f2bca56c88ddb2c2d003e675a855779d81e11f3009346'

The returned entropy is missing an a at the end. This is the only case where I've found that mnemonicToEntropy doesn't return the correct entropy.

Thanks for a great library!

I called this function btw I received

{“_40”:0,”_65”:0,”_55”:null,”_72”:null}
generateMnemonic = async () => {
  try {
    return await bip39.generateMnemonic(256) // default to 128
  } catch(e) {
    return false
  }
}

//=>  {“_40”:0,”_65”:0,”_55”:null,”_72”:null}

Could you help me? Looking forward to your reply. Thanks.

Just wanting to use this without specifying the repository URL :)

How can I call generateMnemonic with non-english wordlist? I can't get it to work.

choosing "strength" works fine: bip39.generateMnemonic(256) .
But I can't seem to choose a specific wordlist, e.g. french.

Help appreciated.

I'm interested in using this in a browser-context. Is that possible?
currently, I have issues with safe-buffer not existing when I try to use this library.

thanks!

I tried to install bip39 to my react-native app, but when I try to generateMnemonic. I get this error.

Here is what I did :

1. npm install bip39
2. Code: import bip39 from 'bip39'; generateMnemonic() { const mnemonic = bip39.generateMnemonic(); console.log(mnemonic); }.

Please help me out on this

Hey!

Thanks for nice library :) Is it possible to compile it for browser usage?

Hi
In this line

var mnemonic = bip39.entropyToMnemonic('133755ff') // hex input, defaults to BIP39 English word list

what is the 133755ff? is this a random string we enter inorder to create entropy? more entropy?

How can I generate a seed that is 32 bytes for a mnemonic? My focus is that the seed is 32 bytes, nothing else.

Doesn't String.prototype.normalize is supported now by most of the browsers?
May be unorm dependency should be removed and polyfills should be set by builders script of projects using this library?

`import bip39 from 'react-native-bip39';

var mnemonic = bip39.generateMnemonic();`

I get an error "Unable to resolve module 'assert' from '----/node_modules/react-native-bip39/index.js':
Module 'assert' does not exist in the Haste module map .

Anyone please help me out!

lets say I already have a 128bit Uint8Array, representing a private key.

How would I generate a mnemonic from that?

Could you please release and publish a new version with the RNG changes?

It appears that this code is nodejs dependent - using "require" as far as I'm aware is specific to Nodejs.

If nodejs dependence is intended then maybe documenting that in README.md would be good. (I'd do a pull request, but I'm not sure if that dependence is intended/fixable).

It might be good also to point at non-nodejs versions. I see https://github.com/ggozad/mnemonic.js/blob/master/mnemonic.js on GIT but there might be others.

I'm try to get mnemonic with privateKey, get error: TypeError: Invalid entropy

privateKey like this: 0xbe03b2771ad49bac7dda1980687fdb1b5b4fce6a5ec7597923c3e3460687a576

my code like this:

const bip39 = require('bip39')
let mnemonic = bip39.entropyToMnemonic(String(privateKey))

is there any mistake i make?

See #48

To support custom separators, the download script needs to be modified.

Proposed form

{
  separator: '...',
  words: [...]
}

Hello,

I’ve added TypeScript support for this module in DefinitelyTyped.

Could you help review th PR at DefinitelyTyped/DefinitelyTyped#22489 ?

Like in #28, though that PR needs to rebased.
Will re-open it when I go to do this.

const mnemonic = bip39.generateMnemonic(); const seed = bip39.mnemonicToSeedHex(mnemonic);
When I run this code, I always have the above error

It seems that mnemonicToSeed() returns a Buffer that contains "too much" entropy? https://github.com/bitcoinjs/bip39/blob/v2.5.0/index.js#L99 will then throw an Exception when I try to feed that entropy seed back into entropyToMnemonic()

Below I share the code with which I tried to create a password derived mnemonic with a passphrase based on the optional BIP39 spec with the bip39.js library. I also add a code snippet of how to achieve the encryption using bitcore-mnemonic

// bip39.js
var mnemonic = bip39.generateMnemonic(256);
var seedFromFirstMnemonic = bip39.mnemonicToSeed(mnemonic, "password");
// next line throws
var encryptedSecondMnemonic = bip39.entropyToMnemonic(seedFromFirstMnemonic);

// bitcore-mnemonic
var mnemonic = new Mnemonic(256, Mnemonic.Words.ENGLISH);
var seed = mnemonic.toSeed("password");
var encryptedMnemonic = Mnemonic.fromSeed(seed, Mnemonic.Words.ENGLISH);

The Exception thrown is

lacksfish@computer:~/tmp/path$ node mnemonic-crypt.js
/tmp/path/bip39/index.js:99
  if (entropy.length > 32) throw new TypeError(INVALID_ENTROPY)
                           ^

TypeError: Invalid entropy
    at Object.entropyToMnemonic (/tmp/path/bip39/index.js:99:34)
    at Object.<anonymous> (/tmp/path/mnemonic-crypt.js:7:37)
    at Module._compile (module.js:653:30)
    at Object.Module._extensions..js (module.js:664:10)
    at Module.load (module.js:566:32)
    at tryModuleLoad (module.js:506:12)
    at Function.Module._load (module.js:498:3)
    at Function.Module.runMain (module.js:694:10)
    at startup (bootstrap_node.js:204:16)
    at bootstrap_node.js:625:3

Most likely I'm doing something wrong. Although what is confusing is that bitcore-mnemonic seems to be using the seed/entropy Buffer the way I'd have expected... ( see https://github.com/bitpay/bitcore-mnemonic/blob/master/lib/mnemonic.js#L71)

Environment: Ubuntu 18.04 , Node v8.12.0

hello, I am using this lib in a react & webpack app, and when importing this lib, i've noticed it brings all wordlists into the bundle.

is there a way to exclude the non-english wordlists? or is a version without the non-english wordlists?

I tried to use Webpack IgnorePlugin, to ignore them, but when running the app there is an error

Uncaught Error: Cannot find module "./wordlists/chinese_simplified.json"
at vendors_a853dca288e8f1c5a51a.js:1
at Object. (vendors_a853dca288e8f1c5a51a.js:1)
at e (vendors_a853dca288e8f1c5a51a.js:1)
at Object. (main_17b4f38a6590aae27c42.js:1)
at e (vendors_a853dca288e8f1c5a51a.js:1)
at Object. (main_17b4f38a6590aae27c42.js:1)
at e (vendors_a853dca288e8f1c5a51a.js:1)
at Object. (main_17b4f38a6590aae27c42.js:1)
at e (vendors_a853dca288e8f1c5a51a.js:1)
at Object. (main_17b4f38a6590aae27c42.js:1)

Hello,
while programming it's nice to have the wordlist you provide in this package, and more so it would be useful if you could do a newer release with other bip39 accepted wordlist as available here:

https://github.com/bitcoin/bips/tree/master/bip-0039

In particular for Italian, French and Spanish.

I'm attempting to use the library with MeteorJs instead of browserify. Everything works fine on the server side, on the client I'm running into an Exception with message

Error: Private key must be less than the curve order

On the client the following works fine
var key = bitcoin.ECPair.makeRandom();
console.log(key.getAddress());

But if I want to generate keys through mnuemonic phrases instead I get the above exception. See code below.

this.mnemonic = bip39.generateMnemonic();
let mnemonicSeedHex = bip39.mnemonicToSeedHex(this.mnemonic);
let node = bitcoin.HDNode.fromSeedHex(mnemonicSeedHex, bitcoin.networks.testnet);
console.log(node.getAddress());

I assume its something down to Buffer in the browser?

I am trying to use this library to generate keys. I have:

let seed        = bip39.mnemonicToSeed(mnemonic);
let master      = bitcoin.HDNode.fromSeedBuffer(seed, bitcoin.networks['testnet']);
let derived     = master.deriveHardened(0).toBase58();

But the result is not consistent with: http://bip32.org/

Dude would like to go both directions from hex -> wordlist. wordlist -> original hex.

Not a crypto Dude, so I'm just asking. Is mnemonicToEntropy() possible?

Can you implement it please?

I have merged a new interface for async usage of pbkdf2. This has increased performance greatly for some users.

@weilu @dcousens

I was wondering if this library supported passphrase protecting mnemonic phrases. It is described in the "From mnemonic to seed" section of the bip39 white paper. I am looking for the type of functionality found in Ian Coleman Web Wallet , BIP39 Passphrase (optional) section. Thank you for the help.

• Add a script to download/verify the word lists against BIP39

Hello, is there a way to contribute to the development of bip39 ? I've created a 2048 brazilian portuguese wordlist and I'd like to open a pull request, or at least send it to the developers in some way...

In my JavaScript app (browser) bip39.mnemonicToSeed(seedPhrase) takes about 1500ms.

Is there anyway to improve the speed of this function?

I was trying to figure out how to optimize bip39 a bit for mobile (cordova), the sjcl package is about 10x faster for me than the pbkdf package, could be interesting to switch?

• note you have to ./configure --with-sha512 --with-hmac --with-pbkdf2 --with-bitArray && make the sjcl, the default npm package does not contain sha512.... *

var sjcl = require('sjcl');
var pbkdf = require('pbkdf');

var mnemonic = "later arrest fit foil goat excess online question trumpet grape license term bounce job nominee nuclear credit artefact measure record buyer service husband april tower average athlete pole alpha law picnic tail prepare satisfy dizzy hire illness legal forum rain sniff ask asthma pond present beach either minimum";
var salt = "roooooooobs";
var mnemonicBuffer = new Buffer(mnemonic, 'utf8');
var saltBuffer = new Buffer(password, 'utf8');

t = (new Date).getTime();

console.log(typeof sjcl.hash.sha512);

var hmacSHA512 = function (key) {
    var hasher = new sjcl.misc.hmac( key, sjcl.hash.sha512 );
    this.encrypt = function () {
        return hasher.encrypt.apply( hasher, arguments );
    };
};

var sjclResult = sjcl.misc.pbkdf2(sjcl.codec.utf8String.toBits(mnemonic), sjcl.codec.utf8String.toBits(salt), 2048, 64 * 8, hmacSHA512);
console.log("sjcl.misc.pbkdf2 " + ((new Date).getTime() - t));
console.log(sjcl.codec.hex.fromBits(sjclResult));

t = (new Date).getTime();

var pbkdf2Result = pbkdf2.pbkdf2Sync(mnemonicBuffer, saltBuffer, 2048, 64, 'sha512');
console.log("pbkdf2.pbkdf2Sync " + ((new Date).getTime() - t));
console.log(pbkdf2Result.toString('hex'));

I'm looking at bip-0039 and I'm not sure why you have this check to make sure the brain seed word count is divisible by 3:

https://github.com/bitcoinjs/bip39/blob/v2.3.0/index.js#L34

Maybe I missed something but I don't see this checking either:
https://github.com/bitpay/bitcore-mnemonic/blob/v1.2.5/lib/mnemonic.js#L110

I'm attempting to generate the private key (not the extended private key, although if the path to generating the private key is through that then that'd be interesting). However I'm having a lot of difficulty.

Is the seed generated from mneumonicToSeed or mneumonicToSeedHex considered a private key or master private key? Does this definition differ between different currencies? i.e. Bitcoin and Ethereum?

As discussed a while back, if you're still up to it.

Hi there, can you cut a release to npm. I want to pick up the recent korean language add. cheers 👍

currently word lists are loaded all at start-up, while realistically the user only ever needs to use one at a time. The suggestion is to make word-lists initialize lazily, and only after the language choice has been made. This abstraction could be hidden in a separate js file to make the main file less verbose. (Imho 154 lines is verbose. You might have taller screens / bigger heads than me, YMMW :-p)

• Isolation of wordlists from primary export (#71)
• Remove mnemonicToSeedHex, remove implicit hex support, Buffer only
• safe-buffer
• Removal of mnemonicToEntropy and entropyToMnemonic from the public API
• Change to async pbkdf2, aka, an async API (#72)

Thoughts any/everyone?