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

Syncing with upstream, fixing flaky tests
fix(tests): Fixed fragile unit tests
2026-09-22 01:02:04 -07:00 · 2024-03-24 08:25:20 -07:00 · 2024-03-24 08:24:08 -07:00 · 2024-03-24 07:44:46 -07:00 · 2024-03-24 07:43:34 -07:00 · 2024-03-23 17:46:55 -07:00
12 changed files with 908 additions and 457 deletions
@@ -47,7 +47,20 @@ 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`.

-## Code Structure
+## Configuration
+
+This program is intended to started with a Bash shell script. In that script, you can set the following environment variables:
+
+```bash
+# The IPFS ID of the service running ipfs-bch-wallet-service
+export PREFERRED_P2WDB_PROVIDER=12D3KooWCNpwHbHmkNSJsqu3CQVVe3iW8g6e1gn3kWTPahj2igiy
+```
+
+### 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 differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](https://christroutner.github.io/trouts-blog/blog/clean-architecture).

@@ -43,14 +43,43 @@ export default {
    ? process.env.EMAILPASS
    : 'emailpassword',

+  // 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',
@@ -58,8 +87,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 : '',
@@ -88,26 +126,6 @@ export default {
  ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 4101,
  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 4103,

-  // 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,
-
-  // Preferred provider running ipfs-bch-wallet-service for BCH wallet.
-  preferredProvider: process.env.PREFERRED_PROVIDER
-    ? process.env.PREFERRED_PROVIDER
-    : '',
-  // If true, users will not be able to change the provider via a REST API call.
-  freezeProvider: process.env.FREEZE_PROVIDER ? true : false,
-  //  : 'QmdBGB8S6sEr19gaAxJYjhRbz5ZmMiH5a1JyyMmaxcRKnY'
-  // : 'QmUTx6KqYKVZbKpKxR7vGDUgZFYVvVVyEWDeCYq4GwBCff'
-  // Used for development
-
-  // Preferred P2WDB provider
-  preferredP2wdbProvider: process.env.PREFERRED_P2WDB_PROVIDER
-    ? process.env.PREFERRED_P2WDB_PROVIDER
-    : '',
-
  // 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',
@@ -124,5 +142,23 @@ export default {

    // v2 Circuit Relay server (FullStack.cash)
    // '/ip4/78.46.129.7/tcp/4001/p2p/12D3KooWFQ11GQ5NubsJGhYZ4X3wrAGimLevxfm6HPExCrMYhpSL'
-  ]
+  ],
+
+  // END IPFS CONFIGURATION
+
+  // Preferred provider running ipfs-bch-wallet-service for BCH wallet.
+  preferredProvider: process.env.PREFERRED_PROVIDER
+    ? process.env.PREFERRED_PROVIDER
+    : '',
+  // If true, users will not be able to change the provider via a REST API call.
+  freezeProvider: process.env.FREEZE_PROVIDER ? true : false,
+  //  : 'QmdBGB8S6sEr19gaAxJYjhRbz5ZmMiH5a1JyyMmaxcRKnY'
+  // : 'QmUTx6KqYKVZbKpKxR7vGDUgZFYVvVVyEWDeCYq4GwBCff'
+  // Used for development
+
+  // Preferred P2WDB provider
+  preferredP2wdbProvider: process.env.PREFERRED_P2WDB_PROVIDER
+    ? process.env.PREFERRED_P2WDB_PROVIDER
+    : ''
+
 }
@@ -26,7 +26,7 @@
        "datastore-fs": "9.1.6",
        "glob": "7.1.6",
        "helia": "2.1.0",
-        "helia-coord": "1.5.5",
+        "helia-coord": "1.5.6",
        "jsonrpc-lite": "2.2.0",
        "jsonwebtoken": "8.5.1",
        "jwt-bch-lib": "1.3.0",
@@ -43,7 +43,7 @@
        "koa2-ratelimit": "0.9.1",
        "libp2p": "1.2.1",
        "line-reader": "0.4.0",
-        "minimal-slp-wallet": "5.11.1",
+        "minimal-slp-wallet": "5.11.2",
        "mongoose": "5.13.14",
        "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
        "nodemailer": "6.7.5",
@@ -2552,231 +2552,6 @@
        "node": ">=10.0.0"
      }
    },
-    "node_modules/@esbuild/android-arm": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.16.17.tgz",
-      "integrity": "sha512-N9x1CMXVhtWEAMS7pNNONyA14f71VPQN9Cnavj1XQh6T7bskqiLLrSca4O0Vr8Wdcga943eThxnVp3JLnBMYtw==",
-      "cpu": [
-        "arm"
-      ],
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/android-arm64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.16.17.tgz",
-      "integrity": "sha512-MIGl6p5sc3RDTLLkYL1MyL8BMRN4tLMRCn+yRJJmEDvYZ2M7tmAf80hx1kbNEUX2KJ50RRtxZ4JHLvCfuB6kBg==",
-      "cpu": [
-        "arm64"
-      ],
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/android-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.16.17.tgz",
-      "integrity": "sha512-a3kTv3m0Ghh4z1DaFEuEDfz3OLONKuFvI4Xqczqx4BqLyuFaFkuaG4j2MtA6fuWEFeC5x9IvqnX7drmRq/fyAQ==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/darwin-arm64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.16.17.tgz",
-      "integrity": "sha512-/2agbUEfmxWHi9ARTX6OQ/KgXnOWfsNlTeLcoV7HSuSTv63E4DqtAc+2XqGw1KHxKMHGZgbVCZge7HXWX9Vn+w==",
-      "cpu": [
-        "arm64"
-      ],
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/darwin-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.16.17.tgz",
-      "integrity": "sha512-2By45OBHulkd9Svy5IOCZt376Aa2oOkiE9QWUK9fe6Tb+WDr8hXL3dpqi+DeLiMed8tVXspzsTAvd0jUl96wmg==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/freebsd-arm64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.16.17.tgz",
-      "integrity": "sha512-mt+cxZe1tVx489VTb4mBAOo2aKSnJ33L9fr25JXpqQqzbUIw/yzIzi+NHwAXK2qYV1lEFp4OoVeThGjUbmWmdw==",
-      "cpu": [
-        "arm64"
-      ],
-      "optional": true,
-      "os": [
-        "freebsd"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/freebsd-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.16.17.tgz",
-      "integrity": "sha512-8ScTdNJl5idAKjH8zGAsN7RuWcyHG3BAvMNpKOBaqqR7EbUhhVHOqXRdL7oZvz8WNHL2pr5+eIT5c65kA6NHug==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "freebsd"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-arm": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.16.17.tgz",
-      "integrity": "sha512-iihzrWbD4gIT7j3caMzKb/RsFFHCwqqbrbH9SqUSRrdXkXaygSZCZg1FybsZz57Ju7N/SHEgPyaR0LZ8Zbe9gQ==",
-      "cpu": [
-        "arm"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-arm64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.16.17.tgz",
-      "integrity": "sha512-7S8gJnSlqKGVJunnMCrXHU9Q8Q/tQIxk/xL8BqAP64wchPCTzuM6W3Ra8cIa1HIflAvDnNOt2jaL17vaW+1V0g==",
-      "cpu": [
-        "arm64"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-ia32": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.16.17.tgz",
-      "integrity": "sha512-kiX69+wcPAdgl3Lonh1VI7MBr16nktEvOfViszBSxygRQqSpzv7BffMKRPMFwzeJGPxcio0pdD3kYQGpqQ2SSg==",
-      "cpu": [
-        "ia32"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-loong64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.16.17.tgz",
-      "integrity": "sha512-dTzNnQwembNDhd654cA4QhbS9uDdXC3TKqMJjgOWsC0yNCbpzfWoXdZvp0mY7HU6nzk5E0zpRGGx3qoQg8T2DQ==",
-      "cpu": [
-        "loong64"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-mips64el": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.16.17.tgz",
-      "integrity": "sha512-ezbDkp2nDl0PfIUn0CsQ30kxfcLTlcx4Foz2kYv8qdC6ia2oX5Q3E/8m6lq84Dj/6b0FrkgD582fJMIfHhJfSw==",
-      "cpu": [
-        "mips64el"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-ppc64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.16.17.tgz",
-      "integrity": "sha512-dzS678gYD1lJsW73zrFhDApLVdM3cUF2MvAa1D8K8KtcSKdLBPP4zZSLy6LFZ0jYqQdQ29bjAHJDgz0rVbLB3g==",
-      "cpu": [
-        "ppc64"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-riscv64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.16.17.tgz",
-      "integrity": "sha512-ylNlVsxuFjZK8DQtNUwiMskh6nT0vI7kYl/4fZgV1llP5d6+HIeL/vmmm3jpuoo8+NuXjQVZxmKuhDApK0/cKw==",
-      "cpu": [
-        "riscv64"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/linux-s390x": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.16.17.tgz",
-      "integrity": "sha512-gzy7nUTO4UA4oZ2wAMXPNBGTzZFP7mss3aKR2hH+/4UUkCOyqmjXiKpzGrY2TlEUhbbejzXVKKGazYcQTZWA/w==",
-      "cpu": [
-        "s390x"
-      ],
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
    "node_modules/@esbuild/linux-x64": {
      "version": "0.16.17",
      "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.16.17.tgz",
@@ -2792,96 +2567,6 @@
        "node": ">=12"
      }
    },
-    "node_modules/@esbuild/netbsd-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.16.17.tgz",
-      "integrity": "sha512-/PzmzD/zyAeTUsduZa32bn0ORug+Jd1EGGAUJvqfeixoEISYpGnAezN6lnJoskauoai0Jrs+XSyvDhppCPoKOA==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "netbsd"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/openbsd-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.16.17.tgz",
-      "integrity": "sha512-2yaWJhvxGEz2RiftSk0UObqJa/b+rIAjnODJgv2GbGGpRwAfpgzyrg1WLK8rqA24mfZa9GvpjLcBBg8JHkoodg==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "openbsd"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/sunos-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.16.17.tgz",
-      "integrity": "sha512-xtVUiev38tN0R3g8VhRfN7Zl42YCJvyBhRKw1RJjwE1d2emWTVToPLNEQj/5Qxc6lVFATDiy6LjVHYhIPrLxzw==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "sunos"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/win32-arm64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.16.17.tgz",
-      "integrity": "sha512-ga8+JqBDHY4b6fQAmOgtJJue36scANy4l/rL97W+0wYmijhxKetzZdKOJI7olaBaMhWt8Pac2McJdZLxXWUEQw==",
-      "cpu": [
-        "arm64"
-      ],
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/win32-ia32": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.16.17.tgz",
-      "integrity": "sha512-WnsKaf46uSSF/sZhwnqE4L/F89AYNMiD4YtEcYekBt9Q7nj0DiId2XH2Ng2PHM54qi5oPrQ8luuzGszqi/veig==",
-      "cpu": [
-        "ia32"
-      ],
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/@esbuild/win32-x64": {
-      "version": "0.16.17",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.16.17.tgz",
-      "integrity": "sha512-y+EHuSchhL7FjHgvQL/0fnnFmO4T1bhvWANX6gcnqTjtnKWbTvUMCpGnv2+t+31d7RzyEAYAd4u2fnIhHL6N/Q==",
-      "cpu": [
-        "x64"
-      ],
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=12"
-      }
-    },
    "node_modules/@eslint-community/eslint-utils": {
      "version": "4.4.0",
      "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz",
@@ -7106,54 +6791,15 @@
      }
    },
    "node_modules/bch-consumer": {
-      "version": "1.4.5",
-      "resolved": "https://registry.npmjs.org/bch-consumer/-/bch-consumer-1.4.5.tgz",
-      "integrity": "sha512-hNnhm1q4q+qyJLxyulet5YB6zdTFXx5PUWpuwOqYW/XkoIOpZCyzfFFU/NTB6m5VSQgxmpXYgoqSsYCm+wDbkQ==",
+      "version": "1.4.6",
+      "resolved": "https://registry.npmjs.org/bch-consumer/-/bch-consumer-1.4.6.tgz",
+      "integrity": "sha512-0R/SPofznZREhMoHHd18nHn97vsjhnqJhIw+olep32aAt93pl9SoKh5i51AtOgHPV/m+o/+WkEWdI7LtIuTVjQ==",
      "dependencies": {
-        "@psf/bch-js": "6.6.0",
+        "@psf/bch-js": "6.7.3",
        "apidoc": "0.51.0",
        "axios": "0.25.0"
      }
    },
-    "node_modules/bch-consumer/node_modules/@psf/bch-js": {
-      "version": "6.6.0",
-      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.6.0.tgz",
-      "integrity": "sha512-623uPhQQRgf5RusRJVReAxwtSPyMygJKe/qnMBVs8ZWvjFJSr1F+mfS/U8n1dHPV/CHsrcaLUVeSy5ZchNHB6g==",
-      "dependencies": {
-        "@chris.troutner/bip32-utils": "1.0.5",
-        "@psf/bip21": "2.0.1",
-        "@psf/bitcoincash-ops": "2.0.0",
-        "@psf/bitcoincashjs-lib": "4.0.3",
-        "@psf/coininfo": "4.0.0",
-        "axios": "0.26.1",
-        "bc-bip68": "1.0.5",
-        "bchaddrjs-slp": "0.2.5",
-        "bigi": "1.4.2",
-        "bignumber.js": "9.0.0",
-        "bip-schnorr": "0.3.0",
-        "bip38": "2.0.2",
-        "bip39": "3.0.2",
-        "bip66": "1.1.5",
-        "bitcoinjs-message": "2.0.0",
-        "bs58": "4.0.1",
-        "ecashaddrjs": "1.0.7",
-        "ini": "1.3.8",
-        "randombytes": "2.0.6",
-        "safe-buffer": "5.1.2",
-        "satoshi-bitcoin": "1.0.4",
-        "slp-mdm": "0.0.6",
-        "slp-parser": "0.0.4",
-        "wif": "2.0.6"
-      }
-    },
-    "node_modules/bch-consumer/node_modules/@psf/bch-js/node_modules/axios": {
-      "version": "0.26.1",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz",
-      "integrity": "sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA==",
-      "dependencies": {
-        "follow-redirects": "^1.14.8"
-      }
-    },
    "node_modules/bch-consumer/node_modules/apidoc": {
      "version": "0.51.0",
      "resolved": "https://registry.npmjs.org/apidoc/-/apidoc-0.51.0.tgz",
@@ -7223,19 +6869,6 @@
        "url": "https://github.com/sponsors/isaacs"
      }
    },
-    "node_modules/bch-consumer/node_modules/randombytes": {
-      "version": "2.0.6",
-      "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.0.6.tgz",
-      "integrity": "sha512-CIQ5OFxf4Jou6uOKe9t1AOgqpeU5fd70A8NPdHSGeYXqXsPe6peOwI0cUl88RWZ6sP1vPMV3avd/R6cZ5/sP1A==",
-      "dependencies": {
-        "safe-buffer": "^5.1.0"
-      }
-    },
-    "node_modules/bch-consumer/node_modules/safe-buffer": {
-      "version": "5.1.2",
-      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
-      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
-    },
    "node_modules/bch-donation": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/bch-donation/-/bch-donation-1.1.2.tgz",
@@ -11178,19 +10811,6 @@
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
    },
-    "node_modules/fsevents": {
-      "version": "2.3.3",
-      "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
-      "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
-      "hasInstallScript": true,
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
-      }
-    },
    "node_modules/function-bind": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",
@@ -11734,9 +11354,9 @@
      }
    },
    "node_modules/helia-coord": {
-      "version": "1.5.5",
-      "resolved": "https://registry.npmjs.org/helia-coord/-/helia-coord-1.5.5.tgz",
-      "integrity": "sha512-IUG/xobS7rcoIarYKTst/YicvXZSIrWSzqcFRu2Xujv820BblQrDMxHbMmUUoWGFnlgt/xw8cqBvH4AzrHLueg==",
+      "version": "1.5.6",
+      "resolved": "https://registry.npmjs.org/helia-coord/-/helia-coord-1.5.6.tgz",
+      "integrity": "sha512-sh7rEiw883aPsIMZ4vxbzA6OKQjuhz4vlIRoaNWJruju1mJY4hrn9BFPrtJ96KN054zZ0EwziVdTxD9vPV4bSQ==",
      "dependencies": {
        "@chris.troutner/retry-queue": "1.0.8",
        "bch-encrypt-lib": "2.1.1",
@@ -16096,14 +15716,14 @@
      }
    },
    "node_modules/minimal-slp-wallet": {
-      "version": "5.11.1",
-      "resolved": "https://registry.npmjs.org/minimal-slp-wallet/-/minimal-slp-wallet-5.11.1.tgz",
-      "integrity": "sha512-kQp6WS8f9ndoRwucpKtMaLXhOPCp3AK6seBT/TjduzUWfQS4SfXIJfYImVCwogknEW6JJyx5MdWQEWVvFIg/Zg==",
+      "version": "5.11.2",
+      "resolved": "https://registry.npmjs.org/minimal-slp-wallet/-/minimal-slp-wallet-5.11.2.tgz",
+      "integrity": "sha512-W3CCstFBjbYTReo/XyCErNFlC6Qb99dceTbSZDptgrCv/Xkgb9HtZrHVJtdriIn5GQN7SXNAlFuyK7m/G1CymA==",
      "dependencies": {
        "@chris.troutner/retry-queue-commonjs": "1.0.8",
        "@psf/bch-js": "6.7.3",
        "apidoc": "0.51.0",
-        "bch-consumer": "1.4.5",
+        "bch-consumer": "1.4.6",
        "bch-donation": "1.1.2",
        "crypto-js": "4.0.0"
      }
@@ -16225,6 +15845,7 @@
      "version": "0.5.6",
      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz",
      "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==",
+      "peer": true,
      "dependencies": {
        "minimist": "^1.2.6"
      },
@@ -24770,6 +24391,7 @@
      "version": "2.4.3",
      "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.3.tgz",
      "integrity": "sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==",
+      "peer": true,
      "dependencies": {
        "graceful-fs": "^4.1.11",
        "imurmurhash": "^0.1.4",
@@ -41,7 +41,7 @@
    "datastore-fs": "9.1.6",
    "glob": "7.1.6",
    "helia": "2.1.0",
-    "helia-coord": "1.5.5",
+    "helia-coord": "1.5.6",
    "jsonrpc-lite": "2.2.0",
    "jsonwebtoken": "8.5.1",
    "jwt-bch-lib": "1.3.0",
@@ -58,7 +58,7 @@
    "koa2-ratelimit": "0.9.1",
    "libp2p": "1.2.1",
    "line-reader": "0.4.0",
-    "minimal-slp-wallet": "5.11.1",
+    "minimal-slp-wallet": "5.11.2",
    "mongoose": "5.13.14",
    "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
    "nodemailer": "6.7.5",
@@ -102,7 +102,7 @@ class BchAdapter {
      return outObj
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in use-cases/bch.js/getStatus()')
+      wlogger.error('Error in adapters/bch.js/getStatus()')
      throw err
    }
  }
@@ -115,7 +115,7 @@ class BchAdapter {
      return true
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in use-cases/bch.js/getStatus()')
+      wlogger.error('Error in adapters/bch.js/getStatus()')
      throw err
    }
  }
@@ -160,13 +160,17 @@ class BchAdapter {
      return data
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in use-cases/bch.js/getBalances()')
+      wlogger.error('Error in adapters/bch.js/getBalances()')
      throw err
    }
  }

  async getUtxos (addr) {
    try {
+      if (!addr) {
+        throw new Error('addr required when calling getUtxos')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -203,7 +207,7 @@ class BchAdapter {
      return data
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in use-cases/bch.js/getUtxos()')
+      wlogger.error('Error in adapters/bch.js/getUtxos()')
      throw err
    }
  }
@@ -257,13 +261,17 @@ class BchAdapter {
      return data
    } catch (err) {
      // console.log('createUser() error: ', err)
-      wlogger.error('Error in use-cases/bch.js/getUtxosBulk()')
+      wlogger.error('Error in adapters/bch.js/getUtxosBulk()')
      throw err
    }
  }

  async broadcast (hex) {
    try {
+      if (!hex) {
+        throw new Error('hex required when calling broadcast')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -309,6 +317,10 @@ class BchAdapter {
    try {
      console.log('Executing getTransaction() bch adapter')

+      if (!address) {
+        throw new Error('address required when calling getTransactions()')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -354,6 +366,10 @@ class BchAdapter {
  // Get details on an array of TXIDs.
  async getTransaction (txids) {
    try {
+      if (!txids) {
+        throw new Error('txids required when calling getTransaction()')
+      }
+
      console.log(
        `Getting txData on these txids: ${JSON.stringify(txids, null, 2)}`
      )
@@ -401,6 +417,10 @@ class BchAdapter {

  async getPubKey (address) {
    try {
+      if (!address) {
+        throw new Error('address required when calling getPubKey()')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -443,6 +463,10 @@ class BchAdapter {

  async utxoIsValid (utxo) {
    try {
+      if (!utxo) {
+        throw new Error('utxo required when calling utxoIsValid()')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -485,6 +509,10 @@ class BchAdapter {

  async getTokenData (tokenId, withTxHistory = false) {
    try {
+      if (!tokenId) {
+        throw new Error('tokenId required when calling getTokenData()')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -529,6 +557,10 @@ class BchAdapter {
  // Get token icon and other media associated with the token.
  async getTokenData2 (tokenId, updateCache) {
    try {
+      if (!tokenId) {
+        throw new Error('tokenId required when calling getTokenData2()')
+      }
+
      // Throw an error if this IPFS node has not yet made a connection to a
      // wallet service provider.
      const selectedProvider =
@@ -573,6 +605,10 @@ class BchAdapter {
  // Returns a promise that resolves to data when the RPC response is recieved.
  async waitForRPCResponse (rpcId) {
    try {
+      if (!rpcId) {
+        throw new Error('rpcId can not be false or undefined')
+      }
+
      // Initialize variables for tracking the return data.
      let dataFound = false
      let cnt = 0
@@ -608,21 +644,25 @@ class BchAdapter {
        }

        // Wait between loops.
-        // await this.sleep(1000)
-        await this.ipfs.ipfsCoordAdapter.bchjs.Util.sleep(2000)
+        await this.sleep(2000)
+        // await this.ipfs.ipfsCoordAdapter.bchjs.Util.sleep(2000)

        cnt++

        // Exit if data was returned, or the window for a response expires.
      } while (!dataFound && cnt < 10)
-      // console.log(`dataFound: ${dataFound}, cnt: ${cnt}`)
+      console.log(`dataFound: ${dataFound}, cnt: ${cnt}`)

      return data
    } catch (err) {
-      console.error('Error in waitForRPCResponse()')
+      console.error('Error in waitForRPCResponse(): ', err)
      throw err
    }
  }
+
+  sleep (ms) {
+    return new Promise(resolve => setTimeout(resolve, ms))
+  }
 }

 // module.exports = BchAdapter
@@ -18,9 +18,9 @@ import P2WDB from './p2wdb/index.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 = {}) {
@@ -44,6 +44,7 @@ class Adapters {
    this.config = config
    this.bch = new BCH(localConfig)
    this.p2wdb = new P2WDB(localConfig)
+    this.wallet = new Wallet(localConfig)

    // Get a valid JWT API key and instance bch-js.
    this.fullStackJwt = new FullStackJWT(config)
@@ -51,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') {
@@ -0,0 +1,234 @@
+/*
+  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 {
+        // console.log('this.config.walletFile: ', this.config.walletFile)
+        walletData = await this.jsonFiles.readJSON(this.config.walletFile)
+      } 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(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()
+      // console.log('original walletdata: ', walletData)
+      walletData.nextAddress++
+      // console.log('walletData finish: ', walletData)
+      await this.jsonFiles.writeJSON(walletData, this.WALLET_FILE)
+      // 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
@@ -94,25 +94,12 @@ describe('#bch-use-case', () => {

    it('should catch and throw an error', async () => {
      try {
-        // Force an error
-        uut.ipfs.ipfsCoordAdapter.bchjs = {
-          Util: {
-            sleep: () => {
-              throw new Error('test error')
-            }
-          }
-        }
-
-        // Mock data.
-        const rpcId = '123'
-        uut.rpcDataQueue.push(mockData.rpcData)
-
-        await uut.waitForRPCResponse(rpcId)
+        await uut.waitForRPCResponse()

        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log('error: ', err)
-        assert.include(err.message, 'test error')
+        assert.include(err.message, 'rpcId can not be false or undefined')
      }
    })
  })
@@ -156,6 +143,9 @@ describe('#bch-use-case', () => {

    it('should catch and throw an error', async () => {
      try {
+        // Force an error
+        sandbox.stub(uut, 'uid').throws(new Error('test error'))
+
        await uut.getBalances()

        assert.fail('Unexpected code path')
@@ -191,7 +181,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'addr required when calling getUtxos')
      }
    })
  })
@@ -267,7 +257,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'hex required when calling broadcast')
      }
    })
  })
@@ -297,7 +287,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'address required when calling getTransactions()')
      }
    })
  })
@@ -327,7 +317,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'txids required when calling getTransaction()')
      }
    })
  })
@@ -357,7 +347,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'address required when calling getPubKey()')
      }
    })
  })
@@ -387,7 +377,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'utxo required when calling utxoIsValid()')
      }
    })
  })
@@ -417,7 +407,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'tokenId required when calling getTokenData()')
      }
    })
  })
@@ -447,7 +437,7 @@ describe('#bch-use-case', () => {
        assert.fail('Unexpected code path')
      } catch (err) {
        // console.log(err)
-        assert.equal(err.message, 'test error')
+        assert.equal(err.message, 'tokenId required when calling getTokenData2()')
      }
    })
  })
@@ -0,0 +1,343 @@
+/*
+  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.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.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
+      // mock instance of minimal-slp-wallet
+      uut.bchWallet = new MockBchWallet()
+      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)
+  }
+}
@@ -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)
@@ -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
+};
@@ -0,0 +1,11 @@
+{
+  "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
+}
Author	SHA1	Message	Date
Chris Troutner	6cfaceb99e	Merge pull request #50 from Permissionless-Software-Foundation/ct-unstable Syncing with upstream, fixing flaky tests	2024-03-24 08:25:20 -07:00
Chris Troutner	b12cc194f4	fix(tests): Fixed fragile unit tests	2024-03-24 08:24:08 -07:00
Chris Troutner	7cffd9f377	Merge pull request #145 from Permissionless-Software-Foundation/ct-unstable fix(helia-coord): Updating to v1.5.6, auto-retry of bootstrap list	2024-03-24 07:44:46 -07:00
Chris Troutner	0a406cb9a4	fix(helia-coord): Updating to v1.5.6, auto-retry of bootstrap list	2024-03-24 07:43:34 -07:00
Chris Troutner	f172a51016	Merge pull request #144 from Permissionless-Software-Foundation/ct-unstable Integrating minimal-slp-wallet. Wallet creation at startup	2024-03-23 17:46:55 -07:00
Chris Troutner	00d53659b1	Updating README	2024-03-23 17:44:41 -07:00
Chris Troutner	b0797d92f5	Increased test coverage to 100%	2024-03-23 17:42:59 -07:00
Chris Troutner	48484ed7af	Fixing typo with web3 wallet	2024-03-23 17:23:07 -07:00
Chris Troutner	6a4aadde8a	Refactoring config file	2024-03-23 17:14:26 -07:00
Chris Troutner	79e3aba26e	Adding default startup wallet	2024-03-23 16:18:10 -07:00
Chris Troutner	bf61359bc7	feat(wallet): Added adapter library for consuming minimal-slp-wallet	2024-03-23 11:16:45 -07:00
Chris Troutner	1911991511	linting	2024-03-23 08:18:47 -07:00
Chris Troutner	ef0179fb3f	fix(README): Adding config variables to README	2024-03-23 08:18:32 -07:00
Chris Troutner	38bdfe306b	Merge pull request #49 from Permissionless-Software-Foundation/helia v3.0: Helia	2024-03-22 13:31:33 -07:00