@ellipticltd/aml-utils 0.2.2 → 0.4.0

package/.circleci/config.yml

@@ -0,0 +1,49 @@
+version: 2.1
+
+executors:
+  node-8_4:
+    docker:
+      - image: circleci/node:8.4.0
+    working_directory: /tmp/workspace
+
+jobs:
+  install:
+    executor: node-8_4
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - npm-cache-{{ checksum "package-lock.json" }}
+      - run:
+          name: install node modules
+          command: |
+            npm i
+      - save_cache:
+          key: npm-cache-{{ checksum "package-lock.json" }}
+          paths:
+            - node_modules
+      - persist_to_workspace:
+          root: /tmp
+          paths:
+            - workspace
+
+  unit_test:
+    executor: node-8_4
+    steps:
+      - attach_workspace:
+          at: /tmp
+      - run:
+          name: unit_test
+          command: npm run coverage
+      - store_artifacts:
+          path: coverage
+
+workflows:
+  version: 2.1
+  build-test-deploy:
+    jobs:
+      - install
+
+      - unit_test:
+          requires:
+            - install

package/.eslintrc

@@ -1,3 +1,20 @@
 {
-  "extends": ["@ellipticltd"]
-}
+  "extends": [
+    "airbnb"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.spec.js",
+      ],
+      "env": {
+        "mocha": true
+      }
+    }
+  ],
+  "rules": {
+    "no-underscore-dangle": 0,
+    "prefer-object-spread": 0,
+    "new-parens": 0
+  }
+}

package/.idea/workspace.xml

@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="beae4972-1969-4895-bbc9-d79f09bb9811" name="Default" comment="" />
+    <list default="true" id="beae4972-1969-4895-bbc9-d79f09bb9811" name="Default" comment="">
+      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
+    </list>
     <ignored path="$PROJECT_DIR$/.tmp/" />
     <ignored path="$PROJECT_DIR$/temp/" />
     <ignored path="$PROJECT_DIR$/tmp/" />
@@ -14,20 +16,20 @@
   </component>
   <component name="FileEditorManager">
     <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
-      <file leaf-file-name="package.json" pinned="false" current-in-tab="false">
+      <file leaf-file-name="package.json" pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/package.json">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="364">
-              <caret line="28" column="32" selection-start-line="28" selection-start-column="32" selection-end-line="28" selection-end-column="32" />
+            <state relative-caret-position="26">
+              <caret line="2" column="17" selection-start-line="2" selection-start-column="17" selection-end-line="2" selection-end-column="17" />
             </state>
           </provider>
         </entry>
       </file>
-      <file leaf-file-name="validations.js" pinned="false" current-in-tab="true">
+      <file leaf-file-name="validations.js" pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/lib/validations.js">
           <provider selected="true" editor-type-id="text-editor">
             <state relative-caret-position="399">
-              <caret line="148" column="7" lean-forward="true" selection-start-line="148" selection-start-column="7" selection-end-line="148" selection-end-column="7" />
+              <caret line="148" column="7" selection-start-line="148" selection-start-column="7" selection-end-line="148" selection-end-column="7" />
             </state>
           </provider>
         </entry>
@@ -45,8 +47,8 @@
   <component name="IdeDocumentHistory">
     <option name="CHANGED_PATHS">
       <list>
-        <option value="$PROJECT_DIR$/package.json" />
         <option value="$PROJECT_DIR$/lib/validations.js" />
+        <option value="$PROJECT_DIR$/package.json" />
       </list>
     </option>
   </component>
@@ -129,11 +131,12 @@
       <updated>1563360614655</updated>
       <workItem from="1563360615721" duration="151000" />
       <workItem from="1567667753338" duration="597000" />
+      <workItem from="1574357456118" duration="8000" />
     </task>
     <servers />
   </component>
   <component name="TimeTrackingManager">
-    <option name="totallyTimeSpent" value="748000" />
+    <option name="totallyTimeSpent" value="756000" />
   </component>
   <component name="ToolWindowManager">
     <frame x="0" y="23" width="1920" height="1057" extended-state="6" />
@@ -143,8 +146,8 @@
       <window_info anchor="bottom" id="TODO" order="6" />
       <window_info anchor="bottom" id="Docker" order="7" show_stripe_button="false" />
       <window_info anchor="bottom" id="Event Log" order="7" side_tool="true" />
