Merge pull request #77 from Permissionless-Software-Foundation/dh-nostr-adapter

feat(nostr): Added Nostr adapter

.gitignore

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

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.

bin/server.js

@@ -45,16 +45,18 @@ class Server {
       const app = new Koa()
       app.keys = [this.config.session]
 
-      // 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
-      })
+      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: ${this.config.env}`)
       console.log(`Debug level: ${this.config.debugLevel}\n`)
@@ -124,9 +126,11 @@ class Server {
       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.

config/env/common.js

@@ -1,6 +1,11 @@
 /*
   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 */
@@ -49,25 +54,68 @@ export default {
   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
-    : '',
+  // 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 : '',
@@ -88,7 +136,10 @@ export default {
       '@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
@@ -105,13 +156,8 @@ export default {
   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) : 1,
-
   // 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)
@@ -120,5 +166,20 @@ export default {
   chatPubSubChan: 'psf-ipfs-chat-001',
 
   // IPFS gateway
-  ipfsGateway: process.env.IPFS_GATEWAY ? process.env.IPFS_GATEWAY : 'https://p2wdb-gateway-678.fullstack.cash/ipfs/'
+  ipfsGateway: process.env.IPFS_GATEWAY ? process.env.IPFS_GATEWAY : 'https://p2wdb-gateway-678.fullstack.cash/ipfs/',
+
+  // 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/test.js

@@ -8,5 +8,6 @@ export default {
   session: 'secret-boilerplate-token',
   token: 'secret-jwt-token',
   database: 'mongodb://localhost:27017/bch-swap-service-test',
-  env: 'test'
+  env: 'test',
+  nostrRelay: 'wss://'
 }

config/index.js

@@ -14,8 +14,4 @@ if (env === 'test') {
   config = production
 }
 
-// const importStr = `./env/${env}.js`
-// console.log('importStr: ', importStr)
-// import config from importStr
-
 export default Object.assign({}, common, config)

config/passport.js

@@ -53,7 +53,4 @@ function applyPassportMods (passport) {
   return true
 }
 
-// For testing
-// export default { passport, passportCallback };
-// export default applyPassportMods
 export { applyPassportMods, passportCallback }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bch-dex",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "A DEX on BCH for trading SLP tokens.",
   "main": "index.js",
   "type": "module",
@@ -28,15 +28,33 @@
   },
   "repository": "Permissionless-Software-Foundation/bch-dex",
   "dependencies": {
+    "@chainsafe/libp2p-gossipsub": "13.1.1",
+    "@chainsafe/libp2p-noise": "15.1.1",
+    "@chainsafe/libp2p-yamux": "6.0.2",
     "@chris.troutner/retry-queue": "1.0.8",
-    "@psf/bch-js": "6.5.1",
+    "@helia/unixfs": "3.0.7",
+    "@libp2p/bootstrap": "10.1.5",
+    "@libp2p/circuit-relay-v2": "1.1.5",
+    "@libp2p/identify": "2.1.5",
+    "@libp2p/keychain": "4.1.5",
+    "@libp2p/logger": "4.0.20",
+    "@libp2p/tcp": "9.1.5",
+    "@libp2p/webrtc": "4.1.7",
+    "@libp2p/websockets": "8.2.0",
+    "@multiformats/multiaddr": "12.3.0",
+    "@psf/bch-js": "6.7.3",
     "axios": "0.27.2",
     "bch-message-lib": "2.2.1",
+    "bch-nostr": "1.3.1",
     "bch-token-sweep": "2.2.1",
     "bcryptjs": "2.4.3",
     "bitcoincashjs-lib": "3.3.3",
+    "blockstore-fs": "2.0.0",
+    "datastore-fs": "9.1.7",
     "glob": "7.1.6",
-    "ipfs-coord-esm": "9.1.3",
+    "helia": "4.2.5",
+    "helia-coord": "1.5.15",
+    "ipfs-coord-esm": "9.1.7",
     "ipfs-http-client": "58.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
@@ -52,15 +70,15 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "0.36.2",
+    "libp2p": "1.9.1",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "5.5.5",
+    "minimal-slp-wallet": "5.12.0",
     "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",
     "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"
   },
@@ -70,6 +88,7 @@
     "chai": "4.3.0",
     "coveralls": "2.11.4",
     "husky": "4.3.8",
+    "lodash.clonedeep": "4.5.0",
     "mocha": "10.0.0",
     "semantic-release": "19.0.3",
     "sinon": "9.2.4",

production/docker/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=ipfs-service-provider

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

@@ -29,6 +29,6 @@ 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
+#export P2WDB_URL=http://172.17.0.1:5667
 
 npm start

production/docker/docker-compose.yml

@@ -46,11 +46,11 @@ services:
     #build:
     #  context: ./p2wdb/
     #  dockerfile: Dockerfile
-    image: christroutner/p2wdb:v3.1.8
+    image: christroutner/p2wdb:v4.1.3
     container_name: p2wdb
     environment:
       CONSUMER_URL: 'https://free-bch.fullstack.cash'
-      ENABLE_BCH_PAYMENT: 1
+      #ENABLE_BCH_PAYMENT: 1
       DEBUG_LEVEL: 1
     logging:
       driver: 'json-file'
@@ -68,14 +68,14 @@ services:
     volumes:
       - ../data/ipfsdata/p2wdb:/home/safeuser/ipfs-p2wdb-service/.ipfsdata/p2wdb
       - ./p2wdb/start-production.sh:/home/safeuser/ipfs-p2wdb-service/start-production.sh
-      - ../scripts/wallet.json:/home/safeuser/ipfs-p2wdb-service/wallet.json
+      #- ../scripts/wallet.json:/home/safeuser/ipfs-p2wdb-service/wallet.json
     restart: always
 
   bch-dex:
     #build:
     #  context: ./bch-dex/
     #  dockerfile: Dockerfile
-    image: christroutner/bch-dex:v2.2.3
+    image: christroutner/bch-dex:v2.2.4
     container_name: bch-dex
     environment:
       CONSUMER_URL: 'https://free-bch.fullstack.cash'
@@ -108,7 +108,7 @@ services:
       options:
         max-size: '10m'
         max-file: '10'
-    mem_limit: 500mb
+    mem_limit: 1000mb
     links:
       - bch-dex
     ports:

production/rpi-docker/bch-dex/Dockerfile

@@ -12,9 +12,12 @@ 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
+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
@@ -34,7 +37,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/

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/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-wallet.js

@@ -2,8 +2,6 @@
   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.
-
-  This script will sweep BCH and fungible (Type 1) tokens, but not NFTs.
 */
 
 // Public npm libraries

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/index.js

@@ -9,22 +9,21 @@ import BCHJS from '@psf/bch-js'
 
 // Load individual adapter libraries.
 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')
 import JSONFiles from './json-files.js'
-
 import FullStackJWT from './fullstack-jwt.js'
 import config from '../../config/index.js'
+// import Wallet from './wallet.adapter.js'
 
 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 = {}) {
@@ -43,6 +42,9 @@ class Adapters {
     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)
@@ -50,14 +52,22 @@ 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.
       // Do not start these adapters if this is an e2e test.
       // if (this.config.env !== 'test') {
@@ -66,6 +76,8 @@ class Adapters {
 
       // Open the wallet file
       const walletData = await this.wallet.openWallet()
+      await this.nostr.start(walletData.privateKey)
+
       // console.log('walletData: ', walletData)
 
       if (this.config.env !== 'test') {
@@ -73,11 +85,18 @@ class Adapters {
         await this.wallet.instanceWallet(walletData, this.bchjs)
 
         // Wait until a webhook is established with the P2WDB
-        await this.webhook.waitUntilSuccess(this.config.webhookTarget)
+        // 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.')

src/adapters/ipfs/index.js

@@ -58,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
+    }
+  }
 }
 
 export default IPFS

src/adapters/ipfs/ipfs-coord.js

@@ -5,11 +5,12 @@
 */
 
 // Global npm libraries
-import IpfsCoord from 'ipfs-coord-esm'
+// import IpfsCoord from 'ipfs-coord-esm'
+import IpfsCoord from 'helia-coord'
 
 // import BCHJS from '@psf/bch-js';
 import SlpWallet from 'minimal-slp-wallet'
-import publicIp from 'public-ip'
+import { publicIpv4 } from 'public-ip'
 
 // Local libraries
 import config from '../../../config/index.js'
@@ -34,7 +35,7 @@ class IpfsCoordAdapter {
     // 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
@@ -51,7 +52,7 @@ class IpfsCoordAdapter {
     // 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
@@ -64,23 +65,28 @@ class IpfsCoordAdapter {
       }
     }
 
+    const nullLog = () => {}
+
     const ipfsCoordOptions = {
       ipfs: this.ipfs,
       type: 'node.js',
       // type: 'browser',
       wallet: this.wallet,
-      privateLog: console.log, // Default to console.log
+      // 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)
 
@@ -107,9 +113,12 @@ class IpfsCoordAdapter {
 
   // 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,
-      console.log,
+      nullLog,
       this.ipfsCoord.thisNode
     )
   }

src/adapters/ipfs/ipfs.js

@@ -9,95 +9,95 @@
 */
 
 // Global npm libraries
-// const IPFS = require('ipfs')
-// const IPFS = require('@chris.troutner/ipfs')
-// import IPFSembedded from 'ipfs';
-
-import { create } from 'ipfs-http-client'
+import { createHelia } from 'helia'
 import fs from 'fs'
-import http from 'http'
+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 } from '@libp2p/identify'
+// import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+import { gossipsub } from '@chainsafe/libp2p-gossipsub'
+import { webSockets } from '@libp2p/websockets'
+import { publicIpv4 } from 'public-ip'
+import { multiaddr } from '@multiformats/multiaddr'
+// import { webRTC } from '@libp2p/webrtc'
+import { keychain } from '@libp2p/keychain'
+import { defaultLogger } from '@libp2p/logger'
+import { unixfs } from '@helia/unixfs'
 
 // Local libraries
 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
     this.fs = fs
-    this.create = create
-
-    // Choose the IPFS constructor based on the config settings.
-    // this.IPFS = IPFSembedded // default
-    // if (this.config.isProduction) {
-    //   this.IPFS = IPFSexternal
-    // }
+    this.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
+
+    // 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.getSeed = this.getSeed.bind(this)
+    this.getKeychain = this.getKeychain.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.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()')
@@ -111,31 +111,175 @@ class IpfsAdapter {
     }
   }
 
+  async getKeychain (datastore) {
+    const keychainInit = {
+      pass: await this.getSeed()
+    }
+
+    const chain = this.keychain(keychainInit)({
+      datastore,
+      logger: defaultLogger()
+    })
+
+    return chain
+  }
+
+  // This function creates an IPFS node using Helia.
+  // It returns the node as an object.
+  async createNode () {
+    try {
+      // Create block and data stores.
+      const blockstore = new FsBlockstore(`${IPFS_DIR}/blockstore`)
+      const datastore = new FsDatastore(`${IPFS_DIR}/datastore`)
+
+      // const keychainInit = {
+      //   pass: await this.getSeed()
+      // }
+
+      // Create an identity
+      let peerId
+      // console.log('this.keychain: ', this.keychain)
+      // const chain = this.keychain(keychainInit)({
+      //   datastore,
+      //   logger: defaultLogger()
+      // })
+      const chain = await this.getKeychain(datastore)
+      try {
+        peerId = await chain.exportPeerId('myKey')
+      } catch (err) {
+        await chain.createKey('myKey', 'Ed25519', 4096)
+        peerId = await chain.exportPeerId('myKey')
+      }
+
+      // Configure services
+      const services = {
+        identify: identify(),
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true })
+      }
+      if (this.config.isCircuitRelay) {
+        console.log('Helia (IPFS) node IS configured as Circuit Relay')
+        services.relay = circuitRelayServer({ // makes the node function as a relay server
+          hopTimeout: 30 * 1000, // incoming relay requests must be resolved within this time limit
+          advertise: true,
+          reservations: {
+            maxReservations: 15, // how many peers are allowed to reserve relay slots on this server
+            reservationClearInterval: 300 * 1000, // how often to reclaim stale reservations
+            applyDefaultLimit: true, // whether to apply default data/duration limits to each relayed connection
+            defaultDurationLimit: 2 * 60 * 1000, // the default maximum amount of time a relayed connection can be open for
+            defaultDataLimit: BigInt(2 << 7), // the default maximum number of bytes that can be transferred over a relayed connection
+            maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
+            maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
+          }
+        })
+      } else {
+        console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
+      }
+
+      const transports = [
+        tcp(),
+        webSockets()
+        // circuitRelayTransport({
+        //   discoverRelays: 3,
+        //   reservationConcurrency: 3
+        // }),
+        // webRTC()
+      ]
+
+      // libp2p is the networking layer that underpins Helia
+      const libp2p = await this.createLibp2p({
+        peerId,
+        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'
+          ]
+        },
+        transports,
+        connectionEncryption: [
+          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
+    }
+  }
+
   async stop () {
     await this.ipfs.stop()
 
     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 () {
-  //  try {
-  //    const dir = `${IPFS_DIR}/blocks`
-  //    console.log(`Deleting ${dir} directory...`)
-  //
-  //    this.fs.rmdirSync(dir, { recursive: true })
-  //
-  //    console.log(`${dir} directory is deleted!`)
-  //
-  //    return true // Signal successful execution.
-  //  } catch (err) {
-  //    console.log('Error in rmBlocksDir()')
-  //    throw err
-  //  }
-  // }
+  // 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 {
+      !this.fs.existsSync(`${ROOT_DIR}.ipfsdata`) && this.fs.mkdirSync(`${ROOT_DIR}.ipfsdata`)
+
+      !this.fs.existsSync(`${IPFS_DIR}`) && this.fs.mkdirSync(`${IPFS_DIR}`)
+
+      !this.fs.existsSync(`${IPFS_DIR}/blockstore`) && this.fs.mkdirSync(`${IPFS_DIR}/blockstore`)
+
+      !this.fs.existsSync(`${IPFS_DIR}/datastore`) && this.fs.mkdirSync(`${IPFS_DIR}/datastore`)
+
+      // !fs.existsSync(`${IPFS_DIR}/datastore/peers`) && fs.mkdirSync(`${IPFS_DIR}/datastore/peers`)
+
+      return true
+    } catch (err) {
+      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
+    }
+  }
 }
 
 export default IpfsAdapter

src/adapters/nostr.js

@@ -0,0 +1,120 @@
+/*
+  Adapter library for working with Nostr.
+*/
+
+import BchNostr from 'bch-nostr'
+import { RelayPool } from 'nostr'
+
+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
+
+    // Bind the 'this' object
+    this.start = this.start.bind(this)
+    this.post = this.post.bind(this)
+    this.read = this.read.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.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) => {
+          messages.push(ev.content)
+        })
+      })
+
+      const messages = await nostrData
+
+      return messages
+    } catch (error) {
+      console.log(`Error in nostr.js/read() ${error.message} `)
+      throw error
+    }
+  }
+}
+
+export default NostrAdapter

src/adapters/wallet.adapter.js

@@ -0,0 +1,244 @@
+/*
+  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 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

@@ -34,6 +34,7 @@ class WalletAdapter {
     this.bitcoinJs = bitcoinJs
     this.BchWallet = BchWallet
     this.bchWallet = {} // Will be replaced when initialized.
+    // this.advancedConfig = localConfig.advancedConfig
 
     // Bind the 'this' object
     this.moveTokens = this.moveTokens.bind(this)

src/controllers/index.js

@@ -6,28 +6,21 @@
 
 // Public npm libraries.
 
-// Load the Clean Architecture Adapters library
+// Local libraries
 import Adapters from '../adapters/index.js'
-
-// Load the JSON RPC Controller.
 import JSONRPC from './json-rpc/index.js'
-
-// Load the Clean Architecture Use Case libraries.
 import UseCases from '../use-cases/index.js'
-
-// const useCases = new UseCases({ adapters })
-
-// Load the REST API Controllers.
 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
   }
 
   // Spin up any adapter libraries that have async startup needs.
@@ -54,8 +47,13 @@ class Controllers {
 
   // Attach any other controllers other than REST API controllers.
   async attachControllers (app) {
+    if (this.config.useIpfs) {
+      // Attach JSON RPC controllers
+      this.attachRPCControllers()
+    }
 
-    // this.attachRPCControllers()
+    // Attach and start the timer controllers
+    this.timerControllers.startTimers()
   }
 
   // Add the JSON RPC router to the ipfs-coord adapter.

src/controllers/rest-api/index.js

@@ -11,6 +11,8 @@ 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'
@@ -32,7 +34,8 @@ class RESTControllers {
       )
     }
 
-    // console.log('Controllers localConfig: ', localConfig)
+    // Encapsulate dependencies
+    this.config = config
   }
 
   attachRESTControllers (app) {
@@ -41,13 +44,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)
@@ -57,6 +62,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)

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/users/controller.js

@@ -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)
     }
   }

src/controllers/timer-controllers.js

@@ -3,8 +3,7 @@
   kicked off periodicially.
 */
 
-// Used to retain scope of 'this', when the scope is lost.
-let _this
+import config from '../../config/index.js'
 
 class TimerControllers {
   constructor (localConfig = {}) {
@@ -23,23 +22,39 @@ class TimerControllers {
     }
 
     this.debugLevel = localConfig.debugLevel
+    this.config = config
 
-    _this = this
+    // 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)
+
+    // State
+    this.gcOrdersInt = null
+    this.gcOffersInt = null
+    this.checkDupOffersInt = null
 
     this.startTimers()
   }
 
   // Start all the time-based controllers.
   startTimers () {
-    setInterval(this.gcOrders, 60000 * 5)
-    setInterval(this.gcOffers, 60000 * 5)
-    setInterval(this.checkDupOffers, 60000 * 4.5)
+    this.gcOrdersInt = setInterval(this.gcOrders, 60000 * 5)
+    this.gcOffersInt = setInterval(this.gcOffers, 60000 * 5)
+    this.checkDupOffersInt = setInterval(this.checkDupOffers, 60000 * 4.5)
+  }
+
+  stopTimers () {
+    clearInterval(this.gcOrdersInt)
+    clearInterval(this.gcOffersInt)
+    clearInterval(this.checkDupOffers)
   }
 
   // Garbage Collect the Orders.
   gcOrders () {
     try {
-      _this.useCases.order.removeStaleOrders()
+      this.useCases.order.removeStaleOrders()
     } catch (err) {
       // Do not throw an error. This is a top-level function.
       console.log('Error in timer-controllers.js/gcOrders(): ', err)
@@ -49,7 +64,7 @@ class TimerControllers {
   // Garbage Collect the Offers.
   gcOffers () {
     try {
-      _this.useCases.offer.removeStaleOffers()
+      this.useCases.offer.removeStaleOffers()
     } catch (err) {
       // Do not throw an error. This is a top-level function.
       console.log('Error in timer-controllers.js/gcOffers(): ', err)
@@ -59,7 +74,7 @@ class TimerControllers {
   // Remove duplicate Offers
   checkDupOffers () {
     try {
-      _this.useCases.offer.removeDuplicateOffers()
+      this.useCases.offer.removeDuplicateOffers()
     } catch (err) {
       // Do not throw an error. This is a top-level function.
       console.log('Error in timer-controllers.js/checkDupOffers(): ', err)

src/use-cases/index.js

@@ -28,15 +28,9 @@ class UseCases {
 
   // Run any startup Use Cases at the start of the app.
   async start () {
-    // try {
     console.log('Async Use Cases have been started.')
 
     return true
-    // } catch (err) {
-    //   console.error('Error in use-cases/index.js/start()')
-    //   // console.log(err)
-    //   throw err
-    // }
   }
 }
 

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

@@ -13,7 +13,6 @@ import axios from 'axios'
 
 // Local support libraries
 import config from '../../../config/index.js'
-
 import Server from '../../../bin/server.js'
 import testUtils from '../../utils/test-utils.js'
 import AdminLib from '../../../src/adapters/admin.js'
@@ -24,105 +23,107 @@ const context = {}
 
 const LOCALHOST = `http://localhost:${config.port}`
 
