bip39 - npm Package Compare versions

Comparing version 2.6.0 to 3.0.0

package.json

 {
   "name": "bip39",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "description": "Bitcoin BIP39: Mnemonic code for generating deterministic keys",
-  "main": "index.js",
-  "files": [
-    "wordlists"
-  ],
+  "main": "src/index.js",
+  "types": "./types/index.d.ts",
   "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "clean": "rm -rf src",
     "coverage": "nyc --branches 100 --functions 100 --check-coverage npm run unit",
-    "standard": "standard",
-    "test": "npm run standard && npm run unit",
+    "format": "npm run prettier -- --write",
+    "format:ci": "npm run prettier -- --check",
+    "gitdiff:ci": "npm run build && git diff --exit-code",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "prettier": "prettier 'ts_src/**/*.ts' --ignore-path ./.prettierignore",
+    "test": "npm run build && npm run format:ci && npm run lint && npm run unit",
     "unit": "tape test/*.js",
@@ -26,19 +30,27 @@ "update": "node -e \"require('./util/wordlists').update()\""
     "type": "git",
-    "url": "https://github.com/weilu/bip39.git"
+    "url": "https://github.com/bitcoinjs/bip39.git"
   },
   "license": "ISC",
+  "files": [
+    "src",
+    "types"
+  ],
   "dependencies": {
+    "@types/node": "11.11.6",
     "create-hash": "^1.1.0",
     "pbkdf2": "^3.0.9",
-    "randombytes": "^2.0.1",
-    "safe-buffer": "^5.0.1",
-    "unorm": "^1.3.3"
+    "randombytes": "^2.0.1"
   },
   "devDependencies": {
+    "@types/create-hash": "1.2.0",
+    "@types/pbkdf2": "3.0.0",
+    "@types/randombytes": "2.0.0",
     "node-fetch": "^1.6.3",
     "nyc": "^13.1.0",
+    "prettier": "1.16.4",
     "proxyquire": "^1.7.10",
-    "standard": "^10.0.2",
-    "tape": "^4.6.2"
+    "tape": "^4.6.2",
+    "tslint": "5.14.0",
+    "typescript": "3.3.4000"
   }
 }

README.md

@@ -19,2 +19,58 @@ # BIP39
 
+## 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/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.
+
+ 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.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
@@ -31,17 +87,17 @@ ``` bash
 
-bip39.mnemonicToSeedHex('basket actual')
+bip39.mnemonicToSeedSync('basket actual').toString('hex')
 // => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'
 
-bip39.mnemonicToSeed('basket actual')
+bip39.mnemonicToSeedSync('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 ...>
 
-// mnemonicToSeed and mnemonicToSeedHex have async versions
-// mnemonicToSeedAsync mnemonicToSeedHexAsync are more performance oriented
-bip39.mnemonicToSeedAsync('basket actual').then(console.log)
+// mnemonicToSeed has an synchronous version
+// mnemonicToSeedSync is less performance oriented
+bip39.mnemonicToSeed('basket actual').then(console.log)
 // => <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.mnemonicToSeedHexAsync('basket actual').then(console.log)
+bip39.mnemonicToSeed('basket actual').then(bytes => bytes.toString('hex')).then(console.log)
 // => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'
 
-bip39.mnemonicToSeed('basket actual', 'a password')
+bip39.mnemonicToSeedSync('basket actual', 'a password')
 // => <Buffer 46 16 a4 4f 2c 90 b9 69 02 14 b8 fd 43 5b b4 14 62 43 de 10 7b 30 87 59 0a 3b b8 d3 1b 2f 3a ef ab 1d 4b 52 6d 21 e5 0a 04 02 3d 7a d0 66 43 ea 68 3b ... >
@@ -58,7 +114,7 @@
 ``` js
-var bip39 = require('bip39')
+const bip39 = require('bip39')
 
 // defaults to BIP39 English word list
 // uses HEX strings for entropy
-var mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')
+const mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')
 // => abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about
@@ -65,0 +121,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

271125

increased by16.34%

Dependency count

4

decreased by-20%

Number of package files

17

increased by41.67%

Lines of code

16609

increased by0.39%

Number of lines in readme file

123

increased by83.58%

Worsened metrics

Dev dependency count

10

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@types/node@11.11.6

• + Added@types/node@11.11.6(transitive)

• - Removedsafe-buffer@^5.0.1

• - Removedunorm@^1.3.3

• - Removedunorm@1.6.0(transitive)