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

Upgrading helia to v4.2.5

.gitignore

@@ -72,3 +72,5 @@ data/
 run-dev.sh
 
 !README.md
+
+wallet.json

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Permissionless Software Foundation Community Contributing Guide 1.0
+
+This document describes a very simple process suitable for most projects under
+the PSF umbrella. It is based on [this Medium article](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951) and the [Node.js Community Contribution Guide](https://github.com/nodejs/TSC/blob/master/BasePolicies/CONTRIBUTING.md).
+Projects are encouraged to adopt this whether they
+are hosted under the PSF or not.
+
+The goal of this document is to create a contribution process that:
+
+* Encourages new contributions.
+* Encourages contributors to remain involved.
+* Avoids unnecessary processes and bureaucracy whenever possible.
+* Creates a transparent decision making process which makes it clear how
+contributors can be involved in decision making.
+
+This document is based on much prior art in the Node.js community, io.js,
+and the Node.js project.
+
+Additional guidance can be found at the [Permissionless Software Foundation Telegram Channel](https://t.me/permissionless_software).
+
+## Vocabulary
+
+* A **Contributor** is any individual creating or commenting on an issue or pull request.
+* A **Committer** is a subset of contributors who have been given write access to the repository.
+* A **TC (Technical Committee)** is a group of committers representing the required technical
+expertise to resolve rare disputes.
+
+# Logging Issues
+
+Log an issue for any question or problem you might have. When in doubt, log an issue,
+any additional policies about what to include will be provided in the responses. The only
+exception is security disclosures which should be sent privately.
+
+Committers may direct you to another repository, ask for additional clarifications, and
+add appropriate metadata before the issue is addressed.
+
+Please be courteous, respectful, and every participant is expected to follow the
+project's Code of Conduct.
+
+# Contributions
+
+Any change to resources in this repository must be through pull requests. This applies to all changes
+to documentation, code, binary files, etc. Even long term committers and TC members must use
+pull requests.
+
+No pull request can be merged without being reviewed.
+
+For non-trivial contributions, pull requests should sit for at least 36 hours to ensure that
+contributors in other timezones have time to review. Consideration should also be given to
+weekends and other holiday periods to ensure active committers all have reasonable time to
+become involved in the discussion and review process if they wish.
+
+The default for each contribution is that it is accepted once no committer has an objection.
+During review committers may also request that a specific contributor who is most versed in a
+particular area gives a "LGTM" before the PR can be merged. There is no additional "sign off"
+process for contributions to land. Once all issues brought by committers are addressed it can
+be landed by any committer.
+
+In the case of an objection being raised in a pull request by another committer, all involved
+committers should seek to arrive at a consensus by way of addressing concerns being expressed
+by discussion, compromise on the proposed change, or withdrawal of the proposed change.
+
+If a contribution is controversial and committers cannot agree about how to get it to land
+or if it should land then it should be escalated to the TC. TC members should regularly
+discuss pending contributions in order to find a resolution. It is expected that only a
+small minority of issues be brought to the TC for resolution and that discussion and
+compromise among committers be the default resolution mechanism.
+
+# Becoming a Committer
+
+All contributors who land a non-trivial contribution should be on-boarded in a timely manner,
+and added as a committer, and be given write access to the repository.
+
+Committers are expected to follow this policy and continue to send pull requests, go through
+proper review, and have other committers merge their pull requests.
+
+# TC Process
+
+The TC uses a "consensus seeking" process for issues that are escalated to the TC.
+The group tries to find a resolution that has no open objections among TC members.
+If a consensus cannot be reached that has no objections then a majority wins vote
+is called. It is also expected that the majority of decisions made by the TC are via
+a consensus seeking process and that voting is only used as a last-resort.
+
+Resolution may involve returning the issue to committers with suggestions on how to
+move forward towards a consensus. It is not expected that a meeting of the TC
+will resolve all issues on its agenda during that meeting and may prefer to continue
+the discussion happening among the committers.
+
+Members can be added to the TC at any time. Any committer can nominate another committer
+to the TC and the TC uses its standard consensus seeking process to evaluate whether or
+not to add this new member. Members who do not participate consistently at the level of
+a majority of the other members are expected to resign.

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2021 Permissionless Software Foundation
+Copyright (c) 2021-2024 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:
 

PEDIGREE.md

@@ -0,0 +1,3 @@
+# Pedigree
+
+This repository was forked from [koa-api-boilerplate](https://github.com/christroutner/koa-api-boilerplate). Code changes from that upstream repository is frequently pulled in and merged to this repository.

README.md

@@ -24,8 +24,8 @@ This repository is one step in a longer path. Here are the major milestones of t
 
 ## Requirements
 
-- node **^14.18.2**
-- npm **^8.3.0**
+- node **^16.20.2**
+- npm **^8.19.4**
 - Docker **^20.10.8**
 - Docker Compose **^1.27.4**
 
@@ -58,35 +58,38 @@ docker-compose pull
 docker-compose up -d
 ```
 
-You can bring the containers back up with `docker-compose up -d`.
+- You can bring the containers down with `docker-compose down`
+- You can bring the containers back up with `docker-compose up -d`.
 
-### Operation Notes
+### Configuration
 
-- 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.
+This program is intended to started with a Bash shell script. In that script, you can set the following environment variables:
 
-- 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.
+```bash
+# The instance of bch-api to connect to.
+export APISERVER=http://172.17.0.1:3000/v5/
+```
 
-- [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`
+### Configuration
 
-## Structure
+This app is intended to be started via a bash shell script. See the environment variables used to configure this app in the [config/env/common.js file](./config/env/common.js).
 
-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).
+## File Structure
+
+The file layout of this repository follows the file layout of [Clean Architecture](https://christroutner.github.io/trouts-blog/blog/clean-architecture). Understaning the principles laid out this article will help developers navigate the code base.
 
 ## Usage
 
 - `npm start` Start server on live mode
 - `npm run docs` Generate API documentation
 - `npm test` Run mocha tests
-- `docker-compose build` Build a 'production' Docker container
-- `docker-compose up` Run the docker container
 
 ## Documentation
 
-API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
+API documentation is written inline and generated by [apidoc](http://apidocjs.com/). Docs can be generated with this command:
+- `npm run docs`
 
-Visit `http://localhost:5000/docs/` to view docs
+Visit `http://localhost:5020/` to view docs
 
 There is additional developer documentation in the [dev-docs directory](./dev-docs).
 

bin/server.js

@@ -8,23 +8,26 @@
 */
 
 // 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')
-const Controllers = require('../src/controllers')
+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 () {
@@ -42,16 +45,18 @@ class Server {
       const app = new Koa()
       app.keys = [this.config.session]
 
-      // Connect to the Mongo Database.
-      this.mongoose.Promise = global.Promise
-      this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
-      console.log(
-        `Connecting to MongoDB with this connection string: ${this.config.database}`
-      )
-      await this.mongoose.connect(this.config.database, {
-        useUnifiedTopology: true,
-        useNewUrlParser: true
-      })
+      if (!this.config.noMongo) {
+        // Connect to the Mongo Database.
+        this.mongoose.Promise = global.Promise
+        this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+        console.log(
+          `Connecting to MongoDB with this connection string: ${this.config.database}`
+        )
+        await this.mongoose.connect(this.config.database, {
+          useUnifiedTopology: true,
+          useNewUrlParser: true
+        })
+      }
 
       console.log(`Starting environment: ${this.config.env}`)
       console.log(`Debug level: ${this.config.debugLevel}`)
@@ -70,7 +75,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())
 
@@ -98,14 +104,14 @@ class Server {
       this.server = await app.listen(this.config.port)
       console.log(`Server started on ${this.config.port}`)
 
-      // Create the system admin user.
-      try {
-        const success = await this.adminLib.createSystemUser()
-        if (success) console.log('System admin user created.')
-      } catch (err) {
-        console.warn(
-          'Error trying to create system admin. Perhaps one already exists?'
-        )
+      if (!this.config.noMongo) {
+        try {
+          // Create the system admin user.
+          const success = await this.adminLib.createSystemUser()
+          if (success) console.log('System admin user created.')
+        } catch (err) {
+          console.log('Could not create system admin user.')
+        }
       }
 
       // Attach the other IPFS controllers.
@@ -137,4 +143,4 @@ class Server {
   }
 }
 
-module.exports = Server
+export default Server

config/env/common.js

@@ -1,12 +1,23 @@
 /*
   This file is used to store unsecure, application-specific data common to all
   environments.
+
+  Additional Environent Variables:
+  - CONNECT_PREF: should have a value of 'cr' (default), or 'direct'. This is
+    used by helia-coord to select a connection preference between peers. Servers
+    with an ip4 or ip6 address should use 'direct'.
 */
 
 /* 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
@@ -15,9 +26,9 @@ const ipfsCoordName = process.env.COORD_NAME
 
 console.log('GET_JWT_AT_STARTUP: ', process.env.GET_JWT_AT_STARTUP)
 
-module.exports = {
+export default {
   // Configure TCP port.
-  port: process.env.PORT || 5001,
+  port: process.env.PORT || 5032,
 
   // Password for HTML UI that displays logs.
   logPass: 'test',
@@ -33,14 +44,46 @@ module.exports = {
     ? process.env.EMAILPASS
     : 'emailpassword',
 
+  // Enable or Disable the usage of Mongo DB.
+  noMongo: process.env.NO_MONGO ? true : false,
+
+  // BEGIN WALLET CONFIGURATION
+
+  // BCH Mnemonic for generating encryption keys and payment address
+  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
+
+  // (Optional) use a wallet file generated by psf-bch-wallet.
+  walletFile: process.env.WALLET_FILE
+    ? process.env.WALLET_FILE
+    : `${__dirname.toString()}/../../wallet.json`,
+
+  // Wallet Configuration
+  // Default value: web3 - connect to bch-api through web 3 JSON RPC over IPFS.
+  // Alternate value: web2 - connect to bch-api through a web 2 REST API over HTTP.
+  walletInterface: process.env.WALLET_INTERFACE ? process.env.WALLET_INTERFACE : 'web3',
+
+  // Wallet API Server
+  // Default web2 server: https://api.fullstack.cash/v5/
+  // Default web3 server: https://free-bch.fullstack.cash/
+  apiServer: process.env.WALLET_INTERFACE === 'web2'
+    ? (
+        process.env.APISERVER
+          ? process.env.APISERVER
+          : 'https://api.fullstack.cash/v5/'
+      )
+    : 'https://free-bch.fullstack.cash/',
+
+  // Basic Authentication Password for connecting to bch-api through a web 2
+  // REST API over HTTP.
+  authPass: process.env.WALLET_AUTH_PASS
+    ? process.env.WALLET_AUTH_PASS
+    : '',
+
   // FullStack.cash account information, used for automatic JWT handling.
   getJwtAtStartup: process.env.GET_JWT_AT_STARTUP ? true : false,
   authServer: process.env.AUTHSERVER
     ? process.env.AUTHSERVER
     : 'https://auth.fullstack.cash',
-  apiServer: process.env.APISERVER
-    ? process.env.APISERVER
-    : 'https://api.fullstack.cash/v5/',
   fullstackLogin: process.env.FULLSTACKLOGIN
     ? process.env.FULLSTACKLOGIN
     : 'demo@demo.com',
@@ -48,7 +91,17 @@ module.exports = {
     ? process.env.FULLSTACKPASS
     : 'demo',
 
-  // IPFS settings.
+  // END WALLET CONFIGURATION
+
+  // BEGIN IPFS CONFIGURATION
+
+  // Debug verbosity level of helia-coord.
+  // 0 = no debug logs. 3 = maximum logs.
+  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2,
+
+  // Enable/Disable the IPFS node at startup. Enabled by default.
+  useIpfs: process.env.DISABLE_IPFS ? false : true,
+
   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 : '',
@@ -56,7 +109,7 @@ module.exports = {
   // Information passed to other IPFS peers about this node.
   apiInfo: 'https://ipfs-bch-wallet-service.fullstack.cash/',
 
-  ipfsCoordName: ipfsCoordName,
+  ipfsCoordName,
 
   // JSON-LD and Schema.org schema with info about this app.
   announceJsonLd: {
@@ -64,7 +117,7 @@ module.exports = {
     '@type': 'WebAPI',
     name: ipfsCoordName,
     version,
-    protocol: 'bch-wallet',
+    protocol: 'ipfs-bch-wallet-service',
     description:
       'IPFS service providing BCH blockchain access needed by a wallet.',
     documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',
@@ -72,24 +125,33 @@ module.exports = {
       '@type': 'Organization',
       name: 'Permissionless Software Foundation',
       url: 'https://PSFoundation.cash'
-    }
+    },
+
+    // If this node has an IP4 address or domain name used to provide a REST API.
+    web2Api: process.env.WEB2_API ? process.env.WEB2_API : null
   },
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 5668,
   ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669,
 
-  // BCH Mnemonic for generating encryption keys and payment address
-  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
-
-  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2,
-
   // Settings for production, using external go-ipfs node.
-  isProduction: process.env.SVC_ENV === 'production' ? true : false,
+  isProduction: process.env.SVC_ENV === 'prod' ? 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,
 
-  chatPubSubChan: 'psf-ipfs-chat-001'
+  chatPubSubChan: 'psf-ipfs-chat-001',
+
+  // This can add specific Circuit Relay v2 servers to connect to.
+  bootstrapRelays: [
+    // v2 Circuit Relay (Token Tiger)
+    // '/ip4/137.184.93.145/tcp/8001/p2p/12D3KooWGMEKkdJfyZbwdH9EafZbRTtMn7FnhWPrE4MhRty2763g',
+
+    // v2 Circuit Relay server (FullStack.cash)
+    // '/ip4/78.46.129.7/tcp/4001/p2p/12D3KooWFQ11GQ5NubsJGhYZ4X3wrAGimLevxfm6HPExCrMYhpSL'
+  ]
+
+  // END IPFS CONFIGURATION
 }

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/bch-service-dev',

config/env/production.js

@@ -7,11 +7,11 @@
   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: process.env.DBURL
     ? process.env.DBURL
-    : 'mongodb://172.17.0.1:5555/bch-service-prod',
+    : 'mongodb://172.17.0.1:5557/bch-service-prod',
   env: '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/bch-service-test',

config/index.js

@@ -1,6 +1,17 @@
-const common = require('./env/common')
+import common from './env/common.js'
+
+import development from './env/development.js'
+import production from './env/production.js'
+import test from './env/test.js'
 
 const env = process.env.SVC_ENV || 'development'
-const config = require(`./env/${env}`)
+console.log(`Loading config for this environment: ${env}`)
 
-module.exports = Object.assign({}, common, config)
+let config = development
+if (env === 'test') {
+  config = test
+} else if (env === 'prod') {
+  config = production
+}
+
+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,32 @@ async function passportCallback (email, password, done) {
   }
 }
 
-// For testing
-module.exports = { passport, passportCallback }
+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
+}
+
+export { applyPassportMods, passportCallback }

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

@@ -1,20 +1,21 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "start": "node index.js",
     "test": "npm run test:all",
-    "test:all": "export SVC_ENV=test && nyc --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
+    "test:all": "export SVC_ENV=test && c8 --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
     "test:unit": "export SVC_ENV=test && mocha --exit --timeout 15000 --recursive test/unit/",
     "test:e2e:auto": "export SVC_ENV=test && mocha --exit --timeout 30000 test/e2e/automated/",
     "test:integration": "export SVC_ENV=test && mocha --timeout 30000 --recursive test/integration/",
     "test:temp": "export SVC_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 SVC_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 SVC_ENV=test && c8 --reporter=html mocha --exit --timeout 15000 --recursive test/unit/ test/e2e/automated/"
   },
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "license": "MIT",
@@ -24,13 +25,28 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "6.5.3",
+    "@chainsafe/libp2p-gossipsub": "13.1.1",
+    "@chainsafe/libp2p-noise": "15.1.1",
+    "@chainsafe/libp2p-yamux": "6.0.2",
+    "@helia/unixfs": "3.0.7",
+    "@libp2p/bootstrap": "10.1.5",
+    "@libp2p/circuit-relay-v2": "1.1.5",
+    "@libp2p/identify": "2.1.5",
+    "@libp2p/keychain": "4.1.5",
+    "@libp2p/logger": "4.0.20",
+    "@libp2p/mplex": "10.0.16",
+    "@libp2p/tcp": "9.1.5",
+    "@libp2p/webrtc": "4.0.34",
+    "@libp2p/websockets": "8.2.0",
+    "@multiformats/multiaddr": "12.3.0",
+    "@psf/bch-js": "6.7.3",
     "axios": "0.27.2",
     "bcryptjs": "2.4.3",
+    "blockstore-fs": "2.0.0",
+    "datastore-fs": "9.1.7",
     "glob": "7.1.6",
-    "ipfs": "0.62.3",
-    "ipfs-coord": "8.0.4",
-    "ipfs-http-client": "55.0.0",
+    "helia": "4.2.5",
+    "helia-coord": "1.5.11",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -45,32 +61,28 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
+    "libp2p": "1.9.1",
     "line-reader": "0.4.0",
+    "minimal-slp-wallet": "5.11.1",
     "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
-    "public-ip": "4.0.4",
+    "public-ip": "6.0.1",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
     "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": "10.0.0",
-    "nyc": "15.1.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

@@ -10,9 +10,12 @@ 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_16.x -o nodesource_setup.sh
-RUN bash nodesource_setup.sh
-RUN apt-get install -y nodejs build-essential
+RUN sudo apt-get install -y ca-certificates curl gnupg
+RUN sudo mkdir -p /etc/apt/keyrings
+RUN curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+RUN echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
+RUN sudo apt-get update
+RUN sudo apt-get install -y nodejs build-essential
 
 #Create the user 'safeuser' and add them to the sudo group.
 RUN useradd -ms /bin/bash safeuser
@@ -32,11 +35,11 @@ RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
 
 # Update to the latest version of npm.
 # Working with npm@7.21.1
-RUN npm install -g npm
+#RUN npm install -g npm
 
 # Update to the latest version of npm.
 #RUN npm install -g npm@7.23.0
-RUN npm install -g npm
+#RUN npm install -g npm
 
 # npm mirror to prevent direct dependency on npm.
 RUN npm set registry http://94.130.170.209:4873/
@@ -70,8 +73,6 @@ RUN mkdir /home/safeuser/.ipfsdata
 #VOLUME /home/safeuser/ipfsdata
 #VOLUME /home/safeuser/orbitdb
 
-EXPOSE 5010
-
 # Start the application.
 #COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]

production/docker/docker-compose.yml

@@ -7,43 +7,16 @@ services:
     image: mongo:4.2.0
     container_name: mongo-bch-service
     ports:
-      - '5555:27017' # <host port>:<container port>
+      - '5557:27017' # <host port>:<container port>
     volumes:
       - ../data/mongodb:/data/db
     command: mongod --logpath=/dev/null # -- quiet
     restart: always
 
-  ipfs-bch-wallet:
-    image: christroutner/trickle-ipfs:v1.0.1
-    #build:
-    #  context: ./
-    #  dockerfile: Dockerfile
-    container_name: ipfs-bch-wallet
-    environment:
-      IPFS_DAEMON_ARGUMENTS: '--enable-pubsub-experiment --migrate=true --agent-version-suffix=docker --routing=dhtclient'
-      UPLOAD_KBPS: '100'
-      DOWNLOAD_KBPS: '100'
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '10m'
-        max-file: '10'
-    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:/root/.ipfs
-    restart: always
-
-  bch-wallet-service:
-    build: ./
-    container_name: bch-wallet-service
+  ipfs-bch-wallet-service:
+    build: .
+    #image: christroutner/ipfs-service-provider:v5.0.1
+    container_name: ipfs-bch-wallet-service
     logging:
       driver: 'json-file'
       options:
@@ -52,9 +25,10 @@ services:
     mem_limit: 1000mb
     links:
       - mongo-bch-service
-      - ipfs-bch-wallet
     ports:
-      - '5010:5010' # <host port>:<container port>
+      - '5032:5032' # <host port>:<container port>
+      - '5668:5668'
+      - '5669:5669'
     volumes:
       - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-service/.ipfsdata
       - ./start-production.sh:/home/safeuser/ipfs-bch-wallet-service/start-production.sh

production/docker/start-production.sh

@@ -16,9 +16,6 @@ export COORD_NAME=bch-wallet-service-generic
 # and you must forward that subdomain to the IPFS_WS_PORT.
 #export CR_DOMAIN=subdomain.yourdomain.com
 
-# Debug level. 0 = minimal info. 2 = max info.
-export DEBUG_LEVEL=2
-
 # BCH Wallet Service Settings
 # Change APISERVER to point to your own installation of bch-api
 export APISERVER=https://api.fullstack.cash/v5/
@@ -32,16 +29,20 @@ export FULLSTACKPASS=demo
 
 
 # Production database connection string.
-export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+export DBURL=mongodb://172.17.0.1:5557/ipfs-service-prod
 
 # Configure REST API port
 export PORT=5010
 
 # Production settings using external go-ipfs node.
-export SVC_ENV=production
+export SVC_ENV=prod
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
-export IPFS_TCP_PORT=4001
-export IPFS_WS_PORT=4003
+export IPFS_TCP_PORT=5668
+export IPFS_WS_PORT=5669
+
+# Set the debug level for helia-coord. 0-3.
+# 0 = no debug logs. 3 = maximum debug logs.
+export DEBUG_LEVEL=0
 
 npm start

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

@@ -13,13 +13,13 @@ export COORD_NAME=ipfs-service-provider-generic
 export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
 
 # 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
 export SVC_ENV=production
-#export IPFS_HOST=localhost
-export IPFS_HOST=172.17.0.1
+export IPFS_HOST=localhost
+# export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 
 # Configure IPFS ports

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/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,19 +5,19 @@
 */
 
 // 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')
+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'
 // const { wlogger } = require('./wlogger')
-const JSONFiles = require('./json-files')
-const FullStackJWT = require('./fullstack-jwt')
-
-const config = require('../../config')
+import JSONFiles from './json-files.js'
+import FullStackJWT from './fullstack-jwt.js'
+import config from '../../config/index.js'
+import Wallet from './wallet.adapter.js'
 
 class Adapters {
   constructor (localConfig = {}) {
@@ -29,7 +29,15 @@ class Adapters {
     this.passport = new Passport()
     this.nodemailer = new Nodemailer()
     this.jsonFiles = new JSONFiles()
-    this.bchjs = new BCHJS({ restURL: this.config.apiServer })
+    this.bchjs = new BCHJS({ restURL: config.apiServer })
+    this.config = config
+
+    const walletConfig = {}
+    if (config.walletInterface === 'web2') {
+      walletConfig.restURL = config.apiServer
+      walletConfig.interface = 'rest-api'
+    }
+    this.wallet = new Wallet(walletConfig)
 
     // Get a valid JWT API key and instance bch-js.
     this.fullStackJwt = new FullStackJWT(config)
@@ -37,10 +45,11 @@ class Adapters {
 
   async start () {
     try {
+      let apiToken
       if (this.config.getJwtAtStartup) {
         // Get a JWT token and instantiate bch-js with it. Then pass that instance
         // to all the rest of the apps controllers and adapters.
-        await this.fullStackJwt.getJWT()
+        apiToken = await this.fullStackJwt.getJWT()
         // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
         this.bchjs = await this.fullStackJwt.instanceBchjs()
       } else {
@@ -50,10 +59,23 @@ class Adapters {
         this.bchjs = new BCHJS({ restURL: this.config.apiServer })
       }
 
+      // Create a default instance of minimal-slp-wallet without initializing it
+      // (without retrieving the wallets UTXOs). This instance will be overwritten
+      // if the operator has configured BCH payments.
+      console.log('\nCreating default startup wallet. This wallet may be overwritten.')
+      await this.wallet.instanceWalletWithoutInitialization({}, { apiToken })
+      this.bchjs = this.wallet.bchWallet.bchjs
+      // console.log('adapters/index.js this.bchjs.restURL: ', this.bchjs.restURL)
+
       // Start the IPFS node.
       // Do not start these adapters if this is an e2e test.
       if (this.config.env !== 'test') {
-        await this.ipfs.start({ bchjs: this.bchjs })
+        if (this.config.useIpfs) {
+          await this.ipfs.start({ bchjs: this.bchjs })
+        }
+      } 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.')
@@ -66,4 +88,4 @@ class Adapters {
   }
 }
 
-module.exports = Adapters
+export default Adapters

src/adapters/ipfs/index.js

@@ -3,9 +3,10 @@
 */
 
 // Local libraries
-const IpfsAdapter = require('./ipfs')
-const IpfsCoordAdapter = require('./ipfs-coord')
-const config = require('../../../config')
+import IpfsAdapter from './ipfs.js'
+
+import IpfsCoordAdapter from './ipfs-coord.js'
+import config from '../../../config/index.js'
 
 class IPFS {
   constructor (localConfig = {}) {
@@ -66,6 +67,140 @@ class IPFS {
       throw err
     }
   }
+
+  // Get the status of this IPFS node.
+  // Create an object with different metrics about this IPFS node, then return
+  // the object.
+  getStatus () {
+    try {
+      const statusObj = {
+        ipfsId: this.ipfsCoordAdapter.ipfsCoord.thisNode.ipfsId,
+        multiAddrs: this.ipfsCoordAdapter.ipfsCoord.thisNode.ipfsMultiaddrs,
+        bchAddr: this.ipfsCoordAdapter.ipfsCoord.thisNode.bchAddr,
+        slpAddr: this.ipfsCoordAdapter.ipfsCoord.thisNode.slpAddr,
+        pubKey: this.ipfsCoordAdapter.ipfsCoord.thisNode.pubKey,
+        peers: this.ipfsCoordAdapter.ipfsCoord.thisNode.peerList.length,
+        relays: this.ipfsCoordAdapter.ipfsCoord.thisNode.relayData.length
+      }
+
+      return statusObj
+    } catch (err) {
+      console.error('Error in ipfs-coord.js/getStatus()')
+      throw err
+    }
+  }
+
+  // Get details on the other peers this node is connected to.
+  async getPeers (showAll) {
+    try {
+      const peerData = this.ipfsCoordAdapter.ipfsCoord.thisNode.peerData
+      // console.log(`peerData: ${JSON.stringify(peerData, null, 2)}`)
+
+      let ipfsPeers =
+        await this.ipfsCoordAdapter.ipfsCoord.adapters.ipfs.getPeers()
+      // console.log('ipfsPeers: ', ipfsPeers)
+
+      ipfsPeers = this._removeDuplicatePeers(ipfsPeers)
+      // console.log('filtered ipfsPeers: ', ipfsPeers)
+
+      const peerDataOut = []
+
+      // Loop through each IPFS peer and hydrate it with data from the peerData.
+      for (let i = 0; i < ipfsPeers.length; i++) {
+        const thisPeer = {
+          peer: ipfsPeers[i]
+        }
+
+        // if (!showAll) {
+        //   // Delete properties that don't contain good info.
+        //   delete thisPeer.muxer
+        //   delete thisPeer.latency
+        //   delete thisPeer.streams
+        // }
+
+        // Get the ipfs-coord peer data for this peer.
+        let thisPeerData = peerData.filter((x) =>
+          x.from.includes(thisPeer.peer)
+        )
+        thisPeerData = thisPeerData[0]
+        // console.log('thisPeerData: ', thisPeerData)
+
+        // Skip if peerData for this IPFS peer could not be found.
+        // if (!thisPeerData) continue
+
+        try {
+          // console.log('thisPeerData: ', thisPeerData)
+
+          // Add data to the IPFS peer data.
+          thisPeer.name = thisPeerData.data.jsonLd.name
+          thisPeer.protocol = thisPeerData.data.jsonLd.protocol
+          thisPeer.version = thisPeerData.data.jsonLd.version
+          thisPeer.connectionAddr = thisPeerData.data.connectionAddr
+
+          if (showAll) {
+            // Add all the peer data.
+            thisPeer.peerData = thisPeerData
+          }
+        } catch (err) {
+          console.warn(
+            `warning: ${thisPeer.peer}: ${err.message}`
+          )
+        }
+
+        peerDataOut.push(thisPeer)
+      }
+
+      return peerDataOut
+    } catch (err) {
+      console.error('Error in getPeers(): ', err)
+      throw err
+    }
+  }
+
+  // Expects an array of peers and returns an array of peers with duplicates
+  // removed.
+  // This function is used by getPeers()
+  _removeDuplicatePeers (arr) {
+    // https://stackoverflow.com/questions/2218999/how-to-remove-all-duplicates-from-an-array-of-objects
+    return arr.filter((v, i, a) => a.findIndex((t) => t === v) === i)
+  }
+
+  // Get data about the known Circuit Relays. Hydrate with data from peers list.
+  getRelays () {
+    try {
+      const relayData = this.ipfsCoordAdapter.ipfsCoord.thisNode.relayData
+      const peerData = this.ipfsCoordAdapter.ipfsCoord.thisNode.peerData
+      // console.log(`relayData: ${JSON.stringify(relayData, null, 2)}`)
+      // console.log(`peerData: ${JSON.stringify(peerData, null, 2)}`)
+
+      for (let i = 0; i < relayData.length; i++) {
+        const thisRelay = relayData[i]
+
+        // Find the peer that corresponds to this relay.
+        const thisPeer = peerData.filter((x) =>
+          x.from.includes(thisRelay.ipfsId)
+        )
+        // console.log('thisPeer: ', thisPeer)
+
+        // If the peer couldn't be found, skip.
+        if (!thisPeer.length) {
+          thisRelay.name = ''
+          thisRelay.description = ''
+          continue
+        }
+
+        thisRelay.name = thisPeer[0].data.jsonLd.name
+        thisRelay.description = thisPeer[0].data.jsonLd.description
+      }
+
+      const v1Relays = this.config.v1Relays
+
+      return { v2Relays: relayData, v1Relays }
+    } catch (err) {
+      console.error('Error in getRelays(): ', err)
+      throw err
+    }
+  }
 }
 
-module.exports = IPFS
+export default IPFS

src/adapters/ipfs/ipfs-coord.js

@@ -5,12 +5,16 @@
 */
 
 // Global npm libraries
-const IpfsCoord = require('ipfs-coord')
-// const BCHJS = require('@psf/bch-js')
-const publicIp = require('public-ip')
+// import IpfsCoord from 'ipfs-coord-esm'
+import IpfsCoord from 'helia-coord'
+
+// import BCHJS from '@psf/bch-js';
+import SlpWallet from 'minimal-slp-wallet'
+import { publicIpv4 } from 'public-ip'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const JSONRPC = require('../../controllers/json-rpc/')
 
 let _this
@@ -34,9 +38,10 @@ class IpfsCoordAdapter {
     // Encapsulate dependencies
     this.IpfsCoord = IpfsCoord
     this.ipfsCoord = {}
-    // this.rpc = new JSONRPC()
+    // this.bchjs = new BCHJS()
+    this.wallet = new SlpWallet()
     this.config = config
-    this.publicIp = publicIp
+    this.publicIp = publicIpv4
 
     // Properties of this class instance.
     this.isReady = false
@@ -47,10 +52,13 @@ class IpfsCoordAdapter {
   async start (localConfig = {}) {
     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 {
-        const ip4 = await this.publicIp.v4()
+        const ip4 = await this.publicIp()
         // const ip6 = await publicIp.v6()
 
         circuitRelayInfo.ip4 = ip4
@@ -63,24 +71,29 @@ class IpfsCoordAdapter {
       }
     }
 
+    const nullLog = () => {}
+
     const ipfsCoordOptions = {
       ipfs: this.ipfs,
       type: 'node.js',
       // type: 'browser',
-      bchjs: this.bchjs,
-      privateLog: console.log, // Default to console.log
+      wallet: this.wallet,
+      // privateLog: console.log, // Default to console.log
+      privateLog: nullLog,
       isCircuitRelay: this.config.isCircuitRelay,
       circuitRelayInfo,
       apiInfo: this.config.apiInfo,
       announceJsonLd: this.config.announceJsonLd,
       mnemonic: this.config.mnemonic,
-      debugLevel: this.config.debugLevel
+      debugLevel: this.config.debugLevel,
+      v1Relays: this.config.v1Relays,
+      tcpPort: this.config.ipfsTcpPort
     }
 
     // Production env uses external go-ipfs node.
-    if (this.config.isProduction) {
-      ipfsCoordOptions.nodeType = 'external'
-    }
+    // if (this.config.isProduction) {
+    //   ipfsCoordOptions.nodeType = 'external'
+    // }
 
     this.ipfsCoord = new this.IpfsCoord(ipfsCoordOptions)
 
@@ -107,12 +120,15 @@ class IpfsCoordAdapter {
 
   // Subscribe to the chat pubsub channel
   async subscribeToChat () {
+    // TODO: Allow user to replace nullog with their own log handler at startup.
+    const nullLog = () => {}
+
     await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
       this.config.chatPubSubChan,
-      console.log,
+      nullLog,
       this.ipfsCoord.thisNode
     )
   }
 }
 
-module.exports = IpfsCoordAdapter
+export default IpfsCoordAdapter

src/adapters/ipfs/ipfs.js

@@ -9,94 +9,95 @@
 */
 
 // 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 { createHelia } from 'helia'
+import fs from 'fs'
+import { FsBlockstore } from 'blockstore-fs'
+import { FsDatastore } from 'datastore-fs'
+import { createLibp2p } from 'libp2p'
+import { tcp } from '@libp2p/tcp'
+import { noise } from '@chainsafe/libp2p-noise'
+import { yamux } from '@chainsafe/libp2p-yamux'
+// import { bootstrap } from '@libp2p/bootstrap'
+// import { identifyService } from 'libp2p/identify'
+import { identify } from '@libp2p/identify'
+// import { circuitRelayServer, circuitRelayTransport } from 'libp2p/circuit-relay'
+import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+import { gossipsub } from '@chainsafe/libp2p-gossipsub'
+import { webSockets } from '@libp2p/websockets'
+import { publicIpv4 } from 'public-ip'
+import { multiaddr } from '@multiformats/multiaddr'
+import { webRTC } from '@libp2p/webrtc'
+import { keychain } from '@libp2p/keychain'
+import { defaultLogger } from '@libp2p/logger'
+import { unixfs } from '@helia/unixfs'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+import JsonFiles from '../json-files.js'
 
-const IPFS_DIR = './.ipfsdata/ipfs'
+// 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))
+// console.log('__dirname: ', __dirname)
+
+const ROOT_DIR = `${__dirname}../../../`
+const IPFS_DIR = `${__dirname}../../../.ipfsdata/ipfs`
 
 class IpfsAdapter {
   constructor (localConfig) {
     // Encapsulate dependencies
     this.config = config
-
-    // Choose the IPFS constructor based on the config settings.
-    this.IPFS = IPFSembedded // default
-    if (this.config.isProduction) {
-      this.IPFS = IPFSexternal
-    }
+    this.fs = fs
+    this.createLibp2p = createLibp2p
+    this.publicIp = publicIpv4
+    this.multiaddr = multiaddr
+    this.jsonFiles = new JsonFiles()
+    this.keychain = keychain
+    this.createHelia = createHelia
 
     // Properties of this class instance.
     this.isReady = false
 
-    this.fs = fs
+    // Bind 'this' object to all subfunctions
+    this.start = this.start.bind(this)
+    this.createNode = this.createNode.bind(this)
+    this.stop = this.stop.bind(this)
+    this.ensureBlocksDir = this.ensureBlocksDir.bind(this)
+    this.getSeed = this.getSeed.bind(this)
+    this.getKeychain = this.getKeychain.bind(this)
   }
 
   // Start an IPFS node.
   async start () {
     try {
-      // Ipfs Options
-      const ipfsOptionsEmbedded = {
-        repo: IPFS_DIR,
-        start: true,
-        config: {
-          relay: {
-            enabled: true, // enable circuit relay dialer and listener
-            hop: {
-              enabled: config.isCircuitRelay // enable circuit relay HOP (make this node a relay)
-            }
-          },
-          pubsub: true, // enable pubsub
-          Swarm: {
-            ConnMgr: {
-              HighWater: 30,
-              LowWater: 10
-            }
-          },
-          Addresses: {
-            Swarm: [
-              `/ip4/0.0.0.0/tcp/${this.config.ipfsTcpPort}`,
-              `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`
-            ]
-          },
-          Datastore: {
-            StorageMax: '2GB',
-            StorageGCWatermark: 50,
-            GCPeriod: '15m'
-          }
-        }
-      }
+      // Ensure the directory structure exists that is needed by the IPFS node to store data.
+      this.ensureBlocksDir()
 
-      const ipfsOptionsExternal = {
-        host: this.config.ipfsHost,
-        port: this.config.ipfsApiPort,
-        agent: http.Agent({ keepAlive: true, maxSockets: 2000 })
-      }
+      // Create an IPFS node
+      const ipfs = await this.createNode()
+      // console.log('ipfs: ', ipfs)
 
-      let ipfsOptions = ipfsOptionsEmbedded
-      if (this.config.isProduction) {
-        ipfsOptions = ipfsOptionsExternal
-      }
+      this.id = ipfs.libp2p.peerId.toString()
+      console.log('IPFS ID: ', this.id)
 
-      // Create a new IPFS node.
-      this.ipfs = await this.IPFS.create(ipfsOptions)
+      // Attempt to guess our ip4 IP address.
+      const ip4 = await this.publicIp()
+      let detectedMultiaddr = `/ip4/${ip4}/tcp/${this.config.ipfsTcpPort}/p2p/${this.id}`
+      detectedMultiaddr = this.multiaddr(detectedMultiaddr)
 
-      // Set the 'server' profile so the node does not scan private networks.
-      await this.ipfs.config.profiles.apply('server')
+      // Get the multiaddrs for the node.
+      const multiaddrs = ipfs.libp2p.getMultiaddrs()
+      multiaddrs.push(detectedMultiaddr)
+      console.log('Multiaddrs: ', multiaddrs)
 
-      // Debugging: Display IPFS config settings.
-      // const configSettings = await this.ipfs.config.getAll()
-      // console.log(`configSettings: ${JSON.stringify(configSettings, null, 2)}`)
+      this.multiaddrs = multiaddrs
 
       // Signal that this adapter is ready.
       this.isReady = true
 
+      this.ipfs = ipfs
+
       return this.ipfs
     } catch (err) {
       console.error('Error in ipfs.js/start()')
@@ -110,31 +111,185 @@ class IpfsAdapter {
     }
   }
 
+  async getKeychain (datastore) {
+    const keychainInit = {
+      pass: await this.getSeed()
+    }
+
+    const chain = this.keychain(keychainInit)({
+      datastore,
+      logger: defaultLogger()
+    })
+
+    return chain
+  }
+
+  // This function creates an IPFS node using Helia.
+  // It returns the node as an object.
+  async createNode () {
+    try {
+      // Create block and data stores.
+      const blockstore = new FsBlockstore(`${IPFS_DIR}/blockstore`)
+      const datastore = new FsDatastore(`${IPFS_DIR}/datastore`)
+
+      // const keychainInit = {
+      //   pass: await this.getSeed()
+      // }
+
+      // Create an identity
+      let peerId
+      // console.log('this.keychain: ', this.keychain)
+      // const chain = this.keychain(keychainInit)({
+      //   datastore,
+      //   logger: defaultLogger()
+      // })
+      const chain = await this.getKeychain(datastore)
+      try {
+        peerId = await chain.exportPeerId('myKey')
+      } catch (err) {
+        await chain.createKey('myKey', 'Ed25519', 4096)
+        peerId = await chain.exportPeerId('myKey')
+      }
+
+      // Configure services
+      const services = {
+        identify: identify(),
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true })
+      }
+      if (this.config.isCircuitRelay) {
+        console.log('Helia (IPFS) node IS configured as Circuit Relay')
+        services.relay = circuitRelayServer({ // makes the node function as a relay server
+          hopTimeout: 30 * 1000, // incoming relay requests must be resolved within this time limit
+          advertise: true,
+          reservations: {
+            maxReservations: 15, // how many peers are allowed to reserve relay slots on this server
+            reservationClearInterval: 300 * 1000, // how often to reclaim stale reservations
+            applyDefaultLimit: true, // whether to apply default data/duration limits to each relayed connection
+            defaultDurationLimit: 2 * 60 * 1000, // the default maximum amount of time a relayed connection can be open for
+            defaultDataLimit: BigInt(2 << 7), // the default maximum number of bytes that can be transferred over a relayed connection
+            maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
+            maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
+          }
+        })
+      } else {
+        console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
+      }
+
+      // Configure transports
+      let transports
+      if (process.env.CONNECT_PREF === 'direct') {
+        transports = [
+          tcp(),
+          webSockets(),
+          webRTC()
+        ]
+      } else {
+        transports = [
+          tcp(),
+          webSockets(),
+          circuitRelayTransport({
+            discoverRelays: 3,
+            reservationConcurrency: 3
+          }),
+          webRTC()
+        ]
+      }
+
+      // libp2p is the networking layer that underpins Helia
+      const libp2p = await this.createLibp2p({
+        peerId,
+        datastore,
+        addresses: {
+          listen: [
+            '/ip4/127.0.0.1/tcp/0',
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsTcpPort}`,
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`,
+            '/webrtc'
+          ]
+        },
+        transports,
+        connectionEncryption: [
+          noise()
+        ],
+        streamMuxers: [
+          yamux()
+        ],
+        services
+      })
+
+      // create a Helia node
+      const helia = await this.createHelia({
+        blockstore,
+        datastore,
+        libp2p
+      })
+
+      // Attach IPFS file system.
+      const fs = unixfs(helia)
+      helia.fs = fs
+
+      return helia
+    } catch (err) {
+      console.error('Error creating Helia node: ', err)
+
+      throw err
+    }
+  }
+
   async stop () {
     await this.ipfs.stop()
 
     return true
   }
 
-  // Remove the '/blocks' directory that is used to store IPFS data.
-  // 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
-  //  }
-  // }
+  // Ensure that the directories exist to store blocks from the IPFS network.
+  // This function is called at startup, before the IPFS node is started.
+  ensureBlocksDir () {
+    try {
+      !this.fs.existsSync(`${ROOT_DIR}.ipfsdata`) && this.fs.mkdirSync(`${ROOT_DIR}.ipfsdata`)
+
+      !this.fs.existsSync(`${IPFS_DIR}`) && this.fs.mkdirSync(`${IPFS_DIR}`)
+
+      !this.fs.existsSync(`${IPFS_DIR}/blockstore`) && this.fs.mkdirSync(`${IPFS_DIR}/blockstore`)
+
+      !this.fs.existsSync(`${IPFS_DIR}/datastore`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore`)
+
+      // !fs.existsSync(`${IPFS_DIR}/datastore/peers`) && fs.mkdirSync(`${IPFS_DIR}/datastore/peers`)
+
+      return true
+    } catch (err) {
+      console.error('Error in adapters/ipfs.js/ensureBlocksDir(): ', err)
+      throw err
+    }
+  }
+
+  // This function opens the seed used to generate the key for this IPFS peer.
+  // The seed is stored in a JSON file. If it doesn't exist, a new one is created.
+  async getSeed () {
+    try {
+      let seed
+
+      const filename = `${IPFS_DIR}/seed.json`
+
+      try {
+        // Try to read the JSON file containing the seed.
+        seed = await this.jsonFiles.readJSON(filename)
+      } catch (err) {
+        const seedNum = Math.floor(Math.random() * 1000000000000000000000)
+        seed = seedNum.toString()
+
+        // Save the newly generated seed
+        await this.jsonFiles.writeJSON(seed, filename)
+      }
+
+      // console.log('getSeed() seed: ', seed)
+
+      return seed
+    } catch (err) {
+      console.error('Error in adapters/ipfs/ipfs.js/getSeed()')
+      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 () {
@@ -169,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/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/wallet.adapter.js

@@ -0,0 +1,245 @@
+/*
+  Wallet adapter. This library instantiates minimal-slp-wallet based on different
+  configuration settings. That single instance of minimal-slp-wallet is then
+  easily passed around the rest of this application.
+*/
+
+// Global npm libraries
+import BchWallet from 'minimal-slp-wallet'
+
+// Local libraries
+import config from '../../config/index.js'
+import JsonFiles from './json-files.js'
+
+class Wallet {
+  constructor (localConfig = {}) {
+    // Encapsulate dependencies
+    this.config = config
+    this.BchWallet = BchWallet
+    this.jsonFiles = new JsonFiles()
+
+    // Bind 'this' object to all subfunctions
+    this.instanceWalletWithoutInitialization = this.instanceWalletWithoutInitialization.bind(this)
+  }
+
+  // This is used for initializing the wallet, without waiting to update the wallet
+  // UTXOs from the blockchain.
+  // This is useful when the wallet is simply needed to make calls to the blockchain,
+  // and there is no need to hydrate it with UTXO data.
+  async instanceWalletWithoutInitialization (walletData = {}, advancedConfig = {}) {
+    try {
+      // Use the apiToken from the config settings, if one is not passed-in at
+      // run-time.
+      if (!advancedConfig.apiToken) {
+        advancedConfig.apiToken = this.config.apiToken
+      }
+
+      // If an authentication password is passed in the config, add it.
+      if (this.config.authPass) {
+        advancedConfig.authPass = this.config.authPass
+      }
+
+      // Detect and configure different blockchain infrastructure settings.
+      if (this.config.walletInterface === 'web2') {
+        advancedConfig.interface = 'rest-api'
+        advancedConfig.restURL = this.config.apiServer
+      } else {
+        // By default use the web3 Cash Stack (https://cashstack.info)
+        advancedConfig.interface = 'consumer-api'
+        advancedConfig.restURL = this.config.apiServer
+      }
+
+      // console.log('advancedConfig setting when creating wallet: ', advancedConfig)
+
+      // Instantiate minimal-slp-wallet.
+      if (walletData.mnemonic) {
+        // Instance the wallet using the mnemonic passed in to this function.
+        console.log('Mnemonic provided to wallet library from calling function.')
+        this.bchWallet = await this._instanceWallet(walletData.mnemonic, advancedConfig)
+      } else if (this.config.mnemonic) {
+        // Otherwise use the mnemonic in the config setting or passed as an environment variable.
+        console.log('Mnemonic retrieved from config file or environment variable.')
+        this.bchWallet = await this._instanceWallet(this.config.mnemonic, advancedConfig)
+      } else {
+        // If no mnemonic is provided, then generate a new mnemonic to create the wallet.
+        console.log('New mnemonic generated.')
+        this.bchWallet = await this._instanceWallet(undefined, advancedConfig)
+      }
+
+      // Wait for wallet to initialize.
+      await this.bchWallet.walletInfoPromise
+      console.log('BCH wallet initialized.')
+      console.log(`Wallet address: ${this.bchWallet.walletInfo.cashAddress}`)
+      console.log(`Wallet mnemonic: ${this.bchWallet.walletInfo.mnemonic}`)
+      console.log(`Wallet backend: ${this.bchWallet.bchjs.restURL}`)
+
+      return this.bchWallet
+    } catch (err) {
+      console.error('Error in instanceWalletWithoutInitialization()')
+      throw err
+    }
+  }
+
+  // This function is used for easier mocking of unit tests.
+  async _instanceWallet (mnemonic, config) {
+    const wallet = new this.BchWallet(mnemonic, config)
+    await wallet.walletInfoPromise
+
+    return wallet
+  }
+
+  // Open the wallet file, or create one if the file doesn't exist.
+  // Does not instance the wallet. The output of this function is expected to
+  // be passed to instanceWallet().
+  async openWallet (advancedConfig = {}) {
+    try {
+      let walletData
+
+      // Try to open the wallet.json file.
+      try {
+        walletData = await this.jsonFiles.readJSON(this.config.walletFile)
+        walletData = walletData.wallet
+      } catch (err) {
+        // Create a new wallet file if one does not already exist.
+        console.log('Wallet file not found. Creating new wallet.json file.')
+
+        // Create a new wallet.
+        // No-Update flag creates wallet without making any network calls.
+        const walletInstance = await this.instanceWalletWithoutInitialization({}, advancedConfig)
+
+        walletData = walletInstance.walletInfo
+
+        // Add the nextAddress property
+        walletData.nextAddress = 1
+
+        // Write the wallet data to the JSON file.
+        await this.jsonFiles.writeJSON({ wallet: walletData }, this.config.walletFile)
+      }
+
+      // console.log('walletData: ', walletData)
+      return walletData
+    } catch (err) {
+      console.error('Error in openWallet()')
+      throw err
+    }
+  }
+
+  // Create an instance of minimal-slp-wallet. Same as
+  // instanceWalletWithoutInitialization(), but waits for the wallet to initialize
+  // its UTXOs (wallet balance and tokens).
+  async instanceWallet (walletData = {}, advancedConfig = {}) {
+    try {
+      // Instance the wallet without initialization.
+      await this.instanceWalletWithoutInitialization(walletData, advancedConfig)
+
+      // Initialize the wallet
+      await this.bchWallet.initialize()
+
+      return this.bchWallet
+    } catch (err) {
+      console.error('Error in wallet.js/instanceWallet()')
+      throw err
+    }
+  }
+
+  // Increments the 'nextAddress' property in the wallet file. This property
+  // indicates the HD index that should be used to generate a key pair for
+  // storing funds for Offers.
+  // This function opens the wallet file, increments the nextAddress property,
+  // then saves the change to the wallet file.
+  async incrementNextAddress () {
+    try {
+      const walletData = await this.openWallet()
+
+      await this.instanceWalletWithoutInitialization(walletData)
+
+      walletData.nextAddress++
+      // console.log('walletData finish: ', walletData)
+
+      await this.jsonFiles.writeJSON({ wallet: walletData }, this.config.walletFile)
+
+      // Update the working instance of the wallet.
+      this.bchWallet.walletInfo.nextAddress++
+      // console.log('this.bchWallet.walletInfo: ', this.bchWallet.walletInfo)
+
+      return walletData.nextAddress
+    } catch (err) {
+      console.error('Error in incrementNextAddress()')
+      throw err
+    }
+  }
+
+  // This method returns an object that contains a private key WIF, public address,
+  // and the index of the HD wallet that the key pair was generated from.
+  // TODO: Allow input integer. If input is used, use that as the index. If no
+  // input is provided, then call incrementNextAddress().
+  async getKeyPair (hdIndex = 0) {
+    try {
+      if (!hdIndex) {
+        // Increment the HD index and generate a new key pair.
+        hdIndex = await this.incrementNextAddress()
+      }
+
+      const mnemonic = this.bchWallet.walletInfo.mnemonic
+
+      // root seed buffer
+      const rootSeed = await this.bchWallet.bchjs.Mnemonic.toSeed(mnemonic)
+      const masterHDNode = this.bchWallet.bchjs.HDNode.fromSeed(rootSeed)
+
+      // HDNode of BIP44 account
+      // const account = this.bchWallet.bchjs.HDNode.derivePath(masterHDNode, "m/44'/245'/0'")
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = this.bchWallet.bchjs.HDNode.toCashAddress(childNode)
+      console.log('Generating a new key pair for cashAddress: ', cashAddress)
+
+      const wif = this.bchWallet.bchjs.HDNode.toWIF(childNode)
+
+      const outObj = {
+        cashAddress,
+        wif,
+        hdIndex
+      }
+      return outObj
+    } catch (err) {
+      console.error('Error in getKeyPair()')
+      throw err
+    }
+  }
+
+  // Optimize the wallet by consolidating the UTXOs.
+  async optimize () {
+    const UTXO_THREASHOLD = 7
+    // Do a dry-run first to see if there are enough UTXOs worth consolidating.
+    const dryRunOut = await this.bchWallet.optimize(true)
+    if (dryRunOut.bchUtxoCnt > UTXO_THREASHOLD) {
+      // Consolidate BCH UTXOs if the count is above the threashold.
+      const txids = await this.bchWallet.optimize()
+      console.log(`Wallet optimized with these return values: ${JSON.stringify(txids, null, 2)}`)
+    }
+    return true
+  }
+
+  // Get the balance of the wallet in sats and PSF tokens.
+  // This function is called by the GET /entry/balance controller.
+  async getBalance () {
+    const balance = await this.bchWallet.getBalance()
+    // console.log('balance: ', balance)
+    const tokens = await this.bchWallet.listTokens()
+    // console.log('tokens: ', tokens)
+    // Find the array entry for the PSF token
+    const psfTokens = tokens.find(x => x.tokenId === '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0')
+    // console.log('psfTokens: ', psfTokens)
+    let psfBalance = 0
+    if (psfTokens) {
+      psfBalance = psfTokens.qty
+    }
+    const outObj = {
+      satBalance: balance,
+      psfBalance,
+      success: true
+    }
+    return outObj
+  }
+}
+
+export default Wallet

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

@@ -6,23 +6,21 @@
 
 // Public npm libraries.
 
-// Load the Clean Architecture Adapters library
-const Adapters = require('../adapters')
-
-// Load the JSON RPC Controller.
-const JSONRPC = require('./json-rpc')
-
-// Load the Clean Architecture Use Case libraries.
-const UseCases = require('../use-cases')
-// const useCases = new UseCases({ adapters })
-
-// Load the REST API Controllers.
-const RESTControllers = require('./rest-api')
+// Local libraries
+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 = {}) {
-    this.adapters = new Adapters()
+    // Encapsulate dependencies
+    this.adapters = new Adapters(localConfig)
     this.useCases = new UseCases({ adapters: this.adapters })
+    this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
+    this.config = config
   }
 
   // Spin up any adapter libraries that have async startup needs.
@@ -52,10 +50,13 @@ class Controllers {
     // Wait for any startup processes to complete for the Adapters libraries.
     // await this.adapters.start()
 
-    // Attach the REST controllers to the Koa app.
-    // this.attachRESTControllers(app)
+    if (this.config.useIpfs) {
+      // Attach JSON RPC controllers
+      this.attachRPCControllers()
+    }
 
-    this.attachRPCControllers()
+    // Attach and start the timer controllers
+    this.timerControllers.startTimers()
   }
 
   // Add the JSON RPC router to the ipfs-coord adapter.
@@ -72,4 +73,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/bch/index.js

@@ -3,13 +3,13 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 // const BCHJS = require('@psf/bch-js')
 
 // 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 BCHRPC {
   constructor (localConfig = {}) {
@@ -60,6 +60,10 @@ class BCHRPC {
           await this.rateLimit.limiter(rpcData.from)
           return await this.utxos(rpcData)
 
+        case 'utxosBulk':
+          await this.rateLimit.limiter(rpcData.from)
+          return await this.utxosBulk(rpcData)
+
         case 'broadcast':
           await this.rateLimit.limiter(rpcData.from)
           return await this.broadcast(rpcData)
@@ -238,7 +242,7 @@ class BCHRPC {
 
       return retObj
     } catch (err) {
-      console.error('Error in JSON RPC BCH balance()')
+      console.error('Error in JSON RPC BCH balance(): ', err)
       // throw err
 
       // Return an error response
@@ -366,6 +370,145 @@ class BCHRPC {
     }
   }
 
+  /**
+   * @api {JSON} /bch UTXOs Bulk
+   * @apiPermission public
+   * @apiName UTXOs Bulk
+   * @apiGroup JSON BCH
+   * @apiDescription This endpoint provides the same data as as the utxos
+   * endpoint, but it allows retrieval of UTXOs for up to 20 addresses at
+   * a 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 array of addresses, this endpoint will return an object
+   *  with the following properties
+   *
+   *  - jsonrpc: "" - jsonrpc version
+   *  - id: "" - jsonrpc id
+   *  - result: {} - Result of the request with the RPC information
+   *    - method: "" - Method used in the request
+   *    - receiver: "" - Receiver address
+   *    - value: [] - Final result value of the request
+   *      - address: "" - the address 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:
+   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "utxos", "address": "bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj"}}
+   *
+   * @apiSuccessExample {json} Success-Response:
+   *
+   * {
+   *    "jsonrpc":"2.0",
+   *    "id":"555",
+   *    "result":{
+   *       "method":"bch",
+   *       "reciever":"QmU86vLVbUY1UhziKB6rak7GPKRA2QHWvzNm2AjEvXNsT6",
+   *       "value":[
+   *          {
+   *             "address":"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":[
+   *
+   *                   ]
+   *                }
+   *             }
+   *          }
+   *       ]
+   *    }
+   * }
+   *
+   */
+  async utxosBulk (rpcData) {
+    try {
+      // console.log('createUser rpcData: ', rpcData)
+
+      const addrs = rpcData.payload.params.addresses
+      // console.log('addrs: ', addrs)
+
+      // 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 result = []
+      for (let i = 0; i < addrs.length; i++) {
+        const thisAddr = addrs[i]
+
+        const data = await this.bchjs.Utxo.get(thisAddr)
+        // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+        result.push({
+          address: thisAddr,
+          utxos: data
+        })
+      }
+      // console.log('result: ', result)
+
+      const retObj = {}
+      retObj.status = 200
+      retObj.success = true
+      retObj.data = result
+
+      // console.log('retObj: ', retObj)
+
+      return retObj
+    } catch (err) {
+      console.error('Error in JSON RPC BCH utxosBulk()')
+      console.error('Error in JSON RPC utxosBulk(): ', err)
+      // throw err
+
+      // Return an error response
+      return {
+        success: false,
+        status: 422,
+        message: err.message,
+        endpoint: 'utxosBulk'
+      }
+    }
+  }
+
   /**
    * @api {JSON} /bch Broadcast
    * @apiPermission public
@@ -823,7 +966,9 @@ class BCHRPC {
       const tokenId = rpcData.payload.params.tokenId
       // console.log('tokenId: ', tokenId)
 
-      const tokenData = await this.bchjs.PsfSlpIndexer.getTokenData2(tokenId)
+      const updateCache = rpcData.payload.params.updateCache
+
+      const tokenData = await this.bchjs.PsfSlpIndexer.getTokenData2(tokenId, updateCache)
 
       const retObj = {
         success: true,
@@ -854,4 +999,5 @@ class BCHRPC {
   }
 }
 
-module.exports = BCHRPC
+// module.exports = BCHRPC
+export default BCHRPC

src/controllers/json-rpc/index.js

@@ -3,14 +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')
-const BCHController = require('./bch')
+import wlogger from '../../adapters/wlogger.js'
+import UserController from './users/index.js'
+import AuthController from './auth/index.js'
+import AboutController from './about/index.js'
+import BCHController from './bch/index.js'
 
 let _this
 
@@ -202,4 +202,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

@@ -444,4 +444,6 @@ class BCHRESTController {
     }
   }
 }
-module.exports = BCHRESTController
+
+// module.exports = BCHRESTController
+export default BCHRESTController

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

@@ -3,10 +3,12 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+// const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const BCHRESTController = require('./controller')
+// const BCHRESTController = require('./controller')
+import BCHRESTController from './controller.js'
 
 class BCHRouter {
   constructor (localConfig = {}) {
@@ -58,4 +60,5 @@ class BCHRouter {
   }
 }
 
-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,12 +6,14 @@
 
 // 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')
+// 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 IpfsRESTController from './ipfs/index.js'
+import BCHRESTController from './bch/index.js'
+import config from '../../../config/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -29,7 +31,8 @@ class RESTControllers {
       )
     }
 
-    // console.log('Controllers localConfig: ', localConfig)
+    // Encapsulate dependencies
+    this.config = config
   }
 
   attachRESTControllers (app) {
@@ -38,13 +41,15 @@ class RESTControllers {
       useCases: this.useCases
     }
 
-    // Attach the REST API Controllers associated with the /auth route
-    const authRESTController = new AuthRESTController(dependencies)
-    authRESTController.attach(app)
+    if (!this.config.noMongo) {
+      // Attach the REST API Controllers associated with the /auth route
+      const authRESTController = new AuthRESTController(dependencies)
+      authRESTController.attach(app)
 
-    // Attach the REST API Controllers associated with the /user route
-    const userRouter = new UserRouter(dependencies)
-    userRouter.attach(app)
+      // Attach the REST API Controllers associated with the /user route
+      const userRouter = new UserRouter(dependencies)
+      userRouter.attach(app)
+    }
 
     // Attach the REST API Controllers associated with the /contact route
     const contactRESTController = new ContactRESTController(dependencies)
@@ -54,10 +59,14 @@ class RESTControllers {
     const logsRESTController = new LogsRESTController(dependencies)
     logsRESTController.attach(app)
 
+    // Attach the REST API Controllers associated with the /ipfs route
+    const ipfsRESTController = new IpfsRESTController(dependencies)
+    ipfsRESTController.attach(app)
+
     // Attach the REST API Controllers associated with the /fulcrum route
     const bchRESTController = new BCHRESTController(dependencies)
     bchRESTController.attach(app)
   }
 }
 
-module.exports = RESTControllers
+export default RESTControllers

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

@@ -0,0 +1,145 @@
+/*
+  REST API Controller library for the /ipfs route
+*/
+
+// Global npm libraries
+
+// Local libraries
+import wlogger from '../../../adapters/wlogger.js'
+
+class IpfsRESTControllerLib {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /ipfs REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /ipfs REST Controller.'
+      )
+    }
+
+    // Encapsulate dependencies
+    // this.UserModel = this.adapters.localdb.Users
+    // this.userUseCases = this.useCases.user
+
+    // Bind 'this' object to all subfunctions
+    this.getStatus = this.getStatus.bind(this)
+    this.getPeers = this.getPeers.bind(this)
+    this.getRelays = this.getRelays.bind(this)
+    this.handleError = this.handleError.bind(this)
+    this.connect = this.connect.bind(this)
+    this.getThisNode = this.getThisNode.bind(this)
+  }
+
+  /**
+   * @api {get} /ipfs Get status on IPFS infrastructure
+   * @apiPermission public
+   * @apiName GetIpfsStatus
+   * @apiGroup REST BCH
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs
+   *
+   */
+  async getStatus (ctx) {
+    try {
+      const status = await this.adapters.ipfs.getStatus()
+
+      ctx.body = { status }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getStatus(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // Return information on IPFS peers this node is connected to.
+  async getPeers (ctx) {
+    try {
+      const showAll = ctx.request.body.showAll
+
+      const peers = await this.adapters.ipfs.getPeers(showAll)
+
+      ctx.body = { peers }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getPeers(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // Get data about the known Circuit Relays. Hydrate with data from peers list.
+  async getRelays (ctx) {
+    try {
+      const relays = await this.adapters.ipfs.getRelays()
+
+      ctx.body = { relays }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getRelays(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  async connect (ctx) {
+    try {
+      const multiaddr = ctx.request.body.multiaddr
+      const getDetails = ctx.request.body.getDetails
+
+      // console.log('this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs: ', this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs)
+      const result = await this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs.connectToPeer({ multiaddr, getDetails })
+      // console.log('result: ', result)
+
+      ctx.body = result
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/connect():', err)
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+   * @api {get} /ipfs/node Get a copy of the thisNode object from helia-coord
+   * @apiPermission public
+   * @apiName GetThisNode
+   * @apiGroup REST BCH
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/node
+   *
+   */
+  async getThisNode (ctx) {
+    try {
+      const thisNode = this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+
+      ctx.body = { thisNode }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getThisNode(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // DRY error handler
+  handleError (ctx, err) {
+    // If an HTTP status is specified by the buisiness logic, use that.
+    if (err.status) {
+      if (err.message) {
+        ctx.throw(err.status, err.message)
+      } else {
+        ctx.throw(err.status)
+      }
+    } else {
+      // By default use a 422 error if the HTTP status is not specified.
+      ctx.throw(422, err.message)
+    }
+  }
+}
+
+// module.exports = IpfsRESTControllerLib
+export default IpfsRESTControllerLib

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

@@ -0,0 +1,67 @@
+/*
+  REST API library for the /ipfs route.
+*/
+
+// Public npm libraries.
+import Router from 'koa-router'
+
+// Local libraries.
+import IPFSRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
+
+// let _this
+
+class IpfsRouter {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating IPFS REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating IPFS REST Controller.'
+      )
+    }
+
+    const dependencies = {
+      adapters: this.adapters,
+      useCases: this.useCases
+    }
+
+    // Encapsulate dependencies.
+    this.ipfsRESTController = new IPFSRESTControllerLib(dependencies)
+    this.validators = new Validators()
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/ipfs'
+    this.router = new Router({ prefix: baseUrl })
+
+    // _this = this
+  }
+
+  attach (app) {
+    if (!app) {
+      throw new Error(
+        'Must pass app object when attaching REST API controllers.'
+      )
+    }
+
+    // Define the routes and attach the controller.
+    this.router.get('/', this.ipfsRESTController.getStatus)
+    this.router.post('/peers', this.ipfsRESTController.getPeers)
+    this.router.post('/relays', this.ipfsRESTController.getRelays)
+    this.router.post('/connect', this.ipfsRESTController.connect)
+    this.router.get('/node', this.ipfsRESTController.getThisNode)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(this.router.routes())
+    app.use(this.router.allowedMethods())
+  }
+}
+
+// module.exports = BchRouter
+export default IpfsRouter

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/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/bch/index.js

@@ -14,6 +14,7 @@ class BCHUseCases {
 
     // Encapsulate dependencies
     this.bchjs = this.adapters.bchjs
+    // console.log('use-cases/bch/index.js restURL: ', this.bchjs.restURL)
   }
 
   // Get transaction history for an address, sorted by block height.
@@ -139,4 +140,5 @@ class BCHUseCases {
   }
 }
 
-module.exports = BCHUseCases
+// module.exports = BCHUseCases
+export default BCHUseCases

src/use-cases/index.js

@@ -5,8 +5,8 @@
 */
 
 // Local libraries
-const UserUseCases = require('./user')
-const BCHUseCases = require('./bch')
+import UserUseCases from './user.js'
+import BCHUseCases from './bch/index.js'
 
 class UseCases {
   constructor (localConfig = {}) {
@@ -24,16 +24,10 @@ class UseCases {
 
   // 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

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

@@ -5,15 +5,17 @@
 */
 
 // 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())
@@ -21,9 +23,9 @@ const context = {}
 
 const LOCALHOST = `http://localhost:${config.port}`
 
-describe('Auth', () => {
-  before(async () => {
-    try {
+if (!config.noMongo) {
+  describe('Auth', () => {
+    before(async () => {
       const app = new Server()
 
       // This should be the first instruction. It starts the REST API server.
@@ -48,82 +50,80 @@ describe('Auth', () => {
 
       context.user = testUser.user
       context.token = testUser.token
-    } catch (err) {
-      console.log('err in auth beforeAll: ', err)
-    }
-  })
-
-  describe('POST /auth', () => {
-    it('should throw 401 if credentials are incorrect', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'test@test.com',
-            password: 'wrongpassword'
-          }
-        }
-
-        const result = await axios(options)
-
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        console.log(
-          `result stringified: ${JSON.stringify(result.data, null, 2)}`
-        )
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert(err.response.status === 401, 'Error code 401 expected.')
-      }
     })
 
-    it('should throw 401 if email is wrong format', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'wrongEmail',
-            password: 'wrongpassword'
+    describe('POST /auth', () => {
+      it('should throw 401 if credentials are incorrect', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'test@test.com',
+              password: 'wrongpassword'
+            }
           }
+
+          const result = await axios(options)
+
+          // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+          console.log(
+            `result stringified: ${JSON.stringify(result.data, null, 2)}`
+          )
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert(err.response.status === 401, 'Error code 401 expected.')
         }
+      })
 
-        await axios(options)
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert(err.response.status === 401, 'Error code 401 expected.')
-      }
-    })
-
-    it('should auth user', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'test@test.com',
-            password: 'pass'
+      it('should throw 401 if email is wrong format', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'wrongEmail',
+              password: 'wrongpassword'
+            }
           }
-        }
-        const result = await axios(options)
-        // console.log(`result: ${JSON.stringify(result.data, null, 2)}`)
 
-        assert(result.status === 200, 'Status Code 200 expected.')
-        assert(
-          result.data.user.email === 'test@test.com',
-          'Email of test expected'
-        )
-        assert(
-          result.data.user.password === undefined,
-          'Password expected to be omited'
-        )
-      } catch (err) {
-        console.log(
-          'Error authenticating test user: ' + JSON.stringify(err, null, 2)
-        )
-        throw err
-      }
+          await axios(options)
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert(err.response.status === 401, 'Error code 401 expected.')
+        }
+      })
+
+      it('should auth user', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'test@test.com',
+              password: 'pass'
+            }
+          }
+          const result = await axios(options)
+          // console.log(`result: ${JSON.stringify(result.data, null, 2)}`)
+
+          assert(result.status === 200, 'Status Code 200 expected.')
+          assert(
+            result.data.user.email === 'test@test.com',
+            'Email of test expected'
+          )
+          assert(
+            result.data.user.password === undefined,
+            'Password expected to be omited'
+          )
+        } catch (err) {
+          console.log(
+            'Error authenticating test user: ' + JSON.stringify(err, null, 2)
+          )
+          throw err
+        }
+      })
     })
   })
-})
+}

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', () => {

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,9 @@
-const assert = require('chai').assert
+import { assert } from 'chai'
+import Admin from '../../../src/adapters/admin.js'
+import sinon from 'sinon'
+import util from 'util'
+import config from '../../../config/index.js'
 
-const Admin = require('../../../src/adapters/admin')
-
-const sinon = require('sinon')
-
-const util = require('util')
 util.inspect.defaultOptions = { depth: 1 }
 
 let sandbox
@@ -18,101 +17,103 @@ describe('Admin', () => {
 
   afterEach(() => sandbox.restore())
 
-  describe('loginAdmin()', () => {
-    it('should logind admin', async () => {
-      try {
-        const error = new Error('test error')
-        error.response = {
-          status: 422
+  if (!config.noMongo) {
+    describe('loginAdmin()', () => {
+      it('should logind admin', async () => {
+        try {
+          const error = new Error('test error')
+          error.response = {
+            status: 422
+          }
+          // sandbox.stub(uut.axios, 'request').onFirstCall().throws(error)
+
+          const result = await uut.loginAdmin()
+          const user = result.data.user
+
+          assert.property(user, '_id')
+          assert.property(user, 'email')
+          assert.property(user, 'type')
+
+          assert.isString(user._id)
+          assert.isString(user.email)
+          assert.isString(user.type)
+
+          assert.equal(user.type, 'admin')
+        } catch (err) {
+          assert(false, 'Unexpected result')
         }
-        // sandbox.stub(uut.axios, 'request').onFirstCall().throws(error)
+      })
 
-        const result = await uut.loginAdmin()
-        const user = result.data.user
+      it('should handle axios error', async () => {
+        try {
+          // Returns an erroneous password to force
+          // an auth error
+          sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
 
-        assert.property(user, '_id')
-        assert.property(user, 'email')
-        assert.property(user, 'type')
-
-        assert.isString(user._id)
-        assert.isString(user.email)
-        assert.isString(user.type)
-
-        assert.equal(user.type, 'admin')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
-    })
-
-    it('should handle axios error', async () => {
-      try {
-        // Returns an erroneous password to force
-        // an auth error
-        sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
-
-        await uut.loginAdmin()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.equal(err.response.status, 401)
-        assert.include(err.response.data, 'Unauthorized')
-      }
-    })
-  })
-
-  describe('createSystemUser()', () => {
-    it('should create admin', async () => {
-      try {
-        const result = await uut.createSystemUser()
-
-        assert.property(result, 'email')
-        assert.property(result, 'password')
-        assert.property(result, 'id')
-        assert.property(result, 'token')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
-    })
-
-    it('should handle axios error', async () => {
-      try {
-        const error1 = new Error('test error')
-        error1.response = {
-          status: 422
+          await uut.loginAdmin()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.equal(err.response.status, 401)
+          assert.include(err.response.data, 'Unauthorized')
         }
-        const error2 = new Error('test error')
-        error1.response = {
-          status: 500
-        }
-        // The loginAdmin() function in some use cases is recursive
-        // after handling the 422 error, it gets called again
-        sandbox
-          .stub(uut.axios, 'request')
-          .onFirstCall()
-          .throws(error1)
-          .onSecondCall()
-          .throws(error2)
-
-        await uut.createSystemUser()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.include(err.message, 'test error')
-      }
+      })
     })
 
-    it('should handle errors when remove user', async () => {
-      try {
-        const error1 = new Error('test error')
-        error1.response = {
-          status: 422
-        }
-        sandbox.stub(uut.axios, 'request').throws(error1)
-        sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
+    describe('createSystemUser()', () => {
+      it('should create admin', async () => {
+        try {
+          const result = await uut.createSystemUser()
 
-        await uut.createSystemUser()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.include(err.message, 'test error')
-      }
+          assert.property(result, 'email')
+          assert.property(result, 'password')
+          assert.property(result, 'id')
+          assert.property(result, 'token')
+        } catch (err) {
+          assert(false, 'Unexpected result')
+        }
+      })
+
+      it('should handle axios error', async () => {
+        try {
+          const error1 = new Error('test error')
+          error1.response = {
+            status: 422
+          }
+          const error2 = new Error('test error')
+          error1.response = {
+            status: 500
+          }
+          // The loginAdmin() function in some use cases is recursive
+          // after handling the 422 error, it gets called again
+          sandbox
+            .stub(uut.axios, 'request')
+            .onFirstCall()
+            .throws(error1)
+            .onSecondCall()
+            .throws(error2)
+
+          await uut.createSystemUser()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
+
+      it('should handle errors when remove user', async () => {
+        try {
+          const error1 = new Error('test error')
+          error1.response = {
+            status: 422
+          }
+          sandbox.stub(uut.axios, 'request').throws(error1)
+          sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
+
+          await uut.createSystemUser()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
     })
-  })
+  }
 })

test/e2e/manual/consumer/lib/test-utils.js

@@ -108,7 +108,7 @@ class TestUtils {
         privateLog: this.rpcHandler, // Default to console.log
         isCircuitRelay: false,
         apiInfo: 'none',
-        announceJsonLd: announceJsonLd,
+        announceJsonLd,
         nodeType: 'external'
       })
 

test/integration/controllers/json-rpc/bch.integration.js

@@ -27,7 +27,7 @@ describe('#BCH', () => {
         payload: {
           params: {
             utxo: {
-              txid: 'b94e1ff82eb5781f98296f0af2488ff06202f12ee92b0175963b8dba688d1b40',
+              txid: 'a2059b1321e96a90a386894a68fa5829756118895b3cdb9a0393d94fd2ceed93',
               vout: 0
             }
           }
@@ -45,7 +45,7 @@ describe('#BCH', () => {
         payload: {
           params: {
             utxo: {
-              tx_hash: 'b94e1ff82eb5781f98296f0af2488ff06202f12ee92b0175963b8dba688d1b40',
+              tx_hash: 'a2059b1321e96a90a386894a68fa5829756118895b3cdb9a0393d94fd2ceed93',
               tx_pos: 0
             }
           }
@@ -100,13 +100,13 @@ describe('#BCH', () => {
       const rpcData = {
         payload: {
           params: {
-            tokenId: 'c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d'
+            tokenId: '5f31905f335fa932879c5aabfd1c14ac748f6696148bd300f845ea5016ad573e'
           }
         }
       }
 
       const result = await uut.getTokenData(rpcData)
-      // console.log('result: ', result)
+      console.log('result: ', result)
 
       // assert.equal(result.isValid, true)
       assert.property(result.tokenData, 'immutableData')

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

@@ -3,11 +3,12 @@
 */
 
 // Global npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
+
+import sinon from 'sinon'
 
 // Local libraries
-const Adapters = require('../../../src/adapters')
+import Adapters from '../../../src/adapters/index.js'
 
 describe('#adapters', () => {
   let uut, sandbox
@@ -26,6 +27,8 @@ describe('#adapters', () => {
     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()

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,20 +2,20 @@
   Unit tests for the IPFS Adapter.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
+import { assert } from 'chai'
 
-const IPFSCoordAdapter = require('../../../src/adapters/ipfs/ipfs-coord')
-const IPFSMock = require('../mocks/ipfs-mock')
-const IPFSCoordMock = require('../mocks/ipfs-coord-mock')
-const config = require('../../../config')
+import sinon from 'sinon'
+import IPFSCoordAdapter from '../../../src/adapters/ipfs/ipfs-coord.js'
+import create from '../mocks/ipfs-mock.js'
+import IPFSCoordMock from '../mocks/ipfs-coord-mock.js'
+import config from '../../../config/index.js'
 
 describe('#IPFS', () => {
   let uut
   let sandbox
 
   beforeEach(() => {
-    const ipfs = IPFSMock.create()
+    const ipfs = create()
     const bchjs = {}
     uut = new IPFSCoordAdapter({ ipfs, bchjs })
 
@@ -40,7 +40,7 @@ describe('#IPFS', () => {
 
     it('should throw an error if bchjs instance is not included', () => {
       try {
-        const ipfs = IPFSMock.create()
+        const ipfs = create()
         uut = new IPFSCoordAdapter({ ipfs })
 
         assert.fail('Unexpected code path')
@@ -67,7 +67,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').resolves('123')
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true
@@ -77,6 +77,21 @@ 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').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.

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

@@ -2,13 +2,13 @@
   Unit tests for the index.js file for the IPFS and ipfs-coord libraries.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-const BCHJS = require('@psf/bch-js')
+import { assert } from 'chai'
+import BCHJS from '@psf/bch-js'
 
-const IPFSLib = require('../../../src/adapters/ipfs')
-const IPFSMock = require('../mocks/ipfs-mock')
-const IPFSCoordMock = require('../mocks/ipfs-coord-mock')
+import sinon from 'sinon'
+import IPFSLib from '../../../src/adapters/ipfs/index.js'
+// import create from '../mocks/ipfs-mock.js'
+import IPFSCoordMock from '../mocks/ipfs-coord-mock.js'
 
 describe('#IPFS-adapter-index', () => {
   let uut
@@ -41,7 +41,9 @@ describe('#IPFS-adapter-index', () => {
 
     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({ bchjs: {} })
@@ -81,4 +83,155 @@ describe('#IPFS-adapter-index', () => {
       }
     })
   })
+
+  describe('#getStatus', () => {
+    it('should return an object with node metrics', () => {
+      // Force uut to have the needed properties
+      uut.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {
+            ipfsId: 'fake-id',
+            ipfsMultiaddrs: [],
+            bchAddr: 'fake-bch-addr',
+            slpAddr: 'fake-slp-addr',
+            pubKey: 'fake-pubkey',
+            peerList: [],
+            relayData: []
+          }
+        }
+      }
+
+      const result = uut.getStatus()
+      // console.log('result: ', result)
+
+      assert.property(result, 'ipfsId')
+      assert.property(result, 'multiAddrs')
+      assert.property(result, 'bchAddr')
+      assert.property(result, 'slpAddr')
+      assert.property(result, 'pubKey')
+      assert.property(result, 'peers')
+      assert.property(result, 'relays')
+    })
+
+    it('should catch, report, and throw errors', () => {
+      try {
+        uut.getStatus()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'Cannot read properties')
+      }
+    })
+  })
+
+  describe('#_removeDuplicatePeers', () => {
+    it('should return the same array when there are no duplicates', () => {
+      const inArray = [
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
+        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
+        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
+        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+      ]
+
+      const result = uut._removeDuplicatePeers(inArray)
+      // console.log('result: ', result)
+
+      assert.equal(result.length, inArray.length)
+    })
+
+    it('should remove duplicates from an array', () => {
+      const inArray = [
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
+        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
+        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
+        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu',
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA'
+      ]
+
+      const result = uut._removeDuplicatePeers(inArray)
+      // console.log('result: ', result)
+
+      assert.equal(result.length, inArray.length - 2)
+    })
+  })
+
+  describe('#getPeers', () => {
+    it('should return an array of current JSON data about each peer when showAll is true', async () => {
+      // Mock dependencies
+      uut.ipfsCoordAdapter.ipfsCoord = {
+        thisNode: {
+          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', protocol: 'test', version: '1' } } }, { from: 'b' }]
+        },
+        adapters: {
+          ipfs: {
+            getPeers: async () => ['a', 'b']
+          }
+        }
+      }
+
+      const result = await uut.getPeers(true)
+
+      assert.isArray(result)
+    })
+
+    it('should catch, report, and throw errors', async () => {
+      try {
+        // Force an error
+        uut.ipfsCoordAdapter.ipfsCoord = {
+          thisNode: {},
+          adapters: {
+            ipfs: {
+              getPeers: async () => { throw new Error('test error') }
+            }
+          }
+        }
+
+        await uut.getPeers()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getRelays', () => {
+    it('should return known relays', () => {
+      uut.ipfsCoordAdapter.ipfsCoord = {
+        thisNode: {
+          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', description: 'test' } } }, { from: 'b' }],
+          relayData: [{ ipfsId: 'c' }, { ipfsId: 'a' }]
+        }
+      }
+
+      const result = uut.getRelays()
+      // console.log('result: ', result)
+
+      assert.isArray(result.v2Relays)
+      assert.equal(result.v2Relays.length, 2)
+      assert.property(result.v2Relays[0], 'name')
+      assert.property(result.v2Relays[0], 'description')
+      assert.property(result.v2Relays[1], 'name')
+      assert.property(result.v2Relays[1], 'description')
+    })
+
+    it('should catch, report, and throw errors', () => {
+      try {
+        // Force an error
+        uut.ipfsCoordAdapter.ipfsCoord = { thisNode: {} }
+
+        uut.getRelays()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'Cannot read')
+      }
+    })
+  })
 })

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

@@ -2,20 +2,29 @@
   Unit tests for the IPFS Adapter.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-const IPFSLib = require('../../../src/adapters/ipfs/ipfs')
-const IPFSMock = require('../mocks/ipfs-mock')
-const config = require('../../../config')
+// Global npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+import cloneDeep from 'lodash.clonedeep'
+import { peerIdFromString } from '@libp2p/peer-id'
+
+// Local libraries
+import IPFSLib from '../../../src/adapters/ipfs/ipfs.js'
+// import create from '../mocks/ipfs-mock.js'
+import config from '../../../config/index.js'
+import createHeliaLib from '../mocks/helia-mock.js'
 
 // config.isProduction =  true;
 describe('#IPFS-adapter', () => {
   let uut
   let sandbox
+  let ipfs
 
   beforeEach(() => {
     uut = new IPFSLib()
 
+    ipfs = cloneDeep(createHeliaLib)
+
     sandbox = sinon.createSandbox()
   })
 
@@ -44,35 +53,28 @@ describe('#IPFS-adapter', () => {
   describe('#start', () => {
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
-      uut.IPFS = IPFSMock
+      sandbox.stub(uut, 'createNode').resolves(ipfs)
+      sandbox.stub(uut, 'publicIp').resolves('192.168.2.4')
+      sandbox.stub(uut, 'multiaddr').returns('/ip4/fake-multiaddr')
 
       const result = await uut.start()
       // console.log('result: ', result)
 
+      // Assert properties of the instance are set.
       assert.equal(uut.isReady, true)
+      assert.property(uut, 'multiaddrs')
+      assert.property(uut, 'id')
 
-      assert.property(result, 'config')
-    })
-
-    it('should return a promise that resolves into an instance of IPFS in production mode.', async () => {
-      // Mock dependencies.
-      uut.IPFS = IPFSMock
-      uut.config.isProduction = true
-      const result = await uut.start()
-      // console.log('result: ', result)
-
-      assert.equal(uut.isReady, true)
-
-      assert.property(result, 'config')
+      // Output should be an instance of IPFS
+      assert.property(result, 'libp2p')
     })
 
     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, 'createNode').rejects(new Error('test error'))
 
         await uut.start()
-
         assert.fail('Unexpected code path.')
       } catch (err) {
         // console.log(err)
@@ -95,24 +97,146 @@ 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('#ensureBlocksDir', () => {
+    it('should create directory if it does not exist', () => {
+      // Force desired code path
+      sandbox.stub(uut.fs, 'existsSync').returns(false)
+      sandbox.stub(uut.fs, 'mkdirSync').returns(true)
+
+      const result = uut.ensureBlocksDir()
+
+      assert.equal(result, true)
+    })
+
+    it('should report and throw errors', () => {
+      // Force an error
+      sandbox.stub(uut.fs, 'existsSync').throws(new Error('test error'))
+
+      try {
+        uut.ensureBlocksDir()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#createNode', () => {
+    it('should report and throw errors', async () => {
+      // Force an error
+      sandbox.stub(uut, 'createLibp2p').rejects(new Error('test error'))
+
+      try {
+        await uut.createNode()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should create an IPFS node from Helia', async () => {
+      uut.config.isCircuitRelay = false
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+
+    it('should create a Circuit Relay if configured', async () => {
+      uut.config.isCircuitRelay = true
+      const result = await uut.createNode()
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+
+    it('should create a new private key on first run', async () => {
+      uut.config.isCircuitRelay = false
+
+      // Mock dependencies and force desired code path.
+      let beenCalled = false
+      sandbox.stub(uut, 'getKeychain').resolves({
+        exportPeerId: async () => {
+          if (!beenCalled) {
+            beenCalled = true
+            throw new Error('test error')
+          }
+          return peerIdFromString('12D3KooWSXF1PnEfiA8bCG8SJduCvzdwHtvhVPK4WC6zzDoto2XP')
+        },
+        createKey: async () => {}
+      })
+      sandbox.stub(uut, 'createLibp2p').resolves()
+      sandbox.stub(uut, 'createHelia').resolves({})
+
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      assert.property(result, 'fs')
+    })
+
+    it('should not use circuit relay when CONNECT_PREF is set to direct', async () => {
+      process.env.CONNECT_PREF = 'direct'
+
+      uut.config.isCircuitRelay = false
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      delete process.env.CONNECT_PREF
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+  })
+
+  describe('#getSeed', () => {
+    it('should read the seed from the JSON file', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.jsonFiles, 'readJSON').resolves('12345678')
+
+      const result = await uut.getSeed()
+      // console.log('result: ', result)
+
+      assert.isString(result)
+    })
+
+    it('should generate a new seed if the JSON file is not found', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.jsonFiles, 'readJSON').rejects(new Error('test error'))
+      sandbox.stub(uut.jsonFiles, 'writeJSON').resolves()
+
+      const result = await uut.getSeed()
+      // console.log('result: ', result)
+
+      assert.isString(result)
+    })
+
+    it('should catch, report, and throw errors', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.jsonFiles, 'readJSON').rejects(new Error('test error'))
+        sandbox.stub(uut.jsonFiles, 'writeJSON').rejects(new Error('test error'))
+
+        await uut.getSeed()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(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

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/wallet.adapter.unit.js

@@ -0,0 +1,344 @@
+/*
+  Unit tests for the Wallet Adapter library.
+*/
+
+// Global npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+import BchWallet from 'minimal-slp-wallet'
+import fs from 'fs'
+
+// Local libraries
+import WalletAdapter from '../../../src/adapters/wallet.adapter.js'
+import { MockBchWallet } from '../mocks/adapters/wallet.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))
+
+// Global constants
+const testWalletFile = `${__dirname.toString()}test-wallet.json`
+
+describe('#wallet', () => {
+  let uut
+  let sandbox
+
+  before(() => {
+    // Delete the test file if it exists.
+    try {
+      deleteFile(testWalletFile)
+    } catch (err) { }
+  })
+
+  beforeEach(() => {
+    uut = new WalletAdapter()
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  after(() => {
+    // Delete the test file if it exists.
+    try {
+      deleteFile(testWalletFile)
+    } catch (err) { }
+  })
+
+  describe('#_instanceWallet', () => {
+    it('should create a wallet given a mnemonic', async () => {
+      const mnemonic = 'wagon tray learn flat erase laugh lonely rug check captain jacket morning'
+      const result = await uut._instanceWallet(mnemonic)
+      // console.log('result: ', result)
+      assert.equal(result.walletInfo.mnemonic, mnemonic)
+    })
+  })
+
+  describe('#openWallet', () => {
+    it('should create a new wallet when wallet file does not exist', async () => {
+      // Mock dependencies
+      uut.BchWallet = MockBchWallet
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const result = await uut.openWallet()
+      // console.log('result: ', result)
+      assert.property(result, 'mnemonic')
+      assert.property(result, 'privateKey')
+      assert.property(result, 'publicKey')
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'address')
+      assert.property(result, 'slpAddress')
+      assert.property(result, 'legacyAddress')
+      assert.property(result, 'hdPath')
+    })
+
+    it('should open existing wallet file', async () => {
+      // This test case uses the file created in the previous test case.
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const result = await uut.openWallet()
+      // console.log('result: ', result)
+      assert.property(result, 'mnemonic')
+      assert.property(result, 'privateKey')
+      assert.property(result, 'publicKey')
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'address')
+      assert.property(result, 'slpAddress')
+      assert.property(result, 'legacyAddress')
+      assert.property(result, 'hdPath')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        uut.config.walletFile = ''
+        uut.BchWallet = () => {
+        }
+        await uut.openWallet()
+        // console.log('result: ', result)
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'this.BchWallet is not a constructor')
+      }
+    })
+  })
+
+  describe('#instanceWalletWithoutInitialization', () => {
+    it('should create an instance of BchWallet', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+      uut.config.authPass = 'fake-auth-pass'
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+
+      // console.log('walletData: ', walletData)
+      const result = await uut.instanceWalletWithoutInitialization(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut, '_instanceWallet').rejects(new Error('test error'))
+
+        await uut.instanceWalletWithoutInitialization()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should create an instance of BchWallet using web2 infra', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      // Force desired code path
+      uut.config.walletInterface = 'web2'
+      const result = await uut.instanceWalletWithoutInitialization(walletData)
+
+      // console.log('result: ', result)
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+
+    it('should generate wallet from mnemonic in config', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      const originalConfig = uut.config.mnemonic
+      uut.config.mnemonic = walletData.mnemonic
+
+      const result = await uut.instanceWalletWithoutInitialization({})
+      // console.log('result: ', result)
+
+      uut.config.mnemonic = originalConfig
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+  })
+
+  describe('#instanceWallet', () => {
+    it('should create an instance of BchWallet', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.WALLET_FILE = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+      const result = await uut.instanceWallet(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut, 'instanceWalletWithoutInitialization').rejects(new Error('test error'))
+
+        await uut.instanceWallet()
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should create an instance of BchWallet using web2 infra', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.WALLET_FILE = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      // Force desired code path
+      uut.config.useFullStackCash = true
+      const result = await uut.instanceWallet(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+  })
+
+  describe('#incrementNextAddress', () => {
+    it('should increment the nextAddress property', async () => {
+      // Ensure we open the test file, not the production wallet file.
+      uut.WALLET_FILE = testWalletFile
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      const result = await uut.incrementNextAddress()
+      assert.equal(result, 2)
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut, 'openWallet').rejects(new Error('test error'))
+        await uut.incrementNextAddress()
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getKeyPair', () => {
+    it('should return an object with a key pair', async () => {
+      // Ensure we open the test file, not the production wallet file.
+      // uut.WALLET_FILE = testWalletFile
+      uut.config.walletFile = testWalletFile
+
+      const result = await uut.getKeyPair()
+      // console.log('result: ', result)
+
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'wif')
+      assert.property(result, 'hdIndex')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut, 'incrementNextAddress')
+          .rejects(new Error('test error'))
+        await uut.getKeyPair()
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#optimize', () => {
+    it('should call the wallet optimize function', async () => {
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      sandbox.stub(uut.bchWallet, 'optimize').resolves({ bchUtxoCnt: 10 })
+      const result = await uut.optimize()
+      assert.equal(result, true)
+    })
+  })
+
+  describe('#getBalance', () => {
+    it('should get the balance for the wallet', async () => {
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.bchWallet, 'getBalance').resolves(41012)
+      sandbox.stub(uut.bchWallet, 'listTokens').resolves([{
+        tokenId: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+        ticker: 'PSF',
+        name: 'Permissionless Software Foundation',
+        decimals: 8,
+        tokenType: 1,
+        url: 'psfoundation.cash',
+        qty: 2
+      }])
+      const result = await uut.getBalance()
+      // console.log('result: ', result)
+      // Assert the expected properties exist and have the expected values.
+      assert.equal(result.satBalance, 41012)
+      assert.equal(result.psfBalance, 2)
+      assert.equal(result.success, true)
+    })
+  })
+})
+
+const deleteFile = (filepath) => {
+  try {
+    // Delete state if exist
+    fs.unlinkSync(filepath)
+  } catch (err) {
+    // console.error('Error trying to delete file: ', err)
+  }
+}

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

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

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/bch.json-rpc.controller.unit.js

@@ -3,20 +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'
+// const { v4: uid } = require('uuid')
+import { v4 as uid } from 'uuid'
+
+// Local libraries
+import BCHRPC from '../../../../src/controllers/json-rpc/bch/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 BCHRPC = require('../../../../src/controllers/json-rpc/bch')
-const RateLimit = require('../../../../src/controllers/json-rpc/rate-limit')
-const adapters = require('../../mocks/adapters')
-const UseCasesMock = require('../../mocks/use-cases')
-
 describe('#BCHRPC', () => {
   let uut
   let sandbox
@@ -118,6 +119,25 @@ describe('#BCHRPC', () => {
       assert.equal(result, true)
     })
 
+    it('should route to the utxosBulk method', async () => {
+      // Mock dependencies
+      sandbox.stub(uut, 'utxosBulk').resolves(true)
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const txCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk'
+      })
+      const jsonStr = JSON.stringify(txCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+      rpcData.from = 'Origin request'
+
+      const result = await uut.bchRouter(rpcData)
+
+      assert.equal(result, true)
+    })
+
     it('should route to the broadcast method', async () => {
       // Mock dependencies
       sandbox.stub(uut, 'broadcast').resolves(true)
@@ -175,6 +195,63 @@ describe('#BCHRPC', () => {
       assert.equal(result, true)
     })
 
+    it('should route to the utxoIsValid method', async () => {
+      // Mock dependencies
+      sandbox.stub(uut, 'utxoIsValid').resolves(true)
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxoIsValid'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+      rpcData.from = 'Origin request'
+
+      const result = await uut.bchRouter(rpcData)
+
+      assert.equal(result, true)
+    })
+
+    it('should route to the getTokenData method', async () => {
+      // Mock dependencies
+      sandbox.stub(uut, 'getTokenData').resolves(true)
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'getTokenData'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+      rpcData.from = 'Origin request'
+
+      const result = await uut.bchRouter(rpcData)
+
+      assert.equal(result, true)
+    })
+
+    it('should route to the getTokenData2 method', async () => {
+      // Mock dependencies
+      sandbox.stub(uut, 'getTokenData2').resolves(true)
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'getTokenData2'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+      rpcData.from = 'Origin request'
+
+      const result = await uut.bchRouter(rpcData)
+
+      assert.equal(result, true)
+    })
+
     it('should return 500 status on routing issue', async () => {
       // Mock dependencies
       sandbox.stub(uut, 'txHistory').rejects(new Error('test error'))
@@ -301,7 +378,7 @@ describe('#BCHRPC', () => {
       const id = uid()
       const rpcCall = jsonrpc.request(id, 'bch', {
         endpoint: 'utxos',
-        addresses: 'testAddr'
+        address: 'testAddr'
       })
       const jsonStr = JSON.stringify(rpcCall, null, 2)
       const rpcData = jsonrpc.parse(jsonStr)
@@ -322,7 +399,7 @@ describe('#BCHRPC', () => {
       const id = uid()
       const rpcCall = jsonrpc.request(id, 'bch', {
         endpoint: 'utxos',
-        addresses: 'testAddr'
+        address: 'testAddr'
       })
       const jsonStr = JSON.stringify(rpcCall, null, 2)
       const rpcData = jsonrpc.parse(jsonStr)
@@ -337,6 +414,98 @@ describe('#BCHRPC', () => {
     })
   })
 
+  describe('#utxosBulk', () => {
+    it('should return UTXO data from bchjs for multiple addresses', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.bchjs.Utxo, 'get').resolves({ success: true })
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: ['testAddr1', 'testAddr2']
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, true)
+      assert.equal(response.status, 200)
+    })
+
+    it('should return an error for invalid address', async () => {
+      // Force an error
+      sandbox.stub(uut.bchjs.Utxo, 'get').rejects(new Error('Invalid address'))
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: ['testAddr1', 'testAddr2']
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'Invalid address')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+
+    it('should throw error if input is not an array', async () => {
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: 'singleAddress'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'addresses parameter must be an array')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+
+    it('should throw error if input array is larger than 20 elements', async () => {
+      // Generate an array larger than 20 elements
+      const inputArray = []
+      for (let i = 0; i < 25; i++) {
+        inputArray.push(i)
+      }
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: inputArray
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'addresses parameter must not exceed 20 elements')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+  })
+
   describe('#broadcast', () => {
     it('should return data from bchjs', async () => {
       // Mock dependencies
@@ -385,6 +554,32 @@ describe('#BCHRPC', () => {
       assert.equal(response.message, 'Invalid data')
       assert.equal(response.endpoint, 'broadcast')
     })
+
+    it('should return an error if full node returns a string error', async () => {
+      // Force an error
+      sandbox
+        .stub(uut.bchjs.RawTransactions, 'sendRawTransaction')
+        // .rejects(new Error('Invalid data'))
+        .rejects({ error: 'Invalid data' })
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'broadcast',
+        hex: 'testHex'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.broadcast(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'Invalid data')
+      assert.equal(response.endpoint, 'broadcast')
+    })
   })
 
   describe('#txData', () => {
@@ -568,7 +763,8 @@ describe('#BCHRPC', () => {
       // Mock dependencies
       sandbox
         .stub(uut.bchjs.Utxo, 'isValid')
-        .rejects(new Error('test error'))
+        // .rejects(new Error('test error'))
+        .rejects({ error: 'test error' })
 
       const rpcData = {
         payload: {
@@ -619,7 +815,8 @@ describe('#BCHRPC', () => {
       // Mock dependencies
       sandbox
         .stub(uut.bchjs.PsfSlpIndexer, 'getTokenData')
-        .rejects(new Error('test error'))
+        // .rejects(new Error('test error'))
+        .rejects({ error: 'test error' })
 
       const rpcData = {
         payload: {
@@ -667,7 +864,8 @@ describe('#BCHRPC', () => {
       // Mock dependencies
       sandbox
         .stub(uut.bchjs.PsfSlpIndexer, 'getTokenData2')
-        .rejects(new Error('test error'))
+        // .rejects(new Error('test error'))
+        .rejects({ error: 'test error' })
 
       const rpcData = {
         payload: {

test/unit/controllers/json-rpc/json-rpc.controller.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/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

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,21 +3,23 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+// const assert = require('chai').assert
+// const sinon = require('sinon')
+import sinon from 'sinon'
+import { assert } from 'chai'
 
 // 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 BCHRESTController = require('../../../../../src/controllers/rest-api/bch/controller')
+import BCHRESTController from '../../../../../src/controllers/rest-api/bch/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('#BCH-REST-Router', () => {
   // const testUser = {}
 

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

@@ -3,15 +3,17 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
+// const assert = require('chai').assert
+// const sinon = require('sinon')
+import sinon from 'sinon'
+import { assert } from 'chai'
 
 // 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,16 +3,16 @@
 */
 
 // 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 () => {
   })

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/ipfs/ipfs.rest.controller.unit.js

@@ -0,0 +1,251 @@
+/*
+  Unit tests for the REST API handler for the /ipfs endpoints.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local libraries
+import IpfsApiController from '../../../../../src/controllers/rest-api/ipfs/controller.js'
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
+import { context as mockContext } from '../../../mocks/ctx-mock.js'
+let uut
+let sandbox
+let ctx
+
+describe('#IPFS REST API', () => {
+  before(async () => {
+  })
+
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+
+    uut = new IpfsApiController({ adapters, useCases })
+
+    sandbox = sinon.createSandbox()
+
+    // Mock the context object.
+    ctx = mockContext()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new IpfsApiController()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating /ipfs REST Controller.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new IpfsApiController({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating /ipfs REST Controller.'
+        )
+      }
+    })
+  })
+
+  describe('#GET /status', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getStatus').rejects(new Error('test error'))
+
+        await uut.getStatus(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getStatus').resolves({ a: 'b' })
+
+      await uut.getStatus(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'status')
+      assert.equal(ctx.body.status.a, 'b')
+    })
+  })
+
+  describe('#POST /peers', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getPeers').rejects(new Error('test error'))
+
+        ctx.request.body = {
+          showAll: true
+        }
+
+        await uut.getPeers(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getPeers').resolves({ a: 'b' })
+
+      ctx.request.body = {
+        showAll: true
+      }
+
+      await uut.getPeers(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'peers')
+      assert.equal(ctx.body.peers.a, 'b')
+    })
+  })
+
+  describe('#POST /relays', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getRelays').rejects(new Error('test error'))
+
+        await uut.getRelays(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getRelays').resolves({ a: 'b' })
+
+      await uut.getRelays(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'relays')
+      assert.equal(ctx.body.relays.a, 'b')
+    })
+  })
+
+  describe('#POST /connect', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').rejects(new Error('test error'))
+
+        ctx.request.body = {
+          multiaddr: '/ip4/161.35.99.207/tcp/4001/p2p/12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+        }
+
+        await uut.connect(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').resolves({ success: true })
+
+      ctx.request.body = {
+        multiaddr: '/ip4/161.35.99.207/tcp/4001/p2p/12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+      }
+
+      await uut.connect(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'success')
+      assert.equal(ctx.body.success, true)
+    })
+  })
+
+  describe('#handleError', () => {
+    it('should still throw error if there is no message', () => {
+      try {
+        const err = {
+          status: 404
+        }
+
+        uut.handleError(ctx, err)
+      } catch (err) {
+        assert.include(err.message, 'Not Found')
+      }
+    })
+
+    it('should throw error with message', () => {
+      try {
+        const err = {
+          status: 422,
+          message: 'test error'
+        }
+
+        uut.handleError(ctx, err)
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getThisNode', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        // sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord, 'thisNode').rejects(new Error('test error'))
+        uut.adapters.ipfs.ipfsCoordAdapter = {}
+
+        ctx.request.body = {}
+
+        await uut.getThisNode(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'Cannot read')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      // sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').resolves({ success: true })
+
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {}
+        }
+      }
+
+      ctx.request.body = {}
+
+      await uut.getThisNode(ctx)
+
+      assert.property(ctx.body, 'thisNode')
+    })
+  })
+})

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

@@ -0,0 +1,78 @@
+/*
+  Unit tests for the REST API handler for the /ipfs endpoints.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local support libraries
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+import IpfsRouter from '../../../../../src/controllers/rest-api/ipfs/index.js'
+// const app = require('../../../mocks/app-mock')
+
+let uut
+let sandbox
+// let ctx
+
+// const mockContext = require('../../../../unit/mocks/ctx-mock').context
+
+describe('#IPFS-REST-Router', () => {
+  // const testUser = {}
+
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+    uut = new IpfsRouter({ adapters, useCases })
+
+    sandbox = sinon.createSandbox()
+
+    // Mock the context object.
+    // ctx = mockContext()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new IpfsRouter()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating IPFS REST Controller.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new IpfsRouter({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating IPFS REST Controller.'
+        )
+      }
+    })
+  })
+
+  describe('#attach', () => {
+    it('should throw an error if app is not passed in.', () => {
+      try {
+        uut.attach()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass app object when attaching REST API controllers.'
+        )
+      }
+    })
+  })
+})

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

@@ -3,16 +3,16 @@
 */
 
 // 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 () => {
   })