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

fix(decodeOpReturn): Replacing error message with better one

package-lock.json

@@ -10,7 +10,7 @@
       "license": "MIT",
       "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",
@@ -576,11 +576,11 @@
       }
     },
     "node_modules/@psf/bip32-utils": {
-      "version": "0.13.1",
-      "resolved": "https://registry.npmjs.org/@psf/bip32-utils/-/bip32-utils-0.13.1.tgz",
-      "integrity": "sha512-5yM2o4TXW3gWKI3zxUFj9eeYqMYbA4Q1w+ptcfb+XnGpSZLrmwGtX48q8rApIKtikRceMEFXp1Jq6ed+bS+1nA==",
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@psf/bip32-utils/-/bip32-utils-1.0.0.tgz",
+      "integrity": "sha512-cWE+uZsGyS2PsE5+bplNq7w/oE3/wGGP0pZV9TiSNMIQvJguxfu7Ruk2FuzROcaVysBclDaL70A9N3sAnworGA==",
       "dependencies": {
-        "keccak": "^1.3.0",
+        "keccak": "^3.0.1",
         "nyc": "*",
         "standard": "^11.0.1",
         "tape": "*"
@@ -5697,18 +5697,16 @@
       "dev": true
     },
     "node_modules/keccak": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/keccak/-/keccak-1.4.0.tgz",
-      "integrity": "sha512-eZVaCpblK5formjPjeTBik7TAg+pqnDrMHIffSvi9Lh7PQgM1+hSzakUeZFCk9DVVG0dacZJuaz2ntwlzZUIBw==",
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/keccak/-/keccak-3.0.1.tgz",
+      "integrity": "sha512-epq90L9jlFWCW7+pQa6JOnKn2Xgl2mtI664seYR6MHskvI9agt7AnDqmAlp9TqU4/caMYbA08Hi5DMZAl5zdkA==",
       "hasInstallScript": true,
       "dependencies": {
-        "bindings": "^1.2.1",
-        "inherits": "^2.0.3",
-        "nan": "^2.2.1",
-        "safe-buffer": "^5.1.0"
+        "node-addon-api": "^2.0.0",
+        "node-gyp-build": "^4.2.0"
       },
       "engines": {
-        "node": ">=4.0.0"
+        "node": ">=10.0.0"
       }
     },
     "node_modules/kind-of": {
@@ -6878,6 +6876,11 @@
         "@sinonjs/commons": "^1.7.0"
       }
     },
+    "node_modules/node-addon-api": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-2.0.2.tgz",
+      "integrity": "sha512-Ntyt4AIXyaLIuMHF6IOoTakB3K+RWxwtsHNRxllEoA6vPwP9o4866g6YWDLUdnucilZhmkxiHwHr11gAENw+QA=="
+    },
     "node_modules/node-emoji": {
       "version": "1.10.0",
       "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-1.10.0.tgz",
@@ -6915,6 +6918,16 @@
         "node": "4.x || >=6.0.0"
       }
     },
+    "node_modules/node-gyp-build": {
+      "version": "4.2.3",
+      "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.2.3.tgz",
+      "integrity": "sha512-MN6ZpzmfNCRM+3t57PTJHgHyw/h4OWnZ6mR8P5j/uZtqQr46RRuDE/P+g3n0YR/AiYXeWixZZzaip77gdICfRg==",
+      "bin": {
+        "node-gyp-build": "bin.js",
+        "node-gyp-build-optional": "optional.js",
+        "node-gyp-build-test": "build-test.js"
+      }
+    },
     "node_modules/node-mocks-http": {
       "version": "1.10.1",
       "resolved": "https://registry.npmjs.org/node-mocks-http/-/node-mocks-http-1.10.1.tgz",
@@ -17611,11 +17624,11 @@
       }
     },
     "@psf/bip32-utils": {
-      "version": "0.13.1",
-      "resolved": "https://registry.npmjs.org/@psf/bip32-utils/-/bip32-utils-0.13.1.tgz",
-      "integrity": "sha512-5yM2o4TXW3gWKI3zxUFj9eeYqMYbA4Q1w+ptcfb+XnGpSZLrmwGtX48q8rApIKtikRceMEFXp1Jq6ed+bS+1nA==",
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@psf/bip32-utils/-/bip32-utils-1.0.0.tgz",
+      "integrity": "sha512-cWE+uZsGyS2PsE5+bplNq7w/oE3/wGGP0pZV9TiSNMIQvJguxfu7Ruk2FuzROcaVysBclDaL70A9N3sAnworGA==",
       "requires": {
-        "keccak": "^1.3.0",
+        "keccak": "^3.0.1",
         "nyc": "*",
         "standard": "^11.0.1",
         "tape": "*"
@@ -21827,14 +21840,12 @@
       "dev": true
     },
     "keccak": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/keccak/-/keccak-1.4.0.tgz",
-      "integrity": "sha512-eZVaCpblK5formjPjeTBik7TAg+pqnDrMHIffSvi9Lh7PQgM1+hSzakUeZFCk9DVVG0dacZJuaz2ntwlzZUIBw==",
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/keccak/-/keccak-3.0.1.tgz",
+      "integrity": "sha512-epq90L9jlFWCW7+pQa6JOnKn2Xgl2mtI664seYR6MHskvI9agt7AnDqmAlp9TqU4/caMYbA08Hi5DMZAl5zdkA==",
       "requires": {
-        "bindings": "^1.2.1",
-        "inherits": "^2.0.3",
-        "nan": "^2.2.1",
-        "safe-buffer": "^5.1.0"
+        "node-addon-api": "^2.0.0",
+        "node-gyp-build": "^4.2.0"
       }
     },
     "kind-of": {
@@ -22815,6 +22826,11 @@
         }
       }
     },
