controllers/transactions/lib/util.js

  1. const {
  2.   addHexPrefix,
  3.   isValidAddress,
  4. } = require('ethereumjs-util')
  6. /**
  7. @module
  8. */
  9. module.exports = {
  10.   normalizeTxParams,
  11.   validateTxParams,
  12.   validateFrom,
  13.   validateRecipient,
  14.   getFinalStates,
  15. }
  18. // functions that handle normalizing of that key in txParams
  19. const normalizers = {
  20.   from: from => addHexPrefix(from).toLowerCase(),
  21.   to: to => addHexPrefix(to).toLowerCase(),
  22.   nonce: nonce => addHexPrefix(nonce),
  23.   value: value => addHexPrefix(value),
  24.   data: data => addHexPrefix(data),
  25.   gas: gas => addHexPrefix(gas),
  26.   gasPrice: gasPrice => addHexPrefix(gasPrice),
  27. }
  29.  /**
  30.   normalizes txParams
  31.   @param txParams {object}
  32.   @returns {object} normalized txParams
  33.  */
  34. function normalizeTxParams (txParams) {
  35.   // apply only keys in the normalizers
  36.   const normalizedTxParams = {}
  37.   for (const key in normalizers) {
  38.     if (txParams[key]) normalizedTxParams[key] = normalizers[key](txParams[key])
  39.   }
  40.   return normalizedTxParams
  41. }
  43.  /**
  44.   validates txParams
  45.   @param txParams {object}
  46.  */
  47. function validateTxParams (txParams) {
  48.   validateFrom(txParams)
  49.   validateRecipient(txParams)
  50.   if ('value' in txParams) {
  51.     const value = txParams.value.toString()
  52.     if (value.includes('-')) {
  53.       throw new Error(`Invalid transaction value of ${txParams.value} not a positive number.`)
  54.     }
  56.     if (value.includes('.')) {
  57.       throw new Error(`Invalid transaction value of ${txParams.value} number must be in wei`)
  58.     }
  59.   }
  60. }
  62.  /**
  63.   validates the from field in  txParams
  64.   @param txParams {object}
  65.  */
  66. function validateFrom (txParams) {
  67.   if (!(typeof txParams.from === 'string')) throw new Error(`Invalid from address ${txParams.from} not a string`)
  68.   if (!isValidAddress(txParams.from)) throw new Error('Invalid from address')
  69. }
  71.  /**
  72.   validates the to field in  txParams
  73.   @param txParams {object}
  74.  */
  75. function validateRecipient (txParams) {
  76.   if (txParams.to === '0x' || txParams.to === null) {
  77.     if (txParams.data) {
  78.       delete txParams.to
  79.     } else {
  80.       throw new Error('Invalid recipient address')
  81.     }
  82.   } else if (txParams.to !== undefined && !isValidAddress(txParams.to)) {
  83.     throw new Error('Invalid recipient address')
  84.   }
  85.   return txParams
  86. }
  88.   /**
  89.     @returns an {array} of states that can be considered final
  90.   */
  91. function getFinalStates () {
  92.   return [
  93.     'rejected', // the user has responded no!
  94.     'confirmed', // the tx has been included in a block.
  95.     'failed', // the tx failed for some reason, included on tx data.
  96.     'dropped', // the tx nonce was already used
  97.   ]
  98. }