@psf/bch-js 5.1.0 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psf/bch-js",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "The FullStack.cash JavaScript library for Bitcoin Cash and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [

package/src/bch-js.js

@@ -36,7 +36,6 @@ const DSProof = require('./dsproof')
 const Ecash = require('./ecash')
 
 // Indexers
-const Ninsight = require('./ninsight')
 const Electrumx = require('./electrumx')
 const PsfSlpIndexer = require('./psf-slp-indexer')
 
@@ -83,9 +82,6 @@ class BCHJS {
 
     // console.log(`apiToken: ${this.apiToken}`)
 
-    // Bitcoin.com Ninsight indexer
-    this.Ninsight = new Ninsight(config)
-
     // ElectrumX indexer
     this.Electrumx = new Electrumx(libConfig)
 

package/src/psf-slp-indexer.js

@@ -11,11 +11,12 @@ const axios = require('axios')
 
 // Local libraries
 const RawTransaction = require('./raw-transactions')
+const SlpUtils = require('./slp/utils')
 
 // let _this
 
 class PsfSlpIndexer {
-  constructor (config) {
+  constructor (config = {}) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
     this.authToken = config.authToken
@@ -38,6 +39,7 @@ class PsfSlpIndexer {
 
     // Encapsulate dependencies
     this.rawTransaction = new RawTransaction(config)
+    this.slpUtils = new SlpUtils(config)
 
     // _this = this
   }
@@ -130,6 +132,7 @@ class PsfSlpIndexer {
    */
   async balance (address) {
     try {
+      console.log('balance() address: ', address)
       // Handle single address.
       if (typeof address === 'string') {
         const response = await axios.post(
@@ -308,16 +311,18 @@ class PsfSlpIndexer {
         //   'TX not found in psf-slp-indexer. Retrieving from full node.'
         // )
 
+        // Check if this txid belongs to a blacklisted token.
+        const isInBlacklist = await this.checkBlacklist(txid)
+
         // Get the TX Details from the full node.
         const txDetails = await this.rawTransaction.getTxData(txid)
         // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
-        // TODO: Run the TX through decodeOpReturn() to see if it has a tokenID
-        // that is in the blacklist. If it is, then set isValidSlp = null to
-        // signal that it's state can not be determined.
-
-        // Assumption: transaction is not a valid SLP UTXO.
-        txDetails.isValidSlp = false
+        if (isInBlacklist) {
+          txDetails.isValidSlp = null
+        } else {
+          txDetails.isValidSlp = false
+        }
 
         const outObj = {
           txData: txDetails
@@ -327,6 +332,39 @@ class PsfSlpIndexer {
       } else throw error
     }
   }
+
+  // Check if the txid has an OP_RETURN containing a tokenID that is in the
+  // blacklist. In that case, the isValidSlp property should be marked as
+  // null, and not false.
+  async checkBlacklist (txid) {
+    try {
+      // TODO: Add endpoint to psf-slp-indexer to retrieve current blacklist.
+      // This should be done once at startup, and not each time this function
+      // is called.
+      const blacklist = [
+        'dd21be4532d93661e8ffe16db6535af0fb8ee1344d1fef81a193e2b4cfa9fbc9'
+      ]
+
+      const outTokenData = await this.slpUtils.decodeOpReturn(txid)
+      // console.log('outTokenData: ', outTokenData)
+
+      // Loop through each token in the blacklist.
+      for (let i = 0; i < blacklist.length; i++) {
+        // If a match is found, return true.
+        if (outTokenData.tokenId === blacklist[i]) {
+          return true
+        }
+      }
+
+      // By default, return false.
+      return false
+    } catch (err) {
+      // console.log(err)
+
+      // Exit quietly.
+      return false
+    }
+  }
 }
 
 module.exports = PsfSlpIndexer

package/src/slp/utils.js

@@ -11,7 +11,7 @@ const Util = require('../util')
 let _this
 
 class Utils {
-  constructor (config) {
+  constructor (config = {}) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
     this.slpParser = slpParser

package/src/utxo.js

@@ -8,19 +8,21 @@
 // Local libraries
 const Electrumx = require('./electrumx')
 const Slp = require('./slp/slp')
+const PsfSlpIndexer = require('./psf-slp-indexer')
 
 class UTXO {
-  constructor (config) {
+  constructor (config = {}) {
     // Encapsulate dependencies for easier mocking.
     this.electrumx = new Electrumx(config)
     this.slp = new Slp(config)
+    this.psfSlpIndexer = new PsfSlpIndexer(config)
   }
 
   /**
-   * @api Utxo.get() get()
-   * @apiName get
+   * @api Utxo.getOld() getOld()
+   * @apiName getOld
    * @apiGroup UTXO
-   * @apiDescription Get UTXOs for an address
+   * @apiDescription Get UTXOs for an address (from SLPDB)
    *
    * Given an address, this function will return an object with thre following
    * properties:
@@ -45,7 +47,7 @@ class UTXO {
    * @apiExample Example usage:
    * (async () => {
    *   try {
-   *     let utxos = await bchjs.Utxo.get('simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj');
+   *     let utxos = await bchjs.Utxo.getOld('simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj');
    *     console.log(utxos);
    *   } catch(error) {
    *    console.error(error)
@@ -181,7 +183,7 @@ class UTXO {
    *
    *
    */
-  async get (address, useWhitelist = false) {
+  async getOld (address, useWhitelist = false) {
     try {
       if (!address) {
         throw new Error('Address must be an array or a string')
@@ -286,6 +288,148 @@ class UTXO {
     }
   }
 
+  /**
+   * @api Utxo.get() get()
+   * @apiName get
+   * @apiGroup UTXO
+   * @apiDescription Get UTXOs for an address (from psf-slp-indexer)
+   *
+   * Given an address, this function will return an object with thre following
+   * properties:
+   * - address: "" - the address these UTXOs are associated with
+   * - bchUtxos: [] - UTXOs confirmed to be spendable as normal BCH
+   * - nullUtxo: [] - UTXOs that did not pass SLP validation. Should be ignored and
+   *   not spent, to be safe.
+   * - slpUtxos: {} - UTXOs confirmed to be colored as valid SLP tokens
+   *   - type1: {}
+   *     - tokens: [] - SLP token Type 1 tokens.
+   *     - mintBatons: [] - SLP token Type 1 mint batons.
+   *   - nft: {}
+   *     - tokens: [] - NFT tokens
+   *     - groupTokens: [] - NFT Group tokens, used to create NFT tokens.
+   *     - groupMintBatons: [] - Minting baton to create more NFT Group tokens.
+   *
+   * Note: You can pass in an optional second Boolean argument. The default
+   * `false` will use the normal waterfall validation method. Set to `true`,
+   * SLP UTXOs will be validated with the whitelist filtered SLPDB. This will
+   * result is many more UTXOs in the `nullUtxos` array.
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   *   try {
+   *     let utxos = await bchjs.Utxo.get('simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj');
+   *     console.log(utxos);
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   * // returns
+   * [
+   *  {
+   *   "address": "bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv",
+   *   "bchUtxos": [
+   *    {
+   *      "height": 674513,
+   *      "tx_hash": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
+   *      "tx_pos": 3,
+   *      "value": 38134,
+   *      "txid": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
+   *      "vout": 3,
+   *      "isValid": false
+   *    }
+   *   ],
+   */
+  // This version of get() uses the psf-slp-indexer. It will replace the older
+  // get() function that uses SLPDB.
+  // TODO: NFT UTXOs are identified as non-token UTXOs, which will cause a wallet
+  // to burn them. The psf-slp-indexer needs to be updated to mark these UTXOs.
+  async get (address) {
+    try {
+      // Convert address to an array if it is a string.
+      if (typeof address !== 'string') {
+        throw new Error('address input must be a string')
+      }
+
+      // Ensure the address is a BCH address.
+      const addr = this.slp.Address.toCashAddress(address)
+
+      // Get the UTXOs associated with the address.
+      const utxoData = await this.electrumx.utxo(addr)
+      // console.log(`utxoData: ${JSON.stringify(utxoData, null, 2)}`)
+      const utxos = utxoData.utxos
+
+      // Get SLP UTXOs from the psf-slp-indexer
+      const slpUtxoData = await this.psfSlpIndexer.balance(addr)
+      // console.log(`slpUtxoData: ${JSON.stringify(slpUtxoData, null, 2)}`)
+      const slpUtxos = slpUtxoData.balance.utxos
+
+      // Loop through the Fulcrum UTXOs.
+      for (let i = 0; i < utxos.length; i++) {
+        const thisUtxo = utxos[i]
+
+        // Loop through the UTXOs from psf-slp-indexer.
+        for (let j = 0; j < slpUtxos.length; j++) {
+          const thisSlpUtxo = slpUtxos[j]
+
+          // If the non-hydrated UTXO matches the SLP UTXO, then combine the data
+          // and mark the UTXO as an SLP token.
+          if (
+            thisUtxo.tx_hash === thisSlpUtxo.txid &&
+            thisUtxo.tx_pos === thisSlpUtxo.vout
+          ) {
+            thisUtxo.txid = thisUtxo.tx_hash
+            thisUtxo.vout = thisUtxo.tx_pos
+            thisUtxo.isSlp = true
+            thisUtxo.type = thisSlpUtxo.type
+            thisUtxo.qty = thisSlpUtxo.qty
+            thisUtxo.tokenId = thisSlpUtxo.tokenId
+            thisUtxo.address = thisSlpUtxo.address
+
+            break
+          }
+        }
+
+        // If there was no match, then this is a normal BCH UTXO. Mark it as such.
+        if (!thisUtxo.isSlp) {
+          thisUtxo.txid = thisUtxo.tx_hash
+          thisUtxo.vout = thisUtxo.tx_pos
+          thisUtxo.isSlp = false
+          thisUtxo.address = addr
+        }
+      }
+
+      const bchUtxos = utxos.filter(x => x.isSlp === false)
+      const type1TokenUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'token'
+      )
+      const type1BatonUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'baton'
+      )
+      const nullUtxos = utxos.filter(x => x.isSlp === null)
+
+      const outObj = {
+        address: addr,
+        bchUtxos,
+        slpUtxos: {
+          type1: {
+            tokens: type1TokenUtxos,
+            mintBatons: type1BatonUtxos
+          },
+          nft: {} // Allocated for future support of NFT spec.
+        },
+        nullUtxos
+      }
+
+      return outObj
+    } catch (err) {
+      // console.error('Error in bchjs.utxo.get2(): ', err)
+
+      if (err.error) throw new Error(err.error)
+      throw err
+    }
+  }
+
   /**
    * @api Utxo.findBiggestUtxo() findBiggestUtxo()
    * @apiName findBiggestUtxo

package/test/integration/chains/bchn/psf-slp-indexer.integration.js

@@ -56,7 +56,7 @@ describe('#psf-slp-indexer', () => {
   describe('#tx', () => {
     it('should get hydrated tx data for an SLP transaction', async () => {
       const txid =
-        '83361c34cac2ea7f9ca287fca57a96cc0763719f0cdf4850f9696c1e68eb635c'
+        '947ccb2a0d62ca287bc4b0993874ab0f9f6afd454193e631e2bf84dca66731fc'
 
       const result = await bchjs.PsfSlpIndexer.tx(txid)
       // console.log('result: ', result)
@@ -67,7 +67,7 @@ describe('#psf-slp-indexer', () => {
       assert.equal(result.txData.isValidSlp, true)
     })
 
-    it('should handle non-SLP transaction', async () => {
+    it('should mark non-SLP transaction as false', async () => {
       const txid =
         '03d6e6b63647ce7b02ecc73dc6d41b485be14a3e20eed4474b8a840358ddf14e'
 
@@ -84,7 +84,7 @@ describe('#psf-slp-indexer', () => {
     // Currently FlexUSD UTXOs are reported as invalid SLP UTXOs, which means
     // the wallet will burn them. There is a TODO in the code. This test will
     // need to be changed when it is done.
-    it('should handle a blacklisted token', async () => {
+    it('should mark blacklisted token as null', async () => {
       const txid =
         '302113c11b90edc5f36c073d2f8a75e1e0eaf59b56235491a843d3819cd6a85f'
 
@@ -94,7 +94,23 @@ describe('#psf-slp-indexer', () => {
       assert.property(result.txData, 'vin')
       assert.property(result.txData, 'vout')
       assert.property(result.txData, 'isValidSlp')
-      assert.equal(result.txData.isValidSlp, false)
+      assert.equal(result.txData.isValidSlp, null)
+    })
+
+    it('should throw error for non-existent txid', async () => {
+      try {
+        const txid =
+          '302113c11b90edc5f36c073d2f8a75e1e0eaf59b56235491a843d3819cd6a85e'
+
+        await bchjs.PsfSlpIndexer.tx(txid)
+        // console.log('result: ', result)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+
+        assert.include(err.message, 'No such mempool or blockchain transaction')
+      }
     })
   })
 })

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

@@ -13,7 +13,7 @@ describe('#UTXO', () => {
 
     if (process.env.IS_USING_FREE_TIER) await sleep(3000)
   })
-
+  /*
   describe('#get', () => {
     it('should get hydrated and filtered UTXOs for an address', async () => {
       // const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
@@ -90,7 +90,40 @@ describe('#UTXO', () => {
       assert.isAbove(result[0].nullUtxos.length, 1)
     })
   })
+*/
+  describe('#get', () => {
+    it('should hydrate address with BCH and SLP UTXOs', async () => {
+      const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
+
+      const result = await bchjs.Utxo.get(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert expected properties exist.
+      assert.property(result, 'address')
+      assert.property(result, 'bchUtxos')
+      assert.property(result, 'slpUtxos')
+      assert.property(result.slpUtxos, 'type1')
+      assert.property(result.slpUtxos, 'nft')
+      assert.property(result, 'nullUtxos')
+
+      assert.isAbove(result.bchUtxos.length, 0)
+      assert.isAbove(result.slpUtxos.type1.tokens.length, 0)
+      assert.equal(result.slpUtxos.type1.mintBatons.length, 0)
+    })
 
+    // TODO: NFTs are currently not identified as different than normal BCH UTXOs.
+    // The psf-slp-indexer needs to be updated to fix this issue.
+    it('should handle NFTs and minting batons', async () => {
+      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
+
+      const result = await bchjs.Utxo.get(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that minting batons are correctly identified.
+      assert.isAbove(result.slpUtxos.type1.mintBatons.length, 0)
+    })
+  })
+  /*
   describe('#findBiggestUtxo', () => {
     it('should sort UTXOs from Electrumx', async () => {
       const addr = 'bitcoincash:qq54fgjn3hz0357n8a6guy4demw9xfkjk5jcj0xr0z'
@@ -118,6 +151,7 @@ describe('#UTXO', () => {
       assert.equal(result.satoshis, 800)
     })
   })
+*/
 })
 
 function sleep (ms) {

package/test/integration/transaction-integration.js

@@ -11,72 +11,74 @@ describe('#Transaction', () => {
     if (process.env.IS_USING_FREE_TIER) await bchjs.Util.sleep(1000)
   })
 
-  describe('#getOld', () => {
-    it('should get details about a non-SLP transaction', async () => {
-      const txid =
-        '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7'
+  if (process.env.TESTSLP) {
+    describe('#getOld', () => {
+      it('should get details about a non-SLP transaction', async () => {
+        const txid =
+          '2b37bdb3b63dd0bca720437754a36671431a950e684b64c44ea910ea9d5297c7'
 
-      const result = await bchjs.Transaction.getOld(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        const result = await bchjs.Transaction.getOld(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 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)
-    })
+        // 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'
+      it('should get details about a SLP transaction', async () => {
+        const txid =
+          '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1'
 
-      const result = await bchjs.Transaction.getOld(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        const result = await bchjs.Transaction.getOld(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 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 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 get problematic transaction', async () => {
-    //   const txid = 'a55515de32577e296c512840bcaabed5823bb773fb4f8fd8e5197cc96cbc54d1'
-    //
-    //   const result = await bchjs.Transaction.get(txid)
-    //   console.log(`result: ${JSON.stringify(result, null, 2)}`)
-    // })
+      // it('should get problematic transaction', async () => {
+      //   const txid = 'a55515de32577e296c512840bcaabed5823bb773fb4f8fd8e5197cc96cbc54d1'
+      //
+      //   const result = await bchjs.Transaction.get(txid)
+      //   console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      // })
 
-    // TX a19f2f395a8b0e15b6202944c56834367d128f1e3630486a4756de53424a46fe has
-    // an input TXID (bd84bc1dd5ecd976165892306992401272f6bedeb37d7b2cdbf74fc4a55967a6)
-    // that is also a valid SLP tx, but is unrelated. Both TXs pass DAG validation,
-    // but for separate tokens.
-    it('should get problematic transaction', async () => {
-      const txid =
-        'a19f2f395a8b0e15b6202944c56834367d128f1e3630486a4756de53424a46fe'
+      // TX a19f2f395a8b0e15b6202944c56834367d128f1e3630486a4756de53424a46fe has
+      // an input TXID (bd84bc1dd5ecd976165892306992401272f6bedeb37d7b2cdbf74fc4a55967a6)
+      // that is also a valid SLP tx, but is unrelated. Both TXs pass DAG validation,
+      // but for separate tokens.
+      it('should get problematic transaction', async () => {
+        const txid =
+          'a19f2f395a8b0e15b6202944c56834367d128f1e3630486a4756de53424a46fe'
 
-      const result = await bchjs.Transaction.getOld(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        const result = await bchjs.Transaction.getOld(txid)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      // The token ID should equal the txid for this Vin.
-      assert.equal(result.vin[2].txid, result.vin[2].tokenId)
+        // The token ID should equal the txid for this Vin.
+        assert.equal(result.vin[2].txid, result.vin[2].tokenId)
+      })
     })
-  })
+  }
 })