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

fix(webhook): Fixing default webhook URL

README.md

@@ -2,33 +2,66 @@
 
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Join the chat at https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev](https://badges.gitter.im/Permissionless-Software-Foundation/psf-dex-dev.svg)](https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-This is a prototype web service that monitors the [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) for trading signals, to trade BCH and SLP tokens. It's inspired by the [SWaP Prototype](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
+This is a prototype web service that monitors the [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) for trading signals, to trade BCH and SLP tokens. It's inspired by the [SWaP Protocol](https://github.com/vinarmani/swap-protocol/blob/master/swap-protocol-spec.md).
 
-This repository was forked from [ipfs-torlist-service](https://github.com/Permissionless-Software-Foundation/ipfs-torlist-service).
-
-## Development Notes
+This repository contains the back end code. The user interface is contained in the [bch-dex-ui](https://github.com/Permissionless-Software-Foundation/bch-dex-ui) repository.
 
 **Warning**: This repository is under active development. Things will be constantly changing and breaking.
 
-### Road Map:
+## Media
+- [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video)
+- [Developer walk-through for installing and hacking on bch-dex](https://youtu.be/T5XI43-SWJo) (Video)
 
-- Phase 1: MVP (single user)
-  - Move tokens or BCH for sale to temporary address.
-  - Accept input from user:
-    - Submit Signal message to P2WDB for new buy/sell order.
-    - Check UTXO status before submitting Payment message.
-  - React to webhook when new Offers come in.
-    - Add and track new Offers in MongoDB.
-    - Process Payment signals:
-      - Checking transaction for compatibility
-      - Broadcast/close trades managed by this app.
-- Phase 2: Build single-user web app
-  - _Make_ buy or sell orders.
-  - Browse Offers on the market.
-  - _Take_ buy or sell orders.
-- Phase 3: Multi-user
-  - Configure REST API as an IPFS Service that can offer services to multiple users.
-  - Update web app to display and select available SWaP services over IPFS.
+## Participate
+This is an open source project, and we encourage other JavaScript developers to participate in its creation and maintenance. We have two chat rooms for the community:
+- [Telegram Channel](https://t.me/psf_dex_dev)
+- [Gitter Channel](https://gitter.im/Permissionless-Software-Foundation/psf-dex-dev)
+
+## Installation
+Running the DEX requires composition of these different software packages:
+- bch-dex - This repository is the back end software that tracks trade data on the network, generates [Offers and Counter Offers](https://github.com/Permissionless-Software-Foundation/bch-dex/tree/ct-unstable/dev-docs#definitions), and finalizes trades by accepting Counter Offers.
+- [bch-dex-ui](https://github.com/Permissionless-Software-Foundation/bch-dex-ui) is a [Gatsby](https://www.gatsbyjs.com/) web app and user interface (UI) for bch-dex.
+- [P2WDB](https://github.com/Permissionless-Software-Foundation/ipfs-p2wdb-service) is a censorship-resistant database used to communicate trade data between peers running bch-dex.
+- [IPFS](https://ipfs.io/) is a censorship-resistant network for communicating data over the internet.
+- [MongoDB](https://www.mongodb.com/) is a database used by both P2WDB and bch-dex to store and manage local data.
+
+The above software is orchestrated using [Docker](https://www.docker.com/) and Docker Compose. The target operating system is Ubuntu 20+, and the target hardware is amd64 (normal desktop PCs) and the arm64 (Raspberry Pi 4). Trying to operate this software on other operating systems or hardware is possible, but not supported.
+
+Instructions for setting up Node.js, Docker, and Docker Compose can be found in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd). Walk-through videos can also be found on the [PSF Videos page](https://psfoundation.cash/video/).
+
+Building the Docker containers and getting the app working involve these steps:
+<ol>
+<li>Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose.</li>
+<li>Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`.</li>
+<li>Install dependencies by running `npm install`</li>
+<li>Create a wallet by executing the [create-wallet.js script](./production/scripts/create-wallet.js) with `node create-wallet.js`</li>
+<li>Move the `wallet.json` file to the `bch-dex` folder in either the [x86 Docker folder](./production/docker/bch-dex) or the [RPi Docker folder](./production/rpi-docker/bch-dex/) depending on your hardware target.</li>
+<li>Change directory to the `docker` or `rpi-docker` folder depending on your hardware target.</li>
+<li>Build the Docker containers with `docker-compose build --no-cache`.</li>
+<li>Start the Docker containers with `docker-compose up -d`</li>
+<li>Wait for the containers to run for about a minute, then bring them down with `docker-compose down`. That will create the needed folders in `production/data`.</li>
+<li>Copy the `swarm.key` into the `production/data/go-ipfs/data/` directory. This will allow the IPFS node to connect to the PSF private network.</li>
+<li>Bring the containers back up with `docker-compose up -d`.</li>
+<li>Wait for the P2WDB to sync and populate bch-dex with trade data. You can monitor it with `docker logs --tail 20 -f p2wdb`.</li>
+<li>Open a web browser and navigate the `http://localhost:4500`. You'll be able to see new Offers as they come in and are detected by bch-dex.</li>
+<li>To take the other side of the trade, click the `Take` button in the UI.</li>
+<li>You can add the 12-word mnemonic from the `wallet.json` file to the the web wallet, which will mirror your wallet in the UI, and allow you to perform basic wallet functions (send and receive BCH and tokens).</li>
+</ol>
+  
+### Applying Software Updates
+As this is an active project, software updates will happen frequently. To apply a software update, perform these steps.
+
+<ol>
+  <li>Enter the `docker` or `rpi-docker` folder, depending on your hardware target.</li>
+<li>Bring down the Docker containers with `docker-compose down`.</li>
+<li>Pull in the software updates with `git pull`</li>
+<li>Update dependencies with `npm install`</li>
+<li>Rebuild the Docker containers with `docker-compose build --no-cache`</li>
+<li>Clean up disk space by deleting old Docker images with `./cleanup-images.sh`</li>
+<li>Start the Docker containers with `docker-compose up -d`</li>
+</ol>
+  
+Sometimes it may be necessary to delete the databases before applying a software update. This can be done by stopping the Docker containers and deleting the `production/data` directory. When the Docker containers are restarted, they will recreate that directory. The P2WDB will re-sync and bch-dex will be populated with fresh trade data.
 
 ## License
 

config/env/common.js

@@ -88,7 +88,7 @@ module.exports = {
   p2wdbAppId: process.env.APP_ID ? process.env.APP_ID : 'bch-dex-test557',
   webhookTarget: process.env.WEBHOOKTARGET
     ? process.env.WEBHOOKTARGET
-    : 'http://localhost:5700/offer',
+    : 'http://localhost:5700/p2wdb',
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 4001,

package.json

@@ -27,9 +27,9 @@
   },
   "repository": "Permissionless-Software-Foundation/bch-dex",
   "dependencies": {
-    "@psf/bch-js": "6.2.1",
+    "@psf/bch-js": "6.2.5",
     "axios": "0.21.1",
-    "bch-message-lib": "2.1.4",
+    "bch-message-lib": "2.2.0",
     "bcryptjs": "2.4.3",
     "bitcoincashjs-lib": "3.3.3",
     "glob": "7.1.6",
@@ -52,7 +52,7 @@
     "koa2-ratelimit": "0.9.1",
     "libp2p": "^0.36.2",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "4.4.5",
+    "minimal-slp-wallet": "4.4.7",
     "mongoose": "5.13.13",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.4.17",

production/docker/docker-compose.yml

@@ -82,13 +82,15 @@ services:
       - '5700:5700' # <host port>:<container port>
     # volumes:
     #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
-    #restart: always
+    restart: always
 
   dex-ui:
     build:
       context: ./bch-dex-ui/
       dockerfile: Dockerfile
     container_name: dex-ui
+    environment:
+      SERVER: 'http://192.168.2.3'
     logging:
       driver: 'json-file'
       options:
@@ -101,4 +103,4 @@ services:
       - '4500:80' # <host port>:<container port>
     # volumes:
     #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
-    #restart: always
+    restart: always

production/rpi-docker/docker-compose.yml

@@ -83,7 +83,7 @@ services:
       - '5700:5700' # <host port>:<container port>
     # volumes:
     #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
-    #restart: always
+    restart: always
 
   dex-ui:
     build:
@@ -102,4 +102,4 @@ services:
       - '4500:80' # <host port>:<container port>
     # volumes:
     #   - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
-    #restart: always
+    restart: always

production/scripts/create-order.js

@@ -8,8 +8,8 @@
 
 const axios = require('axios')
 
-// const LOCALHOST = 'http://localhost:5700'
-const LOCALHOST = 'http://172.17.0.1:5700'
+const LOCALHOST = 'http://localhost:5700'
+// const LOCALHOST = 'http://172.17.0.1:5700'
 
 async function start () {
   try {
@@ -22,7 +22,7 @@ async function start () {
       buyOrSell: 'sell',
       rateInBaseUnit: 5000,
       minUnitsToExchange: 5000,
-      numTokens: 1
+      numTokens: 2
     }
 
     const options = {

production/scripts/create-wallet.js

@@ -0,0 +1,32 @@
+/*
+  Generate a wallet.json file for use with the DEX.
+*/
+
+// Public NPM libraries
+const BchWallet = require('minimal-slp-wallet/index')
+const fs = require('fs').promises
+
+async function createWallet () {
+  try {
+    // Configure the minimal-slp-wallet library to use the JSON RPC over IPFS.
+    const advancedConfig = {
+      interface: 'consumer-api',
+      noUpdate: true
+    }
+
+    // Wait for the wallet to be created.
+    this.bchWallet = new BchWallet(undefined, advancedConfig)
+    await this.bchWallet.walletInfoPromise
+    const walletData = this.bchWallet.walletInfo
+    walletData.nextAddress = 1
+
+    // Save the wallet file to disk.
+    await fs.writeFile('wallet.json', JSON.stringify(walletData, null, 2))
+
+    console.log('Generated wallet.json. Copy this file to the docker/bch-dex folder to be used inside the Docker container.')
+    console.log(`${JSON.stringify(walletData, null, 2)}`)
+  } catch (err) {
+    console.error('Error: ', err)
+  }
+}
+createWallet()

src/adapters/wlogger.js

@@ -49,7 +49,8 @@ class Wlogger {
   }
 
   notifyRotation (oldFilename, newFilename) {
-    this.wlogger.info('Rotating log files')
+    // this.wlogger.info('Rotating log files')
+    console.log('Rotating log files')
   }
 
   outputToConsole () {

src/use-cases/offer/index.js

@@ -250,25 +250,25 @@ class OfferUseCases {
   }
 
   async findOfferByHash (p2wdbHash) {
-    try {
-      if (typeof p2wdbHash !== 'string' || !p2wdbHash) {
-        throw new Error('p2wdbHash must be a string')
-      }
-
-      const offer = await this.OfferModel.findOne({ p2wdbHash })
-
-      if (!offer) {
-        throw new Error('offer not found')
-      }
-
-      const offerObject = offer.toObject()
-      // return this.offerEntity.validateFromModel(offerObject)
-
-      return offerObject
-    } catch (err) {
-      console.error('Error in findOffer(): ', err)
-      throw err
+    // try {
+    if (typeof p2wdbHash !== 'string' || !p2wdbHash) {
+      throw new Error('p2wdbHash must be a string')
     }
+
+    const offer = await this.OfferModel.findOne({ p2wdbHash })
+
+    if (!offer) {
+      throw new Error('offer not found')
+    }
+
+    const offerObject = offer.toObject()
+    // return this.offerEntity.validateFromModel(offerObject)
+
+    return offerObject
+    // } catch (err) {
+    //   // console.error('Error in findOffer(): ', err)
+    //   throw err
+    // }
   }
 
   // This function is called by the P2WDB webhook REST API handler. When a

src/use-cases/order.js

@@ -101,6 +101,9 @@ class OrderLib {
       // console.log('this.adapters.wallet: ', this.adapters.wallet.bchWallet)
       // console.log(`walletInfo: ${JSON.stringify(this.adapters.wallet.bchWallet.walletInfo, null, 2)}`)
 
+      // Update the wallet balance
+      await this.adapters.wallet.bchWallet.getUtxos()
+
       // Ensure the app wallet has enough funds to write to the P2WDB.
       const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
       const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)