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

feat(utxoBulk): Adding REST API endpoint for UTXO bulk queries

LICENSE.md

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

README.md

@@ -72,6 +72,8 @@ API documentation is written inline and generated by [apidoc](http://apidocjs.co
 
 Visit `http://localhost:5000/docs/` to view docs
 
+There is additional developer documentation in the [dev-docs directory](./dev-docs).
+
 ## Dependencies
 
 - [koa2](https://github.com/koajs/koa/tree/v2.x)
@@ -95,5 +97,3 @@ Snapshots pinned to IPFS will be listed here.
 ## License
 
 [MIT](./LICENSE.md)
-
-test

bin/server.js

@@ -24,31 +24,37 @@ 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')
 
 class Server {
   constructor () {
+    // Encapsulate dependencies
     this.adminLib = new AdminLib()
+    this.controllers = new Controllers()
+    this.mongoose = mongoose
+    this.config = config
+    this.process = process
   }
 
   async startServer () {
     try {
       // Create a Koa instance.
       const app = new Koa()
-      app.keys = [config.session]
+      app.keys = [this.config.session]
 
       // Connect to the Mongo Database.
-      mongoose.Promise = global.Promise
-      mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+      this.mongoose.Promise = global.Promise
+      this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
       console.log(
-        `Connecting to MongoDB with this connection string: ${config.database}`
+        `Connecting to MongoDB with this connection string: ${this.config.database}`
       )
-      await mongoose.connect(config.database, {
+      await this.mongoose.connect(this.config.database, {
         useUnifiedTopology: true,
         useNewUrlParser: true
       })
 
-      console.log(`Starting environment: ${config.env}`)
-      console.log(`Debug level: ${config.debugLevel}`)
+      console.log(`Starting environment: ${this.config.env}`)
+      console.log(`Debug level: ${this.config.debugLevel}`)
 
       // MIDDLEWARE START
 
@@ -73,20 +79,24 @@ class Server {
       // Dev Note: This line must come BEFORE controllers.attachRESTControllers()
       app.use(cors({ origin: '*' }))
 
-      // Attach REST API and JSON RPC controllers to the app.
-      const Controllers = require('../src/controllers')
-      const controllers = new Controllers()
-      await controllers.attachRESTControllers(app)
+      // Wait for any adapters to initialize.
+      await this.controllers.initAdapters()
 
-      app.controllers = controllers
+      // Wait for any use-libraries to initialize.
+      await this.controllers.initUseCases()
+
+      // Attach REST API and JSON RPC controllers to the app.
+      await this.controllers.attachRESTControllers(app)
+
+      app.controllers = this.controllers
 
       // MIDDLEWARE END
 
-      console.log(`Running server in environment: ${config.env}`)
-      wlogger.info(`Running server in environment: ${config.env}`)
+      console.log(`Running server in environment: ${this.config.env}`)
+      wlogger.info(`Running server in environment: ${this.config.env}`)
 
-      await app.listen(config.port)
-      console.log(`Server started on ${config.port}`)
+      this.server = await app.listen(this.config.port)
+      console.log(`Server started on ${this.config.port}`)
 
       // Create the system admin user.
       const success = await this.adminLib.createSystemUser()
@@ -94,10 +104,16 @@ class Server {
 
       // Attach the other IPFS controllers.
       // Skip if this is a test environment.
-      if (config.env !== 'test') {
-        await controllers.attachControllers(app)
+      if (this.config.env !== 'test') {
+        await this.controllers.attachControllers(app)
       }
 
+      // Display configuration settings
+      console.log('\nConfiguration:')
+      console.log(`Circuit Relay: ${this.config.isCircuitRelay}`)
+      console.log(`IPFS TCP port: ${this.config.ipfsTcpPort}`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}\n`)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)
@@ -105,14 +121,14 @@ class Server {
       console.log(
         'Exiting after 5 seconds. Depending on process manager to restart.'
       )
-      await sleep(5000)
-      process.exit(1)
+      await this.sleep(5000)
+      this.process.exit(1)
     }
   }
+
+  sleep (ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms))
+  }
 }
 
-function sleep (ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
 module.exports = Server

config/env/common.js

@@ -98,5 +98,7 @@ module.exports = {
   ipfsHost: process.env.IPFS_HOST ? process.env.IPFS_HOST : 'localhost',
   ipfsApiPort: process.env.IPFS_API_PORT
     ? parseInt(process.env.IPFS_API_PORT)
-    : 5001
+    : 5001,
+
+  chatPubSubChan: 'psf-ipfs-chat-001'
 }

dev-docs/README.md

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

package.json

@@ -23,12 +23,12 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-consumer",
   "dependencies": {
-    "@psf/bch-js": "6.4.1",
-    "axios": "0.25.0",
+    "@psf/bch-js": "6.6.0",
+    "axios": "0.27.2",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
-    "ipfs": "0.60.0",
-    "ipfs-coord": "7.1.6",
+    "ipfs": "0.62.3",
+    "ipfs-coord": "8.0.5",
     "ipfs-http-client": "55.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
@@ -45,17 +45,17 @@
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
     "line-reader": "0.4.0",
-    "mongoose": "5.11.15",
+    "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
-    "nodemailer": "6.4.17",
+    "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
     "public-ip": "4.0.4",
-    "semver": "^7.3.5",
+    "semver": "7.3.5",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "0.26.0",
+    "apidoc": "0.51.1",
     "chai": "4.3.0",
     "coveralls": "3.1.0",
     "eslint": "7.19.0",
@@ -65,10 +65,10 @@
     "eslint-plugin-prettier": "3.3.1",
     "eslint-plugin-standard": "4.0.0",
     "husky": "4.3.8",
-    "lodash.clonedeep": "^4.5.0",
-    "mocha": "8.2.1",
+    "lodash.clonedeep": "4.5.0",
+    "mocha": "10.0.0",
     "nyc": "15.1.0",
-    "semantic-release": "17.4.4",
+    "semantic-release": "19.0.3",
     "sinon": "9.2.4",
     "standard": "16.0.3",
     "uuid": "8.3.2"

production/docker/docker-compose.yml

@@ -4,7 +4,7 @@ version: '3.9'
 
 services:
   mongo-bch-consumer:
-    image: mongo
+    image: mongo:4.2.0
     container_name: mongo-bch-consumer
     ports:
       - '5555:27017' # <host port>:<container port>
@@ -14,7 +14,7 @@ services:
     restart: always
 
   ipfs-bch-consumer:
-    image: ipfs/go-ipfs:v0.12.0
+    image: ipfs/go-ipfs:v0.14.0
     container_name: ipfs-bch-consumer
     environment:
       MY_ENV_VAR: 'placeholder'
@@ -26,11 +26,12 @@ services:
     mem_limit: 2000mb
     ports:
       - 4001:4001
+      - 4003:4003
       - 172.17.0.1:5001:5001
       - 172.17.0.1:8080:8080
     volumes:
       - ../data/go-ipfs/data:/data/ipfs
-      - ../../swarm.key:/data/ipfs/swarm.key
+    #  - ../../swarm.key:/data/ipfs/swarm.key
     # https://docs.docker.com/compose/compose-file/compose-file-v3/#command
     # https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
     command:
@@ -43,8 +44,8 @@ services:
     restart: always
 
   bch-consumer:
-    build: .
-    #image: christroutner/ipfs-bch-wallet-consumer:v1.8.0
+    #build: .
+    image: christroutner/ipfs-bch-wallet-consumer:v1.8.4
     container_name: bch-consumer
     logging:
       driver: 'json-file'

production/docker/start-production.sh

@@ -33,6 +33,6 @@ export CONSUMER_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4001
-#export IPFS_WS_PORT=5269
+export IPFS_WS_PORT=4003
 
 npm start

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

@@ -28,4 +28,9 @@ export IPFS_TCP_PORT=4001
 # MongoDB connection string.
 export DBURL=mongodb://localhost:27017/ipfs-service-dev
 
+export CONSUMER_ENV=production
+
+# Lock the consumer into a preferred service provider.
+#export PREFERRED_PROVIDER=12D3KooWEzE3HNH86WCb2Xocu6PgBCnSGUD7myJmuTHvoedMwp7K
+
 npm start

src/adapters/bch/index.js

@@ -208,6 +208,58 @@ class BchAdapter {
     }
   }
 
+  // Query the UTXOs associated with an array of up to 20 addresses.
+  async getUtxosBulk (addrs) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      // Input validation
+      if (!Array.isArray(addrs)) {
+        throw new Error('addresses parameter must be an array')
+      }
+      if (addrs.length > 20) {
+        throw new Error('addresses parameter must not exceed 20 elements')
+      }
+
+      const rpcData = {
+        endpoint: 'utxosBulk',
+        address: addrs
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      // console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      return data
+    } catch (err) {
+      // console.log('createUser() error: ', err)
+      wlogger.error('Error in use-cases/bch.js/getUtxosBulk()')
+      throw err
+    }
+  }
+
   async broadcast (hex) {
     try {
       // Throw an error if this IPFS node has not yet made a connection to a
@@ -429,7 +481,7 @@ class BchAdapter {
     }
   }
 
-  async getTokenData (tokenId) {
+  async getTokenData (tokenId, withTxHistory = false) {
     try {
       // Throw an error if this IPFS node has not yet made a connection to a
       // wallet service provider.
@@ -441,7 +493,8 @@ class BchAdapter {
 
       const rpcData = {
         endpoint: 'getTokenData',
-        tokenId
+        tokenId,
+        withTxHistory
       }
 
       // Generate a UUID for the call.
@@ -471,6 +524,50 @@ class BchAdapter {
     }
   }
 
+  // Get token icon and other media associated with the token.
+  async getTokenData2 (tokenId, updateCache) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      const rpcData = {
+        endpoint: 'getTokenData2',
+        tokenId,
+        updateCache
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.log('getTokenData2() error: ', err)
+      wlogger.error('Error in adapters/bch.js/getTokenData2()')
+      throw err
+    }
+  }
+
   // Returns a promise that resolves to data when the RPC response is recieved.
   async waitForRPCResponse (rpcId) {
     try {

src/adapters/index.js

@@ -59,7 +59,14 @@ class Adapters {
       }
 
       // Start the IPFS node.
-      await this.ipfs.start()
+      // Do not start these adapters if this is an e2e test.
+      if (this.config.env !== 'test') {
+        await this.ipfs.start()
+      }
+
+      console.log('Async Adapters have been started.')
+
+      return true
     } catch (err) {
       console.error('Error in adapters/index.js/start()')
       throw err

src/adapters/ipfs/index.js

@@ -2,8 +2,10 @@
   top-level IPFS library that combines the individual IPFS-based libraries.
 */
 
+// Local libraries
 const IpfsAdapter = require('./ipfs')
 const IpfsCoordAdapter = require('./ipfs-coord')
+const config = require('../../../config')
 
 class IPFS {
   constructor (localConfig = {}) {
@@ -19,6 +21,7 @@ class IPFS {
     this.ipfsAdapter = new IpfsAdapter()
     this.IpfsCoordAdapter = IpfsCoordAdapter
     this.process = process
+    this.config = config
 
     this.ipfsCoordAdapter = {} // placeholder
 
@@ -39,12 +42,16 @@ class IPFS {
 
       // Start ipfs-coord
       this.ipfsCoordAdapter = new this.IpfsCoordAdapter({
-        ipfs: this.ipfs
-        // eventEmitter: this.eventEmitter
+        ipfs: this.ipfs,
+        tcpPort: this.config.ipfsTcpPort,
+        wsPort: this.config.ipfsWsPort
       })
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')
 
+      // Subscribe to the chat pubsub channel
+      await this.ipfsCoordAdapter.subscribeToChat()
+
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')

src/adapters/ipfs/ipfs-coord.js

@@ -301,6 +301,15 @@ class IpfsCoordAdapter {
   //     // Do not throw error. This is a top-level function.
   //   }
   // }
+
+  // Subscribe to the chat pubsub channel
+  async subscribeToChat () {
+    await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
+      this.config.chatPubSubChan,
+      console.log,
+      this.ipfsCoord.thisNode
+    )
+  }
 }
 
 module.exports = IpfsCoordAdapter

src/adapters/logapi.js

@@ -135,8 +135,10 @@ class LogsApi {
         if (!filename || typeof filename !== 'string') {
           throw new Error('filename must be a string')
         }
-        // Throw an error if the file does not exist.
 
+        console.log('readLines() filename: ', filename)
+
+        // Throw an error if the file does not exist.
         if (!_this.fs.existsSync(filename)) {
           throw new Error('file does not exist')
         }

src/controllers/index.js

@@ -29,17 +29,14 @@ class Controllers {
     this.useCases = new UseCases(localConfig)
   }
 
-  async attachControllers (app) {
-    // Skip in a test environment.
-    if (this.config.env !== 'test') {
-      // Wait for any startup processes to complete for the Adapters libraries.
-      await this.adapters.start()
+  // Spin up any adapter libraries that have async startup needs.
+  async initAdapters () {
+    await this.adapters.start()
+  }
 
-      // Attach the REST controllers to the Koa app.
-      // this.attachRESTControllers(app)
-
-      this.attachRPCControllers()
-    }
+  // Run any Use Cases to startup the app.
+  async initUseCases () {
+    await this.useCases.start()
   }
 
   // Top-level function for this library.
@@ -54,6 +51,17 @@ class Controllers {
     restControllers.attachRESTControllers(app)
   }
 
+  // Attach any other controllers other than REST API controllers.
+  async attachControllers (app) {
+    // Wait for any startup processes to complete for the Adapters libraries.
+    // await this.adapters.start()
+
+    // Attach the REST controllers to the Koa app.
+    // this.attachRESTControllers(app)
+
+    this.attachRPCControllers()
+  }
+
   // Add the JSON RPC router to the ipfs-coord adapter.
   attachRPCControllers () {
     const jsonRpcController = new JSONRPC({

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

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

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

@@ -55,12 +55,14 @@ class BchRouter {
     this.router.post('/provider', this.postProvider)
     this.router.post('/balance', this.postBalance)
     this.router.post('/utxos', this.postUtxos)
+    this.router.post('/utxosBulk', this.postUtxosBulk)
     this.router.post('/broadcast', this.postBroadcast)
     this.router.post('/txHistory', this.postTxHistory)
     this.router.post('/txData', this.postTxData)
     this.router.post('/pubkey', this.postPubKey)
     this.router.post('/utxoIsValid', this.utxoIsValid)
     this.router.post('/getTokenData', this.getTokenData)
+    this.router.post('/getTokenData2', this.getTokenData2)
 
     // Attach the Controller routes to the Koa app.
     app.use(this.router.routes())
@@ -83,6 +85,10 @@ class BchRouter {
     await _this.bchRESTController.utxos(ctx, next)
   }
 
+  async postUtxosBulk (ctx, next) {
+    await _this.bchRESTController.utxosBulk(ctx, next)
+  }
+
   async postBroadcast (ctx, next) {
     await _this.bchRESTController.broadcast(ctx, next)
   }
@@ -106,6 +112,10 @@ class BchRouter {
   async getTokenData (ctx, next) {
     await _this.bchRESTController.getTokenData(ctx, next)
   }
+
+  async getTokenData2 (ctx, next) {
+    await _this.bchRESTController.getTokenData2(ctx, next)
+  }
 }
 
 module.exports = BchRouter

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

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

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

@@ -52,6 +52,7 @@ class PriceRouter {
 
     // Define the routes and attach the controller.
     this.router.get('/usd', this.getPrice)
+    this.router.get('/xecusd', this.getXecPrice)
 
     // Attach the Controller routes to the Koa app.
     app.use(this.router.routes())
@@ -61,6 +62,10 @@ class PriceRouter {
   async getPrice (ctx, next) {
     await _this.priceRESTController.getUSD(ctx, next)
   }
+
+  async getXecPrice (ctx, next) {
+    await _this.priceRESTController.getXecPrice(ctx, next)
+  }
 }
 
 module.exports = PriceRouter

src/use-cases/index.js

@@ -24,6 +24,19 @@ class UseCases {
     // console.log('use-cases/index.js localConfig: ', localConfig)
     this.user = new UserUseCases(localConfig)
   }
+
+  // Run any startup Use Cases at the start of the app.
+  async start () {
+    // try {
+    console.log('Async Use Cases have been started.')
+
+    return true
+    // } catch (err) {
+    //   console.error('Error in use-cases/index.js/start()')
+    //   // console.log(err)
+    //   throw err
+    // }
+  }
 }
 
 module.exports = UseCases

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

@@ -7,6 +7,7 @@
 // Public npm libraries
 const assert = require('chai').assert
 const axios = require('axios').default
+// const sinon = require('sinon')
 
 // Local support libraries
 const config = require('../../../config')

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

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

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

@@ -165,6 +165,82 @@ describe('#bch-use-case', () => {
     })
   })
 
+  describe('#getUtxos', () => {
+    it('should get the UTXOs of an address', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const addr = 'addr'
+
+      const result = await uut.getUtxos(addr)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getUtxos()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getUtxosBulk', () => {
+    it('should get the UTXOs of an address', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const addrs = ['addr']
+
+      const result = await uut.getUtxosBulk(addrs)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should throw an error if addresses is not an array', async () => {
+      try {
+        await uut.getUtxosBulk()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'addresses parameter must be an array')
+      }
+    })
+
+    it('should throw an error if addresses array is larger than 20 elements', async () => {
+      try {
+        const addrs = []
+        for (let i = 0; i < 25; i++) {
+          addrs.push(i)
+        }
+
+        await uut.getUtxosBulk(addrs)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'addresses parameter must not exceed 20 elements')
+      }
+    })
+  })
+
   describe('#broadcast', () => {
     it('should broadcast a transaction', async () => {
       // Force connection to a wallet service
@@ -344,4 +420,34 @@ describe('#bch-use-case', () => {
       }
     })
   })
+
+  describe('#getTokenData2', () => {
+    it('should validate a utxo', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const tokenId = 'blah'
+
+      const result = await uut.getTokenData2(tokenId)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getTokenData2()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
 })

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

@@ -180,4 +180,20 @@ describe('#IPFS', () => {
   //     assert.isOk(true, 'Not throwing an error is a success.')
   //   })
   // })
+
+  describe('#subscribeToChat', () => {
+    it('should subscribe to the chat channel', async () => {
+      // Mock dependencies
+      uut.ipfsCoord = {
+        adapters: {
+          pubsub: {
+            subscribeToPubsubChannel: async () => {
+            }
+          }
+        }
+      }
+
+      await uut.subscribeToChat()
+    })
+  })
 })

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

@@ -32,19 +32,18 @@ describe('#LogsApiLib', () => {
     })
 
     it('should return log', async () => {
-      try {
-        const pass = 'test'
-        const result = await uut.getLogs(pass)
-        // console.log('result', result)
+      // Mock dependencies
+      sandbox.stub(uut, 'generateFileName').returns(`${__dirname.toString()}/../mocks/adapters/fake-log`)
 
-        assert.isTrue(result.success)
-        assert.isArray(result.data)
-        assert.property(result.data[0], 'message')
-        assert.property(result.data[0], 'level')
-        assert.property(result.data[0], 'timestamp')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
+      const pass = 'test'
+      const result = await uut.getLogs(pass)
+      // console.log('result', result)
+
+      assert.isTrue(result.success)
+      assert.isArray(result.data)
+      assert.property(result.data[0], 'message')
+      assert.property(result.data[0], 'level')
+      assert.property(result.data[0], 'timestamp')
     })
 
     it('should return false if files are not found!', async () => {
@@ -201,31 +200,25 @@ describe('#LogsApiLib', () => {
     })
 
     it('should ignore fileReader callback errors', async () => {
-      try {
-        // https://sinonjs.org/releases/latest/stubs/
-        // About yields
-        sandbox.stub(uut.lineReader, 'eachLine').yieldsRight({}, true)
+      // https://sinonjs.org/releases/latest/stubs/
+      // About yields
+      sandbox.stub(uut.lineReader, 'eachLine').yieldsRight({}, true)
 
-        const fileName = context.fileName
-        const result = await uut.readLines(fileName)
-        assert.isArray(result)
-      } catch (err) {
-        assert.fail('Unexpected result')
-      }
+      const fileName = `${__dirname.toString()}/../mocks/adapters/fake-log`
+
+      const result = await uut.readLines(fileName)
+      assert.isArray(result)
     })
 
     it('should return data', async () => {
-      try {
-        const fileName = context.fileName
-        const result = await uut.readLines(fileName)
+      const fileName = `${__dirname.toString()}/../mocks/adapters/fake-log`
 
-        assert.isArray(result)
-        assert.property(result[1], 'message')
-        assert.property(result[1], 'level')
-        assert.property(result[1], 'timestamp')
-      } catch (err) {
-        assert.fail('Unexpected result')
-      }
+      const result = await uut.readLines(fileName)
+
+      assert.isArray(result)
+      assert.property(result[1], 'message')
+      assert.property(result[1], 'level')
+      assert.property(result[1], 'timestamp')
     })
   })
 })

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

@@ -177,6 +177,42 @@ describe('#BCH-REST-Controller', () => {
     })
   })
 
+  describe('#utxosBulk', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'getUtxosBulk')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          address: 'blah'
+        }
+
+        await uut.utxosBulk(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'getUtxosBulk').resolves({ status: 200 })
+
+      ctx.request.body = {
+        address: 'blah'
+      }
+
+      await uut.utxosBulk(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
+
   describe('#broadcast', () => {
     it('should return 422 status on arbitrary error', async () => {
       try {
@@ -394,4 +430,40 @@ describe('#BCH-REST-Controller', () => {
       assert.equal(ctx.status, 200)
     })
   })
+
+  describe('#getTokenData2', () => {
+    it('should return 422 status on arbitrary error', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.adapters.bch, 'getTokenData2')
+          .rejects(new Error('test error'))
+
+        ctx.request.body = {
+          tokenId: 'blah'
+        }
+
+        await uut.getTokenData2(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      sandbox.stub(uut.adapters.bch, 'getTokenData2').resolves({ status: 200 })
+
+      ctx.request.body = {
+        tokenId: 'blah'
+      }
+
+      await uut.getTokenData2(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+    })
+  })
 })

test/unit/misc/server-unit.js

@@ -0,0 +1,65 @@
+/*
+  Unit tests for the bin/server.js file
+*/
+
+// Public npm libraries
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+// Local libraries
+const Server = require('../../../bin/server')
+
+describe('#server', () => {
+  let uut, sandbox
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+
+    uut = new Server()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#startServer', () => {
+    it('should start the server', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.mongoose, 'connect').resolves()
+      sandbox.stub(uut.controllers, 'initAdapters').resolves()
+      sandbox.stub(uut.controllers, 'initUseCases').resolves()
+      sandbox.stub(uut.controllers, 'attachRESTControllers').resolves()
+      sandbox.stub(uut.adminLib, 'createSystemUser').resolves(true)
+      sandbox.stub(uut.controllers, 'attachControllers').resolves()
+      uut.config.env = 'dev'
+
+      const result = await uut.startServer()
+      // console.log('result: ', result)
+
+      assert.property(result, 'env')
+
+      // Turn off the server.
+      uut.server.close()
+
+      // Restor config env
+      uut.config.env = 'test'
+    })
+
+    it('should exit on failure', async () => {
+      // Force an error
+      sandbox.stub(uut.mongoose, 'connect').rejects(new Error('test error'))
+
+      // Prevent default behavior of exiting the program.
+      sandbox.stub(uut, 'sleep').resolves()
+      sandbox.stub(uut.process, 'exit').returns()
+
+      await uut.startServer()
+
+      // Not throwing an error is a success
+    })
+  })
+
+  describe('#sleep', () => {
+    it('should execute', async () => {
+      await uut.sleep(1)
+    })
+  })
+})

test/unit/mocks/adapters/fake-log

@@ -0,0 +1,70 @@
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:36:43.907Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:36:43.909Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:36:43.910Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:36:43.912Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:36:43.915Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/sendEmail()","timestamp":"2022-06-27T17:36:58.979Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/sendEmail()","timestamp":"2022-06-27T17:36:58.980Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/sendEmail()","timestamp":"2022-06-27T17:36:58.981Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/sendEmail()","timestamp":"2022-06-27T17:36:58.982Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/sendEmail()","timestamp":"2022-06-27T17:36:58.983Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/validateEmailArray()","timestamp":"2022-06-27T17:36:59.002Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/validateEmailArray()","timestamp":"2022-06-27T17:36:59.003Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/getHtmlFromObject()","timestamp":"2022-06-27T17:36:59.005Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/getHtmlFromObject()","timestamp":"2022-06-27T17:36:59.006Z"}
+{"level":"error","message":"Error in lib/nodemailer.js/getHtmlFromObject()","timestamp":"2022-06-27T17:36:59.008Z"}
+{"level":"info","message":"Warning: Can not send JSON RPC response. Can not determine which peer this message came from.","timestamp":"2022-06-27T17:36:59.353Z"}
+{"level":"info","message":"Rejecting invalid JSON RPC command.","timestamp":"2022-06-27T17:36:59.354Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: ea442e78-2297-466a-823b-9cbb12c8ddd9, type: request, method: unknownMethod","timestamp":"2022-06-27T17:36:59.355Z"}
+{"level":"error","message":"Error in rpc router():  test error","stack":"Error: test error\n    at Context.<anonymous> (/home/trout/work/psf/code/ipfs-service-provider/test/unit/controllers/json-rpc/a10-rpc.unit.js:110:49)\n    at callFn (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:366:21)\n    at Test.Runnable.run (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:354:5)\n    at Runner.runTest (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:666:10)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:789:12\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:581:14)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:591:7\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:474:14)\n    at Immediate._onImmediate (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:559:5)\n    at processImmediate (node:internal/timers:466:21)","timestamp":"2022-06-27T17:36:59.357Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: 9ef6ad90-7fc3-4cb3-8769-4498e5512b3d, type: request, method: users","timestamp":"2022-06-27T17:36:59.358Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: bd57a1cf-7f2f-4ff2-93d4-6727eec4d778, type: request, method: auth","timestamp":"2022-06-27T17:36:59.359Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: 8fd9edc8-6a45-4042-ac06-9ace60567cbf, type: request, method: about","timestamp":"2022-06-27T17:36:59.361Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: 1b27624a-e698-4bbe-9183-b860a1a0d78d, type: request, method: unknownMethod","timestamp":"2022-06-27T17:36:59.363Z"}
+{"level":"info","message":"JSON RPC received from peerA, ID: 40fabddf-59c6-4910-a22c-63da7387f99a, type: request, method: unknownMethod","timestamp":"2022-06-27T17:36:59.365Z"}
+{"level":"error","message":"Error in authUser():  Login credential do not match","stack":"Error: Login credential do not match\n    at Context.<anonymous> (/home/trout/work/psf/code/ipfs-service-provider/test/unit/controllers/json-rpc/auth.json-rpc.controller.unit.js:144:18)\n    at callFn (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:366:21)\n    at Test.Runnable.run (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:354:5)\n    at Runner.runTest (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:666:10)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:789:12\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:581:14)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:591:7\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:474:14)\n    at Immediate.<anonymous> (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:559:5)\n    at processImmediate (node:internal/timers:466:21)","timestamp":"2022-06-27T17:37:04.421Z"}
+{"level":"error","message":"Error in authUser():  login must be specified","stack":"Error: login must be specified\n    at AuthRPC.authUser (/home/trout/work/psf/code/ipfs-service-provider/src/controllers/json-rpc/auth/index.js:78:93)\n    at Context.<anonymous> (/home/trout/work/psf/code/ipfs-service-provider/test/unit/controllers/json-rpc/auth.json-rpc.controller.unit.js:165:34)\n    at callFn (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:366:21)\n    at Test.Runnable.run (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:354:5)\n    at Runner.runTest (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:666:10)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:789:12\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:581:14)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:591:7\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:474:14)\n    at Immediate._onImmediate (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:559:5)\n    at processImmediate (node:internal/timers:466:21)","timestamp":"2022-06-27T17:37:04.423Z"}
+{"level":"error","message":"Error in authUser():  password must be specified","stack":"Error: password must be specified\n    at AuthRPC.authUser (/home/trout/work/psf/code/ipfs-service-provider/src/controllers/json-rpc/auth/index.js:78:284)\n    at Context.<anonymous> (/home/trout/work/psf/code/ipfs-service-provider/test/unit/controllers/json-rpc/auth.json-rpc.controller.unit.js:185:34)\n    at callFn (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:366:21)\n    at Test.Runnable.run (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runnable.js:354:5)\n    at Runner.runTest (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:666:10)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:789:12\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:581:14)\n    at /home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:591:7\n    at next (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:474:14)\n    at Immediate._onImmediate (/home/trout/work/psf/code/ipfs-service-provider/node_modules/mocha/lib/runner.js:559:5)\n    at processImmediate (node:internal/timers:466:21)","timestamp":"2022-06-27T17:37:04.425Z"}
+{"level":"error","timestamp":"2022-06-27T17:37:04.466Z"}
+{"level":"info","message":"Running server in environment: dev","timestamp":"2022-06-27T17:37:04.487Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.495Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.495Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.496Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.497Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.497Z"}
+{"level":"error","message":"Error in lib/users.js/getAllUsers()","timestamp":"2022-06-27T17:37:04.499Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.502Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.503Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.503Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.504Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.505Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:04.506Z"}
+{"level":"error","message":"Error in lib/users.js/deleteUser()","timestamp":"2022-06-27T17:37:04.508Z"}
+{"level":"info","message":"Running server in environment: test","timestamp":"2022-06-27T17:37:04.514Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:04.638Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:05.273Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:05.277Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:05.280Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:05.286Z"}
+{"level":"error","timestamp":"2022-06-27T17:37:05.412Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac1b4f08950b955d27f, Target user: 1","timestamp":"2022-06-27T17:37:05.441Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:05.448Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac1b4f08950b955d27f, Target user: 62b9eac1b4f08950b955d27d","timestamp":"2022-06-27T17:37:05.452Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:05.457Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:05.463Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:05.467Z"}
+{"level":"error","message":"Error in lib/users.js/updateUser()","timestamp":"2022-06-27T17:37:05.473Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac0b4f08950b955d274, Target user: 62b9eac1b4f08950b955d27d","timestamp":"2022-06-27T17:37:05.478Z"}
+{"level":"verbose","message":"It's ok. The user is an admin.","timestamp":"2022-06-27T17:37:05.478Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac1b4f08950b955d27f, Target user: 1","timestamp":"2022-06-27T17:37:05.600Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac1b4f08950b955d27f, Target user: 62b9eac1b4f08950b955d27d","timestamp":"2022-06-27T17:37:05.603Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac0b4f08950b955d274, Target user: 62b9eac1b4f08950b955d27d","timestamp":"2022-06-27T17:37:05.615Z"}
+{"level":"verbose","message":"It's ok. The user is an admin.","timestamp":"2022-06-27T17:37:05.615Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:37:05.619Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:37:05.622Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:37:05.624Z"}
+{"level":"error","message":"Error in lib/contact.js/sendEmail()","timestamp":"2022-06-27T17:37:05.627Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac1b4f08950b955d2a6, Target user: Target Id","timestamp":"2022-06-27T17:37:05.754Z"}
+{"level":"verbose","message":"Calling user and target user do not match! Calling user: 62b9eac0b4f08950b955d274, Target user: 62b9eac1b4f08950b955d2a6","timestamp":"2022-06-27T17:37:05.756Z"}
+{"level":"verbose","message":"It's ok. The user is an admin.","timestamp":"2022-06-27T17:37:05.756Z"}
+{"level":"error","message":"Error in lib/users.js/createUser()","timestamp":"2022-06-27T17:37:06.060Z"}

test/unit/mocks/adapters/index.js

@@ -2,12 +2,20 @@
   Mocks for the Adapter library.
 */
 
-const ipfs = {
-  ipfsAdapter: {
-    ipfs: {}
-  },
-  ipfsCoordAdapter: {
-    ipfsCoord: {
+class IpfsAdapter {
+  constructor () {
+    this.ipfs = {
+      files: {
+        stat: () => {}
+      }
+    }
+  }
+}
+
+class IpfsCoordAdapter {
+  constructor () {
+
+    this.ipfsCoord = {
       useCases: {
         peer: {
           sendPrivateMessage: () => {}
@@ -17,13 +25,21 @@ const ipfs = {
         peerData: []
       }
     },
-    peerInputHandler: () => {},
-    state: {
+
+    this.peerInputHandler = () => {}
+
+    this.state = {
       serviceProviders: []
     }
   }
 }
 
+const ipfs = {
+  ipfsAdapter: new IpfsAdapter(),
+  ipfsCoordAdapter: new IpfsCoordAdapter()
+}
+ipfs.ipfs = ipfs.ipfsAdapter.ipfs
+
 const localdb = {
   Users: class Users {
     static findById () {}
@@ -77,6 +93,10 @@ class BchUseCaseMock {
     return {}
   }
 
+  async getUtxosBulk () {
+    return {}
+  }
+
   async broadcast () {
     return {}
   }
@@ -101,6 +121,10 @@ class BchUseCaseMock {
     return {}
   }
 
+  async getTokenData2() {
+    return {}
+  }
+
   async waitForRPCResponse () {
     return {}
   }

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

@@ -8,6 +8,8 @@ class IPFSCoord {
   }
 
   async start () {}
+
+  async subscribeToChat() {}
 }
 
 module.exports = IPFSCoord

test/unit/use-cases/index.use-case.unit.js

@@ -48,4 +48,17 @@ describe('#use-cases', () => {
       }
     })
   })
+
+  describe('#start', () => {
+    it('should initialize async use cases', async () => {
+      const result = await uut.start()
+
+      assert.equal(result, true)
+    })
+
+    // it('should catch and throw errors', async () => {
+    //   // Force an error
+    //   sandbox.stub()
+    // })
+  })
 })