@theqrl/wallet-helpers 1.0.0 → 3.1.0

package/README.md

@@ -14,4 +14,8 @@ TODO
 
 ## Tests
 
-  `npm test`
+  `npm test`
+
+## Coverage
+
+  `npm run cover`

package/dist/index.js

@@ -0,0 +1,207 @@
+"use strict";
+
+var sha256 = require('js-sha256');
+
+var isEqual = require('lodash.isequal');
+
+var _v3Wallet = require('./v3wallet').v3Wallet;
+
+function hexToBytes(hex) {
+  for (var bytes = [], c = 0; c < hex.length; c += 2) {
+    bytes.push(parseInt(hex.substr(c, 2), 16));
+  }
+
+  return bytes;
+}
+
+function bytesToHex(bytes) {
+  for (var hex = [], i = 0; i < bytes.length; i++) {
+    hex.push((bytes[i] >>> 4).toString(16));
+    hex.push((bytes[i] & 0xf).toString(16));
+  }
+
+  return hex.join('');
+}
+
+function hashPKandformat(ePK) {
+  var h = hexToBytes(ePK);
+  return sha256(h);
+}
+
+function doConvert(ePK) {
+  var a = hashPKandformat(ePK);
+  var qx = sha256(hexToBytes('000400' + a));
+  var qm = qx.slice(56, 64);
+  return 'Q' + bytesToHex([0, 4, 0]) + a + qm;
+}
+
+function isArrayOfInts(arr) {
+  var result = 0;
+  arr.forEach(function (element) {
+    if (element === parseInt(element, 10)) {
+      result += 1;
+    }
+  });
+
+  if (result === arr.length) {
+    return true;
+  }
+
+  return false;
+}
+
+function _checkWeightsAndThreshold(arr, threshold) {
+  // check length > 0
+  if (arr.length === 0) {
+    return {
+      result: false,
+      error: 'Array has length 0'
+    };
+  } // check each element in array, then threshold, is an integer
+
+
+  if (!isArrayOfInts(arr)) {
+    return {
+      result: false,
+      error: 'Array has non-integer values'
+    };
+  }
+
+  if (threshold !== parseInt(threshold, 10)) {
+    return {
+      result: false,
+      error: 'Threshold is not an integer'
+    };
+  } // check threshold can actually be reacher
+
+
+  var sum = arr.reduce(function (accumulator, currentValue) {
+    return accumulator + currentValue;
+  });
+
+  if (threshold > sum) {
+    return {
+      result: false,
+      error: 'Threshold can never be reached with these weights'
+    };
+  }
+
+  return {
+    result: true
+  };
+}
+
+function _getWalletFileType(wallet) {
+  // determines source of wallet file
+  var webWallet = ['address', 'addressB32', 'pk', 'hexseed', 'mnemonic', 'height', 'hashFunction', 'signatureType', 'index', 'encrypted'];
+  var pythonNode = ['addresses', 'encrypted', 'version'];
+  var convertedWebWallet = ['pk', 'hexseed', 'mnemonic', 'height', 'hashFunction', 'signatureType', 'index', 'address', 'encrypted'];
+
+  if (isEqual(pythonNode, Object.keys(wallet))) {
+    return 'PYTHON-NODE';
+  }
+
+  if (wallet instanceof Array) {
+    if (isEqual(webWallet, Object.keys(wallet[0]))) {
+      return 'WEB-WALLET';
+    }
+
+    if (isEqual(convertedWebWallet, Object.keys(wallet[0]))) {
+      return 'CONVERTED-WEB-WALLET';
+    }
+  }
+
+  return 'UNKNOWN';
+}
+
+function _isWalletFileDeprecated(wallet) {
+  if (_getWalletFileType(wallet) === 'PYTHON-NODE') return true; // There are three characteristics that describe a deprecated encrypted wallet file
+  // 1: The encrypted field is true and
+  // 2: The addressB32 field is unencrypted and
+  // 3: The pk field is unencrypted.
+  // Whilst neither of these fields risk funds being lost, they do reveal a users public
+  // address if their wallet file is stolen. This is a privacy concern.
+  // We can determine if they are unencrypted by checking their lengths.
+  // If addressB32 field is 64 characters in length, and pk field is 134 characters in length.
+
+  if (typeof wallet[0].encrypted !== 'undefined' && typeof wallet[0].addressB32 !== 'undefined' && typeof wallet[0].pk !== 'undefined') {
+    if (wallet[0].encrypted === true && wallet[0].addressB32.length === 64 && wallet[0].pk.length === 134) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+function _pythonNodeToWebWallet(wallet) {
+  var output = [];
+  wallet.addresses.forEach(function (element) {
+    var e = element;
+    e.encrypted = wallet.encrypted;
+    output.push(e);
+  });
+  return output;
+}
+
+module.exports = {
+  /**
+   * Reports the current module version
+   * @return {string} version
+   */
+  version: function version() {
+    return "3.1.0";
+  },
+  QRLAddressFromEPKHex: function QRLAddressFromEPKHex(ePK) {
+    if (ePK === undefined) {
+      throw new Error("No ePK parameter");
+    }
+
+    if (ePK.length !== 134) {
+      throw new Error("ePK length invalid");
+    }
+
+    return doConvert(ePK);
+  },
+  checkWeightsAndThreshold: function checkWeightsAndThreshold(arr, threshold) {
+    if (arr === undefined || threshold === undefined) {
+      throw new Error("Missing parameter");
+    }
+
+    return _checkWeightsAndThreshold(arr, threshold);
+  },
+  isWalletFileDeprecated: function isWalletFileDeprecated(wallet) {
+    if (wallet === undefined) {
+      throw new Error("Missing parameter");
+    }
+
+    return _isWalletFileDeprecated(wallet);
+  },
+  getWalletFileType: function getWalletFileType(wallet) {
+    if (wallet === undefined) {
+      throw new Error("Missing parameter");
+    }
+
+    return _getWalletFileType(wallet);
+  },
+  pythonNodeToWebWallet: function pythonNodeToWebWallet(wallet) {
+    if (wallet === undefined) {
+      throw new Error("Missing parameter");
+    }
+
+    return _pythonNodeToWebWallet(wallet);
+  },
+  v3Wallet: function v3Wallet(json, encrypted, password) {
+    if (json === undefined || encrypted === undefined) {
+      throw new Error("Missing parameter");
+    }
+
+    if (encrypted === true && password === undefined) {
+      throw new Error("Missing password");
+    }
+
+    var newWallet = _v3Wallet(json, encrypted, password);
+
+    return newWallet;
+  }
+};
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@theqrl/wallet-helpers",
-  "version": "1.0.0",
+  "version": "3.1.0",
   "description": "QRL wallet helpers",
-  "main": "index.js",
-  "directories": {
-    "test": "test"
-  },
+  "main": "dist/index.js",
+  "files": [
+    "dist/index.js"
+  ],
   "scripts": {
-    "test": "node_modules/.bin/mocha --reporter spec",
-    "cover": "node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec test/*"
+    "build": "babel src --out-dir ./dist --source-maps",
+    "lint": "eslint ./src",
+    "test": "nyc ./node_modules/.bin/mocha --timeout 10000 --require @babel/register",
+    "debug": "node --inspect-brk ./dist/index.js",
+    "cover": "mkdir -p coverage && nyc --reporter=text ./node_modules/mocha/bin/_mocha test/*.js --timeout 10000 && nyc --reporter=text-lcov ./node_modules/mocha/bin/_mocha --timeout 10000 test/*.js > coverage/lcov.info"
   },
   "repository": {
     "type": "git",
@@ -24,12 +27,43 @@
   },
   "homepage": "https://github.com/theqrl/wallet-helpers#readme",
   "devDependencies": {
-    "chai": "^4.1.2",
-    "coveralls": "^3.0.4",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.18.5",
+    "@babel/eslint-parser": "^7.18.2",
+    "@babel/node": "^7.18.5",
+    "@babel/plugin-transform-async-to-generator": "^7.17.12",
+    "@babel/preset-env": "^7.18.2",
+    "@babel/register": "^7.17.7",
+    "babel-plugin-istanbul": "^6.1.1",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
+    "coveralls": "^3.1.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-modules": "^1.1.1",
     "istanbul": "^0.4.5",
-    "mocha": "^5.1.0"
+    "mocha": "^10.0.0",
+    "mocha-lcov-reporter": "^1.3.0",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0"
   },
   "dependencies": {
-    "js-sha256": "^0.9.0"
+    "js-sha256": "^0.9.0",
+    "lodash.isequal": "^4.5.0"
+  },
+  "nyc": {
+    "reporter": [
+      "text-summary",
+      "html"
+    ],
+    "require": [
+      "@babel/register"
+    ],
+    "extension": [
+      ".js"
+    ],
+    "cache": false,
+    "temp-dir": "./test/.nyc-temp",
+    "report-dir": "./test/nyc"
   }
 }

package/.travis.yml

@@ -1,16 +0,0 @@
-language: node_js
-node_js:
-  - stable
-install:
-  - npm install
-script:
-  - npm run cover
-after_script: cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js
-deploy:
-  provider: npm
-  email: jp@theqrl.org
-  api_key:
-    secure: 0zCPBLRbP4w86uad10HGW1kk36nWknULBhZguZtQNsEkeaoMP6fH/RG8hdOUR8yFHgu/7z6tFZHj6FuhtQtMBRt+58lsJyuFkmVskGtz51Us+lRseB+MVeYt4Csd5LlLmpy6bRwbup6j8AQwFEXLn2BmbV4UNsxQsw+z3VE45atfhiQw0Kc/Vo6wcNxwp1mOyAV+IUbEXc++iti1Gywf+ZGdG9IzkIZ2h82O/UBJd6lJ6x0kp9o0UP+MSJe0Czum276UHGB+EL6WLTHJv0AzR4eOX2DS1AQVFMn65DPVBuEUnPaF8WZKfhXaQht7/aV5I2TtsfM+jsX/fWg2GAgUxj3hcYyvErKQv+MAq2WHwTnp5rlaHWM7DjJ43X/hEELMRG5WlzCuNlmjtFI8p4jn7SS5MhwnyTunieGb6PpKf6u0Vs/r4VE6qThrInxamCq/rGoZY8mbMyuub3PpIreWVxvUWPy2WJ2kr/5CoUxFtbSuRxkkxAx589f7+XdA16lZwprldgmacQr5x8UYezZ09dAAe2xoSCialdKXOAvq82cA2jsqaRkNqRfO4cJi9Dwjoy+FstpvFHUe+WKKxebkDiN58PN3MuFwwbNOjgdsoegt/UL0G6jHZTu0qVJXtgKY0cq+K1FX//kLpH4YoUzPb7QdRW7uDRbKpPDEsux5Uz4=
-  on:
-    tags: true
-    branch: master

package/index.js

@@ -1,46 +0,0 @@
-var sha256 = require("js-sha256");
-
-function hexToBytes(hex) {
-  for (var bytes = [], c = 0; c < hex.length; c += 2)
-    bytes.push(parseInt(hex.substr(c, 2), 16));
-  return bytes;
-}
-
-function bytesToHex(bytes) {
-  for (var hex = [], i = 0; i < bytes.length; i++) {
-    hex.push((bytes[i] >>> 4).toString(16));
-    hex.push((bytes[i] & 0xf).toString(16));
-  }
-  return hex.join("");
-}
-
-function hashPKandformat(ePK){
-  const h = hexToBytes(ePK);
-  return sha256(h);
-}
-
-function doConvert(ePK) {
-  const a = hashPKandformat(ePK);
-  const qx = sha256(hexToBytes('000400' + a));
-  const qm = qx.slice(56, 64);
-  return `Q${bytesToHex([0,4,0])}${a}${qm}`;
-}
-
-module.exports = {
- /**
-  * Reports the current module version
-  * @return {string} version
-  */
-  version: function() {
-    return '1.0.0'
-  },
-  QRLAddressFromEPKHex: function (ePK) {
-    if (ePK === undefined) {
-      throw new Error('No ePK parameter')
-    }
-    if (ePK.length !== 134) {
-      throw  new Error('ePK length invalid')
-    }
-    return doConvert(ePK)
-  }
-};

package/test/test.js

@@ -1,27 +0,0 @@
-var expect = require('chai').expect;
-var assert = require('chai').assert;
-var helpers = require('../index.js');
-
-describe('#deploy', function() {
-  it(`.version should report same version as in npm package.json file (=${process.env.npm_package_version})`, function() {
-    var result = helpers.version();
-    expect(result).to.equal(process.env.npm_package_version);
-  });
-});
-
-describe('#QRLAddressFromEPKHex', function() {
-  it('calling with no parameter throws an error', function () {
-    expect(() => {
-      helpers.QRLAddressFromEPKHex()
-    }).to.throw();
-  })
-});
-
-describe('#QRLAddressFromEPKHex', function() {
-  it('test ePK results in result of Q000400846365cd097082ce4404329d143959c8e4557d19b866ce8bf5ad7c9eb409d036651f62bd', function () {
-    var result = helpers.QRLAddressFromEPKHex(
-    '000400106D0856A5198967360B6BDFCA4976A433FA48DEA2A726FDAF30EA8CD3FAD2113191DA3442686282B3D5160F25CF162A517FD2131F83FBF2698A58F9C46AFC5D'
-    );
-    expect(result).to.equal('Q000400846365cd097082ce4404329d143959c8e4557d19b866ce8bf5ad7c9eb409d036651f62bd');
-  })
-});