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

fix(electrumx.getBalance()): Allowing ecash addresses to pass through

.gitignore

@@ -16,9 +16,21 @@ start-local-testnet.sh
 test-fullstack-main.sh
 start-fullstack-main.sh
 start-fullstack-test.sh
+start-fullstack-testnet.sh
 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
+start-ss-main.sh
+start-decatur-bchn.sh
+shell-scripts/
 
 coverage
 start-my-infra
@@ -30,6 +42,6 @@ logs/*
 docs/*
 docker/mainnet/start-local-mainnet.sh
 docker/testnet/start-local-testnet.sh
-
+start-local-bchn.sh
 
 !logs/README.md

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Chris Troutner
+Copyright (c) 2022 Permissionless Software Foundation developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,65 +1,50 @@
 # bch-api
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/christroutner/bch-api.svg)](https://greenkeeper.io/)
+[![License](https://img.shields.io/npm/l/@psf/bch-js)](https://github.com/Permissionless-Software-Foundation/bch-js/blob/master/LICENSE.md)
+[![js-standard-style](https://img.shields.io/badge/javascript-standard%20code%20style-green.svg?style=flat-square)](https://github.com/feross/standard)
 
-[![Build Status](https://travis-ci.org/christroutner/bch-api.svg?branch=master)](https://travis-ci.org/christroutner/bch-api)
+This is a REST API server, written in node.js JavaScript, using the [Express.js](https://expressjs.com/) framework. The purpose of this code is to create a REST API server that provides a common interface for developers to build blockchain-based business applications. This software works with the Bitcoin Cash (BCH) and eCash (XEC) blockchains.
+- High-level documentation is available on [CashStack.info](https://cashstack.info).
 
-This is a fork and alternative implementation of
-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.
+While developers are encouraged to run and manage their own infrastructure, cloud-based infrastructure is available via [FullStack.cash](https://fullstack.cash). Free and paid tiers are available. You can use this REST API right away with the [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) JavaScript library.
 
-This repository is intended to be paired with [bch-js](https://github.com/christroutner/bch-js),
-an npm JavaScript library, and an alternative implementation
-of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk).
+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. [Code examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples) for common use-cases are available, and the [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is a front end JavaScript library that incorporates bch-js and provides basic wallet functionality.
 
-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).
+![bch-api dependency diagram](./diagrams/bch-api-dependency-graph.png)
 
-- [API Documentation](https://fullstack.cash/documentation)
-- [Example Code](https://fullstack.cash/examples)
+## Documentation
+All the software above is part of the [Cash Stack](https://cashstack.info).
 
-Have questions? Need help? Join our community support
-[Telegram channel](https://t.me/bch_js_toolkit)
+- [CashStack](https://cashstack.info) high-level documentation.
+- [bch-api REST API reference](https://api.fullstack.cash/docs/)
+- [bch-js JavaScript API reference](https://bchjs.fullstack.cash/)
+- [bch-js example code](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
+- [Additional documentation on FullStack.cash](https://fullstack.cash/documentation)
+- [Additional examples on FullStack.cash](https://fullstack.cash/examples)
 
-## Features
-The following features set this repository apart from rest.bitcoin.com:
+Have questions? Need help? Join our community support:
+- [Telegram channel](https://t.me/bch_js_toolkit)
 
-- 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).
-- 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.
+### Configure bch-js
+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:
 
-## 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).
-This is fast enough to try out the examples
-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/
-- Testnet REST API server: https://tapi.fullstack.cash/v3/
+- BCH Mainnet REST API server: https://bchn.fullstack.cash/v5/
+- eCash Mainnet REST API server: https://abc.fullstack.cash/v5/
 - 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 [CashStack.info](https://cashstack.info).
 
-This code targets the Ubuntu 18.04 LTS Linux OS.
+This hardware target for this software is a PC running Ubuntu 18.04 LTS Linux OS or higher.
 
 ### Development
 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:
 
@@ -77,7 +62,7 @@ For a production environment, a Docker container is provided in the
 containers target the Ubuntu 18.04 LTS Linux OS.
 
 - Install Docker and Docker Compose by following the commands on
-[this Dev Ops page](https://troutsblog.com/research/dev-ops/overview).
+[this Dev Ops page](https://bafybeidpuq6pgpryd22wwykhqh2etw44pzofuncm5ldczk5v733tkwk55y.ipfs.dweb.link/docs/dev-ops/overview).
 
 - Customize the [bash script](docker/mainnet/start-local-mainnet.sh) for your
 installation.
@@ -88,11 +73,48 @@ installation.
 
 - Run the Docker container with:
 
-`docker-compose up`
+`docker-compose up -d`
 
-## Support
-Have questions? Need help? Join our community support
-[Telegram channel](https://t.me/bch_js_toolkit)
+## Rate Limits
+Rate limiting of the REST API can be controlled in three different ways:
+ - JWT tokens for individual users
+ - Basic Authentication tokens for organization-wide usage.
+ - Whitelisting for specific domain names
+
+### JWT Tokens
+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://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 (without bch-js), 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}"
+```
+
+### Basic Authentication
+For private installations, Basic Authentication can be used to give everyone in an organization access to higher rate limits, while restricting use by the public. More than one Basic Authentication password can be generated by using the colon `:` to separate entries in the `PRO_PASS` environment variable. See the [bash script](docker/mainnet/start-local-mainnet.sh) for an example.
+
+### Whitelists
+Website domain names can be added to the `WHITELIST_DOMAINS` environment variable. Multiple domains can be separated with a comma `,`. Any web app making a request from that domain will be granted top-level rate limits. See the [bash script](docker/mainnet/start-local-mainnet.sh) for an example.
+
+## Donate
+
+This open source software is developed and maintained by the [Permissionless Software Foundation](https://psfoundation.cash). If this library provides value to you, please consider making a donation to support the PSF developers:
+
+<div align="center">
+<img src="./diagrams/donation-qr.png" />
+<p>bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr</p>
+</div>
+
+
+## Censorship Resistance
+Copies of this repository will occasionally be uploaded and hosted on the Filecoin blockchain, [IPFS](https://ipfs.io), and the [Radicle](https://radicle.xyz) p2p network.
+
+- v1.25.1: [QmXFzFJHenymhReDc9oGAxbpmvK2fJYnisQ2pJn3gGyKKX](https://ipfs.io/ipfs/QmXFzFJHenymhReDc9oGAxbpmvK2fJYnisQ2pJn3gGyKKX)
 
 ## License
-[MIT](LICENSE.md)
+[MIT](./LICENSE.md)

apidoc.json

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

config/index.js

@@ -1,9 +1,32 @@
 /*
   Common configuration settings.
+  Default settings in this file can be overridden by an environment variable.
 */
 
 const config = {
-  apiTokenSecret: process.env.TOKENSECRET ? process.env.TOKENSECRET : 'secret-jwt-token'
+  // This is the same secret used by jwt-bch-api
+  apiTokenSecret: process.env.TOKENSECRET
+    ? process.env.TOKENSECRET
+    : 'secret-jwt-token',
+
+  // Rate Limits
+  anonRateLimit: process.env.ANON_RATE_LIMIT
+    ? Number(process.env.ANON_RATE_LIMIT)
+    : 1000,
+  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,
+  whitelistDomains: process.env.WHITELIST_DOMAINS
+    ? process.env.WHITELIST_DOMAINS.split(',')
+    : ['fullstack.cash', 'psfoundation.cash', '10.0.'],
+
+  restURL: process.env.LOCAL_RESTURL ? process.env.LOCAL_RESTURL : 'http://127.0.0.1:3000/v5/'
 }
 
 module.exports = config

deploy-production.sh

@@ -1,15 +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
-curl -X POST http://fullstack.cash:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
+    #echo $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/Dockerfile

@@ -1,24 +1,54 @@
-FROM christroutner/ct-base-ubuntu
+FROM ubuntu:20.04
 MAINTAINER Chris Troutner <chris.troutner@gmail.com>
 
-RUN apt-get update -y
+#Update the OS and install any OS packages needed.
+RUN apt-get update
+RUN apt-get install -y sudo git curl nano gnupg wget
+
+#Install Node and NPM
+RUN curl -sL https://deb.nodesource.com/setup_14.x -o nodesource_setup.sh
+RUN bash nodesource_setup.sh
+RUN apt-get install -y nodejs build-essential
+
+#Create the user 'safeuser' and add them to the sudo group.
+RUN useradd -ms /bin/bash safeuser
+RUN adduser safeuser sudo
+
+#Set password to 'abcd8765' change value below if you want a different password
+RUN echo safeuser:abcd8765 | chpasswd
+
+#Set the working directory to be the users home directory
+WORKDIR /home/safeuser
+
+#Setup NPM for non-root global install (like on a mac)
+RUN mkdir /home/safeuser/.npm-global
+RUN chown -R safeuser .npm-global
+RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
+RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+
+# Update to the latest version of npm.
+# Working with npm@7.21.1
+RUN npm install -g npm
+
+#FROM christroutner/ct-base-ubuntu
+#MAINTAINER Chris Troutner <chris.troutner@gmail.com>
+
+#RUN apt-get update -y
 
 #Set the working directory to be the home directory
-WORKDIR /home/safeuser
+#WORKDIR /home/safeuser
 
 # Switch to user account.
 USER safeuser
 # Prep 'sudo' commands.
 #RUN echo 'abcd8765' | sudo -S pwd
 
-# Install Redis. TODO: Make this a separate container.
-
-
 # Clone the repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/bch-api
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
 WORKDIR /home/safeuser/bch-api
-RUN npm install
+RUN git checkout ct-unstable
+RUN npm install --silent
 
 # Generate documentation
 RUN npm run docs

docker/mainnet/cleanup-images.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Remove all untagged docker images.
+docker rmi $(docker images | grep "^<none>" | awk '{print $3}')
+

docker/mainnet/docker-compose.yml

@@ -1,19 +1,33 @@
-bch-api-main:
-  build: .
-  dockerfile: Dockerfile
-  #image: bitcore
-  container_name: bch-api-main
-  links:
-    - redis-main
-  ports:
-    - "3000:3000"
-  volumes:
-    - ../../logs:/home/safeuser/bch-api/logs
-  restart: always
+version: '3.9'
 
-redis-main:
-  image: redis:latest
-  container_name: redis-main
-  restart: always
-  ports:
-    - "172.17.0.1:6379:6379"
+services:
+  bch-api-main:
+    build:
+      context: ./
+      dockerfile: Dockerfile
+    #image: bitcore
+    container_name: bch-api-main
+    links:
+      - redis-main
+    ports:
+      - "3000:3000"
+    volumes:
+      - ../../logs:/home/safeuser/bch-api/logs
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    restart: always
+
+  redis-main:
+    image: redis:latest
+    container_name: redis-main
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    restart: always
+    ports:
+      - "172.17.0.1:6379:6379"

docker/mainnet/start-local-mainnet.sh

@@ -1,27 +1,75 @@
 #!/bin/bash
 
-# test
+# Docker containers for the below infrastructure is described here:
+# https://psfoundation.cash/blog/cash-stack
+# Pre-synced databases can be downloaded on the CashStrap page:
+# https://fullstack.cash/cashstrap
+
+# Which network are you using?
+export NETWORK=mainnet
+#export NETWORK=testnet
 
 # Full node
-export RPC_BASEURL=http://172.17.0.1:8332/
+export RPC_IP=172.17.0.1:8332
+export RPC_BASEURL=http://$RPC_IP/
 export RPC_USERNAME=bitcoin
 export RPC_PASSWORD=password
-export NETWORK=mainnet
 
 # SLPDB
+export SLPDB_PASS_GP=somelongpassword
 export SLPDB_URL=http://172.17.0.1:12300/
-export SLPDB_PASS=somelongpassword
+# Use the same address as SLPDB_URL if you don't have a separate whitelist server.
+export SLPDB_PASS_WL=somelongpassword
+export SLPDB_WHITELIST_URL=http://172.17.0.1:12300/
+# slp-api alternative SLP validator using slp-validate:
+# https://github.com/Permissionless-Software-Foundation/slp-api
+export SLP_API_URL=http://10.0.0.5:5001/
 
-# Blockbook Indexer
-export BLOCKBOOK_URL=https://172.17.0.1:9131/
-# Allow node.js to make network calls to https using self-signed certificate.
-export NODE_TLS_REJECT_UNAUTHORIZED=0
+# Mainnet Fulcrum / ElectrumX
+export FULCRUM_URL=172.17.0.1
+export FULCRUM_PORT=50002
+export FULCRUM_API=http://172.17.0.1:3001/v1/
 
-# Redis DB
+# Redis DB - Used for rate limiting
 export REDIS_PORT=6379
 export REDIS_HOST=172.17.0.1
 
 # JWT Token Secret
+# This is used to verify JWT tokens generated with jwt-bch-api:
+# https://github.com/Permissionless-Software-Foundation/jwt-bch-api
 export TOKENSECRET=somelongsecretvalue
 
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v5/
+
+# Basic Authentication password
+export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
+
+# Whitelisted domains. Automatically give pro-tier rate limit access to apps
+# that originate froma domain on the whitelist.
+export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
+
+# Disable rate limits
+export DO_NOT_USE_RATE_LIMITS=1
+
+# Rate Limits. Numbers are divided into 1000. e.g. 1000 / 50 = 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
+
+# Set logging parameters
+#1m means no more than 1 megabyte
+export LOG_MAX_SIZE=1m
+#5d means store no more than 5 days
+export LOG_MAX_FILES=5d
+
+# (Optional) bcash full node
+export BCASH_SERVER=http://localhost:3002/
+
+# psf-slp-indexer
+#export SLP_INDEXER_API=https://psf-slp-indexer.fullstack.cash/
+export SLP_INDEXER_API=http://172.17.0.1:5010/
+
 npm start

docker/testnet/Dockerfile

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

docker/testnet/start-local-testnet.sh

@@ -1,24 +1,61 @@
 #!/bin/bash
 
+# Docker containers for the below infrastructure is described here:
+# https://psfoundation.cash/blog/cash-stack
+# Pre-synced databases can be downloaded on the CashStrap page:
+# https://fullstack.cash/cashstrap
+
+# Which network are you using?
+#export NETWORK=mainnet
+export NETWORK=testnet
+
 # Full node
-export RPC_BASEURL=http://172.17.0.1:18332/
+export RPC_IP=172.17.0.1:18332
+export RPC_BASEURL=http://$RPC_IP/
 export RPC_USERNAME=bitcoin
 export RPC_PASSWORD=password
-export NETWORK=testnet
 
 # SLPDB
 export SLPDB_URL=http://172.17.0.1:13300/
+export SLPDB_PASS=portlandisacityinoregon
+export SLPDB_PASS_GP=portlandisacityinoregon
+export SLPDB_PASS_WL=portlandisacityinoregon
+# Use the same address as SLPDB_URL if you don't have a separate whitelist server.
+export SLPDB_WHITELIST_URL=http://172.17.0.1:13300/
+# slp-api alternative SLP validator using slp-validate:
+# https://github.com/Permissionless-Software-Foundation/slp-api
+export SLP_API_URL=https://slpapi-testnet3.fullstackslp.nl/
 
-# Blockbook Indexer
-export BLOCKBOOK_URL=https://172.17.0.1:19131/
-# Allow node.js to make network calls to https using self-signed certificate.
-export NODE_TLS_REJECT_UNAUTHORIZED=0
+# Mainnet Fulcrum / ElectrumX
+export FULCRUM_URL=172.17.0.1
+export FULCRUM_PORT=60002
+export FULCRUM_API=http://172.17.0.1:3000/v1/
 
 # Redis DB
 export REDIS_PORT=6380
 export REDIS_HOST=172.17.0.1
 
 # JWT Token Secret
-export TOKENSECRET=somelongsecretvalue
+export TOKENSECRET=fridayharbor
+
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v4/
+
+# Basic Authentication password (optional)
+export PRO_PASS=thejaasjhehrakseuhakuhr
+
+# Whitelisted domains. Automatically give pro-tier rate limit access to apps
+# 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.
+# 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=1
+
+export INTERNAL_RATE_LIMIT=100
 
 npm start
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bch-api",
-  "version": "1.16.0",
+  "version": "2.0.0",
   "description": "The REST API powering FullStack.cash",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
@@ -14,37 +14,39 @@
   "scripts": {
     "start": "node ./src/app.js",
     "dev": "nodemon ./dist/app.js",
-    "test": "npm run lint && npm run test-v3",
+    "test": "npm run lint && npm run test-v5",
     "lint": "standard --env mocha --fix",
-    "test-v3": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v3/",
-    "test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/a01-electrumx.js",
-    "test:integration": "mocha test/v3/integration",
-    "test:integration:slpdb": "mocha --timeout 25000 test/v3/integration/slp*.js",
+    "test-v4": "export NETWORK=mainnet && nyc --reporter=text mocha --exit --timeout 60000 test/v4/",
+    "test-v5": "export NETWORK=mainnet && nyc --reporter=text mocha --exit --timeout 60000 test/v5/",
+    "test:integration": "mocha test/v5/integration",
+    "test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v5/integration/slp*.js",
+    "test:integration:nft": "mocha --timeout 25000 -g '#nft' test/v5/integration/nft.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v3/",
-    "docs": "./node_modules/.bin/apidoc -i src/routes/v3 -o docs"
+    "coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v4/",
+    "docs": "./node_modules/.bin/apidoc -i src/routes/v5 -o docs",
+    "test:temp1": "export NETWORK=mainnet && export TEST=integration && mocha -g '#utxosBulk' --exit --timeout 30000 test/v5/",
+    "test:temp2": "export SLP_INDEXER_API=http://fakeurl/api/ && export NETWORK=mainnet && mocha  --exit --timeout 30000 test/v5/psf-slp-indexer"
   },
   "engines": {
     "node": ">=10.15.1"
   },
   "dependencies": {
-    "@chris.troutner/bch-js": "^3.0.1",
-    "apidoc": "^0.23.0",
-    "axios": "^0.19.0",
-    "bitcore-lib-cash": "^8.20.3",
+    "@psf/bch-js": "6.3.4",
+    "apidoc": "^0.26.0",
+    "axios": "^0.21.1",
+    "bitcore-lib-cash": "^8.23.1",
     "body-parser": "^1.18.3",
     "cookie-parser": "~1.4.3",
     "cors": "^2.8.3",
     "debug": "~4.1.1",
     "dotenv": "^8.0.0",
-    "electrum-cash": "^1.0.1",
+    "electrum-cash": "^2.0.2",
     "express": "^4.15.5",
     "express-basic-auth": "^1.1.3",
     "express-rate-limit": "^5.0.0",
     "helmet": "^3.21.2",
     "ioredis": "^4.14.1",
     "jsonwebtoken": "^8.5.1",
-    "level": "^6.0.0",
     "mkdirp": "^1.0.0",
     "mocha": "^7.1.1",
     "morgan": "^1.9.1",
@@ -52,8 +54,6 @@
     "passport": "^0.4.0",
     "passport-anonymous": "^1.0.1",
     "passport-http": "^0.3.0",
-    "pg": "^8.0.0",
-    "pg-hstore": "^2.3.2",
     "rate-limiter-flexible": "^2.0.0",
     "winston": "^3.2.1",
     "winston-daily-rotate-file": "^4.0.0"
@@ -62,23 +62,19 @@
     "bignumber.js": "^9.0.0",
     "chai": "^4.1.2",
     "coveralls": "^3.0.2",
-    "eslint": "5.16.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-config-standard": "^13.0.1",
-    "eslint-plugin-prettier": "^3.1.0",
-    "eslint-plugin-standard": "^4.0.0",
+    "eslint": "7.17.0",
+    "eslint-config-prettier": "7.1.0",
+    "eslint-config-standard": "16.0.2",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "3.3.1",
+    "eslint-plugin-standard": "4.0.0",
     "fs-extra": "^9.0.0",
-    "nock": "^12.0.0",
-    "node-mocks-http": "^1.7.0",
+    "lodash.clonedeep": "^4.5.0",
+    "nock": "^13.0.5",
     "nyc": "^15.0.0",
-    "prettier": "^2.0.0",
-    "proxyquire": "^2.1.0",
-    "request": "^2.88.0",
-    "request-promise": "^4.2.2",
-    "semantic-release": "^17.0.0",
+    "semantic-release": "^17.4.2",
     "sinon": "^9.0.0",
-    "standard": "^14.3.1",
-    "typescript": "^3.1.4"
+    "standard": "^16.0.4"
   },
   "release": {
     "publish": [
@@ -90,6 +86,6 @@
   },
   "apidoc": {
     "title": "bch-api",
-    "url": "https://api.fullstack.cash/v3"
+    "url": "https://api.fullstack.cash/v5"
   }
 }

src/app.js

@@ -3,7 +3,6 @@
 const express = require('express')
 
 // Middleware
-// const { routeRateLimit } = require("./middleware/route-ratelimit")
 const RateLimits = require('./middleware/route-ratelimit')
 const rateLimits = new RateLimits()
 
@@ -25,34 +24,40 @@ const jwtAuth = require('./middleware/jwt-auth')
 // Logging for API requests.
 const logReqInfo = require('./middleware/req-logging')
 
-// v3
-const healthCheckV3 = require('./routes/v3/health-check')
-const BlockchainV3 = require('./routes/v3/full-node/blockchain')
-const ControlV3 = require('./routes/v3/full-node/control')
-const MiningV3 = require('./routes/v3/full-node/mining')
-const networkV3 = require('./routes/v3/full-node/network')
-const RawtransactionsV3 = require('./routes/v3/full-node/rawtransactions')
-const utilV3 = require('./routes/v3/util')
-const SlpV3 = require('./routes/v3/slp')
-const xpubV3 = require('./routes/v3/xpub')
-const BlockbookV3 = require('./routes/v3/blockbook')
-const Ninsight = require('./routes/v3/ninsight')
-const ElectrumXV3 = require('./routes/v3/electrumx')
-const EncryptionV3 = require('./routes/v3/encryption')
+// v5
+const healthCheckV5 = require('./routes/v5/health-check')
+const BlockchainV5 = require('./routes/v5/full-node/blockchain')
+const ControlV5 = require('./routes/v5/full-node/control')
+const MiningV5 = require('./routes/v5/full-node/mining')
+const networkV5 = require('./routes/v5/full-node/network')
+const RawtransactionsV5 = require('./routes/v5/full-node/rawtransactions')
+const DSProofV5 = require('./routes/v5/full-node/dsproof')
+const UtilV5 = require('./routes/v5/util')
+const SlpV5 = require('./routes/v5/slp')
+const xpubV5 = require('./routes/v5/xpub')
+const ElectrumXV5 = require('./routes/v5/electrumx')
+const EncryptionV5 = require('./routes/v5/encryption')
+const PriceV5 = require('./routes/v5/price')
+const JWTV5 = require('./routes/v5/jwt')
+const BcashSLP = require('./routes/v5/bcash/slp')
+const PsfSlpIndexer = require('./routes/v5/psf-slp-indexer')
 
 require('dotenv').config()
 
-// Instantiate route libraries.
-const blockchainV3 = new BlockchainV3()
-const controlV3 = new ControlV3()
-const miningV3 = new MiningV3()
-const rawtransactionsV3 = new RawtransactionsV3()
-const slpV3 = new SlpV3()
-const blockbookV3 = new BlockbookV3()
-const electrumxv3 = new ElectrumXV3()
-electrumxv3.connect()
-const encryptionv3 = new EncryptionV3()
-
+// Instantiate v5 route libraries.
+const blockchainV5 = new BlockchainV5()
+const controlV5 = new ControlV5()
+const miningV5 = new MiningV5()
+const rawtransactionsV5 = new RawtransactionsV5()
+const slpV5 = new SlpV5()
+const electrumxv5 = new ElectrumXV5()
+const encryptionv5 = new EncryptionV5()
+const pricev5 = new PriceV5()
+const utilV5 = new UtilV5({ electrumx: electrumxv5 })
+const dsproofV5 = new DSProofV5()
+const jwtV5 = new JWTV5()
+const bcashSLP = new BcashSLP()
+const psfSlpIndexer = new PsfSlpIndexer()
 const app = express()
 
 app.locals.env = process.env
@@ -69,12 +74,12 @@ app.set('views', path.join(__dirname, 'views'))
 app.set('view engine', 'jade')
 
 // Mount the docs
-app.use('/docs', express.static(`${__dirname}/../docs`))
+app.use('/docs', express.static(`${__dirname.toString()}/../docs`))
 
 // Log each request to the console with IP addresses.
 // app.use(logger("dev"))
 const morganFormat =
-  ':remote-addr :remote-user :method :url :status :response-time ms - :res[content-length] :user-agent'
+':remote-addr :remote-user :method :url :status :response-time ms - :res[content-length] :user-agent'
 app.use(logger(morganFormat))
 
 // Log the same data to the winston logs.
@@ -85,45 +90,69 @@ const logStream = {
 }
 app.use(logger(morganFormat, { stream: logStream }))
 
-app.use(bodyParser.json())
-app.use(bodyParser.urlencoded({ extended: false }))
+app.use(bodyParser.json({ limit: '50mb' }))
+app.use(bodyParser.urlencoded({ extended: false, limit: '50mb' }))
 app.use(cookieParser())
 app.use(express.static(path.join(__dirname, 'public')))
 
 // Log requests for later analysis.
 app.use('/', logReqInfo)
 
-// const v2prefix = "v2"
-const v3prefix = 'v3'
+const v5prefix = 'v5'
 
-// Inspect the header for a JWT token.
-app.use(`/${v3prefix}/`, jwtAuth.getTokenFromHeaders)
-
-// Instantiate the authorization middleware, used to implement pro-tier rate limiting.
-// Handles Anonymous and Basic Authorization schemes used by passport.js
+// START Rate Limits
 const auth = new AuthMW()
-app.use(`/${v3prefix}/`, auth.mw())
 
-// Rate limit on all v3 routes
+// Ensure req.locals and res.locals objects exist.
+app.use(`/${v5prefix}/`, rateLimits.populateLocals)
+
+// Allow users to turn off rate limits with an environment variable.
+const DO_NOT_USE_RATE_LIMITS = process.env.DO_NOT_USE_RATE_LIMITS || false
+
+console.log(`DO_NOT_USE_RATE_LIMITS: ${DO_NOT_USE_RATE_LIMITS}`)
+
+if (!DO_NOT_USE_RATE_LIMITS) {
+  console.log('Rate limits are being used')
+  // Inspect the header for a JWT token.
+  app.use(`/${v5prefix}/`, jwtAuth.getTokenFromHeaders)
+
+  // Instantiate the authorization middleware, used to implement pro-tier rate limiting.
+  // Handles Anonymous and Basic Authorization schemes used by passport.js
+  app.use(`/${v5prefix}/`, auth.mw())
+
+  // Experimental rate limits
+  app.use(`/${v5prefix}/`, rateLimits.applyRateLimits)
+
+// Rate limit on all v4 routes
 // Establish and enforce rate limits.
-// app.use(`/${v3prefix}/`, rateLimits.routeRateLimit)
-app.use(`/${v3prefix}/`, rateLimits.rateLimitByResource)
+// app.use(`/${v4prefix}/`, rateLimits.rateLimitByResource)
+} else {
+  console.log('Rate limits are NOT being used')
+}
+// END Rate Limits
 
-app.use(`/${v3prefix}/` + 'health-check', healthCheckV3)
-app.use(`/${v3prefix}/` + 'blockchain', blockchainV3.router)
-app.use(`/${v3prefix}/` + 'control', controlV3.router)
-app.use(`/${v3prefix}/` + 'mining', miningV3.router)
-app.use(`/${v3prefix}/` + 'network', networkV3)
-app.use(`/${v3prefix}/` + 'rawtransactions', rawtransactionsV3.router)
-app.use(`/${v3prefix}/` + 'util', utilV3.router)
-app.use(`/${v3prefix}/` + 'slp', slpV3.router)
-app.use(`/${v3prefix}/` + 'xpub', xpubV3.router)
-app.use(`/${v3prefix}/` + 'blockbook', blockbookV3.router)
-app.use(`/${v3prefix}/` + 'electrumx', electrumxv3.router)
-app.use(`/${v3prefix}/` + 'encryption', encryptionv3.router)
+// Connect v5 routes
+app.use(`/${v5prefix}/` + 'health-check', healthCheckV5)
+app.use(`/${v5prefix}/` + 'blockchain', blockchainV5.router)
+app.use(`/${v5prefix}/` + 'control', controlV5.router)
+app.use(`/${v5prefix}/` + 'mining', miningV5.router)
+app.use(`/${v5prefix}/` + 'network', networkV5)
+app.use(`/${v5prefix}/` + 'rawtransactions', rawtransactionsV5.router)
+app.use(`/${v5prefix}/` + 'slp', slpV5.router)
+app.use(`/${v5prefix}/` + 'xpub', xpubV5.router)
+app.use(`/${v5prefix}/` + 'electrumx', electrumxv5.router)
+app.use(`/${v5prefix}/` + 'encryption', encryptionv5.router)
+app.use(`/${v5prefix}/` + 'price', pricev5.router)
+app.use(`/${v5prefix}/` + 'util', utilV5.router)
+app.use(`/${v5prefix}/` + 'dsproof', dsproofV5.router)
+app.use(`/${v5prefix}/` + 'jwt', jwtV5.router)
 
