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

Syncing with upstream ipfs-service-provider

.gitignore

@@ -72,3 +72,5 @@ data/
 run-dev.sh
 
 !README.md
+
+wallet.json

README.md

@@ -24,9 +24,9 @@ This repository is one step in a longer path. Here are the major milestones of t
 
 ## Requirements
 
-- node **^16.20.2**
-- npm **^8.19.4**
-- Docker **^20.10.8**
+- node **^20.16.0**
+- npm **^10.8.1**
+- Docker **^24.0.7**
 - Docker Compose **^1.27.4**
 
 ## Installation
@@ -61,18 +61,19 @@ docker-compose up -d
 - You can bring the containers down with `docker-compose down`
 - You can bring the containers back up with `docker-compose up -d`.
 
-### Development Environment
+### Configuration
 
-A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. Ubuntu v20 is the recommended OS for creating a dev environment. Other operating systems may cause issues.
+This program is intended to started with a Bash shell script. In that script, you can set the following environment variables:
 
 ```bash
-git clone https://github.com/Permissionless-Software-Foundation/ipfs-service-provider
-cd ipfs-service-provider
-./install-mongo-sh
-npm install
-npm start
+# The instance of bch-api to connect to.
+export APISERVER=http://172.17.0.1:3000/v5/
 ```
 
