@ellipticltd/aml-utils 0.8.0-EN-2570.3 → 0.8.0

package/.circleci/config.yml

@@ -1,14 +1,14 @@
 version: 2.1
 
 executors:
-  node-12:
+  node-8_4:
     docker:
-      - image: circleci/node:12.16.1
+      - image: circleci/node:8.4.0
     working_directory: /tmp/workspace
 
 jobs:
   install:
-    executor: node-12
+    executor: node-8_4
     steps:
       - checkout
       - restore_cache:
@@ -28,7 +28,7 @@ jobs:
             - workspace
 
   unit_test:
-    executor: node-12
+    executor: node-8_4
     steps:
       - attach_workspace:
           at: /tmp
@@ -38,27 +38,6 @@ jobs:
       - store_artifacts:
           path: coverage
 
-  lint:
-    executor: node-12
-    steps:
-      - attach_workspace:
-          at: /tmp
-      - run:
-          name: lint
-          command: npm run lint
-
-  semantic_release:
-    executor: node-12
-    steps:
-      - checkout
-      - attach_workspace:
-          at: /tmp
-      - add_ssh_keys:
-          fingerprints:
-            - "14:c6:29:a4:9e:45:36:d2:0e:e9:be:41:35:d7:06:23"
-      - run:
-          command: npx semantic-release
-
 workflows:
   version: 2.1
   build-test-deploy:
@@ -68,15 +47,3 @@ workflows:
       - unit_test:
           requires:
             - install
-
-      - lint:
-          requires:
-            - install
-
-      - semantic_release:
-          context: npm
-          requires:
-            - lint
-            - unit_test
-
-

package/.eslintrc

@@ -1,44 +1,20 @@
 {
-  "extends": ["airbnb-base"],
+  "extends": [
+    "airbnb"
+  ],
   "overrides": [
     {
       "files": [
-        "*.ts"
-      ],
-      "parser": "@typescript-eslint/parser",
-      "parserOptions": {
-        "project": "tsconfig.json"
-      },
-      "rules": {
-        "no-unused-vars": 0
-        // annoyingly this must be switched off
-        // https://github.com/typescript-eslint/typescript-eslint/issues/46
-      }
-    },
-    {
-      "files": [
-        "*.spec.js"
+        "*.spec.js",
       ],
       "env": {
         "mocha": true
-      },
-      "rules": {
-        "no-unused-expressions": 0,
-        "chai-friendly/no-unused-expressions": 2
-      },
-      "plugins": [
-        "chai-friendly"
-      ]
+      }
     }
   ],
   "rules": {
     "no-underscore-dangle": 0,
     "prefer-object-spread": 0,
     "new-parens": 0
-  },
-  "settings": {
-    "import/resolver": {
-      "typescript": {}
-    }
   }
-}
+}

package/.idea/aml-utils.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/aml-utils.iml" filepath="$PROJECT_DIR$/.idea/aml-utils.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/.idea/workspace.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="13258785-846b-4fb0-8bed-0999c26076e5" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/lib/validations.js" beforeDir="false" afterPath="$PROJECT_DIR$/lib/validations.js" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/test/validations.spec.js" beforeDir="false" afterPath="$PROJECT_DIR$/test/validations.spec.js" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="ProjectId" id="1cYJJDg3VaPA7J75A1iS6a3J7sb" />
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showExcludedFiles" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">
+    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
+    <property name="WebServerToolWindowFactoryState" value="false" />
+    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
+    <property name="node.js.detected.package.eslint" value="true" />
+    <property name="node.js.path.for.package.eslint" value="project" />
+    <property name="node.js.selected.package.eslint" value="(autodetect)" />
+    <property name="nodejs_package_manager_path" value="npm" />
+  </component>
+  <component name="SvnConfiguration">
+    <configuration />
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="13258785-846b-4fb0-8bed-0999c26076e5" name="Default Changelist" comment="" />
+      <created>1590699519147</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1590699519147</updated>
+      <workItem from="1590699522869" duration="144000" />
+      <workItem from="1590699690015" duration="407000" />
+      <workItem from="1590700324370" duration="1060000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="1" />
+  </component>
+</project>

