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

fix(ipfs-coord): Setting name with an env var

bin/server.js

@@ -29,6 +29,9 @@ async function startServer () {
   // Connect to the Mongo Database.
   mongoose.Promise = global.Promise
   mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+  console.log(
+    `Connecting to MongoDB with this connection string: ${config.database}`
+  )
   await mongoose.connect(config.database, {
     useUnifiedTopology: true,
     useNewUrlParser: true
@@ -54,7 +57,7 @@ async function startServer () {
 
   // Attach REST API and JSON RPC controllers to the app.
   const controllers = require('../src/controllers')
-  controllers.attachControllers(app)
+  await controllers.attachControllers(app)
 
   // Enable CORS for testing
   // THIS IS A SECURITY RISK. COMMENT OUT FOR PRODUCTION
@@ -69,8 +72,14 @@ async function startServer () {
   console.log(`Server started on ${config.port}`)
 
   // Create the system admin user.
-  const success = await adminLib.createSystemUser()
-  if (success) console.log('System admin user created.')
+  try {
+    const success = await adminLib.createSystemUser()
+    if (success) console.log('System admin user created.')
+  } catch (err) {
+    console.warn(
+      'Error trying to create system admin. Perhaps one already exists?'
+    )
+  }
 
   return app
 }

config/env/common.js

@@ -5,6 +5,10 @@
 
 /* eslint  no-unneeded-ternary:0 */
 
+const ipfsCoordName = process.env.COORD_NAME
+  ? process.env.COORD_NAME
+  : 'ipfs-bch-wallet-service'
+
 module.exports = {
   // Configure TCP port.
   port: process.env.PORT || 5001,
@@ -23,17 +27,31 @@ module.exports = {
     ? process.env.EMAILPASS
     : 'emailpassword',
 
+  // FullStack.cash account information, used for automatic JWT handling.
+  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',
+  FULLSTACKPASS: process.env.FULLSTACKPASS ? process.env.FULLSTACKPASS : 'demo',
+
   // IPFS settings.
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
 
   // Information passed to other IPFS peers about this node.
   apiInfo: 'https://ipfs-service-provider.fullstack.cash/',
 
+  ipfsCoordName: ipfsCoordName,
+
   // JSON-LD and Schema.org schema with info about this app.
   announceJsonLd: {
     '@context': 'https://schema.org/',
     '@type': 'WebAPI',
-    name: 'ipfs-bch-wallet-service',
+    name: ipfsCoordName,
     description:
       'IPFS service providing BCH blockchain access needed by a wallet.',
     documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',
@@ -42,5 +60,9 @@ module.exports = {
       name: 'Permissionless Software Foundation',
       url: 'https://PSFoundation.cash'
     }
-  }
+  },
+
+  // 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
 }

config/env/development.js

@@ -7,6 +7,6 @@
 module.exports = {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
-  database: 'mongodb://localhost:27017/ipfs-service-dev',
+  database: 'mongodb://localhost:27017/bch-service-dev',
   env: 'dev'
 }

config/env/production.js

@@ -10,6 +10,8 @@
 module.exports = {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
-  database: 'mongodb://172.17.0.1:5555/ipfs-service-prod',
+  database: process.env.DBURL
+    ? process.env.DBURL
+    : 'mongodb://172.17.0.1:5555/bch-service-prod',
   env: 'prod'
 }

config/env/test.js

@@ -7,6 +7,6 @@
 module.exports = {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
-  database: 'mongodb://localhost:27017/ipfs-service-test',
+  database: 'mongodb://localhost:27017/bch-service-test',
   env: 'test'
 }

docker-compose.yml

@@ -1,25 +0,0 @@
-# Start the testnet server with the command 'docker-compose up -d'
-
-koa-mongodb:
-  image: mongo
-  container_name: mongo-koa
-  ports:
-    - "5555:27017" # <host port>:<container port>
-  volumes:
-    - ./database:/data/db
-  command: mongod --smallfiles --logpath=/dev/null # -- quiet
-  restart: always
-
-koa:
-  build: ./production/
-  dockerfile: Dockerfile
-  container_name: koa
-  links:
-    - koa-mongodb
-  ports:
-    - "5001:5001"  # <host port>:<container port>
-  volumes:
-#    - ./logs:/home/coinjoin/consolidating-coinjoin/logs
-    - ./keys:/home/safeuser/keys
-
-  restart: always

package-lock.json

@@ -13,9 +13,10 @@
         "bcryptjs": "^2.4.3",
         "glob": "^7.1.6",
         "ipfs": "^0.54.4",
-        "ipfs-coord": "^3.2.0",
+        "ipfs-coord": "^4.0.1",
         "jsonrpc-lite": "^2.2.0",
         "jsonwebtoken": "^8.5.1",
+        "jwt-bch-lib": "^1.3.0",
         "kcors": "^2.2.2",
         "koa": "^2.13.1",
         "koa-bodyparser": "^4.3.0",
@@ -108,6 +109,34 @@
         "standard": "^16.0.3"
       }
     },
+    "../ipfs-coord": {
+      "version": "4.0.0",
+      "extraneous": true,
+      "license": "MIT",
+      "dependencies": {
+        "bch-encrypt-lib": "^2.0.0",
+        "orbit-db": "^0.26.1"
+      },
+      "devDependencies": {
+        "@psf/bch-js": "^4.18.0",
+        "apidoc": "^0.25.0",
+        "chai": "^4.2.0",
+        "coveralls": "^3.1.0",
+        "eslint": "7.17.0",
+        "eslint-config-prettier": "^7.1.0",
+        "eslint-config-standard": "^16.0.2",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-prettier": "^3.3.1",
+        "eslint-plugin-standard": "^4.0.0",
+        "husky": "^4.3.6",
+        "lodash.clonedeep": "^4.5.0",
+        "mocha": "^8.2.1",
+        "nyc": "^15.1.0",
+        "semantic-release": "^17.4.2",
+        "sinon": "^9.2.2",
+        "standard": "^16.0.3"
+      }
+    },
     "node_modules/@achingbrain/electron-fetch": {
       "version": "1.7.2",
       "resolved": "https://registry.npmjs.org/@achingbrain/electron-fetch/-/electron-fetch-1.7.2.tgz",
@@ -9768,9 +9797,9 @@
       }
     },
     "node_modules/ipfs-coord": {
-      "version": "3.2.0",
-      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-3.2.0.tgz",
-      "integrity": "sha512-OmAhpoHTmQUxFhR5Z6Cl5SnN/2PrHLD+OtGR6ffyIowMzFeCK9/cmj/0FSOLAtNBEOg0vi4F6lc3HM82cnbhnw==",
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-4.0.1.tgz",
+      "integrity": "sha512-WdqoalO6+I1/8hj5q61bU2gj5EIyc1oltN8EMw4HjrxKpTEK5KccK7FY7CX3mZ3t4029xWchu8aERXQsHIsdyw==",
       "dependencies": {
         "bch-encrypt-lib": "^2.0.0",
         "orbit-db": "^0.26.1"
@@ -13576,6 +13605,14 @@
         "safe-buffer": "^5.0.1"
       }
     },
+    "node_modules/jwt-bch-lib": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/jwt-bch-lib/-/jwt-bch-lib-1.3.0.tgz",
+      "integrity": "sha512-CZs3jUHJlWvConvoTeLDogDEwUysKeojYJxfUhbwJKJrtDCSfi3ZWbsZZ8WN30Xs28aZPDB+qlHPJlTXQmup0w==",
+      "dependencies": {
+        "axios": "^0.21.1"
+      }
+    },
     "node_modules/k-bucket": {
       "version": "5.1.0",
       "resolved": "https://registry.npmjs.org/k-bucket/-/k-bucket-5.1.0.tgz",
@@ -34610,9 +34647,9 @@
       }
     },
     "ipfs-coord": {
-      "version": "3.2.0",
-      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-3.2.0.tgz",
-      "integrity": "sha512-OmAhpoHTmQUxFhR5Z6Cl5SnN/2PrHLD+OtGR6ffyIowMzFeCK9/cmj/0FSOLAtNBEOg0vi4F6lc3HM82cnbhnw==",
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-4.0.1.tgz",
+      "integrity": "sha512-WdqoalO6+I1/8hj5q61bU2gj5EIyc1oltN8EMw4HjrxKpTEK5KccK7FY7CX3mZ3t4029xWchu8aERXQsHIsdyw==",
       "requires": {
         "bch-encrypt-lib": "^2.0.0",
         "orbit-db": "^0.26.1"
@@ -37694,6 +37731,14 @@
         "safe-buffer": "^5.0.1"
       }
     },
