fix(upstream): Synced with upstream ipfs-service-provider

README.md

@@ -32,6 +32,7 @@ This repository is one step in a longer path. Here are the major milestones of t
 ```bash
 git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
 cd ipfs-bch-wallet-service
+sudo npm install -g node-pre-gyp
 npm install
 npm start
 ```

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,16 +21,17 @@ 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 () {
+class Server {
+  constructor () {
+    this.adminLib = new AdminLib()
+  }
+
+  async startServer () {
+    try {
       // Create a Koa instance.
       const app = new Koa()
       app.keys = [config.session]
@@ -55,10 +65,12 @@ async function startServer () {
       app.use(passport.initialize())
       app.use(passport.session())
 
-  // Attach REST API and JSON RPC controllersCt unstable to the app.
+      // Attach REST API and JSON RPC controllers to the app.
       const Controllers = require('../src/controllers')
       const controllers = new Controllers()
-  controllers.attachControllers(app)
+      await controllers.attachControllers(app)
+
+      app.controllers = controllers
 
       // Enable CORS for testing
       // THIS IS A SECURITY RISK. COMMENT OUT FOR PRODUCTION
@@ -74,7 +86,7 @@ async function startServer () {
 
       // Create the system admin user.
       try {
-    const success = await adminLib.createSystemUser()
+        const success = await this.adminLib.createSystemUser()
         if (success) console.log('System admin user created.')
       } catch (err) {
         console.warn(
@@ -83,11 +95,10 @@ async function startServer () {
       }
 
       return app
+    } catch (err) {
+      console.error('Could not start server. Error: ', err)
+    }
+  }
 }
-// startServer()
 
-// export default app
-// module.exports = app
-module.exports = {
-  startServer
-}
+module.exports = Server

config/env/common.js

@@ -32,16 +32,19 @@ module.exports = {
     : 'emailpassword',
 
   // FullStack.cash account information, used for automatic JWT handling.
-  AUTHSERVER: process.env.AUTHSERVER
+  getJwtAtStartup: 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,

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()

package.json

@@ -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",
+    "ipfs": "0.55.4",
+    "ipfs-coord": "^6.1.2",
     "jsonrpc-lite": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
     "jwt-bch-lib": "^1.3.0",

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,8 +4,8 @@
   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')
@@ -13,35 +13,45 @@ const LocalDB = require('./localdb')
 const LogsAPI = require('./logapi')
 const Passport = require('./passport')
 const Nodemailer = require('./nodemailer')
-const { wlogger } = require('./wlogger')
+// 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')
+
+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
 
     // Get a valid JWT API key and instance bch-js.
-const fullStackJwt = new FullStackJWT({
-  authServer: config.AUTHSERVER,
-  apiServer: config.APISERVER,
-  login: config.FULLSTACKLOGIN,
-  password: config.FULLSTACKPASS
-})
-const bchjs = {} // Placeholder.
-
-module.exports = {
-  ipfs,
-  localdb,
-  logapi,
-  passport,
-  nodemailer,
-  wlogger,
-  jsonFiles,
-  fullStackJwt,
-  bchjs
+    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()
+      }
+
+      // 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/ipfs-coord.js

@@ -54,16 +54,8 @@ class IpfsCoordAdapter {
       announceJsonLd: this.config.announceJsonLd
     })
 
-    // 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()
-      }
-    }
+    await this.ipfsCoord.start()
 
     // Signal that this adapter is ready.
     this.isReady = true
@@ -76,7 +68,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

@@ -25,7 +25,7 @@ class IpfsAdapter {
     try {
       // Ipfs Options
       const ipfsOptions = {
-        repo: './ipfsdata',
+        repo: './.ipfsdata/ipfs',
         start: true,
         config: {
           relay: {
@@ -56,17 +56,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 +65,10 @@ class IpfsAdapter {
       throw err
     }
   }
+
+  async stop () {
+    await this.ipfs.stop()
+  }
 }
 
 module.exports = IpfsAdapter

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,36 +21,36 @@ 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()
+    await this.adapters.fullStackJwt.getJWT()
     // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
-    adapters.bchjs = await adapters.fullStackJwt.instanceBchjs()
+    this.adapters.bchjs = await this.adapters.fullStackJwt.instanceBchjs()
+
+    // Wait for any startup processes to complete for the Adapters libraries.
+    await this.adapters.start()
 
     // Attach the REST controllers to the Koa app.
     this.attachRESTControllers(app)
 
-    // Start IPFS.
-    await this.adapters.ipfs.start({ bchjs: adapters.bchjs })
-
     this.attachRPCControllers()
   }
 
   // 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

@@ -100,8 +100,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.

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/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: () => {}
       }
 
@@ -45,7 +46,7 @@ describe('#Controllers', () => {
       try {
         // Force an error
         sandbox
-          .stub(adapters.fullStackJwt, 'getJWT')
+          .stub(uut.adapters.fullStackJwt, 'getJWT')
           .rejects(new Error('test error'))
 
         const app = {