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

Syncing with upstream ipfs-service-provider

.on-save.json

@@ -0,0 +1,8 @@
+[
+  {
+    "srcDir": "",
+    "destDir": "",
+    "files": "**/*.js",
+    "command": "npm run lint"
+  }
+]

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2021 Permissionless Software Foundation
+Copyright (c) 2021-2023 Permissionless Software Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -6,6 +6,10 @@ This is a REST API server based on [Koa](https://koajs.com/). It's essentially a
 
 When started, this web server starts an [IPFS](https://ipfs.io) node and connects to an ipfs-bch-wallet-service server over the IPFS network. It then pipes that connection over its own localized REST API.
 
+More details are available at [CashStack.info](https://CashStack.info).
+
+- [Video: Using ipfs-bch-wallet-consumer](https://youtu.be/7ntMPuqAX64)
+
 ## Requirements
 
 - node **^14.18.2**
@@ -17,20 +21,18 @@ When started, this web server starts an [IPFS](https://ipfs.io) node and connect
 
 ### Development Environment
 
-**Note:** This software now uses an external go-ipfs IPFS node. The instructions below have not been updated to reflect this.
+To run this software, you must have an instance of go-ipfs running in daemon mode, with the `--enable-pubsub-experiment` flag set. [Here are instruction for installing go-ipfs](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd#install-ipfs).
 
-A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. [PM2](https://www.npmjs.com/package/pm2) is recommended for running this code base as an IPFS Circuit Relay.
-
-- [Video: Installing ipfs-service-provider](https://youtu.be/Z0NsboIVN44)
-- [Step-by-step installation instructions](https://gist.github.com/christroutner/3304a71d4c12a3a3e1664a438f64d9d0)
+Clone this repository and install npm dependencies. You'll also need to install MongoDB if you don't already have it installed:
 
 ```bash
-git clone https://github.com/Permissionless-Software-Foundation/ipfs-service-provider
-cd ipfs-service-provider
+git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer
+cd ipfs-bch-wallet-consumer
 ./install-mongo-sh
 sudo npm install -g node-pre-gyp
 npm install
-./ipfs-service-provider.sh
+cd shell-script
+./local-external-ipfs-node.sh
 ```
 
 ### Production Environment
@@ -38,27 +40,15 @@ npm install
 The [docker](./production/docker) directory contains a Dockerfile for building a production deployment.
 
 ```
-docker-compose build --no-cache
+docker-compose pull
 docker-compose up -d
 ```
 
-- Bring the containers up once, then take them back down with `docker-compose down`.
-- Copy the [swarm.key](./swarm.key) file to `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`.
-- Bring the containers back up with `docker-compose up -d`.
+You can bring the containers back up with `docker-compose up -d`.
 
-### Operation Notes
+## Code Structure
 
-- There is a memory leak in the version of js-ipfs. The app is currently configured to shut down every 8 hours to flush memory. It relies on a process manager like pm2, Docker, or systemd to restart the app after it shuts down, in order to ensure continuous operation.
-
-- The PSF network operates as a private network. It does not connect or interact with the wider PSF network, relying instead on gateways to bridge the two networks, when they need to share content. This improves the performance and experience for everyone in the PSF network. To join the network, you'll need to add the [swarm.key](./swarm.key) file to the IPFS data folder.
-
-- [Instructions on setting up IPFS private networks.](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#private-networks)
-- For external installations, the swarm.key file will typically go in `~/.ipfs/swarm.key`
-- For production Docker containers, the key would go in `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`
-
-## Structure
-
-The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](troutsblog.com/blog/clean-architecture).
+The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](https://christroutner.github.io/trouts-blog/blog/clean-architecture).
 
 ## Usage
 
@@ -74,21 +64,11 @@ API documentation is written inline and generated by [apidoc](http://apidocjs.co
 
 Visit `http://localhost:5000/docs/` to view docs
 
+There is additional developer documentation in the [dev-docs directory](./dev-docs).
+
 ## Dependencies
 
-- [koa2](https://github.com/koajs/koa/tree/v2.x)
-- [koa-router](https://github.com/alexmingoia/koa-router)
-- [koa-bodyparser](https://github.com/koajs/bodyparser)
-- [koa-generic-session](https://github.com/koajs/generic-session)
-- [koa-logger](https://github.com/koajs/logger)
-- [MongoDB](http://mongodb.org/)
-- [Mongoose](http://mongoosejs.com/)
-- [Passport](http://passportjs.org/)
-- [Nodemon](http://nodemon.io/)
-- [Mocha](https://mochajs.org/)
-- [apidoc](http://apidocjs.com/)
-- [ESLint](http://eslint.org/)
-- [ipfs-coord](https://www.npmjs.com/package/ipfs-coord)
+This repository is forked from [ipfs-service-provider](https://github.com/Permissionless-Software-Foundation/ipfs-service-provider).
 
 ## IPFS
 
@@ -97,5 +77,3 @@ Snapshots pinned to IPFS will be listed here.
 ## License
 
 [MIT](./LICENSE.md)
-
-test

bin/server.js

@@ -8,47 +8,56 @@
 */
 
 // npm libraries
-const Koa = require('koa')
-const bodyParser = require('koa-bodyparser')
-const convert = require('koa-convert')
-const logger = require('koa-logger')
-const mongoose = require('mongoose')
-const session = require('koa-generic-session')
-const passport = require('koa-passport')
-const mount = require('koa-mount')
-const serve = require('koa-static')
-const cors = require('kcors')
+import Koa from 'koa'
+
+import bodyParser from 'koa-bodyparser'
+import convert from 'koa-convert'
+import logger from 'koa-logger'
+import mongoose from 'mongoose'
+import session from 'koa-generic-session'
+import passport from 'koa-passport'
+import mount from 'koa-mount'
+import serve from 'koa-static'
+import cors from 'kcors'
 
 // Local libraries
-const config = require('../config') // this first.
-const AdminLib = require('../src/adapters/admin')
-const errorMiddleware = require('../src/controllers/rest-api/middleware/error')
-const { wlogger } = require('../src/adapters/wlogger')
+import config from '../config/index.js' // this first.
+
+import AdminLib from '../src/adapters/admin.js'
+import errorMiddleware from '../src/controllers/rest-api/middleware/error.js'
+import wlogger from '../src/adapters/wlogger.js'
+import Controllers from '../src/controllers/index.js'
+import { applyPassportMods } from '../config/passport.js'
 
 class Server {
   constructor () {
+    // Encapsulate dependencies
     this.adminLib = new AdminLib()
+    this.controllers = new Controllers()
+    this.mongoose = mongoose
+    this.config = config
+    this.process = process
   }
 
   async startServer () {
     try {
       // Create a Koa instance.
       const app = new Koa()
-      app.keys = [config.session]
+      app.keys = [this.config.session]
 
       // Connect to the Mongo Database.
-      mongoose.Promise = global.Promise
-      mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+      this.mongoose.Promise = global.Promise
+      this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
       console.log(
-        `Connecting to MongoDB with this connection string: ${config.database}`
+        `Connecting to MongoDB with this connection string: ${this.config.database}`
       )
-      await mongoose.connect(config.database, {
+      await this.mongoose.connect(this.config.database, {
         useUnifiedTopology: true,
         useNewUrlParser: true
       })
 
-      console.log(`Starting environment: ${config.env}`)
-      console.log(`Debug level: ${config.debugLevel}`)
+      console.log(`Starting environment: ${this.config.env}`)
+      console.log(`Debug level: ${this.config.debugLevel}`)
 
       // MIDDLEWARE START
 
@@ -64,7 +73,8 @@ class Server {
       app.use(mount('/logs', serve(`${process.cwd()}/config/logs`)))
 
       // User Authentication
-      require('../config/passport')
+      // require('../config/passport')
+      applyPassportMods(passport)
       app.use(passport.initialize())
       app.use(passport.session())
 
@@ -73,20 +83,24 @@ class Server {
       // Dev Note: This line must come BEFORE controllers.attachRESTControllers()
       app.use(cors({ origin: '*' }))
 
-      // Attach REST API and JSON RPC controllers to the app.
-      const Controllers = require('../src/controllers')
-      const controllers = new Controllers()
-      await controllers.attachRESTControllers(app)
+      // Wait for any adapters to initialize.
+      await this.controllers.initAdapters()
 
-      app.controllers = controllers
+      // Wait for any use-libraries to initialize.
+      await this.controllers.initUseCases()
+
+      // Attach REST API and JSON RPC controllers to the app.
+      await this.controllers.attachRESTControllers(app)
+
+      app.controllers = this.controllers
 
       // MIDDLEWARE END
 
-      console.log(`Running server in environment: ${config.env}`)
-      wlogger.info(`Running server in environment: ${config.env}`)
+      console.log(`Running server in environment: ${this.config.env}`)
+      wlogger.info(`Running server in environment: ${this.config.env}`)
 
-      await app.listen(config.port)
-      console.log(`Server started on ${config.port}`)
+      this.server = await app.listen(this.config.port)
+      console.log(`Server started on ${this.config.port}`)
 
       // Create the system admin user.
       const success = await this.adminLib.createSystemUser()
@@ -94,10 +108,16 @@ class Server {
 
       // Attach the other IPFS controllers.
       // Skip if this is a test environment.
-      if (config.env !== 'test') {
-        await controllers.attachControllers(app)
+      if (this.config.env !== 'test') {
+        await this.controllers.attachControllers(app)
       }
 
+      // Display configuration settings
+      console.log('\nConfiguration:')
+      console.log(`Circuit Relay: ${this.config.isCircuitRelay}`)
+      console.log(`IPFS TCP port: ${this.config.ipfsTcpPort}`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}\n`)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)
@@ -105,14 +125,14 @@ class Server {
       console.log(
         'Exiting after 5 seconds. Depending on process manager to restart.'
       )
-      await sleep(5000)
-      process.exit(1)
+      await this.sleep(5000)
+      this.process.exit(1)
     }
   }
+
+  sleep (ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms))
+  }
 }
 
-function sleep (ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
-module.exports = Server
+export default Server

config/env/common.js

@@ -5,15 +5,22 @@
 
 /* eslint  no-unneeded-ternary:0 */
 
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+
 // Get the version from the package.json file.
-const pkgInfo = require('../../package.json')
+import { readFileSync } from 'fs'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+const pkgInfo = JSON.parse(readFileSync(`${__dirname.toString()}/../../package.json`))
+
 const version = pkgInfo.version
 
 const ipfsCoordName = process.env.COORD_NAME
   ? process.env.COORD_NAME
   : 'ipfs-bch-wallet-service'
 
-module.exports = {
+export default {
   // Configure TCP port.
   port: process.env.PORT || 5005,
 
@@ -47,6 +54,7 @@ module.exports = {
     : 'demo',
 
   // IPFS settings.
+  useIpfs: process.env.DISABLE_IPFS ? false : true, // Disable IPFS flag
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
   // SSL domain used for websocket connection via browsers.
   crDomain: process.env.CR_DOMAIN ? process.env.CR_DOMAIN : '',
@@ -84,6 +92,8 @@ module.exports = {
   preferredProvider: process.env.PREFERRED_PROVIDER
     ? process.env.PREFERRED_PROVIDER
     : '',
+  // If true, users will not be able to change the provider via a REST API call.
+  freezeProvider: process.env.FREEZE_PROVIDER ? true : false,
   //  : 'QmdBGB8S6sEr19gaAxJYjhRbz5ZmMiH5a1JyyMmaxcRKnY'
   // : 'QmUTx6KqYKVZbKpKxR7vGDUgZFYVvVVyEWDeCYq4GwBCff'
   // Used for development
@@ -94,9 +104,11 @@ module.exports = {
     : '',
 
   // Settings for production, using external go-ipfs node.
-  isProduction: process.env.SVC_ENV === 'production' ? true : false,
+  isProduction: process.env.CONSUMER_ENV === 'production' ? true : false,
   ipfsHost: process.env.IPFS_HOST ? process.env.IPFS_HOST : 'localhost',
   ipfsApiPort: process.env.IPFS_API_PORT
     ? parseInt(process.env.IPFS_API_PORT)
-    : 5001
+    : 5001,
+
+  chatPubSubChan: 'psf-ipfs-chat-001'
 }

config/env/development.js

@@ -4,7 +4,7 @@
   specified.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   database: 'mongodb://localhost:27017/ipfs-bch-consumer-dev',

config/env/production.js

@@ -7,7 +7,7 @@
   so as not to conflict with the default host port of 27017 for MongoDB.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   // database: 'mongodb://172.17.0.1:5555/ipfs-service-prod',

config/env/test.js

@@ -4,7 +4,7 @@
   This is the environment run by the test suite.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   database: 'mongodb://localhost:27017/ipfs-bch-consumer-test',

config/index.js

@@ -1,6 +1,21 @@
-const common = require('./env/common')
+import common from './env/common.js'
 
-const env = process.env.CONSUMER_ENV || 'development'
-const config = require(`./env/${env}`)
+import development from './env/development.js'
+import production from './env/production.js'
+import test from './env/test.js'
 
-module.exports = Object.assign({}, common, config)
+const env = process.env.SVC_ENV || 'development'
+console.log(`Loading config for this environment: ${env}`)
+
+let config = development
+if (env === 'test') {
+  config = test
+} else if (env === 'prod') {
+  config = production
+}
+
+// const importStr = `./env/${env}.js`
+// console.log('importStr: ', importStr)
+// import config from importStr
+
+export default Object.assign({}, common, config)

config/passport.js

@@ -1,30 +1,6 @@
-const passport = require('koa-passport')
-const User = require('../src/adapters/localdb/models/users')
-const Strategy = require('passport-local')
-
-passport.serializeUser((user, done) => {
-  done(null, user.id)
-})
-
-passport.deserializeUser(async (id, done) => {
-  try {
-    const user = await User.findById(id, '-password')
-    done(null, user)
-  } catch (err) {
-    done(err)
-  }
-})
-
-passport.use(
-  'local',
-  new Strategy(
-    {
-      usernameField: 'email',
-      passwordField: 'password'
-    },
-    passportCallback
-  )
-)
+// import passport from 'koa-passport';
+import User from '../src/adapters/localdb/models/users.js'
+import Strategy from 'passport-local'
 
 async function passportCallback (email, password, done) {
   try {
@@ -49,5 +25,35 @@ async function passportCallback (email, password, done) {
   }
 }
 
+function applyPassportMods (passport) {
+  passport.serializeUser((user, done) => {
+    done(null, user.id)
+  })
+
+  passport.deserializeUser(async (id, done) => {
+    try {
+      const user = await User.findById(id, '-password')
+      done(null, user)
+    } catch (err) {
+      done(err)
+    }
+  })
+
+  passport.use(
+    'local',
+    new Strategy(
+      {
+        usernameField: 'email',
+        passwordField: 'password'
+      },
+      passportCallback
+    )
+  )
+
+  return true
+}
+
 // For testing
-module.exports = { passport, passportCallback }
+// export default { passport, passportCallback };
+// export default applyPassportMods
+export { applyPassportMods, passportCallback }

dev-docs/README.md

@@ -7,3 +7,5 @@ This directory contains documentation for developers.
 This app provides a bridge between the Web 2.0 REST API world and the Web3.0 IPFS world. Web apps (like wallet.fullstack.cash) can interact with the REST API provided by the this web server app. This app then pulls the back-end infrastructure through a the IPFS network.
 
 When started, this app will spin up an IPFS node and connect to the PSF network using [ipfs-coord](https://www.npmjs.com/package/ipfs-coord). It will find and connect with a BCH wallet service provider via IPFS. Clients connecting to the REST API can then access BCH wallet infrastructure via the REST API.
+
+More details at [CashStack.info](https://cashstack.info).

index.js

@@ -1,4 +1,4 @@
-const Server = require('./bin/server.js')
+import Server from './bin/server.js'
 const server = new Server()
 
 server.startServer()

package.json

@@ -3,17 +3,18 @@
   "version": "1.0.0",
   "description": "A (local) REST API that proxies BCH wallet services delivered over IPFS (global).",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "start": "node index.js",
     "test": "npm run test:all",
-    "test:all": "export CONSUMER_ENV=test && nyc --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
+    "test:all": "export CONSUMER_ENV=test && c8 --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
     "test:unit": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 --recursive test/unit/",
     "test:e2e:auto": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 test/e2e/automated/",
     "test:temp": "export CONSUMER_ENV=test && mocha --exit --timeout 15000 -g '#rate-limit' test/unit/json-rpc/",
     "lint": "standard --env mocha --fix",
     "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "coverage:report": "export CONSUMER_ENV=test && nyc --reporter=html mocha --exit --timeout 15000 --recursive test/unit/ test/e2e/automated/"
+    "coverage": "c8 report --reporter=text-lcov | coveralls",
+    "coverage:report": "export CONSUMER_ENV=test && c8 --reporter=html mocha --exit --timeout 15000 --recursive test/unit/ test/e2e/automated/"
   },
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "license": "MIT",
@@ -23,13 +24,12 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-consumer",
   "dependencies": {
-    "@psf/bch-js": "5.3.2",
-    "axios": "0.25.0",
+    "@psf/bch-js": "6.7.3",
+    "axios": "0.27.2",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
-    "ipfs": "0.60.0",
-    "ipfs-coord": "7.1.4",
-    "ipfs-http-client": "55.0.0",
+    "ipfs-coord-esm": "9.1.13",
+    "ipfs-http-client": "58.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -45,32 +45,27 @@
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
     "line-reader": "0.4.0",
-    "mongoose": "5.11.15",
+    "minimal-slp-wallet": "5.11.1",
+    "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
-    "nodemailer": "6.4.17",
+    "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
     "public-ip": "4.0.4",
-    "semver": "^7.3.5",
+    "semver": "7.3.5",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "0.26.0",
+    "apidoc": "0.51.1",
+    "c8": "7.12.0",
     "chai": "4.3.0",
     "coveralls": "3.1.0",
-    "eslint": "7.19.0",
-    "eslint-config-prettier": "7.2.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",
     "husky": "4.3.8",
-    "lodash.clonedeep": "^4.5.0",
-    "mocha": "8.2.1",
-    "nyc": "15.1.0",
-    "semantic-release": "17.4.4",
+    "lodash.clonedeep": "4.5.0",
+    "mocha": "10.0.0",
+    "semantic-release": "19.0.3",
     "sinon": "9.2.4",
-    "standard": "16.0.3",
+    "standard": "17.0.0",
     "uuid": "8.3.2"
   },
   "release": {

production/docker/Dockerfile

@@ -12,7 +12,7 @@ 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 curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
 RUN bash nodesource_setup.sh
 RUN apt-get install -y nodejs build-essential
 
@@ -46,11 +46,11 @@ RUN npm set registry http://94.130.170.209:4873/
 
 # Clone the rest.bitcoin.com repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-service-provider
+RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
-WORKDIR /home/safeuser/ipfs-service-provider
+WORKDIR /home/safeuser/ipfs-bch-wallet-consumer
 
 # For development: switch to unstable branch
 RUN git checkout ct-unstable
@@ -69,7 +69,7 @@ VOLUME /home/safeuser/keys
 EXPOSE 5010
 
 # Start the application.
-COPY start-production.sh start-production.sh
+#COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]
 
 #CMD ["npm", "start"]

production/docker/docker-compose.yml

@@ -3,9 +3,9 @@
 version: '3.9'
 
 services:
-  mongo-ipfs-service:
-    image: mongo
-    container_name: mongo-ipfs-service
+  mongo-bch-consumer:
+    image: mongo:4.2.0
+    container_name: mongo-bch-consumer
     ports:
       - '5555:27017' # <host port>:<container port>
     volumes:
@@ -13,11 +13,17 @@ services:
     command: mongod --logpath=/dev/null # -- quiet
     restart: always
 
-  ipfs:
-    image: ipfs/go-ipfs:v0.11.0
-    container_name: ipfs
+  ipfs-bch-consumer:
+    # https://github.com/christroutner/trickle-ipfs
+    image: christroutner/trickle-ipfs:v1.0.1
+    #build:
+    #  context: ./
+    #  dockerfile: Dockerfile
+    container_name: ipfs-bch-consumer
     environment:
-      MY_ENV_VAR: 'placeholder'
+      IPFS_DAEMON_ARGUMENTS: '--enable-pubsub-experiment --migrate=true --agent-version-suffix=docker --routing=dhtclient'
+      UPLOAD_KBPS: '1000'
+      DOWNLOAD_KBPS: '1000'
     logging:
       driver: 'json-file'
       options:
@@ -26,25 +32,20 @@ services:
     mem_limit: 2000mb
     ports:
       - 4001:4001
+      - 4003:4003
       - 172.17.0.1:5001:5001
       - 172.17.0.1:8080:8080
+    command: [
+      './start-ipfs.sh'
+    ]
     volumes:
-      - ../data/go-ipfs/data:/data/ipfs
-      - ../data/go-ipfs/export:/export
-    # https://docs.docker.com/compose/compose-file/compose-file-v3/#command
-    # https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
-    command:
-      [
-        'daemon',
-        '--migrate=true',
-        '--agent-version-suffix=docker',
-        '--enable-pubsub-experiment'
-      ]
+      - ../data/go-ipfs/data:/root/.ipfs
     restart: always
 
-  ipfs-service:
-    build: .
-    container_name: ipfs-service
+  bch-consumer:
+    #build: .
+    image: christroutner/ipfs-bch-wallet-consumer:v1.8.4
+    container_name: bch-consumer
     logging:
       driver: 'json-file'
       options:
@@ -52,10 +53,11 @@ services:
         max-file: '10'
     mem_limit: 500mb
     links:
-      - mongo-ipfs-service
-      - ipfs
+      - mongo-bch-consumer
+      - ipfs-bch-consumer
     ports:
       - '5010:5010' # <host port>:<container port>
     volumes:
-      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
+      - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-consumer/.ipfsdata
+      - ./start-production.sh:/home/safeuser/ipfs-bch-wallet-consumer/start-production.sh
     restart: always

production/docker/start-production.sh

@@ -8,7 +8,7 @@
 export MNEMONIC="olive two muscle bottom coral ancient wait legend bronze useful process session"
 
 # The human readable name this IPFS node identifies as.
-export COORD_NAME=ipfs-service-provider-generic
+export COORD_NAME=bch-consumer-generic
 
 # Allow this node to function as a circuit relay. It must not be behind a firewall.
 #export ENABLE_CIRCUIT_RELAY=true
@@ -17,22 +17,22 @@ export COORD_NAME=ipfs-service-provider-generic
 #export CR_DOMAIN=subdomain.yourdomain.com
 
 # Debug level. 0 = minimal info. 2 = max info.
-export DEBUG_LEVEL=2
+export DEBUG_LEVEL=1
 
 # END: Optional configuration settings
 
 
 # Production database connection string.
-export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+export DBURL=mongodb://172.17.0.1:5555/ipfs-bch-consumer-prod
 
 # Configure REST API port
 export PORT=5010
 
 # Production settings using external go-ipfs node.
-export SVC_ENV=production
+export CONSUMER_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4001
-#export IPFS_WS_PORT=5269
+export IPFS_WS_PORT=4003
 
 npm start

shell-scripts/local-external-ipfs-node.sh

@@ -13,7 +13,7 @@ export COORD_NAME=trout-dev-bch-wallet-consumer
 export MNEMONIC="stomach mean catch march census author cousin size south romance pumpkin trap"
 
 # 0 = less verbose. 3 = most verbose
-export DEBUG_LEVEL=2
+export DEBUG_LEVEL=0
 
 # Production settings that use external IPFS node.
 # https://github.com/christroutner/docker-ipfs
@@ -28,4 +28,9 @@ export IPFS_TCP_PORT=4001
 # MongoDB connection string.
 export DBURL=mongodb://localhost:27017/ipfs-service-dev
 
+export CONSUMER_ENV=production
+
+# Lock the consumer into a preferred service provider.
+#export PREFERRED_PROVIDER=12D3KooWEzE3HNH86WCb2Xocu6PgBCnSGUD7myJmuTHvoedMwp7K
+
 npm start

src/adapters/admin.js

@@ -13,16 +13,24 @@
   in the Adapter directory.
 */
 
-'use strict'
-const axios = require('axios').default
-const mongoose = require('mongoose')
-const User = require('../adapters/localdb/models/users')
-const config = require('../../config')
-const JsonFiles = require('../adapters/json-files')
+// Global npm libraries
+import axios from 'axios'
+import mongoose from 'mongoose'
+
+// Local libraries
+import User from '../adapters/localdb/models/users.js'
+import config from '../../config/index.js'
+import JsonFiles from '../adapters/json-files.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+
 const jsonFiles = new JsonFiles()
 
 const JSON_FILE = `system-user-${config.env}.json`
-const JSON_PATH = `${__dirname.toString()}/../../config/${JSON_FILE}`
+const JSON_PATH = `${__dirname.toString()}../../config/${JSON_FILE}`
 
 const LOCALHOST = `http://localhost:${config.port}`
 const context = {}
@@ -82,6 +90,8 @@ class Admin {
       // applications like the Task Manager and the test scripts can access.
 
       await jsonFiles.writeJSON(context, JSON_PATH)
+      // console.log('context: ', context)
+      // console.log('JSON_PATH: ', JSON_PATH)
 
       return context
     } catch (err) {
@@ -169,4 +179,4 @@ class Admin {
   }
 }
 
-module.exports = Admin
+export default Admin

src/adapters/bch/index.js

@@ -4,11 +4,11 @@
 */
 
 // Public npm libraries
-const { v4: uid } = require('uuid')
-const jsonrpc = require('jsonrpc-lite')
+import { v4 as uid } from 'uuid'
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
-const { wlogger } = require('../wlogger')
+import wlogger from '../wlogger.js'
 
 let _this
 
@@ -21,15 +21,15 @@ class BchAdapter {
         'An instance of IPFS must be passed when instantiating the BCH Adapter library.'
       )
     }
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'An instance of an EventEmitter must be passed when instantiating the adapters.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'An instance of an EventEmitter must be passed when instantiating the adapters.'
+    //   )
+    // }
 
     // Connect the RPC handler when the event fires with new data.
-    this.eventEmitter.on('rpcData', this.rpcHandler)
+    // this.eventEmitter.on('rpcData', this.rpcHandler)
 
     // Encapsulate dependencies
     this.uid = uid
@@ -208,6 +208,60 @@ class BchAdapter {
     }
   }
 
+  // Query the UTXOs associated with an array of up to 20 addresses.
+  async getUtxosBulk (addrs) {
+    try {
+      // console.log('getUtxosBulk() addrs: ', addrs)
+
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      // Input validation
+      if (!Array.isArray(addrs)) {
+        throw new Error('addresses parameter must be an array')
+      }
+      if (addrs.length > 20) {
+        throw new Error('addresses parameter must not exceed 20 elements')
+      }
+
+      const rpcData = {
+        endpoint: 'utxosBulk',
+        addresses: addrs
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      // console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+      // console.log(`getUtxosBulk() data: ${JSON.stringify(data, null, 2)}`)
+
+      return data
+    } catch (err) {
+      // console.log('createUser() error: ', err)
+      wlogger.error('Error in use-cases/bch.js/getUtxosBulk()')
+      throw err
+    }
+  }
+
   async broadcast (hex) {
     try {
       // Throw an error if this IPFS node has not yet made a connection to a
@@ -265,7 +319,7 @@ class BchAdapter {
 
       const rpcData = {
         endpoint: 'txHistory',
-        address: address,
+        address,
         sortOrder,
         page
       }
@@ -387,6 +441,135 @@ class BchAdapter {
     }
   }
 
+  async utxoIsValid (utxo) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      const rpcData = {
+        endpoint: 'utxoIsValid',
+        utxo
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.log('utxoIsValid() error: ', err)
+      wlogger.error('Error in adapters/bch.js/utxoIsValid()')
+      throw err
+    }
+  }
+
+  async getTokenData (tokenId, withTxHistory = false) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      const rpcData = {
+        endpoint: 'getTokenData',
+        tokenId,
+        withTxHistory
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.log('getTokenData() error: ', err)
+      wlogger.error('Error in adapters/bch.js/getTokenData()')
+      throw err
+    }
+  }
+
+  // Get token icon and other media associated with the token.
+  async getTokenData2 (tokenId, updateCache) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      const rpcData = {
+        endpoint: 'getTokenData2',
+        tokenId,
+        updateCache
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.log('getTokenData2() error: ', err)
+      wlogger.error('Error in adapters/bch.js/getTokenData2()')
+      throw err
+    }
+  }
+
   // Returns a promise that resolves to data when the RPC response is recieved.
   async waitForRPCResponse (rpcId) {
     try {
@@ -442,4 +625,5 @@ class BchAdapter {
   }
 }
 
-module.exports = BchAdapter
+// module.exports = BchAdapter
+export default BchAdapter

src/adapters/contact.js

@@ -3,13 +3,12 @@
 */
 
 /* eslint-disable no-useless-escape */
+import config from '../../config/index.js'
+import NodeMailer from '../adapters/nodemailer.js'
+import wlogger from '../adapters/wlogger.js'
+
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
-
-const config = require('../../config')
-
-const NodeMailer = require('../adapters/nodemailer')
 const nodemailer = new NodeMailer()
-const { wlogger } = require('../adapters/wlogger')
 
 let _this
 
@@ -60,4 +59,4 @@ class ContactLib {
     }
   }
 }
-module.exports = ContactLib
+export default ContactLib

src/adapters/fullstack-jwt.js

@@ -5,8 +5,9 @@
   for this file.
 */
 
-const JwtLib = require('jwt-bch-lib')
-const BCHJS = require('@psf/bch-js')
+import JwtLib from 'jwt-bch-lib'
+
+import BCHJS from '@psf/bch-js'
 
 class FullStackJWT {
   constructor (localConfig = {}) {
@@ -98,4 +99,4 @@ class FullStackJWT {
   }
 }
 
-module.exports = FullStackJWT
+export default FullStackJWT

src/adapters/index.js

@@ -5,31 +5,32 @@
 */
 
 // Public NPM libraries
-const BCHJS = require('@psf/bch-js')
+import BCHJS from '@psf/bch-js'
 
 // Load individual adapter libraries.
-const IPFSAdapter = require('./ipfs')
-const LocalDB = require('./localdb')
-const LogsAPI = require('./logapi')
-const Passport = require('./passport')
-const Nodemailer = require('./nodemailer')
-// const { wlogger } = require('./wlogger')
-const JSONFiles = require('./json-files')
-const FullStackJWT = require('./fullstack-jwt')
-const BCH = require('./bch')
-const P2WDB = require('./p2wdb')
+import IPFSAdapter from './ipfs/index.js'
+import LocalDB from './localdb/index.js'
+import LogsAPI from './logapi.js'
+import Passport from './passport.js'
+import Nodemailer from './nodemailer.js'
+import BCH from './bch/index.js'
+import P2WDB from './p2wdb/index.js'
 
-const config = require('../../config')
+// const { wlogger } = require('./wlogger')
+import JSONFiles from './json-files.js'
+
+import FullStackJWT from './fullstack-jwt.js'
+import config from '../../config/index.js'
 
 class Adapters {
   constructor (localConfig = {}) {
     // Dependency injection.
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'An instance of an EventEmitter must be passed when instantiating the adapters.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'An instance of an EventEmitter must be passed when instantiating the adapters.'
+    //   )
+    // }
 
     // Encapsulate dependencies
     this.ipfs = new IPFSAdapter(localConfig)
@@ -59,7 +60,19 @@ class Adapters {
       }
 
       // Start the IPFS node.
-      await this.ipfs.start()
+      // Do not start these adapters if this is an e2e test.
+      if (this.config.env !== 'test') {
+        if (this.config.useIpfs) {
+          await this.ipfs.start()
+        }
+      } else {
+        // These lines are here to ensure code coverage hits 100%.
+        console.log('Not starting IPFS node since this is an e2e test.')
+      }
+
+      console.log('Async Adapters have been started.')
+
+      return true
     } catch (err) {
       console.error('Error in adapters/index.js/start()')
       throw err
@@ -67,4 +80,4 @@ class Adapters {
   }
 }
 
-module.exports = Adapters
+export default Adapters

src/adapters/ipfs/index.js

@@ -2,23 +2,27 @@
   top-level IPFS library that combines the individual IPFS-based libraries.
 */
 
-const IpfsAdapter = require('./ipfs')
-const IpfsCoordAdapter = require('./ipfs-coord')
+// Local libraries
+import IpfsAdapter from './ipfs.js'
+
+import IpfsCoordAdapter from './ipfs-coord.js'
+import config from '../../../config/index.js'
 
 class IPFS {
   constructor (localConfig = {}) {
     // Dependency injection.
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
+    //   )
+    // }
 
     // Encapsulate dependencies
     this.ipfsAdapter = new IpfsAdapter()
     this.IpfsCoordAdapter = IpfsCoordAdapter
     this.process = process
+    this.config = config
 
     this.ipfsCoordAdapter = {} // placeholder
 
@@ -40,11 +44,15 @@ class IPFS {
       // Start ipfs-coord
       this.ipfsCoordAdapter = new this.IpfsCoordAdapter({
         ipfs: this.ipfs,
-        eventEmitter: this.eventEmitter
+        tcpPort: this.config.ipfsTcpPort,
+        wsPort: this.config.ipfsWsPort
       })
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')
 
+      // Subscribe to the chat pubsub channel
+      await this.ipfsCoordAdapter.subscribeToChat()
+
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')
@@ -184,4 +192,4 @@ class IPFS {
   }
 }
 
-module.exports = IPFS
+export default IPFS

src/adapters/ipfs/ipfs-coord.js

@@ -5,13 +5,16 @@
 */
 
 // Global npm libraries
-const IpfsCoord = require('ipfs-coord')
-const BCHJS = require('@psf/bch-js')
-const publicIp = require('public-ip')
-const semver = require('semver')
+import IpfsCoord from 'ipfs-coord-esm'
+
+// import BCHJS from '@psf/bch-js'
+import SlpWallet from 'minimal-slp-wallet'
+import publicIp from 'public-ip'
+import semver from 'semver'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const JSONRPC = require('../../controllers/json-rpc/')
 
 // The minimum version of ipfs-bch-wallet-service that this wallet can work with.
@@ -31,17 +34,18 @@ class IpfsCoordAdapter {
         'Instance of IPFS must be passed when instantiating ipfs-coord.'
       )
     }
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
+    //   )
+    // }
 
     // Encapsulate dependencies
     this.IpfsCoord = IpfsCoord
     this.ipfsCoord = {}
-    this.bchjs = new BCHJS()
+    // this.bchjs = new BCHJS()
+    this.wallet = new SlpWallet()
     this.config = config
     this.publicIp = publicIp
     this.semver = semver
@@ -70,6 +74,9 @@ class IpfsCoordAdapter {
   async start () {
     const circuitRelayInfo = {}
 
+    // Wait for the BCH wallet to create the wallet.
+    await this.wallet.walletInfoPromise
+
     // If configured as a Circuit Relay, get the public IP addresses for this node.
     if (this.config.isCircuitRelay) {
       try {
@@ -91,8 +98,9 @@ class IpfsCoordAdapter {
       ipfs: this.ipfs,
       type: 'node.js',
       // type: 'browser',
+      wallet: this.wallet,
+      privateLog: console.log, // Default to console.log
       bchjs: this.bchjs,
-      privateLog: this.peerInputHandler,
       isCircuitRelay: this.config.isCircuitRelay,
       circuitRelayInfo,
       apiInfo: this.config.apiInfo,
@@ -214,6 +222,8 @@ class IpfsCoordAdapter {
   // providers. This method is called periodically by a timer-interval.
   pollForBchServices () {
     try {
+      // console.log('pollForBchServices() polling for BCH service')
+
       // An array of IPFS IDs of other nodes in the coordination pubsub channel.
       const peers = _this.ipfsCoord.thisNode.peerList
       // console.log(`peers: ${JSON.stringify(peers, null, 2)}`)
@@ -255,6 +265,8 @@ class IpfsCoordAdapter {
             console.log(`---->BCH wallet service selected: ${thisPeer}`)
           }
 
+          // console.log('preferredProvider: ', _this.config.preferredProvider)
+
           // If a preferred provider is set in the config file, then connect
           // to the preferred provider when it's discovered.
           if (
@@ -264,6 +276,8 @@ class IpfsCoordAdapter {
             _this.state.selectedServiceProvider = thisPeer
           }
 
+          // console.log('selectedServiceProvider: ', _this.state.selectedServiceProvider)
+
           // Check if the peer has already been added to the list of providers.
           const alreadyExists = _this.state.serviceProviders.filter(
             (x) => x === thisPeer
@@ -291,16 +305,25 @@ class IpfsCoordAdapter {
 
   // This method handles input coming in from other IPFS peers.
   // It passes the data on to the REST API library by emitting an event.
-  peerInputHandler (data) {
-    try {
-      // console.log('peerInputHandler triggered with this data: ', data)
+  // peerInputHandler (data) {
+  //   try {
+  //     // console.log('peerInputHandler triggered with this data: ', data)
+  //
+  //     this.eventEmitter.emit('rpcData', data)
+  //   } catch (err) {
+  //     console.error('Error in ipfs-coord.js/peerInputHandler(): ', err)
+  //     // Do not throw error. This is a top-level function.
+  //   }
+  // }
 
-      this.eventEmitter.emit('rpcData', data)
-    } catch (err) {
-      console.error('Error in ipfs-coord.js/peerInputHandler(): ', err)
-      // Do not throw error. This is a top-level function.
-    }
+  // Subscribe to the chat pubsub channel
+  async subscribeToChat () {
+    await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
+      this.config.chatPubSubChan,
+      console.log,
+      this.ipfsCoord.thisNode
+    )
   }
 }
 
-module.exports = IpfsCoordAdapter
+export default IpfsCoordAdapter

src/adapters/ipfs/ipfs.js

@@ -11,13 +11,14 @@
 // Global npm libraries
 // const IPFS = require('ipfs')
 // const IPFS = require('@chris.troutner/ipfs')
-const IPFSembedded = require('ipfs')
-const IPFSexternal = require('ipfs-http-client')
-const fs = require('fs')
-const http = require('http')
+// import IPFSembedded from 'ipfs';
+
+import { create } from 'ipfs-http-client'
+import fs from 'fs'
+import http from 'http'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
 
 const IPFS_DIR = './.ipfsdata/ipfs'
 
@@ -25,17 +26,17 @@ class IpfsAdapter {
   constructor (localConfig) {
     // Encapsulate dependencies
     this.config = config
+    this.fs = fs
+    this.create = create
 
     // Choose the IPFS constructor based on the config settings.
-    this.IPFS = IPFSembedded // default
-    if (this.config.isProduction) {
-      this.IPFS = IPFSexternal
-    }
+    // this.IPFS = IPFSembedded // default
+    // if (this.config.isProduction) {
+    //   this.IPFS = IPFSexternal
+    // }
 
     // Properties of this class instance.
     this.isReady = false
-
-    this.fs = fs
   }
 
   // Start an IPFS node.
@@ -85,7 +86,7 @@ class IpfsAdapter {
       }
 
       // Create a new IPFS node.
-      this.ipfs = await this.IPFS.create(ipfsOptions)
+      this.ipfs = await this.create(ipfsOptions)
 
       // Set the 'server' profile so the node does not scan private networks.
       await this.ipfs.config.profiles.apply('server')
@@ -102,9 +103,9 @@ class IpfsAdapter {
       console.error('Error in ipfs.js/start()')
 
       // If IPFS crashes because the /blocks directory is full, wipe the directory.
-      if (err.message.includes('No space left on device')) {
-        this.rmBlocksDir()
-      }
+      // if (err.message.includes('No space left on device')) {
+      //   this.rmBlocksDir()
+      // }
 
       throw err
     }
@@ -120,21 +121,21 @@ class IpfsAdapter {
   // Dev Note: It's assumed this node is not pinning any data and that
   // everything in this directory is transient. This folder will regularly
   // fill up and prevent IPFS from starting.
-  rmBlocksDir () {
-    try {
-      const dir = `${IPFS_DIR}/blocks`
-      console.log(`Deleting ${dir} directory...`)
-
-      this.fs.rmdirSync(dir, { recursive: true })
-
-      console.log(`${dir} directory is deleted!`)
-
-      return true // Signal successful execution.
-    } catch (err) {
-      console.log('Error in rmBlocksDir()')
-      throw err
-    }
-  }
+  // rmBlocksDir () {
+  //  try {
+  //    const dir = `${IPFS_DIR}/blocks`
+  //    console.log(`Deleting ${dir} directory...`)
+  //
+  //    this.fs.rmdirSync(dir, { recursive: true })
+  //
+  //    console.log(`${dir} directory is deleted!`)
+  //
+  //    return true // Signal successful execution.
+  //  } catch (err) {
+  //    console.log('Error in rmBlocksDir()')
+  //    throw err
+  //  }
+  // }
 }
 
-module.exports = IpfsAdapter
+export default IpfsAdapter

src/adapters/json-files.js

@@ -1,8 +1,8 @@
 /*
   A utility file for reading and writing JSON files.
 */
-'use strict'
-const fs = require('fs')
+
+import fs from 'fs'
 
 let _this
 
@@ -57,7 +57,8 @@ class JsonFiles {
               console.log(`err: ${JSON.stringify(err, null, 2)}`)
             }
 
-            throw err
+            // throw err
+            return reject(err)
           }
 
           const obj = JSON.parse(data)
@@ -72,4 +73,4 @@ class JsonFiles {
   }
 }
 
-module.exports = JsonFiles
+export default JsonFiles

src/adapters/localdb/index.js

@@ -3,7 +3,7 @@
 */
 
 // Load Mongoose models.
-const Users = require('./models/users')
+import Users from './models/users.js'
 
 class LocalDB {
   constructor () {
@@ -12,4 +12,4 @@ class LocalDB {
   }
 }
 
-module.exports = LocalDB
+export default LocalDB

src/adapters/localdb/models/users.js

@@ -1,7 +1,10 @@
-const mongoose = require('mongoose')
-const bcrypt = require('bcryptjs')
-const config = require('../../../../config')
-const jwt = require('jsonwebtoken')
+// Global npm libraries
+import mongoose from 'mongoose'
+import bcrypt from 'bcryptjs'
+import jwt from 'jsonwebtoken'
+
+// Local libraries
+import config from '../../../../config/index.js'
 
 const User = new mongoose.Schema({
   type: { type: String, default: 'user' },
@@ -51,4 +54,4 @@ User.methods.generateToken = function generateToken () {
 }
 
 // export default mongoose.model('user', User)
-module.exports = mongoose.model('user', User)
+export default mongoose.model('user', User)

src/adapters/logapi.js

@@ -1,9 +1,14 @@
-const lineReader = require('line-reader')
-const fs = require('fs')
+import lineReader from 'line-reader'
+import fs from 'fs'
 
-const config = require('../../config')
+import config from '../../config/index.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
 
 let _this
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 class LogsApi {
   constructor () {
@@ -135,8 +140,10 @@ class LogsApi {
         if (!filename || typeof filename !== 'string') {
           throw new Error('filename must be a string')
         }
-        // Throw an error if the file does not exist.
 
+        console.log('readLines() filename: ', filename)
+
+        // Throw an error if the file does not exist.
         if (!_this.fs.existsSync(filename)) {
           throw new Error('file does not exist')
         }
@@ -167,4 +174,4 @@ class LogsApi {
   }
 }
 
-module.exports = LogsApi
+export default LogsApi

src/adapters/nodemailer.js

@@ -3,11 +3,10 @@
 */
 
 'use strict'
-const nodemailer = require('nodemailer')
+import nodemailer from 'nodemailer'
 
-const config = require('../../config')
-
-const { wlogger } = require('./wlogger')
+import config from '../../config/index.js'
+import wlogger from './wlogger.js'
 
 let _this
 
@@ -150,4 +149,4 @@ class NodeMailer {
   }
 }
 
-module.exports = NodeMailer
+export default NodeMailer

src/adapters/p2wdb/index.js

@@ -4,11 +4,11 @@
 */
 
 // Public npm libraries
-const { v4: uid } = require('uuid')
-const jsonrpc = require('jsonrpc-lite')
+import { v4 as uid } from 'uuid'
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
-const { wlogger } = require('../wlogger')
+import wlogger from '../wlogger.js'
 
 let _this
 
@@ -21,15 +21,15 @@ class P2wdbAdapter {
         'An instance of IPFS must be passed when instantiating the P2WDB Adapter library.'
       )
     }
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'An instance of an EventEmitter must be passed when instantiating the adapters.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'An instance of an EventEmitter must be passed when instantiating the adapters.'
+    //   )
+    // }
 
     // Connect the RPC handler when the event fires with new data.
-    this.eventEmitter.on('rpcData', this.rpcHandler)
+    // this.eventEmitter.on('rpcData', this.rpcHandler)
 
     // Encapsulate dependencies
     this.uid = uid
@@ -264,4 +264,5 @@ class P2wdbAdapter {
   }
 }
 
-module.exports = P2wdbAdapter
+// module.exports = P2wdbAdapter
+export default P2wdbAdapter

src/adapters/passport.js

@@ -2,7 +2,7 @@
   koa-passport is an authorization library used for different authentication schemes.
 */
 
-const passport = require('koa-passport')
+import passport from 'koa-passport'
 
 let _this
 class Passport {
@@ -32,4 +32,4 @@ class Passport {
   }
 }
 
-module.exports = Passport
+export default Passport

src/adapters/wlogger.js

@@ -6,10 +6,17 @@
 
 'use strict'
 
-const winston = require('winston')
-require('winston-daily-rotate-file')
+// Global npm libraries
+import winston from 'winston'
+import 'winston-daily-rotate-file'
 
-const config = require('../../config')
+// Local libraries
+import config from '../../config/index.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 class Wlogger {
   constructor (localConfig = {}) {
@@ -69,4 +76,5 @@ logger.outputToConsole()
 
 const wlogger = logger.wlogger
 
-module.exports = { wlogger, Wlogger }
+export { wlogger as default, Wlogger }
+// export default wlogger

src/controllers/index.js

@@ -5,41 +5,34 @@
 */
 
 // Public npm libraries.
-const EventEmitter = require('events')
+// const EventEmitter = require('events')
 
 // Local libraries
-const config = require('../../config')
-const Adapters = require('../adapters')
-const JSONRPC = require('./json-rpc')
-const UseCases = require('../use-cases')
-const RESTControllers = require('./rest-api')
+import Adapters from '../adapters/index.js'
+import JSONRPC from './json-rpc/index.js'
+import UseCases from '../use-cases/index.js'
+import RESTControllers from './rest-api/index.js'
+import TimerControllers from './timer-controllers.js'
+import config from '../../config/index.js'
 
 class Controllers {
   constructor (localConfig = {}) {
     // Encapsulate dependencies
-    this.config = config
-
-    // Initialize EventEmitters used to pass event-driven data around the app.
-    this.eventEmitter = new EventEmitter()
-    localConfig.eventEmitter = this.eventEmitter
-
-    // Initialize Clean Architecture classes. Inject dependencies.
     this.adapters = new Adapters(localConfig)
     localConfig.adapters = this.adapters
     this.useCases = new UseCases(localConfig)
+    this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
+    this.config = config
   }
 
-  async attachControllers (app) {
-    // Skip in a test environment.
-    if (this.config.env !== 'test') {
-      // Wait for any startup processes to complete for the Adapters libraries.
-      await this.adapters.start()
+  // Spin up any adapter libraries that have async startup needs.
+  async initAdapters () {
+    await this.adapters.start()
+  }
 
-      // Attach the REST controllers to the Koa app.
-      // this.attachRESTControllers(app)
-
-      this.attachRPCControllers()
-    }
+  // Run any Use Cases to startup the app.
+  async initUseCases () {
+    await this.useCases.start()
   }
 
   // Top-level function for this library.
@@ -54,6 +47,20 @@ class Controllers {
     restControllers.attachRESTControllers(app)
   }
 
+  // Attach any other controllers other than REST API controllers.
+  async attachControllers (app) {
+    // Wait for any startup processes to complete for the Adapters libraries.
+    // await this.adapters.start()
+
+    if (this.config.useIpfs) {
+      // Attach JSON RPC controllers
+      this.attachRPCControllers()
+    }
+
+    // Attach and start the timer controllers
+    this.timerControllers.startTimers()
+  }
+
   // Add the JSON RPC router to the ipfs-coord adapter.
   attachRPCControllers () {
     const jsonRpcController = new JSONRPC({
@@ -68,4 +75,4 @@ class Controllers {
   }
 }
 
-module.exports = Controllers
+export default Controllers

src/controllers/json-rpc/about/index.js

@@ -6,10 +6,10 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
-const config = require('../../../../config')
+import config from '../../../../config/index.js'
 
 class AboutRPC {
   constructor (localConfig) {
@@ -48,4 +48,4 @@ class AboutRPC {
   }
 }
 
-module.exports = AboutRPC
+export default AboutRPC

src/controllers/json-rpc/auth/index.js

@@ -3,13 +3,14 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
 // const AuthLib = require('../../lib/auth')
 // const UserLib = require('../../../use-cases/user')
-const { wlogger } = require('../../../adapters/wlogger')
-const RateLimit = require('../rate-limit')
+import wlogger from '../../../adapters/wlogger.js'
+
+import RateLimit from '../rate-limit.js'
 
 class AuthRPC {
   constructor (localConfig = {}) {
@@ -173,4 +174,4 @@ class AuthRPC {
   }
 }
 
-module.exports = AuthRPC
+export default AuthRPC

src/controllers/json-rpc/index.js

@@ -3,13 +3,14 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local support libraries
-const { wlogger } = require('../../adapters/wlogger')
-const UserController = require('./users')
-const AuthController = require('./auth')
-const AboutController = require('./about')
+import wlogger from '../../adapters/wlogger.js'
+
+import UserController from './users/index.js'
+import AuthController from './auth/index.js'
+import AboutController from './about/index.js'
 
 let _this
 
@@ -90,13 +91,14 @@ class JSONRPC {
         }
 
         // Process response from REST API.
-        _this.adapters.ipfs.ipfsCoordAdapter.peerInputHandler(parsedData)
+        // _this.adapters.ipfs.ipfsCoordAdapter.peerInputHandler(parsedData)
 
         // Log the incoming JSON RPC command.
         wlogger.info(
           `JSON RPC received from ${from}, ID: ${parsedData.payload.id}, type: ${parsedData.type}`
         )
       }
+      // console.log(`parsedData: ${JSON.stringify(parsedData, null, 2)}`)
 
       // Added the property "from" to the parsedData object;
       // necessary for calculating rate limits (based on the IPFS ID).
@@ -105,6 +107,16 @@ class JSONRPC {
       // Default return string
       let retObj = _this.defaultResponse()
 
+      // Forward data on to bch adapter if this is the response of a BCH query.
+      try {
+        if (parsedData.payload.result.method === 'bch') {
+          console.log('routing to BCH adapter')
+          retObj = await _this.adapters.bch.rpcHandler(parsedData)
+        }
+      } catch (err) {
+        /* exit quietly */
+      }
+
       // Route the command to the appropriate route handler.
       switch (parsedData.payload.method) {
         case 'users':
@@ -116,6 +128,8 @@ class JSONRPC {
         case 'about':
           retObj = await _this.aboutController.aboutRouter(parsedData)
           break
+        case 'bch':
+          retObj = await _this.adapters.bch.rpcHandler(parsedData)
         // default:
         //   // Process response from REST API.
         //   _this.adapters.ipfs.ipfsCoordAdapter.peerInputHandler(parsedData)
@@ -200,4 +214,4 @@ class JSONRPC {
   }
 }
 
-module.exports = JSONRPC
+export default JSONRPC

src/controllers/json-rpc/rate-limit.js

@@ -4,7 +4,7 @@
 /* eslint no-useless-catch: 0 */
 
 // Local libraries
-const RateLimitLib = require('koa2-ratelimit').RateLimit
+import { RateLimit as RateLimitLib } from 'koa2-ratelimit'
 
 class RateLimit {
   constructor (options) {
@@ -80,4 +80,4 @@ class RateLimit {
   }
 }
 
-module.exports = RateLimit
+export default RateLimit

src/controllers/json-rpc/users/index.js

@@ -3,12 +3,13 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
 // const UserLib = require('../../../use-cases/user')
-const Validators = require('../validators')
-const RateLimit = require('../rate-limit')
+import Validators from '../validators.js'
+
+import RateLimit from '../rate-limit.js'
 
 class UserRPC {
   constructor (localConfig = {}) {
@@ -533,4 +534,4 @@ class UserRPC {
   // TODO create deleteUser()
 }
 
-module.exports = UserRPC
+export default UserRPC

src/controllers/json-rpc/validators.js

@@ -4,10 +4,11 @@
 /* eslint no-useless-catch: 0 */
 
 // Public npm libraries
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const UserModel = require('../../adapters/localdb/models/users')
 
 class Validators {
@@ -93,4 +94,4 @@ class Validators {
   }
 }
 
-module.exports = Validators
+export default Validators

src/controllers/rest-api/auth/controller.js

@@ -1,4 +1,4 @@
-const Passport = require('../../../adapters/passport')
+import Passport from '../../../adapters/passport.js'
 const passport = new Passport()
 
 let _this
@@ -96,4 +96,4 @@ class AuthRESTController {
   }
 }
 
-module.exports = AuthRESTController
+export default AuthRESTController

src/controllers/rest-api/auth/index.js

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const AuthRESTController = require('./controller')
+import AuthRESTController from './controller.js'
 
 class AuthRouter {
   constructor (localConfig = {}) {
@@ -48,4 +48,4 @@ class AuthRouter {
   }
 }
 
-module.exports = AuthRouter
+export default AuthRouter

src/controllers/rest-api/bch/controller.js

@@ -2,7 +2,8 @@
   REST API Controller library for the /bch route
 */
 
-const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
+import config from '../../../../config/index.js'
 
 // let _this
 
@@ -23,10 +24,7 @@ class BchRESTControllerLib {
     }
 
     // Encapsulate dependencies
-    // this.UserModel = this.adapters.localdb.Users
-    // this.userUseCases = this.useCases.user
-
-    // _this = this
+    this.config = config
   }
 
   /**
@@ -66,6 +64,11 @@ class BchRESTControllerLib {
     try {
       const providerId = ctx.request.body.provider
 
+      // Throw an error, if the provider has been set by an environment variable.
+      if (this.config.freezeProvider) {
+        throw new Error('Consumer has preferredProvider set in environment variable. Refusing to switch providers.')
+      }
+
       await this.adapters.bch.selectProvider(providerId)
 
       const body = {
@@ -231,6 +234,103 @@ class BchRESTControllerLib {
     }
   }
 
+  /**
+   * @api {post} /bch/utxosBulk UTXOs Bulk
+   * @apiName UTXOs Bulk
+   * @apiGroup REST BCH
+   * @apiDescription This endpoint returns UTXOs held at an address, hydrated
+   *  with token information.
+   * @apiDescription This endpoint is the same as the /bch/utxos endpoint, but
+   * it allows an array of up to 20 addresses to be queried at the same time.
+   * This reduces the number of JSON RPC calls, and is very handy
+   * for HD wallets that need to quickly scan a lot of addresses.
+   *
+   *  Given an address, this endpoint will return an object with thre following
+   *  properties:
+   *
+   *  - addresses: [] - the addresses these UTXOs are associated with
+   *  - bchUtxos: [] - UTXOs confirmed to be spendable as normal BCH
+   *  - nullUtxo: [] - UTXOs that did not pass SLP validation. Should be ignored and
+   *    not spent, to be safe.
+   *  - slpUtxos: {} - UTXOs confirmed to be colored as valid SLP tokens
+   *    - type1: {}
+   *      - tokens: [] - SLP token Type 1 tokens.
+   *      - mintBatons: [] - SLP token Type 1 mint batons.
+   *    - nft: {}
+   *      - tokens: [] - NFT tokens
+   *      - groupTokens: [] - NFT Group tokens, used to create NFT tokens.
+   *      - groupMintBatons: [] - Minting baton to create more NFT Group tokens.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X POST -d '{ "address": "bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj" }' localhost:5001/bch/utxos
+   *
+   * @apiSuccessExample {json} Success-Response:
+   *     HTTP/1.1 200 OK
+   *     [
+   *        {
+   *           "addresses": ["bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj"],
+   *           "bchUtxos":[
+   *              {
+   *                 "height":631219,
+   *                 "tx_hash":"ae2daa01c8172545b5edd205ea438706bcb74e63d4084a26b9ff2a46d46dc97f",
+   *                 "tx_pos":0,
+   *                 "value":1000,
+   *                 "txid":"ae2daa01c8172545b5edd205ea438706bcb74e63d4084a26b9ff2a46d46dc97f",
+   *                 "vout":0,
+   *                 "isValid":false
+   *              }
+   *           ],
+   *           "nullUtxos":[
+   *
+   *           ],
+   *           "slpUtxos":{
+   *              "type1":{
+   *                 "mintBatons":[
+   *
+   *                 ],
+   *                 "tokens":[
+   *
+   *                 ]
+   *              },
+   *              "nft":{
+   *                 "groupMintBatons":[
+   *
+   *                 ],
+   *                 "groupTokens":[
+   *
+   *                 ],
+   *                 "tokens":[
+   *
+   *                 ]
+   *              }
+   *           }
+   *        }
+   *     ]
+   *
+   * @apiError UnprocessableEntity Missing required parameters
+   *
+   * @apiErrorExample {json} Error-Response:
+   *     HTTP/1.1 422 Unprocessable Entity
+   *     {
+   *       "status": 422,
+   *       "error": "Unprocessable Entity"
+   *     }
+   */
+  async utxosBulk (ctx) {
+    try {
+      const addrs = ctx.request.body.addresses
+      // console.log('address: ', address)
+
+      const utxos = await this.adapters.bch.getUtxosBulk(addrs)
+      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
+
+      ctx.body = utxos
+    } catch (err) {
+      this.handleError(ctx, err)
+    }
+  }
+
   /**
    * @api {post} /bch/broadcast Broadcast
    * @apiName Broadcast
@@ -489,6 +589,8 @@ class BchRESTControllerLib {
    *          "pubkey": {
    *            "success": true,
    *            "publicKey": "033f267fec0f7eb2b27f8c2e3052b3d03b09d36b47de4082ffb638ffb334ef0eee"
+   *          }
+   *        }
    *     }
    *  }
    */
@@ -505,6 +607,122 @@ class BchRESTControllerLib {
     }
   }
 
+  /**
+   * @api {REST} /bch/utxoIsValid utxoIsValid
+   * @apiPermission public
+   * @apiName utxoIsValid
+   * @apiGroup REST BCH
+   * @apiDescription Verify if UTXO is valid
+   * Given a UTXO object (txid and vout), a full node is queried to verify that
+   * the UTXO still exists in the mempool (true), or if it has been spent (false).
+   *
+   *  - jsonrpc: "" - jsonrpc version
+   *  - id: "" - jsonrpc id
+   *  - result: {} - Result of the petition with the RPC information
+   *      - success: - Request status
+   *      - isValid: - Boolean: true or false
+   *
+   * @apiExample Example usage:
+   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "utxoIsValid", "utxo": {"tx_hash": "17754221b29f189532d4fc2ae89fb467ad2dede30fdec4854eb2129b3ba90d7a", "tx_pos": 0}}}
+   *
+   * @apiSuccessExample {json} Success-Response:
+   *  {
+   *     "jsonrpc":"2.0",
+   *     "id":"555",
+   *     "result":{
+   *        "method":"bch",
+   *        "reciever":"QmU86vLVbUY1UhziKB6rak7GPKRA2QHWvzNm2AjEvXNsT6",
+   *        "value":{
+   *          "success": true,
+   *          "status": 200,
+   *          "endpoint": "utxoIsValid",
+   *          "isValid": true
+   *        }
+   *     }
+   *
+   *  }
+   */
+  async utxoIsValid (ctx) {
+    try {
+      const utxo = ctx.request.body.utxo
+
+      const data = await this.adapters.bch.utxoIsValid(utxo)
+      // console.log(`utxoIsValid data: ${JSON.stringify(data, null, 2)}`)
+
+      ctx.body = data
+    } catch (err) {
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+    * @api {REST} /bch getTokenData
+    * @apiPermission public
+    * @apiName getTokenData
+    * @apiGroup REST BCH
+    * @apiDescription Get data associated with a token
+    *
+    * Given a token ID, this endpoint will retrieve the IPFS CIDs associated with
+    * the tokens mutable and immutable data. This is extension of the PS002
+    * specification for mutable data for tokens:
+    * https://github.com/Permissionless-Software-Foundation/specifications/blob/master/ps002-slp-mutable-data.md
+    *
+    *
+    * @apiExample Example usage:
+    * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d", "withTxHistory": true }' https://bc01-ca-bch-consumer.fullstackcash.nl/bch/getTokenData
+    */
+  async getTokenData (ctx) {
+    try {
+      const tokenId = ctx.request.body.tokenId
+      const withTxHistory = !!ctx.request.body.withTxHistory
+
+      const data = await this.adapters.bch.getTokenData(tokenId, withTxHistory)
+      console.log(`getTokenData data: ${JSON.stringify(data, null, 2)}`)
+
+      ctx.body = data
+    } catch (err) {
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+    * @api {REST} /bch getTokenData2
+    * @apiPermission public
+    * @apiName getTokenData2
+    * @apiGroup REST BCH
+    * @apiDescription Get token icon and other media
+    *
+    * Get the icon for a token, given it's token ID.
+    * This function expects a string input of a token ID property.
+    * This function returns an object with a tokenIcon property that contains
+    * the URL to the icon.
+    *
+    * The output object always have these properties:
+    * - tokenIcon: A url to the token icon, if it exists.
+    * - tokenStats: Data about the token from psf-slp-indexer.
+    * - optimizedTokenIcon: An alternative, potentially more optimal, url to the token icon, if it exists.
+    * - iconRepoCompatible: true if the token icon is available via token.bch.sx
+    * - ps002Compatible: true if the token icon is compatible with PS007 specification.
+    *
+    * @apiExample Example usage:
+    * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d" }' https://bc01-ca-bch-consumer.fullstackcash.nl/bch/getTokenData2
+    * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d", "updateCache": true }' https://bc01-ca-bch-consumer.fullstackcash.nl/bch/getTokenData2
+    */
+  async getTokenData2 (ctx) {
+    try {
+      const tokenId = ctx.request.body.tokenId
+      const updateCache = ctx.request.body.updateCache
+      console.log('getTokenData2() updateCache: ', updateCache)
+
+      const data = await this.adapters.bch.getTokenData2(tokenId, updateCache)
+      console.log(`getTokenData2 data: ${JSON.stringify(data, null, 2)}`)
+
+      ctx.body = data
+    } catch (err) {
+      this.handleError(ctx, err)
+    }
+  }
+
   // DRY error handler
   handleError (ctx, err) {
     // If an HTTP status is specified by the buisiness logic, use that.
@@ -521,4 +739,5 @@ class BchRESTControllerLib {
   }
 }
 
-module.exports = BchRESTControllerLib
+// module.exports = BchRESTControllerLib
+export default BchRESTControllerLib

src/controllers/rest-api/bch/index.js

@@ -3,11 +3,11 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const BchRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import BchRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -55,10 +55,14 @@ class BchRouter {
     this.router.post('/provider', this.postProvider)
     this.router.post('/balance', this.postBalance)
     this.router.post('/utxos', this.postUtxos)
+    this.router.post('/utxosBulk', this.postUtxosBulk)
     this.router.post('/broadcast', this.postBroadcast)
     this.router.post('/txHistory', this.postTxHistory)
     this.router.post('/txData', this.postTxData)
     this.router.post('/pubkey', this.postPubKey)
+    this.router.post('/utxoIsValid', this.utxoIsValid)
+    this.router.post('/getTokenData', this.getTokenData)
+    this.router.post('/getTokenData2', this.getTokenData2)
 
     // Attach the Controller routes to the Koa app.
     app.use(this.router.routes())
@@ -81,6 +85,10 @@ class BchRouter {
     await _this.bchRESTController.utxos(ctx, next)
   }
 
+  async postUtxosBulk (ctx, next) {
+    await _this.bchRESTController.utxosBulk(ctx, next)
+  }
+
   async postBroadcast (ctx, next) {
     await _this.bchRESTController.broadcast(ctx, next)
   }
@@ -96,6 +104,19 @@ class BchRouter {
   async postPubKey (ctx, next) {
     await _this.bchRESTController.pubKey(ctx, next)
   }
+
+  async utxoIsValid (ctx, next) {
+    await _this.bchRESTController.utxoIsValid(ctx, next)
+  }
+
+  async getTokenData (ctx, next) {
+    await _this.bchRESTController.getTokenData(ctx, next)
+  }
+
+  async getTokenData2 (ctx, next) {
+    await _this.bchRESTController.getTokenData2(ctx, next)
+  }
 }
 
-module.exports = BchRouter
+// module.exports = BchRouter
+export default BchRouter

src/controllers/rest-api/contact/controller.js

@@ -3,9 +3,9 @@
 */
 
 /* eslint-disable no-useless-escape */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
+import ContactLib from '../../../adapters/contact.js'
 
-const ContactLib = require('../../../adapters/contact')
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
 const contactLib = new ContactLib()
 
 let _this
@@ -74,4 +74,4 @@ class ContactController {
     }
   }
 }
-module.exports = ContactController
+export default ContactController

src/controllers/rest-api/contact/index.js

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const ContactRESTControllerLib = require('./controller')
+import ContactRESTControllerLib from './controller.js'
 
 class ContactRouter {
   constructor (localConfig = {}) {
@@ -53,4 +53,4 @@ class ContactRouter {
   }
 }
 
-module.exports = ContactRouter
+export default ContactRouter

src/controllers/rest-api/index.js

@@ -6,15 +6,15 @@
 
 // Public npm libraries.
 
-// Load the REST API Controllers.
-const AuthRESTController = require('./auth')
-const UserRouter = require('./users')
-const ContactRESTController = require('./contact')
-const LogsRESTController = require('./logs')
-const BchRESTController = require('./bch')
-const IpfsRESTController = require('./ipfs')
-const P2wdbRESTController = require('./p2wdb')
-const PriceRESTController = require('./price')
+// Local libraries
+import AuthRESTController from './auth/index.js'
+import UserRouter from './users/index.js'
+import ContactRESTController from './contact/index.js'
+import LogsRESTController from './logs/index.js'
+import BchRESTController from './bch/index.js'
+import IpfsRESTController from './ipfs/index.js'
+import P2wdbRESTController from './p2wdb/index.js'
+import PriceRESTController from './price/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -75,4 +75,4 @@ class RESTControllers {
   }
 }
 
-module.exports = RESTControllers
+export default RESTControllers

src/controllers/rest-api/ipfs/controller.js

@@ -2,7 +2,7 @@
   REST API Controller library for the /ipfs route
 */
 
-const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -95,4 +95,5 @@ class IpfsRESTControllerLib {
   }
 }
 
-module.exports = IpfsRESTControllerLib
+// module.exports = IpfsRESTControllerLib
+export default IpfsRESTControllerLib

src/controllers/rest-api/ipfs/index.js

@@ -3,11 +3,11 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const IPFSRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import IPFSRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
 
 // let _this
 
@@ -65,4 +65,5 @@ class BchRouter {
   // }
 }
 
-module.exports = BchRouter
+// module.exports = BchRouter
+export default BchRouter

src/controllers/rest-api/logs/controller.js

@@ -1,4 +1,4 @@
-const LogsApiLib = require('../../../adapters/logapi')
+import LogsApiLib from '../../../adapters/logapi.js'
 const logsApiLib = new LogsApiLib()
 let _this
 
@@ -62,4 +62,4 @@ class LogsApi {
   }
 }
 
-module.exports = LogsApi
+export default LogsApi

src/controllers/rest-api/logs/index.js

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const LogsRESTControllerLib = require('./controller')
+import LogsRESTControllerLib from './controller.js'
 
 class LogsRouter {
   constructor (localConfig = {}) {
@@ -52,4 +52,4 @@ class LogsRouter {
   }
 }
 
-module.exports = LogsRouter
+export default LogsRouter

src/controllers/rest-api/middleware/error.js

@@ -1,4 +1,4 @@
-module.exports = function errorMiddleware () {
+export default function errorMiddleware () {
   return async (ctx, next) => {
     try {
       await next()
@@ -8,4 +8,4 @@ module.exports = function errorMiddleware () {
       ctx.app.emit('error', err, ctx)
     }
   }
-}
+};

src/controllers/rest-api/middleware/validators.js

@@ -1,11 +1,24 @@
 /*
   REST API validator middleware.
+
+  These are a series of functions that ensure the user making a REST API
+  matches a user in the database (or not). In can do fine-grain user control
+  such as telling the difference between an admin, a normal user, and an
+  anonymous user.
+
+  This middleware is used to gatekeep access to different REST API resources.
+
+  CT 9/17/22:
+  This library was lightly refactored to make it work with the new unit tests.
+  This not and the commented code below can be deleted once it is verified that
+  this refactor did not result in any breaking changes.
 */
 
-const User = require('../../../adapters/localdb/models/users')
-const config = require('../../../../config')
-const jwt = require('jsonwebtoken')
-const { wlogger } = require('../../../adapters/wlogger')
+import User from '../../../adapters/localdb/models/users.js'
+
+import config from '../../../../config/index.js'
+import jwt from 'jsonwebtoken'
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -20,12 +33,10 @@ class Validators {
 
   async ensureUser (ctx, next) {
     try {
-      // console.log(`getToken: ${typeof (getToken)}`)
       const token = _this.getToken(ctx)
 
       if (!token) {
-        // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       let decoded = null
@@ -34,20 +45,23 @@ class Validators {
         // console.log(`config: ${JSON.stringify(config, null, 2)}`)
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
-        // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
+
       if (!ctx.state.user) {
-        // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // console.log('Err: Could not find user.')
+        throw new Error('Could not find user')
       }
 
       // return next()
       return true
     } catch (error) {
-      ctx.throw(401)
+      // console.log('Ensure user error: ', error)
+      // console.log('ctx: ', ctx)
+      ctx.status = 401
+      ctx.throw(401, error.message)
     }
   }
 
@@ -60,7 +74,8 @@ class Validators {
 
       if (!token) {
         // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       let decoded = null
@@ -70,22 +85,26 @@ class Validators {
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
         // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
       if (!ctx.state.user) {
         // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not find user')
       }
 
       if (ctx.state.user.type !== 'admin') {
-        ctx.throw(401, 'not admin')
+        // ctx.throw(401, 'not admin')
+        throw new Error('User is not an admin')
       }
 
       // return next()
       return true
     } catch (error) {
+      ctx.status = 401
       ctx.throw(401, error.message)
     }
   }
@@ -101,7 +120,8 @@ class Validators {
 
       if (!token) {
         // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       // The user ID targeted in this API call.
@@ -114,14 +134,16 @@ class Validators {
         // console.log(`config: ${JSON.stringify(config, null, 2)}`)
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
-        // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        console.log(`Err: Token could not be decoded: ${err}`)
+        // ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
       if (!ctx.state.user) {
         // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not find user')
       }
       // console.log('ctx.state.user: ', ctx.state.user)
 
@@ -135,7 +157,8 @@ class Validators {
 
         // If they don't match, then the calling user better be an admin.
         if (ctx.state.user.type !== 'admin') {
-          ctx.throw(401, 'not admin')
+          // ctx.throw(401, 'not admin')
+          throw new Error('User is not an admin')
         } else {
           wlogger.verbose("It's ok. The user is an admin.")
         }
@@ -144,6 +167,8 @@ class Validators {
       // return next()
       return true
     } catch (error) {
+      // console.log('Error in ensureTargetUserOrAdmin(): ', error)
+      ctx.status = 401
       ctx.throw(401, error.message)
     }
   }
@@ -166,4 +191,4 @@ class Validators {
   }
 }
 
-module.exports = Validators
+export default Validators

src/controllers/rest-api/p2wdb/controller.js

@@ -2,7 +2,7 @@
   REST API Controller library for the /p2wdb route
 */
 
-const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
 
 // let _this
 
@@ -135,4 +135,5 @@ class P2wdbRESTControllerLib {
   }
 }
 
-module.exports = P2wdbRESTControllerLib
+// module.exports = P2wdbRESTControllerLib
+export default P2wdbRESTControllerLib

src/controllers/rest-api/p2wdb/index.js

@@ -3,11 +3,11 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const P2wdbRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import P2wdbRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -98,4 +98,5 @@ class P2wdbRouter {
   // }
 }
 
-module.exports = P2wdbRouter
+// module.exports = P2wdbRouter
+export default P2wdbRouter

src/controllers/rest-api/price/controller.js

@@ -2,8 +2,8 @@
   REST API Controller library for the /bch route
 */
 
-const axios = require('axios')
-const { wlogger } = require('../../../adapters/wlogger')
+import axios from 'axios'
+import wlogger from '../../../adapters/wlogger.js'
 
 // let _this
 
@@ -64,6 +64,31 @@ class PriceRESTControllerLib {
     }
   }
 
+  // Get the XEC price.
+  // TODO: Add API docs.
+  async getXecPrice (ctx) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: 'https://api.coinex.com',
+        url: '/v1/market/ticker?market=xecusdt',
+        timeout: 15000
+      }
+      //
+
+      const response = await this.axios.request(opt)
+      console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      ctx.body = { usd: Number(response.data.data.ticker.last) }
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in GET /price/xecusd.', err)
+
+      this.handleError(ctx, err)
+    }
+  }
+
   // DRY error handler
   handleError (ctx, err) {
     // If an HTTP status is specified by the buisiness logic, use that.
@@ -80,4 +105,5 @@ class PriceRESTControllerLib {
   }
 }
 
-module.exports = PriceRESTControllerLib
+// module.exports = PriceRESTControllerLib
+export default PriceRESTControllerLib

src/controllers/rest-api/price/index.js

@@ -3,11 +3,11 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const PriceRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import PriceRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -52,6 +52,7 @@ class PriceRouter {
 
     // Define the routes and attach the controller.
     this.router.get('/usd', this.getPrice)
+    this.router.get('/xecusd', this.getXecPrice)
 
     // Attach the Controller routes to the Koa app.
     app.use(this.router.routes())
@@ -61,6 +62,11 @@ class PriceRouter {
   async getPrice (ctx, next) {
     await _this.priceRESTController.getUSD(ctx, next)
   }
+
+  async getXecPrice (ctx, next) {
+    await _this.priceRESTController.getXecPrice(ctx, next)
+  }
 }
 
-module.exports = PriceRouter
+// module.exports = PriceRouter
+export default PriceRouter

src/controllers/rest-api/users/controller.js

@@ -2,7 +2,7 @@
   REST API Controller library for the /user route
 */
 
-const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -36,7 +36,7 @@ class UserRESTControllerLib {
    * @apiGroup REST Users
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "email": "email@format.com", "name": "my name", "password": "secretpasas" } }' localhost:5001/users
+   * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "email": "email@format.com", "name": "my name", "password": "secretpasas" } }' localhost:5010/users
    *
    * @apiParam {Object} user          User object (required)
    * @apiParam {String} user.email Email
@@ -124,7 +124,7 @@ class UserRESTControllerLib {
 
       ctx.body = { users }
     } catch (err) {
-      wlogger.error('Error in users/controller.js/getUsers(): '.err)
+      wlogger.error('Error in users/controller.js/getUsers(): ', err)
       ctx.throw(422, err.message)
     }
   }
@@ -136,7 +136,7 @@ class UserRESTControllerLib {
    * @apiGroup REST Users
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X GET localhost:5000/users/56bd1da600a526986cf65c80
+   * curl -H "Content-Type: application/json" -X GET localhost:5010/users/56bd1da600a526986cf65c80
    *
    * @apiSuccess {Object}   users           User object
    * @apiSuccess {ObjectId} users._id       User id
@@ -281,4 +281,4 @@ class UserRESTControllerLib {
   }
 }
 
-module.exports = UserRESTControllerLib
+export default UserRESTControllerLib

src/controllers/rest-api/users/index.js

@@ -3,11 +3,12 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const UserRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import UserRESTControllerLib from './controller.js'
+
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -85,4 +86,4 @@ class UserRouter {
   }
 }
 
-module.exports = UserRouter
+export default UserRouter

src/controllers/timer-controllers.js

@@ -0,0 +1,65 @@
+/*
+  This Controller library is concerned with timer-based functions that are
+  kicked off periodicially.
+*/
+
+import config from '../../config/index.js'
+
+class TimerControllers {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating Timer Controller libraries.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating Timer Controller libraries.'
+      )
+    }
+
+    this.debugLevel = localConfig.debugLevel
+
+    // Encapsulate dependencies
+    this.config = config
+
+    // Bind 'this' object to all subfunctions.
+    this.exampleTimerFunc = this.exampleTimerFunc.bind(this)
+
+    // this.startTimers()
+  }
+
+  // Start all the time-based controllers.
+  startTimers () {
+    // Any new timer control functions can be added here. They will be started
+    // when the server starts.
+    this.optimizeWalletHandle = setInterval(this.exampleTimerFunc, 60000 * 10)
+
+    return true
+  }
+
+  stopTimers () {
+    clearInterval(this.optimizeWalletHandle)
+  }
+
+  // Replace this example function with your own timer handler.
+  exampleTimerFunc (negativeTest) {
+    try {
+      console.log('Example timer controller executed.')
+
+      if (negativeTest) throw new Error('test error')
+
+      return true
+    } catch (err) {
+      console.error('Error in exampleTimerFunc(): ', err)
+
+      // Note: Do not throw an error. This is a top-level function.
+      return false
+    }
+  }
+}
+
+export default TimerControllers

src/entities/user.js

@@ -21,4 +21,4 @@ class User {
   }
 }
 
-module.exports = User
+export default User

src/use-cases/index.js

@@ -4,7 +4,7 @@
   https://troutsblog.com/blog/clean-architecture
 */
 
-const UserUseCases = require('./user')
+import UserUseCases from './user.js'
 
 class UseCases {
   constructor (localConfig = {}) {
@@ -14,16 +14,29 @@ class UseCases {
         'Instance of adapters must be passed in when instantiating Use Cases library.'
       )
     }
-    this.eventEmitter = localConfig.eventEmitter
-    if (!this.eventEmitter) {
-      throw new Error(
-        'Instance of Event Emitter must be passed in when instantiating Use Cases library.'
-      )
-    }
+    // this.eventEmitter = localConfig.eventEmitter
+    // if (!this.eventEmitter) {
+    //   throw new Error(
+    //     'Instance of Event Emitter must be passed in when instantiating Use Cases library.'
+    //   )
+    // }
 
     // console.log('use-cases/index.js localConfig: ', localConfig)
     this.user = new UserUseCases(localConfig)
   }
+
+  // Run any startup Use Cases at the start of the app.
+  async start () {
+    // try {
+    console.log('Async Use Cases have been started.')
+
+    return true
+    // } catch (err) {
+    //   console.error('Error in use-cases/index.js/start()')
+    //   // console.log(err)
+    //   throw err
+    // }
+  }
 }
 
-module.exports = UseCases
+export default UseCases

src/use-cases/user.js

@@ -3,8 +3,9 @@
   functions are called by the /user REST API endpoints.
 */
 
-const UserEntity = require('../entities/user')
-const { wlogger } = require('../adapters/wlogger')
+import UserEntity from '../entities/user.js'
+
+import wlogger from '../adapters/wlogger.js'
 
 class UserLib {
   constructor (localConfig = {}) {
@@ -181,4 +182,4 @@ class UserLib {
   }
 }
 
-module.exports = UserLib
+export default UserLib

swarm.key

@@ -1,3 +0,0 @@
-/key/swarm/psk/1.0.0/
-/base16/
-bbd935b70105b03ebd0c6a3c2d2730cd22fc0d18c490ccf689b6c8a22e1bed2a

test/e2e/automated/a01-auth.rest-e2e.js

@@ -5,14 +5,18 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const axios = require('axios').default
+import { assert } from 'chai'
+
+import axios from 'axios'
+
+// const sinon = require('sinon')
 
 // Local support libraries
-const config = require('../../../config')
-const Server = require('../../../bin/server')
-const testUtils = require('../../utils/test-utils')
-const AdminLib = require('../../../src/adapters/admin')
+import config from '../../../config/index.js'
+
+import Server from '../../../bin/server.js'
+import testUtils from '../../utils/test-utils.js'
+import AdminLib from '../../../src/adapters/admin.js'
 const adminLib = new AdminLib()
 
 // const request = supertest.agent(app.listen())

test/e2e/automated/a02-users.rest-e2e.js

@@ -1,21 +1,25 @@
-const testUtils = require('../../utils/test-utils')
-const assert = require('chai').assert
-const config = require('../../../config')
-const axios = require('axios').default
-const sinon = require('sinon')
+import testUtils from '../../utils/test-utils.js'
+import { assert } from 'chai'
+import config from '../../../config/index.js'
+import axios from 'axios'
+import sinon from 'sinon'
+import util from 'util'
 
-const util = require('util')
+import UserController from '../../../src/controllers/rest-api/users/controller.js'
+import Adapters from '../../../src/adapters/index.js'
+import UseCases from '../../../src/use-cases/index.js'
+
+// import UserController from '../../../src/controllers/rest-api/users/controller.js'
+// import Adapters from '../../../src/adapters/index.js'
+import EventEmitter from 'events'
 util.inspect.defaultOptions = { depth: 1 }
 
 const LOCALHOST = `http://localhost:${config.port}`
 
 const context = {}
-
-const UserController = require('../../../src/controllers/rest-api/users/controller')
-const Adapters = require('../../../src/adapters')
-const EventEmitter = require('events')
 const adapters = new Adapters({ eventEmitter: new EventEmitter() })
-const UseCases = require('../../../src/use-cases/')
+// import UseCases from '../../../src/use-cases/index.js'
+
 let uut
 let sandbox
 
@@ -39,9 +43,9 @@ describe('Users', () => {
     context.id2 = testUser.user._id
 
     // Get the JWT used to log in as the admin 'system' user.
-    const adminJWT = await testUtils.getAdminJWT()
-    // console.log(`adminJWT: ${admi  nJWT}`)
-    context.adminJWT = adminJWT
+    // const adminJWT = await testUtils.getAdminJWT()
+    // console.log(`adminJWT: ${adminJWT}`)
+    // context.adminJWT = adminJWT
 
     // const admin = await testUtils.loginAdminUser()
     // context.adminJWT = admin.token
@@ -72,9 +76,6 @@ describe('Users', () => {
 
         await axios(options)
 
-        /*      console.log(
-          `result stringified: ${JSON.stringify(result.data, null, 2)}`
-        ) */
         assert(false, 'Unexpected result')
       } catch (err) {
         assert(err.response.status === 422, 'Error code 422 expected.')
@@ -599,30 +600,30 @@ describe('Users', () => {
       }
     })
 
-    it('should be able to update other user when admin', async () => {
-      const adminJWT = context.adminJWT
+    // it('should be able to update other user when admin', async () => {
+    //   const adminJWT = context.adminJWT
 
-      const options = {
-        method: 'PUT',
-        url: `${LOCALHOST}/users/${context.user2._id.toString()}`,
-        headers: {
-          Authorization: `Bearer ${adminJWT}`
-        },
-        data: {
-          user: {
-            name: 'This should work',
-            email: 'test4@test.com',
-            password: 'password'
-          }
-        }
-      }
+    //   const options = {
+    //     method: 'PUT',
+    //     url: `${LOCALHOST}/users/${context.user2._id.toString()}`,
+    //     headers: {
+    //       Authorization: `Bearer ${adminJWT}`
+    //     },
+    //     data: {
+    //       user: {
+    //         name: 'This should work',
+    //         email: 'test4@test.com',
+    //         password: 'password'
+    //       }
+    //     }
+    //   }
 
-      const result = await axios(options)
-      // console.log(`result stringified: ${JSON.stringify(result, null, 2)}`)
+    //   const result = await axios(options)
+    //   // console.log(`result stringified: ${JSON.stringify(result, null, 2)}`)
 
-      const userName = result.data.user.name
-      assert.equal(userName, 'This should work')
-    })
+    //   const userName = result.data.user.name
+    //   assert.equal(userName, 'This should work')
+    // })
 
     it('should update user with minimum inputs', async () => {
       const _id = context.user._id
@@ -771,22 +772,22 @@ describe('Users', () => {
       assert.equal(result.data.success, true)
     })
 
-    it('should be able to delete other users when admin', async () => {
-      const id = context.id2
-      const adminJWT = context.adminJWT
+    // it('should be able to delete other users when admin', async () => {
+    //   const id = context.id2
+    //   const adminJWT = context.adminJWT
 
-      const options = {
-        method: 'DELETE',
-        url: `${LOCALHOST}/users/${id}`,
-        headers: {
-          Accept: 'application/json',
-          Authorization: `Bearer ${adminJWT}`
-        }
-      }
-      const result = await axios(options)
-      // console.log(`result: ${util.inspect(result.data)}`)
+    //   const options = {
+    //     method: 'DELETE',
+    //     url: `${LOCALHOST}/users/${id}`,
+    //     headers: {
+    //       Accept: 'application/json',
+    //       Authorization: `Bearer ${adminJWT}`
+    //     }
+    //   }
+    //   const result = await axios(options)
+    //   // console.log(`result: ${util.inspect(result.data)}`)
 
-      assert.equal(result.data.success, true)
-    })
+    //   assert.equal(result.data.success, true)
+    // })
   })
 })

test/e2e/automated/a04-contact.rest-e2e.js

@@ -1,15 +1,15 @@
-const config = require('../../../config')
-const axios = require('axios').default
-const assert = require('chai').assert
-const sinon = require('sinon')
+import config from '../../../config/index.js'
+import axios from 'axios'
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+import { context as mockContext } from '../../unit/mocks/ctx-mock.js'
+import ContactController from '../../../src/controllers/rest-api/contact/controller.js'
 
 // Mock data
 // const mockData = require('./mocks/contact-mocks')
 
 const LOCALHOST = `http://localhost:${config.port}`
-
-const mockContext = require('../../unit/mocks/ctx-mock').context
-const ContactController = require('../../../src/controllers/rest-api/contact/controller')
 let uut
 let sandbox
 

test/e2e/automated/a06-logapi.rest-e2e.js

@@ -1,17 +1,15 @@
-const config = require('../../../config')
-const assert = require('chai').assert
+import config from '../../../config/index.js'
+import { assert } from 'chai'
+import axios from 'axios'
+import sinon from 'sinon'
+import util from 'util'
 
-const axios = require('axios').default
-const sinon = require('sinon')
-
-const util = require('util')
+import LogsController from '../../../src/controllers/rest-api/logs/controller.js'
+import { context as mockContext } from '../../unit/mocks/ctx-mock.js'
 util.inspect.defaultOptions = { depth: 1 }
 
 const LOCALHOST = `http://localhost:${config.port}`
 
-const LogsController = require('../../../src/controllers/rest-api/logs/controller')
-const mockContext = require('../../unit/mocks/ctx-mock').context
-
 let sandbox
 let uut
 describe('LogsApi', () => {
@@ -39,27 +37,25 @@ describe('LogsApi', () => {
       }
     })
 
-    it('should return log', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/logs`,
-          data: {
-            password: 'test'
-          }
-        }
+    // it('should return log', async () => {
 
-        const result = await axios(options)
+    //   const options = {
+    //     method: 'post',
+    //     url: `${LOCALHOST}/logs`,
+    //     data: {
+    //       password: 'test'
+    //     }
+    //   }
 
-        assert.isTrue(result.data.success)
-        assert.isArray(result.data.data)
-        assert.property(result.data.data[0], 'message')
-        assert.property(result.data.data[0], 'level')
-        assert.property(result.data.data[0], 'timestamp')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
-    })
+    //   const result = await axios(options)
+
+    //   assert.isTrue(result.data.success)
+    //   assert.isArray(result.data.data)
+    //   assert.property(result.data.data[0], 'message')
+    //   assert.property(result.data.data[0], 'level')
+    //   assert.property(result.data.data[0], 'timestamp')
+
+    // })
 
     it('should return false if files are not found!', async () => {
       try {

test/e2e/automated/a08-validators.rest-e2e.js

@@ -1,12 +1,10 @@
-const assert = require('chai').assert
-const testUtils = require('../../utils/test-utils')
-
-const Validators = require('../../../src/controllers/rest-api/middleware/validators')
-
-const sinon = require('sinon')
-const mockContext = require('../../unit/mocks/ctx-mock').context
-
-const util = require('util')
+/*
+import { assert } from 'chai';
+import testUtils from '../../utils/test-utils.js';
+import Validators from '../../../src/controllers/rest-api/middleware/validators.js';
+import sinon from 'sinon';
+import { context as mockContext } from '../../unit/mocks/ctx-mock.js';
+import util from 'util';
 util.inspect.defaultOptions = { depth: 1 }
 
 const context = {}
@@ -303,3 +301,4 @@ describe('Validators', () => {
     })
   })
 })
+*/

test/e2e/automated/a09-admin.rest-e2e.js

@@ -1,10 +1,7 @@
-const assert = require('chai').assert
-
-const Admin = require('../../../src/adapters/admin')
-
-const sinon = require('sinon')
-
-const util = require('util')
+import { assert } from 'chai'
+import Admin from '../../../src/adapters/admin.js'
+import sinon from 'sinon'
+import util from 'util'
 util.inspect.defaultOptions = { depth: 1 }
 
 let sandbox

test/unit/adapters/adapters-index-unit.js

@@ -0,0 +1,57 @@
+/*
+  Unit tests for the adapters index.js library
+*/
+
+// Global npm libraries
+import { assert } from 'chai'
+
+import sinon from 'sinon'
+
+// Local libraries
+import Adapters from '../../../src/adapters/index.js'
+
+describe('#adapters', () => {
+  let uut, sandbox
+
+  beforeEach(() => {
+    uut = new Adapters()
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#start', () => {
+    it('should start the async adapters', async () => {
+      // Mock dependencies
+      uut.config.getJwtAtStartup = true
+      uut.config.useIpfs = true
+      uut.config.env = 'not-a-test'
+      sandbox.stub(uut.fullStackJwt, 'getJWT').resolves()
+      sandbox.stub(uut.fullStackJwt, 'instanceBchjs').resolves()
+      sandbox.stub(uut.ipfs, 'start').resolves()
+
+      const result = await uut.start()
+
+      assert.equal(result, true)
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        uut.config.getJwtAtStartup = false
+        uut.config.env = 'dev'
+        sandbox.stub(uut.ipfs, 'start').rejects(new Error('test error'))
+
+        await uut.start()
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+})

test/unit/adapters/bch.adapter.unit.js

@@ -5,19 +5,20 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
-const EventEmitter = require('events')
-const cloneDeep = require('lodash.clonedeep')
+import { assert } from 'chai'
+import sinon from 'sinon'
+import EventEmitter from 'events'
+import cloneDeep from 'lodash.clonedeep'
 
 // Local support libraries
 // const testUtils = require('../../utils/test-utils')
 
 // Unit under test (uut)
-const BchAdapter = require('../../../src/adapters/bch')
-const adapters = require('../mocks/adapters')
+import BchAdapter from '../../../src/adapters/bch/index.js'
+import adapters from '../mocks/adapters/index.js'
+import mockDataLib from '../mocks/use-cases/rest-api-mocks.js'
+
 const eventEmitter = new EventEmitter()
-const mockDataLib = require('../mocks/use-cases/rest-api-mocks')
 
 describe('#bch-use-case', () => {
   let uut
@@ -54,19 +55,19 @@ describe('#bch-use-case', () => {
       }
     })
 
-    it('should throw an error if adapters are not passed in', () => {
-      try {
-        const ipfs = {}
-        uut = new BchAdapter({ ipfs })
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.include(
-          err.message,
-          'An instance of an EventEmitter must be passed when instantiating the adapters.'
-        )
-      }
-    })
+    // it('should throw an error if adapters are not passed in', () => {
+    //   try {
+    //     const ipfs = {}
+    //     uut = new BchAdapter({ ipfs })
+    //
+    //     assert.fail('Unexpected code path')
+    //   } catch (err) {
+    //     assert.include(
+    //       err.message,
+    //       'An instance of an EventEmitter must be passed when instantiating the adapters.'
+    //     )
+    //   }
+    // })
   })
 
   describe('#waitForRPCResponse', () => {
@@ -165,6 +166,82 @@ describe('#bch-use-case', () => {
     })
   })
 
+  describe('#getUtxos', () => {
+    it('should get the UTXOs of an address', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const addr = 'addr'
+
+      const result = await uut.getUtxos(addr)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getUtxos()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getUtxosBulk', () => {
+    it('should get the UTXOs of an address', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const addrs = ['addr']
+
+      const result = await uut.getUtxosBulk(addrs)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should throw an error if addresses is not an array', async () => {
+      try {
+        await uut.getUtxosBulk()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'addresses parameter must be an array')
+      }
+    })
+
+    it('should throw an error if addresses array is larger than 20 elements', async () => {
+      try {
+        const addrs = []
+        for (let i = 0; i < 25; i++) {
+          addrs.push(i)
+        }
+
+        await uut.getUtxosBulk(addrs)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'addresses parameter must not exceed 20 elements')
+      }
+    })
+  })
+
   describe('#broadcast', () => {
     it('should broadcast a transaction', async () => {
       // Force connection to a wallet service
@@ -284,4 +361,94 @@ describe('#bch-use-case', () => {
       }
     })
   })
+
+  describe('#utxoIsValid', () => {
+    it('should validate a utxo', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const utxo = { a: 'b' }
+
+      const result = await uut.utxoIsValid(utxo)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.utxoIsValid()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getTokenData', () => {
+    it('should validate a utxo', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const tokenId = 'blah'
+
+      const result = await uut.getTokenData(tokenId)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getTokenData()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getTokenData2', () => {
+    it('should validate a utxo', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const tokenId = 'blah'
+
+      const result = await uut.getTokenData2(tokenId)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getTokenData2()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
 })

test/unit/adapters/contact.adapter.unit.js

@@ -1,7 +1,6 @@
-const assert = require('chai').assert
-const sinon = require('sinon')
-
-const ContactLib = require('../../../src/adapters/contact')
+import { assert } from 'chai'
+import sinon from 'sinon'
+import ContactLib from '../../../src/adapters/contact.js'
 let uut
 let sandbox
 

test/unit/adapters/fullstack-jwt.adapter.unit.js

@@ -3,10 +3,10 @@
 
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const FullStackJWT = require('../../../src/adapters/fullstack-jwt')
+import sinon from 'sinon'
+import FullStackJWT from '../../../src/adapters/fullstack-jwt.js'
 
 describe('#FullStackJWT', () => {
   let sandbox

test/unit/adapters/ipfs-coord.adapter.unit.js

@@ -2,15 +2,15 @@
   Unit tests for the IPFS Adapter.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-const cloneDeep = require('lodash.clonedeep')
-
-const IPFSCoordAdapter = require('../../../src/adapters/ipfs/ipfs-coord')
-const IPFSMock = require('../mocks/ipfs-mock')
-const IPFSCoordMock = require('../mocks/ipfs-coord-mock')
-const EventEmitter = require('events')
-const mockDataLib = require('../mocks/adapters/ipfs-coord-mocks')
+import { assert } from 'chai'
+import sinon from 'sinon'
+import cloneDeep from 'lodash.clonedeep'
+import IPFSCoordAdapter from '../../../src/adapters/ipfs/ipfs-coord.js'
+// import IPFSMock from '../mocks/ipfs-mock.js'
+import create from '../mocks/ipfs-mock.js'
+import IPFSCoordMock from '../mocks/ipfs-coord-mock.js'
+import config from '../../../config/index.js'
+import mockDataLib from '../mocks/adapters/ipfs-coord-mocks.js'
 
 describe('#IPFS', () => {
   let uut
@@ -18,8 +18,8 @@ describe('#IPFS', () => {
   let mockData
 
   beforeEach(() => {
-    const ipfs = IPFSMock.create()
-    uut = new IPFSCoordAdapter({ ipfs, eventEmitter: new EventEmitter() })
+    const ipfs = create()
+    uut = new IPFSCoordAdapter({ ipfs })
 
     sandbox = sinon.createSandbox()
 
@@ -47,19 +47,19 @@ describe('#IPFS', () => {
       }
     })
 
-    it('should throw an error if EventEmitter instance is not included', () => {
-      try {
-        const ipfs = IPFSMock.create()
-        uut = new IPFSCoordAdapter({ ipfs })
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.include(
-          err.message,
-          'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
-        )
-      }
-    })
+    // it('should throw an error if EventEmitter instance is not included', () => {
+    //   try {
+    //     const ipfs = IPFSMock.create()
+    //     uut = new IPFSCoordAdapter({ ipfs })
+    //
+    //     assert.fail('Unexpected code path')
+    //   } catch (err) {
+    //     assert.include(
+    //       err.message,
+    //       'An instance of an EventEmitter must be passed when instantiating the ipfs-coord adapter.'
+    //     )
+    //   }
+    // })
   })
 
   describe('#start', () => {
@@ -76,7 +76,7 @@ describe('#IPFS', () => {
     it('should get the public IP address if this node is a Circuit Relay', async () => {
       // Mock dependencies.
       uut.IpfsCoord = IPFSCoordMock
-      sandbox.stub(uut.publicIp, 'v4').returns('123')
+      sandbox.stub(uut.publicIp, 'v4').resolves('123')
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true
@@ -86,6 +86,31 @@ describe('#IPFS', () => {
 
       assert.equal(result, true)
     })
+
+    it('should exit quietly if this node is a Circuit Relay and there is an issue getting the IP address', async () => {
+      // Mock dependencies.
+      uut.IpfsCoord = IPFSCoordMock
+      sandbox.stub(uut.publicIp, 'v4').rejects(new Error('test error'))
+
+      // Force Circuit Relay
+      uut.config.isCircuitRelay = true
+
+      const result = await uut.start()
+      // console.log('result: ', result)
+
+      assert.equal(result, true)
+    })
+
+    it('should return a promise that resolves into an instance of IPFS in production mode', async () => {
+      uut.config.isProduction = true
+      // Mock dependencies.
+      uut.IpfsCoord = IPFSCoordMock
+
+      const result = await uut.start()
+      // console.log('result: ', result)
+      assert.equal(result, true)
+      config.isProduction = false
+    })
   })
 
   describe('#attachRPCRouter', () => {
@@ -122,7 +147,7 @@ describe('#IPFS', () => {
 
         assert.fail('Unexpected code path')
       } catch (err) {
-        assert.include(err.message, 'Cannot read property')
+        assert.include(err.message, 'Cannot read')
       }
     })
   })
@@ -152,22 +177,38 @@ describe('#IPFS', () => {
     })
   })
 
-  describe('#peerInputHandler', () => {
-    it('should emit an event trigger', () => {
-      const data = 'some data'
+  // describe('#peerInputHandler', () => {
+  //   it('should emit an event trigger', () => {
+  //     const data = 'some data'
+  //
+  //     uut.peerInputHandler(data)
+  //
+  //     assert.isOk(true, 'Not throwing an error is a success')
+  //   })
+  //
+  //   it('should catch and report errors', () => {
+  //     // Force an error
+  //     sandbox.stub(uut.eventEmitter, 'emit').throws(new Error('test error'))
+  //
+  //     uut.peerInputHandler()
+  //
+  //     assert.isOk(true, 'Not throwing an error is a success.')
+  //   })
+  // })
 
-      uut.peerInputHandler(data)
+  describe('#subscribeToChat', () => {
+    it('should subscribe to the chat channel', async () => {
+      // Mock dependencies
+      uut.ipfsCoord = {
+        adapters: {
+          pubsub: {
+            subscribeToPubsubChannel: async () => {
+            }
+          }
+        }
+      }
 
-      assert.isOk(true, 'Not throwing an error is a success')
-    })
-
-    it('should catch and report errors', () => {
-      // Force an error
-      sandbox.stub(uut.eventEmitter, 'emit').throws(new Error('test error'))
-
-      uut.peerInputHandler()
-
-      assert.isOk(true, 'Not throwing an error is a success.')
+      await uut.subscribeToChat()
     })
   })
 })

test/unit/adapters/ipfs-index.adapter.unit.js

@@ -2,20 +2,22 @@
   Unit tests for the index.js file for the IPFS and ipfs-coord libraries.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const IPFSLib = require('../../../src/adapters/ipfs')
-const IPFSMock = require('../mocks/ipfs-mock')
-const IPFSCoordMock = require('../mocks/ipfs-coord-mock')
-const EventEmitter = require('events')
+import sinon from 'sinon'
+import IPFSLib from '../../../src/adapters/ipfs/index.js'
+// import IPFSMock from '../mocks/ipfs-mock.js'
+// import create from '../mocks/ipfs-mock.js'
+import IPFSCoordMock from '../mocks/ipfs-coord-mock.js'
+// import EventEmiter from 'events'
 
 describe('#IPFS-adapter-index', () => {
   let uut
   let sandbox
 
   beforeEach(() => {
-    uut = new IPFSLib({ eventEmitter: new EventEmitter() })
+    // uut = new IPFSLib({ eventEmitter: new EventEmitter() })
+    uut = new IPFSLib({ })
 
     sandbox = sinon.createSandbox()
   })
@@ -25,7 +27,9 @@ describe('#IPFS-adapter-index', () => {
   describe('#start', () => {
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
-      uut.ipfsAdapter = new IPFSMock()
+      uut.ipfsAdapter = {
+        start: async () => {}
+      }
       uut.IpfsCoordAdapter = IPFSCoordMock
 
       const result = await uut.start()

test/unit/adapters/ipfs.adapter.unit.js

@@ -2,12 +2,14 @@
   Unit tests for the IPFS Adapter.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const IPFSLib = require('../../../src/adapters/ipfs/ipfs')
-const IPFSMock = require('../mocks/ipfs-mock')
+import sinon from 'sinon'
+import IPFSLib from '../../../src/adapters/ipfs/ipfs.js'
+import create from '../mocks/ipfs-mock.js'
+import config from '../../../config/index.js'
 
+// config.isProduction =  true;
 describe('#IPFS-adapter', () => {
   let uut
   let sandbox
@@ -18,12 +20,32 @@ describe('#IPFS-adapter', () => {
     sandbox = sinon.createSandbox()
   })
 
-  afterEach(() => sandbox.restore())
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#constructor', () => {
+    it('should instantiate IPFS Lib in dev mode.', async () => {
+      const _uut = new IPFSLib()
+      assert.exists(_uut)
+      assert.isFunction(_uut.start)
+      assert.isFunction(_uut.stop)
+    })
+
+    it('should instantiate dev IPFS Lib in production mode.', async () => {
+      config.isProduction = true
+      const _uut = new IPFSLib()
+      assert.exists(_uut)
+      assert.isFunction(_uut.start)
+      assert.isFunction(_uut.stop)
+      config.isProduction = false
+    })
+  })
 
   describe('#start', () => {
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
-      uut.IPFS = IPFSMock
+      uut.create = create
 
       const result = await uut.start()
       // console.log('result: ', result)
@@ -33,10 +55,22 @@ describe('#IPFS-adapter', () => {
       assert.property(result, 'config')
     })
 
+    it('should return a promise that resolves into an instance of IPFS in production mode.', async () => {
+      // Mock dependencies.
+      uut.create = create
+      uut.config.isProduction = true
+      const result = await uut.start()
+      // console.log('result: ', result)
+
+      assert.equal(uut.isReady, true)
+
+      assert.property(result, 'config')
+    })
+
     it('should catch and throw an error', async () => {
       try {
         // Force an error
-        sandbox.stub(uut.IPFS, 'create').rejects(new Error('test error'))
+        sandbox.stub(uut, 'create').rejects(new Error('test error'))
 
         await uut.start()
 
@@ -52,7 +86,8 @@ describe('#IPFS-adapter', () => {
     it('should stop the IPFS node', async () => {
       // Mock dependencies
       uut.ipfs = {
-        stop: () => {}
+        stop: () => {
+        }
       }
 
       const result = await uut.stop()
@@ -61,24 +96,24 @@ describe('#IPFS-adapter', () => {
     })
   })
 
-  describe('#rmBlocksDir', () => {
-    it('should delete the /blocks directory', () => {
-      const result = uut.rmBlocksDir()
-
-      assert.equal(result, true)
-    })
-
-    it('should catch and throw an error', () => {
-      try {
-        // Force an error
-        sandbox.stub(uut.fs, 'rmdirSync').throws(new Error('test error'))
-
-        uut.rmBlocksDir()
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.equal(err.message, 'test error')
-      }
-    })
-  })
+// describe('#rmBlocksDir', () => {
+//   it('should delete the /blocks directory', () => {
+//     const result = uut.rmBlocksDir()
+//
+//     assert.equal(result, true)
+//   })
+//
+//   it('should catch and throw an error', () => {
+//     try {
+//       // Force an error
+//       sandbox.stub(uut.fs, 'rmdirSync').throws(new Error('test error'))
+//
+//       uut.rmBlocksDir()
+//
+//       assert.fail('Unexpected code path')
+//     } catch (err) {
+//       assert.equal(err.message, 'test error')
+//     }
+//   })
+// })
 })

test/unit/adapters/json-files.adapter.unit.js

@@ -1,11 +1,15 @@
-const assert = require('chai').assert
-const fs = require('fs')
-const sinon = require('sinon')
+import { assert } from 'chai'
+import fs from 'fs'
+import sinon from 'sinon'
+import util from 'util'
 
-const util = require('util')
+import JsonFiles from '../../../src/adapters/json-files.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
 util.inspect.defaultOptions = { depth: 1 }
-
-const JsonFiles = require('../../../src/adapters/json-files')
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 const JSON_FILE = 'test-json-file.json'
 const JSON_PATH = `${__dirname.toString()}/${JSON_FILE}`

test/unit/adapters/logapi.adapter.unit.js

@@ -1,12 +1,15 @@
-const assert = require('chai').assert
+import { assert } from 'chai'
+import sinon from 'sinon'
+import util from 'util'
 
-const sinon = require('sinon')
+import LogsApiLib from '../../../src/adapters/logapi.js'
+import mockData from '../mocks/log-api-mock.js'
 
-const util = require('util')
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
 util.inspect.defaultOptions = { depth: 1 }
-
-const LogsApiLib = require('../../../src/adapters/logapi')
-const mockData = require('../mocks/log-api-mock')
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 const context = {}
 let sandbox
@@ -32,19 +35,18 @@ describe('#LogsApiLib', () => {
     })
 
     it('should return log', async () => {
-      try {
-        const pass = 'test'
-        const result = await uut.getLogs(pass)
-        // console.log('result', result)
+      // Mock dependencies
+      sandbox.stub(uut, 'generateFileName').returns(`${__dirname.toString()}/../mocks/adapters/fake-log`)
 
-        assert.isTrue(result.success)
-        assert.isArray(result.data)
-        assert.property(result.data[0], 'message')
-        assert.property(result.data[0], 'level')
-        assert.property(result.data[0], 'timestamp')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
+      const pass = 'test'
+      const result = await uut.getLogs(pass)
+      // console.log('result', result)
+
+      assert.isTrue(result.success)
+      assert.isArray(result.data)
+      assert.property(result.data[0], 'message')
+      assert.property(result.data[0], 'level')
+      assert.property(result.data[0], 'timestamp')
     })
 
     it('should return false if files are not found!', async () => {
@@ -201,31 +203,25 @@ describe('#LogsApiLib', () => {
     })
 
     it('should ignore fileReader callback errors', async () => {
-      try {
-        // https://sinonjs.org/releases/latest/stubs/
-        // About yields
-        sandbox.stub(uut.lineReader, 'eachLine').yieldsRight({}, true)
+      // https://sinonjs.org/releases/latest/stubs/
+      // About yields
+      sandbox.stub(uut.lineReader, 'eachLine').yieldsRight({}, true)
 
-        const fileName = context.fileName
-        const result = await uut.readLines(fileName)
-        assert.isArray(result)
-      } catch (err) {
-        assert.fail('Unexpected result')
-      }
+      const fileName = `${__dirname.toString()}/../mocks/adapters/fake-log`
+
+      const result = await uut.readLines(fileName)
+      assert.isArray(result)
     })
 
     it('should return data', async () => {
-      try {
-        const fileName = context.fileName
-        const result = await uut.readLines(fileName)
+      const fileName = `${__dirname.toString()}/../mocks/adapters/fake-log`
 
-        assert.isArray(result)
-        assert.property(result[1], 'message')
-        assert.property(result[1], 'level')
-        assert.property(result[1], 'timestamp')
-      } catch (err) {
-        assert.fail('Unexpected result')
-      }
+      const result = await uut.readLines(fileName)
+
+      assert.isArray(result)
+      assert.property(result[1], 'message')
+      assert.property(result[1], 'level')
+      assert.property(result[1], 'timestamp')
     })
   })
 })

test/unit/adapters/nodemailer.adapter.unit.js

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const NodeMailer = require('../../../src/adapters/nodemailer')
+import sinon from 'sinon'
+import NodeMailer from '../../../src/adapters/nodemailer.js'
 
 let sandbox
 let uut

test/unit/adapters/passport.adapter.unit.js

@@ -1,7 +1,6 @@
-const assert = require('chai').assert
-const PassportLib = require('../../../src/adapters/passport')
-
-const sinon = require('sinon')
+import { assert } from 'chai'
+import PassportLib from '../../../src/adapters/passport.js'
+import sinon from 'sinon'
 
 let uut
 let sandbox

test/unit/adapters/users.adapter.unit.js

@@ -2,16 +2,17 @@
   Unit tests for the users Mongoose model.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-const mongoose = require('mongoose')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
+import mongoose from 'mongoose'
+
+import User from '../../../src/adapters/localdb/models/users.js'
+import config from '../../../config/index.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-const User = require('../../../src/adapters/localdb/models/users')
-const config = require('../../../config')
-
 describe('#User-Adapter', () => {
   // let uut
   let sandbox

test/unit/adapters/wlogger.adapter.unit.js

@@ -1,7 +1,6 @@
-const assert = require('chai').assert
-const { Wlogger } = require('../../../src/adapters/wlogger')
-
-const sinon = require('sinon')
+import { assert } from 'chai'
+import { Wlogger } from '../../../src/adapters/wlogger.js'
+import sinon from 'sinon'
 
 let uut
 let sandbox

test/unit/controllers/controllers.unit.js

@@ -4,9 +4,9 @@
 
 // Public npm libraries
 // const assert = require('chai').assert
-const sinon = require('sinon')
+import sinon from 'sinon'
 
-const Controllers = require('../../../src/controllers')
+import Controllers from '../../../src/controllers/index.js'
 
 describe('#Controllers', () => {
   let uut
@@ -28,6 +28,9 @@ describe('#Controllers', () => {
         attachRPCRouter: () => {}
       }
 
+      // Mock the timer controllers
+      sandbox.stub(uut.timerControllers, 'startTimers').returns()
+
       const app = {
         use: () => {}
       }

test/unit/controllers/json-rpc/a10-rpc.unit.js

@@ -3,19 +3,21 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const jsonrpc = require('jsonrpc-lite')
-const sinon = require('sinon')
-const { v4: uid } = require('uuid')
+import { assert } from 'chai'
+
+import jsonrpc from 'jsonrpc-lite'
+import sinon from 'sinon'
+import { v4 as uid } from 'uuid'
+
+// Local libraries.
+import JSONRPC from '../../../../src/controllers/json-rpc/index.js'
+
+import adapters from '../../mocks/adapters/index.js'
+import UseCasesMock from '../../mocks/use-cases/index.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-// Local libraries.
-const JSONRPC = require('../../../../src/controllers/json-rpc')
-const adapters = require('../../mocks/adapters')
-const UseCasesMock = require('../../mocks/use-cases')
-
 describe('#JSON RPC', () => {
   let uut
   let sandbox

test/unit/controllers/json-rpc/a12-validators.unit.js

@@ -5,18 +5,20 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
-const sinon = require('sinon')
-const assert = require('chai').assert
-const { v4: uid } = require('uuid')
+import jsonrpc from 'jsonrpc-lite'
+
+import sinon from 'sinon'
+import { assert } from 'chai'
+import { v4 as uid } from 'uuid'
+
+// Local libraries
+import Validators from '../../../../src/controllers/json-rpc/validators.js'
+
+import adapters from '../../mocks/adapters/index.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-// Local libraries
-const Validators = require('../../../../src/controllers/json-rpc/validators')
-const adapters = require('../../mocks/adapters')
-
 describe('#validators', () => {
   let uut
   let sandbox

test/unit/controllers/json-rpc/a14-rate-limits.js

@@ -5,15 +5,16 @@
 */
 
 // Public npm libraries
-const sinon = require('sinon')
-const assert = require('chai').assert
+import sinon from 'sinon'
+
+import { assert } from 'chai'
+
+// Local libraries
+import RateLimit from '../../../../src/controllers/json-rpc/rate-limit.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-// Local libraries
-const RateLimit = require('../../../../src/controllers/json-rpc/rate-limit')
-
 describe('#rate-limit', () => {
   let uut
   let sandbox

test/unit/controllers/json-rpc/about.json-rpc.controller.unit.js

@@ -3,11 +3,12 @@
 */
 
 // Public npm libraries
-const sinon = require('sinon')
-const assert = require('chai').assert
+import sinon from 'sinon'
+
+import { assert } from 'chai'
 
 // Local libraries
-const AboutRPC = require('../../../../src/controllers/json-rpc/about')
+import AboutRPC from '../../../../src/controllers/json-rpc/about/index.js'
 
 describe('#AboutRPC', () => {
   let uut

test/unit/controllers/json-rpc/auth.json-rpc.controller.unit.js

@@ -3,20 +3,22 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
-const sinon = require('sinon')
-const assert = require('chai').assert
-const { v4: uid } = require('uuid')
+import jsonrpc from 'jsonrpc-lite'
+
+import sinon from 'sinon'
+import { assert } from 'chai'
+import { v4 as uid } from 'uuid'
+
+// Local libraries
+import AuthRPC from '../../../../src/controllers/json-rpc/auth/index.js'
+
+import RateLimit from '../../../../src/controllers/json-rpc/rate-limit.js'
+import adapters from '../../mocks/adapters/index.js'
+import UseCasesMock from '../../mocks/use-cases/index.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-// Local libraries
-const AuthRPC = require('../../../../src/controllers/json-rpc/auth')
-const RateLimit = require('../../../../src/controllers/json-rpc/rate-limit')
-const adapters = require('../../mocks/adapters')
-const UseCasesMock = require('../../mocks/use-cases')
-
 describe('#AuthRPC', () => {
   let uut
   let sandbox

test/unit/controllers/json-rpc/users.json-rpc-controller.unit.js

@@ -3,19 +3,21 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
-const sinon = require('sinon')
-const assert = require('chai').assert
-const { v4: uid } = require('uuid')
+import jsonrpc from 'jsonrpc-lite'
+
+import sinon from 'sinon'
+import { assert } from 'chai'
+import { v4 as uid } from 'uuid'
+
+// Local libraries
+import UserRPC from '../../../../src/controllers/json-rpc/users/index.js'
+
+import adapters from '../../mocks/adapters/index.js'
+import UseCasesMock from '../../mocks/use-cases/index.js'
 
 // Set the environment variable to signal this is a test.
 process.env.SVC_ENV = 'test'
 
-// Local libraries
-const UserRPC = require('../../../../src/controllers/json-rpc/users')
-const adapters = require('../../mocks/adapters')
-const UseCasesMock = require('../../mocks/use-cases')
-
 describe('#UserRPC', () => {
   let uut
   let sandbox
@@ -333,7 +335,7 @@ describe('#UserRPC', () => {
       assert.equal(result.endpoint, 'updateUser')
       assert.equal(result.success, false)
       assert.equal(result.status, 422)
-      assert.include(result.message, 'Cannot read property')
+      assert.include(result.message, 'Cannot read')
     })
   })
 
@@ -375,7 +377,7 @@ describe('#UserRPC', () => {
       assert.equal(result.endpoint, 'getUser')
       assert.equal(result.success, false)
       assert.equal(result.status, 422)
-      assert.include(result.message, 'Cannot read property')
+      assert.include(result.message, 'Cannot read')
     })
   })
 

test/unit/controllers/rest-api/auth/auth.rest.controller.unit.js

@@ -3,21 +3,25 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
 // const app = require('../../../mocks/app-mock')
 
-const AuthRESTController = require('../../../../../src/controllers/rest-api/auth/controller')
+import AuthRESTController from '../../../../../src/controllers/rest-api/auth/controller.js'
+
+import { context as mockContext } from '../../../../unit/mocks/ctx-mock.js'
+
 let uut
 let sandbox
 let ctx
 
-const mockContext = require('../../../../unit/mocks/ctx-mock').context
-
 describe('#Auth-REST-Router', () => {
   // const testUser = {}
 

test/unit/controllers/rest-api/auth/auth.rest.router.unit.js

@@ -3,15 +3,19 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
 // const app = require('../../../mocks/app-mock')
 
-const AuthRouter = require('../../../../../src/controllers/rest-api/auth')
+import AuthRouter from '../../../../../src/controllers/rest-api/auth/index.js'
+
 let uut
 let sandbox
 // let ctx

test/unit/controllers/rest-api/bch/bch.rest.controller.unit.js

@@ -3,20 +3,21 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
 
-const BchController = require('../../../../../src/controllers/rest-api/bch/controller')
+import BchController from '../../../../../src/controllers/rest-api/bch/controller.js'
+import { context } from '../../../../unit/mocks/ctx-mock.js'
+// import blah '../../../../unit/mocks/ctx-mock.js'
+// console.log('blah: ', blah)
 let uut
 let sandbox
 let ctx
 
-const mockContext = require('../../../../unit/mocks/ctx-mock').context
-
 describe('#BCH-REST-Controller', () => {
   // const testUser = {}
 
@@ -27,7 +28,7 @@ describe('#BCH-REST-Controller', () => {
     sandbox = sinon.createSandbox()
 
     // Mock the context object.
-    ctx = mockContext()
+    ctx = context()
   })
 
   afterEach(() => sandbox.restore())
@@ -177,6 +178,42 @@ describe('#BCH-REST-Controller', () => {
     })
   })
 
+  describe('#utxosBulk', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'getUtxosBulk')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          address: 'blah'
+        }
+
+        await uut.utxosBulk(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'getUtxosBulk').resolves({ status: 200 })
+
+      ctx.request.body = {
+        address: 'blah'
+      }
+
+      await uut.utxosBulk(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
+
   describe('#broadcast', () => {
     it('should return 422 status on arbitrary error', async () => {
       try {
@@ -322,4 +359,112 @@ describe('#BCH-REST-Controller', () => {
       assert.equal(ctx.status, 200)
     })
   })
+
+  describe('#utxoIsValid', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'utxoIsValid')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          utxo: 'blah'
+        }
+
+        await uut.utxoIsValid(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'utxoIsValid').resolves({ status: 200 })
+
+      ctx.request.body = {
+        utxo: 'blah'
+      }
+
+      await uut.utxoIsValid(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
+
+  describe('#getTokenData', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'getTokenData')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          tokenId: 'blah'
+        }
+
+        await uut.getTokenData(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'getTokenData').resolves({ status: 200 })
+
+      ctx.request.body = {
+        tokenId: 'blah'
+      }
+
+      await uut.getTokenData(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
+
+  describe('#getTokenData2', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'getTokenData2')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          tokenId: 'blah'
+        }
+
+        await uut.getTokenData2(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'getTokenData2').resolves({ status: 200 })
+
+      ctx.request.body = {
+        tokenId: 'blah'
+      }
+
+      await uut.getTokenData2(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
 })

test/unit/controllers/rest-api/bch/bch.rest.router.unit.js

@@ -3,15 +3,15 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
 // const app = require('../../../mocks/app-mock')
 
-const BchRouter = require('../../../../../src/controllers/rest-api/bch')
+import BchRouter from '../../../../../src/controllers/rest-api/bch/index.js'
 let uut
 let sandbox
 // let ctx

test/unit/controllers/rest-api/contact/contact.rest.controller.unit.js

@@ -3,18 +3,19 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const ContactController = require('../../../../../src/controllers/rest-api/contact/controller')
+import sinon from 'sinon'
+import ContactController from '../../../../../src/controllers/rest-api/contact/controller.js'
+
+import { context as mockContext } from '../../../../unit/mocks/ctx-mock.js'
 let uut
 let sandbox
 let ctx
 
-const mockContext = require('../../../../unit/mocks/ctx-mock').context
-
 describe('Contact', () => {
-  before(async () => {})
+  before(async () => {
+  })
 
   beforeEach(() => {
     uut = new ContactController()
@@ -36,7 +37,7 @@ describe('Contact', () => {
       } catch (err) {
         // console.log(err)
         assert.equal(err.status, 422)
-        assert.include(err.message, 'Cannot read property')
+        assert.include(err.message, 'Cannot read')
       }
     })
 

test/unit/controllers/rest-api/contact/contact.rest.router.unit.js

@@ -3,15 +3,19 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
 // const app = require('../../../mocks/app-mock')
 
-const ContactRouter = require('../../../../../src/controllers/rest-api/contact')
+import ContactRouter from '../../../../../src/controllers/rest-api/contact/index.js'
+
 let uut
 let sandbox
 // let ctx

test/unit/controllers/rest-api/logs/logs.rest.controller.unit.js

@@ -3,18 +3,19 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const LogsApiController = require('../../../../../src/controllers/rest-api/logs/controller')
+import sinon from 'sinon'
+import LogsApiController from '../../../../../src/controllers/rest-api/logs/controller.js'
+
+import { context as mockContext } from '../../../../unit/mocks/ctx-mock.js'
 let uut
 let sandbox
 let ctx
 
-const mockContext = require('../../../../unit/mocks/ctx-mock').context
-
 describe('Logapi', () => {
-  before(async () => {})
+  before(async () => {
+  })
 
   beforeEach(() => {
     uut = new LogsApiController()
@@ -35,7 +36,7 @@ describe('Logapi', () => {
         assert.fail('Unexpected result')
       } catch (err) {
         assert.equal(err.status, 422)
-        assert.include(err.message, 'Cannot read property')
+        assert.include(err.message, 'Cannot read')
       }
     })
 

test/unit/controllers/rest-api/logs/logs.rest.router.unit.js

@@ -3,15 +3,19 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
 
 // Local support libraries
-const adapters = require('../../../mocks/adapters')
-const UseCasesMock = require('../../../mocks/use-cases')
+import adapters from '../../../mocks/adapters/index.js'
+
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
 // const app = require('../../../mocks/app-mock')
 
-const LogsRouter = require('../../../../../src/controllers/rest-api/logs')
+import LogsRouter from '../../../../../src/controllers/rest-api/logs/index.js'
+
 let uut
 let sandbox
 // let ctx

test/unit/controllers/rest-api/middleware/validators-unit.js

@@ -0,0 +1,306 @@
+/*
+  Unit tests for the REST API middleware that validates users.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local libraries
+import Validators from '../../../../../src/controllers/rest-api/middleware/validators.js'
+import { context as mockContext } from '../../../../unit/mocks/ctx-mock.js'
+
+describe('#Validators', () => {
+  let uut
+  let ctx
+  let sandbox
+
+  beforeEach(() => {
+    uut = new Validators()
+
+    // Mock the context object.
+    ctx = mockContext()
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#getToken', () => {
+    it('should return null if no header is provided', () => {
+      const result = uut.getToken(ctx)
+
+      assert.equal(result, null)
+    })
+
+    it('should return null if header is not in two parts', () => {
+      ctx.request.header.authorization = 'Bearer'
+
+      const result = uut.getToken(ctx)
+
+      assert.equal(result, null)
+    })
+
+    it('should return null if first part of header does not container the word bearer', () => {
+      ctx.request.header.authorization = 'some thing'
+
+      const result = uut.getToken(ctx)
+
+      assert.equal(result, null)
+    })
+
+    it('should return the JWT token from the header', () => {
+      const jwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYzMjNiNTUwNzgxYWYzNTc4YzI0ZmU5YiIsImlhdCI6MTY2MzQ0NDczNCwiZXhwIjoxNjYzNTMxMTM0fQ.BY5sOfXc4z5axS98CdTfyqnO9y2wijOlwnv52rcvxHA'
+      ctx.request.header.authorization = `Bearer ${jwt}`
+
+      const result = uut.getToken(ctx)
+
+      assert.equal(result, jwt)
+    })
+  })
+
+  describe('#ensureUser', () => {
+    it('should throw error if token is not provided', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns()
+
+        await uut.ensureUser(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if token can not be verified', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').throws(new Error('test error'))
+
+        await uut.ensureUser(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if user can not be found in database', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves(false)
+
+        await uut.ensureUser(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should return true if the user is verified', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut, 'getToken').returns('fake-jwt')
+      sandbox.stub(uut.jwt, 'verify').returns({})
+      sandbox.stub(uut.User, 'findById').resolves({ user: 'alice' })
+
+      const result = await uut.ensureUser(ctx)
+
+      assert.equal(result, true)
+    })
+  })
+
+  describe('#ensureUser', () => {
+    it('should throw error if token is not provided', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns()
+
+        await uut.ensureAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if token can not be verified', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').throws(new Error('test error'))
+
+        await uut.ensureAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if user can not be found in database', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves(false)
+
+        await uut.ensureAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if user is not an admin', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves({ type: 'user' })
+
+        await uut.ensureAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should return true if the user is an admin', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut, 'getToken').returns('fake-jwt')
+      sandbox.stub(uut.jwt, 'verify').returns({})
+      sandbox.stub(uut.User, 'findById').resolves({ type: 'admin' })
+
+      const result = await uut.ensureAdmin(ctx)
+
+      assert.equal(result, true)
+    })
+  })
+
+  describe('#ensureTargetUserOrAdmin', () => {
+    it('should throw error if token is not provided', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns()
+
+        await uut.ensureTargetUserOrAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if token can not be verified', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').throws(new Error('test error'))
+
+        ctx.params = {
+          id: '456'
+        }
+
+        await uut.ensureTargetUserOrAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if user can not be found in database', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves(false)
+
+        ctx.params = {
+          id: '456'
+        }
+
+        await uut.ensureTargetUserOrAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error if user is not an admin', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves({ type: 'user' })
+
+        ctx.params = {
+          id: '456'
+        }
+
+        await uut.ensureTargetUserOrAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should throw error is user is not admin or target user', async () => {
+      try {
+        // Mock dependencies and force desired code path
+        sandbox.stub(uut, 'getToken').returns('fake-jwt')
+        sandbox.stub(uut.jwt, 'verify').returns({})
+        sandbox.stub(uut.User, 'findById').resolves({ type: 'user', _id: '123' })
+
+        ctx.params = {
+          id: '456'
+        }
+
+        await uut.ensureTargetUserOrAdmin(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(ctx.status, 401)
+      }
+    })
+
+    it('should return true if the user is an admin', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut, 'getToken').returns('fake-jwt')
+      sandbox.stub(uut.jwt, 'verify').returns({})
+      sandbox.stub(uut.User, 'findById').resolves({ type: 'admin', _id: '123' })
+
+      ctx.params = {
+        id: '456'
+      }
+
+      const result = await uut.ensureTargetUserOrAdmin(ctx)
+
+      assert.equal(result, true)
+    })
+
+    it('should return true if the user is the target user', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut, 'getToken').returns('fake-jwt')
+      sandbox.stub(uut.jwt, 'verify').returns({})
+      sandbox.stub(uut.User, 'findById').resolves({ type: 'user', _id: '123' })
+
+      ctx.params = {
+        id: '123'
+      }
+
+      const result = await uut.ensureTargetUserOrAdmin(ctx)
+
+      assert.equal(result, true)
+    })
+  })
+})