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

fix(dsproof): Adding documentation

package.json

@@ -11,19 +11,19 @@
   "scripts": {
     "test": "nyc mocha --trace-warnings --unhandled-rejections=strict --timeout 30000 test/unit/",
     "test:integration": "npm run test:integration:bchn",
-    "test:integration:nft": "export RESTURL=https://bchn.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 -g '#nft1' test/integration/chains/bchn/slp.js",
-    "test:integration:abc": "export RESTURL=https://abc.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
-    "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
+    "test:integration:nft": "export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 -g '#nft1' test/integration/chains/bchn/slp.js",
+    "test:integration:abc": "export RESTURL=https://abc.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
+    "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:testnet": "IS_USING_FREE_TIER=true mocha --timeout 30000 test/integration/chains/testnet/",
-    "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:integration:temp:bchn": "export RESTURL=http://157.90.174.219:3000/v4/ && mocha --timeout 30000 test/integration/",
-    "test:temp": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#Encryption' test/integration/",
+    "test:integration:local:abc": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
+    "test:integration:local:bchn": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
+    "test:integration:local:testnet": "RESTURL=http://localhost:4000/v5/ mocha --timeout 30000 test/integration/chains/testnet",
+    "test:integration:decatur:bchn": "export RESTURL=http://192.168.0.36:3000/v5/ && mocha --timeout 30000 test/integration/",
+    "test:integration:temp:bchn": "export RESTURL=http://157.90.174.219:3000/v5/ && mocha --timeout 30000 test/integration/",
+    "test:temp": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 -g '#Encryption' test/integration/",
     "test:temp2": "mocha --timeout=30000 -g '#TransactionLib' test/unit/",
-    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#Transaction' test/integration/",
-    "test:temp4": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#decodeOpReturn' test/integration/",
+    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v5/ && mocha --timeout 30000 -g '#DSProof' test/integration/chains/",
+    "test:temp4": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 -g '#decodeOpReturn' test/integration/",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",
     "docs": "./node_modules/.bin/apidoc -i src/ -o docs",

src/address.js

@@ -6,7 +6,7 @@ const coininfo = require('@psf/coininfo')
 class Address {
   constructor (config) {
     const tmp = {}
-    if (!config || !config.restURL) tmp.restURL = 'https://api.bchjs.cash/v4/'
+    if (!config || !config.restURL) tmp.restURL = 'https://api.bchjs.cash/v5/'
     else tmp.restURL = config.restURL
 
     this.restURL = tmp.restURL

src/bch-js.js

@@ -7,8 +7,8 @@
 */
 
 // bch-api mainnet.
-const DEFAULT_REST_API = 'https://api.fullstack.cash/v4/'
-// const DEFAULT_REST_API = "http://localhost:3000/v4/"
+const DEFAULT_REST_API = 'https://api.fullstack.cash/v5/'
+// const DEFAULT_REST_API = "http://localhost:3000/v5/"
 
 // local deps
 const BitcoinCash = require('./bitcoincash')
@@ -32,6 +32,7 @@ const IPFS = require('./ipfs')
 const Encryption = require('./encryption')
 const Utxo = require('./utxo')
 const Transaction = require('./transaction')
+const DSProof = require('./dsproof')
 
 // Indexers
 const Ninsight = require('./ninsight')
@@ -115,6 +116,8 @@ class BCHJS {
     this.IPFS = new IPFS()
     this.Utxo = new Utxo(libConfig)
     this.Transaction = new Transaction(libConfig)
+
+    this.DSProof = new DSProof(libConfig)
   }
 }
 

src/dsproof.js

@@ -0,0 +1,81 @@
+const axios = require('axios')
+
+let _this
+
+class DSProof {
+  constructor (config) {
+    this.restURL = config.restURL
+    this.apiToken = config.apiToken
+    this.authToken = config.authToken
+    this.axios = axios
+
+    if (this.authToken) {
+      // Add Basic Authentication token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: this.authToken
+        }
+      }
+    } else {
+      // Add JWT token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: `Token ${this.apiToken}`
+        }
+      }
+    }
+
+    _this = this
+  }
+
+  /**
+   * @api DSProof.getDSProof() getDSProof()
+   * @apiName getDSProof
+   * @apiGroup DSProof
+   * @apiDescription Checks if a transaction generated a double-spend proof.
+   *
+   * If a double-spend is attempted, one of the transactions will generate a
+   * 'double spend proof'. This call can be used to check if a transaction
+   * generated such a proof.
+   *
+   * Merchants should wait 3-5 seconds after receiving notification of a
+   * transaction before calling this endpoint, to see if the TXID generated a
+   * proof. If this method returns no data, then the TX can be considered 'safe'
+   * and not a double spend. If proof data is returned by this method, then
+   * the transaction generated a proof and can be considered a 'double spend'.
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   *   try {
+   *     const txid = 'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+   *     const result = await bchjs.DSProof.getDSProof(txid)
+   *     console.log(result);
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   * // returns
+   * null
+   */
+  async getDSProof (txid) {
+    try {
+      if (!txid) {
+        throw new Error('txid is required')
+      }
+      if (txid.length !== 64) {
+        throw new Error(`txid must be of length 64 (not ${txid.length})`)
+      }
+      const response = await _this.axios.get(
+        `${this.restURL}dsproof/getdsproof/${txid}`,
+        _this.axiosOptions
+      )
+      return response.data
+    } catch (error) {
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
+}
+
+module.exports = DSProof

src/raw-transactions.js

@@ -120,7 +120,8 @@ class RawTransactions {
 
       throw new Error('Input must be a string or array of strings.')
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }
@@ -185,7 +186,8 @@ class RawTransactions {
 
       throw new Error('Input must be a string or array of strings.')
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }
@@ -281,7 +283,8 @@ class RawTransactions {
 
       throw new Error('Input must be a string or array of strings.')
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }
@@ -326,7 +329,8 @@ class RawTransactions {
 
       return retArray
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }
@@ -379,7 +383,8 @@ class RawTransactions {
 
       return txDetails
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }
@@ -452,7 +457,8 @@ class RawTransactions {
 
       throw new Error('Input hex must be a string or array of strings.')
     } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
+      if (error.error) throw new Error(error.error)
+      else if (error.response && error.response.data) throw error.response.data
       else throw error
     }
   }

