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

fix(rate limits): Setting anonymous rate limits to a constant

.gitignore

@@ -20,6 +20,13 @@ start-free-main.sh
 start-local-mainnet.sh.save
 start-local-testnet.sh.save
 temp.sh
+test-fullstack-test.sh
+start-sweet-main.sh
+test-sweet-main.sh
+test-fullstack-abc.sh
+test-fullstack-bchn.sh
+start-fullstack-abc.sh
+start-fullstack-bchn.sh
 
 coverage
 start-my-infra

README.md

@@ -1,19 +1,12 @@
 # bch-api
 
+This is a node.js JavaScript REST API server using Express.js. The purpose of this code is to create a REST API server that provides a common interface for working with a Bitcoin Cash full node and various indexers. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) to learn about the 'Cash Stack'. Visit [FullStack.cash](https://fullstack.cash), sign up for a free account, and use this REST API right away with the [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) JavaScript library.
 
-[![Build Status](https://travis-ci.org/christroutner/bch-api.svg?branch=master)](https://travis-ci.org/christroutner/bch-api)
+This repository is intended to be paired with [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js), an npm JavaScript library for building Bitcoin Cash apps.
 
-This is a fork and alternative implementation of
+![Cash Stack Network Diagram](./generic-network-diagram.png)
-the [rest.bitcoin.com](https://github.com/Bitcoin-com/rest.bitcoin.com) repository.
-The purpose of this code is to create a REST API server that provides a common
-interface for working with a Bitcoin Cash full node and various indexers. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) to learn about the 'Cash Stack'. Visit [FullStack.cash](https://fullstack.cash), sign up for a free account, and use this REST API right away with the [bch-js](https://github.com/christroutner/bch-js) JavaScript library.
 
-This repository is intended to be paired with [bch-js](https://github.com/christroutner/bch-js),
+Both bch-api and bch-js are part of the 'Cash Stack' [full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
-an npm JavaScript library, and an alternative implementation
-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://fullstack.cash/documentation)
 - [Example Code](https://fullstack.cash/examples)
@@ -24,32 +17,29 @@ Have questions? Need help? Join our community support:
 ## Features
 The following features set this repository apart from rest.bitcoin.com:
 
-- Address balance and UTXO queries use the [Blockbook](https://github.com/trezor/blockbook)
-indexer instead of Insight.
 - Fine grain access is controlled with a JWT token using
-[this back end auth server](https://github.com/Permissionless-Software-Foundation/jwt-bch-api) and [this front end](https://github.com/Permissionless-Software-Foundation/jwt-bch-frontend).
+[this back end auth server](https://github.com/Permissionless-Software-Foundation/jwt-bch-api) and [this front end](https://github.com/Permissionless-Software-Foundation/jwt-bch-frontend). Can be used to monetize access to the REST API.
-- Default rate limits are set to 3 RPM for anonymous connections, 10 RPM for [free accounts](https://fullstack.cash/pricing), up to 100 RPM if a full-access JWT token is used.
 - Typescript removed and ES8 JavaScript used instead.
 - npm audit run on all dependencies.
-- [Greenkeeper](https://greenkeeper.io/) implemented for automatic dependency management
-and security updates.
 
 ## Live Demo
 You can test a live demo of the REST API by running the
 [bch-js examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples).
-Rate limits are 3 requests per minute, but you can increase them to 10 with a [free account](https://fullstack.cash/pricing).
+Rate limits are 20 requests per minute, but you can increase them to 100 with a [paid account](https://fullstack.cash/pricing).
-This is fast enough to try out the examples
+You can bootstrap your own REST API server by downloading and installing the infrastructure listed on the [CashStrap](https://fullstack.cash/cashstrap) page.
-but these servers are not intended as a freemium service. You can run your own
-REST server by purchasing the hard drive at [bchjs.cash](https://bchjs.cash).
 
-- Mainnet REST API server: https://api.fullstack.cash/v3/
+### Configure bch-js
-- Testnet REST API server: https://tapi.fullstack.cash/v3/
+The live servers can be used by [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) by settings the `restURL` config property to one of these servers:
+
+- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v3/
+- ABC Mainnet REST API server: https://abc.fullstack.cash/v3/
+- Testnet3 REST API server: https://testnet3.fullstack.cash/v3/
 - Check server status: https://metrics.fullstack.cash
 
 ## Installation
 There are two installation paths, depending if you want a *development* or
 *production* environment. You'll also need to set up the underlying infrastructure
-described [this page](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
+described on [this page](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
 
 This code targets the Ubuntu 18.04 LTS Linux OS.
 
@@ -58,7 +48,7 @@ This is a standard node.js project. The installation is as follows:
 
 - Clone this repository:
 
-`git clone https://github.com/christroutner/bch-api && cd bch-api`
+`git clone https://github.com/Permissionless-Software-Foundation/bch-api && cd bch-api`
 
 - Install dependencies:
 
@@ -93,5 +83,10 @@ installation.
 Have questions? Need help? Join our community support
 [Telegram channel](https://t.me/bch_js_toolkit)
 
+## IPFS
+Copies of this repository will occasionally be uploaded and hosted on [IPFS](https://ipfs.io):
+
+- v1.15.4: QmSAerFmDJm6KQp2HC8jsRR5MdL5X39hoUsJYvWNDvrD8m
+
 ## License
 [MIT](./LICENSE.md)

deploy-production.sh

@@ -1,17 +1,27 @@
+#!/bin/bash
 # Triggers a webhook to update the staging server at staging.fullstack.cash.
 
-#!/bin/bash
 #echo $DEPLOY_SECRET
 
-echo "Deploy to production...."
+# This if statement will only deploy on Jenkins when its testing the master branch.
+echo "-->$GIT_BRANCH<--"
+if [[ $GIT_BRANCH =~ "master" ]]
+  then
 
-export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
+    echo "Deploying to production...."
 
-#echo $DATA
+    export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
 
-curl -X POST http://fullstack.cash:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
+    #echo $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."
+    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
+    curl -X POST http://$BCHN_BCHAPI:9000/hooks/bch-api-bchn -H "Content-Type: application/json" -d $DATA
+
+    echo "...Finished deploying to production."
+
+  else
+    echo "Not master, so not deploying."
+fi

docker/mainnet/start-local-mainnet.sh

@@ -24,4 +24,10 @@ export REDIS_HOST=172.17.0.1
 # JWT Token Secret
 export TOKENSECRET=somelongsecretvalue
 
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
+
+# slp-api alternative SLP validator.
+export SLP_API_URL=http://10.0.0.5:5001/
+
 npm start

docker/testnet/start-local-testnet.sh

@@ -21,4 +21,10 @@ export REDIS_HOST=172.17.0.1
 # JWT Token Secret
 export TOKENSECRET=somelongsecretvalue
 
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
+
+# slp-api alternative SLP validator.
+export SLP_API_URL=http://10.0.0.5:5001/
+
 npm start

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/slp.js",
+    "test:temp": "export NETWORK=mainnet && export TEST=integration && mocha --timeout 25000 test/v3/encryption.js",
     "test:integration": "mocha test/v3/integration",
     "test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v3/integration/slp*.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls",

src/app.js

@@ -39,6 +39,7 @@ const BlockbookV3 = require('./routes/v3/blockbook')
 const Ninsight = require('./routes/v3/ninsight')
 const ElectrumXV3 = require('./routes/v3/electrumx')
 const EncryptionV3 = require('./routes/v3/encryption')
+const PriceV3 = require('./routes/v3/price')
 
 require('dotenv').config()
 
@@ -52,6 +53,7 @@ const blockbookV3 = new BlockbookV3()
 const electrumxv3 = new ElectrumXV3()
 electrumxv3.connect()
 const encryptionv3 = new EncryptionV3()
+const pricev3 = new PriceV3()
 
 const app = express()
 
@@ -121,6 +123,7 @@ app.use(`/${v3prefix}/` + 'xpub', xpubV3.router)
 app.use(`/${v3prefix}/` + 'blockbook', blockbookV3.router)
 app.use(`/${v3prefix}/` + 'electrumx', electrumxv3.router)
 app.use(`/${v3prefix}/` + 'encryption', encryptionv3.router)
+app.use(`/${v3prefix}/` + 'price', pricev3.router)
 
 const ninsight = new Ninsight()
 app.use(`/${v3prefix}/` + 'ninsight', ninsight.router)

src/middleware/auth.js

@@ -22,9 +22,9 @@
 'use strict'
 
 const passport = require('passport')
-// const BasicStrategy = require('passport-http').BasicStrategy
+const BasicStrategy = require('passport-http').BasicStrategy
 const AnonymousStrategy = require('passport-anonymous')
-// const wlogger = require('../util/winston-logging')
+const wlogger = require('../util/winston-logging')
 
 // Used for debugging and iterrogating JS objects.
 const util = require('util')
@@ -33,9 +33,11 @@ util.inspect.defaultOptions = { depth: 1 }
 // let _this
 
 // Set default rate limit value for testing
-// const PRO_PASSES = process.env.PRO_PASS ? process.env.PRO_PASS : 'BITBOX'
+const PRO_PASSES = process.env.PRO_PASS
+  ? process.env.PRO_PASS
+  : 'testpassword'
 // Convert the pro-tier password string into an array split by ':'.
-// const PRO_PASS = PRO_PASSES.split(':')
+const PRO_PASS = PRO_PASSES.split(':')
 
 // wlogger.verbose(`PRO_PASS set to: ${PRO_PASS}`)
 
@@ -47,56 +49,60 @@ class AuthMW {
     // Initialize passport for 'anonymous' authentication.
     passport.use(new AnonymousStrategy())
 
+    console.log(`PRO_PASS: ${JSON.stringify(PRO_PASS, null, 2)}`)
+
     // Initialize passport for 'basic' authentication.
-    //   passport.use(
+    passport.use(
-    //     new BasicStrategy({ passReqToCallback: true }, function (
+      new BasicStrategy({ passReqToCallback: true }, function (
-    //       req,
+        req,
-    //       username,
+        username,
-    //       password,
+        password,
-    //       done
+        done
-    //     ) {
+      ) {
-    //       // console.log(`req: ${util.inspect(req)}`)
+        // console.log(`req: ${util.inspect(req)}`)
-    //       // console.log(`username: ${username}`)
+        // console.log(`username: ${username}`)
-    //       // console.log(`password: ${password}`)
+        // console.log(`password: ${password}`)
-    //
+
-    //       // Create the req.locals property if it does not yet exist.
+        // Create the req.locals property if it does not yet exist.
-    //       if (!req.locals) {
+        if (!req.locals) {
-    //         req.locals = {
+          req.locals = {
-    //           // default values
+            // default values
-    //           proLimit: false,
+            proLimit: false,
-    //           apiLevel: 0
+            apiLevel: 0
-    //         }
+          }
-    //       }
+        }
-    //
+
-    //       // Set pro-tier rate limit to flag to false by default.
+        // Set pro-tier rate limit to flag to false by default.
-    //       req.locals.proLimit = false
+        req.locals.proLimit = false
-    //
+
-    //       // Evaluate the username and password and set the rate limit accordingly.
+        // Evaluate the username and password and set the rate limit accordingly.
-    //       // if (username === "BITBOX" && password === PRO_PASS) {
+        // if (username === "BITBOX" && password === PRO_PASS) {
-    //       if (username === 'BITBOX') {
+        if (username === 'fullstackcash') {
-    //         for (let i = 0; i < PRO_PASS.length; i++) {
+          for (let i = 0; i < PRO_PASS.length; i++) {
-    //           const thisPass = PRO_PASS[i]
+            const thisPass = PRO_PASS[i]
-    //
+
-    //           if (password === thisPass) {
+            if (password === thisPass) {
-    //             wlogger.verbose(`${req.url} called by ${password.slice(0, 6)}`)
+              wlogger.verbose(`${req.url} called by ${password.slice(0, 6)}`)
-    //
+
-    //             // Success
+              // Success
-    //             req.locals.proLimit = true
+              req.locals.proLimit = true
-    //             break
+              console.log(`User ${req.ip} authenticated using Basic Auth`)
-    //           }
+              break
-    //         }
+            }
-    //       }
+          }
-    //
+        }
-    //       // console.log(`req.locals: ${util.inspect(req.locals)}`)
+
-    //
+        // console.log(`req.locals: ${util.inspect(req.locals)}`)
-    //       return done(null, true)
+
-    //     })
+        return done(null, true)
-    //   )
+      })
+    )
   }
 
   // Middleware called by the route.
   mw () {
-    return passport.authenticate(['anonymous'], {
+    console.log('Initializing passport')
+    return passport.authenticate(['basic', 'anonymous'], {
       session: false
     })
   }

src/middleware/route-ratelimit.js

@@ -1,9 +1,23 @@
+/*
+  Sets the rate limits for the anonymous and paid tiers. Current rate limits:
+  - 1000 points in 60 seconds
+  - 10 points per call for paid tier (100 RPM)
+  - 50 points per call for anonymous tier (20 RPM)
+
+  Background:
+  The rate limits below were originially coded with the idea of charging on a
+  per-resource basis. However, that was confusing to end users trying to purchase
+  a subscription. So everything was simplied to two tiers: paid and anonymous
+*/
+
 'use strict'
 
+const jwt = require('jsonwebtoken')
+
 const wlogger = require('../util/winston-logging')
 const config = require('../../config')
 
-const jwt = require('jsonwebtoken')
+const ANON_LIMITS = 50
 
 // Redis
 const redisOptions = {
@@ -98,74 +112,83 @@ class RateLimits {
         wlogger.debug('No JWT token found!')
       }
 
-      // Used for displaying error message. Default value is 30.
+      // Default value is 50 points per request = 20 RPM
-      let rateLimit = 30
+      let rateLimit = ANON_LIMITS
 
-      // Code here for the rate limiter is adapted from this example:
+      // Only evaluate the JWT token if the user is not using Basic Authentication.
-      // https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#authorized-and-not-authorized-users
+      if (!req.locals.proLimit) {
-      try {
+        // Code here for the rate limiter is adapted from this example:
-        // The resource being consumed: full node, indexer, SLPDB, etc.
+        // https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#authorized-and-not-authorized-users
-        const resource = _this.getResource(req.url)
+        try {
-        wlogger.debug(`resource: ${resource}`)
+          // The resource being consumed: full node, indexer, SLPDB, etc.
+          const resource = _this.getResource(req.url)
+          wlogger.debug(`resource: ${resource}`)
 
-        let key = userId || req.ip
+          let key = userId || req.ip
-        res.locals.key = key // Feedback for tests.
+          res.locals.key = key // Feedback for tests.
 
-        // const pointsToConsume = userId ? 1 : 30
+          // const pointsToConsume = userId ? 1 : 30
-        decoded.resource = resource
+          decoded.resource = resource
-        let pointsToConsume = _this.calcPoints(decoded)
+          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.
-        if (
-          origin &&
-          (origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
-            origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
-            origin === 'slp-api')
-        ) {
-          pointsToConsume = 10
           res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
+
+          // Retrieve the origin.
+          let origin = req.get('origin')
+
+          // Handle calls coming from the intranet.
+          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.
+          if (
+            origin &&
+            (origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
+              origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
+              origin === 'slp-api')
+          ) {
+            pointsToConsume = 10
+            res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
+          }
+
+          // For internal calls, increase rate limits to as fast as possible.
+          if (
+            // Comment out the line below when running bch-js e2e rate limit tests.
+            key.toString().indexOf('::ffff:127.0.0.1') > -1 ||
+
+            // Do not comment out this line.
+            key.toString().indexOf('172.17.') > -1
+          ) {
+            pointsToConsume = 1
+            res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
+          }
+
+          wlogger.info(
+            `User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
+          )
+
+          rateLimit = Math.floor(1000 / pointsToConsume)
+
+          // Update the key so that rate limits track both the user and the resource.
+          key = `${key}-${resource}`
+
+          await _this.rateLimiter.consume(key, pointsToConsume)
+        } catch (err) {
+          // console.log('err: ', err)
+
+          // Used for returning data for tests.
+          res.locals.rateLimitTriggered = true
+          // console.log('res.locals: ', res.locals)
+
+          // Rate limited was triggered
+          res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+          return res.json({
+            error: `Too many requests. Your limits are currently ${rateLimit} requests per minute. Increase rate limits at https://fullstack.cash`
+          })
         }
-
-        // Apply paid-access rate limits based on key/IP
-        if (
-          key.toString().indexOf('172.17.') > -1 ||
-          key.toString().indexOf('::ffff:127.0.0.1') > -1
-        ) {
-          pointsToConsume = 1
-          res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
-        }
-
-        wlogger.info(
-          `User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
-        )
-
-        rateLimit = Math.floor(1000 / pointsToConsume)
-
-        // Update the key so that rate limits track both the user and the resource.
-        key = `${key}-${resource}`
-
-        await _this.rateLimiter.consume(key, pointsToConsume)
-      } catch (err) {
-        // console.log('err: ', err)
-
-        // Used for returning data for tests.
-        res.locals.rateLimitTriggered = true
-        // console.log('res.locals: ', res.locals)
-
-        // Rate limited was triggered
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: `Too many requests. Your limits are currently ${rateLimit} requests per minute. Increase rate limits at https://fullstack.cash`
-        })
       }
     } catch (err) {
       wlogger.error('Error in route-ratelimit.js/newRateLimit(): ', err)
@@ -178,7 +201,7 @@ class RateLimits {
   // Calculates the points consumed, based on the jwt information and the route
   // requested.
   calcPoints (jwtInfo) {
-    let retVal = 300 // By default, use anonymous tier.
+    let retVal = ANON_LIMITS // By default, use anonymous tier.
 
     try {
       // console.log(`jwtInfo: ${JSON.stringify(jwtInfo, null, 2)}`)
@@ -197,12 +220,12 @@ class RateLimits {
         if (level40Routes.includes(resource)) {
           if (apiLevel >= 40) retVal = 10
           // else if (apiLevel >= 10) retVal = 10
-          else retVal = 100
+          else retVal = ANON_LIMITS
 
           // Normal indexer routes
         } else if (level30Routes.includes(resource)) {
           if (apiLevel >= 30) retVal = 10
-          else retVal = 100
+          else retVal = ANON_LIMITS
 
           // Full node tier
         } else if (apiLevel >= 20) {
@@ -210,7 +233,7 @@ class RateLimits {
 
           // Free tier, full node only.
         } else {
-          retVal = 100
+          retVal = ANON_LIMITS
         }
       }
 
@@ -218,7 +241,7 @@ class RateLimits {
     } catch (err) {
       wlogger.error('Error in route-ratelimit.js/calcPoints()')
       // throw err
-      retVal = 300
+      retVal = ANON_LIMITS
     }
 
     return retVal

src/routes/v3/blockbook.js

@@ -96,18 +96,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {get} /blockbook/balance/{addr} Get balance for a single address.
-   * @apiName Balance for a single address
-   * @apiGroup Blockbook
-   * @apiDescription Returns an object with balance and details about an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockbook/balance/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
-   *
-   */
-  // GET handler for single balance
   async balanceSingle (req, res, next) {
     try {
       const address = req.params.address
@@ -165,18 +153,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {post} /blockbook/balance Get balance for an array of addresses.
-   * @apiName  Balance for an array of addresses
-   * @apiGroup Blockbook
-   * @apiDescription Return balances and details for an array of addresses.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/blockbook/balance" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
-   *
-   *
-   */
   // POST handler for bulk queries on address details
   async balanceBulk (req, res, next) {
     try {
@@ -284,17 +260,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {get} /blockbook/utxos/{addr} Get utxos for a single address.
-   * @apiName UTXOs for a single address
-   * @apiGroup Blockbook
-   * @apiDescription Returns an object with UTXOs associated with an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockbook/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
-   *
-   */
   // GET handler for single balance
   async utxosSingle (req, res, next) {
     try {
@@ -352,18 +317,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {post} /blockbook/utxos Get UTXOs for an array of addresses.
-   * @apiName  UTXOs for an array of addresses
-   * @apiGroup Blockbook
-   * @apiDescription Return UTXOs associate with an array of addresses.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/blockbook/utxos" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3","bitcoincash:qzy8wnj0dz927eu6kvh8v2pqsr5w8jh33ys757tdtq"]}'
-   *
-   *
-   */
   // POST handler for bulk queries on address utxos
   async utxosBulk (req, res, next) {
     try {
@@ -461,17 +414,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {get} /blockbook/tx/{txid} Get details for a single transaction.
-   * @apiName Details for a single transaction
-   * @apiGroup Blockbook
-   * @apiDescription Returns an object with details for a single transaction
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockbook/tx/6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d" -H "accept: application/json"
-   *
-   */
   // GET handler for single transaction details.
   async txSingle (req, res, next) {
     try {
@@ -514,18 +456,6 @@ class Blockbook {
     }
   }
 
-  /**
-   * @api {post} /blockbook/tx Get details for an array of transactions.
-   * @apiName  Details for an array of transactions
-   * @apiGroup Blockbook
-   * @apiDescription Return details for an array of transactions.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/blockbook/tx" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d","6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d"]}'
-   *
-   *
-   */
   // POST handler for bulk queries on tx details
   async txBulk (req, res, next) {
     try {

src/routes/v3/encryption.js

@@ -16,15 +16,10 @@ const RouteUtils = require('../../util/route-utils')
 const routeUtils = new RouteUtils()
 
 const BCHJS = require('@psf/bch-js')
-const bchjs = new BCHJS()
+const restURL = process.env.LOCAL_RESTURL
-
+  ? process.env.LOCAL_RESTURL
-// Use Blockbook for getting indexer data.
+  : 'https://api.fullstack.cash/v3/'
-const Blockbook = require('./blockbook')
+const bchjs = new BCHJS({ restURL })
-const blockbook = new Blockbook()
-
-// Use RawTransactions library for getting raw blockchain data.
-const RawTransactions = require('./full-node/rawtransactions')
-const rawTransactions = new RawTransactions()
 
 let _this
 
@@ -36,8 +31,8 @@ class Encryption {
     _this.axios = axios
     _this.routeUtils = routeUtils
     _this.bchjs = bchjs
-    _this.blockbook = blockbook
+    // _this.blockbook = blockbook
-    _this.rawTransactions = rawTransactions
+    // _this.rawTransactions = rawTransactions
 
     _this.router = router
     _this.router.get('/', _this.root)
@@ -115,23 +110,23 @@ class Encryption {
         cashAddr
       )
 
-      // Retrieve the transaction history for this address.
+      const rawTxData = await _this.bchjs.Electrumx.transactions(cashAddr)
-      const balance = await _this.blockbook.balanceFromBlockbook(cashAddr)
+      // console.log(`rawTxData: ${JSON.stringify(rawTxData, null, 2)}`)
-      // console.log(`balance: ${JSON.stringify(balance, null, 2)}`)
 
-      const txHistory = balance.txids
+      // Extract just the TXIDs
-      // console.log(`txHistory: ${JSON.stringify(txHistory, null, 2)}`)
+      const txids = rawTxData.transactions.map((elem) => elem.tx_hash)
+      // console.log(`txids: ${JSON.stringify(txids, null, 2)}`)
 
       // throw error if there is no transaction history.
-      if (!txHistory || txHistory.length === 0) {
+      if (!txids || txids.length === 0) {
         throw new Error('No transaction history.')
       }
 
       // Loop through the transaction history and search for the public key.
-      for (let i = 0; i < txHistory.length; i++) {
+      for (let i = 0; i < txids.length; i++) {
-        const thisTx = txHistory[i]
+        const thisTx = txids[i]
 
-        const txDetails = await _this.rawTransactions.getRawTransactionsFromNode(
+        const txDetails = await _this.bchjs.RawTransactions.getRawTransaction(
           thisTx,
           true
         )

src/routes/v3/price.js

@@ -0,0 +1,118 @@
+/*
+  This price route is really just a wrapper for another API price endpoint.
+  The main reason for hosting this price wrapper is so that the price can
+  be accessible over Tor. Tor is typically blocked by other REST API servers.
+*/
+
+'use strict'
+
+const express = require('express')
+const axios = require('axios')
+const wlogger = require('../../util/winston-logging')
+const util = require('util')
+
+const RouteUtils = require('../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+let _this // Global context for 'this' instance of the Class.
+
+class Price {
+  constructor () {
+    _this = this
+
+    this.axios = axios
+    this.routeUtils = routeUtils
+
+    this.priceUrl = 'https://api.coinbase.com/v2/exchange-rates?currency=BCH'
+
+    this.router = express.Router()
+    this.router.get('/', _this.root)
+    this.router.get('/usd', _this.getUSD)
+    this.router.get('/rates', _this.getBCHRate)
+  }
+
+  // DRY error handler.
+  errorHandler (err, res) {
+    // Attempt to decode the error message.
+    const { msg, status } = _this.routeUtils.decodeError(err)
+    if (msg) {
+      res.status(status)
+      return res.json({ error: msg })
+    }
+
+    res.status(500)
+    return res.json({ error: util.inspect(err) })
+  }
+
+  // Root API endpoint. Simply acknowledges that it exists.
+  root (req, res, next) {
+    return res.json({ status: 'price' })
+  }
+
+  /**
+   * @api {get} /price/usd Get the USD price of BCH
+   * @apiName Get the USD price of BCH
+   * @apiGroup Price
+   * @apiDescription Get the USD price of BCH
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v3/price/usd" -H "accept: application/json"
+   *
+   */
+  async getUSD (req, res, next) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: _this.priceUrl,
+        timeout: 15000
+      }
+
+      const response = await axios.request(opt)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return res.json({ usd: Number(response.data.data.rates.USD) })
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in price.js/getUSD().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {get} /price/usd Get rates for several different currencies
+   * @apiName Get rates for several different currencies
+   * @apiGroup Price
+   * @apiDescription Get rates for several different currencies
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v3/price/rates" -H "accept: application/json"
+   *
+   */
+  // Get rates for several different currencies
+  async getBCHRate (req, res, next) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: _this.priceUrl,
+        timeout: 15000
+      }
+
+      const response = await axios.request(opt)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return res.json(response.data.data.rates)
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in price.js/getUSD().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+}
+
+module.exports = Price

src/routes/v3/slp.js

@@ -1598,7 +1598,7 @@ class Slp {
    * not been confirmed.
    *
    * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/slp/hydrateUtxos" -H "accept:application/json" -H "Content-Type: application/json" -d '{"utxos":[{"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 3, "value": "6816", "height": 606848, "confirmations": 13, "satoshis": 6816}, {"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 2, "value": "546", "height": 606848, "confirmations": 13, "satoshis": 546}]}'
+   * curl -X POST "https://api.fullstack.cash/v3/slp/hydrateUtxos" -H "accept:application/json" -H "Content-Type: application/json" -d '{"utxos":[{"utxos":[{"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 3, "value": "6816", "height": 606848, "confirmations": 13, "satoshis": 6816}, {"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 2, "value": "546", "height": 606848, "confirmations": 13, "satoshis": 546}]}]}'
    *
    *
    */

start-dev-example.sh

@@ -20,4 +20,13 @@ export FULCRUM_PORT=50002
 
 export TOKENSECRET=somelongpassword
 
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
+
+# slp-api alternative SLP validator.
+export SLP_API_URL=http://10.0.0.5:5001/
+
+# Basic Authentication password
+export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
+
 npm start

test/v3/encryption.js

@@ -78,11 +78,11 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
-          .resolves(mockData.mockBalance)
+          .resolves(mockData.mockFulcrumTxHistory)
         sandbox
-          .stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
+          .stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
-          .resolves(mockData.mockTxDetails)
+          .resolves(mockData.mockTxDetails2)
       }
 
       const result = await encryptionRoute.getPublicKey(req, res)
@@ -105,8 +105,8 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
-          .resolves(mockData.mockNoTxHistory)
+          .resolves(mockData.mockFulcrumNoTxHistory)
       }
 
       const result = await encryptionRoute.getPublicKey(req, res)
@@ -126,10 +126,10 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
-          .resolves(mockData.mockNoSendBalance)
+          .resolves(mockData.mockFulcrumNoSendBalance)
         sandbox
-          .stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
+          .stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
           .resolves(mockData.mockNoSendTx)
       }
 

test/v3/integration/price.js

@@ -0,0 +1,34 @@
+/*
+  Integration tests for the price library.
+ */
+
+'use strict'
+
+// const assert = require('chai').assert
+// const axios = require('axios')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+const Price = require('../../../src/routes/v3/price')
+const price = new Price()
+
+const { mockReq, mockRes } = require('../mocks/express-mocks')
+
+describe('#price', () => {
+  let req, res
+
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = mockReq
+    res = mockRes
+  })
+
+  describe('#getUSD', () => {
+    it('should get the USD price', async () => {
+      const result = await price.getUSD(req, res)
+      console.log(`result: ${util.inspect(result)}`)
+    })
+  })
+})

test/v3/integration/rate-limits.js

@@ -1,7 +1,6 @@
 /*
-  This integration tests should be run against a live bch-api REST server. It
+  These tests have been deprecated. To test bch-api rate limits, run the e2e
-  tests to ensure the rate-limits are working as expected. Adjust the values
+  tests in the bch-js repository.
-  in the tests below to match the rate limit setting in your own installation.
  */
 
 'use strict'
@@ -17,11 +16,11 @@ util.inspect.defaultOptions = { depth: 1 }
 // const SERVER = `http://192.168.0.36:12400/v3/`
 const SERVER = 'http://localhost:3000/v3/'
 // const SERVER = 'https://api.fullstack.cash/v3/'
+//
+// const TEST_JWT =
+//   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
 
-const TEST_JWT =
+describe('#JWT rate limits', () => {
-  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
-
-describe('#rate limits', () => {
   it('should get control/getNetworkInfo() with no auth', async () => {
     const options = {
       method: 'GET',
@@ -36,25 +35,24 @@ describe('#rate limits', () => {
     assert.hasAnyKeys(result.data, ['version'])
   })
 
-  it('should trigger rate-limit handler if rate limits exceeds 5 request per minute', async () => {
+  it('should trigger rate-limit handler if rate limits exceeds 20 request per minute', async () => {
     try {
-      // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
       const options = {
         method: 'GET',
         url: `${SERVER}control/getNetworkInfo`
       }
 
       const promises = []
-      for (let i = 0; i < 5; i++) {
+      for (let i = 0; i < 30; i++) {
         const promise = axios(options)
         promises.push(promise)
       }
 
       await Promise.all(promises)
 
-      assert.equal(true, false, 'Unexpected result!')
+      assert.fail('Unexpected result!')
     } catch (err) {
-      // console.log(`err.response: ${util.inspect(err.response)}`)
+      console.log('err: ', err)
 
       assert.equal(err.response.status, 429)
       assert.include(err.response.data.error, 'Too many requests')
@@ -135,32 +133,32 @@ describe('#rate limits', () => {
   //   }
   // })
 
-  it('should unlock pro-tier for a valid JWT token', async () => {
+  // it('should unlock pro-tier for a valid JWT token', async () => {
-    try {
+  //   try {
-      // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
+  //     // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
-      const options = {
+  //     const options = {
-        method: 'GET',
+  //       method: 'GET',
-        url: `${SERVER}control/`,
+  //       url: `${SERVER}control/`,
-        headers: {
+  //       headers: {
-          Authorization: `Token ${TEST_JWT}`
+  //         Authorization: `Token ${TEST_JWT}`
-        }
+  //       }
-      }
+  //     }
-
+  //
-      const promises = []
+  //     const promises = []
-      for (let i = 0; i < 60; i++) {
+  //     for (let i = 0; i < 60; i++) {
-        const promise = axios(options)
+  //       const promise = axios(options)
-        promises.push(promise)
+  //       promises.push(promise)
-      }
+  //     }
-
+  //
-      await Promise.all(promises)
+  //     await Promise.all(promises)
-
+  //
-      // assert.equal(true, false, "Unexpected result!")
+  //     // assert.equal(true, false, "Unexpected result!")
-      assert.equal(true, true, 'Not throwing an error is a pass!')
+  //     assert.equal(true, true, 'Not throwing an error is a pass!')
-    } catch (err) {
+  //   } catch (err) {
-      console.log(`err.response: ${util.inspect(err.response)}`)
+  //     console.log(`err.response: ${util.inspect(err.response)}`)
-
+  //
-      assert.equal(true, false, 'Unexpected result!')
+  //     assert.equal(true, false, 'Unexpected result!')
-    }
+  //   }
-    // Override default timeout for this test.
+  //   // Override default timeout for this test.
-  }).timeout(20000)
+  // }).timeout(20000)
 })

test/v3/mocks/encryption-mocks.js

@@ -2,126 +2,6 @@
   Mock data for the encryption test library
 */
 
-const mockBalance = {
-  page: 1,
-  totalPages: 1,
-  itemsOnPage: 1000,
-  address: 'bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0',
-  balance: '582434',
-  totalReceived: '213083250',
-  totalSent: '212500816',
-  unconfirmedBalance: '0',
-  unconfirmedTxs: 0,
-  txs: 12,
-  txids: [
-    'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a',
-    '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
-    'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f',
-    '0f9b49cafeb9ae1d741cdb12137c92816aa8470944c270a78ba2e610bd59190d',
-    'ceb0cab0e37b59caf3ca29e1a698d19ff47f2827dd09cb2f3b91b9100b1dad1c',
-    '8bc2134c7e48e56e1769b3d7c4c1e3a0acc68e1e58160eee6fa67f3208c07262',
-    'b3792d28377b975560e1b6f09e48aeff8438d4c6969ca578bd406393bd50bd7d',
-    'ecc1b51bac767880382bf3190ff17abf78d0936843a022a943d871116ed50368',
-    '9ea667bcfc9cd337bd6c5583d8094c1b1942bd2015d95b54189deac5070eeff0',
-    '6960255abe64893073921e96bf3c053c82686e0fc22a565494fbe2a31e766975',
-    '7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153',
-    'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3'
-  ]
-}
-
-const mockTxDetails = {
-  txid: '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
-  hash: '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
-  version: 1,
-  size: 437,
-  locktime: 0,
-  vin: [
-    {
-      txid: 'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a',
-      vout: 0,
-      scriptSig: {
-        asm:
-          '30450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da97[ALL|FORKID] 044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c',
-        hex:
-          '4830450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da974141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
-      },
-      sequence: 4294967295
-    },
-    {
-      txid: 'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f',
-      vout: 1,
-      scriptSig: {
-        asm:
-          '3044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e[ALL|FORKID] 044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c',
-        hex:
-          '473044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
-      },
-      sequence: 4294967295
-    }
-  ],
-  vout: [
-    {
-      value: 0.47,
-      n: 0,
-      scriptPubKey: {
-        asm:
-          'OP_DUP OP_HASH160 7ab928d0b41194411a2e87a782b688c7cc69ba46 OP_EQUALVERIFY OP_CHECKSIG',
-        hex: '76a9147ab928d0b41194411a2e87a782b688c7cc69ba4688ac',
-        reqSigs: 1,
-        type: 'pubkeyhash',
-        addresses: ['bitcoincash:qpatj2xsksgegsg696r60q4k3rruc6d6gc3srp333v']
-      }
-    },
-    {
-      value: 0.00531373,
-      n: 1,
-      scriptPubKey: {
-        asm:
-          'OP_DUP OP_HASH160 f3707320bbb4a28759a78a5ad63a77a2f5d462ec OP_EQUALVERIFY OP_CHECKSIG',
-        hex: '76a914f3707320bbb4a28759a78a5ad63a77a2f5d462ec88ac',
-        reqSigs: 1,
-        type: 'pubkeyhash',
-        addresses: ['bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0']
-      }
-    }
-  ],
-  hex:
-    '01000000029a1c67eea78c7b8830dd8ed079239994e0df10f19ea83e34eea2bad3168f2fc4000000008b4830450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da974141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2cffffffff0f501c1be6601b0ed29bd579ae5be8e54842d3a3a2172734fc423fff48aca0e4010000008a473044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2cffffffff02c029cd02000000001976a9147ab928d0b41194411a2e87a782b688c7cc69ba4688acad1b0800000000001976a914f3707320bbb4a28759a78a5ad63a77a2f5d462ec88ac00000000',
-  blockhash: '0000000000000000045e5e52fb4f9746b3d15d3062855fd346aaef3debef4360',
-  confirmations: 71465,
-  time: 1545564654,
-  blocktime: 1545564654
-}
-
-const mockNoTxHistory = {
-  page: 1,
-  totalPages: 1,
-  itemsOnPage: 1000,
-  address: 'bitcoincash:qqwfpk04ecf69wuprj9yjys9rla5mk7rj5j8uthqel',
-  balance: '0',
-  totalReceived: '0',
-  totalSent: '0',
-  unconfirmedBalance: '0',
-  unconfirmedTxs: 0,
-  txs: 0
-}
-
-const mockNoSendBalance = {
-  page: 1,
-  totalPages: 1,
-  itemsOnPage: 1000,
-  address: 'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg',
-  balance: '0',
-  totalReceived: '0',
-  totalSent: '0',
-  unconfirmedBalance: '600',
-  unconfirmedTxs: 1,
-  txs: 0,
-  txids: [
-    'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
-  ]
-}
-
 const mockNoSendTx = {
   txid: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
   hash: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
@@ -133,8 +13,10 @@ const mockNoSendTx = {
       txid: '681cc1d392975a7e78cbd490b8a940d7eb029c554f2cee332e3a7119d77fb189',
       vout: 1,
       scriptSig: {
-        asm: '30450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f[ALL|FORKID] 02bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7',
+        asm:
-        hex: '4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7'
+          '30450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f[ALL|FORKID] 02bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7',
+        hex:
+          '4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7'
       },
       sequence: 4294967295
     }
@@ -144,36 +26,157 @@ const mockNoSendTx = {
       value: 0.000006,
       n: 0,
       scriptPubKey: {
-        asm: 'OP_DUP OP_HASH160 3c79ba54317c4be9cbfa5aaf357f74b97f3d9696 OP_EQUALVERIFY OP_CHECKSIG',
+        asm:
+          'OP_DUP OP_HASH160 3c79ba54317c4be9cbfa5aaf357f74b97f3d9696 OP_EQUALVERIFY OP_CHECKSIG',
         hex: '76a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac',
         reqSigs: 1,
         type: 'pubkeyhash',
-        addresses: [
+        addresses: ['bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg']
-          'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg'
-        ]
       }
     },
     {
       value: 0.00003664,
       n: 1,
       scriptPubKey: {
-        asm: 'OP_DUP OP_HASH160 58502a73888e0a386fc69b44850af4b2a86ac9a6 OP_EQUALVERIFY OP_CHECKSIG',
+        asm:
+          'OP_DUP OP_HASH160 58502a73888e0a386fc69b44850af4b2a86ac9a6 OP_EQUALVERIFY OP_CHECKSIG',
         hex: '76a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac',
         reqSigs: 1,
         type: 'pubkeyhash',
-        addresses: [
+        addresses: ['bitcoincash:qpv9q2nn3z8q5wr0c6d5fpg27je2s6kf5cavp4ney0']
-          'bitcoincash:qpv9q2nn3z8q5wr0c6d5fpg27je2s6kf5cavp4ney0'
-        ]
       }
     }
   ],
-  hex: '020000000189b17fd719713a2e33ee2c4f559c02ebd740a9b890d4cb787e5a9792d3c11c68010000006b4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7ffffffff0258020000000000001976a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac500e0000000000001976a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac00000000'
+  hex:
+    '020000000189b17fd719713a2e33ee2c4f559c02ebd740a9b890d4cb787e5a9792d3c11c68010000006b4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7ffffffff0258020000000000001976a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac500e0000000000001976a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac00000000'
+}
+
+const mockFulcrumTxHistory = {
+  success: true,
+  transactions: [
+    {
+      height: 511463,
+      tx_hash:
+        'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3'
+    },
+    {
+      height: 511464,
+      tx_hash:
+        '7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153'
+    },
+    {
+      height: 513373,
+      tx_hash:
+        '6960255abe64893073921e96bf3c053c82686e0fc22a565494fbe2a31e766975'
+    },
+    {
+      height: 513373,
+      tx_hash:
+        '9ea667bcfc9cd337bd6c5583d8094c1b1942bd2015d95b54189deac5070eeff0'
+    },
+    {
+      height: 560481,
+      tx_hash:
+        'ecc1b51bac767880382bf3190ff17abf78d0936843a022a943d871116ed50368'
+    },
+    {
+      height: 560615,
+      tx_hash:
+        'b3792d28377b975560e1b6f09e48aeff8438d4c6969ca578bd406393bd50bd7d'
+    },
+    {
+      height: 561568,
+      tx_hash:
+        '8bc2134c7e48e56e1769b3d7c4c1e3a0acc68e1e58160eee6fa67f3208c07262'
+    },
+    {
+      height: 561569,
+      tx_hash:
+        'ceb0cab0e37b59caf3ca29e1a698d19ff47f2827dd09cb2f3b91b9100b1dad1c'
+    },
+    {
+      height: 561572,
+      tx_hash:
+        '0f9b49cafeb9ae1d741cdb12137c92816aa8470944c270a78ba2e610bd59190d'
+    },
+    {
+      height: 561582,
+      tx_hash:
+        'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f'
+    },
+    {
+      height: 562106,
+      tx_hash:
+        '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb'
+    },
+    {
+      height: 562106,
+      tx_hash:
+        'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a'
+    }
+  ]
+}
+
+const mockTxDetails2 = {
+  txid: '7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153',
+  hash: '7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153',
+  version: 1,
+  size: 221,
+  locktime: 0,
+  vin: [
+    {
+      txid: 'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3',
+      vout: 0,
+      scriptSig: {
+        asm:
+          '30440220150e7c9b646fe1f7f576456c9808c89a710e8fbb753e9f5ca6ed2d39a0b69ba602202212968163d8dfe35eec5975fce38440082029cb2691a3e0ad1714f9c412c47a[ALL|FORKID] 044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c',
+        hex:
+          '4730440220150e7c9b646fe1f7f576456c9808c89a710e8fbb753e9f5ca6ed2d39a0b69ba602202212968163d8dfe35eec5975fce38440082029cb2691a3e0ad1714f9c412c47a4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
+      },
+      sequence: 4294967295
+    }
+  ],
+  vout: [
+    {
+      value: 0.01266023,
+      n: 0,
+      scriptPubKey: {
+        asm: 'OP_HASH160 91bacd6785e3f8c78d5f29b4020b94c753444130 OP_EQUAL',
+        hex: 'a91491bacd6785e3f8c78d5f29b4020b94c75344413087',
+        reqSigs: 1,
+        type: 'scripthash',
+        addresses: ['bitcoincash:pzgm4nt8sh3l33udtu5mgqstjnr4x3zpxqrrrndnw5']
+      }
+    }
+  ],
+  hex:
+    '0100000001c3aecb09fdfb9aff9a1bc8424c4583579be13db15fc74342f47f4838950af0ef000000008a4730440220150e7c9b646fe1f7f576456c9808c89a710e8fbb753e9f5ca6ed2d39a0b69ba602202212968163d8dfe35eec5975fce38440082029cb2691a3e0ad1714f9c412c47a4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2cffffffff01675113000000000017a91491bacd6785e3f8c78d5f29b4020b94c7534441308700000000',
+  blockhash: '000000000000000001aab6818b4ad0379a3f7a13940d9b3d4838b3dea1d0a083',
+  confirmations: 149222,
+  time: 1515088493,
+  blocktime: 1515088493
+}
+
+const mockFulcrumNoTxHistory = {
+  success: true,
+  transactions: []
+}
+
+const mockFulcrumNoSendBalance = {
+  success: true,
+  transactions: [
+    {
+      height: 633578,
+      tx_hash:
+        'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
+    }
+  ]
 }
 
 module.exports = {
-  mockBalance,
+  mockNoSendTx,
-  mockTxDetails,
+  mockFulcrumTxHistory,
-  mockNoTxHistory,
+  mockTxDetails2,
-  mockNoSendBalance,
+  mockFulcrumNoTxHistory,
-  mockNoSendTx
+  mockFulcrumNoSendBalance
 }

test/v3/mocks/price-mock.js

@@ -0,0 +1,221 @@
+/*
+  This library contains mocking data for running unit tests on the address route.
+*/
+
+'use strict'
+
+const mockCoinbaseFeed = {
+  data: {
+    currency: 'BCH',
+    rates: {
+      AED: '918.11634',
+      AFN: '19208.6584998',
+      ALGO: '823.28722002635056355',
+      ALL: '26365.4673517',
+      AMD: '120379.9761886',
+      ANG: '448.6632494',
+      AOA: '162813.68075',
+      ARS: '19392.84240565',
+      ATOM: '45.3670932026499700525',
+      AUD: '354.4385981',
+      AWG: '449.91',
+      AZN: '425.539875',
+      BAL: '18.824215193276753072',
+      BAM: '415.45514235',
+      BAND: '40.7768732564399590085',
+      BAT: '1168.9711697428450012',
+      BBD: '499.9',
+      BCH: '1.0',
+      BDT: '21194.1523216',
+      BGN: '415.36691',
+      BHD: '94.2501462',
+      BIF: '483670.78174295',
+      BMD: '249.95',
+      BND: '339.227141',
+      BOB: '1725.8732563',
+      BRL: '1401.494645',
+      BSD: '249.95',
+      BSV: '1.567361207606150942625',
+      BTC: '0.021275',
+      BTN: '18323.91073475',
+      BWP: '2859.81217315',
+      BYN: '640.5913561',
+      BYR: '6405913.561',
+      BZD: '503.8107177',
+      CAD: '329.6765515',
+      CDF: '490377.5463717',
+      CGLD: '121.6805004503079241715',
+      CHF: '227.5939721',
+      CLF: '7.13432285',
+      CLP: '196860.63474705',
+      CNH: '1669.50978125',
+      CNY: '1670.21589',
+      COMP: '2.429765723728978241',
+      COP: '961722.29431455',
+      CRC: '150790.4338804',
+      CUC: '250.01273745',
+      CVE: '23620.275',
+      CZK: '5790.09175',
+      DAI: '247.842348666936355635',
+      DASH: '3.338230383973288798',
+      DJF: '44495.8985401',
+      DKK: '1580.608815',
+      DOP: '14597.4179324',
+      DZD: '32214.830745',
+      EEK: '3652.69206545',
+      EGP: '3924.839875',
+      EOS: '96.8423091824874092665',
+      ERN: '3749.25274945',
+      ETB: '9313.6508972',
+      ETC: '45.04821122825989111',
+      ETH: '0.658777328255340453815',
+      EUR: '212.33',
+      FJD: '534.9054975',
+      FKP: '193.01413945',
+      GBP: '193.115',
+      GEL: '807.3385',
+      GGP: '193.01413945',
+      GHS: '1453.70845015',
+      GIP: '193.01413945',
+      GMD: '12934.9125',
+      GNF: '2447970.79115335',
+      GTQ: '1944.576007',
+      GYD: '52260.2868518',
+      HKD: '1937.122498',
+      HNL: '6129.328889',
+      HRK: '1610.802775',
+      HTG: '15746.55080985',
+      HUF: '77512.6058777',
+      IDR: '3675351.03275',
+      ILS: '846.1232415',
+      IMP: '193.01413945',
+      INR: '18345.655135',
+      IQD: '298009.02802165',
+      ISK: '34745.5495',
+      JEP: '193.01413945',
+      JMD: '36409.6696094',
+      JOD: '177.21455',
+      JPY: '26360.601825',
+      KES: '27184.562',
+      KGS: '20308.0755724',
+      KHR: '1025880.7533059',
+      KMF: '105029.03124175',
+      KNC: '274.68542227594924615',
+      KRW: '284915.23080495',
+      KWD: '76.4532063',
+      KYD: '208.2943328',
+      KZT: '107014.42658325',
+      LAK: '2310183.71158185',
+      LBP: '378370.54450325',
+      LINK: '22.894634759817007489',
+      LKR: '46090.95971405',
+      LRC: '1457.8594342373869446',
+      LRD: '48852.72175115',
+      LSL: '4122.3008749',
+      LTC: '5.2062070401999589123',
+      LTL: '806.05000775',
+      LVL: '164.03243695',
+      LYD: '341.5926678',
+      MAD: '2298.47346335',
+      MDL: '4228.5806147',
+      MGA: '982179.7557538',
+      MKD: '13087.73767885',
+      MKR: '0.43764476902003812305',
+      MMK: '322679.7621378',
+      MNT: '709349.8756452',
+      MOP: '1995.2583685',
+      MRO: '89232.15',
+      MTL: '170.9003131',
+      MUR: '9974.21650765',
+      MVR: '3849.23',
+      MWK: '188665.67006785',
+      MXN: '5298.265135',
+      MYR: '1036.517655',
+      MZN: '18229.3548997',
+      NAD: '4134.173',
+      NGN: '95481.03472305',
+      NIO: '8698.6554209',
+      NMR: '8.624556609112112958',
+      NOK: '2334.203066',
+      NPR: '29318.1806909',
+      NZD: '379.2351378',
+      OMG: '74.464123456422320125',
+      OMR: '96.23549905',
+      OXT: '1033.27821413807369045',
+      PAB: '249.95',
+      PEN: '896.6071427',
+      PGK: '874.90073485',
+      PHP: '12136.85639315',
+      PKR: '40613.9575836',
+      PLN: '971.640633',
+      PYG: '1756126.21474795',
+      QAR: '910.1304375',
+      REN: '769.6689761354887733',
+      REP: '18.2912550311013566725',
+      REPV2: '18.1582473904586151205',
+      RON: '1035.54285',
+      RSD: '24943.76025',
+      RUB: '19402.093805',
+      RWF: '244237.3512583',
+      SAR: '937.65668115',
+      SBD: '2019.805958',
+      SCR: '4576.6749819',
+      SEK: '2207.698372',
+      SGD: '339.57582125',
+      SHP: '193.01413945',
+      SLL: '2490751.74625075',
+      SOS: '145044.39506805',
+      SRD: '3537.7923',
+      SSP: '32558.487',
+      STD: '5250063.0293496',
+      SVC: '2187.04525345',
+      SZL: '4118.75383445',
+      THB: '7800.314625',
+      TJS: '2579.48624955',
+      TMT: '874.825',
+      TND: '688.2998125',
+      TOP: '579.953986',
+      TRY: '1969.70598',
+      TTD: '1696.3476626',
+      TWD: '7179.16412995',
+      TZS: '579879.84308155',
+      UAH: '7090.3476468',
+      UGX: '935325.80066935',
+      UMA: '29.276720351390922145',
+      UNI: '78.76161966283282792',
+      USD: '249.95',
+      USDC: '249.95',
+      UYU: '10724.30446005',
+      UZS: '2592145.88136715',
+      VEF: '62109486.17813795',
+      VES: '113073216.80555545',
+      VND: '5792476.0820382',
+      VUV: '28582.2184128',
+      WST: '655.5403657',
+      XAF: '139318.05656485',
+      XAG: '10.233577875',
+      XAU: '0.1313462255',
+      XCD: '675.5023725',
+      XDR: '177.0940741',
+      XLM: '2935.3219224332811736',
+      XOF: '139318.05656485',
+      XPD: '0.1065011955',
+      XPF: '25344.75028595',
+      XPT: '0.290981792',
+      XRP: '1016.6768354687817832',
+      XTZ: '114.010080507218287957',
+      YER: '62574.97275195',
+      YFI: '0.0181099566723181033515',
+      ZAR: '4130.57372',
+      ZEC: '3.88966697790227161905',
+      ZMK: '1313006.15998725',
+      ZMW: '5048.6210738',
+      ZRX: '642.804422350408735165',
+      ZWL: '80483.9'
+    }
+  }
+}
+
+module.exports = {
+  mockCoinbaseFeed
+}

test/v3/price.js

@@ -0,0 +1,214 @@
+/*
+  TESTS FOR THE PRICE.JS LIBRARY
+
+  This test file uses the environment variable TEST to switch between unit
+  and integration tests. By default, TEST is set to 'unit'. Set this variable
+  to 'integration' to run the tests against BCH mainnet.
+
+*/
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+const sinon = require('sinon')
+
+const Price = require('../../src/routes/v3/price')
+let uut
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+const mockData = require('./mocks/price-mock')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+describe('#PriceRouter', () => {
+  let req, res
+  let sandbox
+
+  before(() => {
+    // Set default environment variables for unit tests.
+    if (!process.env.TEST) process.env.TEST = 'unit'
+  })
+
+  // Setup the mocks before each test.
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = mockReq
+    res = mockRes
+
+    // Explicitly reset the parmas and body.
+    req.params = {}
+    req.body = {}
+    req.query = {}
+
+    sandbox = sinon.createSandbox()
+
+    uut = new Price()
+  })
+
+  afterEach(() => {
+    // Restore Sandbox
+    sandbox.restore()
+  })
+
+  after(() => {})
+
+  describe('#root', async () => {
+    // root route handler.
+    // const root = controlRoute.testableComponents.root
+
+    it('should respond to GET for base route', async () => {
+      const result = uut.root(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(result.status, 'price', 'Returns static string')
+    })
+  })
+
+  describe('#getUSD', () => {
+    // const getNetworkInfo = controlRoute.testableComponents.getNetworkInfo
+
+    it('should throw 500 when network issues', async () => {
+      uut.priceUrl = 'http://fakeurl/api/'
+
+      await uut.getUSD(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // console.log(res)
+      assert.include(
+        res.output.error,
+        'Network error: Could not communicate with full node or other external service'
+      )
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getUSD(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
+      assert.include(
+        result.error,
+        'Could not communicate with full node',
+        'Error message expected'
+      )
+    })
+
+    it('returns proper error when downstream service is down', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getUSD(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
+      assert.include(
+        result.error,
+        'Could not communicate with full node',
+        'Error message expected'
+      )
+    })
+
+    it('should get the USD price of BCH', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: mockData.mockCoinbaseFeed })
+      }
+
+      const result = await uut.getUSD(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+
+  describe('#getBCHRate', () => {
+    it('should throw 500 when network issues', async () => {
+      uut.priceUrl = 'http://fakeurl/api/'
+
+      await uut.getBCHRate(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // console.log(res)
+      assert.include(
+        res.output.error,
+        'Network error: Could not communicate with full node or other external service'
+      )
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getBCHRate(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
+      assert.include(
+        result.error,
+        'Could not communicate with full node',
+        'Error message expected'
+      )
+    })
+
+    it('returns proper error when downstream service is down', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getBCHRate(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
+      assert.include(
+        result.error,
+        'Could not communicate with full node',
+        'Error message expected'
+      )
+    })
+
+    it('should get several rates for BCH', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: mockData.mockCoinbaseFeed })
+      }
+
+      const result = await uut.getBCHRate(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // assert.isNumber(result)
+      assert.property(result, 'USD')
+      assert.property(result, 'CAD')
+    })
+  })
+
+  describe('#errorHandler', () => {
+    it('should handle unexpected errors', () => {
+      sandbox.stub(uut.routeUtils, 'decodeError').returns({ msg: false })
+
+      const result = uut.errorHandler(new Error('test error'), res)
+      // console.log('result: ', result)
+
+      assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
+      assert.property(result, 'error')
+    })
+  })
+})

test/v3/rate-limits.js

@@ -105,14 +105,14 @@ describe('#route-ratelimits & jwt-auth', () => {
   })
 
   describe('#calcPoints', () => {
-    it('should return 300 points for anonymous user', () => {
+    it('should return 50 points for anonymous user', () => {
       const result = rateLimits.calcPoints()
       // console.log(`result: ${result}`)
 
-      assert.equal(result, 300)
+      assert.equal(result, 50)
     })
 
-    it('should return 100 points for free tier requesting full node access', () => {
+    it('should return 50 points for free tier requesting full node access', () => {
       const jwtInfo = {
         apiLevel: 10,
         resource: 'blockchain',
@@ -120,10 +120,10 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
-    it('should return 100 points for free tier requesting indexer access', () => {
+    it('should return 50 points for free tier requesting indexer access', () => {
       const jwtInfo = {
         apiLevel: 10,
         resource: 'blockbook',
@@ -131,10 +131,10 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
-    it('should return 100 points for free tier requesting SLPDB access', () => {
+    it('should return 50 points for free tier requesting SLPDB access', () => {
       const jwtInfo = {
         apiLevel: 10,
         resource: 'slp',
@@ -142,7 +142,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
     it('should return 10 points for full node tier requesting full node access', () => {
@@ -156,7 +156,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       assert.equal(result, 10)
     })
 
-    it('should return 100 points for full-node tier requesting indexer access', () => {
+    it('should return 50 points for full-node tier requesting indexer access', () => {
       const jwtInfo = {
         apiLevel: 20,
         resource: 'blockbook',
@@ -164,10 +164,10 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
-    it('should return 100 points for full node tier requesting SLPDB access', () => {
+    it('should return 50 points for full node tier requesting SLPDB access', () => {
       const jwtInfo = {
         apiLevel: 20,
         resource: 'slp',
@@ -175,7 +175,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
     it('should return 10 point for indexer tier requesting full node access', () => {
@@ -200,7 +200,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       assert.equal(result, 10)
     })
 
-    it('should return 100 points for indexer tier requesting SLPDB access', () => {
+    it('should return 50 points for indexer tier requesting SLPDB access', () => {
       const jwtInfo = {
         apiLevel: 30,
         resource: 'slp',
@@ -208,7 +208,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       }
 
       const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 100)
+      assert.equal(result, 50)
     })
 
     it('should return 10 point for SLP tier requesting full node access', () => {
@@ -319,7 +319,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       )
     })
 
-    it('should trigger rate-limit for free tier after 10 RPM', async () => {
+    it('should trigger rate-limit for free tier after 20 RPM', async () => {
       // Create a new instance of the rate limit so we start with zeroed tracking.
       rateLimits = new RateLimits()
 
@@ -338,7 +338,7 @@ describe('#route-ratelimits & jwt-auth', () => {
       // Mock the call to the jwt library.
       sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
 
-      for (let i = 0; i < 12; i++) {
+      for (let i = 0; i < 22; i++) {
         next.reset() // reset the stubbed next() function.
 
         await rateLimits.rateLimitByResource(req, res, next)
@@ -442,7 +442,7 @@ describe('#route-ratelimits & jwt-auth', () => {
 
       // Issues with token secret should treat incoming requests as anonymous
       // calls with 30 points or 3 RPM.
-      assert.equal(res.locals.pointsToConsume, 300)
+      assert.equal(res.locals.pointsToConsume, 50)
     })
   })
 })

test/v3/raw-transactions.js

@@ -975,6 +975,7 @@ describe('#Raw-Transactions', () => {
       // Restore the saved URL.
       process.env.RPC_BASEURL = savedUrl2
     })
+
     it('should submit hex encoded transaction', async () => {
       // This is a difficult test to run as transaction hex is invalid after a
       // block confirmation. So the unit tests simulates what the output 'should'
@@ -1003,8 +1004,13 @@ describe('#Raw-Transactions', () => {
 
         // Integration test
       } else {
-        assert.hasAllKeys(result, ['error'])
+        if (process.env.ISBCHN) {
-        assert.include(result.error, 'Missing inputs')
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'Missing inputs')
+        } else {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'bad-txns-inputs-missingorspent')
+        }
       }
     })
   })
@@ -1158,8 +1164,13 @@ describe('#Raw-Transactions', () => {
 
         // Integration test
       } else {
-        assert.hasAllKeys(result, ['error'])
+        if (process.env.ISBCHN) {
-        assert.include(result.error, 'Missing inputs')
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'Missing inputs')
+        } else {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'bad-txns-inputs-missingorspent')
+        }
       }
     })
   })