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

Syncing with upstream

README.md

@@ -1,14 +1,14 @@
 # bch-dex
 
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Join the chat at https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev](https://badges.gitter.im/Permissionless-Software-Foundation/psf-dex-dev.svg)](https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-`bch-dex` is a decentralized exchange for permissionless trading of [SLP tokens](https://github.com/simpleledger/slp-specifications/blob/master/slp-token-type-1.md) and [NFTs](https://github.com/simpleledger/slp-specifications/blob/master/slp-nft-1.md). Trading fees are incredibly small, compared to other DEX platforms. The software is based entirely on open protocols and open source software. It's not a '.com' website that you visit, but software you run on your own computer, in the confort of your own home. So long as you have an internet connection and the technical knowledge to run this software, no one can stop you from trading tokens. `bch-dex` software is maintained by the [Permissionless Software Foundation](https://psfoundation.cash/).
+`bch-dex` is a decentralized exchange *protocol* for permissionless trading of [SLP tokens](https://github.com/simpleledger/slp-specifications/blob/master/slp-token-type-1.md) and [NFTs](https://github.com/simpleledger/slp-specifications/blob/master/slp-nft-1.md). Trading fees are incredibly small, compared to other DEX platforms. The software is based entirely on open protocols and open source software. `bch-dex` software is maintained by the [Permissionless Software Foundation](https://psfoundation.info).
 
 - [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video)
 
-This is a prototype web service that monitors the [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) for trading signals, to trade BCH and SLP tokens. It's inspired by the [SWaP Protocol](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
+This is a prototype web service that monitors one or more [Nostr relays](https://nostr.com) for trading signals, to trade BCH and SLP tokens. It's inspired by the [SWaP Protocol](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
 
-This repository contains the back end code. The user interface is contained in the [bch-dex-ui](https://github.com/Permissionless-Software-Foundation/bch-dex-ui) repository.
+This repository contains the back end code. The user interface is contained in the [bch-dex-ui-v3](https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v3) repository.
 
 **Warning**: This repository is under active development. Things will be constantly changing and breaking.
 
@@ -19,24 +19,17 @@ This repository contains the back end code. The user interface is contained in t
 
 ## Participate
 This is an open source project, and we encourage other JavaScript developers to participate in its creation and maintenance. We have two chat rooms for the community:
-- [Telegram Channel](https://t.me/psf_dex_dev)
-- [Gitter Channel](https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev)
+- [Telegram Channel](https://t.me/bch_js_toolkit)
 
 ## Installation
 Running the DEX requires composition of these different software packages:
 - bch-dex - This repository is the back end software that tracks trade data on the network, generates [Offers and Counter Offers](https://github.com/Permissionless-Software-Foundation/bch-dex/tree/ct-unstable/dev-docs#definitions), and finalizes trades by accepting Counter Offers.
-- [bch-dex-ui](https://github.com/Permissionless-Software-Foundation/bch-dex-ui) is a [Gatsby](https://www.gatsbyjs.com/) web app and user interface (UI) for bch-dex.
-- [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) is a censorship-resistant database used to communicate trade data between peers running bch-dex.
-- [IPFS](https://ipfs.io/) is a censorship-resistant network for communicating data over the internet.
-- [MongoDB](https://www.mongodb.com/) is a database used by both P2WDB and bch-dex to store and manage local data.
+- [bch-dex-ui-v3](https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v3) web app and user interface (UI) for bch-dex focused on Sellers of tokens.
+- [MongoDB](https://www.mongodb.com/) is a database used by bch-dex to store and manage local data, user accounts, etc.
 
-The above software is orchestrated using [Docker](https://www.docker.com/) and Docker Compose. The target operating system is Ubuntu 20+, and the target hardware is amd64 (normal desktop PCs) and the arm64 (Raspberry Pi 4). Trying to operate this software on other operating systems or hardware is possible, but not supported.
+The above software is orchestrated using [Docker](https://www.docker.com/) and Docker Compose. The target operating system is Ubuntu 20+, and the target hardware is amd64 (normal desktop PCs). Trying to operate this software on other operating systems or hardware is possible, but not supported.
 
-The Raspberry Pi 4 is the primary hardware target, because this software functions best when it is always running. The Pi 4 makes a great appliance for monitoring trade signals and finalizing trades.
-
-Instructions for setting up Node.js, Docker, and Docker Compose can be found in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd). Walk-through videos can also be found on the [PSF Videos page](https://psfoundation.cash/video/).
-
-Here are the steps involved in setting up bch-dex:
+Setup instructions:
 
 1. Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose.
 1. Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`.
@@ -44,32 +37,17 @@ Here are the steps involved in setting up bch-dex:
 1. Create a wallet:
   - `cd production/scripts`
   - `node create-wallet.js`
-1. Change directory to the `production/docker` or `production/rpi-docker` folder depending on your hardware target.
+1. Change directory to the `production/docker` folder.
 1. Pull the Docker images down from Docker Hub: `docker-compose pull`
+1. Build the core software: `docker-compose build --no-cache`
 1. Start the Docker containers with `docker-compose up -d`
-1. Wait for the P2WDB to sync and populate bch-dex with trade data. You can monitor it with `docker logs --tail 20 -f p2wdb`.
 1. Open a web browser and navigate the `http://localhost:4500`. You'll be able to see new Offers as they come in and are detected by bch-dex.
 1. To take the other side of the trade, click the `Take` button in the UI.
 1. You can add the 12-word mnemonic from the `wallet.json` file to the the web wallet, which will mirror your wallet in the UI, and allow you to perform basic wallet functions (send and receive BCH and tokens).
 
 ## Blockchain Infrastructure
 
-The P2WDB and bch-dex containers requires a 'Global Back End' (as described in [CashStack.info](https://cashstack.info)) in order to connect to the blockchain. By default, the Docker containers connect to [free-bch.fullstack.cash](https://free-bch.fullstack.cash/). Several community-provided Global Back End servers are provided and can be [viewed here](https://gist.github.com/christroutner/63c5513782181f8b8ea3eb89f7cadeb6). The back end can be changed by setting the `CONSUMER_URL` environment variable in the `docker-compose.yml` file.
-
-### Applying Software Updates
-As this is an active project, software updates will happen frequently. To apply a software update, perform these steps.
-
-
-1. Enter the `docker` or `rpi-docker` folder, depending on your hardware target.
-1. Bring down the Docker containers with `docker-compose down`.
-1. Pull in the software updates with `git pull`
-1. Update dependencies with `npm install`
-1. Pull new Docker images with `docker-compose pull`
-1. Clean up disk space by deleting old Docker images with `./cleanup-images.sh`
-1. Start the Docker containers with `docker-compose up -d`
-
-
-Sometimes it may be necessary to delete the databases before applying a software update. This can be done by stopping the Docker containers and deleting the `production/data` directory. When the Docker containers are restarted, they will recreate that directory. The P2WDB will re-sync and bch-dex will be populated with fresh trade data.
+bch-dex requires a [Cash Stack](https://cashstack.info) back end in order to connect to the blockchain. By default, the Docker containers connect to [free-bch.fullstack.cash](https://free-bch.fullstack.cash/). Several community-provided servers are provided and can be [viewed here](https://consumers.psfoundation.info/consumers.json). The back end can be changed by setting the `CONSUMER_URL` environment variable in the `docker-compose.yml` file.
 
 ## License
 

bin/server.js

@@ -25,6 +25,7 @@ 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 { usageMiddleware } from '../src/use-cases/usage-use-cases.js'
 // import wlogger from '../src/adapters/wlogger.js'
 import Controllers from '../src/controllers/index.js'
 import { applyPassportMods } from '../config/passport.js'
@@ -70,6 +71,7 @@ class Server {
       app.use(bodyParser())
       app.use(session())
       app.use(errorMiddleware())
+      app.use(usageMiddleware())
 
       // Used to generate the docs.
       app.use(mount('/', serve(`${process.cwd()}/docs`)))
@@ -142,7 +144,9 @@ class Server {
       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`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}`)
+      console.log(`IPFS WebRTC port: ${this.config.ipfsWebRtcPort}`)
+      console.log(`Connection preference: ${this.config.connectPref}\n`)
 
       return app
     } catch (err) {

config/env/common.js

@@ -155,6 +155,8 @@ export default {
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 4001,
   ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 4003,
+  ipfsWebRtcPort: process.env.IPFS_WEB_RTC_PORT ? process.env.IPFS_WEB_RTC_PORT : 4005,
+  connectPref: process.env.CONNECT_PREF, // Used in helia-coord to select connection preference.
 
   // Settings for production, using external go-ipfs node.
   isProduction: process.env.SVC_ENV === 'prod' ? true : false,

index.js

@@ -1,4 +1,8 @@
 import Server from './bin/server.js'
 const server = new Server()
 
+process.on('unhandledRejection', (reason, promise) => {
+  console.log(`Handling ${reason.code} error. stack: `, reason)
+})
+
 server.startServer()

package.json

@@ -28,32 +28,33 @@
   },
   "repository": "Permissionless-Software-Foundation/bch-dex",
   "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "13.1.1",
-    "@chainsafe/libp2p-noise": "15.1.1",
-    "@chainsafe/libp2p-yamux": "6.0.2",
+    "@chainsafe/libp2p-gossipsub": "14.1.0",
+    "@chainsafe/libp2p-noise": "16.0.1",
+    "@chainsafe/libp2p-yamux": "7.0.1",
     "@chris.troutner/retry-queue": "1.0.8",
-    "@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/tcp": "9.1.5",
-    "@libp2p/webrtc": "4.1.7",
-    "@libp2p/websockets": "8.2.0",
-    "@multiformats/multiaddr": "12.3.0",
-    "@psf/bch-js": "6.7.3",
+    "@helia/unixfs": "4.0.2",
+    "@libp2p/bootstrap": "11.0.26",
+    "@libp2p/circuit-relay-v2": "3.2.2",
+    "@libp2p/config": "1.1.0",
+    "@libp2p/identify": "3.0.22",
+    "@libp2p/keychain": "5.0.14",
+    "@libp2p/logger": "5.1.8",
+    "@libp2p/ping": "2.0.22",
+    "@libp2p/tcp": "10.1.2",
+    "@libp2p/webrtc": "5.2.2",
+    "@libp2p/websockets": "9.2.2",
+    "@multiformats/multiaddr": "12.3.5",
     "axios": "0.27.2",
     "bch-message-lib": "2.2.1",
     "bch-nostr": "1.3.3",
     "bch-token-sweep": "2.2.1",
     "bcryptjs": "2.4.3",
-    "bitcoincashjs-lib": "3.3.3",
-    "blockstore-fs": "2.0.0",
-    "datastore-fs": "9.1.7",
+    "bitcoincashjs-lib": "3.3.3",    
+    "blockstore-fs": "2.0.2",
+    "datastore-fs": "10.0.2",
     "glob": "7.1.6",
-    "helia": "4.2.5",
-    "helia-coord": "1.5.15",
+    "helia": "5.2.1",
+    "helia-coord": "1.7.2",
     "ipfs-coord-esm": "9.1.7",
     "ipfs-http-client": "58.0.0",
     "jsonrpc-lite": "2.2.0",
@@ -70,9 +71,9 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "1.9.1",
+    "libp2p": "2.7.2",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "5.12.1",
+    "minimal-slp-wallet": "5.13.2",
     "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",

production/docker/.env

@@ -1 +1 @@
-COMPOSE_PROJECT_NAME=ipfs-service-provider
+COMPOSE_PROJECT_NAME=bch-dex

production/docker/docker-compose.yml

@@ -31,7 +31,12 @@ services:
       - mongo-dex
       #- p2wdb
     ports:
-      - '5700:5700' # <host port>:<container port>
+      # <host port>:<container port>
+      - '5700:5700' # REST API
+      - '4001:4001' # TCP
+      - '4003:4003' # Websockets
+      - '4005:4005' # WebRTC
+
     volumes:
       - ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
       - ./bch-dex/start-production.sh:/home/safeuser/bch-dex/start-production.sh

production/rpi-docker/bch-dex/Dockerfile

@@ -56,7 +56,7 @@ RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex
 WORKDIR /home/safeuser/bch-dex
 
 # For development: switch to unstable branch
-RUN git checkout ct-unstable
+RUN git checkout master
 
 # Install dependencies
 #RUN mkdir .ipfsdata
@@ -66,14 +66,6 @@ RUN npm install
 # Generate the API docs
 RUN npm run docs
 
-# Copy the wallet files
-#COPY wallet.json wallet.json
-
-#VOLUME /home/safeuser/keys
-
-# Expose the port the API will be served on.
-#EXPOSE 5010
-
 # Start the application.
 #COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]

production/rpi-docker/p2wdb/start-production.sh

@@ -41,8 +41,14 @@ export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4001
 export IPFS_WS_PORT=4003
+export IPFS_WEB_RTC_PORT=4005
+# Set the debug level for helia-coord. 0-3.
+# 0 = no debug logs. 3 = maximum debug logs.
+export DEBUG_LEVEL=0
 
-# P2WDB specific env vars
-#export ORBITDB_NAME=/orbitdb/zdpuAqNiwLiJBfbRK7uihV2hAbNSXj78ufzv5VyQb8GuvRwDh/psf-bch-p2wdb-keyvalue-v3.0.0-0001
+# Use this if the IPFS node has a publically accessible IP address.
+#export CONNECT_PREF=direct
+# Use this if the IPFS node is behind a NAT or Firewall and cannot be accessed directly.
+export CONNECT_PREF=cr
 
 npm start

src/adapters/ipfs/ipfs.js

@@ -19,17 +19,20 @@ 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-v2'
-import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+import { identify, identifyPush } from '@libp2p/identify'
+import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+// import { circuitRelayServer } 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 { webRTC, webRTCDirect } from '@libp2p/webrtc'
 import { keychain } from '@libp2p/keychain'
-import { defaultLogger } from '@libp2p/logger'
 import { unixfs } from '@helia/unixfs'
+// import { generateKeyPairFromSeed } from '@libp2p/crypto/keys'
+// import crypto from 'crypto'
+import { ping } from '@libp2p/ping'
+import { loadOrCreateSelfKey } from '@libp2p/config'
 
 // Local libraries
 import config from '../../../config/index.js'
@@ -64,8 +67,8 @@ class IpfsAdapter {
     this.createNode = this.createNode.bind(this)
     this.stop = this.stop.bind(this)
     this.ensureBlocksDir = this.ensureBlocksDir.bind(this)
+    // this.getPrivateKey = this.getPrivateKey.bind(this)
     this.getSeed = this.getSeed.bind(this)
-    this.getKeychain = this.getKeychain.bind(this)
   }
 
   // Start an IPFS node.
@@ -111,19 +114,6 @@ 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 () {
@@ -132,44 +122,38 @@ class IpfsAdapter {
       const blockstore = new FsBlockstore(`${IPFS_DIR}/blockstore`)
       const datastore = new FsDatastore(`${IPFS_DIR}/datastore`)
 
-      // const keychainInit = {
-      //   pass: await this.getSeed()
-      // }
+      // Get the private key.
+      // const privateKey = await this.getPrivateKey()
+      // console.log('privateKey: ', privateKey)
 
       // 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')
+      const keychainInit = {
+        selfKey: 'myKey',
+        pass: await this.getSeed()
       }
+      const privateKey = await loadOrCreateSelfKey(datastore, keychainInit)
 
       // Configure services
       const services = {
         identify: identify(),
-        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true })
+        identifyPush: identifyPush(),
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }),
+        ping: ping(),
+        keychain: keychain(keychainInit)
       }
       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
-          }
+            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')
@@ -177,28 +161,31 @@ class IpfsAdapter {
 
       const transports = [
         tcp(),
-        webSockets()
-        // circuitRelayTransport({
-        //   discoverRelays: 3,
-        //   reservationConcurrency: 3
-        // }),
-        // webRTC()
+        webSockets(),
+        circuitRelayTransport({
+          discoverRelays: 3,
+          reservationConcurrency: 3
+        }),
+        webRTC(),
+        webRTCDirect()
       ]
 
       // libp2p is the networking layer that underpins Helia
       const libp2p = await this.createLibp2p({
-        peerId,
+        // peerId,
+        privateKey,
         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'
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`,
+            '/webrtc',
+            '/p2p-circuit'
           ]
         },
         transports,
-        connectionEncryption: [
+        connectionEncrypters: [
           noise()
         ],
         streamMuxers: [
@@ -244,6 +231,8 @@ class IpfsAdapter {
 
       !this.fs.existsSync(`${IPFS_DIR}/datastore`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore`)
 
+      !this.fs.existsSync(`${IPFS_DIR}/datastore/pkcs8`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore/pkcs8`)
+
       // !fs.existsSync(`${IPFS_DIR}/datastore/peers`) && fs.mkdirSync(`${IPFS_DIR}/datastore/peers`)
 
       return true
@@ -280,6 +269,48 @@ class IpfsAdapter {
       throw err
     }
   }
+
+  // Get the private key from disk, or generate a new one and save it,
+  // if it doesn't exist.
+  // async getPrivateKey () {
+  //   try {
+  //     const filename = `${IPFS_DIR}/privkey.json`
+
+  //     let privKeyHex
+  //     try {
+  //       // Try to read the JSON file containing the seed.
+  //       privKeyHex = await this.jsonFiles.readJSON(filename)
+  //       // console.log('saved privKeyHex: ', privKeyHex)
+  //     } catch (err) {
+  //       // Generate a new private key and save it to disk.
+
+  //       // Generate a new private key and save it to disk.
+  //       const randomBuffer = crypto.randomBytes(32)
+  //       // console.log('randomBuffer: ', randomBuffer)
+
+  //       privKeyHex = randomBuffer.toString('hex')
+  //       // console.log('new privKeyHex: ', privKeyHex)
+
+  //       // Save the newly generated seed
+  //       await this.jsonFiles.writeJSON(privKeyHex, filename)
+  //     }
+
+  //     // Convert the saved hex string to a buffer.
+  //     const privKeyBuf = Buffer.from(privKeyHex, 'hex')
+
+  //     // Convert the buffer to a Uint8Array 'seed'
+  //     const seed = new Uint8Array(privKeyBuf.buffer, privKeyBuf.byteOffset, privKeyBuf.byteLength)
+  //     // console.log('seed: ', seed)
+
+  //     // Generate a ED25519 key pair.
+  //     const privKey = await generateKeyPairFromSeed('Ed25519', seed)
+
+  //     return privKey
+  //   } catch (err) {
+  //     console.error('Error in adapters/ipfs/ipfs.js/getPrivateKey(): ', err)
+  //     throw err
+  //   }
+  // }
 }
 
 export default IpfsAdapter

src/adapters/localdb/models/users.js

@@ -11,6 +11,7 @@ const User = new mongoose.Schema({
   name: { type: String },
   username: { type: String },
   password: { type: String, required: true },
+  mnemonic: { type: String, required: true },
   email: {
     type: String,
     required: true,

src/adapters/wallet.adapter.js

@@ -20,6 +20,13 @@ class Wallet {
 
     // Bind 'this' object to all subfunctions
     this.instanceWalletWithoutInitialization = this.instanceWalletWithoutInitialization.bind(this)
+    this._instanceWallet = this._instanceWallet.bind(this)
+    this.openWallet = this.openWallet.bind(this)
+    this.instanceWallet = this.instanceWallet.bind(this)
+    this.incrementNextAddress = this.incrementNextAddress.bind(this)
+    this.getKeyPair = this.getKeyPair.bind(this)
+    this.optimize = this.optimize.bind(this)
+    this.getBalance = this.getBalance.bind(this)
   }
 
   // This is used for initializing the wallet, without waiting to update the wallet

src/controllers/index.js

@@ -21,6 +21,13 @@ class Controllers {
     this.useCases = new UseCases({ adapters: this.adapters })
     this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
     this.config = config
+
+    // Bind 'this' object to all subfunction
+    this.initAdapters = this.initAdapters.bind(this)
+    this.initUseCases = this.initUseCases.bind(this)
+    this.attachRESTControllers = this.attachRESTControllers.bind(this)
+    this.attachControllers = this.attachControllers.bind(this)
+    this.attachRPCControllers = this.attachRPCControllers.bind(this)
   }
 
   // Spin up any adapter libraries that have async startup needs.

src/controllers/rest-api/index.js

@@ -17,6 +17,7 @@ import EntryRouter from './entry/index.js'
 import OfferRouter from './offer/index.js'
 import OrderRouter from './order/index.js'
 import P2WDBRouter from './p2wdb/index.js'
+import UsageRESTController from './usage/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -34,6 +35,9 @@ class RESTControllers {
       )
     }
 
+    // Bind 'this' object to all subfunctions.
+    this.attachRESTControllers = this.attachRESTControllers.bind(this)
+
     // Encapsulate dependencies
     this.config = config
   }
@@ -78,6 +82,10 @@ class RESTControllers {
 
     const p2wdbRouter = new P2WDBRouter(dependencies)
     p2wdbRouter.attach(app)
+
+    // Attach the REST API Controllers associated with the /usage route
+    const usageRESTController = new UsageRESTController(dependencies)
+    usageRESTController.attach(app)
   }
 }
 

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

@@ -0,0 +1,119 @@
+/*
+  REST API Controller library for the /usage route
+*/
+
+// Global npm libraries
+
+// Local libraries
+import wlogger from '../../../adapters/wlogger.js'
+
+class UsageRESTControllerLib {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /usage REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /usage REST Controller.'
+      )
+    }
+
+    // Encapsulate dependencies
+
+    // Bind 'this' object to all subfunctions
+    this.getStatus = this.getStatus.bind(this)
+    this.getTopIps = this.getTopIps.bind(this)
+    this.getTopEndpoints = this.getTopEndpoints.bind(this)
+    this.handleError = this.handleError.bind(this)
+  }
+
+  /**
+   * @api {get} /usage Get status on IPFS infrastructure
+   * @apiPermission public
+   * @apiName GetUsageStatus
+   * @apiGroup REST Usage
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5020/usage
+   *
+   */
+  getStatus (ctx) {
+    try {
+      // const status = await this.adapters.ipfs.getStatus()
+      const status = this.useCases.usage.getRestSummary()
+
+      ctx.body = { status }
+    } catch (err) {
+      wlogger.error('Error in usage/controller.js/getStatus(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+   * @api {get} /usage/ips Get top IP addresses consuming the REST API
+   * @apiPermission public
+   * @apiName GetUsageIPs
+   * @apiGroup REST Usage
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5020/usage/ips
+   *
+   */
+  getTopIps (ctx) {
+    try {
+      const ips = this.useCases.usage.getTopIps()
+
+      ctx.body = { ips }
+    } catch (err) {
+      wlogger.error('Error in usage/controller.js/getTopIps(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+   * @api {get} /usage/endpoints Get top endpoints consumed from the REST API
+   * @apiPermission public
+   * @apiName GetUsageEndpoints
+   * @apiGroup REST Usage
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5020/usage/endpoints
+   *
+   */
+  getTopEndpoints (ctx) {
+    try {
+      const endpoints = this.useCases.usage.getTopEndpoints()
+
+      ctx.body = { endpoints }
+    } catch (err) {
+      wlogger.error('Error in usage/controller.js/getTopEndpoints(): ')
+      // 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 UsageRESTControllerLib

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

@@ -0,0 +1,65 @@
+/*
+  REST API library for the /usage route.
+*/
+
+// Public npm libraries.
+import Router from 'koa-router'
+
+// Local libraries.
+import UsageRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
+
+// let _this
+
+class UsageRouter {
+  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.usageRESTController = new UsageRESTControllerLib(dependencies)
+    this.validators = new Validators()
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/usage'
+    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.usageRESTController.getStatus)
+    this.router.get('/ips', this.usageRESTController.getTopIps)
+    this.router.get('/endpoints', this.usageRESTController.getTopEndpoints)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(this.router.routes())
+    app.use(this.router.allowedMethods())
+  }
+}
+
+// module.exports = BchRouter
+export default UsageRouter

src/controllers/timer-controllers.js

@@ -30,6 +30,9 @@ class TimerControllers {
     this.gcOffers = this.gcOffers.bind(this)
     this.checkDupOffers = this.checkDupOffers.bind(this)
     this.loadOffers = this.loadOffers.bind(this)
+    // Bind 'this' object to all subfunctions.
+    // this.exampleTimerFunc = this.exampleTimerFunc.bind(this)
+    this.cleanUsage = this.cleanUsage.bind(this)
 
     // State
     this.gcOrdersInt = null
@@ -44,6 +47,11 @@ class TimerControllers {
     this.gcOffersInt = setInterval(this.gcOffers, 60000 * 5)
     // this.checkDupOffersInt = setInterval(this.checkDupOffers, 60000 * 4.5)
     this.loadOffersInt = setInterval(this.loadOffers, 60000 * 2)
+    // Any new timer control functions can be added here. They will be started
+    // when the server starts.
+    // this.optimizeWalletHandle = setInterval(this.exampleTimerFunc, 60000 * 60)
+    this.cleanUsageHandle = setInterval(this.cleanUsage, 60000 * 60) // 1 hour
+
     return true
   }
 
@@ -51,6 +59,8 @@ class TimerControllers {
     clearInterval(this.gcOrdersInt)
     clearInterval(this.gcOffersInt)
     // clearInterval(this.checkDupOffers)
+    clearInterval(this.optimizeWalletHandle)
+    clearInterval(this.cleanusageHandle)
   }
 
   // Garbage Collect the Orders.
@@ -100,6 +110,20 @@ class TimerControllers {
       return false
     }
   }
+
+  // Clean the usage state so that stats reflect the last 24 hours.
+  cleanUsage () {
+    try {
+      this.useCases.usage.cleanUsage()
+
+      return true
+    } catch (err) {
+      console.error('Error in time-controller.js/cleanUsage(): ', err)
+
+      // Note: Do not throw an error. This is a top-level function.
+      return false
+    }
+  }
 }
 
 export default TimerControllers

src/use-cases/index.js

@@ -4,10 +4,12 @@
   https://troutsblog.com/blog/clean-architecture
 */
 
+// Local libraries
 import UserUseCases from './user.js'
 import EntryUseCases from './entry.js'
 import OfferUseCases from './offer/index.js'
 import OrderUseCases from './order.js'
+import { UsageUseCases } from './usage-use-cases.js'
 
 class UseCases {
   constructor (localConfig = {}) {
@@ -24,6 +26,7 @@ class UseCases {
     this.order = new OrderUseCases(localConfig)
     localConfig.order = this.order
     this.offer = new OfferUseCases(localConfig)
+    this.usage = new UsageUseCases(localConfig)
   }
 
   // Run any startup Use Cases at the start of the app.

src/use-cases/offer/index.js

@@ -136,10 +136,9 @@ class OfferUseCases {
       offerEntity.displayCategory = displayCategory
 
       // Detect if user set the NSFW flag.
-      let nsfw = false
-      // nsfw = await this.detectNsfw(tokenData)
-      nsfw = await this.retryQueue.addToQueue(this.detectNsfw, tokenData)
-      offerEntity.nsfw = nsfw
+      // const nsfw = false
+      // nsfw = await this.retryQueue.addToQueue(this.detectNsfw, tokenData)
+      // offerEntity.nsfw = nsfw
 
       // Add offer to the local database.
       const offerModel = new this.OfferModel(offerEntity)

src/use-cases/usage-use-cases.js

@@ -0,0 +1,136 @@
+/*
+  Use Case library for tracking usage. This library contains business logic
+  for tracking the usage of REST API and JSON RPC calls. This library is used
+  by admins to keep an eye on how many API calls were made in a 24-hour and
+  1-hour time period.
+*/
+
+// This global variable is used to share data between the REST middleware and
+// the Usage Use Case class instance.
+let restCalls = []
+
+class UsageUseCases {
+  constructor (localConfig = {}) {
+    // console.log('User localConfig: ', localConfig)
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of adapters must be passed in when instantiating Usage Use Cases library.'
+      )
+    }
+
+    // Bind 'this' object to all subfunctions
+    this.cleanUsage = this.cleanUsage.bind(this)
+    this.getRestSummary = this.getRestSummary.bind(this)
+    this.getTopIps = this.getTopIps.bind(this)
+    this.getTopEndpoints = this.getTopEndpoints.bind(this)
+
+    // State
+  }
+
+  // Clean up the state by removing entries that are older than 24 hours. This
+  // ensures stats reflect only the last 24 hours.
+  // This function is called by a Timer Controller.
+  cleanUsage () {
+    try {
+      const now = new Date()
+      const twentyFourHoursAgo = now.getTime() - (60000 * 60 * 24)
+
+      restCalls = restCalls.filter(x => x.timestamp > twentyFourHoursAgo)
+      return restCalls
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/cleanUsage()')
+      throw err
+    }
+  }
+
+  // Track the calls to a REST API
+  getRestSummary (inObj = {}) {
+    try {
+      console.log(`getRestSummary(): There have been ${restCalls.length} REST calls`)
+
+      return restCalls.length
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/getRestSummary()')
+      throw err
+    }
+  }
+
+  // Get the top 20 IP addresses from the stats.
+  getTopIps () {
+    try {
+      const ips = restCalls.map(x => x.ip)
+      // Create a Map to count occurrences of each IP address string
+      const countMap = new Map()
+      ips.forEach(ip => {
+        countMap.set(ip, (countMap.get(ip) || 0) + 1)
+      })
+
+      // Convert the Map into an array of objects with `str` and `cnt` properties
+      const result = Array.from(countMap, ([ip, cnt]) => ({ ip, cnt }))
+
+      // Sort the results by the `cnt` property in descending order
+      result.sort((a, b) => b.cnt - a.cnt)
+
+      // Ensure the result has at most 20 elements
+      return result.slice(0, 20)
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/getTopIps()')
+      throw err
+    }
+  }
+
+  // Get the top 20 most consumed endpoints.
+  getTopEndpoints () {
+    try {
+      const endpoints = restCalls.map(x => `${x.method} ${x.url}`)
+
+      // Create a Map to count occurrences of each IP address string
+      const countMap = new Map()
+      endpoints.forEach(endpoint => {
+        countMap.set(endpoint, (countMap.get(endpoint) || 0) + 1)
+      })
+
+      // Convert the Map into an array of objects with `str` and `cnt` properties
+      const result = Array.from(countMap, ([endpoint, cnt]) => ({ endpoint, cnt }))
+
+      // Sort the results by the `cnt` property in descending order
+      result.sort((a, b) => b.cnt - a.cnt)
+
+      // Ensure the result has at most 20 elements
+      return result.slice(0, 20)
+    } catch (err) {
+      console.error('Error in usage-use-cases.js/getTopEndpoints()')
+      throw err
+    }
+  }
+}
+
+// This Koa middleware is called any time there is a REST API. It logs the
+// details from the request object.
+function usageMiddleware () {
+  return async (ctx, next) => {
+    try {
+      await next()
+
+      // console.log('ctx.request: ', ctx.request)
+      const now = new Date()
+
+      const reqObj = {
+        ip: ctx.request.ip,
+        url: ctx.request.url,
+        method: ctx.request.method,
+        timestamp: now.getTime()
+      }
+      // console.log('reqObj: ', reqObj)
+
+      restCalls.push(reqObj)
+    } catch (err) {
+      ctx.status = err.status || 500
+      ctx.body = err.message
+      ctx.app.emit('error', err, ctx)
+    }
+  }
+};
+
+export { UsageUseCases, usageMiddleware, restCalls }

src/use-cases/user.js

@@ -16,7 +16,7 @@ class UserLib {
         'Instance of adapters must be passed in when instantiating User Use Cases library.'
       )
     }
-
+    this.BchWallet = this.adapters.wallet.BchWallet
     // Encapsulate dependencies
     this.UserEntity = new UserEntity()
     this.UserModel = this.adapters.localdb.Users
@@ -30,6 +30,11 @@ class UserLib {
       const userEntity = this.UserEntity.validate(userObj)
       const user = new this.UserModel(userEntity)
 
+      const wallet = new this.BchWallet()
+      const walletInfo = await wallet.walletInfoPromise
+      const mnemonic = walletInfo.mnemonic
+      user.mnemonic = mnemonic
+
       // Enforce default value of 'user'
       user.type = 'user'
       // console.log('user: ', user)
@@ -102,6 +107,7 @@ class UserLib {
 
       // Input Validation
       // Optional inputs, but they must be strings if included.
+
       if (newData.email && typeof newData.email !== 'string') {
         throw new Error("Property 'email' must be a string!")
       }
@@ -111,6 +117,9 @@ class UserLib {
       if (newData.password && typeof newData.password !== 'string') {
         throw new Error("Property 'password' must be a string!")
       }
+      if (newData.mnemonic) {
+        throw new Error("Property 'mnemonic' cannot be updated!")
+      }
 
       // Save a copy of the original user type.
       const userType = existingUser.type

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

@@ -173,6 +173,7 @@ if (!config.noMongo) {
         )
         assert.property(result.data, 'token', 'Token property exists.')
         assert.equal(result.data.user.type, 'user')
+        assert.property(result.data.user, 'mnemonic')
       })
     })
 
@@ -265,7 +266,7 @@ if (!config.noMongo) {
         const users = result.data.users
         // console.log(`users: ${util.inspect(users)}`)
 
-        assert.hasAnyKeys(users[0], ['type', '_id', 'email'])
+        assert.hasAnyKeys(users[0], ['type', '_id', 'email', 'mnemonic'])
         assert.isNumber(users.length)
       })
 
@@ -375,6 +376,7 @@ if (!config.noMongo) {
 
         assert.property(user, 'type')
         assert.property(user, 'email')
+        assert.property(user, 'mnemonic')
 
         assert.property(user, '_id')
         assert.equal(user._id, _id)

test/e2e/automated/a10-usage.rest-e2e.js

@@ -0,0 +1,74 @@
+/*
+End-to-end tests for /usage endpoints.
+*/
+
+import config from '../../../config/index.js'
+import { assert } from 'chai'
+import axios from 'axios'
+import sinon from 'sinon'
+import util from 'util'
+
+util.inspect.defaultOptions = { depth: 1 }
+
+const LOCALHOST = `http://localhost:${config.port}`
+
+let sandbox
+
+describe('Usage', () => {
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('GET /usage', () => {
+    it('should return usage status', async () => {
+      try {
+        const options = {
+          method: 'get',
+          url: `${LOCALHOST}/usage`
+        }
+
+        const result = await axios(options)
+
+        assert.property(result.data, 'status')
+      } catch (err) {
+        assert(false, 'Unexpected result')
+      }
+    })
+  })
+
+  describe('GET /usage/ips', () => {
+    it('should return ips', async () => {
+      try {
+        const options = {
+          method: 'get',
+          url: `${LOCALHOST}/usage/ips`
+        }
+
+        const result = await axios(options)
+
+        assert.property(result.data, 'ips')
+      } catch (err) {
+        assert(false, 'Unexpected result')
+      }
+    })
+  })
+
+  describe('GET /usage/endpoints', () => {
+    it('should return ips', async () => {
+      try {
+        const options = {
+          method: 'get',
+          url: `${LOCALHOST}/usage/endpoints`
+        }
+
+        const result = await axios(options)
+
+        assert.property(result.data, 'endpoints')
+      } catch (err) {
+        assert(false, 'Unexpected result')
+      }
+    })
+  })
+})

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

@@ -6,7 +6,7 @@
 import { assert } from 'chai'
 import sinon from 'sinon'
 import cloneDeep from 'lodash.clonedeep'
-import { peerIdFromString } from '@libp2p/peer-id'
+// import { peerIdFromString } from '@libp2p/peer-id'
 
 // Local libraries
 import IPFSLib from '../../../src/adapters/ipfs/ipfs.js'
@@ -165,17 +165,17 @@ describe('#IPFS-adapter', () => {
       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 () => {}
-      })
+      // const 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({})
 

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

@@ -31,7 +31,8 @@ describe('#User-Adapter', () => {
     testuser = new User({
       email: 'test983@test.com',
       name: 'test983',
-      password: 'password'
+      password: 'password',
+      mnemonic: '12 words mnemonic'
     })
   })
 

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

@@ -0,0 +1,66 @@
+/*
+Unit tests for the REST API middleware that handle response errors.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local libraries
+import errorMiddleware from '../../../../../src/controllers/rest-api/middleware/error.js'
+import { context as mockContext } from '../../../../unit/mocks/ctx-mock.js'
+
+describe('#Validators', () => {
+  let ctx
+  let sandbox
+
+  beforeEach(() => {
+    // Mock the context object.
+    ctx = mockContext()
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#errorMiddleware', () => {
+    it('should run next function', async () => {
+      // Spy on next
+      const next = sinon.spy(() => { })
+      errorMiddleware()(ctx, next)
+
+      assert.isTrue(next.calledOnce)
+    })
+
+    it('should handle unknown status error', async () => {
+      try {
+        const next = async () => {
+          const e = new Error('test error')
+          e.status = null
+          throw e
+        }
+
+        await errorMiddleware()(ctx, next)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(ctx.status, 500)
+        assert.equal(ctx.body, 'test error')
+      }
+    })
+    it('should handle known status error', async () => {
+      try {
+        const next = async () => {
+          const e = new Error('test error')
+          e.status = 422
+          throw e
+        }
+
+        await errorMiddleware()(ctx, next)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(ctx.status, 422)
+        assert.equal(ctx.body, 'test error')
+      }
+    })
+  })
+})

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

@@ -0,0 +1,163 @@
+/*
+  Unit tests for the REST API handler for the /usage 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 UsageController from '../../../../../src/controllers/rest-api/usage/controller.js'
+
+import { context as mockContext } from '../../../mocks/ctx-mock.js'
+
+let uut
+let sandbox
+let ctx
+
+describe('#Usage-REST-Controller', () => {
+  // const testUser = {}
+
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+    uut = new UsageController({ 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 UsageController()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating /usage REST Controller.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new UsageController({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating /usage REST Controller.'
+        )
+      }
+    })
+  })
+
+  describe('#Get /usage', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        sandbox.stub(uut.useCases.usage, 'getRestSummary').throws(new Error('test error'))
+        await uut.getStatus(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      await uut.getStatus(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+
+      // Assert that expected properties exist in the returned data.
+      assert.property(ctx.response.body, 'status')
+    })
+  })
+
+  describe('#Get /ips', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        sandbox.stub(uut.useCases.usage, 'getTopIps').throws(new Error('test error'))
+        await uut.getTopIps(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      await uut.getTopIps(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+
+      // Assert that expected properties exist in the returned data.
+      assert.property(ctx.response.body, 'ips')
+    })
+  })
+
+  describe('#Get /endpoints', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        sandbox.stub(uut.useCases.usage, 'getTopEndpoints').throws(new Error('test error'))
+        await uut.getTopEndpoints(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      await uut.getTopEndpoints(ctx)
+
+      // Assert the expected HTTP response
+      assert.equal(ctx.status, 200)
+
+      // Assert that expected properties exist in the returned data.
+      assert.property(ctx.response.body, 'endpoints')
+    })
+  })
+
+  describe('#handleError', () => {
+    it('should pass an error message', () => {
+      try {
+        const err = {
+          status: 422,
+          message: 'Unprocessable Entity'
+        }
+
+        uut.handleError(ctx, err)
+      } catch (err) {
+        assert.include(err.message, 'Unprocessable Entity')
+      }
+    })
+    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')
+      }
+    })
+  })
+})

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

@@ -0,0 +1,75 @@
+/*
+Unit tests for the REST API handler for the /usage 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 UsageRouter from '../../../../../src/controllers/rest-api/usage/index.js'
+
+let uut
+let sandbox
+// let ctx
+
+// const mockContext = require('../../../../unit/mocks/ctx-mock').context
+
+describe('#Usage-REST-Router', () => {
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+    uut = new UsageRouter({ adapters, useCases })
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new UsageRouter()
+
+        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 UsageRouter({ 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/timer-controllers.unit.js

@@ -122,4 +122,19 @@ describe('#Timer-Controllers', () => {
       assert.equal(result, false)
     })
   })
+
+  describe('#cleanUsage', () => {
+    it('should kick off the Use Case', async () => {
+      const result = await uut.cleanUsage()
+
+      assert.equal(result, true)
+    })
+
+    it('should return false on error', async () => {
+      sandbox.stub(uut.useCases.usage, 'cleanUsage').throws(new Error('test error'))
+      const result = await uut.cleanUsage()
+
+      assert.equal(result, false)
+    })
+  })
 })

test/unit/mocks/adapters/index.js

@@ -150,6 +150,7 @@ const wallet = {
     return { cashAddress: 'fakeAddr', wif: 'fakeWif', hdIndex: 1 }
   },
   bchWallet: new MockBchWallet(),
+  BchWallet: MockBchWallet,
   moveTokens: async () => {},
   moveBch: async () => {},
   reclaimTokens: async ()=>{},

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

@@ -57,7 +57,25 @@ class Order {
     return {}
   }
   async removeStaleOrders(){
+    return {}
+  }
+}
 
+class UsageUseCaseMock {
+  async cleanUsage() {
+    return {}
+  }
+
+  async getRestSummary() {
+    return true
+  }
+
+  async getTopIps(params) {
+    return true
+  }
+
+  async getTopEndpoints(existingUser, newData) {
+    return true
   }
 }
 
@@ -70,6 +88,7 @@ class UseCasesMock {
   entry = new EntryUseCaseMock()
   offer = new Offer()
   order = new Order()
+  usage = new UsageUseCaseMock()
 }
 
 export default UseCasesMock;

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

@@ -0,0 +1,255 @@
+/*
+Unit tests for the use-cases/usage-use-cases.js  business logic library.
+
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local support libraries
+import adapters from '../mocks/adapters/index.js'
+
+// Mock
+import { context as mockContext } from '../mocks/ctx-mock.js'
+
+// Unit under test (uut)
+import { UsageUseCases, restCalls, usageMiddleware } from '../../../src/use-cases/usage-use-cases.js'
+
+describe('#usage-use-case', () => {
+  let uut
+  let sandbox
+  let ctx
+
+  before(async () => {
+
+  })
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+    uut = new UsageUseCases({ adapters })
+
+    // Set as empty array
+    restCalls.splice(0, restCalls.length)
+
+    ctx = mockContext()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new UsageUseCases()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of adapters must be passed in when instantiating Usage Use Cases library.'
+        )
+      }
+    })
+  })
+
+  describe('#cleanUsage', () => {
+    it('should delete older data than 24 hours', () => {
+      const now = new Date() // Mock date
+
+      // set older mock data
+      restCalls.push({
+        timestamp: now.getTime() - (60000 * 60 * 24),
+        ip: '127.0.0.1'
+      })
+
+      // Set recently mock data
+      restCalls.push({
+        timestamp: now.getTime(),
+        ip: 'localhost'
+      })
+
+      const result = uut.cleanUsage()
+
+      assert.isArray(result)
+      assert.equal(result.length, 1)
+      assert.equal(result[0].ip, 'localhost')
+    })
+
+    it('should handle error', () => {
+      try {
+        // Force an error
+        sandbox.stub(restCalls, 'filter').throws(new Error('uut error'))
+
+        uut.cleanUsage()
+
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'uut error')
+      }
+    })
+  })
+  describe('#getRestSummary', () => {
+    it('should get the number of rest calls', () => {
+      // Set mock data
+      restCalls.push({
+        ip: 'localhost'
+      })
+
+      const result = uut.getRestSummary()
+
+      assert.isNumber(result)
+      assert.equal(result, 1)
+    })
+
+    it('should handle error', () => {
+      try {
+        // Force an error
+        sandbox.stub(console, 'log').throws(new Error('uut error'))
+
+        uut.getRestSummary()
+
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'uut error')
+      }
+    })
+  })
+
+  describe('#getTopIps', () => {
+    it('should get top IPs', () => {
+      // Set mock data
+      restCalls.push({
+        ip: 'localhost'
+      })
+
+      // Set mock data
+      restCalls.push({
+        ip: 'localhost'
+      })
+
+      const result = uut.getTopIps()
+
+      assert.isArray(result)
+
+      assert.property(result[0], 'ip')
+      assert.property(result[0], 'cnt')
+
+      assert.equal(result[0].ip, 'localhost')
+      assert.equal(result[0].cnt, '2')
+    })
+    it('should return a maximum of 20 values', () => {
+      //  Fill Array with 21 values
+      for (let i = 0; i < 21; i++) {
+        restCalls.push({
+          ip: `localhost-${i}`
+        })
+      }
+
+      const result = uut.getTopIps()
+
+      assert.isArray(result)
+
+      assert.property(result[0], 'ip')
+      assert.property(result[0], 'cnt')
+
+      assert.equal(result.length, 20)
+    })
+    it('should handle error', () => {
+      try {
+        // Set mock data
+        restCalls.push(null)
+
+        uut.getTopIps()
+
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'Cannot read properties')
+      }
+    })
+  })
+
+  describe('#getTopEndpoints', () => {
+    it('should get top Endpoints', () => {
+      // Set mock data
+      restCalls.push({
+        ip: 'localhost',
+        url: '/api/v1/users',
+        method: 'GET'
+      })
+
+      // Set mock data
+      restCalls.push({
+        ip: 'localhost',
+        url: '/api/v1/users',
+        method: 'GET'
+      })
+
+      const result = uut.getTopEndpoints()
+
+      assert.isArray(result)
+
+      assert.property(result[0], 'endpoint')
+      assert.property(result[0], 'cnt')
+
+      assert.equal(result[0].endpoint, 'GET /api/v1/users')
+      assert.equal(result[0].cnt, '2')
+    })
+    it('should return a maximum of 20 values', () => {
+      //  Fill Array with 21 values
+      for (let i = 0; i < 21; i++) {
+        restCalls.push({
+          ip: 'localhost',
+          url: `/api/v1/users-${i}`,
+          method: 'GET'
+        })
+      }
+
+      const result = uut.getTopEndpoints()
+
+      assert.isArray(result)
+
+      assert.property(result[0], 'endpoint')
+      assert.property(result[0], 'cnt')
+
+      assert.equal(result.length, 20)
+    })
+
+    it('should handle error', () => {
+      try {
+        // Set mock data
+        restCalls.push(null)
+
+        uut.getTopEndpoints()
+
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.include(error.message, 'Cannot read properties')
+      }
+    })
+  })
+
+  describe('#usageMiddleware', () => {
+    it('should update restCalls state', async () => {
+      // Spy on next
+      const next = sinon.spy(() => { })
+
+      await usageMiddleware()(ctx, next)
+
+      assert.equal(restCalls.length, 1)
+      assert.isTrue(next.called)
+    })
+
+    it('should handle error', async () => {
+      try {
+        const next = () => { throw new Error('uut error') }
+
+        await usageMiddleware()(ctx, next)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'uut error')
+        assert.equal(ctx.status, 500)
+        assert.equal(restCalls.length, 0)
+      }
+    })
+  })
+})

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

@@ -117,6 +117,29 @@ describe('#users-use-case', () => {
         assert.include(err.message, 'test error')
       }
     })
+    it('should handle wallet errors', async () => {
+      try {
+        // Force an error with the database.
+        class MockErrorBchWallet {
+          constructor () {
+            this.walletInfoPromise = Promise.reject(new Error('test error'))
+          }
+        }
+        uut.BchWallet = MockErrorBchWallet
+
+        const usrObj = {
+          email: 'test@test.com',
+          password: 'password',
+          name: 'test'
+        }
+
+        await uut.createUser(usrObj)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
 
     it('should create a new user in the DB', async () => {
       // Note: The user created in this test is used by the getUser, update,
@@ -129,7 +152,6 @@ describe('#users-use-case', () => {
       }
 
       const { userData, token } = await uut.createUser(usrObj)
-
       testUser = userData
 
       // Commented out because there is some sophisticated mocking required that
@@ -327,6 +349,26 @@ describe('#users-use-case', () => {
         )
       }
     })
+    it('should throw an error if mnemonic is provided', async () => {
+      try {
+        const newData = {
+          email: 'test@test.com',
+          password: 'password',
+          name: 'test',
+          mnemonic: 'test'
+        }
+
+        await uut.updateUser(testUser, newData)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.include(
+          err.message,
+          "Property 'mnemonic' cannot be updated!"
+        )
+      }
+    })
 
     it('should update the user model', async () => {
       const newData = {