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

fix(bch-js): Updating to bch-js v5

README.md

@@ -24,13 +24,17 @@ This repository is one step in a longer path. Here are the major milestones of t
 
 ## Requirements
 
-- node **^14.17.0**
-- npm **^7.13.0**
+- node **^14.18.2**
+- npm **^8.3.0**
+- Docker **^20.10.8**
+- Docker Compose **^1.27.4**
 
 ## Installation
 
 ### Development Environment
 
+**Note:** This software now uses an external go-ipfs IPFS node. The instructions below have not been updated to reflect this.
+
 A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. [PM2](https://www.npmjs.com/package/pm2) is recommended for running this code base as an IPFS Circuit Relay.
 
 - [Video: Installing ipfs-service-provider](https://youtu.be/Z0NsboIVN44)
@@ -41,23 +45,33 @@ git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-
 cd ipfs-bch-wallet-service
 ./install-mongo.sh
 npm install
-cd shell-scripts 
+cd shell-scripts
 ./ipfs-bch-wallet-service.sh
 ```
 
 ### Production Environment
 
-The [docker](./production/docker) directory contains a Dockerfile for building a production deployment. However, there is currently [a bug](https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38) preventing the Docker container from being used as a Circuit Relay.
+The [docker](./production/docker) directory contains a Dockerfile for building a production deployment.
 
 ```
 docker-compose build --no-cache
 docker-compose up -d
 ```
 
+- Bring the containers up once, then take them back down with `docker-compose down`.
+- Copy the [swarm.key](./swarm.key) file to `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`.
+- Bring the containers back up with `docker-compose up -d`.
+
 ### Operation Notes
 
 - There is a memory leak in the version of js-ipfs. The app is currently configured to shut down every 8 hours to flush memory. It relies on a process manager like pm2, Docker, or systemd to restart the app after it shuts down, in order to ensure continuous operation.
 
+- The PSF network operates as a private network. It does not connect or interact with the wider PSF network, relying instead on gateways to bridge the two networks, when they need to share content. This improves the performance and experience for everyone in the PSF network. To join the network, you'll need to add the [swarm.key](./swarm.key) file to the IPFS data folder.
+
+- [Instructions on setting up IPFS private networks.](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#private-networks)
+- For external installations, the swarm.key file will typically go in `~/.ipfs/swarm.key`
+- For production Docker containers, the key would go in `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`
+
 ## Structure
 
 The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](troutsblog.com/blog/clean-architecture).

bin/server.js

@@ -97,8 +97,11 @@ class Server {
         )
       }
 
-      // Attach the other IPFS controllers
-      await controllers.attachControllers(app)
+      // Attach the other IPFS controllers.
+      // Skip if this is a test environment.
+      if (config.env !== 'test') {
+        await controllers.attachControllers(app)
+      }
 
       // ipfs-coord has a memory leak. This app shuts down after 4 hours. It
       // expects to be run by Docker or pm2, which can automatically restart

package-lock.json

@@ -1,20 +1,20 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.11.12",
+  "version": "2.0.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "ipfs-bch-wallet-service",
-      "version": "1.11.12",
+      "version": "2.0.0",
       "license": "MIT",
       "dependencies": {
-        "@psf/bch-js": "4.20.28",
-        "axios": "0.21.1",
+        "@psf/bch-js": "5.2.0",
+        "axios": "0.25.0",
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
         "ipfs": "0.60.0",
-        "ipfs-coord": "6.8.1",
+        "ipfs-coord": "6.8.10",
         "ipfs-http-client": "55.0.0",
         "jsonrpc-lite": "2.2.0",
         "jsonwebtoken": "8.5.1",
@@ -58,6 +58,39 @@
         "uuid": "8.3.2"
       }
     },
+    "../ipfs-coord": {
+      "version": "6.0.0",
+      "extraneous": true,
+      "license": "MIT",
+      "dependencies": {
+        "axios": "0.21.4",
+        "bch-encrypt-lib": "2.0.0",
+        "orbit-db": "0.28.0"
+      },
+      "devDependencies": {
+        "@psf/bch-js": "4.20.10",
+        "apidoc": "0.25.0",
+        "chai": "4.2.0",
+        "coveralls": "3.1.0",
+        "eslint": "7.17.0",
+        "eslint-config-prettier": "7.1.0",
+        "eslint-config-standard": "16.0.2",
+        "eslint-plugin-node": "11.1.0",
+        "eslint-plugin-prettier": "3.3.1",
+        "eslint-plugin-standard": "4.0.0",
+        "husky": "4.3.6",
+        "lodash.clonedeep": "4.5.0",
+        "mocha": "8.4.0",
+        "nyc": "15.1.0",
+        "semantic-release": "17.4.4",
+        "sinon": "9.2.2",
+        "standard": "16.0.3"
+      },
+      "peerDependencies": {
+        "ipfs": "0.60.0",
+        "ipfs-http-client": "55.0.0"
+      }
+    },
     "node_modules/@assemblyscript/loader": {
       "version": "0.9.4",
       "resolved": "http://94.130.170.209:4873/@assemblyscript%2floader/-/loader-0.9.4.tgz",
@@ -2208,9 +2241,9 @@
       "license": "BSD-3-Clause"
     },
     "node_modules/@psf/bch-js": {
-      "version": "4.20.28",
-      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.20.28.tgz",
-      "integrity": "sha512-tlWfYTUnmAzrFZDHTuP2CccE6fp20j4XcCIJiJYlpaKzxB0ilH8CEVWBQaMY+Fb+eaTrlSdiaDC5MBWV4klpQg==",
+      "version": "5.2.0",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-5.2.0.tgz",
+      "integrity": "sha512-1QbKrdtww+nISvuwKe9X8/9GrqZWswjn0AChm0+UqobEV6WqGUXbsYL7621nvUaWzHz040evgOAiM6VaTtfNhg==",
       "license": "MIT",
       "dependencies": {
         "@chris.troutner/bip32-utils": "1.0.5",
@@ -3508,12 +3541,12 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "0.21.1",
-      "resolved": "http://94.130.170.209:4873/axios/-/axios-0.21.1.tgz",
-      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
+      "version": "0.25.0",
+      "resolved": "http://94.130.170.209:4873/axios/-/axios-0.25.0.tgz",
+      "integrity": "sha512-cD8FOb0tRH3uuEe6+evtAbgJtfxr7ly3fQjYcMcuPlgkwVS9xboaVIpcDV+cYQe+yGykgwZCs1pzjntcGa6l5g==",
       "license": "MIT",
       "dependencies": {
-        "follow-redirects": "^1.10.0"
+        "follow-redirects": "^1.14.7"
       }
     },
     "node_modules/backo2": {
@@ -7809,9 +7842,9 @@
       "license": "MIT"
     },
     "node_modules/follow-redirects": {
-      "version": "1.14.4",
-      "resolved": "http://94.130.170.209:4873/follow-redirects/-/follow-redirects-1.14.4.tgz",
-      "integrity": "sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g==",
+      "version": "1.14.7",
+      "resolved": "http://94.130.170.209:4873/follow-redirects/-/follow-redirects-1.14.7.tgz",
+      "integrity": "sha512-+hbxoLbFMbRKDwohX8GkTataGqO6Jb7jGwpAlwgy2bIz25XtRm7KEzJM76R1WiNT5SwZkX4Y75SwBolkpmE7iQ==",
       "funding": [
         {
           "type": "individual",
@@ -10388,9 +10421,9 @@
       }
     },
     "node_modules/ipfs-coord": {
-      "version": "6.8.1",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.1.tgz",
-      "integrity": "sha512-GxGc3oNHg5PvTuzeOqI4cpheo2tNlQ+lMnagFUhD3QzGSzvqxbVrhbggMhkRCwMm/LePOWlba4QAdOkBHuO5bQ==",
+      "version": "6.8.10",
+      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.10.tgz",
+      "integrity": "sha512-04nlX4AkfqLuuLzpMcHnpv++iOETLRkzFA2GfAmY90r99HynfHt3DypP6loVdAnD34iWgD+tLhKNQ7QQM7cgfQ==",
       "license": "MIT",
       "dependencies": {
         "axios": "0.21.4",
@@ -12791,6 +12824,15 @@
         "axios": "^0.21.1"
       }
     },
+    "node_modules/jwt-bch-lib/node_modules/axios": {
+      "version": "0.21.4",
+      "resolved": "http://94.130.170.209:4873/axios/-/axios-0.21.4.tgz",
+      "integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==",
+      "license": "MIT",
+      "dependencies": {
+        "follow-redirects": "^1.14.0"
+      }
+    },
     "node_modules/k-bucket": {
       "version": "5.1.0",
       "resolved": "http://94.130.170.209:4873/k-bucket/-/k-bucket-5.1.0.tgz",
@@ -27913,9 +27955,9 @@
       "integrity": "sha1-p3c2C1s5oaLlEG+OhY8v0tBgxXA="
     },
     "@psf/bch-js": {
-      "version": "4.20.28",
-      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.20.28.tgz",
-      "integrity": "sha512-tlWfYTUnmAzrFZDHTuP2CccE6fp20j4XcCIJiJYlpaKzxB0ilH8CEVWBQaMY+Fb+eaTrlSdiaDC5MBWV4klpQg==",
+      "version": "5.2.0",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-5.2.0.tgz",
+      "integrity": "sha512-1QbKrdtww+nISvuwKe9X8/9GrqZWswjn0AChm0+UqobEV6WqGUXbsYL7621nvUaWzHz040evgOAiM6VaTtfNhg==",
       "requires": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
@@ -28920,11 +28962,11 @@
       "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA=="
     },
     "axios": {
-      "version": "0.21.1",
-      "resolved": "http://94.130.170.209:4873/axios/-/axios-0.21.1.tgz",
-      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
+      "version": "0.25.0",
+      "resolved": "http://94.130.170.209:4873/axios/-/axios-0.25.0.tgz",
+      "integrity": "sha512-cD8FOb0tRH3uuEe6+evtAbgJtfxr7ly3fQjYcMcuPlgkwVS9xboaVIpcDV+cYQe+yGykgwZCs1pzjntcGa6l5g==",
       "requires": {
-        "follow-redirects": "^1.10.0"
+        "follow-redirects": "^1.14.7"
       }
     },
     "backo2": {
@@ -32066,9 +32108,9 @@
       "integrity": "sha1-kV4tbQI8Q9UiStn20qPEFW9XEvU="
     },
     "follow-redirects": {
-      "version": "1.14.4",
-      "resolved": "http://94.130.170.209:4873/follow-redirects/-/follow-redirects-1.14.4.tgz",
-      "integrity": "sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g=="
+      "version": "1.14.7",
+      "resolved": "http://94.130.170.209:4873/follow-redirects/-/follow-redirects-1.14.7.tgz",
+      "integrity": "sha512-+hbxoLbFMbRKDwohX8GkTataGqO6Jb7jGwpAlwgy2bIz25XtRm7KEzJM76R1WiNT5SwZkX4Y75SwBolkpmE7iQ=="
     },
     "for-each": {
       "version": "0.3.3",
@@ -33891,9 +33933,9 @@
       }
     },
     "ipfs-coord": {
-      "version": "6.8.1",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.1.tgz",
-      "integrity": "sha512-GxGc3oNHg5PvTuzeOqI4cpheo2tNlQ+lMnagFUhD3QzGSzvqxbVrhbggMhkRCwMm/LePOWlba4QAdOkBHuO5bQ==",
+      "version": "6.8.10",
+      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.10.tgz",
+      "integrity": "sha512-04nlX4AkfqLuuLzpMcHnpv++iOETLRkzFA2GfAmY90r99HynfHt3DypP6loVdAnD34iWgD+tLhKNQ7QQM7cgfQ==",
       "requires": {
         "axios": "0.21.4",
         "bch-encrypt-lib": "2.0.0",
@@ -35734,6 +35776,16 @@
       "integrity": "sha512-CZs3jUHJlWvConvoTeLDogDEwUysKeojYJxfUhbwJKJrtDCSfi3ZWbsZZ8WN30Xs28aZPDB+qlHPJlTXQmup0w==",
       "requires": {
         "axios": "^0.21.1"
+      },
+      "dependencies": {
+        "axios": {
+          "version": "0.21.4",
+          "resolved": "http://94.130.170.209:4873/axios/-/axios-0.21.4.tgz",
+          "integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==",
+          "requires": {
+            "follow-redirects": "^1.14.0"
+          }
+        }
       }
     },
     "k-bucket": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.11.12",
+  "version": "2.0.0",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "scripts": {
@@ -23,12 +23,12 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "4.20.28",
-    "axios": "0.21.1",
+    "@psf/bch-js": "5.2.0",
+    "axios": "0.25.0",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
     "ipfs": "0.60.0",
-    "ipfs-coord": "6.8.1",
+    "ipfs-coord": "6.8.10",
     "ipfs-http-client": "55.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",

production/docker/README.md

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

production/docker/docker-compose.yml

@@ -14,7 +14,7 @@ services:
     restart: always
 
   ipfs-bch-wallet:
-    image: ipfs/go-ipfs:latest
+    image: ipfs/go-ipfs:v0.11.0
     container_name: ipfs-bch-wallet
     environment:
       MY_ENV_VAR: 'placeholder'
@@ -26,8 +26,8 @@ services:
     mem_limit: 2000mb
     ports:
       - 4001:4001
-      - 5001:5001
-      - 8080:8080
+      - 172.17.0.1:5001:5001
+      - 172.17.0.1:8080:8080
     volumes:
       - ../data/go-ipfs/data:/data/ipfs
       - ../data/go-ipfs/export:/export
@@ -58,3 +58,4 @@ services:
       - '5010:5010' # <host port>:<container port>
     volumes:
       - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-service/.ipfsdata
+    restart: always

production/docker/start-production.sh

@@ -17,7 +17,16 @@ export COORD_NAME=bch-wallet-service-generic
 #export CR_DOMAIN=subdomain.yourdomain.com
 
 # Debug level. 0 = minimal info. 2 = max info.
-export DEBUG_LEVEL=1
+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/
+# These settings are used to proxy a subscription to FullStack.cash.
+export GET_JWT_AT_STARTUP=1
+export AUTHSERVER=https://auth.fullstack.cash
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
 
 # END: Optional configuration settings
 
@@ -25,18 +34,6 @@ export DEBUG_LEVEL=1
 # Production database connection string.
 export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
 
-# Customize these environment variables for your own installation.
-export GET_JWT_AT_STARTUP=1
-export AUTHSERVER=https://auth.fullstack.cash
-export APISERVER=https://api.fullstack.cash/v5/
-export FULLSTACKLOGIN=demo@demo.com
-export FULLSTACKPASS=demo
-
-# Configure IPFS ports
-#export IPFS_TCP_PORT=5268
-#export IPFS_WS_PORT=5269
-
-
 # Configure REST API port
 export PORT=5010
 
@@ -44,5 +41,7 @@ export PORT=5010
 export SVC_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
+export IPFS_TCP_PORT=4001
+#export IPFS_WS_PORT=4002
 
 npm start

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

@@ -13,7 +13,7 @@ export COORD_NAME=ipfs-service-provider-generic
 export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
 
 # 0 = less verbose. 3 = most verbose
-export DEBUG_LEVEL=1
+export DEBUG_LEVEL=2
 
 # Production settings that use external IPFS node.
 # https://github.com/christroutner/docker-ipfs
@@ -22,6 +22,10 @@ export SVC_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 
+# Configure IPFS ports
+export IPFS_TCP_PORT=4001
+#export IPFS_WS_PORT=5269
+
 # MongoDB connection string.
 export DBURL=mongodb://localhost:27017/ipfs-service-dev
 

src/adapters/ipfs/ipfs.js

@@ -14,6 +14,7 @@
 const IPFSembedded = require('ipfs')
 const IPFSexternal = require('ipfs-http-client')
 const fs = require('fs')
+const http = require('http')
 
 // Local libraries
 const config = require('../../../config')
@@ -74,7 +75,8 @@ class IpfsAdapter {
 
       const ipfsOptionsExternal = {
         host: this.config.ipfsHost,
-        port: this.config.ipfsApiPort
+        port: this.config.ipfsApiPort,
+        agent: http.Agent({ keepAlive: true, maxSockets: 2000 })
       }
 
       let ipfsOptions = ipfsOptionsEmbedded

swarm.key

@@ -0,0 +1,3 @@
+/key/swarm/psk/1.0.0/
+/base16/
+bbd935b70105b03ebd0c6a3c2d2730cd22fc0d18c490ccf689b6c8a22e1bed2a