src/slp/nft1.js

@@ -421,9 +421,9 @@ class Nft1 {
   }
 
   /**
-   * @api SLP.Nft1.listNFTGroupChildren() listNFTGroupChildren()
+   * @api SLP.NFT1.listNFTGroupChildren() listNFTGroupChildren()
    * @apiName listNFTGroupChildren
-   * @apiGroup SLP Nft1
+   * @apiGroup SLP NFT1
    * @apiDescription Return list of NFT children tokens in a NFT Group.
    * It's assumed provided groupId parameter is for an NFT Group token (type=129)
    *
@@ -460,9 +460,9 @@ class Nft1 {
   }
 
   /**
-   * @api SLP.Nft1.parentNFTGroup() parentNFTGroup()
+   * @api SLP.NFT1.parentNFTGroup() parentNFTGroup()
    * @apiName parentNFTGroup
-   * @apiGroup SLP Nft1
+   * @apiGroup SLP NFT1
    * @apiDescription Return parent NFT Group information for a given NFT child token.
    * It's assumed provided groupId parameter is for an NFT Child token (type=65)
    *

src/transaction.js

@@ -137,6 +137,8 @@ class Transaction {
       return txDetails
     } catch (err) {
       console.error('Error in transactions.js/get()')
+
+      if (err.error) throw new Error(err.error)
       throw err
     }
   }

src/util.js

@@ -28,7 +28,7 @@ class Util {
   }
 
   /**
-   * @api util.floor8() floor8()
+   * @api Util.floor8() floor8()
    * @apiName floor8
    * @apiGroup Util
    * @apiDescription Round a number down to 8 decimal places.
@@ -63,7 +63,7 @@ class Util {
   }
 
   /**
-   * @api util.floor2() floor2()
+   * @api Util.floor2() floor2()
    * @apiName floor2
    * @apiGroup Util
    * @apiDescription Round a number down to 2 decimal places.
@@ -98,7 +98,7 @@ class Util {
   }
 
   /**
-   * @api util.chunk20() chunk20()
+   * @api Util.chunk20() chunk20()
    * @apiName chunk20
    * @apiGroup Util
    * @apiDescription chunk up an array into multiple arrays of 20 elements each.
@@ -151,7 +151,7 @@ class Util {
   }
 
   /**
-   * @api util.sleep() sleep()
+   * @api Util.sleep() sleep()
    * @apiName sleep
    * @apiGroup Util
    * @apiDescription Promise-based delay.
@@ -175,7 +175,7 @@ class Util {
   }
 
   /**
-   * @api util.validateAddress() validateAddress()
+   * @api Util.validateAddress() validateAddress()
    * @apiName Validate Address.
    * @apiGroup Util
    * @apiDescription Return information about the given bitcoin address.

src/utxo.js

@@ -276,6 +276,8 @@ class UTXO {
       return retAry
     } catch (err) {
       console.error('Error in bchjs.utxo.get()')
+
+      if (err.error) throw new Error(err.error)
       throw err
     }
   }

test/e2e/rate-limits/anonymous-rate-limits.js

@@ -14,9 +14,9 @@
 
 const assert = require('chai').assert
 
-// const RESTURL = `https://abc.fullstack.cash/v4/`
-const RESTURL = 'https://bchn.fullstack.cash/v4/'
-// const RESTURL = `http://localhost:3000/v4/`
+// const RESTURL = `https://abc.fullstack.cash/v5/`
+const RESTURL = 'https://bchn.fullstack.cash/v5/'
+// const RESTURL = `http://localhost:3000/v5/`
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL })

test/e2e/rate-limits/basic-auth-rate-limits.js

@@ -13,9 +13,9 @@ const PRO_PASS = 'testpassword'
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https://abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https://abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   authPass: PRO_PASS
 })
 

test/e2e/rate-limits/free-rate-limits.js

@@ -18,8 +18,8 @@ const JWT_TOKEN =
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  restURL: 'https://api.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  restURL: 'https://api.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   apiToken: JWT_TOKEN
 })
 

test/e2e/rate-limits/full-node-rate-limits.js

@@ -18,9 +18,9 @@ const JWT_TOKEN =
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https:/abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https:/abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   apiToken: JWT_TOKEN
 })
 
@@ -65,7 +65,7 @@ describe('#full node rate limits', () => {
 
   it('should throw error for more than 100 RPM to fullnode', async () => {
     try {
-      console.log('This test usually doesn\'t pass, because of latency.')
+      console.log("This test usually doesn't pass, because of latency.")
       for (let i = 0; i < 100; i++) await bchjs.Control.getNetworkInfo()
     } catch (err) {
       // console.log(`validating after 10th call`)

test/e2e/rate-limits/indexer-rate-limits.js

@@ -14,9 +14,9 @@ const JWT_TOKEN =
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https://abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https://abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   apiToken: JWT_TOKEN
 })
 

test/integration/chains/bchn/dsproof.js

@@ -0,0 +1,25 @@
+/*
+  Integration tests for bchjs dsproof library.
+*/
+
+const assert = require('chai').assert
+
+const BCHJS = require('../../../../src/bch-js')
+const bchjs = new BCHJS()
+
+describe('#DSProof', () => {
+  beforeEach(async () => {
+    if (process.env.IS_USING_FREE_TIER) await bchjs.Util.sleep(1000)
+  })
+
+  describe('#getDSProof', () => {
+    it('should get TX info from the full node', async () => {
+      const txid =
+        'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+      const result = await bchjs.DSProof.getDSProof(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result, null)
+    })
+  })
+})

