Merge pull request #133 from Permissionless-Software-Foundation/ct-unstable

fix(integration tests): slowing down integration tests for the sake o…

package.json

@@ -16,9 +16,11 @@
     "test:integration:local:abc": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
     "test:integration:local:bchn": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:local:testnet": "RESTURL=http://localhost:4000/v4/ mocha --timeout 30000 test/integration/chains/testnet",
-    "test:temp": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
-    "test:temp2": "mocha --timeout=30000 -g '#Util' test/unit/",
-    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
+    "test:integration:decatur:bchn": "export RESTURL=http://192.168.0.36:3000/v4/ && mocha --timeout 30000 test/integration/",
+    "test:integration:temp:bchn": "export RESTURL=http://157.90.174.219:3000/v4/ && mocha --timeout 30000 test/integration/",
+    "test:temp": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#Encryption' test/integration/",
+    "test:temp2": "mocha --timeout=30000 -g '#TransactionLib' test/unit/",
+    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#Transaction' test/integration/",
     "test:temp4": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#decodeOpReturn' test/integration/",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",
@@ -33,7 +35,7 @@
   },
   "dependencies": {
     "@psf/bip21": "^2.0.1",
-    "@psf/bip32-utils": "^0.13.1",
+    "@psf/bip32-utils": "^1.0.0",
     "@psf/bitcoincash-ops": "^2.0.0",
     "@psf/bitcoincashjs-lib": "^4.0.2",
     "@psf/coininfo": "^4.0.0",

src/bch-js.js

@@ -31,6 +31,7 @@ const SLP = require('./slp/slp')
 const IPFS = require('./ipfs')
 const Encryption = require('./encryption')
 const Utxo = require('./utxo')
+const Transaction = require('./transaction')
 
 // Indexers
 const Ninsight = require('./ninsight')
@@ -113,6 +114,7 @@ class BCHJS {
 
     this.IPFS = new IPFS()
     this.Utxo = new Utxo(libConfig)
+    this.Transaction = new Transaction(libConfig)
   }
 }
 

src/electrumx.js

@@ -284,7 +284,7 @@ class ElectrumX {
    *   }
    *
    */