+    "node-addon-api": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-2.0.2.tgz",
+      "integrity": "sha512-Ntyt4AIXyaLIuMHF6IOoTakB3K+RWxwtsHNRxllEoA6vPwP9o4866g6YWDLUdnucilZhmkxiHwHr11gAENw+QA=="
+    },
     "node-emoji": {
       "version": "1.10.0",
       "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-1.10.0.tgz",
@@ -22848,6 +22864,11 @@
       "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==",
       "dev": true
     },
+    "node-gyp-build": {
+      "version": "4.2.3",
+      "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.2.3.tgz",
+      "integrity": "sha512-MN6ZpzmfNCRM+3t57PTJHgHyw/h4OWnZ6mR8P5j/uZtqQr46RRuDE/P+g3n0YR/AiYXeWixZZzaip77gdICfRg=="
+    },
     "node-mocks-http": {
       "version": "1.10.1",
       "resolved": "https://registry.npmjs.org/node-mocks-http/-/node-mocks-http-1.10.1.tgz",

package.json

@@ -16,8 +16,9 @@
     "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:integration:decatur:bchn": "export RESTURL=http://192.168.0.36:3000/v4/ && mocha --timeout 30000 test/integration/",
     "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:temp2": "mocha --timeout=30000 -g '#decodeOpReturn' test/unit/",
     "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
     "test:temp4": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#decodeOpReturn' test/integration/",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
@@ -33,7 +34,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/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/raw-transactions.js

@@ -263,7 +263,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 +278,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
         }

src/slp/utils.js

@@ -440,7 +440,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 +452,7 @@ class Utils {
         path,
         {
           txids: txids,
-          usrObj
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
@@ -651,12 +651,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 +668,7 @@ class Utils {
         path,
         {
           txids: txids,
-          usbObj
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
@@ -926,7 +926,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 +943,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.
@@ -963,7 +963,7 @@ class Utils {
         {
           verbose: true,
           txids: [txid],
-          ip
+          usrObj // pass user data when making an internal call.
         },
         _this.axiosOptions
       )
@@ -1015,8 +1015,15 @@ class Utils {
 
       return tokenData
     } catch (error) {
-      // console.log('decodeOpReturn error: ', error)
-      if (error.response && error.response.data) throw error.response.data
+      console.log('decodeOpReturn error: ', error)
+      console.log(`decodeOpReturn error.message: ${error.message}`)
+
+      if (error.response && error.response.data) {
+        // throw error.response.data
+
+        error.bchApiMessage = error.message
+        error.message = error.response.data
+      }
       throw error
     }
   }
@@ -1081,12 +1088,12 @@ class Utils {
   // 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 +1126,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,
@@ -1135,7 +1142,7 @@ class Utils {
           // 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)}`)
         }
       }
@@ -1239,11 +1246,12 @@ 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) {
+  // If this function hits a rate limit... TODO: describe specific behavior.
+  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 = []
@@ -1260,11 +1268,11 @@ 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'
@@ -1275,10 +1283,10 @@ class Utils {
               err.message.indexOf('lokad id') === -1 &&
               err.message.indexOf('trailing data') === -1)
           ) {
-            // console.log(
-            //   'unknown error from decodeOpReturn(). Marking as \'null\'',
-            //   err
-            // )
+            console.log(
+              'unknown error from decodeOpReturn(). Marking as \'null\'',
+              err
+            )
 
             utxo.isValid = null
             outAry.push(utxo)
@@ -1287,7 +1295,7 @@ class Utils {
             // an SLP UTXO.
             // Mark as false and continue the loop.
           } else {
-            // console.log('marking as invalid')
+            console.log('marking as invalid')
             utxo.isValid = false
             outAry.push(utxo)
           }
@@ -1352,7 +1360,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)}`)
 
@@ -1405,7 +1413,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)}`)
 
@@ -1439,6 +1447,7 @@ class Utils {
 
       return outAry
     } catch (error) {
+      console.log('_hydrateUtxo error: ', error)
       if (error.response && error.response.data) throw error.response.data
       throw error
     }
@@ -1480,7 +1489,7 @@ class Utils {
    * // returns
    * true
    */
-  async waterfallValidateTxid (txid, usbObj = null) {
+  async waterfallValidateTxid (txid, usrObj = null) {
     try {
       // console.log('txid: ', txid)
 
@@ -1512,7 +1521,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 +1542,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)}`
       // )