test/integration/chains/testnet/blockchain.js

@@ -12,11 +12,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/control.js

@@ -7,7 +7,7 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })

test/integration/chains/testnet/electrumx.js

@@ -5,7 +5,7 @@ const util = require('util')
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
@@ -68,7 +68,9 @@ describe('#ElectrumX', () => {
     it('should throw error on array size rate limit', async () => {
       try {
         const addr = []
-        for (let i = 0; i < 25; i++) { addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2') }
+        for (let i = 0; i < 25; i++) {
+          addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2')
+        }
 
         // const result = await bchjs.Electrumx.utxo(addr)
         // console.log(`result: ${util.inspect(result)}`)
@@ -121,7 +123,9 @@ describe('#ElectrumX', () => {
     it('should throw error on array size rate limit', async () => {
       try {
         const addr = []
-        for (let i = 0; i < 25; i++) { addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2') }
+        for (let i = 0; i < 25; i++) {
+          addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2')
+        }
 
         const result = await bchjs.Electrumx.balance(addr)
 
@@ -175,7 +179,9 @@ describe('#ElectrumX', () => {
     it('should throw error on array size rate limit', async () => {
       try {
         const addr = []
-        for (let i = 0; i < 25; i++) { addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2') }
+        for (let i = 0; i < 25; i++) {
+          addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2')
+        }
 
         const result = await bchjs.Electrumx.transactions(addr)
 
@@ -236,7 +242,9 @@ describe('#ElectrumX', () => {
     it('should throw error on array size rate limit', async () => {
       try {
         const addr = []
-        for (let i = 0; i < 25; i++) { addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2') }
+        for (let i = 0; i < 25; i++) {
+          addr.push('bchtest:qrvn2n228aa39xupcw9jw0d3fj8axxky656e4j62z2')
+        }
 
         await bchjs.Electrumx.unconfirmed(addr)
         // console.log(`result: ${util.inspect(result)}`)
@@ -355,7 +363,7 @@ describe('#ElectrumX', () => {
         assert.property(err, 'success')
         assert.equal(err.success, false)
         assert.include(
-          err.error,
+          err.error.error,
           'the transaction was rejected by network rules'
         )
       }

test/integration/chains/testnet/ninsight.js

@@ -1,9 +1,9 @@
-const chai = require('chai')
-const assert = chai.assert
+// const chai = require('chai')
+// const assert = chai.assert
 const sinon = require('sinon')
 
-const BCHJS = require('../../../../src/bch-js')
-const bchjs = new BCHJS({ ninsightURL: 'https://trest.bitcoin.com/v2' })
+// const BCHJS = require('../../../../src/bch-js')
+// const bchjs = new BCHJS({ ninsightURL: 'https://trest.bitcoin.com/v2' })
 
 describe('#Ninsight', () => {
   let sandbox
@@ -16,130 +16,132 @@ describe('#Ninsight', () => {
 
   afterEach(() => sandbox.restore())
 
-  describe('#utxo', () => {
-    it('should GET utxos for a single address', async () => {
-      const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
-
-      const result = await bchjs.Ninsight.utxo(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result[0], 'utxos')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'slpAddress')
-      assert.property(result[0], 'scriptPubKey')
-      assert.property(result[0], 'asm')
-
-      assert.isArray(result[0].utxos)
-
-      assert.property(result[0].utxos[0], 'txid')
-      assert.property(result[0].utxos[0], 'vout')
-      assert.property(result[0].utxos[0], 'amount')
-      assert.property(result[0].utxos[0], 'satoshis')
-      assert.property(result[0].utxos[0], 'height')
-      assert.property(result[0].utxos[0], 'confirmations')
-    })
-
-    it('should POST utxo details for an array of addresses', async () => {
-      const addr = [
-        'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
-        'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
-      ]
-
-      const result = await bchjs.Ninsight.utxo(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.isArray(result[0].utxos)
-
-      assert.property(result[0], 'utxos')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'slpAddress')
-      assert.property(result[0], 'scriptPubKey')
-      assert.property(result[0], 'asm')
-
-      // assert.hasAnyKeys(result[0][0], [
-      //   "txid",
-      //   "vout",
-      //   "value",
-      //   "height",
-      //   "confirmations"
-      // ])
-    })
-  })
-  describe('#transactions', () => {
-    it('should POST transactions history for a single address', async () => {
-      const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
-
-      const result = await bchjs.Ninsight.transactions(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'txs')
-      assert.isArray(result[0].txs)
-      assert.property(result[0].txs[0], 'txid')
-      assert.property(result[0].txs[0], 'vin')
-      assert.property(result[0].txs[0], 'vout')
-    })
-    it('should POST transactions history for an array of addresses', async () => {
-      const addr = [
-        'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
-        'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
-      ]
-
-      const result = await bchjs.Ninsight.transactions(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'txs')
-      assert.isArray(result[0].txs)
-      assert.property(result[0].txs[0], 'txid')
-      assert.property(result[0].txs[0], 'vin')
-      assert.property(result[0].txs[0], 'vout')
-    })
-  })
-  describe('#txDetails', () => {
-    it('should POST transactions details for a single address', async () => {
-      const txid =
-        '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
-
-      const result = await bchjs.Ninsight.txDetails(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'txid')
-      assert.property(result[0], 'version')
-      assert.property(result[0], 'locktime')
-      assert.property(result[0], 'vin')
-      assert.property(result[0], 'vout')
-      assert.property(result[0], 'blockhash')
-      assert.property(result[0], 'blockheight')
-      assert.property(result[0], 'confirmations')
-      assert.property(result[0], 'time')
-      assert.property(result[0], 'blocktime')
-      assert.property(result[0], 'valueOut')
-      assert.property(result[0], 'size')
-    })
-    it('should POST transactions details for an array of addresses', async () => {
-      const txid = [
-        'f191d1062789d7071da6f2168ba306869a829294f6b1c09d03492db4ca3a8e77',
-        '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
-      ]
-
-      const result = await bchjs.Ninsight.txDetails(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'txid')
-      assert.property(result[0], 'vin')
-      assert.property(result[0], 'vout')
-    })
-  })
+  // describe('#utxo', () => {
+  //   it('should GET utxos for a single address', async () => {
+  //     const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
+  //
+  //     const result = await bchjs.Ninsight.utxo(addr)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.property(result[0], 'utxos')
+  //     assert.property(result[0], 'legacyAddress')
+  //     assert.property(result[0], 'cashAddress')
+  //     assert.property(result[0], 'slpAddress')
+  //     assert.property(result[0], 'scriptPubKey')
+  //     assert.property(result[0], 'asm')
+  //
+  //     assert.isArray(result[0].utxos)
+  //
+  //     assert.property(result[0].utxos[0], 'txid')
+  //     assert.property(result[0].utxos[0], 'vout')
+  //     assert.property(result[0].utxos[0], 'amount')
+  //     assert.property(result[0].utxos[0], 'satoshis')
+  //     assert.property(result[0].utxos[0], 'height')
+  //     assert.property(result[0].utxos[0], 'confirmations')
+  //   })
+  //
+  //   it('should POST utxo details for an array of addresses', async () => {
+  //     const addr = [
+  //       'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
+  //       'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
+  //     ]
+  //
+  //     const result = await bchjs.Ninsight.utxo(addr)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.isArray(result)
+  //     assert.isArray(result[0].utxos)
+  //
+  //     assert.property(result[0], 'utxos')
+  //     assert.property(result[0], 'legacyAddress')
+  //     assert.property(result[0], 'cashAddress')
+  //     assert.property(result[0], 'slpAddress')
+  //     assert.property(result[0], 'scriptPubKey')
+  //     assert.property(result[0], 'asm')
+  //
+  //     // assert.hasAnyKeys(result[0][0], [
+  //     //   "txid",
+  //     //   "vout",
+  //     //   "value",
+  //     //   "height",
+  //     //   "confirmations"
+  //     // ])
+  //   })
+  // })
+  //
+  // describe('#transactions', () => {
+  //   it('should POST transactions history for a single address', async () => {
+  //     const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
+  //
+  //     const result = await bchjs.Ninsight.transactions(addr)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.isArray(result)
+  //     assert.property(result[0], 'cashAddress')
+  //     assert.property(result[0], 'legacyAddress')
+  //     assert.property(result[0], 'txs')
+  //     assert.isArray(result[0].txs)
+  //     assert.property(result[0].txs[0], 'txid')
+  //     assert.property(result[0].txs[0], 'vin')
+  //     assert.property(result[0].txs[0], 'vout')
+  //   })
+  //   it('should POST transactions history for an array of addresses', async () => {
+  //     const addr = [
+  //       'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
+  //       'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
+  //     ]
+  //
+  //     const result = await bchjs.Ninsight.transactions(addr)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.isArray(result)
+  //     assert.property(result[0], 'cashAddress')
+  //     assert.property(result[0], 'legacyAddress')
+  //     assert.property(result[0], 'txs')
+  //     assert.isArray(result[0].txs)
+  //     assert.property(result[0].txs[0], 'txid')
+  //     assert.property(result[0].txs[0], 'vin')
+  //     assert.property(result[0].txs[0], 'vout')
+  //   })
+  // })
+  //
+  // describe('#txDetails', () => {
+  //   it('should POST transactions details for a single address', async () => {
+  //     const txid =
+  //       '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
+  //
+  //     const result = await bchjs.Ninsight.txDetails(txid)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.isArray(result)
+  //     assert.property(result[0], 'txid')
+  //     assert.property(result[0], 'version')
+  //     assert.property(result[0], 'locktime')
+  //     assert.property(result[0], 'vin')
+  //     assert.property(result[0], 'vout')
+  //     assert.property(result[0], 'blockhash')
+  //     assert.property(result[0], 'blockheight')
+  //     assert.property(result[0], 'confirmations')
+  //     assert.property(result[0], 'time')
+  //     assert.property(result[0], 'blocktime')
+  //     assert.property(result[0], 'valueOut')
+  //     assert.property(result[0], 'size')
+  //   })
+  //   it('should POST transactions details for an array of addresses', async () => {
+  //     const txid = [
+  //       'f191d1062789d7071da6f2168ba306869a829294f6b1c09d03492db4ca3a8e77',
+  //       '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
+  //     ]
+  //
+  //     const result = await bchjs.Ninsight.txDetails(txid)
+  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  //
+  //     assert.isArray(result)
+  //     assert.property(result[0], 'txid')
+  //     assert.property(result[0], 'vin')
+  //     assert.property(result[0], 'vout')
+  //   })
+  // })
 })
 
 function sleep (ms) {

test/integration/chains/testnet/rawtransaction.js

@@ -10,11 +10,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/slp.js

@@ -7,11 +7,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/test-free-tier.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-export RESTURL=https://free-test.fullstack.cash/v4/
+export RESTURL=https://free-test.fullstack.cash/v5/
 export NETWORK=testnet
 export IS_USING_FREE_TIER=true
 

test/integration/chains/testnet/util.js

@@ -8,11 +8,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/electrumx.js

@@ -359,10 +359,12 @@ describe('#ElectrumX', () => {
       try {
         await bchjs.Electrumx.broadcast(txHex)
       } catch (err) {
+        // console.log('err: ', err)
+
         assert.property(err, 'success')
         assert.equal(err.success, false)
         assert.include(
-          err.error,
+          err.error.error,
           'the transaction was rejected by network rules'
         )
       }

test/integration/rawtransaction.js

@@ -251,9 +251,13 @@ describe('#rawtransaction', () => {
   describe('#_getInputAddrs', () => {
     it('should return an array of input addresses', async () => {
       // const txid = '32233db13f2ae6d82b6262f335643dccf09fc0bcfcef4bc3fbe023355f02e112'
-      const txid = '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
+      const txid =
+        '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
 
-      const txDetails = await bchjs.RawTransactions.getRawTransaction(txid, true)
+      const txDetails = await bchjs.RawTransactions.getRawTransaction(
+        txid,
+        true
+      )
 
       const result = await bchjs.RawTransactions._getInputAddrs(txDetails)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
@@ -268,7 +272,8 @@ describe('#rawtransaction', () => {
 
   describe('#getTxData', () => {
     it('should return tx data with input addresses', async () => {
-      const txid = '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
+      const txid =
+        '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
 
       const result = await bchjs.RawTransactions.getTxData(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)

test/unit/dsproof.js

@@ -0,0 +1,66 @@
+// Public npm libraries
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+// Unit under test (uut)
+const BCHJS = require('../../src/bch-js')
+const mockData = require('./fixtures/dsproof-mock')
+
+let bchjs
+const txid = 'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+describe('#DSProof', () => {
+  let sandbox
+  beforeEach(() => {
+    bchjs = new BCHJS()
+    sandbox = sinon.createSandbox()
+  })
+  afterEach(() => sandbox.restore())
+
+  describe('#getDSProof', () => {
+    it('should throw error if input is not provided', async () => {
+      try {
+        await bchjs.DSProof.getDSProof()
+        assert.equal(false, true, 'unexpected error')
+      } catch (err) {
+        assert.include(err.message, 'txid is required')
+      }
+    })
+    it('should throw error txid is invalid', async () => {
+      try {
+        await bchjs.DSProof.getDSProof('txid')
+        assert.equal(false, true, 'unexpected error')
+      } catch (err) {
+        assert.include(err.message, 'txid must be of length 64')
+      }
+    })
+    it('should handle error', async () => {
+      try {
+        sandbox.stub(bchjs.DSProof.axios, 'get').throws(new Error('test error'))
+        await bchjs.DSProof.getDSProof(txid)
+
+        assert.equal(false, true, 'unexpected error')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+    it('should get double spend proof', async () => {
+      try {
+        sandbox
+          .stub(bchjs.DSProof.axios, 'get')
+          .resolves({ data: mockData.dsproof })
+        const result = await bchjs.DSProof.getDSProof(txid)
+
+        assert.property(result, 'dspid')
+        assert.property(result, 'txid')
+        assert.property(result, 'outpoint')
+        assert.property(result, 'path')
+        assert.property(result, 'descendants')
+
+        assert.property(result.outpoint, 'txid')
+        assert.property(result.outpoint, 'vout')
+      } catch (error) {
+        assert.equal(false, true, 'unexpected error')
+      }
+    })
+  })
+})

test/unit/fixtures/dsproof-mock.js

@@ -0,0 +1,19 @@
+/*
+  Mock data used for unit testing.
+*/
+const dsproof = {
+  dspid: '6234fff2a9dbcaa50e2c50d74e1d725a2bed1757d7a05a2db7a82df659554397',
+  txid: 'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e',
+  outpoint: {
+    txid: '17ebef34f7e9a0692317dd6fbb43ffccff45b7d688a2a754dbccfc5e6d93ce3e',
+    vout: 1
+  },
+  path: ['ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'],
+  descendants: [
+    'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+  ]
+}
+
+module.exports = {
+  dsproof
+}

test/unit/slp-utils.js

@@ -10,7 +10,7 @@ let uut
 
 const REST_URL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://bchn.fullstack.cash/v4/'
+  : 'https://bchn.fullstack.cash/v5/'
 
 // Mock data used for unit tests
 const mockDataLib = require('./fixtures/slp/mock-utils')