feat(Ninsight): Adding TX Details endpoint

README.md

@@ -115,7 +115,7 @@ Have questions? Need help? Join our community support
 
 ## IPFS Releases
 
-Copies of this repository are also published on IPFS.
+Copies of this repository are also published on [IPFS](https://ipfs.io).
 
 - v3.8.10: QmauhggzKDo9A9je5y2K6WRAp32JmGRFCw2ZFTiSnW8yot
 

package.json

@@ -9,15 +9,13 @@
   "main": "src/bch-js",
   "scripts": {
     "test": "nyc mocha --timeout 30000 test/unit/",
-    "test:integration": "bash test/integration/test-free-tier-bchn.sh",
+    "test:integration": "bash test/integration/test-bchn-integration.sh",
+    "test:integration:bchn": "bash test/integration/test-bchn-integration.sh",
     "test:integration:abc": "RESTURL=https://abc.fullstack.cash/v3/ IS_USING_FREE_TIER=true mocha --timeout 30000 test/integration/",
     "test:integration:testnet": "IS_USING_FREE_TIER=true mocha --timeout 30000 test/integration/testnet/",
     "test:integration:local": "RESTURL=http://localhost:3000/v3/ mocha --timeout 30000 test/integration",
     "test:integration:local:bchn": "RESTURL=http://localhost:3000/v3/ bash test/integration/test-free-tier-bchn.sh",
-    "test:integration:testnet:local": "RESTURL=http://localhost:4000/v3/ mocha --timeout 30000 test/integration/testnet",
-    "test:integration:free": "bash test/integration/test-free-tier.sh",
-    "test:integration:free:bchn": "IS_USING_FREE_TIER=true bash test/integration/test-free-tier-bchn.sh",
-    "test:integration:free:testnet": "bash test/integration/testnet/test-free-tier.sh",
+    "test:integration:local:testnet": "RESTURL=http://localhost:4000/v3/ mocha --timeout 30000 test/integration/testnet",
     "test:temp": "mocha --timeout 30000 -g '#Encryption' test/integration/",
     "test:integration:api": "RESTURL=https://api.fullstack.cash/v3/ mocha --timeout 30000 test/integration",
     "coverage": "nyc report --reporter=text-lcov | coveralls",

src/ninsight.js

@@ -241,6 +241,79 @@ class Ninsight {
       else throw error
     }
   }
+
+  /**
+   * @api Ninsight.txDetails()  txDetails()
+   * @apiName Ninsight TX Details
+   * @apiGroup Ninsight
+   * @apiDescription Return transactions details for address(es).
+   *
+   * @apiExample Example usage:
+   *    (async () => {
+   *   try {
+   *     let result = await bchjs.Ninsight.txDetails('fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33');
+   *     console.log(result);
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   *  // [
+   *  //   {
+   *  //     "txid": "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
+   *  //     "version": 1,
+   *  //     "locktime": 0,
+   *  //     "vin": [
+   *  //       {
+   *  //         "sequence": 4294967295,
+   *  //         "n": 0
+   *  //       }
+   *  //     ],
+   *  //     "vout": [
+   *  //       ...
+   *  //     ],
+   *  //     "blockhash": "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09",
+   *  //     "blockheight": 1000,
+   *  //     "confirmations": 659909,
+   *  //     "time": 1232346882,
+   *  //     "blocktime": 1232346882,
+   *  //     "firstSeenTime": null,
+   *  //     "valueOut": 50,
+   *  //     "size": 135
+   *  //   }
+   *  // ]
+   *
+   */
+  async txDetails(txid) {
+    try {
+      if (typeof txid === "string") {
+        const response = await axios.post(
+          `${this.ninsightURL}/transaction/details`,
+          {
+            txids: [txid]
+          },
+          _this.axiosOptions
+        )
+
+        return response.data
+      } else if (Array.isArray(txid)) {
+        const response = await axios.post(
+          `${this.ninsightURL}/transaction/details`,
+          {
+            txids: txid
+          },
+          _this.axiosOptions
+        )
+
+        return response.data
+      }
+
+      throw new Error(`Transaction ID must be a string or array of strings.`)
+    } catch (error) {
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
 }
 
 module.exports = Ninsight

test/integration/bchn/ninsight.js

@@ -89,4 +89,41 @@ describe(`#Ninsight`, () => {
       assert.property(result[0].txs[0], "vout")
     })
   })
