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

Improvements to Transaction.get()

package-lock.json

@@ -6990,9 +6990,9 @@
       }
     },
     "node_modules/npm": {
-      "version": "6.14.14",
-      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.14.tgz",
-      "integrity": "sha512-4TnYPV3rvwk9m92ON0iFrdXtRyMhrNkGdI8sr3dy1HVE3pVNxR9FyWYbjAw/HjfmHvmHUbxTVbmjAMv8NhIa6Q==",
+      "version": "6.14.15",
+      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.15.tgz",
+      "integrity": "sha512-dkcQc4n+DiJAMYG2haNAMyJbmuvevjXz+WC9dCUzodw8EovwTIc6CATSsTEplCY6c0jG4OshxFGFJsrnKJguWA==",
       "bundleDependencies": [
         "abbrev",
         "ansicolors",
@@ -7229,7 +7229,7 @@
         "sorted-union-stream": "~2.1.3",
         "ssri": "^6.0.2",
         "stringify-package": "^1.0.1",
-        "tar": "^4.4.15",
+        "tar": "^4.4.19",
         "text-table": "~0.2.0",
         "tiny-relative-date": "^1.3.0",
         "uid-number": "0.0.6",
@@ -10161,7 +10161,7 @@
       }
     },
     "node_modules/npm/node_modules/path-parse": {
-      "version": "1.0.6",
+      "version": "1.0.7",
       "dev": true,
       "inBundle": true,
       "license": "MIT"
@@ -10984,18 +10984,18 @@
       }
     },
     "node_modules/npm/node_modules/tar": {
-      "version": "4.4.15",
+      "version": "4.4.19",
       "dev": true,
       "inBundle": true,
       "license": "ISC",
       "dependencies": {
-        "chownr": "^1.1.1",
-        "fs-minipass": "^1.2.5",
-        "minipass": "^2.8.6",
-        "minizlib": "^1.2.1",
-        "mkdirp": "^0.5.0",
-        "safe-buffer": "^5.1.2",
-        "yallist": "^3.0.3"
+        "chownr": "^1.1.4",
+        "fs-minipass": "^1.2.7",
+        "minipass": "^2.9.0",
+        "minizlib": "^1.3.3",
+        "mkdirp": "^0.5.5",
+        "safe-buffer": "^5.2.1",
+        "yallist": "^3.1.1"
       },
       "engines": {
         "node": ">=4.5"
@@ -11011,6 +11011,32 @@
         "yallist": "^3.0.0"
       }
     },
+    "node_modules/npm/node_modules/tar/node_modules/safe-buffer": {
+      "version": "5.2.1",
+      "dev": true,
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ],
+      "inBundle": true,
+      "license": "MIT"
+    },
+    "node_modules/npm/node_modules/tar/node_modules/yallist": {
+      "version": "3.1.1",
+      "dev": true,
+      "inBundle": true,
+      "license": "ISC"
+    },
     "node_modules/npm/node_modules/term-size": {
       "version": "1.2.0",
       "dev": true,
@@ -12633,9 +12659,9 @@
       }
     },
     "node_modules/path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw=="
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
     },
     "node_modules/path-to-regexp": {
       "version": "1.8.0",
@@ -15478,9 +15504,9 @@
       "dev": true
     },
     "node_modules/url-parse": {
-      "version": "1.5.1",
-      "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.1.tgz",
-      "integrity": "sha512-HOfCOUJt7iSYzEx/UqgtwKRMC6EU91NFhsCHMv9oM03VJcVo2Qrp8T8kI9D7amFf1cu+/3CEhgb3rF9zL7k85Q==",
+      "version": "1.5.3",
+      "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.3.tgz",
+      "integrity": "sha512-IIORyIQD9rvj0A4CLWsHkBBJuNqWpFQe224b6j9t/ABmquIS0qDU2pY6kl6AuOrL5OkCXHMCFNe1jBcuAggjvQ==",
       "dependencies": {
         "querystringify": "^2.1.1",
         "requires-port": "^1.0.0"
@@ -21820,9 +21846,9 @@
       "dev": true
     },
     "npm": {
-      "version": "6.14.14",
-      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.14.tgz",
-      "integrity": "sha512-4TnYPV3rvwk9m92ON0iFrdXtRyMhrNkGdI8sr3dy1HVE3pVNxR9FyWYbjAw/HjfmHvmHUbxTVbmjAMv8NhIa6Q==",
+      "version": "6.14.15",
+      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.15.tgz",
+      "integrity": "sha512-dkcQc4n+DiJAMYG2haNAMyJbmuvevjXz+WC9dCUzodw8EovwTIc6CATSsTEplCY6c0jG4OshxFGFJsrnKJguWA==",
       "dev": true,
       "requires": {
         "abbrev": "~1.1.1",
@@ -21934,7 +21960,7 @@
         "sorted-union-stream": "~2.1.3",
         "ssri": "^6.0.2",
         "stringify-package": "^1.0.1",
-        "tar": "^4.4.15",
+        "tar": "^4.4.19",
         "text-table": "~0.2.0",
         "tiny-relative-date": "^1.3.0",
         "uid-number": "0.0.6",
@@ -24230,7 +24256,7 @@
           "dev": true
         },
         "path-parse": {
-          "version": "1.0.6",
+          "version": "1.0.7",
           "bundled": true,
           "dev": true
         },
@@ -24865,17 +24891,17 @@
           }
         },
         "tar": {
-          "version": "4.4.15",
+          "version": "4.4.19",
           "bundled": true,
           "dev": true,
           "requires": {
-            "chownr": "^1.1.1",
-            "fs-minipass": "^1.2.5",
-            "minipass": "^2.8.6",
-            "minizlib": "^1.2.1",
-            "mkdirp": "^0.5.0",
-            "safe-buffer": "^5.1.2",
-            "yallist": "^3.0.3"
+            "chownr": "^1.1.4",
+            "fs-minipass": "^1.2.7",
+            "minipass": "^2.9.0",
+            "minizlib": "^1.3.3",
+            "mkdirp": "^0.5.5",
+            "safe-buffer": "^5.2.1",
+            "yallist": "^3.1.1"
           },
           "dependencies": {
             "minipass": {
@@ -24886,6 +24912,16 @@
                 "safe-buffer": "^5.1.2",
                 "yallist": "^3.0.0"
               }
+            },
+            "safe-buffer": {
+              "version": "5.2.1",
+              "bundled": true,
+              "dev": true
+            },
+            "yallist": {
+              "version": "3.1.1",
+              "bundled": true,
+              "dev": true
             }
           }
         },
