Merge pull request #157 from Permissionless-Software-Foundation/dh-dsproof

feat(DSProof): Added DSProof to bch-js

package.json

@@ -22,7 +22,7 @@
     "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/v5/ && mocha --timeout 30000 -g '#Transaction' 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/",

src/bch-js.js

@@ -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,51 @@
+const axios = require('axios')
+
+let _this
+
+class Mining {
+  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
+  }
+
+  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 = Mining

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.

test/integration/chains/bchn/dsproof.js

@@ -0,0 +1,21 @@
+/*
+  Integration tests for bchjs dsproof library.
+*/
+
+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)}`)
+    })
+  })
+})

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
+}