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

Updating P2WDB docker image

.gitignore

@@ -69,5 +69,6 @@ ipfs-service-provider.sh
 run-dev.sh
 wallet.json
 data/
+*.zip
 
 !README.md

.on-save.json

@@ -0,0 +1,8 @@
+[
+  {
+    "srcDir": "",
+    "destDir": "",
+    "files": "**/*.js",
+    "command": "npm run lint"
+  }
+]

README.md

@@ -1,34 +1,75 @@
 # 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)
+[![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)
 
-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 Prototype](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
+`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/).
 
-This repository was forked from [ipfs-torlist-service](https://github.com/Permissionless-Software-Foundation/ipfs-torlist-service).
+- [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video)
 
-## Development Notes
+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 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.
 
 **Warning**: This repository is under active development. Things will be constantly changing and breaking.
 
-### Road Map:
+## Media
+- [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video)
+- [Developer walk-through for installing and hacking on bch-dex](https://youtu.be/T5XI43-SWJo) (Video)
+  - This video is out of date. Follow the instructions below.
 
-- Phase 1: MVP (single user)
-  - Move tokens or BCH for sale to temporary address.
-  - Accept input from user:
-    - Submit Signal message to P2WDB for new buy/sell order.
-    - Check UTXO status before submitting Payment message.
-  - React to webhook when new Offers come in.
-    - Add and track new Offers in MongoDB.
-    - Process Payment signals:
-      - Checking transaction for compatibility
-      - Broadcast/close trades managed by this app.
-- Phase 2: Build single-user web app
-  - _Make_ buy or sell orders.
-  - Browse Offers on the market.
-  - _Take_ buy or sell orders.
-- Phase 3: Multi-user
-  - Configure REST API as an IPFS Service that can offer services to multiple users.
-  - Update web app to display and select available SWaP services over IPFS.
+## 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)
+
+## 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.
+
+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 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:
+
+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`.
+1. Install dependencies by running `npm install`
+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. Pull the Docker images down from Docker Hub: `docker-compose pull`
+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.
 
 ## License
 

bin/server.js

@@ -8,55 +8,59 @@
 */
 
 // npm libraries
-const Koa = require('koa')
-const bodyParser = require('koa-bodyparser')
-const convert = require('koa-convert')
-const logger = require('koa-logger')
-const mongoose = require('mongoose')
-const session = require('koa-generic-session')
-const passport = require('koa-passport')
-const mount = require('koa-mount')
-const serve = require('koa-static')
-const cors = require('kcors')
+import Koa from 'koa'
+
+import bodyParser from 'koa-bodyparser'
+import convert from 'koa-convert'
+import logger from 'koa-logger'
+import mongoose from 'mongoose'
+import session from 'koa-generic-session'
+import passport from 'koa-passport'
+import mount from 'koa-mount'
+import serve from 'koa-static'
+import cors from 'kcors'
 
 // Local libraries
-const config = require('../config') // this first.
-const AdminLib = require('../src/adapters/admin')
-// const adminLib = new AdminLib()
+import config from '../config/index.js' // this first.
 
-const WebHookLib = require('../src/adapters/webhook')
-const webhookLib = new WebHookLib()
-
-// const JSONRPC = require('../src/rpc')
-// const rpc = new JSONRPC()
-
-const errorMiddleware = require('../src/controllers/rest-api/middleware/error')
-// const { wlogger } = require('../src/adapters/wlogger')
+import AdminLib from '../src/adapters/admin.js'
+import errorMiddleware from '../src/controllers/rest-api/middleware/error.js'
+// import wlogger from '../src/adapters/wlogger.js'
+import Controllers from '../src/controllers/index.js'
+import { applyPassportMods } from '../config/passport.js'
 
 class Server {
   constructor () {
+    // Encapsulate dependencies
     this.adminLib = new AdminLib()
+    this.controllers = new Controllers()
+    this.mongoose = mongoose
+    this.config = config
+    this.process = process
   }
 
   async startServer () {
     try {
       // Create a Koa instance.
       const app = new Koa()
-      app.keys = [config.session]
+      app.keys = [this.config.session]
 
       // Connect to the Mongo Database.
-      mongoose.Promise = global.Promise
-      mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+      this.mongoose.Promise = global.Promise
+      this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
       console.log(
-        `Connecting to MongoDB with this connection string: ${config.database}`
+        `Connecting to MongoDB with this connection string: ${this.config.database}`
       )
-      await mongoose.connect(config.database, {
+      await this.mongoose.connect(this.config.database, {
         useUnifiedTopology: true,
         useNewUrlParser: true
       })
 
-      console.log(`Starting environment: ${config.env}`)
-      console.log(`Debug level: ${config.debugLevel}`)
+      console.log(`Starting environment: ${this.config.env}`)
+      console.log(`Debug level: ${this.config.debugLevel}\n`)
+      console.log(`Using this web3 CashStack service: ${this.config.consumerUrl}`)
+      console.log('Alternative web services listed here: https://gist.github.com/christroutner/63c5513782181f8b8ea3eb89f7cadeb6')
+      console.log('This app is built on top of the CashStack. Find out more: https://CashStack.info\n')
 
       // MIDDLEWARE START
 
@@ -72,7 +76,8 @@ class Server {
       app.use(mount('/logs', serve(`${process.cwd()}/config/logs`)))
 
       // User Authentication
-      require('../config/passport')
+      // require('../config/passport')
+      applyPassportMods(passport)
       app.use(passport.initialize())
       app.use(passport.session())
 
@@ -81,33 +86,42 @@ class Server {
       // Dev Note: This line must come BEFORE controllers.attachRESTControllers()
       app.use(cors({ origin: '*' }))
 
-      // Attach REST API and JSON RPC controllers to the app.
-      const Controllers = require('../src/controllers')
-      const controllers = new Controllers()
-      await controllers.attachRESTControllers(app)
+      // Wait for any adapters to initialize.
+      await this.controllers.initAdapters()
 
-      app.controllers = controllers
+      // Wait for any use-libraries to initialize.
+      await this.controllers.initUseCases()
+
+      // Attach REST API and JSON RPC controllers to the app.
+      await this.controllers.attachRESTControllers(app)
+
+      app.controllers = this.controllers
 
       // MIDDLEWARE END
 
+      // 7/7/22 CT: This code paragraph can be deleted
+      // Delay startup to give the P2WDB time to start first, so that it accepts the webook call
+      // if (this.config.env !== 'test') {
+      //   await this.sleep(20000)
+      // }
       // Create webhook
-      try {
-        try {
-          // Delete an old webhook if it exists.
-          await webhookLib.deleteWebhook(`http://localhost:${config.port}/order`)
-        } catch (err) {
-          /* exit quietly */
-          // console.log('err deleting webhook: ', err)
-        }
-
-        await webhookLib.createWebhook(`http://localhost:${config.port}/order`)
-        console.log('Webhook created')
-      } catch (error) {
-        console.log('Webhook cant be created')
-      }
+      // try {
+      //   try {
+      //     // Delete an old webhook if it exists.
+      //     await webhookLib.deleteWebhook(config.webhookTarget)
+      //   } catch (err) {
+      //     /* exit quietly */
+      //     // console.log('err deleting webhook: ', err)
+      //   }
+      //
+      //   await webhookLib.createWebhook(config.webhookTarget)
+      //   console.log('Webhook created')
+      // } catch (error) {
+      //   console.log('Webhook cant be created')
+      // }
 
       // startServer()
-      await app.listen(config.port)
+      this.server = await app.listen(config.port)
       console.log(`Server started on ${config.port}`)
 
       // Create the system admin user.
@@ -116,10 +130,16 @@ class Server {
 
       // Attach the other IPFS controllers.
       // Skip if this is a test environment.
-      if (config.env !== 'test') {
-        await controllers.attachControllers(app)
+      if (this.config.env !== 'test') {
+        await this.controllers.attachControllers(app)
       }
 
+      // Display configuration settings
+      console.log('\nConfiguration:')
+      console.log(`Circuit Relay: ${this.config.isCircuitRelay}`)
+      console.log(`IPFS TCP port: ${this.config.ipfsTcpPort}`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}\n`)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)
@@ -127,14 +147,14 @@ class Server {
       console.log(
         'Exiting after 5 seconds. Depending on process manager to restart.'
       )
-      await sleep(5000)
-      process.exit(1)
+      await this.sleep(5000)
+      this.process.exit(1)
     }
   }
+
+  sleep (ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms))
+  }
 }
 
-function sleep (ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
-module.exports = Server
+export default Server

config/env/common.js

@@ -5,15 +5,22 @@
 
 /* eslint  no-unneeded-ternary:0 */
 
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+
 // Get the version from the package.json file.
-const pkgInfo = require('../../package.json')
+import { readFileSync } from 'fs'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+const pkgInfo = JSON.parse(readFileSync(`${__dirname.toString()}/../../package.json`))
+
 const version = pkgInfo.version
 
 const ipfsCoordName = process.env.COORD_NAME
   ? process.env.COORD_NAME
   : 'ipfs-torlist-service-generic'
 
-module.exports = {
+export default {
   // Configure TCP port.
   port: process.env.PORT || 5700,
 
@@ -36,9 +43,11 @@ module.exports = {
   consumerUrl: process.env.CONSUMER_URL
     ? process.env.CONSUMER_URL
     : 'https://free-bch.fullstack.cash',
+  // : 'https://wa-usa-bch-consumer.fullstackcash.nl',
 
   // P2WDB URL that will accept API calls from the p2wdb npm library.
   p2wdbUrl: process.env.P2WDB_URL ? process.env.P2WDB_URL : 'https://p2wdb.fullstack.cash',
+  // p2wdbUrl: process.env.P2WDB_URL ? process.env.P2WDB_URL : 'http://localhost:5010',
 
   // FullStack.cash account information, used for automatic JWT handling.
   getJwtAtStartup: process.env.GET_JWT_AT_STARTUP ? true : false,
@@ -54,6 +63,9 @@ module.exports = {
   fullstackPassword: process.env.FULLSTACKPASS
     ? process.env.FULLSTACKPASS
     : 'demo',
+  authPass: process.env.FULLSTACK_AUTH_PASS
+    ? process.env.FULLSTACK_AUTH_PASS
+    : '',
 
   // IPFS settings.
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
@@ -84,7 +96,10 @@ module.exports = {
   webhookService: process.env.WEBHOOKSERVICE
     ? process.env.WEBHOOKSERVICE
     : 'http://localhost:5010/webhook', // P2WDB.
-  p2wdbAppId: process.env.APP_ID ? process.env.APP_ID : 'bch-dex-test556',
+  p2wdbAppId: process.env.APP_ID ? process.env.APP_ID : 'bch-dex-001',
+  webhookTarget: process.env.WEBHOOKTARGET
+    ? process.env.WEBHOOKTARGET
+    : 'http://localhost:5700/p2wdb',
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 4001,
@@ -93,12 +108,17 @@ module.exports = {
   // 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,
+  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 1,
 
   // Settings for production, using external go-ipfs node.
   isProduction: process.env.SVC_ENV === 'production' ? true : false,
   ipfsHost: process.env.IPFS_HOST ? process.env.IPFS_HOST : 'localhost',
   ipfsApiPort: process.env.IPFS_API_PORT
     ? parseInt(process.env.IPFS_API_PORT)
-    : 5001
+    : 5001,
+
+  chatPubSubChan: 'psf-ipfs-chat-001',
+
+  // IPFS gateway
+  ipfsGateway: process.env.IPFS_GATEWAY ? process.env.IPFS_GATEWAY : 'https://p2wdb-gateway-678.fullstack.cash/ipfs/'
 }

config/env/development.js

@@ -4,7 +4,7 @@
   specified.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   database: 'mongodb://localhost:27017/bch-swap-service-dev',

config/env/production.js

@@ -7,7 +7,7 @@
   so as not to conflict with the default host port of 27017 for MongoDB.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   // database: 'mongodb://172.17.0.1:5555/ipfs-service-prod',

config/env/test.js

@@ -4,7 +4,7 @@
   This is the environment run by the test suite.
 */
 
-module.exports = {
+export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   database: 'mongodb://localhost:27017/bch-swap-service-test',

config/index.js

@@ -1,6 +1,21 @@
-const common = require('./env/common')
+import common from './env/common.js'
 
-const env = process.env.BCH_ENV || 'development'
-const config = require(`./env/${env}`)
+import development from './env/development.js'
+import production from './env/production.js'
+import test from './env/test.js'
 
-module.exports = Object.assign({}, common, config)
+const env = process.env.BCH_DEX || 'development'
+console.log(`Loading config for this environment: ${env}`)
+
+let config = development
+if (env === 'test') {
+  config = test
+} else if (env === 'prod') {
+  config = production
+}
+
+// const importStr = `./env/${env}.js`
+// console.log('importStr: ', importStr)
+// import config from importStr
+
+export default Object.assign({}, common, config)

config/passport.js

@@ -1,30 +1,6 @@
-const passport = require('koa-passport')
-const User = require('../src/adapters/localdb/models/users')
-const Strategy = require('passport-local')
-
-passport.serializeUser((user, done) => {
-  done(null, user.id)
-})
-
-passport.deserializeUser(async (id, done) => {
-  try {
-    const user = await User.findById(id, '-password')
-    done(null, user)
-  } catch (err) {
-    done(err)
-  }
-})
-
-passport.use(
-  'local',
-  new Strategy(
-    {
-      usernameField: 'email',
-      passwordField: 'password'
-    },
-    passportCallback
-  )
-)
+// import passport from 'koa-passport';
+import User from '../src/adapters/localdb/models/users.js'
+import Strategy from 'passport-local'
 
 async function passportCallback (email, password, done) {
   try {
@@ -49,5 +25,35 @@ async function passportCallback (email, password, done) {
   }
 }
 
+function applyPassportMods (passport) {
+  passport.serializeUser((user, done) => {
+    done(null, user.id)
+  })
+
+  passport.deserializeUser(async (id, done) => {
+    try {
+      const user = await User.findById(id, '-password')
+      done(null, user)
+    } catch (err) {
+      done(err)
+    }
+  })
+
+  passport.use(
+    'local',
+    new Strategy(
+      {
+        usernameField: 'email',
+        passwordField: 'password'
+      },
+      passportCallback
+    )
+  )
+
+  return true
+}
+
 // For testing
-module.exports = { passport, passportCallback }
+// export default { passport, passportCallback };
+// export default applyPassportMods
+export { applyPassportMods, passportCallback }

dev-docs/README.md

@@ -25,7 +25,7 @@ This architecture keeps the global database highly censorship resistant, while a
 
 The workflow of a token trade has three parts:
 1. **Make** - An *Offer* to buy or sell tokens is generated by a user, known as the *Maker*.
-2. **Take** - A second user, known as a *Taker*, will *take* the *Offer* by issues a *Counter Offer*
+2. **Take** - A second user, known as a *Taker*, will *take* the *Offer* by issuing a *Counter Offer*
 3. **Accept** - The original *Maker* checks the *Counter Offer* and *Accepts* it by signing and then broadcasting the transaction.
 
 Trades done in this way are both *trustless* and *atomic*:
@@ -74,7 +74,7 @@ Writing data follows these steps:
 - Tokens and BCH are held by a wallet which is under the controlled of `bch-dex`.
 - The _Client_ submits data to the POST `/order` REST API endpoint to create a new Order.
 - `bch-dex` will move the funds into a segregated UTXO, and will use that UTXO to create an Order. The Order data is written to the P2WDB. The Order data is also saved to the local MongoDB.
-- After submitting the data to the P2WDB, `bch-dex` will receive a webhook call to its POST `/offer` endpoint by the P2WDB. This event will trigger the import of the new data into the apps local Mongo database, and generate a new Offer model.
+- After submitting the data to the P2WDB, `bch-dex` will receive a webhook call to its POST `/p2wdb` endpoint by the P2WDB. This event will trigger the import of the new data into the apps local Mongo database, and generate a new Offer model.
 - This webhook event is mirrored by every instance of `bch-dex` on the network. Each P2WDB peer on the network will independently validate the new database entry and create a new Offer model.
 
 ## Taking an Offer
@@ -82,8 +82,8 @@ Writing data follows these steps:
 Users can browse the Offers tracked by a local `bch-dex` by using a *Client*. When they find an Offer they want to to take, they'll use some UI element that will send data to the POST `/offer/take` REST API endpoint. These series of steps happen:
 
 - The `bch-dex` checks to see if the wallet it controls has enough BCH to take the other side of the Offer. If it does, the funds for the offer are moved to a segregated UTXO.
-- The new UTXO is used to generate a *Counter Offer*, which contain a partially signed transaction saved as a hex string.
-- The *Counter Offer* is submitted to the P2WDB. This triggers a webhook event in every running instance of `bch-dex` on the network.
+- The new UTXO is used to generate a *Counter Offer*, which contains a partially signed transaction saved as a hex string.
+- The *Counter Offer* is uploaded to the P2WDB. This triggers a webhook event in every running instance of `bch-dex` on the network.
 - When the webhook is triggered, `bch-dex` will check to see if the *Counter Offer* matches an *Order* under its control. If a match is found, it will trigger an *Accept* event.
 
 ## Accepting a Counter Offer
@@ -92,6 +92,7 @@ This part of the process is automated and does not require input from the user.
 
 - When a *Counter Offer* is received that matches an *Order* tracked by the local copy of `bch-dex`, it will trigger the *Acceptance* phase.
 - In the *Acceptance* phase, the transaction will be checked to see if it matches the conditions in the original *Order*. If all checks pass, `bch-dex` will sign the transaction and broadcast it, completing the trade.
+- A 'garbage collection' function that runs periodically will delete Orders and Offers in bch-dex that have had their UTXO spent, automatically cleaning up stale trade data that is no longer valid.
 
 ## Maintenance
 

dev-docs/specification.md

@@ -26,28 +26,31 @@ Order entities have the following properties:
   - _utxoTxid_ - The TXID of the UTXO representing the token or BCH being offered for sale.
   - _utxoVout_ - The vout of the UTXO representing the token or BCH being offered for sale.
 
-  - Trade Data:
-    - _buyOrSell_ - A string with a value `buy` or `sell` indicating which type of offer this is.
-    - _numTokens_ - The maximum number of tokens offered for sale.
-    - _rateInBaseUnit_ - The rate in terms of currency-unit-per-token. Ex: 1000 = 1000 sats per token
-      - For Bitcoin, the min currency is sats.
-      - For AVAX, the min currency is nano-Avax.
-      - for eCash, the min currency is bits.
-    - _minUnitsToExchange_ - The minimum order size accepted.
+- Trade Data:
+  - _buyOrSell_ - A string with a value `buy` or `sell` indicating which type of offer this is.
+  - _numTokens_ - The maximum number of tokens offered for sale.
+  - _rateInBaseUnit_ - The rate in terms of currency-unit-per-token. Ex: 1000 = 1000 sats per token
+    - For Bitcoin, the min currency is sats.
+    - For AVAX, the min currency is nano-Avax.
+    - for eCash, the min currency is bits.
+  - _minUnitsToExchange_ - The minimum order size accepted.
+  - _makerAddr_ - The address for the taker to send money to.
+  - _p2wdbTxid_ - The TXID proof-of-burn used to add the order to the P2WDB.
+  - _p2wdbHash_ - The CID used to identify the order entry in the P2WDB.
 
-  - Authentication Data:
-    - _signature_ - A message signed by the address which created the order.
-    - _sigMsg_ - The clear-text message used to generate the signature.
-    - _offerBchAddr_ - The BCH address controlling the offer.
-    - _offerPubKey_ - The public key used to generate the BCH address, used for encryption.
+- Authentication Data:
+  - _signature_ - A message signed by the address which created the order.
+  - _sigMsg_ - The clear-text message used to generate the signature.
+  - _offerBchAddr_ - The BCH address controlling the offer.
+  - _offerPubKey_ - The public key used to generate the BCH address, used for encryption.
 
-  - Wallet Data:
-    - _hdIndex_ - The HD index of the wallet used to generate the keypair to store the UTXO being offered for sale.
+- Wallet Data:
+  - _hdIndex_ - The HD index of the wallet used to generate the keypair to store the UTXO being offered for sale.
 
-  - SWaP Protocol properties:
-    - _lokadId_ - Not used. Provided for future functionality.
-    - _messageType_ - Not used. Provided for future functionality.
-    - _messageClass_ - Not used. Provided for future functionality.
+- SWaP Protocol properties:
+  - _lokadId_ - Not used. Provided for future functionality.
+  - _messageType_ - Not used. Provided for future functionality.
+  - _messageClass_ - Not used. Provided for future functionality.
 
 
 ### Offer
@@ -70,8 +73,13 @@ Offer entities have the following properties:
     - For AVAX, the min currency is nano-Avax.
     - for eCash, the min currency is bits.
   - _minUnitsToExchange_ - The minimum order size accepted.
+  - _makerAddr_ - The address for the taker to send money to.
   - _p2wdbTxid_ - The TXID proof-of-burn used to add the order to the P2WDB.
   - _p2wdbHash_ - The CID used to identify the order entry in the P2WDB.
+  - _offerStatus_ - The state of the offer. When the data is added to the P2WDB, it gets a value of 'posted', but the database model internal to bch-dex can have the following properties:
+    - *posted* - The offer is posted and can be countered by a taker.
+    - *taken* - The offer was countered and accepted.
+    - *dead* - The UTXO was spent outside the trade, which automatically makes the offer dead.
 
 - Authentication Data:
   - _signature_ - A message signed by the address which created the order.
@@ -88,46 +96,76 @@ Offer entities have the following properties:
   - _messageType_ - Not used. Provided for future functionality.
   - _messageClass_ - Not used. Provided for future functionality.
 
+When an Offer is uploaded to the P2WDB, the following properties are added to the data:
+
+- Added properties to P2WDB data:
+  - *dataType* - Has a value of 'offer'. This is used to route the data correctly when the P2WDB webhook passes the data to `bch-dex`.
 
 ### Counter Offer
 
-A Counter Offer is the other side of an Offer. It contains a partially signed transaction, created by the Taker. The Maker will review the Counter Offer before accepting and finalizing the trade.
+A Counter Offer is the other side of the trade, a mirror image to an Offer. It contains a partially signed transaction, created by the Taker. The Maker will review the Counter Offer before accepting and finalizing the trade.
+
+Counter Offers are not tracked via database models like Offers and Orders are. They are processed by `bch-dex` as soon as they are received. A garbage collection function will be called periodically, to sweep the segregated UTXOs used to generate a Counter Offer back into the root address of the wallet, if it is not accepted after a period of time.
+
+To generate a Counter Offer, a segregated UTXO is created that matches the requirements in the Offer. A partially signed transaction is created that includes the Offer UTXO and the Counter Offer UTXO. The Taker signs the input consuming the Counter Offer UTXO. The partially signed transaction and other trade data is uploaded to P2WDB.
+
+When the Counter Offer data is uploaded to the P2WDB, the data must have the following properties:
+
+- *partialTxHex* - A hexidecimal representation of the partially-signed transaction, which includes the UTXO in the Offer and a second UTXO for that matches the conditions in the Offer.
+- *dataType* - Must have a value of `counter-offer`
 
-Details TBD.
 
 ## Use Cases
 
 Use cases are verbs or actions that is done _to_ an Entity or _between_ Entities.
 
-### Offer
-
-- **`createOffer()`** - This method is triggered by a webhook from the P2WDB. It will take the data provided by the P2WDB and create a new Order entity in the local database.
-
 ### Order
 
+- **`createOrder()`** - A macro command that leverages the other functions in this library to create a new Order and submit it to the P2WDB.
 - **`ensureFunds()`** - Ensure that the wallet has enough BCH and tokens to complete the requested trade.
-- **`moveTokens()`** - Move the tokens indicated in the order to a temporary holding address. This will generate the UTXO used in the webhook message. This function moves the funds and returns the UTXO information.
-- **`createOrder()`** - A macro command that leverages `ensureFunds()` and `moveTokens()`, to create a new Order and submit it to the P2WDB.
+- **`findOrderByHash()`** - Given a P2WDB CID 'hash', this function will return the corresponding Order model associated with that CID.
 
-### Counter Offer
+### Offer
 
-TBD
+- **`createOffer()`** - This method is triggered by a webhook from the P2WDB. It will take the data provided by the P2WDB and create a new Offer entity in the local database.
+- **`listOffers()`** - Returns a list of all the active Offers tracked by `bch-dex`.
+- **`takeOffer()`** - Generate a segregated UTXO and partially signed transaction, then upload the Counter Offer data to the P2WDB.
+- **`ensureFunds()`** - Ensure the wallet has enough BCH and tokens to make a Counter Offer.
+- **`findOfferByHash()`** - Given a P2WDB CID 'hash', this function will return the corresponding Offer model associated with that CID.
+- **`acceptCounterOffer()`** - This function is triggered by the P2WDB webhook REST API handler. When a Counter Offer is passed to `bch-dex` by the P2WDB, the data is then passed to this function. It does due diligence on the Counter Offer, then signs and broadcasts the transaction to accept the Counter Offer.
 
 ## Controllers
 
 Controllers are inputs to the system. When a controller is activated, it causes the system to react in some way.
 
-### Offers
-
-- **POST /offer** - This POST REST API endpoint will be triggered by a webhook generated from P2WDB. This will notify the `bch-dex` that a new entry has been added to the P2WDB that matches the `appId` of `swap-<chain>`, where `<chain>` has a value of `avax`, `bch`, or `ecash`. It's a new entry that should be evaluated for inclusion in the `ipfs-swap-service` local database.
-
 ### Orders
 
-- **POST /order** - This POST REST API endpoint can be triggered by the Client or a simple curl call. It passes in the data needed for `bch-dex` to generate and track a new Order, then submit the data to the P2WDB to generate an Offer that is tracked by all other instances of `bch-dex`.
+- **POST /order** - This POST REST API endpoint can be triggered by the Client or a simple curl call. It passes in the data needed for `bch-dex` to generate and track a new Order, then submits the data to the P2WDB to generate an Offer that is tracked by all other instances of `bch-dex` on the network.
+
+### Offers
+
+- **GET /offer/list** - Returns an array of objects, where each object represents an active Offer.
+
+- **POST /offer/take** - Given the P2WDB CID of an Offer, calling this endpoint will attempt to generate a Counter Offer and upload it to the P2WDB.
+
+### P2WDB
+
+- **POST /p2wdb** - This POST REST API endpoint will be called by a webhook generated from the P2WDB. This will notify the `bch-dex` that a new entry has been added to the P2WDB that matches the `appId` of `swap-<chain>`, where `<chain>` has a value of `avax`, `bch`, or `ecash`. It's a new entry that should be evaluated for inclusion in the `bch-dex` local database. Based on the `dataType` property, the data is routed to either create a new Offer or to process a new Counter Offer.
 
 ## Adapters
 
-Adapters are output libraries so that the business logic doesn't need to know any specific information about the I/O. They are essentially the output of the application.
+Adapters are outputs. These libraries exist so that the business logic doesn't need to know any specific information about the I/O. They handle the low-level mechanics of the various subsystems.
 
 - **localdb** - An adapter for the local database (MongoDB).
 - **ipfs** - An adapter for IPFS and the ipfs-coord library. It allows the app to use the JSON-RPC over IPFS.
+- **wallet** - Handles low-level wallet tasks.
+  - **`moveTokens()`** - Move the tokens indicated in the order to a temporary holding address. This will generate the segregated UTXOs used in the trade. This function moves the funds and returns the UTXO information.
+  - **`moveBCH()`** - Same idea as `moveTokens()`, but creates a non-SLP segregated UTXO, used when generating a Counter Offer.
+  - **`openWallet()`** - Opens the JSON file containing the wallet data for the app.
+  - **`instanceWallet()`** - Given the wallet data returned by `openWallet()`, it generates an instance of the [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) for generating UTXOs and interacting with the blockchain.
+  - **`incrementNextAddress()`** - Increments the index of the [HD wallet](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch05.asciidoc#hd_wallets) used to generate keypairs for storing segregated UTXOs.
+  - **`getKeyPair()`** - Generates a keypair from the HD wallet.
+  - **`generateSignature()`** - Generate a cryptographic signature.
+  - **`generatePartialTx()`** - Create a partial transaction as part of a Counter Offer.
+  - **`deseralizeTx()`** - Used only for debugging purposes. Expands a hex transaction into a JSON object.
+  - **`completeTx()`** - Complete the partially signed transaction by signing the first input, then broadcasting the transaction to the network.

index.js

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

package.json

@@ -1,20 +1,21 @@
 {
   "name": "bch-dex",
-  "version": "1.0.0",
+  "version": "2.0.2",
   "description": "A DEX on BCH for trading SLP tokens.",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "start": "node index.js",
     "test": "npm run test:all",
-    "test:all": "export BCH_DEX=test && nyc --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
+    "test:all": "export BCH_DEX=test && c8 --reporter=text mocha --exit --timeout 15000 --recursive test/unit test/e2e/automated/",
     "test:unit": "export BCH_DEX=test && mocha --exit --timeout 15000 --recursive test/unit/",
-    "test:e2e:auto": "export BCH_DEX=test && mocha --exit --timeout 15000 test/e2e/automated/",
+    "test:e2e:auto": "export BCH_DEX=test && mocha --exit --timeout 30000 test/e2e/automated/",
     "test:integration": "export BCH_DEX=test && mocha --exit --timeout 45000 --recursive test/integration",
     "test:temp": "export BCH_DEX=test && mocha --exit --timeout 15000 -g '#rate-limit' test/unit/json-rpc/",
     "lint": "standard --env mocha --fix",
     "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "coverage:report": "export BCH_DEX=test && nyc --reporter=html mocha --exit --timeout 15000 --recursive test/unit/ test/e2e/automated/"
+    "coverage": "c8 report --reporter=text-lcov | coveralls",
+    "coverage:report": "export BCH_DEX=test && c8 --reporter=html mocha --exit --timeout 15000 --recursive test/unit/ test/e2e/automated/"
   },
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
@@ -27,14 +28,16 @@
   },
   "repository": "Permissionless-Software-Foundation/bch-dex",
   "dependencies": {
-    "@psf/bch-js": "5.4.0",
-    "axios": "0.21.1",
-    "bch-message-lib": "2.1.4",
+    "@chris.troutner/retry-queue": "1.0.8",
+    "@psf/bch-js": "6.5.1",
+    "axios": "0.27.2",
+    "bch-message-lib": "2.2.1",
+    "bch-token-sweep": "2.2.1",
     "bcryptjs": "2.4.3",
+    "bitcoincashjs-lib": "3.3.3",
     "glob": "7.1.6",
-    "ipfs": "0.60.0",
-    "ipfs-coord": "7.1.6",
-    "ipfs-http-client": "55.0.0",
+    "ipfs-coord-esm": "9.1.3",
+    "ipfs-http-client": "58.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -49,36 +52,28 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "^0.36.2",
+    "libp2p": "0.36.2",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "4.4.3",
-    "mongoose": "5.13.13",
+    "minimal-slp-wallet": "5.5.5",
+    "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
-    "nodemailer": "6.4.17",
-    "p2wdb": "1.3.1",
+    "nodemailer": "6.7.5",
+    "p2wdb-esm": "2.2.9",
     "passport-local": "1.0.0",
-    "public-ip": "^4.0.4",
+    "public-ip": "4.0.4",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "0.26.0",
-    "bch-token-sweep": "1.5.16",
+    "apidoc": "0.51.1",
+    "c8": "7.12.0",
     "chai": "4.3.0",
     "coveralls": "2.11.4",
-    "eslint": "7.19.0",
-    "eslint-config-prettier": "7.2.0",
-    "eslint-config-standard": "16.0.2",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "3.3.1",
-    "eslint-plugin-promise": "^4.3.1",
-    "eslint-plugin-standard": "4.0.0",
     "husky": "4.3.8",
-    "mocha": "8.4.0",
-    "nyc": "15.1.0",
-    "semantic-release": "17.4.4",
+    "mocha": "10.0.0",
+    "semantic-release": "19.0.3",
     "sinon": "9.2.4",
-    "standard": "16.0.4",
+    "standard": "17.0.0",
     "uuid": "8.3.2"
   },
   "release": {

production/docker/README.md

@@ -1,61 +0,0 @@
-# Docker Containers
-
-The 'production' environment is assumed to be a set of Docker containers orchestrated with Docker Compose. The files in this directory will stand up three Docker containers:
-
-1 An instance of go-ipfs.
-2 An instance of MongoDB.
-3 The JavaScript software in this repository.
-
-The software in this repository depends on the first two containers, so if they aren't running correctly, the application won't run correctly either.
-
-## IPFS
-
-IPFS can be a little tricky to set up. By default, the container uses the following ports:
-
-- 4001 for TCP connections, exposed publicly.
-- 5001 for control by the application, exposed privately.
-- 8080 for an IPFS gateway, consumed by the application, exposed privately.
-
-If you already have an IPFS node running on a the computer, you will need to change the ports to avaid a conflict. To change the ports from the default, you'll need to perform a series of steps, and the order of the steps matter.
-
-1. Edit the `docker-compose.yml` file and change the ports. Then save the file. Here is an example:
-
-```
-ports:
-  - 4101:4101
-  - 172.17.0.1:5101:5101
-  - 172.17.0.1:8180:8180
-```
-
-2. Bring the Docker containers up, and then back down. This will allow the IPFS container to create the config file that you'll need to edit.
-
-- `docker-compose up -d`
-- Wait a few seconds.
-- `docker-compose down`
-
-3. Update the generated config file at `../data/go-ipfs/data/config`, to update the ports in the config file, like this:
-
-```
-"Addresses": {
-    "API": "/ip4/0.0.0.0/tcp/5101",
-    "Announce": [],
-    "AppendAnnounce": [],
-    "Gateway": "/ip4/0.0.0.0/tcp/8180",
-    "NoAnnounce": [],
-    "Swarm": [
-      "/ip4/0.0.0.0/tcp/4101",
-      "/ip6/::/tcp/4101",
-      "/ip4/0.0.0.0/udp/4101/quic",
-      "/ip6/::/udp/4101/quic"
-    ]
-  },
-
-```
-
-4. Update the port changes in the `start-production.sh` shell script. This tells the application which ports to use, in order to control the IPFS node, are are used when signaling other nodes.
-
-5. Quickly rebuild the containers, to add the modified `start-production.sh` shell script to the application Docker container:
-
-- `docker-compose build`
-
-6. Now start the containers, and the port changes to IPFS should be complete.

production/docker/bch-dex-ui/Dockerfile

@@ -0,0 +1,73 @@
+# Create a Dockerized API server
+#
+
+#IMAGE BUILD COMMANDS
+# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
+#FROM christroutner/ct-base-ubuntu
+FROM ubuntu:20.04 as builder
+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_16.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
+
+#Set password to 'password' change value below if you want a different password
+#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'"
+
+# Update to the latest version of npm.
+#RUN npm install -g npm@7.23.0
+RUN npm install -g npm
+
+# npm mirror to prevent direct dependency on npm.
+#RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+# Clone the rest.bitcoin.com repository
+WORKDIR /home/safeuser
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v2
+
+# Switch to the desired branch. `master` is usually stable,
+# and `stage` has the most up-to-date changes.
+WORKDIR /home/safeuser/bch-dex-ui-v2
+
+# For development: switch to unstable branch
+RUN git checkout ct-unstable
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+#RUN npm install -g @mapbox/node-pre-gyp
+RUN npm install
+
+# Build the site
+RUN CI=true npm run build
+
+# Load the NGINX image.
+FROM nginx
+EXPOSE 80
+
+# Copy the files built in the first container to the new NGINX container.
+COPY --from=builder /home/safeuser/bch-dex-ui-v2/build /usr/share/nginx/html
+
+#USER safeuser

production/docker/bch-dex/Dockerfile

@@ -0,0 +1,81 @@
+# Create a Dockerized API server
+#
+
+#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_16.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
+
+#Set password to 'password' change value below if you want a different password
+#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'"
+
+# Update to the latest version of npm.
+#RUN npm install -g npm@7.23.0
+RUN npm install -g npm
+
+# npm mirror to prevent direct dependency on npm.
+RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+# Clone the rest.bitcoin.com repository
+WORKDIR /home/safeuser
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex
+
+# Switch to the desired branch. `master` is usually stable,
+# and `stage` has the most up-to-date changes.
+WORKDIR /home/safeuser/bch-dex
+
+# For development: switch to unstable branch
+RUN git checkout ct-unstable
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+#RUN npm install -g @mapbox/node-pre-gyp
+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.
+CMD ["./start-production.sh"]
+
+#CMD ["npm", "start"]
+
+# Used for debugging
+#COPY dummy-app.js dummy-app.js
+#CMD ["node", "dummy-app.js"]

production/docker/bch-dex/dummy-app.js

@@ -0,0 +1,4 @@
+setInterval(function () {
+  const now = new Date()
+  console.log(`timestamp: ${now.toLocaleString()}`)
+}, 5000)

production/docker/bch-dex/start-production.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# BEGIN: Optional configuration settings
+
+# The human readable name this IPFS node identifies as.
+export COORD_NAME=bch-dex-generic
+
+# Allow this node to function as a circuit relay. It must not be behind a firewall.
+#export ENABLE_CIRCUIT_RELAY=true
+# For browsers to use your circuit realy, you must set up a domain, SSL certificate,
+# and you must forward that subdomain to the IPFS_WS_PORT.
+#export CR_DOMAIN=subdomain.yourdomain.com
+
+# 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:5666/bch-swap-service-prod
+
+# Configure REST API port
+export PORT=5700
+
+# bch-dex specific env vars
+export BCH_DEX=prod
+export WEBHOOKSERVICE=http://172.17.0.1:5667/webhook
+export WEBHOOKTARGET=http://172.17.0.1:5700/p2wdb
+export APP_ID=bch-dex-001
+
+#export P2WDB_URL=http://172.17.0.1:5667
+
+npm start

production/docker/docker-compose.yml

@@ -3,21 +3,27 @@
 version: '3.9'
 
 services:
-  mongo-ipfs-service:
-    image: mongo
-    container_name: mongo-ipfs-service
+  mongo-p2wdb-service:
+    image: mongo:4.2.0
+    container_name: mongo-p2wdb-service
     ports:
-      - '5555:27017' # <host port>:<container port>
+      - '5666:27017' # <host port>:<container port>
     volumes:
       - ../data/database:/data/db
     command: mongod --logpath=/dev/null # -- quiet
     restart: always
 
   ipfs:
-    image: ipfs/go-ipfs:v0.11.0
+    # https://github.com/christroutner/trickle-ipfs
+    image: christroutner/trickle-ipfs:v1.0.1
+    #build:
+    #  context: ./
+    #  dockerfile: Dockerfile
     container_name: ipfs
     environment:
-      MY_ENV_VAR: 'placeholder'
+      IPFS_DAEMON_ARGUMENTS: '--enable-pubsub-experiment --migrate=true --agent-version-suffix=docker --routing=dhtclient'
+      UPLOAD_KBPS: '1000'
+      DOWNLOAD_KBPS: '1000'
     logging:
       driver: 'json-file'
       options:
@@ -26,25 +32,77 @@ services:
     mem_limit: 2000mb
     ports:
       - 4001:4001
+      - 4003:4003
       - 172.17.0.1:5001:5001
       - 172.17.0.1:8080:8080
+    command: [
+      './start-ipfs.sh'
+    ]
     volumes:
-      - ../data/go-ipfs/data:/data/ipfs
-      - ../data/go-ipfs/export:/export
-    # https://docs.docker.com/compose/compose-file/compose-file-v3/#command
-    # https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
-    command:
-      [
-        'daemon',
-        '--migrate=true',
-        '--agent-version-suffix=docker',
-        '--enable-pubsub-experiment'
-      ]
+      - ../data/go-ipfs/data:/root/.ipfs
     restart: always
 
-  ipfs-service:
-    build: .
-    container_name: ipfs-service
+  p2wdb:
+    #build:
+    #  context: ./p2wdb/
+    #  dockerfile: Dockerfile
+    image: christroutner/p2wdb:v4.0.3
+    container_name: p2wdb
+    environment:
+      CONSUMER_URL: 'https://free-bch.fullstack.cash'
+      #ENABLE_BCH_PAYMENT: 1
+      DEBUG_LEVEL: 1
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 1gb
+    links:
+      - mongo-p2wdb-service
+    ports:
+      # <host port>:<container port>
+      - 5667:5667 # REST API
+      #- 5668:5668 # IPFS TCP port
+      #- 5669:5669 # IPFS WS Port
+    volumes:
+      - ../data/ipfsdata/p2wdb:/home/safeuser/ipfs-p2wdb-service/.ipfsdata/p2wdb
+      - ./p2wdb/start-production.sh:/home/safeuser/ipfs-p2wdb-service/start-production.sh
+      #- ../scripts/wallet.json:/home/safeuser/ipfs-p2wdb-service/wallet.json
+    restart: always
+
+  bch-dex:
+    #build:
+    #  context: ./bch-dex/
+    #  dockerfile: Dockerfile
+    image: christroutner/bch-dex:v2.2.4
+    container_name: bch-dex
+    environment:
+      CONSUMER_URL: 'https://free-bch.fullstack.cash'
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 1000mb
+    links:
+      - mongo-p2wdb-service
+      - p2wdb
+    ports:
+      - '5700:5700' # <host port>:<container port>
+    volumes:
+      - ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
+      - ./bch-dex/start-production.sh:/home/safeuser/bch-dex/start-production.sh
+    restart: always
+
+  dex-ui:
+    #build:
+    #  context: ./bch-dex-ui/
+    #  dockerfile: Dockerfile
+    image: christroutner/bch-dex-ui:v1.2.4
+    container_name: dex-ui
+    environment:
+      SERVER: 'http://192.168.2.3'
     logging:
       driver: 'json-file'
       options:
@@ -52,10 +110,9 @@ services:
         max-file: '10'
     mem_limit: 500mb
     links:
-      - mongo-ipfs-service
-      - ipfs
+      - bch-dex
     ports:
-      - '5010:5010' # <host port>:<container port>
-    volumes:
-      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
+      - '4500:80' # <host port>:<container port>
+    # volumes:
+    #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
     restart: always

production/docker/p2wdb/Dockerfile

@@ -0,0 +1,71 @@
+# Create a Docker container for the P2WDB
+#
+
+#IMAGE BUILD COMMANDS
+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_16.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
+
+#Set password to 'abcd8765' change value below if you want a different password
+RUN echo safeuser:abcd8765 | chpasswd
+
+#Set the working directory to be the users home directory
+WORKDIR /home/safeuser
+
+#Setup NPM for non-root global install (like on a mac)
+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.
+#RUN npm install -g npm@7.23.0
+RUN npm install -g npm
+
+# npm mirror to prevent direct dependency on npm.
+RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+# Clone the rest.bitcoin.com repository
+RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service
+WORKDIR /home/safeuser/ipfs-p2wdb-service
+RUN mkdir .ipfsdata
+RUN git checkout ct-unstable
+
+#RUN npm install fsevents
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+RUN npm install
+
+# Generate the API docs
+RUN npm run docs
+
+# 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"]
+
+#CMD ["npm", "start"]
+
+# Used for debugging
+#COPY dummyapp.js dummyapp.js
+#CMD ["node", "dummyapp.js"]

production/docker/p2wdb/dummyapp.js

@@ -0,0 +1,4 @@
+setInterval(function () {
+  const now = new Date()
+  console.log(`ping ${now.toLocaleString()}`)
+}, 10000)

production/docker/p2wdb/start-production.sh

@@ -4,11 +4,10 @@
 
 # This mnemonic is used to set up persistent public key for e2ee
 # Replace this with your own 12-word mnemonic.
-# You can get one at https://wallet.fullstack.cash.
-export MNEMONIC="olive two muscle bottom coral ancient wait legend bronze useful process session"
+export MNEMONIC="mass response fiscal world message exact series swallow forward confirm canoe festival"
 
 # The human readable name this IPFS node identifies as.
-export COORD_NAME=ipfs-service-provider-generic
+export COORD_NAME=generic-p2wdb-production
 
 # Allow this node to function as a circuit relay. It must not be behind a firewall.
 #export ENABLE_CIRCUIT_RELAY=true
@@ -17,22 +16,32 @@ export COORD_NAME=ipfs-service-provider-generic
 #export CR_DOMAIN=subdomain.yourdomain.com
 
 # Debug level. 0 = minimal info. 2 = max info.
-export DEBUG_LEVEL=2
+# This value set by docker-compose.yml
+#export DEBUG_LEVEL=1
+
+# Log-in information for retrieving a JWT token from FullStack.cash.
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
 
 # END: Optional configuration settings
 
 
 # Production database connection string.
-export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+export DBURL=mongodb://172.17.0.1:5666/p2wdb-service-dev
+
+# Configure IPFS ports
+#export IPFS_TCP_PORT=5668
+#export IPFS_WS_PORT=5669
 
 # Configure REST API port
-export PORT=5010
+export PORT=5667
 
-# Production settings using external go-ipfs node.
-export SVC_ENV=production
+export P2W_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4001
-#export IPFS_WS_PORT=5269
+
+# P2WDB specific env vars
+#export ORBITDB_NAME=/orbitdb/zdpuAm4fPafpjs5mgbBUJV8Az7kd8Xj1ttD6M1JaAxF8RMRrw/psf-bch-p2wdb-keyvalue-v1.0.0-0004
 
 npm start

production/rpi-docker/bch-dex-ui/Dockerfile

@@ -0,0 +1,73 @@
+# Create a Dockerized API server
+#
+
+#IMAGE BUILD COMMANDS
+# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
+#FROM christroutner/ct-base-ubuntu
+FROM ubuntu:20.04 as builder
+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_16.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
+
+#Set password to 'password' change value below if you want a different password
+#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'"
+
+# Update to the latest version of npm.
+#RUN npm install -g npm@7.23.0
+RUN npm install -g npm
+
+# npm mirror to prevent direct dependency on npm.
+RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+# Clone the rest.bitcoin.com repository
+WORKDIR /home/safeuser
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v2
+
+# Switch to the desired branch. `master` is usually stable,
+# and `stage` has the most up-to-date changes.
+WORKDIR /home/safeuser/bch-dex-ui-v2
+
+# For development: switch to unstable branch
+RUN git checkout ct-unstable
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+#RUN npm install -g @mapbox/node-pre-gyp
+RUN npm install
+
+# Build the site
+RUN CI=true npm run build
+
+# Load the NGINX image.
+FROM nginx
+EXPOSE 80
+
+# Copy the files built in the first container to the new NGINX container.
+COPY --from=builder /home/safeuser/bch-dex-ui-v2/build /usr/share/nginx/html
+
+#USER safeuser

production/rpi-docker/bch-dex/Dockerfile

@@ -12,7 +12,7 @@ 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 curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
 RUN bash nodesource_setup.sh
 RUN apt-get install -y nodejs build-essential
 
@@ -46,11 +46,11 @@ RUN npm set registry http://94.130.170.209:4873/
 
 # Clone the rest.bitcoin.com repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-service-provider
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
-WORKDIR /home/safeuser/ipfs-service-provider
+WORKDIR /home/safeuser/bch-dex
 
 # For development: switch to unstable branch
 RUN git checkout ct-unstable
@@ -63,13 +63,16 @@ RUN npm install
 # Generate the API docs
 RUN npm run docs
 
-VOLUME /home/safeuser/keys
+# Copy the wallet files
+#COPY wallet.json wallet.json
+
+#VOLUME /home/safeuser/keys
 
 # Expose the port the API will be served on.
-EXPOSE 5010
+#EXPOSE 5010
 
 # Start the application.
-COPY start-production.sh start-production.sh
+#COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]
 
 #CMD ["npm", "start"]

production/rpi-docker/bch-dex/start-production.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# BEGIN: Optional configuration settings
+
+# The human readable name this IPFS node identifies as.
+export COORD_NAME=bch-dex-generic
+
+# Allow this node to function as a circuit relay. It must not be behind a firewall.
+#export ENABLE_CIRCUIT_RELAY=true
+# For browsers to use your circuit realy, you must set up a domain, SSL certificate,
+# and you must forward that subdomain to the IPFS_WS_PORT.
+#export CR_DOMAIN=subdomain.yourdomain.com
+
+# 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:5666/bch-swap-service-prod
+
+# Configure REST API port
+export PORT=5700
+
+# bch-dex specific env vars
+export BCH_DEX=prod
+export WEBHOOKSERVICE=http://172.17.0.1:5667/webhook
+export WEBHOOKTARGET=http://172.17.0.1:5700/p2wdb
+export APP_ID=bch-dex-001
+
+npm start

production/rpi-docker/cleanup-images.sh

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

production/rpi-docker/docker-compose.yml

@@ -0,0 +1,112 @@
+# Start the service with the command 'docker-compose up -d'
+
+version: '3.9'
+
+services:
+  mongo-bch-dex:
+    image: mongo:4.2.0
+    container_name: mongo-bch-dex
+    ports:
+      - '5666:27017' # <host port>:<container port>
+    volumes:
+      - ../data/database:/data/db
+    command: mongod --logpath=/dev/null # -- quiet
+    restart: always
+
+  ipfs:
+    image: christroutner/trickle-ipfs-rpi:v1.0.1
+    #image: odanado/go-ipfs:v0.11.0
+    container_name: ipfs
+    environment:
+      IPFS_DAEMON_ARGUMENTS: '--enable-pubsub-experiment --migrate=true --agent-version-suffix=docker --routing=dhtclient'
+      UPLOAD_KBPS: '25'
+      DOWNLOAD_KBPS: '25'
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 1000mb
+    ports:
+      - 4001:4001
+      - 4003:4003
+      - 172.17.0.1:5001:5001
+      - 172.17.0.1:8080:8080
+    volumes:
+      - ./data/go-ipfs:/root/.ipfs
+    command: [
+      './start-ipfs.sh'
+    ]
+    restart: always
+
+  p2wdb:
+    #build:
+    #  context: ./p2wdb/
+    #  dockerfile: Dockerfile
+    image: christroutner/p2wdb-rpi:v3.1.9
+    container_name: p2wdb
+    environment:
+      CONSUMER_URL: 'https://wa-usa-bch-consumer.fullstackcash.nl'
+      DEBUG_LEVEL: 1
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 1gb
+    links:
+      - mongo-bch-dex
+    ports:
+      # <host port>:<container port>
+      - 5667:5667 # REST API
+      #- 5668:5668 # IPFS TCP port
+      #- 5669:5669 # IPFS WS Port
+    volumes:
+      - ../data/ipfsdata/p2wdb:/home/safeuser/ipfs-p2wdb-service/.ipfsdata/p2wdb
+      - ./p2wdb/start-production.sh:/home/safeuser/ipfs-p2wdb-service/start-production.sh
+    restart: always
+
+  bch-dex:
+    #build:
+    # context: ./bch-dex/
+    # dockerfile: Dockerfile
+    image: christroutner/bch-dex-rpi:v2.0.8
+    container_name: bch-dex
+    environment:
+      #CONSUMER_URL: 'https://free-bch.fullstack.cash'
+      CONSUMER_URL: 'https://wa-usa-bch-consumer.fullstackcash.nl'
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 1000mb
+    links:
+      - mongo-bch-dex
+      - p2wdb
+    ports:
+      - '5700:5700' # <host port>:<container port>
+    volumes:
+      - ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
+      - ./bch-dex/start-production.sh:/home/safeuser/bch-dex/start-production.sh
+    restart: always
+
+  dex-ui:
+    #build:
+    #  context: ./bch-dex-ui/
+    #  dockerfile: Dockerfile
+    image: christroutner/bch-dex-ui-rpi:v1.2.4
+    container_name: dex-ui
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    mem_limit: 500mb
+    links:
+      - bch-dex
+    ports:
+      - '4500:80' # <host port>:<container port>
+    # volumes:
+    #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
+    restart: always

production/rpi-docker/p2wdb/Dockerfile

@@ -0,0 +1,71 @@
+# Create a Docker container for the P2WDB
+#
+
+#IMAGE BUILD COMMANDS
+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_16.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
+
+#Set password to 'abcd8765' change value below if you want a different password
+RUN echo safeuser:abcd8765 | chpasswd
+
+#Set the working directory to be the users home directory
+WORKDIR /home/safeuser
+
+#Setup NPM for non-root global install (like on a mac)
+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.
+#RUN npm install -g npm@7.23.0
+RUN npm install -g npm
+
+# npm mirror to prevent direct dependency on npm.
+RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+# Clone the rest.bitcoin.com repository
+RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service
+WORKDIR /home/safeuser/ipfs-p2wdb-service
+RUN mkdir .ipfsdata
+RUN git checkout ct-unstable
+
+#RUN npm install fsevents
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+RUN npm install
+
+# Generate the API docs
+RUN npm run docs
+
+# 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"]
+
+#CMD ["npm", "start"]
+
+# Used for debugging
+#COPY dummyapp.js dummyapp.js
+#CMD ["node", "dummyapp.js"]

production/rpi-docker/p2wdb/dummyapp.js

@@ -0,0 +1,4 @@
+setInterval(function () {
+  const now = new Date()
+  console.log(`ping ${now.toLocaleString()}`)
+}, 10000)

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

@@ -0,0 +1,48 @@
+#!/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="mass response fiscal world message exact series swallow forward confirm canoe festival"
+
+# The human readable name this IPFS node identifies as.
+export COORD_NAME=generic-p2wdb-production
+
+# Allow this node to function as a circuit relay. It must not be behind a firewall.
+#export ENABLE_CIRCUIT_RELAY=true
+# For browsers to use your circuit realy, you must set up a domain, SSL certificate,
+# and you must forward that subdomain to the IPFS_WS_PORT.
+#export CR_DOMAIN=subdomain.yourdomain.com
+
+# Debug level. 0 = minimal info. 2 = max info.
+# This value set by docker-compose.yml
+#export DEBUG_LEVEL=1
+
+# Log-in information for retrieving a JWT token from FullStack.cash.
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
+
+# END: Optional configuration settings
+
+
+# Production database connection string.
+export DBURL=mongodb://172.17.0.1:5666/p2wdb-service-dev
+
+# Configure IPFS ports
+export IPFS_TCP_PORT=5668
+export IPFS_WS_PORT=5669
+
+# Configure REST API port
+export PORT=5667
+
+export P2W_ENV=production
+export IPFS_HOST=172.17.0.1
+export IPFS_API_PORT=5001
+export IPFS_TCP_PORT=4001
+export IPFS_WS_PORT=4003
+
+# P2WDB specific env vars
+#export ORBITDB_NAME=/orbitdb/zdpuAqNiwLiJBfbRK7uihV2hAbNSXj78ufzv5VyQb8GuvRwDh/psf-bch-p2wdb-keyvalue-v3.0.0-0001
+
+npm start

production/scripts/bulk-sweep-wallet.js

@@ -0,0 +1,153 @@
+/*
+  This script is similar ot sweep-wallet.js, but it can do a much faster (bulk)
+  scanning of addresses. However, this requires a subscription to a FullStack.cash
+  or access to a web2 Cash Stack.
+
+  This script will scan 20 addresses at a time. If a balance is found in any
+  of the addresses, it will sweep the funds from that address.
+*/
+/*
+// Public npm libraries
+import BchTokenSweep from 'bch-token-sweep/index.js'
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+import BCHJS from '@psf/bch-js'
+import JwtLib from 'jwt-bch-lib'
+
+// Constants
+// const EMTPY_ADDR_CUTOFF = 100
+const LAST_ADDR_INDEX = 100
+
+if (!process.env.BCHJSTOKEN) {
+  console.log('You will need a JWT token from FullStack.cash to execute this script. Export it to the BCHJSTOKEN environment variable and try again.')
+  exit(0)
+}
+
+async function sweepFunds () {
+  try {
+    // Configure the wallet library to use a FullStack.cash or a local Cash Stack
+    const walletLib = new WalletAdapter()
+    walletLib.config.useFullStackCash = true
+    walletLib.config.apiServer = 'http://192.168.2.129:3000/v5/'
+
+    // const walletInfo = await walletLib.openWallet()
+    const walletInfo = await openWallet(walletLib)
+    const wallet = await walletLib.instanceWallet(walletInfo)
+    console.log('walletInfo: ', walletInfo)
+
+    const rootAddr = walletInfo.cashAddress
+    const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Instantiate bch-js, and use the JWT token saved to environment variable.
+
+    // Generate an HD tree
+    // const bchjs = wallet.bchjs
+    const bchjs = new BCHJS()
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    const emptyAddrCnt = 0
+    const hdIndex = 1
+
+    // Divide all the addresses by 20, since that's how many will be checked at once.
+    const numOfLoops = Math.ceil(LAST_ADDR_INDEX / 20)
+
+    for (let i = 1; i < numOfLoops; i++) {
+      const startIndex = i
+      const stopIndex = i * 20
+      console.log(`startIndex: ${startIndex}, stopIndex: ${stopIndex}`)
+
+      // Generate the next block of 20 key pairs to scan.
+      const addrsToScan = []
+      const wifsToScan = []
+      for (let j = startIndex; j < stopIndex; j++) {
+        // Generate a keypair from the HD wallet.
+        const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${j}`)
+        const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+        const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+        addrsToScan.push(cashAddress)
+        wifsToScan.push(wifToSweep)
+      }
+      console.log(`Scanning these addresses for a balance: ${JSON.stringify(addrsToScan, null, 2)}`)
+
+      // Scan a block of 20 addresses for a balance.
+      const balances = await bchjs.Electrumx.balance(addrsToScan)
+      console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
+
+      // Scan through the results and look for a balance.
+      for (let j = 0; j < balances.balances.length; j++) {
+        const thisBalance = balances.balances[j]
+
+        // const combinedBal = thisBalance.balance.confirmed + thisBalance.balance.
+
+        // if(thisBalance.)
+      }
+    }
+
+    // do {
+    //   // Generate a keypair from the HD wallet.
+    //   const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+    //   const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+    //   const wifToSweep = bchjs.HDNode.toWIF(childNode)
+    //
+    //   console.log(`\nSweeping ${cashAddress} with private key ${wifToSweep}`)
+    //
+    //   try {
+    //     // Sweep tokens from address
+    //     const sweeper = new BchTokenSweep(
+    //       wifToSweep,
+    //       rootWif,
+    //       wallet,
+    //       550,
+    //       rootAddr
+    //     )
+    //     await sweeper.populateObjectFromNetwork()
+    //
+    //     const hex = await sweeper.sweepTo(rootAddr)
+    //     // console.log(`hex: ${hex}`)
+    //
+    //     const txid = await sweeper.blockchain.broadcast(hex)
+    //
+    //     // console.log('Transaction ID', txid)
+    //     console.log(`Swept HD index ${hdIndex}. TXID: ${txid}`)
+    //
+    //     emptyAddrCnt = 0
+    //
+    //     // Wait between loop iterations.
+    //     await bchjs.Util.sleep(3000)
+    //   } catch (err) {
+    //     console.log(`error message with index ${hdIndex}: ${err.message}`)
+    //     // console.log(err)
+    //     emptyAddrCnt++
+    //   }
+    //
+    //   hdIndex++
+    // } while (emptyAddrCnt < EMTPY_ADDR_CUTOFF)
+    //
+    // console.log(`${EMTPY_ADDR_CUTOFF} empty addresses detected. Exiting.`)
+    //
+    // console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
+  } catch (err) {
+    console.error('Error in sweepFunds(): ', err)
+  }
+}
+sweepFunds()
+
+// Open the wallet file, or create one if the file doesn't exist.
+// Does not instance the wallet. The output of this function is expected to
+// be passed to instanceWallet().
+async function openWallet (walletLib) {
+  try {
+    // console.log('this.WALLET_FILE: ', this.WALLET_FILE)
+    const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
+
+    return walletData
+  } catch (err) {
+    console.error('Error in openWallet()')
+    throw err
+  }
+}
+*/

production/scripts/create-order.js

@@ -0,0 +1,40 @@
+/*
+  This script can be used to generate new Orders and Offers, until the UI for
+  that is built.
+
+  Customize the settings below to add your own Order. The token must exist in
+  the DEX app wallet in order to be acceped.
+*/
+
+import axios from 'axios'
+
+const LOCALHOST = 'http://localhost:5700'
+// const LOCALHOST = 'http://172.17.0.1:5700'
+
+async function start () {
+  try {
+    const mockOrder = {
+      lokadId: 'SWP',
+      messageType: 1,
+      messageClass: 1,
+      tokenId:
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+      buyOrSell: 'sell',
+      rateInBaseUnit: 5000,
+      minUnitsToExchange: 5000,
+      numTokens: 2
+    }
+
+    const options = {
+      method: 'post',
+      url: `${LOCALHOST}/order`,
+      data: { order: mockOrder }
+    }
+
+    const result = await axios(options)
+    console.log('result.data: ', result.data)
+  } catch (err) {
+    console.log(err)
+  }
+}
+start()

production/scripts/create-wallet.js

@@ -0,0 +1,33 @@
+/*
+  Generate a wallet.json file for use with the DEX.
+*/
+
+// Public NPM libraries
+import BchWallet from 'minimal-slp-wallet'
+
+import { promises as fs } from 'fs'
+
+async function createWallet () {
+  try {
+    // Configure the minimal-slp-wallet library to use the JSON RPC over IPFS.
+    const advancedConfig = {
+      interface: 'consumer-api',
+      noUpdate: true
+    }
+
+    // Wait for the wallet to be created.
+    const bchWallet = new BchWallet(undefined, advancedConfig)
+    await bchWallet.walletInfoPromise
+    const walletData = bchWallet.walletInfo
+    walletData.nextAddress = 1
+
+    // Save the wallet file to disk.
+    await fs.writeFile('wallet.json', JSON.stringify(walletData, null, 2))
+
+    console.log('Generated wallet.json. Copy this file to the docker/bch-dex folder to be used inside the Docker container.')
+    console.log(`${JSON.stringify(walletData, null, 2)}`)
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+createWallet()

production/scripts/fullstack-sweep-wallet.js

@@ -0,0 +1,111 @@
+/*
+  This script is the same as sweep-wallet.js, but it requires a FullStack.cash
+  account, which makes the scanning much faster.
+*/
+
+// Public npm libraries
+// const BCHJS = require('@psf/bch-js')
+import BchTokenSweep from 'bch-token-sweep/index.js'
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+
+// Constants
+// const EMTPY_ADDR_CUTOFF = 10
+const START_INDEX = 1
+const LAST_ADDR_INDEX = 100
+
+if (!process.env.BCHJSTOKEN) {
+  console.log('You will need a JWT token from FullStack.cash to execute this script. Export it to the BCHJSTOKEN environment variable and try again.')
+  process.exit(0)
+}
+
+async function sweepFunds () {
+  try {
+    // Configure the wallet library to use a FullStack.cash or a local Cash Stack
+    const walletLib = new WalletAdapter()
+    walletLib.config.useFullStackCash = true
+    // walletLib.config.apiServer = 'http://192.168.2.129:3000/v5/'
+    walletLib.config.apiServer = 'https://api.fullstack.cash/v5/'
+
+    // Open the wallet files.
+    const walletInfo = await openWallet(walletLib)
+    const wallet = await walletLib.instanceWallet(walletInfo)
+    console.log('walletInfo: ', walletInfo)
+
+    const rootAddr = walletInfo.cashAddress
+    const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Generate an HD tree
+    const bchjs = wallet.bchjs
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    let emptyAddrCnt = 0
+    let hdIndex = START_INDEX
+
+    do {
+      // Generate a keypair from the HD wallet.
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+      const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+      console.log(`\nSweeping ${cashAddress} with private key ${wifToSweep}`)
+
+      try {
+        // Sweep tokens from address
+        const sweeper = new BchTokenSweep(
+          wifToSweep,
+          rootWif,
+          wallet,
+          550,
+          rootAddr
+        )
+        await sweeper.populateObjectFromNetwork()
+
+        const hex = await sweeper.sweepTo(rootAddr)
+        // console.log(`hex: ${hex}`)
+
+        const txid = await sweeper.blockchain.broadcast(hex)
+
+        // console.log('Transaction ID', txid)
+        console.log(`Swept HD index ${hdIndex}. TXID: ${txid}`)
+
+        emptyAddrCnt = 0
+
+        // Wait between loop iterations.
+        await bchjs.Util.sleep(3000)
+      } catch (err) {
+        console.log(`error message with index ${hdIndex}: ${err.message}`)
+        // console.log(err)
+        emptyAddrCnt++
+      }
+
+      hdIndex++
+      // } while (emptyAddrCnt < EMTPY_ADDR_CUTOFF)
+      // console.log(`${EMTPY_ADDR_CUTOFF} empty addresses detected. Exiting.`)
+    } while (hdIndex < LAST_ADDR_INDEX)
+    console.log(`Last index of ${LAST_ADDR_INDEX} reached. emptyAddrCnt: ${emptyAddrCnt}`)
+
+    console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
+  } catch (err) {
+    console.error('Error in sweepFunds(): ', err)
+  }
+}
+sweepFunds()
+
+// Open the wallet file, or create one if the file doesn't exist.
+// Does not instance the wallet. The output of this function is expected to
+// be passed to instanceWallet().
+async function openWallet (walletLib) {
+  try {
+    // console.log('this.WALLET_FILE: ', this.WALLET_FILE)
+    const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
+
+    return walletData
+  } catch (err) {
+    console.error('Error in openWallet()')
+    throw err
+  }
+}

production/scripts/list-addrs.js

@@ -0,0 +1,67 @@
+/*
+  This script is the same as sweep-wallet.js, but instead of sweeping the keys,
+  it simply lists out the addresses in the HD keychain. This is hany when trying
+  to figure out which address a token was sent to.
+*/
+
+// Public npm libraries
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+
+// Constants
+const START_INDEX = 1
+const LAST_ADDR_INDEX = 100
+
+async function listAddrs () {
+  try {
+    // Configure the wallet library to use a FullStack.cash or a local Cash Stack
+    const walletLib = new WalletAdapter()
+
+    // Open the wallet files.
+    const walletInfo = await openWallet(walletLib)
+    const wallet = await walletLib.instanceWallet(walletInfo)
+    console.log('walletInfo: ', walletInfo)
+
+    const rootAddr = walletInfo.cashAddress
+    // const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Generate an HD tree
+    const bchjs = wallet.bchjs
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    let hdIndex = START_INDEX
+
+    do {
+      // Generate a keypair from the HD wallet.
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+      // const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+      console.log(`HD Index ${hdIndex}: ${cashAddress}`)
+
+      hdIndex++
+    } while (hdIndex < LAST_ADDR_INDEX)
+    console.log(`Last index of ${LAST_ADDR_INDEX} reached.`)
+  } catch (err) {
+    console.error('Error in sweepFunds(): ', err)
+  }
+}
+listAddrs()
+
+// Open the wallet file, or create one if the file doesn't exist.
+// Does not instance the wallet. The output of this function is expected to
+// be passed to instanceWallet().
+async function openWallet (walletLib) {
+  try {
+    // console.log('this.WALLET_FILE: ', this.WALLET_FILE)
+    const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
+
+    return walletData
+  } catch (err) {
+    console.error('Error in openWallet()')
+    throw err
+  }
+}

production/scripts/sweep-nfts.js

@@ -0,0 +1,143 @@
+/*
+  This script will sweep the HD wallet, looking for NFTs. When found, it will
+  send the NFT to the root (index 0) address. It will pay transaction fees from
+  the root address.
+*/
+
+// Global npm libraries
+import BchWallet from 'minimal-slp-wallet'
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+
+// Constants
+const EMTPY_ADDR_CUTOFF = 10
+const WEB3_SERVER = 'https://free-bch.fullstack.cash'
+
+async function sweepNfts () {
+  try {
+    // Open the wallet files.
+    const walletLib = new WalletAdapter()
+    // const walletInfo = await walletLib.openWallet()
+    const walletInfo = await openWallet(walletLib)
+    // const walletRoot = await walletLib.instanceWallet(walletInfo)
+    const walletRoot = new BchWallet(walletInfo.mnemonic, {
+      interface: 'consumer-api',
+      restURL: WEB3_SERVER
+    })
+    await walletRoot.walletInfoPromise
+    console.log('walletInfo: ', walletInfo)
+
+    const rootAddr = walletInfo.cashAddress
+    // const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Generate an HD tree
+    const bchjs = walletRoot.bchjs
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    let emptyAddrCnt = 0
+    let hdIndex = 1
+
+    do {
+      // Generate a keypair from the HD wallet.
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+      const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+      console.log(`\n${hdIndex}: Sweeping ${cashAddress} with private key ${wifToSweep}`)
+
+      const walletChild = new BchWallet(wifToSweep, { interface: 'consumer-api', restURL: WEB3_SERVER })
+      await walletChild.walletInfoPromise
+
+      try {
+        const tokens = await walletChild.tokens.listTokensFromAddress(cashAddress)
+        // console.log(`tokens: ${JSON.stringify(tokens, null, 2)}`)
+
+        await walletChild.utxos.initUtxoStore(cashAddress)
+        // console.log(`utxoStore: ${JSON.stringify(utxoStore, null, 2)}`)
+
+        for (let i = 0; i < tokens.length; i++) {
+          const thisToken = tokens[i]
+
+          if (thisToken.tokenType === 65) {
+            console.log(`NFT ${thisToken.ticker} (${thisToken.name}) found. Sweeping to ${rootAddr}`)
+
+            await walletRoot.initialize()
+
+            // Send BCH to the child address, to pay for transaction fees.
+            const receiver1 = [{
+              address: cashAddress,
+              amountSat: 10000
+            }]
+            const txid1 = await walletRoot.send(receiver1)
+            console.log(`10,000 sats sent to child address. TXID: ${txid1}`)
+
+            // Wait for indexers to update.
+            console.log('Waiting for indexers to update...')
+            await bchjs.Util.sleep(120000)
+
+            await walletChild.initialize()
+
+            // Send NFT to root address.
+            const receiver2 = [{
+              address: rootAddr,
+              tokenId: thisToken.tokenId,
+              qty: thisToken.qty
+            }]
+            const txid2 = await walletChild.sendTokens(receiver2)
+            console.log(`NFT sent from child address to root address. TXID: ${txid2}`)
+
+            // Wait for indexers to update.
+            console.log('Waiting for indexers to update...')
+            await bchjs.Util.sleep(3000)
+
+            // Refresh the UTXO store.
+            await walletChild.utxos.initUtxoStore(cashAddress)
+
+            // Send the rest of the BCH back to the root address.
+            const txid3 = await walletChild.sendAll(rootAddr)
+            console.log(`Leftover BCH in child address sent to root address. TXID: ${txid3}`)
+
+            emptyAddrCnt = 0
+          }
+        }
+
+        // Wait between loop iterations.
+        await bchjs.Util.sleep(3000)
+
+        // emptyAddrCnt++
+      } catch (err) {
+        console.log(`error message with index ${hdIndex}: ${err.message}`)
+        console.log(err)
+        // emptyAddrCnt++
+      }
+
+      emptyAddrCnt++
+      hdIndex++
+    } while (emptyAddrCnt < EMTPY_ADDR_CUTOFF)
+
+    console.log(`${EMTPY_ADDR_CUTOFF} empty addresses detected. Exiting.`)
+
+    console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
+  } catch (err) {
+    console.log('Error while sweeping NFTs: ', err)
+  }
+}
+sweepNfts()
+
+// Open the wallet file, or create one if the file doesn't exist.
+// Does not instance the wallet. The output of this function is expected to
+// be passed to instanceWallet().
+async function openWallet (walletLib) {
+  try {
+    // console.log('this.WALLET_FILE: ', this.WALLET_FILE)
+    const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
+
+    return walletData
+  } catch (err) {
+    console.error('Error in openWallet()')
+    throw err
+  }
+}

production/scripts/sweep-wallet.js

@@ -0,0 +1,100 @@
+/*
+  This script will travers the HD wallet and sweep funds and tokens back
+  into the root address (index 0). That root address needs to have funds
+  to pay for the transactions.
+*/
+
+// Public npm libraries
+// const BCHJS = require('@psf/bch-js')
+import BchTokenSweep from 'bch-token-sweep/index.js'
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+
+// Constants
+const EMTPY_ADDR_CUTOFF = 10
+
+async function sweepFunds () {
+  try {
+    // Open the wallet files.
+    const walletLib = new WalletAdapter()
+    // const walletInfo = await walletLib.openWallet()
+    const walletInfo = await openWallet(walletLib)
+    const wallet = await walletLib.instanceWallet(walletInfo)
+    console.log('walletInfo: ', walletInfo)
+
+    const rootAddr = walletInfo.cashAddress
+    const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Generate an HD tree
+    const bchjs = wallet.bchjs
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    let emptyAddrCnt = 0
+    let hdIndex = 1
+
+    do {
+      // Generate a keypair from the HD wallet.
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+      const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+      console.log(`\nSweeping ${cashAddress} with private key ${wifToSweep}`)
+
+      try {
+        // Sweep tokens from address
+        const sweeper = new BchTokenSweep(
+          wifToSweep,
+          rootWif,
+          wallet,
+          550,
+          rootAddr
+        )
+        await sweeper.populateObjectFromNetwork()
+
+        const hex = await sweeper.sweepTo(rootAddr)
+        // console.log(`hex: ${hex}`)
+
+        const txid = await sweeper.blockchain.broadcast(hex)
+
+        // console.log('Transaction ID', txid)
+        console.log(`Swept HD index ${hdIndex}. TXID: ${txid}`)
+
+        emptyAddrCnt = 0
+
+        // Wait between loop iterations.
+        await bchjs.Util.sleep(3000)
+      } catch (err) {
+        console.log(`error message with index ${hdIndex}: ${err.message}`)
+        // console.log(err)
+        emptyAddrCnt++
+      }
+
+      hdIndex++
+    } while (emptyAddrCnt < EMTPY_ADDR_CUTOFF)
+
+    console.log(`${EMTPY_ADDR_CUTOFF} empty addresses detected. Exiting.`)
+
+    console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
+  } catch (err) {
+    console.error('Error in sweepFunds(): ', err)
+  }
+}
+sweepFunds()
+
+// Open the wallet file, or create one if the file doesn't exist.
+// Does not instance the wallet. The output of this function is expected to
+// be passed to instanceWallet().
+async function openWallet (walletLib) {
+  try {
+    // console.log('this.WALLET_FILE: ', this.WALLET_FILE)
+    const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
+
+    return walletData
+  } catch (err) {
+    console.error('Error in openWallet()')
+    throw err
+  }
+}

src/adapters/admin.js

@@ -13,16 +13,24 @@
   in the Adapter directory.
 */
 
-'use strict'
-const axios = require('axios').default
-const mongoose = require('mongoose')
-const User = require('../adapters/localdb/models/users')
-const config = require('../../config')
-const JsonFiles = require('../adapters/json-files')
+// Global npm libraries
+import axios from 'axios'
+import mongoose from 'mongoose'
+
+// Local libraries
+import User from '../adapters/localdb/models/users.js'
+import config from '../../config/index.js'
+import JsonFiles from '../adapters/json-files.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+
 const jsonFiles = new JsonFiles()
 
 const JSON_FILE = `system-user-${config.env}.json`
-const JSON_PATH = `${__dirname.toString()}/../../config/${JSON_FILE}`
+const JSON_PATH = `${__dirname.toString()}../../config/${JSON_FILE}`
 
 const LOCALHOST = `http://localhost:${config.port}`
 const context = {}
@@ -82,6 +90,8 @@ class Admin {
       // applications like the Task Manager and the test scripts can access.
 
       await jsonFiles.writeJSON(context, JSON_PATH)
+      // console.log('context: ', context)
+      // console.log('JSON_PATH: ', JSON_PATH)
 
       return context
     } catch (err) {
@@ -169,4 +179,4 @@ class Admin {
   }
 }
 
-module.exports = Admin
+export default Admin

src/adapters/bch.js

@@ -3,9 +3,10 @@
 */
 
 // Public npm libraries
-const BCHJS = require('@psf/bch-js')
-const MsgLib = require('bch-message-lib')
-const BchWallet = require('minimal-slp-wallet/index')
+import BCHJS from '@psf/bch-js'
+
+import MsgLib from 'bch-message-lib'
+import BchWallet from 'minimal-slp-wallet'
 
 class Bch {
   constructor () {
@@ -40,30 +41,30 @@ class Bch {
   }
 
   // Gets the total psf token balance
-  async getPSFTokenBalance (slpAddress) {
-    try {
-      if (!slpAddress || typeof slpAddress !== 'string') {
-        throw new Error('slpAddress must be a string')
-      }
-      let psfBalance = 0
-      const balances = await this.bchjs.SLP.Utils.balancesForAddress(
-        slpAddress
-      )
-
-      // Sums all the balances of all tokens
-      // that match the psf token ID
-      for (let i = 0; i < balances.length; i++) {
-        if (balances[i].tokenId === this.PSF_TOKEN_ID) {
-          psfBalance += balances[i].balance
-        }
-      }
-
-      return psfBalance
-    } catch (err) {
-      console.error('Error in bch.js/getPSFTokenBalance()')
-      throw err
-    }
-  }
+  // async getPSFTokenBalance (slpAddress) {
+  //   try {
+  //     if (!slpAddress || typeof slpAddress !== 'string') {
+  //       throw new Error('slpAddress must be a string')
+  //     }
+  //     let psfBalance = 0
+  //     const balances = await this.bchjs.SLP.Utils.balancesForAddress(
+  //       slpAddress
+  //     )
+  //
+  //     // Sums all the balances of all tokens
+  //     // that match the psf token ID
+  //     for (let i = 0; i < balances.length; i++) {
+  //       if (balances[i].tokenId === this.PSF_TOKEN_ID) {
+  //         psfBalance += balances[i].balance
+  //       }
+  //     }
+  //
+  //     return psfBalance
+  //   } catch (err) {
+  //     console.error('Error in bch.js/getPSFTokenBalance()')
+  //     throw err
+  //   }
+  // }
 
   async getMerit (slpAddr) {
     try {
@@ -79,4 +80,4 @@ class Bch {
   }
 }
 
-module.exports = Bch
+export default Bch

src/adapters/contact.js

@@ -3,13 +3,12 @@
 */
 
 /* eslint-disable no-useless-escape */
+import config from '../../config/index.js'
+import NodeMailer from '../adapters/nodemailer.js'
+import wlogger from '../adapters/wlogger.js'
+
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
-
-const config = require('../../config')
-
-const NodeMailer = require('../adapters/nodemailer')
 const nodemailer = new NodeMailer()
-const { wlogger } = require('../adapters/wlogger')
 
 let _this
 
@@ -60,4 +59,4 @@ class ContactLib {
     }
   }
 }
-module.exports = ContactLib
+export default ContactLib

src/adapters/fullstack-jwt.js

@@ -5,8 +5,9 @@
   for this file.
 */
 
-const JwtLib = require('jwt-bch-lib')
-const BCHJS = require('@psf/bch-js')
+import JwtLib from 'jwt-bch-lib'
+
+import BCHJS from '@psf/bch-js'
 
 class FullStackJWT {
   constructor (localConfig = {}) {
@@ -98,4 +99,4 @@ class FullStackJWT {
   }
 }
 
-module.exports = FullStackJWT
+export default FullStackJWT

src/adapters/index.js

@@ -5,42 +5,26 @@
 */
 
 // Public NPM libraries
-const BCHJS = require('@psf/bch-js')
+import BCHJS from '@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')
+import IPFSAdapter from './ipfs/index.js'
+
+import LocalDB from './localdb/index.js'
+import LogsAPI from './logapi.js'
+import Passport from './passport.js'
+import Nodemailer from './nodemailer.js'
+
 // const { wlogger } = require('./wlogger')
-const JSONFiles = require('./json-files')
-const FullStackJWT = require('./fullstack-jwt')
-const BCHAdapter = require('./bch')
-const WalletAdapter = require('./wallet')
-const P2wdbAdapter = require('./p2wdb-adapter')
+import JSONFiles from './json-files.js'
 
-//
-// // 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 bchjs = new BCHJSAdapter()
-//
-// module.exports = {
-//   ipfs,
-//   localdb,
-//   logapi,
-//   passport,
-//   nodemailer,
-//   wlogger,
-//   jsonFiles,
-//   bchjs
+import FullStackJWT from './fullstack-jwt.js'
+import config from '../../config/index.js'
 
-const config = require('../../config')
+import BCHAdapter from './bch.js'
+import WalletAdapter from './wallet.js'
+import P2wdbAdapter from './p2wdb-adapter.js'
+import Webhook from './webhook.js'
 
 class Adapters {
   constructor (localConfig = {}) {
@@ -56,7 +40,9 @@ class Adapters {
     this.bch = new BCHAdapter()
     this.config = config
     this.wallet = new WalletAdapter()
+    localConfig.bchWallet = this.wallet.bchWallet
     this.p2wdb = new P2wdbAdapter(localConfig)
+    this.webhook = new Webhook()
 
     // Get a valid JWT API key and instance bch-js.
     this.fullStackJwt = new FullStackJWT(config)
@@ -73,14 +59,30 @@ class Adapters {
       }
 
       // Start the IPFS node.
-      // await this.ipfs.start()
+      // Do not start these adapters if this is an e2e test.
+      // if (this.config.env !== 'test') {
+      //   await this.ipfs.start()
+      // }
 
       // Open the wallet file
       const walletData = await this.wallet.openWallet()
       // console.log('walletData: ', walletData)
 
-      // Instance the wallet.
-      await this.wallet.instanceWallet(walletData, this.bchjs)
+      if (this.config.env !== 'test') {
+        // Instance the wallet.
+        await this.wallet.instanceWallet(walletData, this.bchjs)
+
+        // Wait until a webhook is established with the P2WDB
+        await this.webhook.waitUntilSuccess(this.config.webhookTarget)
+
+        // Overwrite instances of wallet used by P2WDB lib.
+        this.p2wdb.bchWallet = this.wallet.bchWallet
+        this.p2wdb.bchjs = this.wallet.bchWallet.bchjs
+      }
+
+      console.log('Async Adapters have been started.')
+
+      return true
     } catch (err) {
       console.error('Error in adapters/index.js/start()')
       throw err
@@ -88,4 +90,4 @@ class Adapters {
   }
 }
 
-module.exports = Adapters
+export default Adapters

src/adapters/ipfs/index.js

@@ -2,8 +2,11 @@
   top-level IPFS library that combines the individual IPFS-based libraries.
 */
 
-const IpfsAdapter = require('./ipfs')
-const IpfsCoordAdapter = require('./ipfs-coord')
+// Local libraries
+import IpfsAdapter from './ipfs.js'
+
+import IpfsCoordAdapter from './ipfs-coord.js'
+import config from '../../../config/index.js'
 
 class IPFS {
   constructor (localConfig = {}) {
@@ -11,6 +14,7 @@ class IPFS {
     this.ipfsAdapter = new IpfsAdapter()
     this.IpfsCoordAdapter = IpfsCoordAdapter
     this.process = process
+    this.config = config
 
     this.ipfsCoordAdapter = {} // placeholder
 
@@ -31,11 +35,16 @@ class IPFS {
 
       // Start ipfs-coord
       this.ipfsCoordAdapter = new this.IpfsCoordAdapter({
-        ipfs: this.ipfs
+        ipfs: this.ipfs,
+        tcpPort: this.config.ipfsTcpPort,
+        wsPort: this.config.ipfsWsPort
       })
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')
 
+      // Subscribe to the chat pubsub channel
+      await this.ipfsCoordAdapter.subscribeToChat()
+
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')
@@ -51,4 +60,4 @@ class IPFS {
   }
 }
 
-module.exports = IPFS
+export default IPFS

src/adapters/ipfs/ipfs-coord.js

@@ -5,12 +5,15 @@
 */
 
 // Global npm libraries
-const IpfsCoord = require('ipfs-coord')
-const BCHJS = require('@psf/bch-js')
-const publicIp = require('public-ip')
+import IpfsCoord from 'ipfs-coord-esm'
+
+// import BCHJS from '@psf/bch-js';
+import SlpWallet from 'minimal-slp-wallet'
+import publicIp from 'public-ip'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const JSONRPC = require('../../controllers/json-rpc/')
 
 let _this
@@ -28,7 +31,8 @@ class IpfsCoordAdapter {
     // Encapsulate dependencies
     this.IpfsCoord = IpfsCoord
     this.ipfsCoord = {}
-    this.bchjs = new BCHJS()
+    // this.bchjs = new BCHJS()
+    this.wallet = new SlpWallet()
     this.config = config
     this.publicIp = publicIp
 
@@ -41,6 +45,9 @@ class IpfsCoordAdapter {
   async start () {
     const circuitRelayInfo = {}
 
+    // Wait for the BCH wallet to create the wallet.
+    await this.wallet.walletInfoPromise
+
     // If configured as a Circuit Relay, get the public IP addresses for this node.
     if (this.config.isCircuitRelay) {
       try {
@@ -61,7 +68,7 @@ class IpfsCoordAdapter {
       ipfs: this.ipfs,
       type: 'node.js',
       // type: 'browser',
-      bchjs: this.bchjs,
+      wallet: this.wallet,
       privateLog: console.log, // Default to console.log
       isCircuitRelay: this.config.isCircuitRelay,
       circuitRelayInfo,
@@ -97,6 +104,15 @@ class IpfsCoordAdapter {
       throw err
     }
   }
+
+  // Subscribe to the chat pubsub channel
+  async subscribeToChat () {
+    await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
+      this.config.chatPubSubChan,
+      console.log,
+      this.ipfsCoord.thisNode
+    )
+  }
 }
 
-module.exports = IpfsCoordAdapter
+export default IpfsCoordAdapter

src/adapters/ipfs/ipfs.js

@@ -11,13 +11,14 @@
 // Global npm libraries
 // const IPFS = require('ipfs')
 // const IPFS = require('@chris.troutner/ipfs')
-const IPFSembedded = require('ipfs')
-const IPFSexternal = require('ipfs-http-client')
-const fs = require('fs')
-const http = require('http')
+// import IPFSembedded from 'ipfs';
+
+import { create } from 'ipfs-http-client'
+import fs from 'fs'
+import http from 'http'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
 
 const IPFS_DIR = './.ipfsdata/ipfs'
 
@@ -25,17 +26,17 @@ class IpfsAdapter {
   constructor (localConfig) {
     // Encapsulate dependencies
     this.config = config
+    this.fs = fs
+    this.create = create
 
     // Choose the IPFS constructor based on the config settings.
-    this.IPFS = IPFSembedded // default
-    if (this.config.isProduction) {
-      this.IPFS = IPFSexternal
-    }
+    // this.IPFS = IPFSembedded // default
+    // if (this.config.isProduction) {
+    //   this.IPFS = IPFSexternal
+    // }
 
     // Properties of this class instance.
     this.isReady = false
-
-    this.fs = fs
   }
 
   // Start an IPFS node.
@@ -85,7 +86,7 @@ class IpfsAdapter {
       }
 
       // Create a new IPFS node.
-      this.ipfs = await this.IPFS.create(ipfsOptions)
+      this.ipfs = await this.create(ipfsOptions)
 
       // Set the 'server' profile so the node does not scan private networks.
       await this.ipfs.config.profiles.apply('server')
@@ -102,9 +103,9 @@ class IpfsAdapter {
       console.error('Error in ipfs.js/start()')
 
       // If IPFS crashes because the /blocks directory is full, wipe the directory.
-      if (err.message.includes('No space left on device')) {
-        this.rmBlocksDir()
-      }
+      // if (err.message.includes('No space left on device')) {
+      //   this.rmBlocksDir()
+      // }
 
       throw err
     }
@@ -120,21 +121,21 @@ class IpfsAdapter {
   // Dev Note: It's assumed this node is not pinning any data and that
   // everything in this directory is transient. This folder will regularly
   // fill up and prevent IPFS from starting.
-  rmBlocksDir () {
-    try {
-      const dir = `${IPFS_DIR}/blocks`
-      console.log(`Deleting ${dir} directory...`)
-
-      this.fs.rmdirSync(dir, { recursive: true })
-
-      console.log(`${dir} directory is deleted!`)
-
-      return true // Signal successful execution.
-    } catch (err) {
-      console.log('Error in rmBlocksDir()')
-      throw err
-    }
-  }
+  // rmBlocksDir () {
+  //  try {
+  //    const dir = `${IPFS_DIR}/blocks`
+  //    console.log(`Deleting ${dir} directory...`)
+  //
+  //    this.fs.rmdirSync(dir, { recursive: true })
+  //
+  //    console.log(`${dir} directory is deleted!`)
+  //
+  //    return true // Signal successful execution.
+  //  } catch (err) {
+  //    console.log('Error in rmBlocksDir()')
+  //    throw err
+  //  }
+  // }
 }
 
-module.exports = IpfsAdapter
+export default IpfsAdapter

src/adapters/json-files.js

@@ -1,8 +1,8 @@
 /*
   A utility file for reading and writing JSON files.
 */
-'use strict'
-const fs = require('fs')
+
+import fs from 'fs'
 
 let _this
 
@@ -75,4 +75,4 @@ class JsonFiles {
   }
 }
 
-module.exports = JsonFiles
+export default JsonFiles

src/adapters/localdb/index.js

@@ -3,10 +3,10 @@
 */
 
 // Load Mongoose models.
-const Users = require('./models/users')
-const Entries = require('./models/entry')
-const Order = require('./models/order')
-const Offer = require('./models/offer')
+import Users from './models/users.js'
+import Entries from './models/entry.js'
+import Order from './models/order.js'
+import Offer from './models/offer.js'
 
 class LocalDB {
   constructor () {
@@ -18,4 +18,4 @@ class LocalDB {
   }
 }
 
-module.exports = LocalDB
+export default LocalDB

src/adapters/localdb/models/entry.js

@@ -1,4 +1,4 @@
-const mongoose = require('mongoose')
+import mongoose from 'mongoose'
 
 const Entry = new mongoose.Schema({
   entry: { type: String },
@@ -10,4 +10,4 @@ const Entry = new mongoose.Schema({
   merit: { type: Number }
 })
 
-module.exports = mongoose.model('entry', Entry)
+export default mongoose.model('entry', Entry)

src/adapters/localdb/models/offer.js

@@ -1,4 +1,4 @@
-const mongoose = require('mongoose')
+import mongoose from 'mongoose'
 
 const Offer = new mongoose.Schema({
 
@@ -6,6 +6,8 @@ const Offer = new mongoose.Schema({
   tokenId: { type: String },
   utxoTxid: { type: String },
   utxoVout: { type: Number },
+  ticker: { type: String, default: '' },
+  tokenType: { type: Number },
 
   // Trade data
   buyOrSell: { type: String },
@@ -14,14 +16,20 @@ const Offer = new mongoose.Schema({
   minUnitsToExchange: { type: String },
   p2wdbTxid: { type: String },
   p2wdbHash: { type: String },
+  offerStatus: { type: String },
+  makerAddr: { type: String },
 
   // Authentication data
   signature: { type: String },
   sigMsg: { type: String },
 
   // Utility data
-  timestamp: { type: String },
+  timestamp: { type: Number },
+  globalTimestamp: { type: String },
   localTimestamp: { type: String },
+  displayCategory: { type: String },
+  nsfw: { type: Boolean, default: false },
+  flags: { type: Array },
 
   // SWaP Protocol Properties
   lokadId: { type: String },
@@ -30,4 +38,4 @@ const Offer = new mongoose.Schema({
 
 })
 
-module.exports = mongoose.model('offer', Offer)
+export default mongoose.model('offer', Offer)

src/adapters/localdb/models/order.js

@@ -1,10 +1,20 @@
-const mongoose = require('mongoose')
+/*
+  Order Model. Orders are 'internal' to the system and track the HD wallet index
+  that contains funds for that Order. This is in contrast to Offers, which
+  are 'external' to the system and mirrored by every instance of bch-dex.
+
+  See the dev-docs/specification.md for details on each property.
+*/
+
+import mongoose from 'mongoose'
 
 const Order = new mongoose.Schema({
   // Token data
   tokenId: { type: String },
   utxoTxid: { type: String },
   utxoVout: { type: Number },
+  ticker: { type: String },
+  tokenType: { type: Number },
 
   // Trade data
   buyOrSell: { type: String },
@@ -13,6 +23,7 @@ const Order = new mongoose.Schema({
   minUnitsToExchange: { type: String },
   p2wdbTxid: { type: String },
   p2wdbHash: { type: String },
+  makerAddr: { type: String },
 
   // Authentication data
   signature: { type: String },
@@ -27,7 +38,6 @@ const Order = new mongoose.Schema({
   lokadId: { type: String },
   messageType: { type: Number },
   messageClass: { type: Number }
-
 })
 
-module.exports = mongoose.model('order', Order)
+export default mongoose.model('order', Order)

src/adapters/localdb/models/users.js

@@ -1,7 +1,10 @@
-const mongoose = require('mongoose')
-const bcrypt = require('bcryptjs')
-const config = require('../../../../config')
-const jwt = require('jsonwebtoken')
+// Global npm libraries
+import mongoose from 'mongoose'
+import bcrypt from 'bcryptjs'
+import jwt from 'jsonwebtoken'
+
+// Local libraries
+import config from '../../../../config/index.js'
 
 const User = new mongoose.Schema({
   type: { type: String, default: 'user' },
@@ -51,4 +54,4 @@ User.methods.generateToken = function generateToken () {
 }
 
 // export default mongoose.model('user', User)
-module.exports = mongoose.model('user', User)
+export default mongoose.model('user', User)

src/adapters/localdb/order-pagination.js

@@ -3,7 +3,7 @@
   orders from the datatabase.
 */
 
-const Order = require('./models/order')
+import Order from './models/order.js'
 
 // let _this
 
@@ -39,4 +39,4 @@ class OrderPagination {
   }
 }
 
-module.exports = OrderPagination
+export default OrderPagination

src/adapters/logapi.js

@@ -1,9 +1,14 @@
-const lineReader = require('line-reader')
-const fs = require('fs')
+import lineReader from 'line-reader'
+import fs from 'fs'
 
-const config = require('../../config')
+import config from '../../config/index.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
 
 let _this
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 class LogsApi {
   constructor () {
@@ -135,8 +140,10 @@ class LogsApi {
         if (!filename || typeof filename !== 'string') {
           throw new Error('filename must be a string')
         }
-        // Throw an error if the file does not exist.
 
+        console.log('readLines() filename: ', filename)
+
+        // Throw an error if the file does not exist.
         if (!_this.fs.existsSync(filename)) {
           throw new Error('file does not exist')
         }
@@ -167,4 +174,4 @@ class LogsApi {
   }
 }
 
-module.exports = LogsApi
+export default LogsApi

src/adapters/nodemailer.js

@@ -3,11 +3,10 @@
 */
 
 'use strict'
-const nodemailer = require('nodemailer')
+import nodemailer from 'nodemailer'
 
-const config = require('../../config')
-
-const { wlogger } = require('./wlogger')
+import config from '../../config/index.js'
+import wlogger from './wlogger.js'
 
 let _this
 
@@ -150,4 +149,4 @@ class NodeMailer {
   }
 }
 
-module.exports = NodeMailer
+export default NodeMailer

src/adapters/p2wdb-adapter.js

@@ -3,18 +3,20 @@
 */
 
 // Public npm libraries.
-const axios = require('axios')
-const { Write, Read } = require('p2wdb/index')
+import axios from 'axios'
+
+import P2WDB from 'p2wdb-esm'
 
 // Local libraries
-const config = require('../../config')
+import config from '../../config/index.js'
+const { Write, Read } = P2WDB
 
 class P2wdbAdapter {
   constructor (localConfig = {}) {
     // Dependency injection
-    this.bchjs = localConfig.bchjs
-    if (!this.bchjs) {
-      throw new Error('Must pass an instance of bch-js when instantiating p2wdb.js adapter.')
+    this.bchWallet = localConfig.bchWallet
+    if (!this.bchWallet) {
+      throw new Error('Must pass an instance of minimal-slp-wallet as bchWallet when instantiating p2wdb.js adapter.')
     }
 
     // Encapsulate dependencies
@@ -22,9 +24,14 @@ class P2wdbAdapter {
     this.config = config
     this.Write = Write
     this.Read = Read
+    this.bchjs = this.bchWallet.bchjs
 
     // Allow the localConfig to overwrite the config file values.
     this.p2wdbURL = localConfig.p2wdbURL || config.p2wdbUrl
+
+    // Bind the 'this' object to all functions
+    this.write = this.write.bind(this)
+    this.checkForSufficientFunds = this.checkForSufficientFunds.bind(this)
   }
 
   // Write some data to the P2WDB
@@ -51,6 +58,10 @@ class P2wdbAdapter {
   // settings.
   instantiateWriteLib (wif) {
     try {
+      if (!wif) {
+        throw new Error('WIF input required when calling instantiateWriteLib()')
+      }
+
       // Object used to configure the Write library.
       let configObj = {}
 
@@ -62,7 +73,8 @@ class P2wdbAdapter {
           wif,
           serverURL: this.p2wdbURL,
           restURL: this.bchjs.restURL,
-          apiToken: this.bchjs.apiToken
+          apiToken: this.bchjs.apiToken,
+          bchWallet: this.bchWallet
         }
       } else {
         // Use web 3 infrastructure.
@@ -72,7 +84,8 @@ class P2wdbAdapter {
           wif,
           serverURL: this.p2wdbURL,
           interface: 'consumer-api',
-          restURL: this.config.consumerUrl
+          restURL: this.config.consumerUrl,
+          bchWallet: this.bchWallet
         }
       }
 
@@ -104,4 +117,4 @@ class P2wdbAdapter {
   }
 }
 
-module.exports = P2wdbAdapter
+export default P2wdbAdapter

src/adapters/passport.js

@@ -2,7 +2,7 @@
   koa-passport is an authorization library used for different authentication schemes.
 */
 
-const passport = require('koa-passport')
+import passport from 'koa-passport'
 
 let _this
 class Passport {
@@ -32,4 +32,4 @@ class Passport {
   }
 }
 
-module.exports = Passport
+export default Passport

src/adapters/wallet.js

@@ -3,24 +3,41 @@
 */
 
 // Public npm libraries
-const BchWallet = require('minimal-slp-wallet/index')
+import BchWallet from 'minimal-slp-wallet'
+import BchTokenSweep from 'bch-token-sweep/index.js'
+
+import bitcoinJs from 'bitcoincashjs-lib'
 
 // Local libraries
-const JsonFiles = require('./json-files')
-const config = require('../../config')
+import JsonFiles from './json-files.js'
+
+import config from '../../config/index.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 const WALLET_FILE = `${__dirname.toString()}/../../wallet.json`
 // const PROOF_OF_BURN_QTY = 0.01
 // const P2WDB_TOKEN_ID =
 // '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0'
 
+const advancedConfig = {}
+
 class WalletAdapter {
   constructor (localConfig = {}) {
     // Encapsulate dependencies
     this.jsonFiles = new JsonFiles()
     this.WALLET_FILE = WALLET_FILE
-    this.BchWallet = BchWallet
     this.config = config
+    this.bitcoinJs = bitcoinJs
+    this.BchWallet = BchWallet
+    this.bchWallet = {} // Will be replaced when initialized.
+    // this.advancedConfig = localConfig.advancedConfig
+
+    // Bind the 'this' object
+    this.moveTokens = this.moveTokens.bind(this)
   }
 
   // Open the wallet file, or create one if the file doesn't exist.
@@ -36,7 +53,7 @@ class WalletAdapter {
         walletData = await this.jsonFiles.readJSON(this.WALLET_FILE)
       } catch (err) {
         // Create a new wallet file if one does not already exist.
-        console.warn('Wallet file not found. Creating new wallet.json file.')
+        console.log('Wallet file not found. Creating new wallet.json file.')
 
         // Create a new wallet.
         // No-Update flag creates wallet without making any network calls.
@@ -67,9 +84,15 @@ class WalletAdapter {
   // and pass the bch-js information to the minimal-slp-wallet library.
   async instanceWallet (walletData) {
     try {
-      // TODO: throw error if wallet data is not passed in.
+      // console.log(`instanceWallet() walletData: ${JSON.stringify(walletData, null, 2)}`)
 
-      const advancedConfig = {}
+      // TODO: throw error if wallet data is not passed in.
+      if (!walletData.mnemonic) {
+        throw new Error('Wallet data is not formatted correctly. Can not read mnemonic in wallet file!')
+      }
+
+      // const advancedConfig = {}
+      console.log(`Using FullStack.cash: ${this.config.useFullStackCash}`)
       if (this.config.useFullStackCash) {
         advancedConfig.interface = 'rest-api'
         advancedConfig.restURL = this.config.apiServer
@@ -84,6 +107,9 @@ class WalletAdapter {
 
       // Wait for wallet to initialize.
       await this.bchWallet.walletInfoPromise
+      await this.bchWallet.initialize()
+      console.log(`BCH wallet initialized. Wallet address: ${this.bchWallet.walletInfo.cashAddress}`)
+      // console.log(`this.bchWallet.walletInfo: ${JSON.stringify(this.bchWallet.walletInfo, null, 2)}`)
 
       return this.bchWallet
     } catch (err) {
@@ -122,9 +148,12 @@ class WalletAdapter {
   // and the index of the HD wallet that the key pair was generated from.
   // TODO: Allow input integer. If input is used, use that as the index. If no
   // input is provided, then call incrementNextAddress().
-  async getKeyPair () {
+  async getKeyPair (hdIndex = 0) {
     try {
-      const hdIndex = await this.incrementNextAddress()
+      if (!hdIndex) {
+        // Increment the HD index and generate a new key pair.
+        hdIndex = await this.incrementNextAddress()
+      }
 
       const mnemonic = this.bchWallet.walletInfo.mnemonic
 
@@ -178,10 +207,10 @@ class WalletAdapter {
     }
   }
 
-  // Generate a partial transcation to *take* a 'sell' order.
-  async generatePartialTx (orderInfo) {
+  // Generate a partial transcation to *take* a 'sell' offer.
+  async generatePartialTx (offerInfo, utxoInfo) {
     try {
-      console.log(`orderInfo: ${JSON.stringify(orderInfo, null, 2)}`)
+      console.log(`offerInfo: ${JSON.stringify(offerInfo, null, 2)}`)
 
       const bchjs = this.bchWallet.bchjs
 
@@ -190,32 +219,47 @@ class WalletAdapter {
 
       // Get a payment UTXO.
       // TODO: Create a segregated UTXO.
-      const bchUtxos = this.bchWallet.utxos.utxoStore.bchUtxos
-      const paymentUtxo = await bchjs.Utxo.findBiggestUtxo(bchUtxos)
-      console.log('paymentUtxo: ', paymentUtxo)
+      // const bchUtxos = this.bchWallet.utxos.utxoStore.bchUtxos
+      // const paymentUtxo = await bchjs.Utxo.findBiggestUtxo(bchUtxos)
+      // console.log('paymentUtxo: ', paymentUtxo)
 
       // Get token info on the offered UTXO
-      const txData = await this.bchWallet.getTxData([orderInfo.utxoTxid])
+      const txData = await this.bchWallet.getTxData([offerInfo.utxoTxid])
       console.log(`txData: ${JSON.stringify(txData, null, 2)}`)
 
       // Construct the UTXO being offered for sale.
       const offeredUtxo = {
-        txid: orderInfo.utxoTxid,
-        vout: orderInfo.utxoVout,
-        tokenId: orderInfo.tokenId,
+        txid: offerInfo.utxoTxid,
+        vout: offerInfo.utxoVout,
+        tokenId: offerInfo.tokenId,
         decimals: txData[0].tokenDecimals,
-        tokenQty: orderInfo.numTokens.toString()
+        tokenQty: offerInfo.numTokens.toString()
       }
       console.log(`offeredUtxo: ${JSON.stringify(offeredUtxo, null, 2)}`)
 
       // Build First part of the collaborative Tx a.k.a. Alice
       // Generate the OP_RETURN code.
-      const slpSendObj = bchjs.SLP.TokenType1.generateSendOpReturn(
-        [offeredUtxo],
-        orderInfo.numTokens.toString()
-      )
+      let slpSendObj
+      if (offerInfo.tokenType === 65) {
+        // Type 65 NFT
+
+        slpSendObj = bchjs.SLP.NFT1.generateNFTChildSendOpReturn(
+          [offeredUtxo],
+          offerInfo.numTokens.toString()
+        )
+        console.log(`slpOutputs: ${slpSendObj.outputs}`)
+      } else if (offerInfo.tokenType === 1) {
+        // Type 1 fungible token
+
+        slpSendObj = bchjs.SLP.TokenType1.generateSendOpReturn(
+          [offeredUtxo],
+          offerInfo.numTokens.toString()
+        )
+        console.log(`slpOutputs: ${slpSendObj.outputs}`)
+      } else {
+        throw new Error(`Unknown token type of ${offerInfo.tokenType}. Can not create Counter Offer.`)
+      }
       const slpData = slpSendObj.script
-      console.log(`slpOutputs: ${slpSendObj.outputs}`)
 
       // Currently this app only supports a single SLP token UTXO for exact
       // token quantities (no token change). e.g. 1 UTXO representing the
@@ -226,32 +270,34 @@ class WalletAdapter {
       }
 
       // Calculate sats needed to pay the offer.
-      const satsNeeded = orderInfo.numTokens * parseInt(orderInfo.rateInSats)
+      const satsNeeded = offerInfo.numTokens * parseInt(offerInfo.rateInBaseUnit)
+      if (isNaN(satsNeeded)) throw new Error('Can not calculate needed sats')
 
       // Calculate miner fees.
       // Get byte count (minimum 2 inputs, 3 outputs)
-      const opReturnBufLength = slpData.byteLength + 32 // add padding
-      const byteCount =
-      bchjs.BitcoinCash.getByteCount({ P2PKH: 2 }, { P2PKH: 4 }) +
-        opReturnBufLength
-      const totalSatsNeeded = byteCount + satsNeeded
+      // const opReturnBufLength = slpData.byteLength + 32 // add padding
+      // const byteCount =
+      // bchjs.BitcoinCash.getByteCount({ P2PKH: 2 }, { P2PKH: 4 }) +
+      //   opReturnBufLength
+      // const totalSatsNeeded = byteCount + satsNeeded
       // console.log(`satoshis needed: ${satsNeeded}`)
 
       // One last check to ensure the app wallet has enough BCH to complete
       // the trade.
-      if (totalSatsNeeded > paymentUtxo.value) {
-        console.log(`Selected payment UTXO is not big enough. Sats needed: ${totalSatsNeeded}, UTXO value: ${paymentUtxo.value}`)
-      }
+      // if (totalSatsNeeded > paymentUtxo.value) {
+      //   console.log(`Selected payment UTXO is not big enough. Sats needed: ${totalSatsNeeded}, UTXO value: ${paymentUtxo.value}`)
+      // }
 
-      // add UTXO for sell(STILL CANNOT SPEND - not signed yet)
-      transactionBuilder.addInput(orderInfo.utxoTxid, orderInfo.utxoVout)
+      // add UTXO for sale (STILL CANNOT SPEND - not signed yet)
+      transactionBuilder.addInput(offerInfo.utxoTxid, offerInfo.utxoVout)
 
       // add payment UTXO
-      transactionBuilder.addInput(paymentUtxo.tx_hash, paymentUtxo.tx_pos)
+      // transactionBuilder.addInput(paymentUtxo.tx_hash, paymentUtxo.tx_pos)
+      transactionBuilder.addInput(utxoInfo.txid, utxoInfo.vout)
 
-      const originalAmount = paymentUtxo.value
+      // const originalAmount = paymentUtxo.value
       const dust = 546
-      const remainder = originalAmount - satsNeeded - dust // exchange fee + token UTXO dust
+      // const remainder = originalAmount - satsNeeded - dust // exchange fee + token UTXO dust
 
       // Add the SLP OP_RETURN data as the first output.
       transactionBuilder.addOutput(slpData, 0)
@@ -266,20 +312,18 @@ class WalletAdapter {
       )
 
       // Get seller address
-      // TODO: Seller should explicitly define the address to send to in the
-      // orderInfo object. Right now it retrieves the address from the UTXO
-      // for sale, which is not ideal.
-      const sellerAddr = txData[0].vout[1].scriptPubKey.addresses[0]
+      const sellerAddr = offerInfo.makerAddr
 
       // Send payment to the offer side
       transactionBuilder.addOutput(sellerAddr, satsNeeded)
 
       // Send the BCH change back to the buyer
-      if (remainder > 550) {
-        transactionBuilder.addOutput(buyerAddr, remainder)
-      }
+      // if (remainder > 550) {
+      //   transactionBuilder.addOutput(buyerAddr, remainder)
+      // }
 
-      const buyerECPair = bchjs.ECPair.fromWIF(this.bchWallet.walletInfo.privateKey)
+      // const buyerECPair = bchjs.ECPair.fromWIF(this.bchWallet.walletInfo.privateKey)
+      const buyerECPair = bchjs.ECPair.fromWIF(utxoInfo.wif)
 
       // Sign the buyers input UTXO for spending.
       transactionBuilder.sign(
@@ -287,13 +331,13 @@ class WalletAdapter {
         buyerECPair,
         null,
         transactionBuilder.hashTypes.SIGHASH_ALL,
-        originalAmount
+        utxoInfo.sats
       )
 
       const tx = transactionBuilder.transaction.buildIncomplete()
 
       const hex = tx.toHex()
-      console.log('hex: ', hex)
+      // console.log('hex: ', hex)
 
       return hex
     } catch (err) {
@@ -303,6 +347,216 @@ class WalletAdapter {
 
   // return true
   }
+
+  // Move tokens to an address controlled by the HD wallet, to generate a
+  // segregated UTXO.
+  async moveTokens (inObj = {}) {
+    try {
+      const { tokenId, qty } = inObj
+
+      const keyPair = await this.getKeyPair()
+      console.log('keyPair: ', keyPair)
+
+      const receiver = {
+        address: keyPair.cashAddress,
+        tokenId,
+        qty
+      }
+
+      // Update the UTXO store of the wallet.
+      await this.bchWallet.initialize()
+
+      // Get the token type of the token being moved.
+      // Combine Fungible and NFT token UTXOs.
+      let tokenUtxos = this.bchWallet.utxos.utxoStore.slpUtxos.type1.tokens.concat(
+        this.bchWallet.utxos.utxoStore.slpUtxos.nft.tokens)
+      // Get token UTXOs that match the token in the order.
+      tokenUtxos = tokenUtxos.filter(
+        x => x.tokenId === tokenId
+      )
+
+      const txid = await this.bchWallet.sendTokens(receiver, 3)
+
+      const utxoInfo = {
+        txid,
+        vout: 1,
+        hdIndex: keyPair.hdIndex,
+        tokenType: tokenUtxos[0].tokenType
+      }
+
+      return utxoInfo
+    } catch (err) {
+      console.error('Error in wallet.js/moveTokens()')
+      throw err
+    }
+  }
+
+  // Move a quanity of BCH to an address controlled by the HD wallet, to
+  // generate a segregated UTXO.
+  async moveBch (amountSat) {
+    try {
+      const keyPair = await this.getKeyPair()
+      console.log('keyPair: ', keyPair)
+
+      const receivers = [{
+        address: keyPair.cashAddress,
+        amountSat
+      }]
+      console.log(`receivers: ${JSON.stringify(receivers, null, 2)}`)
+
+      // Update the UTXO store of the wallet.
+      await this.bchWallet.getUtxos()
+
+      const txid = await this.bchWallet.send(receivers)
+
+      const utxoInfo = {
+        txid,
+        vout: 0,
+        hdIndex: keyPair.hdIndex,
+        wif: keyPair.wif
+      }
+
+      return utxoInfo
+    } catch (err) {
+      console.error('Error in wallet.js/moveBch()')
+      throw err
+    }
+  }
+
+  // Deserialize a hex string representing a partial TX. Returns an object
+  // representing the transaction.
+  async deseralizeTx (txHex) {
+    try {
+      // Ensure the URL points at FullStack.cash, since the web 3 infra does not
+      // yet support this call.
+      const oldUrl = this.bchWallet.bchjs.RawTransactions.restURL
+      this.bchWallet.bchjs.RawTransactions.restURL = 'https://api.fullstack.cash/v5/'
+
+      // Use a full node to deserialize the transaction.
+      const txObj2 = await this.bchWallet.bchjs.RawTransactions.decodeRawTransaction(txHex)
+      // console.log(`txObj2: ${JSON.stringify(txObj2, null, 2)}`)
+
+      // Restore the old URL.
+      this.bchWallet.bchjs.RawTransactions.restURL = oldUrl
+
+      return txObj2
+    } catch (err) {
+      console.error('Error in wallet.js/deserializePartialTx()')
+      throw err
+    }
+  }
+
+  // Complete the partially signed transaction by signing the first input,
+  // then broadcasting the transaction to the network.
+  async completeTx (hex, hdIndex) {
+    try {
+      // console.log('hex: ', hex)
+
+      const bchjs = this.bchWallet.bchjs
+
+      // instance of transaction builder
+      // const transactionBuilder = new bchjs.TransactionBuilder()
+
+      // Convert the hex string version of the transaction into a Buffer.
+      // const paymentBuffer = Buffer.from(hex, 'hex')
+
+      // Generate a Transaction object from the transaction binary data.
+      // const csTransaction = this.bitcoinJs.Transaction.fromBuffer(paymentBuffer)
+      const csTransaction = this.bitcoinJs.Transaction.fromHex(hex)
+      // console.log(`payment tx: ${JSON.stringify(csTransaction, null, 2)}`)
+
+      // Instantiate the Transaction Builder.
+      const csTransactionBuilder = this.bitcoinJs.TransactionBuilder.fromTransaction(
+        csTransaction,
+        'mainnet'
+      )
+      // const csTransactionBuilder = bchjs.TransactionBuilder.fromTransaction(
+      //   csTransaction,
+      //   'mainnet'
+      // )
+
+      // Get the keypair for the address used in the Order
+      const keyPair = await this.getKeyPair(hdIndex)
+      console.log(`maker keyPair: ${JSON.stringify(keyPair, null, 2)}`)
+      const makerECPair = bchjs.ECPair.fromWIF(keyPair.wif)
+
+      // Assumption: segregated UTXO has a value of 546 sats. It might be better
+      // to explicitly look this data up via the blockchain.
+      const dust = 546
+
+      // Coutnersign the Maker's input, representing the tokens for sale.
+      csTransactionBuilder.sign(
+        0,
+        makerECPair,
+        null,
+        this.bitcoinJs.Transaction.SIGHASH_ALL,
+        // csTransactionBuilder.hashTypes.SIGHASH_ALL,
+        dust
+      )
+
+      // build tx
+      const csTx = csTransactionBuilder.build()
+
+      // output rawhex
+      const csTxHex = csTx.toHex()
+      console.log(`Fully signed Tx hex: ${csTxHex}`)
+
+      // Debug: Display the fully signed TX
+      const txObj = await this.deseralizeTx(csTxHex)
+      console.log(`Final tx: ${JSON.stringify(txObj, null, 2)}`)
+
+      // return csTxHex
+
+      // Broadcast transaction to the network
+      const txid = await this.bchWallet.ar.sendTx(csTxHex)
+
+      return txid
+    } catch (err) {
+      console.error('Error in wallet.js/completeTx()')
+      throw err
+    }
+  }
+
+  // Given an Order database object, this function sends the tokens from the
+  // HD index where they are stored, back to the root address of the wallet.
+  async reclaimTokens (orderData) {
+    try {
+      // Get the key pair from the Order.
+      const keyPair = await this.getKeyPair(orderData.hdIndex)
+      console.log('keyPair: ', keyPair)
+
+      // Instantiate the wallet using the private key of the Order.
+      // const tempWallet = new this.BchWallet(keyPair.wif, advancedConfig)
+      // await tempWallet.initialize()
+
+      // Send the tokens from the Order to the root address.
+      // const receiver = {
+      //   address: this.bchWallet.walletInfo.address,
+      //   tokenId: orderData.tokenId,
+      //   qty: orderData.numTokens
+      // }
+      // console.log('receiver: ', receiver)
+      //
+      // const txid = await tempWallet.sendTokens(receiver)
+
+      // Sweep the tokens to the root address.
+      const sweeper = new BchTokenSweep(
+        keyPair.wif,
+        this.bchWallet.walletInfo.privateKey,
+        this.bchWallet,
+        550,
+        this.bchWallet.walletInfo.cashAddress
+      )
+      await sweeper.populateObjectFromNetwork()
+      const hex = await sweeper.sweepTo(this.bchWallet.walletInfo.cashAddress)
+      const txid = await this.bchWallet.ar.sendTx(hex)
+
+      return txid
+    } catch (err) {
+      console.error('Error in wallet.js/reclaimTokens()')
+      throw err
+    }
+  }
 }
 
-module.exports = WalletAdapter
+export default WalletAdapter

src/adapters/webhook.js

@@ -2,8 +2,9 @@
   The (Clean Architecture) Adapter for manageing a webhook connection to P2WDB.
 */
 
-const config = require('../../config')
-const axios = require('axios')
+import config from '../../config/index.js'
+
+import axios from 'axios'
 
 let _this
 
@@ -59,6 +60,46 @@ class WebHook {
       throw err
     }
   }
+
+  // Returns a promise that will not resolve until a webhook has been successfully
+  // created with the P2WDB.
+  // Dev Note: This was created because establishing a webhook between bch-dex
+  // and the P2WDB at startup is critical. If it's not established, then bch-dex
+  // can not 'see' new Offers and Counter Offers.
+  async waitUntilSuccess (url) {
+    try {
+      let success = false
+
+      do {
+        try {
+          // Delete an old webhook if it exists.
+          await this.deleteWebhook(this.config.webhookTarget)
+        } catch (err) {
+          /* exit quietly */
+          // console.log('err deleting webhook: ', err)
+        }
+
+        try {
+          await this.createWebhook(this.config.webhookTarget)
+          console.log('Webhook created')
+          success = true
+        } catch (err) {
+          const now = new Date()
+          console.log(`${now.toLocaleString()}: Error trying to create webhook with P2WDB. Trying again...`)
+          await sleep(2000)
+        }
+      } while (!success)
+
+      return true
+    } catch (err) {
+      console.error('Error in webhook.js/waitUntilSuccess()')
+      throw err
+    }
+  }
 }
 
-module.exports = WebHook
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+export default WebHook

src/adapters/wlogger.js

@@ -6,10 +6,17 @@
 
 'use strict'
 
-const winston = require('winston')
-require('winston-daily-rotate-file')
+// Global npm libraries
+import winston from 'winston'
+import 'winston-daily-rotate-file'
 
-const config = require('../../config')
+// Local libraries
+import config from '../../config/index.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 class Wlogger {
   constructor (localConfig = {}) {
@@ -49,7 +56,8 @@ class Wlogger {
   }
 
   notifyRotation (oldFilename, newFilename) {
-    this.wlogger.info('Rotating log files')
+    // this.wlogger.info('Rotating log files')
+    console.log('Rotating log files')
   }
 
   outputToConsole () {
@@ -69,4 +77,5 @@ logger.outputToConsole()
 
 const wlogger = logger.wlogger
 
-module.exports = { wlogger, Wlogger }
+export { wlogger as default, Wlogger }
+// export default wlogger

src/controllers/index.js

@@ -7,32 +7,37 @@
 // Public npm libraries.
 
 // Load the Clean Architecture Adapters library
-const Adapters = require('../adapters')
+import Adapters from '../adapters/index.js'
 
 // Load the JSON RPC Controller.
-const JSONRPC = require('./json-rpc')
+import JSONRPC from './json-rpc/index.js'
 
 // Load the Clean Architecture Use Case libraries.
-const UseCases = require('../use-cases')
+import UseCases from '../use-cases/index.js'
+
 // const useCases = new UseCases({ adapters })
 
 // Load the REST API Controllers.
-const RESTControllers = require('./rest-api')
+import RESTControllers from './rest-api/index.js'
+
+import TimerControllers from './timer-controllers.js'
 
 class Controllers {
   constructor (localConfig = {}) {
     this.adapters = new Adapters()
     this.useCases = new UseCases({ adapters: this.adapters })
+
+    this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
   }
 
-  async attachControllers (app) {
-    // Wait for any startup processes to complete for the Adapters libraries.
+  // Spin up any adapter libraries that have async startup needs.
+  async initAdapters () {
     await this.adapters.start()
+  }
 
-    // Attach the REST controllers to the Koa app.
-    // this.attachRESTControllers(app)
-
-    // this.attachRPCControllers()
+  // Run any Use Cases to startup the app.
+  async initUseCases () {
+    await this.useCases.start()
   }
 
   // Top-level function for this library.
@@ -47,6 +52,12 @@ class Controllers {
     restControllers.attachRESTControllers(app)
   }
 
+  // Attach any other controllers other than REST API controllers.
+  async attachControllers (app) {
+
+    // this.attachRPCControllers()
+  }
+
   // Add the JSON RPC router to the ipfs-coord adapter.
   attachRPCControllers () {
     const jsonRpcController = new JSONRPC({
@@ -61,4 +72,4 @@ class Controllers {
   }
 }
 
-module.exports = Controllers
+export default Controllers

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

@@ -6,10 +6,10 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
-const config = require('../../../../config')
+import config from '../../../../config/index.js'
 
 class AboutRPC {
   constructor (localConfig) {
@@ -48,4 +48,4 @@ class AboutRPC {
   }
 }
 
-module.exports = AboutRPC
+export default AboutRPC

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

@@ -3,13 +3,14 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
 // const AuthLib = require('../../lib/auth')
 // const UserLib = require('../../../use-cases/user')
-const { wlogger } = require('../../../adapters/wlogger')
-const RateLimit = require('../rate-limit')
+import wlogger from '../../../adapters/wlogger.js'
+
+import RateLimit from '../rate-limit.js'
 
 class AuthRPC {
   constructor (localConfig = {}) {
@@ -173,4 +174,4 @@ class AuthRPC {
   }
 }
 
-module.exports = AuthRPC
+export default AuthRPC

src/controllers/json-rpc/index.js

@@ -3,13 +3,14 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local support libraries
-const { wlogger } = require('../../adapters/wlogger')
-const UserController = require('./users')
-const AuthController = require('./auth')
-const AboutController = require('./about')
+import wlogger from '../../adapters/wlogger.js'
+
+import UserController from './users/index.js'
+import AuthController from './auth/index.js'
+import AboutController from './about/index.js'
 
 let _this
 
@@ -190,4 +191,4 @@ class JSONRPC {
   }
 }
 
-module.exports = JSONRPC
+export default JSONRPC

src/controllers/json-rpc/rate-limit.js

@@ -4,7 +4,7 @@
 /* eslint no-useless-catch: 0 */
 
 // Local libraries
-const RateLimitLib = require('koa2-ratelimit').RateLimit
+import { RateLimit as RateLimitLib } from 'koa2-ratelimit'
 
 class RateLimit {
   constructor (options) {
@@ -80,4 +80,4 @@ class RateLimit {
   }
 }
 
-module.exports = RateLimit
+export default RateLimit

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

@@ -3,12 +3,13 @@
 */
 
 // Public npm libraries
-const jsonrpc = require('jsonrpc-lite')
+import jsonrpc from 'jsonrpc-lite'
 
 // Local libraries
 // const UserLib = require('../../../use-cases/user')
-const Validators = require('../validators')
-const RateLimit = require('../rate-limit')
+import Validators from '../validators.js'
+
+import RateLimit from '../rate-limit.js'
 
 class UserRPC {
   constructor (localConfig = {}) {
@@ -533,4 +534,4 @@ class UserRPC {
   // TODO create deleteUser()
 }
 
-module.exports = UserRPC
+export default UserRPC

src/controllers/json-rpc/validators.js

@@ -4,10 +4,11 @@
 /* eslint no-useless-catch: 0 */
 
 // Public npm libraries
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const UserModel = require('../../adapters/localdb/models/users')
 
 class Validators {
@@ -93,4 +94,4 @@ class Validators {
   }
 }
 
-module.exports = Validators
+export default Validators

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

@@ -1,4 +1,4 @@
-const Passport = require('../../../adapters/passport')
+import Passport from '../../../adapters/passport.js'
 const passport = new Passport()
 
 let _this
@@ -96,4 +96,4 @@ class AuthRESTController {
   }
 }
 
-module.exports = AuthRESTController
+export default AuthRESTController

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

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const AuthRESTController = require('./controller')
+import AuthRESTController from './controller.js'
 
 class AuthRouter {
   constructor (localConfig = {}) {
@@ -48,4 +48,4 @@ class AuthRouter {
   }
 }
 
-module.exports = AuthRouter
+export default AuthRouter

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

@@ -3,9 +3,9 @@
 */
 
 /* eslint-disable no-useless-escape */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
+import ContactLib from '../../../adapters/contact.js'
 
-const ContactLib = require('../../../adapters/contact')
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
 const contactLib = new ContactLib()
 
 let _this
@@ -74,4 +74,4 @@ class ContactController {
     }
   }
 }
-module.exports = ContactController
+export default ContactController

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

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const ContactRESTControllerLib = require('./controller')
+import ContactRESTControllerLib from './controller.js'
 
 class ContactRouter {
   constructor (localConfig = {}) {
@@ -53,4 +53,4 @@ class ContactRouter {
   }
 }
 
-module.exports = ContactRouter
+export default ContactRouter

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

@@ -64,4 +64,4 @@ class EntryRESTControllerLib {
   }
 }
 
-module.exports = EntryRESTControllerLib
+export default EntryRESTControllerLib

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

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const EntryRESTControllerLib = require('./controller')
+import EntryRESTControllerLib from './controller.js'
 
 let _this
 
@@ -57,4 +57,4 @@ class UserRouter {
   }
 }
 
-module.exports = UserRouter
+export default UserRouter

src/controllers/rest-api/index.js

@@ -6,14 +6,15 @@
 
 // Public npm libraries.
 
-// Load the REST API Controllers.
-const AuthRESTController = require('./auth')
-const UserRouter = require('./users')
-const ContactRESTController = require('./contact')
-const LogsRESTController = require('./logs')
-const EntryRouter = require('./entry')
-const OfferRouter = require('./offer')
-const OrderRouter = require('./order')
+// Local libraries
+import AuthRESTController from './auth/index.js'
+import UserRouter from './users/index.js'
+import ContactRESTController from './contact/index.js'
+import LogsRESTController from './logs/index.js'
+import EntryRouter from './entry/index.js'
+import OfferRouter from './offer/index.js'
+import OrderRouter from './order/index.js'
+import P2WDBRouter from './p2wdb/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -65,7 +66,10 @@ class RESTControllers {
 
     const orderRouter = new OrderRouter(dependencies)
     orderRouter.attach(app)
+
+    const p2wdbRouter = new P2WDBRouter(dependencies)
+    p2wdbRouter.attach(app)
   }
 }
 
-module.exports = RESTControllers
+export default RESTControllers

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

@@ -1,4 +1,4 @@
-const LogsApiLib = require('../../../adapters/logapi')
+import LogsApiLib from '../../../adapters/logapi.js'
 const logsApiLib = new LogsApiLib()
 let _this
 
@@ -62,4 +62,4 @@ class LogsApi {
   }
 }
 
-module.exports = LogsApi
+export default LogsApi

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

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const LogsRESTControllerLib = require('./controller')
+import LogsRESTControllerLib from './controller.js'
 
 class LogsRouter {
   constructor (localConfig = {}) {
@@ -52,4 +52,4 @@ class LogsRouter {
   }
 }
 
-module.exports = LogsRouter
+export default LogsRouter

src/controllers/rest-api/middleware/error.js

@@ -1,4 +1,4 @@
-module.exports = function errorMiddleware () {
+export default function errorMiddleware () {
   return async (ctx, next) => {
     try {
       await next()
@@ -8,4 +8,4 @@ module.exports = function errorMiddleware () {
       ctx.app.emit('error', err, ctx)
     }
   }
-}
+};

src/controllers/rest-api/middleware/validators.js

@@ -1,11 +1,24 @@
 /*
   REST API validator middleware.
+
+  These are a series of functions that ensure the user making a REST API
+  matches a user in the database (or not). In can do fine-grain user control
+  such as telling the difference between an admin, a normal user, and an
+  anonymous user.
+
+  This middleware is used to gatekeep access to different REST API resources.
+
+  CT 9/17/22:
+  This library was lightly refactored to make it work with the new unit tests.
+  This not and the commented code below can be deleted once it is verified that
+  this refactor did not result in any breaking changes.
 */
 
-const User = require('../../../adapters/localdb/models/users')
-const config = require('../../../../config')
-const jwt = require('jsonwebtoken')
-const { wlogger } = require('../../../adapters/wlogger')
+import User from '../../../adapters/localdb/models/users.js'
+
+import config from '../../../../config/index.js'
+import jwt from 'jsonwebtoken'
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -20,12 +33,10 @@ class Validators {
 
   async ensureUser (ctx, next) {
     try {
-      // console.log(`getToken: ${typeof (getToken)}`)
       const token = _this.getToken(ctx)
 
       if (!token) {
-        // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       let decoded = null
@@ -34,20 +45,23 @@ class Validators {
         // console.log(`config: ${JSON.stringify(config, null, 2)}`)
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
-        // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
+
       if (!ctx.state.user) {
-        // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // console.log('Err: Could not find user.')
+        throw new Error('Could not find user')
       }
 
       // return next()
       return true
     } catch (error) {
-      ctx.throw(401)
+      // console.log('Ensure user error: ', error)
+      // console.log('ctx: ', ctx)
+      ctx.status = 401
+      ctx.throw(401, error.message)
     }
   }
 
@@ -60,7 +74,8 @@ class Validators {
 
       if (!token) {
         // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       let decoded = null
@@ -70,22 +85,26 @@ class Validators {
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
         // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
       if (!ctx.state.user) {
         // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not find user')
       }
 
       if (ctx.state.user.type !== 'admin') {
-        ctx.throw(401, 'not admin')
+        // ctx.throw(401, 'not admin')
+        throw new Error('User is not an admin')
       }
 
       // return next()
       return true
     } catch (error) {
+      ctx.status = 401
       ctx.throw(401, error.message)
     }
   }
@@ -101,7 +120,8 @@ class Validators {
 
       if (!token) {
         // console.log(`Err: Token not provided.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Token could not be retrieved from header')
       }
 
       // The user ID targeted in this API call.
@@ -114,14 +134,16 @@ class Validators {
         // console.log(`config: ${JSON.stringify(config, null, 2)}`)
         decoded = _this.jwt.verify(token, config.token)
       } catch (err) {
-        // console.log(`Err: Token could not be decoded: ${err}`)
-        ctx.throw(401)
+        console.log(`Err: Token could not be decoded: ${err}`)
+        // ctx.throw(401)
+        throw new Error('Could not verify JWT')
       }
 
       ctx.state.user = await _this.User.findById(decoded.id, '-password')
       if (!ctx.state.user) {
         // console.log(`Err: Could not find user.`)
-        ctx.throw(401)
+        // ctx.throw(401)
+        throw new Error('Could not find user')
       }
       // console.log('ctx.state.user: ', ctx.state.user)
 
@@ -135,7 +157,8 @@ class Validators {
 
         // If they don't match, then the calling user better be an admin.
         if (ctx.state.user.type !== 'admin') {
-          ctx.throw(401, 'not admin')
+          // ctx.throw(401, 'not admin')
+          throw new Error('User is not an admin')
         } else {
           wlogger.verbose("It's ok. The user is an admin.")
         }
@@ -144,6 +167,8 @@ class Validators {
       // return next()
       return true
     } catch (error) {
+      // console.log('Error in ensureTargetUserOrAdmin(): ', error)
+      ctx.status = 401
       ctx.throw(401, error.message)
     }
   }
@@ -166,4 +191,4 @@ class Validators {
   }
 }
 
-module.exports = Validators
+export default Validators

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

@@ -2,7 +2,7 @@
   REST API Controller library for the /offer route
 */
 
-// const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -32,13 +32,15 @@ class OfferRESTControllerLib {
   // No api-doc documentation because this wont be a public endpoint
   async createOffer (ctx) {
     try {
-      // console.log('body: ', ctx.request.body)
+      console.log('body: ', ctx.request.body)
 
-      const offerObj = ctx.request.body.offer
+      const offerObj = ctx.request.body
 
-      const hash = await _this.useCases.offer.createOffer(offerObj)
+      await _this.useCases.offer.createOffer(offerObj)
 
-      ctx.body = { hash }
+      ctx.body = {
+        success: true
+      }
     } catch (err) {
       // console.log(`err.message: ${err.message}`)
       // console.log('err: ', err)
@@ -47,10 +49,71 @@ class OfferRESTControllerLib {
     }
   }
 
+  // curl -X GET http://localhost:5700/offer/list/all/0
+  async listOffers (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listOffers(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in listOffers REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // curl -X GET http://localhost:5700/offer/list/nft/0
+  async listNftOffers (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listNftOffers(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in listNftOffers REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // curl -X GET http://localhost:5700/offer/list/fungible/0
+  async listFungibleOffers (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listFungibleOffers(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in Fungible REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // Currently only supports 'sell' offers, and will only buy the 'numTokens'
+  // listed in the offer.
+  async takeOffer (ctx) {
+    try {
+      console.log('REST API controller, body: ', ctx.request.body)
+
+      const offerCid = ctx.request.body.offerCid
+
+      const hash = await _this.useCases.offer.takeOffer(offerCid)
+
+      ctx.body = { hash }
+    } catch (err) {
+      wlogger.error('Error in takeOffer() REST API handler.')
+      _this.handleError(ctx, err)
+    }
+  }
+
   // DRY error handler
   handleError (ctx, err) {
-    console.log('err', err)
-
+    console.log('err', err.message)
     // If an HTTP status is specified by the buisiness logic, use that.
     if (err.status) {
       if (err.message) {
@@ -65,4 +128,4 @@ class OfferRESTControllerLib {
   }
 }
 
-module.exports = OfferRESTControllerLib
+export default OfferRESTControllerLib

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

@@ -3,10 +3,10 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const OfferRESTControllerLib = require('./controller')
+import OfferRESTControllerLib from './controller.js'
 
 let _this
 
@@ -50,6 +50,10 @@ class OfferRouter {
 
     // Define the routes and attach the controller.
     this.router.post('/', _this.offerRESTController.createOffer)
+    this.router.post('/take', _this.offerRESTController.takeOffer)
+    this.router.get('/list/all/:page', _this.offerRESTController.listOffers)
+    this.router.get('/list/nft/:page', _this.offerRESTController.listNftOffers)
+    this.router.get('/list/fungible/:page', _this.offerRESTController.listFungibleOffers)
 
     // Attach the Controller routes to the Koa app.
     app.use(_this.router.routes())
@@ -57,4 +61,4 @@ class OfferRouter {
   }
 }
 
-module.exports = OfferRouter
+export default OfferRouter

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

@@ -1,5 +1,5 @@
 /*
-  REST API Controller library for the /offer route
+  REST API Controller library for the /order route
 */
 
 // const { wlogger } = require('../../../adapters/wlogger')
@@ -32,15 +32,14 @@ class OrderRESTControllerLib {
   // No api-doc documentation because this wont be a public endpoint
   async createOrder (ctx) {
     try {
-      console.log('body: ', ctx.request.body)
+      // console.log('body: ', ctx.request.body)
 
-      const orderObj = ctx.request.body
+      const orderObj = ctx.request.body.order
+      console.log('orderObj: ', orderObj)
 
-      await _this.useCases.order.createOrder(orderObj)
+      const hash = await _this.useCases.order.createOrder(orderObj)
 
-      ctx.body = {
-        success: true
-      }
+      ctx.body = { hash }
     } catch (err) {
       // console.log(`err.message: ${err.message}`)
       // console.log('err: ', err)
@@ -49,42 +48,45 @@ class OrderRESTControllerLib {
     }
   }
 
-  // curl -X GET http://localhost:5700/order/list
+  // curl -X GET http://localhost:5700/order/list/all/0
   async listOrders (ctx) {
     try {
-      const orders = await _this.useCases.order.listOrders()
+      let page = ctx.params.page
+      if (!page) page = 0
 
-      ctx.body = orders
+      const offers = await _this.useCases.order.listOrders(page)
+
+      ctx.body = offers
     } catch (err) {
-      console.log('Error in listOrders REST API handler.')
+      console.log('Error in listOrders REST API handler: ', err)
       _this.handleError(ctx, err)
     }
   }
 
-  // Currently only supports 'sell' orders, and will only buy the 'numTokens'
-  // listed in the order.
-  async takeOrder (ctx) {
+  // Delete an existing order by returning the token to the root address of
+  // the DEX wallet.
+  async deleteOrder (ctx) {
     try {
-      console.log('body: ', ctx.request.body)
+      // console.log('body: ', ctx.request.body)
 
-      const orderCid = ctx.request.body.orderCid
+      const p2wdbHash = ctx.request.body.p2wdbHash
+      // console.log('p2wdbHash: ', p2wdbHash)
 
-      // Find the Order.
-      // const orderEntity = await _this.useCases.order.findOrder(orderId)
+      const txid = await _this.useCases.order.deleteOrder(p2wdbHash)
 
-      // 'Take' the Order.
-      const hash = await _this.useCases.order.takeOrder(orderCid)
-
-      ctx.body = { hash }
+      ctx.body = { txid }
     } catch (err) {
-      console.log('Error in takeOrder REST API handler.')
+      // console.log(`err.message: ${err.message}`)
+      // console.log('err: ', err)
+      // ctx.throw(422, err.message)
       _this.handleError(ctx, err)
     }
   }
 
   // DRY error handler
   handleError (ctx, err) {
-    console.log('err', err.message)
+    console.log('err', err)
+
     // If an HTTP status is specified by the buisiness logic, use that.
     if (err.status) {
       if (err.message) {
@@ -99,4 +101,4 @@ class OrderRESTControllerLib {
   }
 }
 
-module.exports = OrderRESTControllerLib
+export default OrderRESTControllerLib

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

@@ -1,12 +1,12 @@
 /*
-  REST API library for /offer route.
+  REST API library for /order route.
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const OrderRESTControllerLib = require('./controller')
+import OrderRESTControllerLib from './controller.js'
 
 let _this
 
@@ -50,8 +50,8 @@ class OrderRouter {
 
     // Define the routes and attach the controller.
     this.router.post('/', _this.orderRESTController.createOrder)
-    this.router.get('/list', _this.orderRESTController.listOrders)
-    this.router.post('/take', _this.orderRESTController.takeOrder)
+    this.router.get('/list/all/:page', _this.orderRESTController.listOrders)
+    this.router.post('/delete', _this.orderRESTController.deleteOrder)
 
     // Attach the Controller routes to the Koa app.
     app.use(_this.router.routes())
@@ -59,4 +59,4 @@ class OrderRouter {
   }
 }
 
-module.exports = OrderRouter
+export default OrderRouter

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

@@ -0,0 +1,104 @@
+/*
+  REST API Controller library for the /p2wdb route
+  This route handles incoming data from the P2WDB webhook, and routes the data
+  to the proper handler.
+*/
+
+// const { wlogger } = require('../../../adapters/wlogger')
+
+let _this
+
+class P2WDBRESTControllerLib {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /p2wdb REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /p2wdb REST Controller.'
+      )
+    }
+
+    // Encapsulate dependencies
+    // this.OrderModel = this.adapters.localdb.Order
+    // this.userUseCases = this.useCases.user
+
+    _this = this
+  }
+
+  // No api-doc documentation because this wont be a public endpoint
+  async routeWebhook (ctx) {
+    try {
+      console.log('p2wdb REST API handler: body: ', ctx.request.body)
+
+      const dataType = ctx.request.body.data.dataType
+
+      if (dataType.includes('counter')) {
+        // Detect and handle Counter Offers
+        console.log('counter-offer data detected.')
+
+        const counterOffer = ctx.request.body
+
+        await _this.useCases.offer.acceptCounterOffer(counterOffer)
+
+        //
+      } else if (dataType.includes('offer')) {
+        // Detect and handle new Offers
+        console.log('offer data detected')
+
+        const offerObj = ctx.request.body
+        await _this.useCases.offer.createOffer(offerObj)
+
+        //
+      } else if (dataType.includes('flag')) {
+        // Detect and handle data generated by users flagging NSFW Offers.
+        const flagData = ctx.request.body
+        console.log('Flag type data received: ', flagData)
+
+        // const p2wdbHash = flagData.p2wdbHash
+        await _this.useCases.offer.flagOffer(flagData)
+      } else {
+        console.log('Could not route P2WDB webhook data.')
+      }
+
+      // const orderObj = ctx.request.body.order
+      //
+      // const hash = await _this.useCases.order.createOrder(orderObj)
+      //
+      // ctx.body = { hash }
+
+      ctx.body = {
+        success: true
+      }
+    } catch (err) {
+      // console.log(`err.message: ${err.message}`)
+      // console.log('err: ', err)
+      // ctx.throw(422, err.message)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // DRY error handler
+  handleError (ctx, err) {
+    console.log('err', 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)
+    }
+  }
+}
+
+export default P2WDBRESTControllerLib

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

@@ -0,0 +1,62 @@
+/*
+  REST API library for /p2wdb route.
+  This route handles incoming data from the P2WDB webhook, and routes the data
+  to the proper handler.
+*/
+
+// Public npm libraries.
+import Router from 'koa-router'
+
+// Local libraries.
+import P2WDBRESTControllerLib from './controller.js'
+
+let _this
+
+class P2WDBRouter {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /p2wdb REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /p2wdb REST Controller.'
+      )
+    }
+
+    const dependencies = {
+      adapters: this.adapters,
+      useCases: this.useCases
+    }
+
+    // Encapsulate dependencies.
+    this.p2wdbRESTController = new P2WDBRESTControllerLib(dependencies)
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/p2wdb'
+    this.router = new Router({ prefix: baseUrl })
+
+    _this = this
+  }
+
+  attach (app) {
+    if (!app) {
+      throw new Error(
+        'Must pass app object when attached REST API controllers.'
+      )
+    }
+
+    // Define the routes and attach the controller.
+    this.router.post('/', _this.p2wdbRESTController.routeWebhook)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(_this.router.routes())
+    app.use(_this.router.allowedMethods())
+  }
+}
+
+export default P2WDBRouter

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

@@ -2,7 +2,7 @@
   REST API Controller library for the /user route
 */
 
-const { wlogger } = require('../../../adapters/wlogger')
+import wlogger from '../../../adapters/wlogger.js'
 
 let _this
 
@@ -36,7 +36,7 @@ class UserRESTControllerLib {
    * @apiGroup REST Users
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "email": "email@format.com", "name": "my name", "password": "secretpasas" } }' localhost:5001/users
+   * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "email": "email@format.com", "name": "my name", "password": "secretpasas" } }' localhost:5010/users
    *
    * @apiParam {Object} user          User object (required)
    * @apiParam {String} user.email Email
@@ -136,7 +136,7 @@ class UserRESTControllerLib {
    * @apiGroup REST Users
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X GET localhost:5000/users/56bd1da600a526986cf65c80
+   * curl -H "Content-Type: application/json" -X GET localhost:5010/users/56bd1da600a526986cf65c80
    *
    * @apiSuccess {Object}   users           User object
    * @apiSuccess {ObjectId} users._id       User id
@@ -281,4 +281,4 @@ class UserRESTControllerLib {
   }
 }
 
-module.exports = UserRESTControllerLib
+export default UserRESTControllerLib

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

@@ -3,11 +3,12 @@
 */
 
 // Public npm libraries.
-const Router = require('koa-router')
+import Router from 'koa-router'
 
 // Local libraries.
-const UserRESTControllerLib = require('./controller')
-const Validators = require('../middleware/validators')
+import UserRESTControllerLib from './controller.js'
+
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -85,4 +86,4 @@ class UserRouter {
   }
 }
 
-module.exports = UserRouter
+export default UserRouter

src/controllers/timer-controllers.js

@@ -0,0 +1,70 @@
+/*
+  This Controller library is concerned with timer-based functions that are
+  kicked off periodicially.
+*/
+
+// Used to retain scope of 'this', when the scope is lost.
+let _this
+
+class TimerControllers {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating Timer Controller libraries.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating Timer Controller libraries.'
+      )
+    }
+
+    this.debugLevel = localConfig.debugLevel
+
+    _this = this
+
+    this.startTimers()
+  }
+
+  // Start all the time-based controllers.
+  startTimers () {
+    setInterval(this.gcOrders, 60000 * 5)
+    setInterval(this.gcOffers, 60000 * 5)
+    setInterval(this.checkDupOffers, 60000 * 4.5)
+  }
+
+  // Garbage Collect the Orders.
+  gcOrders () {
+    try {
+      _this.useCases.order.removeStaleOrders()
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/gcOrders(): ', err)
+    }
+  }
+
+  // Garbage Collect the Offers.
+  gcOffers () {
+    try {
+      _this.useCases.offer.removeStaleOffers()
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/gcOffers(): ', err)
+    }
+  }
+
+  // Remove duplicate Offers
+  checkDupOffers () {
+    try {
+      _this.useCases.offer.removeDuplicateOffers()
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/checkDupOffers(): ', err)
+    }
+  }
+}
+
+export default TimerControllers

src/entities/entry.js

@@ -38,4 +38,4 @@ class Entry {
   }
 }
 
-module.exports = Entry
+export default Entry

src/entities/offer.js

@@ -1,22 +1,37 @@
 /*
   Offer Entity
-  An Offer Entity is nearly the same as an Order. But while an Order is generated
-  by a webhook from P2WDB, the Offer Entity is created internally. It is used
-  to track an Order generated by this application.
-
-  The Offer tracks the hdIndex address used to hold tokens or BCH for sale.
+  An ffer is created when a new Signal is detected via the P2WDB webhook.
+  It's destroyed when the UTXO described in the Signal has been detected as spent.
 */
-class Offer {
-  validate (data) {
+
+class OfferEntity {
+  constructor () {
+    this.offerStatus = ['posted', 'taken', 'dead']
+  }
+
+  validate (offerData = {}) {
+    // Throw an error if input object does not have a data property
+    if (!offerData.data) {
+      throw new Error(
+        'Input to offer.validate() must be an object with a data property.'
+      )
+    }
+
     const {
       messageType,
       messageClass,
       tokenId,
       buyOrSell,
-      rateInSats,
-      minSatsToExchange,
-      numTokens
-    } = data
+      rateInBaseUnit,
+      minUnitsToExchange,
+      numTokens,
+      utxoTxid,
+      utxoVout,
+      offerStatus,
+      makerAddr,
+      ticker,
+      tokenType
+    } = offerData.data
 
     // Input Validation
     if (!messageType || typeof messageType !== 'number') {
@@ -31,28 +46,61 @@ class Offer {
     if (!buyOrSell || typeof buyOrSell !== 'string') {
       throw new Error("Property 'buyOrSell' must be a string.")
     }
-    if (!rateInSats || typeof rateInSats !== 'number') {
-      throw new Error("Property 'rateInSats' must be an integer number.")
+    if (!rateInBaseUnit || typeof rateInBaseUnit !== 'number') {
+      throw new Error("Property 'rateInBaseUnit' must be an integer number.")
     }
-    if (!minSatsToExchange || typeof minSatsToExchange !== 'number') {
-      throw new Error("Property 'minSatsToExchange' must be an integer number.")
+    if (!minUnitsToExchange || typeof minUnitsToExchange !== 'number') {
+      throw new Error("Property 'minUnitsToExchange' must be an integer number.")
     }
     if (!numTokens || typeof numTokens !== 'number') {
       throw new Error("Property 'numTokens' must be a number.")
     }
+    if (!utxoTxid || typeof utxoTxid !== 'string') {
+      throw new Error("Property 'utxoTxid' must be a string.")
+    }
+    if (typeof utxoVout !== 'number') {
+      throw new Error("Property 'utxoVout' must be an integer number.")
+    }
+    if (offerStatus && !this.offerStatus.includes(offerStatus)) {
+      throw new Error("Property 'offerStatus' must be posted, taken, or dead")
+    }
+    if (!makerAddr || typeof makerAddr !== 'string') {
+      throw new Error("Property 'makerAddr' must be a string.")
+    }
+    // if (!ticker || typeof ticker !== 'string') {
+    //   throw new Error("Property 'ticker' must be a string.")
+    // }
+    if (!tokenType || typeof tokenType !== 'number') {
+      throw new Error("Property 'tokenType' must be a number.")
+    }
 
-    const offerData = {
+    // Convert the timestamp to a number.
+    let timestamp = new Date(offerData.timestamp)
+    timestamp = timestamp.getTime()
+
+    const validatedOfferData = {
       messageType,
       messageClass,
       tokenId,
       buyOrSell,
-      rateInSats,
-      minSatsToExchange,
-      numTokens
+      rateInBaseUnit,
+      minUnitsToExchange,
+      numTokens,
+      utxoTxid,
+      utxoVout,
+      timestamp,
+      globaltimestamp: offerData.timestamp,
+      localTimestamp: offerData.localTimeStamp,
+      txid: offerData.txid,
+      p2wdbHash: offerData.hash,
+      offerStatus: offerStatus || this.offerStatus[0],
+      makerAddr,
+      ticker,
+      tokenType
     }
 
-    return offerData
+    return validatedOfferData
   }
 }
 
-module.exports = Offer
+export default OfferEntity

src/entities/order-old.js

@@ -1,24 +0,0 @@
-/*
-  Order Entity
-  An order is created when a new Signal is detected via the P2WDB webhook.
-  It's destroyed when the UTXO described in the Signal has been detected as spent.
-
-  {
-    lokadId: 'SWP', // Placeholder for now, use for backwards compatibility
-    messageType: 1, // SLP Atomic Swap
-    messageClass: 1,
-    tokenId: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-    buyOrSell: 'sell',
-    rateInSats: 7972, // Price per token in sats
-    minSatsToExchange: 8100, // Minum size of UTXO to use, e.g. 1 token + miner fees
-
-    // Signature from the address holding the tokens, provides 'proof of reserves'
-    signature: 'H2Sq0UPh0jgs1Zt3JERHtbzfPGXJk9DgJ0FVxVa6iUqiIh6XcvEUFBbvYIuODQs3hYSCkkjcuzbvzNEiv69kFKg=',
-    sigMsg: 'test',
-    address: 'bitcoincash:qphjncqpnv444jq8acqk4dkm3296c50xhqggeatvn8',
-
-    // UTXO for sale
-    utxoTxid: 'b9457808be70c39a9cc6c5857cbef856b35fdc91a59debfe06acfc45b11955e3',
-    utxoVout: 2
-  }
-*/

src/entities/order.js

@@ -1,22 +1,26 @@
 /*
   Order Entity
-  An order is created when a new Signal is detected via the P2WDB webhook.
-  It's destroyed when the UTXO described in the Signal has been detected as spent.
+  An Order Entity is nearly the same as an Offer. But while an Offer is generated
+  by a webhook from P2WDB, the Order Entity is created internally. It is used
+  to track an Order generated by this application.
+
+  The Order tracks the hdIndex address used to hold tokens or BCH for sale.
 */
-class OrderEntity {
-  constructor () {
-    this.orderStatus = ['posted', 'taken', 'completed']
-  }
+class Order {
+  // TODO: Create a fullValidate() function that validates a fully-hydrated
+  // order model.
 
-  validate (orderData = {}) {
-    // Throw an error if input object does not have a data property
-    if (!orderData.data) {
-      throw new Error(
-        'Input to order.validate() must be an object with a data property.'
-      )
-    }
-
-    const { messageType, messageClass, tokenId, buyOrSell, rateInSats, minSatsToExchange, numTokens, utxoTxid, utxoVout, orderStatus } = orderData.data
+  inputValidate (data) {
+    const {
+      messageType,
+      messageClass,
+      tokenId,
+      buyOrSell,
+      rateInBaseUnit,
+      minUnitsToExchange,
+      numTokens,
+      makerAddr
+    } = data
 
     // Input Validation
     if (!messageType || typeof messageType !== 'number') {
@@ -31,44 +35,36 @@ class OrderEntity {
     if (!buyOrSell || typeof buyOrSell !== 'string') {
       throw new Error("Property 'buyOrSell' must be a string.")
     }
-    if (!rateInSats || typeof rateInSats !== 'number') {
-      throw new Error("Property 'rateInSats' must be an integer number.")
+    if (!rateInBaseUnit || typeof rateInBaseUnit !== 'number') {
+      throw new Error("Property 'rateInBaseUnit' must be an integer number.")
     }
-    if (!minSatsToExchange || typeof minSatsToExchange !== 'number') {
-      throw new Error("Property 'minSatsToExchange' must be an integer number.")
+    if (!minUnitsToExchange || typeof minUnitsToExchange !== 'number') {
+      throw new Error("Property 'minUnitsToExchange' must be an integer number.")
     }
     if (!numTokens || typeof numTokens !== 'number') {
       throw new Error("Property 'numTokens' must be a number.")
     }
-    if (!utxoTxid || typeof utxoTxid !== 'string') {
-      throw new Error("Property 'utxoTxid' must be a string.")
-    }
-    if (typeof utxoVout !== 'number') {
-      throw new Error("Property 'utxoVout' must be an integer number.")
-    }
-    if (orderStatus && !this.orderStatus.includes(orderStatus)) {
-      throw new Error("Property 'orderStatus' must be a valid string")
+    if (!makerAddr || typeof makerAddr !== 'string') {
+      throw new Error("Property 'makerAddr' must be a string.")
     }
+    // if (!ticker || typeof ticker !== 'string') {
+    //   throw new Error("Property 'ticker' must be a string.")
+    // }
 
-    const validatedOrderData = {
+    const offerData = {
       messageType,
       messageClass,
       tokenId,
       buyOrSell,
-      rateInSats,
-      minSatsToExchange,
+      rateInBaseUnit,
+      minUnitsToExchange,
       numTokens,
-      utxoTxid,
-      utxoVout,
-      timestamp: orderData.timestamp,
-      localTimestamp: orderData.localTimeStamp,
-      txid: orderData.txid,
-      p2wdbHash: orderData.hash,
-      orderStatus: orderStatus || this.orderStatus[0]
+      makerAddr
+      // ticker
     }
 
-    return validatedOrderData
+    return offerData
   }
 }
 
-module.exports = OrderEntity
+export default Order

src/entities/user.js

@@ -21,4 +21,4 @@ class User {
   }
 }
 
-module.exports = User
+export default User

src/use-cases/entry.js

@@ -1,6 +1,8 @@
-const { wlogger } = require('../adapters/wlogger')
 
-const EntryEntiy = require('../entities/entry')
+// local libraries
+import wlogger from '../adapters/wlogger.js'
+import EntryEntiy from '../entities/entry.js'
+
 class EntryLib {
   constructor (localConfig = {}) {
     // console.log('User localConfig: ', localConfig)
@@ -30,10 +32,10 @@ class EntryLib {
       }
 
       // Verify psf tokens balance
-
-      const psfBalance = await this.bch.getPSFTokenBalance(
-        entryEntity.slpAddress
-      )
+      // const psfBalance = await this.bch.getPSFTokenBalance(
+      //   entryEntity.slpAddress
+      // )
+      const psfBalance = 1
 
       if (psfBalance < 10) {
         throw new Error('Insufficient psf balance')
@@ -63,4 +65,4 @@ class EntryLib {
   }
 }
 
-module.exports = EntryLib
+export default EntryLib

src/use-cases/index.js

@@ -4,10 +4,10 @@
   https://troutsblog.com/blog/clean-architecture
 */
 
-const UserUseCases = require('./user')
-const EntryUseCases = require('./entry')
-const OfferUseCases = require('./offer')
-const OrderUseCases = require('./order')
+import UserUseCases from './user.js'
+import EntryUseCases from './entry.js'
+import OfferUseCases from './offer/index.js'
+import OrderUseCases from './order.js'
 
 class UseCases {
   constructor (localConfig = {}) {
@@ -21,9 +21,23 @@ class UseCases {
     // console.log('use-cases/index.js localConfig: ', localConfig)
     this.user = new UserUseCases(localConfig)
     this.entry = new EntryUseCases(localConfig)
-    this.offer = new OfferUseCases(localConfig)
     this.order = new OrderUseCases(localConfig)
+    localConfig.order = this.order
+    this.offer = new OfferUseCases(localConfig)
+  }
+
+  // Run any startup Use Cases at the start of the app.
+  async start () {
+    // try {
+    console.log('Async Use Cases have been started.')
+
+    return true
+    // } catch (err) {
+    //   console.error('Error in use-cases/index.js/start()')
+    //   // console.log(err)
+    //   throw err
+    // }
   }
 }
 
-module.exports = UseCases
+export default UseCases

src/use-cases/offer.js

@@ -1,157 +0,0 @@
-/*
-  Offer use-case library.
-*/
-
-// Local libraries
-const { wlogger } = require('../adapters/wlogger')
-const OfferEntity = require('../entities/offer')
-const config = require('../../config')
-
-class OfferLib {
-  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 Offer Use Cases library.'
-      )
-    }
-
-    // Encapsulate dependencies
-    this.offerEntity = new OfferEntity()
-    this.OfferModel = this.adapters.localdb.Offer
-    this.bch = this.adapters.bch
-    this.config = config
-  }
-
-  // Create a new offer model and add it to the Mongo database.
-  async createOffer (entryObj) {
-    try {
-      // console.log('createOffer(entryObj): ', entryObj)
-
-      // Input Validation
-      const offerEntity = this.offerEntity.validate(entryObj)
-      console.log('offerEntity: ', offerEntity)
-
-      // Ensure sufficient tokens exist to create the offer.
-      await this.ensureFunds(offerEntity)
-
-      // Move the tokens to holding address.
-      const utxoInfo = await this.moveTokens(offerEntity)
-      console.log('utxoInfo: ', utxoInfo)
-
-      // Update the UTXO store for the wallet.
-      await this.adapters.wallet.bchWallet.bchjs.Util.sleep(3000)
-      await this.adapters.wallet.bchWallet.getUtxos()
-
-      // Update the offer with the new UTXO information.
-      offerEntity.utxoTxid = utxoInfo.txid
-      offerEntity.utxoVout = utxoInfo.vout
-      offerEntity.hdIndex = utxoInfo.hdIndex
-
-      // Add offer to P2WDB.
-      const p2wdbObj = {
-        wif: this.adapters.wallet.bchWallet.walletInfo.privateKey,
-        data: offerEntity,
-        appId: this.config.p2wdbAppId
-      }
-      const hash = await this.adapters.p2wdb.write(p2wdbObj)
-      // console.log('hash: ', hash)
-
-      // Create a MongoDB model to hold the Offer
-      offerEntity.p2wdbHash = hash
-      console.log(`creating new offer model: ${JSON.stringify(offerEntity, null, 2)}`)
-      const offer = new this.OfferModel(offerEntity)
-      await offer.save()
-
-      return hash
-    } catch (err) {
-      // console.log("Error in use-cases/entry.js/createEntry()", err.message)
-      wlogger.error('Error in use-cases/entry.js/createOffer())')
-      throw err
-    }
-  }
-
-  // Move the tokens indicated in the offer to a temporary holding address.
-  // This will generate the UTXO used in the Signal message. This function
-  // moves the funds and returns the UTXO information.
-  async moveTokens (offerEntity) {
-    try {
-      const keyPair = await this.adapters.wallet.getKeyPair()
-      console.log('keyPair: ', keyPair)
-
-      const receiver = {
-        address: keyPair.cashAddress,
-        tokenId: offerEntity.tokenId,
-        qty: offerEntity.numTokens
-      }
-
-      const txid = await this.adapters.wallet.bchWallet.sendTokens(receiver, 3)
-
-      const utxoInfo = {
-        txid,
-        vout: 1,
-        hdIndex: keyPair.hdIndex
-      }
-
-      return utxoInfo
-    } catch (err) {
-      console.error('Error in moveTokens(): ', err)
-      throw err
-    }
-  }
-
-  // Ensure that the wallet has enough BCH and tokens to complete the requested
-  // trade.
-  async ensureFunds (offerEntity) {
-    try {
-      // console.log('this.adapters.wallet: ', this.adapters.wallet.bchWallet)
-      // console.log(`walletInfo: ${JSON.stringify(this.adapters.wallet.bchWallet.walletInfo, null, 2)}`)
-
-      // Ensure the app wallet has enough funds to write to the P2WDB.
-      const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
-      const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)
-      if (!canWriteToP2WDB) throw new Error('App wallet does not have funds for writing to the P2WDB.')
-
-      // Get UTXOs.
-      const utxos = this.adapters.wallet.bchWallet.utxos.utxoStore
-      console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-      if (offerEntity.buyOrSell.includes('sell')) {
-        // Sell Offer
-
-        // Get token UTXOs that match the token in the offer.
-        const tokenUtxos = utxos.slpUtxos.type1.tokens.filter(
-          x => x.tokenId === offerEntity.tokenId
-        )
-        // console.log('tokenUtxos: ', tokenUtxos)
-
-        // Get the total amount of tokens in the wallet that match the token
-        // in the offer.
-        let totalTokenBalance = 0
-        tokenUtxos.map(x => (totalTokenBalance += parseFloat(x.qtyStr)))
-        console.log('totalTokenBalance: ', totalTokenBalance)
-
-        // If there are fewer tokens in the wallet than what's in the offer,
-        // throw an error.
-        if (totalTokenBalance <= offerEntity.numTokens || isNaN(totalTokenBalance)) {
-          throw new Error(
-            'App wallet does not have enough tokens to satisfy the SELL offer.'
-          )
-        }
-
-      //
-      } else {
-        // Buy Offer
-        throw new Error('Buy orders are not supported yet.')
-      }
-
-      return true
-    } catch (err) {
-      console.error('Error in ensureFunds()')
-      throw err
-    }
-  }
-}
-
-module.exports = OfferLib

src/use-cases/offer/index.js

@@ -0,0 +1,632 @@
+/*
+  Use Case library for Offers.
+
+  Offers are created by a webhook trigger from the P2WDB. Offers are a result of
+  new data in P2WDB. They differ from Offers, which are generated by a local
+  user.
+
+  An Offer is created to match a local Offer, but it's created indirectly, as
+  a response to the webhook from the P2WDB. In this way, Offers generated from
+  local Offers are no different than Offers generated by other peers.
+
+  A Counter Offer is created by calling the /take/:cid endpoint. It creates
+  a partially signed transaction.
+ */
+
+// Global npm libraries
+import axios from 'axios'
+import RetryQueue from '@chris.troutner/retry-queue'
+
+// Local libraries
+import OfferEntity from '../../entities/offer.js'
+import config from '../../../config/index.js'
+
+const DEFAULT_ENTRIES_PER_PAGE = 20
+const NFT_ENTRIES_PER_PAGE = 6
+const FUNGIBLE_ENTRIES_PER_PAGE = 20
+
+class OfferUseCases {
+  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 Offer Use Cases library.'
+      )
+    }
+    this.orderUseCase = localConfig.order
+    if (!this.orderUseCase) {
+      throw new Error(
+        'Instance of Offer Use Cases must be passed in when instantiating Offer Use Cases library.'
+      )
+    }
+
+    // Encapsulate dependencies
+    this.config = config
+    this.axios = axios
+    this.offerEntity = new OfferEntity()
+    this.OfferModel = this.adapters.localdb.Offer
+    this.retryQueue = new RetryQueue({ retryPeriod: 1000, attempts: 3 })
+
+    // Bind 'this' object to functions
+    this.detectNsfw = this.detectNsfw.bind(this)
+  }
+
+  // This method is called by the POST /offer REST API controller, which is
+  // triggered by a P2WDB webhook.
+  async createOffer (offerObj) {
+    try {
+      console.log('Use Case createOffer(offerObj): ', offerObj)
+
+      // Return if Offer already exists in database with the same P2WDB CID.
+      try {
+        await this.findOfferByHash(offerObj.hash)
+
+        console.log('Offer already found in local database.')
+        return false
+      } catch (err) { /* exit quietly */ }
+
+      // console.log('this.adapters.bchjs: ', this.adapters.bchjs)
+
+      // Input Validation
+      // TODO: This is a hack. Find a better way to protect against the corner-
+      // case of counter-offers getting routed here.
+      if (offerObj.data.dataType === 'counter-offer') {
+        console.log('WARN: Counter Offer innappropriately routed to createOffer()')
+      }
+
+      // Verify that UTXO in offer is unspent. If it is spent, then ignore the
+      // offer.
+      const utxo = {
+        tx_hash: offerObj.data.utxoTxid,
+        tx_pos: offerObj.data.utxoVout
+      }
+      // const utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
+      const utxoStatus = await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.utxoIsValid, utxo)
+      console.log('utxoStatus: ', utxoStatus)
+      // if (utxoStatus === null) return false
+      if (!utxoStatus) return false
+
+      // A new offer gets a status of 'posted'
+      offerObj.data.offerStatus = 'posted'
+
+      const offerEntity = this.offerEntity.validate(offerObj)
+      console.log('offerEntity: ', offerEntity)
+
+      // Get data about the token.
+      const tokenId = offerEntity.tokenId
+      // const tokenData = await this.adapters.wallet.bchWallet.getTokenData(tokenId)
+      const tokenData = await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.getTokenData, tokenId)
+      console.log(`tokenData: ${JSON.stringify(tokenData, null, 2)}`)
+
+      // Generate a 'display category' for the token. This will allow the
+      // front end UI to figure out how to display the token.
+      const displayCategory = this.categorizeToken(offerEntity, tokenData)
+      console.log('displayCategory: ', displayCategory)
+      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
+
+      // Add offer to the local database.
+      const offerModel = new this.OfferModel(offerEntity)
+      await offerModel.save()
+
+      return true
+    } catch (err) {
+      console.error('Error in createOffer()')
+      throw err
+    }
+  }
+
+  // By default this function returns false, to indicate the NFT is safe for work.
+  // If the user who created the token sets the nsfw property in the mutable data,
+  // this function will return true.
+  async detectNsfw (tokenData) {
+    try {
+      let nsfw = false
+
+      const mutableCid = tokenData.mutableData
+
+      // If there is no mutable IPFS CID, then skip this token.
+      if (!mutableCid.includes('ipfs://')) return nsfw
+
+      // Revove the ipfs:// prefix.
+      const cid = mutableCid.substring(7)
+
+      // Retrieve the mutable data from Filecoin/IPFS.
+      // const url = `https://${cid}.ipfs.w3s.link/data.json`
+      const url = `${this.config.ipfsGateway}${cid}/data.json`
+      const result = await axios.get(url)
+      const mutableData = result.data
+      console.log(`mutableData: ${JSON.stringify(mutableData, null, 2)}`)
+
+      // Logical tests
+      const hasNsfw = !!mutableData.nsfw
+      const nsfwSetTrue = mutableData.nsfw === true
+      const nsfwStringTrue = mutableData.nsfw === 'true'
+      const nsfwDetected = hasNsfw && (nsfwSetTrue || nsfwStringTrue)
+
+      if (nsfwDetected) {
+        console.log('NSFW flag set as true')
+        nsfw = true
+      }
+
+      return nsfw
+    } catch (err) {
+      console.error('Error in detectNsfw(): ', err)
+      return false
+    }
+  }
+
+  // Categorize the token for display purposes. This will categorize a token
+  // into one of these categories:
+  // - nft
+  // - group
+  // - fungible
+  // - simple-nft
+  //
+  // The first three are easy to categorize. The simple-nft is a fungible token
+  // with a quantity of 1, decimals of 0, and no minting baton. Categorizing this
+  // type of token is the main reason why this function exists.
+  categorizeToken (offerData, tokenData) {
+    try {
+      // console.log(`categorizeToken(): ${JSON.stringify(offerData, null, 2)}`)
+
+      // const tokenId = offerData.tokenId
+      //
+      // const tokenData = await this.adapters.wallet.bchWallet.getTokenData(tokenId)
+      // console.log(`tokenData: ${JSON.stringify(tokenData, null, 2)}`)
+
+      if (tokenData.genesisData.type === 65) {
+        return 'nft'
+      }
+
+      // Create a set of checks to detect a simple NFT
+      const isType1 = tokenData.genesisData.type === 1
+      const hasNoMintingBaton = !tokenData.genesisData.mintBatonIsActive
+      const hasNoDecimals = !tokenData.genesisData.decimals
+      const hasQtyOfOne = parseInt(tokenData.genesisData.tokensInCirculationStr) === 1
+
+      if (isType1 && hasNoMintingBaton && hasNoDecimals && hasQtyOfOne) {
+        return 'simple-nft'
+      }
+
+      if (isType1) return 'fungible'
+
+      throw new Error(`Unknown token type: ${tokenData.genesisData.type}`)
+    } catch (err) {
+      console.error('Error in use-cases/offer/index.js categorizeToken(): ', err)
+      throw err
+    }
+  }
+
+  async listOffers (page = 0) {
+    try {
+      const data = await this.OfferModel.find({})
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * DEFAULT_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(DEFAULT_ENTRIES_PER_PAGE)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/offer/listOffers()')
+      throw error
+    }
+  }
+
+  async listNftOffers (page = 0, nsfw = false) {
+    try {
+      const data = await this.OfferModel.find({
+        displayCategory: { $ne: 'fungible' },
+        nsfw
+      })
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * NFT_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(NFT_ENTRIES_PER_PAGE)
+
+      // console.log('listNftOffers() returning this data: ', data)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/offer/listNftOffers()')
+      throw error
+    }
+  }
+
+  async listFungibleOffers (page = 0) {
+    try {
+      const data = await this.OfferModel.find({ displayCategory: 'fungible' })
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * FUNGIBLE_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(FUNGIBLE_ENTRIES_PER_PAGE)
+
+      // console.log('listFungibleOffers() returning this data: ', data)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/offer/listFungibleOffers()')
+      throw error
+    }
+  }
+
+  // Generate phase 2 of 3 - take the other side of an Offer.
+  // Based on this example:
+  // https://github.com/Permission=less-Software-Foundation/bch-js-examples/blob/master/bch/applications/collaborate/sell-slp/e2e-exchange/step2-purchase-tx.js
+  //
+  // Dev Note: Right now this use cases takes all the tokens offered. It does not
+  // provide functionality to take less than the total amount of tokens offered
+  // (offerInfo.numTokens). Taking less than the offered amount will be added
+  // in the future.
+  async takeOffer (offerCid) {
+    try {
+      console.log('offerCid: ', offerCid)
+
+      // Get the Offer information
+      const offerInfo = await this.findOfferByHash(offerCid)
+      console.log(`offerInfo: ${JSON.stringify(offerInfo, null, 2)}`)
+
+      // Ensure the offer is in a 'posted' state and not already 'taken'
+      if (!offerInfo.offerStatus || offerInfo.offerStatus !== 'posted') {
+        throw new Error('offer status is not "posted", so offer is dead and can not be countered.')
+      }
+
+      // Verify that UTXO for sale is unspent. Abort if it's been spent.
+      const utxo = {
+        tx_hash: offerInfo.utxoTxid,
+        tx_pos: offerInfo.utxoVout
+      }
+      const utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
+      console.log('utxoStatus: ', utxoStatus)
+      if (!utxoStatus) {
+        console.log(`utxo txid: ${offerInfo.utxoTxid}, vout: ${offerInfo.utxoVout}`)
+
+        // TODO: Mark this Offer as 'dead'
+
+        throw new Error('UTXO does not exist. Aborting.')
+      }
+
+      // Ensure the app has enough funds to complete the trade.
+      await this.ensureFunds(offerInfo)
+
+      // Get UTXOs.
+      const utxos = this.adapters.wallet.bchWallet.utxos.utxoStore
+      console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
+
+      // Calculate amount of sats to generate a counter offer.
+      let satsToMove = Math.ceil(offerInfo.numTokens * parseInt(offerInfo.rateInBaseUnit))
+      if (isNaN(satsToMove)) {
+        throw new Error('Could not calculate the amount of BCH to generate counter offer')
+      }
+
+      // Add sats to cover mining fees and dust for token UTXO
+      satsToMove += 1000
+
+      // Move funds to create a segrated UTXO for taking the offer
+      const utxoInfo = await this.adapters.wallet.moveBch(satsToMove)
+      utxoInfo.sats = satsToMove
+      console.log('utxoInfo: ', utxoInfo)
+
+      // Create a partially signed transaction.
+      // https://github.com/Permissionless-Software-Foundation/bch-js-examples/blob/master/bch/applications/collaborate/sell-slp/e2e-exchange/step2-purchase-tx.js#L59
+      const partialTxHex = await this.adapters.wallet.generatePartialTx(offerInfo, utxoInfo)
+      console.log('partialTxHex: ', partialTxHex)
+      // return partialTxHex
+
+      // Debug: Decode the transaction for manual QA
+      const txObj = await this.adapters.wallet.deseralizeTx(partialTxHex)
+      console.log(`partially-signed transaction: ${JSON.stringify(txObj, null, 2)}`)
+
+      // Create valid Offer object
+      const takenOfferInfo = Object.assign({}, offerInfo)
+      takenOfferInfo.partialTxHex = partialTxHex
+      delete takenOfferInfo.p2wdbHash
+      delete takenOfferInfo._id
+      takenOfferInfo.offerHash = offerInfo.p2wdbHash
+
+      // Add P2WDB specific flag for signaling that this is a new offer.
+      takenOfferInfo.dataType = 'counter-offer'
+
+      // Write offer info to the P2WDB
+      // TODO: This will trigger the webhook. Find some way of triggering the
+      // webhook on new offers, but not on counteroffers
+      const p2wdbObj = {
+        wif: this.adapters.wallet.bchWallet.walletInfo.privateKey,
+        data: takenOfferInfo,
+        appId: this.config.p2wdbAppId
+      }
+      const hash = await this.adapters.p2wdb.write(p2wdbObj)
+
+      // Delete the Offer from the database, so that the user doesn't attempt
+      // to take the offer more than once.
+      offerInfo.remove()
+
+      // Return the P2WDB CID
+      return hash
+
+      // return 'fake-hash'
+    } catch (err) {
+      console.error('Error in use-cases/offer/takeOffer(): ', err)
+      throw err
+    }
+  }
+
+  // Ensure that the wallet has enough BCH and tokens to complete the requested
+  // trade. Will return true if it does. Will throw an error if it doesn't.
+  async ensureFunds (offerEntity) {
+    try {
+      // console.log('this.adapters.wallet: ', this.adapters.wallet.bchWallet)
+      // console.log(`walletInfo: ${JSON.stringify(this.adapters.wallet.bchWallet.walletInfo, null, 2)}`)
+
+      await this.adapters.wallet.bchWallet.walletInfoPromise
+      // console.log(`utxos: ${JSON.stringify(this.adapters.wallet.bchWallet.utxos.utxoStore, null, 2)}`)
+
+      // Refresh the wallet UTXOs
+      await this.adapters.wallet.bchWallet.initialize()
+
+      // Ensure the app wallet has enough funds to write to the P2WDB.
+      const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
+      const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)
+      if (!canWriteToP2WDB) throw new Error('App wallet does not have funds for writing to the P2WDB.')
+
+      if (offerEntity.buyOrSell.includes('sell')) {
+        // Sell Offer
+
+        // Calculate the sats needed
+        const satsNeeded = Math.ceil(offerEntity.numTokens * parseInt(offerEntity.rateInBaseUnit))
+        if (isNaN(satsNeeded)) {
+          throw new Error('Could not calculate sats needed!')
+        }
+
+        // Ensure the app wallet controlls enough BCH to pay for the tokens.
+        const balance = await this.adapters.wallet.bchWallet.getBalance()
+        console.log(`wallet balance: ${balance}, sats needed: ${satsNeeded}`)
+        const SATS_MARGIN = 5000
+        if (satsNeeded + SATS_MARGIN > balance) {
+          throw new Error('App wallet does not control enough BCH to purchase the tokens.')
+        }
+
+      //
+      } else {
+        // Buy Offer
+        throw new Error('Buy offers are not supported yet.')
+      }
+
+      return true
+    } catch (err) {
+      console.error('Error in offer/index.js/ensureFunds()')
+
+      // Debugging
+      try {
+        console.error(`Error with this address: ${this.adapters.wallet.bchWallet.walletInfo.cashAddress}`)
+      } catch (err) { /* exit quietly */ }
+
+      throw err
+    }
+  }
+
+  async findOfferByHash (p2wdbHash) {
+    // try {
+    if (typeof p2wdbHash !== 'string' || !p2wdbHash) {
+      throw new Error('p2wdbHash must be a string')
+    }
+
+    const offer = await this.OfferModel.findOne({ p2wdbHash })
+
+    if (!offer) {
+      throw new Error('offer not found')
+    }
+
+    return offer
+
+    // const offerObject = offer.toObject()
+    // return this.offerEntity.validateFromModel(offerObject)
+
+    // return offerObject
+    // } catch (err) {
+    //   // console.error('Error in findOffer(): ', err)
+    //   throw err
+    // }
+  }
+
+  // This function is called by the P2WDB webhook REST API handler. When a
+  // Counter Offer is passed to bch-dex by the P2WDB, the data is then passed
+  // to this function. It does due dilligence on the Counter Offer, then signs
+  // and broadcasts the transaction to accept the Counter Offer.
+  async acceptCounterOffer (p2wdbData) {
+    try {
+      console.log(`acceptCounterOffer() p2wdbData: ${JSON.stringify(p2wdbData, null, 2)}`)
+
+      // See if this instance of bch-dex is managing the Order associated with
+      // the incoming Counter Offer.
+      const orderHash = p2wdbData.data.offerHash
+      let orderData = {}
+      try {
+        orderData = await this.orderUseCase.findOrderByHash(orderHash)
+        console.log(`orderData: ${JSON.stringify(orderData, null, 2)}`)
+      } catch (err) {
+        console.log('Order matching this Counter Offer is not managed by this instance of bch-dex. Exiting.')
+        return 'N/A'
+      }
+
+      // Deserialize the partially signed transaction.
+      const txHex = p2wdbData.data.partialTxHex
+      const txObj = await this.adapters.wallet.deseralizeTx(txHex)
+      console.log(`txObj: ${JSON.stringify(txObj, null, 2)}`)
+
+      // Ensure the 3rd output (vout=2) contains the required amount of BCH.
+      const satsToReceive = Math.ceil(orderData.numTokens * parseInt(orderData.rateInBaseUnit))
+      if (isNaN(satsToReceive)) {
+        throw new Error('Could not calculate the amount of BCH offered in the Counter Offer')
+      }
+      const satsOut = this.adapters.wallet.bchWallet.bchjs.BitcoinCash.toSatoshi(txObj.vout[2].value)
+      const hasRequiredAmount = satsOut === satsToReceive
+      if (!hasRequiredAmount) {
+        throw new Error(`The Counter Offer has an output of ${satsOut}, which does not match the required ${satsToReceive} in the Offer.`)
+      }
+
+      // Ensure the 3rd output (vout=2) is going to the maker address specified
+      // in the Offer.
+      const addrInCounterOffer = txObj.vout[2].scriptPubKey.addresses[0]
+      const makerAddr = orderData.makerAddr
+      const hasCorrectAddr = makerAddr === addrInCounterOffer
+      if (!hasCorrectAddr) {
+        throw new Error(`The Counter Offer has an output address of ${addrInCounterOffer}, which does not match the Maker address of ${makerAddr} in the Offer.`)
+      }
+
+      // Sign and broadcast the transaction.
+      const txid = await this.adapters.wallet.completeTx(txHex, orderData.hdIndex)
+      console.log('txid: ', txid)
+
+      return txid
+    } catch (err) {
+      console.error('Error in acceptCounterOffer()')
+      throw err
+    }
+  }
+
+  // TODO: Write unit tests for this function, then add it to the Timer Controllers
+  // Looks for duplicate offers and removes the duplicate.
+  // Duplicates are checked for when an offer is created, and so should not
+  // exist. But emperical testing shows that they do. This function is called
+  // periodically by a timer, to clean up any duplicates that slipped through
+  // the cracks.
+  async removeDuplicateOffers () {
+    try {
+      const now = new Date()
+      console.log(`Starting removeDuplicateOffers() at ${now.toLocaleString()}`)
+
+      let duplicateFound = false
+
+      // Get all Offers in the database.
+      const offers = await this.OfferModel.find({})
+      // console.log('offers: ', offers)
+
+      const offerZcids = []
+
+      for (let i = 0; i < offers.length; i++) {
+        const thisOffer = offers[i]
+
+        if (offerZcids.includes(thisOffer.p2wdbHash)) {
+          await thisOffer.remove()
+          duplicateFound = true
+          continue
+        }
+
+        // Add the zcid to the array.
+        offerZcids.push(thisOffer.p2wdbHash)
+      }
+
+      return duplicateFound
+    } catch (err) {
+      console.error('Error in removeDuplicateOffers()')
+      throw err
+    }
+  }
+
+  // This function is called by the garbage collection timer controller. It
+  // checks the UTXO associated with each Offer in the database. If the UTXO
+  // has been spent, the Offer is deleted from the database.
+  async removeStaleOffers () {
+    try {
+      const now = new Date()
+      console.log(`Starting garbage collection for Offers at ${now.toLocaleString()}`)
+
+      // Get all Offers in the database.
+      const offers = await this.OfferModel.find({})
+      // console.log('offers: ', offers)
+
+      // Loop through each Offer and ensure the UTXO is still valid.
+      for (let i = 0; i < offers.length; i++) {
+        const thisOffer = offers[i]
+
+        let utxoStatus = null
+        try {
+          // Get the status of the UTXO associate with this Offer.
+          const utxo = {
+            tx_hash: thisOffer.utxoTxid,
+            tx_pos: thisOffer.utxoVout
+          }
+          // console.log(`Checking this UTXO: ${JSON.stringify(utxo, null, 2)}`)
+
+          // utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
+          utxoStatus = await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.utxoIsValid, utxo)
+          // console.log('utxoStatus: ', utxoStatus)
+        } catch (err) {
+          // Handle corner case of bad-data in the Offer model.
+          if (err.message && err.message.includes('txid needs to be a proper transaction ID')) {
+            console.log(`Deleting Offer with bad data: ${JSON.stringify(thisOffer, null, 2)}`)
+            await thisOffer.remove()
+            continue
+          } else if (err.isAxiosError) {
+            console.log('Error trying to contact wallet service: ', err)
+            continue
+          } else {
+            throw err
+          }
+        }
+
+        // If the Offer UTXO is spent, delete the Offer model.
+        if (utxoStatus === false) {
+          console.log('utxoStatus: ', utxoStatus)
+          console.log(`Spent UTXO detected. Deleting this Offer: ${JSON.stringify(thisOffer, null, 2)}`)
+          await thisOffer.remove()
+        }
+
+        // If the Offer is older than 7 days, delete it.
+        const nowMs = now.getTime()
+        const eightWeeks = 1000 * 60 * 60 * 24 * 7 * 8
+        const eightWeeksAgo = nowMs - eightWeeks
+        if (thisOffer.timestamp < eightWeeksAgo) {
+          console.log('Offer older than 8 weeks. Deleting.')
+          await thisOffer.remove()
+        }
+      }
+    } catch (err) {
+      console.error('Error in removeStaleOffers(): ', err)
+      throw err
+    }
+  }
+
+  async flagOffer (flagData) {
+    console.log(`flagData: ${JSON.stringify(flagData, null, 2)}`)
+
+    const p2wdbHash = flagData.data.p2wdbHash
+
+    // Get the offer from the database.
+    const offer = await this.findOfferByHash(p2wdbHash)
+    console.log(`Flagging this offer: ${JSON.stringify(offer, null, 2)}`)
+
+    if (!offer) {
+      throw new Error(`Offer ${p2wdbHash} not found in the database.`)
+    }
+
+    // Add the raw flag data to the database model.
+    offer.flags.push(flagData)
+
+    // If flag count is 3 or more, mark the Offer as NSFW
+    const flagCnt = offer.flags.length
+    if (flagCnt >= 3) {
+      offer.nsfw = true
+    }
+
+    // Save the updated offer data to the database.
+    await offer.save()
+
+    return true
+  }
+}
+
+export default OfferUseCases

src/use-cases/offer/retry-queue.js

@@ -9,8 +9,9 @@
   pay-to-write-access-controller.js depends on this library.
 */
 
-const PQueue = require('p-queue').default
-const pRetry = require('p-retry')
+// Global npm libraries
+import PQueue from 'p-queue'
+import pRetry from 'p-retry'
 
 let _this
 
@@ -103,4 +104,4 @@ class RetryQueue {
   }
 }
 
-module.exports = RetryQueue
+export default RetryQueue

src/use-cases/order.js

@@ -0,0 +1,294 @@
+/*
+  Order use-case library.
+*/
+
+// Global npm libraries
+import RetryQueue from '@chris.troutner/retry-queue'
+
+// Local libraries
+import wlogger from '../adapters/wlogger.js'
+import OrderEntity from '../entities/order.js'
+import config from '../../config/index.js'
+
+const DEFAULT_ENTRIES_PER_PAGE = 20
+
+class OrderLib {
+  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 Order Use Cases library.'
+      )
+    }
+
+    // Encapsulate dependencies
+    this.orderEntity = new OrderEntity()
+    this.OrderModel = this.adapters.localdb.Order
+    this.bch = this.adapters.bch
+    this.config = config
+    this.retryQueue = new RetryQueue({ retryPeriod: 1000, attempts: 3 })
+
+    // Bind subfunctions to the 'this' object.
+    this.ensureFunds = this.ensureFunds.bind(this)
+  }
+
+  // Create a new order model and add it to the Mongo database.
+  async createOrder (entryObj) {
+    try {
+      console.log('createOrder(entryObj): ', entryObj)
+      if (!entryObj) return false
+
+      if (!entryObj.tokenId) throw new Error('entry does not contain required properties')
+
+      // Specify the address to send payment.
+      entryObj.makerAddr = this.adapters.wallet.bchWallet.walletInfo.cashAddress
+      console.log('entryObj.makerAddr: ', entryObj.makerAddr)
+
+      // Input Validation
+      const orderEntity = this.orderEntity.inputValidate(entryObj)
+      console.log('orderEntity: ', orderEntity)
+
+      // Optimize the wallet to speed up working with it.
+      console.log('Optimizing wallet before creating new order.')
+      await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.optimize, {})
+
+      // Ensure sufficient tokens exist to create the order.
+      // await this.ensureFunds(orderEntity)
+      await this.retryQueue.addToQueue(this.ensureFunds, orderEntity)
+
+      // Get Ticker for token ID.
+      // const tokenData = await this.adapters.wallet.bchWallet.getTxData([entryObj.tokenId])
+      const tokenData = await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.getTxData, [entryObj.tokenId])
+      // console.log(`tokenData: ${JSON.stringify(tokenData, null, 2)}`)
+      orderEntity.ticker = tokenData[0].tokenTicker
+
+      // Move the tokens to holding address.
+      const moveObj = {
+        tokenId: orderEntity.tokenId,
+        qty: orderEntity.numTokens
+      }
+      // const utxoInfo = await this.adapters.wallet.moveTokens(moveObj)
+      const utxoInfo = await this.retryQueue.addToQueue(this.adapters.wallet.moveTokens, moveObj)
+      console.log('utxoInfo: ', utxoInfo)
+
+      // Update the UTXO store for the wallet.
+      await this.adapters.wallet.bchWallet.bchjs.Util.sleep(3000)
+      // await this.adapters.wallet.bchWallet.getUtxos()
+      await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.initialize, {})
+
+      // Update the order with the new UTXO information.
+      orderEntity.utxoTxid = utxoInfo.txid
+      orderEntity.utxoVout = utxoInfo.vout
+      orderEntity.tokenType = utxoInfo.tokenType
+
+      // Add P2WDB specific flag for signaling that this is a new offer.
+      orderEntity.dataType = 'offer'
+
+      // Add order to P2WDB.
+      const p2wdbObj = {
+        wif: this.adapters.wallet.bchWallet.walletInfo.privateKey,
+        data: orderEntity,
+        appId: this.config.p2wdbAppId
+      }
+      // const hash = await this.adapters.p2wdb.write(p2wdbObj)
+      const hash = await this.retryQueue.addToQueue(this.adapters.p2wdb.write, p2wdbObj)
+      // console.log('hash: ', hash)
+
+      // Create a MongoDB model to hold the Order
+      orderEntity.hdIndex = utxoInfo.hdIndex
+      orderEntity.p2wdbHash = hash
+
+      console.log(`creating new order model: ${JSON.stringify(orderEntity, null, 2)}`)
+      const order = new this.OrderModel(orderEntity)
+      await order.save()
+
+      return hash
+    } catch (err) {
+      // console.log("Error in use-cases/entry.js/createEntry()", err.message)
+      wlogger.error('Error in use-cases/order.js/createOrder())')
+      console.log('error entryObj: ', entryObj)
+      throw err
+    }
+  }
+
+  // Ensure that the wallet has enough BCH and tokens to complete the requested
+  // trade.
+  async ensureFunds (orderEntity) {
+    try {
+      // console.log('this.adapters.wallet: ', this.adapters.wallet.bchWallet)
+      // console.log(`walletInfo: ${JSON.stringify(this.adapters.wallet.bchWallet.walletInfo, null, 2)}`)
+
+      // Update the wallet balance
+      await this.adapters.wallet.bchWallet.getUtxos()
+      // console.log(`wallet UTXOs: ${JSON.stringify(this.adapters.wallet.bchWallet.utxos.utxoStore, null, 2)}`)
+
+      // Ensure the app wallet has enough funds to write to the P2WDB.
+      const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
+      const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)
+      if (!canWriteToP2WDB) throw new Error('App wallet does not have funds for writing to the P2WDB.')
+
+      // Get UTXOs.
+      const utxos = this.adapters.wallet.bchWallet.utxos.utxoStore
+      // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
+
+      if (orderEntity.buyOrSell.includes('sell')) {
+        // Sell Order
+
+        // Combine Fungible and NFT token UTXOs.
+        let tokenUtxos = utxos.slpUtxos.type1.tokens.concat(utxos.slpUtxos.nft.tokens)
+
+        // Get token UTXOs that match the token in the order.
+        tokenUtxos = tokenUtxos.filter(
+          x => x.tokenId === orderEntity.tokenId
+        )
+        console.log('tokenUtxos: ', tokenUtxos)
+
+        // Get the total amount of tokens in the wallet that match the token
+        // in the order.
+        let totalTokenBalance = 0
+        tokenUtxos.map(x => (totalTokenBalance += parseFloat(x.qtyStr)))
+        console.log('totalTokenBalance: ', totalTokenBalance)
+
+        // If there are fewer tokens in the wallet than what's in the order,
+        // throw an error.
+        if (totalTokenBalance < orderEntity.numTokens || isNaN(totalTokenBalance)) {
+          throw new Error(
+            'App wallet does not have enough tokens to satisfy the SELL order.'
+          )
+        }
+
+      //
+      } else {
+        // Buy Order
+        throw new Error('Buy orders are not supported yet.')
+      }
+
+      return true
+    } catch (err) {
+      console.error('Error in ensureFunds()')
+      throw err
+    }
+  }
+
+  // Retrieve an Order model from the database. Find it by its P2WDB CID.
+  async findOrderByHash (p2wdbHash) {
+    try {
+      if (typeof p2wdbHash !== 'string' || !p2wdbHash) {
+        throw new Error('p2wdbHash must be a string')
+      }
+
+      const order = await this.OrderModel.findOne({ p2wdbHash })
+
+      if (!order) {
+        throw new Error('order not found')
+      }
+
+      const orderObject = order.toObject()
+      // return this.offerEntity.validateFromModel(offerObject)
+
+      return orderObject
+    } catch (err) {
+      console.error('Error in findOrder()')
+      throw err
+    }
+  }
+
+  // This function is called by the garbage collection timer controller. It
+  // checks the UTXO associated with each Order in the database. If the UTXO
+  // has been spent, the Order is deleted from the database.
+  async removeStaleOrders () {
+    try {
+      const now = new Date()
+      console.log(`Starting garbage collection for Orders at ${now.toLocaleString()}`)
+
+      // Get all Orders in the database.
+      const orders = await this.OrderModel.find({})
+      // console.log('orders: ', orders)
+
+      // Loop through each Order and ensure the UTXO is still valid.
+      for (let i = 0; i < orders.length; i++) {
+        const thisOrder = orders[i]
+
+        let utxoStatus = null
+        try {
+          // Get the status of the UTXO associate with this Order.
+          // utxoStatus = await this.adapters.bchjs.Blockchain.getTxOut(
+          //   thisOrder.utxoTxid,
+          //   thisOrder.utxoVout
+          // )
+
+          // Get the status of the UTXO associate with this Order.
+          const utxo = {
+            tx_hash: thisOrder.utxoTxid,
+            tx_pos: thisOrder.utxoVout
+          }
+          // utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
+          utxoStatus = await this.retryQueue.addToQueue(this.adapters.wallet.bchWallet.utxoIsValid, utxo)
+          // console.log('utxoStatus: ', utxoStatus)
+        } catch (err) {
+          // Handle corner case of bad-data in the Order model.
+          if (err.message && err.message.includes('txid needs to be a proper transaction ID')) {
+            console.log(`Deleting Order with bad data: ${JSON.stringify(thisOrder, null, 2)}`)
+            await thisOrder.remove()
+            continue
+          } else if (err.isAxiosError) {
+            console.log('Error trying to contact wallet service: ', err)
+            continue
+          } else {
+            throw err
+          }
+        }
+
+        // If the Order UTXO is spent, delete the Order model.
+        if (utxoStatus === false) {
+          console.log('utxoStatus: ', utxoStatus)
+          console.log(`Spent UTXO detected. Deleting this Order: ${JSON.stringify(thisOrder, null, 2)}`)
+          await thisOrder.remove()
+        }
+      }
+    } catch (err) {
+      console.error('Error in removeStaleOrders()')
+      throw err
+    }
+  }
+
+  async listOrders (page = 0) {
+    try {
+      const data = await this.OrderModel.find({})
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * DEFAULT_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(DEFAULT_ENTRIES_PER_PAGE)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/order/listOrders()')
+      throw error
+    }
+  }
+
+  // Delete an Order model by sending the token back to the root address. This
+  // will allow the garbage collectors to delete the Order and the Offer.
+  async deleteOrder (p2wdbHash) {
+    try {
+      console.log('p2wdbHash: ', p2wdbHash)
+
+      // Find the order by the given hash.
+      const order = await this.findOrderByHash(p2wdbHash)
+      console.log('order: ', order)
+
+      // Reclaim the tokens
+      const txid = await this.adapters.wallet.reclaimTokens(order)
+
+      return txid
+    } catch (err) {
+      console.error('Error in use-cases/order/deleteOrder()')
+      throw err
+    }
+  }
+}
+
+export default OrderLib

src/use-cases/order/index.js

@@ -1,205 +0,0 @@
-/*
-  Use Case library for Orders.
-  Orders are created by a webhook trigger from the P2WDB. Orders are a result of
-  new data in P2WDB. They differ from Offers, which are generated by a local
-  user.
-  An Order is created to match a local Offer, but it's created indirectly, as
-  a response to the webhook from the P2WDB. In this way, Orders generated from
-  local Offers are no different than Orders generated by other peers.
-*/
-
-// Local libraries
-const OrderEntity = require('../../entities/order')
-const config = require('../../../config')
-
-class OrderUseCases {
-  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 Order Use Cases library.'
-      )
-    }
-
-    // Encapsulate dependencies
-    this.config = config
-
-    this.orderEntity = new OrderEntity()
-    this.OrderModel = this.adapters.localdb.Order
-  }
-
-  // This method is called by the POST /order REST API controller, which is
-  // triggered by a P2WDB webhook.
-  async createOrder (orderObj) {
-    try {
-      console.log('Use Case createOrder(orderObj): ', orderObj)
-
-      // console.log('this.adapters.bchjs: ', this.adapters.bchjs)
-
-      // Verify that UTXO in order is unspent. If it is spent, then ignore the
-      // order.
-      const txid = orderObj.data.utxoTxid
-      const vout = orderObj.data.utxoVout
-      const utxoStatus = await this.adapters.bchjs.Blockchain.getTxOut(
-        txid,
-        vout
-      )
-      console.log('utxoStatus: ', utxoStatus)
-      if (utxoStatus === null) return false
-
-      // A new order gets a status of 'posted'
-      orderObj.data.orderStatus = 'posted'
-
-      const orderEntity = this.orderEntity.validate(orderObj)
-      console.log('orderEntity: ', orderEntity)
-
-      // Add order to the local database.
-      const orderModel = new this.OrderModel(orderEntity)
-      await orderModel.save()
-
-      return true
-    } catch (err) {
-      console.error('Error in createOrder()')
-      throw err
-    }
-  }
-
-  async listOrders () {
-    try {
-      return this.OrderModel.find({})
-    } catch (error) {
-      console.error('Error in use-cases/order/listOrders()')
-      throw error
-    }
-  }
-
-  // Generate phase 2 of 3 - take the other side of an Order.
-  // Based on this example:
-  // https://github.com/Permissionless-Software-Foundation/bch-js-examples/blob/master/bch/applications/collaborate/sell-slp/e2e-exchange/step2-purchase-tx.js
-  async takeOrder (orderCid) {
-    try {
-      console.log('orderCid: ', orderCid)
-
-      // Get the Order information
-      const orderInfo = await this.findOrderByHash(orderCid)
-      console.log(`orderInfo: ${JSON.stringify(orderInfo, null, 2)}`)
-
-      // Ensure the order is in a 'posted' state and not already 'taken'
-      if (orderInfo.orderStatus && orderInfo.orderStatus !== 'posted') {
-        throw new Error('order already taken')
-      }
-
-      // Verify that UTXO for sale is unspent. Abort if it's been spent.
-      const txid = orderInfo.utxoTxid
-      const vout = orderInfo.utxoVout
-      const utxoStatus = await this.adapters.bchjs.Blockchain.getTxOut(
-        txid,
-        vout
-      )
-      console.log('utxoStatus: ', utxoStatus)
-      if (utxoStatus === null) {
-        console.log(`utxo txid: ${txid}, vout: ${vout}`)
-        throw new Error('UTXO does not exist. Aborting.')
-      }
-
-      // Ensure the app has enough funds to complete the trade.
-      await this.ensureFunds(orderInfo)
-
-      // Get UTXOs.
-      const utxos = this.adapters.wallet.bchWallet.utxos.utxoStore
-      console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-      // TODO: Move funds to create a segrated UTXO for taking the order
-
-      // Create a partially signed transaction.
-      // https://github.com/Permissionless-Software-Foundation/bch-js-examples/blob/master/bch/applications/collaborate/sell-slp/e2e-exchange/step2-purchase-tx.js#L59
-      const partialTxHex = await this.adapters.wallet.generatePartialTx(orderInfo)
-      // return partialTxHex
-
-      // Create valid Order object
-      const takenOrderInfo = Object.assign({}, orderInfo)
-      takenOrderInfo.patialTxHex = partialTxHex
-      delete takenOrderInfo.p2wdbHash
-      delete takenOrderInfo._id
-      takenOrderInfo.offerHash = orderInfo.p2wdbHash
-
-      // Write order info to the P2WDB
-      // TODO: This will trigger the webhook. Find some way of triggering the
-      // webhook on new orders, but not on counteroffers
-      const p2wdbObj = {
-        wif: this.adapters.wallet.bchWallet.walletInfo.privateKey,
-        data: takenOrderInfo,
-        appId: this.config.p2wdbAppId
-      }
-      const hash = await this.adapters.p2wdb.write(p2wdbObj)
-
-      // Return the P2WDB CID
-      return hash
-    } catch (err) {
-      console.error('Error in use-cases/order/takeOrder(): ', err)
-      throw err
-    }
-  }
-
-  // Ensure that the wallet has enough BCH and tokens to complete the requested
-  // trade. Will return true if it does. Will throw an error if it doesn't.
-  async ensureFunds (orderEntity) {
-    try {
-      // console.log('this.adapters.wallet: ', this.adapters.wallet.bchWallet)
-      // console.log(`walletInfo: ${JSON.stringify(this.adapters.wallet.bchWallet.walletInfo, null, 2)}`)
-
-      await this.adapters.wallet.bchWallet.walletInfoPromise
-
-      // Ensure the app wallet has enough funds to write to the P2WDB.
-      const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
-      const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)
-      if (!canWriteToP2WDB) throw new Error('App wallet does not have funds for writing to the P2WDB.')
-
-      if (orderEntity.buyOrSell.includes('sell')) {
-        // Sell Offer
-
-        // Ensure the app wallet controlls enough BCH to pay for the tokens.
-        const satsNeeded = orderEntity.numTokens * parseInt(orderEntity.rateInSats)
-        const balance = await this.adapters.wallet.bchWallet.getBalance()
-        console.log(`wallet balance: ${balance}, sats needed: ${satsNeeded}`)
-        const SATS_MARGIN = 5000
-        if (satsNeeded + SATS_MARGIN > balance) { throw new Error('App wallet does not control enough BCH to purchase the tokens.') }
-
-      //
-      } else {
-        // Buy Offer
-        throw new Error('Buy orders are not supported yet.')
-      }
-
-      return true
-    } catch (err) {
-      console.error('Error in ensureFunds()')
-      throw err
-    }
-  }
-
-  async findOrderByHash (p2wdbHash) {
-    try {
-      if (typeof p2wdbHash !== 'string' || !p2wdbHash) {
-        throw new Error('p2wdbHash must be a string')
-      }
-
-      const order = await this.OrderModel.findOne({ p2wdbHash })
-
-      if (!order) {
-        throw new Error('order not found')
-      }
-
-      const orderObject = order.toObject()
-      // return this.orderEntity.validateFromModel(orderObject)
-
-      return orderObject
-    } catch (err) {
-      console.error('Error in findOrder(): ', err)
-      throw err
-    }
-  }
-}
-
-module.exports = OrderUseCases