-const ninsight = new Ninsight()
-app.use(`/${v3prefix}/` + 'ninsight', ninsight.router)
+app.use(`/${v5prefix}/` + 'bcash/slp', bcashSLP.router)
+
+app.use(`/${v5prefix}/` + 'psf/slp', psfSlpIndexer.router)
+
+// Daniel:
+// app.use(`/${v5prefix}/` + 'psfslp', psfSlp.router)
 
 // catch 404 and forward to error handler
 app.use((req, res, next) => {
@@ -171,9 +200,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.
@@ -228,4 +259,4 @@ function onListening () {
   debug(`Listening on ${bind}`)
 }
 //
-// module.exports = app;
+// module.exports = app

src/middleware/auth.js

@@ -1,22 +1,25 @@
 /*
-  CT 2/4/20 Note: This library handles anonymous and Basic auth. This library
-  can be phased out with the chage to JWT tokens and the new rate-limit library.
-
-  Handle authorization for bypassing rate limits.
+  This library handles anonymous and Basic Authentication.
 
   1) Default is 'Anonymous Authentication', which unlocks the freemimum tier by
   default.
+
   2) Hard-coded 'Basic Authentication' is a token that does not expire and is
-  provided to buisiness partners.
+  provided for clients who run their own isolated infrastructure without rate
+  limits, but still need a way from preventing the random public from using
+  their API.
+
   3) JWT-based 'Local Authentication' is used for normal users that pay to
   access the premium pro-tier services.
 
   This file uses the passport npm library to check the header of each REST API
-  call for the prescence of a Basic authorization header:
+  call for the prescence of a Basic Authentication header:
   https://en.wikipedia.org/wiki/Basic_access_authentication
 
   If the header is found and validated, the req.locals.proLimit Boolean value
-  is set and passed to the route-ratelimits.ts middleware.
+  is set and passed to the route-ratelimit.js middleware. route-ratelimit.js
+  is for fine-grain JWT-based rate limits. If req.locals.proLimit is set to
+  true, then those rate limits will be skipped.
 */
 
 'use strict'
@@ -33,7 +36,9 @@ 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(':')
 
@@ -47,6 +52,8 @@ 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(
       new BasicStrategy({ passReqToCallback: true }, function (
@@ -72,8 +79,9 @@ class AuthMW {
         req.locals.proLimit = false
 
         // Evaluate the username and password and set the rate limit accordingly.
-        // if (username === "BITBOX" && password === PRO_PASS) {
-        if (username === 'BITBOX') {
+        if (username === 'fullstackcash') {
+          // Can set several different passwords in the environment variable.
+          // Loop through each one to see if one matches.
           for (let i = 0; i < PRO_PASS.length; i++) {
             const thisPass = PRO_PASS[i]
 
@@ -82,6 +90,7 @@ class AuthMW {
 
               // Success
               req.locals.proLimit = true
+              console.log(`User ${req.ip} authenticated using Basic Auth`)
               break
             }
           }
@@ -96,6 +105,7 @@ class AuthMW {
 
   // Middleware called by the route.
   mw () {
+    console.log('Initializing passport')
     return passport.authenticate(['basic', 'anonymous'], {
       session: false
     })

src/middleware/jwt-auth.js

@@ -12,6 +12,8 @@
 // req.locals.jwtToken property.
 const getTokenFromHeaders = (req, res, next) => {
   try {
+    // console.log('req.headers: ', req.headers)
+
     // Only executes if the authorization header exists.
     if (req.headers.authorization) {
       // Retrieve the auth string from the header object.

src/middleware/req-logging.js

@@ -40,7 +40,7 @@ const logReqInfo = function (req, res, next) {
       body: req.body
     }
 
-    wlogger.verbose(`Request: ${ip} ${method} ${url}`, dataToLog)
+    wlogger.info(`Request: ${ip} ${method} ${url}`, dataToLog)
 
     next()
   } catch (err) {

src/middleware/route-ratelimit.js

@@ -1,30 +1,64 @@
-'use strict'
+/*
+Sets the rate limits for the anonymous and paid tiers. Current rate limits:
+- 10000 points in 60 seconds
+- 500 points per call for anonymous tier (20 RPM)
+- 100 points per call for tier 40 (100 RPM)
+- 40 points per call for tier 50 (250 RPM)
+- 16 points per call for tier 60 (625 RPM)
 
+The rate limit handling is designed for these four use cases:
+- Users who want to buy a JWT token for 24 hour access.
+- Users who want to buy different RPM tiers: 100, 250, 600
+- Basic Authentication which should not have any rate limits applied.
+- Local installations that do not want any authentication or rate limits at all.
+
+The Basic Auth use cases is considered when determining internal rate limits.
+The internal rate limits should not be applied to calls from those users.
+
+A lot of attention has been paid to passing rate-limit information for the user
+when they trigger an endpoint that makes a lot of internal API calls. Examples
+are hydrateUtxos() and getPublicKey(). These keeps things fair by charging the
+same for 'light' API calls and 'heavy' API calls.
+
+TODO:
+- Add code for applying rate limits to whitelist domains.
+*/
+
+// Public npm libraries.
+const jwt = require('jsonwebtoken')
+const Redis = require('ioredis')
+const { RateLimiterRedis } = require('rate-limiter-flexible')
+
+// local libraries.
 const wlogger = require('../util/winston-logging')
 const config = require('../../config')
 
-const jwt = require('jsonwebtoken')
+// The amount of delay in milliseconds to add to anonymous requests, in order
+// to slow down freeloaders that are hitting the system too hard.
+const ANON_DELAY = 3000
 
-// Redis
+let _this // Global pointer to instance of class, when 'this' context is lost.
+
+// Setup Redis to track rate limits for each user.
 const redisOptions = {
   enableOfflineQueue: false,
   port: process.env.REDIS_PORT ? process.env.REDIS_PORT : 6379,
   host: process.env.REDIS_HOST ? process.env.REDIS_HOST : '127.0.0.1'
 }
-console.log(`redisOptions: ${JSON.stringify(redisOptions, null, 2)}`)
-
-const Redis = require('ioredis')
 const redisClient = new Redis(redisOptions)
-
-// Rate limiter middleware lib.
-const { RateLimiterRedis } = require('rate-limiter-flexible')
 const rateLimitOptions = {
   storeClient: redisClient,
-  points: 100, // Number of points
+  points: config.pointsPerMinute, // Number of points
   duration: 60 // Per minute (per 60 seconds)
 }
 
-let _this
+// Constants
+const ANON_LIMITS = config.anonRateLimit
+// const WHITELIST_RATE_LIMIT = config.whitelistRateLimit
+const WHITELIST_DOMAINS = config.whitelistDomains
+const WHITELIST_POINTS_TO_CONSUME = config.whitelistRateLimit
+const POINTS_PER_MINUTE = config.pointsPerMinute
+const INTERNAL_POINTS_TO_CONSUME = config.internalRateLimit
 
 class RateLimits {
   constructor () {
@@ -35,25 +69,388 @@ class RateLimits {
     this.config = config
   }
 
+  // This is the main middleware funciton of this library. All other functions
+  // support this function.
+  async applyRateLimits (req, res, next) {
+    try {
+      // Exit if the user has already authenticated with Basic Authentication.
+      if (req.locals.proLimit) {
+        console.log('External call, basic auth, skipping rate limits.')
+        wlogger.debug(
+          'req.locals.proLimit = true; Using Basic Authentication instead of rate limits'
+        )
+        return next()
+      }
+
+      // Determine if the call is an external or internal API call.
+      const isInternal = _this.checkInternalIp(req)
+      // console.log(`isInternal: ${isInternal}`)
+
+      // Determine if the call originates from another computer on the intranet.
+      const isWhitelistOrigin = _this.isInWhitelist(req)
+      // console.log('isWhitelistOrigin: ', isWhitelistOrigin)
+
+      // Handle the use case of internally-generated requests.
+      if (isInternal) {
+        // Internal API calls should pass the authentication data in through the
+        // 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.')
+
+            // 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.'
+            // )
+
+            // Determine if user has exceeded their rate limits. Pass in the
+            // JWT token if one exists.
+            const hasExceededRateLimit = await _this.trackRateLimits(
+              req,
+              res,
+              req.body.usrObj.jwtToken
+            )
+
+            if (!hasExceededRateLimit) {
+              // Rate limits have not been exceeded. Processing can continue.
+              return next()
+            } else {
+              // trackRateLimits() returns the 'res' object with an error message
+              // and status code.
+              return hasExceededRateLimit
+            }
+          }
+        } else {
+          // This should be a corner case. Calls should not be going into this
+          // code path, so the system should throw up big warning signs when they
+          // do.
+          // This code path happens when an internal call is made but does not
+          // pass the usrObj. Legacy code needs to be refactored to use the usrObj
+          // 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 defaultPayload = {
+            id: '98.76.54.32',
+            email: 'internal@bchtest.net',
+            apiLevel: 40,
+            rateLimit: 100,
+            pointsToConsume: INTERNAL_POINTS_TO_CONSUME,
+            duration: 30
+          }
+
+          // Default values, in case there is an error.
+          const defaultJwt = _this.generateJwtToken(defaultPayload)
+
+          // Track the rate limit for this user. Pass in the JWT token, if one
+          // is available.
+          const hasExceededRateLimit = await _this.trackRateLimits(
+            req,
+            res,
+            defaultJwt
+          )
+          // console.log(`hasExceededRateLimit: `, hasExceededRateLimit)
+
+          if (!hasExceededRateLimit) {
+            // Rate limits have not been exceeded. Processing can continue.
+            return next()
+          } else {
+            // trackRateLimits() returns the 'res' object with an error message
+            // and status code.
+            return hasExceededRateLimit
+          }
+        }
+        //
+        //
+      } else {
+        // Handle the normal use-case of external requests
+        // 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.
+        if (isWhitelistOrigin) {
+          const defaultPayload = {
+            id: '77.77.77.77',
+            email: 'whitelist@bchtest.net',
+            apiLevel: 40,
+            rateLimit: 100,
+            pointsToConsume: WHITELIST_POINTS_TO_CONSUME,
+            duration: 30
+          }
+
+          // Inject the high-RPM JWT token into the call.
+          req.locals.jwtToken = _this.generateJwtToken(defaultPayload)
+        }
+
+        // Track the rate limit for this user. Pass in the JWT token, if one
+        // is available.
+        const hasExceededRateLimit = await _this.trackRateLimits(
+          req,
+          res,
+          req.locals.jwtToken
+        )
+        // console.log('hasExceededRateLimit: ', hasExceededRateLimit)
+
+        if (!hasExceededRateLimit) {
+          // Rate limits have not been exceeded. Processing can continue.
+          return next()
+        } else {
+          // trackRateLimits() returns the 'res' object with an error message
+          // and status code.
+          return hasExceededRateLimit
+        }
+      }
+    } catch (err) {
+      wlogger.error('Error in route-ratelimit2.js/applyRateLimits(): ', err)
+    }
+
+    // By default, move to the next middleware.
+    next()
+  }
+
+  sleep (ms) {
+    return new Promise(resolve => setTimeout(resolve, ms))
+  }
+
+  // A wrapper for Redis-based rate limiter.
+  // Will return false if the user has not exceeded the rate limit. Otherwise
+  // it will return the 'res' object with an error status and message, which
+  // should be returned by the middleware.
+  async trackRateLimits (req, res, jwtToken) {
+    const debugInfo = {
+      jwtToken,
+      userObj: req.body.usrObj,
+      locals: req.locals
+    }
+
+    // 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.
+    debugInfo.ip = req.ip
+
+    // console.log('jwtToken: ', jwtToken)
+
+    try {
+      // Decode the JWT token if it exists
+      if (jwtToken) {
+        const decoded = _this.decodeJwtToken(jwtToken)
+        // console.log(`decoded: ${JSON.stringify(decoded, null, 2)}`)
+
+        // Preferentially use the decoded ID in the JWT payload, as the key.
+        key = decoded.id
+        debugInfo.id = key
+
+        pointsToConsume = decoded.pointsToConsume
+        debugInfo.pointsToConsume = pointsToConsume
+      }
+      // 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)
+
+      // Add data to logs for analytics.
+      const logData = {
+        ip: req.ip,
+        key,
+        pointsToConsume,
+        status: 'OK'
+      }
+      wlogger.info(logData)
+
+      res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
+
+      // Add artificial delay to slow down freeloaders.
+      if (pointsToConsume === ANON_LIMITS) {
+        await this.sleep(ANON_DELAY)
+      }
+
+      // Signal that the user has not exceeded their rate limits.
+      return false
+    } catch (err) {
+      // console.log('err: ', err)
+
+      const rateLimit = Math.floor(POINTS_PER_MINUTE / pointsToConsume)
+
+      res.locals.rateLimitTriggered = true
+      // console.log('res.locals: ', res.locals)
+
+      // console.log(
+      //   `rate limit debug info: ${JSON.stringify(debugInfo, null, 2)}`
+      // )
+
+      // Add data to logs for analytics.
+      const logData = {
+        ip: req.ip,
+        key,
+        pointsToConsume,
+        status: 429
+      }
+      wlogger.info(logData)
+
+      // Add artificial delay to slow down freeloaders.
+      if (pointsToConsume === ANON_LIMITS) {
+        await this.sleep(ANON_DELAY)
+      }
+
+      // 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`
+      })
+    }
+  }
+
+  // Attempts to decode a JWT token. Returns default values if it fails.
+  decodeJwtToken (jwtToken) {
+    const defaultPayload = {
+      id: '123.456.789.10',
+      email: 'test@bchtest.net',
+      apiLevel: 10,
+      rateLimit: 3,
+      pointsToConsume: ANON_LIMITS,
+      duration: 30
+    }
+
+    try {
+      // Default values, in case there is an error.
+      const defaultJwt = _this.generateJwtToken(defaultPayload)
+
+      // Generate a default payload to use, if the decoding of the user-provided
+      // jwt fails.
+      let decoded = _this.jwt.verify(defaultJwt, _this.config.apiTokenSecret)
+
+      try {
+        decoded = _this.jwt.verify(jwtToken, _this.config.apiTokenSecret)
+      } catch (err) {
+        wlogger.error('Error in route-ratelimit2.js/decodeJwtTokens(): ', err)
+      }
+
+      return decoded
+    } catch (err) {
+      wlogger.error(
+        'Unhandled error in route-ratelimit2.js/deocdeJwtToken: ',
+        err
+      )
+
+      // Making sure there is an exp property. Not sure if this will cause an
+      // issue, using a hard-coded value.
+      defaultPayload.exp = 1574269450
+
+      return defaultPayload
+    }
+  }
+
+  // Returns a boolean if the origin of the request matches a domain in the
+  // whitelist.
+  isInWhitelist (req) {
+    try {
+      const retVal = false // Default value.
+
+      // Retrieve the origin.
+      const origin = req.get('origin')
+
+      if (!process.env.TEST) console.log('origin:', origin)
+
+      // If the origin is not determinable, return false.
+      if (!origin) return false
+
+      // console.log(`WHITELIST_DOMAINS: ${JSON.stringify(WHITELIST_DOMAINS, null, 2)}`)
+
+      for (let i = 0; i < WHITELIST_DOMAINS.length; i++) {
+        const thisDomain = WHITELIST_DOMAINS[i]
+
+        if (origin.includes(thisDomain)) return true
+      }
+
+      return retVal
+    } catch (err) {
+      wlogger.error(
+        'Error in route-ratelimit.js/isInWhitelist(). Returning false by default.'
+      )
+      return false
+    }
+  }
+
+  // Checks the request object to see if it's IP address matches an internal
+  // IP address. That means the call is an internal API call and should be
+  // treated differently than an external API call.
+  checkInternalIp (req) {
+    try {
+      // Default value
+      let isInternal = false
+
+      const ip = req.ip
+
+      if (ip.includes('127.0.0.1')) isInternal = true
+
+      if (ip.includes('172.17.')) isInternal = true
+
+      // TODO: Add 192.168.
+
+      return isInternal
+    } catch (err) {
+      wlogger.error(
+        'Error in checkInternalIp(). Returning false be default. Err: ',
+        err
+      )
+      return false
+    }
+  }
+
   // Used to disconnect from the Redis DB.
   // Called by unit tests so that node.js thread doesn't live forever.
   closeRedis () {
     redisClient.disconnect()
   }
 
+  // Clear the redis database. Used by unit tests.
   async wipeRedis () {
     await redisClient.flushdb()
   }
 
-  // This is the new rate limit function that uses the rate-limiter-flexible npm
-  // library. It uses fine-grain rate limiting based on the resources being
-  // consumed.
-  async rateLimitByResource (req, res, next) {
+  // Generates a JWT token for testing purposes. This is not used in production.
+  // This function mirrors the kind of JWT token that would be generated by
+  // jwt-bch-api.
+  generateJwtToken (payload) {
     try {
-      let userId
-      let decoded = {}
+      const jwtOptions = {
+        expiresIn: '30 days'
+      }
 
-      // Create a req.locals object if not passed in.
+      const token = _this.jwt.sign(
+        payload,
+        _this.config.apiTokenSecret,
+        jwtOptions
+      )
+
+      return token
+    } catch (err) {
+      console.error('Error in generateJwtToken()')
+      throw err
+    }
+  }
+
+  // Called when rate limits are not used.
+  populateLocals (req, res, next) {
+    try {
+      // Create a re*Q*.locals object if not passed in.
+      // req.locals.proLimit will be true if the user is using Basic Authentication.
       if (!req.locals) {
         req.locals = {
           // default values
@@ -63,165 +460,16 @@ class RateLimits {
         }
       }
 
-      // Create a res.locals object if it does not exist. This is used for
-      // debugging.
+      // Create a re*S*.locals object if it does not exist.
       if (!res.locals) {
         res.locals = {
           rateLimitTriggered: false
         }
       }
 
-      // Decode the JWT token if one exists.
-      if (req.locals.jwtToken) {
-        try {
-          decoded = _this.jwt.verify(
-            req.locals.jwtToken,
-            _this.config.apiTokenSecret
-          )
-          // console.log(`decoded: ${JSON.stringify(decoded, null, 2)}`)
-
-          userId = decoded.id
-        } catch (err) {
-          // This handler will be triggered if the JWT token does not match the
-          // token secret.
-          wlogger.error(
-            `Last three letters of token secret: ${_this.config.apiTokenSecret.slice(
-              -3
-            )}`
-          )
-          wlogger.error(
-            'Error trying to decode JWT token in route-ratelimit.js/newRateLimit(): ',
-            err
-          )
-        }
-      } else {
-        wlogger.debug('No JWT token found!')
-      }
-
-      // Used for displaying error message. Default value is 3.
-      let rateLimit = 3
-
-      // Code here for the rate limiter is adapted from this example:
-      // https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#authorized-and-not-authorized-users
-      try {
-        // The resource being consumed: full node, indexer, SLPDB, etc.
-        const resource = _this.getResource(req.url)
-        wlogger.debug(`resource: ${resource}`)
-
-        let key = userId || req.ip
-        res.locals.key = key // Feedback for tests.
-
-        // const pointsToConsume = userId ? 1 : 30
-        decoded.resource = resource
-        let pointsToConsume = _this.calcPoints(decoded)
-        res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
-
-        // If the request originates from one of the approved wallet apps, then
-        // apply paid-access rate limits.
-        const origin = req.get('origin')
-        if (
-          origin &&
-          (origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
-            origin.toString().indexOf('sandbox.fullstack.cash') > -1)
-        ) {
-          pointsToConsume = 1
-          res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
-        }
-
-        wlogger.info(
-          `User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
-        )
-
-        rateLimit = Math.floor(100 / 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`
-        })
-      }
+      next()
     } catch (err) {
-      wlogger.error('Error in route-ratelimit.js/newRateLimit(): ', err)
-      // throw err
-    }
-
-    next()
-  }
-
-  // Calculates the points consumed, based on the jwt information and the route
-  // requested.
-  calcPoints (jwtInfo) {
-    let retVal = 30 // By default, use anonymous tier.
-
-    try {
-      // console.log(`jwtInfo: ${JSON.stringify(jwtInfo, null, 2)}`)
-
-      const apiLevel = jwtInfo.apiLevel
-      const resource = jwtInfo.resource
-
-      const level30Routes = ['insight', 'bitcore', 'blockbook', 'electrumx']
-      const level40Routes = ['slp']
-
-      wlogger.debug(`apiLevel: ${apiLevel}`)
-
-      // Only evaluate if user is using a JWT token.
-      if (jwtInfo.id) {
-        // SLP indexer routes
-        if (level40Routes.includes(resource)) {
-          if (apiLevel >= 40) retVal = 1
-          // else if (apiLevel >= 10) retVal = 10
-          else retVal = 10
-
-          // Normal indexer routes
-        } else if (level30Routes.includes(resource)) {
-          if (apiLevel >= 30) retVal = 1
-          else retVal = 10
-
-          // Full node tier
-        } else if (apiLevel >= 20) {
-          retVal = 1
-
-          // Free tier, full node only.
-        } else {
-          retVal = 10
-        }
-      }
-
-      return retVal
-    } catch (err) {
-      wlogger.error('Error in route-ratelimit.js/calcPoints()')
-      // throw err
-      retVal = 30
-    }
-
-    return retVal
-  }
-
-  // This function parses the req.url property to identify what resource
-  // the user is requesting.
-  // This was created as a function so that it can be unit tested. Not sure
-  // what kind of variations will be seen in production.
-  getResource (url) {
-    try {
-      wlogger.debug(`url: ${JSON.stringify(url, null, 2)}`)
-
-      const splitUrl = url.split('/')
-      const resource = splitUrl[1]
-
-      return resource
-    } catch (err) {
-      wlogger.error('Error in getResource().')
+      console.error('Error in populateLocals(): ', err)
       throw err
     }
   }

src/routes/v3/blockbook.js

@@ -1,591 +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('@chris.troutner/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
-    }
-  }
-
-  /**
-   * @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
-
-      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)
-    }
-  }
-
-  /**
-   * @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 {
-      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(429) // 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
-    }
-  }
-
-  /**
-   * @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 {
-      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)
-    }
-  }
-
-  /**
-   * @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 {
-      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(429) // 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
-    }
-  }
-
-  /**
-   * @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 {
-      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)
-    }
-  }
-
-  /**
-   * @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 {
-      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(429) // 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/v3/electrumx.js

@@ -1,930 +0,0 @@
-/*
-  Electrum API route
-*/
-
-'use strict'
-
-const express = require('express')
-const router = express.Router()
-const axios = require('axios')
-const util = require('util')
-const bitcore = require('bitcore-lib-cash')
-
-const ElectrumCash = require('electrum-cash').Client
-// const ElectrumCash = require('/home/trout/work/personal/electrum-cash/electrum.js').Client // eslint-disable-line
-
-const wlogger = require('../../util/winston-logging')
-const config = require('../../../config')
-
-const RouteUtils = require('../../util/route-utils')
-const routeUtils = new RouteUtils()
-
-const BCHJS = require('@chris.troutner/bch-js')
-const bchjs = new BCHJS()
-
-let _this
-
-class Electrum {
-  constructor () {
-    _this = this
-
-    _this.config = config
-    _this.axios = axios
-    _this.routeUtils = routeUtils
-    _this.bchjs = bchjs
-    _this.bitcore = bitcore
-
-    _this.electrumx = new ElectrumCash(
-      'bch-api',
-      '1.4.1',
-      process.env.FULCRUM_URL,
-      process.env.FULCRUM_PORT
-      // '192.168.0.6',
-      // '50002'
-    )
-
-    _this.isReady = false
-    // _this.connectToServers()
-
-    _this.router = router
-    _this.router.get('/', _this.root)
-    _this.router.get('/utxos/:address', _this.getUtxos)
-    _this.router.post('/utxos', _this.utxosBulk)
-    _this.router.get('/balance/:address', _this.getBalance)
-    _this.router.post('/balance', _this.balanceBulk)
-    _this.router.get('/transactions/:address', _this.getTransactions)
-    _this.router.post('/transactions', _this.transactionsBulk)
-    _this.router.get('/unconfirmed/:address', _this.getMempool)
-    _this.router.post('/unconfirmed', _this.mempoolBulk)
-  }
-
-  // Initializes a connection to electrum servers.
-  async connect () {
-    try {
-      console.log('Attempting to connect to ElectrumX server...')
-
-      // console.log('_this.electrumx: ', _this.electrumx)
-
-      // Return immediately if a connection has already been established.
-      if (_this.isReady) return true
-
-      // Connect to the server.
-      await _this.electrumx.connect()
-
-      // Set the connection flag.
-      _this.isReady = true
-
-      console.log('...Successfully connected to ElectrumX server.')
-
-      // console.log(`_this.isReady: ${_this.isReady}`)
-      return _this.isReady
-    } catch (err) {
-      console.log('err: ', err)
-      wlogger.error('Error in electrumx.js/connect(): ', err)
-      // throw err
-    }
-  }
-
-  // Disconnect from the ElectrumX server.
-  async disconnect () {
-    try {
-      // Return immediately if the isReady flag is false.
-      if (!_this.isReady) return true
-
-      // Disconnect from the server.
-      await _this.electrumx.disconnect()
-
-      // Clear the isReady flag.
-      _this.isReady = false
-
-      // Return true to signal that the disconnection happened successfully.
-      return true
-    } catch (err) {
-      // console.log(`err: `, err)
-      wlogger.error('Error in electrumx.js/disconnect()')
-      throw err
-    }
-  }
-
-  // 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 })
-    }
-
-    // Handle error patterns specific to this route.
-    if (err.message) {
-      res.status(400)
-      return res.json({ success: false, error: err.message })
-    }
-
-    // If error can be handled, return the stack trace
-    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: 'electrumx' })
-  }
-
-  // Returns a promise that resolves to UTXO data for an address. Expects input
-  // to be a cash address, and input validation to have already been done by
-  // parent, calling function.
-  async _utxosFromElectrumx (address) {
-    try {
-      // Convert the address to a scripthash.
-      const scripthash = _this.addressToScripthash(address)
-
-      if (!_this.isReady) {
-        throw new Error(
-          'ElectrumX server connection is not ready. Call await connectToServer() first.'
-        )
-      }
-
-      // Query the utxos from the ElectrumX server.
-      const electrumResponse = await _this.electrumx.request(
-        'blockchain.scripthash.listunspent',
-        scripthash
-      )
-      // console.log(
-      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
-      // )
-
-      return electrumResponse
-    } catch (err) {
-      // console.log('err: ', err)
-
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/_utxosFromElectrumx(): ', err)
-      throw err
-    }
-  }
-
-  /**
-   * @api {get} /electrumx/utxos/{addr} Get utxos for a single address.
-   * @apiName UTXOs for a single address
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an object with UTXOs associated with an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/electrumx/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
-   *
-   */
-  // GET handler for single balance
-  async getUtxos (req, res, next) {
-    try {
-      const address = req.params.address
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      const cashAddr = _this.bchjs.Address.toCashAddress(address)
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx/getUtxos with this address: ',
-        cashAddr
-      )
-
-      // Get data from ElectrumX server.
-      const electrumResponse = await _this._utxosFromElectrumx(cashAddr)
-      // console.log(`_utxosFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
-
-      // Pass the error message if ElectrumX reports an error.
-      if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
-        res.status(400)
-        return res.json({
-          success: false,
-          message: electrumResponse.message
-        })
-      }
-
-      res.status(200)
-      return res.json({
-        success: true,
-        utxos: electrumResponse
-      })
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/getUtxos().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  /**
-   * @api {post} /electrumx/utxo Get utxos for an array of addresses.
-   * @apiName  UTXOs for an array of addresses
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an array of objects with UTXOs associated with an address.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/electrumx/utxos" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
-   *
-   *
-   */
-  // POST handler for bulk queries on address details
-  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(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx.js/utxoBulk 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}`)
-        const utxos = await _this._utxosFromElectrumx(address)
-
-        return {
-          utxos,
-          address
-        }
-      })
-
-      // Wait for all parallel Insight requests to return.
-      const result = await Promise.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json({
-        success: true,
-        utxos: result
-      })
-    } catch (err) {
-      wlogger.error('Error in electrumx.js/utxoBulk().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Returns a promise that resolves to a balance for an address. Expects input
-  // to be a cash address, and input validation to have already been done by
-  // parent, calling function.
-  async _balanceFromElectrumx (address) {
-    try {
-      // Convert the address to a scripthash.
-      const scripthash = _this.addressToScripthash(address)
-
-      if (!_this.isReady) {
-        throw new Error(
-          'ElectrumX server connection is not ready. Call await connectToServer() first.'
-        )
-      }
-
-      // Query the address balance from the ElectrumX server.
-      const electrumResponse = await _this.electrumx.request(
-        'blockchain.scripthash.get_balance',
-        scripthash
-      )
-      // console.log(
-      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
-      // )
-
-      return electrumResponse
-    } catch (err) {
-      // console.log('err1: ', err)
-
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/_utxosFromElectrumx(): ', err)
-      throw err
-    }
-  }
-
-  /**
-   * @api {get} /electrumx/balance/{addr} Get balance for a single address.
-   * @apiName Balance for a single address
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an object with confirmed and unconfirmed balance associated with an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
-   *
-   */
-  // GET handler for single balance
-  async getBalance (req, res, next) {
-    try {
-      const address = req.params.address
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      // Ensure the address is in cash address format.
-      const cashAddr = _this.bchjs.Address.toCashAddress(address)
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx/getBalance with this address: ',
-        cashAddr
-      )
-
-      // Get data from ElectrumX server.
-      const electrumResponse = await _this._balanceFromElectrumx(cashAddr)
-      // console.log(`_utxosFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
-
-      // Pass the error message if ElectrumX reports an error.
-      if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
-        res.status(400)
-        return res.json({
-          success: false,
-          message: electrumResponse.message
-        })
-      }
-
-      res.status(200)
-      return res.json({
-        success: true,
-        balance: electrumResponse
-      })
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/getBalance().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  /**
-   * @api {post} /electrumx/balance Get balances for an array of addresses.
-   * @apiName  Balances for an array of addresses
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an array of balanes associated with an array of address.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/electrumx/balance" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
-   *
-   *
-   */
-  // POST handler for bulk queries on address balance
-  async balanceBulk (req, res, next) {
-    try {
-      let addresses = req.body.addresses
-
-      // 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(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx.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
-      // ElectrumX API in parallel.
-      addresses = addresses.map(async (address, index) => {
-        // console.log(`address: ${address}`)
-        const balance = await _this._balanceFromElectrumx(address)
-
-        return {
-          balance,
-          address
-        }
-      })
-
-      // Wait for all parallel Insight requests to return.
-      const result = await Promise.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json({
-        success: true,
-        balances: result
-      })
-    } catch (err) {
-      wlogger.error('Error in electrumx.js/balanceBulk().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Returns a promise that resolves an array of transaction history for an
-  // address. Expects input to be a cash address, and input validation to have
-  // already been done by parent, calling function.
-  async _transactionsFromElectrumx (address) {
-    try {
-      // Convert the address to a scripthash.
-      const scripthash = _this.addressToScripthash(address)
-
-      if (!_this.isReady) {
-        throw new Error(
-          'ElectrumX server connection is not ready. Call await connectToServer() first.'
-        )
-      }
-
-      // Query the address transaction history from the ElectrumX server.
-      const electrumResponse = await _this.electrumx.request(
-        'blockchain.scripthash.get_history',
-        scripthash
-      )
-      // console.log(
-      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
-      // )
-
-      return electrumResponse
-    } catch (err) {
-      // console.log('err1: ', err)
-
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/_transactionsFromElectrumx(): ', err)
-      throw err
-    }
-  }
-
-  /**
-   * @api {get} /electrumx/transactions/{addr} Get transaction history for a single address.
-   * @apiName Transaction history for a single address
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an array of historical transactions associated with an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/electrumx/transactions/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
-   *
-   */
-  // GET handler for single balance
-  async getTransactions (req, res, next) {
-    try {
-      const address = req.params.address
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      // Ensure the address is in cash address format.
-      const cashAddr = _this.bchjs.Address.toCashAddress(address)
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx/getTransactions with this address: ',
-        cashAddr
-      )
-
-      // Get data from ElectrumX server.
-      const electrumResponse = await _this._transactionsFromElectrumx(cashAddr)
-      // console.log(`_utxosFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
-
-      // Pass the error message if ElectrumX reports an error.
-      if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
-        res.status(400)
-        return res.json({
-          success: false,
-          message: electrumResponse.message
-        })
-      }
-
-      res.status(200)
-      return res.json({
-        success: true,
-        transactions: electrumResponse
-      })
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/getTransactions().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  /**
-   * @api {post} /electrumx/transactions Get the transaction history for an array of addresses.
-   * @apiName  Transactions for an array of addresses
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an array of transactions associated with an array of address.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/electrumx/transactions" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
-   *
-   *
-   */
-  // POST handler for bulk queries on transaction histories for addresses.
-  async transactionsBulk (req, res, next) {
-    try {
-      let addresses = req.body.addresses
-
-      // 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(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx.js/transactionsBulk 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
-      // ElectrumX API in parallel.
-      addresses = addresses.map(async (address, index) => {
-        // console.log(`address: ${address}`)
-        const transactions = await _this._transactionsFromElectrumx(address)
-
-        return {
-          transactions,
-          address
-        }
-      })
-
-      // Wait for all parallel Insight requests to return.
-      const result = await Promise.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json({
-        success: true,
-        transactions: result
-      })
-    } catch (err) {
-      wlogger.error('Error in electrumx.js/transactionsBulk().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Returns a promise that resolves to unconfirmed UTXO data (mempool) for an address.
-  // Expects input to be a cash address, and input validation to have
-  // already been done by parent, calling function.
-  async _mempoolFromElectrumx (address) {
-    try {
-      // Convert the address to a scripthash.
-      const scripthash = _this.addressToScripthash(address)
-
-      if (!_this.isReady) {
-        throw new Error(
-          'ElectrumX server connection is not ready. Call await connectToServer() first.'
-        )
-      }
-
-      // Query the unconfirmed utxos from the ElectrumX server.
-      const electrumResponse = await _this.electrumx.request(
-        'blockchain.scripthash.get_mempool',
-        scripthash
-      )
-      // console.log(
-      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
-      // )
-
-      return electrumResponse
-    } catch (err) {
-      // console.log('err: ', err)
-
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/_mempoolFromElectrumx(): ', err)
-      throw err
-    }
-  }
-
-  /**
-   * @api {get} /electrumx/unconfirmed/{addr} Get unconfirmed utxos for a single address.
-   * @apiName Unconfirmed UTXOs for a single address
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an object with unconfirmed UTXOs associated with an address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/electrumx/unconfirmed/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
-   *
-   */
-  // GET handler for single balance
-  async getMempool (req, res, next) {
-    try {
-      const address = req.params.address
-
-      // Reject if address is an array.
-      if (Array.isArray(address)) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error: 'address can not be an array. Use POST for bulk upload.'
-        })
-      }
-
-      // Ensure the address is in cash address format.
-      const cashAddr = _this.bchjs.Address.toCashAddress(address)
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          success: false,
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx/getMempool with this address: ',
-        cashAddr
-      )
-
-      // Get data from ElectrumX server.
-      const electrumResponse = await _this._mempoolFromElectrumx(cashAddr)
-      // console.log(`_mempoolFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
-
-      // Pass the error message if ElectrumX reports an error.
-      if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
-        res.status(400)
-        return res.json({
-          success: false,
-          message: electrumResponse.message
-        })
-      }
-
-      res.status(200)
-      return res.json({
-        success: true,
-        utxos: electrumResponse
-      })
-    } catch (err) {
-      // Write out error to error log.
-      wlogger.error('Error in elecrumx.js/getMempool().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  /**
-   * @api {post} /electrumx/unconfirmed Get unconfirmed utxos for an array of addresses.
-   * @apiName  Unconfirmed UTXOs for an array of addresses
-   * @apiGroup ElectrumX / Fulcrum
-   * @apiDescription Returns an array of objects with unconfirmed UTXOs associated with an address.
-   * Limited to 20 items per request.
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/electrumx/unconfirmed" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
-   *
-   *
-   */
-  // POST handler for bulk queries on address details
-  async mempoolBulk (req, res, next) {
-    try {
-      let addresses = req.body.addresses
-
-      // 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(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      wlogger.debug(
-        'Executing electrumx.js/mempoolBulk 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}`)
-        const utxos = await _this._mempoolFromElectrumx(address)
-
-        return {
-          utxos,
-          address
-        }
-      })
-
-      // Wait for all parallel Insight requests to return.
-      const result = await Promise.all(addresses)
-
-      // Return the array of retrieved address information.
-      res.status(200)
-      return res.json({
-        success: true,
-        utxos: result
-      })
-    } catch (err) {
-      wlogger.error('Error in electrumx.js/mempoolBulk().', err)
-
-      return _this.errorHandler(err, res)
-    }
-  }
-
-  // Convert a 'bitcoincash:...' address to a script hash used by ElectrumX.
-  addressToScripthash (addrStr) {
-    try {
-      // console.log(`addrStr: ${addrStr}`)
-
-      const address = _this.bitcore.Address.fromString(addrStr)
-      // console.log(`address: ${address}`)
-
-      const script = _this.bitcore.Script.buildPublicKeyHashOut(address)
-      // console.log(`script: ${script}`)
-
-      const scripthash = _this.bitcore.crypto.Hash.sha256(script.toBuffer())
-        .reverse()
-        .toString('hex')
-      // console.log(`scripthash: ${scripthash}`)
-
-      return scripthash
-    } catch (err) {
-      wlogger.error('Error in electrumx.js/addressToScripthash()')
-      throw err
-    }
-  }
-}
-
-module.exports = Electrum

src/routes/v3/ninsight.js

@@ -1,32 +0,0 @@
-/*
-  A library for interacting with the Bitcoin.com ninsight (not Insight) indexer.
-*/
-
-'use strict'
-
-const express = require('express')
-// const axios = require('axios')
-// const routeUtils = require('./route-utils')
-// const wlogger = require('../../util/winston-logging')
-
-const router = express.Router()
-
-// const BCHJS = require('@chris.troutner/bch-js')
-// const bchjs = new BCHJS()
-
-// let _this
-
-class Ninsight {
-  constructor () {
-    // _this = this
-
-    this.router = router
-    this.router.get('/', this.root)
-  }
-
-  root (req, res, next) {
-    return res.json({ status: 'ninsight' })
-  }
-}
-
-module.exports = Ninsight

src/routes/v3/route-utils.js

@@ -1,183 +0,0 @@
-/*
-  A private library of utility functions used by several different routes.
-*/
-
-'use strict'
-
-const axios = require('axios')
-const wlogger = require('../../util/winston-logging')
-
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-const BCHJS = require('@chris.troutner/bch-js')
-const bchjs = new BCHJS()
-
-module.exports = {
-  validateNetwork, // Prevents a common user error
-  setEnvVars, // Allows RPC variables to be set dynamically based on changing env vars.
-  decodeError, // Extract and interpret error messages.
-  validateArraySize, // Ensure the passed array meets rate limiting requirements.
-  getAxiosOptions
-}
-
-// This function expects the Request Express.js object and an array as input.
-// The array is then validated against freemium and pro-tier rate limiting
-// requirements. A boolean is returned to indicate if the array size if valid
-// or not.
-function validateArraySize (req, array) {
-  const FREEMIUM_INPUT_SIZE = 20
-  const PRO_INPUT_SIZE = 20
-
-  if (req.locals && req.locals.proLimit) {
-    if (array.length <= PRO_INPUT_SIZE) return true
-  } else if (array.length <= FREEMIUM_INPUT_SIZE) {
-    return true
-  }
-
-  return false
-}
-
-// Returns true if user-provided cash address matches the correct network,
-// mainnet or testnet. If NETWORK env var is not defined, it returns false.
-// This prevent a common user-error issue that is easy to make: passing a
-// testnet address into rest.bitcoin.com or passing a mainnet address into
-// trest.bitcoin.com.
-function validateNetwork (addr) {
-  try {
-    const network = process.env.NETWORK
-
-    // Return false if NETWORK is not defined.
-    if (!network || network === '') {
-      console.log('Warning: NETWORK environment variable is not defined!')
-      return false
-    }
-
-    // Convert the user-provided address to a cashaddress, for easy detection
-    // of the intended network.
-    const cashAddr = bchjs.Address.toCashAddress(addr)
-
-    // Return true if the network and address both match testnet
-    const addrIsTest = bchjs.Address.isTestnetAddress(cashAddr)
-    if (network === 'testnet' && addrIsTest) return true
-
-    // Return true if the network and address both match mainnet
-    const addrIsMain = bchjs.Address.isMainnetAddress(cashAddr)
-    if (network === 'mainnet' && addrIsMain) return true
-
-    return false
-  } catch (err) {
-    wlogger.error('Error in validateNetwork()')
-    return false
-  }
-}
-
-// Dynamically set these based on env vars. Allows unit testing.
-function setEnvVars () {
-  const BitboxHTTP = axios.create({
-    baseURL: process.env.RPC_BASEURL,
-    timeout: 15000
-  })
-  const username = process.env.RPC_USERNAME
-  const password = process.env.RPC_PASSWORD
-
-  const requestConfig = {
-    method: 'post',
-    auth: {
-      username: username,
-      password: password
-    },
-    data: {
-      jsonrpc: '1.0'
-    }
-  }
-
-  return { BitboxHTTP, username, password, requestConfig }
-}
-
-// Axios options used when calling axios.post() to talk with a full node.
-function getAxiosOptions () {
-  return {
-    method: 'post',
-    baseURL: process.env.RPC_BASEURL,
-    timeout: 15000,
-    auth: {
-      username: process.env.RPC_USERNAME,
-      password: process.env.RPC_PASSWORD
-    },
-    data: {
-      jsonrpc: '1.0'
-    }
-  }
-}
-
-// Error messages returned by a full node can be burried pretty deep inside the
-// error object returned by Axios. This function attempts to extract and interpret
-// error messages.
-// Returns an object. If successful, obj.msg is a string.
-// If there is a failure, obj.msg is false.
-function decodeError (err) {
-  try {
-    // Attempt to extract the full node error message.
-    if (
-      err.response &&
-      err.response.data &&
-      err.response.data.error &&
-      err.response.data.error.message
-    ) {
-      return { msg: err.response.data.error.message, status: 400 }
-    }
-
-    // Attempt to extract the Insight error message
-    if (err.response && err.response.data) {
-      return { msg: err.response.data, status: err.response.status }
-    }
-
-    // console.log(`err.message: ${err.message}`)
-    // console.log(`err: `, err)
-
-    // Attempt to detect a network connection error.
-    if (err.message && err.message.indexOf('ENOTFOUND') > -1) {
-      return {
-        msg:
-          'Network error: Could not communicate with full node or other external service.',
-        status: 503
-      }
-    }
-
-    // Different kind of network error
-    if (err.message && err.message.indexOf('ENETUNREACH') > -1) {
-      return {
-        msg:
-          'Network error: Could not communicate with full node or other external service.',
-        status: 503
-      }
-    }
-
-    // Different kind of network error
-    if (err.message && err.message.indexOf('EAI_AGAIN') > -1) {
-      return {
-        msg:
-          'Network error: Could not communicate with full node or other external service.',
-        status: 503
-      }
-    }
-
-    // Axios timeout (aborted) error, or service is down (connection refused).
-    if (
-      err.code &&
-      (err.code === 'ECONNABORTED' || err.code === 'ECONNREFUSED')
-    ) {
-      return {
-        msg:
-          'Network error: Could not communicate with full node or other external service.',
-        status: 503
-      }
-    }
-
-    return { msg: false, status: 500 }
-  } catch (err) {
-    wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
-    return { msg: false, status: 500 }
-  }
-}

src/routes/v3/services/slpdb.js

@@ -1,351 +0,0 @@
-const axios = require('axios')
-
-const SLPSDK = require('@chris.troutner/bch-js')
-const SLP = new SLPSDK()
-
-class Slpdb {
-  // Gets transaction history for all tokens for an address. Can also specify
-  // block height, but defaults to 0.
-  async getHistoricalSlpTransactions (addressList, fromBlock = 0) {
-    // Build SLPDB or query from addressList
-    const orQueryArray = []
-    for (const address of addressList) {
-      const cashAddress = SLP.SLP.Address.toCashAddress(address)
-      const slpAddress = SLP.SLP.Address.toSLPAddress(address)
-
-      const cashQuery = {
-        'in.e.a': cashAddress.slice(12)
-      }
-      const slpQuery = {
-        'slp.detail.outputs.address': slpAddress
-      }
-
-      orQueryArray.push(cashQuery)
-      orQueryArray.push(slpQuery)
-    }
-
-    const query = {
-      v: 3,
-      q: {
-        find: {
-          db: ['c', 'u'],
-          $query: {
-            $or: orQueryArray,
-            'slp.valid': true,
-            'blk.i': {
-              $not: {
-                $lte: fromBlock
-              }
-            }
-          },
-          $orderby: {
-            'blk.i': -1
-          }
-        },
-        project: {
-          _id: 0,
-          'tx.h': 1,
-          'in.i': 1,
-          'in.e': 1,
-          'out.e': 1,
-          'out.a': 1,
-          'slp.detail': 1,
-          blk: 1
-        },
-        limit: 500
-      }
-    }
-
-    const result = await this.runQuery(query)
-    // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
-
-    let transactions = []
-
-    // Add confirmed transactions
-    if (result.data && result.data.c) {
-      transactions = transactions.concat(result.data.c)
-    }
-
-    // Add unconfirmed transactions
-    if (result.data && result.data.u) {
-      transactions = transactions.concat(result.data.u)
-    }
-
-    return transactions
-  }
-
-  async getTokenStats (tokenId) {
-    const [
-      totalMinted,
-      totalBurned,
-      tokenDetails,
-      circulatingSupply
-    ] = await Promise.all([
-      this.getTotalMinted(tokenId),
-      this.getTotalBurned(tokenId),
-      this.getTokenDetails(tokenId),
-      this.getTotalCirculating(tokenId)
-    ])
-
-    tokenDetails.totalMinted = tokenDetails.initialTokenQty + totalMinted
-    tokenDetails.totalBurned = totalBurned
-
-    // tokenDetails.circulatingSupply =
-    //   tokenDetails.totalMinted - tokenDetails.totalBurned
-    tokenDetails.circulatingSupply = circulatingSupply
-
-    return tokenDetails
-  }
-
-  generateCredentials () {
-    // Generate the Basic Authentication header for a private instance of SLPDB.
-    const SLPDB_PASS = process.env.SLPDB_PASS
-      ? process.env.SLPDB_PASS
-      : 'BITBOX'
-    const username = 'BITBOX'
-    const password = SLPDB_PASS
-    const combined = `${username}:${password}`
-    var base64Credential = Buffer.from(combined).toString('base64')
-    var readyCredential = `Basic ${base64Credential}`
-
-    const options = {
-      headers: {
-        authorization: readyCredential,
-        timeout: 30000
-      }
-    }
-
-    return options
-  }
-
-  async runQuery (query) {
-    const queryString = JSON.stringify(query)
-    const queryBase64 = Buffer.from(queryString).toString('base64')
-    const url = `${process.env.SLPDB_URL}q/${queryBase64}`
-
-    const options = this.generateCredentials()
-
-    const response = await axios.get(url, options)
-    return response
-  }
-
-  async getTotalMinted (tokenId) {
-    const query = {
-      v: 3,
-      q: {
-        db: ['g'],
-        aggregate: [
-          {
-            $match: {
-              'tokenDetails.tokenIdHex': tokenId,
-              'graphTxn.outputs.status': {
-                $in: [
-                  'BATON_SPENT_IN_MINT',
-                  'BATON_UNSPENT',
-                  'BATON_SPENT_NOT_IN_MINT'
-                ]
-              }
-            }
-          },
-          {
-            $unwind: '$graphTxn.outputs'
-          },
-          {
-            $group: {
-              _id: null,
-              count: {
-                $sum: '$graphTxn.outputs.slpAmount'
-              }
-            }
-          }
-        ],
-        limit: 1
-      }
-    }
-
-    const result = await this.runQuery(query)
-
-    if (!result.data.g.length) {
-      return 0
-    }
-
-    return parseFloat(result.data.g[0].count)
-  }
-
-  async getTotalCirculating (tokenId) {
-    const query = {
-      v: 3,
-      q: {
-        db: ['g'],
-        aggregate: [
-          {
-            $match: {
-              'tokenDetails.tokenIdHex': tokenId,
-              'graphTxn.outputs': {
-                $elemMatch: {
-                  status: 'UNSPENT',
-                  slpAmount: { $gte: 0 }
-                }
-              }
-            }
-          },
-          { $unwind: '$graphTxn.outputs' },
-          {
-            $match: {
-              'graphTxn.outputs.status': 'UNSPENT',
-              'graphTxn.outputs.slpAmount': { $gte: 0 }
-            }
-          },
-          {
-            $group: {
-              _id: null,
-              circulating_supply: {
-                $sum: '$graphTxn.outputs.slpAmount'
-              }
-            }
-          }
-        ],
-        limit: 100000
-      }
-    }
-
-    const result = await this.runQuery(query)
-    // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
-
-    if (!result.data.g.length) {
-      return 0
-    }
-
-    return parseFloat(result.data.g[0].circulating_supply)
-  }
-
-  async getTotalBurned (tokenId) {
-    const query = {
-      v: 3,
-      q: {
-        db: ['g'],
-        aggregate: [
-          {
-            $match: {
-              'tokenDetails.tokenIdHex': tokenId,
-              'graphTxn.outputs.status': {
-                $in: [
-                  'SPENT_NON_SLP',
-                  'BATON_SPENT_INVALID_SLP',
-                  'SPENT_INVALID_SLP',
-                  'BATON_SPENT_NON_SLP',
-                  'MISSING_BCH_VOUT',
-                  'BATON_MISSING_BCH_VOUT',
-                  'BATON_SPENT_NOT_IN_MINT',
-                  'EXCESS_INPUT_BURNED'
-                ]
-              }
-            }
-          },
-          {
-            $unwind: '$graphTxn.outputs'
-          },
-          {
-            $match: {
-              'graphTxn.outputs.status': {
-                $in: [
-                  'SPENT_NON_SLP',
-                  'BATON_SPENT_INVALID_SLP',
-                  'SPENT_INVALID_SLP',
-                  'BATON_SPENT_NON_SLP',
-                  'MISSING_BCH_VOUT',
-                  'BATON_MISSING_BCH_VOUT',
-                  'BATON_SPENT_NOT_IN_MINT',
-                  'EXCESS_INPUT_BURNED'
-                ]
-              }
-            }
-          },
-          {
-            $group: {
-              _id: null,
-              count: {
-                $sum: '$graphTxn.outputs.slpAmount'
-              }
-            }
-          }
-        ],
-        limit: 1
-      }
-    }
-
-    const result = await this.runQuery(query)
-
-    if (!result.data.g.length) {
-      return 0
-    }
-
-    return parseFloat(result.data.g[0].count)
-  }
-
-  async getTokenDetails (tokenId) {
-    const query = {
-      v: 3,
-      q: {
-        db: ['t'],
-        find: {
-          $query: {
-            'tokenDetails.tokenIdHex': tokenId
-          }
-        },
-        project: { tokenDetails: 1, tokenStats: 1, _id: 0 },
-        limit: 1
-      }
-    }
-
-    const result = await this.runQuery(query)
-
-    if (!result.data.t.length) {
-      throw new Error('Token could not be found')
-    }
-
-    const token = this.formatTokenOutput(result.data.t[0])
-
-    return token
-  }
-
-  formatTokenOutput (token) {
-    // console.log(`token: ${JSON.stringify(token, null, 2)}`)
-
-    token.tokenDetails.id = token.tokenDetails.tokenIdHex
-    delete token.tokenDetails.tokenIdHex
-    token.tokenDetails.documentHash = token.tokenDetails.documentSha256Hex
-    delete token.tokenDetails.documentSha256Hex
-    token.tokenDetails.initialTokenQty = parseFloat(
-      token.tokenDetails.genesisOrMintQuantity
-    )
-    delete token.tokenDetails.genesisOrMintQuantity
-    delete token.tokenDetails.transactionType
-    delete token.tokenDetails.batonVout
-    delete token.tokenDetails.sendOutputs
-
-    token.tokenDetails.blockCreated = token.tokenStats.block_created
-    token.tokenDetails.blockLastActiveSend =
-      token.tokenStats.block_last_active_send
-    token.tokenDetails.blockLastActiveMint =
-      token.tokenStats.block_last_active_mint
-    token.tokenDetails.txnsSinceGenesis =
-      token.tokenStats.qty_valid_txns_since_genesis
-    token.tokenDetails.validAddresses =
-      token.tokenStats.qty_valid_token_addresses
-    token.tokenDetails.mintingBatonStatus =
-      token.tokenStats.minting_baton_status
-
-    delete token.tokenStats.block_last_active_send
-    delete token.tokenStats.block_last_active_mint
-    delete token.tokenStats.qty_valid_txns_since_genesis
-    delete token.tokenStats.qty_valid_token_addresses
-
-    token.tokenDetails.timestampUnix = token.tokenDetails.timestamp_unix
-    delete token.tokenDetails.timestamp_unix
-
-    return token.tokenDetails
-  }
-}
-
-module.exports = Slpdb

src/routes/v3/util.js

@@ -1,604 +0,0 @@
-'use strict'
-
-const express = require('express')
-const router = express.Router()
-const axios = require('axios')
-
-const routeUtils = require('./route-utils')
-const wlogger = require('../../util/winston-logging')
-const Blockbook = require('./blockbook')
-const blockbook = new Blockbook()
-
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-const BCHJS = require('@chris.troutner/bch-js')
-const bchjs = new BCHJS()
-// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v3/'
-
-// const bchjsHTTP = axios.create({
-//   baseURL: process.env.RPC_BASEURL
-// })
-
-// const username = process.env.RPC_USERNAME
-// const password = process.env.RPC_PASSWORD
-
-// const requestConfig = {
-//   method: 'post',
-//   auth: {
-//     username: username,
-//     password: password
-//   },
-//   data: {
-//     jsonrpc: '1.0'
-//   }
-// }
-
-let _this
-
-class UtilRoute {
-  constructor () {
-    this.bchjs = bchjs
-    this.blockbook = blockbook
-
-    _this = this
-  }
-
-  root (req, res, next) {
-    return res.json({ status: 'util' })
-  }
-
-  /**
-   * @api {get} /util/validateAddress/{address}  Get information about single bitcoin cash address.
-   * @apiName Information about single bitcoin cash address
-   * @apiGroup Util
-   * @apiDescription Returns information about single bitcoin cash address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/util/validateAddress/bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c" -H "accept: application/json"
-   *
-   *
-   */
-  async validateAddressSingle (req, res, next) {
-    try {
-      const address = req.params.address
-      if (!address || address === '') {
-        res.status(400)
-        return res.json({ error: 'address can not be empty' })
-      }
-
-      const {
-        BitboxHTTP,
-        // username,
-        // password,
-        requestConfig
-      } = routeUtils.setEnvVars()
-
-      requestConfig.data.id = 'validateaddress'
-      requestConfig.data.method = 'validateaddress'
-      requestConfig.data.params = [address]
-
-      const response = await BitboxHTTP(requestConfig)
-
-      return res.json(response.data.result)
-    } catch (err) {
-      // Attempt to decode the error message.
-      const { msg, status } = routeUtils.decodeError(err)
-      if (msg) {
-        res.status(status)
-        return res.json({ error: msg })
-      }
-
-      wlogger.error('Error in util.ts/validateAddressSingle().', err)
-
-      res.status(500)
-      return res.json({ error: util.inspect(err) })
-    }
-  }
-
-  /**
-   * @api {post} /util/validateAddress  Get information about bulk bitcoin cash addresses..
-   * @apiName Information about bulk bitcoin cash addresses.
-   * @apiGroup Util
-   * @apiDescription Returns information about bulk bitcoin cash addresses..
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"]}'
-   * curl -X POST "https://api.fullstack.cash/v3/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"],"from": 1, "to": 5}'
-   *
-   *
-   */
-  async validateAddressBulk (req, res, next) {
-    try {
-      const addresses = req.body.addresses
-
-      // 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 (!routeUtils.validateArraySize(req, addresses)) {
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
-        return res.json({
-          error: 'Array too large.'
-        })
-      }
-
-      // Validate each element in the array.
-      for (let i = 0; i < addresses.length; i++) {
-        const address = addresses[i]
-
-        // Ensure the input is a valid BCH address.
-        try {
-          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 = 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.'
-          })
-        }
-      }
-
-      wlogger.debug('Executing util/validate with these addresses: ', addresses)
-
-      const {
-        BitboxHTTP,
-        // username,
-        // password,
-        requestConfig
-      } = routeUtils.setEnvVars()
-
-      // Loop through each address and creates an array of requests to call in parallel
-      const promises = addresses.map(async address => {
-        requestConfig.data.id = 'validateaddress'
-        requestConfig.data.method = 'validateaddress'
-        requestConfig.data.params = [address]
-
-        return BitboxHTTP(requestConfig)
-      })
-
-      // Wait for all parallel Insight requests to return.
-      const axiosResult = await axios.all(promises)
-
-      // Retrieve the data part of the result.
-      const result = axiosResult.map(x => x.data.result)
-
-      res.status(200)
-      return res.json(result)
-    } catch (err) {
-      // Attempt to decode the error message.
-      const { msg, status } = routeUtils.decodeError(err)
-      if (msg) {
-        res.status(status)
-        return res.json({ error: msg })
-      }
-
-      wlogger.error('Error in util.ts/validateAddressSingle().', err)
-
-      res.status(500)
-      return res.json({ error: util.inspect(err) })
-    }
-  }
-
-  /**
-   * @api {post} /util/sweep  Sweep BCH and tokens
-   * @apiName Sweep BCH and tokens from a paper wallet
-   * @apiGroup Util
-   * @apiDescription This function can be used to check the BCH balance of a
-   * paper wallet. It can also be used to sweep BCH and tokens from a paper
-   * wallet and send them to a destination address.
-   *
-   * Note: It does not yet support multiple token classes on the same paper wallet.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "balanceOnly": true}'
-   * curl -X POST "https://api.fullstack.cash/v3/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "toAddr": "bitcoincash:qpt8m4kqu963geedyrur6pdggqmv5kxwnq0rn322qu"}'
-   *
-   *
-   */
-
-  async sweepWif (req, res, next) {
-    try {
-      // Validate input
-      const wif = req.body.wif
-      const toAddr = req.body.toAddr
-      const balanceOnly = req.body.balanceOnly
-
-      if (typeof wif !== 'string' || wif.length !== 52) {
-        res.status(400)
-        return res.json({
-          error: 'WIF needs to a proper compressed WIF starting with K or L'
-        })
-      }
-
-      if (!balanceOnly) {
-        // Only throw error if balanceOnly is false or undefined.
-        if (!toAddr || toAddr === '') {
-          res.status(400)
-          return res.json({ error: 'address can not be empty' })
-        }
-      }
-
-      wlogger.debug('Executing util/sweepWif with this address: ', toAddr)
-
-      // Generate a private and public key pair from the WIF.
-      const ecPair = bchjs.ECPair.fromWIF(wif)
-      const fromAddr = bchjs.ECPair.toCashAddress(ecPair)
-
-      // Get a balance on the public address
-      const balances = await _this.blockbook.balanceFromBlockbook(fromAddr)
-      // console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
-
-      // Total balance is the sum of the confirmed and unconfirmed balance.
-      const totalBalance =
-        Number(balances.balance) + Number(balances.unconfirmedBalance)
-
-      // Exit if balance is zero.
-      if (isNaN(totalBalance) || totalBalance === 0) {
-        res.status(422)
-        return res.json({ error: 'No balance found at BCH address.' })
-      }
-
-      // Exit if this is a balance-only call.
-      if (balanceOnly) {
-        res.status(200)
-        return res.json(totalBalance)
-      }
-
-      // Get all UTXOs help by the address.
-      const utxos = await _this.blockbook.utxosFromBlockbook(fromAddr)
-      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-      const tokenUtxos = []
-      const bchUtxos = []
-
-      // Exit if there are no UTXOs.
-      if (utxos.length === 0) {
-        res.status(422)
-        return res.json({ error: 'No utxos found.' })
-      }
-
-      // Figure out which UTXOs are associated with SLP tokens.
-      const isTokenUtxo = await _this.bchjs.SLP.Utils.tokenUtxoDetails(utxos)
-      // console.log(`isTokenUtxo: ${JSON.stringify(isTokenUtxo, null, 2)}`)
-
-      // Separate the bch and token UTXOs.
-      for (let i = 0; i < utxos.length; i++) {
-        // Filter based on isTokenUtxo.
-        if (!isTokenUtxo[i]) bchUtxos.push(utxos[i])
-        else tokenUtxos.push(isTokenUtxo[i])
-      }
-      // console.log(
-      //   `bchUtxos.length: ${bchUtxos.length}, tokenUtxos.length: ${tokenUtxos.length}`
-      // )
-
-      // Throw error if no BCH to move tokens.
-      if (bchUtxos.length === 0 && tokenUtxos.length > 0) {
-        res.status(422)
-        return res.json({
-          error:
-            'Tokens found, but no BCH UTXOs found. Add BCH to wallet to move tokens.'
-        })
-      }
-
-      // console.log(`tokenUtxos: ${JSON.stringify(tokenUtxos, null, 2)}`)
-
-      const options = {
-        ecPair,
-        utxos,
-        fromAddr,
-        toAddr,
-        bchUtxos,
-        tokenUtxos
-      }
-
-      let hex
-
-      // Choose the sweeping algorithm, based on if there are tokens or not.
-      if (tokenUtxos.length === 0) hex = await _this._sweepBCH(options)
-      else hex = await _this._sweepTokens(options, bchUtxos, tokenUtxos)
-      // console.log(`hex: ${hex}`)
-
-      // Throw error if there is more than one token class.
-
-      // Generate a transaction to move tokens and BCH.
-
-      // Broadcast the transaction.
-      const txid = _this.bchjs.RawTransactions.sendRawTransaction([hex])
-
-      res.status(200)
-      return res.json(txid)
-    } catch (err) {
-      // Attempt to decode the error message.
-      const { msg, status } = routeUtils.decodeError(err)
-      if (msg) {
-        res.status(status)
-        return res.json({ error: msg })
-      }
-
-      // Catch the specific case of multiple tokens.
-      if (
-        err.message &&
-        err.message.indexOf('Multiple token classes detected') > -1
-      ) {
-        res.status(422)
-        return res.json({ error: err.message })
-      }
-
-      wlogger.error('Error in util.js/sweepWif().', err)
-      console.error('Error in util.js/sweepWif().', err)
-
-      res.status(500)
-      return res.json({ error: err.message })
-    }
-  }
-
-  // Sweep BCH only from a private WIF.
-  async _sweepBCH (options) {
-    try {
-      // const wif = flags.wif
-      // const toAddr = flags.address
-
-      const ecPair = options.ecPair
-      const toAddr = options.toAddr
-
-      // const fromAddr = this.BITBOX.ECPair.toCashAddress(ecPair)
-      //
-      // // Get the UTXOs for that address.
-      // let utxos = await this.BITBOX.Blockbook.utxo(fromAddr)
-      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-      let utxos = options.utxos
-
-      // Ensure all utxos have the satoshis property.
-      utxos = utxos.map(x => {
-        x.satoshis = Number(x.value)
-        return x
-      })
-      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-      // instance of transaction builder
-      let transactionBuilder
-      if (options.testnet) {
-        transactionBuilder = new _this.bchjs.TransactionBuilder('testnet')
-      } else transactionBuilder = new _this.bchjs.TransactionBuilder()
-
-      let originalAmount = 0
-
-      // Loop through all UTXOs.
-      for (let i = 0; i < utxos.length; i++) {
-        const utxo = utxos[i]
-
-        originalAmount = originalAmount + utxo.satoshis
-
-        transactionBuilder.addInput(utxo.txid, utxo.vout)
-      }
-
-      if (originalAmount < 546) {
-        throw new Error(
-          'Original amount less than the dust limit. Not enough BCH to send.'
-        )
-      }
-
-      // get byte count to calculate fee. paying 1 sat/byte
-      const byteCount = _this.bchjs.BitcoinCash.getByteCount(
-        { P2PKH: utxos.length },
-        { P2PKH: 1 }
-      )
-      const fee = Math.ceil(1.1 * byteCount)
-
-      // amount to send to receiver. It's the original amount - 1 sat/byte for tx size
-      const sendAmount = originalAmount - fee
-
-      // add output w/ address and amount to send
-      transactionBuilder.addOutput(
-        _this.bchjs.Address.toLegacyAddress(toAddr),
-        sendAmount
-      )
-
-      // Loop through each input and sign
-      let redeemScript
-      for (var i = 0; i < utxos.length; i++) {
-        const utxo = utxos[i]
-
-        transactionBuilder.sign(
-          i,
-          ecPair,
-          redeemScript,
-          transactionBuilder.hashTypes.SIGHASH_ALL,
-          utxo.satoshis
-        )
-      }
-
-      // build tx
-      const tx = transactionBuilder.build()
-
-      // output rawhex
-      const hex = tx.toHex()
-      return hex
-    } catch (err) {
-      wlogger.error('Error in util.js/sweepBCH().')
-      throw err
-    }
-  }
-
-  // Sweep BCH and tokens from a WIF.
-  async _sweepTokens (options) {
-    try {
-      // const { ecPair, utxos, fromAddr, toAddr, bchUtxos, tokenUtxos } = options
-      const { ecPair, utxos, toAddr, bchUtxos, tokenUtxos } = options
-
-      // Input validation
-      if (!Array.isArray(bchUtxos) || bchUtxos.length === 0) {
-        throw new Error('bchUtxos need to be an array with one UTXO.')
-      }
-      if (!Array.isArray(tokenUtxos) || tokenUtxos.length === 0) {
-        throw new Error('tokenUtxos need to be an array with one UTXO.')
-      }
-
-      // if (flags.testnet)
-      //   this.BITBOX = new config.BCHLIB({ restURL: config.TESTNET_REST })
-
-      // console.log(`tokenUtxos: ${JSON.stringify(tokenUtxos, null, 2)}`)
-
-      // Ensure there is only one class of token in the wallet. Throw an error if
-      // there is more than one.
-      const tokenId = tokenUtxos[0].tokenId
-      const otherTokens = tokenUtxos.filter(x => x.tokenId !== tokenId)
-      if (otherTokens.length > 0) {
-        throw new Error(
-          'Multiple token classes detected. This function only supports a single class of token.'
-        )
-      }
-
-      // instance of transaction builder
-      let transactionBuilder
-      if (options.testnet) {
-        transactionBuilder = new _this.bchjs.TransactionBuilder('testnet')
-      } else transactionBuilder = new _this.bchjs.TransactionBuilder()
-
-      // Combine all the UTXOs into a single array.
-      const allUtxos = utxos
-      // console.log(`allUtxos: ${JSON.stringify(allUtxos, null, 2)}`)
-
-      // Loop through all UTXOs.
-      let originalAmount = 0
-      for (let i = 0; i < allUtxos.length; i++) {
-        const utxo = allUtxos[i]
-
-        originalAmount = originalAmount + utxo.satoshis
-
-        transactionBuilder.addInput(utxo.txid, utxo.vout)
-      }
-
-      if (originalAmount < 300) {
-        throw new Error(
-          'Not enough BCH to send. Send more BCH to the wallet to pay miner fees.'
-        )
-      }
-
-      // get byte count to calculate fee. paying 1 sat
-      // Note: This may not be totally accurate. Just guessing on the byteCount size.
-      // const byteCount = this.BITBOX.BitcoinCash.getByteCount(
-      //   { P2PKH: 3 },
-      //   { P2PKH: 5 }
-      // )
-      // //console.log(`byteCount: ${byteCount}`)
-      // const satoshisPerByte = 1.1
-      // const txFee = Math.floor(satoshisPerByte * byteCount)
-      // console.log(`txFee: ${txFee} satoshis\n`)
-      const txFee = 500
-
-      // amount to send back to the sending address. It's the original amount - 1 sat/byte for tx size
-      const remainder = originalAmount - txFee - 546
-      if (remainder < 1) {
-        throw new Error('Selected UTXO does not have enough satoshis')
-      }
-      // console.log(`remainder: ${remainder}`)
-
-      // Tally up the quantity of tokens
-      let tokenQty = 0
-      for (let i = 0; i < tokenUtxos.length; i++) {
-        tokenQty += tokenUtxos[i].tokenQty
-      }
-      // console.log(`tokenQty: ${tokenQty}`)
-
-      // Generate the OP_RETURN entry for an SLP SEND transaction.
-      // console.log(`Generating op-return.`)
-      const {
-        script,
-        outputs
-      } = _this.bchjs.SLP.TokenType1.generateSendOpReturn(tokenUtxos, tokenQty)
-      // console.log(`token outputs: ${outputs}`)
-
-      // Since we are sweeping all tokens from the WIF, there generateOpReturn()
-      // function should only compute 1 token output. If it returns 2, then there
-      // is something unexpected happening.
-      if (outputs > 1) {
-        throw new Error(
-          'More than one class of token detected. Sweep feature not supported.'
-        )
-      }
-
-      // Add OP_RETURN as first output.
-      const data = _this.bchjs.Script.encode(script)
-      transactionBuilder.addOutput(data, 0)
-
-      // Send dust transaction representing tokens being sent.
-      transactionBuilder.addOutput(
-        _this.bchjs.Address.toLegacyAddress(toAddr),
-        546
-      )
-
-      // Last output: send remaining BCH
-      transactionBuilder.addOutput(
-        _this.bchjs.Address.toLegacyAddress(toAddr),
-        remainder
-      )
-      // console.log(`utxo: ${JSON.stringify(utxo, null, 2)}`)
-
-      // Sign each UTXO being consumed.
-      let redeemScript
-      for (let i = 0; i < allUtxos.length; i++) {
-        const thisUtxo = allUtxos[i]
-        // console.log(`thisUtxo: ${JSON.stringify(thisUtxo, null, 2)}`)
-
-        transactionBuilder.sign(
-          i,
-          ecPair,
-          redeemScript,
-          transactionBuilder.hashTypes.SIGHASH_ALL,
-          thisUtxo.satoshis
-        )
-      }
-
-      // build tx
-      const tx = transactionBuilder.build()
-
-      // output rawhex
-      const hex = tx.toHex()
-      // console.log(`Transaction raw hex: `)
-      // console.log(hex)
-
-      return hex
-    } catch (err) {
-      wlogger.error('Error in util.js/sweepBCH().')
-      throw err
-    }
-  }
-}
-
-const utilRoute = new UtilRoute()
-
-router.get('/', utilRoute.root)
-router.get('/validateAddress/:address', utilRoute.validateAddressSingle)
-router.post('/validateAddress', utilRoute.validateAddressBulk)
-router.post('/sweep', utilRoute.sweepWif)
-
-module.exports = {
-  router,
-  // testableComponents: {
-  //   root,
-  //   validateAddressSingle,
-  //   validateAddressBulk,
-  //   sweepWif
-  // }
-  UtilRoute
-}

src/routes/v5/bcash/slp.js

@@ -0,0 +1,196 @@
+/*
+  bcash node routes for working with SLP tokens.
+*/
+
+'use strict'
+
+const express = require('express')
+const router = express.Router()
+const axios = require('axios')
+const util = require('util')
+// const bitcore = require('bitcore-lib-cash')
+
+// const ElectrumCash = require('electrum-cash').ElectrumClient
+// const ElectrumCash = require('/home/trout/work/personal/electrum-cash/electrum.js').Client // eslint-disable-line
+
+const wlogger = require('../../../util/winston-logging')
+const config = require('../../../../config')
+
+const RouteUtils = require('../../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+const BCHJS = require('@psf/bch-js')
+const bchjs = new BCHJS()
+
+let _this
+
+class BcashSlp {
+  constructor () {
+    _this = this
+    this.config = config
+    this.axios = axios
+    this.routeUtils = routeUtils
+    this.bchjs = bchjs
+    // _this.bitcore = bitcore
+
+    this.router = router
+    this.router.get('/', this.root)
+    this.router.get('/utxos/:address', this.getUtxos)
+  }
+
+  /**
+   * @api {get} /bcash/utxos/{addr} Get utxos for a single address.
+   * @apiName UTXOs for a single address
+   * @apiGroup bcash
+   * @apiDescription Returns an object with UTXOs associated with an address.
+   * This UTXOs will be hydrated with token information.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/bcash/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
+   *
+   */
+  // GET handler for single balance
+  async getUtxos (req, res, next) {
+    try {
+      const address = req.params.address
+
+      this.bcashServer = process.env.BCASH_SERVER
+      if (!this.bcashServer) {
+        // console.warn('FULCRUM_API env var not set. Can not connect to Fulcrum indexer.')
+        throw new Error(
+          'BCASH_SERVER env var not set. Can not connect to bcash full node.'
+        )
+      }
+
+      // Reject if address is an array.
+      if (Array.isArray(address)) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'address can not be an array. Use POST for bulk upload.'
+        })
+      }
+
+      const cashAddr = _this.bchjs.Address.toCashAddress(address)
+
+      // Prevent a common user error. Ensure they are using the correct network address.
+      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
+      if (!networkIsValid) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error:
+            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
+        })
+      }
+
+      // TODO: Customize this function below here for bcash, based on this gist:
+      // https://gist.github.com/christroutner/dcb25a895900e557d7b43341ee85fa79
+
+      wlogger.debug(
+        'Executing bcash/slp.js/getUtxos(). with this address: ',
+        cashAddr
+      )
+
+      // Get data from ElectrumX server.
+      const response = await _this.axios.get(
+        `${_this.bcashServer}coin/address/${cashAddr}?slp=true`
+      )
+      // Get address UTXOs
+      const utxos = response.data
+      // Hydrate UTXOs
+      const hydratedUtxos = await _this.hydrateUTXOS(utxos)
+      res.status(200)
+      return res.json(hydratedUtxos)
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in bcash/slp.js/getUtxos().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  // Maps and filter the SLP UTXOs of an UTXOs array
+  // get information about the SLP UTXOs
+  async hydrateUTXOS (UTXOS) {
+    try {
+      if (!Array.isArray(UTXOS)) {
+        throw new Error('UTXOs must be an array of slp utxos')
+      }
+      const slpUtxos = UTXOS.filter((val) => val.slp)
+      const hydrated = []
+
+      // Find information of each token
+      for (let i = 0; i < slpUtxos.length; i++) {
+        const slp = slpUtxos[i].slp
+        const info = await _this.getTokenInfo(slp.tokenId)
+        const obj = Object.assign(slp, info)
+
+        slpUtxos[i].slp = obj
+        hydrated.push(slpUtxos[i])
+      }
+      return hydrated
+    } catch (error) {
+      console.log(error)
+      throw error
+    }
+  }
+
+  // Get information of a token
+  async getTokenInfo (tokenId) {
+    try {
+      if (!tokenId || typeof tokenId !== 'string') {
+        throw new Error('tokenId must be string')
+      }
+
+      this.bcashServer = process.env.BCASH_SERVER
+      if (!this.bcashServer) {
+        // console.warn('FULCRUM_API env var not set. Can not connect to Fulcrum indexer.')
+        throw new Error(
+          'BCASH_SERVER env var not set. Can not connect to bcash full node.'
+        )
+      }
+
+      const result = await _this.axios.get(
+        `${_this.bcashServer}token/${tokenId}`
+      )
+      const tokenInfo = result.data
+      // console.log('token info', tokenInfo)
+      return tokenInfo
+    } catch (error) {
+      console.log(error)
+      throw error
+    }
+  }
+
+  // DRY error handler.
+  errorHandler (err, res) {
+    // Attempt to decode the error message.
+    const { msg, status } = _this.routeUtils.decodeError(err)
+    // console.log('errorHandler msg: ', msg)
+    // console.log('errorHandler status: ', status)
+
+    if (msg) {
+      res.status(status)
+      return res.json({ success: false, error: msg })
+    }
+
+    // Handle error patterns specific to this route.
+    if (err.message) {
+      res.status(400)
+      return res.json({ success: false, error: err.message })
+    }
+
+    // If error can be handled, return the stack trace
+    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: 'bcash-slp' })
+  }
+}
+
+module.exports = BcashSlp