+### Configuration
+
+This app is intended to be started via a bash shell script. See the environment variables used to configure this app in the [config/env/common.js file](./config/env/common.js).
+
 ## File Structure
 
 The file layout of this repository follows the file layout of [Clean Architecture](https://christroutner.github.io/trouts-blog/blog/clean-architecture). Understaning the principles laid out this article will help developers navigate the code base.

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}`)
@@ -102,14 +104,14 @@ class Server {
       this.server = await app.listen(this.config.port)
       console.log(`Server started on ${this.config.port}`)
 
-      // Create the system admin user.
-      try {
-        const success = await this.adminLib.createSystemUser()
-        if (success) console.log('System admin user created.')
-      } catch (err) {
-        console.warn(
-          'Error trying to create system admin. Perhaps one already exists?'
-        )
+      if (!this.config.noMongo) {
+        try {
+          // Create the system admin user.
+          const success = await this.adminLib.createSystemUser()
+          if (success) console.log('System admin user created.')
+        } catch (err) {
+          console.log('Could not create system admin user.')
+        }
       }
 
       // Attach the other IPFS controllers.

config/env/common.js

@@ -18,7 +18,6 @@ import * as url from 'url'
 import { readFileSync } from 'fs'
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 const pkgInfo = JSON.parse(readFileSync(`${__dirname.toString()}/../../package.json`))
-
 const version = pkgInfo.version
 
 const ipfsCoordName = process.env.COORD_NAME
@@ -29,7 +28,7 @@ console.log('GET_JWT_AT_STARTUP: ', process.env.GET_JWT_AT_STARTUP)
 
 export default {
   // Configure TCP port.
-  port: process.env.PORT || 5020,
+  port: process.env.PORT || 5032,
 
   // Password for HTML UI that displays logs.
   logPass: 'test',
@@ -45,14 +44,46 @@ export default {
     ? process.env.EMAILPASS
     : 'emailpassword',
 
+  // 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',
@@ -60,8 +91,17 @@ export default {
     ? process.env.FULLSTACKPASS
     : 'demo',
 
-  // IPFS settings.
-  useIpfs: process.env.DISABLE_IPFS ? false : true, // Disable IPFS flag
+  // 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,
+
   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 : '',
@@ -77,7 +117,7 @@ export default {
     '@type': 'WebAPI',
     name: ipfsCoordName,
     version,
-    protocol: 'bch-wallet',
+    protocol: 'ipfs-bch-wallet-service',
     description:
       'IPFS service providing BCH blockchain access needed by a wallet.',
     documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',
@@ -85,18 +125,16 @@ 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
   },
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 5668,
   ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669,
 
-  // BCH Mnemonic for generating encryption keys and payment address
-  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
-
-  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2,
-
   // Settings for production, using external go-ipfs node.
   isProduction: process.env.SVC_ENV === 'prod' ? true : false,
   ipfsHost: process.env.IPFS_HOST ? process.env.IPFS_HOST : 'localhost',
@@ -114,4 +152,6 @@ export default {
     // v2 Circuit Relay server (FullStack.cash)
     // '/ip4/78.46.129.7/tcp/4001/p2p/12D3KooWFQ11GQ5NubsJGhYZ4X3wrAGimLevxfm6HPExCrMYhpSL'
   ]
+
+  // END IPFS CONFIGURATION
 }

config/env/production.js

@@ -12,6 +12,6 @@ export default {
   token: 'secret-jwt-token',
   database: process.env.DBURL
     ? process.env.DBURL
-    : 'mongodb://172.17.0.1:5555/bch-service-prod',
+    : 'mongodb://172.17.0.1:5557/bch-service-prod',
   env: 'prod'
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "type": "module",
@@ -25,26 +25,28 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "11.0.1",
-    "@chainsafe/libp2p-noise": "14.1.0",
-    "@chainsafe/libp2p-yamux": "6.0.1",
-    "@helia/unixfs": "3.0.1",
-    "@libp2p/bootstrap": "10.0.7",
-    "@libp2p/circuit-relay-v2": "1.0.13",
-    "@libp2p/identify": "1.0.6",
-    "@libp2p/keychain": "4.0.7",
-    "@libp2p/logger": "4.0.5",
+    "@chainsafe/libp2p-gossipsub": "13.1.1",
+    "@chainsafe/libp2p-noise": "15.1.1",
+    "@chainsafe/libp2p-yamux": "6.0.2",
+    "@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/mplex": "10.0.16",
-    "@libp2p/tcp": "9.0.7",
-    "@libp2p/webrtc": "4.0.17",
+    "@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",
     "bcryptjs": "2.4.3",
-    "blockstore-fs": "1.1.8",
-    "datastore-fs": "9.1.6",
+    "blockstore-fs": "2.0.0",
+    "datastore-fs": "9.1.7",
     "glob": "7.1.6",
-    "helia": "2.1.0",
-    "helia-coord": "1.5.5",
+    "helia": "4.2.5",
+    "helia-coord": "1.5.14",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -59,9 +61,9 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "1.2.1",
+    "libp2p": "1.9.1",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "5.11.1",
+    "minimal-slp-wallet": "5.12.0",
     "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",

production/docker/Dockerfile

@@ -13,7 +13,7 @@ RUN apt-get install -y sudo git curl nano gnupg wget
 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_16.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
+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
 
@@ -35,7 +35,7 @@ RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
 
 # Update to the latest version of npm.
 # Working with npm@7.21.1
-RUN npm install -g npm
+#RUN npm install -g npm
 
 # Update to the latest version of npm.
 #RUN npm install -g npm@7.23.0
@@ -73,8 +73,6 @@ RUN mkdir /home/safeuser/.ipfsdata
 #VOLUME /home/safeuser/ipfsdata
 #VOLUME /home/safeuser/orbitdb
 
-EXPOSE 5010
-
 # Start the application.
 #COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]

production/docker/docker-compose.yml

@@ -7,16 +7,16 @@ services:
     image: mongo:4.2.0
     container_name: mongo-bch-service
     ports:
-      - '5555:27017' # <host port>:<container port>
+      - '5557:27017' # <host port>:<container port>
     volumes:
       - ../data/mongodb:/data/db
     command: mongod --logpath=/dev/null # -- quiet
     restart: always
 
-  ipfs-bch-wallet:
+  ipfs-bch-wallet-service:
     build: .
     #image: christroutner/ipfs-service-provider:v5.0.1
-    container_name: ipfs-service
+    container_name: ipfs-bch-wallet-service
     logging:
       driver: 'json-file'
       options:
@@ -26,9 +26,9 @@ services:
     links:
       - mongo-bch-service
     ports:
-      - '5010:5010' # <host port>:<container port>
-      - '4001:4001'
-      - '4003:4003'
+      - '5032:5032' # <host port>:<container port>
+      - '5668:5668'
+      - '5669:5669'
     volumes:
       - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-service/.ipfsdata
       - ./start-production.sh:/home/safeuser/ipfs-bch-wallet-service/start-production.sh

production/docker/start-production.sh

@@ -16,9 +16,6 @@ export COORD_NAME=bch-wallet-service-generic
 # and you must forward that subdomain to the IPFS_WS_PORT.
 #export CR_DOMAIN=subdomain.yourdomain.com
 
-# Debug level. 0 = minimal info. 2 = max info.
-export DEBUG_LEVEL=2
-
 # BCH Wallet Service Settings
 # Change APISERVER to point to your own installation of bch-api
 export APISERVER=https://api.fullstack.cash/v5/
@@ -32,7 +29,7 @@ export FULLSTACKPASS=demo
 
 
 # Production database connection string.
-export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+export DBURL=mongodb://172.17.0.1:5557/ipfs-service-prod
 
 # Configure REST API port
 export PORT=5010
@@ -41,8 +38,8 @@ export PORT=5010
 export SVC_ENV=prod
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
-export IPFS_TCP_PORT=4001
-export IPFS_WS_PORT=4003
+export IPFS_TCP_PORT=5668
+export IPFS_WS_PORT=5669
 
 # Set the debug level for helia-coord. 0-3.
 # 0 = no debug logs. 3 = maximum debug logs.

src/adapters/index.js

@@ -9,17 +9,15 @@ 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'
 
 class Adapters {
   constructor (localConfig = {}) {
@@ -31,7 +29,15 @@ class Adapters {
     this.passport = new Passport()
     this.nodemailer = new Nodemailer()
     this.jsonFiles = new JSONFiles()
-    this.bchjs = new BCHJS({ restURL: this.config.apiServer })
+    this.bchjs = new BCHJS({ restURL: config.apiServer })
+    this.config = config
+
+    const walletConfig = {}
+    if (config.walletInterface === 'web2') {
+      walletConfig.restURL = config.apiServer
+      walletConfig.interface = 'rest-api'
+    }
+    this.wallet = new Wallet(walletConfig)
 
     // Get a valid JWT API key and instance bch-js.
     this.fullStackJwt = new FullStackJWT(config)
@@ -39,10 +45,11 @@ 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()
       } else {
@@ -52,6 +59,14 @@ class Adapters {
         this.bchjs = new BCHJS({ restURL: this.config.apiServer })
       }
 
+      // 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
+      // console.log('adapters/index.js this.bchjs.restURL: ', this.bchjs.restURL)
+
       // Start the IPFS node.
       // Do not start these adapters if this is an e2e test.
       if (this.config.env !== 'test') {

src/adapters/ipfs/ipfs.js

@@ -21,12 +21,12 @@ import { yamux } from '@chainsafe/libp2p-yamux'
 // import { identifyService } from 'libp2p/identify'
 import { identify } from '@libp2p/identify'
 // import { circuitRelayServer, circuitRelayTransport } from 'libp2p/circuit-relay'
-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 { webRTC } from '@libp2p/webrtc'
 import { keychain } from '@libp2p/keychain'
 import { defaultLogger } from '@libp2p/logger'
 import { unixfs } from '@helia/unixfs'
@@ -154,7 +154,7 @@ class IpfsAdapter {
       // Configure services
       const services = {
         identify: identify(),
-        pubsub: gossipsub({ allowPublishToZeroPeers: true })
+        pubsub: gossipsub({ allowPublishToZeroTopicPeers: true })
       }
       if (this.config.isCircuitRelay) {
         console.log('Helia (IPFS) node IS configured as Circuit Relay')
@@ -175,25 +175,15 @@ class IpfsAdapter {
         console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
       }
 
-      // Configure transports
-      let transports
-      if (process.env.CONNECT_PREF === 'direct') {
-        transports = [
-          tcp(),
-          webSockets(),
-          webRTC()
-        ]
-      } else {
-        transports = [
-          tcp(),
-          webSockets(),
-          circuitRelayTransport({
-            discoverRelays: 3,
-            reservationConcurrency: 3
-          }),
-          webRTC()
-        ]
-      }
+      const transports = [
+        tcp(),
+        webSockets()
+        // circuitRelayTransport({
+        //   discoverRelays: 3,
+        //   reservationConcurrency: 3
+        // }),
+        // webRTC()
+      ]
 
       // libp2p is the networking layer that underpins Helia
       const libp2p = await this.createLibp2p({
@@ -254,6 +244,8 @@ class IpfsAdapter {
 
       !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)

src/adapters/wallet.adapter.js

@@ -0,0 +1,245 @@
+/*
+  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}`)
+      console.log(`Wallet backend: ${this.bchWallet.bchjs.restURL}`)
+
+      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/controllers/index.js