+    "jwt-bch-lib": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/jwt-bch-lib/-/jwt-bch-lib-1.3.0.tgz",
+      "integrity": "sha512-CZs3jUHJlWvConvoTeLDogDEwUysKeojYJxfUhbwJKJrtDCSfi3ZWbsZZ8WN30Xs28aZPDB+qlHPJlTXQmup0w==",
+      "requires": {
+        "axios": "^0.21.1"
+      }
+    },
     "k-bucket": {
       "version": "5.1.0",
       "resolved": "https://registry.npmjs.org/k-bucket/-/k-bucket-5.1.0.tgz",

package.json

@@ -8,7 +8,7 @@
     "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:unit": "export SVC_ENV=test && mocha --exit --timeout 15000 --recursive test/unit/",
-    "test:e2e:auto": "export SVC_ENV=test && mocha --exit --timeout 15000 test/e2e/automated/",
+    "test:e2e:auto": "export SVC_ENV=test && mocha --exit --timeout 30000 test/e2e/automated/",
     "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",
@@ -28,9 +28,10 @@
     "bcryptjs": "^2.4.3",
     "glob": "^7.1.6",
     "ipfs": "^0.54.4",
-    "ipfs-coord": "^3.2.0",
+    "ipfs-coord": "^4.0.1",
     "jsonrpc-lite": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
+    "jwt-bch-lib": "^1.3.0",
     "kcors": "^2.2.2",
     "koa": "^2.13.1",
     "koa-bodyparser": "^4.3.0",

production/Dockerfile

@@ -29,13 +29,13 @@ RUN echo 'abcd8765' | sudo -S pwd
 
 # Clone the rest.bitcoin.com repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/koa-api-boilerplate
-RUN mv koa-api-boilerplate koa
-RUN mkdir keys
+RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
+# RUN mv koa-api-boilerplate koa
+# RUN mkdir keys
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
-WORKDIR /home/safeuser/koa
+WORKDIR /home/safeuser/ipfs-bch-wallet-service
 
 # For development: switch to unstable branch
 # RUN git checkout unstable
@@ -46,13 +46,14 @@ RUN npm install
 # Generate the API docs
 RUN npm run docs
 
-VOLUME /home/safeuser/keys
-
-# Expose the port the API will be served on.
-EXPOSE 5001
+# Calling out the directorys that should be mounted as external volumes.
+RUN mkdir /home/safeuser/ipfsdata
+RUN mkdir /home/safeuser/orbitdb
+VOLUME /home/safeuser/ipfsdata
+VOLUME /home/safeuser/orbitdb
 
 # Start the application.
-COPY start-production start-production
-CMD ["./start-production"]
+COPY start-production.sh start-production.sh
+CMD ["./start-production.sh"]
 
 #CMD ["npm", "start"]

production/cleanup-images.sh

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

production/docker-compose.yml

@@ -0,0 +1,28 @@
+# Start the testnet server with the command 'docker-compose up -d'
+
+bch-wallet-mongodb:
+  image: mongo
+  container_name: mongo-bch-service
+  ports:
+    - '5555:27017' # <host port>:<container port>
+  volumes:
+    - ./database:/data/db
+  command: mongod --logpath=/dev/null # -- quiet
+  restart: always
+
+bch-wallet-service:
+  build: ./
+  dockerfile: Dockerfile
+  container_name: bch-wallet-service
+  links:
+    - bch-wallet-mongodb
+  ports:
+    # <host port>:<container port>
+    - '5001:5001' # REST API
+    - '5668:5668' # IPFS TCP Port
+    - '5669:5669' # IPFS WS Port
+  volumes:
+    - ../ipfsdata:/home/safeuser/ipfsdata
+    - ../orbitdb:/home/safeuser/orbitdb
+
+  restart: always

production/start-production

@@ -1,3 +0,0 @@
-#!/bin/bash
-export KOA_ENV=production
-npm start

production/start-production.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Customize these environment variables for your own installation.
+export AUTHSERVER=https://auth.fullstack.cash
+export APISERVER=https://api.fullstack.cash/v5/
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
+
+# Ports
+export PORT=5001 # REST API
+export IPFS_TCP_PORT=5668 # IPSF TCP Port
+export IPFS_WS_PORT=5669 # IPFS WS Port
+
+# Production database connection string.
+export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+
+#export ENABLE_CIRCUIT_RELAY=1
+
+export SVC_ENV=production
+npm start

src/adapters/fullstack-jwt.js

@@ -0,0 +1,107 @@
+/*
+  A library of utility functions for working with FullStack.cash JWT tokens.
+
+  Feel free to copy this library into your own app, as well as the unit tests
+  for this file.
+*/
+
+const JwtLib = require('jwt-bch-lib')
+const BCHJS = require('@psf/bch-js')
+
+class FullStackJWT {
+  constructor (localConfig = {}) {
+    // Input Validation
+    this.authServer = localConfig.authServer
+    if (!this.authServer || typeof this.authServer !== 'string') {
+      throw new Error(
+        'Must pass a url for the AUTH server when instantiating FullStackJWT class.'
+      )
+    }
+    this.apiServer = localConfig.apiServer
+    if (!this.apiServer || typeof this.apiServer !== 'string') {
+      throw new Error(
+        'Must pass a url for the API server when instantiating FullStackJWT class.'
+      )
+    }
+    this.login = localConfig.login
+    if (!this.login || typeof this.login !== 'string') {
+      throw new Error(
+        'Must pass a FullStack.cash login (email) instantiating FullStackJWT class.'
+      )
+    }
+    this.password = localConfig.password
+    if (!this.password || typeof this.password !== 'string') {
+      throw new Error(
+        'Must pass a FullStack.cash account password when instantiating FullStackJWT class.'
+      )
+    }
+
+    // Encapsulate dependencies
+    this.jwtLib = new JwtLib({
+      // Overwrite default values with the values in the config file.
+      server: this.server,
+      login: this.login,
+      password: this.password
+    })
+
+    // State
+    this.apiToken = '' // Default value.
+    this.bchjs = {}
+  }
+
+  // Get's a JWT token from FullStack.cash.
+  async getJWT () {
+    try {
+      // Skip connecting FullStack.cash auth server to the network if this is an E2E test.
+      if (process.env.E2ETEST) {
+        this.apiToken = 'faketoken'
+        return this.apiToken
+      }
+
+      // Log into the auth server.
+      await this.jwtLib.register()
+
+      this.apiToken = this.jwtLib.userData.apiToken
+      if (!this.apiToken) {
+        throw new Error('This account does not have a JWT')
+      }
+      console.log(`Retrieved JWT token: ${this.apiToken}\n`)
+
+      // Ensure the JWT token is valid to use.
+      const isValid = await this.jwtLib.validateApiToken()
+
+      // Get a new token with the same API level, if the existing token is not
+      // valid (probably expired).
+      if (!isValid.isValid) {
+        this.apiToken = await this.jwtLib.getApiToken(
+          this.jwtLib.userData.apiLevel
+        )
+        console.log(
+          `The JWT token was not valid. Retrieved new JWT token: ${this.apiToken}\n`
+        )
+      } else {
+        console.log('JWT token is valid.\n')
+      }
+
+      return this.apiToken
+    } catch (err) {
+      console.error(
+        `Error trying to log into ${this.server} and retrieve JWT token.`
+      )
+      throw err
+    }
+  }
+
+  // Create an instance of bchjs with the validated JWT token. Returns this
+  // instance of bch-js.
+  instanceBchjs () {
+    this.bchjs = new BCHJS({
+      restURL: this.apiServer,
+      apiToken: this.apiToken
+    })
+
+    return this.bchjs
+  }
+}
+
+module.exports = FullStackJWT

src/adapters/index.js

@@ -4,6 +4,9 @@
   https://troutsblog.com/blog/clean-architecture
 */
 
+// Load the config file
+const config = require('../../config')
+
 // Load individual adapter libraries.
 const IPFSAdapter = require('./ipfs')
 const LocalDB = require('./localdb')
@@ -12,6 +15,7 @@ const Passport = require('./passport')
 const Nodemailer = require('./nodemailer')
 const { wlogger } = require('./wlogger')
 const JSONFiles = require('./json-files')
+const FullStackJWT = require('./fullstack-jwt')
 
 // Instantiate adapter libraries.
 const ipfs = new IPFSAdapter()
@@ -21,6 +25,15 @@ const passport = new Passport()
 const nodemailer = new Nodemailer()
 const jsonFiles = new JSONFiles()
 
+// Get a valid JWT API key and instance bch-js.
+const fullStackJwt = new FullStackJWT({
+  authServer: config.AUTHSERVER,
+  apiServer: config.APISERVER,
+  login: config.FULLSTACKLOGIN,
+  password: config.FULLSTACKPASS
+})
+const bchjs = {} // Placeholder.
+
 module.exports = {
   ipfs,
   localdb,
@@ -28,5 +41,7 @@ module.exports = {
   passport,
   nodemailer,
   wlogger,
-  jsonFiles
+  jsonFiles,
+  fullStackJwt,
+  bchjs
 }

src/adapters/ipfs/index.js

@@ -19,8 +19,15 @@ class IPFS {
 
   // Provides a global start() function that triggers the start() function in
   // the underlying libraries.
-  async start () {
+  async start (localConfig = {}) {
     try {
+      const bchjs = localConfig.bchjs
+      if (!bchjs) {
+        throw new Error(
+          'Instance of bch-js must be passed when instantiating IPFS adapter.'
+        )
+      }
+
       // Start IPFS
       await this.ipfsAdapter.start()
       console.log('IPFS is ready.')
@@ -30,7 +37,8 @@ class IPFS {
 
       // Start ipfs-coord
       this.ipfsCoordAdapter = new this.IpfsCoordAdapter({
-        ipfs: this.ipfs
+        ipfs: this.ipfs,
+        bchjs
       })
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')

src/adapters/ipfs/ipfs-coord.js

@@ -6,7 +6,7 @@
 
 // Global npm libraries
 const IpfsCoord = require('ipfs-coord')
-const BCHJS = require('@psf/bch-js')
+// const BCHJS = require('@psf/bch-js')
 
 // Local libraries
 const config = require('../../../config')
@@ -23,11 +23,16 @@ class IpfsCoordAdapter {
         'Instance of IPFS must be passed when instantiating ipfs-coord.'
       )
     }
+    this.bchjs = localConfig.bchjs
+    if (!this.bchjs) {
+      throw new Error(
+        'Instance of bch-js must be passed when instantiating ipfs-coord.'
+      )
+    }
 
     // Encapsulate dependencies
     this.IpfsCoord = IpfsCoord
     this.ipfsCoord = {}
-    this.bchjs = new BCHJS()
     // this.rpc = new JSONRPC()
     this.config = config
 
@@ -37,7 +42,7 @@ class IpfsCoordAdapter {
     _this = this
   }
 
-  async start () {
+  async start (localConfig = {}) {
     this.ipfsCoord = new this.IpfsCoord({
       ipfs: this.ipfs,
       type: 'node.js',
@@ -49,8 +54,12 @@ class IpfsCoordAdapter {
       announceJsonLd: this.config.announceJsonLd
     })
 
-    // Wait for the ipfs-coord library to signal that it is ready.
-    await this.ipfsCoord.isReady()
+    // Skip connecting ipfs-coord to the network if this is an E2E test.
+    if (!process.env.E2ETEST) {
+      // Wait for the ipfs-coord library to signal that it is ready.
+      await this.ipfsCoord.ipfs.start()
+      await this.ipfsCoord.isReady()
+    }
 
     // Signal that this adapter is ready.
     this.isReady = true

src/adapters/ipfs/ipfs.js

@@ -63,6 +63,7 @@ class IpfsAdapter {
 
       // Stop the IPFS node if we're running tests.
       if (this.config.env === 'test') {
+        console.log('Stopping IPFS for tests.')
         await this.ipfs.stop()
       }
 

src/controllers/index.js

@@ -22,13 +22,24 @@ const RESTControllers = require('./rest-api')
 // Top-level function for this library.
 // Start the various Controllers and attach them to the app.
 async function attachControllers (app) {
-  // Attach the REST controllers to the Koa app.
-  attachRESTControllers(app)
+  try {
+    // 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 adapters.fullStackJwt.getJWT()
+    // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
+    adapters.bchjs = await adapters.fullStackJwt.instanceBchjs()
 
-  // Start IPFS.
-  await adapters.ipfs.start()
+    // Attach the REST controllers to the Koa app.
+    attachRESTControllers(app)
 
-  attachRPCControllers()
+    // Start IPFS.
+    await adapters.ipfs.start({ bchjs: adapters.bchjs })
+
+    attachRPCControllers()
+  } catch (err) {
+    console.error('Error in attachControllers()')
+    throw err
+  }
 }
 
 function attachRESTControllers (app) {

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

@@ -4,7 +4,7 @@
 
 // Public npm libraries
 const jsonrpc = require('jsonrpc-lite')
-const BCHJS = require('@psf/bch-js')
+// const BCHJS = require('@psf/bch-js')
 
 // Local libraries
 // const UserLib = require('../../../use-cases/user')
@@ -32,7 +32,8 @@ class BCHRPC {
     this.jsonrpc = jsonrpc
     this.validators = new Validators(localConfig)
     this.rateLimit = new RateLimit()
-    this.bchjs = new BCHJS()
+    // this.bchjs = new BCHJS()
+    this.bchjs = this.adapters.bchjs
   }
 
   // Top-level router for this library. All other methods in this class are for

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

@@ -2,7 +2,7 @@
   Controller for the /fulcrum REST API endpoints.
 */
 
-const BCHJS = require('@psf/bch-js')
+// const BCHJS = require('@psf/bch-js')
 
 let _this
 
@@ -22,7 +22,8 @@ class BCHRESTController {
       )
     }
 
-    this.bchjs = new BCHJS()
+    // this.bchjs = new BCHJS()
+    this.bchjs = this.adapters.bchjs
 
     _this = this
   }

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

@@ -22,25 +22,31 @@ const LOCALHOST = `http://localhost:${config.port}`
 
 describe('Auth', () => {
   before(async () => {
-    // This should be the first instruction. It starts the REST API server.
-    await app.startServer()
+    try {
+      process.env.E2ETEST = 'true'
 
-    // Delete all previous users in the database.
-    await testUtils.deleteAllUsers()
+      // This should be the first instruction. It starts the REST API server.
+      await app.startServer()
 
-    // Create a new admin user.
-    await adminLib.createSystemUser()
+      // Delete all previous users in the database.
+      await testUtils.deleteAllUsers()
 
-    const userObj = {
-      email: 'test@test.com',
-      password: 'pass',
-      name: 'test'
+      // Create a new admin user.
+      await adminLib.createSystemUser()
+
+      const userObj = {
+        email: 'test@test.com',
+        password: 'pass',
+        name: 'test'
+      }
+      const testUser = await testUtils.createUser(userObj)
+      // console.log('TestUser: ', testUser)
+
+      context.user = testUser.user
+      context.token = testUser.token
+    } catch (err) {
+      console.log('err in auth beforeAll: ', err)
     }
-    const testUser = await testUtils.createUser(userObj)
-    // console.log('TestUser: ', testUser)
-
-    context.user = testUser.user
-    context.token = testUser.token
   })
 
   describe('POST /auth', () => {

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

@@ -0,0 +1,162 @@
+/*
+  Unit tests for the jwt-bch-lib and fullstack-jwt.js adapter library.
+
+*/
+
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+const FullStackJWT = require('../../../src/adapters/fullstack-jwt')
+
+describe('#FullStackJWT', () => {
+  let sandbox
+  let uut
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+
+    const localConfig = {
+      authServer: 'someserver',
+      apiServer: 'someserver',
+      login: 'somelogin',
+      password: 'somepassword'
+    }
+    uut = new FullStackJWT(localConfig)
+  })
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if auth server is not specified', () => {
+      try {
+        uut = new FullStackJWT()
+
+        assert.fail('Unexpected code path')
+        console.log(uut) // For linting.
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass a url for the AUTH server when instantiating FullStackJWT class.'
+        )
+      }
+    })
+
+    it('should throw an error if api server is not specified', () => {
+      try {
+        const localConfig = {
+          authServer: 'someserver'
+        }
+
+        uut = new FullStackJWT(localConfig)
+
+        assert.fail('Unexpected code path')
+        console.log(uut) // For linting.
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass a url for the API server when instantiating FullStackJWT class.'
+        )
+      }
+    })
+
+    it('should throw an error if login is not specified', () => {
+      try {
+        const localConfig = {
+          authServer: 'someserver',
+          apiServer: 'someserver'
+        }
+        uut = new FullStackJWT(localConfig)
+
+        assert.fail('Unexpected code path')
+        console.log(uut) // For linting.
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass a FullStack.cash login (email) instantiating FullStackJWT class.'
+        )
+      }
+    })
+
+    it('should throw an error if login is not specified', () => {
+      try {
+        const localConfig = {
+          authServer: 'someserver',
+          apiServer: 'someserver',
+          login: 'somelogin'
+        }
+        uut = new FullStackJWT(localConfig)
+
+        assert.fail('Unexpected code path')
+        console.log(uut) // For linting.
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass a FullStack.cash account password when instantiating FullStackJWT class.'
+        )
+      }
+    })
+  })
+
+  describe('#getJWT', () => {
+    it('should return the JWT token', async () => {
+      // Mock dependencies to force a code path.
+      sandbox.stub(uut.jwtLib, 'register').resolves({})
+      uut.jwtLib.userData.apiToken = 'abc123'
+      sandbox.stub(uut.jwtLib, 'validateApiToken').resolves({ isValid: true })
+
+      const result = await uut.getJWT()
+      // console.log('result: ', result)
+
+      assert.equal(result, 'abc123')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.jwtLib, 'register').rejects(new Error('test error'))
+
+        await uut.getJWT()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should throw an error if user does not have a JWT', async () => {
+      try {
+        // Mock dependencies to force a code path.
+        sandbox.stub(uut.jwtLib, 'register').resolves({})
+
+        await uut.getJWT()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'This account does not have a JWT')
+      }
+    })
+
+    it('should retrieve a new JWT token if the old one invalid', async () => {
+      // Mock dependencies to force a code path.
+      sandbox.stub(uut.jwtLib, 'register').resolves({})
+      uut.jwtLib.userData.apiToken = 'abc123'
+      uut.jwtLib.userData.apiLevel = 30
+      sandbox.stub(uut.jwtLib, 'validateApiToken').resolves({ isValid: false })
+      sandbox.stub(uut.jwtLib, 'getApiToken').resolves('xyz789')
+
+      const result = await uut.getJWT()
+      // console.log('result: ', result)
+
+      assert.equal(result, 'xyz789')
+    })
+  })
+
+  describe('#instanceBchjs', () => {
+    it('should return an instance of bch-js', () => {
+      const result = uut.instanceBchjs()
+      // console.log('result: ', result)
+
+      assert.property(result, 'restURL')
+    })
+  })
+})

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

@@ -15,7 +15,8 @@ describe('#IPFS', () => {
 
   beforeEach(() => {
     const ipfs = IPFSMock.create()
-    uut = new IPFSCoordAdapter({ ipfs })
+    const bchjs = {}
+    uut = new IPFSCoordAdapter({ ipfs, bchjs })
 
     sandbox = sinon.createSandbox()
   })
@@ -35,6 +36,20 @@ describe('#IPFS', () => {
         )
       }
     })
+
+    it('should throw an error if bchjs instance is not included', () => {
+      try {
+        const ipfs = IPFSMock.create()
+        uut = new IPFSCoordAdapter({ ipfs })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of bch-js must be passed when instantiating ipfs-coord.'
+        )
+      }
+    })
   })
 
   describe('#start', () => {

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

@@ -22,12 +22,26 @@ describe('#IPFS-adapter-index', () => {
   afterEach(() => sandbox.restore())
 
   describe('#start', () => {
+    it('should throw error if bch-js is not passed', async () => {
+      try {
+        await uut.start()
+
+        assert.fail('Unexpected code path.')
+      } catch (err) {
+        // console.log(err)
+        assert.include(
+          err.message,
+          'Instance of bch-js must be passed when instantiating IPFS adapter.'
+        )
+      }
+    })
+
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
       uut.ipfsAdapter = new IPFSMock()
       uut.IpfsCoordAdapter = IPFSCoordMock
 
-      const result = await uut.start()
+      const result = await uut.start({ bchjs: {} })
 
       assert.equal(result, true)
     })
@@ -37,7 +51,7 @@ describe('#IPFS-adapter-index', () => {
         // Force an error
         sandbox.stub(uut.ipfsAdapter, 'start').rejects(new Error('test error'))
 
-        await uut.start()
+        await uut.start({ bchjs: {} })
 
         assert.fail('Unexpected code path.')
       } catch (err) {

test/unit/controllers/controllers.unit.js

@@ -3,7 +3,7 @@
 */
 
 // Public npm libraries
-// const assert = require('chai').assert
+const assert = require('chai').assert
 const sinon = require('sinon')
 
 const adapters = require('../../../src/adapters')
@@ -23,6 +23,8 @@ describe('#Controllers', () => {
     it('should attach the controllers', async () => {
       // mock IPFS
       sandbox.stub(adapters.ipfs, 'start').resolves({})
+      sandbox.stub(adapters.fullStackJwt, 'getJWT').resolves({})
+      sandbox.stub(adapters.fullStackJwt, 'instanceBchjs').resolves({})
       adapters.ipfs.ipfsCoordAdapter = {
         attachRPCRouter: () => {}
       }
@@ -33,5 +35,19 @@ describe('#Controllers', () => {
 
       await attachControllers(app)
     })
+
+    it('should catch and throw errors', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(adapters.fullStackJwt, 'getJWT')
+          .rejects(new Error('test error'))
+
+        await attachControllers()
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'test error')
+      }
+    })
   })
 })

test/unit/mocks/adapters/index.js

@@ -47,4 +47,20 @@ const localdb = {
   }
 }
 
-module.exports = { ipfs, localdb }
+const bchjs = {
+  Electrumx: {
+    transactions: () => {},
+    balance: () => {}
+  },
+  Utxo: {
+    get: () => {}
+  },
+  Transaction: {
+    get: () => {}
+  },
+  RawTransactions: {
+    sendRawTransaction: () => {}
+  }
+}
+
+module.exports = { ipfs, localdb, bchjs }

test/unit/mocks/ipfs-coord-mock.js

@@ -3,6 +3,12 @@
 */
 
 class IPFSCoord {
+  constructor () {
+    this.ipfs = {
+      async start () {}
+    }
+  }
+
   async isReady () {
     return true
   }