fix(README): Adding config variables to README

This commit is contained in:
Chris Troutner
2024-03-23 08:18:32 -07:00
parent 38bdfe306b
commit ef0179fb3f
4 changed files with 33 additions and 70 deletions
+9
View File
@@ -47,6 +47,15 @@ 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`.
## 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
```
## Code 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).
+11 -61
View File
@@ -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",
@@ -7106,54 +7106,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 +7184,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",
@@ -16096,14 +16044,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 +16173,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 +24719,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",
+1 -1
View File
@@ -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",
+12 -8
View File
@@ -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,7 +160,7 @@ 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
}
}
@@ -203,7 +203,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,7 +257,7 @@ 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
}
}
@@ -608,8 +608,8 @@ 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++
@@ -619,10 +619,14 @@ class BchAdapter {
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