@@ -17,7 +17,7 @@ import config from '../../config/index.js'
 class Controllers {
   constructor (localConfig = {}) {
     // Encapsulate dependencies
-    this.adapters = new Adapters()
+    this.adapters = new Adapters(localConfig)
     this.useCases = new UseCases({ adapters: this.adapters })
     this.timerControllers = new TimerControllers({ adapters: this.adapters, useCases: this.useCases })
     this.config = config

src/controllers/rest-api/index.js

@@ -13,6 +13,7 @@ import ContactRESTController from './contact/index.js'
 import LogsRESTController from './logs/index.js'
 import IpfsRESTController from './ipfs/index.js'
 import BCHRESTController from './bch/index.js'
+import config from '../../../config/index.js'
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -30,7 +31,8 @@ class RESTControllers {
       )
     }
 
-    // console.log('Controllers localConfig: ', localConfig)
+    // Encapsulate dependencies
+    this.config = config
   }
 
   attachRESTControllers (app) {
@@ -39,13 +41,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)

src/use-cases/bch/index.js

@@ -14,6 +14,7 @@ class BCHUseCases {
 
     // Encapsulate dependencies
     this.bchjs = this.adapters.bchjs
+    // console.log('use-cases/bch/index.js restURL: ', this.bchjs.restURL)
   }
 
   // Get transaction history for an address, sorted by block height.

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,9 +23,9 @@ const context = {}
 
 const LOCALHOST = `http://localhost:${config.port}`
 
