add BIP-0044 path option to generate wallets from mnemonic by path

Author: shrpne

Diff for: .ncurc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  format: [
+      // 'group',
+      'repo',
+      'ownerChanged',
+  ],
+  reject: [
+      // breaking change
+      'ethereum-cryptography',
+      // https://github.com/jsdom/jsdom/issues/3395
+      'jest-environment-jsdom',
+  ],
+};

Diff for: CHANGELOG.md

@@ -1,3 +1,6 @@
+# 6.2.0 - 2022-08-31
+- add `path` option to generate wallets from mnemonic by specified BIP-0044 HD paths
+
 ## 6.1.0 - 2021-03-24
 - add `walletFromMnemonicAsync`, use it to get better performance in browser
 

Diff for: README.md

@@ -42,23 +42,24 @@ const wallet3 = await minterWallet.walletFromMnemonicAsync('...');
 ## Wallet API
 
 ### Construction methods:
+Mnemonic wallets are generated by a [BIP-0044 ](https://en.bitcoin.it/wiki/BIP_0044) path, Ethereum path is used by default "m/44'/60'/0'/0/0"
 
-#### `generateWallet()`
+#### `generateWallet(path)`
 Generates wallet from a random BIP39 mnemonic phrase (uses `bip39.generateMnemonic()` under the hood).
 ```js
 import {generateWallet} from 'minterjs-wallet';
 const wallet = generateWallet();
 ```
 
-#### `walletFromMnemonic(mnemonic)`
+#### `walletFromMnemonic(mnemonic, path)`
 Create a wallet instance based on BIP39 12 words mnemonic phrase
 ```js
 import {walletFromMnemonic} from 'minterjs-wallet';
 const wallet = walletFromMnemonic('surround tape away million into program organ tonight write prefer inform cool');
 ```
 
-#### `walletFromMnemonicAsync(mnemonic)`
-Same as `walletFromMnemonic` but async and has better performance in browser, beacause it uses `window.crypto.subtle` under hood
+#### `walletFromMnemonicAsync(mnemonic, path)`
+Same as `walletFromMnemonic` but async and has better performance in browser, because it uses `window.crypto.subtle` under hood
 ```js
 import {walletFromMnemonicAsync} from 'minterjs-wallet';
 const wallet = await walletFromMnemonicAsync('surround tape away million into program organ tonight write prefer inform cool');