-describe('Auth', () => {
-  before(async () => {
-    const app = new Server()
+if (!config.noMongo) {
+  describe('Auth', () => {
+    before(async () => {
+      const app = new Server()
 
-    // This should be the first instruction. It starts the REST API server.
-    await app.startServer()
+      // This should be the first instruction. It starts the REST API server.
+      await app.startServer()
 
-    // Stop the IPFS node for the rest of the e2e tests.
-    // await app.controllers.adapters.ipfs.stop()
+      // Stop the IPFS node for the rest of the e2e tests.
+      // await app.controllers.adapters.ipfs.stop()
 
-    // Delete all previous users in the database.
-    await testUtils.deleteAllUsers()
+      // Delete all previous users in the database.
+      await testUtils.deleteAllUsers()
 
-    // Create a new admin user.
-    await adminLib.createSystemUser()
+      // Create a new admin user.
+      await adminLib.createSystemUser()
 
-    const userObj = {
-      email: 'test@test.com',
-      password: 'pass',
-      name: 'test'
-    }
-    const testUser = await testUtils.createUser(userObj)
-    // console.log('TestUser: ', testUser)
-
-    context.user = testUser.user
-    context.token = testUser.token
-  })
-
-  describe('POST /auth', () => {
-    it('should throw 401 if credentials are incorrect', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'test@test.com',
-            password: 'wrongpassword'
-          }
-        }
-
-        const result = await axios(options)
-
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        console.log(
-          `result stringified: ${JSON.stringify(result.data, null, 2)}`
-        )
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert(err.response.status === 401, 'Error code 401 expected.')
+      const userObj = {
+        email: 'test@test.com',
+        password: 'pass',
+        name: 'test'
       }
+      const testUser = await testUtils.createUser(userObj)
+      // console.log('TestUser: ', testUser)
+
+      context.user = testUser.user
+      context.token = testUser.token
     })
 
-    it('should throw 401 if email is wrong format', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'wrongEmail',
-            password: 'wrongpassword'
+    describe('POST /auth', () => {
+      it('should throw 401 if credentials are incorrect', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'test@test.com',
+              password: 'wrongpassword'
+            }
           }
+
+          const result = await axios(options)
+
+          // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+          console.log(
+            `result stringified: ${JSON.stringify(result.data, null, 2)}`
+          )
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert(err.response.status === 401, 'Error code 401 expected.')
         }
+      })
 
-        await axios(options)
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert(err.response.status === 401, 'Error code 401 expected.')
-      }
-    })
-
-    it('should auth user', async () => {
-      try {
-        const options = {
-          method: 'post',
-          url: `${LOCALHOST}/auth`,
-          data: {
-            email: 'test@test.com',
-            password: 'pass'
+      it('should throw 401 if email is wrong format', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'wrongEmail',
+              password: 'wrongpassword'
+            }
           }
-        }
-        const result = await axios(options)
-        // console.log(`result: ${JSON.stringify(result.data, null, 2)}`)
 
-        assert(result.status === 200, 'Status Code 200 expected.')
-        assert(
-          result.data.user.email === 'test@test.com',
-          'Email of test expected'
-        )
-        assert(
-          result.data.user.password === undefined,
-          'Password expected to be omited'
-        )
-      } catch (err) {
-        console.log(
-          'Error authenticating test user: ' + JSON.stringify(err, null, 2)
-        )
-        throw err
-      }
+          await axios(options)
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert(err.response.status === 401, 'Error code 401 expected.')
+        }
+      })
+
+      it('should auth user', async () => {
+        try {
+          const options = {
+            method: 'post',
+            url: `${LOCALHOST}/auth`,
+            data: {
+              email: 'test@test.com',
+              password: 'pass'
+            }
+          }
+          const result = await axios(options)
+          // console.log(`result: ${JSON.stringify(result.data, null, 2)}`)
+
+          assert(result.status === 200, 'Status Code 200 expected.')
+          assert(
+            result.data.user.email === 'test@test.com',
+            'Email of test expected'
+          )
+          assert(
+            result.data.user.password === undefined,
+            'Password expected to be omited'
+          )
+        } catch (err) {
+          console.log(
+            'Error authenticating test user: ' + JSON.stringify(err, null, 2)
+          )
+          throw err
+        }
+      })
     })
   })
