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

Updating example start shell script

.gitignore

@@ -30,6 +30,7 @@ start-fullstack-abc.sh
 start-fullstack-bchn.sh
 start-ss-main.sh
 start-decatur-bchn.sh
+shell-scripts/
 
 coverage
 start-my-infra

README.md

@@ -82,6 +82,20 @@ installation.
 
 `docker-compose up`
 
+## Rate Limits
+The rate limits for [api.fullstack.cash](https://api.fullstack.cash) are controlled by a JWT token. You can increase your rate limits by [purchasing a JWT token](https://https://fullstack.cash). If you're using bch-js, [check the readme for instructions on increasing rate limits](https://github.com/Permissionless-Software-Foundation/bch-js#api-key). For interacting with bch-api directly, you can then include the JWT token in the HTTP header like this:
+
+- `Authorization: Token <JWT token>`
+
+### cURL example
+Here is an example using curl for using the JWT token when making a call to the REST API:
+
+```
+export BCHJSTOKEN=eyJhbGciOiJ....
+
+curl "https://bchn.fullstack.cash/v4/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -X GET -H "Content-Type: application/json" -H "Authorization: Token ${BCHJSTOKEN}"
+```
+
 ## Support
 Have questions? Need help? Join our community support
 [Telegram channel](https://t.me/bch_js_toolkit)

apidoc.json

@@ -0,0 +1,4 @@
+{
+    "sampleUrl": null
+
+  }

config/index.js

@@ -16,6 +16,9 @@ const config = {
   whitelistRateLimit: process.env.WHITELIST_RATE_LIMIT
     ? Number(process.env.WHITELIST_RATE_LIMIT)
     : 10,
+  internalRateLimit: process.env.INTERNAL_RATE_LIMIT
+    ? Number(process.env.INTERNAL_RATE_LIMIT)
+    : 10,
   pointsPerMinute: process.env.POINTS_PER_MINUTE
     ? Number(process.env.POINTS_PER_MINUTE)
     : 10000,

package.json

@@ -16,20 +16,20 @@
     "dev": "nodemon ./dist/app.js",
     "test": "npm run lint && npm run test-v4",
     "lint": "standard --env mocha --fix",
-    "test-v4": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v4/",
+    "test-v4": "export NETWORK=mainnet && nyc --reporter=text mocha --exit --timeout 60000 test/v4/",
     "test:integration": "mocha test/v4/integration",
     "test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v4/integration/slp*.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v4/",
     "docs": "./node_modules/.bin/apidoc -i src/routes/v4 -o docs",
     "test:temp1": "export NETWORK=mainnet && export TEST=integration && mocha --exit --timeout 25000 -g '#hydrateUtxos-' test/v4/integration/",
-    "test:temp2": "mocha test/v4/rate-limit2-unit.js"
+    "test:temp2": "mocha -g '#rate-routelimit' --timeout 30000 test/v4/"
   },
   "engines": {
     "node": ">=10.15.1"
   },
   "dependencies": {
-    "@psf/bch-js": "^4.16.1",
+    "@psf/bch-js": "^4.18.0",
     "apidoc": "^0.26.0",
     "axios": "^0.21.1",
     "bitcore-lib-cash": "^8.23.1",
@@ -70,7 +70,7 @@
     "nock": "^13.0.5",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
-    "semantic-release": "^17.3.9",
+    "semantic-release": "^17.4.2",
     "sinon": "^9.0.0",
     "standard": "^14.3.1"
   },

src/app.js

@@ -189,9 +189,11 @@ server.listen(port)
 server.on('error', onError)
 server.on('listening', onListening)
 
-// Set the time before a timeout error is generated. This impacts testing and
-// the handling of timeout errors. Is 10 seconds too agressive?
-server.setTimeout(30 * 1000)
+// Set the time before a timeout error is generated.
+// 10 seconds is way too agressive. 30 Seconds was used for a while, but with
+// being able to set a timeout between UTXOs for tokenUtxoDetails, the timeout
+// needed to be extended.
+server.setTimeout(1000 * 60 * 5) // 5 minutes
 
 /**
  * Normalize a port into a number, string, or false.

src/middleware/route-ratelimit.js

@@ -56,7 +56,7 @@ const ANON_LIMITS = config.anonRateLimit
 const WHITELIST_DOMAINS = config.whitelistDomains
 const WHITELIST_POINTS_TO_CONSUME = config.whitelistRateLimit
 const POINTS_PER_MINUTE = config.pointsPerMinute
-const INTERNAL_POINTS_TO_CONSUME = 10
+const INTERNAL_POINTS_TO_CONSUME = config.internalRateLimit
 
 class RateLimits {
   constructor () {
@@ -82,11 +82,11 @@ class RateLimits {
 
       // Determine if the call is an external or internal API call.
       const isInternal = _this.checkInternalIp(req)
-      console.log(`isInternal: ${isInternal}`)
+      // console.log(`isInternal: ${isInternal}`)
 
       // Determine if the call originates from another computer on the intranet.
       const isWhitelistOrigin = _this.isInWhitelist(req)
-      console.log('isWhitelistOrigin: ', isWhitelistOrigin)
+      // console.log('isWhitelistOrigin: ', isWhitelistOrigin)
 
       // Handle the use case of internally-generated requests.
       if (isInternal) {
@@ -94,15 +94,15 @@ class RateLimits {
         // the usrObj in the body.
         if (req.body && req.body.usrObj) {
           if (req.body.usrObj.proLimit) {
-            console.log('Internal call, basic auth, skipping rate limits.')
+            // console.log('Internal call, basic auth, skipping rate limits.')
 
             // If this is an internal call that originated from a user using
             // Basic Authentication, then skip rate-limits.
             return next()
           } else {
-            console.log(
-              'Internal call, applying rate limits. Using JWT if available.'
-            )
+            // console.log(
+            //   'Internal call, applying rate limits. Using JWT if available.'
+            // )
 
             // Determine if user has exceeded their rate limits. Pass in the
             // JWT token if one exists.
@@ -130,10 +130,10 @@ class RateLimits {
           // and avoid this code path. This code path is 'pooled': all users
           // share the same rate limits. Even at 1000 RPM, this pool will get
           // exhausted easily.
-          const warnMsg =
-            'Internal call. req.body.usrObj does not exist. Applying high-speed internal rate limits.'
-          console.log(warnMsg)
-          wlogger.info(warnMsg)
+          // const warnMsg =
+          //   'Internal call. req.body.usrObj does not exist. Applying high-speed internal rate limits.'
+          // console.log(warnMsg)
+          // wlogger.info(warnMsg)
 
           const defaultPayload = {
             id: '98.76.54.32',
@@ -154,6 +154,7 @@ class RateLimits {
             res,
             defaultJwt
           )
+          // console.log(`hasExceededRateLimit: `, hasExceededRateLimit)
 
           if (!hasExceededRateLimit) {
             // Rate limits have not been exceeded. Processing can continue.
@@ -168,9 +169,9 @@ class RateLimits {
         //
       } else {
         // Handle the normal use-case of external requests
-        console.log(
-          'External call, applying rate limits. Using JWT if available.'
-        )
+        // console.log(
+        //   'External call, applying rate limits. Using JWT if available.'
+        // )
 
         // For calls originating from a whitelist domain, apply a high-RPM
         // JWT token to the call.
@@ -195,6 +196,7 @@ class RateLimits {
           res,
           req.locals.jwtToken
         )
+        // console.log('hasExceededRateLimit: ', hasExceededRateLimit)
 
         if (!hasExceededRateLimit) {
           // Rate limits have not been exceeded. Processing can continue.
@@ -220,8 +222,12 @@ class RateLimits {
   async trackRateLimits (req, res, jwtToken) {
     // Anonymous rate limits are used by default.
     let pointsToConsume = ANON_LIMITS
+    // console.log('pointsToConsume: ', pointsToConsume)
+
     let key = req.ip // Use the IP address as the key, by default.
 
+    // console.log('jwtToken: ', jwtToken)
+
     try {
       // Decode the JWT token if it exists
       if (jwtToken) {
@@ -233,18 +239,22 @@ class RateLimits {
 
         pointsToConsume = decoded.pointsToConsume
       }
-      console.log(`rate limit key: ${key}`)
+      // console.log(`rate limit key: ${key}`)
 
       // This function will throw an error if the user exceeds the rate limit.
       // The 429 error response is handled by the catch().
       await _this.rateLimiter.consume(key, pointsToConsume)
 
+      // Debugging
+      // const rateLimitData = await _this.rateLimiter.consume(key, pointsToConsume)
+      // console.log(`rateLimitData: `, rateLimitData)
+
       res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
 
       // Signal that the user has not exceeded their rate limits.
       return false
     } catch (err) {
-      console.log('err: ', err)
+      // console.log('err: ', err)
 
       const rateLimit = Math.floor(POINTS_PER_MINUTE / pointsToConsume)
 
@@ -307,7 +317,8 @@ class RateLimits {
 
       // Retrieve the origin.
       const origin = req.get('origin')
-      console.log(`origin: ${origin}`)
+
+      if (!process.env.TEST) console.log('origin:', origin)
 
       // If the origin is not determinable, return false.
       if (!origin) return false

src/routes/v4/blockbook.js

@@ -1,521 +0,0 @@
-/*
-  Blockbook API route
-*/
-
-'use strict'
-
-const express = require('express')
-const axios = require('axios')
-const wlogger = require('../../util/winston-logging')
-
-const RouteUtils = require('../../util/route-utils')
-const routeUtils = new RouteUtils()
-
-// Library for easily switching the API paths to use different instances of
-// Blockbook.
-const BlockbookPath = require('../../util/blockbook-path')
-const BLOCKBOOKPATH = new BlockbookPath()
-// BLOCKBOOKPATH.toOpenBazaar()
-
-const router = express.Router()
-
-// Used for processing error messages before sending them to the user.
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-const BCHJS = require('@psf/bch-js')
-const bchjs = new BCHJS()
-
-let _this
-
-class Blockbook {
-  constructor () {
-    _this = this
-
-    _this.axios = axios
-    _this.routeUtils = routeUtils
-    _this.bchjs = bchjs
-    _this.BLOCKBOOKPATH = BLOCKBOOKPATH
-
-    _this.router = router
-    _this.router.get('/', _this.root)
-    _this.router.get('/balance/:address', _this.balanceSingle)
-    _this.router.post('/balance', _this.balanceBulk)
-    _this.router.get('/utxos/:address', _this.utxosSingle)
-    _this.router.post('/utxos', _this.utxosBulk)
-    _this.router.get('/tx/:txid', _this.txSingle)
-    _this.router.post('/tx', _this.txBulk)
-  }
-
-  // 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: 'address' })
-  }
-
-  // Query the Blockbook Node API for a balance on a single BCH address.
-  // Returns a Promise.
-  async balanceFromBlockbook (thisAddress) {
-    try {
-      // console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
-
-      // Convert the address to a cashaddr without a prefix.
-      const addr = _this.bchjs.Address.toCashAddress(thisAddress)
-
-      const path = `${_this.BLOCKBOOKPATH.addrPath}${addr}`
-      // console.log(`path: ${path}`)
-
-      // Query the Blockbook Node API.
-      const options = {
-        method: 'get',
-        baseURL: path
-      }
-
-      const axiosResponse = await _this.axios.request(options)
-      const retData = axiosResponse.data
-      // console.log(`retData: ${util.inspect(retData)}`)
-
-      return retData
-    } catch (err) {
-      // Dev Note: Do not log error messages here. Throw them instead and let the
-      // parent function handle it.
-      wlogger.debug('Error in blockbook.js/balanceFromBlockbook()')
-      throw err
-    }
-  }
-
-  async balanceSingle (req, res, next) {
-    try {
-      const address = req.params.address
-
-      if (!address || address === '') {
-        res.status(400)
-        return res.json({ error: 'address can not be empty' })
-      }
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing blockbook/balanceSingle with this address: ',
-        address
-      )
-
-      // Ensure the input is a valid BCH address.
-      try {
-        // const legacyAddr = bchjs.Address.toLegacyAddress(address)
-        _this.bchjs.Address.toLegacyAddress(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 networkIsValid = _this.routeUtils.validateNetwork(address)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      // Query the Blockbook Node API.
-      const retData = await _this.balanceFromBlockbook(address)
-
-      // Return the retrieved address information.
-      res.status(200)
-      return res.json(retData)
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in blockbook.js/balanceSingle().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // POST handler for bulk queries on address details
-  async balanceBulk (req, res, next) {
-    try {
-      let addresses = req.body.addresses
-      // const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
-
-      // Reject if addresses is not an array.
-      if (!Array.isArray(addresses)) {
-        res.status(400)
-        return res.json({
-          error: 'addresses needs to be an array. Use GET for single address.'
-        })
-      }
-
-      // Enforce array size rate limits
-      if (!_this.routeUtils.validateArraySize(req, addresses)) {
-        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing blockbook.js/balanceBulk with these addresses: ',
-        addresses
-      )
-
-      // Validate each element in the address array.
-      for (let i = 0; i < addresses.length; i++) {
-        const thisAddress = addresses[i]
-
-        // Ensure the input is a valid BCH address.
-        try {
-          _this.bchjs.Address.toLegacyAddress(thisAddress)
-        } catch (err) {
-          res.status(400)
-          return res.json({
-            error: `Invalid BCH address. Double check your address is valid: ${thisAddress}`
-          })
-        }
-
-        // Prevent a common user error. Ensure they are using the correct network address.
-        const networkIsValid = _this.routeUtils.validateNetwork(thisAddress)
-        if (!networkIsValid) {
-          res.status(400)
-          return res.json({
-            error: `Invalid network for address ${thisAddress}. Trying to use a testnet address on mainnet, or vice versa.`
-          })
-        }
-      }
-
-      // Loops through each address and creates an array of Promises, querying
-      // Insight API in parallel.
-      addresses = addresses.map(async (address, index) =>
-        // console.log(`address: ${address}`)
-        _this.balanceFromBlockbook(address)
-      )
-
-      // Wait for all parallel Insight requests to return.
-      const result = await _this.axios.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json(result)
-    } catch (err) {
-      wlogger.error('Error in blockbook.js/balanceBulk().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Query the Blockbook API for utxos associated with a BCH address.
-  // Returns a Promise.
-  async utxosFromBlockbook (thisAddress) {
-    try {
-      // console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
-
-      // Convert the address to a cashaddr without a prefix.
-      const addr = _this.bchjs.Address.toCashAddress(thisAddress)
-
-      const path = `${_this.BLOCKBOOKPATH.utxoPath}${addr}`
-      // console.log(`path: ${path}`)
-
-      // Query the Blockbook API.
-      // Query the Blockbook Node API.
-      const options = {
-        method: 'get',
-        baseURL: path
-      }
-      const axiosResponse = await _this.axios.request(options)
-      const retData = axiosResponse.data
-      // console.log(`retData: ${util.inspect(retData)}`)
-
-      // Add the satoshis property to each UTXO.
-      for (let i = 0; i < retData.length; i++) {
-        retData[i].satoshis = Number(retData[i].value)
-      }
-
-      return retData
-    } catch (err) {
-      // Dev Note: Do not log error messages here. Throw them instead and let the
-      // parent function handle it.
-      wlogger.debug('Error in blockbook.js/utxosFromBlockbook()')
-      throw err
-    }
-  }
-
-  // GET handler for single balance
-  async utxosSingle (req, res, next) {
-    try {
-      const address = req.params.address
-
-      if (!address || address === '') {
-        res.status(400)
-        return res.json({ error: 'address can not be empty' })
-      }
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing blockbook/utxosSingle with this address: ',
-        address
-      )
-
-      // Ensure the input is a valid BCH address.
-      try {
-        // const legacyAddr = bchjs.Address.toLegacyAddress(address)
-        _this.bchjs.Address.toLegacyAddress(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 networkIsValid = _this.routeUtils.validateNetwork(address)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      // Query the Blockbook API.
-      const retData = await _this.utxosFromBlockbook(address)
-
-      // Return the retrieved address information.
-      res.status(200)
-      return res.json(retData)
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in blockbook.js/utxosSingle().', err)
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // POST handler for bulk queries on address utxos
-  async utxosBulk (req, res, next) {
-    try {
-      let addresses = req.body.addresses
-      // const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
-
-      // Reject if addresses is not an array.
-      if (!Array.isArray(addresses)) {
-        res.status(400)
-        return res.json({
-          error: 'addresses needs to be an array. Use GET for single address.'
-        })
-      }
-
-      // Enforce array size rate limits
-      if (!_this.routeUtils.validateArraySize(req, addresses)) {
-        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing blockbook.js/utxosBulk with these addresses: ',
-        addresses
-      )
-
-      // Validate each element in the address array.
-      for (let i = 0; i < addresses.length; i++) {
-        const thisAddress = addresses[i]
-
-        // Ensure the input is a valid BCH address.
-        try {
-          _this.bchjs.Address.toLegacyAddress(thisAddress)
-        } catch (err) {
-          res.status(400)
-          return res.json({
-            error: `Invalid BCH address. Double check your address is valid: ${thisAddress}`
-          })
-        }
-
-        // Prevent a common user error. Ensure they are using the correct network address.
-        const networkIsValid = _this.routeUtils.validateNetwork(thisAddress)
-        if (!networkIsValid) {
-          res.status(400)
-          return res.json({
-            error: `Invalid network for address ${thisAddress}. Trying to use a testnet address on mainnet, or vice versa.`
-          })
-        }
-      }
-
-      // Loops through each address and creates an array of Promises, querying
-      // Insight API in parallel.
-      addresses = addresses.map(async (address, index) =>
-        // console.log(`address: ${address}`)
-        _this.utxosFromBlockbook(address)
-      )
-
-      // Wait for all parallel Insight requests to return.
-      const result = await _this.axios.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json(result)
-    } catch (err) {
-      wlogger.error('Error in blockbook.js/utxosBulk().', err)
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Query the Blockbook Node API for transactions on a single TXID.
-  // Returns a Promise.
-  async transactionsFromBlockbook (txid) {
-    try {
-      // console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
-
-      const path = `${_this.BLOCKBOOKPATH.txPath}${txid}`
-      // console.log(`path: ${path}`)
-
-      // Query the Blockbook Node API.
-      const options = {
-        method: 'get',
-        baseURL: path
-      }
-      const axiosResponse = await _this.axios.request(options)
-      const retPromise = axiosResponse.data
-      // console.log(`retData: ${util.inspect(retData)}`)
-
-      return retPromise
-    } catch (err) {
-      // Dev Note: Do not log error messages here. Throw them instead and let the
-      // parent function handle it.
-      wlogger.debug('Error in blockbook.js/transactionsFromBlockbook()')
-      throw err
-    }
-  }
-
-  // GET handler for single transaction details.
-  async txSingle (req, res, next) {
-    try {
-      const txid = req.params.txid
-
-      if (!txid || txid === '') {
-        res.status(400)
-        return res.json({ error: 'txid can not be empty' })
-      }
-
-      // Reject if address is an array.
-      if (Array.isArray(txid)) {
-        res.status(400)
-        return res.json({
-          error: 'txid can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      // TODO: Add regex comparison of txid to ensure it's valid.
-      if (txid.length !== 64) {
-        res.status(400)
-        return res.json({
-          error: `txid must be of length 64 (not ${txid.length})`
-        })
-      }
-
-      wlogger.debug('Executing blockbook/txSingle with this txid: ', txid)
-
-      // Query the Blockbook Node API.
-      const retData = await _this.transactionsFromBlockbook(txid)
-
-      // Return the retrieved address information.
-      res.status(200)
-      return res.json(retData)
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in blockbook.js/txSingle().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // POST handler for bulk queries on tx details
-  async txBulk (req, res, next) {
-    try {
-      let txids = req.body.txids
-      // const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
-
-      // Reject if txids is not an array.
-      if (!Array.isArray(txids)) {
-        res.status(400)
-        return res.json({
-          error: 'txids need to be an array. Use GET for single address.'
-        })
-      }
-
-      // Enforce array size rate limits
-      if (!_this.routeUtils.validateArraySize(req, txids)) {
-        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug('Executing blockbook.js/txBulk with these txids: ', txids)
-
-      // Validate each element in the txids array.
-      for (let i = 0; i < txids.length; i++) {
-        const thisTxid = txids[i]
-
-        if (!thisTxid || thisTxid === '') {
-          res.status(400)
-          return res.json({ error: 'txid can not be empty' })
-        }
-
-        // TODO: Add regex comparison of txid to ensure it's valid.
-        if (thisTxid.length !== 64) {
-          res.status(400)
-          return res.json({
-            error: `txid must be of length 64 (not ${thisTxid.length})`
-          })
-        }
-      }
-
-      // Loops through each address and creates an array of Promises, querying
-      // Insight API in parallel.
-      txids = txids.map(async (txid, index) =>
-        // console.log(`address: ${address}`)
-        _this.transactionsFromBlockbook(txid)
-      )
-
-      // Wait for all parallel Insight requests to return.
-      const result = await _this.axios.all(txids)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json(result)
-    } catch (err) {
-      wlogger.error('Error in blockbook.js/txBulk().', err)
-      return _this.errorHandler(err, res)
-    }
-  }
-}
-
-module.exports = Blockbook

src/routes/v4/encryption.js

@@ -181,7 +181,7 @@ class Encryption {
         publicKey: 'not found'
       })
     } catch (err) {
-      console.log('Error in encryption.js/getPublicKey().', err)
+      // console.log('Error in encryption.js/getPublicKey().', err)
       wlogger.error('Error in encryption.js/getPublicKey().', err)
 
       return _this.errorHandler(err, res)

src/routes/v4/full-node/blockchain.js

@@ -53,6 +53,7 @@ class Blockchain {
     this.router.post('/getTxOutProof', this.getTxOutProofBulk)
     this.router.get('/verifyTxOutProof/:proof', this.verifyTxOutProofSingle)
     this.router.post('/verifyTxOutProof', this.verifyTxOutProofBulk)
+    this.router.post('/getBlock', this.getBlock)
   }
 
   root (req, res, next) {
@@ -937,6 +938,52 @@ class Blockchain {
       return _this.errorHandler(err, res)
     }
   }
+
+  /**
+   * @api {post} /blockchain/getBlock/ Get block details
+   * @apiName getBlock
+   * @apiGroup Blockchain
+   * @apiDescription Returns block details
+   *
+   * @apiExample Example usage:
+   * curl "https://api.fullstack.cash/v4/blockchain/getblock/" -X POST -H "Content-Type: application/json" --data-binary '{"blockhash":"000000000000000002a5fe0bdd6e3f04342a975c0f55e57f97e73bb90041676b","verbosity":0 }'
+   *
+   * @apiParam {String} blockhash Block hash (required)
+   * @apiParam {Number} verbosity Default 1 (optional)
+   *
+   */
+  async getBlock (req, res, next) {
+    try {
+      // Validate input parameter
+      const blockhash = req.body.blockhash
+      let verbosity = req.body.verbosity
+
+      // Default to a value of 1 if another verbosity level is not defined.
+      if (!verbosity && verbosity !== 0) verbosity = 1
+
+      if (!blockhash || blockhash === '') {
+        res.status(400)
+        return res.json({ error: 'blockhash can not be empty' })
+      }
+
+      // Axios options
+      const options = _this.routeUtils.getAxiosOptions()
+
+      options.data.id = 'getblock'
+      options.data.method = 'getblock'
+      options.data.params = [blockhash, verbosity]
+
+      const response = await _this.axios.request(options)
+
+      return res.json(response.data.result)
+    } catch (err) {
+      // Write out error to error log.
+      // logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
+      wlogger.error('Error in blockchain.js/getBlock()', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
 }
 
 module.exports = Blockchain

src/routes/v4/slp.js

@@ -1780,8 +1780,6 @@ class Slp {
 
   // Format the response from SLPDB into an object.
   async formatToRestObject (slpDBFormat) {
-    _this.BigNumber.set({ DECIMAL_PLACES: 8 })
-
     // console.log(`slpDBFormat.data: ${JSON.stringify(slpDBFormat.data, null, 2)}`)
 
     const transaction = slpDBFormat.data.u.length

src/util/route-utils.js

@@ -154,16 +154,23 @@ class RouteUtils {
         }
       }
 
-      // Handle 429 errors thrown by nginx
+      // Handle 429 errors
       if (err.error) {
-        // console.log('decodeError: err: ', err)
+        console.log('decodeError: err: ', err)
 
+        // Error thrown by nginx (usually the SLPDB load balancer.)
         if (err.error.includes('429 Too Many Requests')) {
           const internalMsg =
             '429 error thrown by nginx caught by route-utils.js/decodeError()'
           console.error(internalMsg)
           wlogger.error(internalMsg)
 
+          return {
+            msg: '429 Too Many Requests',
+            status: 429
+          }
+        } else if (err.error.includes('Too many requests')) {
+          // Error is being thrown by bch-api rate limit middleware.
           return {
             msg: '429 Too Many Requests',
             status: 429

src/util/winston-logging.js

@@ -15,7 +15,11 @@ var NETWORK = process.env.NETWORK
 var LOG_MAX_SIZE = process.env.LOG_MAX_SIZE ? process.env.LOG_MAX_SIZE : '1m'
 
 // Default 5 days.
-var LOG_MAX_FILES = process.env.LOG_MAX_FILES ? process.env.LOG_MAX_FILES : '5d'
+// This was causing a problem with popularity. Creating over a gigabyte of files.
+// var LOG_MAX_FILES = process.env.LOG_MAX_FILES ? process.env.LOG_MAX_FILES : '5d'
+
+// 250 files @ 1Meg each = 250 megs
+var LOG_MAX_FILES = process.env.LOG_MAX_FILES ? process.env.LOG_MAX_FILES : '250'
 
 // Configure daily-rotation transport.
 var transport = new winston.transports.DailyRotateFile({

start-dev-example.sh

@@ -48,12 +48,12 @@ export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
 # that originate froma domain on the whitelist.
 export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
 
-# Rate Limits. Numbers are divided into 1000. e.g. 1000 / 50 = 20 RPM for ANON.
+# Rate Limits. Numbers are divided into 1000. e.g. 10000 / 500 = 20 RPM for ANON.
 # Requests use the ANON rate limit if they fail to pass in a JWT token.
 # ANON = 20 requests per minute (RPM)
-export ANON_RATE_LIMIT=50
-# 10 = 100 RPM
-export WHITELIST_RATE_LIMIT=10
+export ANON_RATE_LIMIT=500
+# 10 = 1000 RPM
+export WHITELIST_RATE_LIMIT=100
 
 # Set logging parameters
 #1m means no more than 1 megabyte

test/v4/blockchain.js

@@ -1823,4 +1823,204 @@ describe('#BlockchainRouter', () => {
       assert.equal(result.length, 2)
     })
   })
+
+  describe('#getBlock()', () => {
+    it('returns proper error when downstream service stalls', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
+
+      req.body.blockhash =
+        '000000202ed2723e7590e2b937f6821a99d6764cb8799bf30f8e300000000000000000001d311c02df9a1e3f57b8dbdcf97ec8dbc3109a26779724c63e560b29ad9ea501e2af955d286403183049e39c1e000000067139f230701a2819a76795564bd2f67ded7eeae68596f368eddb3dd5bc54e59320e896f71d61cfc3ae3d4a90fca08b1aa35ba91256d8939d2cad11e638c0081f66724abdef55cf7b8b9fed064bce0369171434f8b289c1330ccef765f8e97a2c0d794d81aafb535855f7daa6bb51e40f77c6b59d7af7f62d0eb726a4fc4df82353d56fcbda7c7ea6bd935d61af8fb3b295637e6f323b10231135b3f10a034cfb238f635830c0595e52c6c31247cf677b555f7a287076e20cd0e1d3cc9af7260f02b700'
+
+      const result = await uut.getBlock(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' })
+
+      req.body.blockhash =
+        '000000202ed2723e7590e2b937f6821a99d6764cb8799bf30f8e300000000000000000001d311c02df9a1e3f57b8dbdcf97ec8dbc3109a26779724c63e560b29ad9ea501e2af955d286403183049e39c1e000000067139f230701a2819a76795564bd2f67ded7eeae68596f368eddb3dd5bc54e59320e896f71d61cfc3ae3d4a90fca08b1aa35ba91256d8939d2cad11e638c0081f66724abdef55cf7b8b9fed064bce0369171434f8b289c1330ccef765f8e97a2c0d794d81aafb535855f7daa6bb51e40f77c6b59d7af7f62d0eb726a4fc4df82353d56fcbda7c7ea6bd935d61af8fb3b295637e6f323b10231135b3f10a034cfb238f635830c0595e52c6c31247cf677b555f7a287076e20cd0e1d3cc9af7260f02b700'
+      const result = await uut.getBlock(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 throw 400 if blockhash is empty', async () => {
+      const result = await uut.getBlock(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'blockhash can not be empty')
+    })
+
+    it('should return block info with verbosity 0', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: { result: mockData.mockBlockInfo.verbosity0 } })
+      }
+
+      req.body.blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+      req.body.verbosity = 0
+
+      const result = await uut.getBlock(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isString(result)
+    })
+
+    it('should return block info with verbosity 1', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
+      }
+
+      req.body.blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+      req.body.verbosity = 1
+
+      const result = await uut.getBlock(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'hash', 'hash property expected')
+      assert.property(
+        result,
+        'confirmations',
+        'confirmations property expected'
+      )
+      assert.property(result, 'size', 'size property expected')
+      assert.property(result, 'height', 'height property expected')
+      assert.property(result, 'version', 'version property expected')
+      assert.property(result, 'versionHex', 'versionHex property expected')
+      assert.property(result, 'merkleroot', 'merkleroot property expected')
+      assert.property(result, 'tx', 'tx property expected')
+      assert.property(result, 'time', 'time property expected')
+      assert.property(result, 'mediantime', 'mediantime property expected')
+      assert.property(result, 'nonce', 'nonce property expected')
+      assert.property(result, 'bits', 'bits property expected')
+      assert.property(result, 'difficulty', 'difficulty property expected')
+      assert.property(result, 'chainwork', 'chainwork property expected')
+      assert.property(result, 'nTx', 'nTx property expected')
+      assert.property(
+        result,
+        'previousblockhash',
+        'previousblockhash property expected'
+      )
+      assert.property(
+        result,
+        'nextblockhash',
+        'nextblockhash property expected'
+      )
+    })
+
+    it('should return block info with verbosity 2', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
+      }
+
+      req.body.blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+      req.body.verbosity = 2
+
+      const result = await uut.getBlock(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'hash', 'hash property expected')
+      assert.property(
+        result,
+        'confirmations',
+        'confirmations property expected'
+      )
+      assert.property(result, 'size', 'size property expected')
+      assert.property(result, 'height', 'height property expected')
+      assert.property(result, 'version', 'version property expected')
+      assert.property(result, 'versionHex', 'versionHex property expected')
+      assert.property(result, 'merkleroot', 'merkleroot property expected')
+      assert.property(result, 'tx', 'tx property expected')
+      assert.property(result, 'time', 'time property expected')
+      assert.property(result, 'mediantime', 'mediantime property expected')
+      assert.property(result, 'nonce', 'nonce property expected')
+      assert.property(result, 'bits', 'bits property expected')
+      assert.property(result, 'difficulty', 'difficulty property expected')
+      assert.property(result, 'chainwork', 'chainwork property expected')
+      assert.property(result, 'nTx', 'nTx property expected')
+      assert.property(
+        result,
+        'previousblockhash',
+        'previousblockhash property expected'
+      )
+      assert.property(
+        result,
+        'nextblockhash',
+        'nextblockhash property expected'
+      )
+    })
+
+    it('should return block info without verbosity especified', async () => {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
+      }
+
+      req.body.blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+
+      const result = await uut.getBlock(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'hash', 'hash property expected')
+      assert.property(
+        result,
+        'confirmations',
+        'confirmations property expected'
+      )
+      assert.property(result, 'size', 'size property expected')
+      assert.property(result, 'height', 'height property expected')
+      assert.property(result, 'version', 'version property expected')
+      assert.property(result, 'versionHex', 'versionHex property expected')
+      assert.property(result, 'merkleroot', 'merkleroot property expected')
+      assert.property(result, 'tx', 'tx property expected')
+      assert.property(result, 'time', 'time property expected')
+      assert.property(result, 'mediantime', 'mediantime property expected')
+      assert.property(result, 'nonce', 'nonce property expected')
+      assert.property(result, 'bits', 'bits property expected')
+      assert.property(result, 'difficulty', 'difficulty property expected')
+      assert.property(result, 'chainwork', 'chainwork property expected')
+      assert.property(result, 'nTx', 'nTx property expected')
+      assert.property(
+        result,
+        'previousblockhash',
+        'previousblockhash property expected'
+      )
+      assert.property(
+        result,
+        'nextblockhash',
+        'nextblockhash property expected'
+      )
+    })
+  })
 })

test/v4/mocks/blockchain-mock.js

@@ -285,7 +285,86 @@ const mockAncestors = [
   'e68dad4a7292105cfa84fcaef7f99e5d4f2ece9613ca625d4d2ebf61efa84118',
   'fe94caf5da672be3772d2304a6272eb8bc3d3f5cb4a886f39b7981e1485cf74b'
 ]
-
+const mockBlockInfo = {
+  verbosity0: '20000000',
+  verbosity1: {
+    hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
+    confirmations: 1,
+    size: 3725,
+    strippedsize: 3725,
+    weight: 3725,
+    height: 6725,
+    version: 1,
+    versionHex: '00000000',
+    merkleroot: 'xxxx',
+    tx: [
+      '2afb8264508e2bf3e5288ccad01ed2ab766745b6b9747666b519d59212012c01',
+      '18f40b1ae56bba3fa1934b737fbe46ed8d5ca40fa9aed95073eeb5a119530cd3',
+      '349720d878547752607a69eb19e330592fee271fb5376cdfd811bee423558ed8',
+      '35571c80e7d0e9247b467454ef147d1d5833c775bc2d4164b1bebd4c1f69164f',
+      '480937e8efacdafeeb97d401ff0dd9ea8e8ddb27244cefa67a03621315bdb0e6',
+      '523327469d0b90c0de9a905c2fe6e227278fc5b55b9d9911ca151e1c26647065',
+      '61de4af971d94dbc741762f21dcef08b74b62863a56a1cb3496becdd8d47a858',
+      '69f70a288403b5bba23030ccd05d2e5cb00394620fdae3b050cff9432cc590ce',
+      '94472a90fbdba2eb2cba68308415181faedf3585c66b89efcbdb927a0c10ba23',
+      'bc6f781f9e2f2df460f89995c5e1c7224e48ccbe1aa2a575961f3f5330259864',
+      'f2d945a79bec5454a9ab4d570a150d81124daa308f1c81106a977d6413476944'
+    ],
+    time: 111,
+    mediantime: 111,
+    nonce: 111,
+    bits: '1d00ffff',
+    difficulty: 99.999,
+    chainwork: 'xxxx',
+    nTx: 1,
+    previousblockhash:
+      '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
+    nextblockhash:
+      '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
+  },
+  verbosity2: {
+    hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
+    confirmations: 1,
+    size: 3725,
+    strippedsize: 3725,
+    weight: 3725,
+    height: 6725,
+    version: 1,
+    versionHex: '00000000',
+    merkleroot: 'xxxx',
+    tx: [
+      {
+        hex:
+          '01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000',
+        txid:
+          '0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',
+        hash:
+          '0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',
+        size: 134,
+        version: 1,
+        locktime: 0,
+        vin: [],
+        vout: [],
+        blockhash:
+          '00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048',
+        confirmations: 581882,
+        time: 1231469665,
+        blocktime: 1231469665
+      }
+    ],
+    time: 111,
+    mediantime: 111,
+    nonce: 111,
+    bits: '1d00ffff',
+    difficulty: 99.999,
+    chainwork: 'xxxx',
+    nTx: 1,
+    previousblockhash:
+      '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
+    nextblockhash:
+      '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
+  }
+}
 module.exports = {
   mockBlockHash,
   mockBlockchainInfo,
@@ -296,5 +375,6 @@ module.exports = {
   mockBlockHeader,
   mockTxOut,
   mockTxOutProof,
-  mockAncestors
+  mockAncestors,
+  mockBlockInfo
 }

test/v4/rate-limit-unit.js

@@ -129,7 +129,7 @@ describe('#rate-routelimit', () => {
         'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYxNTE1NzA4NywiZXhwIjoxNjE3NzQ5MDg3fQ.RLNGuYAa-CcLdhTGD27tDeaxT6-GIdeR8T4JWZZLDZA'
 
       const result = uut.decodeJwtToken(jwt)
-      console.log('result: ', result)
+      // console.log('result: ', result)
 
       assert.property(result, 'id')
       // assert.equal(result.id, '123.456.789.10')
@@ -309,10 +309,10 @@ describe('#rate-routelimit', () => {
 
       let val
       for (let i = 0; i < 25; i++) {
-        console.log('req.locals: ', req.locals)
+        // console.log('req.locals: ', req.locals)
         val = await uut.applyRateLimits(req, res, next)
       }
-      console.log('val: ', val)
+      // console.log('val: ', val)
 
       assert.property(val, 'error')
       assert.include(
@@ -446,7 +446,7 @@ describe('#rate-routelimit', () => {
       // Generate a new JWT token for the test.
       const jwtPayload = {
         id: '5dade3f5739e6c0ff034b9a1',
-        pointsToConsume: 10
+        pointsToConsume: 100
       }
       const jwtToken = uut.generateJwtToken(jwtPayload)
 
@@ -460,7 +460,7 @@ describe('#rate-routelimit', () => {
         for (let i = 0; i < 120; i++) {
           val = await uut.applyRateLimits(req, res, next)
         }
-        console.log('val: ', val)
+        // console.log('val: ', val)
 
         assert.property(val, 'error')
         assert.include(
@@ -470,11 +470,12 @@ describe('#rate-routelimit', () => {
 
         assert.equal(
           res.locals.pointsToConsume,
-          10,
+          100,
           'User JWT rate limits applied'
         )
       } catch (err) {
         console.log('err: ', err)
+        assert.fail('Unexpected result')
       }
     })
 

test/v4/raw-transactions.js

@@ -250,6 +250,7 @@ describe('#Raw-Transactions', () => {
         'Proper error message'
       )
     })
+
     it('returns proper error when downstream service stalls', async () => {
       req.body.hexes = [
         '0200000001b9b598d7d6d72fc486b2b3a3c03c79b5bade6ec9a77ced850515ab5e64edcc21010000006b483045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413dffffffff0210270000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac786e9800000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000'

test/v4/route-utils.js

@@ -0,0 +1,34 @@
+/*
+  Unit tests for the route-utils.js library.
+*/
+
+const assert = require('chai').assert
+
+const RouteUtils = require('../../src/util/route-utils.js')
+
+describe('#route-utils', () => {
+  let uut
+
+  beforeEach(() => {
+    uut = new RouteUtils()
+  })
+
+  describe('#decodeError', () => {
+    it('should decode a 429 error from nginx', () => {
+      const err = {
+        error: '<html>\r\n<head><title>429 Too Many Requests</title></head>\r\n<body>\r\n<center><h1>429 Too Many Requests</h1></center>\r\n<hr><center>nginx/1.18.0 (Ubuntu)</center>\r\n</body>\r\n</html>\r\n',
+        level: 'error',
+        message: 'Error in slp.js/hydrateUtxos().',
+        timestamp: '2021-03-31T04:13:36.662Z'
+      }
+
+      const result = uut.decodeError(err)
+      // console.log('result: ', result)
+
+      assert.property(result, 'msg')
+      assert.equal(result.msg, '429 Too Many Requests')
+      assert.property(result, 'status')
+      assert.equal(result.status, 429)
+    })
+  })
+})