src/routes/v5/encryption.js

@@ -15,16 +15,11 @@ const config = require('../../../config')
 const RouteUtils = require('../../util/route-utils')
 const routeUtils = new RouteUtils()
 
-const BCHJS = require('@chris.troutner/bch-js')
-const bchjs = new BCHJS()
-
-// Use Blockbook for getting indexer data.
-const Blockbook = require('./blockbook')
-const blockbook = new Blockbook()
-
-// Use RawTransactions library for getting raw blockchain data.
-const RawTransactions = require('./full-node/rawtransactions')
-const rawTransactions = new RawTransactions()
+const BCHJS = require('@psf/bch-js')
+const restURL = process.env.LOCAL_RESTURL
+  ? process.env.LOCAL_RESTURL
+  : 'https://api.fullstack.cash/v5/'
+const bchjs = new BCHJS({ restURL })
 
 let _this
 
@@ -36,8 +31,8 @@ class Encryption {
     _this.axios = axios
     _this.routeUtils = routeUtils
     _this.bchjs = bchjs
-    _this.blockbook = blockbook
-    _this.rawTransactions = rawTransactions
+    // _this.blockbook = blockbook
+    // _this.rawTransactions = rawTransactions
 
     _this.router = router
     _this.router.get('/', _this.root)
@@ -50,7 +45,7 @@ class Encryption {
     const { msg, status } = _this.routeUtils.decodeError(err)
     if (msg) {
       res.status(status)
-      return res.json({ error: msg })
+      return res.json({ success: false, error: msg })
     }
 
     // Handle error patterns specific to this route.
@@ -81,7 +76,7 @@ class Encryption {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
    *
    */
   async getPublicKey (req, res, next) {
@@ -97,6 +92,15 @@ class Encryption {
         })
       }
 
+      // Generate a user object that can be passed along with internal calls
+      // from bch-js.
+      const usrObj = {
+        ip: req._remoteAddress,
+        jwtToken: req.locals.jwtToken,
+        proLimit: req.locals.proLimit,
+        apiLevel: req.locals.apiLevel
+      }
+
       const cashAddr = _this.bchjs.Address.toCashAddress(address)
 
       // Prevent a common user error. Ensure they are using the correct network address.
@@ -110,34 +114,36 @@ class Encryption {
         })
       }
 
+      // console.log(
       wlogger.debug(
         'Executing encryption/getPublicKey with this address: ',
         cashAddr
       )
 
-      // Retrieve the transaction history for this address.
-      const balance = await _this.blockbook.balanceFromBlockbook(cashAddr)
-      // console.log(`balance: ${JSON.stringify(balance, null, 2)}`)
+      const rawTxData = await _this.bchjs.Electrumx.transactions([cashAddr], usrObj)
+      // console.log(`rawTxData: ${JSON.stringify(rawTxData, null, 2)}`)
 