package/README.md

@@ -6,42 +6,3 @@ This is a library that contains a set of utilities used by aml-api. In particula
 - Formatting functions (sql escaping)
 - Validator functions, also used by swagger node middleware. E.g. Bitcoin and Ethereum addresses validators
 - Express middlewares to validate params types
-- An async CSV file parser
-
-
-Prereqs
--------
-
-1. Correct version of node (use [nvm](https://github.com/creationix/nvm)).
-
-Development
------------
-
-`nvm use` ensures you are running the correct version of node.js.
-
-`npm i` installs your dependencies.
-
-`npm run build:dev`:
-- starts webpack on watch mode, recompiling any changes made to the code
-
-To test your changes locally go to the repo you are working on's package.json and replace:
- ```
- @ellipticltd/aml-utils: "*.*.*"
- ```
-with
- ```
-@ellipticltd/aml-utils: "file:../front-end-component-kit"
-```
-(if you repositories are in the same directory).
-
-Commiting
------------
-
-This repository uses [Semantic release](https://semantic-release.gitbook.io/) for version publishing. To create a new version of the package simply push to bitbucket and CircleCI will create a new version. No change to this repo's package.json is required.
-
-To work out what the next version of package should be a git commit linter is used. This is enforced by Husky and only commits with the following syntax can be [used](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-angular).
-  
-Setting up Semantic release
------------
-
-This [article](https://circleci.com/docs/2.0/gh-bb-integration/#creating-a-bitbucket-user-key) explains the integration between Bitbucket and CirlceCI. An NPM token also needs to be provided for the write access to the npm package

package/index.d.ts

@@ -0,0 +1 @@
+declare module '@ellipticltd/aml-utils';

package/index.js

@@ -0,0 +1,8 @@
+module.exports = {
+  types: require('./lib/types'),
+  validations: require('./lib/validations'),
+  errors: require('./lib/errors'),
+  formatting: require('./lib/formatting'),
+  middleware: require('./lib/middleware'),
+  ormHelpers: require('./lib/ormHelpers'),
+};

package/lib/{middleware/middleware.js → middleware.js}

@@ -1,4 +1,4 @@
-const T = require('../types/types');
+const T = require('./types');
 
 const ensureType = (type) => (req, res, next, id, name) => {
   let error;

package/lib/{types/types.js → types.js}

@@ -2,9 +2,9 @@ const TC = require('type-check');
 
 const _ = require('lodash');
 
-const E = require('../errors/errors');
+const E = require('./errors');
 
-const V = require('../validations/validations');
+const V = require('./validations');
 
 const customTypes = {
   Integer: {

package/lib/{validations/validations.ts → validations.js}

@@ -1,5 +1,4 @@
 const V = require('validator');
-// @ts-ignore
 const _ = require('lodash');
 const {
   crypto: { Signature },
@@ -13,32 +12,20 @@ const addressValidator = require('wallet-address-validator');
 const zilUtils = require('@zilliqa-js/util');
 const web3 = require('web3-utils');
 const stellarSDK = require('stellar-sdk');
-const E = require('../errors/errors');
+const E = require('./errors');
 
-type Validations = {
-  [key: string]: any
-}
 
-const validations: Validations = {
-  _validate(
-    Err: new (msg: string) => Error,
-    pred: (x: any) => boolean,
-    x: any,
-    msg: string,
-  ) {
+const validations = {
+  _validate(Err, pred, x, msg) {
     if (pred(x)) {
       return x;
     }
     throw new Err(msg);
   },
-  _validateArg(
-    pred: (x: any) => boolean,
-    x: any,
-    msg: string,
-  ) {
+  _validateArg(pred, x, msg) {
     return this._validate(E.InvalidArguments, pred, x, msg);
   },
-  _tryCheck(fn: (arg: any) => any, arg: any) {
+  _tryCheck(fn, arg) {
     try {
       fn(arg);
       return true;
@@ -47,35 +34,34 @@ const validations: Validations = {
     }
   },
 
-  exists(x: any) {
+  exists(x) {
     return x != null;
   },
-  nonEmpty(x: any) {
+  nonEmpty(x) {
     return (x != null ? x.length : undefined) > 0;
   },
-  isNonEmptyString(x: any) {
-    // @ts-ignore
+  isNonEmptyString(x) {
     return _.isString(x) && (x != null ? x.length : undefined) > 0;
   },
-  ensureShortEnough(limit: any, x: any) {
+  ensureShortEnough(limit, x) {
     const l = x != null ? x.length : undefined;
     if (l <= limit) {
       return true;
     }
     throw new E.BadRequest(`Max query size exceeded: ${l} / ${limit}`);
   },
-  ensure(crit: any, msg: any) {
+  ensure(crit, msg) {
     if (crit) {
       return true;
     }
     throw new E.BadRequest(msg);
   },
-  argExists(x: any, msg: any) {
+  argExists(x, msg) {
     return this._validateArg(this.exists, x, msg);
   },
 
   check: {
-    matches(required: any, given: any, msg: any) {
+    matches(required, given, msg) {
       const newGiven = _.uniq(given);
       const crit = _.intersection(newGiven, required).length === given.length;
       if (crit) {
@@ -83,8 +69,8 @@ const validations: Validations = {
       }
       throw new E.BadRequest(msg);
     },
-    wasFound(type: any) {
-      return (item: any) => {
+    wasFound(type) {
+      return (item) => {
         if (item == null) {
           throw new E.NotFound(`Unknown ${type}`);
         } else {
@@ -92,8 +78,8 @@ const validations: Validations = {
         }
       };
     },
-    wasCreated(msg: any) {
-      return (arr: any) => {
+    wasCreated(msg) {
+      return (arr) => {
         if (!arr[1]) {
           throw new E.BadRequest(msg);
         } else {
@@ -101,13 +87,13 @@ const validations: Validations = {
         }
       };
     },
-    isTrue(crit: any, msg: any) {
+    isTrue(crit, msg) {
       if (crit) {
         return true;
       }
       throw new E.BadRequest(msg);
     },
-    isFalse(crit: any, msg: any) {
+    isFalse(crit, msg) {
       if (!crit) {
         return true;
       }
@@ -115,45 +101,40 @@ const validations: Validations = {
     },
   },
 
-  isCustomerReference(x: any) {
+  isCustomerReference(x) {
     return (
       _.isString(x)
-      // @ts-ignore
       && (x != null ? x.length : undefined) > 0
-      // @ts-ignore
       && (x != null ? x.length : undefined) <= 100
     );
   },
-  isCustomerLabelName(x: any) {
+  isCustomerLabelName(x) {
     return (
       _.isString(x)
-      // @ts-ignore
       && (x != null ? x.length : undefined) > 0
-      // @ts-ignore
       && (x != null ? x.length : undefined) <= 50
     );
   },
   binanceCoin: {
-    isAddress(str: string) {
+    isAddress(str) {
       return /^(bnb)([a-z0-9]{39})$/.test(str);
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
       return str.length === 64;
-    },
+    }
   },
   bitcoin: {
-    isAddress(str: string) {
+    isAddress(str) {
       const network = process.env.BITCOIN_NETWORK === 'testnet' ? 'testnet' : 'prod';
-
       return typeof str === 'string' && addressValidator.validate(str.trim(), 'BTC', network);
     },
-    isBech32Address(str: string) {
+    isBech32Address(str) {
       return /^bc1[ac-hj-np-z02-9]{6,86}|^BC1[AC-HJ-NP-Z02-9]{6,86}/.test(str);
     },
-    isHDPublicKey(str: string) {
+    isHDPublicKey(str) {
       try {
         HDPublicKey(str);
         return true;
@@ -161,7 +142,7 @@ const validations: Validations = {
         return false;
       }
     },
-    isPublicKey(str: string) {
+    isPublicKey(str) {
       try {
         PublicKey(str);
         return true;
@@ -169,13 +150,13 @@ const validations: Validations = {
         return false;
       }
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
       return str.length === 64;
     },
-    isTxHex(str: string) {
+    isTxHex(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -186,10 +167,10 @@ const validations: Validations = {
         return false;
       }
     },
-    isHDPath(str: string) {
+    isHDPath(str) {
       return HDPrivateKey.isValidPath(str);
     },
-    isScriptHex(str: string) {
+    isScriptHex(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -200,7 +181,7 @@ const validations: Validations = {
         return false;
       }
     },
-    isTxSignature(str: string) {
+    isTxSignature(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -212,15 +193,15 @@ const validations: Validations = {
         return false;
       }
     },
-    isBlockHeight(obj: any) {
+    isBlockHeight(obj) {
       return _.isInteger(+obj) && parseInt(obj, 10) >= 0;
     },
   },
   bitcoinCash: {
-    isAddress(str: string) {
+    isAddress(str) {
       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: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -228,19 +209,19 @@ const validations: Validations = {
     },
   },
   ethereum: {
-    isAddress(str: string) {
+    isAddress(str) {
       return web3.isAddress(str);
     },
-    isBlockHash(str: string) {
+    isBlockHash(str) {
       return str.length === 66 && web3.isHexStrict(str);
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       return str.length === 66 && web3.isHexStrict(str);
     },
-    isAddressCode(str: string) {
+    isAddressCode(str) {
       return web3.isHexStrict(str);
     },
-    isValidWeiAmount(str: string) {
+    isValidWeiAmount(str) {
       try {
         web3.fromWei(str);
         return true;
@@ -250,21 +231,20 @@ const validations: Validations = {
     },
   },
   horizen: {
-    isAddress(str: string) {
+    isAddress(str) {
       return addressValidator.validate(str, 'ZEN');
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
-      return str.length === 64;
-    },
+      return str.length === 64;    },
   },
   litecoin: {
-    isAddress(str: string) {
+    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: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -272,10 +252,10 @@ const validations: Validations = {
     },
   },
   ripple: {
-    isAddress(str: string) {
+    isAddress(str) {
       return addressValidator.validate(str, 'XRP');
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -283,10 +263,10 @@ const validations: Validations = {
     },
   },
   stellar: {
-    isAddress(str: string) {
+    isAddress(str) {
       return stellarSDK.StrKey.isValidEd25519PublicKey(str);
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -294,10 +274,10 @@ const validations: Validations = {
     },
   },
   zcash: {
-    isAddress(str: string) {
+    isAddress(str) {
       return addressValidator.validate(str, 'ZEC');
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       if (!V.isHexadecimal(str)) {
         return false;
       }
@@ -305,10 +285,10 @@ const validations: Validations = {
     },
   },
   zilliqa: {
-    isAddress(str: string) {
+    isAddress(str) {
       return zilUtils.validation.isBech32(str);
     },
-    isTxHash(str: string) {
+    isTxHash(str) {
       return str.length === 66 && web3.isHexStrict(str);
     },
   },
@@ -317,7 +297,7 @@ const validations: Validations = {
 Object.keys(V).forEach((k) => {
   const v = V[k];
   // don't trigger validation with null values (prevents swagger 500 error)
-  validations[k] = (x: any) => (x === null ? false : v(x));
+  validations[k] = (x) => (x === null ? false : v(x));
 });
 
-export default validations;
+module.exports = validations;