-  async transactions (address) {
+  async transactions (address, usrObj = null) {
     try {
       // Handle single address.
       if (typeof address === 'string') {
@@ -299,7 +299,8 @@ class ElectrumX {
         const response = await axios.post(
           `${this.restURL}electrumx/transactions`,
           {
-            addresses: address
+            addresses: address,
+            usrObj // pass user data when making an internal call.
           },
           _this.axiosOptions
         )

src/price.js

@@ -156,6 +156,41 @@ class Price {
       else throw err
     }
   }
+
+  /**
+   * @api price.getBchUsd() getBchUsd()
+   * @apiName Price getBchUsd()
+   * @apiGroup Price
+   * @apiDescription Return current price of BCH in USD.
+   * This endpoint gets the USD price of BCH from the Coinex API. The price
+   * comes from bch-api, so it has a better chance of working in Tor.
+   *
+   * @apiExample Example usage:
+   *(async () => {
+   *  try {
+   *    let current = await bchjs.Price.getBchUsd();
+   *    console.log(current);
+   *  } catch(err) {
+   *   console.err(err)
+   *  }
+   *})()
+   *
+   * // 512.81
+   */
+  async getBchUsd () {
+    try {
+      const response = await this.axios.get(
+        `${this.restURL}price/bchusd`,
+        _this.axiosOptions
+      )
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return response.data.usd
+    } catch (err) {
+      if (err.response && err.response.data) throw err.response.data
+      else throw err
+    }
+  }
 }
 
 module.exports = Price

src/raw-transactions.js

@@ -1,7 +1,5 @@
 const axios = require('axios')
 
-const SlpUtils = require('./slp/utils')
-
 let _this
 
 class RawTransactions {
@@ -29,9 +27,6 @@ class RawTransactions {
     // Encapsulate dependencies
     this.axios = axios
 
-    // Dependencies
-    this.slpUtils = new SlpUtils(config)
-
     _this = this
   }
 
@@ -116,9 +111,7 @@ class RawTransactions {
           data: {
             hexes: hex
           },
-          headers: {
-            authorization: `Token ${_this.apiToken}`
-          }
+          headers: _this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -183,9 +176,7 @@ class RawTransactions {
           data: {
             hexes: script
           },
-          headers: {
-            authorization: `Token ${this.apiToken}`
-          }
+          headers: _this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -263,7 +254,7 @@ class RawTransactions {
    * //   time: 1547752564,
    * //   blocktime: 1547752564 } ]
    */
-  async getRawTransaction (txid, verbose = false) {
+  async getRawTransaction (txid, verbose = false, usrObj = null) {
     try {
       if (typeof txid === 'string') {
         const response = await axios.get(
@@ -278,7 +269,8 @@ class RawTransactions {
           url: `${this.restURL}rawtransactions/getRawTransaction`,
           data: {
             txids: txid,
-            verbose: verbose
+            verbose: verbose,
+            usrObj // pass user data when making an internal call.
           },
           headers: _this.axiosOptions.headers
         }
@@ -327,7 +319,8 @@ class RawTransactions {
 
         retArray.push({
           vin: i,
-          address: voutSender.scriptPubKey.addresses[0]
+          address: voutSender.scriptPubKey.addresses[0],
+          value: voutSender.value
         })
       }
 
@@ -381,84 +374,7 @@ class RawTransactions {
       // Add the input address to the transaction data.
       for (let i = 0; i < inAddrs.length; i++) {
         txDetails.vin[i].address = inAddrs[i].address
-      }
-
-      return txDetails
-    } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
-    }
-  }
-
-  // Wraps getTxData(), but also appends SLP token information to each input
-  // and output of the transaction. This is a very API-heavy call.
-  // Returns false if the txid is not an SLP transaction.
-  //
-  // Warning! This is a prototype function and the output can change at any time
-  // without reflecting a change in the semantic version. DO NOT USE IN PRODUCTION.
-  async getTxDataSlp (txid) {
-    try {
-      if (typeof txid !== 'string') {
-        throw new Error('Input must be a string or array of strings.')
-      }
-
-      const txDetails = await this.getTxData(txid)
-
-      // First get the token information for the output. If that fails, then
-      // this is not an SLP transaction, and this method can return false.
-      let outTokenData
-      try {
-        outTokenData = await this.slpUtils.decodeOpReturn(txid)
-        // console.log(`outTokenData: ${JSON.stringify(outTokenData, null, 2)}`)
-
-        // Add token information to the tx details object.
-        txDetails.tokenTxType = outTokenData.txType
-        txDetails.tokenId = outTokenData.tokenId
-
-        // Add the token quantity to each output.
-        for (let i = 0; i < outTokenData.amounts.length; i++) {
-          txDetails.vout[i + 1].tokenQty = outTokenData.amounts[i]
-        }
-
-        // Loop through each input and retrieve the token data.
-        for (let i = 0; i < txDetails.vin.length; i++) {
-          const thisVin = txDetails.vin[i]
-
-          try {
-            // If decodeOpReturn() throws an error, then this input is not
-            // from an SLP transaction and can be ignored.
-            const inTokenData = await this.slpUtils.decodeOpReturn(thisVin.txid)
-            // console.log(
-            //   `vin[${i}] tokenData: ${JSON.stringify(inTokenData, null, 2)}`
-            // )
-
-            // Get the appropriate vout token amount. This may throw an error,
-            // which means this Vin is not actually a token UTXO, it was just
-            // associated with a previous token TX.
-            const tokenQty = inTokenData.amounts[thisVin.vout - 1]
-            // console.log(`tokenQty: ${JSON.stringify(tokenQty, null, 2)}`)
-
-            if (tokenQty) {
-              thisVin.tokenQty = tokenQty
-              // txDetails.vin[i].tokenQty = tokenQty
-            } else {
-              thisVin.tokenQty = null
-            }
-          } catch (err) {
-            // console.log('catch 2: ', err)
-            // If decodeOpReturn() throws an error, then this input is not
-            // from an SLP transaction and can be ignored.
-            // thisVin.tokenQty = null
-            thisVin.tokenQty = null
-            continue
-          }
-          // console.log(
-          //   `2: txDetails.vin[i]: ${JSON.stringify(txDetails.vin[i], null, 2)}`
-          // )
-        }
-      } catch (err) {
-        // console.log('catch 1: ', err)
-        return false
+        txDetails.vin[i].value = inAddrs[i].value
       }
 
       return txDetails

src/slp/utils.js

@@ -1,12 +1,12 @@
+/* eslint-disable no-useless-catch */
+
 // Public npm libraries
 const axios = require('axios')
 const slpParser = require('slp-parser')
 const BigNumber = require('bignumber.js')
 
-// const Script = require("../script")
-// const scriptLib = new Script()
-
-// const BigNumber = require("bignumber.js")
+// Local libraries
+const Util = require('../util')
 
 let _this
 
@@ -37,6 +37,8 @@ class Utils {
     _this = this
 
     this.whitelist = []
+
+    this.util = new Util(config)
   }
 
   /**
@@ -440,7 +442,7 @@ class Utils {
     const path = `${this.restURL}slp/validateTxid`
 
     // console.log(`txid: ${JSON.stringify(txid, null, 2)}`)
-    console.log(`validateTxid usrObj: ${JSON.stringify(usrObj, null, 2)}`)
+    // console.log(`validateTxid usrObj: ${JSON.stringify(usrObj, null, 2)}`)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -452,7 +454,7 @@ class Utils {
         path,
         {
           txids: txids,
-          usrObj
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
@@ -651,12 +653,12 @@ class Utils {
    *     '00ea27261196a411776f81029c0ebe34362936b4a9847deb1f7a40a02b3a1476',
    *    valid: true } ]
    */
-  async validateTxid3 (txid, usbObj = null) {
+  async validateTxid3 (txid, usrObj = null) {
     const path = `${this.restURL}slp/validateTxid3`
 
     // console.log(`txid: ${JSON.stringify(txid, null, 2)}`)
     // console.log(`path: ${JSON.stringify(path, null, 2)}`)
-    console.log('validateTxid3 usbObj: ', usbObj)
+    // console.log('validateTxid3 usrObj: ', usrObj)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -668,7 +670,7 @@ class Utils {
         path,
         {
           txids: txids,
-          usbObj
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
@@ -897,6 +899,9 @@ class Utils {
    * If optional associative array parameter cache is used, will cache and
    * reuse responses for the same input.
    *
+   * A third optional input, `usrObj`, is used by bch-api for managing rate limits.
+   * It can be safely ignored when writing apps using this call.
+   *
    *
    * @apiExample Example usage:
    *
@@ -926,7 +931,7 @@ class Utils {
    *
    */
   // Reimplementation of decodeOpReturn() using slp-parser.
-  async decodeOpReturn (txid, cache = null, ip = null) {
+  async decodeOpReturn (txid, cache = null, usrObj = null) {
     // The cache object is an in-memory cache (JS Object) that can be passed
     // into this function. It helps if multiple vouts from the same TXID are
     // being evaluated. In that case, it can significantly reduce the number
@@ -943,7 +948,7 @@ class Utils {
       if (cachedVal) return cachedVal
     }
 
-    console.log(`decodeOpReturn ip: ${ip}`)
+    // console.log(`decodeOpReturn usrObj: ${JSON.stringify(usrObj, null, 2)}`)
 
     try {
       // Validate the txid input.
@@ -953,22 +958,17 @@ class Utils {
 
       // CT: 2/24/21 Deprected GET in favor of POST, to pass IP address.
       // Retrieve the transaction object from the full node.
-      // const path = `${this.restURL}rawtransactions/getRawTransaction/${txid}?verbose=true`
-      // const response = await _this.axios.get(path, _this.axiosOptions)
-      // const txDetails = response.data
-
       const path = `${this.restURL}rawtransactions/getRawTransaction`
       const response = await _this.axios.post(
         path,
         {
           verbose: true,
           txids: [txid],
-          ip
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
       const txDetails = response.data[0]
-
       // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
       // SLP spec expects OP_RETURN to be the first output of the transaction.
@@ -1015,8 +1015,16 @@ class Utils {
 
       return tokenData
     } catch (error) {
+      // Used for debugging
       // console.log('decodeOpReturn error: ', error)
-      if (error.response && error.response.data) throw error.response.data
+      // console.log(`decodeOpReturn error.message: ${error.message}`)
+      // if (error.response && error.response.data) {
+      //   console.log(
+      //     `decodeOpReturn error.response.data: ${JSON.stringify(
+      //       error.response.data
+      //     )}`
+      //   )
+      // }
       throw error
     }
   }
@@ -1029,18 +1037,30 @@ class Utils {
    *
    * Expects an array of UTXO objects as input. Returns an array of equal size.
    * Returns UTXO data hydrated with token information.
-   * If the
-   * UTXO does not belong to a SLP transaction, it will return an `isValid` property
-   * set to false.
-   * If the UTXO is part of an SLP transaction, it will return the UTXO object
-   * with additional SLP information attached. An `isValid` property will be included.
-   * If its value is true, the UTXO is a valid SLP UTXO.
-   * If the isValid value is null,
-   * then SLPDB has not yet processed that txid and validity has not been confirmed,
-   * or a 429 rate-limit error was enountered during the processing of the request.
    *
-   * This is an API-heavy call. If you get a lot of null values, then slow down
-   * the calls or request info on fewer UTXOs at a time.
+   * - If the UTXO does not belong to a SLP transaction, it will return an
+   * `isValid` property set to `false`.
+   *
+   * - If the UTXO is part of an SLP transaction, it will return the UTXO object
+   * with additional SLP information attached. An `isValid` property will be
+   * included.
+   *   - If the `isValid` property is `true`, the UTXO is a valid SLP UTXO.
+   *   - If the `isValid` property is `null`, then SLPDB has not yet processed
+   *     that txid and validity has not been confirmed, or a 429 rate-limit error
+   *     was enountered during the processing of the request.
+   *
+   * An optional second input object, `usrObj`, allows the user to inject an
+   * artifical delay while processing UTXOs. If `usrObj.utxoDelay` is set to
+   * a number, the call will delay by that number of milliseconds between
+   * processing UTXOs.
+   *
+   * This is an API-heavy call. If you get a lot of `null` values, then slow down
+   * the calls by using the usrObj.utxoDelay property, or request info on fewer
+   * UTXOs at a
+   * time. `null` indicates that the UTXO can *not* be safely spent, because
+   * a judgement as to weather it is a token UTXO has not been made. Spending it
+   * could burn tokens. It's safest to ignore UTXOs with a value of `null`.
+   *
    *
    * @apiExample Example usage:
    *
@@ -1048,7 +1068,8 @@ class Utils {
    * try {
    *  const utxos = await bchjs.Electrumx.utxo(`bitcoincash:qpcqs0n5xap26un2828n55gan2ylj7wavvzeuwdx05`)
    *
-   *  const utxoInfo = await bchjs.SLP.Utils.tokenUtxoDetails(utxos)
+   *  // Delay 100mS between processing UTXOs, to prevent rate-limit errors.
+   *  const utxoInfo = await bchjs.SLP.Utils.tokenUtxoDetails(utxos, { utxoDelay: 100 })
    *
    *  console.log(`utxoInfo: ${JSON.stringify(utxoInfo, null, 2)}`)
    * } catch (error) {
@@ -1076,17 +1097,12 @@ class Utils {
    *  "tokenType": 1
    * }
    */
-
-  // CT 1/11/20: Refactored to comply with this GitHub Issue:
-  // https://github.com/Bitcoin-com/slp-sdk/issues/84
-
-  // CT 5/31/20: Refactored to use slp-parse library.
-  async tokenUtxoDetails (utxos, usbObj = null) {
+  async tokenUtxoDetails (utxos, usrObj = null) {
     try {
       // Throw error if input is not an array.
       if (!Array.isArray(utxos)) throw new Error('Input must be an array.')
 
-      console.log(`tokenUtxoDetails usbObj: ${JSON.stringify(usbObj, null, 2)}`)
+      // console.log(`tokenUtxoDetails usrObj: ${JSON.stringify(usrObj, null, 2)}`)
 
       // Loop through each element in the array and validate the input before
       // further processing.
@@ -1119,7 +1135,7 @@ class Utils {
       }
 
       // Hydrate each UTXO with data from SLP OP_REUTRNs.
-      const outAry = await this._hydrateUtxo(utxos, usbObj)
+      const outAry = await this._hydrateUtxo(utxos, usrObj)
       // console.log(`outAry: ${JSON.stringify(outAry, null, 2)}`)
 
       // *After* each UTXO has been hydrated with SLP data,
@@ -1130,12 +1146,12 @@ class Utils {
         // *After* the UTXO has been hydrated with SLP data,
         // validate the TXID with SLPDB.
         if (utxo.tokenType) {
-          // Only execute this block if the current UTXO has a 'tokenType'
+          // Only execute this code-path if the current UTXO has a 'tokenType'
           // property. i.e. it has been successfully hydrated with SLP
           // information.
 
           // Validate using a 'waterfall' of validators.
-          utxo.isValid = await this.waterfallValidateTxid(utxo.txid, usbObj)
+          utxo.isValid = await this.waterfallValidateTxid(utxo.txid, usrObj)
           // console.log(`isValid: ${JSON.stringify(utxo.isValid, null, 2)}`)
         }
       }
@@ -1158,8 +1174,20 @@ class Utils {
    * but much more performant handling of SLP tokens. Some wallet apps prefer
    * the scaling performance over the breadth of supported tokens.
    *
+   * An optional second input object, `usrObj`, allows the user to inject an
+   * artifical delay while processing UTXOs. If `usrObj.utxoDelay` is set to
+   * a number, the call will delay by that number of milliseconds between
+   * processing UTXOs.
+   *
+   * This is an API-heavy call. If you get a lot of `null` values, then slow down
+   * the calls by using the usrObj.utxoDelay property, or request info on fewer
+   * UTXOs at a
+   * time. `null` indicates that the UTXO can *not* be safely spent, because
+   * a judgement as to weather it is a token UTXO has not been made. Spending it
+   * could burn tokens. It's safest to ignore UTXOs with a value of `null`.
+   *
    */
-  async tokenUtxoDetailsWL (utxos) {
+  async tokenUtxoDetailsWL (utxos, usrObj = null) {
     try {
       // Throw error if input is not an array.
       if (!Array.isArray(utxos)) throw new Error('Input must be an array.')
@@ -1195,7 +1223,7 @@ class Utils {
       }
 
       // Hydrate each UTXO with data from SLP OP_REUTRNs.
-      const outAry = await this._hydrateUtxo(utxos)
+      const outAry = await this._hydrateUtxo(utxos, usrObj)
       // console.log(`outAry: ${JSON.stringify(outAry, null, 2)}`)
 
       // *After* each UTXO has been hydrated with SLP data,
@@ -1211,7 +1239,7 @@ class Utils {
           // information.
 
           // Validate against the whitelist SLPDB.
-          const whitelistResult = await this.validateTxid3(utxo.txid)
+          const whitelistResult = await this.validateTxid3(utxo.txid, usrObj)
           // console.log(
           //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
           //     whitelistResult,
@@ -1239,11 +1267,25 @@ class Utils {
   // This is a private function that is called by tokenUtxoDetails().
   // It loops through an array of UTXOs and tries to hydrate them with SLP
   // token information from the OP_RETURN data.
-  async _hydrateUtxo (utxos, usbObj = null) {
+  //
+  // This function makes several calls to decodeOpReturn() to retrieve SLP
+  // token data. If that call throws an error due to hitting rate limits, this
+  // function will not throw an error. Instead, it will mark the `isValid`
+  // property as `null`
+  //
+  // Exception to the above: It *will* throw an error if decodeOpReturn() throws
+  // an error while trying to get the Genesis transaction for a Send or Mint
+  // transaction. However, that is a rare occurence since the cache of
+  // decodeOpReturn() will minimize API calls for this case. This behavior
+  // could be changed, but right now it's a corner case of a corner case.
+  //
+  // If the usrObj has a utxoDelay property, then it will delay the loop for
+  // each UTXO by that many milliseconds.
+  async _hydrateUtxo (utxos, usrObj = null) {
     try {
       const decodeOpReturnCache = {}
 
-      console.log(`_hydrateUtxo usbObj: ${JSON.stringify(usbObj, null, 2)}`)
+      // console.log(`_hydrateUtxo usrObj: ${JSON.stringify(usrObj, null, 2)}`)
 
       // Output Array
       const outAry = []
@@ -1252,6 +1294,12 @@ class Utils {
       for (let i = 0; i < utxos.length; i++) {
         const utxo = utxos[i]
 
+        // If the user passes in a delay, then wait.
+        if (usrObj && usrObj.utxoDelay && !isNaN(Number(usrObj.utxoDelay))) {
+          const delayMs = Number(usrObj.utxoDelay)
+          await this.util.sleep(delayMs)
+        }
+
         // Get raw transaction data from the full node and attempt to decode
         // the OP_RETURN data.
         // If there is no OP_RETURN, mark the UTXO as false.
@@ -1260,11 +1308,14 @@ class Utils {
           slpData = await this.decodeOpReturn(
             utxo.txid,
             decodeOpReturnCache,
-            usbObj
+            usrObj // pass user data when making an internal call.
           )
           // console.log(`slpData: ${JSON.stringify(slpData, null, 2)}`)
         } catch (err) {
-          // console.log(`error from decodeOpReturn(${utxo.txid}): `, err)
+          // console.log(
+          //   `error in _hydrateUtxo() from decodeOpReturn(${utxo.txid}): `,
+          //   err
+          // )
 
           // An error will be thrown if the txid is not SLP.
           // If error is for some other reason, like a 429 error, mark utxo as 'null'
@@ -1276,7 +1327,7 @@ class Utils {
               err.message.indexOf('trailing data') === -1)
           ) {
             // console.log(
-            //   'unknown error from decodeOpReturn(). Marking as \'null\'',
+            //   "unknown error from decodeOpReturn(). Marking as 'null'",
             //   err
             // )
 
@@ -1295,6 +1346,7 @@ class Utils {
           // Halt the execution of the loop and increase to the next index.
           continue
         }
+        // console.log(`slpData: ${JSON.stringify(slpData, null, 2)}`)
 
         const txType = slpData.txType.toLowerCase()
 
@@ -1332,6 +1384,10 @@ class Utils {
             utxo.decimals = slpData.decimals
             utxo.tokenType = slpData.tokenType
 
+            // Initial value is null until UTXO can be validated and confirmed
+            // to be valid (true) or not (false).
+            utxo.isValid = null
+
             outAry[i] = utxo
           }
         }
@@ -1352,7 +1408,7 @@ class Utils {
             const genesisData = await this.decodeOpReturn(
               slpData.tokenId,
               decodeOpReturnCache,
-              usbObj
+              usrObj // pass user data when making an internal call.
             )
             // console.log(`genesisData: ${JSON.stringify(genesisData, null, 2)}`)
 
@@ -1381,6 +1437,10 @@ class Utils {
 
             utxo.mintBatonVout = slpData.mintBatonVout
 
+            // Initial value is null until UTXO can be validated and confirmed
+            // to be valid (true) or not (false).
+            utxo.isValid = null
+
             outAry[i] = utxo
           }
         }
@@ -1405,7 +1465,7 @@ class Utils {
             const genesisData = await this.decodeOpReturn(
               slpData.tokenId,
               decodeOpReturnCache,
-              usbObj
+              usrObj // pass user data when making an internal call.
             )
             // console.log(`genesisData: ${JSON.stringify(genesisData, null, 2)}`)
 
@@ -1422,6 +1482,10 @@ class Utils {
             utxo.decimals = genesisData.decimals
             utxo.tokenType = slpData.tokenType
 
+            // Initial value is null until UTXO can be validated and confirmed
+            // to be valid (true) or not (false).
+            utxo.isValid = null
+
             // Calculate the real token quantity.
 
             const tokenQtyBig = new BigNumber(tokenQty).div(
@@ -1439,7 +1503,7 @@ class Utils {
 
       return outAry
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      // console.log('_hydrateUtxo error: ', error)
       throw error
     }
   }
@@ -1480,7 +1544,7 @@ class Utils {
    * // returns
    * true
    */
-  async waterfallValidateTxid (txid, usbObj = null) {
+  async waterfallValidateTxid (txid, usrObj = null) {
     try {
       // console.log('txid: ', txid)
 
@@ -1512,7 +1576,7 @@ class Utils {
       // validateTxid2() uses slp-validate, which has a different output format.
 
       // Validate against the whitelist SLPDB first.
-      const whitelistResult = await this.validateTxid3(txid, usbObj)
+      const whitelistResult = await this.validateTxid3(txid, usrObj)
       // console.log(
       //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
       //     whitelistResult,
@@ -1533,7 +1597,7 @@ class Utils {
       }
 
       // Try the general SLPDB, if the whitelist returned null.
-      const generalResult = await this.validateTxid(txid, usbObj)
+      const generalResult = await this.validateTxid(txid, usrObj)
       // console.log(
       //   `validateTxid() isValid: ${JSON.stringify(generalResult, null, 2)}`
       // )
@@ -1586,22 +1650,33 @@ class Utils {
    * @apiDescription Hydrate a UTXO with SLP token metadata.
    *
    * The same as tokenUtxoDetails(), but uses bch-api to do the heavy lifting,
-   * which greatly reduces the number of API calls.
+   * which greatly increases the speed, since fewer API calls need to be made.
+   * However, internal API calls are still counted against your rate limits.
    *
-   * Expects an array of UTXO objects as input. Returns an array of equal size.
-   * Returns UTXO data hydrated with token information.
-   * If the
-   * UTXO does not belong to a SLP transaction, it will return an `isValid` property
-   * set to false.
-   * If the UTXO is part of an SLP transaction, it will return the UTXO object
-   * with additional SLP information attached. An `isValid` property will be included.
-   * If its value is true, the UTXO is a valid SLP UTXO.
-   * If the isValid value is null,
-   * then SLPDB has not yet processed that txid and validity has not been confirmed,
-   * or a 429 rate-limit error was enountered during the processing of the request.
+   * This function expects an array of UTXO objects as input. It returns an
+   * array of equal size. The UTXO data hydrated with token information.
+   * - If the UTXO does not belong to a SLP transaction, it will return an
+   *   `isValid` property set to `false`.
+   * - If the UTXO is part of an SLP transaction, it will return the UTXO object
+   *   with additional SLP information attached. An `isValid` property will be
+   *   included.
+   *     - If `isValid` is `true`, the UTXO is a valid SLP UTXO.
+   *     - If `isValid` is `null`, then SLPDB has not yet processed that txid
+   *       and validity has not been confirmed,
+   *       or a 429 rate-limit error was enountered during the processing of the
+   *       request.
    *
-   * This is an API-heavy call. If you get a lot of null values, then slow down
-   * the calls or request info on fewer UTXOs at a time.
+   * An optional second input object, `usrObj`, allows the user to inject an
+   * artifical delay while processing UTXOs. If `usrObj.utxoDelay` is set to
+   * a number, the call will delay by that number of milliseconds between
+   * processing UTXOs.
+   *
+   * This is an API-heavy call. If you get a lot of `null` values, then slow down
+   * the calls by using the usrObj.utxoDelay property, or request info on fewer
+   * UTXOs at a
+   * time. `null` indicates that the UTXO can *not* be safely spent, because
+   * a judgement as to weather it is a token UTXO has not been made. Spending it
+   * could burn tokens. It's safest to ignore UTXOs with a value of `null`.
    *
    * @apiExample Example usage:
    *
@@ -1613,7 +1688,8 @@ class Utils {
    *   "bitcoincash:qzygn28zpgeemnptkn26xzyuzzfu9l8f9vfvq7kptk"
    *  ])
    *
-   *  const utxoInfo = await bchjs.SLP.Utils.hydrateUtxos(utxos.utxos)
+   *  // Wait 100mS between processing UTXOs, to prevent rate limit errors.
+   *  const utxoInfo = await bchjs.SLP.Utils.hydrateUtxos(utxos.utxos, { utxoDelay: 100 })
    *
    *  console.log(`${JSON.stringify(utxoInfo, null, 2)}`)
    * } catch (error) {
@@ -1747,7 +1823,7 @@ class Utils {
    */
   // Same as tokenUtxoDetails(), but reduces API calls by having bch-api server
   // do the heavy lifting.
-  async hydrateUtxos (utxos) {
+  async hydrateUtxos (utxos, usrObj) {
     try {
       // Throw error if input is not an array.
       if (!Array.isArray(utxos)) throw new Error('Input must be an array.')
@@ -1755,15 +1831,18 @@ class Utils {
       const response = await _this.axios.post(
         `${this.restURL}slp/hydrateUtxos`,
         {
-          utxos: utxos
+          utxos: utxos,
+          usrObj
         },
         _this.axiosOptions
       )
 
       return response.data
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
+      if (error.response && error.response.data) {
+        throw new Error(JSON.stringify(error.response.data, null, 2))
+      }
+      throw error
     }
   }
 

src/transaction.js

@@ -0,0 +1,145 @@
+/*
+  High-level functions for working with Transactions
+*/
+
+const RawTransaction = require('./raw-transactions')
+const SlpUtils = require('./slp/utils')
+
+class Transaction {
+  constructor (config) {
+    // Encapsulate dependencies
+    this.slpUtils = new SlpUtils(config)
+    this.rawTransaction = new RawTransaction(config)
+  }
+
+  /**
+   * @api Transaction.get() get()
+   * @apiName get
+   * @apiGroup Transaction
+   * @apiDescription
+   * Returns an object of transaction data, including addresses for input UTXOs.
+   * If it is a SLP token transaction, the token information for inputs and
+   * outputs will also be included.
+   *
+   * This is an API heavy call. This function will only work with a single txid.
+   * It does not yet support an array of TXIDs.
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   * try {
+   *  let txData = await bchjs.Transaction.get("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
+   *  console.log(txData);
+   * } catch(error) {
+   * console.error(error)
+   * }
+   * })()
+   */
+  async get (txid) {
+    try {
+      if (typeof txid !== 'string') {
+        throw new Error('Input must be a string or array of strings.')
+      }
+
+      const txDetails = await this.rawTransaction.getTxData(txid)
+      // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
+
+      // Setup default SLP properties.
+      txDetails.isValidSLPTx = false
+
+      // First get the token information for the output. If that fails, then
+      // this is not an SLP transaction, and this method can return false.
+      let outTokenData
+      try {
+        outTokenData = await this.slpUtils.decodeOpReturn(txid)
+        // console.log(`outTokenData: ${JSON.stringify(outTokenData, null, 2)}`)
+
+        // Get Genesis data for this token.
+        const genesisData = await this.slpUtils.decodeOpReturn(
+          outTokenData.tokenId
+          // decodeOpReturnCache
+          // usrObj // pass user data when making an internal call.
+        )
+        // console.log(`genesisData: ${JSON.stringify(genesisData, null, 2)}`)
+
+        // Add token information to the tx details object.
+        txDetails.tokenTxType = outTokenData.txType
+        txDetails.tokenId = outTokenData.tokenId
+        txDetails.tokenTicker = genesisData.ticker
+        txDetails.tokenName = genesisData.name
+        txDetails.tokenDecimals = genesisData.decimals
+        txDetails.tokenUri = genesisData.documentUri
+        txDetails.tokenDocHash = genesisData.documentHash
+
+        // Add the token quantity to each output.
+        for (let i = 0; i < outTokenData.amounts.length; i++) {
+          const rawQty = outTokenData.amounts[i]
+          const realQty = Number(rawQty) / Math.pow(10, txDetails.tokenDecimals)
+
+          txDetails.vout[i + 1].tokenQty = realQty
+        }
+
+        // Add tokenQty = null to any outputs that don't have a value.
+        for (let i = 0; i < txDetails.vout.length; i++) {
+          const thisVout = txDetails.vout[i]
+
+          if (!thisVout.tokenQty && thisVout.tokenQty !== 0) {
+            thisVout.tokenQty = null
+          }
+        }
+
+        // Loop through each input and retrieve the token data.
+        for (let i = 0; i < txDetails.vin.length; i++) {
+          const thisVin = txDetails.vin[i]
+
+          try {
+            // If decodeOpReturn() throws an error, then this input is not
+            // from an SLP transaction and can be ignored.
+            const inTokenData = await this.slpUtils.decodeOpReturn(thisVin.txid)
+            // console.log(
+            //   `vin[${i}] tokenData: ${JSON.stringify(inTokenData, null, 2)}`
+            // )
+
+            // Get the appropriate vout token amount. This may throw an error,
+            // which means this Vin is not actually a token UTXO, it was just
+            // associated with a previous token TX.
+            const tokenQty = inTokenData.amounts[thisVin.vout - 1]
+            // console.log(`tokenQty: ${JSON.stringify(tokenQty, null, 2)}`)
+
+            if (tokenQty) {
+              const realQty =
+                Number(tokenQty) / Math.pow(10, txDetails.tokenDecimals)
+
+              thisVin.tokenQty = realQty
+              // txDetails.vin[i].tokenQty = tokenQty
+            } else {
+              thisVin.tokenQty = null
+            }
+          } catch (err) {
+            // If decodeOpReturn() throws an error, then this input is not
+            // from an SLP transaction and can be ignored.
+            // thisVin.tokenQty = null
+            thisVin.tokenQty = null
+            continue
+          }
+        }
+
+        // Finally, validate the SLP TX.
+        // this.slpUtils.waterfallValidateTxid(txid, usrObj)
+        txDetails.isValidSLPTx = await this.slpUtils.waterfallValidateTxid(txid)
+      } catch (err) {
+        // console.log('Error: ', err)
+
+        // If decoding the op_return fails, then it's not an SLP transaction,
+        // and the non-hyrated TX details can be returned.
+        return txDetails
+      }
+
+      return txDetails
+    } catch (err) {
+      console.error('Error in transactions.js/get()')
+      throw err
+    }
+  }
+}
+
+module.exports = Transaction

test/integration/chains/bchn/rawtransaction.js

@@ -20,7 +20,7 @@ util.inspect.defaultOptions = {
 
 describe('#rawtransaction', () => {
   beforeEach(async () => {
-    if (process.env.IS_USING_FREE_TIER) await sleep(1000)
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
   })
 
   /*

test/integration/chains/bchn/slp.js

@@ -25,12 +25,37 @@ describe('#SLP', () => {
 
   beforeEach(async () => {
     // Introduce a delay so that the BVT doesn't trip the rate limits.
-    if (process.env.IS_USING_FREE_TIER) await sleep(1000)
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
 
     bchjs = new BCHJS()
   })
 
   describe('#util', () => {
+    describe('#decodeOpReturn', () => {
+      it('should decode a NFT Child transaction', async () => {
+        const txid =
+          'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b'
+
+        const data = await bchjs.SLP.Utils.decodeOpReturn(txid)
+        // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+        assert.property(data, 'tokenType')
+        assert.property(data, 'txType')
+        assert.property(data, 'ticker')
+        assert.property(data, 'name')
+        assert.property(data, 'tokenId')
+        assert.property(data, 'documentUri')
+        assert.property(data, 'documentHash')
+        assert.property(data, 'decimals')
+        assert.property(data, 'mintBatonVout')
+        assert.property(data, 'qty')
+
+        assert.equal(data.tokenType, 65)
+        assert.equal(data.mintBatonVout, 0)
+        assert.equal(data.qty, '1')
+      })
+    })
+
     describe('#tokenUtxoDetails', () => {
       it('should handle a range of UTXO types', async () => {
         const utxos = [

test/integration/chains/bchn/utxo-integration.js

@@ -11,7 +11,7 @@ describe('#UTXO', () => {
   beforeEach(async () => {
     // sandbox = sinon.createSandbox()
 
-    if (process.env.IS_USING_FREE_TIER) await sleep(1000)
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
   })
 
   describe('#get', () => {

test/integration/price.js

@@ -33,6 +33,14 @@ describe('#price', () => {
       assert.isNumber(result)
     })
   })
+  describe('#getBchUsd', () => {
+    it('should get the USD price of BCH', async () => {
+      const result = await bchjs.Price.getBchUsd()
+      console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
 
   describe('#rates', () => {
     it('should get the price of BCH in several currencies', async () => {

test/integration/rawtransaction.js

@@ -1,6 +1,5 @@
 /*
-  Integration tests for the bchjs. Only covers calls made to
-  rest.bitcoin.com.
+  Integration tests for the bchjs.
 
   TODO
 */
@@ -263,6 +262,7 @@ describe('#rawtransaction', () => {
       assert.equal(result.length, 1)
       assert.property(result[0], 'vin')
       assert.property(result[0], 'address')
+      assert.property(result[0], 'value')
     })
   })
 
@@ -274,32 +274,33 @@ describe('#rawtransaction', () => {
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
     })
   })
 
-  describe('#getTxDataSlp', () => {
-    it('should return tx data with SLP information', async () => {
-      const txid = 'b438855cfcab64516b44097d7212df9cdb99226c8d7c7ab504d35fcfd834cb5b'
-
-      const result = await bchjs.RawTransactions.getTxDataSlp(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result.vin[0], 'address')
-      assert.property(result.vin[0], 'tokenQty')
-
-      assert.equal(result.vin[0].tokenQty, null)
-      assert.equal(result.vin[1].tokenQty, '100000000000')
-    })
-
-    it('should handle non-slp tx', async () => {
-      const txid = '04a6aca328af2445327015895b8da9766093b1989b52e477559759eb8072fc0a'
-
-      const result = await bchjs.RawTransactions.getTxDataSlp(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.equal(result, false)
-    })
-  })
+  // describe('#getTxDataSlp', () => {
+  //   it('should return tx data with SLP information', async () => {
+  //     const txid = 'b438855cfcab64516b44097d7212df9cdb99226c8d7c7ab504d35fcfd834cb5b'
+  //
+  //     const result = await bchjs.RawTransactions.getTxDataSlp(txid)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.property(result.vin[0], 'address')
+  //     assert.property(result.vin[0], 'tokenQty')
+  //
+  //     assert.equal(result.vin[0].tokenQty, null)
+  //     assert.equal(result.vin[1].tokenQty, '100000000000')
+  //   })
+  //
+  //   it('should handle non-slp tx', async () => {
+  //     const txid = '04a6aca328af2445327015895b8da9766093b1989b52e477559759eb8072fc0a'
+  //
+  //     const result = await bchjs.RawTransactions.getTxDataSlp(txid)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.equal(result, false)
+  //   })
+  // })
 })
 
 function sleep (ms) {

test/integration/slp.js

@@ -24,7 +24,7 @@ describe('#SLP', () => {
 
   beforeEach(async () => {
     // Introduce a delay so that the BVT doesn't trip the rate limits.
-    if (process.env.IS_USING_FREE_TIER) await sleep(1000)
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
 
     bchjs = new BCHJS()
   })
@@ -639,7 +639,7 @@ describe('#SLP', () => {
       })
     })
 
-    describe('#hydrateUtxos', () => {
+    describe('#hydrateUtxos-', () => {
       it('should hydrate UTXOs', async () => {
         const utxos = [
           {

test/integration/transaction-integration.js

@@ -0,0 +1,60 @@
+/*
+  Integration tests for the transaction.js library.
+*/
+
+const assert = require('chai').assert
+const BCHJS = require('../../src/bch-js')
+const bchjs = new BCHJS()
+
+describe('#Transaction', () => {
+  beforeEach(async () => {
+    if (process.env.IS_USING_FREE_TIER) await bchjs.Util.sleep(1000)
+  })
+
+  describe('#get', () => {
+    it('should get details about a non-SLP transaction', async () => {
+      const txid =
+        '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7'
+
+      const result = await bchjs.Transaction.get(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that there are stanardized properties.
+      assert.property(result, 'txid')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.property(result.vout[0], 'value')
+      assert.property(result.vout[0].scriptPubKey, 'addresses')
+
+      // Assert that added properties exist.
+      assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
+      assert.property(result, 'isValidSLPTx')
+      assert.equal(result.isValidSLPTx, false)
+    })
+
+    it('should get details about a SLP transaction', async () => {
+      const txid =
+        '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1'
+
+      const result = await bchjs.Transaction.get(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that there are stanardized properties.
+      assert.property(result, 'txid')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.property(result.vout[0], 'value')
+      assert.property(result.vout[1].scriptPubKey, 'addresses')
+
+      // Assert that added properties exist.
+      assert.property(result.vout[0], 'tokenQty')
+      assert.equal(result.vout[0].tokenQty, null)
+      assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
+      assert.property(result.vin[0], 'tokenQty')
+      assert.property(result, 'isValidSLPTx')
+      assert.equal(result.isValidSLPTx, true)
+    })
+  })
+})

test/unit/fixtures/slp/mock-utils.js

@@ -1290,6 +1290,100 @@ const slpdbStatus = {
   }
 }
 
+const txDetailsSLPNftChild = {
+  txid: 'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b',
+  hash: 'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b',
+  version: 2,
+  size: 453,
+  locktime: 0,
+  vin: [
+    {
+      txid: 'a9a2458a0f9f0761d5b8725c256f2e7fa35b9de4dec6f47b46e9f20d92d0e395',
+      vout: 1,
+      scriptSig: {
+        asm:
+          '3045022100890ff2f80f3c184419ba03a575b9d159c0a5edfa817e4548cfdb6c74d16ce8d202205a8237d2139196716c273fe80506896d369a0022bb54401e2eadb364286a9f07[ALL|FORKID] 03136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623b',
+        hex:
+          '483045022100890ff2f80f3c184419ba03a575b9d159c0a5edfa817e4548cfdb6c74d16ce8d202205a8237d2139196716c273fe80506896d369a0022bb54401e2eadb364286a9f07412103136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623b'
+      },
+      sequence: 4294967295
+    },
+    {
+      txid: 'a9a2458a0f9f0761d5b8725c256f2e7fa35b9de4dec6f47b46e9f20d92d0e395',
+      vout: 3,
+      scriptSig: {
+        asm:
+          '304402203905a61ec4e3567f7cad7eb514132e5b32d8a1d77c8838baac1b34b735282a5f022044da6130b5cc41b65615b17df6610087fe1baedd1a3a9f37552b56ea8d36d026[ALL|FORKID] 03136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623b',
+        hex:
+          '47304402203905a61ec4e3567f7cad7eb514132e5b32d8a1d77c8838baac1b34b735282a5f022044da6130b5cc41b65615b17df6610087fe1baedd1a3a9f37552b56ea8d36d026412103136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623b'
+      },
+      sequence: 4294967295
+    }
+  ],
+  vout: [
+    {
+      value: 0,
+      n: 0,
+      scriptPubKey: {
+        asm:
+          'OP_RETURN 5262419 65 47454e45534953 4e4654303034 4e4654204368696c64 68747470733a2f2f46756c6c537461636b2e63617368 0 0 0 0000000000000001',
+        hex:
+          '6a04534c500001410747454e45534953064e4654303034094e4654204368696c641668747470733a2f2f46756c6c537461636b2e636173684c0001004c00080000000000000001',
+        type: 'nulldata'
+      }
+    },
+    {
+      value: 0.00000546,
+      n: 1,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 f6fc6bce702ef779d2373aa4356a32113d95e674 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914f6fc6bce702ef779d2373aa4356a32113d95e67488ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv']
+      }
+    },
+    {
+      value: 0.0003923,
+      n: 2,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 f6fc6bce702ef779d2373aa4356a32113d95e674 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914f6fc6bce702ef779d2373aa4356a32113d95e67488ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv']
+      }
+    }
+  ],
+  hex:
+    '020000000295e3d0920df2e9467bf4c6dee49d5ba37f2e6f255c72b8d561079f0f8a45a2a9010000006b483045022100890ff2f80f3c184419ba03a575b9d159c0a5edfa817e4548cfdb6c74d16ce8d202205a8237d2139196716c273fe80506896d369a0022bb54401e2eadb364286a9f07412103136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623bffffffff95e3d0920df2e9467bf4c6dee49d5ba37f2e6f255c72b8d561079f0f8a45a2a9030000006a47304402203905a61ec4e3567f7cad7eb514132e5b32d8a1d77c8838baac1b34b735282a5f022044da6130b5cc41b65615b17df6610087fe1baedd1a3a9f37552b56ea8d36d026412103136d9ec06adef1c9154105950e82d470d290aa019ed34a5e3bbd0b679805623bffffffff030000000000000000476a04534c500001410747454e45534953064e4654303034094e4654204368696c641668747470733a2f2f46756c6c537461636b2e636173684c0001004c0008000000000000000122020000000000001976a914f6fc6bce702ef779d2373aa4356a32113d95e67488ac3e990000000000001976a914f6fc6bce702ef779d2373aa4356a32113d95e67488ac00000000',
+  blockhash: '000000000000000001360fe42629f4136e9adec53546b278de0e7ef788eed328',
+  confirmations: 2113,
+  time: 1613181364,
+  blocktime: 1613181364
+}
+
+const mock429Error = new Error('Request failed with status code 429')
+mock429Error.response = {
+  status: 429,
+  statusText: 'Too Many Requests',
+  data: {
+    error:
+      'Too many requests. Your limits are currently 100 requests per minute. Increase rate limits at https://fullstack.cash'
+  }
+}
+
+const mock503Error = new Error('Request failed with status code 503')
+mock503Error.response = {
+  status: 503,
+  statusText: 'Service Unavailable',
+  data: {
+    error: 'Some error message'
+  }
+}
+
 module.exports = {
   mockList,
   mockToken,
@@ -1311,6 +1405,7 @@ module.exports = {
   txDetailsSLPGenesisNoBaton,
   txDetailsSLPSendAlt,
   txDetailsSLPNftGenesis,
+  txDetailsSLPNftChild,
   mockTxDetails,
   mockDualValidation,
   mockDualOpData,
@@ -1320,5 +1415,7 @@ module.exports = {
   mockValidateTxid3Invalid,
   whitelist,
   slpdbStatus,
-  mockValidateTxidArray
+  mockValidateTxidArray,
+  mock429Error,
+  mock503Error
 }

test/unit/fixtures/transaction-mock.js

@@ -0,0 +1,184 @@
+/*
+  Mocking data used in the transaction-unit.js tests.
+*/
+
+const nonSlpTxDetails = {
+  txid: '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7',
+  hash: '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7',
+  version: 2,
+  size: 225,
+  locktime: 0,
+  vin: [
+    {
+      txid: '5f09d317e24c5d376f737a2711f3bd1d381abdb41743fff3819b4f76382e1eac',
+      vout: 1,
+      scriptSig: {
+        asm:
+          '3044022000dd11c41a472f2e54348db996e60864d489429f12d1e044d49ff600b880c9590220715a926404bb0e2731a3795afb341ec1dad3f84ead7d27cd31fcc59abb14738c[ALL|FORKID] 038476128287ac37c7a3cf7e8625fd5f024db1bc3d8e37395abe7bf42fda78d0d9',
+        hex:
+          '473044022000dd11c41a472f2e54348db996e60864d489429f12d1e044d49ff600b880c9590220715a926404bb0e2731a3795afb341ec1dad3f84ead7d27cd31fcc59abb14738c4121038476128287ac37c7a3cf7e8625fd5f024db1bc3d8e37395abe7bf42fda78d0d9'
+      },
+      sequence: 4294967295,
+      address: 'bitcoincash:qqxy8hycqe89j7wa79gnggq6z3gaqu2uvqy26xehfe',
+      value: 0.00047504
+    }
+  ],
+  vout: [
+    {
+      value: 0.00001,
+      n: 0,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 2fe2c4c5ef359bb2fe1a849f891cecffbcfb4f77 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a9142fe2c4c5ef359bb2fe1a849f891cecffbcfb4f7788ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9']
+      }
+    },
+    {
+      value: 0.00046256,
+      n: 1,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 2dbf5e1804c39a497b908c876097d63210c84902 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a9142dbf5e1804c39a497b908c876097d63210c8490288ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qqkm7hscqnpe5jtmjzxgwcyh6ceppjzfqg3jdn422e']
+      }
+    }
+  ],
+  hex:
+    '0200000001ac1e2e38764f9b81f3ff4317b4bd1a381dbdf311277a736f375d4ce217d3095f010000006a473044022000dd11c41a472f2e54348db996e60864d489429f12d1e044d49ff600b880c9590220715a926404bb0e2731a3795afb341ec1dad3f84ead7d27cd31fcc59abb14738c4121038476128287ac37c7a3cf7e8625fd5f024db1bc3d8e37395abe7bf42fda78d0d9ffffffff02e8030000000000001976a9142fe2c4c5ef359bb2fe1a849f891cecffbcfb4f7788acb0b40000000000001976a9142dbf5e1804c39a497b908c876097d63210c8490288ac00000000',
+  blockhash: '0000000000000000010903a1fc4274499037c9339be9ec7338ee980331c20ce5',
+  confirmations: 77741,
+  time: 1569792892,
+  blocktime: 1569792892
+}
+
+const slpTxDetails = {
+  txid: '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1',
+  hash: '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1',
+  version: 2,
+  size: 479,
+  locktime: 0,
+  vin: [
+    {
+      txid: 'abc685f1f2a95f51e5e05a350f3fb9c74676e9f78c835b2a019c888ac0a2a736',
+      vout: 2,
+      scriptSig: {
+        asm:
+          '3045022100e5f0f6f1212fcbb10eedb7fdc38fca6e86629b4e7e8356a3ad7371a109fc37a602204bfff37d1a34d2e2908b81c23677706fb59ff4ab639fa3299da6c303de74e1f7[ALL|FORKID] 0245b9b3586fab3cfd46db6d116c4588004fe7fe9798216ccb8e55a89bcebc07ac',
+        hex:
+          '483045022100e5f0f6f1212fcbb10eedb7fdc38fca6e86629b4e7e8356a3ad7371a109fc37a602204bfff37d1a34d2e2908b81c23677706fb59ff4ab639fa3299da6c303de74e1f741210245b9b3586fab3cfd46db6d116c4588004fe7fe9798216ccb8e55a89bcebc07ac'
+      },
+      sequence: 4294967295,
+      address: 'bitcoincash:qzv7t2pzn2d0pklnetdjt65crh6fe8vnhuwvhsk2nn',
+      value: 0.00000546
+    },
+    {
+      txid: '58c8576404c01c23a224053307399483d3a070599b3e9eb6d45be9714b8d6856',
+      vout: 1,
+      scriptSig: {
+        asm:
+          '30430220784f6d81fa8f54db8a4948259e8c15972a0285f8b1640c433d4e9f606dc38f0c021f14eecc2e8af2efede0867ce459c400dde54186a0e64babdbe89f795db12753[ALL|FORKID] 0209ebe6d9da5043945ed1d81bec0fcace299eba05e5f46b72d6838c790d31c505',
+        hex:
+          '4630430220784f6d81fa8f54db8a4948259e8c15972a0285f8b1640c433d4e9f606dc38f0c021f14eecc2e8af2efede0867ce459c400dde54186a0e64babdbe89f795db1275341210209ebe6d9da5043945ed1d81bec0fcace299eba05e5f46b72d6838c790d31c505'
+      },
+      sequence: 4294967295,
+      address: 'bitcoincash:qppzuxemgqyxf07nz3kan33gmc83mf3z3yz295c4s7',
+      value: 0.68369626
+    }
+  ],
+  vout: [
+    {
+      value: 0,
+      n: 0,
+      scriptPubKey: {
+        asm:
+          'OP_RETURN 5262419 1 1145980243 497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7 0000000005f5e100 00005ad7e49d9100',
+        hex:
+          '6a04534c500001010453454e4420497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7080000000005f5e1000800005ad7e49d9100',
+        type: 'nulldata'
+      }
+    },
+    {
+      value: 0.00000546,
+      n: 1,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 36be3b7d185a85b6cf6fc61d63c16f2f10e54260 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a91436be3b7d185a85b6cf6fc61d63c16f2f10e5426088ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qqmtuwmarpdgtdk0dlrp6c7pduh3pe2zvqrkys2ex8']
+      }
+    },
+    {
+      value: 0.00000546,
+      n: 2,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 99e5a8229a9af0dbf3cadb25ea981df49c9d93bf OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a91499e5a8229a9af0dbf3cadb25ea981df49c9d93bf88ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qzv7t2pzn2d0pklnetdjt65crh6fe8vnhuwvhsk2nn']
+      }
+    },
+    {
+      value: 0.68368564,
+      n: 3,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 422e1b3b400864bfd3146dd9c628de0f1da62289 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914422e1b3b400864bfd3146dd9c628de0f1da6228988ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qppzuxemgqyxf07nz3kan33gmc83mf3z3yz295c4s7']
+      }
+    }
+  ],
+  hex:
+    '020000000236a7a2c08a889c012a5b838cf7e97646c7b93f0f355ae0e5515fa9f2f185c6ab020000006b483045022100e5f0f6f1212fcbb10eedb7fdc38fca6e86629b4e7e8356a3ad7371a109fc37a602204bfff37d1a34d2e2908b81c23677706fb59ff4ab639fa3299da6c303de74e1f741210245b9b3586fab3cfd46db6d116c4588004fe7fe9798216ccb8e55a89bcebc07acffffffff56688d4b71e95bd4b69e3e9b5970a0d383943907330524a2231cc0046457c85801000000694630430220784f6d81fa8f54db8a4948259e8c15972a0285f8b1640c433d4e9f606dc38f0c021f14eecc2e8af2efede0867ce459c400dde54186a0e64babdbe89f795db1275341210209ebe6d9da5043945ed1d81bec0fcace299eba05e5f46b72d6838c790d31c505ffffffff040000000000000000406a04534c500001010453454e4420497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7080000000005f5e1000800005ad7e49d910022020000000000001976a91436be3b7d185a85b6cf6fc61d63c16f2f10e5426088ac22020000000000001976a91499e5a8229a9af0dbf3cadb25ea981df49c9d93bf88acb4381304000000001976a914422e1b3b400864bfd3146dd9c628de0f1da6228988ac00000000',
+  blockhash: '0000000000000000015284202422a688554b7fc80c54f18122847a99c4f79607',
+  confirmations: 76722,
+  time: 1570392893,
+  blocktime: 1570392893
+}
+
+const mockOpReturnData01 = {
+  tokenType: 1,
+  txType: 'SEND',
+  tokenId: '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+  amounts: ['100000000', '99883300000000']
+}
+
+const mockOpReturnData02 = {
+  tokenType: 1,
+  txType: 'GENESIS',
+  ticker: 'TOK-CH',
+  name: 'TokyoCash',
+  tokenId: '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+  documentUri: '',
+  documentHash: '',
+  decimals: 8,
+  mintBatonVout: 0,
+  qty: '2100000000000000'
+}
+
+const mockOpReturnData03 = {
+  tokenType: 1,
+  txType: 'SEND',
+  tokenId: '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+  amounts: ['1000000000', '99883400000000']
+}
+
+module.exports = {
+  nonSlpTxDetails,
+  slpTxDetails,
+  mockOpReturnData01,
+  mockOpReturnData02,
+  mockOpReturnData03
+}

test/unit/price.js

@@ -67,4 +67,26 @@ describe('#price', () => {
       assert.isNumber(result)
     })
   })
+  describe('#getBchUsd', () => {
+    it('should get the USD price of BCH', async () => {
+      sandbox.stub(bchjs.Price.axios, 'get').resolves({ data: { usd: 510.39 } })
+
+      const result = await bchjs.Price.getBchUsd()
+      // console.log(result)
+
+      assert.isNumber(result)
+    })
+    it('should handle error', async () => {
+      try {
+        sandbox.stub(bchjs.Price.axios, 'get').throws(new Error('test error'))
+
+        await bchjs.Price.getBchUsd()
+        // console.log(result)
+
+        assert.equal(false, true, 'unexpected error')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
 })

test/unit/raw-tranactions.js

@@ -1,6 +1,5 @@
 /*
-  TODO:
-  -Create a mocking library of data to compare unit and integration tests.
+  Unit tests for raw-transactions.js library.
 */
 
 // Public npm libraries

test/unit/slp-utils.js

@@ -453,33 +453,383 @@ describe('#SLP Utils', () => {
       assert.equal(data.qty, 1)
     })
 
-    // it("should decode a NFT Child transaction", async () => {
-    //   // Mock the call to the REST API.
-    //   // sandbox
-    //   //   .stub(uut.Utils.axios, "get")
-    //   //   .resolves({ data: mockData.txDetailsSLPNftGenesis })
-    //
-    //   const txid =
-    //     "3de3766b10506c9156533f1639979e49d1884521543c13e4af73647df1ed3f76"
-    //
-    //   const data = await uut.Utils.decodeOpReturn(txid)
-    //   console.log(`data: ${JSON.stringify(data, null, 2)}`)
-    //
-    //   // assert.property(data, "tokenType")
-    //   // assert.property(data, "txType")
-    //   // assert.property(data, "ticker")
-    //   // assert.property(data, "name")
-    //   // assert.property(data, "tokenId")
-    //   // assert.property(data, "documentUri")
-    //   // assert.property(data, "documentHash")
-    //   // assert.property(data, "decimals")
-    //   // assert.property(data, "mintBatonVout")
-    //   // assert.property(data, "qty")
-    //   //
-    //   // assert.equal(data.tokenType, 129)
-    //   // assert.equal(data.mintBatonVout, 2)
-    //   // assert.equal(data.qty, 1)
-    // })
+    it('should decode a NFT Child transaction', async () => {
+      // Mock the call to the REST API.
+      sandbox
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPNftChild] })
+
+      const txid =
+        'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b'
+
+      const data = await uut.Utils.decodeOpReturn(txid)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      assert.property(data, 'tokenType')
+      assert.property(data, 'txType')
+      assert.property(data, 'ticker')
+      assert.property(data, 'name')
+      assert.property(data, 'tokenId')
+      assert.property(data, 'documentUri')
+      assert.property(data, 'documentHash')
+      assert.property(data, 'decimals')
+      assert.property(data, 'mintBatonVout')
+      assert.property(data, 'qty')
+
+      assert.equal(data.tokenType, 65)
+      assert.equal(data.mintBatonVout, 0)
+      assert.equal(data.qty, '1')
+    })
+
+    // 429 means the user is exceeding the rate limits.
+    it('should throw error when axios returns 429 status', async () => {
+      try {
+        // Mock the call to the REST API
+        sandbox.stub(uut.Utils.axios, 'post').rejects(mockData.mock429Error)
+
+        const txid =
+          'a60a522cc11ad7011b74e57fbabbd99296e4b9346bcb175dcf84efb737030415'
+
+        await uut.Utils.decodeOpReturn(txid)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.fail('Unexpect result')
+      } catch (err) {
+        // console.log('err: ', err)
+
+        assert.property(err, 'message')
+        assert.property(err, 'response')
+        assert.equal(err.response.status, 429)
+        assert.equal(err.response.statusText, 'Too Many Requests')
+        assert.include(err.response.data.error, 'Too many requests')
+      }
+    })
+
+    // 503 means the service is down.
+    it('should throw error when axios returns 503 status', async () => {
+      try {
+        // Mock the call to the REST API
+        sandbox.stub(uut.Utils.axios, 'post').rejects(mockData.mock503Error)
+
+        const txid =
+          'a60a522cc11ad7011b74e57fbabbd99296e4b9346bcb175dcf84efb737030415'
+
+        await uut.Utils.decodeOpReturn(txid)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.fail('Unexpect result')
+      } catch (err) {
+        // console.log('err: ', err)
+
+        assert.property(err, 'message')
+        assert.property(err, 'response')
+        assert.equal(err.response.status, 503)
+        assert.equal(err.response.statusText, 'Service Unavailable')
+        assert.property(err.response, 'data')
+      }
+    })
+  })
+
+  describe('#_hydrateUtxo', () => {
+    // // This captures an important corner-case. When an SLP token is created, the
+    // // change UTXO will contain the same SLP txid, but it is not an SLP UTXO.
+    it('should return details on minting baton from genesis transaction', async () => {
+      // Mock the call to REST API
+      // sandbox.stub(uut.Utils, 'waterfallValidateTxid').resolves(true)
+
+      // Stub the calls to decodeOpReturn.
+      sandbox.stub(uut.Utils, 'decodeOpReturn').resolves({
+        tokenType: 1,
+        txType: 'GENESIS',
+        ticker: 'SLPSDK',
+        name: 'SLP SDK example using BITBOX',
+        tokenId:
+          'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+        documentUri: 'developer.bitcoin.com',
+        documentHash: '',
+        decimals: 8,
+        mintBatonVout: 2,
+        qty: '50700000000'
+      })
+
+      const utxos = [
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 3,
+          amount: 0.00002015,
+          satoshis: 2015,
+          height: 594892,
+          confirmations: 5
+        },
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 2,
+          amount: 0.00000546,
+          satoshis: 546,
+          height: 594892,
+          confirmations: 5
+        }
+      ]
+
+      const data = await uut.Utils._hydrateUtxo(utxos)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      // assert.equal(data[0], false, "Change UTXO marked as false.")
+      assert.property(data[0], 'txid')
+      assert.property(data[0], 'vout')
+      assert.property(data[0], 'amount')
+      assert.property(data[0], 'satoshis')
+      assert.property(data[0], 'height')
+      assert.property(data[0], 'confirmations')
+      assert.property(data[0], 'isValid')
+      assert.equal(data[0].isValid, false)
+
+      assert.property(data[1], 'txid')
+      assert.property(data[1], 'vout')
+      assert.property(data[1], 'amount')
+      assert.property(data[1], 'satoshis')
+      assert.property(data[1], 'height')
+      assert.property(data[1], 'confirmations')
+      assert.property(data[1], 'utxoType')
+      assert.property(data[1], 'tokenId')
+      assert.property(data[1], 'tokenTicker')
+      assert.property(data[1], 'tokenName')
+      assert.property(data[1], 'tokenDocumentUrl')
+      assert.property(data[1], 'tokenDocumentHash')
+      assert.property(data[1], 'decimals')
+    })
+
+    // 429 means the user is exceeding the rate limits.
+    it('should return isValid=null for 429 rate limit error', async () => {
+      // Force decodeOpReturn() to throw a 429 error.
+      sandbox.stub(uut.Utils, 'decodeOpReturn').rejects(mockData.mock429Error)
+
+      const utxos = [
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 3,
+          amount: 0.00002015,
+          satoshis: 2015,
+          height: 594892,
+          confirmations: 5
+        },
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 2,
+          amount: 0.00000546,
+          satoshis: 546,
+          height: 594892,
+          confirmations: 5
+        }
+      ]
+
+      const result = await uut.Utils._hydrateUtxo(utxos)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result[0].isValid, null)
+      assert.equal(result[1].isValid, null)
+    })
+
+    // 503 means the server is down or is not responding.
+    it('should return isValid=null for 503 rate limit error', async () => {
+      // Force decodeOpReturn() to throw a 429 error.
+      sandbox.stub(uut.Utils, 'decodeOpReturn').rejects(mockData.mock503Error)
+
+      const utxos = [
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 3,
+          amount: 0.00002015,
+          satoshis: 2015,
+          height: 594892,
+          confirmations: 5
+        },
+        {
+          txid:
+            'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
+          vout: 2,
+          amount: 0.00000546,
+          satoshis: 546,
+          height: 594892,
+          confirmations: 5
+        }
+      ]
+
+      const result = await uut.Utils._hydrateUtxo(utxos)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result[0].isValid, null)
+      assert.equal(result[1].isValid, null)
+    })
+
+    it('should return details for a simple SEND SLP token utxo', async () => {
+      // Mock the call to REST API
+      // Stub the calls to decodeOpReturn.
+      sandbox
+        .stub(uut.Utils, 'decodeOpReturn')
+        .onCall(0)
+        .resolves({
+          tokenType: 1,
+          txType: 'SEND',
+          tokenId:
+            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+          amounts: ['200000000', '99887500000000']
+        })
+        .onCall(1)
+        .resolves({
+          tokenType: 1,
+          txType: 'GENESIS',
+          ticker: 'TOK-CH',
+          name: 'TokyoCash',
+          tokenId:
+            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+          documentUri: '',
+          documentHash: '',
+          decimals: 8,
+          mintBatonVout: 0,
+          qty: '2100000000000000'
+        })
+
+      // sandbox.stub(uut.Utils, 'waterfallValidateTxid').resolves(true)
+
+      const utxos = [
+        {
+          txid:
+            'fde117b1f176b231e2fa9a6cb022e0f7c31c288221df6bcb05f8b7d040ca87cb',
+          vout: 1,
+          amount: 0.00000546,
+          satoshis: 546,
+          height: 596089,
+          confirmations: 748
+        }
+      ]
+
+      const data = await uut.Utils._hydrateUtxo(utxos)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      assert.property(data[0], 'txid')
+      assert.property(data[0], 'vout')
+      assert.property(data[0], 'amount')
+      assert.property(data[0], 'satoshis')
+      assert.property(data[0], 'height')
+      assert.property(data[0], 'confirmations')
+      assert.property(data[0], 'utxoType')
+      assert.property(data[0], 'tokenId')
+      assert.property(data[0], 'tokenTicker')
+      assert.property(data[0], 'tokenName')
+      assert.property(data[0], 'tokenDocumentUrl')
+      assert.property(data[0], 'tokenDocumentHash')
+      assert.property(data[0], 'decimals')
+      assert.property(data[0], 'tokenQty')
+      assert.property(data[0], 'isValid')
+      assert.equal(data[0].isValid, null)
+    })
+
+    // I don't know if this is the ideal behavior, but this is the behavior
+    // that is in production, so I wanted to capture it in a test case. This
+    // behavior can always be changed in the future.
+    it('should throw error if 429 when querying Genesis transaction', async () => {
+      try {
+        // Mock the call to REST API
+        // Stub the calls to decodeOpReturn.
+        sandbox
+          .stub(uut.Utils, 'decodeOpReturn')
+          .onCall(0)
+          .resolves({
+            tokenType: 1,
+            txType: 'SEND',
+            tokenId:
+              '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+            amounts: ['200000000', '99887500000000']
+          })
+          .onCall(1)
+          .rejects(mockData.mock429Error)
+
+        const utxos = [
+          {
+            txid:
+              'fde117b1f176b231e2fa9a6cb022e0f7c31c288221df6bcb05f8b7d040ca87cb',
+            vout: 1,
+            amount: 0.00000546,
+            satoshis: 546,
+            height: 596089,
+            confirmations: 748
+          }
+        ]
+
+        await uut.Utils._hydrateUtxo(utxos)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('error: ', err)
+
+        assert.property(err, 'message')
+        assert.property(err, 'response')
+        assert.equal(err.response.status, 429)
+        assert.equal(err.response.statusText, 'Too Many Requests')
+        assert.include(err.response.data.error, 'Too many requests')
+      }
+    })
+
+    it('should add delay if delay is specified', async () => {
+      // Mock the call to REST API
+      // Stub the calls to decodeOpReturn.
+      sandbox
+        .stub(uut.Utils, 'decodeOpReturn')
+        .onCall(0)
+        .resolves({
+          tokenType: 1,
+          txType: 'SEND',
+          tokenId:
+            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+          amounts: ['200000000', '99887500000000']
+        })
+        .onCall(1)
+        .resolves({
+          tokenType: 1,
+          txType: 'GENESIS',
+          ticker: 'TOK-CH',
+          name: 'TokyoCash',
+          tokenId:
+            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
+          documentUri: '',
+          documentHash: '',
+          decimals: 8,
+          mintBatonVout: 0,
+          qty: '2100000000000000'
+        })
+
+      // sandbox.stub(uut.Utils, 'waterfallValidateTxid').resolves(true)
+
+      const utxos = [
+        {
+          txid:
+            'fde117b1f176b231e2fa9a6cb022e0f7c31c288221df6bcb05f8b7d040ca87cb',
+          vout: 1,
+          amount: 0.00000546,
+          satoshis: 546,
+          height: 596089,
+          confirmations: 748
+        }
+      ]
+
+      const usrObj = {
+        utxoDelay: 100
+      }
+
+      await uut.Utils._hydrateUtxo(utxos, usrObj)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      // TODO: This test should realy assert that the test took at least 100mS
+      // to complete. However, as-is, it exercises the code path, so not
+      // throwing an error can be considered a pass.
+      assert.equal(true, true)
+    })
   })
 
   describe('#tokenUtxoDetails', () => {

test/unit/transaction-unit.js

@@ -0,0 +1,119 @@
+/*
+  Unit tests for the transaction.js library.
+*/
+
+// Public npm libraries
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+const BCHJS = require('../../src/bch-js')
+const bchjs = new BCHJS()
+
+const mockData = require('./fixtures/transaction-mock.js')
+
+describe('#TransactionLib', () => {
+  let sandbox
+  beforeEach(() => (sandbox = sinon.createSandbox()))
+  afterEach(() => sandbox.restore())
+
+  describe('#get', () => {
+    it('should throw an error if txid is not specified', async () => {
+      try {
+        await bchjs.Transaction.get()
+
+        assert.fail('Unexpected code path!')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Input must be a string or array of strings.'
+        )
+      }
+    })
+
+    it('should get details about a non-SLP transaction', async () => {
+      const txid =
+        '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7'
+
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.Transaction.rawTransaction, 'getTxData')
+        .resolves(mockData.nonSlpTxDetails)
+
+      const result = await bchjs.Transaction.get(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that there are stanardized properties.
+      assert.property(result, 'txid')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.property(result.vout[0], 'value')
+      assert.property(result.vout[0].scriptPubKey, 'addresses')
+
+      // Assert that added properties exist.
+      assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
+      assert.property(result, 'isValidSLPTx')
+      assert.equal(result.isValidSLPTx, false)
+    })
+
+    it('should get details about a SLP transaction', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.Transaction.rawTransaction, 'getTxData')
+        .resolves(mockData.slpTxDetails)
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'decodeOpReturn')
+        .onCall(0)
+        .resolves(mockData.mockOpReturnData01)
+        .onCall(1)
+        .resolves(mockData.mockOpReturnData02)
+        .onCall(2)
+        .resolves(mockData.mockOpReturnData03)
+        .onCall(3)
+        .rejects(new Error('No OP_RETURN'))
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'waterfallValidateTxid')
+        .resolves(true)
+
+      const txid =
+        '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1'
+
+      const result = await bchjs.Transaction.get(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that there are stanardized properties.
+      assert.property(result, 'txid')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.property(result.vout[0], 'value')
+      assert.property(result.vout[1].scriptPubKey, 'addresses')
+
+      // Assert that added properties exist.
+      assert.property(result.vout[0], 'tokenQty')
+      assert.equal(result.vout[0].tokenQty, null)
+      assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
+      assert.property(result.vin[0], 'tokenQty')
+      assert.property(result, 'isValidSLPTx')
+      assert.equal(result.isValidSLPTx, true)
+    })
+
+    it('should catch and throw error on network error', async () => {
+      try {
+        const txid =
+          '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7'
+
+        // Force an error
+        sandbox
+          .stub(bchjs.Transaction.rawTransaction, 'getTxData')
+          .rejects(new Error('test error'))
+
+        await bchjs.Transaction.get(txid)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+})