@@ -26155,9 +26191,9 @@
       "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="
     },
     "path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw=="
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
     },
     "path-to-regexp": {
       "version": "1.8.0",
@@ -28478,9 +28514,9 @@
       "dev": true
     },
     "url-parse": {
-      "version": "1.5.1",
-      "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.1.tgz",
-      "integrity": "sha512-HOfCOUJt7iSYzEx/UqgtwKRMC6EU91NFhsCHMv9oM03VJcVo2Qrp8T8kI9D7amFf1cu+/3CEhgb3rF9zL7k85Q==",
+      "version": "1.5.3",
+      "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.3.tgz",
+      "integrity": "sha512-IIORyIQD9rvj0A4CLWsHkBBJuNqWpFQe224b6j9t/ABmquIS0qDU2pY6kl6AuOrL5OkCXHMCFNe1jBcuAggjvQ==",
       "requires": {
         "querystringify": "^2.1.1",
         "requires-port": "^1.0.0"

src/raw-transactions.js

@@ -319,6 +319,9 @@ class RawTransactions {
         const inputTxid = vin.txid
         const inputVout = vin.vout
 
+        // TODO: Coinbase TXs have no input transaction. Figure out how to
+        // handle this corner case.
+
         // Get the TX details for the input, in order to retrieve the address of
         // the sender.
         const txDetailsParent = await this.getRawTransaction(inputTxid, true)

src/slp/utils.js

@@ -921,7 +921,7 @@ class Utils {
    *  const txid =
    *   "266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1"
    *
-   *  const data = await slp.Utils.decodeOpReturn2(txid)
+   *  const data = await bchjs.SLP.Utils.decodeOpReturn(txid)
    *
    *  console.log(`Decoded OP_RETURN data: ${JSON.stringify(data,null,2)}`)
    * } catch (error) {

src/transaction.js

@@ -4,6 +4,7 @@
 
 const RawTransaction = require('./raw-transactions')
 const SlpUtils = require('./slp/utils')
+const BigNumber = require('bignumber.js')
 
 class Transaction {
   constructor (config) {
@@ -75,9 +76,18 @@ class Transaction {
         // 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)
+          // const realQty = Number(rawQty) / Math.pow(10, txDetails.tokenDecimals)
 
-          txDetails.vout[i + 1].tokenQty = realQty
+          // Calculate the real quantity using a BigNumber, then convert it to a
+          // floating point number.
+          let realQty = new BigNumber(rawQty).dividedBy(
+            10 ** parseInt(txDetails.tokenDecimals)
+          )
+          realQty = realQty.toString()
+          // realQty = parseFloat(realQty)
+
+          txDetails.vout[i + 1].tokenQtyStr = realQty
+          txDetails.vout[i + 1].tokenQty = parseFloat(realQty)
         }
 
         // Add tokenQty = null to any outputs that don't have a value.
@@ -101,17 +111,46 @@ class Transaction {
             //   `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)}`)
+            let tokenQty = 0
+            if (inTokenData.txType === 'SEND') {
+              // 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.
+              tokenQty = inTokenData.amounts[thisVin.vout - 1]
+              // console.log(`tokenQty: ${JSON.stringify(tokenQty, null, 2)}`)
+
+              //
+            } else if (inTokenData.txType === 'GENESIS') {
+              // Only vout[1] of a Genesis transaction represents the tokens.
+              // Any other outputs in that transaction are normal BCH UTXOs.
+              if (thisVin.vout === 1) {
+                tokenQty = inTokenData.qty
+                // console.log(`tokenQty: ${JSON.stringify(tokenQty, null, 2)}`)
+              }
+
+              //
+            } else {
+              console.log(
+                'Unexpected code path in Transaction.get(). Is this a MINT transaction?'
+              )
+              console.log(inTokenData)
+              throw new Error('Unexpected code path')
+            }
 
             if (tokenQty) {
-              const realQty =
-                Number(tokenQty) / Math.pow(10, txDetails.tokenDecimals)
+              // const realQty =
+              //   Number(tokenQty) / Math.pow(10, txDetails.tokenDecimals)
 
-              thisVin.tokenQty = realQty
+              // Calculate the real quantity using a BigNumber, then convert it to a
+              // floating point number.
+              let realQty = new BigNumber(tokenQty).dividedBy(
+                10 ** parseInt(txDetails.tokenDecimals)
+              )
+              realQty = realQty.toString()
+              // realQty = parseFloat(realQty)
+
+              thisVin.tokenQtyStr = realQty
+              thisVin.tokenQty = parseFloat(realQty)
               // txDetails.vin[i].tokenQty = tokenQty
             } else {
               thisVin.tokenQty = null

test/unit/fixtures/transaction-mock.js

@@ -175,10 +175,124 @@ const mockOpReturnData03 = {
   amounts: ['1000000000', '99883400000000']
 }
 
+const genesisTestInputTx = {
+  txid: '874306bda204d3a5dd15e03ea5732cccdca4c33a52df35162cdd64e30ea7f04e',
+  hash: '874306bda204d3a5dd15e03ea5732cccdca4c33a52df35162cdd64e30ea7f04e',
+  version: 1,
+  size: 480,
+  locktime: 543408,
+  vin: [
+    {
+      txid: '323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35',
+      vout: 1,
+      scriptSig: {
+        asm:
+          '30440220268dacee1117975d904dd0d45ef8de42b86030d825a9522bae196a38bbf6b271022001ae1ce2536ab300040e597bcfaa8ef9fb2beaf702d0842f3161aae8e9867f55[ALL|FORKID] 028ff9e32b0dbc82c1d5e0fc945b2537b00420513b10684726f312f1b717c0ae11',
+        hex:
+          '4730440220268dacee1117975d904dd0d45ef8de42b86030d825a9522bae196a38bbf6b271022001ae1ce2536ab300040e597bcfaa8ef9fb2beaf702d0842f3161aae8e9867f554121028ff9e32b0dbc82c1d5e0fc945b2537b00420513b10684726f312f1b717c0ae11'
+      },
+      sequence: 4294967294,
+      address: 'bitcoincash:qp2jesd06k8ycj4wvkpl9lcwaemtr04f5yphjsa07v',
+      value: 0.00000546
+    },
+    {
+      txid: '323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35',
+      vout: 3,
+      scriptSig: {
+        asm:
+          '3045022100fa241bb2de46f68688451bfcae3f165b724e3ccf13b219e7bf2d8d2df7712ad60220353017d6e581a06efce478adfcd2047cea2f92531e283845f3d0a345ef101519[ALL|FORKID] 02cc48ad10516f97e914b8836ff25448d07ad96ebb4704c6a828339880280831bc',
+        hex:
+          '483045022100fa241bb2de46f68688451bfcae3f165b724e3ccf13b219e7bf2d8d2df7712ad60220353017d6e581a06efce478adfcd2047cea2f92531e283845f3d0a345ef101519412102cc48ad10516f97e914b8836ff25448d07ad96ebb4704c6a828339880280831bc'
+      },
+      sequence: 4294967294,
+      address: 'bitcoincash:qppj3euc36x5u6twr5cxrrea2rca53vsfu3dxwr86j',
+      value: 0.00172192
+    }
+  ],
+  vout: [
+    {
+      value: 0,
+      n: 0,
+      scriptPubKey: {
+        asm:
+          'OP_RETURN 5262419 1 1145980243 323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35 00000000004c4b40 00000000004c4b40',
+        hex:
+          '6a04534c500001010453454e4420323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d350800000000004c4b400800000000004c4b40',
+        type: 'nulldata'
+      }
+    },
+    {
+      value: 0.00000546,
+      n: 1,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 0a74cf9c0fb3f6dd62c3f5eecd1ed6e1051428e0 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a9140a74cf9c0fb3f6dd62c3f5eecd1ed6e1051428e088ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qq98fnuup7eldhtzc067ang76mss29pguqh7qv9eac']
+      }
+    },
+    {
+      value: 0.00000546,
+      n: 2,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 d4548261e1be0de7e50b7511597799ec4af2b173 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914d4548261e1be0de7e50b7511597799ec4af2b17388ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qr29fqnpuxlqmel9pd63zkthn8ky4u43wv0v7pg5mn']
+      }
+    },
+    {
+      value: 0.00171165,
+      n: 3,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 d4548261e1be0de7e50b7511597799ec4af2b173 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914d4548261e1be0de7e50b7511597799ec4af2b17388ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qr29fqnpuxlqmel9pd63zkthn8ky4u43wv0v7pg5mn']
+      }
+    }
+  ],
+  hex:
+    '0100000002359dab0d9c8ddc788b14c0b51493d195c9fbd9f2203d091663350bae351e3a32010000006a4730440220268dacee1117975d904dd0d45ef8de42b86030d825a9522bae196a38bbf6b271022001ae1ce2536ab300040e597bcfaa8ef9fb2beaf702d0842f3161aae8e9867f554121028ff9e32b0dbc82c1d5e0fc945b2537b00420513b10684726f312f1b717c0ae11feffffff359dab0d9c8ddc788b14c0b51493d195c9fbd9f2203d091663350bae351e3a32030000006b483045022100fa241bb2de46f68688451bfcae3f165b724e3ccf13b219e7bf2d8d2df7712ad60220353017d6e581a06efce478adfcd2047cea2f92531e283845f3d0a345ef101519412102cc48ad10516f97e914b8836ff25448d07ad96ebb4704c6a828339880280831bcfeffffff040000000000000000406a04534c500001010453454e4420323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d350800000000004c4b400800000000004c4b4022020000000000001976a9140a74cf9c0fb3f6dd62c3f5eecd1ed6e1051428e088ac22020000000000001976a914d4548261e1be0de7e50b7511597799ec4af2b17388ac9d9c0200000000001976a914d4548261e1be0de7e50b7511597799ec4af2b17388acb04a0800',
+  blockhash: '000000000000000000292a9c6150fce48e2edd8df346948494fe6249e6e7f63b',
+  confirmations: 163095,
+  time: 1534271330,
+  blocktime: 1534271330
+}
+
+genesisTestOpReturnData01 = {
+  tokenType: 1,
+  txType: 'SEND',
+  tokenId: '323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35',
+  amounts: ['5000000', '5000000']
+}
+
+genesisTestOpReturnData02 = {
+  tokenType: 1,
+  txType: 'GENESIS',
+  ticker: '',
+  name: '',
+  tokenId: '323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35',
+  documentUri: '',
+  documentHash: '',
+  decimals: 0,
+  mintBatonVout: 2,
+  qty: '10000000'
+}
+
 module.exports = {
   nonSlpTxDetails,
   slpTxDetails,
   mockOpReturnData01,
   mockOpReturnData02,
-  mockOpReturnData03
+  mockOpReturnData03,
+  genesisTestInputTx,
+  genesisTestOpReturnData01,
+  genesisTestOpReturnData02
 }

test/unit/transaction-unit.js

@@ -115,5 +115,54 @@ describe('#TransactionLib', () => {
         assert.include(err.message, 'test error')
       }
     })
+
+    // This test case was created in response to a bug. When the input TX
+    // was a Genesis SLP transaction, the inputs of the transaction were not
+    // being hydrated properly.
+    it('should get input details when input is a genesis tx', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.Transaction.rawTransaction, 'getTxData')
+        .resolves(mockData.genesisTestInputTx)
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'decodeOpReturn')
+        .onCall(0)
+        .resolves(mockData.genesisTestOpReturnData01)
+        .onCall(1)
+        .resolves(mockData.genesisTestOpReturnData02)
+        .onCall(2)
+        .resolves(mockData.genesisTestOpReturnData02)
+        .onCall(3)
+        .resolves(mockData.genesisTestOpReturnData02)
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'waterfallValidateTxid')
+        .resolves(true)
+
+      const txid =
+        '874306bda204d3a5dd15e03ea5732cccdca4c33a52df35162cdd64e30ea7f04e'
+
+      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)
+
+      // Assert inputs values unique to a Genesis input have the proper values.
+      assert.equal(result.vin[0].tokenQty, 10000000)
+      assert.equal(result.vin[1].tokenQty, null)
+    })
   })
 })