-describe('Auth', () => {
-  before(async () => {
-    try {
+if (!config.noMongo) {
+  describe('Auth', () => {
+    before(async () => {
       const app = new Server()
 
       // This should be the first instruction. It starts the REST API server.
@@ -51,82 +50,80 @@ describe('Auth', () => {
 
       context.user = testUser.user
       context.token = testUser.token
-    } catch (err) {
-      console.log('err in auth beforeAll: ', err)
-    }
-  })
-
-  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.')
-      }
     })
 
-    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/wallet.adapter.unit.js

@@ -0,0 +1,344 @@
+/*
+  Unit tests for the Wallet Adapter library.
+*/
+
+// Global npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+import BchWallet from 'minimal-slp-wallet'
+import fs from 'fs'
+
+// Local libraries
+import WalletAdapter from '../../../src/adapters/wallet.adapter.js'
+import { MockBchWallet } from '../mocks/adapters/wallet.js'
+
+// Hack to get __dirname back.
+// https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/
+import * as url from 'url'
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+
+// Global constants
+const testWalletFile = `${__dirname.toString()}test-wallet.json`
+
+describe('#wallet', () => {
+  let uut
+  let sandbox
+
+  before(() => {
+    // Delete the test file if it exists.
+    try {
+      deleteFile(testWalletFile)
+    } catch (err) { }
+  })
+
+  beforeEach(() => {
+    uut = new WalletAdapter()
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  after(() => {
+    // Delete the test file if it exists.
+    try {
+      deleteFile(testWalletFile)
+    } 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 when wallet file does not exist', async () => {
+      // Mock dependencies
+      uut.BchWallet = MockBchWallet
+      // Ensure we open the test file, not the production wallet file.
+      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')
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'address')
+      assert.property(result, 'slpAddress')
+      assert.property(result, 'legacyAddress')
+      assert.property(result, 'hdPath')
+    })
+
+    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.config.walletFile = testWalletFile
+      const result = await uut.openWallet()
+      // console.log('result: ', result)
+      assert.property(result, 'mnemonic')
+      assert.property(result, 'privateKey')
+      assert.property(result, 'publicKey')
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'address')
+      assert.property(result, 'slpAddress')
+      assert.property(result, 'legacyAddress')
+      assert.property(result, 'hdPath')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        uut.config.walletFile = ''
+        uut.BchWallet = () => {
+        }
+        await uut.openWallet()
+        // console.log('result: ', result)
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'this.BchWallet is not a constructor')
+      }
+    })
+  })
+
+  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 {
+        // 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, '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('#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)
+    })
+
+    it('should catch and throw an error', async () => {
+      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')
+      }
+    })
+  })
+
+  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
+      uut.config.walletFile = testWalletFile
+
+      const result = await uut.getKeyPair()
+      // console.log('result: ', result)
+
+      assert.property(result, 'cashAddress')
+      assert.property(result, 'wif')
+      assert.property(result, 'hdIndex')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        // Force an error
+        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')
+      }
+    })
+  })
+
+  describe('#optimize', () => {
+    it('should call the wallet optimize function', async () => {
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      sandbox.stub(uut.bchWallet, 'optimize').resolves({ bchUtxoCnt: 10 })
+      const result = await uut.optimize()
+      assert.equal(result, true)
+    })
+  })
+
+  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 the expected properties exist and have the expected values.
+      assert.equal(result.satBalance, 41012)
+      assert.equal(result.psfBalance, 2)
+      assert.equal(result.success, true)
+    })
+  })
+})
+
+const deleteFile = (filepath) => {
+  try {
+    // Delete state if exist
+    fs.unlinkSync(filepath)
+  } catch (err) {
+    // console.error('Error trying to delete file: ', err)
+  }
+}

test/unit/misc/config.js

@@ -38,9 +38,13 @@ describe('#config', () => {
     assert.equal(config.env, 'test')
   })
 
-  it('Should return test environment config', async () => {
+  it('Should return prod environment config', async () => {
     process.env.SVC_ENV = '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/wallet.js

@@ -0,0 +1,149 @@
+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
+};
+
+class MockBchWallet {
+    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 };
+
+export { mockWallet };
+
+export default {
+    MockBchWallet,
+    mockWallet
+};