-      const txHistory = balance.txids
-      // console.log(`txHistory: ${JSON.stringify(txHistory, null, 2)}`)
+      // Extract just the TXIDs
+      const txids = rawTxData.transactions[0].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++) {
-        const thisTx = txHistory[i]
+      for (let i = 0; i < txids.length; i++) {
+        const thisTx = txids[i]
 
-        const txDetails = await _this.rawTransactions.getRawTransactionsFromNode(
-          thisTx,
-          true
+        const txDetails = await _this.bchjs.RawTransactions.getRawTransaction(
+          [thisTx],
+          true,
+          usrObj
         )
         // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
-        const vin = txDetails.vin
+        const vin = txDetails[0].vin
 
         // Loop through each input.
         for (let j = 0; j < vin.length; j++) {
@@ -175,6 +181,7 @@ class Encryption {
         publicKey: 'not found'
       })
     } catch (err) {
+      // console.log('Error in encryption.js/getPublicKey().', err)
       wlogger.error('Error in encryption.js/getPublicKey().', err)
 
       return _this.errorHandler(err, res)

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

@@ -17,7 +17,7 @@ const routeUtils = new RouteUtils()
 const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
-const BCHJS = require('@chris.troutner/bch-js')
+const BCHJS = require('@psf/bch-js')
 const bchjs = new BCHJS()
 
 let _this
@@ -53,6 +53,8 @@ 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)
+    this.router.get('/getBlockHash/:height', this.getBlockHash)
   }
 
   root (req, res, next) {
@@ -80,7 +82,7 @@ class Blockchain {
    * block chain.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getBestBlockHash" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getBestBlockHash" -H "accept: application/json"
    *
    * @apiSuccess {String}   bestBlockHash           000000000000000002bc884334336d99c9a9c616670a9244c6a8c1fc35aa91a1
    */
@@ -111,7 +113,7 @@ class Blockchain {
    * @apiDescription Returns an object containing various state info regarding blockchain processing.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockchainInfo" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getBlockchainInfo" -H "accept: application/json"
    *
    * @apiSuccess {Object}   object                      Object containing data
    * @apiSuccess {String}   object.chain                "main"
@@ -155,7 +157,7 @@ class Blockchain {
    * @apiDescription Returns the number of blocks in the longest blockchain.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockCount" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getBlockCount" -H "accept: application/json"
    *
    * @apiSuccess {Number} bestBlockCount  587665
    */
@@ -188,7 +190,7 @@ class Blockchain {
    * returns an Object with information about blockheader hash.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockHeader/000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201?verbose=true" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getBlockHeader/000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201?verbose=true" -H "accept: application/json"
    *
    * @apiParam {String} hash block hash
    * @apiParam {Boolean} verbose Return verbose data
@@ -249,7 +251,7 @@ class Blockchain {
    * returns an Object with information about blockheader hash.
    *
    * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/blockchain/getBlockHeader" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"hashes\":[\"000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201\",\"00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3\"],\"verbose\":true}"
+   * curl -X POST "https://api.fullstack.cash/v5/blockchain/getBlockHeader" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"hashes\":[\"000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201\",\"00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3\"],\"verbose\":true}"
    *
    * @apiParam {String} hash block hash
    * @apiParam {Boolean} verbose Return verbose data
@@ -284,7 +286,7 @@ class Blockchain {
 
       // Enforce array size rate limits
       if (!routeUtils.validateArraySize(req, hashes)) {
-        res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -341,7 +343,7 @@ class Blockchain {
    * including the main chain as well as orphaned branches.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getChainTips" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getChainTips" -H "accept: application/json"
    *
    */
   async getChainTips (req, res, next) {
@@ -372,7 +374,7 @@ class Blockchain {
    * power on the network.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getDifficulty" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getDifficulty" -H "accept: application/json"
    *
    */
   async getDifficulty (req, res, next) {
@@ -404,7 +406,7 @@ class Blockchain {
    * mempool (unconfirmed)
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolEntry/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getMempoolEntry/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
    *
    */
   async getMempoolEntrySingle (req, res, next) {
@@ -442,7 +444,7 @@ class Blockchain {
    * @apiDescription Returns mempool data for multiple transactions
    *
    * @apiExample Example usage:
-   * curl -X POST https://api.fullstack.cash/v3/blockchain/getMempoolEntry -H "Content-Type: application/json" -d "{\"txids\":[\"a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1\",\"5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e\"]}"
+   * curl -X POST https://api.fullstack.cash/v5/blockchain/getMempoolEntry -H "Content-Type: application/json" -d "{\"txids\":[\"a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1\",\"5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e\"]}"
    */
   async getMempoolEntryBulk (req, res, next) {
     try {
@@ -457,7 +459,7 @@ class Blockchain {
 
       // Enforce array size rate limits
       if (!routeUtils.validateArraySize(req, txids)) {
-        res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -515,7 +517,7 @@ class Blockchain {
    * against the 25 ancestor chain-limit.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolAncestors/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getMempoolAncestors/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
    *
    */
   async getMempoolAncestorsSingle (req, res, next) {
@@ -557,7 +559,7 @@ class Blockchain {
    * @apiDescription Returns details on the active state of the TX memory pool.
    *
    * @apiExample Example usage:
-   * curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
+   * curl -X GET https://api.fullstack.cash/v5/getMempoolInfo -H "accept: application/json"
    *
    */
   async getMempoolInfo (req, res, next) {
@@ -587,7 +589,7 @@ class Blockchain {
    * @apiDescription Returns details on the active state of the TX memory pool.
    *
    * @apiExample Example usage:
-   * curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
+   * curl -X GET https://api.fullstack.cash/v5/getMempoolInfo -H "accept: application/json"
    *
    */
 
@@ -599,7 +601,7 @@ class Blockchain {
    * of string transaction ids.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/getRawMempool/?verbose=true" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/getRawMempool/?verbose=true" -H "accept: application/json"
    *
    * @apiParam {Boolean} verbose Return verbose data
    *
@@ -635,7 +637,7 @@ class Blockchain {
    * @apiDescription Returns details about an unspent transaction output.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOut/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33/0?mempool=false" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getTxOut/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33/0?mempool=false" -H "accept: application/json"
    *
    * @apiParam {String} txid Transaction id (required)
    * @apiParam {Number} n Output number (required)
@@ -692,7 +694,7 @@ class Blockchain {
    * @apiDescription Returns details about an unspent transaction output (UTXO).
    *
    * @apiExample Example usage:
-   * curl "https://api.fullstack.cash/v3/blockchain/getTxOut/" -X POST -H "Content-Type: application/json" --data-binary '{"txid":"d5228d2cdc77fbe5a9aa79f19b0933b6802f9f0067f42847fc4fe343664723e5","vout":0,"mempool":true}'
+   * curl "https://api.fullstack.cash/v5/blockchain/getTxOut/" -X POST -H "Content-Type: application/json" --data-binary '{"txid":"d5228d2cdc77fbe5a9aa79f19b0933b6802f9f0067f42847fc4fe343664723e5","vout":0,"mempool":true}'
    *
    * @apiParam {String} txid Transaction id (required)
    * @apiParam {Number} vout of transaction (required)
@@ -746,7 +748,7 @@ class Blockchain {
    * @apiDescription Returns a hex-encoded proof that 'txid' was included in a block.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOutProofSingle/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getTxOutProofSingle/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
    *
    * @apiParam {String} txid Transaction id (required)
    *
@@ -794,7 +796,7 @@ class Blockchain {
 
       // Enforce array size rate limits
       if (!routeUtils.validateArraySize(req, txids)) {
-        res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -888,7 +890,7 @@ class Blockchain {
 
       // Enforce array size rate limits
       if (!routeUtils.validateArraySize(req, proofs)) {
-        res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -937,6 +939,93 @@ 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/v5/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)
+    }
+  }
+
+  /**
+   * @api {post} /blockchain/getBlockHash/ Get block hash
+   * @apiName getBlockHash
+   * @apiGroup Blockchain
+   * @apiDescription Returns the hash of a block, given its block height.
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/blockchain/getBlockHash/544444" -H "accept: application/json"
+   *
+   * @apiParam {String} height Block height (required)
+   *
+   *
+   */
+  async getBlockHash (req, res, next) {
+    try {
+      // Validate input parameter
+      const height = req.params.height
+      if (!height || height === '') {
+        res.status(400)
+        return res.json({ error: 'height can not be empty' })
+      }
+
+      // Axios options
+      const options = _this.routeUtils.getAxiosOptions()
+
+      options.data.id = 'getblockhash'
+      options.data.method = 'getblockhash'
+      options.data.params = [parseInt(height)]
+
+      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/getBlockHash()', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
 }
 
 module.exports = Blockchain

src/routes/v5/full-node/control.js

@@ -53,7 +53,7 @@ class Control {
    * @apiDescription RPC call which gets basic full node information.
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/control/getnetworkinfo" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/control/getnetworkinfo" -H "accept: application/json"
    *
    */
   async getNetworkInfo (req, res, next) {
@@ -75,42 +75,6 @@ class Control {
       return _this.errorHandler(error, res)
     }
   }
-  // router.get('/getMemoryInfo', (req, res, next) => {
-  //   BitboxHTTP({
-  //     method: 'post',
-  //     auth: {
-  //       username: username,
-  //       password: password
-  //     },
-  //     data: {
-  //       jsonrpc: "1.0",
-  //       id:"getmemoryinfo",
-  //       method: "getmemoryinfo"
-  //     }
-  //   })
-  //   .then((response) => {
-  //     res.json(response.data.result);
-  //   })
-  //   .catch((error) => {
-  //     res.send(error.response.data.error.message);
-  //   });
-  // });
-  //
-  // router.get('/help', (req, res, next) => {
-  //   BITBOX.Control.help()
-  //   .then((result) => {
-  //     res.json(result);
-  //   }, (err) => { console.log(err);
-  //   });
-  // });
-  //
-  // router.post('/stop', (req, res, next) => {
-  //   BITBOX.Control.stop()
-  //   .then((result) => {
-  //     res.json(result);
-  //   }, (err) => { console.log(err);
-  //   });
-  // });
 }
 
 module.exports = Control

src/routes/v5/full-node/dsproof.js

@@ -0,0 +1,95 @@
+'use strict'
+
+const express = require('express')
+const router = express.Router()
+
+const axios = require('axios')
+const wlogger = require('../../../util/winston-logging')
+
+const RouteUtils = require('../../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+// Used to convert error messages to strings, to safely pass to users.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+let _this
+class DSProof {
+  constructor () {
+    _this = this
+    _this.axios = axios
+    _this.routeUtils = routeUtils
+
+    _this.router = router
+    _this.router.get('/', this.root)
+    _this.router.get('/getdsproof/:txid', _this.getDSProof)
+  }
+
+  // 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 (req, res, next) {
+    return res.json({ status: 'dsproof' })
+  }
+
+  /**
+   * @api {get} /dsproof/getdsproof/:txid  Get Double-Spend Proof.
+   * @apiName DS Proof.
+   * @apiGroup DSProof
+   * @apiDescription Get information for a double-spend proof.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/dsproof/getdsproof/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -H "accept: application/json"
+   *
+   *
+   */
+  async getDSProof (req, res, next) {
+    try {
+      const txid = req.params.txid
+
+      let verbose = 2 // default
+      if (req.query.verbose === 'true') verbose = 3
+
+      if (!txid || txid === '') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'txid can not be empty'
+        })
+      }
+
+      if (txid.length !== 64) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: `txid must be of length 64 (not ${txid.length})`
+        })
+      }
+
+      const options = _this.routeUtils.getAxiosOptions()
+      options.data.id = 'getdsproof'
+      options.data.method = 'getdsproof'
+      options.data.params = [txid, verbose]
+
+      const response = await _this.axios.request(options)
+      return res.json(response.data.result)
+    } catch (err) {
+      wlogger.error('Error in dsproof.js/getDSProof().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+}
+
+module.exports = DSProof

src/routes/v5/full-node/mining.js

@@ -77,7 +77,7 @@ class Mining {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/mining/getMiningInfo" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/mining/getMiningInfo" -H "accept: application/json"
    *
    *
    */
@@ -107,7 +107,7 @@ class Mining {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/mining/getNetworkHashps?nblocks=120&height=-1" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/mining/getNetworkHashps?nblocks=120&height=-1" -H "accept: application/json"
    *
    *
    */

src/routes/v5/full-node/rawtransactions.js

@@ -65,7 +65,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
    */
   async decodeRawTransactionSingle (req, res, next) {
     try {
@@ -103,7 +103,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/rawtransactions/decodeRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
+   * curl -X POST "https://api.fullstack.cash/v5/rawtransactions/decodeRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
    *
    *
    */
@@ -118,7 +118,7 @@ class RawTransactions {
 
       // Enforce array size rate limits
       if (!_this.routeUtils.validateArraySize(req, hexes)) {
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -140,7 +140,7 @@ class RawTransactions {
       const options = _this.routeUtils.getAxiosOptions()
 
       // Loop through each height and creates an array of requests to call in parallel
-      const promises = hexes.map(async hex => {
+      const promises = hexes.map(async (hex) => {
         options.data.id = 'decoderawtransaction'
         options.data.method = 'decoderawtransaction'
         options.data.params = [hex]
@@ -152,7 +152,7 @@ class RawTransactions {
       const axiosResult = await _this.axios.all(promises)
 
       // Retrieve the data part of the result.
-      const result = axiosResult.map(x => x.data.result)
+      const result = axiosResult.map((x) => x.data.result)
 
       res.status(200)
       return res.json(result)
@@ -177,7 +177,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
    *
    *
    */
@@ -218,7 +218,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   *curl -X POST "https://api.fullstack.cash/v3/rawtransactions/decodeScript" -H "accept:" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
+   *curl -X POST "https://api.fullstack.cash/v5/rawtransactions/decodeScript" -H "accept:" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
    *
    *
    */
@@ -234,7 +234,7 @@ class RawTransactions {
 
       // Enforce array size rate limits
       if (!_this.routeUtils.validateArraySize(req, hexes)) {
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -254,7 +254,7 @@ class RawTransactions {
       const options = _this.routeUtils.getAxiosOptions()
 
       // Loop through each hex and create an array of promises
-      const promises = hexes.map(async hex => {
+      const promises = hexes.map(async (hex) => {
         options.data.id = 'decodescript'
         options.data.method = 'decodescript'
         options.data.params = [hex]
@@ -267,7 +267,7 @@ class RawTransactions {
       const resolved = await Promise.all(promises)
 
       // Retrieve the data from each resolved promise.
-      const result = resolved.map(x => x.data.result)
+      const result = resolved.map((x) => x.data.result)
 
       res.status(200)
       return res.json(result)
@@ -308,7 +308,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/rawtransactions/getRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1","5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e"],"verbose":true}'
+   * curl -X POST "https://api.fullstack.cash/v5/rawtransactions/getRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1","5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e"],"verbose":true}'
    *
    */
   async getRawTransactionBulk (req, res, next) {
@@ -324,20 +324,12 @@ class RawTransactions {
 
       // Enforce array size rate limits
       if (!_this.routeUtils.validateArraySize(req, txids)) {
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
         return res.json({
           error: 'Array too large.'
         })
       }
 
-      // stub response object
-      // const returnResponse = {
-      //   status: 100,
-      //   json: {
-      //     error: ''
-      //   }
-      // }
-
       // Validate each txid in the array.
       for (let i = 0; i < txids.length; i++) {
         const txid = txids[i]
@@ -356,7 +348,7 @@ class RawTransactions {
       }
 
       // Loop through each txid and create an array of promises
-      const promises = txids.map(async txid =>
+      const promises = txids.map(async (txid) =>
         _this.getRawTransactionsFromNode(txid, verbose)
       )
 
@@ -383,7 +375,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
+   * curl -X GET "https://api.fullstack.cash/v5/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
    *
    *
    */
@@ -429,7 +421,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X POST "https://api.fullstack.cash/v3/rawtransactions/sendRawTransaction" -H "accept:application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
+   * curl -X POST "https://api.fullstack.cash/v5/rawtransactions/sendRawTransaction" -H "accept:application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
    *
    *
    */
@@ -444,11 +436,12 @@ class RawTransactions {
         return res.json({ error: 'hex must be an array' })
       }
 
-      const options = _this.routeUtils.getAxiosOptions()
+      let options = _this.routeUtils.getAxiosOptions()
+      options = _this.sendTxOptions(options)
 
       // Enforce array size rate limits
       if (!_this.routeUtils.validateArraySize(req, hexes)) {
-        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
         return res.json({
           error: 'Array too large.'
         })
@@ -522,7 +515,7 @@ class RawTransactions {
    *
    *
    * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: "
+   * curl -X GET "https://api.fullstack.cash/v5/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: "
    *
    *
    */
@@ -544,7 +537,8 @@ class RawTransactions {
         })
       }
 
-      const options = _this.routeUtils.getAxiosOptions()
+      let options = _this.routeUtils.getAxiosOptions()
+      options = _this.sendTxOptions(options)
 
       // RPC call
       options.data.id = 'sendrawtransaction'
@@ -565,6 +559,31 @@ class RawTransactions {
       return _this.errorHandler(err, res)
     }
   }
+
+  // This method modifies the default axios options. It attempts to inject
+  // a specific full node to use when broadcasting transactions. This is useful
+  // because it leverages the built-in protections that a full node has against
+  // accidental double spends. It mitigates a corner-case when rapidly spending
+  // TXs on load balanced nodes. By piping all TX sends through a single node,
+  // accidental double spends can be reduced.
+  sendTxOptions (options) {
+    try {
+      const sendUrl = process.env.RPC_SENDURL
+
+      if (sendUrl !== 'undefined' && sendUrl !== undefined) {
+        // console.log(`original options: ${JSON.stringify(options, null, 2)}`)
+
+        options.baseURL = process.env.RPC_SENDURL
+
+        // console.log(`modified options: ${JSON.stringify(options, null, 2)}`)
+      }
+
+      return options
+    } catch (err) {
+      wlogger.error('Error in rawtransactions.js/sendTxOptions()')
+      throw err
+    }
+  }
 }
 
 module.exports = RawTransactions

src/routes/v5/jwt.js

@@ -0,0 +1,95 @@
+/*
+  Utility functions for troubleshooting a JWT token.
+*/
+
+'use strict'
+
+// Public npm libraries.
+const jwt = require('jsonwebtoken')
+const axios = require('axios')
+
+const express = require('express')
+const router = express.Router()
+
+const config = require('../../../config')
+const wlogger = require('../../util/winston-logging')
+
+const RouteUtils = require('../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+// Used for processing error messages before sending them to the user.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+let _this
+
+class JWT {
+  constructor () {
+    _this = this
+
+    _this.axios = axios
+    _this.routeUtils = routeUtils
+    _this.jwt = jwt
+    _this.config = config
+
+    _this.router = router
+    _this.router.get('/', _this.root)
+    _this.router.post('/info', _this.jwtInfo)
+  }
+
+  root (req, res, next) {
+    return res.json({ status: 'jwt' })
+  }
+
+  // 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) })
+  }
+
+  /**
+   * @api {post} /jwt/info Get JWT Info
+   * @apiName GetJWTInfo
+   * @apiGroup JWT
+   * @apiDescription
+   * Get info on your JWT token. Useful for debugging rate limit issues with your
+   * JWT token.
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v5/jwt/info" -H "accept: application/json" -H "Content-Type: application/json" -d '{"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwZGRmZmI2NzRhM2Q2MDAxOTY3NjE1NCIsImVtYWlsIjoiY2hyaXNAYmNodGVzdC5uZXQiLCJhcGlMZXZlbCI6NjAsInJhdGVMaW1pdCI6MywicG9pbnRzVG9Db25zdW1lIjoxNiwiZHVyYXRpb24iOjMwLCJpYXQiOjE2MjU0MzQ2MzYsImv5cCI6MTYyODAyNjYzNn0.1WLugTkQKVG0yMXD1h5nxfho3gRzvSvs8NMa9obVhPM"}'
+   *
+   */
+  async jwtInfo (req, res, next) {
+    try {
+      const jwtIn = req.body.jwt
+      // console.log('jwt: ', jwtIn)
+      // console.log('_this.config.apiTokenSecret: ', _this.config.apiTokenSecret)
+
+      const decoded = _this.jwt.verify(jwtIn, _this.config.apiTokenSecret)
+      // console.log('decoded: ', decoded)
+
+      const expiration = new Date(decoded.exp * 1000)
+      decoded.expiration = expiration.toISOString()
+
+      const createdAt = new Date(decoded.iat * 1000)
+      decoded.createdAt = createdAt.toISOString()
+
+      res.status(200)
+      return res.json(decoded)
+    } catch (error) {
+      // console.log('Error in jwt.js/jwtInfo().', error)
+      wlogger.error('Error in jwt.js/jwtInfo().', error)
+
+      return _this.errorHandler(error, res)
+    }
+  }
+}
+
+module.exports = JWT

src/routes/v5/price.js

@@ -0,0 +1,193 @@
+/*
+  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.coinexPriceUrl =
+      'https://api.coinex.com/v1/market/ticker?market=xecusdt'
+
+    this.bchCoinexPriceUrl =
+      'https://api.coinex.com/v1/market/ticker?market=bchusdt'
+
+    this.router = express.Router()
+    this.router.get('/', _this.root)
+    this.router.get('/usd', _this.getUSD)
+    this.router.get('/rates', _this.getBCHRate)
+    this.router.get('/bchausd', _this.getBCHAUSD)
+    this.router.get('/bchusd', _this.getBCHUSD)
+  }
+
+  // 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 from Coinbase.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/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 from Coinbase.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/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)
+    }
+  }
+
+  /**
+   * @api {get} /price/bchausd Get the USD price of BCHA
+   * @apiName Get the USD price of BCHA
+   * @apiGroup Price
+   * @apiDescription Get the USD price of BCHA from Coinex.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/price/bchausd" -H "accept: application/json"
+   *
+   */
+  async getBCHAUSD (req, res, next) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: _this.coinexPriceUrl,
+        timeout: 15000
+      }
+
+      const response = await axios.request(opt)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      const price = Number(response.data.data.ticker.last)
+
+      return res.json({ usd: price })
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in price.js/getBCHAUSD().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {get} /price/bchusd Get the USD price of BCH
+   * @apiName Get the USD price of BCH
+   * @apiGroup Price
+   * @apiDescription Get the USD price of BCH from Coinex.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/price/bchusd" -H "accept: application/json"
+   *
+   */
+  async getBCHUSD (req, res, next) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: _this.bchCoinexPriceUrl,
+        timeout: 15000
+      }
+
+      const response = await axios.request(opt)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      const price = Number(response.data.data.ticker.last)
+
+      return res.json({ usd: price })
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in price.js/getBCHUSD().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+}
+
+module.exports = Price

src/routes/v5/psf-slp-indexer.js

@@ -0,0 +1,474 @@
+/*
+  Routes for interacting with the psf-slp-indexer
+*/
+
+// Public npm libraries
+const express = require('express')
+const router = express.Router()
+const axios = require('axios')
+const util = require('util')
+const BCHJS = require('@psf/bch-js')
+
+// Local libraries
+const RouteUtils = require('../../util/route-utils')
+const config = require('../../../config')
+
+const routeUtils = new RouteUtils()
+const bchjs = new BCHJS({ restURL: config.restURL })
+
+let _this
+
+class PsfSlpIndexer {
+  constructor () {
+    // Encapsulate dependencies
+    this.axios = axios
+    this.router = router
+    this.routeUtils = routeUtils
+    this.config = config
+    this.bchjs = bchjs
+    // Define routes
+    this.router.get('/', this.root)
+    this.router.get('/status', this.getStatus)
+    this.router.post('/address', this.getAddress)
+    this.router.post('/txid', this.getTxid)
+    this.router.post('/token', this.getTokenStats)
+    this.router.post('/token/data', this.getTokenData)
+
+    _this = this
+  }
+
+  // Root API endpoint. Simply acknowledges that it exists.
+  root (req, res, next) {
+    return res.json({ status: 'psf-slp-indexer' })
+  }
+
+  /**
+   * @api {get} /psf/slp/status/  Indexer Status.
+   * @apiName SLP indexer status.
+   * @apiGroup PSF SLP
+   * @apiDescription Return SLP  indexer status
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:3000/v5/psf/slp/status
+   *
+   *
+   */
+  async getStatus (req, res, next) {
+    try {
+      // Verify env var is set for interacting with the indexer.
+      _this.checkEnvVar()
+
+      const response = await _this.axios.get(
+        `${_this.psfSlpIndexerApi}slp/status/`
+      )
+
+      res.status(200)
+      return res.json(response.data)
+    } catch (err) {
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /psf/slp/address/  SLP  balance for address.
+   * @apiName SLP  balance for address.
+   * @apiGroup PSF SLP
+   * @apiDescription Return SLP  balance for address
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "address": "bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n" }' localhost:3000/v5/psf/slp/address
+   *
+   *
+   */
+  async getAddress (req, res, next) {
+    try {
+      // Verify env var is set for interacting with the indexer.
+      _this.checkEnvVar()
+
+      // Validate the input data.
+      const address = req.body.address
+      if (!address || address === '') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'address can not be empty'
+        })
+      }
+
+      if (!address.includes('ecash')) {
+        // Ensure the input is a valid BCH address.
+        try {
+          _this.bchjs.SLP.Address.toCashAddress(address)
+        } catch (err) {
+          res.status(400)
+          return res.json({
+            success: false,
+            error: `Invalid BCH address. Double check your address is valid: ${address}`
+          })
+        }
+
+        // Prevent a common user error. Ensure they are using the correct network address.
+        const cashAddr = _this.bchjs.SLP.Address.toCashAddress(address)
+        const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
+        if (!networkIsValid) {
+          res.status(400)
+          return res.json({
+            success: false,
+            error:
+              'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
+          })
+        }
+      }
+
+      const response = await _this.axios.post(
+        `${_this.psfSlpIndexerApi}slp/address/`,
+        { address }
+      )
+
+      res.status(200)
+      return res.json(response.data)
+    } catch (err) {
+      // console.log('err', err)
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /psf/slp/txid/  SLP transaction data.
+   * @apiName SLP transaction data.
+   * @apiGroup PSF SLP
+   * @apiDescription Return slp transaction data.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "txid": "f3e14cd871402a766e85045dc552f2c1e87857dd3ea1b15efab6334ccef5e315" }' localhost:3000/v5/psf/slp/txid
+   *
+   *
+   */
+  async getTxid (req, res, next) {
+    try {
+      // Verify env var is set for interacting with the indexer.
+      _this.checkEnvVar()
+
+      const txid = req.body.txid
+      if (!txid || txid === '') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'txid can not be empty'
+        })
+      }
+
+      if (txid.length !== 64) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'This is not a txid'
+        })
+      }
+
+      const response = await _this.axios.post(
+        `${_this.psfSlpIndexerApi}slp/tx/`,
+        { txid }
+      )
+
+      res.status(200)
+      return res.json(response.data)
+    } catch (err) {
+      // console.log('err', err)
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /psf/slp/token  List stats for a single slp token.
+   * @apiName List stats for a single slp token.
+   * @apiGroup PSF SLP
+   * @apiDescription Return list stats for a single slp token.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2" }' localhost:3000/v5/psf/slp/token
+   *
+   *
+   */
+  async getTokenStats (req, res, next) {
+    try {
+      // Verify env var is set for interacting with the indexer.
+      _this.checkEnvVar()
+
+      const tokenId = req.body.tokenId
+      if (!tokenId || tokenId === '') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'tokenId can not be empty'
+        })
+      }
+
+      // Flag to toggle tx history of the token.
+      let withTxHistory = false
+      if (req.body.withTxHistory) withTxHistory = true
+
+      const response = await _this.axios.post(
+        `${_this.psfSlpIndexerApi}slp/token/`,
+        { tokenId, withTxHistory }
+      )
+
+      res.status(200)
+      return res.json(response.data)
+    } catch (err) {
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /psf/slp/token/data  Get token data
+   * @apiName Get token data
+   * @apiGroup PSF SLP
+   * @apiDescription Get mutable and immutable data if the token contains them.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "f055256b938f1ecfa270459d6f12c7c8c82b66d3263c03d5074445a2b1a498a3" }' localhost:3000/v5/psf/slp/token/data
+   *
+   *
+   */
+  // Get mutable and immutable data for a token, if the token was created with
+  // such data.
+  //
+  // Example:
+  // curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "f055256b938f1ecfa270459d6f12c7c8c82b66d3263c03d5074445a2b1a498a3" }' localhost:3000/v5/psf/slp/token/data
+  async getTokenData (req, res, next) {
+    try {
+      // Verify env var is set for interacting with the indexer.
+      _this.checkEnvVar()
+      const tokenData = {}
+
+      const tokenId = req.body.tokenId
+      if (!tokenId || tokenId === '') {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'tokenId can not be empty'
+        })
+      }
+
+      // get token stats from the Genesis TX of the token.
+      const withTxHistory = false
+      const response = await _this.axios.post(
+        `${_this.psfSlpIndexerApi}slp/token/`,
+        { tokenId, withTxHistory }
+      )
+      // console.log('response', response.data)
+
+      const tokenStats = response.data.tokenData
+
+      tokenData.genesisData = tokenStats
+
+      // try to get immutable data
+      try {
+        // const immutableData = await _this.getCIDData(tokenStats.documentUri)
+        const immutableData = tokenStats.documentUri
+        tokenData.immutableData = immutableData
+      } catch (error) {
+        tokenData.immutableData = ''
+      }
+
+      // try to get mutable data
+      try {
+        const mutableData = await _this.getMutableData(tokenStats.documentHash)
+        tokenData.mutableData = mutableData
+      } catch (error) {
+        tokenData.mutableData = ''
+      }
+
+      res.status(200)
+      return res.json(tokenData)
+    } catch (err) {
+      console.log('Error in getTokenData(): ', err)
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  // Retrieves the mutable data associated with a token document hash.
+  async getMutableData (documentHash) {
+    try {
+      if (!documentHash || typeof documentHash !== 'string') {
+        throw new Error(
+          'documentHash string required when calling mutableData().'
+        )
+      }
+
+      // Get the OP_RETURN data and decode it.
+      const mutableData = await _this.decodeOpReturn(documentHash)
+      const jsonData = JSON.parse(mutableData)
+      // console.log(`jsonData: ${JSON.stringify(jsonData, null, 2)}`)
+
+      const mutableDataAddr = jsonData.mda
+
+      // Gets the mutable data address (MDA) transaction history.
+      const transactions = await _this.bchjs.Electrumx.transactions(mutableDataAddr)
+
+      const mdaTxs = transactions.transactions
+      // console.log(`mdaTxs: ${JSON.stringify(mdaTxs, null, 2)}`)
+
+      let data = false
+      // Maps each transaction of the mutableDataAddr.
+      // If it finds an OP_RETURN, decode it. Exit the loop once the first
+      // valid mutable data entry is found.
+      // Start with the newest TXID entry and scan the history to find the first
+      // entry with an IPFS CID.
+      for (let i = mdaTxs.length - 1; i > -1; i--) {
+        const tx = mdaTxs[i]
+        const txid = tx.tx_hash
+        console.log(`Retrieving and decoding txid ${txid}`)
+
+        data = await _this.decodeOpReturn(txid)
+        // console.log('data: ', data)
+
+        //  Try parse the OP_RETURN data to a JSON object.
+        if (data) {
+          try {
+            // console.log('Mutable Data  : ', data)
+
+            // Convert the OP_RETURN data to a JSON object.
+            const obj = JSON.parse(data)
+            console.log(`obj: ${JSON.stringify(obj, null, 2)}`)
+
+            // Keep searching if this TX does not have a cid value.
+            if (!obj.cid) continue
+
+            // Ensure data was generated by the MDA
+            const txData = await this.bchjs.Transaction.get(txid)
+            const vinAddress = txData.txData.vin[0].address
+
+            // Skip entry if it was not made by the MDA private key.
+            if (mutableDataAddr !== vinAddress) {
+              console.log('Data is not generated by MDA, skipping.')
+              data = false
+              continue
+            }
+
+            break
+          } catch (error) {
+            continue
+          }
+        }
+      }
+      if (!data) {
+        console.log('Mutable Data  Not found ')
+      }
+
+      // Get the CID:
+      const obj = JSON.parse(data)
+      const cid = obj.cid
+      if (!cid) {
+        throw new Error('CID could not be found in OP_RETURN data')
+      }
+      const result = cid
+
+      // const result = await _this.getCIDData(cid)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return result
+    } catch (err) {
+      // console.log('Error in getMutableData().')
+      console.log('Error in getMutableData(): ', err)
+      throw err
+    }
+  }
+
+  // Decodes the OP_RETURN of a transaction if this exists
+  async decodeOpReturn (txid) {
+    try {
+      if (!txid || typeof txid !== 'string') {
+        throw new Error('txid must be a string.')
+      }
+
+      // get transaction data
+      const txData = await _this.bchjs.Electrumx.txData(txid)
+      let data = false
+
+      // Maps the vout of the transaction in search of an OP_RETURN
+      for (let i = 0; i < txData.details.vout.length; i++) {
+        const vout = txData.details.vout[i]
+
+        const script = _this.bchjs.Script.toASM(
+          Buffer.from(vout.scriptPubKey.hex, 'hex')
+        ).split(' ')
+
+        // Exit on the first OP_RETURN found.
+        if (script[0] === 'OP_RETURN') {
+          data = Buffer.from(script[1], 'hex').toString('ascii')
+          break
+        }
+      }
+
+      return data
+    } catch (error) {
+      console.log('Error in decodeOpReturn().')
+      throw error
+    }
+  }
+
+  // Get the immutable data stored in the documentUrl field of the token.
+  async getCIDData (cid) {
+    try {
+      if (!cid || typeof cid !== 'string') {
+        throw new Error('cid must be a string.')
+      }
+
+      // Assuming that CID starts with ipfs://. Cutting out that prefix.
+      cid = cid.substring(7)
+
+      const dataUrl = `https://${cid}.ipfs.dweb.link/data.json`
+      console.log(`dataUrl: ${dataUrl}`)
+
+      const response = await _this.axios.get(dataUrl)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return response.data
+    } catch (error) {
+      console.log('Error in getCIDData(): ', error)
+      throw error
+    }
+  }
+
+  // Check the the environment variable is set correctly.
+  checkEnvVar () {
+    _this.psfSlpIndexerApi = process.env.SLP_INDEXER_API
+    if (!_this.psfSlpIndexerApi) {
+      throw new Error(
+        'SLP_INDEXER_API env var not set. Can not connect to PSF SLP indexer.'
+      )
+    }
+  }
+
+  // DRY error handler.
+  errorHandler (err, res) {
+    // Attempt to decode the error message.
+    const { msg, status } = _this.routeUtils.decodeError(err)
+    // console.log('errorHandler msg: ', msg)
+    // console.log('errorHandler status: ', status)
+
+    if (msg) {
+      res.status(status)
+      return res.json({ success: false, error: msg })
+    }
+
+    // Handle error patterns specific to this route.
+    if (err.message) {
+      res.status(400)
+      return res.json({ success: false, error: err.message })
+    }
+
+    // If error can be handled, return the stack trace
+    res.status(500)
+    return res.json({ error: util.inspect(err) })
+  }
+}
+
+module.exports = PsfSlpIndexer

src/routes/v5/slp.js

@@ -0,0 +1,540 @@
+'use strict'
+
+const express = require('express')
+const router = express.Router()
+const axios = require('axios')
+const BigNumber = require('bignumber.js')
+
+const RouteUtils = require('../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+// const strftime = require('strftime')
+const wlogger = require('../../util/winston-logging')
+
+// Instantiate a local copy of bch-js using the local REST API server.
+const LOCAL_RESTURL = process.env.LOCAL_RESTURL
+  ? process.env.LOCAL_RESTURL
+  : 'https://api.fullstack.cash/v5/'
+
+const BCHJS = require('@psf/bch-js')
+// const BCHJS = require('../../../../bch-js')
+const bchjs = new BCHJS({ restURL: LOCAL_RESTURL })
+
+// Used to convert error messages to strings, to safely pass to users.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 5 }
+
+// Setup JSON RPC
+// const BitboxHTTP = axios.create({
+//   baseURL: process.env.RPC_BASEURL
+// })
+// const username = process.env.RPC_USERNAME
+// const password = process.env.RPC_PASSWORD
+
+// Determine the Access password for a private instance of SLPDB.
+// https://gist.github.com/christroutner/fc717ca704dec3dded8b52fae387eab2
+// Password for General Purpose (GP) SLPDB.
+const SLPDB_PASS_GP = process.env.SLPDB_PASS_GP
+  ? process.env.SLPDB_PASS_GP
+  : 'BITBOX'
+// Password for Whitelist (WL) SLPDB.
+const SLPDB_PASS_WL = process.env.SLPDB_PASS_WL
+  ? process.env.SLPDB_PASS_WL
+  : 'BITBOX'
+
+// const rawtransactions = require('./full-node/rawtransactions')
+const RawTransactions = require('./full-node/rawtransactions')
+const rawTransactions = new RawTransactions()
+
+// Setup REST and TREST URLs used by slpjs
+// Dev note: this allows for unit tests to mock the URL.
+if (!process.env.REST_URL) {
+  process.env.REST_URL = 'https://bchn.fullstack.cash/v5/'
+}
+if (!process.env.TREST_URL) {
+  process.env.TREST_URL = 'https://testnet.fullstack.cash/v5/'
+}
+
+let _this
+
+class Slp {
+  constructor () {
+    _this = this
+
+    // Encapsulate external libraries.
+    _this.axios = axios
+    _this.routeUtils = routeUtils
+    _this.BigNumber = BigNumber
+    _this.bchjs = bchjs
+    _this.rawTransactions = rawTransactions
+
+    _this.router = router
+
+    _this.router.get('/', _this.root)
+    _this.router.get('/convert/:address', _this.convertAddressSingle)
+    _this.router.post('/convert', _this.convertAddressBulk)
+    _this.router.get('/validateTxid2/:txid', _this.validate2Single)
+    _this.router.get('/whitelist', _this.getSlpWhitelist)
+    _this.router.post('/generateSendOpReturn', _this.generateSendOpReturn)
+  }
+
+  // DRY error handler.
+  errorHandler (err, res) {
+    // console.error('Entering slp.js/errorHandler(). err: ', err)
+
+    // Attempt to decode the error message.
+    const { msg, status } = _this.routeUtils.decodeError(err)
+    console.log('slp.js/errorHandler msg from decodeError: ', msg)
+    console.log('slp.js/errorHandler status from decodeError: ', status)
+
+    if (msg) {
+      res.status(status)
+      return res.json({ error: msg })
+    }
+
+    res.status(500)
+    return res.json({ error: util.inspect(err) })
+  }
+
+  formatTokenOutput (token) {
+    token.tokenDetails.id = token.tokenDetails.tokenIdHex
+    delete token.tokenDetails.tokenIdHex
+    token.tokenDetails.documentHash = token.tokenDetails.documentSha256Hex
+    delete token.tokenDetails.documentSha256Hex
+    token.tokenDetails.initialTokenQty = parseFloat(
+      token.tokenDetails.genesisOrMintQuantity
+    )
+    delete token.tokenDetails.genesisOrMintQuantity
+    delete token.tokenDetails.transactionType
+    delete token.tokenDetails.batonVout
+    delete token.tokenDetails.sendOutputs
+
+    if (token.tokenDetails.versionType === 65 && token.nftParentId) {
+      token.tokenDetails.nftParentId = token.nftParentId
+    }
+
+    token.tokenDetails.blockCreated = token.tokenStats.block_created
+    token.tokenDetails.blockLastActiveSend =
+      token.tokenStats.block_last_active_send
+    token.tokenDetails.blockLastActiveMint =
+      token.tokenStats.block_last_active_mint
+    token.tokenDetails.txnsSinceGenesis =
+      token.tokenStats.qty_valid_txns_since_genesis
+    token.tokenDetails.validAddresses =
+      token.tokenStats.qty_valid_token_addresses
+    token.tokenDetails.totalMinted = parseFloat(
+      token.tokenStats.qty_token_minted
+    )
+    token.tokenDetails.totalBurned = parseFloat(
+      token.tokenStats.qty_token_burned
+    )
+    token.tokenDetails.circulatingSupply = parseFloat(
+      token.tokenStats.qty_token_circulating_supply
+    )
+    token.tokenDetails.mintingBatonStatus =
+      token.tokenStats.minting_baton_status
+
+    delete token.tokenStats.block_last_active_send
+    delete token.tokenStats.block_last_active_mint
+    delete token.tokenStats.qty_valid_txns_since_genesis
+    delete token.tokenStats.qty_valid_token_addresses
+    return token
+  }
+
+  root (req, res, next) {
+    return res.json({ status: 'slp' })
+  }
+
+  /**
+   * @api {get} /slp/convert/{address}  Convert address to slpAddr, cashAddr and legacy.
+   * @apiName Convert address to slpAddr, cashAddr and legacy.
+   * @apiGroup SLP
+   * @apiDescription Convert address to slpAddr, cashAddr and legacy.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/slp/convert/simpleledger:qz9tzs6d5097ejpg279rg0rnlhz546q4fsnck9wh5m" -H "accept:application/json"
+   *
+   *
+   */
+  async convertAddressSingle (req, res, next) {
+    try {
+      const address = req.params.address
+
+      // Validate input
+      if (!address || address === '') {
+        res.status(400)
+        return res.json({ error: 'address can not be empty' })
+      }
+
+      const slpAddr = _this.bchjs.SLP.Address.toSLPAddress(address)
+
+      const obj = {
+        slpAddress: '',
+        cashAddress: '',
+        legacyAddress: ''
+      }
+      obj.slpAddress = slpAddr
+      obj.cashAddress = _this.bchjs.SLP.Address.toCashAddress(slpAddr)
+      obj.legacyAddress = _this.bchjs.SLP.Address.toLegacyAddress(
+        obj.cashAddress
+      )
+
+      res.status(200)
+      return res.json(obj)
+    } catch (err) {
+      wlogger.error('Error in slp.ts/convertAddressSingle().', err)
+      return _this.errorHandler(err, res)
+    // return res.json({
+    //   error: `Error in /address/convert/:address: ${err.message}`
+    // })
+    }
+  }
+
+  /**
+   * @api {post} /slp/convert/  Convert multiple addresses to cash, legacy and simpleledger format.
+   * @apiName Convert multiple addresses to cash, legacy and simpleledger format.
+   * @apiGroup SLP
+   * @apiDescription Convert multiple addresses to cash, legacy and simpleledger format.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v5/slp/convert" -H "accept:application/json" -H "Content-Type: application/json" -d '{"addresses":["simpleledger:qrxa0unrn67rtn85v7asfddhhth43ecnxua0antk2l"]}'
+   *
+   *
+   */
+  async convertAddressBulk (req, res, next) {
+    const addresses = req.body.addresses
+
+    // Reject if hashes 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.'
+      })
+    }
+
+    // Convert each address in the array.
+    const convertedAddresses = []
+    for (let i = 0; i < addresses.length; i++) {
+      const address = addresses[i]
+
+      // Validate input
+      if (!address || address === '') {
+        res.status(400)
+        return res.json({ error: 'address can not be empty' })
+      }
+
+      const slpAddr = _this.bchjs.SLP.Address.toSLPAddress(address)
+
+      const obj = {
+        slpAddress: '',
+        cashAddress: '',
+        legacyAddress: ''
+      }
+      obj.slpAddress = slpAddr
+      obj.cashAddress = _this.bchjs.SLP.Address.toCashAddress(slpAddr)
+      obj.legacyAddress = _this.bchjs.SLP.Address.toLegacyAddress(
+        obj.cashAddress
+      )
+
+      convertedAddresses.push(obj)
+    }
+
+    res.status(200)
+    return res.json(convertedAddresses)
+  }
+
+  /**
+   * @api {get} /slp/validateTxid2/{txid}  Validate 2 Single
+   * @apiName Validate a single SLP transaction by txid using slp-validate.
+   * @apiGroup SLP
+   * @apiDescription Validate single SLP transaction by txid, using slp-validate.
+   * Slower, less efficient method of validating an SLP TXID using the slp-validate
+   * npm library. This method is independent of SLPDB and can be used as a fall-back
+   * when SLPDB returns 'null' values.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/slp/validateTxid2/f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a" -H "accept:application/json"
+   *
+   *
+   */
+  async validate2Single (req, res, next) {
+    try {
+      const txid = req.params.txid
+
+      // Validate input
+      if (!txid || txid === '') {
+        res.status(400)
+        return res.json({ error: 'txid can not be empty' })
+      }
+
+      wlogger.debug(
+        'Executing slp/validate2Single/:txid with this txid: ',
+        txid
+      )
+
+      // null by default.
+      // Default return value.
+      const result = {
+        txid: txid,
+        isValid: null,
+        msg: ''
+      }
+
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: `${process.env.SLP_API_URL}slp/validate/${txid}`,
+        timeout: 10000 // Exit after 10 seconds.
+      }
+      const tokenRes = await _this.axios.request(opt)
+      // console.log(`tokenRes.data: ${JSON.stringify(tokenRes.data, null, 2)}`)
+      // console.log(`tokenRes: `, tokenRes)
+
+      // Overwrite the default value with the result from slp-api.
+      result.isValid = tokenRes.data.isValid
+
+      res.status(200)
+      return res.json(result)
+    } catch (err) {
+      // console.log('validate2Single error: ', err)
+      wlogger.error('Error in slp.ts/validate2Single().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {get} /slp/whitelist SLP token whitelist.
+   * @apiName SLP token whitelist
+   * @apiGroup SLP
+   * @apiDescription Get tokens that are on the whitelist.
+   * SLPDB is typically used to validate SLP transactions. It can become unstable
+   * during periods of high network usage. A second SLPDB has been implemented
+   * that is much more stable, because it only tracks a whitelist of SLP tokens.
+   * This endpoint will return information on the SLP tokens that are included
+   * in that whitelist.
+   *
+   * For tokens on the whitelist, the /slp/validateTxid3 endpoints can be used.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/slp/whitelist" -H "accept:application/json"
+   *
+   */
+  async getSlpWhitelist (req, res, next) {
+    try {
+      const list = [
+        {
+          name: 'USDH',
+          tokenId: 'c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca479'
+        },
+        {
+          name: 'SPICE',
+          tokenId: '4de69e374a8ed21cbddd47f2338cc0f479dc58daa2bbe11cd604ca488eca0ddf'
+        },
+        {
+          name: 'PSF',
+          tokenId: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0'
+        },
+        {
+          name: 'TROUT',
+          tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+        },
+        {
+          name: 'PSFTEST',
+          tokenId: 'd0ef4de95b78222bfee2326ab11382f4439aa0855936e2fe6ac129a8d778baa0'
+        }
+      ]
+
+      res.status(200)
+      return res.json(list)
+    } catch (err) {
+      wlogger.error('Error in slp.ts/whitelist().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  // Generates a Basic Authorization header for slpserve.
+  generateCredentialsGP () {
+    // Generate the Basic Authentication header for a private instance of SLPDB.
+    const username = 'BITBOX'
+    const password = SLPDB_PASS_GP
+    const combined = `${username}:${password}`
+    // console.log(`combined: ${combined}`)
+    const base64Credential = Buffer.from(combined).toString('base64')
+    const readyCredential = `Basic ${base64Credential}`
+
+    const options = {
+      headers: {
+        authorization: readyCredential
+      },
+      timeout: 45000
+    }
+
+    return options
+  }
+
+  // Generates a Basic Authorization header for slpserve.
+  generateCredentialsWL () {
+    // Generate the Basic Authentication header for a private instance of SLPDB.
+    const username = 'BITBOX'
+    const password = SLPDB_PASS_WL
+    const combined = `${username}:${password}`
+    // console.log(`combined: ${combined}`)
+    const base64Credential = Buffer.from(combined).toString('base64')
+    const readyCredential = `Basic ${base64Credential}`
+
+    const options = {
+      headers: {
+        authorization: readyCredential
+      },
+      timeout: 15000
+    }
+
+    return options
+  }
+
+  // Format the response from SLPDB into an object.
+  async formatToRestObject (slpDBFormat) {
+    // console.log(`slpDBFormat.data: ${JSON.stringify(slpDBFormat.data, null, 2)}`)
+
+    const transaction = slpDBFormat.data.u.length
+      ? slpDBFormat.data.u[0]
+      : slpDBFormat.data.c[0]
+
+    // const inputs = transaction.in
+
+    // const outputs = transaction.out
+    const tokenOutputs = transaction.slp.detail.outputs
+
+    const sendOutputs = ['0']
+    tokenOutputs.map((x) => {
+      const string = parseFloat(x.amount) * 100000000
+      sendOutputs.push(string.toString())
+      return 1 // Making the linter happy
+    })
+
+    // Because you are not using Insight API indexer, you do not get the
+    // sending addresses from an indexer or from the node.
+    // However, they are available from the SLPDB output.
+    const tokenInputs = transaction.in
+    // Collect the input addresses
+    const sendInputs = []
+    for (let i = 0; i < tokenInputs.length; i += 1) {
+      const tokenInput = tokenInputs[i]
+      const sendInput = {}
+      sendInput.address = tokenInput.e.a
+      sendInputs.push(sendInput)
+    }
+
+    const obj = {
+      tokenInfo: {
+        versionType: transaction.slp.detail.versionType,
+        tokenName: transaction.slp.detail.name,
+        tokenTicker: transaction.slp.detail.symbol,
+        transactionType: transaction.slp.detail.transactionType,
+        tokenIdHex: transaction.slp.detail.tokenIdHex,
+        sendOutputs: sendOutputs,
+        sendInputsFull: sendInputs,
+        sendOutputsFull: transaction.slp.detail.outputs
+      },
+      tokenIsValid: transaction.slp.valid
+    }
+
+    return obj
+  }
+
+  /**
+   * @api {post} /slp/generateSendOpReturn/ generateSendOpReturn
+   * @apiName SLP generateSendOpReturn
+   * @apiGroup SLP
+   * @apiDescription Generate the hex required for a SLP Send OP_RETURN.
+   *
+   * This will return a hexidecimal representation of the OP_RETURN code that
+   * can be used to generate an SLP Send transaction. The number of outputs
+   * (1 or 2) will also be returned.
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v5/slp/generateSendOpReturn" -H "accept:application/json" -H "Content-Type: application/json" -d '{"tokenUtxos":[{"tokenId": "0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1","decimals": 0, "tokenQty": 2}], "sendQty": 1.5}'
+   *
+   *
+   */
+  // Get OP_RETURN script and outputs
+  async generateSendOpReturn (req, res, next) {
+    try {
+      const tokenUtxos = req.body.tokenUtxos
+      // console.log(`tokenUtxos: `, tokenUtxos)
+
+      const _sendQty = req.body.sendQty
+      const sendQty = Number(_sendQty)
+
+      // console.log(`sendQty: `, sendQty)
+
+      // Reject if tokenUtxos is not an array.
+      if (!Array.isArray(tokenUtxos)) {
+        res.status(400)
+        return res.json({
+          error: 'tokenUtxos needs to be an array.'
+        })
+      }
+
+      // Reject if tokenUtxos array is empty.
+      if (!tokenUtxos.length) {
+        res.status(400)
+        return res.json({
+          error: 'tokenUtxos array can not be empty.'
+        })
+      }
+
+      // Reject if sendQty is not an number.
+      if (!sendQty) {
+        res.status(400)
+        return res.json({
+          error: 'sendQty must be a number.'
+        })
+      }
+
+      // console.log('sendQty: ', sendQty)
+      // console.log(`tokenUtxos: `, tokenUtxos)
+      const opReturn = await _this.bchjs.SLP.TokenType1.generateSendOpReturn(
+        tokenUtxos,
+        sendQty
+      )
+
+      const script = opReturn.script.toString('hex')
+      // console.log(`script: ${script}`)
+
+      res.status(200)
+      return res.json({ script, outputs: opReturn.outputs })
+    } catch (err) {
+      console.log('err: ', err)
+      wlogger.error('Error in slp.js/generateSendOpReturn().', err)
+
+      // Decode the error message.
+      const { msg, status } = routeUtils.decodeError(err)
+      if (msg) {
+        res.status(status)
+        return res.json({ error: msg })
+      }
+
+      res.status(500)
+      return res.json({
+        error: 'Error in /generateSendOpReturn()'
+      })
+    }
+  }
+}
+
+module.exports = Slp

src/routes/v5/util.js

@@ -0,0 +1,200 @@
+'use strict'
+
+const express = require('express')
+const router = express.Router()
+const axios = require('axios')
+
+const RouteUtils = require('../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+const wlogger = require('../../util/winston-logging')
+
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+const BCHJS = require('@psf/bch-js')
+const bchjs = new BCHJS()
+
+// let _this
+
+class UtilRoute {
+  constructor (utilConfig) {
+    this.bchjs = bchjs
+    // this.blockbook = blockbook
+
+    if (!utilConfig) {
+      throw new Error(
+        'Must pass a config object when instantiating the Util library.'
+      )
+    }
+    if (!utilConfig.electrumx) {
+      throw new Error(
+        'Must pass an instance of Electrumx when instantiating the Util library.'
+      )
+    }
+
+    this.electrumx = utilConfig.electrumx
+
+    this.router = router
+    this.router.get('/', this.root)
+    this.router.get('/validateAddress/:address', this.validateAddressSingle)
+    this.router.post('/validateAddress', this.validateAddressBulk)
+    // this.router.post('/sweep', this.sweepWif)
+
+    // _this = this
+  }
+
+  root (req, res, next) {
+    return res.json({ status: 'util' })
+  }
+
+  /**
+   * @api {get} /util/validateAddress/{address}  Get information about single bitcoin cash address.
+   * @apiName Information about single bitcoin cash address
+   * @apiGroup Util
+   * @apiDescription Returns information about single bitcoin cash address.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/util/validateAddress/bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c" -H "accept: application/json"
+   *
+   *
+   */
+  async validateAddressSingle (req, res, next) {
+    try {
+      const address = req.params.address
+      if (!address || address === '') {
+        res.status(400)
+        return res.json({ error: 'address can not be empty' })
+      }
+
+      const {
+        BitboxHTTP,
+        // username,
+        // password,
+        requestConfig
+      } = routeUtils.setEnvVars()
+
+      requestConfig.data.id = 'validateaddress'
+      requestConfig.data.method = 'validateaddress'
+      requestConfig.data.params = [address]
+
+      const response = await BitboxHTTP(requestConfig)
+
+      return res.json(response.data.result)
+    } catch (err) {
+      // Attempt to decode the error message.
+      const { msg, status } = routeUtils.decodeError(err)
+      if (msg) {
+        res.status(status)
+        return res.json({ error: msg })
+      }
+
+      wlogger.error('Error in util.ts/validateAddressSingle().', err)
+
+      res.status(500)
+      return res.json({ error: util.inspect(err) })
+    }
+  }
+
+  /**
+   * @api {post} /util/validateAddress  Get information about bulk bitcoin cash addresses..
+   * @apiName Information about bulk bitcoin cash addresses.
+   * @apiGroup Util
+   * @apiDescription Returns information about bulk bitcoin cash addresses..
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v5/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"]}'
+   * curl -X POST "https://api.fullstack.cash/v5/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"],"from": 1, "to": 5}'
+   *
+   *
+   */
+  async validateAddressBulk (req, res, next) {
+    try {
+      const addresses = req.body.addresses
+
+      // 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 (!routeUtils.validateArraySize(req, addresses)) {
+        res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        return res.json({
+          error: 'Array too large.'
+        })
+      }
+
+      // Validate each element in the array.
+      for (let i = 0; i < addresses.length; i++) {
+        const address = addresses[i]
+
+        // Ensure the input is a valid BCH address.
+        try {
+          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 = 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.'
+          })
+        }
+      }
+
+      wlogger.debug('Executing util/validate with these addresses: ', addresses)
+
+      const {
+        BitboxHTTP,
+        // username,
+        // password,
+        requestConfig
+      } = routeUtils.setEnvVars()
+
+      // Loop through each address and creates an array of requests to call in parallel
+      const promises = addresses.map(async (address) => {
+        requestConfig.data.id = 'validateaddress'
+        requestConfig.data.method = 'validateaddress'
+        requestConfig.data.params = [address]
+
+        return BitboxHTTP(requestConfig)
+      })
+
+      // Wait for all parallel Insight requests to return.
+      const axiosResult = await axios.all(promises)
+
+      // Retrieve the data part of the result.
+      const result = axiosResult.map((x) => x.data.result)
+
+      res.status(200)
+      return res.json(result)
+    } catch (err) {
+      // Attempt to decode the error message.
+      const { msg, status } = routeUtils.decodeError(err)
+      if (msg) {
+        res.status(status)
+        return res.json({ error: msg })
+      }
+
+      wlogger.error('Error in util.ts/validateAddressSingle().', err)
+
+      res.status(500)
+      return res.json({ error: util.inspect(err) })
+    }
+  }
+}
+
+module.exports = UtilRoute

src/routes/v5/xpub.js

@@ -5,8 +5,10 @@
 'use strict'
 
 const express = require('express')
-// const axios = require('axios')
-const routeUtils = require('./route-utils')
+
+const RouteUtils = require('../../util/route-utils')
+const routeUtils = new RouteUtils()
+
 const wlogger = require('../../util/winston-logging')
 
 // const router = express.Router()
@@ -16,7 +18,7 @@ const router = express.Router()
 const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
-const BCHJS = require('@chris.troutner/bch-js')
+const BCHJS = require('@psf/bch-js')
 const bchjs = new BCHJS()
 
 // Connect the route endpoints to their handler functions.

src/util/route-utils.js

@@ -10,7 +10,7 @@ const wlogger = require('./winston-logging')
 const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
-const BCHJS = require('@chris.troutner/bch-js')
+const BCHJS = require('@psf/bch-js')
 const bchjs = new BCHJS()
 
 // let _this
@@ -154,12 +154,73 @@ class RouteUtils {
         }
       }
 
+      // Handle 429 errors
+      if (err.error) {
+        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
+          }
+        } else if (err.error.includes('Network error:')) {
+          return {
+            msg: err.error,
+            status: 503
+          }
+        }
+      }
+
+      // Handle general Error objects.
+      if (err.message) {
+        return {
+          msg: err.message,
+          status: 422
+        }
+      }
+
       return { msg: false, status: 500 }
     } catch (err) {
+      console.error('unhandled error in route-utils.js/decodeError(): ', err)
       wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
       return { msg: false, status: 500 }
     }
   }
+
+  // Dynamically set these based on env vars. Allows unit testing.
+  setEnvVars () {
+    const BitboxHTTP = axios.create({
+      baseURL: process.env.RPC_BASEURL,
+      timeout: 15000
+    })
+    const username = process.env.RPC_USERNAME
+    const password = process.env.RPC_PASSWORD
+
+    const requestConfig = {
+      method: 'post',
+      auth: {
+        username: username,
+        password: password
+      },
+      data: {
+        jsonrpc: '1.0'
+      }
+    }
+
+    return { BitboxHTTP, username, password, requestConfig }
+  }
 }
 
 module.exports = RouteUtils

src/util/winston-logging.js

@@ -6,18 +6,30 @@
 
 'use strict'
 
-var winston = require('winston')
+const winston = require('winston')
 require('winston-daily-rotate-file')
 
-var NETWORK = process.env.NETWORK
+const NETWORK = process.env.NETWORK
+
+// Default 1 Megabyte
+const LOG_MAX_SIZE = process.env.LOG_MAX_SIZE ? process.env.LOG_MAX_SIZE : '1m'
+
+// Default 5 days.
+// 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
+const LOG_MAX_FILES = process.env.LOG_MAX_FILES
+  ? process.env.LOG_MAX_FILES
+  : '250'
 
 // Configure daily-rotation transport.
-var transport = new winston.transports.DailyRotateFile({
-  filename: `${__dirname}/../../logs/rest-${NETWORK}-%DATE%.log`,
+const transport = new winston.transports.DailyRotateFile({
+  filename: `${__dirname.toString()}/../../logs/rest-${NETWORK}-%DATE%.log`,
   datePattern: 'YYYY-MM-DD',
   zippedArchive: false,
-  maxSize: '1m',
-  maxFiles: '5d',
+  maxSize: LOG_MAX_SIZE,
+  maxFiles: LOG_MAX_FILES,
   format: winston.format.combine(
     winston.format.timestamp(),
     winston.format.json()
@@ -29,7 +41,7 @@ transport.on('rotate', function (oldFilename, newFilename) {
 })
 
 // This controls what goes into the log FILES
-var wlogger = winston.createLogger({
+const wlogger = winston.createLogger({
   level: 'verbose',
   format: winston.format.json(),
   transports: [

start-dev-example.sh

@@ -1,23 +1,69 @@
 #!/bin/bash
 
-# Full node
-export RPC_BASEURL=http://<full node ip>:8332/
-export RPC_USERNAME=<RPC username>
-export RPC_PASSWORD=<RPC password>
+# Docker containers for the below infrastructure is described here:
+# https://CashStack.info
+# Pre-synced databases can be downloaded on the CashStrap page:
+# https://fullstack.cash/cashstrap
+
+# Which network are you using?
 export NETWORK=mainnet
+#export NETWORK=testnet
 
-# SLPDB
-export SLPDB_URL=http://<SLPDB IP>:12300/
+# Full node
+export RPC_IP=<ip>:8332
+export RPC_BASEURL=http://$RPC_IP/
+export RPC_USERNAME=bitcoin
+export RPC_PASSWORD=password
 
-# Blockbook
-export BLOCKBOOK_URL=https://<Blockbook IP>:9131/
-# Allow node.js to make network calls to https using self-signed certificate.
-export NODE_TLS_REJECT_UNAUTHORIZED=0
+# (optional) If load-balancing multiple full nodes, it's best to pick a single
+# one for broadcasting transactions to the network. Prevents accidental
+# double spends.
+#export RPC_SENDURL=http://$RPC_IP/
+
+# psf-slp-indxer
+export SLP_INDEXER_API=http://<ip>:<port>/
 
 # Mainnet Fulcrum / ElectrumX
-export FULCRUM_URL=192.168.0.6
-export FULCRUM_PORT=50002
+export FULCRUM_API=http://172.17.0.1:3001/v1/
 
+# Redis DB - Used for rate limiting - customize to your own Redis installation.
+export REDIS_PORT=6379
+export REDIS_HOST=172.17.0.1
+
+# JWT Token Secret
+# This is used to verify JWT tokens generated with jwt-bch-api:
+# https://github.com/Permissionless-Software-Foundation/jwt-bch-api
 export TOKENSECRET=somelongpassword
 
+# So that bch-api can call bch-js locally.
+export LOCAL_RESTURL=http://127.0.0.1:3000/v5/
+
+# Basic Authentication password
+export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
+
+# Whitelisted domains. Automatically give pro-tier rate limit access to apps
+# that originate froma domain on the whitelist.
+export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
+
+# Uncomment the line below if you do not want to use rate limits
+#export export DO_NOT_USE_RATE_LIMITS=1
+# 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=500
+# 10 = 1000 RPM
+export WHITELIST_RATE_LIMIT=100
+
+# Set logging parameters
+#1m means no more than 1 megabyte
+export LOG_MAX_SIZE=1m
+#5d means store no more than 5 days
+export LOG_MAX_FILES=5d
+
+# (Optional) if using a bcash node, set this variable. Otherwise leave it as-is.
+export BCASH_SERVER=http://localhost
+
+# PSF SLP indexer
+export SLP_INDEXER_API=https://psf-slp-indexer.fullstack.cash/
+
 npm start

test/v3/integration/rate-limits.js

@@ -1,165 +0,0 @@
-/*
-  This integration tests should be run against a live bch-api REST server. It
-  tests to ensure the rate-limits are working as expected. Adjust the values
-  in the tests below to match the rate limit setting in your own installation.
- */
-
-'use strict'
-
-const chai = require('chai')
-const assert = chai.assert
-const axios = require('axios')
-
-// Used for debugging.
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-// const SERVER = `http://192.168.0.36:12400/v3/`
-const SERVER = 'http://localhost:3000/v3/'
-
-const TEST_JWT =
-  'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlM2EwNDE1ZWIyOWE5NjJkYTI3MDhiNCIsImFwaUxldmVsIjowLCJyYXRlTGltaXQiOjEwLCJpYXQiOjE1ODA4NjA0NjcsImV4cCI6MTU4MzQ1MjQ2N30.fuY5S-YrF0J11h5uyMjPe7wiVkYRnIyXi4dL9-V-C6pLJm33p0dSq_pSheVVWw78n5kAvL_9kFHngbnmQiOJYQ'
-
-describe('#rate limits', () => {
-  it('should get control/getNetworkInfo() with no auth', async () => {
-    const options = {
-      method: 'GET',
-      url: `${SERVER}control/getNetworkInfo`
-    }
-
-    const result = await axios(options)
-    // console.log(`result.status: ${result.status}`)
-    // console.log(`result.data: ${util.inspect(result.data)}`)
-
-    assert.equal(result.status, 200)
-    assert.hasAnyKeys(result.data, ['version'])
-  })
-
-  it('should trigger rate-limit handler if rate limits exceeds 30 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 < 30; i++) {
-        const promise = axios(options)
-        promises.push(promise)
-      }
-
-      await Promise.all(promises)
-
-      assert.equal(true, false, 'Unexpected result!')
-    } catch (err) {
-      // console.log(`err.response: ${util.inspect(err.response)}`)
-
-      assert.equal(err.response.status, 429)
-      assert.include(err.response.data.error, 'Too many requests')
-    }
-  })
-
-  it('should not trigger rate-limit handler if correct pro-tier password is used', async () => {
-    try {
-      const username = 'BITBOX'
-
-      // Pro-tier is accessed by using the right password.
-      const password = 'BITBOX'
-      // const password = "something"
-
-      const combined = `${username}:${password}`
-      const base64Credential = Buffer.from(combined).toString('base64')
-      const readyCredential = `Basic ${base64Credential}`
-
-      const options = {
-        method: 'GET',
-        url: `${SERVER}control/getNetworkInfo`,
-        headers: { Authorization: readyCredential }
-      }
-
-      const promises = []
-      for (let i = 0; i < 30; i++) {
-        const promise = axios(options)
-        promises.push(promise)
-      }
-
-      await Promise.all(promises)
-
-      assert.equal(true, true, 'Not throwing an error is a pass!')
-    } catch (err) {
-      // console.log(`err.response: ${util.inspect(err.response)}`)
-
-      assert.equal(
-        true,
-        false,
-        'This error handler should not have been triggered. Is the password correct?'
-      )
-    }
-  })
-
-  it('should trigger rate-limit handler if rate limits exceeds pro-tier limit', async () => {
-    try {
-      const username = 'BITBOX'
-
-      // Pro-tier is accessed by using the right password.
-      const password = 'BITBOX'
-      // const password = "something"
-
-      const combined = `${username}:${password}`
-      const base64Credential = Buffer.from(combined).toString('base64')
-      const readyCredential = `Basic ${base64Credential}`
-
-      // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
-      const options = {
-        method: 'GET',
-        url: `${SERVER}control/getNetworkInfo`,
-        headers: { Authorization: readyCredential }
-      }
-
-      const promises = []
-      for (let i = 0; i < 80; i++) {
-        const promise = axios(options)
-        promises.push(promise)
-      }
-
-      await Promise.all(promises)
-
-      assert.equal(true, false, 'Unexpected result!')
-    } catch (err) {
-      // console.log(`err.response: ${util.inspect(err.response)}`)
-
-      assert.equal(err.response.status, 429)
-      assert.include(err.response.data.error, 'Too many requests')
-    }
-  })
-
-  it('should unlock pro-tier for a valid JWT token', async () => {
-    try {
-      // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
-      const options = {
-        method: 'GET',
-        url: `${SERVER}control/`,
-        headers: {
-          Authorization: `Token ${TEST_JWT}`
-        }
-      }
-
-      const promises = []
-      for (let i = 0; i < 60; i++) {
-        const promise = axios(options)
-        promises.push(promise)
-      }
-
-      await Promise.all(promises)
-
-      // assert.equal(true, false, "Unexpected result!")
-      assert.equal(true, true, 'Not throwing an error is a pass!')
-    } catch (err) {
-      console.log(`err.response: ${util.inspect(err.response)}`)
-
-      assert.equal(true, false, 'Unexpected result!')
-    }
-    // Override default timeout for this test.
-  }).timeout(20000)
-})

test/v3/integration/slp.js

@@ -1,124 +0,0 @@
-/*
-  These integration tests need to be run against a live SLPDB. They query
-  against a live SLPDB and test the results against known token stats.
- */
-
-'use strict'
-
-const assert = require('chai').assert
-// const axios = require('axios')
-
-// Used for debugging.
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-// Exit if SLPDB URL is not defined.
-if (!process.env.SLPDB_URL) {
-  throw new Error(
-    'SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.'
-  )
-}
-
-const SLP = require('../../../src/routes/v3/slp')
-const slp = new SLP()
-
-const { mockReq, mockRes } = require('../mocks/express-mocks')
-
-describe('#slp', () => {
-  let req, res
-
-  beforeEach(() => {
-    // Mock the req and res objects used by Express routes.
-    req = mockReq
-    res = mockRes
-  })
-
-  describe('#tokenStats', () => {
-    it('should get token stats for token with no mint baton', async () => {
-      req.params.tokenId =
-        '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7'
-      // 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
-
-      const result = await slp.tokenStats(req, res)
-      // console.log(`result: ${util.inspect(result)}`)
-
-      // Assert that expected properties exist.
-      assert.property(result, 'decimals')
-      assert.property(result, 'timestamp')
-      assert.property(result, 'versionType')
-      assert.property(result, 'documentUri')
-      assert.property(result, 'symbol')
-      assert.property(result, 'name')
-      assert.property(result, 'containsBaton')
-      assert.property(result, 'id')
-      assert.property(result, 'documentHash')
-      assert.property(result, 'initialTokenQty')
-      assert.property(result, 'blockCreated')
-      assert.property(result, 'blockLastActiveSend')
-      assert.property(result, 'blockLastActiveMint')
-      assert.property(result, 'txnsSinceGenesis')
-      assert.property(result, 'validAddresses')
-      assert.property(result, 'mintingBatonStatus')
-      assert.property(result, 'timestampUnix')
-      assert.property(result, 'totalMinted')
-      assert.property(result, 'totalBurned')
-      assert.property(result, 'circulatingSupply')
-
-      // baton was never created.
-      assert.equal(result.containsBaton, false)
-    })
-
-    it('should get token stats for token with a mint baton', async () => {
-      req.params.tokenId =
-        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
-
-      const result = await slp.tokenStats(req, res)
-      // console.log(`result: ${util.inspect(result)}`)
-
-      // Assert that expected properties exist.
-      assert.property(result, 'decimals')
-      assert.property(result, 'timestamp')
-      assert.property(result, 'versionType')
-      assert.property(result, 'documentUri')
-      assert.property(result, 'symbol')
-      assert.property(result, 'name')
-      assert.property(result, 'containsBaton')
-      assert.property(result, 'id')
-      assert.property(result, 'documentHash')
-      assert.property(result, 'initialTokenQty')
-      assert.property(result, 'blockCreated')
-      assert.property(result, 'blockLastActiveSend')
-      assert.property(result, 'blockLastActiveMint')
-      assert.property(result, 'txnsSinceGenesis')
-      assert.property(result, 'validAddresses')
-      assert.property(result, 'mintingBatonStatus')
-      assert.property(result, 'timestampUnix')
-      assert.property(result, 'totalMinted')
-      assert.property(result, 'totalBurned')
-      assert.property(result, 'circulatingSupply')
-
-      // baton was created.
-      assert.equal(result.containsBaton, true)
-    })
-  })
-
-  describe('generateSendOpReturn', () => {
-    it('should return OP_RETURN script', async () => {
-      req.body.tokenUtxos = [
-        {
-          tokenId:
-            '0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1',
-          decimals: 0,
-          tokenQty: 2
-        }
-      ]
-      req.body.sendQty = 1.5
-
-      const result = await slp.generateSendOpReturn(req, res)
-      // console.log(`result: ${util.inspect(result)}`)
-
-      assert.hasAllKeys(result, ['script', 'outputs'])
-      assert.isNumber(result.outputs)
-    })
-  })
-})

test/v3/mocks/electrumx-mock.js

@@ -1,47 +0,0 @@
-/*
-  Mocking data for electrumx unit tests
-*/
-
-'use strict'
-
-const utxos = [
-  {
-    height: 604392,
-    tx_hash: '7774e449c5a3065144cefbc4c0c21e6b69c987f095856778ef9f45ddd8ae1a41',
-    tx_pos: 0,
-    value: 1000
-  },
-  {
-    height: 630834,
-    tx_hash: '4fe60a51e0d8f5134bfd8e5f872d6e502d7f01b28a6afebb27f4438a4f638d53',
-    tx_pos: 0,
-    value: 6000
-  }
-]
-
-const balance = {
-  confirmed: 7000,
-  unconfirmed: 0
-}
-
-const txHistory = [
-  {
-    height: 601861,
-    tx_hash: '6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d'
-  }
-]
-
-const mempool = [
-  {
-    tx_hash: '45381031132c57b2ff1cbe8d8d3920cf9ed25efd9a0beb764bdb2f24c7d1c7e3',
-    height: 0,
-    fee: 24310
-  }
-]
-
-module.exports = {
-  utxos,
-  balance,
-  txHistory,
-  mempool
-}

test/v3/mocks/encryption-mocks.js

@@ -1,179 +0,0 @@
-/*
-  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',
-  version: 2,
-  size: 226,
-  locktime: 0,
-  vin: [
-    {
-      txid: '681cc1d392975a7e78cbd490b8a940d7eb029c554f2cee332e3a7119d77fb189',
-      vout: 1,
-      scriptSig: {
-        asm: '30450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f[ALL|FORKID] 02bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7',
-        hex: '4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7'
-      },
-      sequence: 4294967295
-    }
-  ],
-  vout: [
-    {
-      value: 0.000006,
-      n: 0,
-      scriptPubKey: {
-        asm: 'OP_DUP OP_HASH160 3c79ba54317c4be9cbfa5aaf357f74b97f3d9696 OP_EQUALVERIFY OP_CHECKSIG',
-        hex: '76a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac',
-        reqSigs: 1,
-        type: 'pubkeyhash',
-        addresses: [
-          'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg'
-        ]
-      }
-    },
-    {
-      value: 0.00003664,
-      n: 1,
-      scriptPubKey: {
-        asm: 'OP_DUP OP_HASH160 58502a73888e0a386fc69b44850af4b2a86ac9a6 OP_EQUALVERIFY OP_CHECKSIG',
-        hex: '76a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac',
-        reqSigs: 1,
-        type: 'pubkeyhash',
-        addresses: [
-          'bitcoincash:qpv9q2nn3z8q5wr0c6d5fpg27je2s6kf5cavp4ney0'
-        ]
-      }
-    }
-  ],
-  hex: '020000000189b17fd719713a2e33ee2c4f559c02ebd740a9b890d4cb787e5a9792d3c11c68010000006b4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7ffffffff0258020000000000001976a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac500e0000000000001976a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac00000000'
-}
-
-module.exports = {
-  mockBalance,
-  mockTxDetails,
-  mockNoTxHistory,
-  mockNoSendBalance,
-  mockNoSendTx
-}

test/v3/mocks/slp-mocks.js

@@ -1,537 +0,0 @@
-/*
-  This library contains mocking data for running unit tests.
-*/
-
-'use strict'
-
-const mockList = {
-  t: [
-    {
-      tokenDetails: {
-        tokenIdHex:
-          'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
-        documentUri: '',
-        documentSha256: '',
-        symbol: 'NAKAMOTO',
-        name: 'NAKAMOTO',
-        decimals: 8
-      },
-      tokenStats: {
-        qty_valid_txns_since_genesis: 241,
-        qty_valid_token_utxos: 151,
-        qty_valid_token_addresses: 113,
-        qty_token_circulating_supply: '20995990',
-        qty_token_burned: '4010',
-        qty_token_minted: '21000000',
-        qty_satoshis_locked_up: 81900
-      }
-    }
-  ]
-}
-
-const mockSingleToken = {
-  t: [
-    {
-      tokenDetails: {
-        decimals: 0,
-        tokenIdHex:
-          '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-        timestamp: '2019-06-14 06:31:37',
-        timestamp_unix: 1560493897,
-        transactionType: 'GENESIS',
-        versionType: 1,
-        documentUri: 'ot@ot.com',
-        documentSha256Hex: null,
-        symbol: 'OT',
-        name: 'Test First SLP oasis Token',
-        batonVout: 2,
-        containsBaton: true,
-        genesisOrMintQuantity: '10000',
-        sendOutputs: null
-      },
-      tokenStats: {
-        block_created: 1308634,
-        block_last_active_send: 1308655,
-        block_last_active_mint: 1308636,
-        qty_valid_txns_since_genesis: 11,
-        qty_valid_token_utxos: 9,
-        qty_valid_token_addresses: 2,
-        qty_token_minted: '20000',
-        qty_token_burned: '0',
-        qty_token_circulating_supply: '20000',
-        qty_satoshis_locked_up: 4914,
-        minting_baton_status: 'ALIVE'
-      }
-    }
-  ]
-}
-
-const mockSingleTokenError = {
-  t: []
-}
-
-const mockSingleAddress = {
-  g: [
-    {
-      _id: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
-      balanceString: '0.002382',
-      slpAddress: 'simpleledger:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5me5fdrdn'
-    }
-  ],
-  t: [
-    {
-      tokenDetails: {
-        decimals: 6,
-        tokenIdHex:
-          'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f'
-      }
-    }
-  ]
-}
-
-const mockTx = {
-  txid: '57b3082a2bf269b3d6f40fee7fb9c664e8256a88ca5ee2697c05b9457822d446',
-  version: 2,
-  locktime: 0,
-  vin: [
-    {
-      txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
-      vout: 2,
-      sequence: 4294967295,
-      n: 0,
-      scriptSig: {
-        hex:
-          '4730440220409e79fec552f01203f41d3d621ae3db89c720af261c8268ce5f0453de009f5d022001e7ffefeba7b0716d32ea55cb6ace267b6ee9cbcc8a017bb9c3b6acf7889418412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
-        asm:
-          '30440220409e79fec552f01203f41d3d621ae3db89c720af261c8268ce5f0453de009f5d022001e7ffefeba7b0716d32ea55cb6ace267b6ee9cbcc8a017bb9c3b6acf7889418[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
-      },
-      value: 546,
-      legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
-      cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
-    },
-    {
-      txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
-      vout: 1,
-      sequence: 4294967295,
-      n: 1,
-      scriptSig: {
-        hex:
-          '483045022100a743bee56c99bd103be48a78fa4c7342100815d9d2448dbe6e1d338c3a13b241022066728b5279fc22eef5cd019582ff34771e29175835fc98aa3168a1548fd78ac8412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
-        asm:
-          '3045022100a743bee56c99bd103be48a78fa4c7342100815d9d2448dbe6e1d338c3a13b241022066728b5279fc22eef5cd019582ff34771e29175835fc98aa3168a1548fd78ac8[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
-      },
-      value: 546,
-      legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
-      cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
-    },
-    {
-      txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
-      vout: 3,
-      sequence: 4294967295,
-      n: 2,
-      scriptSig: {
-        hex:
-          '483045022100821473902eec5f1ce7d43b1ba7f9ec453bfe8b8dfc3de3e0723c883ab109922f02206162960e80618531fab2c16aee260fddd7979bab62471c8686af7de75f8732ec412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
-        asm:
-          '3045022100821473902eec5f1ce7d43b1ba7f9ec453bfe8b8dfc3de3e0723c883ab109922f02206162960e80618531fab2c16aee260fddd7979bab62471c8686af7de75f8732ec[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
-      },
-      value: 9997521,
-      legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
-      cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
-    }
-  ],
-  vout: [
-    {
-      value: '0.00000000',
-      n: 0,
-      scriptPubKey: {
-        hex:
-          '6a04534c500001010453454e44207ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796080000000049504f80080000001c71e64280',
-        asm:
-          'OP_RETURN 5262419 1 1145980243 7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796 0000000049504f80 0000001c71e64280'
-      },
-      spentTxId: null,
-      spentIndex: null,
-      spentHeight: null
-    },
-    {
-      value: '0.00000546',
-      n: 1,
-      scriptPubKey: {
-        hex: '76a914396b8e57ad0cb58d30e2992f22047b3c20377aa688ac',
-        asm:
-          'OP_DUP OP_HASH160 396b8e57ad0cb58d30e2992f22047b3c20377aa6 OP_EQUALVERIFY OP_CHECKSIG',
-        addresses: ['mkkZf7T3fU3vHSzNPy51HBmM46ghN1gnN9'],
-        type: 'pubkeyhash'
-      },
-      spentTxId: null,
-      spentIndex: null,
-      spentHeight: null
-    },
-    {
-      value: '0.00000546',
-      n: 2,
-      scriptPubKey: {
-        hex: '76a914aa099b067337dc20993bbfdb5c4f3c6867ba2c5b88ac',
-        asm:
-          'OP_DUP OP_HASH160 aa099b067337dc20993bbfdb5c4f3c6867ba2c5b OP_EQUALVERIFY OP_CHECKSIG',
-        addresses: ['mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL'],
-        type: 'pubkeyhash'
-      },
-      spentTxId: null,
-      spentIndex: null,
-      spentHeight: null
-    },
-    {
-      value: '0.09996891',
-      n: 3,
-      scriptPubKey: {
-        hex: '76a914aa099b067337dc20993bbfdb5c4f3c6867ba2c5b88ac',
-        asm:
-          'OP_DUP OP_HASH160 aa099b067337dc20993bbfdb5c4f3c6867ba2c5b OP_EQUALVERIFY OP_CHECKSIG',
-        addresses: ['mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL'],
-        type: 'pubkeyhash'
-      },
-      spentTxId: null,
-      spentIndex: null,
-      spentHeight: null
-    }
-  ],
-  blockhash: '000000000000ce978accc64a6bb567acf0c653c202309a0f8e220149bf0c6968',
-  blockheight: 1287490,
-  confirmations: 746,
-  time: 1550855104,
-  blocktime: 1550855104,
-  valueOut: 0.09997983,
-  size: 628,
-  valueIn: 0.09998613,
-  fees: 0.0000063,
-  tokenInfo: {
-    versionType: 1,
-    transactionType: 'SEND',
-    tokenIdHex:
-      '7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796',
-    sendOutputs: ['0', '1230000000', '122170000000']
-  },
-  tokenIsValid: true
-}
-
-const mockConvert = {
-  slpAddress: 'slptest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2shlcycvd5',
-  cashAddress: 'bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf',
-  legacyAddress: 'mvQPGnzRT6gMWASZBMg7NcT3vmvsSKSQtf'
-}
-
-const mockTokenDetails = {
-  tokenIdHex:
-    'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
-  documentUri: '',
-  symbol: 'NAKAMOTO',
-  name: 'NAKAMOTO',
-  decimals: 8,
-  timestamp: '',
-  containsBaton: true,
-  versionType: 1
-}
-
-const mockTokenStats = {
-  qty_valid_txns_since_genesis: 241,
-  qty_valid_token_utxos: 151,
-  qty_valid_token_addresses: 113,
-  qty_token_circulating_supply: '20995990',
-  qty_token_burned: '4010',
-  qty_token_minted: '21000000',
-  qty_satoshis_locked_up: 81900
-}
-
-const mockBalance = {
-  _id: 'simpleledger:qp9d8mn8ypryfvea2mev0ggc3wg6plpn4suuaeuss3',
-  token_balance: '1000'
-}
-
-const mockTransactions = [
-  {
-    txid: 'a302f045be8efa1cd982833a7f187ff4fac8baac36da0c887eb2787d8b45e2af',
-    tokenDetails: {
-      valid: true,
-      detail: {
-        decimals: null,
-        tokenIdHex:
-          '495322b37d6b2eae81f045eda612b95870a0c2b6069c58f70cf8ef4e6a9fd43a',
-        timestamp: null,
-        transactionType: 'MINT',
-        versionType: 1,
-        documentUri: null,
-        documentSha256Hex: null,
-        symbol: null,
-        name: null,
-        batonVout: 2,
-        containsBaton: true,
-        genesisOrMintQuantity: {
-          $numberDecimal: '1000'
-        },
-        sendOutputs: null
-      },
-      invalidReason: null,
-      schema_version: 30
-    }
-  }
-]
-
-const mockFoobar = {
-  c: [],
-  u: []
-}
-
-const mockSingleValidTxid = {
-  c: [
-    {
-      _id: '5d965fc27f1cf2184ca2fe73',
-      tx: {
-        h: '77872738b6bddee6c0cbdb9509603de20b15d4f6b26602f629417aec2f5d5e8d'
-      },
-      slp: {
-        valid: true,
-        invalidReason: null
-      }
-    }
-  ],
-  u: []
-}
-
-const mockTwoValidTxid = {
-  c: [
-    {
-      _id: '5d965fc27f1cf2184ca2fe73',
-      tx: {
-        h: '77872738b6bddee6c0cbdb9509603de20b15d4f6b26602f629417aec2f5d5e8d'
-      },
-      slp: {
-        valid: true,
-        invalidReason: null
-      }
-    },
-    {
-      _id: '5d71e69758380a002c492a90',
-      tx: {
-        h: '552112f9e458dc7d1d8b328b0a6685e8af74a64b60b6846e7c86407f27f47e42'
-      },
-      slp: {
-        valid: true,
-        invalidReason: null
-      }
-    }
-  ],
-  u: []
-}
-
-const mockTwoRedundentTxid = {
-  c: [
-    {
-      _id: '5db99c72a391ae2afd604bde',
-      tx: {
-        h: 'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56'
-      },
-      slp: {
-        valid: true,
-        invalidReason: null
-      }
-    }
-  ],
-  u: []
-}
-
-const mockTxHistory = [
-  {
-    tx: {
-      h: '3a7646b3976a8745928c7192c8dde989bfa275fa6d7bce950180ab8002cf6cef'
-    },
-    in: [
-      {
-        i: 0,
-        e: {
-          h: '7bdd586ebd1e5f3dfd5295ab6e896c48b25855ab77a72c035ce1e7aacc965c2d',
-          i: 1,
-          s: 'RzBEAiAsu5o9EnxgZChjxKygxhGLhlfxJJbQfd4PP/vp2od3fAIgPpMqg+Sp4YpiInQZ6weJwELq8LEIrHXJpueBz7yF5gRBIQLsyL3809mRphc/+tPAcTQO5bi0kqZRFKpKIHXE3qN8Rw==',
-          a: 'simpleledger:qrrrpqmdkggpnw0czwg0jgcjd7yhu25jy5zxh2gqdq'
-        }
-      },
-      {
-        i: 1,
-        e: {
-          h: 'df49feff24dc34a10a44a0cbd7c908d964801ec7218512c84574fbce698535f0',
-          i: 3,
-          s: 'SDBFAiEAhW3zbKTlPrOXD2E2oEcNof6vCMPGYIg8vOVSE9c8IakCIFLg/gxydG9eL8HMAzkScGElKWJRnfhVMpMHU3evNcrZQSEDRS7F+pSC8OxSldsT4FctJLZBU7f2+FDiE05ae1xqtN0=',
-          a: 'simpleledger:qpkpeqfslejw5pptzcy25h2jxhsc9k0vts43n26up0'
-        }
-      }
-    ],
-    out: [
-      {
-        e: {
-          v: 0,
-          i: 0,
-          s: 'agRTTFAAAQEEU0VORCA46XxdfTWFosvz+VgMgsozmF+csIRdTcziIMtwn5U4sAgAAAAAAJiWgAgAAAAAJHfU+g=='
-        }
-      },
-      {
-        e: {
-          v: 546,
-          i: 1,
-          s: 'dqkUqo4lVohqOK6rDd7nIIkFQ6Uf41aIrA==',
-          a: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza'
-        }
-      },
-      {
-        e: {
-          v: 546,
-          i: 2,
-          s: 'dqkUgYSfxf90wVkERCiOMyh16iB4d92IrA==',
-          a: 'simpleledger:qzqcf879la6vzkgygs5guvegwh4zq7rhm5nu0pljjl'
-        }
-      },
-      {
-        e: {
-          v: 21849,
-          i: 3,
-          s: 'dqkUxjCDbbIQGbn4E5D5IxJviX4qkiWIrA==',
-          a: 'simpleledger:qrrrpqmdkggpnw0czwg0jgcjd7yhu25jy5zxh2gqdq'
-        }
-      }
-    ],
-    slp: {
-      detail: {
-        decimals: 8,
-        tokenIdHex: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-        transactionType: 'SEND',
-        versionType: 1,
-        documentUri: 'psfoundation.cash',
-        documentSha256Hex: null,
-        symbol: 'PSF',
-        name: 'Permissionless Software Foundation',
-        txnBatonVout: null,
-        txnContainsBaton: false,
-        outputs: [
-          {
-            address: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza',
-            amount: '0.1'
-          },
-          {
-            address: 'simpleledger:qzqcf879la6vzkgygs5guvegwh4zq7rhm5nu0pljjl',
-            amount: '6.11833082'
-          }
-        ]
-      }
-    },
-    blk: {
-      h: '000000000000000001a47bf337ca211c1e7218234d0d70117c64d6f213f5dacb',
-      i: 634833,
-      t: 1589300214
-    }
-  },
-  {
-    tx: {
-      h: '3b11b48cab1e7c8384facf482b3f6bfe659a58245ab4aa4147b42b5cb2a5fac5'
-    },
-    in: [
-      {
-        i: 0,
-        e: {
-          h: 'e4e1e1f6b502cbd42f69b919634cea3e37fc8595e6ca800e0a7d8f6dcdfb249e',
-          i: 3,
-          s: 'SDBFAiEAjCGRmU28x24LMTwg5XqC+fLf3zGhTYCsSWpmF8Eshq0CIAJhxAKMbwKWC4ASmjWzplpno2ch+hGNUD6HNWOdbd4SQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
-          a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
-        }
-      },
-      {
-        i: 1,
-        e: {
-          h: '438420345dd8b7fb4ea74aaf2e3090f44899bf3c71662243946a441de6dae720',
-          i: 2,
-          s: 'SDBFAiEAhmLYL4QY3mvZo3/i0XG9PJAYMruw3MaGOLJ3Z4si7hwCIAaaGwRnj/cZK3L/KKFBoMtItpGRZ10GowNN//vgn6PKQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
-          a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
-        }
-      }
-    ],
-    out: [
-      {
-        e: {
-          v: 0,
-          i: 0,
-          s: 'agRTTFAAAQEEU0VORCCk+1wtoaoGTiUBikP5FlBABx2emEuhkMIip/WQU6+EsggAAAAAAA9CQAgAAAAXQnHEwA=='
-        }
-      },
-      {
-        e: {
-          v: 546,
-          i: 1,
-          s: 'dqkUqo4lVohqOK6rDd7nIIkFQ6Uf41aIrA==',
-          a: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza'
-        }
-      },
-      {
-        e: {
-          v: 546,
-          i: 2,
-          s: 'dqkUWQQVny9pv6Y+76cSYzoNltwufoiIrA==',
-          a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
-        }
-      },
-      {
-        e: {
-          v: 43074,
-          i: 3,
-          s: 'dqkUWQQVny9pv6Y+76cSYzoNltwufoiIrA==',
-          a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
-        }
-      }
-    ],
-    slp: {
-      detail: {
-        decimals: 2,
-        tokenIdHex: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
-        transactionType: 'SEND',
-        versionType: 1,
-        documentUri: 'troutsblog.com',
-        documentSha256Hex: null,
-        symbol: 'TROUT',
-        name: "Trout's test token",
-        txnBatonVout: null,
-        txnContainsBaton: false,
-        outputs: [
-          {
-            address: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza',
-            amount: '10000'
-          },
-          {
-            address: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7',
-            amount: '998990000'
-          }
-        ]
-      }
-    },
-    blk: {
-      h: '000000000000000002a4ee2ed6fe8a764ffef0b2556f545ca0b3ef39ecd2b7c4',
-      i: 634832,
-      t: 1589297145
-    }
-  }
-]
-
-module.exports = {
-  mockList,
-  mockSingleToken,
-  mockConvert,
-  mockTokenDetails,
-  mockTokenStats,
-  mockTx,
-  mockBalance,
-  mockTransactions,
-  mockSingleTokenError,
-  mockSingleAddress,
-  mockFoobar,
-  mockSingleValidTxid,
-  mockTwoValidTxid,
-  mockTwoRedundentTxid,
-  mockTxHistory
-}

test/v3/rate-limits.js

@@ -1,460 +0,0 @@
-'use strict'
-
-const chai = require('chai')
-const assert = chai.assert
-// const nock = require('nock') // HTTP mocking
-const sinon = require('sinon')
-
-// Used for debugging.
-const util = require('util')
-util.inspect.defaultOptions = { depth: 1 }
-
-// Mocking data.
-const { mockReq, mockRes, mockNext } = require('./mocks/express-mocks')
-
-// Libraries under test
-const RateLimits = require('../../src/middleware/route-ratelimit')
-let rateLimits = new RateLimits()
-
-// const controlRoute = require('../../src/routes/v3/full-node/control')
-const jwtAuth = require('../../src/middleware/jwt-auth')
-
-let req, res, next
-// let originalEnvVars // Used during transition from integration to unit tests.
-
-// JWT token used in tests.
-const jwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkYWRlM2Y1NzM5ZTZjMGZmMDM0YjlhMSIsImlhdCI6MTU3MTY3NzQ1MCwiZXhwIjoxNTc0MjY5NDUwfQ.SSz7F7ETyBB3eoNG2VKCzPOhddtB-vrtmEoj7PxicrQ'
-
-describe('#route-ratelimits & jwt-auth', () => {
-  let sandbox
-
-  before(async () => {
-    // Save existing environment variables.
-    // originalEnvVars = {
-    //   BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
-    //   RPC_BASEURL: process.env.RPC_BASEURL,
-    //   RPC_USERNAME: process.env.RPC_USERNAME,
-    //   RPC_PASSWORD: process.env.RPC_PASSWORD
-    // }
-
-    if (!process.env.JWT_AUTH_SERVER) { process.env.JWT_AUTH_SERVER = 'http://fakeurl.com/' }
-
-    // Wipe the Redis DB, which prevents false negatives when running integration
-    // tests back-to-back.
-    await rateLimits.wipeRedis()
-  })
-
-  // Setup the mocks before each test.
-  beforeEach(() => {
-    // Mock the req and res objects used by Express routes.
-    req = Object.assign({}, mockReq)
-    res = Object.assign({}, mockRes)
-    next = mockNext
-
-    // Explicitly reset the parmas and body.
-    req.params = {}
-    req.body = {}
-    req.query = {}
-    req.locals = {}
-
-    sandbox = sinon.createSandbox()
-  })
-
-  afterEach(() => {
-    sandbox.restore()
-  })
-
-  after(() => {
-    rateLimits.closeRedis()
-  })
-
-  describe('#jwt-auth.js', () => {
-    describe('#getTokenFromHeaders', () => {
-      it('should populate the req.locals object correctly', () => {
-        // Initialize req.locals
-        req.locals = {
-          proLimit: false,
-          apiLevel: 0
-        }
-
-        const header = `Token ${jwt}`
-        req.headers.authorization = header
-
-        jwtAuth.getTokenFromHeaders(req, res, next)
-
-        // console.log(`req.locals: ${JSON.stringify(req.locals, null, 2)}`)
-
-        assert.property(req.locals, 'proLimit')
-        assert.property(req.locals, 'apiLevel')
-        assert.property(req.locals, 'jwtToken')
-        assert.equal(req.locals.jwtToken, jwt)
-      })
-    })
-  })
-
-  describe('#getResource', () => {
-    it('should decode a blockchain request', () => {
-      const url =
-        '/blockchain/getTxOut/62a3ea958a463a372bc0caf2c374a7f60be9c624be63a0db8db78f05809df6d8/0?include_mempool=true'
-
-      const result = rateLimits.getResource(url)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.equal(result, 'blockchain')
-    })
-  })
-
-  describe('#calcPoints', () => {
-    it('should return 30 points for anonymous user', () => {
-      const result = rateLimits.calcPoints()
-      // console.log(`result: ${result}`)
-
-      assert.equal(result, 30)
-    })
-
-    it('should return 10 points for free tier requesting full node access', () => {
-      const jwtInfo = {
-        apiLevel: 10,
-        resource: 'blockchain',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 10 points for free tier requesting indexer access', () => {
-      const jwtInfo = {
-        apiLevel: 10,
-        resource: 'blockbook',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 10 points for free tier requesting SLPDB access', () => {
-      const jwtInfo = {
-        apiLevel: 10,
-        resource: 'slp',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 1 point for full node tier requesting full node access', () => {
-      const jwtInfo = {
-        apiLevel: 20,
-        resource: 'blockchain',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-
-    it('should return 10 points for full-node tier requesting indexer access', () => {
-      const jwtInfo = {
-        apiLevel: 20,
-        resource: 'blockbook',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 10 points for full node tier requesting SLPDB access', () => {
-      const jwtInfo = {
-        apiLevel: 20,
-        resource: 'slp',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 1 point for indexer tier requesting full node access', () => {
-      const jwtInfo = {
-        apiLevel: 30,
-        resource: 'blockchain',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-
-    it('should return 1 points for indexer tier requesting indexer access', () => {
-      const jwtInfo = {
-        apiLevel: 30,
-        resource: 'blockbook',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-
-    it('should return 10 points for indexer tier requesting SLPDB access', () => {
-      const jwtInfo = {
-        apiLevel: 30,
-        resource: 'slp',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 10)
-    })
-
-    it('should return 1 point for SLP tier requesting full node access', () => {
-      const jwtInfo = {
-        apiLevel: 40,
-        resource: 'blockchain',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-
-    it('should return 1 points for SLP tier requesting indexer access', () => {
-      const jwtInfo = {
-        apiLevel: 40,
-        resource: 'blockbook',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-
-    it('should return 1 points for SLP tier requesting SLPDB access', () => {
-      const jwtInfo = {
-        apiLevel: 40,
-        resource: 'slp',
-        id: '5e3a0415eb29a962da2708b4'
-      }
-
-      const result = rateLimits.calcPoints(jwtInfo)
-      assert.equal(result, 1)
-    })
-  })
-
-  describe('#rateLimitByResource', () => {
-    // NOTE: this test will fail if you run multiple integration tests in a
-    // short period. Because it talks to the Redis DB.
-    it('should pass through rate-limit middleware', async () => {
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      // Call the route twice to trigger the rate handling.
-      await rateLimits.rateLimitByResource(req, res, next)
-      await rateLimits.rateLimitByResource(req, res, next)
-
-      // next() will be called if rate-limit is not triggered
-      assert.equal(next.called, true)
-    })
-
-    it('should trigger rate-limit handler if rate limits exceeds 5 request per minute', async () => {
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      for (let i = 0; i < 5; i++) {
-        next.reset() // reset the stubbed next() function.
-
-        await rateLimits.rateLimitByResource(req, res, next)
-        // console.log(`next() called: ${next.called}`)
-      }
-
-      // Note: next() will be called unless the rate-limit kicks in.
-      assert.equal(
-        next.called,
-        false,
-        'next should not be called if rate limit was triggered.'
-      )
-    })
-
-    it('should NOT trigger rate-limit for free-tier at 5 RPM', async () => {
-      // Create a new instance of the rate limit so we start with zeroed tracking.
-      rateLimits = new RateLimits()
-
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      req.locals.jwtToken = 'some-token'
-
-      const jwtInfo = {
-        apiLevel: 10,
-        id: '5e3a0415eb29a962da2708b1'
-      }
-
-      // Mock the call to the jwt library.
-      sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
-
-      for (let i = 0; i < 5; i++) {
-        next.reset() // reset the stubbed next() function.
-
-        await rateLimits.rateLimitByResource(req, res, next)
-        // console.log(`next() called: ${next.called}`)
-      }
-
-      // console.log(`req.locals after test: ${util.inspect(req.locals)}`)
-
-      // Note: next() will be called unless the rate-limit kicks in.
-      assert.equal(
-        next.called,
-        true,
-        'next should be called if rate limit was not triggered.'
-      )
-    })
-
-    it('should trigger rate-limit for free tier after 10 RPM', async () => {
-      // Create a new instance of the rate limit so we start with zeroed tracking.
-      rateLimits = new RateLimits()
-
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      req.locals.jwtToken = 'some-token'
-
-      const jwtInfo = {
-        apiLevel: 10,
-        id: '5e3a0415eb29a962da2708b2'
-      }
-
-      // Mock the call to the jwt library.
-      sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
-
-      for (let i = 0; i < 12; i++) {
-        next.reset() // reset the stubbed next() function.
-
-        await rateLimits.rateLimitByResource(req, res, next)
-        // console.log(`next() called: ${next.called}`)
-      }
-
-      // Note: next() will be called unless the rate-limit kicks in.
-      assert.equal(
-        next.called,
-        false,
-        'next should not be called if rate limit was triggered.'
-      )
-    })
-
-    it('should NOT trigger rate-limit handler for indexer-tier at 25 RPM', async () => {
-      // Create a new instance of the rate limit so we start with zeroed tracking.
-      rateLimits = new RateLimits()
-
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      req.locals.jwtToken = 'some-token'
-
-      const jwtInfo = {
-        apiLevel: 20,
-        id: '5e3a0415eb29a962da2708b3'
-      }
-
-      // Mock the call to the jwt library.
-      sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
-
-      for (let i = 0; i < 25; i++) {
-        next.reset() // reset the stubbed next() function.
-
-        await rateLimits.rateLimitByResource(req, res, next)
-        // console.log(`next() called: ${next.called}`)
-      }
-
-      // console.log(`req.locals after test: ${util.inspect(req.locals)}`)
-
-      // Note: next() will be called unless the rate-limit kicks in.
-      assert.equal(
-        next.called,
-        true,
-        'next should be called if rate limit was not triggered.'
-      )
-    })
-
-    it('should still rate-limit at a higher RPM for pro-tier', async () => {
-      // Create a new instance of the rate limit so we start with zeroed tracking.
-      rateLimits = new RateLimits()
-
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      req.locals.jwtToken = 'some-token'
-
-      const jwtInfo = {
-        apiLevel: 20,
-        id: '5e3a0415eb29a962da2708b5'
-      }
-
-      // Mock the call to the jwt library.
-      sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
-
-      for (let i = 0; i < 150; i++) {
-        next.reset() // reset the stubbed next() function.
-
-        await rateLimits.rateLimitByResource(req, res, next)
-        // console.log(`next() called: ${next.called}`)
-      }
-
-      // console.log(`req.locals after test: ${util.inspect(req.locals)}`)
-
-      // Note: next() will be called unless the rate-limit kicks in.
-      assert.equal(
-        next.called,
-        false,
-        'next should NOT be called if rate limit was triggered.'
-      )
-    })
-
-    it('should handle misconfigured token secret', async () => {
-      // Create a new instance of the rate limit so we start with zeroed tracking.
-      rateLimits = new RateLimits()
-
-      req.baseUrl = '/v3'
-      req.path = '/control/getNetworkInfo'
-      req.url = req.path
-      req.method = 'GET'
-
-      req.locals.jwtToken = 'some-token'
-
-      next.reset() // reset the stubbed next() function.
-
-      await rateLimits.rateLimitByResource(req, res, next)
-
-      // Issues with token secret should treat incoming requests as anonymous
-      // calls with 30 points or 3 RPM.
-      assert.equal(res.locals.pointsToConsume, 30)
-    })
-  })
-})
-
-// Generates a Basic authorization header.
-// function generateAuthHeader (pass) {
-//   // https://en.wikipedia.org/wiki/Basic_access_authentication
-//   const username = 'BITBOX'
-//   const combined = `${username}:${pass}`
-//
-//   var base64Credential = Buffer.from(combined).toString('base64')
-//   var readyCredential = `Basic ${base64Credential}`
-//
-//   return readyCredential
-// }

test/v5/bcash-slp.js

@@ -0,0 +1,244 @@
+/*
+  TESTS FOR THE bcash/slp.js LIBRARY
+*/
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+
+const sinon = require('sinon')
+
+const BcashSlp = require('../../src/routes/v5/bcash/slp')
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+const mockData = require('./mocks/bcash-slp-mock')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+if (!process.env.BCASH_SERVER) process.env.BCASH_SERVER = 'http://localhost'
+
+describe('#bcash-slp', () => {
+  let req, res
+  let sandbox
+  const bcashSlp = new BcashSlp()
+  // let electrumxRoute
+
+  before(async () => {
+    if (!process.env.TEST) {
+      process.env.TEST = 'unit'
+    }
+    console.log(`Testing type is: ${process.env.TEST}`)
+
+    if (!process.env.NETWORK) process.env.NETWORK = 'testnet'
+
+    // Connect to electrumx servers if this is an integration test.
+    // if (process.env.TEST === 'integration') {
+    //   await electrumxRoute.connect()
+    //   console.log('Connected to ElectrumX server')
+    // }
+  })
+
+  after(async () => {
+    // console.log(`electrumxRoute.electrumx: `, electrumxRoute.electrumx)
+    // Disconnect from the electrumx server if this is an integration test.
+    // if (process.env.TEST === 'integration') {
+    //   await electrumxRoute.disconnect()
+    //   console.log('Disconnected from ElectrumX server')
+    // }
+  })
+
+  // 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()
+
+    // electrumxRoute = new ElecrumxRoute()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  after(() => {
+    //
+  })
+
+  describe('#root', () => {
+    // root route handler.
+    const root = bcashSlp.root
+
+    it('should respond to GET for base route', async () => {
+      const result = root(req, res)
+
+      assert.equal(result.status, 'bcash-slp', 'Returns static string')
+    })
+  })
+
+  describe('#getUtxos', () => {
+    it('should return UTXOs for an address, hydrated with SLP info', async () => {
+      sandbox.stub(bcashSlp.axios, 'get').resolves({ data: mockData.utxos })
+      sandbox.stub(bcashSlp, 'getTokenInfo').resolves(mockData.tokenInfo)
+      req.params.address =
+        'bitcoincash:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk'
+
+      const utxos = await bcashSlp.getUtxos(req, res)
+      assert.isArray(utxos)
+      const utxo = utxos[0]
+
+      assert.property(utxo, 'version')
+      assert.property(utxo, 'height')
+      assert.property(utxo, 'value')
+      assert.property(utxo, 'script')
+      assert.property(utxo, 'address')
+      assert.property(utxo, 'coinbase')
+      assert.property(utxo, 'hash')
+      assert.property(utxo, 'index')
+      assert.property(utxo, 'slp')
+
+      assert.property(utxo.slp, 'tokenId')
+      assert.property(utxo.slp, 'ticker')
+      assert.property(utxo.slp, 'name')
+      assert.property(utxo.slp, 'uri')
+      assert.property(utxo.slp, 'hash')
+      assert.property(utxo.slp, 'decimals')
+      assert.property(utxo.slp, 'vout')
+      assert.property(utxo.slp, 'value')
+      assert.property(utxo.slp, 'type')
+    })
+    it('should handle error if address is array', async () => {
+      req.params.address = [
+        'bchtest:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk'
+      ]
+
+      const result = await bcashSlp.getUtxos(req, res)
+      assert.include(
+        result.error,
+        'address can not be an array. Use POST for bulk upload.'
+      )
+    })
+    it('should throw error if address has invalid format', async () => {
+      sandbox.stub(bcashSlp.routeUtils, 'validateNetwork').returns(false)
+
+      req.params.address = 'qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk'
+
+      const result = await bcashSlp.getUtxos(req, res)
+      assert.include(
+        result.error,
+        'Invalid network. Trying to use a testnet address on mainnet'
+      )
+    })
+    it('should catch axios error', async () => {
+      sandbox.stub(bcashSlp.axios, 'get').throws(new Error('test error'))
+      req.params.address =
+        'bitcoincash:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk'
+      const result = await bcashSlp.getUtxos(req, res)
+      assert.include(result.error, 'test error')
+    })
+  })
+
+  describe('#hydrateUTXOS', () => {
+    it('should hydrate slp utxos', async () => {
+      sandbox.stub(bcashSlp, 'getTokenInfo').resolves(mockData.tokenInfo)
+
+      const hydratedUtxos = await bcashSlp.hydrateUTXOS(mockData.utxos)
+      assert.isArray(hydratedUtxos)
+      const hydratedUtxo = hydratedUtxos[0]
+      assert.property(hydratedUtxo, 'version')
+      assert.property(hydratedUtxo, 'height')
+      assert.property(hydratedUtxo, 'value')
+      assert.property(hydratedUtxo, 'script')
+      assert.property(hydratedUtxo, 'address')
+      assert.property(hydratedUtxo, 'coinbase')
+      assert.property(hydratedUtxo, 'hash')
+      assert.property(hydratedUtxo, 'index')
+      assert.property(hydratedUtxo, 'slp')
+
+      assert.property(hydratedUtxo.slp, 'tokenId')
+      assert.property(hydratedUtxo.slp, 'ticker')
+      assert.property(hydratedUtxo.slp, 'name')
+      assert.property(hydratedUtxo.slp, 'uri')
+      assert.property(hydratedUtxo.slp, 'hash')
+      assert.property(hydratedUtxo.slp, 'decimals')
+      assert.property(hydratedUtxo.slp, 'vout')
+      assert.property(hydratedUtxo.slp, 'value')
+      assert.property(hydratedUtxo.slp, 'type')
+    })
+
+    it('should throw error if utxos is not provided', async () => {
+      try {
+        await bcashSlp.hydrateUTXOS()
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'UTXOs must be an array of slp utxos')
+      }
+    })
+    it('should handle error', async () => {
+      try {
+        sandbox.stub(bcashSlp, 'getTokenInfo').throws(new Error('test error'))
+
+        await bcashSlp.getTokenInfo(mockData.utxos)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getTokenInfo', () => {
+    it('should return SLP info for an token id', async () => {
+      sandbox.stub(bcashSlp.axios, 'get').resolves({ data: mockData.tokenInfo })
+
+      const tokenId =
+        'afd88e9afab110e7b75410417edb5c98798c08aa892cee8d97b44f2e5545a900'
+      const slpInfo = await bcashSlp.getTokenInfo(tokenId)
+      assert.isObject(slpInfo)
+      assert.property(slpInfo, 'tokenId')
+      assert.property(slpInfo, 'ticker')
+      assert.property(slpInfo, 'name')
+      assert.property(slpInfo, 'uri')
+      assert.property(slpInfo, 'hash')
+      assert.property(slpInfo, 'decimals')
+    })
+    it('should throw error if token id is not provided', async () => {
+      try {
+        await bcashSlp.getTokenInfo()
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'tokenId must be string')
+      }
+    })
+    it('should catch axios error', async () => {
+      try {
+        sandbox.stub(bcashSlp.axios, 'get').throws(new Error('test error'))
+        const tokenId =
+          'afd88e9afab110e7b75410417edb5c98798c08aa892cee8d97b44f2e5545a900'
+        await bcashSlp.getTokenInfo(tokenId)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'test error')
+      }
+    })
+  })
+  describe('#errorHandler', () => {
+    it('should handle unexpected errors', () => {
+      sandbox.stub(bcashSlp.routeUtils, 'decodeError').returns({ msg: false })
+
+      const result = bcashSlp.errorHandler(new Error('test error'), res)
+      // console.log('result: ', result)
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.property(result, 'error')
+    })
+  })
+})

test/v5/blockchain.js

@@ -12,7 +12,7 @@ const chai = require('chai')
 const assert = chai.assert
 const sinon = require('sinon')
 
-const Blockchain = require('../../src/routes/v3/full-node/blockchain')
+const Blockchain = require('../../src/routes/v5/full-node/blockchain')
 const uut = new Blockchain()
 
 const util = require('util')
@@ -456,7 +456,7 @@ describe('#BlockchainRouter', () => {
 
     it('should throw 400 error if addresses array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.hashes = testArray
 
@@ -821,6 +821,7 @@ describe('#BlockchainRouter', () => {
       ])
     })
   })
+
   describe('getRawMempool()', () => {
     it('should throw 503 when network issues', async () => {
       // Save the existing RPC URL.
@@ -842,6 +843,7 @@ describe('#BlockchainRouter', () => {
         'Error message expected'
       )
     })
+
     it('returns proper error when downstream service stalls', async () => {
       // Mock the timeout error.
       sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
@@ -856,6 +858,7 @@ describe('#BlockchainRouter', () => {
         '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' })
@@ -871,7 +874,7 @@ describe('#BlockchainRouter', () => {
       )
     })
 
-    it('should GET /getMempoolInfo', async () => {
+    it('should GET /getRawMempool', async () => {
       // Mock the RPC call for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
@@ -886,6 +889,7 @@ describe('#BlockchainRouter', () => {
       // Not sure what other assertions should be made here.
     })
   })
+
   describe('getMempoolEntrySingle()', () => {
     it('should throw 400 if txid is empty', async () => {
       const result = await uut.getMempoolEntrySingle(req, res)
@@ -1002,7 +1006,7 @@ describe('#BlockchainRouter', () => {
 
     it('should throw 400 error if addresses array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.txids = testArray
 
@@ -1521,7 +1525,7 @@ describe('#BlockchainRouter', () => {
 
     it('should throw 400 error if addresses array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.txids = testArray
 
@@ -1725,7 +1729,7 @@ describe('#BlockchainRouter', () => {
 
     it('should throw 400 error if addresses array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.proofs = testArray
 
@@ -1819,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/v5/control.js

@@ -11,7 +11,7 @@
 
 const chai = require('chai')
 const assert = chai.assert
-const ControlRoute = require('../../src/routes/v3/full-node/control')
+const ControlRoute = require('../../src/routes/v5/full-node/control')
 const uut = new ControlRoute()
 const sinon = require('sinon')
 

test/v5/dsproof.js

@@ -0,0 +1,190 @@
+/*
+  TESTS FOR THE DSPROOF.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 DSProofRoute = require('../../src/routes/v5/full-node/dsproof')
+const uut = new DSProofRoute()
+
+// const nock = require('nock') // HTTP mocking
+const sinon = require('sinon')
+
+let originalEnvVars // Used during transition from integration to unit tests.
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+const mockData = require('./mocks/dsproof-mocks')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+describe('#DSProof', () => {
+  let req, res
+  let sandbox
+  before(() => {
+    // Save existing environment variables.
+    originalEnvVars = {
+      BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
+      RPC_BASEURL: process.env.RPC_BASEURL,
+      RPC_USERNAME: process.env.RPC_USERNAME,
+      RPC_PASSWORD: process.env.RPC_PASSWORD
+    }
+
+    // Set default environment variables for unit tests.
+    if (!process.env.TEST) process.env.TEST = 'unit'
+    if (process.env.TEST === 'unit') {
+      process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
+      process.env.RPC_BASEURL = 'http://fakeurl/api'
+      process.env.RPC_USERNAME = 'fakeusername'
+      process.env.RPC_PASSWORD = 'fakepassword'
+    }
+  })
+
+  // 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()
+  })
+
+  afterEach(() => {
+    // Restore Sandbox
+    sandbox.restore()
+  })
+
+  after(() => {
+    // Restore any pre-existing environment variables.
+    process.env.BITCOINCOM_BASEURL = originalEnvVars.BITCOINCOM_BASEURL
+    process.env.RPC_BASEURL = originalEnvVars.RPC_BASEURL
+    process.env.RPC_USERNAME = originalEnvVars.RPC_USERNAME
+    process.env.RPC_PASSWORD = originalEnvVars.RPC_PASSWORD
+  })
+
+  describe('#root', async () => {
+    // root route handler.
+    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, 'dsproof', 'Returns static string')
+    })
+  })
+
+  describe('#getDSProof', async () => {
+    it('should throw 400 error if txid  is missing', async () => {
+      const result = await uut.getDSProof(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'txid can not be empty')
+    })
+    it('should throw 400 error if txid is invalid', async () => {
+      req.params.txid = 'abc123'
+
+      const result = await uut.getDSProof(req, res)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.include(result.error, 'txid must be of length 64')
+    })
+    it('should throw 503 when network issues', async () => {
+      req.params.txid =
+        'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.RPC_BASEURL
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.RPC_BASEURL = 'http://fakeurl/api/'
+
+      await uut.getDSProof(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.RPC_BASEURL = savedUrl2
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+    it('returns proper error when downstream service stalls', async () => {
+      req.params.txid =
+        'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getDSProof(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 () => {
+      req.params.txid =
+        'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getDSProof(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 double-spend proof', async function () {
+      req.params.txid =
+        'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(uut.axios, 'request')
+          .resolves({ data: { result: mockData.mockGetDsProof } })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getDSProof(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.property(result, 'dspid')
+      assert.property(result, 'txid')
+      assert.property(result, 'outpoint')
+      assert.property(result, 'path')
+      assert.property(result, 'descendants')
+
+      assert.property(result.outpoint, 'txid')
+      assert.property(result.outpoint, 'vout')
+    })
+  })
+})

test/v5/encryption.js

@@ -19,7 +19,7 @@ const sinon = require('sinon')
 if (!process.env.TEST) process.env.TEST = 'unit'
 
 // Only load blockbook library after setting BLOCKBOOK_URL env var.
-const EncryptionRoute = require('../../src/routes/v3/encryption')
+const EncryptionRoute = require('../../src/routes/v5/encryption')
 const encryptionRoute = new EncryptionRoute()
 
 // Mocking data.
@@ -78,11 +78,11 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
-          .resolves(mockData.mockBalance)
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
+          .resolves(mockData.mockFulcrumTxHistory)
         sandbox
-          .stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
-          .resolves(mockData.mockTxDetails)
+          .stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
+          .resolves([mockData.mockTxDetails2])
       }
 
       const result = await encryptionRoute.getPublicKey(req, res)
@@ -105,12 +105,12 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
-          .resolves(mockData.mockNoTxHistory)
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
+          .resolves(mockData.mockFulcrumNoTxHistory)
       }
 
       const result = await encryptionRoute.getPublicKey(req, res)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.property(result, 'success')
       assert.equal(result.success, false)
@@ -126,11 +126,11 @@ describe('#Encryption Router', () => {
       // Mock the Insight URL for unit tests.
       if (process.env.TEST === 'unit') {
         sandbox
-          .stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
-          .resolves(mockData.mockNoSendBalance)
+          .stub(encryptionRoute.bchjs.Electrumx, 'transactions')
+          .resolves(mockData.mockFulcrumNoSendBalance)
         sandbox
-          .stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
-          .resolves(mockData.mockNoSendTx)
+          .stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
+          .resolves([mockData.mockNoSendTx])
       }
 
       const result = await encryptionRoute.getPublicKey(req, res)

test/v5/integration/nft.js

@@ -0,0 +1,114 @@
+/*
+  These integration tests need to be run against a live SLPDB. They query
+  against a live SLPDB and test the results against known token stats.
+ */
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+// const axios = require('axios')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+// Exit if SLPDB URL is not defined.
+if (!process.env.SLPDB_URL) {
+  throw new Error(
+    'SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.'
+  )
+}
+
+const SLP = require('../../../src/routes/v4/slp')
+const slp = new SLP()
+
+const { mockReq, mockRes } = require('../mocks/express-mocks')
+
+describe('#nft', () => {
+  let req, res
+
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = mockReq
+    res = mockRes
+  })
+
+  describe('#getNftChildren', () => {
+    it('should return error on non-existing NFT group token', async () => {
+      req.params.tokenId =
+        '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0b'
+      const result = await slp.getNftChildren(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.include(
+        result.error,
+        'NFT group does not exists',
+        'Error message expected'
+      )
+    })
+    it('should return error on non-group NFT token', async () => {
+      req.params.tokenId =
+        '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+
+      const result = await slp.getNftChildren(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.include(
+        result.error,
+        'NFT group does not exists',
+        'Error message expected'
+      )
+    })
+    it('should get NFT children list', async () => {
+      req.params.tokenId =
+        '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
+
+      const result = await slp.getNftChildren(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isArray(result.nftChildren)
+      assert.equal(result.nftChildren.length, 2)
+      assert.equal(
+        result.nftChildren[0],
+        '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+      )
+      assert.equal(
+        result.nftChildren[1],
+        '928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
+      )
+    })
+  })
+
+  describe('#getNftGroup', () => {
+    it('should return error on non-existing NFT child token', async () => {
+      req.params.tokenId =
+        '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a8'
+      const result = await slp.getNftGroup(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.include(
+        result.error,
+        'NFT child does not exists',
+        'Error message expected'
+      )
+    })
+    it('should get NFT group token info', async () => {
+      req.params.tokenId =
+        '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+      // req.params.tokenId = '928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
+      const result = await slp.getNftGroup(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+      assert.property(result, 'nftGroup')
+      assert.property(result.nftGroup, 'id')
+      assert.property(result.nftGroup, 'versionType')
+      assert.property(result.nftGroup, 'symbol')
+      assert.equal(
+        result.nftGroup.id,
+        '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
+      )
+      assert.equal(result.nftGroup.versionType, 129)
+      assert.equal(result.nftGroup.symbol, 'PSF.TEST.GROUP')
+    })
+  })
+})

test/v5/integration/price.js

@@ -0,0 +1,53 @@
+/*
+  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/v4/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)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+
+  describe('#getBCHAUSD', () => {
+    it('should get the USD price of BCHA', async () => {
+      const result = await price.getBCHAUSD(req, res)
+      console.log(`result: ${util.inspect(result)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+  describe('#getBCHUSD', () => {
+    it('should get the USD price of BCH', async () => {
+      const result = await price.getBCHUSD(req, res)
+      console.log(`result: ${util.inspect(result)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+})

test/v5/integration/rate-limits.js

@@ -0,0 +1,164 @@
+/*
+  These tests have been deprecated. To test bch-api rate limits, run the e2e
+  tests in the bch-js repository.
+ */
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+const axios = require('axios')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+// const SERVER = `http://192.168.0.36:12400/v4/`
+const SERVER = 'http://localhost:3000/v4/'
+// const SERVER = 'https://api.fullstack.cash/v4/'
+//
+// const TEST_JWT =
+//   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
+
+describe('#JWT rate limits', () => {
+  it('should get control/getNetworkInfo() with no auth', async () => {
+    const options = {
+      method: 'GET',
+      url: `${SERVER}control/getNetworkInfo`
+    }
+
+    const result = await axios(options)
+    // console.log(`result.status: ${result.status}`)
+    // console.log(`result.data: ${util.inspect(result.data)}`)
+
+    assert.equal(result.status, 200)
+    assert.hasAnyKeys(result.data, ['version'])
+  })
+
+  it('should trigger rate-limit handler if rate limits exceeds 20 request per minute', async () => {
+    try {
+      const options = {
+        method: 'GET',
+        url: `${SERVER}control/getNetworkInfo`
+      }
+
+      const promises = []
+      for (let i = 0; i < 30; i++) {
+        const promise = axios(options)
+        promises.push(promise)
+      }
+
+      await Promise.all(promises)
+
+      assert.fail('Unexpected result!')
+    } catch (err) {
+      console.log('err: ', err)
+
+      assert.equal(err.response.status, 429)
+      assert.include(err.response.data.error, 'Too many requests')
+    }
+  })
+
+  // it('should not trigger rate-limit handler if correct pro-tier password is used', async () => {
+  //   try {
+  //     const username = 'BITBOX'
+  //
+  //     // Pro-tier is accessed by using the right password.
+  //     const password = 'BITBOX'
+  //     // const password = "something"
+  //
+  //     const combined = `${username}:${password}`
+  //     const base64Credential = Buffer.from(combined).toString('base64')
+  //     const readyCredential = `Basic ${base64Credential}`
+  //
+  //     const options = {
+  //       method: 'GET',
+  //       url: `${SERVER}control/getNetworkInfo`,
+  //       headers: { Authorization: readyCredential }
+  //     }
+  //
+  //     const promises = []
+  //     for (let i = 0; i < 30; i++) {
+  //       const promise = axios(options)
+  //       promises.push(promise)
+  //     }
+  //
+  //     await Promise.all(promises)
+  //
+  //     assert.equal(true, true, 'Not throwing an error is a pass!')
+  //   } catch (err) {
+  //     // console.log(`err.response: ${util.inspect(err.response)}`)
+  //
+  //     assert.equal(
+  //       true,
+  //       false,
+  //       'This error handler should not have been triggered. Is the password correct?'
+  //     )
+  //   }
+  // })
+
+  // it('should trigger rate-limit handler if rate limits exceeds pro-tier limit', async () => {
+  //   try {
+  //     const username = 'BITBOX'
+  //
+  //     // Pro-tier is accessed by using the right password.
+  //     const password = 'BITBOX'
+  //     // const password = "something"
+  //
+  //     const combined = `${username}:${password}`
+  //     const base64Credential = Buffer.from(combined).toString('base64')
+  //     const readyCredential = `Basic ${base64Credential}`
+  //
+  //     // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
+  //     const options = {
+  //       method: 'GET',
+  //       url: `${SERVER}control/getNetworkInfo`,
+  //       headers: { Authorization: readyCredential }
+  //     }
+  //
+  //     const promises = []
+  //     for (let i = 0; i < 80; i++) {
+  //       const promise = axios(options)
+  //       promises.push(promise)
+  //     }
+  //
+  //     await Promise.all(promises)
+  //
+  //     assert.equal(true, false, 'Unexpected result!')
+  //   } catch (err) {
+  //     // console.log(`err.response: ${util.inspect(err.response)}`)
+  //
+  //     assert.equal(err.response.status, 429)
+  //     assert.include(err.response.data.error, 'Too many requests')
+  //   }
+  // })
+
+  // it('should unlock pro-tier for a valid JWT token', async () => {
+  //   try {
+  //     // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
+  //     const options = {
+  //       method: 'GET',
+  //       url: `${SERVER}control/`,
+  //       headers: {
+  //         Authorization: `Token ${TEST_JWT}`
+  //       }
+  //     }
+  //
+  //     const promises = []
+  //     for (let i = 0; i < 60; i++) {
+  //       const promise = axios(options)
+  //       promises.push(promise)
+  //     }
+  //
+  //     await Promise.all(promises)
+  //
+  //     // assert.equal(true, false, "Unexpected result!")
+  //     assert.equal(true, true, 'Not throwing an error is a pass!')
+  //   } catch (err) {
+  //     console.log(`err.response: ${util.inspect(err.response)}`)
+  //
+  //     assert.equal(true, false, 'Unexpected result!')
+  //   }
+  //   // Override default timeout for this test.
+  // }).timeout(20000)
+})

test/v5/integration/raw-transactions.js

@@ -7,21 +7,22 @@
   TODO:
   -/rawtransactions/sendRawTransaction is more appropropriate for an e2e test,
   so it is omitted here.
+  - Replace request-promise with axios.
 */
 
 'use strict'
 
-const chai = require('chai')
-const assert = chai.assert
+// const chai = require('chai')
+// const assert = chai.assert
 // const rawtransactions = require('../../../dist/routes/v2/rawtransactions')
-const rp = require('request-promise')
+// const rp = require('request-promise')
 
 // Used for debugging.
 const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
 // const mockData = require('../mocks/raw-transactions-mocks')
-
+/*
 describe('#Raw-Transactions', () => {
   describe('#root', () => {
     it('should return root', async () => {
@@ -189,3 +190,4 @@ describe('#Raw-Transactions', () => {
     })
   })
 })
+*/

test/v5/integration/slp.js

@@ -0,0 +1,461 @@
+/*
+  These integration tests need to be run against a live SLPDB. They query
+  against a live SLPDB and test the results against known token stats.
+ */
+
+'use strict'
+
+const assert = require('chai').assert
+// const axios = require('axios')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+// Exit if SLPDB URL is not defined.
+if (!process.env.SLPDB_URL) {
+  throw new Error(
+    'SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.'
+  )
+}
+
+const SLP = require('../../../src/routes/v4/slp')
+const slp = new SLP()
+
+const BCHJS = require('@psf/bch-js')
+const bchjs = new BCHJS()
+
+const { mockReq, mockRes } = require('../mocks/express-mocks')
+
+describe('#slp', () => {
+  let req, res
+
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = mockReq
+    res = mockRes
+  })
+
+  describe('#tokenStats', () => {
+    it('should get token stats for token with no mint baton', async () => {
+      req.params.tokenId =
+        '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7'
+      // 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      const result = await slp.tokenStats(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Assert that expected properties exist.
+      assert.property(result, 'decimals')
+      assert.property(result, 'timestamp')
+      assert.property(result, 'versionType')
+      assert.property(result, 'documentUri')
+      assert.property(result, 'symbol')
+      assert.property(result, 'name')
+      assert.property(result, 'containsBaton')
+      assert.property(result, 'id')
+      assert.property(result, 'documentHash')
+      assert.property(result, 'initialTokenQty')
+      assert.property(result, 'blockCreated')
+      assert.property(result, 'blockLastActiveSend')
+      assert.property(result, 'blockLastActiveMint')
+      assert.property(result, 'txnsSinceGenesis')
+      assert.property(result, 'validAddresses')
+      assert.property(result, 'mintingBatonStatus')
+      assert.property(result, 'timestampUnix')
+      assert.property(result, 'totalMinted')
+      assert.property(result, 'totalBurned')
+      assert.property(result, 'circulatingSupply')
+
+      // baton was never created.
+      assert.equal(result.containsBaton, false)
+    })
+
+    it('should get token stats for token with a mint baton', async () => {
+      req.params.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      const result = await slp.tokenStats(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Assert that expected properties exist.
+      assert.property(result, 'decimals')
+      assert.property(result, 'timestamp')
+      assert.property(result, 'versionType')
+      assert.property(result, 'documentUri')
+      assert.property(result, 'symbol')
+      assert.property(result, 'name')
+      assert.property(result, 'containsBaton')
+      assert.property(result, 'id')
+      assert.property(result, 'documentHash')
+      assert.property(result, 'initialTokenQty')
+      assert.property(result, 'blockCreated')
+      assert.property(result, 'blockLastActiveSend')
+      assert.property(result, 'blockLastActiveMint')
+      assert.property(result, 'txnsSinceGenesis')
+      assert.property(result, 'validAddresses')
+      assert.property(result, 'mintingBatonStatus')
+      assert.property(result, 'timestampUnix')
+      assert.property(result, 'totalMinted')
+      assert.property(result, 'totalBurned')
+      assert.property(result, 'circulatingSupply')
+
+      // baton was created.
+      assert.equal(result.containsBaton, true)
+    })
+  })
+
+  describe('#generateSendOpReturn', () => {
+    it('should return OP_RETURN script', async () => {
+      req.body.tokenUtxos = [
+        {
+          tokenId:
+            '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+          decimals: 8,
+          tokenQty: 2
+        }
+      ]
+      req.body.sendQty = 1.5
+
+      const result = await slp.generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['script', 'outputs'])
+      assert.isNumber(result.outputs)
+    })
+  })
+
+  describe('#hydrateUtxos', () => {
+    it('should return utxo details', async () => {
+      const 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
+            }
+          ]
+        }
+      ]
+
+      req.body.utxos = utxos
+      const result = await slp.hydrateUtxos(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Test the general structure of the output.
+      assert.isArray(result.slpUtxos)
+      assert.equal(result.slpUtxos.length, 1)
+      assert.equal(result.slpUtxos[0].utxos.length, 2)
+
+      // Test the non-slp UTXO.
+      assert.property(result.slpUtxos[0].utxos[0], 'txid')
+      assert.property(result.slpUtxos[0].utxos[0], 'vout')
+      assert.property(result.slpUtxos[0].utxos[0], 'value')
+      assert.property(result.slpUtxos[0].utxos[0], 'height')
+      assert.property(result.slpUtxos[0].utxos[0], 'confirmations')
+      assert.property(result.slpUtxos[0].utxos[0], 'satoshis')
+      assert.property(result.slpUtxos[0].utxos[0], 'isValid')
+      assert.equal(result.slpUtxos[0].utxos[0].isValid, false)
+
+      // Test the slp UTXO.
+      assert.property(result.slpUtxos[0].utxos[1], 'txid')
+      assert.property(result.slpUtxos[0].utxos[1], 'vout')
+      assert.property(result.slpUtxos[0].utxos[1], 'value')
+      assert.property(result.slpUtxos[0].utxos[1], 'height')
+      assert.property(result.slpUtxos[0].utxos[1], 'confirmations')
+      assert.property(result.slpUtxos[0].utxos[1], 'satoshis')
+      assert.property(result.slpUtxos[0].utxos[1], 'isValid')
+      assert.equal(result.slpUtxos[0].utxos[1].isValid, true)
+      assert.property(result.slpUtxos[0].utxos[1], 'transactionType')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenId')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenTicker')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenName')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentUrl')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentHash')
+      assert.property(result.slpUtxos[0].utxos[1], 'decimals')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenType')
+      assert.property(result.slpUtxos[0].utxos[1], 'tokenQty')
+    })
+
+    it('should process data directly from Electrumx', async () => {
+      const addrs = [
+        'bitcoincash:qq6mvsm7l92d77zpymmltvaw09p5uzghyuyx7spygg',
+        'bitcoincash:qpjdrs8qruzh8xvusdfmutjx62awcepnhyperm3g89',
+        'bitcoincash:qzygn28zpgeemnptkn26xzyuzzfu9l8f9vfvq7kptk'
+      ]
+
+      const utxos = await bchjs.Electrumx.utxo(addrs)
+      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
+
+      req.body.utxos = utxos.utxos
+      const result = await slp.hydrateUtxos(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Test the general structure of the output.
+      assert.isArray(result.slpUtxos)
+      assert.equal(result.slpUtxos.length, 3)
+      assert.equal(result.slpUtxos[0].utxos.length, 1)
+      assert.equal(result.slpUtxos[1].utxos.length, 1)
+      assert.equal(result.slpUtxos[2].utxos.length, 2)
+    })
+  })
+
+  describe('#hydrateUtxosWL', () => {
+    it('should return utxo details', async () => {
+      const utxos = [
+        {
+          utxos: [
+            {
+              tx_hash:
+                '89b3f0c84efe8b01b24e2d7ac08636de5781f31dbb84478e3de868ca0a7ed93a',
+              tx_pos: 1,
+              value: 546
+            }
+          ]
+        }
+      ]
+
+      req.body.utxos = utxos
+      const result = await slp.hydrateUtxosWL(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Test the general structure of the output.
+      assert.isArray(result.slpUtxos)
+      assert.equal(result.slpUtxos.length, 1)
+      assert.equal(result.slpUtxos[0].utxos.length, 1)
+
+      // Test the non-slp UTXO.
+      assert.property(result.slpUtxos[0].utxos[0], 'tx_hash')
+      assert.property(result.slpUtxos[0].utxos[0], 'tx_pos')
+      assert.property(result.slpUtxos[0].utxos[0], 'value')
+      assert.property(result.slpUtxos[0].utxos[0], 'isValid')
+      assert.equal(result.slpUtxos[0].utxos[0].isValid, true)
+    })
+  })
+
+  describe('#validate2Single', () => {
+    it('should invalidate a known invalid TXID', async () => {
+      const txid =
+        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
+
+      req.params.txid = txid
+      const result = await slp.validate2Single(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.txid, txid)
+      assert.equal(result.isValid, false)
+    })
+
+    it('should validate a known valid TXID', async () => {
+      const txid =
+        '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
+
+      req.params.txid = txid
+      const result = await slp.validate2Single(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.txid, txid)
+      assert.equal(result.isValid, true)
+    })
+
+    // CT 10-11-2020: This test is valid, but because of the cacheing built
+    // into slp-validate, it will not consistently pass or fail. To manually
+    // Run this test, re-start slp-api or find a token txid with a long DAG.
+    // it('should cancel if validation takes too long', async () => {
+    //   const txid =
+    //     'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
+    //
+    //   req.params.txid = txid
+    //   const result = await slp.validate2Single(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'
+    //   )
+    // })
+  })
+
+  describe('#validateBulk', () => {
+    it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
+      const txids = [
+        // Malformed SLP tx
+        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
+        // Normal TX (non-SLP)
+        '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
+        // Valid PSF SLP tx
+        'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
+        // Valid SLP token not in whitelist
+        '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
+        // Token send on BCHN network.
+        '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
+        // Token send on ABC network.
+        '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
+        // Known invalid SLP token send of PSF tokens.
+        '2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
+      ]
+
+      req.body.txids = txids
+      const result = await slp.validateBulk(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // BCHN expected results
+      if (process.env.ISBCHN) {
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, true)
+
+        // Note: This should change from null to true once SLPDB finishes indexing.
+        assert.equal(result[4].txid, txids[4])
+        assert.equal(result[4].valid, null)
+
+        assert.equal(result[5].txid, txids[5])
+        assert.equal(result[5].valid, null)
+
+        assert.equal(result[6].txid, txids[6])
+        assert.equal(result[6].valid, false)
+        assert.include(
+          result[6].invalidReason,
+          'Token outputs are greater than valid token inputs'
+        )
+      } else {
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, true)
+
+        assert.equal(result[4].txid, txids[4])
+        assert.equal(result[4].valid, null)
+
+        assert.equal(result[5].txid, txids[5])
+        assert.equal(result[5].valid, true)
+
+        assert.equal(result[6].txid, txids[6])
+        assert.equal(result[6].valid, false)
+        assert.include(
+          result[6].invalidReason,
+          'Token outputs are greater than valid token inputs'
+        )
+      }
+    })
+  })
+
+  describe('#validate3Bulk', () => {
+    it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
+      const txids = [
+        // Malformed SLP tx
+        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
+        // Normal TX (non-SLP)
+        '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
+        // Valid PSF SLP tx
+        'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
+        // Valid SLP token not in whitelist
+        '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
+        // Token send on BCHN network.
+        '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
+        // Token send on ABC network.
+        '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
+        // Known invalid SLP token send of PSF tokens.
+        '2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
+      ]
+
+      req.body.txids = txids
+      const result = await slp.validate3Bulk(req, res)
+      console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // BCHN expected results
+      if (process.env.ISBCHN) {
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, null)
+
+        // Note: This should change from null to true once SLPDB finishes indexing.
+        assert.equal(result[4].txid, txids[4])
+        assert.equal(result[4].valid, null)
+
+        assert.equal(result[5].txid, txids[5])
+        assert.equal(result[5].valid, null)
+
+        assert.equal(result[6].txid, txids[6])
+        assert.equal(result[6].valid, false)
+        assert.include(
+          result[6].invalidReason,
+          'Token outputs are greater than valid token inputs'
+        )
+      } else {
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, true)
+
+        assert.equal(result[4].txid, txids[4])
+        assert.equal(result[4].valid, null)
+
+        assert.equal(result[5].txid, txids[5])
+        assert.equal(result[5].valid, true)
+
+        assert.equal(result[6].txid, txids[6])
+        assert.equal(result[6].valid, false)
+        assert.include(
+          result[6].invalidReason,
+          'Token outputs are greater than valid token inputs'
+        )
+      }
+    })
+  })
+
+  describe('#getStatus', () => {
+    it('should get the SLPDB status', async () => {
+      const result = await slp.getStatus(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'bchBlockHeight')
+    })
+  })
+})

test/v5/integration/slpdb.js

@@ -18,7 +18,7 @@ if (!process.env.SLPDB_URL) {
   throw new Error('SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.')
 }
 
-const SLPDB = require('../../../src/routes/v3/services/slpdb')
+const SLPDB = require('../../../src/routes/v4/services/slpdb')
 const slpdb = new SLPDB()
 
 describe('#slpdb', () => {

test/v5/jwt.js

@@ -0,0 +1,101 @@
+/*
+  TESTS FOR THE JWT.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 JWTRoute = require('../../src/routes/v5/jwt')
+const uut = new JWTRoute()
+const sinon = require('sinon')
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+// const mockData = require('./mocks/control-mock')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+describe('#JWTRouter', () => {
+  let req, res
+  let sandbox
+
+  before(() => {
+    // Set default environment variables for unit tests.
+  })
+
+  // 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()
+  })
+
+  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, 'jwt', 'Returns static string')
+    })
+  })
+
+  describe('#jwtInfo', () => {
+    it('should decode the JWT token', async () => {
+      const jwtToken =
+        'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwZWM3NTY1YTM4ZjkyMjdlOWVjNTM3MCIsImVtYWlsIjoidGVzdHVzZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjAsInJhdGVMaW1pdCI6MywicG9pbnRzVG9Db25zdW1lIjo1MDAsImR1cmF0aW9uIjozMCwiaWF0IjoxNjI2MTA5MzQ4LCJleHAiOjE2Mjg3MDEzNDh9.hF8BKU-1SvlvQBnTNbB65ErQTtNSl-pWlRANSJY-Zb4'
+      req.body.jwt = jwtToken
+
+      const result = await uut.jwtInfo(req, res)
+      // console.log('result: ', result)
+
+      assert.equal(result.error, 'jwt expired')
+
+      // assert.property(result, 'id')
+      // assert.property(result, 'email')
+      // assert.property(result, 'apiLevel')
+      // assert.property(result, 'rateLimit')
+      // assert.property(result, 'pointsToConsume')
+      // assert.property(result, 'duration')
+      // assert.property(result, 'iat')
+      // assert.property(result, 'exp')
+      // assert.property(result, 'expiration')
+      // assert.property(result, 'createdAt')
+    })
+
+    it('should return an error with malformed JWT token', async () => {
+      const jwtToken =
+        'eyJhbGciOiJIUzI1NiLsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwZWM3NTY1YTM4ZjkyMjdlOWVjNTM3MCIsImVtYWlsIjoidGVzdHVzZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjAsInJhdGVMaW1pdCI6MywicG9pbnRzVG9Db25zdW1lIjo1MDAsImR1cmF0aW9uIjozMCwiaWF0IjoxNjI2MTA5MzQ4LCJleHAiOjE2Mjg3MDEzNDh9.hF8BKU-1SvlvQBnTNbB65ErQTtNSl-pWlRANSJY-Zb4'
+      req.body.jwt = jwtToken
+
+      const result = await uut.jwtInfo(req, res)
+      // console.log('result: ', result)
+
+      assert.equal(result.error, 'invalid token')
+    })
+  })
+})

test/v5/mining.js

@@ -10,7 +10,7 @@
 
 const chai = require('chai')
 const assert = chai.assert
-const MiningRoute = require('../../src/routes/v3/full-node/mining')
+const MiningRoute = require('../../src/routes/v5/full-node/mining')
 const uut = new MiningRoute()
 
 // const nock = require('nock') // HTTP mocking

test/v5/mocks/bcash-slp-mock.js

@@ -0,0 +1,71 @@
+/*
+  This library contains mocking data for running unit tests on the bcash route.
+*/
+
+const tokenInfo = {
+  tokenId: 'c7cb019764df3a352d9433749330b4b2eb022d8fbc101e68a6943a7a58a8ee84',
+  ticker: 'PSI',
+  name: 'Psidium',
+  uri: '',
+  hash: '',
+  decimals: 8
+}
+
+const utxos = [
+  {
+    version: 2,
+    height: 707135,
+    value: 546,
+    script: '76a91466b2156f71629c89f5bf882cb3920b0e1e4d4fa888ac',
+    address: 'bitcoincash:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk',
+    coinbase: false,
+    hash: '77e514d59c0c866e791d08ddab73a1f7827be5f1ca15c1e05515dac9b271b596',
+    index: 2,
+    slp: {
+      vout: 2,
+      tokenId:
+        '5f2914840d0fd82689bdf0a0f8194ea363b9d0e2bd69b01608e18e1c6a4b9861',
+      value: '9999777700000',
+      type: 'SEND'
+    }
+  },
+  {
+    version: 2,
+    height: 707135,
+    value: 546,
+    script: '76a91466b2156f71629c89f5bf882cb3920b0e1e4d4fa888ac',
+    address: 'bitcoincash:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk',
+    coinbase: false,
+    hash: '350aab06bf9523c062692f62622cb28b18cff9e4aa92be5476143336da217e98',
+    index: 1,
+    slp: {
+      vout: 1,
+      tokenId:
+        '2d860662801067828be3c4f504ce31b2a1a36c2cdbc6d92f6160920f66b0a9ee',
+      value: '1',
+      type: 'SEND'
+    }
+  },
+  {
+    version: 2,
+    height: 687335,
+    value: 546,
+    script: '76a91466b2156f71629c89f5bf882cb3920b0e1e4d4fa888ac',
+    address: 'bitcoincash:qpnty9t0w93fez04h7yzevujpv8pun204qv6yfuahk',
+    coinbase: false,
+    hash: 'b7a0f52a344b1169292c757a36c62dbdaaa4ad684e96837eec732a9a2033dfd1',
+    index: 1,
+    slp: {
+      vout: 1,
+      tokenId:
+        'c7cb019764df3a352d9433749330b4b2eb022d8fbc101e68a6943a7a58a8ee84',
+      value: '100000000',
+      type: 'SEND'
+    }
+  }
+]
+
+module.exports = {
+  tokenInfo,
+  utxos
+}

test/v5/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/v5/mocks/dsproof-mocks.js

@@ -0,0 +1,22 @@
+/*
+  This library contains mocking data for running unit tests on the dsproof route.
+*/
+
+'use strict'
+
+const mockGetDsProof = {
+  dspid: '6234fff2a9dbcaa50e2c50d74e1d725a2bed1757d7a05a2db7a82df659554397',
+  txid: 'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e',
+  outpoint: {
+    txid: '17ebef34f7e9a0692317dd6fbb43ffccff45b7d688a2a754dbccfc5e6d93ce3e',
+    vout: 1
+  },
+  path: ['ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'],
+  descendants: [
+    'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+  ]
+}
+
+module.exports = {
+  mockGetDsProof
+}

test/v5/mocks/electrumx-mock.js

@@ -0,0 +1,221 @@
+/*
+  Mocking data for electrumx unit tests
+*/
+
+'use strict'
+
+const utxos = [
+  {
+    height: 604392,
+    tx_hash: '7774e449c5a3065144cefbc4c0c21e6b69c987f095856778ef9f45ddd8ae1a41',
+    tx_pos: 0,
+    value: 1000
+  },
+  {
+    height: 630834,
+    tx_hash: '4fe60a51e0d8f5134bfd8e5f872d6e502d7f01b28a6afebb27f4438a4f638d53',
+    tx_pos: 0,
+    value: 6000
+  }
+]
+
+const utxosArray = {
+  success: true,
+  utxos: [
+    {
+      utxos: [
+        {
+          height: 601861,
+          tx_hash:
+            '6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d',
+          tx_pos: 0,
+          value: 1000
+        }
+      ],
+      address: 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+    },
+    {
+      utxos: [
+        {
+          height: 604392,
+          tx_hash:
+            '7774e449c5a3065144cefbc4c0c21e6b69c987f095856778ef9f45ddd8ae1a41',
+          tx_pos: 0,
+          value: 1000
+        },
+        {
+          height: 630834,
+          tx_hash:
+            '4fe60a51e0d8f5134bfd8e5f872d6e502d7f01b28a6afebb27f4438a4f638d53',
+          tx_pos: 0,
+          value: 6000
+        }
+      ],
+      address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+    }
+  ]
+}
+
+const balance = {
+  success: true,
+  balance: {
+    confirmed: 7000,
+    unconfirmed: 0
+  }
+}
+const balances = {
+  success: true,
+  balances: [
+    {
+      balance: { confirmed: 7000, unconfirmed: 0 },
+      address: 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+    },
+    {
+      balance: { confirmed: 7000, unconfirmed: 0 },
+      address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+    }
+  ]
+}
+const txHistory = [
+  {
+    height: 601861,
+    tx_hash: '6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d'
+  }
+]
+
+const mempool = [
+  {
+    tx_hash: '45381031132c57b2ff1cbe8d8d3920cf9ed25efd9a0beb764bdb2f24c7d1c7e3',
+    height: 0,
+    fee: 24310
+  }
+]
+
+const txDetails = {
+  blockhash: '0000000000000000002aaf94953da3b487317508ebd1003a1d75d6d6ec2e75cc',
+  blocktime: 1578327094,
+  confirmations: 31861,
+  hash: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
+  hex:
+    '020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000',
+  locktime: 0,
+  size: 392,
+  time: 1578327094,
+  txid: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
+  version: 2,
+  vin: [
+    {
+      scriptSig: {
+        asm:
+          'dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e[ALL|FORKID] 020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309',
+        hex:
+          '41dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309'
+      },
+      sequence: 4294967295,
+      txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
+      vout: 1
+    },
+    {
+      scriptSig: {
+        asm:
+          '347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f77[ALL|FORKID] 028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954',
+        hex:
+          '41347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954'
+      },
+      sequence: 4294967295,
+      txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
+      vout: 0
+    }
+  ],
+  vout: [
+    {
+      n: 0,
+      scriptPubKey: {
+        addresses: ['bitcoincash: pqvfecpwxvj53ayqfwkxtjaxsgpvnklcyg8xewk9hl'],
+        asm: 'OP_HASH160 189ce02e332548f4804bac65cba68202c9dbf822 OP_EQUAL',
+        hex: 'a914189ce02e332548f4804bac65cba68202c9dbf82287',
+        reqSigs: 1,
+        type: 'scripthash'
+      },
+      value: 0.0562057
+    },
+    {
+      n: 1,
+      scriptPubKey: {
+        addresses: ['bitcoincash: qq59hv6s3qdjrtyfwfxxldkuj9xsjmx48vrz882knz'],
+        asm:
+          'OP_DUP OP_HASH160 285bb350881b21ac89724c6fb6dc914d096cd53b OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914285bb350881b21ac89724c6fb6dc914d096cd53b88ac',
+        reqSigs: 1,
+        type: 'pubkeyhash'
+      },
+      value: 0.00589197
+    },
+    {
+      n: 2,
+      scriptPubKey: {
+        addresses: ['bitcoincash: qpzlruwy4xu5rxjs3z37nsj29y7h59gwvsu4ddp0u4'],
+        asm:
+          'OP_DUP OP_HASH160 45f1f1c4a9b9419a5088a3e9c24a293d7a150e64 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac',
+        reqSigs: 1,
+        type: 'pubkeyhash'
+      },
+      value: 0.03272697
+    }
+  ]
+}
+
+const txDetailsBulk = {
+  success: true,
+  transactions: [{ details: txDetails }]
+}
+
+const blockHeaders = [
+  '010000008b52bbd72c2f49569059f559c1b1794de5192e4f7d6d2b03c7482bad0000000083e4f8a9d502ed0c419075c1abb5d56f878a2e9079e5612bfb76a2dc37d9c42741dd6849ffff001d2b909dd6',
+  '01000000f528fac1bcb685d0cd6c792320af0300a5ce15d687c7149548904e31000000004e8985a786d864f21e9cbb7cbdf4bc9265fe681b7a0893ac55a8e919ce035c2f85de6849ffff001d385ccb7c'
+]
+
+const blockHeadersBulk = {
+  success: true,
+  headers: [{ headers: blockHeaders }, { headers: blockHeaders }]
+}
+
+const transactions = [
+  {
+    height: 603416,
+    tx_hash: 'eef683d236d88e978bd406419f144057af3fe1b62ef59162941c1a9f05ded62c'
+  },
+  {
+    height: 646894,
+    tx_hash: '4c695fae636f3e8e2edc571d11756b880ccaae744390f3950d798ce7b5e25754'
+  }
+]
+
+const transactionsBulk = {
+  success: true,
+  transactions: [
+    {
+      transactions,
+      address: 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+    },
+    {
+      transactions,
+      address: 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+    }
+  ]
+}
+module.exports = {
+  utxos,
+  utxosArray,
+  balance,
+  txHistory,
+  mempool,
+  txDetails,
+  txDetailsBulk,
+  blockHeaders,
+  blockHeadersBulk,
+  balances,
+  transactions,
+  transactionsBulk
+}

test/v5/mocks/encryption-mocks.js

@@ -0,0 +1,195 @@
+/*
+  Mock data for the encryption test library
+*/
+
+const mockNoSendTx = {
+  txid: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
+  hash: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
+  version: 2,
+  size: 226,
+  locktime: 0,
+  vin: [
+    {
+      txid: '681cc1d392975a7e78cbd490b8a940d7eb029c554f2cee332e3a7119d77fb189',
+      vout: 1,
+      scriptSig: {
+        asm:
+          '30450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f[ALL|FORKID] 02bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7',
+        hex:
+          '4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7'
+      },
+      sequence: 4294967295
+    }
+  ],
+  vout: [
+    {
+      value: 0.000006,
+      n: 0,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 3c79ba54317c4be9cbfa5aaf357f74b97f3d9696 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg']
+      }
+    },
+    {
+      value: 0.00003664,
+      n: 1,
+      scriptPubKey: {
+        asm:
+          'OP_DUP OP_HASH160 58502a73888e0a386fc69b44850af4b2a86ac9a6 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: ['bitcoincash:qpv9q2nn3z8q5wr0c6d5fpg27je2s6kf5cavp4ney0']
+      }
+    }
+  ],
+  hex:
+    '020000000189b17fd719713a2e33ee2c4f559c02ebd740a9b890d4cb787e5a9792d3c11c68010000006b4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7ffffffff0258020000000000001976a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac500e0000000000001976a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac00000000'
+}
+
+const mockFulcrumTxHistory = {
+  success: true,
+  transactions: [
+    {
+      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: [
+    {
+      transactions: [],
+      address: 'bitcoincash:qrgqqkky28jdkv3w0ctrah0mz3jcsnsklc34gtukrh'
+    }
+  ]
+}
+
+const mockFulcrumNoSendBalance = {
+  success: true,
+  transactions: [
+    {
+      transactions: [
+        {
+          height: 633578,
+          tx_hash:
+            'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
+        }
+      ]
+    }
+  ]
+}
+
+module.exports = {
+  mockNoSendTx,
+  mockFulcrumTxHistory,
+  mockTxDetails2,
+  mockFulcrumNoTxHistory,
+  mockFulcrumNoSendBalance
+}

test/v5/mocks/price-mock.js

@@ -0,0 +1,241 @@
+/*
+  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'
+    }
+  }
+}
+
+const mockCoinexFeed = {
+  code: 0,
+  data: {
+    date: 1605649499848,
+    ticker: {
+      vol: '26717.39062407',
+      low: '10.4000',
+      open: '11.8000',
+      high: '19.0029',
+      last: '18.5000',
+      buy: '18.0100',
+      buy_amount: '200.00000000',
+      sell: '18.5000',
+      sell_amount: '47.89580474'
+    }
+  },
+  message: 'OK'
+}
+
+module.exports = {
+  mockCoinbaseFeed,
+  mockCoinexFeed
+}

test/v5/mocks/psf-slp-indexer-mocks.js

@@ -0,0 +1,227 @@
+/*
+  This library contains mocking data for running unit tests on the psf-slp-indexer route.
+*/
+
+'use strict'
+
+const tokenStats = {
+  tokenData: {
+    type: 1,
+    ticker: 'TP03',
+    name: 'Test Plugin 03',
+    tokenId: '13cad617d523c8eb4ab11fff19c010e0e0a4ea4360b58e0c8c955a45a146a669',
+    documentUri: 'fullstack.cash',
+    documentHash: 'i\u0004���3��s\u0003�tz}�/��P�ǚ�Z>T��)��',
+    decimals: 0,
+    mintBatonIsActive: false,
+    tokensInCirculationBN: '1',
+    tokensInCirculationStr: '1',
+    blockCreated: 722420,
+    totalBurned: '0',
+    totalMinted: '1',
+    txs: [
+      {
+        txid: '13cad617d523c8eb4ab11fff19c010e0e0a4ea4360b58e0c8c955a45a146a669',
+        height: 722420,
+        type: 'GENESIS',
+        qty: '1'
+      }
+    ]
+  }
+}
+// txData generated by MDA
+const txDataByMDA = {
+  txData: {
+    txid: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    hash: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    version: 2,
+    size: 339,
+    locktime: 0,
+    vin: [
+      {
+        txid: '8370db30d94761ab9a11b71ecd22541151bf6125c8c613f0f6fab8ab794565a7',
+        vout: 0,
+        scriptSig: {
+          asm: '304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4[ALL|FORKID] 02791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851',
+          hex: '47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851'
+        },
+        sequence: 4294967295,
+        address: 'bitcoincash:qrg77j4jf2pl7azgvzrz2z567ls464gkuuhplt30dp',
+        value: 0.00051303,
+        tokenQty: 0,
+        tokenQtyStr: '0',
+        tokenId: null
+      }
+    ],
+    vout: [
+      {
+        value: 0,
+        n: 0,
+        scriptPubKey: {
+          asm: 'OP_RETURN 5262419 1 47454e45534953 54524f5554 54726f75742773207465737420746f6b656e 74726f757473626c6f672e636f6d 0 2 2 000000174876e800',
+          hex: '6a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e800',
+          type: 'nulldata'
+        },
+        tokenQtyStr: '0',
+        tokenQty: 0
+      }
+    ],
+    hex: '0200000001a7654579abb8faf6f013c6c82561bf51115422cd1eb7119aab6147d930db7083000000006a47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851ffffffff040000000000000000476a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e80022020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088ac22020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088accec20000000000001976a9145904159f2f69bfa63eefa712633a0d96dc2e7e8888ac00000000',
+    blockhash: '0000000000000000009f65225a3e12e23a7ea057c869047e0f36563a1f410267',
+    confirmations: 97398,
+    time: 1581773131,
+    blocktime: 1581773131,
+    blockheight: 622414,
+    isSlpTx: true,
+    tokenTxType: 'GENESIS',
+    tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    tokenType: 1,
+    tokenTicker: 'TROUT',
+    tokenName: "Trout's test token",
+    tokenDecimals: 2,
+    tokenUri: 'troutsblog.com',
+    tokenDocHash: '',
+    isValidSlp: true
+  }
+}
+
+const txData = {
+  txData: {
+    txid: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    hash: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    version: 2,
+    size: 339,
+    locktime: 0,
+    vin: [
+      {
+        txid: '8370db30d94761ab9a11b71ecd22541151bf6125c8c613f0f6fab8ab794565a7',
+        vout: 0,
+        scriptSig: {
+          asm: '304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4[ALL|FORKID] 02791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851',
+          hex: '47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851'
+        },
+        sequence: 4294967295,
+        address: 'bitcoincash:qrqy3kj7r822ps6628vwqq5k8hyjl6ey3y4eea2m4s',
+        value: 0.00051303,
+        tokenQty: 0,
+        tokenQtyStr: '0',
+        tokenId: null
+      }
+    ],
+    vout: [
+      {
+        value: 0,
+        n: 0,
+        scriptPubKey: {
+          asm: 'OP_RETURN 5262419 1 47454e45534953 54524f5554 54726f75742773207465737420746f6b656e 74726f757473626c6f672e636f6d 0 2 2 000000174876e800',
+          hex: '6a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e800',
+          type: 'nulldata'
+        },
+        tokenQtyStr: '0',
+        tokenQty: 0
+      }
+    ],
+    hex: '0200000001a7654579abb8faf6f013c6c82561bf51115422cd1eb7119aab6147d930db7083000000006a47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851ffffffff040000000000000000476a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e80022020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088ac22020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088accec20000000000001976a9145904159f2f69bfa63eefa712633a0d96dc2e7e8888ac00000000',
+    blockhash: '0000000000000000009f65225a3e12e23a7ea057c869047e0f36563a1f410267',
+    confirmations: 97398,
+    time: 1581773131,
+    blocktime: 1581773131,
+    blockheight: 622414,
+    isSlpTx: true,
+    tokenTxType: 'GENESIS',
+    tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+    tokenType: 1,
+    tokenTicker: 'TROUT',
+    tokenName: "Trout's test token",
+    tokenDecimals: 2,
+    tokenUri: 'troutsblog.com',
+    tokenDocHash: '',
+    isValidSlp: true
+  }
+}
+const balance = {
+  balance: {
+    utxos: [
+      {
+        txid: 'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
+        vout: 1,
+        type: 'token',
+        qty: '1800',
+        tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+        address: 'bitcoincash:qrqy3kj7r822ps6628vwqq5k8hyjl6ey3y4eea2m4s'
+      }
+    ],
+    txs: [
+      {
+        txid: '078b2c48ed1db0d5d5996f2889b8d847a49200d0a781f6aa6752f740f312688f',
+        height: 717796
+      },
+      {
+        txid: 'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
+        height: 717832
+      }
+    ],
+    balances: [
+      {
+        tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+        qty: '1800'
+      }
+    ]
+  }
+}
+const transactions = {
+  success: true,
+  transactions: [
+    {
+      height: 734439,
+      tx_hash: '0bd2a8a72108659cd39a59bde89c45fff7d51c334531f036b1e102ab4b62f33f'
+    },
+    {
+      height: 734441,
+      tx_hash: '4f2837b7fff325c0442b550863de3470e016df234561d9151cbb6949fe43ac17'
+    },
+    {
+      height: 735564,
+      tx_hash: '1bfa83355839c0ef0f974463415fa983466e0286d7bcdfdd825f244e357ad1e5'
+    },
+    {
+      height: 735564,
+      tx_hash: '6eba09627175af4b50ac75fa8b3a15a9015df8a19b5b28a992f26044f4fd8891'
+    },
+    {
+      height: 735564,
+      tx_hash: 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+    }]
+}
+
+const status = {
+  status: {
+    startBlockHeight: 543376,
+    syncedBlockHeight: 722860,
+    chainBlockHeight: 722679
+  }
+}
+const immutableData = {
+  payloadCid: 'QmY3EaRaUcc5bNuqDfc7TaeNPThBGUefbqJeJVDjCqxqFZ',
+  about: 'This is a placeholder'
+}
+const mutableData = {
+  tokenIcon: 'https://gateway.ipfs.io/ipfs/bafybeiehitanirn5gmhqjg44xrmdtomn4n5lu5yjoepsvgpswk5mggaw6i/LP_logo-1.png',
+  about: 'Mutable data managed with npm package: https://www.npmjs.com/package/slp-mutable-data'
+}
+
+const decodedOpReturn = JSON.stringify({
+  mda: 'bitcoincash:qrg77j4jf2pl7azgvzrz2z567ls464gkuuhplt30dp',
+  cid: 'bafybeie6t5uyupddc7azms737xg4hxrj7i5t5ov3lb5g2qeehaujj6ak64'
+})
+module.exports = {
+  tokenStats,
+  txDataByMDA,
+  txData,
+  balance,
+  status,
+  transactions,
+  immutableData,
+  mutableData,
+  decodedOpReturn
+}

test/v5/mocks/util-mocks.js

@@ -13,75 +13,70 @@ const mockAddress = {
   isscript: false
 }
 
+// const mockBalance = {
+//   page: 1,
+//   totalPages: 1,
+//   itemsOnPage: 1000,
+//   address: 'bitcoincash:qzp7gdl52edm24xlpkyqnza9rv43u3mdxyc77j3u6k',
+//   balance: '2546',
+//   totalReceived: '2546',
+//   totalSent: '0',
+//   unconfirmedBalance: '0',
+//   unconfirmedTxs: 0,
+//   txs: 2,
+//   txids: [
+//     'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
+//     '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6'
+//   ]
+// }
+
 const mockBalance = {
-  page: 1,
-  totalPages: 1,
-  itemsOnPage: 1000,
-  address: 'bitcoincash:qzp7gdl52edm24xlpkyqnza9rv33u3mdxyc77j3u6k',
-  balance: '2546',
-  totalReceived: '2546',
-  totalSent: '0',
-  unconfirmedBalance: '0',
-  unconfirmedTxs: 0,
-  txs: 2,
-  txids: [
-    'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
-    '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6'
-  ]
+  confirmed: 2546,
+  unconfirmed: 0
 }
 
 const mockUtxos = [
   {
-    txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
-    vout: 0,
-    value: '2000',
-    height: 605873,
-    confirmations: 298,
-    satoshis: 2000
+    tx_hash: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
+    tx_pos: 0,
+    value: 2000,
+    height: 605873
   },
   {
-    txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
-    vout: 1,
-    value: '546',
-    height: 605873,
-    confirmations: 298,
-    satoshis: 546
+    tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
+    tx_pos: 1,
+    value: 546,
+    height: 605873
   }
 ]
 
 const mockThreeUtxos = [
   {
-    txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
-    vout: 0,
-    value: '2000',
-    height: 605873,
-    confirmations: 298,
-    satoshis: 2000
+    tx_hash: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
+    tx_pos: 0,
+    value: 2000,
+    height: 605873
   },
   {
-    txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
-    vout: 1,
-    value: '546',
-    height: 605873,
-    confirmations: 298,
-    satoshis: 546
+    tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
+    tx_pos: 1,
+    value: 546,
+    height: 605873
   },
   {
-    txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
-    vout: 1,
-    value: '546',
-    height: 605873,
-    confirmations: 298,
-    satoshis: 546
+    tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
+    tx_pos: 1,
+    value: 546,
+    height: 605873
   }
 ]
 
 const mockIsTokenUtxos = [
   false,
   {
-    txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
-    vout: 1,
-    value: '546',
+    tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
+    tx_out: 1,
+    value: 546,
     height: 605873,
     confirmations: 298,
     satoshis: 546,

test/v5/price.js

@@ -0,0 +1,346 @@
+/*
+  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/v5/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')
+    })
+  })
+
+  describe('#getBCHAUSD', () => {
+    // const getNetworkInfo = controlRoute.testableComponents.getNetworkInfo
+
+    it('should throw 500 when network issues', async () => {
+      uut.coinexPriceUrl = 'http://fakeurl/api/'
+
+      await uut.getBCHAUSD(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.getBCHAUSD(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.getBCHAUSD(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.mockCoinexFeed })
+      }
+
+      const result = await uut.getBCHAUSD(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+
+  describe('#getBCHUSD', () => {
+    // const getNetworkInfo = controlRoute.testableComponents.getNetworkInfo
+
+    it('should throw 500 when network issues', async () => {
+      uut.bchCoinexPriceUrl = 'http://fakeurl/api/'
+
+      await uut.getBCHUSD(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.getBCHUSD(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.getBCHUSD(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.mockCoinexFeed })
+      }
+
+      const result = await uut.getBCHUSD(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.isNumber(result.usd)
+    })
+  })
+})

test/v5/psf-slp-indexer.js

@@ -0,0 +1,931 @@
+/*
+  TESTS FOR THE PSF-SLP-INDEXER.JS LIBRARY
+*/
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+const PsfSlpIndexerRouter = require('../../src/routes/v5/psf-slp-indexer')
+const uut = new PsfSlpIndexerRouter()
+
+// const nock = require('nock') // HTTP mocking
+const sinon = require('sinon')
+let originalEnvVars // Used during transition from integration to unit tests.
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+const mockData = require('./mocks/psf-slp-indexer-mocks')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+describe('#PsfSlpIndexer', () => {
+  let req, res
+  let sandbox
+  before(() => {
+    // Save existing environment variables.
+    originalEnvVars = {
+      SLP_INDEXER_API: process.env.SLP_INDEXER_API
+    }
+
+    // Set default environment variables for unit tests.
+    if (!process.env.TEST) process.env.TEST = 'unit'
+    if (process.env.TEST === 'unit') {
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+    }
+  })
+
+  // 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()
+  })
+
+  afterEach(() => {
+    // Restore Sandbox
+    sandbox.restore()
+  })
+
+  after(() => {
+    // Restore any pre-existing environment variables.
+    process.env.SLP_INDEXER_API = originalEnvVars.SLP_INDEXER_API
+  })
+
+  describe('#root', async () => {
+    // root route handler.
+    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, 'psf-slp-indexer', 'Returns static string')
+    })
+  })
+
+  describe('#getTokenStats', async () => {
+    it('should throw 400 error if tokenId  is missing', async () => {
+      const result = await uut.getTokenStats(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'tokenId can not be empty')
+    })
+
+    it('should throw 503 when network issues', async () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.SLP_INDEXER_API
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+
+      await uut.getTokenStats(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.SLP_INDEXER_API = savedUrl2
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getTokenStats(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 () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getTokenStats(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 tokens stats', async function () {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.tokenStats })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTokenStats(req, res)
+      const tokenData = result.tokenData
+      assert.property(tokenData, 'type')
+      assert.property(tokenData, 'ticker')
+      assert.property(tokenData, 'name')
+      assert.property(tokenData, 'tokenId')
+      assert.property(tokenData, 'documentUri')
+      assert.property(tokenData, 'documentHash')
+      assert.property(tokenData, 'decimals')
+      assert.property(tokenData, 'mintBatonIsActive')
+      assert.property(tokenData, 'tokensInCirculationBN')
+      assert.property(tokenData, 'tokensInCirculationStr')
+      assert.property(tokenData, 'blockCreated')
+      assert.property(tokenData, 'totalBurned')
+      assert.property(tokenData, 'totalMinted')
+      assert.property(tokenData, 'txs')
+    })
+    it('should GET tokens stats with tx hisroty', async function () {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      req.body.withTxHistory = true
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.tokenStats })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTokenStats(req, res)
+      const tokenData = result.tokenData
+      assert.property(tokenData, 'type')
+      assert.property(tokenData, 'ticker')
+      assert.property(tokenData, 'name')
+      assert.property(tokenData, 'tokenId')
+      assert.property(tokenData, 'documentUri')
+      assert.property(tokenData, 'documentHash')
+      assert.property(tokenData, 'decimals')
+      assert.property(tokenData, 'mintBatonIsActive')
+      assert.property(tokenData, 'tokensInCirculationBN')
+      assert.property(tokenData, 'tokensInCirculationStr')
+      assert.property(tokenData, 'blockCreated')
+      assert.property(tokenData, 'totalBurned')
+      assert.property(tokenData, 'totalMinted')
+      assert.property(tokenData, 'txs')
+    })
+  })
+
+  describe('#getTxid', async () => {
+    it('should throw 400 error if txid  is missing', async () => {
+      const result = await uut.getTxid(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'txid can not be empty')
+    })
+    it('should throw 400 error if txid  is invalid format', async () => {
+      req.body.txid = 'txid'
+
+      const result = await uut.getTxid(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'This is not a txid')
+    })
+
+    it('should throw 503 when network issues', async () => {
+      req.body.txid =
+        'f3e14cd871402a766e85045dc552f2c1e87857dd3ea1b15efab6334ccef5e315'
+
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.SLP_INDEXER_API
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+
+      await uut.getTxid(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.SLP_INDEXER_API = savedUrl2
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+    it('returns proper error when downstream service stalls', async () => {
+      req.body.txid =
+        'f3e14cd871402a766e85045dc552f2c1e87857dd3ea1b15efab6334ccef5e315'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getTxid(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 () => {
+      req.body.txid =
+        'f3e14cd871402a766e85045dc552f2c1e87857dd3ea1b15efab6334ccef5e315'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getTxid(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 tx data', async function () {
+      req.body.txid =
+        'f3e14cd871402a766e85045dc552f2c1e87857dd3ea1b15efab6334ccef5e315'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.txData })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTxid(req, res)
+      const txData = result.txData
+      assert.property(txData, 'txid')
+      assert.property(txData, 'hash')
+      assert.property(txData, 'version')
+      assert.property(txData, 'size')
+      assert.property(txData, 'locktime')
+      assert.property(txData, 'vin')
+      assert.property(txData, 'vout')
+      assert.property(txData, 'hex')
+      assert.property(txData, 'blockhash')
+      assert.property(txData, 'confirmations')
+      assert.property(txData, 'time')
+      assert.property(txData, 'blocktime')
+      assert.property(txData, 'blockheight')
+      assert.property(txData, 'isSlpTx')
+      assert.property(txData, 'tokenTxType')
+      assert.property(txData, 'tokenId')
+      assert.property(txData, 'tokenType')
+      assert.property(txData, 'tokenTicker')
+      assert.property(txData, 'tokenName')
+      assert.property(txData, 'tokenDecimals')
+      assert.property(txData, 'tokenUri')
+      assert.property(txData, 'tokenDocHash')
+      assert.property(txData, 'isValidSlp')
+    })
+  })
+
+  describe('#getAddress', async () => {
+    it('should throw 400 error if address  is missing', async () => {
+      const result = await uut.getAddress(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'address can not be empty')
+    })
+    it('should throw 400 error if address is invalid format', async () => {
+      req.body.address = 'address'
+
+      const result = await uut.getAddress(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(
+        result.error,
+        'Invalid BCH address. Double check your address is valid'
+      )
+    })
+    it('should throw 400 error for invalid network address', async () => {
+      req.body.address = 'bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4'
+
+      const result = await uut.getAddress(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(
+        result.error,
+        'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
+      )
+    })
+
+    it('should throw 503 when network issues', async () => {
+      req.body.address =
+        'bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n'
+
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.SLP_INDEXER_API
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+
+      await uut.getAddress(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.SLP_INDEXER_API = savedUrl2
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      req.body.address =
+        'bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getAddress(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 () => {
+      req.body.address =
+        'bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getAddress(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 address data', async function () {
+      req.body.address =
+        'bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n'
+
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.balance })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getAddress(req, res)
+      const balance = result.balance
+      assert.property(balance, 'utxos')
+      assert.property(balance, 'txs')
+      assert.property(balance, 'balances')
+      assert.isArray(balance.utxos)
+      assert.isArray(balance.txs)
+      assert.isArray(balance.balances)
+    })
+
+    it('should GET data for ecash address', async function () {
+      req.body.address =
+        'ecash:qr5c4hfy52zn87484cucvzle5pljz0gtr5vhtw9z09'
+
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.balance })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getAddress(req, res)
+      const balance = result.balance
+      assert.property(balance, 'utxos')
+      assert.property(balance, 'txs')
+      assert.property(balance, 'balances')
+      assert.isArray(balance.utxos)
+      assert.isArray(balance.txs)
+      assert.isArray(balance.balances)
+    })
+  })
+
+  describe('#getStatus', async () => {
+    it('should throw 503 when network issues', async () => {
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.SLP_INDEXER_API
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+
+      await uut.getStatus(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.SLP_INDEXER_API = savedUrl2
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'get').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getStatus(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, 'get').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getStatus(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 indexer status', async function () {
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'get').resolves({ data: mockData.status })
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getStatus(req, res)
+      const status = result.status
+      assert.property(status, 'startBlockHeight')
+      assert.property(status, 'syncedBlockHeight')
+      assert.property(status, 'chainBlockHeight')
+    })
+  })
+
+  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.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.property(result, 'error')
+    })
+
+    it('should handle unknow errors', () => {
+      sandbox.stub(uut.routeUtils, 'decodeError').returns({ msg: false })
+
+      const result = uut.errorHandler({}, res)
+      // console.log('result: ', result)
+      assert.equal(res.statusCode, 500, 'HTTP status code 500 expected.')
+      assert.property(result, 'error')
+    })
+  })
+
+  describe('#checkEnvVar', () => {
+    it('should throw errors if SLP_INDEXER_API env var is not provided', () => {
+      const savedSlpIndexerUrl = process.env.SLP_INDEXER_API
+      try {
+        process.env.SLP_INDEXER_API = ''
+        uut.checkEnvVar()
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'SLP_INDEXER_API env var not set. Can not connect to PSF SLP indexer.',
+          'Error message expected'
+        )
+      }
+      process.env.SLP_INDEXER_API = savedSlpIndexerUrl
+    })
+  })
+
+  describe('#getCIDData', () => {
+    it('should throw errors if cid is not provided', async () => {
+      try {
+        await uut.getCIDData()
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'cid must be a string.',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should handle axios error', async () => {
+      try {
+        sandbox.stub(uut.axios, 'get').throws(new Error('test error'))
+        const cid = 'bafybeigp3bfmj6woms7pywb7s7r6npcdudvsabvzne2chyspxtdendrwmy'
+        await uut.getCIDData(cid)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'test error',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should return cid object data', async () => {
+      sandbox.stub(uut.axios, 'get').resolves({ data: mockData.immutableData })
+      const cid = 'bafybeigp3bfmj6woms7pywb7s7r6npcdudvsabvzne2chyspxtdendrwmy'
+      const result = await uut.getCIDData(cid)
+      assert.isObject(result)
+    })
+  })
+
+  describe('#decodeOpReturn', () => {
+    it('should throw errors if txid is not provided', async () => {
+      try {
+        await uut.decodeOpReturn()
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'txid must be a string.',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should handle bchjs error', async () => {
+      try {
+        sandbox.stub(uut.bchjs.Electrumx, 'txData').throws(new Error('test error'))
+        const txid = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+        await uut.decodeOpReturn(txid)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'test error',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should return  data', async () => {
+      sandbox.stub(uut.bchjs.Electrumx, 'txData').resolves({ details: mockData.txData.txData })
+      const txid = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+      const result = await uut.decodeOpReturn(txid)
+      assert.isString(result)
+    })
+
+    it('should return  false if data is not found', async () => {
+      sandbox.stub(uut.bchjs.Electrumx, 'txData').resolves({ details: { vout: [] } })
+      const txid = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+      const result = await uut.decodeOpReturn(txid)
+      assert.isFalse(result)
+    })
+  })
+
+  describe('#getTokenData', async () => {
+    it('should throw 400 error if tokenId  is missing', async () => {
+      const result = await uut.getTokenData(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error', 'success'])
+      assert.isFalse(result.success)
+      assert.include(result.error, 'tokenId can not be empty')
+    })
+
+    it('should throw 503 when network issues', async () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Save the existing RPC URL.
+      const savedUrl2 = process.env.SLP_INDEXER_API
+
+      // Manipulate the URL to cause a 500 network error.
+      process.env.SLP_INDEXER_API = 'http://fakeurl/api/'
+
+      await uut.getTokenData(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      // Restore the saved URL.
+      process.env.SLP_INDEXER_API = savedUrl2
+
+      assert.isAbove(
+        res.statusCode,
+        499,
+        'HTTP status code 500 or greater expected.'
+      )
+      // assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
+    })
+
+    it('returns proper error when downstream service stalls', async () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNABORTED' })
+
+      const result = await uut.getTokenData(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 () => {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+
+      // Mock the timeout error.
+      sandbox.stub(uut.axios, 'post').throws({ code: 'ECONNREFUSED' })
+
+      const result = await uut.getTokenData(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 tokens data', async function () {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.tokenStats })
+        sandbox.stub(uut, 'getCIDData').resolves(mockData.immutableData)
+        sandbox.stub(uut, 'getMutableData').resolves(mockData.mutableData)
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTokenData(req, res)
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+
+      assert.isObject(result.genesisData)
+      // assert.isObject(result.immutableData)
+      // assert.isObject(result.mutableData)
+
+      const genesisData = result.genesisData
+      assert.property(genesisData, 'ticker')
+      assert.property(genesisData, 'name')
+      assert.property(genesisData, 'type')
+      assert.property(genesisData, 'tokenId')
+      assert.property(genesisData, 'documentUri')
+      assert.property(genesisData, 'documentHash')
+      assert.property(genesisData, 'decimals')
+      assert.property(genesisData, 'mintBatonIsActive')
+      assert.property(genesisData, 'tokensInCirculationBN')
+      assert.property(genesisData, 'tokensInCirculationStr')
+      assert.property(genesisData, 'blockCreated')
+      assert.property(genesisData, 'totalBurned')
+      assert.property(genesisData, 'totalMinted')
+      assert.property(genesisData, 'txs')
+    })
+
+    it('should GET tokens data if immutableData data not found', async function () {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.tokenStats })
+        sandbox.stub(uut, 'getCIDData').throws(new Error('test error'))
+        sandbox.stub(uut, 'getMutableData').resolves(mockData.mutableData)
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTokenData(req, res)
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+
+      assert.isObject(result.genesisData)
+      assert.isObject(result.mutableData)
+      // assert.equal(result.immutableData, '')
+
+      const genesisData = result.genesisData
+      assert.property(genesisData, 'ticker')
+      assert.property(genesisData, 'name')
+      assert.property(genesisData, 'type')
+      assert.property(genesisData, 'tokenId')
+      assert.property(genesisData, 'documentUri')
+      assert.property(genesisData, 'documentHash')
+      assert.property(genesisData, 'decimals')
+      assert.property(genesisData, 'mintBatonIsActive')
+      assert.property(genesisData, 'tokensInCirculationBN')
+      assert.property(genesisData, 'tokensInCirculationStr')
+      assert.property(genesisData, 'blockCreated')
+      assert.property(genesisData, 'totalBurned')
+      assert.property(genesisData, 'totalMinted')
+      assert.property(genesisData, 'txs')
+    })
+
+    it('should GET tokens data if mutable data not found', async function () {
+      req.body.tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      // Mock the RPC call for unit tests.
+      if (process.env.TEST === 'unit') {
+        sandbox.stub(uut.axios, 'post').resolves({ data: mockData.tokenStats })
+        sandbox.stub(uut, 'getCIDData').resolves(mockData.immutableData)
+        sandbox.stub(uut, 'getMutableData').throws(new Error('test error'))
+      } else {
+        return this.skip()
+      }
+
+      const result = await uut.getTokenData(req, res)
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+
+      assert.isObject(result.genesisData)
+      // assert.isObject(result.immutableData)
+      // assert.equal(result.mutableData, '')
+
+      const genesisData = result.genesisData
+      assert.property(genesisData, 'ticker')
+      assert.property(genesisData, 'name')
+      assert.property(genesisData, 'type')
+      assert.property(genesisData, 'tokenId')
+      assert.property(genesisData, 'documentUri')
+      assert.property(genesisData, 'documentHash')
+      assert.property(genesisData, 'decimals')
+      assert.property(genesisData, 'mintBatonIsActive')
+      assert.property(genesisData, 'tokensInCirculationBN')
+      assert.property(genesisData, 'tokensInCirculationStr')
+      assert.property(genesisData, 'blockCreated')
+      assert.property(genesisData, 'totalBurned')
+      assert.property(genesisData, 'totalMinted')
+      assert.property(genesisData, 'txs')
+    })
+  })
+
+  describe('#getMutableData', () => {
+    it('should throw errors if documentHash is not provided', async () => {
+      try {
+        await uut.getMutableData()
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'documentHash string required when calling mutableData().',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should throw errors if cid is not provided in OP Return', async () => {
+      try {
+        sandbox.stub(uut, 'decodeOpReturn').resolves('{}')
+        sandbox.stub(uut.bchjs.Electrumx, 'transactions').resolves(mockData.transactions)
+        sandbox.stub(uut, 'getCIDData').resolves(mockData.mutableData)
+
+        const documentHash = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+        await uut.getMutableData(documentHash)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'CID could not be found in OP_RETURN data',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should throw errors if data is not found', async () => {
+      try {
+        sandbox.stub(uut, 'decodeOpReturn').resolves(mockData.decodedOpReturn)
+        sandbox.stub(uut.bchjs.Electrumx, 'transactions').resolves({ transactions: [] })
+        sandbox.stub(uut, 'getCIDData').resolves(mockData.mutableData)
+
+        const documentHash = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+        await uut.getMutableData(documentHash)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'CID could not be found in OP_RETURN data',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should  handle bchjs error', async () => {
+      try {
+        sandbox.stub(uut, 'decodeOpReturn').resolves(mockData.decodedOpReturn)
+        sandbox.stub(uut.bchjs.Electrumx, 'transactions').throws(new Error('test error'))
+
+        const documentHash = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+        await uut.getMutableData(documentHash)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'test error',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should skip mutable data if was not generated by the MDA private key', async () => {
+      try {
+        sandbox.stub(uut, 'decodeOpReturn').resolves(mockData.decodedOpReturn)
+
+        sandbox.stub(uut.bchjs.Electrumx, 'transactions').resolves(mockData.transactions)
+        sandbox.stub(uut.bchjs.Transaction, 'get').resolves(mockData.txData)
+
+        const documentHash = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+
+        await uut.getMutableData(documentHash)
+        assert.fail('unexpected code path')
+      } catch (error) {
+        assert.include(
+          error.message,
+          'CID could not be found in OP_RETURN data',
+          'Error message expected'
+        )
+      }
+    })
+
+    it('should return  mutable data', async () => {
+      sandbox.stub(uut, 'decodeOpReturn')
+        .onFirstCall().resolves(mockData.decodedOpReturn)
+        .onSecondCall().resolves(JSON.parse(mockData.decodedOpReturn)) // data to force an error while parsing the JSON
+        .onThirdCall().resolves(mockData.decodedOpReturn)
+
+      sandbox.stub(uut.bchjs.Electrumx, 'transactions').resolves(mockData.transactions)
+      sandbox.stub(uut.bchjs.Transaction, 'get').resolves(mockData.txDataByMDA)
+
+      sandbox.stub(uut, 'getCIDData').resolves(mockData.mutableData)
+
+      const documentHash = 'c37ba29f40ecc61662ea56324fdb72a5f1e66add2078854c2144765b9030358a'
+
+      const result = await uut.getMutableData(documentHash)
+      assert.isString(result)
+    })
+  })
+})

test/v5/rate-limit-unit.js

@@ -0,0 +1,515 @@
+/*
+  Unit tests for the route-ratelimit2.js middleware.
+*/
+
+'use strict'
+
+// Public npm libraries.
+const assert = require('chai').assert
+const sinon = require('sinon')
+const cloneDeep = require('lodash.clonedeep')
+
+const config = require('../../config')
+
+// Mocking data.
+const { mockReq, mockRes, mockNext } = require('./mocks/express-mocks')
+
+// Libraries under test
+const RateLimits = require('../../src/middleware/route-ratelimit')
+let uut = new RateLimits()
+
+let req, res, next
+
+describe('#rate-routelimit', () => {
+  let sandbox
+
+  before(async () => {
+    if (!process.env.JWT_AUTH_SERVER) {
+      process.env.JWT_AUTH_SERVER = 'http://fakeurl.com/'
+    }
+
+    // Wipe the Redis DB, which prevents false negatives when running integration
+    // tests back-to-back.
+    await uut.wipeRedis()
+  })
+
+  // Setup the mocks before each test.
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = cloneDeep(mockReq)
+    res = cloneDeep(mockRes)
+    next = mockNext
+
+    // Explicitly reset the parmas and body.
+    req.params = {}
+    req.body = {}
+    req.query = {}
+    req.locals = {}
+
+    sandbox = sinon.createSandbox()
+
+    uut = new RateLimits()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  after(() => {
+    uut.closeRedis()
+  })
+
+  describe('#checkInternalIp', () => {
+    it('should return true for a request from localhost', () => {
+      req.ip = '::ffff:127.0.0.1'
+
+      const result = uut.checkInternalIp(req)
+
+      assert.equal(result, true)
+    })
+
+    it('should return true for a request from a Docker container', () => {
+      req.ip = '172.17.0.3'
+
+      const result = uut.checkInternalIp(req)
+
+      assert.equal(result, true)
+    })
+
+    it('should return false for a random ip address', () => {
+      req.ip = '123.456.7.8'
+
+      const result = uut.checkInternalIp(req)
+
+      assert.equal(result, false)
+    })
+
+    it('should return false when an error is encountered', () => {
+      req.ip = 4
+
+      const result = uut.checkInternalIp(req)
+
+      assert.equal(result, false)
+    })
+  })
+
+  describe('#isInWhitelist', () => {
+    it('should return false when no argument is passed in', () => {
+      const result = uut.isInWhitelist()
+
+      assert.equal(result, false)
+    })
+
+    it('should return false when origin is not in the whitelist', () => {
+      req.origin = 'blah.com'
+      req.get = sandbox.stub().returns(req.origin)
+
+      const result = uut.isInWhitelist(req)
+
+      assert.equal(result, false)
+
+      // Used to appease linter. Remove these.
+      res.blah = 4
+      next()
+    })
+
+    it('should return true when origin is in the whitelist', () => {
+      req.origin = 'message.fullstack.cash'
+      req.get = sandbox.stub().returns(req.origin)
+
+      const result = uut.isInWhitelist(req)
+
+      assert.equal(result, true)
+    })
+  })
+
+  describe('#decodeJwtToken', () => {
+    it('should return the default JWT payload if decoding fails', () => {
+      const jwt =
+        'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYxNTE1NzA4NywiZXhwIjoxNjE3NzQ5MDg3fQ.RLNGuYAa-CcLdhTGD27tDeaxT6-GIdeR8T4JWZZLDZA'
+
+      const result = uut.decodeJwtToken(jwt)
+      // console.log('result: ', result)
+
+      assert.property(result, 'id')
+      // assert.equal(result.id, '123.456.789.10')
+      assert.property(result, 'email')
+      // assert.equal(result.email, 'test@bchtest.net')
+      // assert.property(result, 'pointsToConsume')
+      // assert.equal(result.pointsToConsume, config.anonRateLimit)
+      // assert.property(result, 'duration')
+      // assert.equal(result.duration, 30)
+      assert.property(result, 'exp')
+    })
+
+    it('should return the default JWT payload if no input is given', () => {
+      const result = uut.decodeJwtToken()
+      // console.log('result: ', result)
+
+      assert.property(result, 'id')
+      assert.equal(result.id, '123.456.789.10')
+      assert.property(result, 'email')
+      assert.equal(result.email, 'test@bchtest.net')
+      assert.property(result, 'pointsToConsume')
+      assert.equal(result.pointsToConsume, config.anonRateLimit)
+      assert.property(result, 'duration')
+      assert.equal(result.duration, 30)
+      assert.property(result, 'exp')
+    })
+
+    it('should correctly decode a JWT token', () => {
+      // Generate a new JWT token for the test.
+      const jwtPayload = {
+        id: '5dade3f5739e6c0ff034b9a1',
+        pointsToConsume: 10,
+        email: 'gooduser@test.com',
+        apiLevel: 40,
+        rateLimit: 100,
+        duration: 30
+      }
+      const jwtToken = uut.generateJwtToken(jwtPayload)
+
+      const result = uut.decodeJwtToken(jwtToken)
+      // console.log('result: ', result)
+
+      assert.property(result, 'id')
+      assert.equal(result.id, jwtPayload.id)
+      assert.property(result, 'email')
+      assert.equal(result.email, jwtPayload.email)
+      assert.property(result, 'pointsToConsume')
+      assert.equal(result.pointsToConsume, jwtPayload.pointsToConsume)
+      assert.property(result, 'duration')
+      assert.equal(result.duration, jwtPayload.duration)
+      assert.property(result, 'exp')
+    })
+
+    it('should return the default payload if there is an unhandled error', () => {
+      // Force an error.
+      sandbox.stub(uut, 'generateJwtToken').throws(new Error('test error'))
+
+      const result = uut.decodeJwtToken()
+      // console.log('result: ', result)
+
+      assert.property(result, 'id')
+      assert.equal(result.id, '123.456.789.10')
+      assert.property(result, 'email')
+      assert.equal(result.email, 'test@bchtest.net')
+      assert.property(result, 'pointsToConsume')
+      assert.equal(result.pointsToConsume, config.anonRateLimit)
+      assert.property(result, 'duration')
+      assert.equal(result.duration, 30)
+      assert.property(result, 'exp')
+    })
+  })
+
+  describe('#trackRateLimits', () => {
+    it('should apply anonymous rate limits if no JWT token is provided', async () => {
+      // Mock sleep function
+      sandbox.stub(uut, 'sleep').resolves()
+
+      req.ip = '127.0.0.1'
+
+      const result = await uut.trackRateLimits(req, res)
+      // console.log(`result: `, result)
+
+      // console.log('res.locals.pointsToConsume: ', res.locals.pointsToConsume)
+
+      assert.equal(result, false, 'Rate limits not exceeded')
+      assert.equal(
+        res.locals.pointsToConsume,
+        config.anonRateLimit,
+        'Anonymous rate limits applied'
+      )
+    })
+
+    it('should apply 100 RPM rate limits when JWT token is provided', async () => {
+      // Generate a new JWT token for the test.
+      const jwtPayload = {
+        id: '5dade3f5739e6c0ff034b9a1',
+        pointsToConsume: 10
+      }
+      const jwtToken = uut.generateJwtToken(jwtPayload)
+
+      const result = await uut.trackRateLimits(req, res, jwtToken)
+      // console.log(`result: `, result)
+
+      // console.log('res.locals.pointsToConsume: ', res.locals.pointsToConsume)
+
+      assert.equal(result, false, 'Rate limits not exceeded')
+      assert.equal(res.locals.pointsToConsume, 10, '100 RPM limits applied')
+    })
+  })
+
+  describe('#applyRateLimits', () => {
+    it('should skip rate limits if basic auth token is used', async () => {
+      req.locals.proLimit = true
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+    })
+
+    it('should skip rate limits if internal call passes basic auth token', async () => {
+      req.ip = '127.0.0.1'
+      req.body.usrObj = {
+        proLimit: true
+      }
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+    })
+
+    it('should apply rate limits to anonymous users', async () => {
+      // Mock sleep function
+      sandbox.stub(uut, 'sleep').resolves()
+
+      req.ip = '123.456.7.8'
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        config.anonRateLimit,
+        'Anonymous rate limits applied'
+      )
+    })
+
+    it('should return 429 error when anonymous users exceed rate limit', async () => {
+      // Mock sleep function
+      sandbox.stub(uut, 'sleep').resolves()
+
+      req.ip = '123.456.7.8'
+
+      // force req.locals.jwtToken to be empty.
+      req.locals.jwtToken = undefined
+
+      let val
+      for (let i = 0; i < 25; i++) {
+        // console.log('req.locals: ', req.locals)
+        val = await uut.applyRateLimits(req, res, next)
+      }
+      // console.log('val: ', val)
+
+      assert.property(val, 'error')
+      assert.include(
+        val.error,
+        'Too many requests. Your limits are currently'
+      )
+
+      assert.equal(res.locals.rateLimitTriggered, true, 'Rate limits triggered')
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        config.anonRateLimit,
+        'Anonymous rate limits applied'
+      )
+    })
+
+    it('should apply rate limits when JWT token is provided', async () => {
+      // Generate a new JWT token for the test.
+      const jwtPayload = {
+        id: '5dade3f5739e6c0ff034b9a1',
+        pointsToConsume: 10
+      }
+      const jwtToken = uut.generateJwtToken(jwtPayload)
+
+      req.ip = '123.456.7.8'
+      req.locals.jwtToken = jwtToken
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        10,
+        'Anonymous rate limits applied'
+      )
+    })
+
+    it('should apply internal rate limits to internal calls', async () => {
+      req.ip = '127.0.0.1'
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        10,
+        'Internal rate limits applied'
+      )
+    })
+
+    it('should return 429 error when internal calls exceed interal rate limit', async () => {
+      req.ip = '127.0.0.1'
+
+      let val
+      for (let i = 0; i < 1025; i++) {
+        val = await uut.applyRateLimits(req, res, next)
+      }
+
+      assert.property(val, 'error')
+      assert.include(
+        val.error,
+        'Too many requests. Your limits are currently 1000 requests per minute.'
+      )
+
+      assert.equal(res.locals.rateLimitTriggered, true, 'Rate limits triggered')
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        10,
+        'Internal rate limits applied'
+      )
+    })
+
+    it('should apply JWT rate limits to internal calls when JWT passes through', async () => {
+      // Generate a new JWT token for the test.
+      const jwtPayload = {
+        id: '5dade3f5739e6c0ff034b9a1',
+        pointsToConsume: 10
+      }
+      const jwtToken = uut.generateJwtToken(jwtPayload)
+
+      req.ip = '127.0.0.1'
+      req.body.usrObj = {
+        jwtToken
+      }
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+
+      assert.equal(
+        res.locals.pointsToConsume,
+        10,
+        'User JWT rate limits applied'
+      )
+    })
+
+    it('should return 429 error when internal calls using JWT pass-through exceeds rate limit', async () => {
+      // Generate a new JWT token for the test.
+      const jwtPayload = {
+        id: '5dade3f5739e6c0ff034b9a1',
+        pointsToConsume: 100
+      }
+      const jwtToken = uut.generateJwtToken(jwtPayload)
+
+      req.ip = '127.0.0.1'
+      req.body.usrObj = {
+        jwtToken
+      }
+
+      try {
+        let val
+        for (let i = 0; i < 120; i++) {
+          val = await uut.applyRateLimits(req, res, next)
+        }
+        // console.log('val: ', val)
+
+        assert.property(val, 'error')
+        assert.include(
+          val.error,
+          'Too many requests. Your limits are currently 100 requests per minute.'
+        )
+
+        assert.equal(
+          res.locals.pointsToConsume,
+          100,
+          'User JWT rate limits applied'
+        )
+      } catch (err) {
+        console.log('err: ', err)
+        assert.fail('Unexpected result')
+      }
+    })
+
+    it('should move to the next middleware when encountering an unexpected internal error', async () => {
+      // Force the creation of the res and req locals property. Covers an
+      // otherwise untested code path.
+      req.locals = undefined
+      res.locals = undefined
+
+      // Force an error
+      sandbox.stub(uut, 'checkInternalIp').throws(new Error('test error'))
+
+      // console.log('next.callCount: ', next.callCount)
+      const startCallCount = next.callCount
+
+      await uut.applyRateLimits(req, res, next)
+
+      // console.log('next.callCount: ', next.callCount)
+      const endCallCount = next.callCount
+
+      assert.isAbove(
+        endCallCount,
+        startCallCount,
+        'Expecting next() to be called'
+      )
+    })
+  })
+})

test/v5/raw-transactions.js

@@ -14,7 +14,7 @@
 
 const chai = require('chai')
 const assert = chai.assert
-const Rawtransactions = require('../../src/routes/v3/full-node/rawtransactions')
+const Rawtransactions = require('../../src/routes/v5/full-node/rawtransactions')
 const uut = new Rawtransactions()
 
 // const nock = require('nock') // HTTP mocking
@@ -216,7 +216,7 @@ describe('#Raw-Transactions', () => {
 
     it('should throw 400 error if hexes array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.hexes = testArray
 
@@ -250,6 +250,7 @@ describe('#Raw-Transactions', () => {
         'Proper error message'
       )
     })
+
     it('returns proper error when downstream service stalls', async () => {
       req.body.hexes = [
         '0200000001b9b598d7d6d72fc486b2b3a3c03c79b5bade6ec9a77ced850515ab5e64edcc21010000006b483045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413dffffffff0210270000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac786e9800000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000'
@@ -458,7 +459,7 @@ describe('#Raw-Transactions', () => {
 
     it('should throw 400 error if hexes array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.hexes = testArray
 
@@ -598,7 +599,7 @@ describe('#Raw-Transactions', () => {
 
     it('should throw 400 error if txids array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.txids = testArray
 
@@ -884,7 +885,7 @@ describe('#Raw-Transactions', () => {
 
     it('should throw 400 error if hexs array is too large', async () => {
       const testArray = []
-      for (var i = 0; i < 25; i++) testArray.push('')
+      for (let i = 0; i < 25; i++) testArray.push('')
 
       req.body.hexes = testArray
 
@@ -975,6 +976,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 +1005,13 @@ describe('#Raw-Transactions', () => {
 
         // Integration test
       } else {
-        assert.hasAllKeys(result, ['error'])
-        assert.include(result.error, 'Missing inputs')
+        if (process.env.ISBCHN) {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'Missing inputs')
+        } else {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'bad-txns-inputs-missingorspent')
+        }
       }
     })
   })
@@ -1040,10 +1047,12 @@ describe('#Raw-Transactions', () => {
       // Save the existing RPC URL.
       const savedUrl = process.env.BITCOINCOM_BASEURL
       const savedUrl2 = process.env.RPC_BASEURL
+      const savedUrl3 = process.env.RPC_SENDURL
 
       // Manipulate the URL to cause a 500 network error.
       process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
       process.env.RPC_BASEURL = 'http://fakeurl/api/'
+      process.env.RPC_SENDURL = 'http://fakeurl/api/'
 
       req.params.hex =
         '020000000136697692fed77bc4f5b6885295d0c56d1d0280fb578f445ce42be4eb6db381f2010000006a4730440220473adba0e7da14f0abf4817bbd591741ecb8da6544b998f10341f6704f5f05280220405221c626cb7edcf333367ebd469aff3f5a2169e37ee58eebb811ffc2fbc9e0412102202ff86325c5d903171fa5a2895c4efb3765105115460dc96f113048ddb69b47feffffff027a621b00000000001976a914e0a8ffc3b91e35f46618d6db90f66397989abf0588ac38041300000000001976a914a741f282af390bc7ea8c4375a3a56401d668564288ac2c330900'
@@ -1053,6 +1062,7 @@ describe('#Raw-Transactions', () => {
       // Restore the saved URL.
       process.env.BITCOINCOM_BASEURL = savedUrl
       process.env.RPC_BASEURL = savedUrl2
+      process.env.RPC_SENDURL = savedUrl3
 
       assert.isAbove(
         res.statusCode,
@@ -1158,8 +1168,13 @@ describe('#Raw-Transactions', () => {
 
         // Integration test
       } else {
-        assert.hasAllKeys(result, ['error'])
-        assert.include(result.error, 'Missing inputs')
+        if (process.env.ISBCHN) {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'Missing inputs')
+        } else {
+          assert.hasAllKeys(result, ['error'])
+          assert.include(result.error, 'bad-txns-inputs-missingorspent')
+        }
       }
     })
   })

test/v5/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)
+    })
+  })
+})

test/v5/slp.js

@@ -0,0 +1,274 @@
+/*
+  TESTS FOR THE SLP.TS 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.
+
+  TODO:
+  -See listSingleToken() tests.
+*/
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+const sinon = require('sinon')
+// const proxyquire = require('proxyquire').noPreserveCache()
+// const axios = require('axios')
+
+// Save existing environment variables.
+// Used during transition from integration to unit tests.
+
+// eslint-disable-next-line no-unused-vars
+let mockServerUrl
+const originalEnvVars = {
+  BITDB_URL: process.env.BITDB_URL,
+  BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
+  SLPDB_URL: process.env.SLPDB_URL
+}
+
+// Set default environment variables for unit tests.
+if (!process.env.TEST) process.env.TEST = 'unit'
+
+// Block network connections for unit tests.
+if (process.env.TEST === 'unit') {
+  process.env.BITDB_URL = 'http://fakeurl/'
+  process.env.BITCOINCOM_BASEURL = 'http://fakeurl/'
+  process.env.SLPDB_URL = 'http://fakeurl/'
+// mockServerUrl = 'http://fakeurl'
+}
+
+// Prepare the slpRoute for stubbing dependcies on slpjs.
+const SlpRoute = require('../../src/routes/v5/slp')
+const slpRoute = new SlpRoute()
+
+// const pathStub = {} // Used to stub methods within slpjs.
+// const slpRouteStub = proxyquire('../../src/routes/v5/slp', { slpjs: pathStub })
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+// const mockData = require('./mocks/slp-mocks')
+// const slpjsMock = require('./mocks/slpjs-mocks')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+describe('#SLP', () => {
+  let req, res
+  let sandbox
+
+  before(() => {
+  })
+
+  // 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 = {}
+    req.locals = {}
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  after(() => {
+    // Restore any pre-existing environment variables.
+    process.env.BITDB_URL = originalEnvVars.BITDB_URL
+    process.env.BITCOINCOM_BASEURL = originalEnvVars.BITCOINCOM_BASEURL
+    process.env.SLPDB_URL = originalEnvVars.SLPDB_URL
+  })
+
+  describe('#root', async () => {
+    // root route handler.
+    const root = slpRoute.root
+
+    it('should respond to GET for base route', async () => {
+      const result = root(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(result.status, 'slp', 'Returns static string')
+    })
+  })
+
+  describe('#validate2Single', () => {
+    it('should throw 400 if txid is empty', async () => {
+      req.params.txid = ''
+      const result = await slpRoute.validate2Single(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'txid can not be empty')
+    })
+
+    /*
+    it('should invalidate a known invalid TXID', async () => {
+      if (process.env.TEST === 'unit') {
+        // Mock to prevent live network connection.
+        sandbox
+          .stub(slpRoute.axios, 'request')
+          .resolves({ data: { isValid: false } })
+      }
+
+      const txid =
+        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
+
+      req.params.txid = txid
+      const result = await slpRoute.validate2Single(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.txid, txid)
+      assert.equal(result.isValid, false)
+    })
+*/
+    /*
+    it('should validate a known valid TXID', async () => {
+      if (process.env.TEST === 'unit') {
+        // Mock to prevent live network connection.
+        sandbox
+          .stub(slpRoute.axios, 'request')
+          .resolves({ data: { isValid: true } })
+      }
+
+      const txid =
+        '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
+
+      req.params.txid = txid
+      const result = await slpRoute.validate2Single(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.txid, txid)
+      assert.equal(result.isValid, true)
+    })
+*/
+    // This test can only be run as a mocked unit test. It's too inconsistent
+    // to run as an integration test, due to the caching built into slp-validate.
+    if (process.env.TEST === 'unit') {
+      it('should cancel if validation takes too long', async () => {
+        // Mock the timeout error.
+        sandbox.stub(slpRoute.axios, 'request').throws({
+          code: 'ECONNABORTED'
+        })
+
+        const txid =
+        'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
+
+        req.params.txid = txid
+        const result = await slpRoute.validate2Single(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'
+        )
+      })
+    }
+  })
+
+  describe('#generateSendOpReturn()', () => {
+    const generateSendOpReturn = slpRoute.generateSendOpReturn
+    // Validate tokenUtxos input
+    it('should throw 400 if tokenUtxos is missing', async () => {
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'tokenUtxos needs to be an array.')
+    })
+
+    it('should throw 400 if tokenUtxos is empty', async () => {
+      req.body.tokenUtxos = ''
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'tokenUtxos needs to be an array.')
+    })
+
+    it('should throw 400 if tokenUtxos is not array', async () => {
+      req.body.tokenUtxos = 'tokenUtxos'
+
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'tokenUtxos needs to be an array.')
+    })
+
+    it('should throw 400 if tokenUtxos is empty array', async () => {
+      req.body.tokenUtxos = []
+
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'tokenUtxos array can not be empty.')
+    })
+
+    // Validate sendQty input
+    it('should throw 400 if sendQty is missing', async () => {
+      req.body.tokenUtxos = [{}, {}, {}]
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'sendQty must be a number')
+    })
+
+    it('should throw 400 if sendQty is empty', async () => {
+      req.body.tokenUtxos = [{}, {}, {}]
+      req.body.sendQty = ''
+
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'sendQty must be a number')
+    })
+
+    it('should throw 400 if sendQty is not a number', async () => {
+      req.body.tokenUtxos = [{}, {}, {}]
+      req.body.sendQty = 'sendQty'
+
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'sendQty must be a number')
+    })
+
+    it('should return OP_RETURN script', async () => {
+      req.body.tokenUtxos = [
+        {
+          tokenId: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+          decimals: 8,
+          tokenQty: 2
+        }
+      ]
+      req.body.sendQty = 1.5
+
+      if (process.env.TEST === 'unit') {
+        sandbox
+          .stub(slpRoute.bchjs.SLP.TokenType1, 'generateSendOpReturn')
+          .resolves({ script: '<Buffer ', outputs: 2 })
+      }
+
+      const result = await generateSendOpReturn(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['script', 'outputs'])
+      assert.isNumber(result.outputs)
+    })
+  })
+})