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

fix(debug): Adding debugging conosole.logs to bch-dex

.gitignore

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

.on-save.json

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

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Permissionless Software Foundation Community Contributing Guide 1.0
+
+This document describes a very simple process suitable for most projects under
+the PSF umbrella. It is based on [this Medium article](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951) and the [Node.js Community Contribution Guide](https://github.com/nodejs/TSC/blob/master/BasePolicies/CONTRIBUTING.md).
+Projects are encouraged to adopt this whether they
+are hosted under the PSF or not.
+
+The goal of this document is to create a contribution process that:
+
+* Encourages new contributions.
+* Encourages contributors to remain involved.
+* Avoids unnecessary processes and bureaucracy whenever possible.
+* Creates a transparent decision making process which makes it clear how
+contributors can be involved in decision making.
+
+This document is based on much prior art in the Node.js community, io.js,
+and the Node.js project.
+
+Additional guidance can be found at the [Permissionless Software Foundation Telegram Channel](https://t.me/permissionless_software).
+
+## Vocabulary
+
+* A **Contributor** is any individual creating or commenting on an issue or pull request.
+* A **Committer** is a subset of contributors who have been given write access to the repository.
+* A **TC (Technical Committee)** is a group of committers representing the required technical
+expertise to resolve rare disputes.
+
+# Logging Issues
+
+Log an issue for any question or problem you might have. When in doubt, log an issue,
+any additional policies about what to include will be provided in the responses. The only
+exception is security disclosures which should be sent privately.
+
+Committers may direct you to another repository, ask for additional clarifications, and
+add appropriate metadata before the issue is addressed.
+
+Please be courteous, respectful, and every participant is expected to follow the
+project's Code of Conduct.
+
+# Contributions
+
+Any change to resources in this repository must be through pull requests. This applies to all changes
+to documentation, code, binary files, etc. Even long term committers and TC members must use
+pull requests.
+
+No pull request can be merged without being reviewed.
+
+For non-trivial contributions, pull requests should sit for at least 36 hours to ensure that
+contributors in other timezones have time to review. Consideration should also be given to
+weekends and other holiday periods to ensure active committers all have reasonable time to
+become involved in the discussion and review process if they wish.
+
+The default for each contribution is that it is accepted once no committer has an objection.
+During review committers may also request that a specific contributor who is most versed in a
+particular area gives a "LGTM" before the PR can be merged. There is no additional "sign off"
+process for contributions to land. Once all issues brought by committers are addressed it can
+be landed by any committer.
+
+In the case of an objection being raised in a pull request by another committer, all involved
+committers should seek to arrive at a consensus by way of addressing concerns being expressed
+by discussion, compromise on the proposed change, or withdrawal of the proposed change.
+
+If a contribution is controversial and committers cannot agree about how to get it to land
+or if it should land then it should be escalated to the TC. TC members should regularly
+discuss pending contributions in order to find a resolution. It is expected that only a
+small minority of issues be brought to the TC for resolution and that discussion and
+compromise among committers be the default resolution mechanism.
+
+# Becoming a Committer
+
+All contributors who land a non-trivial contribution should be on-boarded in a timely manner,
+and added as a committer, and be given write access to the repository.
+
+Committers are expected to follow this policy and continue to send pull requests, go through
+proper review, and have other committers merge their pull requests.
+
+# TC Process
+
+The TC uses a "consensus seeking" process for issues that are escalated to the TC.
+The group tries to find a resolution that has no open objections among TC members.
+If a consensus cannot be reached that has no objections then a majority wins vote
+is called. It is also expected that the majority of decisions made by the TC are via
+a consensus seeking process and that voting is only used as a last-resort.
+
+Resolution may involve returning the issue to committers with suggestions on how to
+move forward towards a consensus. It is not expected that a meeting of the TC
+will resolve all issues on its agenda during that meeting and may prefer to continue
+the discussion happening among the committers.
+
+Members can be added to the TC at any time. Any committer can nominate another committer
+to the TC and the TC uses its standard consensus seeking process to evaluate whether or
+not to add this new member. Members who do not participate consistently at the level of
+a majority of the other members are expected to resign.

LICENSE.md

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

PEDIGREE.md

@@ -0,0 +1,3 @@
+# Pedigree
+
+This repository was forked from [koa-api-boilerplate](https://github.com/christroutner/koa-api-boilerplate). Code changes from that upstream repository is frequently pulled in and merged to this repository.

README.md

@@ -2,33 +2,52 @@
 
 [![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)
 
-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 *protocol* for permissionless trading of [SLP tokens](https://github.com/simpleledger/slp-specifications/blob/master/slp-token-type-1.md) and [NFTs](https://github.com/simpleledger/slp-specifications/blob/master/slp-nft-1.md). Trading fees are incredibly small, compared to other DEX platforms. The software is based entirely on open protocols and open source software. `bch-dex` software is maintained by the [Permissionless Software Foundation](https://psfoundation.info).
 
-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 one or more [Nostr relays](https://nostr.com) for trading signals, to trade BCH and SLP tokens. It's inspired by the [SWaP Protocol](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
+
+This repository contains the back end code. The user interface is contained in the [bch-dex-ui-v3](https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v3) repository.
 
 **Warning**: This repository is under active development. Things will be constantly changing and breaking.
 
-### 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/bch_js_toolkit)
+
+## Installation
+Running the DEX requires composition of these different software packages:
+- bch-dex - This repository is the back end software that tracks trade data on the network, generates [Offers and Counter Offers](https://github.com/Permissionless-Software-Foundation/bch-dex/tree/ct-unstable/dev-docs#definitions), and finalizes trades by accepting Counter Offers.
+- [bch-dex-ui-v3](https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v3) web app and user interface (UI) for bch-dex focused on Sellers of tokens.
+- [MongoDB](https://www.mongodb.com/) is a database used by bch-dex to store and manage local data, user accounts, etc.
+
+The above software is orchestrated using [Docker](https://www.docker.com/) and Docker Compose. The target operating system is Ubuntu 20+, and the target hardware is amd64 (normal desktop PCs). Trying to operate this software on other operating systems or hardware is possible, but not supported.
+
+Setup instructions:
+
+1. Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose.
+1. Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`.
+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` folder.
+1. Pull the Docker images down from Docker Hub: `docker-compose pull`
+1. Build the core software: `docker-compose build --no-cache`
+1. Start the Docker containers with `docker-compose up -d`
+1. 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
+
+bch-dex requires a [Cash Stack](https://cashstack.info) back end in order to connect to the blockchain. By default, the Docker containers connect to [free-bch.fullstack.cash](https://free-bch.fullstack.cash/). Several community-provided servers are provided and can be [viewed here](https://consumers.psfoundation.info/consumers.json). The back end can be changed by setting the `CONSUMER_URL` environment variable in the `docker-compose.yml` file.
 
 ## License
 

bin/server.js

@@ -8,55 +8,62 @@
 */
 
 // 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 { usageMiddleware } from '../src/use-cases/usage-use-cases.js'
+// import wlogger from '../src/adapters/wlogger.js'
+import Controllers from '../src/controllers/index.js'
+import { applyPassportMods } from '../config/passport.js'
 
 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.
-      console.log(
-        `Connecting to MongoDB with this connection string: ${config.database}`
-      )
-      await mongoose.connect(config.database, {
-        useUnifiedTopology: true,
-        useNewUrlParser: true
-      })
+      if (!this.config.noMongo) {
+        // Connect to the Mongo Database.
+        this.mongoose.Promise = global.Promise
+        this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+        console.log(
+          `Connecting to MongoDB with this connection string: ${this.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
 
@@ -64,6 +71,7 @@ class Server {
       app.use(bodyParser())
       app.use(session())
       app.use(errorMiddleware())
+      app.use(usageMiddleware())
 
       // Used to generate the docs.
       app.use(mount('/', serve(`${process.cwd()}/docs`)))
@@ -72,7 +80,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,45 +90,64 @@ 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.
-      const success = await this.adminLib.createSystemUser()
-      if (success) console.log('System admin user created.')
+      if (!this.config.noMongo) {
+        // Create the system admin user.
+        const success = await this.adminLib.createSystemUser()
+        if (success) console.log('System admin user created.')
+      }
 
       // 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}`)
+      console.log(`IPFS WebRTC port: ${this.config.ipfsWebRtcPort}`)
+      console.log(`Connection preference: ${this.config.connectPref}\n`)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)
@@ -127,14 +155,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

@@ -1,21 +1,33 @@
 /*
   This file is used to store unsecure, application-specific data common to all
   environments.
+
+  Additional Environent Variables:
+  - CONNECT_PREF: should have a value of 'cr' (default), or 'direct'. This is
+    used by helia-coord to select a connection preference between peers. Servers
+    with an ip4 or ip6 address should use 'direct'.
 */
 
 /* 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 || 5002,
+  port: process.env.PORT || 5700,
 
   // Password for HTML UI that displays logs.
   logPass: 'test',
@@ -36,23 +48,74 @@ 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',
+
+  // Enable or Disable the usage of Mongo DB.
+  noMongo: process.env.NO_MONGO ? true : false,
+
+  // BEGIN WALLET CONFIGURATION
+
+  // BCH Mnemonic for generating encryption keys and payment address
+  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
+
+  // (Optional) use a wallet file generated by psf-bch-wallet.
+  walletFile: process.env.WALLET_FILE
+    ? process.env.WALLET_FILE
+    : `${__dirname.toString()}/../../wallet.json`,
+
+  // Wallet Configuration
+  // Default value: web3 - connect to bch-api through web 3 JSON RPC over IPFS.
+  // Alternate value: web2 - connect to bch-api through a web 2 REST API over HTTP.
+  walletInterface: process.env.WALLET_INTERFACE ? process.env.WALLET_INTERFACE : 'web3',
+
+  // Wallet API Server
+  // Default web2 server: https://api.fullstack.cash/v5/
+  // Default web3 server: https://free-bch.fullstack.cash/
+  apiServer: process.env.WALLET_INTERFACE === 'web2'
+    ? (
+        process.env.APISERVER
+          ? process.env.APISERVER
+          : 'https://api.fullstack.cash/v5/'
+      )
+    : 'https://free-bch.fullstack.cash/',
+
+  // Basic Authentication Password for connecting to bch-api through a web 2
+  // REST API over HTTP.
+  authPass: process.env.WALLET_AUTH_PASS
+    ? process.env.WALLET_AUTH_PASS
+    : '',
 
   // FullStack.cash account information, used for automatic JWT handling.
   getJwtAtStartup: process.env.GET_JWT_AT_STARTUP ? true : false,
   authServer: process.env.AUTHSERVER
     ? process.env.AUTHSERVER
     : 'https://auth.fullstack.cash',
-  apiServer: process.env.APISERVER
-    ? process.env.APISERVER
-    : 'https://api.fullstack.cash/v5/',
   fullstackLogin: process.env.FULLSTACKLOGIN
     ? process.env.FULLSTACKLOGIN
     : 'demo@demo.com',
   fullstackPassword: process.env.FULLSTACKPASS
     ? process.env.FULLSTACKPASS
     : 'demo',
+  // authPass: process.env.FULLSTACK_AUTH_PASS
+  //   ? process.env.FULLSTACK_AUTH_PASS
+  //   : '',
+
+  // END WALLET CONFIGURATION
+
+  // BEGIN IPFS CONFIGURATION
+
+  // Debug verbosity level of helia-coord.
+  // 0 = no debug logs. 3 = maximum logs.
+  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2,
+
+  // Enable/Disable the IPFS node at startup. Enabled by default.
+  // useIpfs: process.env.DISABLE_IPFS ? false : true,
+  useIpfs: false,
 
-  // IPFS settings.
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
   // SSL domain used for websocket connection via browsers.
   crDomain: process.env.CR_DOMAIN ? process.env.CR_DOMAIN : '',
@@ -67,14 +130,16 @@ module.exports = {
     name: ipfsCoordName,
     version,
     protocol: 'generic-service',
-    description:
-      'This is a generic IPFS Serivice Provider that uses JSON RPC over IPFS to communicate with it. This instance has not been customized. Source code: https://github.com/Permissionless-Software-Foundation/ipfs-service-provider',
+    description: 'This is a generic IPFS Serivice Provider that uses JSON RPC over IPFS to communicate with it. This instance has not been customized. Source code: https://github.com/Permissionless-Software-Foundation/ipfs-service-provider',
     documentation: 'https://ipfs-service-provider.fullstack.cash/',
     provider: {
       '@type': 'Organization',
       name: 'Permissionless Software Foundation',
       url: 'https://PSFoundation.cash'
-    }
+    },
+
+    // If this node has an IP4 address or domain name used to provide a REST API.
+    web2Api: process.env.WEB2_API ? process.env.WEB2_API : null
   },
 
   // P2WDB webhook endpoint
@@ -82,21 +147,41 @@ 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,
   ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 4003,
-
-  // 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,
+  ipfsWebRtcPort: process.env.IPFS_WEB_RTC_PORT ? process.env.IPFS_WEB_RTC_PORT : 4005,
+  connectPref: process.env.CONNECT_PREF, // Used in helia-coord to select connection preference.
 
   // Settings for production, using external go-ipfs node.
-  isProduction: process.env.SVC_ENV === 'production' ? true : false,
+  isProduction: process.env.SVC_ENV === 'prod' ? 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://pin.fullstack.cash/ipfs/download/',
+
+  // This can add specific Circuit Relay v2 servers to connect to.
+  bootstrapRelays: [
+    // v2 Circuit Relay (Token Tiger)
+    // '/ip4/137.184.93.145/tcp/8001/p2p/12D3KooWGMEKkdJfyZbwdH9EafZbRTtMn7FnhWPrE4MhRty2763g',
+
+    // v2 Circuit Relay server (FullStack.cash)
+    // '/ip4/78.46.129.7/tcp/4001/p2p/12D3KooWFQ11GQ5NubsJGhYZ4X3wrAGimLevxfm6HPExCrMYhpSL'
+  ],
+
+  // END IPFS CONFIGURATION
+
+  // Nostr
+  nostrRelay: process.env.NOSTR_RELAY ? process.env.NOSTR_RELAY : 'wss://nostr-relay.psfoundation.info',
+  nostrTopic: process.env.NOSTR_TOPIC ? process.env.NOSTR_TOPIC : 'bch-dex-test-topic-01'
 }

config/env/development.js

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

config/env/production.js

@@ -7,12 +7,12 @@
   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',
   database: process.env.DBURL
     ? process.env.DBURL
-    : 'mongodb://172.17.0.1:5555/swap-service-prod',
+    : 'mongodb://172.17.0.1:5555/bch-swap-service-prod',
   env: 'prod'
 }

config/env/test.js

@@ -4,9 +4,10 @@
   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/swap-service-test',
-  env: 'test'
+  database: 'mongodb://localhost:27017/bch-swap-service-test',
+  env: 'test',
+  nostrRelay: 'wss://'
 }

config/index.js

@@ -1,6 +1,17 @@
-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
+}
+
+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,32 @@ async function passportCallback (email, password, done) {
   }
 }
 
-// For testing
-module.exports = { passport, passportCallback }
+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
+}
+
+export { applyPassportMods, passportCallback }

dev-docs/README.md

@@ -10,16 +10,32 @@ There are three major pieces of software behind the bch-dex concept. They work t
 
 ![bch-dex major subcomponents](./diagrams/software-interaction.png)
 
-- _Client_ could be a web browser, or a command-line client like [psf-bch-wallet](https://github.com/Permissionless-Software-Foundation/psf-bch-wallet) or [psf-avax-wallet](https://github.com/Permissionless-Software-Foundation/psf-avax-wallet).
+- _Client_ could be a web browser like [wallet.fullstack.cash](https://bchn-wallet.fullstack.cash), or a command-line client like [psf-bch-wallet](https://github.com/Permissionless-Software-Foundation/psf-bch-wallet) or [psf-avax-wallet](https://github.com/Permissionless-Software-Foundation/psf-avax-wallet).
 - [bch-dex](https://github.com/Permissionless-Software-Foundation/bch-dex) is the back end REST API that maintains a local database of information that the client reads from.
 - [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) is the pay-to-write global database with a REST API for interfacing with the other two pieces of software.
 
 The arrows in the image represent the information flow between the three pieces of software:
 
 - The _Client_ is essentially a 'dummy terminal' with a bidirectional interface to bch-dex. bch-dex does the heavy lifting, and the _Client_ is a 'thin' UI wrapper.
-- `bch-dex` imports data from the global P2WDB database into its local database, using a [webhook](https://en.wikipedia.org/wiki/Webhook) (dashed line). It can also custody funds, pay transaction fees, and create an _Offer_ by submitting the data to the P2WDB to generate an _Order_ (solid line).
+- `bch-dex` imports data from the global P2WDB database into its local database, using a [webhook](https://en.wikipedia.org/wiki/Webhook) (dashed line). It can also custody funds, pay transaction fees, and create an _Offer_ by creating an _Order_ and submitting the data to the P2WDB (solid line).
 
-This architecture keeps the global database highly censorship resistant, while allowing local installations to maintain tight control over the user experience. The goal is to have many redundant copies of `bch-dex` on the network, and to empower individual traders to run their own, private copy.
+This architecture keeps the global database highly censorship resistant, while allowing local installations to maintain tight control over the user experience. The goal is to have many redundant copies of `bch-dex` on the network, and to empower individual traders to run their own, private copy, while maintaining a single source of truth via the P2WDB.
+
+# Definitions
+
+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 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*:
+- **Trustless** - This means that neither party needs to trust the other. The *Maker* gets to review the *Counter Offer* before broadcasting it. The *Maker* can not alter the *Counter Offer* after the *Taker* has signed it.
+- **Atomic** - The trade happens in a single transaction. There is no middle-state where the trade can get stuck. It either happens or doesn't, it's state is binary and atomic.
+
+Specific *Entities* are defined in the [specification](./specification.md), but here is a brief summary:
+- **Order** represents the *Maker* side of the trade. This entity is internal to `bch-dex`. It is used to track tokens set aside for sale and managed by the wallet controlled by `bch-dex`.
+- **Offer** contains most of the same information as an **Order**, but is external to `bch-dex`. This is data submitted to the P2WDB and visible to all users on the network.
+- **Counter Offer** is generated by a *Taker*, in order to take the other side of the trade. It contains a partially-signed transaction, ready for review by the *Maker*.
 
 # Back End
 
@@ -45,19 +61,39 @@ This section describes the protocols for the database interactions between the t
 
 These are just a brief, high-level overview. Review the [Specifications](./specification.md) for more details.
 
-## Writing to the Global Database
+## Reading from the Local Database
 
-Adding data to the global P2WDB is triggered by the _Client_ calling a REST API endpoint on `bch-dex`. `bch-dex` [p2wdb npm library](https://www.npmjs.com/package/p2wdb) can be leveraged for easy reading and writing to the P2WDB.
+The *Client* reads data from the local database stored by `bch-dex`, and does not read the P2WDB global database directly. This gives `bch-dex` the opportunity to filter and modify the data locally, for a more controlled user experience.
+
+## Making an Offer
+
+Adding data to the global P2WDB is triggered by the _Client_ calling a REST API endpoint on `bch-dex`. The [p2wdb npm library](https://www.npmjs.com/package/p2wdb) can be leveraged for easy reading and writing to the P2WDB.
 
 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 `/offer` REST API endpoint to create a new Offer.
-- `bch-dex` will move the funds into a segregated UTXO, and will use that UTXO to create an Offer. The Offer data is written to the P2WDB.
-- `bch-dex` will receive a webhook call to its POST `/order` endpoint by the P2WDB. This event will trigger the import of the new data into the apps local Mongo database, and generate a new Order 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.
+- 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 `/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
 
-## Reading from the Local Database
+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 *Client* reads data from the local database stored by `bch-dex`, and does not read the P2WDB global database directly. This gives `bch-dex` the opportunity to filter and modify the data locally, for a more controlled user experience.
+- 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 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
+
+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
+
+Occasional maintenance functions will be called by an interval timer. The primary purpose of these functions is to check the UTXOs in the Order, Offer, and Counter Offer entities. If any of these UTXOs are spent, the entity is deleted from the local Mongo database.

dev-docs/specification.md

@@ -15,63 +15,105 @@ Entities make up the core business concepts. If these entities change, they fund
 
 ### Order
 
-An order is created from data passed to the app by the P2WDB webhook.
-It is destroyed when the UTXO described in the Signal has been detected as spent.
+An Order Entity is nearly the same as an Offer. The Order is generated first, but is always internal to the bch-dex system. Most of the data in an Order is submitted to the P2WDB, which generates an Offer (external) Entity.
+
+The Order tracks the [HD index address](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch05.asciidoc#hd-wallets-bip-32bip-44) used to hold tokens or BCH for sale. This is the part of the app concerned with the custody of the funds. It creates a segregated [UTXO](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch06.asciidoc#transaction-outputs-and-inputs) to hold the offered asset. The Order is automatically destroyed if the UTXO is spent.
 
 Order entities have the following properties:
 
-- _tokenId_ - The unique ID that identifies the class of token being offered for sale.
-- _buyOrSell_ - A string with a value `buy` or `sell` indicating which type of offer this is.
-- _rateInSats_ - The rate in terms of tokens-per-currency-unit.
-  - For Bitcoin, the min currency is sats.
-  - For AVAX, the min currency is nano-Avax.
-  - for eCash, the min currency is bits.
-- _minSatsToExchange_ - The minimum order size accepted.
-- _signature_ - A message signed by the address which created the order.
-- _sigMsg_ - The clear-text message used to generate the signature.
-- _utxoTxid_ - The TXID of the UTXO used in the order.
-- _utxoVout_ - The vout of the UTXO used in the order.
-- _numTokens_ - The maximum number of tokens offered for sale.
-- _timestamp_ - The ISO time when the order was created.
-- _localTimestamp_ - The localized time when the order was created.
-- _p2wdbTxid_ - The TXID proof-of-burn used to add the order to the P2WDB.
-- _p2wdbHash_ - The hash used to identify the order entry in the P2WDB.
-- _lokadId_ - Not used. Provided for future functionality.
-- _messageType_ - Not used. Provided for future functionality.
-- _messageClass_ - Not used. Provided for future functionality.
+- Token Data:
+  - _tokenId_ - The unique ID that identifies the class of token being offered for sale.
+  - _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.
+  - _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.
+
+- 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.
+
 
 ### Offer
 
-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 and managed by this application.
-
-The Offer tracks the [HD index address](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch05.asciidoc#hd-wallets-bip-32bip-44) used to hold tokens or BCH for sale. This is the part of the app concerned with the custody of the funds. It creates a segregated [UTXO](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch06.asciidoc#transaction-outputs-and-inputs) to hold the offered asset. The Offer is automatically destroyed if the UTXO is spent.
+An offer is created from data passed to the app by the P2WDB webhook.
+It is destroyed when the UTXO described in the Signal has been detected as spent.
 
 Offer entities have the following properties:
 
-- _offerIpfsId_ - The IPFS ID of the instance of `ipfs-swap-service` that is managing the offer.
-- _offerBchAddr_ - The BCH address controlling the offer.
-- _offerPubKey_ - The public key used to generate the BCH address, used for encryption.
-- _tokenId_ - The unique ID that identifies the class of token being offered for sale.
-- _buyOrSell_ - A string with a value `buy` or `sell` indicating which type of offer this is.
-- _rateInSats_ - The rate in terms of tokens-per-currency-unit.
-  - For Bitcoin, the min currency is sats.
-  - For AVAX, the min currency is nano-Avax.
-  - for eCash, the min currency is bits.
-- _minSatsToExchange_ - The minimum order size accepted.
-- _signature_ - A message signed by the address which created the order.
-- _sigMsg_ - The clear-text message used to generate the signature.
-- _utxoTxid_ - The TXID of the UTXO used in the order.
-- _utxoVout_ - The vout of the UTXO used in the order.
-- _numTokens_ - The maximum number of tokens offered for sale.
-- _timestamp_ - The ISO time when the order was created.
-- _localTimestamp_ - The localized time when the order was created.
-- _p2wdbTxid_ - The TXID proof-of-burn used to add the order to the P2WDB.
-- _p2wdbHash_ - The hash used to identify the order entry in the P2WDB.
-- _lokadId_ - Not used. Provided for future functionality.
-- _messageType_ - Not used. Provided for future functionality.
-- _messageClass_ - Not used. Provided for future functionality.
+- Token Data:
+  - _tokenId_ - The unique ID that identifies the class of token being offered for sale.
+  - _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.
+  - _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.
+  - _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.
+
+- Utility Data:
+  - _timestamp_ - The ISO time when the order was created.
+  - _localTimestamp_ - The localized time when the order was created.
+
+- SWaP Protocol properties:
+  - _lokadId_ - Not used. Provided for future functionality.
+  - _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 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`
+
 
 ## Use Cases
 
@@ -79,13 +121,18 @@ Use cases are verbs or actions that is done _to_ an Entity or _between_ Entities
 
 ### Order
 
-- **`createOrder()`** - 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.
+- **`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.
+- **`findOrderByHash()`** - Given a P2WDB CID 'hash', this function will return the corresponding Order model associated with that CID.
 
 ### Offer
 
-- **`ensureFunds()`** - Ensure that the wallet has enough BCH and tokens to complete the requested trade.
-- **`moveTokens()`** - Move the tokens indicated in the offer 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.
-- **`createOffer()`** - A macro command that leverages `ensureFunds()` and `moveTokens()`, to create a new Offer and submit it to the P2WDB.
+- **`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
 
@@ -93,15 +140,32 @@ Controllers are inputs to the system. When a controller is activated, it causes
 
 ### Orders
 
-- **POST /order** - 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.
+- **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
 
-- **POST /offer** - This POST REST API endpoint can be triggered by the Client or a simple curl call. It passes in the data needed for `ipfs-swap-service` to generate and track a new Offer, then submit the data to the P2WDB to generate an Order that is tracked by all other instances of `ipfs-swap-service`.
+- **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,8 @@
-const Server = require('./bin/server.js')
+import Server from './bin/server.js'
 const server = new Server()
 
+process.on('unhandledRejection', (reason, promise) => {
+  console.log(`Handling ${reason.code} error. stack: `, reason)
+})
+
 server.startServer()

package.json

@@ -1,20 +1,21 @@
 {
   "name": "bch-dex",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "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:integration": "export BCH_DEX=test && mocha --exit --timeout 30000 --recursive test/integration",
+    "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,35 @@
   },
   "repository": "Permissionless-Software-Foundation/bch-dex",
   "dependencies": {
-    "@psf/bch-js": "5.3.2",
-    "axios": "0.21.1",
-    "bch-message-lib": "2.1.4",
+    "@chainsafe/libp2p-gossipsub": "14.1.0",
+    "@chainsafe/libp2p-noise": "16.0.1",
+    "@chainsafe/libp2p-yamux": "7.0.1",
+    "@chris.troutner/retry-queue": "1.0.8",
+    "@helia/unixfs": "4.0.2",
+    "@libp2p/bootstrap": "11.0.26",
+    "@libp2p/circuit-relay-v2": "3.2.2",
+    "@libp2p/config": "1.1.0",
+    "@libp2p/identify": "3.0.22",
+    "@libp2p/keychain": "5.0.14",
+    "@libp2p/logger": "5.1.8",
+    "@libp2p/ping": "2.0.22",
+    "@libp2p/tcp": "10.1.2",
+    "@libp2p/webrtc": "5.2.2",
+    "@libp2p/websockets": "9.2.2",
+    "@multiformats/multiaddr": "12.3.5",
+    "axios": "0.27.2",
+    "bch-message-lib": "2.2.1",
+    "bch-nostr": "1.3.3",
+    "bch-token-sweep": "2.2.1",
     "bcryptjs": "2.4.3",
+    "bitcoincashjs-lib": "3.3.3",    
+    "blockstore-fs": "2.0.2",
+    "datastore-fs": "10.0.2",
     "glob": "7.1.6",
-    "ipfs": "0.60.0",
-    "ipfs-coord": "6.8.12",
-    "ipfs-http-client": "55.0.0",
+    "helia": "5.2.1",
+    "helia-coord": "1.7.2",
+    "ipfs-coord-esm": "9.1.7",
+    "ipfs-http-client": "58.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -49,34 +71,30 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "^0.36.2",
+    "libp2p": "2.7.2",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "../minimal-slp-wallet",
-    "mongoose": "5.13.13",
+    "minimal-slp-wallet": "5.13.2",
+    "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
-    "nodemailer": "6.4.17",
+    "nodemailer": "6.7.5",
+    "nostr-tools": "2.10.4",
+    "p2wdb-esm": "2.2.9",
     "passport-local": "1.0.0",
-    "public-ip": "^4.0.4",
+    "public-ip": "6.0.1",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "0.26.0",
+    "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",
+    "lodash.clonedeep": "4.5.0",
+    "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/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=bch-dex

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_20.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

@@ -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_20.x -o nodesource_setup.sh
 RUN bash nodesource_setup.sh
 RUN apt-get install -y nodejs build-essential
 
@@ -34,7 +34,7 @@ WORKDIR /home/safeuser
 
 # Update to the latest version of npm.
 #RUN npm install -g npm@7.23.0
-RUN npm install -g npm
+#RUN npm install -g npm
 
 # npm mirror to prevent direct dependency on npm.
 RUN npm set registry http://94.130.170.209:4873/
@@ -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,19 @@ 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
 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

@@ -2,13 +2,8 @@
 
 # BEGIN: Optional configuration settings
 
-# 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"
-
 # The human readable name this IPFS node identifies as.
-export COORD_NAME=ipfs-service-provider-generic
+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
@@ -17,22 +12,23 @@ 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
+export DEBUG_LEVEL=1
 
 # 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/bch-swap-service-prod
 
 # Configure REST API port
-export PORT=5010
+export PORT=5700
 
-# Production settings using external go-ipfs node.
-export SVC_ENV=production
-export IPFS_HOST=172.17.0.1
-export IPFS_API_PORT=5001
-export IPFS_TCP_PORT=4001
-#export IPFS_WS_PORT=5269
+# 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,59 +3,63 @@
 version: '3.9'
 
 services:
-  mongo-ipfs-service:
-    image: mongo
-    container_name: mongo-ipfs-service
+  mongo-dex:
+    image: mongo:4.2.0
+    container_name: mongo-dex
     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
-    container_name: ipfs
+  bch-dex:
+    build:
+      context: ./bch-dex/
+      dockerfile: Dockerfile
+    #image: christroutner/bch-dex:v2.2.4
+    container_name: bch-dex
     environment:
-      MY_ENV_VAR: 'placeholder'
+      CONSUMER_URL: 'https://free-bch.fullstack.cash'
     logging:
       driver: 'json-file'
       options:
         max-size: '10m'
         max-file: '10'
-    mem_limit: 2000mb
+    mem_limit: 1000mb
+    links:
+      - mongo-dex
+      #- p2wdb
     ports:
-      - 4001:4001
-      - 172.17.0.1:5001:5001
-      - 172.17.0.1:8080:8080
+      # <host port>:<container port>
+      - '5700:5700' # REST API
+      - '4001:4001' # TCP
+      - '4003:4003' # Websockets
+      - '4005:4005' # WebRTC
+
     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'
-      ]
+      - ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
+      - ./bch-dex/start-production.sh:/home/safeuser/bch-dex/start-production.sh
     restart: always
 
-  ipfs-service:
-    build: .
-    container_name: ipfs-service
+  dex-ui:
+    build:
+      context: ./bch-dex-ui/
+      dockerfile: Dockerfile
+    #image: christroutner/bch-dex-ui:v1.2.4
+    container_name: dex-ui
+    environment:
+      SERVER: 'http://172.17.0.1'
     logging:
       driver: 'json-file'
       options:
         max-size: '10m'
         max-file: '10'
-    mem_limit: 500mb
+    mem_limit: 1000mb
     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/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

@@ -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
+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 sudo apt-get install -y ca-certificates curl gnupg
+RUN sudo mkdir -p /etc/apt/keyrings
+RUN curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+RUN echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
+RUN sudo apt-get update
+RUN sudo 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 master
+
+# Install dependencies
+#RUN mkdir .ipfsdata
+#RUN npm install -g @mapbox/node-pre-gyp
+RUN npm install
+
+# Generate the API docs
+RUN npm run docs
+
+# Start the application.
+#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,54 @@
+#!/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
+export IPFS_WEB_RTC_PORT=4005
+# Set the debug level for helia-coord. 0-3.
+# 0 = no debug logs. 3 = maximum debug logs.
+export DEBUG_LEVEL=0
+
+# Use this if the IPFS node has a publically accessible IP address.
+#export CONNECT_PREF=direct
+# Use this if the IPFS node is behind a NAT or Firewall and cannot be accessed directly.
+export CONNECT_PREF=cr
+
+npm start

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
+  }
+}

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

@@ -13,7 +13,7 @@ export COORD_NAME=ipfs-service-provider-generic
 export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
 
 # 0 = less verbose. 3 = most verbose
-export DEBUG_LEVEL=2
+export DEBUG_LEVEL=0
 
 # Production settings that use external IPFS node.
 # https://github.com/christroutner/docker-ipfs

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,25 @@
 */
 
 // 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')
+import JSONFiles from './json-files.js'
+import FullStackJWT from './fullstack-jwt.js'
+import config from '../../config/index.js'
+// import Wallet from './wallet.adapter.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
-
-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'
+import NostrAdapter from './nostr.js'
 
 class Adapters {
   constructor (localConfig = {}) {
@@ -52,10 +35,16 @@ class Adapters {
     this.nodemailer = new Nodemailer()
     this.jsonFiles = new JSONFiles()
     this.bchjs = new BCHJS()
+    localConfig.bchjs = this.bchjs
     this.bch = new BCHAdapter()
     this.config = config
     this.wallet = new WalletAdapter()
-    this.p2wdb = new P2wdbAdapter()
+    localConfig.bchWallet = this.wallet.bchWallet
+    this.p2wdb = new P2wdbAdapter(localConfig)
+    this.webhook = new Webhook()
+    this.nostr = new NostrAdapter(this.config)
+
+    // this.wallet = new Wallet(localConfig)
 
     // Get a valid JWT API key and instance bch-js.
     this.fullStackJwt = new FullStackJWT(config)
@@ -63,23 +52,56 @@ class Adapters {
 
   async start () {
     try {
+      // let apiToken
       if (this.config.getJwtAtStartup) {
         // Get a JWT token and instantiate bch-js with it. Then pass that instance
         // to all the rest of the apps controllers and adapters.
-        await this.fullStackJwt.getJWT()
+        // apiToken = await this.fullStackJwt.getJWT()
         // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
         this.bchjs = await this.fullStackJwt.instanceBchjs()
       }
 
+      // Create a default instance of minimal-slp-wallet without initializing it
+      // (without retrieving the wallets UTXOs). This instance will be overwritten
+      // if the operator has configured BCH payments.
+      console.log('\nCreating default startup wallet. This wallet may be overwritten.')
+      // await this.wallet.instanceWalletWithoutInitialization({}, { apiToken })
+      this.bchjs = this.wallet.bchWallet.bchjs
+
       // 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()
+      await this.nostr.start(walletData.privateKey)
+
       // 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
+
+        if (this.config.useIpfs) {
+          await this.ipfs.start()
+        }
+      } else {
+        // These lines are here to ensure code coverage hits 100%.
+        console.log('Not starting IPFS node since this is an e2e test.')
+      }
+
+      console.log('Async Adapters have been started.')
+
+      return true
     } catch (err) {
       console.error('Error in adapters/index.js/start()')
       throw err
@@ -87,4 +109,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()')
@@ -49,6 +58,140 @@ class IPFS {
       throw err
     }
   }
+
+  // Get the status of this IPFS node.
+  // Create an object with different metrics about this IPFS node, then return
+  // the object.
+  getStatus () {
+    try {
+      const statusObj = {
+        ipfsId: this.ipfsCoordAdapter.ipfsCoord.thisNode.ipfsId,
+        multiAddrs: this.ipfsCoordAdapter.ipfsCoord.thisNode.ipfsMultiaddrs,
+        bchAddr: this.ipfsCoordAdapter.ipfsCoord.thisNode.bchAddr,
+        slpAddr: this.ipfsCoordAdapter.ipfsCoord.thisNode.slpAddr,
+        pubKey: this.ipfsCoordAdapter.ipfsCoord.thisNode.pubKey,
+        peers: this.ipfsCoordAdapter.ipfsCoord.thisNode.peerList.length,
+        relays: this.ipfsCoordAdapter.ipfsCoord.thisNode.relayData.length
+      }
+
+      return statusObj
+    } catch (err) {
+      console.error('Error in ipfs-coord.js/getStatus()')
+      throw err
+    }
+  }
+
+  // Get details on the other peers this node is connected to.
+  async getPeers (showAll) {
+    try {
+      const peerData = this.ipfsCoordAdapter.ipfsCoord.thisNode.peerData
+      // console.log(`peerData: ${JSON.stringify(peerData, null, 2)}`)
+
+      let ipfsPeers =
+        await this.ipfsCoordAdapter.ipfsCoord.adapters.ipfs.getPeers()
+      // console.log('ipfsPeers: ', ipfsPeers)
+
+      ipfsPeers = this._removeDuplicatePeers(ipfsPeers)
+      // console.log('filtered ipfsPeers: ', ipfsPeers)
+
+      const peerDataOut = []
+
+      // Loop through each IPFS peer and hydrate it with data from the peerData.
+      for (let i = 0; i < ipfsPeers.length; i++) {
+        const thisPeer = {
+          peer: ipfsPeers[i]
+        }
+
+        // if (!showAll) {
+        //   // Delete properties that don't contain good info.
+        //   delete thisPeer.muxer
+        //   delete thisPeer.latency
+        //   delete thisPeer.streams
+        // }
+
+        // Get the ipfs-coord peer data for this peer.
+        let thisPeerData = peerData.filter((x) =>
+          x.from.includes(thisPeer.peer)
+        )
+        thisPeerData = thisPeerData[0]
+        // console.log('thisPeerData: ', thisPeerData)
+
+        // Skip if peerData for this IPFS peer could not be found.
+        // if (!thisPeerData) continue
+
+        try {
+          // console.log('thisPeerData: ', thisPeerData)
+
+          // Add data to the IPFS peer data.
+          thisPeer.name = thisPeerData.data.jsonLd.name
+          thisPeer.protocol = thisPeerData.data.jsonLd.protocol
+          thisPeer.version = thisPeerData.data.jsonLd.version
+          thisPeer.connectionAddr = thisPeerData.data.connectionAddr
+
+          if (showAll) {
+            // Add all the peer data.
+            thisPeer.peerData = thisPeerData
+          }
+        } catch (err) {
+          console.warn(
+            `warning: ${thisPeer.peer}: ${err.message}`
+          )
+        }
+
+        peerDataOut.push(thisPeer)
+      }
+
+      return peerDataOut
+    } catch (err) {
+      console.error('Error in getPeers(): ', err)
+      throw err
+    }
+  }
+
+  // Expects an array of peers and returns an array of peers with duplicates
+  // removed.
+  // This function is used by getPeers()
+  _removeDuplicatePeers (arr) {
+    // https://stackoverflow.com/questions/2218999/how-to-remove-all-duplicates-from-an-array-of-objects
+    return arr.filter((v, i, a) => a.findIndex((t) => t === v) === i)
+  }
+
+  // Get data about the known Circuit Relays. Hydrate with data from peers list.
+  getRelays () {
+    try {
+      const relayData = this.ipfsCoordAdapter.ipfsCoord.thisNode.relayData
+      const peerData = this.ipfsCoordAdapter.ipfsCoord.thisNode.peerData
+      // console.log(`relayData: ${JSON.stringify(relayData, null, 2)}`)
+      // console.log(`peerData: ${JSON.stringify(peerData, null, 2)}`)
+
+      for (let i = 0; i < relayData.length; i++) {
+        const thisRelay = relayData[i]
+
+        // Find the peer that corresponds to this relay.
+        const thisPeer = peerData.filter((x) =>
+          x.from.includes(thisRelay.ipfsId)
+        )
+        // console.log('thisPeer: ', thisPeer)
+
+        // If the peer couldn't be found, skip.
+        if (!thisPeer.length) {
+          thisRelay.name = ''
+          thisRelay.description = ''
+          continue
+        }
+
+        thisRelay.name = thisPeer[0].data.jsonLd.name
+        thisRelay.description = thisPeer[0].data.jsonLd.description
+      }
+
+      const v1Relays = this.config.v1Relays
+
+      return { v2Relays: relayData, v1Relays }
+    } catch (err) {
+      console.error('Error in getRelays(): ', err)
+      throw err
+    }
+  }
 }
 
-module.exports = IPFS
+export default IPFS

src/adapters/ipfs/ipfs-coord.js

@@ -5,12 +5,16 @@
 */
 
 // 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 IpfsCoord from 'helia-coord'
+
+// import BCHJS from '@psf/bch-js';
+import SlpWallet from 'minimal-slp-wallet'
+import { publicIpv4 } from 'public-ip'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+
 // const JSONRPC = require('../../controllers/json-rpc/')
 
 let _this
@@ -28,9 +32,10 @@ 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
+    this.publicIp = publicIpv4
 
     // Properties of this class instance.
     this.isReady = false
@@ -41,10 +46,13 @@ 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 {
-        const ip4 = await this.publicIp.v4()
+        const ip4 = await this.publicIp()
         // const ip6 = await publicIp.v6()
 
         circuitRelayInfo.ip4 = ip4
@@ -57,23 +65,28 @@ class IpfsCoordAdapter {
       }
     }
 
+    const nullLog = () => {}
+
     const ipfsCoordOptions = {
       ipfs: this.ipfs,
       type: 'node.js',
       // type: 'browser',
-      bchjs: this.bchjs,
-      privateLog: console.log, // Default to console.log
+      wallet: this.wallet,
+      // privateLog: console.log, // Default to console.log
+      privateLog: nullLog,
       isCircuitRelay: this.config.isCircuitRelay,
       circuitRelayInfo,
       apiInfo: this.config.apiInfo,
       announceJsonLd: this.config.announceJsonLd,
-      debugLevel: this.config.debugLevel
+      debugLevel: this.config.debugLevel,
+      v1Relays: this.config.v1Relays,
+      tcpPort: this.config.ipfsTcpPort
     }
 
     // Production env uses external go-ipfs node.
-    if (this.config.isProduction) {
-      ipfsCoordOptions.nodeType = 'external'
-    }
+    // if (this.config.isProduction) {
+    //   ipfsCoordOptions.nodeType = 'external'
+    // }
 
     this.ipfsCoord = new this.IpfsCoord(ipfsCoordOptions)
 
@@ -91,12 +104,24 @@ class IpfsCoordAdapter {
   attachRPCRouter (router) {
     try {
       _this.ipfsCoord.privateLog = router
-      _this.ipfsCoord.adapters.orbit.privateLog = router
+      _this.ipfsCoord.adapters.pubsub.privateLog = router
     } catch (err) {
       console.error('Error in attachRPCRouter()')
       throw err
     }
   }
+
+  // Subscribe to the chat pubsub channel
+  async subscribeToChat () {
+    // TODO: Allow user to replace nullog with their own log handler at startup.
+    const nullLog = () => {}
+
+    await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
+      this.config.chatPubSubChan,
+      nullLog,
+      this.ipfsCoord.thisNode
+    )
+  }
 }
 
-module.exports = IpfsCoordAdapter
+export default IpfsCoordAdapter

src/adapters/ipfs/ipfs.js

@@ -9,102 +9,205 @@
 */
 
 // 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 { createHelia } from 'helia'
+import fs from 'fs'
+import { FsBlockstore } from 'blockstore-fs'
+import { FsDatastore } from 'datastore-fs'
+import { createLibp2p } from 'libp2p'
+import { tcp } from '@libp2p/tcp'
+import { noise } from '@chainsafe/libp2p-noise'
+import { yamux } from '@chainsafe/libp2p-yamux'
+// import { bootstrap } from '@libp2p/bootstrap'
+// import { identifyService } from 'libp2p/identify'
+import { identify, identifyPush } from '@libp2p/identify'
+import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+// import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+import { gossipsub } from '@chainsafe/libp2p-gossipsub'
+import { webSockets } from '@libp2p/websockets'
+import { publicIpv4 } from 'public-ip'
+import { multiaddr } from '@multiformats/multiaddr'
+import { webRTC, webRTCDirect } from '@libp2p/webrtc'
+import { keychain } from '@libp2p/keychain'
+import { unixfs } from '@helia/unixfs'
+// import { generateKeyPairFromSeed } from '@libp2p/crypto/keys'
+// import crypto from 'crypto'
+import { ping } from '@libp2p/ping'
+import { loadOrCreateSelfKey } from '@libp2p/config'
 
 // Local libraries
-const config = require('../../../config')
+import config from '../../../config/index.js'
+import JsonFiles from '../json-files.js'
 
-const IPFS_DIR = './.ipfsdata/ipfs'
+// 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))
+// console.log('__dirname: ', __dirname)
+
+const ROOT_DIR = `${__dirname}../../../`
+const IPFS_DIR = `${__dirname}../../../.ipfsdata/ipfs`
 
 class IpfsAdapter {
   constructor (localConfig) {
     // Encapsulate dependencies
     this.config = config
-
-    // Choose the IPFS constructor based on the config settings.
-    this.IPFS = IPFSembedded // default
-    if (this.config.isProduction) {
-      this.IPFS = IPFSexternal
-    }
+    this.fs = fs
+    this.createLibp2p = createLibp2p
+    this.publicIp = publicIpv4
+    this.multiaddr = multiaddr
+    this.jsonFiles = new JsonFiles()
+    this.keychain = keychain
+    this.createHelia = createHelia
 
     // Properties of this class instance.
     this.isReady = false
 
-    this.fs = fs
+    // Bind 'this' object to all subfunctions
+    this.start = this.start.bind(this)
+    this.createNode = this.createNode.bind(this)
+    this.stop = this.stop.bind(this)
+    this.ensureBlocksDir = this.ensureBlocksDir.bind(this)
+    // this.getPrivateKey = this.getPrivateKey.bind(this)
+    this.getSeed = this.getSeed.bind(this)
   }
 
   // Start an IPFS node.
   async start () {
     try {
-      // Ipfs Options
-      const ipfsOptionsEmbedded = {
-        repo: IPFS_DIR,
-        start: true,
-        config: {
-          relay: {
-            enabled: true, // enable circuit relay dialer and listener
-            hop: {
-              enabled: config.isCircuitRelay // enable circuit relay HOP (make this node a relay)
-            }
-          },
-          pubsub: true, // enable pubsub
-          Swarm: {
-            ConnMgr: {
-              HighWater: 30,
-              LowWater: 10
-            }
-          },
-          Addresses: {
-            Swarm: [
-              `/ip4/0.0.0.0/tcp/${this.config.ipfsTcpPort}`,
-              `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`
-            ]
-          },
-          Datastore: {
-            StorageMax: '2GB',
-            StorageGCWatermark: 50,
-            GCPeriod: '15m'
-          }
-        }
-      }
+      // Ensure the directory structure exists that is needed by the IPFS node to store data.
+      this.ensureBlocksDir()
 
-      const ipfsOptionsExternal = {
-        host: this.config.ipfsHost,
-        port: this.config.ipfsApiPort,
-        agent: http.Agent({ keepAlive: true, maxSockets: 2000 })
-      }
+      // Create an IPFS node
+      const ipfs = await this.createNode()
+      // console.log('ipfs: ', ipfs)
 
-      let ipfsOptions = ipfsOptionsEmbedded
-      if (this.config.isProduction) {
-        ipfsOptions = ipfsOptionsExternal
-      }
+      this.id = ipfs.libp2p.peerId.toString()
+      console.log('IPFS ID: ', this.id)
 
-      // Create a new IPFS node.
-      this.ipfs = await this.IPFS.create(ipfsOptions)
+      // Attempt to guess our ip4 IP address.
+      const ip4 = await this.publicIp()
+      let detectedMultiaddr = `/ip4/${ip4}/tcp/${this.config.ipfsTcpPort}/p2p/${this.id}`
+      detectedMultiaddr = this.multiaddr(detectedMultiaddr)
 
-      // Set the 'server' profile so the node does not scan private networks.
-      await this.ipfs.config.profiles.apply('server')
+      // Get the multiaddrs for the node.
+      const multiaddrs = ipfs.libp2p.getMultiaddrs()
+      multiaddrs.push(detectedMultiaddr)
+      console.log('Multiaddrs: ', multiaddrs)
 
-      // Debugging: Display IPFS config settings.
-      // const configSettings = await this.ipfs.config.getAll()
-      // console.log(`configSettings: ${JSON.stringify(configSettings, null, 2)}`)
+      this.multiaddrs = multiaddrs
 
       // Signal that this adapter is ready.
       this.isReady = true
 
+      this.ipfs = ipfs
+
       return this.ipfs
     } catch (err) {
       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
+    }
+  }
+
+  // This function creates an IPFS node using Helia.
+  // It returns the node as an object.
+  async createNode () {
+    try {
+      // Create block and data stores.
+      const blockstore = new FsBlockstore(`${IPFS_DIR}/blockstore`)
+      const datastore = new FsDatastore(`${IPFS_DIR}/datastore`)
+
+      // Get the private key.
+      // const privateKey = await this.getPrivateKey()
+      // console.log('privateKey: ', privateKey)
+
+      // Create an identity
+      const keychainInit = {
+        selfKey: 'myKey',
+        pass: await this.getSeed()
       }
+      const privateKey = await loadOrCreateSelfKey(datastore, keychainInit)
+
+      // Configure services
+      const services = {
+        identify: identify(),
+        identifyPush: identifyPush(),
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }),
+        ping: ping(),
+        keychain: keychain(keychainInit)
+      }
+      if (this.config.isCircuitRelay) {
+        console.log('Helia (IPFS) node IS configured as Circuit Relay')
+        services.relay = circuitRelayServer({ // makes the node function as a relay server
+          hopTimeout: 30 * 1000, // incoming relay requests must be resolved within this time limit
+          reservations: {
+            maxReservations: 15, // how many peers are allowed to reserve relay slots on this server
+            reservationClearInterval: 300 * 1000, // how often to reclaim stale reservations
+            applyDefaultLimit: true, // whether to apply default data/duration limits to each relayed connection
+            defaultDurationLimit: 2 * 60 * 1000, // the default maximum amount of time a relayed connection can be open for
+            defaultDataLimit: BigInt(2 << 7) // the default maximum number of bytes that can be transferred over a relayed connection
+          },
+          maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
+          maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
+        })
+      } else {
+        console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
+      }
+
+      const transports = [
+        tcp(),
+        webSockets(),
+        circuitRelayTransport({
+          discoverRelays: 3,
+          reservationConcurrency: 3
+        }),
+        webRTC(),
+        webRTCDirect()
+      ]
+
+      // libp2p is the networking layer that underpins Helia
+      const libp2p = await this.createLibp2p({
+        // peerId,
+        privateKey,
+        datastore,
+        addresses: {
+          listen: [
+            '/ip4/127.0.0.1/tcp/0',
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsTcpPort}`,
+            `/ip4/0.0.0.0/tcp/${this.config.ipfsWsPort}/ws`,
+            '/webrtc',
+            '/p2p-circuit'
+          ]
+        },
+        transports,
+        connectionEncrypters: [
+          noise()
+        ],
+        streamMuxers: [
+          yamux()
+        ],
+        services
+      })
+
+      // create a Helia node
+      const helia = await this.createHelia({
+        blockstore,
+        datastore,
+        libp2p
+      })
+
+      // Attach IPFS file system.
+      const fs = unixfs(helia)
+      helia.fs = fs
+
+      return helia
+    } catch (err) {
+      console.error('Error creating Helia node: ', err)
 
       throw err
     }
@@ -116,25 +219,98 @@ class IpfsAdapter {
     return true
   }
 
-  // Remove the '/blocks' directory that is used to store IPFS data.
-  // 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 () {
+  // Ensure that the directories exist to store blocks from the IPFS network.
+  // This function is called at startup, before the IPFS node is started.
+  ensureBlocksDir () {
     try {
-      const dir = `${IPFS_DIR}/blocks`
-      console.log(`Deleting ${dir} directory...`)
+      !this.fs.existsSync(`${ROOT_DIR}.ipfsdata`) && this.fs.mkdirSync(`${ROOT_DIR}.ipfsdata`)
 
-      this.fs.rmdirSync(dir, { recursive: true })
+      !this.fs.existsSync(`${IPFS_DIR}`) && this.fs.mkdirSync(`${IPFS_DIR}`)
 
-      console.log(`${dir} directory is deleted!`)
+      !this.fs.existsSync(`${IPFS_DIR}/blockstore`) && this.fs.mkdirSync(`${IPFS_DIR}/blockstore`)
 
-      return true // Signal successful execution.
+      !this.fs.existsSync(`${IPFS_DIR}/datastore`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore`)
+
+      !this.fs.existsSync(`${IPFS_DIR}/datastore/pkcs8`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore/pkcs8`)
+
+      // !fs.existsSync(`${IPFS_DIR}/datastore/peers`) && fs.mkdirSync(`${IPFS_DIR}/datastore/peers`)
+
+      return true
     } catch (err) {
-      console.log('Error in rmBlocksDir()')
+      console.error('Error in adapters/ipfs.js/ensureBlocksDir(): ', err)
       throw err
     }
   }
+
+  // This function opens the seed used to generate the key for this IPFS peer.
+  // The seed is stored in a JSON file. If it doesn't exist, a new one is created.
+  async getSeed () {
+    try {
+      let seed
+
+      const filename = `${IPFS_DIR}/seed.json`
+
+      try {
+        // Try to read the JSON file containing the seed.
+        seed = await this.jsonFiles.readJSON(filename)
+      } catch (err) {
+        const seedNum = Math.floor(Math.random() * 1000000000000000000000)
+        seed = seedNum.toString()
+
+        // Save the newly generated seed
+        await this.jsonFiles.writeJSON(seed, filename)
+      }
+
+      // console.log('getSeed() seed: ', seed)
+
+      return seed
+    } catch (err) {
+      console.error('Error in adapters/ipfs/ipfs.js/getSeed()')
+      throw err
+    }
+  }
+
+  // Get the private key from disk, or generate a new one and save it,
+  // if it doesn't exist.
+  // async getPrivateKey () {
+  //   try {
+  //     const filename = `${IPFS_DIR}/privkey.json`
+
+  //     let privKeyHex
+  //     try {
+  //       // Try to read the JSON file containing the seed.
+  //       privKeyHex = await this.jsonFiles.readJSON(filename)
+  //       // console.log('saved privKeyHex: ', privKeyHex)
+  //     } catch (err) {
+  //       // Generate a new private key and save it to disk.
+
+  //       // Generate a new private key and save it to disk.
+  //       const randomBuffer = crypto.randomBytes(32)
+  //       // console.log('randomBuffer: ', randomBuffer)
+
+  //       privKeyHex = randomBuffer.toString('hex')
+  //       // console.log('new privKeyHex: ', privKeyHex)
+
+  //       // Save the newly generated seed
+  //       await this.jsonFiles.writeJSON(privKeyHex, filename)
+  //     }
+
+  //     // Convert the saved hex string to a buffer.
+  //     const privKeyBuf = Buffer.from(privKeyHex, 'hex')
+
+  //     // Convert the buffer to a Uint8Array 'seed'
+  //     const seed = new Uint8Array(privKeyBuf.buffer, privKeyBuf.byteOffset, privKeyBuf.byteLength)
+  //     // console.log('seed: ', seed)
+
+  //     // Generate a ED25519 key pair.
+  //     const privKey = await generateKeyPairFromSeed('Ed25519', seed)
+
+  //     return privKey
+  //   } catch (err) {
+  //     console.error('Error in adapters/ipfs/ipfs.js/getPrivateKey(): ', err)
+  //     throw err
+  //   }
+  // }
 }
 
-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,9 +3,10 @@
 */
 
 // Load Mongoose models.
-const Users = require('./models/users')
-const Entries = require('./models/entry')
-const Order = require('./models/order')
+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 () {
@@ -13,7 +14,8 @@ class LocalDB {
     this.Users = Users
     this.Entry = Entries
     this.Order = Order
+    this.Offer = Offer
   }
 }
 
-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,24 +1,42 @@
-const mongoose = require('mongoose')
+import mongoose from 'mongoose'
 
 const Offer = new mongoose.Schema({
+
+  // Token data
+  tokenId: { type: String },
+  utxoTxid: { type: String },
+  utxoVout: { type: Number },
+  ticker: { type: String, default: '' },
+  tokenType: { type: Number },
+
+  // Trade data
+  buyOrSell: { type: String },
+  numTokens: { type: Number },
+  rateInBaseUnit: { type: String },
+  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: Number },
+  globalTimestamp: { type: String },
+  localTimestamp: { type: String },
+  displayCategory: { type: String },
+  nsfw: { type: Boolean, default: false },
+  flags: { type: Array },
+
   // SWaP Protocol Properties
   lokadId: { type: String },
   messageType: { type: Number },
   messageClass: { type: Number },
-  tokenId: { type: String },
-  buyOrSell: { type: String },
-  rateInSats: { type: String },
-  minSatsToExchange: { type: String },
-  signature: { type: String },
-  sigMsg: { type: String },
-  utxoTxid: { type: String },
-  utxoVout: { type: Number },
-  numTokens: { type: Number },
+  nostrEventId: { type: String } // Nostr Event Id.
 
-  //
-  offerIpfsId: { type: String },
-  offerBchAddr: { type: String },
-  offerPubKey: { type: String }
 })
 
-module.exports = mongoose.model('offer', Offer)
+export default mongoose.model('offer', Offer)

src/adapters/localdb/models/order.js

@@ -1,23 +1,44 @@
-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 },
+  numTokens: { type: Number },
+  rateInBaseUnit: { type: String },
+  minUnitsToExchange: { type: String },
+  p2wdbTxid: { type: String },
+  p2wdbHash: { type: String },
+  makerAddr: { type: String },
+
+  // Authentication data
+  signature: { type: String },
+  sigMsg: { type: String },
+  offerBchAddr: { type: String },
+  offerPubKey: { type: String },
+
+  // Wallet Data
+  hdIndex: { type: Number }, // HD index address holding the UTXO for this offer.
+
   // SWaP Protocol Properties
   lokadId: { type: String },
   messageType: { type: Number },
   messageClass: { type: Number },
-  tokenId: { type: String },
-  buyOrSell: { type: String },
-  rateInSats: { type: String },
-  minSatsToExchange: { type: String },
-  signature: { type: String },
-  sigMsg: { type: String },
-  utxoTxid: { type: String },
-  utxoVout: { type: Number },
-  numTokens: { type: Number },
-  timestamp: { type: String },
-  localTimestamp: { type: String },
-  p2wdbTxid: { type: String },
-  p2wdbHash: { type: String }
+  nostrEventId: { type: String } // Nostr Event Id.
 })
 
-module.exports = mongoose.model('order', Order)
+export default mongoose.model('order', Order)

src/adapters/localdb/models/users.js

@@ -1,13 +1,17 @@
-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' },
   name: { type: String },
   username: { type: String },
   password: { type: String, required: true },
+  mnemonic: { type: String, required: true },
   email: {
     type: String,
     required: true,
@@ -51,4 +55,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/nostr.js

@@ -0,0 +1,136 @@
+/*
+  Adapter library for working with Nostr.
+*/
+
+// Global npm libraries
+import BchNostr from 'bch-nostr'
+import { RelayPool } from 'nostr'
+import RetryQueue from '@chris.troutner/retry-queue'
+import * as nip19 from 'nostr-tools/nip19'
+
+class NostrAdapter {
+  constructor (localConfig = { nostrRelay: '', nostrTopic: '' }) {
+    this.relayWs = localConfig.nostrRelay //
+    this.topic = localConfig.nostrTopic
+
+    if (!this.relayWs) {
+      throw new Error(
+        '"nostrRelay" must be passed when instantiate NostrAdapter'
+      )
+    }
+
+    if (!this.topic) {
+      throw new Error(
+        '"nostrTopic" must be passed when instantiate NostrAdapter'
+      )
+    }
+
+    // Encapsulate dependencies
+    this.bchNostr = new BchNostr()
+    this.RelayPool = RelayPool
+    this.retryQueue = new RetryQueue({
+      concurrency: 1,
+      attempts: 5,
+      retryPeriod: 1000
+    })
+
+    // Bind the 'this' object
+    this.start = this.start.bind(this)
+    this.post = this.post.bind(this)
+    this.read = this.read.bind(this)
+    this.eventId2note = this.eventId2note.bind(this)
+  }
+
+  // Create nostr keys.
+  // NOTE:  WIF must be provided in this function instead the constructor function
+  // we can provide it after app wallet creation.
+  async start (WIF) {
+    try {
+      if (!WIF || typeof WIF !== 'string') {
+        throw new Error('WIF must be a string!')
+      }
+
+      const { privKeyBuf, nostrPubKey } =
+        this.bchNostr.keys.createNostrPubKeyFromWif({ wif: WIF })
+
+      this.privKeyBuf = privKeyBuf
+      this.nostrPubKey = nostrPubKey
+
+      console.log(`Nostr Pub Key : ${nostrPubKey}`)
+
+      return true
+    } catch (error) {
+      console.log(`Error in nostr.js/start() ${error.message} `)
+      throw error
+    }
+  }
+
+  // Post a message over the instance-topic.
+  async post (msg = '') {
+    try {
+      if (!msg || typeof msg !== 'string') {
+        throw new Error('msg must be a string!')
+      }
+
+      const inObj = {
+        kind: 867,
+        privKeyBuf: this.privKeyBuf,
+        nostrPubKey: this.nostrPubKey,
+        relayWs: this.relayWs,
+        msg,
+        tags: [['t', this.topic]]
+      }
+      const eventId = await this.retryQueue.addToQueue(this.bchNostr.post.uploadToNostr, inObj)
+      return eventId
+    } catch (error) {
+      console.log(`Error in nostr.js/post() ${error.message} `)
+      throw error
+    }
+  }
+
+  // Read a message over the instance-topic.
+  async read (limit = 10) {
+    try {
+      if (typeof limit !== 'number' || limit < 1) {
+        throw new Error('Limit must be greater than 0')
+      }
+
+      const relays = [this.relayWs]
+      const pool = this.RelayPool(relays)
+
+      const nostrData = new Promise((resolve, reject) => {
+        const messages = []
+
+        pool.on('open', (relay) => {
+          // relay.subscribe('REQ', { ids: [eventId] })
+          relay.subscribe('REQ', { limit, kinds: [867], '#t': [this.topic] })
+        })
+
+        pool.on('eose', (relay) => {
+          relay.close()
+          resolve(messages)
+        })
+
+        pool.on('event', (relay, subId, ev) => {
+          // console.log('ev: ', ev)
+          messages.push({ content: ev.content, eventId: ev.id })
+        })
+      })
+
+      const messages = await nostrData
+
+      return messages
+    } catch (error) {
+      console.log(`Error in nostr.js/read() ${error.message} `)
+      throw error
+    }
+  }
+
+  // Convert an Event ID into a `noteabc..` syntax that Astral expects.
+  // This can be used to generate a link to Astral to display the post.
+  eventId2note (eventId) {
+    return nip19.noteEncode(eventId)
+  }
+}
+
+export default NostrAdapter

src/adapters/p2wdb-adapter.js

@@ -0,0 +1,120 @@
+/*
+  Adapter library for interacting with the P2WDB
+*/
+
+// Public npm libraries.
+import axios from 'axios'
+
+import P2WDB from 'p2wdb-esm'
+
+// Local libraries
+import config from '../../config/index.js'
+const { Write, Read } = P2WDB
+
+class P2wdbAdapter {
+  constructor (localConfig = {}) {
+    // Dependency injection
+    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
+    this.axios = axios
+    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
+  async write (inputObj = {}) {
+    try {
+      const { appId = 'test', data = {}, wif } = inputObj
+
+      if (typeof wif !== 'string' || !wif) {
+        throw new Error('wif input must be a private key starting with the letter L or K')
+      }
+
+      const p2write = this.instantiateWriteLib(wif)
+
+      const result = await p2write.postEntry(data, appId)
+
+      return result.hash
+    } catch (err) {
+      console.error('Error in p2wdb.js/write()')
+      throw err
+    }
+  }
+
+  // Instantiate the Write library with a WIF, handling the various config
+  // settings.
+  instantiateWriteLib (wif) {
+    try {
+      if (!wif) {
+        throw new Error('WIF input required when calling instantiateWriteLib()')
+      }
+
+      // Object used to configure the Write library.
+      let configObj = {}
+
+      if (this.config.useFullStackCash) {
+        // Use web 2 infrastructure.
+        // bch-js and FullStack.cash
+
+        configObj = {
+          wif,
+          serverURL: this.p2wdbURL,
+          restURL: this.bchjs.restURL,
+          apiToken: this.bchjs.apiToken,
+          bchWallet: this.bchWallet
+        }
+      } else {
+        // Use web 3 infrastructure.
+        // ipfs-bch-wallet-consumer and bch-consumer library
+
+        configObj = {
+          wif,
+          serverURL: this.p2wdbURL,
+          interface: 'consumer-api',
+          restURL: this.config.consumerUrl,
+          bchWallet: this.bchWallet
+        }
+      }
+
+      const write = new this.Write(configObj)
+
+      return write
+    } catch (err) {
+      console.error('Error in p2wdb-adapter.js/instantitateWriteLib()')
+      throw err
+    }
+  }
+
+  // Returns a promise that resolves to true or false, to indicate if the
+  // WIF controls the required funds to write to the P2WDB.
+  async checkForSufficientFunds (wif) {
+    try {
+      if (typeof wif !== 'string' || !wif) {
+        throw new Error('invalid wif to check for funds')
+      }
+
+      // Instatiate the Write library
+      const p2write = this.instantiateWriteLib(wif)
+
+      return await p2write.checkForSufficientFunds()
+    } catch (err) {
+      console.error('Error in p2wdb.js/checkForSufficientFunds()')
+      throw err
+    }
+  }
+}
+
+export default P2wdbAdapter

src/adapters/p2wdb.js

@@ -1,57 +0,0 @@
-/*
-  Adapter library for interacting with the P2WDB
-*/
-
-// Public npm libraries.
-const axios = require('axios')
-
-// Local libraries
-const config = require('../../config')
-
-// Global constants
-let P2WDB_SERVER = 'http://localhost:5001/entry/write'
-// const P2WDB_SERVER = 'https://p2wdb.fullstack.cash/entry/write'
-
-class P2wdbAdapter {
-  constructor (localConfig = {}) {
-    // Encapsulate dependencies
-    this.axios = axios
-    this.config = config
-
-    P2WDB_SERVER = `http://localhost:${config.p2wdbPort}/entry/write`
-  }
-
-  async write (inputObj) {
-    try {
-      const { txid, signature, message, appId, data } = inputObj
-
-      // TODO: Input validation
-
-      const now = new Date()
-
-      const dataObj = {
-        appId,
-        data,
-        timestamp: now.toISOString(),
-        localTimeStamp: now.toLocaleString()
-      }
-
-      const bodyData = {
-        txid,
-        message,
-        signature,
-        data: JSON.stringify(dataObj)
-      }
-
-      const result = await this.axios.post(P2WDB_SERVER, bodyData)
-      // console.log(`Response from API: ${JSON.stringify(result.data, null, 2)}`)
-
-      return result.data.hash
-    } catch (err) {
-      console.error('Error in p2wdb.js/write()')
-      throw err
-    }
-  }
-}
-
-module.exports = 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.adapter.js

@@ -0,0 +1,251 @@
+/*
+  Wallet adapter. This library instantiates minimal-slp-wallet based on different
+  configuration settings. That single instance of minimal-slp-wallet is then
+  easily passed around the rest of this application.
+*/
+
+// Global npm libraries
+import BchWallet from 'minimal-slp-wallet'
+
+// Local libraries
+import config from '../../config/index.js'
+import JsonFiles from './json-files.js'
+
+class Wallet {
+  constructor (localConfig = {}) {
+    // Encapsulate dependencies
+    this.config = config
+    this.BchWallet = BchWallet
+    this.jsonFiles = new JsonFiles()
+
+    // Bind 'this' object to all subfunctions
+    this.instanceWalletWithoutInitialization = this.instanceWalletWithoutInitialization.bind(this)
+    this._instanceWallet = this._instanceWallet.bind(this)
+    this.openWallet = this.openWallet.bind(this)
+    this.instanceWallet = this.instanceWallet.bind(this)
+    this.incrementNextAddress = this.incrementNextAddress.bind(this)
+    this.getKeyPair = this.getKeyPair.bind(this)
+    this.optimize = this.optimize.bind(this)
+    this.getBalance = this.getBalance.bind(this)
+  }
+
+  // This is used for initializing the wallet, without waiting to update the wallet
+  // UTXOs from the blockchain.
+  // This is useful when the wallet is simply needed to make calls to the blockchain,
+  // and there is no need to hydrate it with UTXO data.
+  async instanceWalletWithoutInitialization (walletData = {}, advancedConfig = {}) {
+    try {
+      // Use the apiToken from the config settings, if one is not passed-in at
+      // run-time.
+      if (!advancedConfig.apiToken) {
+        advancedConfig.apiToken = this.config.apiToken
+      }
+
+      // If an authentication password is passed in the config, add it.
+      if (this.config.authPass) {
+        advancedConfig.authPass = this.config.authPass
+      }
+
+      // Detect and configure different blockchain infrastructure settings.
+      if (this.config.walletInterface === 'web2') {
+        advancedConfig.interface = 'rest-api'
+        advancedConfig.restURL = this.config.apiServer
+      } else {
+        // By default use the web3 Cash Stack (https://cashstack.info)
+        advancedConfig.interface = 'consumer-api'
+        advancedConfig.restURL = this.config.apiServer
+      }
+
+      // console.log('advancedConfig setting when creating wallet: ', advancedConfig)
+
+      // Instantiate minimal-slp-wallet.
+      if (walletData.mnemonic) {
+        // Instance the wallet using the mnemonic passed in to this function.
+        console.log('Mnemonic provided to wallet library from calling function.')
+        this.bchWallet = await this._instanceWallet(walletData.mnemonic, advancedConfig)
+      } else if (this.config.mnemonic) {
+        // Otherwise use the mnemonic in the config setting or passed as an environment variable.
+        console.log('Mnemonic retrieved from config file or environment variable.')
+        this.bchWallet = await this._instanceWallet(this.config.mnemonic, advancedConfig)
+      } else {
+        // If no mnemonic is provided, then generate a new mnemonic to create the wallet.
+        console.log('New mnemonic generated.')
+        this.bchWallet = await this._instanceWallet(undefined, advancedConfig)
+      }
+
+      // Wait for wallet to initialize.
+      await this.bchWallet.walletInfoPromise
+      console.log('BCH wallet initialized.')
+      console.log(`Wallet address: ${this.bchWallet.walletInfo.cashAddress}`)
+      console.log(`Wallet mnemonic: ${this.bchWallet.walletInfo.mnemonic}`)
+
+      return this.bchWallet
+    } catch (err) {
+      console.error('Error in instanceWalletWithoutInitialization()')
+      throw err
+    }
+  }
+
+  // This function is used for easier mocking of unit tests.
+  async _instanceWallet (mnemonic, config) {
+    const wallet = new this.BchWallet(mnemonic, config)
+    await wallet.walletInfoPromise
+
+    return wallet
+  }
+
+  // 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 openWallet (advancedConfig = {}) {
+    try {
+      let walletData
+
+      // Try to open the wallet.json file.
+      try {
+        walletData = await this.jsonFiles.readJSON(this.config.walletFile)
+        walletData = walletData.wallet
+      } catch (err) {
+        // Create a new wallet file if one does not already exist.
+        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.
+        const walletInstance = await this.instanceWalletWithoutInitialization({}, advancedConfig)
+
+        walletData = walletInstance.walletInfo
+
+        // Add the nextAddress property
+        walletData.nextAddress = 1
+
+        // Write the wallet data to the JSON file.
+        await this.jsonFiles.writeJSON({ wallet: walletData }, this.config.walletFile)
+      }
+
+      // console.log('walletData: ', walletData)
+      return walletData
+    } catch (err) {
+      console.error('Error in openWallet()')
+      throw err
+    }
+  }
+
+  // Create an instance of minimal-slp-wallet. Same as
+  // instanceWalletWithoutInitialization(), but waits for the wallet to initialize
+  // its UTXOs (wallet balance and tokens).
+  async instanceWallet (walletData = {}, advancedConfig = {}) {
+    try {
+      // Instance the wallet without initialization.
+      await this.instanceWalletWithoutInitialization(walletData, advancedConfig)
+
+      // Initialize the wallet
+      await this.bchWallet.initialize()
+
+      return this.bchWallet
+    } catch (err) {
+      console.error('Error in wallet.js/instanceWallet()')
+      throw err
+    }
+  }
+
+  // Increments the 'nextAddress' property in the wallet file. This property
+  // indicates the HD index that should be used to generate a key pair for
+  // storing funds for Offers.
+  // This function opens the wallet file, increments the nextAddress property,
+  // then saves the change to the wallet file.
+  async incrementNextAddress () {
+    try {
+      const walletData = await this.openWallet()
+
+      await this.instanceWalletWithoutInitialization(walletData)
+
+      walletData.nextAddress++
+      // console.log('walletData finish: ', walletData)
+
+      await this.jsonFiles.writeJSON({ wallet: walletData }, this.config.walletFile)
+
+      // Update the working instance of the wallet.
+      this.bchWallet.walletInfo.nextAddress++
+      // console.log('this.bchWallet.walletInfo: ', this.bchWallet.walletInfo)
+
+      return walletData.nextAddress
+    } catch (err) {
+      console.error('Error in incrementNextAddress()')
+      throw err
+    }
+  }
+
+  // This method returns an object that contains a private key WIF, public address,
+  // 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 (hdIndex = 0) {
+    try {
+      if (!hdIndex) {
+        // Increment the HD index and generate a new key pair.
+        hdIndex = await this.incrementNextAddress()
+      }
+
+      const mnemonic = this.bchWallet.walletInfo.mnemonic
+
+      // root seed buffer
+      const rootSeed = await this.bchWallet.bchjs.Mnemonic.toSeed(mnemonic)
+      const masterHDNode = this.bchWallet.bchjs.HDNode.fromSeed(rootSeed)
+
+      // HDNode of BIP44 account
+      // const account = this.bchWallet.bchjs.HDNode.derivePath(masterHDNode, "m/44'/245'/0'")
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = this.bchWallet.bchjs.HDNode.toCashAddress(childNode)
+      console.log('Generating a new key pair for cashAddress: ', cashAddress)
+
+      const wif = this.bchWallet.bchjs.HDNode.toWIF(childNode)
+
+      const outObj = {
+        cashAddress,
+        wif,
+        hdIndex
+      }
+      return outObj
+    } catch (err) {
+      console.error('Error in getKeyPair()')
+      throw err
+    }
+  }
+
+  // Optimize the wallet by consolidating the UTXOs.
+  async optimize () {
+    const UTXO_THREASHOLD = 7
+    // Do a dry-run first to see if there are enough UTXOs worth consolidating.
+    const dryRunOut = await this.bchWallet.optimize(true)
+    if (dryRunOut.bchUtxoCnt > UTXO_THREASHOLD) {
+      // Consolidate BCH UTXOs if the count is above the threashold.
+      const txids = await this.bchWallet.optimize()
+      console.log(`Wallet optimized with these return values: ${JSON.stringify(txids, null, 2)}`)
+    }
+    return true
+  }
+
+  // Get the balance of the wallet in sats and PSF tokens.
+  // This function is called by the GET /entry/balance controller.
+  async getBalance () {
+    const balance = await this.bchWallet.getBalance()
+    // console.log('balance: ', balance)
+    const tokens = await this.bchWallet.listTokens()
+    // console.log('tokens: ', tokens)
+    // Find the array entry for the PSF token
+    const psfTokens = tokens.find(x => x.tokenId === '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0')
+    // console.log('psfTokens: ', psfTokens)
+    let psfBalance = 0
+    if (psfTokens) {
+      psfBalance = psfTokens.qty
+    }
+    const outObj = {
+      satBalance: balance,
+      psfBalance,
+      success: true
+    }
+    return outObj
+  }
+}
+
+export default Wallet

src/adapters/wallet.js

@@ -1,26 +1,60 @@
 /*
   Adapter library for working with a wallet.
+  This library is specific to bch-dex. The other wallet adapter library is
+  inherited from ipfs-service-provider.
 */
 
 // 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'
+import RetryQueue from '@chris.troutner/retry-queue'
 
 // 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 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
+    this.retryQueue = new RetryQueue({
+      concurrency: 1,
+      attempts: 5,
+      retryPeriod: 5000
+    })
+
+    // Bind the 'this' object
+    this.openWallet = this.openWallet.bind(this)
+    this.instanceWallet = this.instanceWallet.bind(this)
+    this.incrementNextAddress = this.incrementNextAddress.bind(this)
+    this.getKeyPair = this.getKeyPair.bind(this)
+    this.generateSignature = this.generateSignature.bind(this)
+    this.generatePartialTx = this.generatePartialTx.bind(this)
+    this.moveTokens = this.moveTokens.bind(this)
+    this.moveBch = this.moveBch.bind(this)
+    this.deseralizeTx = this.deseralizeTx.bind(this)
+    this.completeTx = this.completeTx.bind(this)
+    this.reclaimTokens = this.reclaimTokens.bind(this)
+    this.moveTokensFromCustomWallet = this.moveTokensFromCustomWallet.bind(this)
   }
 
   // Open the wallet file, or create one if the file doesn't exist.
@@ -36,7 +70,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 +101,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 +124,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 +165,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,63 +224,403 @@ class WalletAdapter {
     }
   }
 
-  // Burn enough PSF to generate a valide proof-of-burn for writing to the P2WDB.
-  async burnPsf () {
+  // Generate a partial transcation to *take* a 'sell' offer.
+  async generatePartialTx (offerInfo, utxoInfo) {
     try {
-      // TODO: Throw error if this.bchWallet has not been instantiated.
+      console.log(`offerInfo: ${JSON.stringify(offerInfo, null, 2)}`)
 
-      // console.log('walletData: ', walletData)
-      // console.log(
-      //   `walletData.utxos.utxoStore.slpUtxos: ${JSON.stringify(
-      //     walletData.utxos.utxoStore.slpUtxos,
-      //     null,
-      //     2,
-      //   )}`,
+      const bchjs = this.bchWallet.bchjs
+
+      // instance of transaction builder
+      const transactionBuilder = new bchjs.TransactionBuilder()
+
+      // 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)
+
+      // Get token info on the offered UTXO
+      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: offerInfo.utxoTxid,
+        vout: offerInfo.utxoVout,
+        tokenId: offerInfo.tokenId,
+        decimals: txData[0].tokenDecimals,
+        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.
+      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
+
+      // Currently this app only supports a single SLP token UTXO for exact
+      // token quantities (no token change). e.g. 1 UTXO representing the
+      // exact number of 'numTokens'
+      if (slpSendObj.outputs > 1) {
+        console.log('WARNING: choose one UTXO with all tokens to exchange')
+        return
+      }
+
+      // Calculate sats needed to pay the offer.
+      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
+      // 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}`)
+      // }
+
+      // 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(utxoInfo.txid, utxoInfo.vout)
+
+      // const originalAmount = paymentUtxo.value
+      const dust = 546
+      // const remainder = originalAmount - satsNeeded - dust // exchange fee + token UTXO dust
+
+      // Add the SLP OP_RETURN data as the first output.
+      transactionBuilder.addOutput(slpData, 0)
+
+      const buyerAddr = this.bchWallet.walletInfo.legacyAddress
+      // console.log(`buyAddr: ${JSON.stringify(buyAddr, null, 2)}`)
+
+      // Send dust transaction representing tokens being sent.
+      transactionBuilder.addOutput(
+        buyerAddr,
+        dust
+      )
+
+      // Get seller address
+      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)
+      // }
+
+      // 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(
+        1,
+        buyerECPair,
+        null,
+        transactionBuilder.hashTypes.SIGHASH_ALL,
+        utxoInfo.sats
+      )
+
+      const tx = transactionBuilder.transaction.buildIncomplete()
+
+      const hex = tx.toHex()
+      // console.log('hex: ', hex)
+
+      return hex
+    } catch (err) {
+      console.error('Error in wallet.js/generatePartialTx(): ', err)
+      throw err
+    }
+
+  // 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/deserializeTx()')
+      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)
+      console.log('completeTx() hdIndex: ', hdIndex)
+
+      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 token UTXOs held by the wallet.
-      const tokenUtxos = this.bchWallet.utxos.utxoStore.slpUtxos.type1.tokens
-      // console.log(`tokenUtxos: ${JSON.stringify(tokenUtxos, null, 2)}`)
+      console.log('completeTx() this.walletInfo: ', this.walletInfo)
 
-      // Find a token UTXO that contains PSF with a quantity higher than needed
-      // to generate a proof-of-burn.
-      let tokenUtxo = {}
-      for (let i = 0; i < tokenUtxos.length; i++) {
-        const thisUtxo = tokenUtxos[i]
+      // 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)
 
-        // If token ID matches.
-        if (thisUtxo.tokenId === P2WDB_TOKEN_ID) {
-          if (parseFloat(thisUtxo.qtyStr) >= PROOF_OF_BURN_QTY) {
-            tokenUtxo = thisUtxo
-            break
-          }
-        }
-      }
+      // 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
 
-      if (tokenUtxo.tokenId !== P2WDB_TOKEN_ID) {
-        throw new Error(
-          `Token UTXO of with ID of ${P2WDB_TOKEN_ID} and quantity greater than ${PROOF_OF_BURN_QTY} could not be found in wallet.`
-        )
-      }
-      // console.log(`tokenUtxo: ${JSON.stringify(tokenUtxo, null, 2)}`)
-
-      const result = await this.bchWallet.burnTokens(
-        PROOF_OF_BURN_QTY,
-        P2WDB_TOKEN_ID
+      // 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
       )
-      // console.log('walletData.burnTokens() result: ', result)
 
-      return result
+      // build tx
+      const csTx = csTransactionBuilder.build()
 
-      // return {
-      //   success: true,
-      //   txid: 'fakeTxid',
-      // }
+      // 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)
+      const txid = await this.retryQueue.addToQueue(this.bchWallet.broadcast, { hex: csTxHex })
+      console.log('completeTx() txid: ', txid)
+
+      return txid
     } catch (err) {
-      console.error('Error in burnPsf(): ', 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
+    }
+  }
+
+  async moveTokensFromCustomWallet (inObj = {}) {
+    try {
+      const { tokenId, qty, wallet } = inObj
+
+      const keyPair = await this.getKeyPair()
+      console.log('keyPair: ', keyPair)
+
+      const receiver = {
+        address: keyPair.cashAddress,
+        tokenId,
+        qty
+      }
+      console.log('receiver: ', receiver)
+
+      // Update the UTXO store of the wallet.
+      await wallet.initialize()
+
+      // Get the token type of the token being moved.
+      // Combine Fungible and NFT token UTXOs.
+      let tokenUtxos = wallet.utxos.utxoStore.slpUtxos.type1.tokens.concat(
+        wallet.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 wallet.sendTokens(receiver, 3)
+      console.log('txid: ', txid)
+      const utxoInfo = {
+        txid,
+        vout: 1,
+        hdIndex: wallet.walletInfo.hdIndex,
+        tokenType: tokenUtxos[0].tokenType
+      }
+
+      return utxoInfo
+    } catch (err) {
+      console.error('Error in wallet.js/moveTokens()')
       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

@@ -6,33 +6,38 @@
 
 // Public npm libraries.
 
-// Load the Clean Architecture Adapters library
-const Adapters = require('../adapters')
-
-// Load the JSON RPC Controller.
-const JSONRPC = require('./json-rpc')
-
-// Load the Clean Architecture Use Case libraries.
-const UseCases = require('../use-cases')
-// const useCases = new UseCases({ adapters })
-
-// Load the REST API Controllers.
-const RESTControllers = require('./rest-api')
+// Local libraries
+import Adapters from '../adapters/index.js'
+import JSONRPC from './json-rpc/index.js'
+import UseCases from '../use-cases/index.js'
+import RESTControllers from './rest-api/index.js'
+import TimerControllers from './timer-controllers.js'
+import config from '../../config/index.js'
 
 class Controllers {
   constructor (localConfig = {}) {
+    // Encapsulate dependencies
     this.adapters = new Adapters()
     this.useCases = new UseCases({ adapters: this.adapters })
+    this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
+    this.config = config
+
+    // Bind 'this' object to all subfunction
+    this.initAdapters = this.initAdapters.bind(this)
+    this.initUseCases = this.initUseCases.bind(this)
+    this.attachRESTControllers = this.attachRESTControllers.bind(this)
+    this.attachControllers = this.attachControllers.bind(this)
+    this.attachRPCControllers = this.attachRPCControllers.bind(this)
   }
 
-  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,17 @@ class Controllers {
     restControllers.attachRESTControllers(app)
   }
 
+  // Attach any other controllers other than REST API controllers.
+  async attachControllers (app) {
+    if (this.config.useIpfs) {
+      // Attach JSON RPC controllers
+      this.attachRPCControllers()
+    }
+
+    // Attach and start the timer controllers
+    this.timerControllers.startTimers()
+  }
+
   // Add the JSON RPC router to the ipfs-coord adapter.
   attachRPCControllers () {
     const jsonRpcController = new JSONRPC({
@@ -61,4 +77,4 @@ class Controllers {
   }
 }
 
-module.exports = Controllers
+export default Controllers

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

@@ -1,12 +1,15 @@
 /*
   This is the JSON RPC router for the users API
+
+  CT 3/5/22: This library can probably be deleted. Handling of the /about endpoint
+  is now directly controlled by the ipfs-coord library.
 */
 
 // 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) {
@@ -33,6 +36,8 @@ class AboutRPC {
   // This is a bit different than other router libraries, because there is
   // only one response, which is a string about this node.
   async aboutRouter (rpcData) {
+    console.log('debugging: aboutRouter from ipfs-service-provider triggered')
+
     return {
       success: true,
       status: 200,
@@ -43,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,18 @@
 
 // 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 IpfsRESTController from './ipfs/index.js'
+import config from '../../../config/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'
+import UsageRESTController from './usage/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -31,7 +35,11 @@ class RESTControllers {
       )
     }
 
-    // console.log('Controllers localConfig: ', localConfig)
+    // Bind 'this' object to all subfunctions.
+    this.attachRESTControllers = this.attachRESTControllers.bind(this)
+
+    // Encapsulate dependencies
+    this.config = config
   }
 
   attachRESTControllers (app) {
@@ -40,13 +48,15 @@ class RESTControllers {
       useCases: this.useCases
     }
 
-    // Attach the REST API Controllers associated with the /auth route
-    const authRESTController = new AuthRESTController(dependencies)
-    authRESTController.attach(app)
+    if (!this.config.noMongo) {
+      // Attach the REST API Controllers associated with the /auth route
+      const authRESTController = new AuthRESTController(dependencies)
+      authRESTController.attach(app)
 
-    // Attach the REST API Controllers associated with the /user route
-    const userRouter = new UserRouter(dependencies)
-    userRouter.attach(app)
+      // Attach the REST API Controllers associated with the /user route
+      const userRouter = new UserRouter(dependencies)
+      userRouter.attach(app)
+    }
 
     // Attach the REST API Controllers associated with the /contact route
     const contactRESTController = new ContactRESTController(dependencies)
@@ -56,6 +66,10 @@ class RESTControllers {
     const logsRESTController = new LogsRESTController(dependencies)
     logsRESTController.attach(app)
 
+    // Attach the REST API Controllers associated with the /ipfs route
+    const ipfsRESTController = new IpfsRESTController(dependencies)
+    ipfsRESTController.attach(app)
+
     // Attach the REST API Controllers associated with the /entry route
     const entryRouter = new EntryRouter(dependencies)
     entryRouter.attach(app)
@@ -65,7 +79,14 @@ class RESTControllers {
 
     const orderRouter = new OrderRouter(dependencies)
     orderRouter.attach(app)
+
+    const p2wdbRouter = new P2WDBRouter(dependencies)
+    p2wdbRouter.attach(app)
+
+    // Attach the REST API Controllers associated with the /usage route
+    const usageRESTController = new UsageRESTController(dependencies)
+    usageRESTController.attach(app)
   }
 }
 
-module.exports = RESTControllers
+export default RESTControllers

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

@@ -0,0 +1,145 @@
+/*
+  REST API Controller library for the /ipfs route
+*/
+
+// Global npm libraries
+
+// Local libraries
+import wlogger from '../../../adapters/wlogger.js'
+
+class IpfsRESTControllerLib {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /ipfs REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /ipfs REST Controller.'
+      )
+    }
+
+    // Encapsulate dependencies
+    // this.UserModel = this.adapters.localdb.Users
+    // this.userUseCases = this.useCases.user
+
+    // Bind 'this' object to all subfunctions
+    this.getStatus = this.getStatus.bind(this)
+    this.getPeers = this.getPeers.bind(this)
+    this.getRelays = this.getRelays.bind(this)
+    this.handleError = this.handleError.bind(this)
+    this.connect = this.connect.bind(this)
+    this.getThisNode = this.getThisNode.bind(this)
+  }
+
+  /**
+   * @api {get} /ipfs Get status on IPFS infrastructure
+   * @apiPermission public
+   * @apiName GetIpfsStatus
+   * @apiGroup REST BCH
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs
+   *
+   */
+  async getStatus (ctx) {
+    try {
+      const status = await this.adapters.ipfs.getStatus()
+
+      ctx.body = { status }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getStatus(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // Return information on IPFS peers this node is connected to.
+  async getPeers (ctx) {
+    try {
+      const showAll = ctx.request.body.showAll
+
+      const peers = await this.adapters.ipfs.getPeers(showAll)
+
+      ctx.body = { peers }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getPeers(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // Get data about the known Circuit Relays. Hydrate with data from peers list.
+  async getRelays (ctx) {
+    try {
+      const relays = await this.adapters.ipfs.getRelays()
+
+      ctx.body = { relays }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getRelays(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  async connect (ctx) {
+    try {
+      const multiaddr = ctx.request.body.multiaddr
+      const getDetails = ctx.request.body.getDetails
+
+      // console.log('this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs: ', this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs)
+      const result = await this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs.connectToPeer({ multiaddr, getDetails })
+      // console.log('result: ', result)
+
+      ctx.body = result
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/connect():', err)
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  /**
+   * @api {get} /ipfs/node Get a copy of the thisNode object from helia-coord
+   * @apiPermission public
+   * @apiName GetThisNode
+   * @apiGroup REST BCH
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/node
+   *
+   */
+  async getThisNode (ctx) {
+    try {
+      const thisNode = this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+
+      ctx.body = { thisNode }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getThisNode(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // DRY error handler
+  handleError (ctx, err) {
+    // If an HTTP status is specified by the buisiness logic, use that.
+    if (err.status) {
+      if (err.message) {
+        ctx.throw(err.status, err.message)
+      } else {
+        ctx.throw(err.status)
+      }
+    } else {
+      // By default use a 422 error if the HTTP status is not specified.
+      ctx.throw(422, err.message)
+    }
+  }
+}
+
+// module.exports = IpfsRESTControllerLib
+export default IpfsRESTControllerLib

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

@@ -0,0 +1,67 @@
+/*
+  REST API library for the /ipfs route.
+*/
+
+// Public npm libraries.
+import Router from 'koa-router'
+
+// Local libraries.
+import IPFSRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
+
+// let _this
+
+class IpfsRouter {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating IPFS REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating IPFS REST Controller.'
+      )
+    }
+
+    const dependencies = {
+      adapters: this.adapters,
+      useCases: this.useCases
+    }
+
+    // Encapsulate dependencies.
+    this.ipfsRESTController = new IPFSRESTControllerLib(dependencies)
+    this.validators = new Validators()
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/ipfs'
+    this.router = new Router({ prefix: baseUrl })
+
+    // _this = this
+  }
+
+  attach (app) {
+    if (!app) {
+      throw new Error(
+        'Must pass app object when attaching REST API controllers.'
+      )
+    }
+
+    // Define the routes and attach the controller.
+    this.router.get('/', this.ipfsRESTController.getStatus)
+    this.router.post('/peers', this.ipfsRESTController.getPeers)
+    this.router.post('/relays', this.ipfsRESTController.getRelays)
+    this.router.post('/connect', this.ipfsRESTController.connect)
+    this.router.get('/node', this.ipfsRESTController.getThisNode)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(this.router.routes())
+    app.use(this.router.allowedMethods())
+  }
+}
+
+// module.exports = BchRouter
+export default IpfsRouter

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,9 +2,7 @@
   REST API Controller library for the /offer route
 */
 
-// const { wlogger } = require('../../../adapters/wlogger')
-
-let _this
+import wlogger from '../../../adapters/wlogger.js'
 
 class OfferRESTControllerLib {
   constructor (localConfig = {}) {
@@ -26,31 +24,100 @@ class OfferRESTControllerLib {
     this.OfferModel = this.adapters.localdb.Offer
     // this.userUseCases = this.useCases.user
 
-    _this = this
+    // Bind 'this' object to all subfunctions.
+    this.createOffer = this.createOffer.bind(this)
+    this.listOffers = this.listOffers.bind(this)
+    this.listNftOffers = this.listNftOffers.bind(this)
+    this.listFungibleOffers = this.listFungibleOffers.bind(this)
+    this.takeOffer = this.takeOffer.bind(this)
+    this.handleError = this.handleError.bind(this)
   }
 
   // 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)
       // ctx.throw(422, err.message)
-      _this.handleError(ctx, err)
+      this.handleError(ctx, err)
+    }
+  }
+
+  // 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 nostrEventId = ctx.request.body.nostrEventId
+
+      const { eventId, noteId } = await this.useCases.offer.takeOffer(nostrEventId)
+
+      ctx.body = { eventId, noteId }
+    } 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 +132,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
 
@@ -48,8 +48,17 @@ class OfferRouter {
       )
     }
 
+    // 12/3/24 CT:
+    // Note: The createOffer() path was used by a P2WDB webhook to generate an
+    // Offer from and Order. This has been deprecated and Offers are now created
+    // by a Timer Controller monitoring a Nostr topic.
+
     // Define the routes and attach the controller.
-    this.router.post('/', _this.offerRESTController.createOffer)
+    // this.router.post('/', _this.offerRESTController.createOffer) // Deprecated.
+    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 +66,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,51 @@ 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
+      const user = ctx.state.user
+      orderObj.userId = user._id
+      console.log('orderObj: ', orderObj)
 
-      await _this.useCases.order.createOrder(orderObj)
+      const { eventId, noteId } = await _this.useCases.order.createOrder(orderObj)
 
-      ctx.body = {
-        success: true
-      }
+      ctx.body = { eventId, noteId }
+    } catch (err) {
+      // console.log(`err.message: ${err.message}`)
+      // console.log('err: ', err)
+      // ctx.throw(422, err.message)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // curl -X GET http://localhost:5700/order/list/all/0
+  async listOrders (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.order.listOrders(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in listOrders REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // 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)
+
+      const nostrEventId = ctx.request.body.nostrEventId
+      // console.log('p2wdbHash: ', p2wdbHash)
+
+      const txid = await _this.useCases.order.deleteOrder(nostrEventId)
+
+      ctx.body = { txid }
     } catch (err) {
       // console.log(`err.message: ${err.message}`)
       // console.log('err: ', err)
@@ -51,7 +87,8 @@ class OrderRESTControllerLib {
 
   // 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) {
@@ -66,4 +103,4 @@ class OrderRESTControllerLib {
   }
 }
 
-module.exports = OrderRESTControllerLib
+export default OrderRESTControllerLib

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

@@ -1,12 +1,13 @@
 /*
-  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'
+import Validators from '../middleware/validators.js'
 
 let _this
 
@@ -32,12 +33,14 @@ class OrderRouter {
     }
 
     // Encapsulate dependencies.
+    this.validators = new Validators()
     this.orderRESTController = new OrderRESTControllerLib(dependencies)
 
     // Instantiate the router and set the base route.
     const baseUrl = '/order'
     this.router = new Router({ prefix: baseUrl })
 
+    this.createOrder = this.createOrder.bind(this)
     _this = this
   }
 
@@ -49,12 +52,19 @@ class OrderRouter {
     }
 
     // Define the routes and attach the controller.
-    this.router.post('/', _this.orderRESTController.createOrder)
+    this.router.post('/', this.createOrder)
+    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())
     app.use(_this.router.allowedMethods())
   }
+
+  async createOrder (ctx, next) {
+    await _this.validators.ensureUser(ctx, next)
+    await _this.orderRESTController.createOrder(ctx, next)
+  }
 }
 
-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/usage/controller.js

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

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

@@ -0,0 +1,65 @@
+/*
+  REST API library for the /usage route.
+*/
+
+// Public npm libraries.
+import Router from 'koa-router'
+
+// Local libraries.
+import UsageRESTControllerLib from './controller.js'
+import Validators from '../middleware/validators.js'
+
+// let _this
+
+class UsageRouter {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating IPFS REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating IPFS REST Controller.'
+      )
+    }
+
+    const dependencies = {
+      adapters: this.adapters,
+      useCases: this.useCases
+    }
+
+    // Encapsulate dependencies.
+    this.usageRESTController = new UsageRESTControllerLib(dependencies)
+    this.validators = new Validators()
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/usage'
+    this.router = new Router({ prefix: baseUrl })
+
+    // _this = this
+  }
+
+  attach (app) {
+    if (!app) {
+      throw new Error(
+        'Must pass app object when attaching REST API controllers.'
+      )
+    }
+
+    // Define the routes and attach the controller.
+    this.router.get('/', this.usageRESTController.getStatus)
+    this.router.get('/ips', this.usageRESTController.getTopIps)
+    this.router.get('/endpoints', this.usageRESTController.getTopEndpoints)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(this.router.routes())
+    app.use(this.router.allowedMethods())
+  }
+}
+
+// module.exports = BchRouter
+export default UsageRouter

src/controllers/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
@@ -124,7 +124,7 @@ class UserRESTControllerLib {
 
       ctx.body = { users }
     } catch (err) {
-      wlogger.error('Error in users/controller.js/getUsers(): '.err)
+      wlogger.error('Error in users/controller.js/getUsers(): ', err)
       ctx.throw(422, err.message)
     }
   }
@@ -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,129 @@
+/*
+  This Controller library is concerned with timer-based functions that are
+  kicked off periodicially.
+*/
+
+import config from '../../config/index.js'
+
+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.config = config
+
+    // Bind 'this' object to all subfunctions
+    this.startTimers = this.startTimers.bind(this)
+    this.gcOrders = this.gcOrders.bind(this)
+    this.gcOffers = this.gcOffers.bind(this)
+    this.checkDupOffers = this.checkDupOffers.bind(this)
+    this.loadOffers = this.loadOffers.bind(this)
+    // Bind 'this' object to all subfunctions.
+    // this.exampleTimerFunc = this.exampleTimerFunc.bind(this)
+    this.cleanUsage = this.cleanUsage.bind(this)
+
+    // State
+    this.gcOrdersInt = null
+    this.gcOffersInt = null
+    this.checkDupOffersInt = null
+    this.loadOffersInt = null
+  }
+
+  // Start all the time-based controllers.
+  startTimers () {
+    this.gcOrdersInt = setInterval(this.gcOrders, 60000 * 5)
+    this.gcOffersInt = setInterval(this.gcOffers, 60000 * 5)
+    // this.checkDupOffersInt = setInterval(this.checkDupOffers, 60000 * 4.5)
+    this.loadOffersInt = setInterval(this.loadOffers, 60000 * 2)
+    // Any new timer control functions can be added here. They will be started
+    // when the server starts.
+    // this.optimizeWalletHandle = setInterval(this.exampleTimerFunc, 60000 * 60)
+    this.cleanUsageHandle = setInterval(this.cleanUsage, 60000 * 60) // 1 hour
+
+    return true
+  }
+
+  stopTimers () {
+    clearInterval(this.gcOrdersInt)
+    clearInterval(this.gcOffersInt)
+    // clearInterval(this.checkDupOffers)
+    clearInterval(this.optimizeWalletHandle)
+    clearInterval(this.cleanusageHandle)
+  }
+
+  // Garbage Collect the Orders.
+  gcOrders () {
+    try {
+      this.useCases.order.removeStaleOrders()
+      return true
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/gcOrders(): ', err)
+      return false
+    }
+  }
+
+  // Garbage Collect the Offers.
+  gcOffers () {
+    try {
+      this.useCases.offer.removeStaleOffers()
+      return true
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/gcOffers(): ', err)
+      return false
+    }
+  }
+
+  // Remove duplicate Offers
+  checkDupOffers () {
+    try {
+      this.useCases.offer.removeDuplicateOffers()
+      return true
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/checkDupOffers(): ', err)
+      return false
+    }
+  }
+
+  // Load offers From nostr .
+  async loadOffers () {
+    try {
+      await this.useCases.offer.loadOffers()
+      return true
+    } catch (err) {
+      // Do not throw an error. This is a top-level function.
+      console.log('Error in timer-controllers.js/loadOffers(): ', err)
+      return false
+    }
+  }
+
+  // Clean the usage state so that stats reflect the last 24 hours.
+  cleanUsage () {
+    try {
+      this.useCases.usage.cleanUsage()
+
+      return true
+    } catch (err) {
+      console.error('Error in time-controller.js/cleanUsage(): ', err)
+
+      // Note: Do not throw an error. This is a top-level function.
+      return false
+    }
+  }
+}
+
+export default TimerControllers

src/entities/entry.js

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