+  describe(`#txDetails`, () => {
+    it(`should POST transactions details for a single address`, async () => {
+      const txid = "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33"
+
+      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], "isCoinBase")
+      assert.property(result[0], "valueOut")
+      assert.property(result[0], "size")
+    })
+    it(`should POST transactions details for an array of addresses`, async () => {
+      const txid = [
+        "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
+        "4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251"
+      ]
+
+      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")
+    })
+  })
 })

test/integration/ninsight.js

@@ -95,6 +95,42 @@ describe(`#Ninsight`, () => {
       assert.property(result[0].txs[0], "vout")
     })
   })
+  describe(`#txDetails`, () => {
+    it(`should POST transactions details for a single address`, async () => {
+      const txid = "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33"
+
+      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 = [
+        "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
+        "4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251"
+      ]
+
+      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/test-bchn-integration.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-#export RESTURL=https://bchn.fullstack.cash/v3/
+export RESTURL=https://bchn.fullstack.cash/v3/
 #export RESTURL=http://localhost:3000/v3/
 #export IS_USING_FREE_TIER=true
 

test/integration/test-free-tier.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-export RESTURL=https://free-main.fullstack.cash/v3/
-#export RESTURL=http://localhost:3000/v3/
-export IS_USING_FREE_TIER=true
-
-cd test/integration/
-mocha --timeout 30000 blockchain.js control.js electrumx.js ninsight.js openbazaar.js price.js rawtransaction.js slp.js util.js

test/integration/testnet/ninsight.js

@@ -103,6 +103,42 @@ describe(`#Ninsight`, () => {
       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/unit/fixtures/ninsight-mock.js

@@ -116,11 +116,55 @@ const transactions = {
 
 const transactionsPost = [transactions, transactions]
 
+const details = {
+  txid: "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
+  version: 1,
+  locktime: 0,
+  vin: [
+    {
+      coinbase: "04ffff001d02fd04",
+      sequence: 4294967295,
+      n: 0
+    }
+  ],
+  vout: [
+    {
+      value: "50.00000000",
+      n: 0,
+      scriptPubKey: {
+        hex:
+          "4104f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446aac",
+        asm:
+          "04f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446a OP_CHECKSIG",
+        addresses: ["1BW18n7MfpU35q4MTBSk8pse3XzQF8XvzT"],
+        type: "pubkeyhash",
+        cashAddrs: ["bitcoincash:qpej6mkrwca4tvy2snq4crhrf88v4ljspysx0ueetk"]
+      },
+      spentTxId: null,
+      spentIndex: null,
+      spentHeight: null
+    }
+  ],
+  blockhash:
+    "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09",
+  blockheight: 1000,
+  confirmations: 585610,
+  time: 1232346882,
+  blocktime: 1232346882,
+  isCoinBase: true,
+  valueOut: 50,
+  size: 135
+}
+
+const detailsPost = [details, details]
+
 module.exports = {
   utxo,
   utxoPost,
   unconfirmed,
   unconfirmedPost,
   transactions,
-  transactionsPost
+  transactionsPost,
+  details,
+  detailsPost
 }

test/unit/ninsight.js

@@ -195,4 +195,61 @@ describe(`#Ninsight`, () => {
       assert.property(result[0].txs[0], "txid")
     })
   })
+  describe(`#txDetails`, () => {
+    it(`should throw an error for improper input`, async () => {
+      try {
+        const txid = 12345
+
+        await bchjs.Ninsight.txDetails(txid)
+        assert.equal(true, false, "Unexpected result!")
+      } catch (err) {
+        //console.log(`err: `, err)
+        assert.include(
+          err.message,
+          `Transaction ID must be a string or array of strings.`
+        )
+      }
+    })
+    it(`should POST transaction details for a single TxID`, async () => {
+      // Stub the network call.
+      sandbox.stub(axios, "post").resolves({ data: mockData.detailsPost })
+
+      const txid = "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33"
+
+      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], "isCoinBase")
+      assert.property(result[0], "valueOut")
+      assert.property(result[0], "size")
+    })
+    it(`should POST transaction details for an array of TxIDs`, async () => {
+      // Stub the network call.
+      sandbox.stub(axios, "post").resolves({ data: mockData.detailsPost })
+
+      const txid = [
+        "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
+        "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33"
+      ]
+
+      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")
+    })
+  })
 })