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

fix(Transaction.get()): Handling coinbase txs

package-lock.json

@@ -7545,9 +7545,10 @@
       }
     },
     "node_modules/minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "version": "1.2.6",
+      "resolved": "http://94.130.170.209:4873/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
+      "license": "MIT"
     },
     "node_modules/minimist-options": {
       "version": "4.1.0",
@@ -20342,9 +20343,9 @@
       }
     },
     "minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "version": "1.2.6",
+      "resolved": "http://94.130.170.209:4873/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
     },
     "minimist-options": {
       "version": "4.1.0",

src/psf-slp-indexer.js

@@ -288,6 +288,8 @@ class PsfSlpIndexer {
    */
   async tx (txid) {
     try {
+      // console.log('txid: ', txid)
+
       // Handle single address.
       if (typeof txid === 'string') {
         const response = await axios.post(
@@ -295,8 +297,11 @@ class PsfSlpIndexer {
           { txid },
           this.axiosOptions
         )
+        // console.log('response: ', response)
+
         return response.data
       }
+
       throw new Error('Input txid must be a string.')
     } catch (error) {
       // console.log('error: ', error)
@@ -316,6 +321,7 @@ class PsfSlpIndexer {
 
         // Check if this txid belongs to a blacklisted token.
         const isInBlacklist = await this.checkBlacklist(txid)
+        // console.log('isInBlacklist: ', isInBlacklist)
 
         // Get the TX Details from the full node.
         const txDetails = await this.rawTransaction.getTxData(txid)

src/raw-transactions.js

@@ -381,6 +381,8 @@ class RawTransactions {
   // Appends the BCH address to the inputs of the transaction.
   async getTxData (txid) {
     try {
+      // console.log('getTxData() txid: ', txid)
+
       if (typeof txid !== 'string') {
         throw new Error(
           'Input to raw-transaction.js/getTxData() must be a string containg a TXID.'
@@ -391,17 +393,24 @@ class RawTransactions {
       const txDetails = await this.getRawTransaction(txid, true)
       // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
-      const inAddrs = await this._getInputAddrs(txDetails)
-      // console.log(`inAddrs: ${JSON.stringify(inAddrs, null, 2)}`)
+      try {
+        const inAddrs = await this._getInputAddrs(txDetails)
+        // console.log(`inAddrs: ${JSON.stringify(inAddrs, null, 2)}`)
 
-      // Add the input address to the transaction data.
-      for (let i = 0; i < inAddrs.length; i++) {
-        txDetails.vin[i].address = inAddrs[i].address
-        txDetails.vin[i].value = inAddrs[i].value
+        // Add the input address to the transaction data.
+        for (let i = 0; i < inAddrs.length; i++) {
+          txDetails.vin[i].address = inAddrs[i].address
+          txDetails.vin[i].value = inAddrs[i].value
+        }
+      } catch (err) {
+        // Coinbase transactions will throw an error. Just ignore them and
+        // pass back the raw transaction data.
+        /* exit quietly */
       }
 
       return txDetails
     } catch (error) {
+      // console.log('error: ', error)
       if (error.error) throw new Error(error.error)
 
       // This case handles rate limit errors.

src/transaction.js

@@ -20,11 +20,51 @@ class Transaction {
     this.psfSlpIndexer = new PsfSlpIndexer(config)
   }
 
-  // Proxy the call to the psf-slp-indexer.
+  /**
+   * @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.
+   *
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   * try {
+   *  let txData = await bchjs.Transaction.get("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
+   *  console.log(txData);
+   * } catch(error) {
+   * console.error(error)
+   * }
+   * })()
+   */
   async get (txid) {
+    // console.log('transaction.get() txid: ', txid)
     return await this.psfSlpIndexer.tx(txid)
   }
 
+  /**
+   * @api Transaction.getTokenInfo() getTokenInfo()
+   * @apiName getTokenInfo
+   * @apiGroup Transaction
+   * @apiDescription
+   * Given the TXID of a token transaction, it will return data about that
+   * token by retrieving the data from the Genesis transaction and docoding
+   * the OP_RETURN.
+   *
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   * try {
+   *  let txData = await bchjs.Transaction.getTokenInfo("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
+   *  console.log(txData);
+   * } catch(error) {
+   * console.error(error)
+   * }
+   * })()
+   */
   // A wrapper for decodeOpReturn(). Returns false if txid is not an SLP tx.
   // Returns the token data if the txid is an SLP tx.
   async getTokenInfo (txid) {

src/utxo.js

@@ -230,6 +230,9 @@ class UTXO {
           10 ** parseInt(thisUtxo.decimals)
         )
         thisUtxo.qtyStr = qty.toString()
+
+        // tokenQty is property expected by SLP.tokentype1.js library
+        thisUtxo.tokenQty = thisUtxo.qtyStr
       }
 
       return utxoAry

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

@@ -24,5 +24,14 @@ describe('#Transaction', () => {
       assert.property(result.txData, 'vout')
       assert.equal(result.txData.isValidSlp, false)
     })
+
+    it('should handle a coinbase transaction', async () => {
+      const txid = 'cca1d2dd3a533d2f501448dec03face2cb2814afd59a533a611e9a2909f2302b'
+
+      const details = await bchjs.Transaction.get(txid)
+      // console.log(`details: ${JSON.stringify(details, null, 2)}`)
+
+      assert.property(details.txData, 'txid')
+    })
   })
 })