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

fix(decodeOpReturn): Added NFT child test case

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/slp/utils.js

@@ -968,7 +968,6 @@ class Utils {
         _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 +1014,21 @@ 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
+        // error.data = error.response.data
+        console.log(
+          `decodeOpReturn error.response.data: ${JSON.stringify(
+            error.response.data
+          )}`
+        )
+      }
       throw error
     }
   }
@@ -1239,6 +1251,11 @@ 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.
+  //
+  // 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`
   async _hydrateUtxo (utxos, usrObj = null) {
     try {
       const decodeOpReturnCache = {}
@@ -1264,7 +1281,10 @@ class Utils {
           )
           // 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 +1295,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 +1307,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)
           }
@@ -1439,6 +1459,7 @@ class Utils {
 
       return outAry
     } catch (error) {
+      console.log('_hydrateUtxo error: ', error)
       if (error.response && error.response.data) throw error.response.data
       throw error
     }

test/integration/slp.js

@@ -228,6 +228,29 @@ describe('#SLP', () => {
           assert.include(err.message, 'amount string size not 8 bytes')
         }
       })
+
+      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', () => {

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

@@ -1290,6 +1290,83 @@ 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')
+
 module.exports = {
   mockList,
   mockToken,
@@ -1311,6 +1388,7 @@ module.exports = {
   txDetailsSLPGenesisNoBaton,
   txDetailsSLPSendAlt,
   txDetailsSLPNftGenesis,
+  txDetailsSLPNftChild,
   mockTxDetails,
   mockDualValidation,
   mockDualOpData,
@@ -1320,5 +1398,6 @@ module.exports = {
   mockValidateTxid3Invalid,
   whitelist,
   slpdbStatus,
-  mockValidateTxidArray
+  mockValidateTxidArray,
+  mock429Error
 }

test/unit/slp-utils.js

@@ -453,33 +453,52 @@ 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.include(err.message, 'amount string size not 8 bytes')
+      }
+    })
   })
 
   describe('#tokenUtxoDetails', () => {