Merge pull request #20 from Permissionless-Software-Foundation/5-electrum-tx-data

Add get transaction details from Electrum

README.md

@@ -1,6 +1,5 @@
 # bch-api
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/christroutner/bch-api.svg)](https://greenkeeper.io/)
 
 [![Build Status](https://travis-ci.org/christroutner/bch-api.svg?branch=master)](https://travis-ci.org/christroutner/bch-api)
 
@@ -16,9 +15,8 @@ of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk).
 Both bch-api and bch-js are part of the
 [full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
 
-- [API Documentation](https://api.bchjs.cash/docs/)
-- [BCH Example Applications](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
-- [slp-cli-wallet](https://github.com/christroutner/slp-cli-wallet): a hacker-friendly, command-line BCH and SLP token wallet using this REST API.
+- [API Documentation](https://fullstack.cash/documentation)
+- [Example Code](https://fullstack.cash/examples)
 
 Have questions? Need help? Join our community support
 [Telegram channel](https://t.me/bch_js_toolkit)

deploy-production.sh

@@ -11,5 +11,7 @@ export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
 
 curl -X POST http://fullstack.cash:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
 curl -X POST http://fullstack.cash:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
+curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
+curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
 
 echo "...Finished deploying to production."

docker/mainnet/Dockerfile

@@ -16,9 +16,9 @@ USER safeuser
 
 # Clone the repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/bch-api
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
 WORKDIR /home/safeuser/bch-api
-RUN npm install
+RUN npm install --silent
 
 # Generate documentation
 RUN npm run docs

docker/testnet/Dockerfile

@@ -13,9 +13,9 @@ USER safeuser
 
 # Clone the repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/bch-api
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
 WORKDIR /home/safeuser/bch-api
-RUN npm install
+RUN npm install --silent
 
 # Generate documentation
 RUN npm run docs

package.json

@@ -17,7 +17,7 @@
     "test": "npm run lint && npm run test-v3",
     "lint": "standard --env mocha --fix",
     "test-v3": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v3/",
-    "test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/a01-electrumx.js",
+    "test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/util.js",
     "test:integration": "mocha test/v3/integration",
     "test:integration:slpdb": "mocha --timeout 25000 test/v3/integration/slp*.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls",

src/middleware/route-ratelimit.js

@@ -116,13 +116,20 @@ class RateLimits {
         let pointsToConsume = _this.calcPoints(decoded)
         res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
 
+        // Retrieve the origin.
+        let origin = req.get('origin')
+        if (origin === undefined && key.indexOf('10.0.0.5') > -1) {
+          origin = 'slp-api'
+        }
+        wlogger.info(`origin: ${origin}`)
+
         // If the request originates from one of the approved wallet apps, then
         // apply paid-access rate limits.
-        const origin = req.get('origin')
         if (
           origin &&
           (origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
-            origin.toString().indexOf('sandbox.fullstack.cash') > -1)
+            origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
+            origin === 'slp-api')
         ) {
           pointsToConsume = 1
           res.locals.pointsToConsume = pointsToConsume // Feedback for tests.

src/public/index.html

@@ -23,24 +23,24 @@
         target="_blank"
         >REST API</a
       >, allowing modern applications to interact with the Bitcoin Cash (BCH)
-      blockchain. New to the BCH blockchain? Start by reading more about
+      blockchain. New to the BCH blockchain? Check out these
       <a
-        href="https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer"
+        href="https://fullstack.cash/documentation"
         target="_blank"
-        >building full stack applications on BCH</a
+        >educational resources</a
       >.
     </p><br />
     <p>
       A REST API can work with any programming language, but bch-api is intended
       to be paired with the
       <a
-        href="https://www.npmjs.com/package/@chris.troutner/bch-js"
+        href="https://www.npmjs.com/package/@psf/bch-js"
         target="_blank"
         >npm bch-js</a
       >
       JavaScript library.
       <a
-        href="https://github.com/Permissionless-Software-Foundation/bch-js-examples"
+        href="https://fullstack.cash/examples"
         target="_blank"
         >Here is example code</a
       >
@@ -53,7 +53,7 @@
     </p><br />
     <p>
       While you'll be able to run through the examples without one, you should
-      <a href="https://account.bchjs.cash/" target="_blank"
+      <a href="https://fullstack.cash/login" target="_blank"
         >sign-up for a free API key</a
       >
       in order to unlock higher rate limits.
@@ -66,7 +66,7 @@
         <h3>bch-api</h3>
         <ul>
           <li>
-            <a href="https://account.bchjs.cash" target="_blank">
+            <a href="https://fullstack.cash/login" target="_blank">
               Get an API key to increase rate limits
             </a>
           </li>
@@ -80,14 +80,14 @@
           <br />
 
           <li>
-            <a href="https://tapi.bchjs.cash">
+            <a href="https://tapi.fullstack.cash">
               testnet REST API
             </a>
           </li>
           <br />
 
           <li>
-            <a href="https://github.com/christroutner/bch-api" target="_blank">
+            <a href="https://github.com/Permissionless-Software-Foundation/bch-api" target="_blank">
               bch-api GitHub repository
             </a>
           </li>
@@ -114,14 +114,14 @@
           </li>
           <br />
           <li>
-            <a href="https://bchjs.cash/" target="_blank">
+            <a href="https://fullstack.cash/cashstrap" target="_blank">
               Run your own infrastructure
             </a>
           </li>
           <br />
 
           <li>
-            <a href="https://github.com/bitcoinbook/bitcoinbook#chapters" target="_blank">
+            <a href="https://fullstack.cash/documentation" target="_blank">
               Mastering Bitcoin (great free reference)
             </a>
           </li>
@@ -135,7 +135,7 @@
           <br />
 
           <li>
-            <a href="https://developer.bitcoin.com/faucets/bch/" target="_blank">
+            <a href="https://fullstack.cash/faucet/" target="_blank">
               Testnet Faucet
             </a>
           </li>
@@ -148,7 +148,7 @@
         <h3>bch-js</h3>
         <ul>
           <li>
-            <a href="https://www.npmjs.com/package/@chris.troutner/bch-js"
+            <a href="https://www.npmjs.com/package/@psf/bch-js"
             target="_blank">
               npm library
             </a>
@@ -163,7 +163,7 @@
           <br />
 
           <li>
-            <a href="https://github.com/christroutner/bch-js" target="_blank">
+            <a href="https://github.com/Permissionless-Software-Foundation/bch-js" target="_blank">
               GitHub code repository
             </a>
           </li>

src/routes/v3/electrumx.js

@@ -50,6 +50,8 @@ class Electrum {
     _this.router.get('/', _this.root)
     _this.router.get('/utxos/:address', _this.getUtxos)
     _this.router.post('/utxos', _this.utxosBulk)
+    _this.router.get('/tx/data/:address', _this.getTransactionDetails)
+    _this.router.post('/tx/data', _this.transactionDetailsBulk)
     _this.router.get('/balance/:address', _this.getBalance)
     _this.router.post('/balance', _this.balanceBulk)
     _this.router.get('/transactions/:address', _this.getTransactions)
@@ -324,6 +326,169 @@ class Electrum {
     }
   }
 
+  // Returns a promise that resolves to transaction details data for a txid.
+  // Expects input to be a txid string, and input validation to have already
+  // been done by parent, calling function.
+  async _transactionDetailsFromElectrum (txid, verbose = true) {
+    try {
+      if (!_this.isReady) {
+        throw new Error(
+          'ElectrumX server connection is not ready. Call await connectToServer() first.'
+        )
+      }
+
+      // Query the utxos from the ElectrumX server.
+      const electrumResponse = await _this.electrumx.request(
+        'blockchain.transaction.get',
+        txid,
+        verbose
+      )
+      // console.log(
+      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
+      // )
+
+      return electrumResponse
+    } catch (err) {
+      // console.log('err: ', err)
+
+      // Write out error to error log.
+      wlogger.error(
+        'Error in elecrumx.js/_transactionDetailsFromElectrum(): ',
+        err
+      )
+      throw err
+    }
+  }
+
+  /**
+   * @api {get} /electrumx/tx/data/{txid} Get transaction details for a TXID
+   * @apiName transaction details for a TXID
+   * @apiGroup ElectrumX / Fulcrum
+   * @apiDescription Returns an object with transaction details of the TXID
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v3/electrumx/tx/data/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -H "accept: application/json"
+   *
+   */
+  // GET handler for single transaction
+  async getTransactionDetails (req, res, next) {
+    try {
+      const txid = req.params.txid
+      const verbose = req.query.verbose
+
+      // Reject if txid is anything other than a string
+      if (typeof txid !== 'string') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'txid must be a string'
+        })
+      }
+
+      wlogger.debug(
+        'Executing electrumx/getTransactionDetails with this txid: ',
+        txid
+      )
+
+      // Get data from ElectrumX server.
+      const electrumResponse = await _this._transactionDetailsFromElectrum(
+        txid,
+        verbose
+      )
+      // console.log(`_transactionDetailsFromElectrum(): ${JSON.stringify(electrumResponse, null, 2)}`)
+
+      // Pass the error message if ElectrumX reports an error.
+      if (electrumResponse instanceof Error) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: electrumResponse.message
+        })
+      }
+
+      res.status(200)
+      return res.json({
+        success: true,
+        details: electrumResponse
+      })
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in elecrumx.js/getTransactionDetails().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /electrumx/tx/data Get transaction details for an array of TXIDs
+   * @apiName  Transaction details for an array of TXIDs
+   * @apiGroup ElectrumX / Fulcrum
+   * @apiDescription Returns an array of objects with transaction details of an array of TXIDs.
+   * Limited to 20 items per request.
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v3/electrumx/tx/data" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d","a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], "verbose":false}'
+   *
+   *
+   */
+  // POST handler for bulk queries on transaction details
+  async transactionDetailsBulk (req, res, next) {
+    try {
+      const txids = req.body.txids
+      const verbose = req.body.verbose || true
+
+      // Reject if txids is not an array.
+      if (!Array.isArray(txids)) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'txids needs to be an array. Use GET for single txid.'
+        })
+      }
+
+      // Enforce array size rate limits
+      if (!_this.routeUtils.validateArraySize(req, txids)) {
+        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        return res.json({
+          success: false,
+          error: 'Array too large.'
+        })
+      }
+
+      wlogger.debug(
+        'Executing electrumx.js/transactionDetailsBulk with these txids: ',
+        txids
+      )
+
+      // Loops through each address and creates an array of Promises, querying
+      // the Electrum server in parallel.
+      const transactions = txids.map(async (txid, index) => {
+        // console.log(`address: ${address}`)
+        const details = await _this._transactionDetailsFromElectrum(
+          txid,
+          verbose
+        )
+
+        return { details, txid }
+      })
+
+      // Wait for all parallel Electrum requests to return.
+      const result = await Promise.all(transactions)
+
+      // Return the array of retrieved transaction details.
+      res.status(200)
+      return res.json({
+        success: true,
+        transactions: result
+      })
+    } catch (err) {
+      wlogger.error('Error in electrumx.js/transactionDetailsBulk().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
   // Returns a promise that resolves to a balance for an address. Expects input
   // to be a cash address, and input validation to have already been done by
   // parent, calling function.
@@ -911,7 +1076,9 @@ class Electrum {
       const address = _this.bitcore.Address.fromString(addrStr)
       // console.log(`address: ${address}`)
 
-      const script = _this.bitcore.Script.buildPublicKeyHashOut(address)
+      const script = address.isPayToPublicKeyHash()
+        ? _this.bitcore.Script.buildPublicKeyHashOut(address)
+        : _this.bitcore.Script.buildScriptHashOut(address)
       // console.log(`script: ${script}`)
 
       const scripthash = _this.bitcore.crypto.Hash.sha256(script.toBuffer())

src/routes/v3/slp.js

@@ -64,10 +64,6 @@ class Slp {
     _this.router.get('/balancesForAddress/:address', _this.balancesForAddress)
     _this.router.post('/balancesForAddress', _this.balancesForAddressBulk)
     _this.router.get('/balancesForToken/:tokenId', _this.balancesForTokenSingle)
-    _this.router.get(
-      '/balance/:address/:tokenId',
-      _this.balancesForAddressByTokenID
-    )
     _this.router.get('/convert/:address', _this.convertAddressSingle)
     _this.router.post('/convert', _this.convertAddressBulk)
     _this.router.post('/validateTxid', _this.validateBulk)
@@ -830,170 +826,6 @@ class Slp {
     }
   }
 
-  /**
-   * @api {get} /slp/balance/{address}/{TokenId}  List single slp token balance for address.
-   * @apiName List single slp token balance for address.
-   * @apiGroup SLP
-   * @apiDescription Returns List single slp token balance for address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/slp/balance/simpleledger:qz9tzs6d5097ejpg279rg0rnlhz546q4fsnck9wh5m/1cda254d0a995c713b7955298ed246822bee487458cd9747a91d9e81d9d28125" -H "accept:application/json"
-   *
-   *
-   */
-  // Retrieve token balances for a single token class, for a single address.
-  async balancesForAddressByTokenID (req, res, next) {
-    try {
-      // Validate input data.
-      const address = req.params.address
-      if (!address || address === '') {
-        res.status(400)
-        return res.json({ error: 'address can not be empty' })
-      }
-
-      const tokenId = req.params.tokenId
-      if (!tokenId || tokenId === '') {
-        res.status(400)
-        return res.json({ error: 'tokenId can not be empty' })
-      }
-
-      // Ensure the input is a valid BCH address.
-      try {
-        _this.bchjs.SLP.Address.toCashAddress(address)
-      } catch (err) {
-        res.status(400)
-        return res.json({
-          error: `Invalid BCH address. Double check your address is valid: ${address}`
-        })
-      }
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const cashAddr = _this.bchjs.SLP.Address.toCashAddress(address)
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      // Convert input to an simpleledger: address.
-      const slpAddr = _this.bchjs.SLP.Address.toSlpAddress(req.params.address)
-
-      const query = {
-        v: 3,
-        q: {
-          db: ['g'],
-          aggregate: [
-            {
-              $match: {
-                'graphTxn.outputs': {
-                  $elemMatch: {
-                    address: slpAddr,
-                    status: 'UNSPENT',
-                    slpAmount: { $gte: 0 }
-                  }
-                }
-              }
-            },
-            {
-              $unwind: '$graphTxn.outputs'
-            },
-            {
-              $match: {
-                'graphTxn.outputs.address': slpAddr,
-                'graphTxn.outputs.status': 'UNSPENT',
-                'graphTxn.outputs.slpAmount': { $gte: 0 }
-              }
-            },
-            {
-              $project: {
-                amount: '$graphTxn.outputs.slpAmount',
-                address: '$graphTxn.outputs.address',
-                txid: '$graphTxn.txid',
-                vout: '$graphTxn.outputs.vout',
-                tokenId: '$tokenDetails.tokenIdHex'
-              }
-            },
-            {
-              $group: {
-                _id: '$tokenId',
-                balanceString: {
-                  $sum: '$amount'
-                },
-                slpAddress: {
-                  $first: '$address'
-                }
-              }
-            }
-          ],
-          limit: 10000
-        }
-      }
-
-      const options = _this.generateCredentials()
-
-      const s = JSON.stringify(query)
-      const b64 = Buffer.from(s).toString('base64')
-      const url = `${process.env.SLPDB_URL}q/${b64}`
-
-      // Get data from SLPDB.
-      const opt = {
-        method: 'get',
-        baseURL: url,
-        headers: options.headers,
-        timeout: options.timeout
-      }
-      const tokenRes = await _this.axios.request(opt)
-      console.log(`tokenRes.data: ${JSON.stringify(tokenRes.data, null, 2)}`)
-
-      let resVal = {
-        cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-        legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-        slpAddress: slpAddr,
-        tokenId: tokenId,
-        balance: 0,
-        balanceString: '0'
-      }
-
-      if (tokenRes.data.g.length > 0) {
-        tokenRes.data.g.forEach(async (token) => {
-          if (token._id === tokenId) {
-            resVal = {
-              cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-              legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-              slpAddress: slpAddr,
-              tokenId: token._id,
-              balance: parseFloat(token.balanceString),
-              balanceString: token.balanceString
-            }
-          }
-        })
-      } else {
-        resVal = {
-          cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-          legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-          slpAddress: slpAddr,
-          tokenId: tokenId,
-          balance: 0,
-          balanceString: '0'
-        }
-      }
-
-      res.status(200)
-      return res.json(resVal)
-    } catch (err) {
-      wlogger.error('Error in slp.ts/balancesForAddressByTokenID().', err)
-
-      return _this.errorHandler(err, res)
-      // return res.json({
-      //   error: `Error in /balance/:address/:tokenId: ${err.message}`
-      // })
-    }
-  }
-
   /**
    * @api {get} /slp/convert/{address}  Convert address to slpAddr, cashAddr and legacy.
    * @apiName Convert address to slpAddr, cashAddr and legacy.

test/v3/a01-electrumx.js

@@ -2,7 +2,7 @@
   TESTS FOR THE ELECTRUMX.JS LIBRARY
 
   Named with a01 prefix so that these tests are run first. Something about running
-  the Blcokbook and Blockchain tests screws up these tests. Spend a couple hours
+  the Blcokbook and Blockchain tests screws up these tests. Spent a couple hours
   debugging and couldn't isolate the source of the issue, but renaming the file
   was an easy fix.
 
@@ -30,6 +30,18 @@ const mockData = require('./mocks/electrumx-mock')
 const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
+// A wrapper for asserting that the correct response is returned when an error
+// is expected.
+function expectRouteError (res, result, expectedError, code = 400) {
+  assert.equal(res.statusCode, code, `HTTP status code ${code} expected.`)
+
+  assert.property(result, 'error')
+  assert.include(result.error, expectedError)
+
+  assert.property(result, 'success')
+  assert.equal(result.success, false)
+}
+
 describe('#ElectrumX Router', () => {
   let req, res
   let sandbox
@@ -82,6 +94,17 @@ describe('#ElectrumX Router', () => {
     //
   })
 
+  // A wrapper for stubbing with the Sinon sandbox.
+  function stubMethodForUnitTests (obj, method, value) {
+    if (!process.env.TEST === 'unit') return false
+
+    electrumxRoute.isReady = true // Force flag.
+
+    sandbox.stub(obj, method).resolves(value)
+
+    return true
+  }
+
   describe('#root', () => {
     // root route handler.
     const root = electrumxRoute.root
@@ -94,7 +117,7 @@ describe('#ElectrumX Router', () => {
   })
 
   describe('#addressToScripthash', () => {
-    it('should accurately return a scripthash', () => {
+    it('should accurately return a scripthash for a P2PKH address', () => {
       const addr = 'bitcoincash:qpr270a5sxphltdmggtj07v4nskn9gmg9yx4m5h7s4'
 
       const scripthash = electrumxRoute.addressToScripthash(addr)
@@ -104,6 +127,17 @@ describe('#ElectrumX Router', () => {
 
       assert.equal(scripthash, expectedOutput)
     })
+
+    it('should accurately return a scripthash for a P2SH address', () => {
+      const addr = 'bitcoincash:pz0z7u9p96h2p6hfychxdrmwgdlzpk5luc5yks2wxq'
+
+      const scripthash = electrumxRoute.addressToScripthash(addr)
+
+      const expectedOutput =
+        '8bc2235c8e7d5634d9ec429fc0171f2c58e728d4f1e2fb7e440e313133cfa4f0'
+
+      assert.equal(scripthash, expectedOutput)
+    })
   })
 
   describe('#_utxosFromElectrumx', () => {
@@ -412,6 +446,226 @@ describe('#ElectrumX Router', () => {
     })
   })
 
+  describe('#_transactionDetailsFromElectrum', () => {
+    it('should return error object for invalid txid', async () => {
+      const txid =
+        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        new Error('Invalid tx hash')
+      )
+
+      const result = await electrumxRoute._transactionDetailsFromElectrum(txid)
+
+      assert.instanceOf(result, Error)
+      assert.include(result.message, 'Invalid tx hash')
+    })
+
+    it('should get details for a single txid', async () => {
+      const txid =
+        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        mockData.txDetails
+      )
+
+      const result = await electrumxRoute._transactionDetailsFromElectrum(txid)
+
+      assert.isObject(result)
+      assert.property(result, 'blockhash')
+      assert.property(result, 'hash')
+      assert.property(result, 'hex')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.equal(result.hash, txid)
+    })
+  })
+
+  describe('#getTransactionDetails', () => {
+    it('should throw 400 if txid is not a string', async () => {
+      req.params.txid = 5
+
+      const result = await electrumxRoute.getTransactionDetails(req, res)
+
+      expectRouteError(res, result, 'txid must be a string')
+    })
+
+    it('should throw 400 on array input', async () => {
+      req.params.address = [
+        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+      ]
+
+      const result = await electrumxRoute.getTransactionDetails(req, res)
+
+      expectRouteError(res, result, 'txid must be a string')
+    })
+
+    it('should return error object for invalid txid', async () => {
+      req.params.txid =
+        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        new Error('Invalid tx hash')
+      )
+
+      // Call the details API.
+      const result = await electrumxRoute.getTransactionDetails(req, res)
+
+      expectRouteError(res, result, 'Invalid tx hash')
+    })
+
+    it('should get details for a single txid', async () => {
+      req.params.txid =
+        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        mockData.txDetails
+      )
+
+      // Call the details API.
+      const result = await electrumxRoute.getTransactionDetails(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'details')
+      assert.isObject(result.details)
+
+      assert.property(result.details, 'blockhash')
+      assert.property(result.details, 'hash')
+      assert.property(result.details, 'hex')
+      assert.property(result.details, 'vin')
+      assert.property(result.details, 'vout')
+      assert.equal(result.details.hash, req.params.txid)
+    })
+  })
+
+  describe('#transactionDetailsBulk', () => {
+    it('should throw an error for an empty body', async () => {
+      req.body = {}
+
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+
+      expectRouteError(res, result, 'txids needs to be an array')
+    })
+
+    it('should error on non-array single txid', async () => {
+      req.body = {
+        txid: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+      }
+
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+
+      expectRouteError(res, result, 'txids needs to be an array')
+    })
+
+    it('should NOT throw 400 error for an invalid txid', async () => {
+      req.body = {
+        txids: [
+          '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
+        ]
+      }
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        mockData.txDetails
+      )
+
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+
+      // This should probably throw a 400 error, but to be consistent with the other
+      // bulk endpoints it doesn't throw. This will change in the future
+      // expectRouteError(res, result, 'Invalid tx hash')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'transactions')
+      assert.isArray(result.transactions)
+    })
+
+    it('should throw 429 error if txid array is too large', async () => {
+      const testArray = []
+      for (var i = 0; i < 25; i++) testArray.push('')
+
+      req.body.txids = testArray
+
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      expectRouteError(res, result, 'Array too large', 429)
+    })
+
+    it('should get details for a single txid', async () => {
+      req.body = {
+        txids: [
+          '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+        ]
+      }
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        mockData.txDetails
+      )
+
+      // Call the details API.
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'transactions')
+      assert.isArray(result.transactions)
+
+      assert.property(result.transactions[0], 'txid')
+      assert.property(result.transactions[0], 'details')
+
+      assert.property(result.transactions[0].details, 'blockhash')
+      assert.property(result.transactions[0].details, 'hash')
+      assert.property(result.transactions[0].details, 'hex')
+      assert.property(result.transactions[0].details, 'vin')
+      assert.property(result.transactions[0].details, 'vout')
+    })
+
+    it('should get details for multiple txids', async () => {
+      req.body = {
+        txids: [
+          '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
+          '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
+        ]
+      }
+
+      stubMethodForUnitTests(
+        electrumxRoute.electrumx,
+        'request',
+        mockData.txDetails
+      )
+
+      // Call the details API.
+      const result = await electrumxRoute.transactionDetailsBulk(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)'
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.isArray(result.transactions)
+      assert.isObject(result.transactions[0].details)
+      assert.equal(result.transactions.length, 2, '2 outputs for 2 inputs')
+    })
+  })
+
   describe('#_balanceFromElectrumx', () => {
     it('should throw error for invalid address', async () => {
       try {

test/v3/mocks/electrumx-mock.js

@@ -39,9 +39,78 @@ const mempool = [
   }
 ]
 
+const txDetails = {
+  blockhash: '0000000000000000002aaf94953da3b487317508ebd1003a1d75d6d6ec2e75cc',
+  blocktime: 1578327094,
+  confirmations: 31861,
+  hash: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
+  hex: '020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000',
+  locktime: 0,
+  size: 392,
+  time: 1578327094,
+  txid: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
+  version: 2,
+  vin: [
+    {
+      scriptSig: {
+        asm: 'dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e[ALL|FORKID] 020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309',
+        hex: '41dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309'
+      },
+      sequence: 4294967295,
+      txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
+      vout: 1
+    },
+    {
+      scriptSig: {
+        asm: '347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f77[ALL|FORKID] 028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954',
+        hex: '41347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954'
+      },
+      sequence: 4294967295,
+      txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
+      vout: 0
+    }
+  ],
+  vout: [
+    {
+      n: 0,
+      scriptPubKey: {
+        addresses: ['bitcoincash: pqvfecpwxvj53ayqfwkxtjaxsgpvnklcyg8xewk9hl'],
+        asm: 'OP_HASH160 189ce02e332548f4804bac65cba68202c9dbf822 OP_EQUAL',
+        hex: 'a914189ce02e332548f4804bac65cba68202c9dbf82287',
+        reqSigs: 1,
+        type: 'scripthash'
+      },
+      value: 0.0562057
+    },
+    {
+      n: 1,
+      scriptPubKey: {
+        addresses: ['bitcoincash: qq59hv6s3qdjrtyfwfxxldkuj9xsjmx48vrz882knz'],
+        asm: 'OP_DUP OP_HASH160 285bb350881b21ac89724c6fb6dc914d096cd53b OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914285bb350881b21ac89724c6fb6dc914d096cd53b88ac',
+        reqSigs: 1,
+        type: 'pubkeyhash'
+      },
+      value: 0.00589197
+    },
+    {
+      n: 2,
+      scriptPubKey: {
+        addresses: ['bitcoincash: qpzlruwy4xu5rxjs3z37nsj29y7h59gwvsu4ddp0u4'],
+        asm: 'OP_DUP OP_HASH160 45f1f1c4a9b9419a5088a3e9c24a293d7a150e64 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac',
+        reqSigs: 1,
+        type: 'pubkeyhash'
+      },
+      value: 0.03272697
+    }
+  ]
+}
+
 module.exports = {
   utxos,
   balance,
   txHistory,
-  mempool
+  mempool,
+  txDetails
 }

test/v3/util.js

@@ -135,11 +135,12 @@ describe('#Util', () => {
       // Mock the RPC call for unit tests.
       if (process.env.TEST === 'unit') {
         nock(`${process.env.RPC_BASEURL}`)
-          .post(uri => uri.includes('/'))
+          .post((uri) => uri.includes('/'))
           .reply(200, { result: mockData.mockAddress })
       }
 
-      req.params.address = 'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
+      req.params.address =
+        'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
 
       const result = await validateAddress(req, res)
       // console.log(`result: ${util.inspect(result)}`)
@@ -255,7 +256,7 @@ describe('#Util', () => {
       // Mock the RPC call for unit tests.
       if (process.env.TEST === 'unit') {
         nock(`${process.env.RPC_BASEURL}`)
-          .post(uri => uri.includes('/'))
+          .post((uri) => uri.includes('/'))
           .reply(200, { result: mockData.mockAddress })
       }
 
@@ -281,7 +282,7 @@ describe('#Util', () => {
       // Mock the RPC call for unit tests.
       if (process.env.TEST === 'unit') {
         nock(`${process.env.RPC_BASEURL}`)
-          .post(uri => uri.includes('/'))
+          .post((uri) => uri.includes('/'))
           .times(2)
           .reply(200, { result: mockData.mockAddress })
       }
@@ -356,17 +357,11 @@ describe('#Util', () => {
         // Mock the RPC call for unit tests.
 
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'balanceFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
           .resolves(mockData.mockBalance)
 
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'utxosFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
           .resolves(mockData.mockUtxos)
 
         sandbox
@@ -389,51 +384,41 @@ describe('#Util', () => {
 
         assert.equal(result, 'test-txid')
       })
-    }
 
-    it('should return balance if balance-only is true', async () => {
-      // Mock the RPC call for unit tests.
-      if (process.env.TEST === 'unit') {
+      it('should return balance if balance-only is true', async () => {
+        // Mock the RPC call for unit tests.
+
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'balanceFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
           .resolves(mockData.mockBalance)
-      }
 
-      // Mock sendRawTransaction() so that the hex does not actually get broadcast
-      // to the network.
-      sandbox
-        .stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
-        .resolves('test-txid')
+        // Mock sendRawTransaction() so that the hex does not actually get broadcast
+        // to the network.
+        sandbox
+          .stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
+          .resolves('test-txid')
 
-      req.body = {
-        wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
-        balanceOnly: true
-      }
+        req.body = {
+          wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
+          balanceOnly: true
+        }
 
-      const result = await utilRouteInst.sweepWif(req, res)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        const result = await utilRouteInst.sweepWif(req, res)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      assert.isNumber(result)
-    })
+        assert.isNumber(result)
+      })
+    }
 
     // Unit tests only
     if (process.env.TEST === 'unit') {
       it('should generate transaction for valid BCH-only sweep', async () => {
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'balanceFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
           .resolves(mockData.mockBalance)
 
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'utxosFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
           .resolves(mockData.mockUtxos)
 
         // Force token utxo to appear as regular BCH utxo.
@@ -460,17 +445,11 @@ describe('#Util', () => {
 
       it('should throw 422 error if no non-token UTXOs', async () => {
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'balanceFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
           .resolves(mockData.mockBalance)
 
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'utxosFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
           .resolves(mockData.mockUtxos)
 
         // Force token utxo to appear as regular BCH utxo.
@@ -502,17 +481,11 @@ describe('#Util', () => {
 
       it('should detect and throw error for multiple token classes', async () => {
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'balanceFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
           .resolves(mockData.mockBalance)
 
         sandbox
-          .stub(
-            utilRouteInst.blockbook,
-            'utxosFromBlockbook'
-          )
+          .stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
           .resolves(mockData.mockThreeUtxos)
 
         // Force token utxo to appear as regular BCH utxo.