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

fix(dsproof): Adding documentation

src/dsproof.js

@@ -2,7 +2,7 @@ const axios = require('axios')
 
 let _this
 
-class Mining {
+class DSProof {
   constructor (config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
@@ -28,6 +28,36 @@ class Mining {
     _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) {
@@ -48,4 +78,4 @@ class Mining {
   }
 }
 
-module.exports = Mining
+module.exports = DSProof

test/integration/chains/bchn/dsproof.js

@@ -2,6 +2,8 @@
   Integration tests for bchjs dsproof library.
 */
 
+const assert = require('chai').assert
+
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS()
 
@@ -15,7 +17,9 @@ describe('#DSProof', () => {
       const txid =
         'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
       const result = await bchjs.DSProof.getDSProof(txid)
-      console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result, null)
     })
   })
 })