Merge pull request #15 from SpringRole/develop

nervehammer · web-flow · commit 45363cc341cc · 2021-01-18T13:51:31.000+05:30
v0.2.0
diff --git a/.babelrc b/.babelrc
@@ -1,14 +1,3 @@
 {
-    "presets": ["@babel/env"],
-    "plugins": [
-        "@babel/plugin-proposal-export-default-from",
-        "@babel/plugin-proposal-export-namespace-from",
-        [
-            "@babel/plugin-transform-runtime",
-            {
-                "helpers": true,
-                "regenerator": true
-            }
-        ]
-    ]
+    "presets": ["@babel/env", "minify"]
 }
diff --git a/README.md b/README.md
@@ -12,12 +12,12 @@ SpringWallet - A simple wallet for flexible identity management for your fronten
 
 1.  Install `springwallet` with `npm`.
 
-    ```npm install springwallet --save``` or ```yarn add springwallet```
+    ```npm install @springrole/springwallet --save``` or ```yarn add @springrole/springwallet```
 
 2. Import springwallet into your project.
 
     ```js 
-    import SpringWallet from '@springrole/springwallet';
+    import { SpringWallet } from '@springrole/springwallet';
     ```
 3. Generate 12 words random mnemonic
 
@@ -28,7 +28,7 @@ SpringWallet - A simple wallet for flexible identity management for your fronten
 
     ```js
     async function createWallet(plainTextMnemonic, password) {
-        const encryptedMnemonic = await encryptMnemonic(plainTextMnemonic, password); // encrypting mnemonic
+        const encryptedMnemonic = await SpringWallet.encryptMnemonic(plainTextMnemonic, password); // encrypting mnemonic
         const wallet = await SpringWallet.initializeWalletFromMnemonic(plainTextMnemonic); // initializing wallet 
         const address = wallet.getChecksumAddressString(); // wallet address
         const key = wallet.getPrivateKey().toString('hex'); // private key
@@ -51,7 +51,7 @@ SpringWallet - A simple wallet for flexible identity management for your fronten
     async function unlockWallet(encryptedMnemonic, password) {
       let plainTextMnemonic;
       try {
-        plainTextMnemonic = await decryptMnemonic(encryptedMnemonic, password);
+        plainTextMnemonic = await SpringWallet.decryptMnemonic(encryptedMnemonic, password);
       } catch {
         return false;
       }
@@ -78,10 +78,9 @@ SpringWallet - A simple wallet for flexible identity management for your fronten
 
     ```js
     async function changeWalletPassword(address, encryptedMnemonic, oldPassword, newPassword) {
-      const mnemonicPhrase = await decryptMnemonic(encryptedMnemonic, oldPassword);
-      const newEncryptedMnemonic = await encryptMnemonic(mnemonicPhrase, newPassword);
-      const status = await updateEncryptedMnemonic(address, newEncryptedMnemonic);
-      return status;
+      const mnemonicPhrase = await SpringWallet.decryptMnemonic(encryptedMnemonic, oldPassword);
+      const newEncryptedMnemonic = await SpringWallet.encryptMnemonic(mnemonicPhrase, newPassword);
+      return true;
     }
     ```
     **NOTE** This will decrypt mnemonic with old password and reencrypts it using new password which will create new encrypted mnemonic 
@@ -90,11 +89,10 @@ SpringWallet - A simple wallet for flexible identity management for your fronten
 
     ```js
     async function resetWalletPassword(plainTextMnemonic, newPassword) {
-      const newEncryptedMnemonic = await encryptMnemonic(plainTextMnemonic, newPassword);
+      const newEncryptedMnemonic = await SpringWallet.encryptMnemonic(plainTextMnemonic, newPassword);
       const wallet = await SpringWallet.initializeWalletFromMnemonic(plainTextMnemonic);
       const walletAddress = wallet.getChecksumAddressString();
-      const status = await updateEncryptedMnemonic(walletAddress, newEncryptedMnemonic);
-      return status;
+      return true;
     }
     ```
     
diff --git a/package.json b/package.json
@@ -1,13 +1,13 @@
 {
     "name": "@springrole/springwallet",
-    "version": "0.1.7-beta.7",
+    "version": "0.2.0",
     "description": "Wallet for SpringRole users",
     "main": "dist/index.js",
     "scripts": {
-        "build": "./node_modules/.bin/babel src --out-dir dist",
-        "lint": "./node_modules/.bin/eslint .",
-        "lint:fix": "./node_modules/.bin/eslint --fix .",
-        "format": "./node_modules/.bin/prettier --ignore-path .gitignore --write ./{*.json,**/*.json}"
+        "build": "babel src --out-dir dist",
+        "lint": "eslint .",
+        "lint:fix": "eslint --fix .",
+        "format": "prettier --ignore-path .gitignore --config .prettierrc --write \"**/*.{js,json}\""
     },
     "repository": {
         "type": "git",
@@ -37,24 +37,21 @@
     },
     "homepage": "https://github.com/SpringRole/SpringWallet#readme",
     "dependencies": {
-        "bip39": "^3.0.2",
-        "ethereumjs-wallet": "^0.6.3",
-        "web3-provider-engine": "^15.0.3"
+        "bip39": "^3.0.3",
+        "ethereumjs-wallet": "^1.0.1",
+        "web3-provider-engine": "^16.0.1"
     },
     "devDependencies": {
-        "@babel/cli": "^7.6.0",
-        "@babel/core": "^7.6.0",
-        "@babel/plugin-proposal-export-default-from": "^7.5.2",
-        "@babel/plugin-proposal-export-namespace-from": "^7.5.2",
-        "@babel/plugin-transform-runtime": "^7.6.0",
-        "@babel/preset-env": "^7.6.0",
-        "@babel/runtime": "^7.6.3",
-        "eslint": "^6.3.0",
-        "eslint-config-prettier": "^6.2.0",
-        "eslint-plugin-prettier": "^3.1.0",
-        "husky": "^3.1.0",
-        "lint-staged": "^9.5.0",
-        "prettier": "^1.18.2"
+        "@babel/cli": "^7.12.10",
+        "@babel/core": "^7.12.10",
+        "@babel/preset-env": "^7.12.11",
+        "babel-preset-minify": "^0.5.1",
+        "eslint": "^7.18.0",
+        "eslint-config-prettier": "^7.1.0",
+        "eslint-plugin-prettier": "^3.3.1",
+        "husky": "^4.3.8",
+        "lint-staged": "^10.5.3",
+        "prettier": "^2.2.1"
     },
     "husky": {
         "hooks": {
@@ -63,12 +60,10 @@
     },
     "lint-staged": {
         "*.js": [
-            "./node_modules/.bin/eslint --ignore-pattern '!.eslintrc.js --fix",
-            "git add"
+            "eslint --ignore-pattern '!.eslintrc.js --fix"
         ],
         "*.{json,css}": [
-            "./node_modules/.bin/prettier --write",
-            "git add"
+            "prettier --write"
         ]
     }
 }
diff --git a/src/index.js b/src/index.js
@@ -1,9 +1,11 @@
-import * as bip39 from 'bip39';
-import crypto from 'crypto';
-import * as HDKey from 'ethereumjs-wallet/hdkey';
+import { generateMnemonic, validateMnemonic, mnemonicToSeed } from 'bip39';
+import { randomBytes } from 'crypto';
+import { hdkey } from 'ethereumjs-wallet';
 import Web3ProviderEngine from 'web3-provider-engine';
 import FixtureSubprovider from 'web3-provider-engine/subproviders/fixture.js';
+import NonceSubprovider from 'web3-provider-engine/subproviders/nonce-tracker.js';
 import RpcSubprovider from 'web3-provider-engine/subproviders/rpc.js';
+import WebSocketSubProvider from 'web3-provider-engine/subproviders/websocket.js';
 import HookedWalletSubprovider from 'web3-provider-engine/subproviders/hooked-wallet-ethtx.js';
 import networkConfig from './networkConfig';
 import { encryptMnemonic, decryptMnemonic } from './utils/encryption';
@@ -14,15 +16,13 @@ const MNEMONIC_PATH = "m/44'/60'/0'/0/0";
 /**
  * `SpringWallet` class
  */
-export default class SpringWallet {
+export class SpringWallet {
     /**
-     * @param {Object|String} network
+     * @param {Object} network
      * @constructor
      */
     constructor(network) {
-        if (!network) {
-            throw new Error("'network' not defined");
-        }
+        if (!network) throw new Error("'network' not defined");
         this.network = networkConfig(network);
         this.walletAddress = this.initWalletAddress();
         this.privateKey = this.initPrivateKey();
@@ -49,7 +49,7 @@ export default class SpringWallet {
         const engine = new Web3ProviderEngine();
         engine.addProvider(
             new FixtureSubprovider({
-                web3_clientVersion: 'SpringWallet/v0.1.7/javascript',
+                web3_clientVersion: 'SpringWallet/v0.2.0/javascript',
                 net_listening: true,
                 eth_hashrate: '0x00',
                 eth_mining: false,
@@ -58,9 +58,9 @@ export default class SpringWallet {
         );
 
         opts.getPrivateKey = (address, cb) => {
-            if (address.toLowerCase() === this.walletAddress.toLowerCase()) {
+            if (address.toLowerCase() == this.walletAddress.toLowerCase()) {
                 if (this.privateKey) {
-                    cb(null, this.privateKey);
+                    cb(null, Buffer.from(this.privateKey, 'hex'));
                 } else if (this.wallet) {
                     const privKey = this.wallet.getPrivateKey().toString('hex');
                     cb(null, Buffer.from(privKey, 'hex'));
@@ -84,11 +84,14 @@ export default class SpringWallet {
             cb(false, [address]);
         };
 
+        engine.addProvider(new NonceSubprovider());
         engine.addProvider(new HookedWalletSubprovider(opts));
-        engine.addProvider(new RpcSubprovider(opts));
-        engine.on('error', (error) => {
-            console.error(error);
-        });
+        if (opts && opts.rpcUrl && opts.rpcUrl.indexOf && opts.rpcUrl.indexOf('wss://') == 0) {
+            engine.addProvider(new WebSocketSubProvider(opts));
+        } else {
+            engine.addProvider(new RpcSubprovider(opts));
+        }
+
         engine.start();
         return engine;
     }
@@ -99,7 +102,7 @@ export default class SpringWallet {
      * @returns {String} mnemonic
      */
     static generateMnemonic() {
-        return bip39.generateMnemonic(128, crypto.randomBytes);
+        return generateMnemonic(128, randomBytes);
     }
 
     /**
@@ -109,7 +112,7 @@ export default class SpringWallet {
      * @returns {Boolean}
      */
     static isValidMnemonic(phrase) {
-        return bip39.validateMnemonic(phrase);
+        return validateMnemonic(phrase);
     }
 
     /**
@@ -166,11 +169,9 @@ export default class SpringWallet {
      * @returns wallet instance
      */
     static async initializeWalletFromMnemonic(mnemonic) {
-        const hdKey = await HDKey.fromMasterSeed(bip39.mnemonicToSeedSync(mnemonic));
-        const wallet = await hdKey
-            .derivePath(MNEMONIC_PATH)
-            .deriveChild(0)
-            .getWallet();
+        const seed = mnemonicToSeed(mnemonic);
+        const hdKey = await hdkey.fromMasterSeed(seed);
+        const wallet = await hdKey.derivePath(MNEMONIC_PATH).deriveChild(0).getWallet();
         return wallet;
     }
 
diff --git a/src/networkConfig.js b/src/networkConfig.js
@@ -1,29 +1,11 @@
-const networks = {
-    mainnet: {
-        rpcUrl: 'https://mainnet.infura.io/v3/607d0ccc6e364affa61439c855e1188a',
-        chainId: '1'
-    },
-    maticAlpha: {
-        rpcUrl: 'https://alpha.ethereum.matic.network',
-        chainId: '4626'
-    },
-    maticBeta: {
-        rpcUrl: 'https://beta.matic.network',
-        chainId: '15001'
-    }
-};
-
 export default function networkConfig(network) {
-    // TODO: Add infura mainnet prod url
-    const nObj = typeof network === 'string' ? Object.assign({}, networks[network]) : network;
-
-    if (typeof nObj !== 'object') {
+    if (typeof network !== 'object') {
         throw new Error("illegal 'network' parameter");
     }
 
-    if (!nObj.rpcUrl) {
+    if (!network.rpcUrl) {
         throw new Error("'rpcUrl' is not defined");
     }
 
-    return nObj;
+    return network;
 }
diff --git a/src/utils/encryption.js b/src/utils/encryption.js
@@ -1,5 +1,8 @@
-import * as bip39 from 'bip39';
-import * as crypto from 'crypto';
+import { promisify } from 'util';
+import { validateMnemonic, mnemonicToEntropy, entropyToMnemonic } from 'bip39';
+import { pbkdf2, randomBytes, createCipheriv, createHmac, createDecipheriv, createHash } from 'crypto';
+
+const asyncPbkdf2 = promisify(pbkdf2);
 
 /**
  * Encrypt a mnemonic using password
@@ -8,25 +11,25 @@ import * as crypto from 'crypto';
  * @returns {Promise<String>} hex-encoded string of the encrypted mnemonic
  */
 export async function encryptMnemonic(phrase, password) {
-    if (!bip39.validateMnemonic(phrase)) {
+    if (!validateMnemonic(phrase)) {
         throw new Error('Not a valid bip39 mnemonic');
     }
 
-    const plaintextBuffer = Buffer.from(bip39.mnemonicToEntropy(phrase), 'hex');
+    const plaintextBuffer = Buffer.from(mnemonicToEntropy(phrase), 'hex');
 
     // AES-128-CBC with SHA256 HMAC
-    const salt = crypto.randomBytes(16);
-    const keysAndIV = crypto.pbkdf2Sync(password, salt, 100000, 48, 'sha512');
+    const salt = randomBytes(16);
+    const keysAndIV = await asyncPbkdf2(password, salt, 100000, 48, 'sha512');
     const encKey = keysAndIV.slice(0, 16);
     const macKey = keysAndIV.slice(16, 32);
     const iv = keysAndIV.slice(32, 48);
 
-    const cipher = crypto.createCipheriv('aes-128-cbc', encKey, iv);
+    const cipher = createCipheriv('aes-128-cbc', encKey, iv);
 
     const cipherText = Buffer.concat([cipher.update(plaintextBuffer), cipher.final()]);
 
     const hmacPayload = Buffer.concat([salt, cipherText]);
-    const hmac = crypto.createHmac('sha256', macKey);
+    const hmac = createHmac('sha256', macKey);
     hmac.write(hmacPayload);
     const hmacDigest = hmac.digest();
     const payload = Buffer.concat([salt, hmacDigest, cipherText]);
@@ -49,37 +52,29 @@ export async function decryptMnemonic(encryptedMnemonic, password) {
     const cipherText = dataBuffer.slice(48);
 
     const hmacPayload = Buffer.concat([salt, cipherText]);
-    const keysAndIV = crypto.pbkdf2Sync(password, salt, 100000, 48, 'sha512');
+    const keysAndIV = await asyncPbkdf2(password, salt, 100000, 48, 'sha512');
     const encKey = keysAndIV.slice(0, 16);
     const macKey = keysAndIV.slice(16, 32);
     const iv = keysAndIV.slice(32, 48);
 
-    const decipher = crypto.createDecipheriv('aes-128-cbc', encKey, iv);
+    const decipher = createDecipheriv('aes-128-cbc', encKey, iv);
     const plaintextBuffer = Buffer.concat([decipher.update(cipherText), decipher.final()]);
 
     const hmac = crypto.createHmac('sha256', macKey);
     hmac.write(hmacPayload);
 
     const hmacDigest = hmac.digest();
-    const hmacSigHash = crypto
-        .createHash('sha256')
-        .update(hmacSig)
-        .digest()
-        .toString('hex');
-
-    const hmacDigestHash = crypto
-        .createHash('sha256')
-        .update(hmacDigest)
-        .digest()
-        .toString('hex');
+    const hmacSigHash = createHash('sha256').update(hmacSig).digest().toString('hex');
+
+    const hmacDigestHash = createHash('sha256').update(hmacDigest).digest().toString('hex');
 
     if (hmacSigHash !== hmacDigestHash) {
         throw new Error('Wrong password (HMAC mismatch)');
     }
 
-    const mnemonic = bip39.entropyToMnemonic(plaintextBuffer);
+    const mnemonic = entropyToMnemonic(plaintextBuffer);
 
-    if (!bip39.validateMnemonic(mnemonic)) {
+    if (!validateMnemonic(mnemonic)) {
         throw new Error('Wrong password (invalid plaintext)');
     }
 
diff --git a/yarn.lock b/yarn.lock
