mirror of
https://github.com/Permissionless-Software-Foundation/bch-dex.git
synced 2026-09-21 16:52:00 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f2a12f6ec | ||
|
|
c1b687efd1 | ||
|
|
faf5a83eb6 | ||
|
|
92a35b220f | ||
|
|
58e934eeab | ||
|
|
d5de76729d | ||
|
|
805cac97d9 | ||
|
|
91fa460158 | ||
|
|
2d6055b537 | ||
|
|
72e6a37ed1 | ||
|
|
9d18a24c7e | ||
|
|
feacf6e571 | ||
|
|
c51f7cdf3a | ||
|
|
07fbe8c654 | ||
|
|
a65ec7494f | ||
|
|
59fca7903f | ||
|
|
f8948f12fa | ||
|
|
b79163cdf7 | ||
|
|
2d537994ef | ||
|
|
2ae963ee62 | ||
|
|
f5cd59eb12 | ||
|
|
d4f9e128b3 | ||
|
|
3c322ecbd0 | ||
|
|
56944176fa | ||
|
|
5f9cdc3f2e | ||
|
|
c20938f9f7 | ||
|
|
5be3c92a29 | ||
|
|
1476500c61 | ||
|
|
519980eb99 | ||
|
|
1e4b71aacd | ||
|
|
2c1c009b64 | ||
|
|
09cbfd00e8 | ||
|
|
2c21d79740 | ||
|
|
15eb871b1f | ||
|
|
f4e80017d6 | ||
|
|
e27b9da2ee | ||
|
|
adb210cd60 | ||
|
|
ff7697baf6 | ||
|
|
d65c3701cd | ||
|
|
4303efdb43 | ||
|
|
87b1b7f9ca | ||
|
|
3dddf21986 | ||
|
|
238bee3d92 | ||
|
|
04f77c883a | ||
|
|
cddf141ce4 | ||
|
|
628d8c01f8 | ||
|
|
0ed4a03314 | ||
|
|
5eb8464469 | ||
|
|
d1dc4dd198 | ||
|
|
1ba3633fac | ||
|
|
69dd2c2627 | ||
|
|
0a838b7fd7 | ||
|
|
de9ede9859 | ||
|
|
8273ae29d0 | ||
|
|
4d733f0995 | ||
|
|
f812580169 | ||
|
|
ec8dc91d36 | ||
|
|
03214fd7df | ||
|
|
9aae6da4a7 | ||
|
|
6e7ab40dea | ||
|
|
3b45e3c2c4 | ||
|
|
756002dd8c | ||
|
|
86da41b6c8 | ||
|
|
c2838b6117 | ||
|
|
af33de3f9a | ||
|
|
50d7cf137f | ||
|
|
dad9803d69 | ||
|
|
a235e57302 | ||
|
|
bb2f20b322 | ||
|
|
1f91bb05dd | ||
|
|
5e044f3d10 | ||
|
|
a94f2d32b5 | ||
|
|
4b66305392 |
@@ -2,33 +2,74 @@
|
||||
|
||||
[](http://standardjs.com) [](https://github.com/semantic-release/semantic-release) [](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).
|
||||
`bch-dex` is a decentralized exchange for permissionless trading of [SLP tokens](https://github.com/simpleledger/slp-specifications/blob/master/slp-token-type-1.md) and [NFTs](https://github.com/simpleledger/slp-specifications/blob/master/slp-nft-1.md). Trading fees are incredibly small, compared to other DEX platforms. The software is based entirely on open protocols and open source software. It's not a '.com' website that you visit, but software you run on your own computer, in the confort of your own home. So long as you have an internet connection and the technical knowledge to run this software, no one can stop you from trading tokens. `bch-dex` software is maintained by the [Permissionless Software Foundation](https://psfoundation.cash/).
|
||||
|
||||
This repository was forked from [ipfs-torlist-service](https://github.com/Permissionless-Software-Foundation/ipfs-torlist-service).
|
||||
- [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video)
|
||||
|
||||
## Development Notes
|
||||
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 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)
|
||||
- This video is out of date. Follow the instructions below.
|
||||
|
||||
- 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.
|
||||
|
||||
The Raspberry Pi 4 is the primary hardware target, because this software functions best when it is always running. The Pi 4 makes a great appliance for monitoring trade signals and finalizing trades.
|
||||
|
||||
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/).
|
||||
|
||||
Here are the steps involved in setting up bch-dex:
|
||||
|
||||
1. Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose.
|
||||
1. Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`.
|
||||
1. Install dependencies by running `npm install`
|
||||
1. Create a wallet:
|
||||
- `cd production/scripts`
|
||||
- `node create-wallet.js`
|
||||
1. Change directory to the `production/docker` or `production/rpi-docker` folder depending on your hardware target.
|
||||
1. Pull the Docker images down from Docker Hub: `docker-compose pull`
|
||||
1. Start the Docker containers with `docker-compose up -d`
|
||||
1. Wait for the P2WDB to sync and populate bch-dex with trade data. You can monitor it with `docker logs --tail 20 -f p2wdb`.
|
||||
1. 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.
|
||||
1. To take the other side of the trade, click the `Take` button in the UI.
|
||||
1. 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).
|
||||
|
||||
## Blockchain Infrastructure
|
||||
|
||||
The P2WDB and bch-dex containers requires a 'Global Back End' (as described in [CashStack.info](https://cashstack.info)) in order to connect to the blockchain. By default, the Docker containers connect to [free-bch.fullstack.cash](https://free-bch.fullstack.cash/). Several community-provided Global Back End servers are provided and can be [viewed here](https://gist.github.com/christroutner/63c5513782181f8b8ea3eb89f7cadeb6). The back end can be changed by setting the `CONSUMER_URL` environment variable in the `docker-compose.yml` file.
|
||||
|
||||
### Applying Software Updates
|
||||
As this is an active project, software updates will happen frequently. To apply a software update, perform these steps.
|
||||
|
||||
|
||||
1. Enter the `docker` or `rpi-docker` folder, depending on your hardware target.
|
||||
1. Bring down the Docker containers with `docker-compose down`.
|
||||
1. Pull in the software updates with `git pull`
|
||||
1. Update dependencies with `npm install`
|
||||
1. Pull new Docker images with `docker-compose pull`
|
||||
1. Clean up disk space by deleting old Docker images with `./cleanup-images.sh`
|
||||
1. Start the Docker containers with `docker-compose up -d`
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
+7
-1
@@ -56,7 +56,10 @@ class Server {
|
||||
})
|
||||
|
||||
console.log(`Starting environment: ${config.env}`)
|
||||
console.log(`Debug level: ${config.debugLevel}`)
|
||||
console.log(`Debug level: ${config.debugLevel}\n`)
|
||||
console.log(`Using this web3 CashStack service: ${config.consumerUrl}`)
|
||||
console.log('Alternative web services listed here: https://gist.github.com/christroutner/63c5513782181f8b8ea3eb89f7cadeb6')
|
||||
console.log('This app is built on top of the CashStack. Find out more: https://CashStack.info\n')
|
||||
|
||||
// MIDDLEWARE START
|
||||
|
||||
@@ -90,6 +93,9 @@ class Server {
|
||||
|
||||
// MIDDLEWARE END
|
||||
|
||||
// Delay startup to give the P2WDB time to start first, so that it accepts the webook call
|
||||
await sleep(20000)
|
||||
|
||||
// Create webhook
|
||||
try {
|
||||
try {
|
||||
|
||||
Vendored
+4
-4
@@ -35,8 +35,8 @@ module.exports = {
|
||||
useFullStackCash: process.env.USE_FULLSTACKCASH ? true : false,
|
||||
consumerUrl: process.env.CONSUMER_URL
|
||||
? process.env.CONSUMER_URL
|
||||
// : 'https://free-bch.fullstack.cash',
|
||||
: 'https://wa-usa-bch-consumer.fullstackcash.nl',
|
||||
: 'https://free-bch.fullstack.cash',
|
||||
// : 'https://wa-usa-bch-consumer.fullstackcash.nl',
|
||||
|
||||
// P2WDB URL that will accept API calls from the p2wdb npm library.
|
||||
p2wdbUrl: process.env.P2WDB_URL ? process.env.P2WDB_URL : 'https://p2wdb.fullstack.cash',
|
||||
@@ -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,
|
||||
@@ -97,7 +97,7 @@ module.exports = {
|
||||
// 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,
|
||||
debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 1,
|
||||
|
||||
// Settings for production, using external go-ipfs node.
|
||||
isProduction: process.env.SVC_ENV === 'production' ? true : false,
|
||||
|
||||
Generated
+2902
-318
File diff suppressed because it is too large
Load Diff
+4
-4
@@ -27,9 +27,9 @@
|
||||
},
|
||||
"repository": "Permissionless-Software-Foundation/bch-dex",
|
||||
"dependencies": {
|
||||
"@psf/bch-js": "6.2.1",
|
||||
"@psf/bch-js": "6.3.1",
|
||||
"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.5.4",
|
||||
"mongoose": "5.13.13",
|
||||
"node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
|
||||
"nodemailer": "6.4.17",
|
||||
@@ -64,7 +64,7 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"apidoc": "0.26.0",
|
||||
"bch-token-sweep": "1.5.16",
|
||||
"bch-token-sweep": "2.1.1",
|
||||
"chai": "4.3.0",
|
||||
"coveralls": "2.11.4",
|
||||
"eslint": "7.19.0",
|
||||
|
||||
@@ -58,7 +58,7 @@ RUN git checkout ct-unstable
|
||||
# Install dependencies
|
||||
#RUN mkdir .ipfsdata
|
||||
#RUN npm install -g @mapbox/node-pre-gyp
|
||||
RUN npm install
|
||||
RUN npm install --force
|
||||
|
||||
# Build the site
|
||||
RUN CI=true npm run build
|
||||
|
||||
@@ -64,7 +64,7 @@ RUN npm install
|
||||
RUN npm run docs
|
||||
|
||||
# Copy the wallet files
|
||||
COPY wallet.json wallet.json
|
||||
#COPY wallet.json wallet.json
|
||||
|
||||
#VOLUME /home/safeuser/keys
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ services:
|
||||
- 172.17.0.1:8080:8080
|
||||
volumes:
|
||||
- ../data/go-ipfs/data:/data/ipfs
|
||||
- ../data/go-ipfs/export:/export
|
||||
- ../../swarm.key:/data/ipfs/swarm.key
|
||||
# https://docs.docker.com/compose/compose-file/compose-file-v3/#command
|
||||
# https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
|
||||
command:
|
||||
@@ -43,10 +43,14 @@ services:
|
||||
restart: always
|
||||
|
||||
p2wdb:
|
||||
build:
|
||||
context: ./p2wdb/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./p2wdb/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/p2wdb-bch-dex:v1.7.0
|
||||
container_name: p2wdb
|
||||
environment:
|
||||
CONSUMER_URL: 'https://free-bch.fullstack.cash'
|
||||
DEBUG_LEVEL: 1
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -65,10 +69,13 @@ services:
|
||||
restart: always
|
||||
|
||||
bch-dex:
|
||||
build:
|
||||
context: ./bch-dex/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./bch-dex/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/bch-dex:v1.7.1
|
||||
container_name: bch-dex
|
||||
environment:
|
||||
CONSUMER_URL: 'https://free-bch.fullstack.cash'
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -80,15 +87,18 @@ services:
|
||||
- p2wdb
|
||||
ports:
|
||||
- '5700:5700' # <host port>:<container port>
|
||||
# volumes:
|
||||
# - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
|
||||
#restart: always
|
||||
volumes:
|
||||
- ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
|
||||
restart: always
|
||||
|
||||
dex-ui:
|
||||
build:
|
||||
context: ./bch-dex-ui/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./bch-dex-ui/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/bch-dex-ui:v1.6.5
|
||||
container_name: dex-ui
|
||||
environment:
|
||||
SERVER: 'http://192.168.2.3'
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -101,4 +111,4 @@ services:
|
||||
- '4500:80' # <host port>:<container port>
|
||||
# volumes:
|
||||
# - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
|
||||
#restart: always
|
||||
restart: always
|
||||
|
||||
@@ -16,7 +16,8 @@ export COORD_NAME=generic-p2wdb-production
|
||||
#export CR_DOMAIN=subdomain.yourdomain.com
|
||||
|
||||
# Debug level. 0 = minimal info. 2 = max info.
|
||||
export DEBUG_LEVEL=2
|
||||
# This value set by docker-compose.yml
|
||||
#export DEBUG_LEVEL=1
|
||||
|
||||
# Log-in information for retrieving a JWT token from FullStack.cash.
|
||||
export FULLSTACKLOGIN=demo@demo.com
|
||||
|
||||
@@ -58,7 +58,7 @@ RUN git checkout ct-unstable
|
||||
# Install dependencies
|
||||
#RUN mkdir .ipfsdata
|
||||
#RUN npm install -g @mapbox/node-pre-gyp
|
||||
RUN npm install
|
||||
RUN npm install --force
|
||||
|
||||
# Build the site
|
||||
RUN CI=true npm run build
|
||||
|
||||
@@ -64,7 +64,7 @@ RUN npm install
|
||||
RUN npm run docs
|
||||
|
||||
# Copy the wallet files
|
||||
COPY wallet.json wallet.json
|
||||
#COPY wallet.json wallet.json
|
||||
|
||||
#VOLUME /home/safeuser/keys
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ services:
|
||||
- 172.17.0.1:8080:8080
|
||||
volumes:
|
||||
- ../data/go-ipfs/data:/data/ipfs
|
||||
- ../data/go-ipfs/export:/export
|
||||
- ../../swarm.key:/data/ipfs/swarm.key
|
||||
# https://docs.docker.com/compose/compose-file/compose-file-v3/#command
|
||||
# https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
|
||||
command:
|
||||
@@ -44,10 +44,14 @@ services:
|
||||
restart: always
|
||||
|
||||
p2wdb:
|
||||
build:
|
||||
context: ./p2wdb/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./p2wdb/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/pwd-bch-dex-rpi:v1.7.1
|
||||
container_name: p2wdb
|
||||
environment:
|
||||
CONSUMER_URL: 'https://free-bch.fullstack.cash'
|
||||
DEBUG_LEVEL: 1
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -66,10 +70,13 @@ services:
|
||||
restart: always
|
||||
|
||||
bch-dex:
|
||||
build:
|
||||
context: ./bch-dex/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./bch-dex/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/bch-dex-rpi:v1.7.1
|
||||
container_name: bch-dex
|
||||
environment:
|
||||
CONSUMER_URL: 'https://free-bch.fullstack.cash'
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -81,14 +88,15 @@ services:
|
||||
- p2wdb
|
||||
ports:
|
||||
- '5700:5700' # <host port>:<container port>
|
||||
# volumes:
|
||||
# - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
|
||||
#restart: always
|
||||
volumes:
|
||||
- ../scripts/wallet.json:/home/safeuser/bch-dex/wallet.json
|
||||
restart: always
|
||||
|
||||
dex-ui:
|
||||
build:
|
||||
context: ./bch-dex-ui/
|
||||
dockerfile: Dockerfile
|
||||
#build:
|
||||
# context: ./bch-dex-ui/
|
||||
# dockerfile: Dockerfile
|
||||
image: christroutner/bch-dex-ui-rpi:v1.7.3
|
||||
container_name: dex-ui
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
@@ -102,4 +110,4 @@ services:
|
||||
- '4500:80' # <host port>:<container port>
|
||||
# volumes:
|
||||
# - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
|
||||
#restart: always
|
||||
restart: always
|
||||
|
||||
@@ -16,7 +16,8 @@ export COORD_NAME=generic-p2wdb-production
|
||||
#export CR_DOMAIN=subdomain.yourdomain.com
|
||||
|
||||
# Debug level. 0 = minimal info. 2 = max info.
|
||||
export DEBUG_LEVEL=2
|
||||
# This value set by docker-compose.yml
|
||||
#export DEBUG_LEVEL=1
|
||||
|
||||
# Log-in information for retrieving a JWT token from FullStack.cash.
|
||||
export FULLSTACKLOGIN=demo@demo.com
|
||||
|
||||
@@ -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 = {
|
||||
|
||||
@@ -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()
|
||||
@@ -0,0 +1,100 @@
|
||||
/*
|
||||
This script will travers the HD wallet and sweep funds and tokens back
|
||||
into the root address (index 0). That root address needs to have funds
|
||||
to pay for the transactions.
|
||||
*/
|
||||
|
||||
// Public npm libraries
|
||||
// const BCHJS = require('@psf/bch-js')
|
||||
const BchTokenSweep = require('bch-token-sweep/index')
|
||||
|
||||
// Local libraries
|
||||
const WalletAdapter = require('../../src/adapters/wallet')
|
||||
|
||||
// Constants
|
||||
const EMTPY_ADDR_CUTOFF = 10
|
||||
|
||||
async function sweepFunds () {
|
||||
try {
|
||||
// Open the wallet files.
|
||||
const walletLib = new WalletAdapter()
|
||||
// const walletInfo = await walletLib.openWallet()
|
||||
const walletInfo = await openWallet(walletLib)
|
||||
const wallet = await walletLib.instanceWallet(walletInfo)
|
||||
console.log('walletInfo: ', walletInfo)
|
||||
|
||||
const rootAddr = walletInfo.cashAddress
|
||||
const rootWif = walletInfo.privateKey
|
||||
console.log(`Sweeping all funds into root address ${rootAddr}...`)
|
||||
|
||||
// Generate an HD tree
|
||||
const bchjs = wallet.bchjs
|
||||
const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
|
||||
const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
|
||||
|
||||
let emptyAddrCnt = 0
|
||||
let hdIndex = 1
|
||||
|
||||
do {
|
||||
// Generate a keypair from the HD wallet.
|
||||
const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
|
||||
const cashAddress = bchjs.HDNode.toCashAddress(childNode)
|
||||
const wifToSweep = bchjs.HDNode.toWIF(childNode)
|
||||
|
||||
console.log(`\nSweeping ${cashAddress}`)
|
||||
|
||||
try {
|
||||
// Sweep tokens from address
|
||||
const sweeper = new BchTokenSweep(
|
||||
wifToSweep,
|
||||
rootWif,
|
||||
wallet,
|
||||
550,
|
||||
rootAddr
|
||||
)
|
||||
await sweeper.populateObjectFromNetwork()
|
||||
|
||||
const hex = await sweeper.sweepTo(rootAddr)
|
||||
// console.log(`hex: ${hex}`)
|
||||
|
||||
const txid = await sweeper.blockchain.broadcast(hex)
|
||||
|
||||
// console.log('Transaction ID', txid)
|
||||
console.log(`Swept HD index ${hdIndex}. TXID: ${txid}`)
|
||||
|
||||
emptyAddrCnt = 0
|
||||
|
||||
// Wait between loop iterations.
|
||||
await bchjs.Util.sleep(3000)
|
||||
} catch (err) {
|
||||
console.log(`error message with index ${hdIndex}: ${err.message}`)
|
||||
// console.log(err)
|
||||
emptyAddrCnt++
|
||||
}
|
||||
|
||||
hdIndex++
|
||||
} while (emptyAddrCnt < EMTPY_ADDR_CUTOFF)
|
||||
|
||||
console.log(`${EMTPY_ADDR_CUTOFF} empty addresses detected. Exiting.`)
|
||||
|
||||
console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
|
||||
} catch (err) {
|
||||
console.error('Error in sweepFunds(): ', err)
|
||||
}
|
||||
}
|
||||
sweepFunds()
|
||||
|
||||
// Open the wallet file, or create one if the file doesn't exist.
|
||||
// Does not instance the wallet. The output of this function is expected to
|
||||
// be passed to instanceWallet().
|
||||
async function openWallet (walletLib) {
|
||||
try {
|
||||
// console.log('this.WALLET_FILE: ', this.WALLET_FILE)
|
||||
const walletData = await walletLib.jsonFiles.readJSON('./wallet.json')
|
||||
|
||||
return walletData
|
||||
} catch (err) {
|
||||
console.error('Error in openWallet()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,7 @@ const Offer = new mongoose.Schema({
|
||||
utxoTxid: { type: String },
|
||||
utxoVout: { type: Number },
|
||||
ticker: { type: String },
|
||||
tokenType: { type: Number },
|
||||
|
||||
// Trade data
|
||||
buyOrSell: { type: String },
|
||||
@@ -23,7 +24,8 @@ const Offer = new mongoose.Schema({
|
||||
sigMsg: { type: String },
|
||||
|
||||
// Utility data
|
||||
timestamp: { type: String },
|
||||
timestamp: { type: Number },
|
||||
globalTimestamp: { type: String },
|
||||
localTimestamp: { type: String },
|
||||
|
||||
// SWaP Protocol Properties
|
||||
|
||||
@@ -14,6 +14,7 @@ const Order = new mongoose.Schema({
|
||||
utxoTxid: { type: String },
|
||||
utxoVout: { type: Number },
|
||||
ticker: { type: String },
|
||||
tokenType: { type: Number },
|
||||
|
||||
// Trade data
|
||||
buyOrSell: { type: String },
|
||||
|
||||
+32
-7
@@ -208,7 +208,7 @@ class WalletAdapter {
|
||||
|
||||
// Get token info on the offered UTXO
|
||||
const txData = await this.bchWallet.getTxData([offerInfo.utxoTxid])
|
||||
// console.log(`txData: ${JSON.stringify(txData, null, 2)}`)
|
||||
console.log(`txData: ${JSON.stringify(txData, null, 2)}`)
|
||||
|
||||
// Construct the UTXO being offered for sale.
|
||||
const offeredUtxo = {
|
||||
@@ -222,12 +222,27 @@ class WalletAdapter {
|
||||
|
||||
// Build First part of the collaborative Tx a.k.a. Alice
|
||||
// Generate the OP_RETURN code.
|
||||
const slpSendObj = bchjs.SLP.TokenType1.generateSendOpReturn(
|
||||
[offeredUtxo],
|
||||
offerInfo.numTokens.toString()
|
||||
)
|
||||
let slpSendObj
|
||||
if (offerInfo.tokenType === 65) {
|
||||
// Type 65 NFT
|
||||
|
||||
slpSendObj = bchjs.SLP.NFT1.generateNFTChildSendOpReturn(
|
||||
[offeredUtxo],
|
||||
offerInfo.numTokens.toString()
|
||||
)
|
||||
console.log(`slpOutputs: ${slpSendObj.outputs}`)
|
||||
} else if (offerInfo.tokenType === 1) {
|
||||
// Type 1 fungible token
|
||||
|
||||
slpSendObj = bchjs.SLP.TokenType1.generateSendOpReturn(
|
||||
[offeredUtxo],
|
||||
offerInfo.numTokens.toString()
|
||||
)
|
||||
console.log(`slpOutputs: ${slpSendObj.outputs}`)
|
||||
} else {
|
||||
throw new Error(`Unknown token type of ${offerInfo.tokenType}. Can not create Counter Offer.`)
|
||||
}
|
||||
const slpData = slpSendObj.script
|
||||
console.log(`slpOutputs: ${slpSendObj.outputs}`)
|
||||
|
||||
// Currently this app only supports a single SLP token UTXO for exact
|
||||
// token quantities (no token change). e.g. 1 UTXO representing the
|
||||
@@ -334,12 +349,22 @@ class WalletAdapter {
|
||||
// Update the UTXO store of the wallet.
|
||||
await this.bchWallet.getUtxos()
|
||||
|
||||
// Get the token type of the token being moved.
|
||||
// Combine Fungible and NFT token UTXOs.
|
||||
let tokenUtxos = this.bchWallet.utxos.utxoStore.slpUtxos.type1.tokens.concat(
|
||||
this.bchWallet.utxos.utxoStore.slpUtxos.nft.tokens)
|
||||
// Get token UTXOs that match the token in the order.
|
||||
tokenUtxos = tokenUtxos.filter(
|
||||
x => x.tokenId === tokenId
|
||||
)
|
||||
|
||||
const txid = await this.bchWallet.sendTokens(receiver, 3)
|
||||
|
||||
const utxoInfo = {
|
||||
txid,
|
||||
vout: 1,
|
||||
hdIndex: keyPair.hdIndex
|
||||
hdIndex: keyPair.hdIndex,
|
||||
tokenType: tokenUtxos[0].tokenType
|
||||
}
|
||||
|
||||
return utxoInfo
|
||||
|
||||
@@ -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 () {
|
||||
|
||||
+13
-3
@@ -29,7 +29,8 @@ class OfferEntity {
|
||||
utxoVout,
|
||||
offerStatus,
|
||||
makerAddr,
|
||||
ticker
|
||||
ticker,
|
||||
tokenType
|
||||
} = offerData.data
|
||||
|
||||
// Input Validation
|
||||
@@ -69,6 +70,13 @@ class OfferEntity {
|
||||
if (!ticker || typeof ticker !== 'string') {
|
||||
throw new Error("Property 'ticker' must be a string.")
|
||||
}
|
||||
if (!tokenType || typeof tokenType !== 'number') {
|
||||
throw new Error("Property 'tokenType' must be a number.")
|
||||
}
|
||||
|
||||
// Convert the timestamp to a number.
|
||||
let timestamp = new Date(offerData.timestamp)
|
||||
timestamp = timestamp.getTime()
|
||||
|
||||
const validatedOfferData = {
|
||||
messageType,
|
||||
@@ -80,13 +88,15 @@ class OfferEntity {
|
||||
numTokens,
|
||||
utxoTxid,
|
||||
utxoVout,
|
||||
timestamp: offerData.timestamp,
|
||||
timestamp,
|
||||
globaltimestamp: offerData.timestamp,
|
||||
localTimestamp: offerData.localTimeStamp,
|
||||
txid: offerData.txid,
|
||||
p2wdbHash: offerData.hash,
|
||||
offerStatus: offerStatus || this.offerStatus[0],
|
||||
makerAddr,
|
||||
ticker
|
||||
ticker,
|
||||
tokenType
|
||||
}
|
||||
|
||||
return validatedOfferData
|
||||
|
||||
@@ -93,7 +93,7 @@ class OfferUseCases {
|
||||
|
||||
async listOffers () {
|
||||
try {
|
||||
return this.OfferModel.find({})
|
||||
return this.OfferModel.find({}).sort('-timestamp')
|
||||
} catch (error) {
|
||||
console.error('Error in use-cases/offer/listOffers()')
|
||||
throw error
|
||||
@@ -188,6 +188,10 @@ class OfferUseCases {
|
||||
}
|
||||
const hash = await this.adapters.p2wdb.write(p2wdbObj)
|
||||
|
||||
// Delete the Offer from the database, so that the user doesn't attempt
|
||||
// to take the offer more than once.
|
||||
offerInfo.remove()
|
||||
|
||||
// Return the P2WDB CID
|
||||
return hash
|
||||
|
||||
@@ -250,25 +254,27 @@ 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')
|
||||
}
|
||||
|
||||
return offer
|
||||
|
||||
// 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
|
||||
@@ -353,10 +359,13 @@ class OfferUseCases {
|
||||
// console.log('utxoStatus: ', utxoStatus)
|
||||
} catch (err) {
|
||||
// Handle corner case of bad-data in the Offer model.
|
||||
if (err.message.includes('txid needs to be a proper transaction ID')) {
|
||||
if (err.message && err.message.includes('txid needs to be a proper transaction ID')) {
|
||||
console.log(`Deleting Offer with bad data: ${JSON.stringify(thisOffer, null, 2)}`)
|
||||
await thisOffer.remove()
|
||||
continue
|
||||
} else if (err.isAxiosError) {
|
||||
console.log('Error trying to contact api.fullstack.cash')
|
||||
continue
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
@@ -367,9 +376,18 @@ class OfferUseCases {
|
||||
console.log(`Spent UTXO detected. Deleting this Offer: ${JSON.stringify(thisOffer, null, 2)}`)
|
||||
await thisOffer.remove()
|
||||
}
|
||||
|
||||
// If the Offer is older than 7 days, delete it.
|
||||
const nowMs = now.getTime()
|
||||
const sevenDays = 1000 * 60 * 60 * 24 * 7
|
||||
const sevenDaysAgo = nowMs - sevenDays
|
||||
if (thisOffer.timestamp < sevenDaysAgo) {
|
||||
console.log('Offer older than 7 days. Deleting.')
|
||||
await thisOffer.remove()
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
console.error('Error in removeStaleOffers()')
|
||||
console.error('Error in removeStaleOffers(): ', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
+16
-5
@@ -65,6 +65,7 @@ class OrderLib {
|
||||
// Update the order with the new UTXO information.
|
||||
orderEntity.utxoTxid = utxoInfo.txid
|
||||
orderEntity.utxoVout = utxoInfo.vout
|
||||
orderEntity.tokenType = utxoInfo.tokenType
|
||||
|
||||
// Add P2WDB specific flag for signaling that this is a new offer.
|
||||
orderEntity.dataType = 'offer'
|
||||
@@ -81,6 +82,7 @@ class OrderLib {
|
||||
// Create a MongoDB model to hold the Order
|
||||
orderEntity.hdIndex = utxoInfo.hdIndex
|
||||
orderEntity.p2wdbHash = hash
|
||||
|
||||
console.log(`creating new order model: ${JSON.stringify(orderEntity, null, 2)}`)
|
||||
const order = new this.OrderModel(orderEntity)
|
||||
await order.save()
|
||||
@@ -88,7 +90,7 @@ class OrderLib {
|
||||
return hash
|
||||
} catch (err) {
|
||||
// console.log("Error in use-cases/entry.js/createEntry()", err.message)
|
||||
wlogger.error('Error in use-cases/createOrder())')
|
||||
wlogger.error('Error in use-cases/order.js/createOrder())')
|
||||
console.log('error entryObj: ', entryObj)
|
||||
throw err
|
||||
}
|
||||
@@ -101,6 +103,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)
|
||||
@@ -113,11 +118,14 @@ class OrderLib {
|
||||
if (orderEntity.buyOrSell.includes('sell')) {
|
||||
// Sell Order
|
||||
|
||||
// Combine Fungible and NFT token UTXOs.
|
||||
let tokenUtxos = utxos.slpUtxos.type1.tokens.concat(utxos.slpUtxos.nft.tokens)
|
||||
|
||||
// Get token UTXOs that match the token in the order.
|
||||
const tokenUtxos = utxos.slpUtxos.type1.tokens.filter(
|
||||
tokenUtxos = tokenUtxos.filter(
|
||||
x => x.tokenId === orderEntity.tokenId
|
||||
)
|
||||
// console.log('tokenUtxos: ', tokenUtxos)
|
||||
console.log('tokenUtxos: ', tokenUtxos)
|
||||
|
||||
// Get the total amount of tokens in the wallet that match the token
|
||||
// in the order.
|
||||
@@ -127,7 +135,7 @@ class OrderLib {
|
||||
|
||||
// If there are fewer tokens in the wallet than what's in the order,
|
||||
// throw an error.
|
||||
if (totalTokenBalance <= orderEntity.numTokens || isNaN(totalTokenBalance)) {
|
||||
if (totalTokenBalance < orderEntity.numTokens || isNaN(totalTokenBalance)) {
|
||||
throw new Error(
|
||||
'App wallet does not have enough tokens to satisfy the SELL order.'
|
||||
)
|
||||
@@ -195,10 +203,13 @@ class OrderLib {
|
||||
// console.log('utxoStatus: ', utxoStatus)
|
||||
} catch (err) {
|
||||
// Handle corner case of bad-data in the Order model.
|
||||
if (err.message.includes('txid needs to be a proper transaction ID')) {
|
||||
if (err.message && err.message.includes('txid needs to be a proper transaction ID')) {
|
||||
console.log(`Deleting Order with bad data: ${JSON.stringify(thisOrder, null, 2)}`)
|
||||
await thisOrder.remove()
|
||||
continue
|
||||
} else if (err.isAxiosError) {
|
||||
console.log('Error trying to contact api.fullstack.cash')
|
||||
continue
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
|
||||
@@ -262,10 +262,11 @@ describe('#wallet', () => {
|
||||
wif: 'L4qKTMCwjH9jHnYtNh9Vsrxj7Hg6zmoN8E2v7N47UKvNVEjw7FU8',
|
||||
hdIndex: 6
|
||||
})
|
||||
uut.bchWallet = {
|
||||
sendTokens: async () => 'fake-txid',
|
||||
getUtxos: async () => {}
|
||||
}
|
||||
uut.bchWallet = new MockBchWallet()
|
||||
// uut.bchWallet = {
|
||||
// sendTokens: async () => 'fake-txid',
|
||||
// getUtxos: async () => {}
|
||||
// }
|
||||
|
||||
const inObj = {
|
||||
tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
|
||||
|
||||
@@ -254,7 +254,8 @@ describe('#Offer-Entity', () => {
|
||||
utxoVout: 0,
|
||||
offerStatus: 'posted',
|
||||
makerAddr: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
|
||||
ticker: 'TROUT'
|
||||
ticker: 'TROUT',
|
||||
tokenType: 1
|
||||
},
|
||||
timestamp: '2021-09-20T17:54:26.395Z',
|
||||
localTimeStamp: '9/20/2021, 10:54:26 AM',
|
||||
@@ -279,6 +280,7 @@ describe('#Offer-Entity', () => {
|
||||
assert.property(result, 'localTimestamp')
|
||||
assert.property(result, 'txid')
|
||||
assert.property(result, 'p2wdbHash')
|
||||
assert.property(result, 'tokenType')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -127,9 +127,11 @@ class MockBchWallet {
|
||||
]
|
||||
},
|
||||
nft: {
|
||||
groupMintBatons: [],
|
||||
groupTokens: [],
|
||||
tokens: []
|
||||
},
|
||||
group: {
|
||||
tokens: [],
|
||||
mintBatons: []
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -96,7 +96,8 @@ describe('#offer-use-case', () => {
|
||||
'241c06bf61384b8623477e419bf4779edbcc7e3bc862f0f179a9ed2967069b87',
|
||||
utxoVout: 0,
|
||||
makerAddr: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
|
||||
ticker: 'TROUT'
|
||||
ticker: 'TROUT',
|
||||
tokenType: 1
|
||||
},
|
||||
timestamp: '2021-09-20T17:54:26.395Z',
|
||||
localTimeStamp: '9/20/2021, 10:54:26 AM',
|
||||
|
||||
Reference in New Issue
Block a user