v12.0.0 - initial commit

packages/server/lib/cash-out/cash-out-helper.js

@@ -0,0 +1,197 @@
+const _ = require('lodash/fp')
+
+const db = require('../db')
+const T = require('../time')
+const BN = require('../bn')
+
+// FP operations on Postgres result in very big errors.
+// E.g.: 1853.013808 * 1000 = 1866149.494
+const REDEEMABLE_AGE = T.day / 1000
+
+const CASH_OUT_TRANSACTION_STATES = `
+case
+  when error = 'Operator cancel' then 'Cancelled'
+  when error is not null then 'Error'
+  when dispense then 'Success'
+  when (extract(epoch from (now() - greatest(created, confirmed_at))) * 1000) >= ${REDEEMABLE_AGE} then 'Expired'
+  else 'Pending'
+end`
+
+const MAX_CASSETTES = 4
+const MAX_RECYCLERS = 6
+
+const SNAKE_CASE_BILL_FIELDS = [
+  'denomination_1',
+  'denomination_2',
+  'denomination_3',
+  'denomination_4',
+  'denomination_recycler_1',
+  'denomination_recycler_2',
+  'denomination_recycler_3',
+  'denomination_recycler_4',
+  'denomination_recycler_5',
+  'denomination_recycler_6',
+  'provisioned_1',
+  'provisioned_2',
+  'provisioned_3',
+  'provisioned_4',
+  'provisioned_recycler_1',
+  'provisioned_recycler_2',
+  'provisioned_recycler_3',
+  'provisioned_recycler_4',
+  'provisioned_recycler_5',
+  'provisioned_recycler_6',
+]
+
+const BILL_FIELDS = _.map(_.camelCase, SNAKE_CASE_BILL_FIELDS)
+
+module.exports = {
+  redeemableTxs,
+  toObj,
+  toDb,
+  REDEEMABLE_AGE,
+  CASH_OUT_TRANSACTION_STATES,
+}
+
+const mapValuesWithKey = _.mapValues.convert({ cap: false })
+
+function convertBigNumFields(obj) {
+  const convert = (value, key) => {
+    if (
+      _.includes(key, [
+        'cryptoAtoms',
+        'receivedCryptoAtoms',
+        'fiat',
+        'fixedFee',
+      ])
+    ) {
+      // BACKWARDS_COMPATIBILITY 10.1
+      // bills before 10.2 don't have fixedFee
+      if (key === 'fixedFee' && !value) return new BN(0).toString()
+      return value.toString()
+    }
+
+    // Only test isNil for these fields since the others should not be empty.
+    if (
+      _.includes(key, ['commissionPercentage', 'rawTickerPrice']) &&
+      !_.isNil(value)
+    ) {
+      return value.toString()
+    }
+
+    return value
+  }
+
+  const convertKey = key =>
+    _.includes(key, ['cryptoAtoms', 'fiat']) ? key + '#' : key
+
+  return _.mapKeys(convertKey, mapValuesWithKey(convert, obj))
+}
+
+function convertField(key) {
+  return _.snakeCase(key)
+}
+
+function addDbBills(tx) {
+  const bills = tx.bills
+  if (_.isEmpty(bills)) return tx
+
+  const billsObj = _.flow(
+    _.reduce((acc, value) => {
+      const suffix = _.snakeCase(value.name.replace(/cassette/gi, ''))
+      return {
+        ...acc,
+        [`provisioned_${suffix}`]: value.provisioned,
+        [`denomination_${suffix}`]: value.denomination,
+      }
+    }, {}),
+    it => {
+      const missingKeys = _.reduce((acc, value) => {
+        return _.assign({ [value]: 0 })(acc)
+      }, {})(_.difference(SNAKE_CASE_BILL_FIELDS, _.keys(it)))
+      return _.assign(missingKeys, it)
+    },
+  )(bills)
+
+  return _.assign(tx, billsObj)
+}
+
+function toDb(tx) {
+  const massager = _.flow(
+    convertBigNumFields,
+    addDbBills,
+    _.omit(['direction', 'bills', 'promoCodeApplied']),
+    _.mapKeys(convertField),
+  )
+
+  return massager(tx)
+}
+
+function toObj(row) {
+  if (!row) return null
+
+  const keys = _.keys(row)
+  let newObj = {}
+
+  keys.forEach(key => {
+    const objKey = _.camelCase(key)
+    if (key === 'received_crypto_atoms' && row[key]) {
+      newObj[objKey] = new BN(row[key])
+      return
+    }
+    if (
+      _.includes(key, [
+        'crypto_atoms',
+        'fiat',
+        'commission_percentage',
+        'raw_ticker_price',
+      ])
+    ) {
+      newObj[objKey] = new BN(row[key])
+      return
+    }
+
+    newObj[objKey] = row[key]
+  })
+
+  newObj.direction = 'cashOut'
+
+  if (_.every(_.isNil, _.at(BILL_FIELDS, newObj))) return newObj
+  if (_.some(_.isNil, _.at(BILL_FIELDS, newObj)))
+    throw new Error('Missing cassette values')
+
+  const billFieldsArr = _.concat(
+    _.map(it => ({
+      name: `cassette${it + 1}`,
+      denomination: newObj[`denomination${it + 1}`],
+      provisioned: newObj[`provisioned${it + 1}`],
+    }))(_.range(0, MAX_CASSETTES)),
+    _.map(it => ({
+      name: `recycler${it + 1}`,
+      denomination: newObj[`denominationRecycler${it + 1}`],
+      provisioned: newObj[`provisionedRecycler${it + 1}`],
+    }))(_.range(0, MAX_RECYCLERS)),
+  )
+
+  // There can't be bills with denomination === 0.
+  // If a bill has denomination === 0, then that cassette is not set and should be filtered out.
+  const bills = _.filter(it => it.denomination > 0, billFieldsArr)
+
+  return _.set('bills', bills, _.omit(BILL_FIELDS, newObj))
+}
+
+function redeemableTxs(deviceId) {
+  const sql = `select * from cash_out_txs
+  where device_id=$1
+  and redeem=$2
+  and dispense=$3
+  and (
+    provisioned_1 is not null or provisioned_2 is not null or provisioned_3 is not null or provisioned_4 is not null or
+    provisioned_recycler_1 is not null or provisioned_recycler_2 is not null or 
+    provisioned_recycler_3 is not null or provisioned_recycler_4 is not null or 
+    provisioned_recycler_5 is not null or provisioned_recycler_6 is not null
+  )
+  and extract(epoch from (now() - greatest(created, confirmed_at))) < $4`
+
+  return db.any(sql, [deviceId, true, false, REDEEMABLE_AGE]).then(_.map(toObj))
+}