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

fix(ipfs-service-provider): Syncing with upstream repo

.gitignore

@@ -67,5 +67,7 @@ ipfsdata
 .ipfsdata
 ipfs-service-provider.sh
 start-bch-wallet-service.sh
+data/
+run-dev.sh
 
 !README.md

README.md

@@ -29,13 +29,34 @@ This repository is one step in a longer path. Here are the major milestones of t
 
 ## Installation
 
+### Development Environment
+
+A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. [PM2](https://www.npmjs.com/package/pm2) is recommended for running this code base as an IPFS Circuit Relay.
+
+- [Video: Installing ipfs-service-provider](https://youtu.be/Z0NsboIVN44)
+- [Step-by-step installation instructions](https://gist.github.com/christroutner/3304a71d4c12a3a3e1664a438f64d9d0)
+
 ```bash
 git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
 cd ipfs-bch-wallet-service
+./install-mongo-sh
 npm install
-npm start
+./ipfs-bch-wallet-service.sh
 ```
 
+### Production Environment
+
+The [docker](./production/docker) directory contains a Dockerfile for building a production deployment. However, there is currently [a bug](https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38) preventing the Docker container from being used as a Circuit Relay.
+
+```
+docker-compose build --no-cache
+docker-compose up -d
+```
+
+### Operation Notes
+
+- There is a memory leak in the version of js-ipfs. The app is currently configured to shut down every 8 hours to flush memory. It relies on a process manager like pm2, Docker, or systemd to restart the app after it shuts down, in order to ensure continuous operation.
+
 ## Structure
 
 The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](troutsblog.com/blog/clean-architecture).
@@ -77,3 +98,5 @@ Snapshots pinned to IPFS will be listed here.
 ## License
 
 [MIT](./LICENSE.md)
+
+a

bin/server.js

@@ -1,3 +1,12 @@
+/*
+  This Koa server has two interfaces:
+  - REST API over HTTP
+  - JSON RPC over IPFS
+
+  The architecture of the code follows the Clean Architecture pattern:
+  https://troutsblog.com/blog/clean-architecture
+*/
+
 // npm libraries
 const Koa = require('koa')
 const bodyParser = require('koa-bodyparser')
@@ -12,82 +21,97 @@ const cors = require('kcors')
 
 // Local libraries
 const config = require('../config') // this first.
-// const IPFSLib = require('../src/lib/ipfs')
 const AdminLib = require('../src/adapters/admin')
-const adminLib = new AdminLib()
-// const JSONRPC = require('../src/rpc')
-// const rpc = new JSONRPC()
-
 const errorMiddleware = require('../src/controllers/rest-api/middleware/error')
 const { wlogger } = require('../src/adapters/wlogger')
 
-async function startServer () {
-  // Create a Koa instance.
-  const app = new Koa()
-  app.keys = [config.session]
-
-  // Connect to the Mongo Database.
-  mongoose.Promise = global.Promise
-  mongoose.set('useCreateIndex', true) // Stop deprecation warning.
-  console.log(
-    `Connecting to MongoDB with this connection string: ${config.database}`
-  )
-  await mongoose.connect(config.database, {
-    useUnifiedTopology: true,
-    useNewUrlParser: true
-  })
-
-  // MIDDLEWARE START
-
-  app.use(convert(logger()))
-  app.use(bodyParser())
-  app.use(session())
-  app.use(errorMiddleware())
-
-  // Used to generate the docs.
-  app.use(mount('/', serve(`${process.cwd()}/docs`)))
-
-  // Mount the page for displaying logs.
-  app.use(mount('/logs', serve(`${process.cwd()}/config/logs`)))
-
-  // User Authentication
-  require('../config/passport')
-  app.use(passport.initialize())
-  app.use(passport.session())
-
-  // Attach REST API and JSON RPC controllersCt unstable to the app.
-  const Controllers = require('../src/controllers')
-  const controllers = new Controllers()
-  controllers.attachControllers(app)
-
-  // Enable CORS for testing
-  // THIS IS A SECURITY RISK. COMMENT OUT FOR PRODUCTION
-  app.use(cors({ origin: '*' }))
-
-  // MIDDLEWARE END
-
-  console.log(`Running server in environment: ${config.env}`)
-  wlogger.info(`Running server in environment: ${config.env}`)
-
-  await app.listen(config.port)
-  console.log(`Server started on ${config.port}`)
-
-  // Create the system admin user.
-  try {
-    const success = await adminLib.createSystemUser()
-    if (success) console.log('System admin user created.')
-  } catch (err) {
-    console.warn(
-      'Error trying to create system admin. Perhaps one already exists?'
-    )
+class Server {
+  constructor () {
+    this.adminLib = new AdminLib()
   }
 
-  return app
-}
-// startServer()
+  async startServer () {
+    try {
+      // Create a Koa instance.
+      const app = new Koa()
+      app.keys = [config.session]
 
-// export default app
-// module.exports = app
-module.exports = {
-  startServer
+      // Connect to the Mongo Database.
+      mongoose.Promise = global.Promise
+      mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+      console.log(
+        `Connecting to MongoDB with this connection string: ${config.database}`
+      )
+      await mongoose.connect(config.database, {
+        useUnifiedTopology: true,
+        useNewUrlParser: true
+      })
+
+      console.log(`Starting environment: ${config.env}`)
+      console.log(`Debug level: ${config.debugLevel}`)
+
+      // MIDDLEWARE START
+
+      app.use(convert(logger()))
+      app.use(bodyParser())
+      app.use(session())
+      app.use(errorMiddleware())
+
+      // Used to generate the docs.
+      app.use(mount('/', serve(`${process.cwd()}/docs`)))
+
+      // Mount the page for displaying logs.
+      app.use(mount('/logs', serve(`${process.cwd()}/config/logs`)))
+
+      // User Authentication
+      require('../config/passport')
+      app.use(passport.initialize())
+      app.use(passport.session())
+
+      // Attach REST API and JSON RPC controllers to the app.
+      const Controllers = require('../src/controllers')
+      const controllers = new Controllers()
+      await controllers.attachRESTControllers(app)
+
+      app.controllers = controllers
+
+      // Enable CORS for testing
+      // THIS IS A SECURITY RISK. COMMENT OUT FOR PRODUCTION
+      app.use(cors({ origin: '*' }))
+
+      // MIDDLEWARE END
+
+      console.log(`Running server in environment: ${config.env}`)
+      wlogger.info(`Running server in environment: ${config.env}`)
+
+      await app.listen(config.port)
+      console.log(`Server started on ${config.port}`)
+
+      // Create the system admin user.
+      try {
+        const success = await this.adminLib.createSystemUser()
+        if (success) console.log('System admin user created.')
+      } catch (err) {
+        console.warn(
+          'Error trying to create system admin. Perhaps one already exists?'
+        )
+      }
+
+      // Attach the other IPFS controllers
+      await controllers.attachControllers(app)
+
+      // ipfs-coord has a memory leak. This app shuts down after 4 hours. It
+      // expects to be run by Docker or pm2, which can automatically restart
+      // the app.
+      setTimeout(function () {
+        process.exit(0)
+      }, 60000 * 60 * 4)
+
+      return app
+    } catch (err) {
+      console.error('Could not start server. Error: ', err)
+    }
+  }
 }
+
+module.exports = Server

config/env/common.js

@@ -13,6 +13,8 @@ const ipfsCoordName = process.env.COORD_NAME
   ? process.env.COORD_NAME
   : 'ipfs-bch-wallet-service'
 
+console.log('GET_JWT_AT_STARTUP: ', process.env.GET_JWT_AT_STARTUP)
+
 module.exports = {
   // Configure TCP port.
   port: process.env.PORT || 5001,
@@ -32,16 +34,19 @@ module.exports = {
     : 'emailpassword',
 
   // FullStack.cash account information, used for automatic JWT handling.
-  AUTHSERVER: process.env.AUTHSERVER
+  getJwtAtStartup: process.env.GET_JWT_AT_STARTUP ? true : false,
+  authServer: process.env.AUTHSERVER
     ? process.env.AUTHSERVER
     : 'https://auth.fullstack.cash',
-  APISERVER: process.env.APISERVER
+  apiServer: process.env.APISERVER
     ? process.env.APISERVER
     : 'https://api.fullstack.cash/v5/',
-  FULLSTACKLOGIN: process.env.FULLSTACKLOGIN
+  fullstackLogin: process.env.FULLSTACKLOGIN
     ? process.env.FULLSTACKLOGIN
     : 'demo@demo.com',
-  FULLSTACKPASS: process.env.FULLSTACKPASS ? process.env.FULLSTACKPASS : 'demo',
+  fullstackPassword: process.env.FULLSTACKPASS
+    ? process.env.FULLSTACKPASS
+    : 'demo',
 
   // IPFS settings.
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
@@ -70,5 +75,10 @@ module.exports = {
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 5668,
-  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669
+  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669,
+
+  // BCH Mnemonic for generating encryption keys and payment address
+  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
+
+  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2
 }

database/README.md

@@ -1 +0,0 @@
-This is where the mongodb docker container stores its db files.

index.js

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

ipfs-bch-wallet-service.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# Ports
+export PORT=5001 # REST API port
+export IPFS_TCP_PORT=5268
+export IPFS_WS_PORT=5269
+
+#export ENABLE_CIRCUIT_RELAY=1
+
+# Production database connection string.
+#export DBURL=mongodb://localhost:27017/bch-service-dev
+
+export COORD_NAME=ipfs-service-provider-generic
+export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
+
+export DEBUG_LEVEL=1
+
+npm start

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.9.1",
+  "version": "1.11.12",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "scripts": {
@@ -23,12 +23,12 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "^4.20.2",
+    "@psf/bch-js": "^4.20.3",
     "axios": "^0.21.1",
     "bcryptjs": "^2.4.3",
     "glob": "^7.1.6",
-    "ipfs": "^0.54.4",
-    "ipfs-coord": "^5.0.0",
+    "@chris.troutner/ipfs": "2.0.2",
+    "ipfs-coord": "^6.6.6",
     "jsonrpc-lite": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
     "jwt-bch-lib": "^1.3.0",
@@ -45,6 +45,7 @@
     "koa2-ratelimit": "^0.9.0",
     "line-reader": "^0.4.0",
     "mongoose": "^5.11.15",
+    "node-fetch": "npm:@achingbrain/node-fetch@^2.6.7",
     "nodemailer": "^6.4.17",
     "passport-local": "^1.0.0",
     "winston": "^3.3.3",

production/docker-compose.yml

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

production/docker/Dockerfile

@@ -2,55 +2,66 @@
 #
 
 #IMAGE BUILD COMMANDS
-# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
-FROM christroutner/ct-base-ubuntu
+FROM ubuntu:20.04
 MAINTAINER Chris Troutner <chris.troutner@gmail.com>
 
+#Update the OS and install any OS packages needed.
+RUN apt-get update
+RUN apt-get install -y sudo git curl nano gnupg wget
+
+#Install Node and NPM
+RUN curl -sL https://deb.nodesource.com/setup_14.x -o nodesource_setup.sh
+RUN bash nodesource_setup.sh
+RUN apt-get install -y nodejs build-essential
+
 #Create the user 'safeuser' and add them to the sudo group.
-#RUN useradd -ms /bin/bash safeuser
-#RUN adduser safeuser sudo
+RUN useradd -ms /bin/bash safeuser
+RUN adduser safeuser sudo
 
 #Set password to 'password' change value below if you want a different password
-#RUN echo safeuser:password | chpasswd
+RUN echo safeuser:password | chpasswd
 
 #Set the working directory to be the home directory
 WORKDIR /home/safeuser
 
 #Setup NPM for non-root global install
-#RUN mkdir /home/safeuser/.npm-global
-#RUN chown -R safeuser .npm-global
-#RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
-#RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+RUN mkdir /home/safeuser/.npm-global
+RUN chown -R safeuser .npm-global
+RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
+RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+
+# Update to the latest version of npm.
+# Working with npm@7.21.1
+RUN npm install -g npm
 
 # Switch to user account.
-USER safeuser
+#USER safeuser
 # Prep 'sudo' commands.
-RUN echo 'abcd8765' | sudo -S pwd
+#RUN echo 'abcd8765' | sudo -S pwd
 
-# Clone the rest.bitcoin.com repository
+# Clone the repository
 WORKDIR /home/safeuser
 RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
-# RUN mv koa-api-boilerplate koa
-# RUN mkdir keys
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
 WORKDIR /home/safeuser/ipfs-bch-wallet-service
 
 # For development: switch to unstable branch
-# RUN git checkout unstable
+RUN git checkout ct-unstable
 
 # Install dependencies
+RUN npm install -g @mapbox/node-pre-gyp
 RUN npm install
 
 # Generate the API docs
 RUN npm run docs
 
 # Calling out the directorys that should be mounted as external volumes.
-RUN mkdir /home/safeuser/ipfsdata
-RUN mkdir /home/safeuser/orbitdb
-VOLUME /home/safeuser/ipfsdata
-VOLUME /home/safeuser/orbitdb
+RUN mkdir /home/safeuser/.ipfsdata
+#RUN mkdir /home/safeuser/orbitdb
+#VOLUME /home/safeuser/ipfsdata
+#VOLUME /home/safeuser/orbitdb
 
 # Start the application.
 COPY start-production.sh start-production.sh

production/docker/docker-compose.yml

@@ -0,0 +1,31 @@
+# Start the service with the command 'docker-compose up -d'
+
+version: '2'
+services:
+  bch-wallet-mongodb:
+    image: mongo
+    container_name: mongo-bch-service
+    ports:
+      - '5555:27017' # <host port>:<container port>
+    volumes:
+      - ../data/mongodb:/data/db
+    command: mongod --logpath=/dev/null # -- quiet
+    restart: always
+
+  bch-wallet-service:
+    build: ./
+    container_name: bch-wallet-service
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    links:
+      - bch-wallet-mongodb
+    ports:
+      # <host port>:<container port>
+      - '5001:5001' # REST API
+      - '5668:5668' # IPFS TCP Port
+      - '5669:5669' # IPFS WS Port
+    volumes:
+      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata

production/docker/start-production.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# BEGIN: Optional configuration settings
+
+# This mnemonic is used to set up persistent public key for e2ee
+# Replace this with your own 12-word mnemonic.
+export MNEMONIC="olive two muscle bottom coral ancient wait legend bronze useful process session"
+
+# The human readable name this IPFS node identifies as.
+export COORD_NAME=bch-wallet-service-generic
+
+# Allow this node to function as a circuit relay. It must not be behind a firewall.
+#export ENABLE_CIRCUIT_RELAY=true
+
+# Debug level. 0 = minimal info. 2 = max info.
+export DEBUG_LEVEL=1
+
+# END: Optional configuration settings
+
+
+# Production database connection string.
+export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+
+# Customize these environment variables for your own installation.
+export GET_JWT_AT_STARTUP=1
+export AUTHSERVER=https://auth.fullstack.cash
+export APISERVER=https://api.fullstack.cash/v5/
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
+
+# Ports
+export PORT=5001 # REST API
+export IPFS_TCP_PORT=5668 # IPSF TCP Port
+export IPFS_WS_PORT=5669 # IPFS WS Port
+
+export SVC_ENV=production
+npm start

production/start-production.sh

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

src/adapters/fullstack-jwt.js

@@ -23,13 +23,13 @@ class FullStackJWT {
         'Must pass a url for the API server when instantiating FullStackJWT class.'
       )
     }
-    this.login = localConfig.login
+    this.login = localConfig.fullstackLogin
     if (!this.login || typeof this.login !== 'string') {
       throw new Error(
         'Must pass a FullStack.cash login (email) instantiating FullStackJWT class.'
       )
     }
-    this.password = localConfig.password
+    this.password = localConfig.fullstackPassword
     if (!this.password || typeof this.password !== 'string') {
       throw new Error(
         'Must pass a FullStack.cash account password when instantiating FullStackJWT class.'
@@ -39,7 +39,7 @@ class FullStackJWT {
     // Encapsulate dependencies
     this.jwtLib = new JwtLib({
       // Overwrite default values with the values in the config file.
-      server: this.server,
+      server: this.authServer,
       login: this.login,
       password: this.password
     })
@@ -53,7 +53,7 @@ class FullStackJWT {
   async getJWT () {
     try {
       // Skip connecting FullStack.cash auth server to the network if this is an E2E test.
-      if (process.env.E2ETEST) {
+      if (process.env.TEST_TYPE === 'e2e') {
         this.apiToken = 'faketoken'
         return this.apiToken
       }

src/adapters/index.js

@@ -4,44 +4,56 @@
   https://troutsblog.com/blog/clean-architecture
 */
 
-// Load the config file
-const config = require('../../config')
+// Public NPM libraries
+const BCHJS = require("@psf/bch-js");
 
 // Load individual adapter libraries.
-const IPFSAdapter = require('./ipfs')
-const LocalDB = require('./localdb')
-const LogsAPI = require('./logapi')
-const Passport = require('./passport')
-const Nodemailer = require('./nodemailer')
-const { wlogger } = require('./wlogger')
-const JSONFiles = require('./json-files')
-const FullStackJWT = require('./fullstack-jwt')
+const IPFSAdapter = require("./ipfs");
+const LocalDB = require("./localdb");
+const LogsAPI = require("./logapi");
+const Passport = require("./passport");
+const Nodemailer = require("./nodemailer");
+// const { wlogger } = require('./wlogger')
+const JSONFiles = require("./json-files");
+const FullStackJWT = require("./fullstack-jwt");
 
-// Instantiate adapter libraries.
-const ipfs = new IPFSAdapter()
-const localdb = new LocalDB()
-const logapi = new LogsAPI()
-const passport = new Passport()
-const nodemailer = new Nodemailer()
-const jsonFiles = new JSONFiles()
+const config = require("../../config");
 
-// Get a valid JWT API key and instance bch-js.
-const fullStackJwt = new FullStackJWT({
-  authServer: config.AUTHSERVER,
-  apiServer: config.APISERVER,
-  login: config.FULLSTACKLOGIN,
-  password: config.FULLSTACKPASS
-})
-const bchjs = {} // Placeholder.
+class Adapters {
+  constructor(localConfig = {}) {
+    // Encapsulate dependencies
+    this.ipfs = new IPFSAdapter();
+    this.localdb = new LocalDB();
+    this.logapi = new LogsAPI();
+    this.passport = new Passport();
+    this.nodemailer = new Nodemailer();
+    this.jsonFiles = new JSONFiles();
+    this.bchjs = new BCHJS();
+    this.config = config;
 
-module.exports = {
-  ipfs,
-  localdb,
-  logapi,
-  passport,
-  nodemailer,
-  wlogger,
-  jsonFiles,
-  fullStackJwt,
-  bchjs
+    // Get a valid JWT API key and instance bch-js.
+    this.fullStackJwt = new FullStackJWT(config);
+  }
+
+  async start() {
+    try {
+      if (this.config.getJwtAtStartup) {
+        // Get a JWT token and instantiate bch-js with it. Then pass that instance
+        // to all the rest of the apps controllers and adapters.
+        await this.fullStackJwt.getJWT();
+        // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
+        this.bchjs = await this.fullStackJwt.instanceBchjs();
+      } else {
+        this.bchjs = new BCHJS({ restURL: this.config.apiServer });
+      }
+
+      // Start the IPFS node.
+      await this.ipfs.start({ bchjs: this.bchjs });
+    } catch (err) {
+      console.error("Error in adapters/index.js/start()");
+      throw err;
+    }
+  }
 }
+
+module.exports = Adapters;

src/adapters/ipfs/index.js

@@ -46,6 +46,19 @@ class IPFS {
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')
+
+      // If we are not in a test environment.
+      if (process.env.SVC_ENV !== 'test') {
+        // If error is due to a lock file issue. Kill the process, so that
+        // Docker or pm2 has a chance to restart the service.
+        if (err.message.includes('Lock already being held')) {
+          console.log(
+            'Lock file issue with IPFS. Shutting down so that process manager can restart app.'
+          )
+          process.exit(1)
+        }
+      }
+
       throw err
     }
   }

src/adapters/ipfs/ipfs-coord.js

@@ -43,6 +43,8 @@ class IpfsCoordAdapter {
   }
 
   async start (localConfig = {}) {
+    // console.log('this.config.announceJsonLd: ', this.config.announceJsonLd)
+
     this.ipfsCoord = new this.IpfsCoord({
       ipfs: this.ipfs,
       type: 'node.js',
@@ -51,19 +53,13 @@ class IpfsCoordAdapter {
       privateLog: console.log, // Default to console.log
       isCircuitRelay: this.config.isCircuitRelay,
       apiInfo: this.config.apiInfo,
-      announceJsonLd: this.config.announceJsonLd
+      announceJsonLd: this.config.announceJsonLd,
+      mnemonic: this.config.mnemonic,
+      debugLevel: this.config.debugLevel
     })
 
-    // Skip connecting ipfs-coord to the network if this is an E2E test.
-    if (!process.env.E2ETEST) {
-      // Wait for the ipfs-coord library to signal that it is ready.
-      await this.ipfsCoord.ipfs.start()
-
-      // some ipfs-coord versions do not have this function
-      if (this.ipfsCoord.isReady) {
-        await this.ipfsCoord.isReady()
-      }
-    }
+    // Wait for the ipfs-coord library to signal that it is ready.
+    await this.ipfsCoord.start({ type: 'node.js' })
 
     // Signal that this adapter is ready.
     this.isReady = true
@@ -76,7 +72,7 @@ class IpfsCoordAdapter {
   attachRPCRouter (router) {
     try {
       _this.ipfsCoord.privateLog = router
-      _this.ipfsCoord.ipfs.orbitdb.privateLog = router
+      _this.ipfsCoord.adapters.orbit.privateLog = router
     } catch (err) {
       console.error('Error in attachRPCRouter()')
       throw err

src/adapters/ipfs/ipfs.js

@@ -2,10 +2,15 @@
   Clean Architecture Adapter for IPFS.
   This library deals with IPFS so that the apps business logic doesn't need
   to have any specific knowledge of the js-ipfs library.
+
+  TODO: Add the external IP address to the list of multiaddrs advertised by
+  this node. See this GitHub Issue for details:
+  https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38
 */
 
 // Global npm libraries
-const IPFS = require('ipfs')
+// const IPFS = require('ipfs')
+const IPFS = require('@chris.troutner/ipfs')
 
 // Local libraries
 const config = require('../../../config')
@@ -25,7 +30,7 @@ class IpfsAdapter {
     try {
       // Ipfs Options
       const ipfsOptions = {
-        repo: './ipfsdata',
+        repo: './.ipfsdata/ipfs',
         start: true,
         config: {
           relay: {
@@ -56,17 +61,6 @@ class IpfsAdapter {
       // Set the 'server' profile so the node does not scan private networks.
       await this.ipfs.config.profiles.apply('server')
 
-      // const nodeConfig = await this.ipfs.config.getAll()
-      // console.log(
-      //   `IPFS node configuration: ${JSON.stringify(nodeConfig, null, 2)}`
-      // )
-
-      // Stop the IPFS node if we're running tests.
-      if (this.config.env === 'test') {
-        console.log('Stopping IPFS for tests.')
-        await this.ipfs.stop()
-      }
-
       // Signal that this adapter is ready.
       this.isReady = true
 
@@ -76,6 +70,10 @@ class IpfsAdapter {
       throw err
     }
   }
+
+  async stop () {
+    await this.ipfs.stop()
+  }
 }
 
 module.exports = IpfsAdapter

src/adapters/wlogger.js

@@ -62,42 +62,11 @@ class Wlogger {
   }
 }
 
-// transport.on('rotate', notifyRotation)
-
-// function notifyRotation (oldFilename, newFilename) {
-//   wlogger.info('Rotating log files')
-// }
-
-// This controls what goes into the log FILES
-// const wlogger = winston.createLogger({
-//   level: 'verbose',
-//   format: winston.format.json(),
-//   transports: [
-//     //
-//     // - Write to all logs with level `info` and below to `combined.log`
-//     // - Write all logs error (and below) to `error.log`.
-//     //
-//     // new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
-//     // new winston.transports.File({ filename: 'logs/combined.log' })
-//     transport
-//   ]
-// })
-
-// function outputToConsole () {
-//   wlogger.add(
-//     new winston.transports.Console({
-//       format: winston.format.simple(),
-//       level: 'info'
-//     })
-//   )
-// }
-
-// This controls the logs to CONSOLE
-// if (config.env !== 'test') {
-//   outputToConsole()
-// }
-
 const logger = new Wlogger()
+
+// Allow the logger to write to the console.
+logger.outputToConsole()
+
 const wlogger = logger.wlogger
 
 module.exports = { wlogger, Wlogger }

src/controllers/index.js

@@ -7,7 +7,7 @@
 // Public npm libraries.
 
 // Load the Clean Architecture Adapters library
-const adapters = require('../adapters')
+const Adapters = require('../adapters')
 
 // Load the JSON RPC Controller.
 const JSONRPC = require('./json-rpc')
@@ -21,22 +21,13 @@ const RESTControllers = require('./rest-api')
 
 class Controllers {
   constructor (localConfig = {}) {
-    this.adapters = adapters
-    this.useCases = new UseCases({ adapters })
+    this.adapters = new Adapters()
+    this.useCases = new UseCases({ adapters: this.adapters })
   }
 
   async attachControllers (app) {
-    // Get a JWT token and instantiate bch-js with it. Then pass that instance
-    // to all the rest of the apps controllers and adapters.
-    await adapters.fullStackJwt.getJWT()
-    // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
-    adapters.bchjs = await adapters.fullStackJwt.instanceBchjs()
-
-    // Attach the REST controllers to the Koa app.
-    this.attachRESTControllers(app)
-
-    // Start IPFS.
-    await this.adapters.ipfs.start({ bchjs: adapters.bchjs })
+    // Wait for any startup processes to complete for the Adapters libraries.
+    await this.adapters.start()
 
     this.attachRPCControllers()
   }
@@ -44,13 +35,13 @@ class Controllers {
   // Top-level function for this library.
   // Start the various Controllers and attach them to the app.
   attachRESTControllers (app) {
-    const rESTControllers = new RESTControllers({
+    const restControllers = new RESTControllers({
       adapters: this.adapters,
       useCases: this.useCases
     })
 
     // Attach the REST API Controllers associated with the boilerplate code to the Koa app.
-    rESTControllers.attachRESTControllers(app)
+    restControllers.attachRESTControllers(app)
   }
 
   // Add the JSON RPC router to the ipfs-coord adapter.

src/controllers/json-rpc/index.js

@@ -38,6 +38,11 @@ class JSONRPC {
     this.aboutController = new AboutController()
     this.bchController = new BCHController(localConfig)
 
+    // Cache to store IDs of processed JSON RPC commands. Used to prevent
+    // duplicate processing.
+    this.msgCache = []
+    this.MSG_CACHE_SIZE = 30
+
     _this = this
   }
 
@@ -45,26 +50,48 @@ class JSONRPC {
   // which controller to route the instruction to.
   async router (str, from) {
     try {
-      console.log('router str: ', str)
-      console.log('router from: ', from)
+      // console.log('router str: ', str)
+      console.log('JSON RPC router recieved data from: ', from)
 
       // Exit quietly if 'from' is not specified.
       if (!from || typeof from !== 'string') {
-        // console.warn(
-        //   'Warning: Can not send JSON RPC response. Can not determine which peer this message came from.'
-        // )
+        wlogger.info(
+          'Warning: Can not send JSON RPC response. Can not determine which peer this message came from.'
+        )
         return
       }
 
       // Attempt to parse the incoming data as a JSON RPC string.
       const parsedData = _this.jsonrpc.parse(str)
-      // console.log('parsedData: ', parsedData)
+      // wlogger.debug(`parsedData: ${JSON.stringify(parsedData, null, 2)}`)
 
       // Exit quietly if the incoming string is an invalid JSON RPC string.
       if (parsedData.type === 'invalid') {
+        wlogger.info('Rejecting invalid JSON RPC command.')
         return
       }
 
+      // Check for duplicate entries with same 'id' value.
+      const alreadyProcessed = _this._checkIfAlreadyProcessed(parsedData)
+      if (alreadyProcessed) {
+        return
+      } else {
+        // This node will regularly ping known circuit relays with an /about
+        // JSON RPC call. These will be handled by ipfs-coord, but will percolate
+        // up to ipfs-coord. Ignore these messages.
+        if (
+          parsedData.type.includes('success') &&
+          parsedData.payload.method === undefined
+        ) {
+          return
+        }
+
+        // Log the incoming JSON RPC command.
+        wlogger.info(
+          `JSON RPC received from ${from}, ID: ${parsedData.payload.id}, type: ${parsedData.type}, method: ${parsedData.payload.method}`
+        )
+      }
+
       // Added the property "from" to the parsedData object;
       // necessary for calculating rate limits (based on the IPFS ID).
       parsedData.from = from
@@ -100,8 +127,19 @@ class JSONRPC {
 
       // Encrypt and publish the response to the originators private OrbitDB,
       // if ipfs-coord has been initialized and the peers ID is registered.
-      if (_this.ipfsCoord.ipfs) {
-        await _this.ipfsCoord.ipfs.orbitdb.sendToDb(from, retStr)
+
+      // console.log('responding to JSON RPC command')
+      const thisNode = _this.ipfsCoord.thisNode
+      // console.log('thisNode: ', thisNode)
+
+      try {
+        await _this.ipfsCoord.useCases.peer.sendPrivateMessage(
+          from,
+          retStr,
+          thisNode
+        )
+      } catch (err) {
+        console.log('sendPrivateMessage() err: ', err)
       }
 
       // Return the response and originator. Useful for testing.
@@ -113,6 +151,34 @@ class JSONRPC {
     }
   }
 
+  // Checks the ID of the JSON RPC call, to see if the message has already been
+  // processed. Returns true if the ID exists in the cache of processed messages.
+  // If the ID is new, the function adds it to the cache and return false.
+  _checkIfAlreadyProcessed (data) {
+    try {
+      const id = data.payload.id
+
+      // Check if the hash is in the array of already processed message.
+      const alreadyProcessed = this.msgCache.includes(id)
+
+      // Update the msgCache if this is a new message.
+      if (!alreadyProcessed) {
+        // Add the hash to the array.
+        this.msgCache.push(id)
+
+        // If the array is at its max size, then remove the oldest element.
+        if (this.msgCache.length > this.MSG_CACHE_SIZE) {
+          this.msgCache.shift()
+        }
+      }
+
+      return alreadyProcessed
+    } catch (err) {
+      console.error('Error in _checkIfAlreadyProcessed: ', err)
+      return false
+    }
+  }
+
   // The default JSON RPC response if the incoming command could not be routed.
   defaultResponse () {
     const errorObj = {

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

@@ -10,7 +10,7 @@ const axios = require('axios').default
 
 // Local support libraries
 const config = require('../../../config')
-const app = require('../../../bin/server')
+const Server = require('../../../bin/server')
 const testUtils = require('../../utils/test-utils')
 const AdminLib = require('../../../src/adapters/admin')
 const adminLib = new AdminLib()
@@ -23,11 +23,14 @@ const LOCALHOST = `http://localhost:${config.port}`
 describe('Auth', () => {
   before(async () => {
     try {
-      process.env.E2ETEST = 'true'
+      const app = new Server()
 
       // This should be the first instruction. It starts the REST API server.
       await app.startServer()
 
+      // Stop the IPFS node for the rest of the e2e tests.
+      // await app.controllers.adapters.ipfs.stop()
+
       // Delete all previous users in the database.
       await testUtils.deleteAllUsers()
 

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

@@ -12,7 +12,8 @@ const LOCALHOST = `http://localhost:${config.port}`
 const context = {}
 
 const UserController = require('../../../src/controllers/rest-api/users/controller')
-const adapters = require('../../../src/adapters')
+const Adapters = require('../../../src/adapters')
+const adapters = new Adapters()
 const UseCases = require('../../../src/use-cases/')
 let uut
 let sandbox

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

@@ -45,12 +45,17 @@ class TestUtils {
   async sendRPC (ipfsId, cmdStr) {
     try {
       // Send the RPC command to the server/service.
-      await this.ipfsCoord.ipfs.orbitdb.sendToDb(ipfsId, cmdStr)
+      // await this.ipfsCoord.ipfs.orbitdb.sendToDb(ipfsId, cmdStr)
+      await this.ipfsCoord.useCases.peer.sendPrivateMessage(
+        ipfsId,
+        cmdStr,
+        this.ipfsCoord.thisNode
+      )
 
       let retData
 
       // This event is triggered when the response comes back.
-      this.eventEmitter.on('rpcData', inData => {
+      this.eventEmitter.on('rpcData', (inData) => {
         retData = inData
       })
 
@@ -98,11 +103,8 @@ class TestUtils {
         apiInfo: 'none',
         announceJsonLd: announceJsonLd
       })
-      await this.ipfsCoord.ipfs.start()
-      // some ipfs-coord versions do not have this function
-      if (this.ipfsCoord.isReady) {
-        await this.ipfsCoord.isReady()
-      }
+
+      await this.ipfsCoord.start()
 
       // Wait to let ipfs-coord connect to subnet peers.
       await this.bchjs.Util.sleep(30000)
@@ -126,10 +128,17 @@ class TestUtils {
       //   'ipfs-coord peer info: ',
       //   this.ipfsCoord.ipfs.peers.state.peers[ipfsId]
       // )
-      if (!this.ipfsCoord.ipfs.peers.state.peers[ipfsId]) {
+
+      const peers = this.ipfsCoord.thisNode.peerList
+      // console.log('peers: ', peers)
+      // console.log('Target peer in peerList? ', peers.includes(ipfsId))
+
+      // if (!this.ipfsCoord.ipfs.peers.state.peers[ipfsId]) {
+      if (!peers.includes(ipfsId)) {
         throw new Error('Could not find UUT in ipfs-coord list of peers.')
       }
     } catch (err) {
+      console.log(err)
       console.error('Error in connectToUut()')
       console.log(
         'Is the service running? Did you update the test-data.json file?'
@@ -215,7 +224,10 @@ class TestUtils {
       const result = await this.sendRPC(ipfsId, cmdStr)
       // console.log('result: ', result)
 
-      if (result.result.value.status && Array.isArray(result.result.value.transactions)) {
+      if (
+        result.result.value.status &&
+        Array.isArray(result.result.value.transactions)
+      ) {
         console.log('E2E TEST: transactions test passed.')
         return true
       } else {

test/e2e/manual/consumer/test-data.json

@@ -1,4 +1,4 @@
 {
-  "uutAddr": "/ip4/192.168.43.115/tcp/5668/p2p/QmVBWvFxao7smhRjUUh1q8rNAEwMqbg4X3dqsQDMSjUpmx",
-  "uutId": "QmfUjMqUeXSCzNkFGrzvf79yvV62dtjsnwtBSYKx3wegXw"
+  "uutAddr": "/ip4/127.0.0.1/tcp/5701/p2p/QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2",
+  "uutId": "QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2"
 }

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

@@ -18,8 +18,8 @@ describe('#FullStackJWT', () => {
     const localConfig = {
       authServer: 'someserver',
       apiServer: 'someserver',
-      login: 'somelogin',
-      password: 'somepassword'
+      fullstackLogin: 'somelogin',
+      fullstackPassword: 'somepassword'
     }
     uut = new FullStackJWT(localConfig)
   })
@@ -81,7 +81,7 @@ describe('#FullStackJWT', () => {
         const localConfig = {
           authServer: 'someserver',
           apiServer: 'someserver',
-          login: 'somelogin'
+          fullstackLogin: 'somelogin'
         }
         uut = new FullStackJWT(localConfig)
 

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

@@ -65,7 +65,7 @@ describe('#IPFS', () => {
   })
 
   describe('#attachRPCRouter', () => {
-    it('should attached a router output', async () => {
+    it('should attach a router output', async () => {
       // Mock dependencies
       uut.ipfsCoord = {
         privateLog: {},
@@ -73,6 +73,11 @@ describe('#IPFS', () => {
           orbitdb: {
             privateLog: {}
           }
+        },
+        adapters: {
+          orbit: {
+            privateLog: () => {}
+          }
         }
       }
 
@@ -81,16 +86,16 @@ describe('#IPFS', () => {
       uut.attachRPCRouter(router)
     })
 
-    it('should throw an error if ipfs-coord has not been instantiated', () => {
-      try {
-        const router = console.log
-
-        uut.attachRPCRouter(router)
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
-        assert.include(err.message, 'Cannot read property')
-      }
-    })
+    // it('should throw an error if ipfs-coord has not been instantiated', () => {
+    //   try {
+    //     const router = console.log
+    //
+    //     uut.attachRPCRouter(router)
+    //
+    //     assert.fail('Unexpected code path')
+    //   } catch (err) {
+    //     assert.include(err.message, 'Cannot read property')
+    //   }
+    // })
   })
 })

test/unit/controllers/controllers.unit.js

@@ -6,8 +6,6 @@
 const assert = require('chai').assert
 const sinon = require('sinon')
 
-const adapters = require('../../../src/adapters')
-// const { attachControllers } = require('../../../src/controllers')
 const Controllers = require('../../../src/controllers')
 
 describe('#Controllers', () => {
@@ -24,11 +22,14 @@ describe('#Controllers', () => {
 
   describe('#attachControllers', () => {
     it('should attach the controllers', async () => {
-      // mock IPFS
-      sandbox.stub(adapters.fullStackJwt, 'getJWT').resolves({})
-      sandbox.stub(adapters.fullStackJwt, 'instanceBchjs').resolves({})
-      sandbox.stub(adapters.ipfs, 'start').resolves({})
-      adapters.ipfs.ipfsCoordAdapter = {
+      // mock dependencies
+      // sandbox.stub(adapters.fullStackJwt, 'getJWT').resolves({})
+      // sandbox.stub(adapters.fullStackJwt, 'instanceBchjs').resolves({})
+      // sandbox.stub(adapters.ipfs, 'start').resolves({})
+      // adapters.ipfs.ipfsCoordAdapter = {
+
+      sandbox.stub(uut.adapters, 'start').resolves({})
+      uut.adapters.ipfs.ipfsCoordAdapter = {
         attachRPCRouter: () => {}
       }
 
@@ -44,9 +45,7 @@ describe('#Controllers', () => {
     it('should catch and throw errors', async () => {
       try {
         // Force an error
-        sandbox
-          .stub(adapters.fullStackJwt, 'getJWT')
-          .rejects(new Error('test error'))
+        sandbox.stub(uut.adapters, 'start').rejects(new Error('test error'))
 
         const app = {
           use: () => {}