-})
+}

test/e2e/automated/a09-admin.rest-e2e.js

@@ -2,6 +2,8 @@ import { assert } from 'chai'
 import Admin from '../../../src/adapters/admin.js'
 import sinon from 'sinon'
 import util from 'util'
+import config from '../../../config/index.js'
+
 util.inspect.defaultOptions = { depth: 1 }
 
 let sandbox
@@ -15,101 +17,103 @@ describe('Admin', () => {
 
   afterEach(() => sandbox.restore())
 
-  describe('loginAdmin()', () => {
-    it('should logind admin', async () => {
-      try {
-        const error = new Error('test error')
-        error.response = {
-          status: 422
+  if (!config.noMongo) {
+    describe('loginAdmin()', () => {
+      it('should logind admin', async () => {
+        try {
+          const error = new Error('test error')
+          error.response = {
+            status: 422
+          }
+          // sandbox.stub(uut.axios, 'request').onFirstCall().throws(error)
+
+          const result = await uut.loginAdmin()
+          const user = result.data.user
+
+          assert.property(user, '_id')
+          assert.property(user, 'email')
+          assert.property(user, 'type')
+
+          assert.isString(user._id)
+          assert.isString(user.email)
+          assert.isString(user.type)
+
+          assert.equal(user.type, 'admin')
+        } catch (err) {
+          assert(false, 'Unexpected result')
         }
-        // sandbox.stub(uut.axios, 'request').onFirstCall().throws(error)
+      })
 
-        const result = await uut.loginAdmin()
-        const user = result.data.user
+      it('should handle axios error', async () => {
+        try {
+          // Returns an erroneous password to force
+          // an auth error
+          sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
 
-        assert.property(user, '_id')
-        assert.property(user, 'email')
-        assert.property(user, 'type')
-
-        assert.isString(user._id)
-        assert.isString(user.email)
-        assert.isString(user.type)
-
-        assert.equal(user.type, 'admin')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
-    })
-
-    it('should handle axios error', async () => {
-      try {
-        // Returns an erroneous password to force
-        // an auth error
-        sandbox.stub(uut.jsonFiles, 'readJSON').resolves({ password: 'wrong' })
-
-        await uut.loginAdmin()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.equal(err.response.status, 401)
-        assert.include(err.response.data, 'Unauthorized')
-      }
-    })
-  })
-
-  describe('createSystemUser()', () => {
-    it('should create admin', async () => {
-      try {
-        const result = await uut.createSystemUser()
-
-        assert.property(result, 'email')
-        assert.property(result, 'password')
-        assert.property(result, 'id')
-        assert.property(result, 'token')
-      } catch (err) {
-        assert(false, 'Unexpected result')
-      }
-    })
-
-    it('should handle axios error', async () => {
-      try {
-        const error1 = new Error('test error')
-        error1.response = {
-          status: 422
+          await uut.loginAdmin()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.equal(err.response.status, 401)
+          assert.include(err.response.data, 'Unauthorized')
         }
-        const error2 = new Error('test error')
-        error1.response = {
-          status: 500
-        }
-        // The loginAdmin() function in some use cases is recursive
-        // after handling the 422 error, it gets called again
-        sandbox
-          .stub(uut.axios, 'request')
-          .onFirstCall()
-          .throws(error1)
-          .onSecondCall()
-          .throws(error2)
-
-        await uut.createSystemUser()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.include(err.message, 'test error')
-      }
+      })
     })
 
-    it('should handle errors when remove user', async () => {
-      try {
-        const error1 = new Error('test error')
-        error1.response = {
-          status: 422
-        }
-        sandbox.stub(uut.axios, 'request').throws(error1)
-        sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
+    describe('createSystemUser()', () => {
+      it('should create admin', async () => {
+        try {
+          const result = await uut.createSystemUser()
 
-        await uut.createSystemUser()
-        assert(false, 'Unexpected result')
-      } catch (err) {
-        assert.include(err.message, 'test error')
-      }
+          assert.property(result, 'email')
+          assert.property(result, 'password')
+          assert.property(result, 'id')
+          assert.property(result, 'token')
+        } catch (err) {
+          assert(false, 'Unexpected result')
+        }
+      })
+
+      it('should handle axios error', async () => {
+        try {
+          const error1 = new Error('test error')
+          error1.response = {
+            status: 422
+          }
+          const error2 = new Error('test error')
+          error1.response = {
+            status: 500
+          }
+          // The loginAdmin() function in some use cases is recursive
+          // after handling the 422 error, it gets called again
+          sandbox
+            .stub(uut.axios, 'request')
+            .onFirstCall()
+            .throws(error1)
+            .onSecondCall()
+            .throws(error2)
+
+          await uut.createSystemUser()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
+
+      it('should handle errors when remove user', async () => {
+        try {
+          const error1 = new Error('test error')
+          error1.response = {
+            status: 422
+          }
+          sandbox.stub(uut.axios, 'request').throws(error1)
+          sandbox.stub(uut.User, 'deleteOne').throws(new Error('test error'))
+
+          await uut.createSystemUser()
+          assert(false, 'Unexpected result')
+        } catch (err) {
+          assert.include(err.message, 'test error')
+        }
+      })
     })
-  })
+  }
 })

test/unit/adapters/adapters-index-unit.js

@@ -27,6 +27,8 @@ describe('#adapters', () => {
     it('should start the async adapters', async () => {
       // Mock dependencies
       uut.config.getJwtAtStartup = true
+      uut.config.useIpfs = true
+      uut.config.env = 'not-a-test'
       sandbox.stub(uut.fullStackJwt, 'getJWT').resolves()
       sandbox.stub(uut.fullStackJwt, 'instanceBchjs').resolves()
       sandbox.stub(uut.ipfs, 'start').resolves()

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

@@ -52,7 +52,7 @@ describe('#IPFS', () => {
     it('should get the public IP address if this node is a Circuit Relay', async () => {
       // Mock dependencies.
       uut.IpfsCoord = IPFSCoordMock
-      sandbox.stub(uut.publicIp, 'v4').resolves('123')
+      sandbox.stub(uut, 'publicIp').resolves('123')
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true
@@ -66,7 +66,7 @@ describe('#IPFS', () => {
     it('should exit quietly if this node is a Circuit Relay and there is an issue getting the IP address', async () => {
       // Mock dependencies.
       uut.IpfsCoord = IPFSCoordMock
-      sandbox.stub(uut.publicIp, 'v4').rejects(new Error('test error'))
+      sandbox.stub(uut, 'publicIp').rejects(new Error('test error'))
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true

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

@@ -66,4 +66,155 @@ describe('#IPFS-adapter-index', () => {
       }
     })
   })
+
+  describe('#getStatus', () => {
+    it('should return an object with node metrics', () => {
+      // Force uut to have the needed properties
+      uut.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {
+            ipfsId: 'fake-id',
+            ipfsMultiaddrs: [],
+            bchAddr: 'fake-bch-addr',
+            slpAddr: 'fake-slp-addr',
+            pubKey: 'fake-pubkey',
+            peerList: [],
+            relayData: []
+          }
+        }
+      }
+
+      const result = uut.getStatus()
+      // console.log('result: ', result)
+
+      assert.property(result, 'ipfsId')
+      assert.property(result, 'multiAddrs')
+      assert.property(result, 'bchAddr')
+      assert.property(result, 'slpAddr')
+      assert.property(result, 'pubKey')
+      assert.property(result, 'peers')
+      assert.property(result, 'relays')
+    })
+
+    it('should catch, report, and throw errors', () => {
+      try {
+        uut.getStatus()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'Cannot read properties')
+      }
+    })
+  })
+
+  describe('#_removeDuplicatePeers', () => {
+    it('should return the same array when there are no duplicates', () => {
+      const inArray = [
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
+        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
+        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
+        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+      ]
+
+      const result = uut._removeDuplicatePeers(inArray)
+      // console.log('result: ', result)
+
+      assert.equal(result.length, inArray.length)
+    })
+
+    it('should remove duplicates from an array', () => {
+      const inArray = [
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA',
+        '12D3KooWGsgHWyDLKuV4ZSfRJfsxQJj77rxx3i8Px3qXKHsLN7a2',
+        '12D3KooWJyc54njjeZGbLew4D8u1ghrmZTTPyh3QpBF7dxtd3zGY',
+        '12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu',
+        '12D3KooWPpBXhhAeoCZCGuQ3KR4xwHzzvtP57f6zLmo8P7ZFBJFE',
+        '12D3KooWRBhwfeP2Y9CDkFRBAZ1pmxUadH36TKuk3KtKm5XXP8mA'
+      ]
+
+      const result = uut._removeDuplicatePeers(inArray)
+      // console.log('result: ', result)
+
+      assert.equal(result.length, inArray.length - 2)
+    })
+  })
+
+  describe('#getPeers', () => {
+    it('should return an array of current JSON data about each peer when showAll is true', async () => {
+      // Mock dependencies
+      uut.ipfsCoordAdapter.ipfsCoord = {
+        thisNode: {
+          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', protocol: 'test', version: '1' } } }, { from: 'b' }]
+        },
+        adapters: {
+          ipfs: {
+            getPeers: async () => ['a', 'b']
+          }
+        }
+      }
+
+      const result = await uut.getPeers(true)
+
+      assert.isArray(result)
+    })
+
+    it('should catch, report, and throw errors', async () => {
+      try {
+        // Force an error
+        uut.ipfsCoordAdapter.ipfsCoord = {
+          thisNode: {},
+          adapters: {
+            ipfs: {
+              getPeers: async () => { throw new Error('test error') }
+            }
+          }
+        }
+
+        await uut.getPeers()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getRelays', () => {
+    it('should return known relays', () => {
+      uut.ipfsCoordAdapter.ipfsCoord = {
+        thisNode: {
+          peerData: [{ from: 'a', data: { jsonLd: { name: 'a', description: 'test' } } }, { from: 'b' }],
+          relayData: [{ ipfsId: 'c' }, { ipfsId: 'a' }]
+        }
+      }
+
+      const result = uut.getRelays()
+      // console.log('result: ', result)
+
+      assert.isArray(result.v2Relays)
+      assert.equal(result.v2Relays.length, 2)
+      assert.property(result.v2Relays[0], 'name')
+      assert.property(result.v2Relays[0], 'description')
+      assert.property(result.v2Relays[1], 'name')
+      assert.property(result.v2Relays[1], 'description')
+    })
+
+    it('should catch, report, and throw errors', () => {
+      try {
+        // Force an error
+        uut.ipfsCoordAdapter.ipfsCoord = { thisNode: {} }
+
+        uut.getRelays()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err.message: ', err.message)
+        assert.include(err.message, 'Cannot read')
+      }
+    })
+  })
 })

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

@@ -2,21 +2,29 @@
   Unit tests for the IPFS Adapter.
 */
 
+// Global npm libraries
 import { assert } from 'chai'
-
 import sinon from 'sinon'
+import cloneDeep from 'lodash.clonedeep'
+import { peerIdFromString } from '@libp2p/peer-id'
+
+// Local libraries
 import IPFSLib from '../../../src/adapters/ipfs/ipfs.js'
-import create from '../mocks/ipfs-mock.js'
+// import create from '../mocks/ipfs-mock.js'
 import config from '../../../config/index.js'
+import createHeliaLib from '../mocks/helia-mock.js'
 
 // config.isProduction =  true;
 describe('#IPFS-adapter', () => {
   let uut
   let sandbox
+  let ipfs
 
   beforeEach(() => {
     uut = new IPFSLib()
 
+    ipfs = cloneDeep(createHeliaLib)
+
     sandbox = sinon.createSandbox()
   })
 
@@ -45,35 +53,28 @@ describe('#IPFS-adapter', () => {
   describe('#start', () => {
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
-      uut.create = create
+      sandbox.stub(uut, 'createNode').resolves(ipfs)
+      sandbox.stub(uut, 'publicIp').resolves('192.168.2.4')
+      sandbox.stub(uut, 'multiaddr').returns('/ip4/fake-multiaddr')
 
       const result = await uut.start()
       // console.log('result: ', result)
 
+      // Assert properties of the instance are set.
       assert.equal(uut.isReady, true)
+      assert.property(uut, 'multiaddrs')
+      assert.property(uut, 'id')
 
-      assert.property(result, 'config')
-    })
-
-    it('should return a promise that resolves into an instance of IPFS in production mode.', async () => {
-      // Mock dependencies.
-      uut.create = create
-      uut.config.isProduction = true
-      const result = await uut.start()
-      // console.log('result: ', result)
-
-      assert.equal(uut.isReady, true)
-
-      assert.property(result, 'config')
+      // Output should be an instance of IPFS
+      assert.property(result, 'libp2p')
     })
 
     it('should catch and throw an error', async () => {
       try {
         // Force an error
-        sandbox.stub(uut, 'create').rejects(new Error('test error'))
+        sandbox.stub(uut, 'createNode').rejects(new Error('test error'))
 
         await uut.start()
-
         assert.fail('Unexpected code path.')
       } catch (err) {
         // console.log(err)
@@ -96,24 +97,146 @@ describe('#IPFS-adapter', () => {
     })
   })
 
-// describe('#rmBlocksDir', () => {
-//   it('should delete the /blocks directory', () => {
-//     const result = uut.rmBlocksDir()
-//
-//     assert.equal(result, true)
-//   })
-//
-//   it('should catch and throw an error', () => {
-//     try {
-//       // Force an error
-//       sandbox.stub(uut.fs, 'rmdirSync').throws(new Error('test error'))
-//
-//       uut.rmBlocksDir()
-//
-//       assert.fail('Unexpected code path')
-//     } catch (err) {
-//       assert.equal(err.message, 'test error')
-//     }
-//   })
-// })
+  describe('#ensureBlocksDir', () => {
+    it('should create directory if it does not exist', () => {
+      // Force desired code path
+      sandbox.stub(uut.fs, 'existsSync').returns(false)
+      sandbox.stub(uut.fs, 'mkdirSync').returns(true)
+
+      const result = uut.ensureBlocksDir()
+
+      assert.equal(result, true)
+    })
+
+    it('should report and throw errors', () => {
+      // Force an error
+      sandbox.stub(uut.fs, 'existsSync').throws(new Error('test error'))
+
+      try {
+        uut.ensureBlocksDir()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#createNode', () => {
+    it('should report and throw errors', async () => {
+      // Force an error
+      sandbox.stub(uut, 'createLibp2p').rejects(new Error('test error'))
+
+      try {
+        await uut.createNode()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should create an IPFS node from Helia', async () => {
+      uut.config.isCircuitRelay = false
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+
+    it('should create a Circuit Relay if configured', async () => {
+      uut.config.isCircuitRelay = true
+      const result = await uut.createNode()
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+
+    it('should create a new private key on first run', async () => {
+      uut.config.isCircuitRelay = false
+
+      // Mock dependencies and force desired code path.
+      let beenCalled = false
+      sandbox.stub(uut, 'getKeychain').resolves({
+        exportPeerId: async () => {
+          if (!beenCalled) {
+            beenCalled = true
+            throw new Error('test error')
+          }
+          return peerIdFromString('12D3KooWSXF1PnEfiA8bCG8SJduCvzdwHtvhVPK4WC6zzDoto2XP')
+        },
+        createKey: async () => {}
+      })
+      sandbox.stub(uut, 'createLibp2p').resolves()
+      sandbox.stub(uut, 'createHelia').resolves({})
+
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      assert.property(result, 'fs')
+    })
+
+    it('should not use circuit relay when CONNECT_PREF is set to direct', async () => {
+      process.env.CONNECT_PREF = 'direct'
+
+      uut.config.isCircuitRelay = false
+      const result = await uut.createNode()
+      // console.log('result: ', result)
+
+      delete process.env.CONNECT_PREF
+
+      // Assert the returned IPFS node has expected properties
+      assert.property(result, 'libp2p')
+      assert.property(result, 'blockstore')
+
+      // Stop the IPFS node
+      await result.stop()
+    })
+  })
+
+  describe('#getSeed', () => {
+    it('should read the seed from the JSON file', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.jsonFiles, 'readJSON').resolves('12345678')
+
+      const result = await uut.getSeed()
+      // console.log('result: ', result)
+
+      assert.isString(result)
+    })
+
+    it('should generate a new seed if the JSON file is not found', async () => {
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.jsonFiles, 'readJSON').rejects(new Error('test error'))
+      sandbox.stub(uut.jsonFiles, 'writeJSON').resolves()
+
+      const result = await uut.getSeed()
+      // console.log('result: ', result)
+
+      assert.isString(result)
+    })
+
+    it('should catch, report, and throw errors', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.jsonFiles, 'readJSON').rejects(new Error('test error'))
+        sandbox.stub(uut.jsonFiles, 'writeJSON').rejects(new Error('test error'))
+
+        await uut.getSeed()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
 })

test/unit/adapters/nostr.adapter.unit.js

@@ -0,0 +1,131 @@
+/*
+  Unit tests for the Nostr Adapter library.
+*/
+
+// Public npm libraries.
+import { assert } from 'chai'
+import sinon from 'sinon'
+import NostrAdapter from '../../../src/adapters/nostr.js'
+import NostrMock from '../mocks/nostr-mock.js'
+
+describe('#nostr.js', () => {
+  let uut
+  let sandbox
+
+  before(() => {})
+
+  beforeEach(() => {
+    uut = new NostrAdapter({
+      nostrRelay: 'wss://nostr',
+      nostrTopic: 'uut-topic'
+    })
+    uut.RelayPool = NostrMock.RelayPoolMock
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  after(() => {})
+
+  describe('#contructor', () => {
+    it('should throw an error if nostr relay is not provided', async () => {
+      try {
+        const _uut = new NostrAdapter()
+        // Eslint
+        console.log(_uut)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(
+          err.message,
+          '"nostrRelay" must be passed when instantiate NostrAdapter'
+        )
+      }
+    })
+    it('should throw an error if nostr topic is not provided', async () => {
+      try {
+        const _uut = new NostrAdapter({ nostrRelay: 'wss://' })
+        // Eslint
+        console.log(_uut)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(
+          err.message,
+          '"nostrTopic" must be passed when instantiate NostrAdapter'
+        )
+      }
+    })
+  })
+  describe('#start', () => {
+    it('should throw an error if WIF is not provided', async () => {
+      try {
+        await uut.start()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'WIF must be a string!')
+      }
+    })
+    it('should start adapter', async () => {
+      // Stub bchNostr
+      sandbox
+        .stub(uut.bchNostr.keys, 'createNostrPubKeyFromWif')
+        .returns({ privKeyBuf: 'privKeyBuf', nostrPubKey: 'nostrPubKey' })
+
+      const result = await uut.start('WIF')
+      assert.isTrue(result)
+    })
+  })
+
+  describe('#post', () => {
+    it('should throw an error if msg is not provided', async () => {
+      try {
+        await uut.post()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'msg must be a string!')
+      }
+    })
+    it('should post message', async () => {
+      const evId = 'uut-eventId' // Mock
+
+      sandbox.stub(uut.bchNostr.post, 'uploadToNostr').resolves(evId)
+
+      const result = await uut.post('uut-message')
+      assert.isString(result)
+      assert.equal(result, evId)
+    })
+  })
+
+  describe('#read', () => {
+    it('should throw an error if provided limit is wrong', async () => {
+      try {
+        await uut.read(-5)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'Limit must be greater than 0')
+      }
+    })
+
+    it('should read message', async () => {
+      const result = await uut.read()
+      assert.isArray(result)
+      assert.equal(result.length, 1)
+    })
+
+    it('should read message with custom limit', async () => {
+      const result = await uut.read(1)
+      assert.isArray(result)
+      assert.equal(result.length, 1)
+    })
+  })
+})

test/unit/adapters/wallet.adapter.unit.js

@@ -2,16 +2,14 @@
   Unit tests for the Wallet Adapter library.
 */
 
-// Public npm libraries.
+// Global npm libraries
 import { assert } from 'chai'
 import sinon from 'sinon'
+import BchWallet from 'minimal-slp-wallet'
 import fs from 'fs'
 
-// const BCHJS = require('@psf/bch-js')
-
-// Local libraries.
-import WalletAdapter from '../../../src/adapters/wallet.js'
-
+// Local libraries
+import WalletAdapter from '../../../src/adapters/wallet.adapter.js'
 import { MockBchWallet } from '../mocks/adapters/wallet.js'
 
 // Hack to get __dirname back.
@@ -20,7 +18,7 @@ import * as url from 'url'
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 // Global constants
-const testWalletFile = `${__dirname.toString()}/test-wallet.json`
+const testWalletFile = `${__dirname.toString()}test-wallet.json`
 
 describe('#wallet', () => {
   let uut
@@ -30,7 +28,7 @@ describe('#wallet', () => {
     // Delete the test file if it exists.
     try {
       deleteFile(testWalletFile)
-    } catch (err) {}
+    } catch (err) { }
   })
 
   beforeEach(() => {
@@ -44,20 +42,26 @@ describe('#wallet', () => {
     // Delete the test file if it exists.
     try {
       deleteFile(testWalletFile)
-    } catch (err) {}
+    } catch (err) { }
+  })
+
+  describe('#_instanceWallet', () => {
+    it('should create a wallet given a mnemonic', async () => {
+      const mnemonic = 'wagon tray learn flat erase laugh lonely rug check captain jacket morning'
+      const result = await uut._instanceWallet(mnemonic)
+      // console.log('result: ', result)
+      assert.equal(result.walletInfo.mnemonic, mnemonic)
+    })
   })
 
   describe('#openWallet', () => {
-    it('should create a new wallet what wallet file does not exist', async () => {
+    it('should create a new wallet when wallet file does not exist', async () => {
       // Mock dependencies
       uut.BchWallet = MockBchWallet
-
       // Ensure we open the test file, not the production wallet file.
-      uut.WALLET_FILE = testWalletFile
-
+      uut.config.walletFile = testWalletFile
       const result = await uut.openWallet()
       // console.log('result: ', result)
-
       assert.property(result, 'mnemonic')
       assert.property(result, 'privateKey')
       assert.property(result, 'publicKey')
@@ -70,13 +74,10 @@ describe('#wallet', () => {
 
     it('should open existing wallet file', async () => {
       // This test case uses the file created in the previous test case.
-
       // Ensure we open the test file, not the production wallet file.
-      uut.WALLET_FILE = testWalletFile
-
+      uut.config.walletFile = testWalletFile
       const result = await uut.openWallet()
       // console.log('result: ', result)
-
       assert.property(result, 'mnemonic')
       assert.property(result, 'privateKey')
       assert.property(result, 'publicKey')
@@ -90,13 +91,11 @@ describe('#wallet', () => {
     it('should catch and throw an error', async () => {
       try {
         // Force an error
-        uut.WALLET_FILE = ''
+        uut.config.walletFile = ''
         uut.BchWallet = () => {
         }
-
         await uut.openWallet()
         // console.log('result: ', result)
-
         assert.fail('Unexpected code path')
       } catch (err) {
         // console.log('err: ', err)
@@ -105,113 +104,158 @@ describe('#wallet', () => {
     })
   })
 
-  describe('#instanceWallet', () => {
-    // it('should create an instance of BchWallet', async () => {
-    //   // Mock dependencies
-    //   uut.BchWallet = MockBchWallet
-    //
-    //   // Ensure we open the test file, not the production wallet file.
-    //   uut.WALLET_FILE = testWalletFile
-    //
-    //   const walletData = await uut.openWallet()
-    //
-    //   const result = await uut.instanceWallet(walletData.mnemonic)
-    //   console.log('result: ', result)
-    //
-    //   assert.property(result, 'walletInfoPromise')
-    // })
+  describe('#instanceWalletWithoutInitialization', () => {
+    it('should create an instance of BchWallet', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+      uut.config.authPass = 'fake-auth-pass'
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+
+      // console.log('walletData: ', walletData)
+      const result = await uut.instanceWalletWithoutInitialization(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
 
     it('should catch and throw an error', async () => {
       try {
-        await uut.instanceWallet()
+        // Force an error
+        sandbox.stub(uut, '_instanceWallet').rejects(new Error('test error'))
+
+        await uut.instanceWalletWithoutInitialization()
 
         assert.fail('Unexpected code path')
       } catch (err) {
         // console.log('err: ', err)
-        assert.include(err.message, 'Cannot read')
-      }
-    })
-  })
-
-  describe('#generateSignature', () => {
-    it('should return a signature', async () => {
-      // mock instance of minimal-slp-wallet
-      uut.bchWallet = new MockBchWallet()
-
-      const result = await uut.generateSignature('test')
-      // console.log('result: ', result)
-
-      assert.isString(result)
-    })
-
-    it('should catch and throw errors', async () => {
-      try {
-        // mock instance of minimal-slp-wallet
-        uut.bchWallet = new MockBchWallet()
-
-        // force an error
-        sandbox
-          .stub(uut.bchWallet.bchjs.BitcoinCash, 'signMessageWithPrivKey')
-          .throws(new Error('test error'))
-
-        await uut.generateSignature('test')
-
-        assert.fail('Unexpected code path')
-      } catch (err) {
         assert.include(err.message, 'test error')
       }
     })
+
+    it('should create an instance of BchWallet using web2 infra', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      // Force desired code path
+      uut.config.walletInterface = 'web2'
+      const result = await uut.instanceWalletWithoutInitialization(walletData)
+
+      // console.log('result: ', result)
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+
+    it('should generate wallet from mnemonic in config', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.config.walletFile = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      const originalConfig = uut.config.mnemonic
+      uut.config.mnemonic = walletData.mnemonic
+
+      const result = await uut.instanceWalletWithoutInitialization({})
+      // console.log('result: ', result)
+
+      uut.config.mnemonic = originalConfig
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
   })
 
-  // describe('#burnPsf', () => {
-  //   it('should burn PSF tokens and return the txid', async () => {
-  //     // mock instance of minimal-slp-wallet
-  //     uut.bchWallet = new MockBchWallet()
-  //
-  //     const result = await uut.burnPsf()
-  //     // console.log('result: ', result)
-  //
-  //     assert.equal(result.success, true)
-  //     assert.equal(result.txid, 'txid')
-  //   })
-  //
-  //   it('should throw error if no PSF tokens are found', async () => {
-  //     try {
-  //       // mock instance of minimal-slp-wallet
-  //       uut.bchWallet = new MockBchWallet()
-  //
-  //       // Remove the PSF token from the mock data.
-  //       uut.bchWallet.utxos.utxoStore.slpUtxos.type1.tokens.pop()
-  //
-  //       await uut.burnPsf()
-  //
-  //       assert.fail('Unexpected code path')
-  //     } catch (err) {
-  //       assert.include(err.message, 'Token UTXO of with ID of')
-  //     }
-  //   })
-  //
-  //   it('should catch and throw an error', async () => {
-  //     try {
-  //       await uut.burnPsf()
-  //
-  //       assert.fail('Unexpected code path')
-  //     } catch (err) {
-  //       assert.include(err.message, 'Cannot read')
-  //     }
-  //   })
-  // })
+  describe('#instanceWallet', () => {
+    it('should create an instance of BchWallet', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.WALLET_FILE = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+      const result = await uut.instanceWallet(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut, 'instanceWalletWithoutInitialization').rejects(new Error('test error'))
+
+        await uut.instanceWallet()
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should create an instance of BchWallet using web2 infra', async () => {
+      // Create a mock wallet.
+      const mockWallet = new BchWallet()
+      await mockWallet.walletInfoPromise
+      sandbox.stub(mockWallet, 'initialize').resolves()
+
+      // Mock dependencies
+      sandbox.stub(uut, '_instanceWallet').resolves(mockWallet)
+
+      // Ensure we open the test file, not the production wallet file.
+      uut.WALLET_FILE = testWalletFile
+      const walletData = await uut.openWallet()
+      // console.log('walletData: ', walletData)
+
+      // Force desired code path
+      uut.config.useFullStackCash = true
+      const result = await uut.instanceWallet(walletData)
+      // console.log('result: ', result)
+
+      assert.property(result, 'walletInfoPromise')
+      assert.property(result, 'walletInfo')
+    })
+  })
 
   describe('#incrementNextAddress', () => {
     it('should increment the nextAddress property', async () => {
       // Ensure we open the test file, not the production wallet file.
       uut.WALLET_FILE = testWalletFile
-
       // mock instance of minimal-slp-wallet
       uut.bchWallet = new MockBchWallet()
-
       const result = await uut.incrementNextAddress()
-
       assert.equal(result, 2)
     })
 
@@ -219,9 +263,7 @@ describe('#wallet', () => {
       try {
         // Force an error
         sandbox.stub(uut, 'openWallet').rejects(new Error('test error'))
-
         await uut.incrementNextAddress()
-
         assert.fail('Unexpected code path')
       } catch (err) {
         assert.include(err.message, 'test error')
@@ -232,10 +274,8 @@ describe('#wallet', () => {
   describe('#getKeyPair', () => {
     it('should return an object with a key pair', async () => {
       // Ensure we open the test file, not the production wallet file.
-      uut.WALLET_FILE = testWalletFile
-
-      // mock instance of minimal-slp-wallet
-      uut.bchWallet = new MockBchWallet()
+      // uut.WALLET_FILE = testWalletFile
+      uut.config.walletFile = testWalletFile
 
       const result = await uut.getKeyPair()
       // console.log('result: ', result)
@@ -251,9 +291,7 @@ describe('#wallet', () => {
         sandbox
           .stub(uut, 'incrementNextAddress')
           .rejects(new Error('test error'))
-
         await uut.getKeyPair()
-
         assert.fail('Unexpected code path')
       } catch (err) {
         assert.include(err.message, 'test error')
@@ -261,55 +299,37 @@ describe('#wallet', () => {
     })
   })
 
-  describe('#moveTokens', () => {
-    it('should move tokens to a new address in the HD wallet', async () => {
-      // Mock dependencies
-      sandbox.stub(uut, 'getKeyPair').resolves({
-        cashAddress: 'bitcoincash:qqsj63493jk4p05zzdgqzc29k5unqtet9vv8l4x0yt',
-        wif: 'L4qKTMCwjH9jHnYtNh9Vsrxj7Hg6zmoN8E2v7N47UKvNVEjw7FU8',
-        hdIndex: 6
-      })
+  describe('#optimize', () => {
+    it('should call the wallet optimize function', async () => {
+      // mock instance of minimal-slp-wallet
       uut.bchWallet = new MockBchWallet()
-      // uut.bchWallet = {
-      //   sendTokens: async () => 'fake-txid',
-      //   getUtxos: async () => {}
-      // }
-
-      const inObj = {
-        tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
-        qty: 1
-      }
-
-      const result = await uut.moveTokens(inObj)
-      // console.log('result: ', result)
-
-      assert.property(result, 'txid')
-      assert.property(result, 'vout')
-      assert.property(result, 'hdIndex')
+      sandbox.stub(uut.bchWallet, 'optimize').resolves({ bchUtxoCnt: 10 })
+      const result = await uut.optimize()
+      assert.equal(result, true)
     })
   })
 
-  describe('#moveBch', () => {
-    it('should move BCH to a new address in the HD wallet', async () => {
-      // Mock dependencies
-      sandbox.stub(uut, 'getKeyPair').resolves({
-        cashAddress: 'bitcoincash:qqsj63493jk4p05zzdgqzc29k5unqtet9vv8l4x0yt',
-        wif: 'L4qKTMCwjH9jHnYtNh9Vsrxj7Hg6zmoN8E2v7N47UKvNVEjw7FU8',
-        hdIndex: 6
-      })
-      uut.bchWallet = {
-        send: async () => 'fake-txid',
-        getUtxos: async () => {}
-      }
-
-      const amountSat = 1000
-
-      const result = await uut.moveBch(amountSat)
+  describe('#getBalance', () => {
+    it('should get the balance for the wallet', async () => {
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      // Mock dependencies and force desired code path
+      sandbox.stub(uut.bchWallet, 'getBalance').resolves(41012)
+      sandbox.stub(uut.bchWallet, 'listTokens').resolves([{
+        tokenId: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+        ticker: 'PSF',
+        name: 'Permissionless Software Foundation',
+        decimals: 8,
+        tokenType: 1,
+        url: 'psfoundation.cash',
+        qty: 2
+      }])
+      const result = await uut.getBalance()
       // console.log('result: ', result)
-
-      assert.property(result, 'txid')
-      assert.property(result, 'vout')
-      assert.property(result, 'hdIndex')
+      // Assert the expected properties exist and have the expected values.
+      assert.equal(result.satBalance, 41012)
+      assert.equal(result.psfBalance, 2)
+      assert.equal(result.success, true)
     })
   })
 })

test/unit/controllers/controllers.unit.js

@@ -28,6 +28,9 @@ describe('#Controllers', () => {
         attachRPCRouter: () => {}
       }
 
+      // Mock the timer controllers
+      sandbox.stub(uut.timerControllers, 'startTimers').returns()
+
       const app = {
         use: () => {}
       }

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

@@ -0,0 +1,251 @@
+/*
+  Unit tests for the REST API handler for the /ipfs endpoints.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local libraries
+import IpfsApiController from '../../../../../src/controllers/rest-api/ipfs/controller.js'
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+
+import { context as mockContext } from '../../../mocks/ctx-mock.js'
+let uut
+let sandbox
+let ctx
+
+describe('#IPFS REST API', () => {
+  before(async () => {
+  })
+
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+
+    uut = new IpfsApiController({ adapters, useCases })
+
+    sandbox = sinon.createSandbox()
+
+    // Mock the context object.
+    ctx = mockContext()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new IpfsApiController()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating /ipfs REST Controller.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new IpfsApiController({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating /ipfs REST Controller.'
+        )
+      }
+    })
+  })
+
+  describe('#GET /status', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getStatus').rejects(new Error('test error'))
+
+        await uut.getStatus(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getStatus').resolves({ a: 'b' })
+
+      await uut.getStatus(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'status')
+      assert.equal(ctx.body.status.a, 'b')
+    })
+  })
+
+  describe('#POST /peers', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getPeers').rejects(new Error('test error'))
+
+        ctx.request.body = {
+          showAll: true
+        }
+
+        await uut.getPeers(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getPeers').resolves({ a: 'b' })
+
+      ctx.request.body = {
+        showAll: true
+      }
+
+      await uut.getPeers(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'peers')
+      assert.equal(ctx.body.peers.a, 'b')
+    })
+  })
+
+  describe('#POST /relays', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs, 'getRelays').rejects(new Error('test error'))
+
+        await uut.getRelays(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs, 'getRelays').resolves({ a: 'b' })
+
+      await uut.getRelays(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'relays')
+      assert.equal(ctx.body.relays.a, 'b')
+    })
+  })
+
+  describe('#POST /connect', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').rejects(new Error('test error'))
+
+        ctx.request.body = {
+          multiaddr: '/ip4/161.35.99.207/tcp/4001/p2p/12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+        }
+
+        await uut.connect(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').resolves({ success: true })
+
+      ctx.request.body = {
+        multiaddr: '/ip4/161.35.99.207/tcp/4001/p2p/12D3KooWDtj9cfj1SKuLbDNKvKRKSsGN8qivq9M8CYpLPDpcD5pu'
+      }
+
+      await uut.connect(ctx)
+      // console.log('ctx.body: ', ctx.body)
+
+      assert.property(ctx.body, 'success')
+      assert.equal(ctx.body.success, true)
+    })
+  })
+
+  describe('#handleError', () => {
+    it('should still throw error if there is no message', () => {
+      try {
+        const err = {
+          status: 404
+        }
+
+        uut.handleError(ctx, err)
+      } catch (err) {
+        assert.include(err.message, 'Not Found')
+      }
+    })
+
+    it('should throw error with message', () => {
+      try {
+        const err = {
+          status: 422,
+          message: 'test error'
+        }
+
+        uut.handleError(ctx, err)
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#getThisNode', () => {
+    it('should return 422 status on biz logic error', async () => {
+      try {
+        // Force an error
+        // sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord, 'thisNode').rejects(new Error('test error'))
+        uut.adapters.ipfs.ipfsCoordAdapter = {}
+
+        ctx.request.body = {}
+
+        await uut.getThisNode(ctx)
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.equal(err.status, 422)
+        assert.include(err.message, 'Cannot read')
+      }
+    })
+
+    it('should return 200 status on success', async () => {
+      // Mock dependencies
+      // sandbox.stub(uut.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.adapters.ipfs, 'connectToPeer').resolves({ success: true })
+
+      uut.adapters.ipfs.ipfsCoordAdapter = {
+        ipfsCoord: {
+          thisNode: {}
+        }
+      }
+
+      ctx.request.body = {}
+
+      await uut.getThisNode(ctx)
+
+      assert.property(ctx.body, 'thisNode')
+    })
+  })
+})

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

@@ -0,0 +1,78 @@
+/*
+  Unit tests for the REST API handler for the /ipfs endpoints.
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local support libraries
+import adapters from '../../../mocks/adapters/index.js'
+import UseCasesMock from '../../../mocks/use-cases/index.js'
+import IpfsRouter from '../../../../../src/controllers/rest-api/ipfs/index.js'
+// const app = require('../../../mocks/app-mock')
+
+let uut
+let sandbox
+// let ctx
+
+// const mockContext = require('../../../../unit/mocks/ctx-mock').context
+
+describe('#IPFS-REST-Router', () => {
+  // const testUser = {}
+
+  beforeEach(() => {
+    const useCases = new UseCasesMock()
+    uut = new IpfsRouter({ adapters, useCases })
+
+    sandbox = sinon.createSandbox()
+
+    // Mock the context object.
+    // ctx = mockContext()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new IpfsRouter()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating IPFS REST Controller.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new IpfsRouter({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating IPFS REST Controller.'
+        )
+      }
+    })
+  })
+
+  describe('#attach', () => {
+    it('should throw an error if app is not passed in.', () => {
+      try {
+        uut.attach()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Must pass app object when attaching REST API controllers.'
+        )
+      }
+    })
+  })
+})

test/unit/controllers/timer-controllers.unit.js

@@ -0,0 +1,82 @@
+/*
+  Unit tests for the timer-controller.js Controller library
+*/
+
+// Public npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+// Local libraries
+import TimerControllers from '../../../src/controllers/timer-controllers.js'
+import adapters from '../mocks/adapters/index.js'
+import UseCasesMock from '../mocks/use-cases/index.js'
+
+describe('#Timer-Controllers', () => {
+  let uut
+  let sandbox
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+
+    const useCases = new UseCasesMock()
+    uut = new TimerControllers({ adapters, useCases })
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+
+    uut.stopTimers()
+  })
+
+  describe('#constructor', () => {
+    it('should throw an error if adapters are not passed in', () => {
+      try {
+        uut = new TimerControllers()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Adapters library required when instantiating Timer Controller libraries.'
+        )
+      }
+    })
+
+    it('should throw an error if useCases are not passed in', () => {
+      try {
+        uut = new TimerControllers({ adapters })
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(
+          err.message,
+          'Instance of Use Cases library required when instantiating Timer Controller libraries.'
+        )
+      }
+    })
+  })
+
+  // describe('#startTimers', () => {
+  //   it('should start the timers', () => {
+  //     const result = uut.startTimers()
+  //
+  //     // uut.stopTimers()
+  //
+  //     assert.equal(result, true)
+  //   })
+  // })
+
+  // describe('#exampleTimerFunc', () => {
+  //   it('should kick off the Use Case', async () => {
+  //     const result = await uut.exampleTimerFunc()
+  //
+  //     assert.equal(result, true)
+  //   })
+  //
+  //   it('should return false on error', async () => {
+  //     const result = await uut.exampleTimerFunc(true)
+  //
+  //     assert.equal(result, false)
+  //   })
+  // })
+})

test/unit/misc/config-unit.js

@@ -40,9 +40,13 @@ describe('#config', () => {
     assert.equal(config.env, 'test')
   })
 
-  it('Should return test environment config', async () => {
+  it('Should return prod environment config', async () => {
     process.env.BCH_DEX = 'prod'
 
+    process.env.WALLET_INTERFACE = 'web2'
+    process.env.APISERVER = 'https://api.fullstack.cash/v5/'
+
+    await import('../../../config/env/common.js?foo=bar2')
     const importedConfig3 = await import('../../../config/index.js?foo=bar2')
     const config = importedConfig3.default
     // console.log('config: ', config)

test/unit/mocks/adapters/index.js

@@ -18,19 +18,28 @@ class IpfsAdapter {
 class IpfsCoordAdapter {
   constructor () {
     this.ipfsCoord = {
+      adapters: {
+        ipfs: {
+          connectToPeer: async () => {}
+        }
+      },
       useCases: {
         peer: {
           sendPrivateMessage: () => {
           }
         }
-      }
+      },
+      thisNode: {}
     }
   }
 }
 
 const ipfs = {
   ipfsAdapter: new IpfsAdapter(),
-  ipfsCoordAdapter: new IpfsCoordAdapter()
+  ipfsCoordAdapter: new IpfsCoordAdapter(),
+  getStatus: async () => {},
+  getPeers: async () => {},
+  getRelays: async () => {}
 }
 ipfs.ipfs = ipfs.ipfsAdapter.ipfs
 

test/unit/mocks/adapters/wallet.js

@@ -1,147 +1,149 @@
-/*
-  Mock data for the wallet.adapter.unit.js test file.
-*/
-
-import BCHJS from '@psf/bch-js';
+import BCHJS from "@psf/bch-js";
 
 const mockWallet = {
-  mnemonic: 'course abstract aerobic deer try switch turtle diet fence affair butter top',
-  privateKey: 'L5D2UAam8tvo3uii5kpgaGyjvVMimdrXu8nWGQSQjuuAix6ji1YQ',
-  publicKey: '0379433ffc401483ade310469953c1cba77c71af904f07c15bde330d7198b4d6dc',
-  cashAddress: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
-  address: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
-  slpAddress: 'simpleledger:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acq9zm7d33',
-  legacyAddress: '1JQj1KcQL7GPKzc1D2PvdUSgw3MbDtrHzi',
-  hdPath: "m/44'/245'/0'/0/0",
-  nextAddress: 1
-}
+    mnemonic: 'course abstract aerobic deer try switch turtle diet fence affair butter top',
+    privateKey: 'L5D2UAam8tvo3uii5kpgaGyjvVMimdrXu8nWGQSQjuuAix6ji1YQ',
+    publicKey: '0379433ffc401483ade310469953c1cba77c71af904f07c15bde330d7198b4d6dc',
+    cashAddress: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+    address: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+    slpAddress: 'simpleledger:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acq9zm7d33',
+    legacyAddress: '1JQj1KcQL7GPKzc1D2PvdUSgw3MbDtrHzi',
+    hdPath: "m/44'/245'/0'/0/0",
+    nextAddress: 1
+};
 
 class MockBchWallet {
-  constructor () {
-    this.walletInfoPromise = true
-    this.walletInfo = mockWallet
-    this.bchjs = new BCHJS()
-    this.burnTokens = async () => {
-      return { success: true, txid: 'txid' }
-    }
-    this.sendTokens = async () => {
-      return 'fakeTxid'
-    }
-    this.getUtxos = async () => {
-    }
-    this.getTxData = async () => {
-      return [{
-        tokenTicker: 'TROUT'
-      }]
-    }
-    this.getTokenData = async () => {}
-    this.initialize = async () => {}
-    this.utxoIsValid = async () => {}
-    this.optimize = async () => {}
-
-    // Environment variable is used by wallet-balance.unit.js to force an error.
-    if (process.env.NO_UTXO) {
-      this.utxos = {}
-    } else {
-      this.utxos = {
-        utxoStore: {
-          address: 'bitcoincash:qqetvdnlt0p8g27dr44cx7h057kpzly9xse9huc97z',
-          bchUtxos: [
-            {
-              height: 700685,
-              tx_hash: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
-              tx_pos: 0,
-              value: 1000,
-              txid: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
-              vout: 0,
-              isValid: false
-            },
-            {
-              height: 700685,
-              tx_hash: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
-              tx_pos: 2,
-              value: 19406,
-              txid: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
-              vout: 2,
-              isValid: false
-            }
-          ],
-          nullUtxos: [],
-          slpUtxos: {
-            type1: {
-              mintBatons: [],
-              tokens: [
-                {
-                  'height': 717331,
-                  'tx_hash': '74889580bb1a5f8c026aa2f55118ac9917df3332f7abae72a70343daa1c29621',
-                  'tx_pos': 1,
-                  'value': 546,
-                  'txid': '74889580bb1a5f8c026aa2f55118ac9917df3332f7abae72a70343daa1c29621',
-                  'vout': 1,
-                  'isSlp': true,
-                  'type': 'token',
-                  'qty': '10',
-                  'tokenId': '600ee24d0f208aebc2bdd2c4ee1b9acb6d57343561442e8676b5bbea311d5a0f',
-                  'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
-                  'ticker': 'FLIPS',
-                  'name': 'FLIPS',
-                  'documentUri': '',
-                  'documentHash': '',
-                  'decimals': 1,
-                  'qtyStr': '1'
-                },
-                {
-                  'height': 730597,
-                  'tx_hash': '52520faddfafc46b8f8c9548b097f3a3b82a5bf363b5095047b9c5f83247fe36',
-                  'tx_pos': 1,
-                  'value': 546,
-                  'txid': '52520faddfafc46b8f8c9548b097f3a3b82a5bf363b5095047b9c5f83247fe36',
-                  'vout': 1,
-                  'isSlp': true,
-                  'type': 'token',
-                  'qty': '34999991',
-                  'tokenId': '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-                  'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
-                  'ticker': 'PSF',
-                  'name': 'Permissionless Software Foundation',
-                  'documentUri': 'psfoundation.cash',
-                  'documentHash': '',
-                  'decimals': 8,
-                  'qtyStr': '0.34999991'
-                },
-                {
-                  'height': 730597,
-                  'tx_hash': '5dc7e7c91382aed1666a51212dfb74050261e12c3c4f62b6b1e57f42d6c51ee1',
-                  'tx_pos': 2,
-                  'value': 546,
-                  'txid': '5dc7e7c91382aed1666a51212dfb74050261e12c3c4f62b6b1e57f42d6c51ee1',
-                  'vout': 2,
-                  'isSlp': true,
-                  'type': 'token',
-                  'qty': '18898',
-                  'tokenId': 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
-                  'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
-                  'ticker': 'TROUT',
-                  'name': "Trout's test token",
-                  'documentUri': 'troutsblog.com',
-                  'documentHash': '',
-                  'decimals': 2,
-                  'qtyStr': '188.98'
-                }
-              ]
-            },
-            nft: {
-              tokens: []
-            },
-            group: {
-              tokens: [],
-              mintBatons: []
-            }
-          }
+    constructor() {
+        this.walletInfoPromise = true;
+        this.walletInfo = mockWallet;
+        this.initialize = async () => {}
+        this.bchjs = new BCHJS();
+        this.burnTokens = async () => {
+            return { success: true, txid: 'txid' };
+        };
+        this.sendTokens = async () => {
+            return 'fakeTxid';
+        };
+        this.getUtxos = async () => { };
+        this.getBalance = async () => { };
+        this.listTokens = async () => { };
+        this.getTxData = async () => {
+            return [{
+                    tokenTicker: 'TROUT'
+                }];
+        };
+        this.optimize = async () => { };
+        // Environment variable is used by wallet-balance.unit.js to force an error.
+        if (process.env.NO_UTXO) {
+            this.utxos = {};
+        }
+        else {
+            this.utxos = {
+                utxoStore: {
+                    address: 'bitcoincash:qqetvdnlt0p8g27dr44cx7h057kpzly9xse9huc97z',
+                    bchUtxos: [
+                        {
+                            height: 700685,
+                            tx_hash: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
+                            tx_pos: 0,
+                            value: 1000,
+                            txid: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
+                            vout: 0,
+                            isValid: false
+                        },
+                        {
+                            height: 700685,
+                            tx_hash: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
+                            tx_pos: 2,
+                            value: 19406,
+                            txid: '1fc577caaff5626a8477162581e57bae1b19dc6aa6c10638013c2b1ba14dc654',
+                            vout: 2,
+                            isValid: false
+                        }
+                    ],
+                    nullUtxos: [],
+                    slpUtxos: {
+                        type1: {
+                            mintBatons: [],
+                            tokens: [
+                                {
+                                    'height': 717331,
+                                    'tx_hash': '74889580bb1a5f8c026aa2f55118ac9917df3332f7abae72a70343daa1c29621',
+                                    'tx_pos': 1,
+                                    'value': 546,
+                                    'txid': '74889580bb1a5f8c026aa2f55118ac9917df3332f7abae72a70343daa1c29621',
+                                    'vout': 1,
+                                    'isSlp': true,
+                                    'type': 'token',
+                                    'qty': '10',
+                                    'tokenId': '600ee24d0f208aebc2bdd2c4ee1b9acb6d57343561442e8676b5bbea311d5a0f',
+                                    'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
+                                    'ticker': 'FLIPS',
+                                    'name': 'FLIPS',
+                                    'documentUri': '',
+                                    'documentHash': '',
+                                    'decimals': 1,
+                                    'qtyStr': '1'
+                                },
+                                {
+                                    'height': 730597,
+                                    'tx_hash': '52520faddfafc46b8f8c9548b097f3a3b82a5bf363b5095047b9c5f83247fe36',
+                                    'tx_pos': 1,
+                                    'value': 546,
+                                    'txid': '52520faddfafc46b8f8c9548b097f3a3b82a5bf363b5095047b9c5f83247fe36',
+                                    'vout': 1,
+                                    'isSlp': true,
+                                    'type': 'token',
+                                    'qty': '34999991',
+                                    'tokenId': '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+                                    'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
+                                    'ticker': 'PSF',
+                                    'name': 'Permissionless Software Foundation',
+                                    'documentUri': 'psfoundation.cash',
+                                    'documentHash': '',
+                                    'decimals': 8,
+                                    'qtyStr': '0.34999991'
+                                },
+                                {
+                                    'height': 730597,
+                                    'tx_hash': '5dc7e7c91382aed1666a51212dfb74050261e12c3c4f62b6b1e57f42d6c51ee1',
+                                    'tx_pos': 2,
+                                    'value': 546,
+                                    'txid': '5dc7e7c91382aed1666a51212dfb74050261e12c3c4f62b6b1e57f42d6c51ee1',
+                                    'vout': 2,
+                                    'isSlp': true,
+                                    'type': 'token',
+                                    'qty': '18898',
+                                    'tokenId': 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+                                    'address': 'bitcoincash:qqraj35x6l2qyqhjm5l7qlt7z2245ez8l5z3dwkeq5',
+                                    'ticker': 'TROUT',
+                                    'name': "Trout's test token",
+                                    'documentUri': 'troutsblog.com',
+                                    'documentHash': '',
+                                    'decimals': 2,
+                                    'qtyStr': '188.98'
+                                }
+                            ]
+                        },
+                        nft: {
+                            tokens: []
+                        },
+                        group: {
+                            tokens: [],
+                            mintBatons: []
+                        }
+                    }
+                }
+            };
         }
-      }
     }
-  }
 }
 
-export { MockBchWallet, mockWallet};
+export { MockBchWallet };
+
+export { mockWallet };
+
+export default {
+    MockBchWallet,
+    mockWallet
+};

test/unit/mocks/helia-mock.js

@@ -0,0 +1,13 @@
+/*
+  Mocking library for helia.
+  This is used to replace the helia library when running unit tests.
+*/
+
+const ipfs = {
+  libp2p: {
+    getMultiaddrs: () => [],
+    peerId: 'fake-id'
+  }
+}
+
+export default ipfs

test/unit/mocks/nostr-mock.js

@@ -0,0 +1,15 @@
+class RelayPoolClassMock {
+  constructor() {
+    this.relay = { close: () => { } , subscribe: () => { } }
+    this.event = { content: 'content' }
+  }
+  on(ev, callback) {
+    callback(this.relay, null, this.event)
+  }
+}
+
+const RelayPoolMock =()=>{
+  return new RelayPoolClassMock()
+}
+
+export default {  RelayPoolMock }

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

@@ -51,76 +51,76 @@ describe('#offer-use-case', () => {
   })
 
   describe('#createOffer', () => {
-    it('should ignore an offer if utxo has been spent', async () => {
-      const offerObj = {
-        appId: 'swapTest555',
-        data: {
-          messageType: 1,
-          messageClass: 1,
-          tokenId:
-            '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-          buyOrSell: 'sell',
-          rateInSats: 1000,
-          minSatsToExchange: 10,
-          numTokens: 0.02,
-          utxoTxid:
-            '241c06bf61384b8623477e419bf4779edbcc7e3bc862f0f179a9ed2967069b87',
-          utxoVout: 0
-        },
-        timestamp: '2021-09-20T17:54:26.395Z',
-        localTimeStamp: '9/20/2021, 10:54:26 AM',
-        txid: '46f50f2a0cf44e3ed70dfb0618ef3ebfee57aabcf229b5d2d17c07322b54a8d7',
-        hash: 'zdpuB2X25AZCKo3wpr4sSbw44vqPWJRqcxWQRHZccK5BdtoGD'
-      }
+    // it('should ignore an offer if utxo has been spent', async () => {
+    //   const offerObj = {
+    //     appId: 'swapTest555',
+    //     data: {
+    //       messageType: 1,
+    //       messageClass: 1,
+    //       tokenId:
+    //         '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+    //       buyOrSell: 'sell',
+    //       rateInSats: 1000,
+    //       minSatsToExchange: 10,
+    //       numTokens: 0.02,
+    //       utxoTxid:
+    //         '241c06bf61384b8623477e419bf4779edbcc7e3bc862f0f179a9ed2967069b87',
+    //       utxoVout: 0
+    //     },
+    //     timestamp: '2021-09-20T17:54:26.395Z',
+    //     localTimeStamp: '9/20/2021, 10:54:26 AM',
+    //     txid: '46f50f2a0cf44e3ed70dfb0618ef3ebfee57aabcf229b5d2d17c07322b54a8d7',
+    //     hash: 'zdpuB2X25AZCKo3wpr4sSbw44vqPWJRqcxWQRHZccK5BdtoGD'
+    //   }
+    //
+    //   // Mock dependencies
+    //   // sandbox.stub(uut.adapters.wallet.bchWallet, 'utxoIsValid').resolves(false)
+    //   sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
+    //   sandbox.stub(uut, 'categorizeToken').resolves('nft')
+    //   sandbox.stub(uut, 'detectNsfw').resolves(false)
+    //
+    //   const result = await uut.createOffer(offerObj)
+    //   // console.log('result: ', result)
+    //
+    //   assert.equal(result, false)
+    // })
 
-      // Mock dependencies
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'utxoIsValid').resolves(false)
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
-      sandbox.stub(uut, 'categorizeToken').resolves('nft')
-      sandbox.stub(uut, 'detectNsfw').resolves(false)
-
-      const result = await uut.createOffer(offerObj)
-      // console.log('result: ', result)
-
-      assert.equal(result, false)
-    })
-
-    it('should create an offer and return the hash', async () => {
-      const offerObj = {
-        appId: 'swapTest555',
-        data: {
-          messageType: 1,
-          messageClass: 1,
-          tokenId:
-            '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
-          buyOrSell: 'sell',
-          rateInBaseUnit: 1000,
-          minUnitsToExchange: 10,
-          numTokens: 0.02,
-          utxoTxid:
-            '241c06bf61384b8623477e419bf4779edbcc7e3bc862f0f179a9ed2967069b87',
-          utxoVout: 0,
-          makerAddr: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
-          ticker: 'TROUT',
-          tokenType: 1
-        },
-        timestamp: '2021-09-20T17:54:26.395Z',
-        localTimeStamp: '9/20/2021, 10:54:26 AM',
-        txid: '46f50f2a0cf44e3ed70dfb0618ef3ebfee57aabcf229b5d2d17c07322b54a8d7',
-        hash: 'zdpuB2X25AZCKo3wpr4sSbw44vqPWJRqcxWQRHZccK5BdtoGD'
-      }
-
-      // Mock dependencies
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'utxoIsValid').resolves(true)
-      sandbox.stub(uut, 'categorizeToken').resolves('fungible')
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
-      sandbox.stub(uut, 'detectNsfw').resolves(false)
-
-      const result = await uut.createOffer(offerObj)
-      // console.log('result: ', result)
-
-      assert.equal(result, true)
-    })
+    // it('should create an offer and return the hash', async () => {
+    //   const offerObj = {
+    //     appId: 'swapTest555',
+    //     data: {
+    //       messageType: 1,
+    //       messageClass: 1,
+    //       tokenId:
+    //         '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
+    //       buyOrSell: 'sell',
+    //       rateInBaseUnit: 1000,
+    //       minUnitsToExchange: 10,
+    //       numTokens: 0.02,
+    //       utxoTxid:
+    //         '241c06bf61384b8623477e419bf4779edbcc7e3bc862f0f179a9ed2967069b87',
+    //       utxoVout: 0,
+    //       makerAddr: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+    //       ticker: 'TROUT',
+    //       tokenType: 1
+    //     },
+    //     timestamp: '2021-09-20T17:54:26.395Z',
+    //     localTimeStamp: '9/20/2021, 10:54:26 AM',
+    //     txid: '46f50f2a0cf44e3ed70dfb0618ef3ebfee57aabcf229b5d2d17c07322b54a8d7',
+    //     hash: 'zdpuB2X25AZCKo3wpr4sSbw44vqPWJRqcxWQRHZccK5BdtoGD'
+    //   }
+    //
+    //   // Mock dependencies
+    //   // sandbox.stub(uut.adapters.wallet.bchWallet, 'utxoIsValid').resolves(true)
+    //   sandbox.stub(uut, 'categorizeToken').resolves('fungible')
+    //   sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
+    //   sandbox.stub(uut, 'detectNsfw').resolves(false)
+    //
+    //   const result = await uut.createOffer(offerObj)
+    //   // console.log('result: ', result)
+    //
+    //   assert.equal(result, true)
+    // })
   })
 
   describe('#categorizeToken', () => {