ln-accounting 6.0.0 → 6.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## Version 6.1.0
+
+- `parseAmount`: Add method to parse a human readable amount into tokens
+
 ## Version 6.0.0
 
 ### Breaking Changes

package/README.md

@@ -119,6 +119,25 @@ Get chain transactions, including sweep fees
       }]
     }
 
+## parseAmount
+
+Parse a described amount into tokens
+
+    {
+      amount: <Amount String>
+      [variables]: {
+        <Name String>: <Amount Number>
+      }
+    }
+
+    @throws
+    <Error>
+
+    @returns
+    {
+      tokens: <Tokens Number>
+    }
+
 ## rateProviders
 
 Rate provider source options

package/index.js

@@ -1,5 +1,11 @@
 const {getAccountingReport} = require('./report');
 const {getChainTransactions} = require('./records');
+const {parseAmount} = require('./report');
 const {rateProviders} = require('./fiat');
 
-module.exports = {getAccountingReport, getChainTransactions, rateProviders};
+module.exports = {
+  getAccountingReport,
+  getChainTransactions,
+  parseAmount,
+  rateProviders,
+};

package/package.json

@@ -11,8 +11,9 @@
     "asyncjs-util": "1.2.10",
     "bitcoinjs-lib": "6.0.2",
     "goldengate": "11.4.0",
+    "hot-formula-parser": "4.0.0",
     "json2csv": "5.0.7",
-    "ln-service": "54.2.0"
+    "ln-service": "54.2.3"
   },
   "description": "lnd accounting reports",
   "devDependencies": {
@@ -33,7 +34,7 @@
     "url": "https://github.com/alexbosworth/ln-accounting.git"
   },
   "scripts": {
-    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 test/blockstream/*.js test/fiat/*.js test/harmony/*.js test/records/*.js"
+    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 test/blockstream/*.js test/fiat/*.js test/harmony/*.js test/records/*.js test/report/*.js"
   },
-  "version": "6.0.0"
+  "version": "6.1.0"
 }

package/report/index.js

@@ -1,3 +1,4 @@
 const getAccountingReport = require('./get_accounting_report');
+const parseAmount = require('./parse_amount');
 
-module.exports = {getAccountingReport};
+module.exports = {getAccountingReport, parseAmount};

package/report/parse_amount.js

@@ -0,0 +1,76 @@
+const {Parser} = require('hot-formula-parser');
+
+const {ceil} = Math;
+const {isArray} = Array;
+const {keys} = Object;
+const {round} = Math;
+
+/** Parse a described amount into tokens
+
+  {
+    amount: <Amount String>
+    [variables]: {
+      <Name String>: <Amount Number>
+    }
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    tokens: <Tokens Number>
+  }
+*/
+module.exports = ({amount, variables}) => {
+  if (isArray(amount)) {
+    throw new Error('CannotParseMultipleAmounts');
+  }
+
+  const parser = new Parser();
+
+  keys(variables || {}).forEach(key => {
+    parser.setVariable(key.toLowerCase(), variables[key]);
+    parser.setVariable(key.toUpperCase(), variables[key]);
+
+    return;
+  });
+
+  parser.setVariable('BTC', 1e8);
+  parser.setVariable('btc', 1e8);
+  parser.setVariable('m', 1e6);
+  parser.setVariable('M', 1e6);
+  parser.setVariable('mm', 1e6);
+  parser.setVariable('MM', 1e6);
+  parser.setVariable('k', 1e3);
+  parser.setVariable('K', 1e3);
+
+  const parsed = parser.parse(amount);
+
+  switch (parsed.error) {
+  case '#DIV/0!':
+    throw new Error('CannotDivideByZeroInSpecifiedAmount');
+
+  case '#ERROR!':
+    throw new Error('FailedToParseSpecifiedAmount');
+
+  case '#N/A':
+  case '#NAME?':
+    throw new Error('UnrecognizedVariableOrFunctionInSpecifiedAmount');
+
+  case '#NUM!':
+    throw new Error('InvalidNumberFoundInSpecifiedAmount');
+
+  case '#VALUE!':
+    throw new Error('UnexpectedValueTypeInSpecifiedAmount');
+
+  default:
+    break;
+  }
+
+  if (!!parsed.error) {
+    throw new Error(parsed.error);
+  }
+
+  return {tokens: round(parsed.result)};
+};

package/test/report/test_parse_amount.js

@@ -0,0 +1,55 @@
+const {test} = require('@alexbosworth/tap');
+
+const {parseAmount} = require('./../../');
+
+const tests = [
+  {
+    args: {amount: 'amount'},
+    description: 'A value is required',
+    error: 'UnrecognizedVariableOrFunctionInSpecifiedAmount',
+  },
+  {
+    args: {amount: '1/0'},
+    description: 'Dividing by zero is not allowed',
+    error: 'CannotDivideByZeroInSpecifiedAmount',
+  },
+  {
+    args: {amount: '0.0.0'},
+    description: 'A generic invalid amount is rejected',
+    error: 'FailedToParseSpecifiedAmount',
+  },
+  {
+    args: {amount: 'OCT2DEC()'},
+    description: 'Invalid numbers are rejected',
+    error: 'InvalidNumberFoundInSpecifiedAmount',
+  },
+  {
+    args: {amount: '"string" + 1'},
+    description: 'Invalid formulas are rejected',
+    error: 'UnexpectedValueTypeInSpecifiedAmount',
+  },
+  {
+    args: {amount: '1.20969468*btc', variables: {variable: 'value'}},
+    description: 'A long precision BTC value is parsed',
+    expected: {tokens: 120969468},
+  },
+  {
+    args: {amount: '1.20969465*btc'},
+    description: 'A long precision BTC value that rounds down is parsed',
+    expected: {tokens: 120969465},
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, equal, throws}) => {
+    if (!!error) {
+      throws(() => parseAmount(args), new Error(error), 'Got expected error');
+    } else {
+      const {tokens} = parseAmount(args);
+
+      equal(tokens, expected.tokens, 'Got expected output');
+    }
+
+    return end();
+  });
+});