-      <window_info id="npm" order="2" side_tool="true" />
       <window_info anchor="bottom" id="Version Control" order="7" />
+      <window_info id="npm" order="2" side_tool="true" />
       <window_info anchor="bottom" id="Run" order="2" />
       <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
       <window_info anchor="bottom" id="Terminal" order="7" />
@@ -169,21 +172,35 @@
     <entry file="file://$PROJECT_DIR$/package.json">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="364">
-          <caret line="28" column="24" selection-start-line="28" selection-start-column="24" selection-end-line="28" selection-end-column="24" />
+          <caret line="28" column="27" lean-forward="true" selection-start-line="28" selection-start-column="27" selection-end-line="28" selection-end-column="27" />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/lib/validations.js">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="1924">
+          <caret line="148" column="7" lean-forward="true" selection-start-line="148" selection-start-column="7" selection-end-line="148" selection-end-column="7" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/package.json">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="364">
-          <caret line="28" column="32" selection-start-line="28" selection-start-column="32" selection-end-line="28" selection-end-column="32" />
+          <caret line="28" column="24" selection-start-line="28" selection-start-column="24" selection-end-line="28" selection-end-column="24" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/lib/validations.js">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="399">
-          <caret line="148" column="7" lean-forward="true" selection-start-line="148" selection-start-column="7" selection-end-line="148" selection-end-column="7" />
+          <caret line="148" column="7" selection-start-line="148" selection-start-column="7" selection-end-line="148" selection-end-column="7" />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/package.json">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="26">
+          <caret line="2" column="17" selection-start-line="2" selection-start-column="17" selection-end-line="2" selection-end-column="17" />
         </state>
       </provider>
     </entry>

package/.nycrc.json

@@ -0,0 +1,11 @@
+{
+  "include": [
+    "lib/**/*.js"
+  ],
+  "exclude": [
+    "lib/types.js",
+    "lib/middleware.js"
+  ],
+  "all": true,
+  "check-coverage": false
+}

package/codecov.yml

@@ -0,0 +1,29 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project:
+      default:
+        target: 85%
+    patch: 
+      default:
+        target: 85%
+    changes: no
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no

package/lib/formatting.js

@@ -10,7 +10,7 @@ const rethrowError = (fnName, e) => {
   return `${fnName} - ${e.name}: ${e.statusCode} - ${formattedError}`;
 };
 
-const sqlEscapeWildcard = str => str.replace(/_|%|\\/g, x => `\\${x}`);
+const sqlEscapeWildcard = (str) => str.replace(/_|%|\\/g, (x) => `\\${x}`);
 
 module.exports = {
   rethrowError,

package/lib/middleware.js

@@ -1,6 +1,6 @@
 const T = require('./types');
 
-const ensureType = type => (req, res, next, id, name) => {
+const ensureType = (type) => (req, res, next, id, name) => {
   let error;
   try {
     T.ensureType(type, id, `Invalid ${name}`);

package/lib/ormHelpers.js

@@ -1,18 +1,17 @@
 const _ = require('lodash');
 
-const includeNested = (orm, models) =>
-  _.map(_.toPairs(models), (arg) => {
-    const [modelName, inclusion] = arg;
-    const include = includeNested(orm, inclusion);
-    const model = orm[modelName];
-    if (_.isEmpty(include)) {
-      return model;
-    }
-    return {
-      model,
-      include,
-    };
-  });
+const includeNested = (orm, models) => _.map(_.toPairs(models), (arg) => {
+  const [modelName, inclusion] = arg;
+  const include = includeNested(orm, inclusion);
+  const model = orm[modelName];
+  if (_.isEmpty(include)) {
+    return model;
+  }
+  return {
+    model,
+    include,
+  };
+});
 
 module.exports = {
   includeNested,

package/lib/types.js

@@ -1,11 +1,11 @@
 const TC = require('type-check');
 
+const _ = require('lodash');
+
 const E = require('./errors');
 
 const V = require('./validations');
 
-const _ = require('lodash');
-
 const customTypes = {
   Integer: {
     typeOf: 'Number',
@@ -152,8 +152,7 @@ const withNullable = Object.keys(customTypes).reduce((acc, _type) => {
 
   // for every type, add Nullable+type. A nullable string can also be empty
   acc[`Nullable${_type}`] = Object.assign({}, customTypes[_type], {
-    validate: x =>
-      x == null || (typeOf === 'String' && x === '') || validate(x),
+    validate: (x) => x == null || (typeOf === 'String' && x === '') || validate(x),
   });
 
   return acc;
@@ -176,10 +175,13 @@ module.exports = {
     return V.ensure(this.typeCheck(type, obj), msg);
   },
   checkArg(obj, prop, type, msg) {
+    let message;
     if (msg == null) {
-      msg = `Invalid ${prop}`;
+      message = `Invalid ${prop}`;
+    } else {
+      message = msg;
     }
-    this.ensureType(type, obj[prop], msg);
+    this.ensureType(type, obj[prop], message);
     return obj[prop];
   },
   checkArgs(input, types) {
@@ -197,8 +199,8 @@ module.exports = {
     numKeys = 0;
 
     Object.keys(fields).forEach((key) => {
-      types = fields[key];
-      V.ensure(this.parsedTypeCheck(types, input[key]), `Invalid ${key}`);
+      const objTypes = fields[key];
+      V.ensure(this.parsedTypeCheck(objTypes, input[key]), `Invalid ${key}`);
       if (inputKeys[key]) {
         numKeys += 1;
       }

package/lib/validations.js

@@ -1,4 +1,3 @@
-const E = require('./errors');
 const V = require('validator');
 const _ = require('lodash');
 const {
@@ -11,6 +10,7 @@ const {
 } = require('bitcore-lib');
 const addressValidator = require('wallet-address-validator');
 const web3 = require('web3-utils');
+const E = require('./errors');
 
 const validations = {
   _validate(Err, pred, x, msg) {
@@ -59,8 +59,8 @@ const validations = {
 
   check: {
     matches(required, given, msg) {
-      given = _.uniq(given);
-      const crit = _.intersection(given, required).length === given.length;
+      const newGiven = _.uniq(given);
+      const crit = _.intersection(newGiven, required).length === given.length;
       if (crit) {
         return true;
       }
@@ -100,44 +100,21 @@ const validations = {
 
   isCustomerReference(x) {
     return (
-      _.isString(x) &&
-      (x != null ? x.length : undefined) > 0 &&
-      (x != null ? x.length : undefined) <= 100
+      _.isString(x)
+      && (x != null ? x.length : undefined) > 0
+      && (x != null ? x.length : undefined) <= 100
     );
   },
   isCustomerLabelName(x) {
     return (
-      _.isString(x) &&
-      (x != null ? x.length : undefined) > 0 &&
-      (x != null ? x.length : undefined) <= 50
+      _.isString(x)
+      && (x != null ? x.length : undefined) > 0
+      && (x != null ? x.length : undefined) <= 50
     );
   },
-  ethereum: {
-    isAddress(str) {
-      return web3.isAddress(str);
-    },
-    isBlockHash(str) {
-      return str.length === 66 && web3.isHexStrict(str);
-    },
-    isTxHash(str) {
-      return str.length === 66 && web3.isHexStrict(str);
-    },
-    isAddressCode(str) {
-      return web3.isHexStrict(str);
-    },
-    isValidWeiAmount(str) {
-      try {
-        web3.fromWei(str);
-        return true;
-      } catch (e) {
-        return false;
-      }
-    },
-  },
   bitcoin: {
     isAddress(str) {
-      const network =
-        process.env.BITCOIN_NETWORK === 'testnet' ? 'testnet' : 'prod';
+      const network = process.env.BITCOIN_NETWORK === 'testnet' ? 'testnet' : 'prod';
       return typeof str === 'string' && addressValidator.validate(str.trim(), 'BTC', network);
     },
     isBech32Address(str) {
@@ -160,13 +137,13 @@ const validations = {
       }
     },
     isTxHash(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       return str.length === 64;
     },
     isTxHex(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       try {
@@ -180,7 +157,7 @@ const validations = {
       return HDPrivateKey.isValidPath(str);
     },
     isScriptHex(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       try {
@@ -191,7 +168,7 @@ const validations = {
       }
     },
     isTxSignature(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       try {
@@ -211,29 +188,62 @@ const validations = {
       return /^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^(bitcoincash:)?[q|p][a-z0-9]{41}$|^(BITCOINCASH:)?[Q|P][A-Z0-9]{41}$/.test(str);
     },
     isTxHash(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       return str.length === 64;
     },
   },
+  ethereum: {
+    isAddress(str) {
+      return web3.isAddress(str);
+    },
+    isBlockHash(str) {
+      return str.length === 66 && web3.isHexStrict(str);
+    },
+    isTxHash(str) {
+      return str.length === 66 && web3.isHexStrict(str);
+    },
+    isAddressCode(str) {
+      return web3.isHexStrict(str);
+    },
+    isValidWeiAmount(str) {
+      try {
+        web3.fromWei(str);
+        return true;
+      } catch (e) {
+        return false;
+      }
+    },
+  },
   litecoin: {
     isAddress(str) {
       return /^[3LM][a-km-zA-HJ-NP-Z1-9]{24,33}$|^ltc1[ac-hj-np-z02-9]{6,86}$|^LTC1[AC-HJ-NP-Z02-9]{6,86}$/.test(str);
     },
     isTxHash(str) {
-      if (!V.isHexadecimal(`${str}`)) {
+      if (!V.isHexadecimal(str)) {
         return false;
       }
       return str.length === 64;
     },
-  }
+  },
+  ripple: {
+    isAddress(str) {
+      return addressValidator.validate(str, 'XRP');
+    },
+    isTxHash(str) {
+      if (!V.isHexadecimal(str)) {
+        return false;
+      }
+      return str.length === 64;
+    },
+  },
 };
 
 Object.keys(V).forEach((k) => {
   const v = V[k];
   // don't trigger validation with null values (prevents swagger 500 error)
-  validations[k] = x => (x === null ? false : v(x));
+  validations[k] = (x) => (x === null ? false : v(x));
 });
 
 module.exports = validations;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ellipticltd/aml-utils",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Utilities, helpers, validations, type-checking, etc",
   "engines": {
     "node": "10.1.0",
@@ -13,28 +13,37 @@
   "homepage": "https://bitbucket.org/elliptic/aml-utils#readme",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/.bin/mocha --reporter spec --compilers coffee:coffee-script/register --require 'test/index.coffee'",
+    "test:unit": "./node_modules/.bin/mocha --reporter spec --compilers coffee:coffee-script/register --require 'test/index.coffee'",
     "compile": "./node_modules/coffee-script/bin/coffee -c index.coffee **/*.coffee",
-    "preprocess": "npm run compile"
+    "preprocess": "npm run compile",
+    "lint": "./node_modules/.bin/eslint --color 'lib/**/*.js' 'test/**/*.js' ",
+    "test": "nyc npm run test:unit && nyc report --reporter=html",
+    "coverage": "nyc npm run test:unit && nyc report --reporter=lcov --reporter=text-lcov | codecov --pipe"
   },
   "author": "Adam Joyce <adam@ellipitc.co>",
   "license": "MIT",
   "dependencies": {
-    "bitcore-lib": "5.0.0-beta.1",
+    "bitcore-lib": "^8.10.1",
     "create-error": "0.3.1",
-    "lodash": "^4.17.11",
+    "lodash": "^4.17.15",
     "type-check": "0.3.2",
     "validator": "10.10.0",
     "wallet-address-validator": "0.2.4",
     "web3-utils": "1.0.0"
   },
   "devDependencies": {
-    "@ellipticltd/eslint-config": "0.0.3",
     "chai": "4.1.1",
+    "codecov": "^3.6.1",
     "coffee-script": "1.12.7",
-    "eslint": "5.9.0",
-    "eslint-config-airbnb-base": "13.1.0",
-    "eslint-plugin-import": "^2.18.0",
-    "mocha": "3.5.0"
+    "eslint": "^6.6.0",
+    "eslint-config-airbnb": "^18.0.1",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-plugin-coffeescript": "^1.0.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jsx-a11y": "^6.2.3",
+    "eslint-plugin-react": "^7.16.0",
+    "mocha": "3.5.0",
+    "mocha-lcov-reporter": "^1.3.0",
+    "nyc": "^14.1.1"
   }
-}
+}

package/.npmignore

@@ -1,4 +0,0 @@
-**/*.coffee
-test/
-.history
-.vscode