mirror of
https://github.com/fullstack-cash/bch-api.git
synced 2026-09-22 01:02:05 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ebbf12c394 | ||
|
|
eeb63ec373 | ||
|
|
8244fbbef5 | ||
|
|
43dfea7cbe | ||
|
|
a2c30aee6d | ||
|
|
1959b20115 | ||
|
|
e399e05022 | ||
|
|
2d04169329 | ||
|
|
5619c2fbed | ||
|
|
388a3ee53b | ||
|
|
8aff89dead | ||
|
|
efd669e5fe | ||
|
|
d5433ed811 | ||
|
|
6b2588c487 | ||
|
|
4aee109223 | ||
|
|
5f63e53a6d | ||
|
|
bde809d62d | ||
|
|
c664758654 | ||
|
|
b4823be86a | ||
|
|
1c9e0858de | ||
|
|
41a3cd91fc | ||
|
|
0b4038eeb4 | ||
|
|
86bf504b78 | ||
|
|
d56e6d6b3a | ||
|
|
7339b8554f | ||
|
|
e97a0be456 | ||
|
|
085618470f | ||
|
|
22d7a2b7a2 | ||
|
|
e6dcaa2f24 | ||
|
|
698ac38251 | ||
|
|
7c66ce7f73 | ||
|
|
9e3dfd9848 | ||
|
|
10eb4da112 | ||
|
|
f4f5f02a2f | ||
|
|
bb69a6dee9 | ||
|
|
d67b3aa052 | ||
|
|
7e1c3d6a73 | ||
|
|
6165001790 | ||
|
|
77ba06d68c | ||
|
|
40f6b17d3b | ||
|
|
4d40a7cb01 | ||
|
|
0a14ca08a4 | ||
|
|
198141b75a | ||
|
|
6f25ec4b68 | ||
|
|
cb416d26c0 | ||
|
|
376094c6c2 | ||
|
|
f566d44252 | ||
|
|
0e7b45214f | ||
|
|
58366b5442 | ||
|
|
f97e7016c5 | ||
|
|
f82c85712c | ||
|
|
5f18bc578b | ||
|
|
e72a6b50e4 | ||
|
|
66c99ae442 | ||
|
|
5e04125bc3 | ||
|
|
fd3fd43800 | ||
|
|
5184da7c26 | ||
|
|
595caffb51 | ||
|
|
6b00f0fd5b | ||
|
|
e4a427788f | ||
|
|
27a2825a43 | ||
|
|
3d453c335f | ||
|
|
9a85a2a4ef | ||
|
|
443fb233ae | ||
|
|
63b8168c45 | ||
|
|
1e5dae56af | ||
|
|
553d6fd4b0 | ||
|
|
ab98bf05da | ||
|
|
6806b4a197 | ||
|
|
4ae74aed59 | ||
|
|
98e1a5b40f | ||
|
|
279c9b7bea | ||
|
|
56be614980 | ||
|
|
584037ebdd | ||
|
|
44230b73f7 | ||
|
|
b7f1eba6bd | ||
|
|
35bc3025d6 | ||
|
|
6f6531428a | ||
|
|
cb5e962167 | ||
|
|
33da626f78 | ||
|
|
e9766630ed | ||
|
|
9b6adbf4ec | ||
|
|
5f09447da4 | ||
|
|
3c1a140cad | ||
|
|
cd3444fb27 | ||
|
|
b383312ec0 | ||
|
|
34b4c423d6 | ||
|
|
b84ca11a6b | ||
|
|
5cc7b6f1cd | ||
|
|
96f948f410 | ||
|
|
b2f32b2ff8 | ||
|
|
14ac642bdb | ||
|
|
74112a1ed8 | ||
|
|
1e53a42efd | ||
|
|
08a1315082 | ||
|
|
e81ccfae20 | ||
|
|
932c7dbfd5 |
@@ -19,6 +19,7 @@ start-fullstack-test.sh
|
||||
start-free-main.sh
|
||||
start-local-mainnet.sh.save
|
||||
start-local-testnet.sh.save
|
||||
temp.sh
|
||||
|
||||
coverage
|
||||
start-my-infra
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
# bch-api
|
||||
|
||||
[](https://greenkeeper.io/)
|
||||
|
||||
[](https://travis-ci.org/christroutner/bch-api)
|
||||
|
||||
@@ -16,11 +15,10 @@ of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk).
|
||||
Both bch-api and bch-js are part of the
|
||||
[full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
|
||||
|
||||
- [API Documentation](https://api.bchjs.cash/docs/)
|
||||
- [BCH Example Applications](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
|
||||
- [slp-cli-wallet](https://github.com/christroutner/slp-cli-wallet): a hacker-friendly, command-line BCH and SLP token wallet using this REST API.
|
||||
- [API Documentation](https://fullstack.cash/documentation)
|
||||
- [Example Code](https://fullstack.cash/examples)
|
||||
|
||||
Have questions? Need help? Join our community support
|
||||
Have questions? Need help? Join our community support:
|
||||
[Telegram channel](https://t.me/bch_js_toolkit)
|
||||
|
||||
## Features
|
||||
@@ -96,4 +94,4 @@ Have questions? Need help? Join our community support
|
||||
[Telegram channel](https://t.me/bch_js_toolkit)
|
||||
|
||||
## License
|
||||
[MIT](LICENSE.md)
|
||||
[MIT](./LICENSE.md)
|
||||
|
||||
+3
-1
@@ -3,7 +3,9 @@
|
||||
*/
|
||||
|
||||
const config = {
|
||||
apiTokenSecret: process.env.TOKENSECRET ? process.env.TOKENSECRET : 'secret-jwt-token'
|
||||
apiTokenSecret: process.env.TOKENSECRET
|
||||
? process.env.TOKENSECRET
|
||||
: 'secret-jwt-token'
|
||||
}
|
||||
|
||||
module.exports = config
|
||||
|
||||
@@ -11,5 +11,7 @@ export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
|
||||
|
||||
curl -X POST http://fullstack.cash:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
|
||||
curl -X POST http://fullstack.cash:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
|
||||
curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
|
||||
curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
|
||||
|
||||
echo "...Finished deploying to production."
|
||||
|
||||
@@ -16,9 +16,9 @@ USER safeuser
|
||||
|
||||
# Clone the repository
|
||||
WORKDIR /home/safeuser
|
||||
RUN git clone https://github.com/christroutner/bch-api
|
||||
RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
|
||||
WORKDIR /home/safeuser/bch-api
|
||||
RUN npm install
|
||||
RUN npm install --silent
|
||||
|
||||
# Generate documentation
|
||||
RUN npm run docs
|
||||
|
||||
@@ -13,9 +13,9 @@ USER safeuser
|
||||
|
||||
# Clone the repository
|
||||
WORKDIR /home/safeuser
|
||||
RUN git clone https://github.com/christroutner/bch-api
|
||||
RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
|
||||
WORKDIR /home/safeuser/bch-api
|
||||
RUN npm install
|
||||
RUN npm install --silent
|
||||
|
||||
# Generate documentation
|
||||
RUN npm run docs
|
||||
|
||||
Generated
+898
-711
File diff suppressed because it is too large
Load Diff
+7
-7
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "bch-api",
|
||||
"version": "1.0.0",
|
||||
"description": "REST API based on rest.bitcoin.com",
|
||||
"version": "1.16.0",
|
||||
"description": "The REST API powering FullStack.cash",
|
||||
"author": "Chris Troutner <chris.troutner@gmail.com>",
|
||||
"contributors": [
|
||||
"Gabriel Cardona <gabriel@bitcoin.com>"
|
||||
@@ -9,7 +9,7 @@
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/christroutner/bch-api.git"
|
||||
"url": "git+https://github.com/Permissionless-Software-Foundation/bch-api.git"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "node ./src/app.js",
|
||||
@@ -17,9 +17,9 @@
|
||||
"test": "npm run lint && npm run test-v3",
|
||||
"lint": "standard --env mocha --fix",
|
||||
"test-v3": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v3/",
|
||||
"test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/integration/slp.js",
|
||||
"test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/slp.js",
|
||||
"test:integration": "mocha test/v3/integration",
|
||||
"test:integration:slpdb": "mocha --timeout 25000 test/v3/integration/slp*.js",
|
||||
"test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v3/integration/slp*.js",
|
||||
"coverage": "nyc report --reporter=text-lcov | coveralls",
|
||||
"coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v3/",
|
||||
"docs": "./node_modules/.bin/apidoc -i src/routes/v3 -o docs"
|
||||
@@ -28,7 +28,7 @@
|
||||
"node": ">=10.15.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@chris.troutner/bch-js": "^3.0.1",
|
||||
"@psf/bch-js": "^3.7.1",
|
||||
"apidoc": "^0.23.0",
|
||||
"axios": "^0.19.0",
|
||||
"bitcore-lib-cash": "^8.20.3",
|
||||
@@ -37,7 +37,7 @@
|
||||
"cors": "^2.8.3",
|
||||
"debug": "~4.1.1",
|
||||
"dotenv": "^8.0.0",
|
||||
"electrum-cash": "^1.0.1",
|
||||
"electrum-cash": "^2.0.2",
|
||||
"express": "^4.15.5",
|
||||
"express-basic-auth": "^1.1.3",
|
||||
"express-rate-limit": "^5.0.0",
|
||||
|
||||
+49
-49
@@ -22,9 +22,9 @@
|
||||
'use strict'
|
||||
|
||||
const passport = require('passport')
|
||||
const BasicStrategy = require('passport-http').BasicStrategy
|
||||
// const BasicStrategy = require('passport-http').BasicStrategy
|
||||
const AnonymousStrategy = require('passport-anonymous')
|
||||
const wlogger = require('../util/winston-logging')
|
||||
// const wlogger = require('../util/winston-logging')
|
||||
|
||||
// Used for debugging and iterrogating JS objects.
|
||||
const util = require('util')
|
||||
@@ -33,9 +33,9 @@ util.inspect.defaultOptions = { depth: 1 }
|
||||
// let _this
|
||||
|
||||
// Set default rate limit value for testing
|
||||
const PRO_PASSES = process.env.PRO_PASS ? process.env.PRO_PASS : 'BITBOX'
|
||||
// const PRO_PASSES = process.env.PRO_PASS ? process.env.PRO_PASS : 'BITBOX'
|
||||
// Convert the pro-tier password string into an array split by ':'.
|
||||
const PRO_PASS = PRO_PASSES.split(':')
|
||||
// const PRO_PASS = PRO_PASSES.split(':')
|
||||
|
||||
// wlogger.verbose(`PRO_PASS set to: ${PRO_PASS}`)
|
||||
|
||||
@@ -48,55 +48,55 @@ class AuthMW {
|
||||
passport.use(new AnonymousStrategy())
|
||||
|
||||
// Initialize passport for 'basic' authentication.
|
||||
passport.use(
|
||||
new BasicStrategy({ passReqToCallback: true }, function (
|
||||
req,
|
||||
username,
|
||||
password,
|
||||
done
|
||||
) {
|
||||
// console.log(`req: ${util.inspect(req)}`)
|
||||
// console.log(`username: ${username}`)
|
||||
// console.log(`password: ${password}`)
|
||||
|
||||
// Create the req.locals property if it does not yet exist.
|
||||
if (!req.locals) {
|
||||
req.locals = {
|
||||
// default values
|
||||
proLimit: false,
|
||||
apiLevel: 0
|
||||
}
|
||||
}
|
||||
|
||||
// Set pro-tier rate limit to flag to false by default.
|
||||
req.locals.proLimit = false
|
||||
|
||||
// Evaluate the username and password and set the rate limit accordingly.
|
||||
// if (username === "BITBOX" && password === PRO_PASS) {
|
||||
if (username === 'BITBOX') {
|
||||
for (let i = 0; i < PRO_PASS.length; i++) {
|
||||
const thisPass = PRO_PASS[i]
|
||||
|
||||
if (password === thisPass) {
|
||||
wlogger.verbose(`${req.url} called by ${password.slice(0, 6)}`)
|
||||
|
||||
// Success
|
||||
req.locals.proLimit = true
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// console.log(`req.locals: ${util.inspect(req.locals)}`)
|
||||
|
||||
return done(null, true)
|
||||
})
|
||||
)
|
||||
// passport.use(
|
||||
// new BasicStrategy({ passReqToCallback: true }, function (
|
||||
// req,
|
||||
// username,
|
||||
// password,
|
||||
// done
|
||||
// ) {
|
||||
// // console.log(`req: ${util.inspect(req)}`)
|
||||
// // console.log(`username: ${username}`)
|
||||
// // console.log(`password: ${password}`)
|
||||
//
|
||||
// // Create the req.locals property if it does not yet exist.
|
||||
// if (!req.locals) {
|
||||
// req.locals = {
|
||||
// // default values
|
||||
// proLimit: false,
|
||||
// apiLevel: 0
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// // Set pro-tier rate limit to flag to false by default.
|
||||
// req.locals.proLimit = false
|
||||
//
|
||||
// // Evaluate the username and password and set the rate limit accordingly.
|
||||
// // if (username === "BITBOX" && password === PRO_PASS) {
|
||||
// if (username === 'BITBOX') {
|
||||
// for (let i = 0; i < PRO_PASS.length; i++) {
|
||||
// const thisPass = PRO_PASS[i]
|
||||
//
|
||||
// if (password === thisPass) {
|
||||
// wlogger.verbose(`${req.url} called by ${password.slice(0, 6)}`)
|
||||
//
|
||||
// // Success
|
||||
// req.locals.proLimit = true
|
||||
// break
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// // console.log(`req.locals: ${util.inspect(req.locals)}`)
|
||||
//
|
||||
// return done(null, true)
|
||||
// })
|
||||
// )
|
||||
}
|
||||
|
||||
// Middleware called by the route.
|
||||
mw () {
|
||||
return passport.authenticate(['basic', 'anonymous'], {
|
||||
return passport.authenticate(['anonymous'], {
|
||||
session: false
|
||||
})
|
||||
}
|
||||
|
||||
@@ -20,7 +20,7 @@ const redisClient = new Redis(redisOptions)
|
||||
const { RateLimiterRedis } = require('rate-limiter-flexible')
|
||||
const rateLimitOptions = {
|
||||
storeClient: redisClient,
|
||||
points: 100, // Number of points
|
||||
points: 1000, // Number of points
|
||||
duration: 60 // Per minute (per 60 seconds)
|
||||
}
|
||||
|
||||
@@ -98,8 +98,8 @@ class RateLimits {
|
||||
wlogger.debug('No JWT token found!')
|
||||
}
|
||||
|
||||
// Used for displaying error message. Default value is 3.
|
||||
let rateLimit = 3
|
||||
// Used for displaying error message. Default value is 30.
|
||||
let rateLimit = 30
|
||||
|
||||
// Code here for the rate limiter is adapted from this example:
|
||||
// https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#authorized-and-not-authorized-users
|
||||
@@ -116,13 +116,29 @@ class RateLimits {
|
||||
let pointsToConsume = _this.calcPoints(decoded)
|
||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||
|
||||
// Retrieve the origin.
|
||||
let origin = req.get('origin')
|
||||
if (origin === undefined && key.indexOf('10.0.0.5') > -1) {
|
||||
origin = 'slp-api'
|
||||
}
|
||||
wlogger.info(`origin: ${origin}`)
|
||||
|
||||
// If the request originates from one of the approved wallet apps, then
|
||||
// apply paid-access rate limits.
|
||||
const origin = req.get('origin')
|
||||
if (
|
||||
origin &&
|
||||
(origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
|
||||
origin.toString().indexOf('sandbox.fullstack.cash') > -1)
|
||||
origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
|
||||
origin === 'slp-api')
|
||||
) {
|
||||
pointsToConsume = 10
|
||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||
}
|
||||
|
||||
// Apply paid-access rate limits based on key/IP
|
||||
if (
|
||||
key.toString().indexOf('172.17.') > -1 ||
|
||||
key.toString().indexOf('::ffff:127.0.0.1') > -1
|
||||
) {
|
||||
pointsToConsume = 1
|
||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||
@@ -132,7 +148,7 @@ class RateLimits {
|
||||
`User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
|
||||
)
|
||||
|
||||
rateLimit = Math.floor(100 / pointsToConsume)
|
||||
rateLimit = Math.floor(1000 / pointsToConsume)
|
||||
|
||||
// Update the key so that rate limits track both the user and the resource.
|
||||
key = `${key}-${resource}`
|
||||
@@ -162,7 +178,7 @@ class RateLimits {
|
||||
// Calculates the points consumed, based on the jwt information and the route
|
||||
// requested.
|
||||
calcPoints (jwtInfo) {
|
||||
let retVal = 30 // By default, use anonymous tier.
|
||||
let retVal = 300 // By default, use anonymous tier.
|
||||
|
||||
try {
|
||||
// console.log(`jwtInfo: ${JSON.stringify(jwtInfo, null, 2)}`)
|
||||
@@ -179,22 +195,22 @@ class RateLimits {
|
||||
if (jwtInfo.id) {
|
||||
// SLP indexer routes
|
||||
if (level40Routes.includes(resource)) {
|
||||
if (apiLevel >= 40) retVal = 1
|
||||
if (apiLevel >= 40) retVal = 10
|
||||
// else if (apiLevel >= 10) retVal = 10
|
||||
else retVal = 10
|
||||
else retVal = 100
|
||||
|
||||
// Normal indexer routes
|
||||
} else if (level30Routes.includes(resource)) {
|
||||
if (apiLevel >= 30) retVal = 1
|
||||
else retVal = 10
|
||||
if (apiLevel >= 30) retVal = 10
|
||||
else retVal = 100
|
||||
|
||||
// Full node tier
|
||||
} else if (apiLevel >= 20) {
|
||||
retVal = 1
|
||||
retVal = 10
|
||||
|
||||
// Free tier, full node only.
|
||||
} else {
|
||||
retVal = 10
|
||||
retVal = 100
|
||||
}
|
||||
}
|
||||
|
||||
@@ -202,7 +218,7 @@ class RateLimits {
|
||||
} catch (err) {
|
||||
wlogger.error('Error in route-ratelimit.js/calcPoints()')
|
||||
// throw err
|
||||
retVal = 30
|
||||
retVal = 300
|
||||
}
|
||||
|
||||
return retVal
|
||||
|
||||
+14
-14
@@ -23,24 +23,24 @@
|
||||
target="_blank"
|
||||
>REST API</a
|
||||
>, allowing modern applications to interact with the Bitcoin Cash (BCH)
|
||||
blockchain. New to the BCH blockchain? Start by reading more about
|
||||
blockchain. New to the BCH blockchain? Check out these
|
||||
<a
|
||||
href="https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer"
|
||||
href="https://fullstack.cash/documentation"
|
||||
target="_blank"
|
||||
>building full stack applications on BCH</a
|
||||
>educational resources</a
|
||||
>.
|
||||
</p><br />
|
||||
<p>
|
||||
A REST API can work with any programming language, but bch-api is intended
|
||||
to be paired with the
|
||||
<a
|
||||
href="https://www.npmjs.com/package/@chris.troutner/bch-js"
|
||||
href="https://www.npmjs.com/package/@psf/bch-js"
|
||||
target="_blank"
|
||||
>npm bch-js</a
|
||||
>
|
||||
JavaScript library.
|
||||
<a
|
||||
href="https://github.com/Permissionless-Software-Foundation/bch-js-examples"
|
||||
href="https://fullstack.cash/examples"
|
||||
target="_blank"
|
||||
>Here is example code</a
|
||||
>
|
||||
@@ -53,7 +53,7 @@
|
||||
</p><br />
|
||||
<p>
|
||||
While you'll be able to run through the examples without one, you should
|
||||
<a href="https://account.bchjs.cash/" target="_blank"
|
||||
<a href="https://fullstack.cash/login" target="_blank"
|
||||
>sign-up for a free API key</a
|
||||
>
|
||||
in order to unlock higher rate limits.
|
||||
@@ -66,7 +66,7 @@
|
||||
<h3>bch-api</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://account.bchjs.cash" target="_blank">
|
||||
<a href="https://fullstack.cash/login" target="_blank">
|
||||
Get an API key to increase rate limits
|
||||
</a>
|
||||
</li>
|
||||
@@ -80,14 +80,14 @@
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://tapi.bchjs.cash">
|
||||
<a href="https://tapi.fullstack.cash">
|
||||
testnet REST API
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/christroutner/bch-api" target="_blank">
|
||||
<a href="https://github.com/Permissionless-Software-Foundation/bch-api" target="_blank">
|
||||
bch-api GitHub repository
|
||||
</a>
|
||||
</li>
|
||||
@@ -114,14 +114,14 @@
|
||||
</li>
|
||||
<br />
|
||||
<li>
|
||||
<a href="https://bchjs.cash/" target="_blank">
|
||||
<a href="https://fullstack.cash/cashstrap" target="_blank">
|
||||
Run your own infrastructure
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/bitcoinbook/bitcoinbook#chapters" target="_blank">
|
||||
<a href="https://fullstack.cash/documentation" target="_blank">
|
||||
Mastering Bitcoin (great free reference)
|
||||
</a>
|
||||
</li>
|
||||
@@ -135,7 +135,7 @@
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://developer.bitcoin.com/faucets/bch/" target="_blank">
|
||||
<a href="https://fullstack.cash/faucet/" target="_blank">
|
||||
Testnet Faucet
|
||||
</a>
|
||||
</li>
|
||||
@@ -148,7 +148,7 @@
|
||||
<h3>bch-js</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://www.npmjs.com/package/@chris.troutner/bch-js"
|
||||
<a href="https://www.npmjs.com/package/@psf/bch-js"
|
||||
target="_blank">
|
||||
npm library
|
||||
</a>
|
||||
@@ -163,7 +163,7 @@
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/christroutner/bch-js" target="_blank">
|
||||
<a href="https://github.com/Permissionless-Software-Foundation/bch-js" target="_blank">
|
||||
GitHub code repository
|
||||
</a>
|
||||
</li>
|
||||
|
||||
@@ -23,7 +23,7 @@ const router = express.Router()
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
|
||||
+623
-3
@@ -10,7 +10,7 @@ const axios = require('axios')
|
||||
const util = require('util')
|
||||
const bitcore = require('bitcore-lib-cash')
|
||||
|
||||
const ElectrumCash = require('electrum-cash').Client
|
||||
const ElectrumCash = require('electrum-cash').ElectrumClient
|
||||
// const ElectrumCash = require('/home/trout/work/personal/electrum-cash/electrum.js').Client // eslint-disable-line
|
||||
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
@@ -19,7 +19,7 @@ const config = require('../../../config')
|
||||
const RouteUtils = require('../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
@@ -50,10 +50,17 @@ class Electrum {
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/utxos/:address', _this.getUtxos)
|
||||
_this.router.post('/utxos', _this.utxosBulk)
|
||||
_this.router.get('/tx/data/:txid', _this.getTransactionDetails)
|
||||
_this.router.post('/tx/data', _this.transactionDetailsBulk)
|
||||
_this.router.post('/tx/broadcast', _this.broadcastTransaction)
|
||||
_this.router.get('/block/headers/:height', _this.getBlockHeaders)
|
||||
_this.router.post('/block/headers', _this.blockHeadersBulk)
|
||||
_this.router.get('/balance/:address', _this.getBalance)
|
||||
_this.router.post('/balance', _this.balanceBulk)
|
||||
_this.router.get('/transactions/:address', _this.getTransactions)
|
||||
_this.router.post('/transactions', _this.transactionsBulk)
|
||||
_this.router.get('/unconfirmed/:address', _this.getMempool)
|
||||
_this.router.post('/unconfirmed', _this.mempoolBulk)
|
||||
}
|
||||
|
||||
// Initializes a connection to electrum servers.
|
||||
@@ -322,6 +329,424 @@ class Electrum {
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to transaction details data for a txid.
|
||||
// Expects input to be a txid string, and input validation to have already
|
||||
// been done by parent, calling function.
|
||||
async _transactionDetailsFromElectrum (txid, verbose = true) {
|
||||
try {
|
||||
if (!_this.isReady) {
|
||||
throw new Error(
|
||||
'ElectrumX server connection is not ready. Call await connectToServer() first.'
|
||||
)
|
||||
}
|
||||
|
||||
// Query the utxos from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.transaction.get',
|
||||
txid,
|
||||
verbose
|
||||
)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error(
|
||||
'Error in elecrumx.js/_transactionDetailsFromElectrum(): ',
|
||||
err
|
||||
)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/tx/data/{txid} Get transaction details for a TXID
|
||||
* @apiName transaction details for a TXID
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an object with transaction details of the TXID
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/tx/data/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single transaction
|
||||
async getTransactionDetails (req, res, next) {
|
||||
try {
|
||||
const txid = req.params.txid
|
||||
const verbose = req.query.verbose
|
||||
|
||||
// Reject if txid is anything other than a string
|
||||
if (typeof txid !== 'string') {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'txid must be a string'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx/getTransactionDetails with this txid: ',
|
||||
txid
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._transactionDetailsFromElectrum(
|
||||
txid,
|
||||
verbose
|
||||
)
|
||||
// console.log(`_transactionDetailsFromElectrum(): ${JSON.stringify(electrumResponse, null, 2)}`)
|
||||
|
||||
// Pass the error message if ElectrumX reports an error.
|
||||
if (electrumResponse instanceof Error) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: electrumResponse.message
|
||||
})
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
details: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/getTransactionDetails().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/tx/data Get transaction details for an array of TXIDs
|
||||
* @apiName Transaction details for an array of TXIDs
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of objects with transaction details of an array of TXIDs.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/tx/data" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d","a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], "verbose":false}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on transaction details
|
||||
async transactionDetailsBulk (req, res, next) {
|
||||
try {
|
||||
const txids = req.body.txids
|
||||
const verbose = req.body.verbose || true
|
||||
|
||||
// Reject if txids is not an array.
|
||||
if (!Array.isArray(txids)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'txids needs to be an array. Use GET for single txid.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, txids)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx.js/transactionDetailsBulk with these txids: ',
|
||||
txids
|
||||
)
|
||||
|
||||
// Loops through each address and creates an array of Promises, querying
|
||||
// the Electrum server in parallel.
|
||||
const transactions = txids.map(async (txid, index) => {
|
||||
// console.log(`address: ${address}`)
|
||||
const details = await _this._transactionDetailsFromElectrum(
|
||||
txid,
|
||||
verbose
|
||||
)
|
||||
|
||||
return { details, txid }
|
||||
})
|
||||
|
||||
// Wait for all parallel Electrum requests to return.
|
||||
const result = await Promise.all(transactions)
|
||||
|
||||
// Return the array of retrieved transaction details.
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
transactions: result
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/transactionDetailsBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to transaction ID of the broadcasted transaction or an error.
|
||||
// Expects input to be a txHex string, and input validation to have already
|
||||
// been done by parent, calling function.
|
||||
async _broadcastTransactionWithElectrum (txHex) {
|
||||
try {
|
||||
if (!_this.isReady) {
|
||||
throw new Error(
|
||||
'ElectrumX server connection is not ready. Call await connectToServer() first.'
|
||||
)
|
||||
}
|
||||
|
||||
// Broadcast the transaction hex to the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.transaction.broadcast',
|
||||
txHex
|
||||
)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error(
|
||||
'Error in elecrumx.js/_transactionDetailsFromElectrum(): ',
|
||||
err
|
||||
)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/tx/broadcast Broadcast a raw transaction
|
||||
* @apiName Broadcast a raw transaction
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Broadcast a raw transaction and return the transaction ID on success or error on failure.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/tx/broadcast" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txHex":"020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000"}'
|
||||
*
|
||||
*/
|
||||
// POST handler for broadcasting a single transaction
|
||||
async broadcastTransaction (req, res, next) {
|
||||
try {
|
||||
const txHex = req.body.txHex
|
||||
|
||||
if (typeof txHex !== 'string') {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'request body must be a string.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx/broadcastTransaction with this tx hex: ',
|
||||
txHex
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._broadcastTransactionWithElectrum(txHex)
|
||||
// console.log(`_utxosFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
|
||||
|
||||
// Pass the error message if ElectrumX reports an error.
|
||||
if (electrumResponse instanceof Error) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: electrumResponse.message
|
||||
})
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
txid: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/broadcastTransaction().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to block header data for a block height.
|
||||
// Expects input to be a height number, and input validation to have already
|
||||
// been done by parent, calling function.
|
||||
async _blockHeadersFromElectrum (height, count = 1) {
|
||||
try {
|
||||
if (!_this.isReady) {
|
||||
throw new Error(
|
||||
'ElectrumX server connection is not ready. Call await connectToServer() first.'
|
||||
)
|
||||
}
|
||||
|
||||
// Query the block header from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request('blockchain.block.headers', height, count)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
const HEADER_SIZE = 80 * 2
|
||||
|
||||
if (!(electrumResponse instanceof Error)) {
|
||||
const headers = electrumResponse.hex.match(new RegExp(`.{1,${HEADER_SIZE}}`, 'g'))
|
||||
return headers
|
||||
}
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error(
|
||||
'Error in elecrumx.js/_blockHeaderFromElectrum(): ',
|
||||
err
|
||||
)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/block/headers/{height} Get `count` block headers starting at a height
|
||||
* @apiName Block header data for a `count` blocks starting at a block height
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array with block headers starting at the block height
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/block/header/42?count=2" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single block headers
|
||||
async getBlockHeaders (req, res, next) {
|
||||
try {
|
||||
const height = Number(req.params.height)
|
||||
const count = req.query.count === undefined ? 1 : Number(req.query.count)
|
||||
|
||||
// Reject if height is not a number
|
||||
if (Number.isNaN(height) || height < 0) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'height must be a positive number'
|
||||
})
|
||||
}
|
||||
|
||||
// Reject if height is not a number
|
||||
if (Number.isNaN(count) || count < 0) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'count must be a positive number'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx/getBlockHeaders with this height: ',
|
||||
height
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._blockHeadersFromElectrum(height, count)
|
||||
// console.log(`_transactionDetailsFromElectrum(): ${JSON.stringify(electrumResponse, null, 2)}`)
|
||||
|
||||
// Pass the error message if ElectrumX reports an error.
|
||||
if (electrumResponse instanceof Error) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: electrumResponse.message
|
||||
})
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
headers: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/getBlockHeader().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/block/headers Get block headers for an array of height + count pairs
|
||||
* @apiName Block headers for an array of height + count pairs
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of objects with blockheaders of an array of TXIDs.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/block/headers" -H "accept: application/json" -H "Content-Type: application/json" -d '{"heights":[{ "height": 42, count: 2 }, { "height": 100, count: 5 }]}'
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on block headers
|
||||
async blockHeadersBulk (req, res, next) {
|
||||
try {
|
||||
const heights = req.body.heights
|
||||
|
||||
// Reject if heights is not an array.
|
||||
if (!Array.isArray(heights)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'heights needs to be an array. Use GET for single height.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, heights)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx.js/blockHeadersBulk with these txids: ',
|
||||
heights
|
||||
)
|
||||
|
||||
// Loops through each address and creates an array of Promises, querying
|
||||
// the Electrum server in parallel.
|
||||
const transactions = heights.map(async (obj) => {
|
||||
const headers = await _this._blockHeadersFromElectrum(
|
||||
obj.height,
|
||||
obj.count
|
||||
)
|
||||
|
||||
return { headers }
|
||||
})
|
||||
|
||||
// Wait for all parallel Electrum requests to return.
|
||||
const result = await Promise.all(transactions)
|
||||
|
||||
// Return the array of retrieved transaction details.
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
headers: result
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/blockHeadersBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to a balance for an address. Expects input
|
||||
// to be a cash address, and input validation to have already been done by
|
||||
// parent, calling function.
|
||||
@@ -708,6 +1133,199 @@ class Electrum {
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to unconfirmed UTXO data (mempool) for an address.
|
||||
// Expects input to be a cash address, and input validation to have
|
||||
// already been done by parent, calling function.
|
||||
async _mempoolFromElectrumx (address) {
|
||||
try {
|
||||
// Convert the address to a scripthash.
|
||||
const scripthash = _this.addressToScripthash(address)
|
||||
|
||||
if (!_this.isReady) {
|
||||
throw new Error(
|
||||
'ElectrumX server connection is not ready. Call await connectToServer() first.'
|
||||
)
|
||||
}
|
||||
|
||||
// Query the unconfirmed utxos from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.scripthash.get_mempool',
|
||||
scripthash
|
||||
)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/_mempoolFromElectrumx(): ', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/unconfirmed/{addr} Get unconfirmed utxos for a single address.
|
||||
* @apiName Unconfirmed UTXOs for a single address
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an object with unconfirmed UTXOs associated with an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/unconfirmed/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async getMempool (req, res, next) {
|
||||
try {
|
||||
const address = req.params.address
|
||||
|
||||
// Reject if address is an array.
|
||||
if (Array.isArray(address)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'address can not be an array. Use POST for bulk upload.'
|
||||
})
|
||||
}
|
||||
|
||||
// Ensure the address is in cash address format.
|
||||
const cashAddr = _this.bchjs.Address.toCashAddress(address)
|
||||
|
||||
// Prevent a common user error. Ensure they are using the correct network address.
|
||||
const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error:
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx/getMempool with this address: ',
|
||||
cashAddr
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._mempoolFromElectrumx(cashAddr)
|
||||
// console.log(`_mempoolFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
|
||||
|
||||
// Pass the error message if ElectrumX reports an error.
|
||||
if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
message: electrumResponse.message
|
||||
})
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
utxos: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/getMempool().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/unconfirmed Get unconfirmed utxos for an array of addresses.
|
||||
* @apiName Unconfirmed UTXOs for an array of addresses
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of objects with unconfirmed UTXOs associated with an address.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/unconfirmed" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on address details
|
||||
async mempoolBulk (req, res, next) {
|
||||
try {
|
||||
let addresses = req.body.addresses
|
||||
|
||||
// Reject if addresses is not an array.
|
||||
if (!Array.isArray(addresses)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'addresses needs to be an array. Use GET for single address.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing electrumx.js/mempoolBulk with these addresses: ',
|
||||
addresses
|
||||
)
|
||||
|
||||
// Validate each element in the address array.
|
||||
for (let i = 0; i < addresses.length; i++) {
|
||||
const thisAddress = addresses[i]
|
||||
|
||||
// Ensure the input is a valid BCH address.
|
||||
try {
|
||||
_this.bchjs.Address.toLegacyAddress(thisAddress)
|
||||
} catch (err) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `Invalid BCH address. Double check your address is valid: ${thisAddress}`
|
||||
})
|
||||
}
|
||||
|
||||
// Prevent a common user error. Ensure they are using the correct network address.
|
||||
const networkIsValid = _this.routeUtils.validateNetwork(thisAddress)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `Invalid network for address ${thisAddress}. Trying to use a testnet address on mainnet, or vice versa.`
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Loops through each address and creates an array of Promises, querying
|
||||
// Insight API in parallel.
|
||||
addresses = addresses.map(async (address, index) => {
|
||||
// console.log(`address: ${address}`)
|
||||
const utxos = await _this._mempoolFromElectrumx(address)
|
||||
|
||||
return {
|
||||
utxos,
|
||||
address
|
||||
}
|
||||
})
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const result = await Promise.all(addresses)
|
||||
|
||||
// Return the array of retrieved address information.
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
utxos: result
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/mempoolBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Convert a 'bitcoincash:...' address to a script hash used by ElectrumX.
|
||||
addressToScripthash (addrStr) {
|
||||
try {
|
||||
@@ -716,7 +1334,9 @@ class Electrum {
|
||||
const address = _this.bitcore.Address.fromString(addrStr)
|
||||
// console.log(`address: ${address}`)
|
||||
|
||||
const script = _this.bitcore.Script.buildPublicKeyHashOut(address)
|
||||
const script = address.isPayToPublicKeyHash()
|
||||
? _this.bitcore.Script.buildPublicKeyHashOut(address)
|
||||
: _this.bitcore.Script.buildScriptHashOut(address)
|
||||
// console.log(`script: ${script}`)
|
||||
|
||||
const scripthash = _this.bitcore.crypto.Hash.sha256(script.toBuffer())
|
||||
|
||||
@@ -15,7 +15,7 @@ const config = require('../../../config')
|
||||
const RouteUtils = require('../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// Use Blockbook for getting indexer data.
|
||||
|
||||
@@ -17,7 +17,7 @@ const routeUtils = new RouteUtils()
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
|
||||
@@ -11,7 +11,7 @@ const express = require('express')
|
||||
|
||||
const router = express.Router()
|
||||
|
||||
// const BCHJS = require('@chris.troutner/bch-js')
|
||||
// const BCHJS = require('@psf/bch-js')
|
||||
// const bchjs = new BCHJS()
|
||||
|
||||
// let _this
|
||||
|
||||
@@ -10,7 +10,7 @@ const wlogger = require('../../util/winston-logging')
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
module.exports = {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
const axios = require('axios')
|
||||
|
||||
const SLPSDK = require('@chris.troutner/bch-js')
|
||||
const SLPSDK = require('@psf/bch-js')
|
||||
const SLP = new SLPSDK()
|
||||
|
||||
class Slpdb {
|
||||
|
||||
+155
-176
@@ -13,8 +13,12 @@ const Slpdb = require('./services/slpdb')
|
||||
// const strftime = require('strftime')
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
// Instantiate a local copy of bch-js using the local REST API server.
|
||||
const LOCAL_RESTURL = process.env.LOCAL_RESTURL
|
||||
? process.env.LOCAL_RESTURL
|
||||
: 'https://api.fullstack.cash/v3/'
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS({ restURL: LOCAL_RESTURL })
|
||||
|
||||
// Used to convert error messages to strings, to safely pass to users.
|
||||
const util = require('util')
|
||||
@@ -48,6 +52,7 @@ class Slp {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
// Encapsulate external libraries.
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
_this.BigNumber = BigNumber
|
||||
@@ -64,14 +69,11 @@ class Slp {
|
||||
_this.router.get('/balancesForAddress/:address', _this.balancesForAddress)
|
||||
_this.router.post('/balancesForAddress', _this.balancesForAddressBulk)
|
||||
_this.router.get('/balancesForToken/:tokenId', _this.balancesForTokenSingle)
|
||||
_this.router.get(
|
||||
'/balance/:address/:tokenId',
|
||||
_this.balancesForAddressByTokenID
|
||||
)
|
||||
_this.router.get('/convert/:address', _this.convertAddressSingle)
|
||||
_this.router.post('/convert', _this.convertAddressBulk)
|
||||
_this.router.post('/validateTxid', _this.validateBulk)
|
||||
_this.router.get('/validateTxid/:txid', _this.validateSingle)
|
||||
_this.router.get('/validateTxid2/:txid', _this.validate2Single)
|
||||
_this.router.get('/txDetails/:txid', _this.txDetails)
|
||||
_this.router.get('/tokenStats/:tokenId', _this.tokenStats)
|
||||
_this.router.get(
|
||||
@@ -83,6 +85,7 @@ class Slp {
|
||||
_this.txsByAddressSingle
|
||||
)
|
||||
_this.router.post('/generateSendOpReturn', _this.generateSendOpReturn)
|
||||
_this.router.post('/hydrateUtxos', _this.hydrateUtxos)
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
@@ -830,170 +833,6 @@ class Slp {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /slp/balance/{address}/{TokenId} List single slp token balance for address.
|
||||
* @apiName List single slp token balance for address.
|
||||
* @apiGroup SLP
|
||||
* @apiDescription Returns List single slp token balance for address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/slp/balance/simpleledger:qz9tzs6d5097ejpg279rg0rnlhz546q4fsnck9wh5m/1cda254d0a995c713b7955298ed246822bee487458cd9747a91d9e81d9d28125" -H "accept:application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
// Retrieve token balances for a single token class, for a single address.
|
||||
async balancesForAddressByTokenID (req, res, next) {
|
||||
try {
|
||||
// Validate input data.
|
||||
const address = req.params.address
|
||||
if (!address || address === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'address can not be empty' })
|
||||
}
|
||||
|
||||
const tokenId = req.params.tokenId
|
||||
if (!tokenId || tokenId === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'tokenId can not be empty' })
|
||||
}
|
||||
|
||||
// Ensure the input is a valid BCH address.
|
||||
try {
|
||||
_this.bchjs.SLP.Address.toCashAddress(address)
|
||||
} catch (err) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `Invalid BCH address. Double check your address is valid: ${address}`
|
||||
})
|
||||
}
|
||||
|
||||
// Prevent a common user error. Ensure they are using the correct network address.
|
||||
const cashAddr = _this.bchjs.SLP.Address.toCashAddress(address)
|
||||
const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error:
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
|
||||
})
|
||||
}
|
||||
|
||||
// Convert input to an simpleledger: address.
|
||||
const slpAddr = _this.bchjs.SLP.Address.toSlpAddress(req.params.address)
|
||||
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
db: ['g'],
|
||||
aggregate: [
|
||||
{
|
||||
$match: {
|
||||
'graphTxn.outputs': {
|
||||
$elemMatch: {
|
||||
address: slpAddr,
|
||||
status: 'UNSPENT',
|
||||
slpAmount: { $gte: 0 }
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
$unwind: '$graphTxn.outputs'
|
||||
},
|
||||
{
|
||||
$match: {
|
||||
'graphTxn.outputs.address': slpAddr,
|
||||
'graphTxn.outputs.status': 'UNSPENT',
|
||||
'graphTxn.outputs.slpAmount': { $gte: 0 }
|
||||
}
|
||||
},
|
||||
{
|
||||
$project: {
|
||||
amount: '$graphTxn.outputs.slpAmount',
|
||||
address: '$graphTxn.outputs.address',
|
||||
txid: '$graphTxn.txid',
|
||||
vout: '$graphTxn.outputs.vout',
|
||||
tokenId: '$tokenDetails.tokenIdHex'
|
||||
}
|
||||
},
|
||||
{
|
||||
$group: {
|
||||
_id: '$tokenId',
|
||||
balanceString: {
|
||||
$sum: '$amount'
|
||||
},
|
||||
slpAddress: {
|
||||
$first: '$address'
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
limit: 10000
|
||||
}
|
||||
}
|
||||
|
||||
const options = _this.generateCredentials()
|
||||
|
||||
const s = JSON.stringify(query)
|
||||
const b64 = Buffer.from(s).toString('base64')
|
||||
const url = `${process.env.SLPDB_URL}q/${b64}`
|
||||
|
||||
// Get data from SLPDB.
|
||||
const opt = {
|
||||
method: 'get',
|
||||
baseURL: url,
|
||||
headers: options.headers,
|
||||
timeout: options.timeout
|
||||
}
|
||||
const tokenRes = await _this.axios.request(opt)
|
||||
console.log(`tokenRes.data: ${JSON.stringify(tokenRes.data, null, 2)}`)
|
||||
|
||||
let resVal = {
|
||||
cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
|
||||
legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
|
||||
slpAddress: slpAddr,
|
||||
tokenId: tokenId,
|
||||
balance: 0,
|
||||
balanceString: '0'
|
||||
}
|
||||
|
||||
if (tokenRes.data.g.length > 0) {
|
||||
tokenRes.data.g.forEach(async (token) => {
|
||||
if (token._id === tokenId) {
|
||||
resVal = {
|
||||
cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
|
||||
legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
|
||||
slpAddress: slpAddr,
|
||||
tokenId: token._id,
|
||||
balance: parseFloat(token.balanceString),
|
||||
balanceString: token.balanceString
|
||||
}
|
||||
}
|
||||
})
|
||||
} else {
|
||||
resVal = {
|
||||
cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
|
||||
legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
|
||||
slpAddress: slpAddr,
|
||||
tokenId: tokenId,
|
||||
balance: 0,
|
||||
balanceString: '0'
|
||||
}
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json(resVal)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in slp.ts/balancesForAddressByTokenID().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
// return res.json({
|
||||
// error: `Error in /balance/:address/:tokenId: ${err.message}`
|
||||
// })
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /slp/convert/{address} Convert address to slpAddr, cashAddr and legacy.
|
||||
* @apiName Convert address to slpAddr, cashAddr and legacy.
|
||||
@@ -1226,7 +1065,7 @@ class Slp {
|
||||
* @api {get} /slp/validateTxid/{txid} Validate single SLP transaction by txid.
|
||||
* @apiName Validate single SLP transaction by txid.
|
||||
* @apiGroup SLP
|
||||
* @apiDescription Validate single SLP transaction by txid.
|
||||
* @apiDescription Validate single SLP transaction by txid, using SLPDB.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
@@ -1299,11 +1138,66 @@ class Slp {
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a Boolean if the input TXID is a valid SLP TXID.
|
||||
// async function isValidSlpTxid (txid) {
|
||||
// const isValid = await slpValidator.isValidSlpTxid(txid)
|
||||
// return isValid
|
||||
// }
|
||||
/**
|
||||
* @api {get} /slp/validateTxid2/{txid} Validate single SLP transaction by txid.
|
||||
* @apiName Validate single SLP transaction by txid.
|
||||
* @apiGroup SLP
|
||||
* @apiDescription Validate single SLP transaction by txid, using slp-validate.
|
||||
* Slower, less efficient method of validating an SLP TXID using the slp-validate
|
||||
* npm library. This method is independent of SLPDB and can be used as a fall-back
|
||||
* when SLPDB returns 'null' values.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/slp/validateTxid2/f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a" -H "accept:application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
async validate2Single (req, res, next) {
|
||||
try {
|
||||
const txid = req.params.txid
|
||||
|
||||
// Validate input
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing slp/validate2Single/:txid with this txid: ',
|
||||
txid
|
||||
)
|
||||
|
||||
// null by default.
|
||||
// Default return value.
|
||||
const result = {
|
||||
txid: txid,
|
||||
isValid: null,
|
||||
msg: ''
|
||||
}
|
||||
|
||||
// Request options
|
||||
const opt = {
|
||||
method: 'get',
|
||||
baseURL: `${process.env.SLP_API_URL}slp/validate/${txid}`,
|
||||
timeout: 10000 // Exit after 10 seconds.
|
||||
}
|
||||
const tokenRes = await _this.axios.request(opt)
|
||||
// console.log(`tokenRes.data: ${JSON.stringify(tokenRes.data, null, 2)}`)
|
||||
// console.log(`tokenRes: `, tokenRes)
|
||||
|
||||
// Overwrite the default value with the result from slp-api.
|
||||
result.isValid = tokenRes.data.isValid
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// console.log('validate2Single error: ', err)
|
||||
wlogger.error('Error in slp.ts/validate2Single().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /slp/txDetails/{txid} SLP transaction details.
|
||||
@@ -1687,6 +1581,91 @@ class Slp {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /slp/hydrateUtxos/ hydrateUtxos
|
||||
* @apiName SLP hydrateUtxos
|
||||
* @apiGroup SLP
|
||||
* @apiDescription Hydrate UTXO data with SLP information.
|
||||
*
|
||||
* Expects an array of UTXO objects as input. Returns an array of equal size.
|
||||
* Returns UTXO data hydrated with token information. If the UTXO does not
|
||||
* belong to a SLP transaction, it will return an isValid property set to
|
||||
* false. If the UTXO is part of an SLP transaction, it will return the UTXO
|
||||
* object with additional SLP information attached. An isValid property will
|
||||
* be included. If its value is true, the UTXO is a valid SLP UTXO. If the
|
||||
* value is null, then SLPDB has not yet processed that txid and validity has
|
||||
* not been confirmed.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/slp/hydrateUtxos" -H "accept:application/json" -H "Content-Type: application/json" -d '{"utxos":[{"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 3, "value": "6816", "height": 606848, "confirmations": 13, "satoshis": 6816}, {"txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56","vout": 2, "value": "546", "height": 606848, "confirmations": 13, "satoshis": 546}]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
async hydrateUtxos (req, res, next) {
|
||||
try {
|
||||
const utxos = req.body.utxos
|
||||
|
||||
// Validate inputs
|
||||
if (!Array.isArray(utxos)) {
|
||||
res.status(422)
|
||||
return res.json({
|
||||
error: 'Input must be an array.'
|
||||
})
|
||||
}
|
||||
|
||||
if (!utxos.length) {
|
||||
res.status(422)
|
||||
return res.json({
|
||||
error: 'Array should not be empty'
|
||||
})
|
||||
}
|
||||
|
||||
if (utxos.length > 20) {
|
||||
res.status(422)
|
||||
return res.json({
|
||||
error: 'Array too long, max length is 20'
|
||||
})
|
||||
}
|
||||
|
||||
if (!utxos[0].utxos) {
|
||||
res.status(422)
|
||||
return res.json({
|
||||
error: 'Each element in array should have a utxos property'
|
||||
})
|
||||
}
|
||||
|
||||
// Loop through each address and query the UTXOs for that element.
|
||||
for (let i = 0; i < utxos.length; i++) {
|
||||
const theseUtxos = utxos[i].utxos
|
||||
|
||||
// Get SLP token details.
|
||||
const details = await _this.bchjs.SLP.Utils.tokenUtxoDetails(theseUtxos)
|
||||
// console.log('details : ', details)
|
||||
|
||||
// Replace the original UTXO data with the hydrated data.
|
||||
utxos[i].utxos = details
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({ slpUtxos: utxos })
|
||||
} catch (err) {
|
||||
wlogger.error('Error in slp.js/hydrateUtxos().', err)
|
||||
console.error('Error in slp.js/hydrateUtxos().', err)
|
||||
|
||||
// Decode the error message.
|
||||
const { msg, status } = routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({
|
||||
error: 'Error in hydrateUtxos()'
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Slp
|
||||
|
||||
@@ -12,7 +12,7 @@ const blockbook = new Blockbook()
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v3/'
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ const router = express.Router()
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// Connect the route endpoints to their handler functions.
|
||||
|
||||
@@ -10,7 +10,7 @@ const wlogger = require('./winston-logging')
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// let _this
|
||||
|
||||
+897
-5
@@ -2,7 +2,7 @@
|
||||
TESTS FOR THE ELECTRUMX.JS LIBRARY
|
||||
|
||||
Named with a01 prefix so that these tests are run first. Something about running
|
||||
the Blcokbook and Blockchain tests screws up these tests. Spend a couple hours
|
||||
the Blcokbook and Blockchain tests screws up these tests. Spent a couple hours
|
||||
debugging and couldn't isolate the source of the issue, but renaming the file
|
||||
was an easy fix.
|
||||
|
||||
@@ -30,6 +30,18 @@ const mockData = require('./mocks/electrumx-mock')
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// A wrapper for asserting that the correct response is returned when an error
|
||||
// is expected.
|
||||
function expectRouteError (res, result, expectedError, code = 400) {
|
||||
assert.equal(res.statusCode, code, `HTTP status code ${code} expected.`)
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, expectedError)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
}
|
||||
|
||||
describe('#ElectrumX Router', () => {
|
||||
let req, res
|
||||
let sandbox
|
||||
@@ -82,6 +94,17 @@ describe('#ElectrumX Router', () => {
|
||||
//
|
||||
})
|
||||
|
||||
// A wrapper for stubbing with the Sinon sandbox.
|
||||
function stubMethodForUnitTests (obj, method, value) {
|
||||
if (process.env.TEST !== 'unit') return false
|
||||
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox.stub(obj, method).resolves(value)
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
describe('#root', () => {
|
||||
// root route handler.
|
||||
const root = electrumxRoute.root
|
||||
@@ -94,7 +117,7 @@ describe('#ElectrumX Router', () => {
|
||||
})
|
||||
|
||||
describe('#addressToScripthash', () => {
|
||||
it('should accurately return a scripthash', () => {
|
||||
it('should accurately return a scripthash for a P2PKH address', () => {
|
||||
const addr = 'bitcoincash:qpr270a5sxphltdmggtj07v4nskn9gmg9yx4m5h7s4'
|
||||
|
||||
const scripthash = electrumxRoute.addressToScripthash(addr)
|
||||
@@ -104,6 +127,17 @@ describe('#ElectrumX Router', () => {
|
||||
|
||||
assert.equal(scripthash, expectedOutput)
|
||||
})
|
||||
|
||||
it('should accurately return a scripthash for a P2SH address', () => {
|
||||
const addr = 'bitcoincash:pz0z7u9p96h2p6hfychxdrmwgdlzpk5luc5yks2wxq'
|
||||
|
||||
const scripthash = electrumxRoute.addressToScripthash(addr)
|
||||
|
||||
const expectedOutput =
|
||||
'8bc2235c8e7d5634d9ec429fc0171f2c58e728d4f1e2fb7e440e313133cfa4f0'
|
||||
|
||||
assert.equal(scripthash, expectedOutput)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_utxosFromElectrumx', () => {
|
||||
@@ -412,6 +446,552 @@ describe('#ElectrumX Router', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_transactionDetailsFromElectrum', () => {
|
||||
it('should return error object for invalid txid', async () => {
|
||||
const txid =
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Invalid tx hash')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._transactionDetailsFromElectrum(txid)
|
||||
|
||||
assert.instanceOf(result, Error)
|
||||
assert.include(result.message, 'Invalid tx hash')
|
||||
})
|
||||
|
||||
it('should get details for a single txid', async () => {
|
||||
const txid =
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._transactionDetailsFromElectrum(txid)
|
||||
|
||||
assert.isObject(result)
|
||||
assert.property(result, 'blockhash')
|
||||
assert.property(result, 'hash')
|
||||
assert.property(result, 'hex')
|
||||
assert.property(result, 'vin')
|
||||
assert.property(result, 'vout')
|
||||
assert.equal(result.hash, txid)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getTransactionDetails', () => {
|
||||
it('should throw 400 if txid is not a string', async () => {
|
||||
req.params.txid = 5
|
||||
|
||||
const result = await electrumxRoute.getTransactionDetails(req, res)
|
||||
|
||||
expectRouteError(res, result, 'txid must be a string')
|
||||
})
|
||||
|
||||
it('should throw 400 on array input', async () => {
|
||||
req.params.txid = [
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
]
|
||||
|
||||
const result = await electrumxRoute.getTransactionDetails(req, res)
|
||||
|
||||
expectRouteError(res, result, 'txid must be a string')
|
||||
})
|
||||
|
||||
it('should return error object for invalid txid', async () => {
|
||||
req.params.txid =
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Invalid tx hash')
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getTransactionDetails(req, res)
|
||||
|
||||
expectRouteError(res, result, 'Invalid tx hash')
|
||||
})
|
||||
|
||||
it('should get details for a single txid', async () => {
|
||||
req.params.txid =
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getTransactionDetails(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'details')
|
||||
assert.isObject(result.details)
|
||||
|
||||
assert.property(result.details, 'blockhash')
|
||||
assert.property(result.details, 'hash')
|
||||
assert.property(result.details, 'hex')
|
||||
assert.property(result.details, 'vin')
|
||||
assert.property(result.details, 'vout')
|
||||
assert.equal(result.details.hash, req.params.txid)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#transactionDetailsBulk', () => {
|
||||
it('should throw an error for an empty body', async () => {
|
||||
req.body = {}
|
||||
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
|
||||
expectRouteError(res, result, 'txids needs to be an array')
|
||||
})
|
||||
|
||||
it('should error on non-array single txid', async () => {
|
||||
req.body = {
|
||||
txid: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
}
|
||||
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
|
||||
expectRouteError(res, result, 'txids needs to be an array')
|
||||
})
|
||||
|
||||
it('should NOT throw 400 error for an invalid txid', async () => {
|
||||
req.body = {
|
||||
txids: [
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb25'
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails
|
||||
)
|
||||
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
|
||||
// This should probably throw a 400 error, but to be consistent with the other
|
||||
// bulk endpoints it doesn't throw. This will change in the future
|
||||
// expectRouteError(res, result, 'Invalid tx hash')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'transactions')
|
||||
assert.isArray(result.transactions)
|
||||
})
|
||||
|
||||
it('should throw 429 error if txid array is too large', async () => {
|
||||
const testArray = []
|
||||
for (var i = 0; i < 25; i++) testArray.push('')
|
||||
|
||||
req.body.txids = testArray
|
||||
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
expectRouteError(res, result, 'Array too large', 429)
|
||||
})
|
||||
|
||||
it('should get details for a single txid', async () => {
|
||||
req.body = {
|
||||
txids: [
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'transactions')
|
||||
assert.isArray(result.transactions)
|
||||
|
||||
assert.property(result.transactions[0], 'txid')
|
||||
assert.property(result.transactions[0], 'details')
|
||||
|
||||
assert.property(result.transactions[0].details, 'blockhash')
|
||||
assert.property(result.transactions[0].details, 'hash')
|
||||
assert.property(result.transactions[0].details, 'hex')
|
||||
assert.property(result.transactions[0].details, 'vin')
|
||||
assert.property(result.transactions[0].details, 'vout')
|
||||
})
|
||||
|
||||
it('should get details for multiple txids', async () => {
|
||||
req.body = {
|
||||
txids: [
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
|
||||
'4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)'
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.isArray(result.transactions)
|
||||
assert.isObject(result.transactions[0].details)
|
||||
assert.equal(result.transactions.length, 2, '2 outputs for 2 inputs')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_blockHeadersFromElectrum', () => {
|
||||
it('should return error object for invalid block height', async () => {
|
||||
const height = -10
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Invalid height')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._blockHeadersFromElectrum(height, 2)
|
||||
|
||||
assert.instanceOf(result, Error)
|
||||
assert.include(result.message, 'Invalid height')
|
||||
})
|
||||
|
||||
it('should return error object for invalid count', async () => {
|
||||
const height = 42
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Invalid count')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._blockHeadersFromElectrum(height, -1)
|
||||
|
||||
assert.instanceOf(result, Error)
|
||||
assert.include(result.message, 'Invalid count')
|
||||
})
|
||||
|
||||
it('should get block header for a single block height', async () => {
|
||||
const height = 42
|
||||
|
||||
const mockedResponse = { count: 2, hex: mockData.blockHeaders.join(''), max: 2016 }
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockedResponse
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._blockHeadersFromElectrum(height, 2)
|
||||
|
||||
assert.isArray(result)
|
||||
assert.deepEqual(result, mockData.blockHeaders)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getBlockheaders', () => {
|
||||
it('should throw 400 if height is not a number', async () => {
|
||||
req.params.height = 'Hello'
|
||||
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'height must be a positive number')
|
||||
})
|
||||
|
||||
it('should throw 400 if height is negative', async () => {
|
||||
req.params.height = -42
|
||||
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'height must be a positive number')
|
||||
})
|
||||
|
||||
it('should throw 400 if count is not a number', async () => {
|
||||
req.params.height = 42
|
||||
req.query.count = 'Hello'
|
||||
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'count must be a positive number')
|
||||
})
|
||||
|
||||
it('should throw 400 if count is negative', async () => {
|
||||
req.params.height = 42
|
||||
req.query.count = -10
|
||||
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'count must be a positive number')
|
||||
})
|
||||
|
||||
it('should throw 400 on array input', async () => {
|
||||
req.params.height = [42, 42]
|
||||
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'height must be a positive number')
|
||||
})
|
||||
|
||||
it('should return error object for invalid height', async () => {
|
||||
req.params.height = 1000000000
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Invalid height')
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
|
||||
expectRouteError(res, result, 'Invalid height')
|
||||
})
|
||||
|
||||
it('should get headers for a single block height with count 2', async () => {
|
||||
req.params.height = 42
|
||||
req.query.count = 2
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_blockHeadersFromElectrum',
|
||||
mockData.blockHeaders
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getBlockHeaders(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'headers')
|
||||
assert.isArray(result.headers)
|
||||
assert.deepEqual(result.headers, mockData.blockHeaders)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#blockHeadersBulk', () => {
|
||||
it('should throw an error for an empty body', async () => {
|
||||
req.body = {}
|
||||
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
|
||||
expectRouteError(res, result, 'heights needs to be an array')
|
||||
})
|
||||
|
||||
it('should error on non-array single height', async () => {
|
||||
req.body = {
|
||||
heights: 42
|
||||
}
|
||||
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
|
||||
expectRouteError(res, result, 'heights needs to be an array')
|
||||
})
|
||||
|
||||
it('should NOT throw 400 error for an invalid height', async () => {
|
||||
req.body = {
|
||||
heights: [
|
||||
{ height: -10, count: 2 }
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_blockHeadersFromElectrum',
|
||||
mockData.blockHeaders
|
||||
)
|
||||
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
|
||||
// This should probably throw a 400 error, but to be consistent with the other
|
||||
// bulk endpoints it doesn't throw. This will change in the future
|
||||
// expectRouteError(res, result, 'Invalid tx hash')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'headers')
|
||||
assert.isArray(result.headers)
|
||||
})
|
||||
|
||||
it('should throw 429 error if heights array is too large', async () => {
|
||||
const testArray = []
|
||||
for (var i = 0; i < 25; i++) testArray.push('')
|
||||
|
||||
req.body.heights = testArray
|
||||
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
|
||||
expectRouteError(res, result, 'Array too large', 429)
|
||||
})
|
||||
|
||||
it('should get details for a single height', async () => {
|
||||
req.body = {
|
||||
heights: [
|
||||
{ height: 42, count: 2 }
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_blockHeadersFromElectrum',
|
||||
mockData.blockHeaders
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'headers')
|
||||
assert.isArray(result.headers)
|
||||
|
||||
assert.property(result.headers[0], 'headers')
|
||||
assert.isArray(result.headers[0].headers)
|
||||
})
|
||||
|
||||
it('should get details for multiple txids', async () => {
|
||||
req.body = {
|
||||
heights: [
|
||||
{ height: 42, count: 2 },
|
||||
{ height: 42, count: 2 }
|
||||
]
|
||||
}
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_blockHeadersFromElectrum',
|
||||
mockData.blockHeaders
|
||||
)
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)'
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.isArray(result.headers)
|
||||
assert.isArray(result.headers[0].headers)
|
||||
assert.equal(result.headers.length, 2, '2 outputs for 2 inputs')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_broadcastTransactionWithElectrum', () => {
|
||||
it('should return error object for invalid formatted transaction', async () => {
|
||||
const invalidHex = mockData.txDetails.hex.substring(10)
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
new Error('Error: the transaction was rejected by network rules.\n\nTX decode failed\n')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._broadcastTransactionWithElectrum(invalidHex)
|
||||
|
||||
assert.instanceOf(result, Error)
|
||||
assert.include(result.message, 'TX decode failed')
|
||||
})
|
||||
|
||||
it('should return txid for valid transaction', async function () {
|
||||
// We cannot send an actual broadcast transaction to mainnet
|
||||
if (process.env.TEST !== 'unit') return this.skip()
|
||||
|
||||
const validHex = mockData.txDetails.hex
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute.electrumx,
|
||||
'request',
|
||||
mockData.txDetails.hash
|
||||
)
|
||||
|
||||
const result = await electrumxRoute._broadcastTransactionWithElectrum(validHex)
|
||||
|
||||
assert.typeOf(result, 'string')
|
||||
assert.equal(result, mockData.txDetails.hash)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#broadcastTransaction', () => {
|
||||
it('should throw an error for a non-string', async () => {
|
||||
req.body = 456
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_broadcastTransactionWithElectrum',
|
||||
new Error('request body must be a string.')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute.broadcastTransaction(req, res)
|
||||
|
||||
expectRouteError(res, result, 'request body must be a string.')
|
||||
})
|
||||
|
||||
it('should throw an error object for invalid formatted transaction', async () => {
|
||||
req.body.txHex = mockData.txDetails.hex.substring(10)
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_broadcastTransactionWithElectrum',
|
||||
new Error('Error: the transaction was rejected by network rules.\n\nTX decode failed\n')
|
||||
)
|
||||
|
||||
const result = await electrumxRoute.broadcastTransaction(req, res)
|
||||
|
||||
expectRouteError(res, result, 'TX decode failed')
|
||||
})
|
||||
|
||||
it('should return txid for valid transaction', async function () {
|
||||
// We cannot send an actual broadcast transaction to mainnet
|
||||
if (process.env.TEST !== 'unit') return this.skip()
|
||||
|
||||
req.body.txHex = mockData.txDetails.hex
|
||||
|
||||
stubMethodForUnitTests(
|
||||
electrumxRoute,
|
||||
'_broadcastTransactionWithElectrum',
|
||||
mockData.txDetails.hash
|
||||
)
|
||||
|
||||
const result = await electrumxRoute.broadcastTransaction(req, res)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'txid')
|
||||
assert.equal(result.txid, mockData.txDetails.hash)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_balanceFromElectrumx', () => {
|
||||
it('should throw error for invalid address', async () => {
|
||||
try {
|
||||
@@ -753,9 +1333,7 @@ describe('#ElectrumX Router', () => {
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox
|
||||
.stub(electrumxRoute.electrumx, 'request')
|
||||
.resolves([])
|
||||
sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
@@ -999,4 +1577,318 @@ describe('#ElectrumX Router', () => {
|
||||
assert.equal(result.transactions.length, 2, '2 outputs for 2 inputs')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#_mempoolFromElectrumx', () => {
|
||||
it('should throw error for invalid address', async () => {
|
||||
try {
|
||||
// Address has invalid checksum.
|
||||
const address = 'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
|
||||
|
||||
// Call the details API.
|
||||
await electrumxRoute._mempoolFromElectrumx(address)
|
||||
|
||||
assert.equal(true, false, 'Unexpected code path')
|
||||
} catch (err) {
|
||||
assert.include(err.message, 'Invalid checksum')
|
||||
}
|
||||
})
|
||||
|
||||
it('should return empty array for address with no unconfirmed utxos', async () => {
|
||||
// Address has invalid checksum.
|
||||
const address = 'bchtest:qqtmlpspjakqlvywae226esrcdrj9auynuwadh55uf'
|
||||
|
||||
// Mock unit tests to prevent live network calls.
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute._mempoolFromElectrumx(address)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.isArray(result)
|
||||
assert.equal(result.length, 0)
|
||||
})
|
||||
|
||||
it('should get mempool for a single address', async () => {
|
||||
const address = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
|
||||
|
||||
// Mock unit tests to prevent live network calls.
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox
|
||||
.stub(electrumxRoute.electrumx, 'request')
|
||||
.resolves(mockData.mempool)
|
||||
} else {
|
||||
// Skip this test for integrations. Unconfirmed UTXOs are transient and
|
||||
// not easy to test in real-time.
|
||||
assert.equal(true, true)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute._mempoolFromElectrumx(address)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.isArray(result)
|
||||
assert.property(result[0], 'height')
|
||||
assert.property(result[0], 'tx_hash')
|
||||
assert.property(result[0], 'fee')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getMempool', () => {
|
||||
it('should throw 400 if address is empty', async () => {
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, 'Unsupported address format')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
})
|
||||
|
||||
it('should throw 400 on array input', async () => {
|
||||
req.params.address = ['qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c']
|
||||
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, 'address can not be an array')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
})
|
||||
|
||||
it('should throw an error for an invalid address', async () => {
|
||||
req.params.address = '02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
|
||||
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, 'Unsupported address format')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
})
|
||||
|
||||
it('should detect a network mismatch', async () => {
|
||||
req.params.address = 'bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4'
|
||||
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, 'Invalid network', 'Proper error message')
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
})
|
||||
|
||||
it('should pass errors from electrum-cash to user', async () => {
|
||||
// Address has invalid checksum.
|
||||
req.params.address =
|
||||
'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
|
||||
assert.property(result, 'error')
|
||||
assert.include(result.error, 'Unsupported address format')
|
||||
})
|
||||
|
||||
it('should get mempool for a single address', async () => {
|
||||
req.params.address =
|
||||
'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
|
||||
// Mock unit tests to prevent live network calls.
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox
|
||||
.stub(electrumxRoute, '_mempoolFromElectrumx')
|
||||
.resolves(mockData.mempool)
|
||||
} else {
|
||||
// Skip this test for integrations. Unconfirmed UTXOs are transient and
|
||||
// not easy to test in real-time.
|
||||
assert.equal(true, true)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.getMempool(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'utxos')
|
||||
assert.isArray(result.utxos)
|
||||
|
||||
assert.property(result.utxos[0], 'height')
|
||||
assert.property(result.utxos[0], 'tx_hash')
|
||||
assert.property(result.utxos[0], 'fee')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#mempoolBulk', () => {
|
||||
it('should throw an error for an empty body', async () => {
|
||||
req.body = {}
|
||||
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'addresses needs to be an array',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should error on non-array single address', async () => {
|
||||
req.body = {
|
||||
address: 'qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
|
||||
}
|
||||
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'addresses needs to be an array',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw 400 error if addresses array is too large', async () => {
|
||||
const testArray = []
|
||||
for (var i = 0; i < 25; i++) testArray.push('')
|
||||
|
||||
req.body.addresses = testArray
|
||||
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Array too large')
|
||||
})
|
||||
|
||||
it('should throw an error for an invalid address', async () => {
|
||||
req.body = {
|
||||
addresses: ['02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c']
|
||||
}
|
||||
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Invalid BCH address',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should detect a network mismatch', async () => {
|
||||
req.body = {
|
||||
addresses: ['bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4']
|
||||
}
|
||||
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(result.error, 'Invalid network', 'Proper error message')
|
||||
})
|
||||
|
||||
it('should get mempool details for a single address', async () => {
|
||||
req.body = {
|
||||
addresses: ['bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7']
|
||||
}
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox
|
||||
.stub(electrumxRoute, '_mempoolFromElectrumx')
|
||||
.resolves(mockData.mempool)
|
||||
} else {
|
||||
// Skip this test for integrations. Unconfirmed UTXOs are transient and
|
||||
// not easy to test in real-time.
|
||||
assert.equal(true, true)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'utxos')
|
||||
assert.isArray(result.utxos)
|
||||
|
||||
assert.property(result.utxos[0], 'address')
|
||||
assert.property(result.utxos[0], 'utxos')
|
||||
|
||||
assert.isArray(result.utxos[0].utxos)
|
||||
assert.property(result.utxos[0].utxos[0], 'height')
|
||||
assert.property(result.utxos[0].utxos[0], 'tx_hash')
|
||||
assert.property(result.utxos[0].utxos[0], 'fee')
|
||||
})
|
||||
|
||||
it('should get mempool for multiple addresses', async () => {
|
||||
req.body = {
|
||||
addresses: [
|
||||
'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf',
|
||||
'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
]
|
||||
}
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
electrumxRoute.isReady = true // Force flag.
|
||||
|
||||
sandbox
|
||||
.stub(electrumxRoute, '_mempoolFromElectrumx')
|
||||
.resolves(mockData.mempool)
|
||||
} else {
|
||||
// Skip this test for integrations. Unconfirmed UTXOs are transient and
|
||||
// not easy to test in real-time.
|
||||
assert.equal(true, true)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the details API.
|
||||
const result = await electrumxRoute.mempoolBulk(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.isArray(result.utxos)
|
||||
assert.isArray(result.utxos[0].utxos)
|
||||
assert.equal(result.utxos.length, 2, '2 outputs for 2 inputs')
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -16,9 +16,10 @@ util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// const SERVER = `http://192.168.0.36:12400/v3/`
|
||||
const SERVER = 'http://localhost:3000/v3/'
|
||||
// const SERVER = 'https://api.fullstack.cash/v3/'
|
||||
|
||||
const TEST_JWT =
|
||||
'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlM2EwNDE1ZWIyOWE5NjJkYTI3MDhiNCIsImFwaUxldmVsIjowLCJyYXRlTGltaXQiOjEwLCJpYXQiOjE1ODA4NjA0NjcsImV4cCI6MTU4MzQ1MjQ2N30.fuY5S-YrF0J11h5uyMjPe7wiVkYRnIyXi4dL9-V-C6pLJm33p0dSq_pSheVVWw78n5kAvL_9kFHngbnmQiOJYQ'
|
||||
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
|
||||
|
||||
describe('#rate limits', () => {
|
||||
it('should get control/getNetworkInfo() with no auth', async () => {
|
||||
@@ -35,7 +36,7 @@ describe('#rate limits', () => {
|
||||
assert.hasAnyKeys(result.data, ['version'])
|
||||
})
|
||||
|
||||
it('should trigger rate-limit handler if rate limits exceeds 30 request per minute', async () => {
|
||||
it('should trigger rate-limit handler if rate limits exceeds 5 request per minute', async () => {
|
||||
try {
|
||||
// Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
|
||||
const options = {
|
||||
@@ -44,7 +45,7 @@ describe('#rate limits', () => {
|
||||
}
|
||||
|
||||
const promises = []
|
||||
for (let i = 0; i < 30; i++) {
|
||||
for (let i = 0; i < 5; i++) {
|
||||
const promise = axios(options)
|
||||
promises.push(promise)
|
||||
}
|
||||
@@ -60,79 +61,79 @@ describe('#rate limits', () => {
|
||||
}
|
||||
})
|
||||
|
||||
it('should not trigger rate-limit handler if correct pro-tier password is used', async () => {
|
||||
try {
|
||||
const username = 'BITBOX'
|
||||
// it('should not trigger rate-limit handler if correct pro-tier password is used', async () => {
|
||||
// try {
|
||||
// const username = 'BITBOX'
|
||||
//
|
||||
// // Pro-tier is accessed by using the right password.
|
||||
// const password = 'BITBOX'
|
||||
// // const password = "something"
|
||||
//
|
||||
// const combined = `${username}:${password}`
|
||||
// const base64Credential = Buffer.from(combined).toString('base64')
|
||||
// const readyCredential = `Basic ${base64Credential}`
|
||||
//
|
||||
// const options = {
|
||||
// method: 'GET',
|
||||
// url: `${SERVER}control/getNetworkInfo`,
|
||||
// headers: { Authorization: readyCredential }
|
||||
// }
|
||||
//
|
||||
// const promises = []
|
||||
// for (let i = 0; i < 30; i++) {
|
||||
// const promise = axios(options)
|
||||
// promises.push(promise)
|
||||
// }
|
||||
//
|
||||
// await Promise.all(promises)
|
||||
//
|
||||
// assert.equal(true, true, 'Not throwing an error is a pass!')
|
||||
// } catch (err) {
|
||||
// // console.log(`err.response: ${util.inspect(err.response)}`)
|
||||
//
|
||||
// assert.equal(
|
||||
// true,
|
||||
// false,
|
||||
// 'This error handler should not have been triggered. Is the password correct?'
|
||||
// )
|
||||
// }
|
||||
// })
|
||||
|
||||
// Pro-tier is accessed by using the right password.
|
||||
const password = 'BITBOX'
|
||||
// const password = "something"
|
||||
|
||||
const combined = `${username}:${password}`
|
||||
const base64Credential = Buffer.from(combined).toString('base64')
|
||||
const readyCredential = `Basic ${base64Credential}`
|
||||
|
||||
const options = {
|
||||
method: 'GET',
|
||||
url: `${SERVER}control/getNetworkInfo`,
|
||||
headers: { Authorization: readyCredential }
|
||||
}
|
||||
|
||||
const promises = []
|
||||
for (let i = 0; i < 30; i++) {
|
||||
const promise = axios(options)
|
||||
promises.push(promise)
|
||||
}
|
||||
|
||||
await Promise.all(promises)
|
||||
|
||||
assert.equal(true, true, 'Not throwing an error is a pass!')
|
||||
} catch (err) {
|
||||
// console.log(`err.response: ${util.inspect(err.response)}`)
|
||||
|
||||
assert.equal(
|
||||
true,
|
||||
false,
|
||||
'This error handler should not have been triggered. Is the password correct?'
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
it('should trigger rate-limit handler if rate limits exceeds pro-tier limit', async () => {
|
||||
try {
|
||||
const username = 'BITBOX'
|
||||
|
||||
// Pro-tier is accessed by using the right password.
|
||||
const password = 'BITBOX'
|
||||
// const password = "something"
|
||||
|
||||
const combined = `${username}:${password}`
|
||||
const base64Credential = Buffer.from(combined).toString('base64')
|
||||
const readyCredential = `Basic ${base64Credential}`
|
||||
|
||||
// Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
|
||||
const options = {
|
||||
method: 'GET',
|
||||
url: `${SERVER}control/getNetworkInfo`,
|
||||
headers: { Authorization: readyCredential }
|
||||
}
|
||||
|
||||
const promises = []
|
||||
for (let i = 0; i < 80; i++) {
|
||||
const promise = axios(options)
|
||||
promises.push(promise)
|
||||
}
|
||||
|
||||
await Promise.all(promises)
|
||||
|
||||
assert.equal(true, false, 'Unexpected result!')
|
||||
} catch (err) {
|
||||
// console.log(`err.response: ${util.inspect(err.response)}`)
|
||||
|
||||
assert.equal(err.response.status, 429)
|
||||
assert.include(err.response.data.error, 'Too many requests')
|
||||
}
|
||||
})
|
||||
// it('should trigger rate-limit handler if rate limits exceeds pro-tier limit', async () => {
|
||||
// try {
|
||||
// const username = 'BITBOX'
|
||||
//
|
||||
// // Pro-tier is accessed by using the right password.
|
||||
// const password = 'BITBOX'
|
||||
// // const password = "something"
|
||||
//
|
||||
// const combined = `${username}:${password}`
|
||||
// const base64Credential = Buffer.from(combined).toString('base64')
|
||||
// const readyCredential = `Basic ${base64Credential}`
|
||||
//
|
||||
// // Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
|
||||
// const options = {
|
||||
// method: 'GET',
|
||||
// url: `${SERVER}control/getNetworkInfo`,
|
||||
// headers: { Authorization: readyCredential }
|
||||
// }
|
||||
//
|
||||
// const promises = []
|
||||
// for (let i = 0; i < 80; i++) {
|
||||
// const promise = axios(options)
|
||||
// promises.push(promise)
|
||||
// }
|
||||
//
|
||||
// await Promise.all(promises)
|
||||
//
|
||||
// assert.equal(true, false, 'Unexpected result!')
|
||||
// } catch (err) {
|
||||
// // console.log(`err.response: ${util.inspect(err.response)}`)
|
||||
//
|
||||
// assert.equal(err.response.status, 429)
|
||||
// assert.include(err.response.data.error, 'Too many requests')
|
||||
// }
|
||||
// })
|
||||
|
||||
it('should unlock pro-tier for a valid JWT token', async () => {
|
||||
try {
|
||||
|
||||
+138
-1
@@ -22,6 +22,9 @@ if (!process.env.SLPDB_URL) {
|
||||
const SLP = require('../../../src/routes/v3/slp')
|
||||
const slp = new SLP()
|
||||
|
||||
const BCHJS = require('@psf/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||
|
||||
describe('#slp', () => {
|
||||
@@ -102,7 +105,7 @@ describe('#slp', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('generateSendOpReturn', () => {
|
||||
describe('#generateSendOpReturn', () => {
|
||||
it('should return OP_RETURN script', async () => {
|
||||
req.body.tokenUtxos = [
|
||||
{
|
||||
@@ -121,4 +124,138 @@ describe('#slp', () => {
|
||||
assert.isNumber(result.outputs)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#hydrateUtxos', () => {
|
||||
it('should return utxo details', async () => {
|
||||
const utxos = [
|
||||
{
|
||||
utxos: [
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 3,
|
||||
value: '6816',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 6816
|
||||
},
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 2,
|
||||
value: '546',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 546
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
req.body.utxos = utxos
|
||||
const result = await slp.hydrateUtxos(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
// Test the general structure of the output.
|
||||
assert.isArray(result.slpUtxos)
|
||||
assert.equal(result.slpUtxos.length, 1)
|
||||
assert.equal(result.slpUtxos[0].utxos.length, 2)
|
||||
|
||||
// Test the non-slp UTXO.
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'txid')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'vout')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'value')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'height')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'confirmations')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'satoshis')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'isValid')
|
||||
assert.equal(result.slpUtxos[0].utxos[0].isValid, false)
|
||||
|
||||
// Test the slp UTXO.
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'txid')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'vout')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'value')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'height')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'confirmations')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'satoshis')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'isValid')
|
||||
assert.equal(result.slpUtxos[0].utxos[1].isValid, true)
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'transactionType')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenId')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenTicker')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenName')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentUrl')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentHash')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'decimals')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenType')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenQty')
|
||||
})
|
||||
|
||||
it('should process data directly from Electrumx', async () => {
|
||||
const addrs = [
|
||||
'bitcoincash:qq6mvsm7l92d77zpymmltvaw09p5uzghyuyx7spygg',
|
||||
'bitcoincash:qpjdrs8qruzh8xvusdfmutjx62awcepnhyperm3g89',
|
||||
'bitcoincash:qzygn28zpgeemnptkn26xzyuzzfu9l8f9vfvq7kptk'
|
||||
]
|
||||
|
||||
const utxos = await bchjs.Electrumx.utxo(addrs)
|
||||
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||
|
||||
req.body.utxos = utxos.utxos
|
||||
const result = await slp.hydrateUtxos(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
// Test the general structure of the output.
|
||||
assert.isArray(result.slpUtxos)
|
||||
assert.equal(result.slpUtxos.length, 3)
|
||||
assert.equal(result.slpUtxos[0].utxos.length, 1)
|
||||
assert.equal(result.slpUtxos[1].utxos.length, 1)
|
||||
assert.equal(result.slpUtxos[2].utxos.length, 2)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#validate2Single', () => {
|
||||
it('should invalidate a known invalid TXID', async () => {
|
||||
const txid =
|
||||
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
|
||||
|
||||
req.params.txid = txid
|
||||
const result = await slp.validate2Single(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result.txid, txid)
|
||||
assert.equal(result.isValid, false)
|
||||
})
|
||||
|
||||
it('should validate a known valid TXID', async () => {
|
||||
const txid =
|
||||
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
|
||||
|
||||
req.params.txid = txid
|
||||
const result = await slp.validate2Single(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result.txid, txid)
|
||||
assert.equal(result.isValid, true)
|
||||
})
|
||||
|
||||
// CT 10-11-2020: This test is valid, but because of the cacheing built
|
||||
// into slp-validate, it will not consistently pass or fail. To manually
|
||||
// Run this test, re-start slp-api or find a token txid with a long DAG.
|
||||
// it('should cancel if validation takes too long', async () => {
|
||||
// const txid =
|
||||
// 'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
|
||||
//
|
||||
// req.params.txid = txid
|
||||
// const result = await slp.validate2Single(req, res)
|
||||
// // console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
//
|
||||
// assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
|
||||
// assert.include(
|
||||
// result.error,
|
||||
// 'Could not communicate with full node',
|
||||
// 'Error message expected'
|
||||
// )
|
||||
// })
|
||||
})
|
||||
})
|
||||
|
||||
@@ -31,8 +31,92 @@ const txHistory = [
|
||||
}
|
||||
]
|
||||
|
||||
const mempool = [
|
||||
{
|
||||
tx_hash: '45381031132c57b2ff1cbe8d8d3920cf9ed25efd9a0beb764bdb2f24c7d1c7e3',
|
||||
height: 0,
|
||||
fee: 24310
|
||||
}
|
||||
]
|
||||
|
||||
const txDetails = {
|
||||
blockhash: '0000000000000000002aaf94953da3b487317508ebd1003a1d75d6d6ec2e75cc',
|
||||
blocktime: 1578327094,
|
||||
confirmations: 31861,
|
||||
hash: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
|
||||
hex: '020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000',
|
||||
locktime: 0,
|
||||
size: 392,
|
||||
time: 1578327094,
|
||||
txid: '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251',
|
||||
version: 2,
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e[ALL|FORKID] 020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309',
|
||||
hex: '41dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309'
|
||||
},
|
||||
sequence: 4294967295,
|
||||
txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
|
||||
vout: 1
|
||||
},
|
||||
{
|
||||
scriptSig: {
|
||||
asm: '347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f77[ALL|FORKID] 028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954',
|
||||
hex: '41347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954'
|
||||
},
|
||||
sequence: 4294967295,
|
||||
txid: '6796672c8f0342770e3d4ac2a3b0e4494daeb7af7997f3518a0c8402f43ed165',
|
||||
vout: 0
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
addresses: ['bitcoincash: pqvfecpwxvj53ayqfwkxtjaxsgpvnklcyg8xewk9hl'],
|
||||
asm: 'OP_HASH160 189ce02e332548f4804bac65cba68202c9dbf822 OP_EQUAL',
|
||||
hex: 'a914189ce02e332548f4804bac65cba68202c9dbf82287',
|
||||
reqSigs: 1,
|
||||
type: 'scripthash'
|
||||
},
|
||||
value: 0.0562057
|
||||
},
|
||||
{
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
addresses: ['bitcoincash: qq59hv6s3qdjrtyfwfxxldkuj9xsjmx48vrz882knz'],
|
||||
asm: 'OP_DUP OP_HASH160 285bb350881b21ac89724c6fb6dc914d096cd53b OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a914285bb350881b21ac89724c6fb6dc914d096cd53b88ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
value: 0.00589197
|
||||
},
|
||||
{
|
||||
n: 2,
|
||||
scriptPubKey: {
|
||||
addresses: ['bitcoincash: qpzlruwy4xu5rxjs3z37nsj29y7h59gwvsu4ddp0u4'],
|
||||
asm: 'OP_DUP OP_HASH160 45f1f1c4a9b9419a5088a3e9c24a293d7a150e64 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
value: 0.03272697
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const blockHeaders = [
|
||||
'010000008b52bbd72c2f49569059f559c1b1794de5192e4f7d6d2b03c7482bad0000000083e4f8a9d502ed0c419075c1abb5d56f878a2e9079e5612bfb76a2dc37d9c42741dd6849ffff001d2b909dd6',
|
||||
'01000000f528fac1bcb685d0cd6c792320af0300a5ce15d687c7149548904e31000000004e8985a786d864f21e9cbb7cbdf4bc9265fe681b7a0893ac55a8e919ce035c2f85de6849ffff001d385ccb7c'
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
utxos,
|
||||
balance,
|
||||
txHistory
|
||||
txHistory,
|
||||
mempool,
|
||||
txDetails,
|
||||
blockHeaders
|
||||
}
|
||||
|
||||
@@ -352,7 +352,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
h: '7bdd586ebd1e5f3dfd5295ab6e896c48b25855ab77a72c035ce1e7aacc965c2d',
|
||||
i: 1,
|
||||
s: 'RzBEAiAsu5o9EnxgZChjxKygxhGLhlfxJJbQfd4PP/vp2od3fAIgPpMqg+Sp4YpiInQZ6weJwELq8LEIrHXJpueBz7yF5gRBIQLsyL3809mRphc/+tPAcTQO5bi0kqZRFKpKIHXE3qN8Rw==',
|
||||
s:
|
||||
'RzBEAiAsu5o9EnxgZChjxKygxhGLhlfxJJbQfd4PP/vp2od3fAIgPpMqg+Sp4YpiInQZ6weJwELq8LEIrHXJpueBz7yF5gRBIQLsyL3809mRphc/+tPAcTQO5bi0kqZRFKpKIHXE3qN8Rw==',
|
||||
a: 'simpleledger:qrrrpqmdkggpnw0czwg0jgcjd7yhu25jy5zxh2gqdq'
|
||||
}
|
||||
},
|
||||
@@ -361,7 +362,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
h: 'df49feff24dc34a10a44a0cbd7c908d964801ec7218512c84574fbce698535f0',
|
||||
i: 3,
|
||||
s: 'SDBFAiEAhW3zbKTlPrOXD2E2oEcNof6vCMPGYIg8vOVSE9c8IakCIFLg/gxydG9eL8HMAzkScGElKWJRnfhVMpMHU3evNcrZQSEDRS7F+pSC8OxSldsT4FctJLZBU7f2+FDiE05ae1xqtN0=',
|
||||
s:
|
||||
'SDBFAiEAhW3zbKTlPrOXD2E2oEcNof6vCMPGYIg8vOVSE9c8IakCIFLg/gxydG9eL8HMAzkScGElKWJRnfhVMpMHU3evNcrZQSEDRS7F+pSC8OxSldsT4FctJLZBU7f2+FDiE05ae1xqtN0=',
|
||||
a: 'simpleledger:qpkpeqfslejw5pptzcy25h2jxhsc9k0vts43n26up0'
|
||||
}
|
||||
}
|
||||
@@ -371,7 +373,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
v: 0,
|
||||
i: 0,
|
||||
s: 'agRTTFAAAQEEU0VORCA46XxdfTWFosvz+VgMgsozmF+csIRdTcziIMtwn5U4sAgAAAAAAJiWgAgAAAAAJHfU+g=='
|
||||
s:
|
||||
'agRTTFAAAQEEU0VORCA46XxdfTWFosvz+VgMgsozmF+csIRdTcziIMtwn5U4sAgAAAAAAJiWgAgAAAAAJHfU+g=='
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -402,7 +405,8 @@ const mockTxHistory = [
|
||||
slp: {
|
||||
detail: {
|
||||
decimals: 8,
|
||||
tokenIdHex: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||
tokenIdHex:
|
||||
'38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||
transactionType: 'SEND',
|
||||
versionType: 1,
|
||||
documentUri: 'psfoundation.cash',
|
||||
@@ -439,7 +443,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
h: 'e4e1e1f6b502cbd42f69b919634cea3e37fc8595e6ca800e0a7d8f6dcdfb249e',
|
||||
i: 3,
|
||||
s: 'SDBFAiEAjCGRmU28x24LMTwg5XqC+fLf3zGhTYCsSWpmF8Eshq0CIAJhxAKMbwKWC4ASmjWzplpno2ch+hGNUD6HNWOdbd4SQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
s:
|
||||
'SDBFAiEAjCGRmU28x24LMTwg5XqC+fLf3zGhTYCsSWpmF8Eshq0CIAJhxAKMbwKWC4ASmjWzplpno2ch+hGNUD6HNWOdbd4SQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
},
|
||||
@@ -448,7 +453,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
h: '438420345dd8b7fb4ea74aaf2e3090f44899bf3c71662243946a441de6dae720',
|
||||
i: 2,
|
||||
s: 'SDBFAiEAhmLYL4QY3mvZo3/i0XG9PJAYMruw3MaGOLJ3Z4si7hwCIAaaGwRnj/cZK3L/KKFBoMtItpGRZ10GowNN//vgn6PKQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
s:
|
||||
'SDBFAiEAhmLYL4QY3mvZo3/i0XG9PJAYMruw3MaGOLJ3Z4si7hwCIAaaGwRnj/cZK3L/KKFBoMtItpGRZ10GowNN//vgn6PKQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
}
|
||||
@@ -458,7 +464,8 @@ const mockTxHistory = [
|
||||
e: {
|
||||
v: 0,
|
||||
i: 0,
|
||||
s: 'agRTTFAAAQEEU0VORCCk+1wtoaoGTiUBikP5FlBABx2emEuhkMIip/WQU6+EsggAAAAAAA9CQAgAAAAXQnHEwA=='
|
||||
s:
|
||||
'agRTTFAAAQEEU0VORCCk+1wtoaoGTiUBikP5FlBABx2emEuhkMIip/WQU6+EsggAAAAAAA9CQAgAAAAXQnHEwA=='
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -489,7 +496,8 @@ const mockTxHistory = [
|
||||
slp: {
|
||||
detail: {
|
||||
decimals: 2,
|
||||
tokenIdHex: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
|
||||
tokenIdHex:
|
||||
'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
|
||||
transactionType: 'SEND',
|
||||
versionType: 1,
|
||||
documentUri: 'troutsblog.com',
|
||||
|
||||
+35
-35
@@ -105,14 +105,14 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
})
|
||||
|
||||
describe('#calcPoints', () => {
|
||||
it('should return 30 points for anonymous user', () => {
|
||||
it('should return 300 points for anonymous user', () => {
|
||||
const result = rateLimits.calcPoints()
|
||||
// console.log(`result: ${result}`)
|
||||
|
||||
assert.equal(result, 30)
|
||||
assert.equal(result, 300)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting full node access', () => {
|
||||
it('should return 100 points for free tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'blockchain',
|
||||
@@ -120,10 +120,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting indexer access', () => {
|
||||
it('should return 100 points for free tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'blockbook',
|
||||
@@ -131,10 +131,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting SLPDB access', () => {
|
||||
it('should return 100 points for free tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'slp',
|
||||
@@ -142,10 +142,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 1 point for full node tier requesting full node access', () => {
|
||||
it('should return 10 points for full node tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'blockchain',
|
||||
@@ -153,10 +153,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 10 points for full-node tier requesting indexer access', () => {
|
||||
it('should return 100 points for full-node tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'blockbook',
|
||||
@@ -164,10 +164,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 10 points for full node tier requesting SLPDB access', () => {
|
||||
it('should return 100 points for full node tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'slp',
|
||||
@@ -175,10 +175,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 1 point for indexer tier requesting full node access', () => {
|
||||
it('should return 10 point for indexer tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 30,
|
||||
resource: 'blockchain',
|
||||
@@ -186,32 +186,32 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 points for indexer tier requesting indexer access', () => {
|
||||
it('should return 10 points for indexer tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 30,
|
||||
resource: 'blockbook',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
|
||||
it('should return 10 points for indexer tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 30,
|
||||
resource: 'slp',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 point for SLP tier requesting full node access', () => {
|
||||
it('should return 100 points for indexer tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 30,
|
||||
resource: 'slp',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 100)
|
||||
})
|
||||
|
||||
it('should return 10 point for SLP tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'blockchain',
|
||||
@@ -219,10 +219,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 points for SLP tier requesting indexer access', () => {
|
||||
it('should return 10 points for SLP tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'blockbook',
|
||||
@@ -230,10 +230,10 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 points for SLP tier requesting SLPDB access', () => {
|
||||
it('should return 10 points for SLP tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'slp',
|
||||
@@ -241,7 +241,7 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -442,7 +442,7 @@ describe('#route-ratelimits & jwt-auth', () => {
|
||||
|
||||
// Issues with token secret should treat incoming requests as anonymous
|
||||
// calls with 30 points or 3 RPM.
|
||||
assert.equal(res.locals.pointsToConsume, 30)
|
||||
assert.equal(res.locals.pointsToConsume, 300)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
+250
@@ -362,6 +362,7 @@ describe('#SLP', () => {
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Array too large')
|
||||
})
|
||||
|
||||
it('returns proper error when downstream service stalls', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(slpRoute.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||
@@ -462,6 +463,80 @@ describe('#SLP', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('#validate2Single', () => {
|
||||
it('should throw 400 if txid is empty', async () => {
|
||||
req.params.txid = ''
|
||||
const result = await slpRoute.validate2Single(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'txid can not be empty')
|
||||
})
|
||||
|
||||
it('should invalidate a known invalid TXID', async () => {
|
||||
if (process.env.TEST === 'unit') {
|
||||
// Mock to prevent live network connection.
|
||||
sandbox
|
||||
.stub(slpRoute.axios, 'request')
|
||||
.resolves({ data: { isValid: false } })
|
||||
}
|
||||
|
||||
const txid =
|
||||
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
|
||||
|
||||
req.params.txid = txid
|
||||
const result = await slpRoute.validate2Single(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result.txid, txid)
|
||||
assert.equal(result.isValid, false)
|
||||
})
|
||||
|
||||
it('should validate a known valid TXID', async () => {
|
||||
if (process.env.TEST === 'unit') {
|
||||
// Mock to prevent live network connection.
|
||||
sandbox
|
||||
.stub(slpRoute.axios, 'request')
|
||||
.resolves({ data: { isValid: true } })
|
||||
}
|
||||
|
||||
const txid =
|
||||
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
|
||||
|
||||
req.params.txid = txid
|
||||
const result = await slpRoute.validate2Single(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result.txid, txid)
|
||||
assert.equal(result.isValid, true)
|
||||
})
|
||||
|
||||
// This test can only be run as a mocked unit test. It's too inconsistent
|
||||
// to run as an integration test, due to the caching built into slp-validate.
|
||||
if (process.env.TEST === 'unit') {
|
||||
it('should cancel if validation takes too long', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(slpRoute.axios, 'request').throws({
|
||||
code: 'ECONNABORTED'
|
||||
})
|
||||
|
||||
const txid =
|
||||
'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
|
||||
|
||||
req.params.txid = txid
|
||||
const result = await slpRoute.validate2Single(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Could not communicate with full node',
|
||||
'Error message expected'
|
||||
)
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
describe('tokenStats()', () => {
|
||||
it('should throw 400 if tokenID is empty', async () => {
|
||||
req.params.tokenId = ''
|
||||
@@ -888,6 +963,181 @@ describe('#SLP', () => {
|
||||
assert.isNumber(result.outputs)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#hydrateUtxos', () => {
|
||||
it('should throw error if input is not an array.', async () => {
|
||||
req.body.utxos = 'test'
|
||||
|
||||
const result = await slpRoute.hydrateUtxos(req, res)
|
||||
// console.log(`result: `, result)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Input must be an array')
|
||||
})
|
||||
|
||||
it('should throw error if Array is empty', async () => {
|
||||
req.body.utxos = []
|
||||
|
||||
const result = await slpRoute.hydrateUtxos(req, res)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Array should not be empty')
|
||||
})
|
||||
|
||||
it('should throw error if Array is too long', async () => {
|
||||
const utxo = {
|
||||
txid:
|
||||
'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90',
|
||||
vout: 3,
|
||||
amount: 0.00002015,
|
||||
satoshis: 2015,
|
||||
height: 594892,
|
||||
confirmations: 5
|
||||
}
|
||||
|
||||
const utxos = []
|
||||
|
||||
// Populate array with 21 utxos
|
||||
for (let i = 0; i < 21; i++) {
|
||||
utxos.push(utxo)
|
||||
}
|
||||
|
||||
req.body.utxos = utxos
|
||||
|
||||
const result = await slpRoute.hydrateUtxos(req, res)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Array too long, max length is 20')
|
||||
})
|
||||
|
||||
it('should return utxo details', async () => {
|
||||
const utxos = [
|
||||
{
|
||||
utxos: [
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 3,
|
||||
value: '6816',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 6816
|
||||
},
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 2,
|
||||
value: '546',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 546
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
// Mock the external network call.
|
||||
sandbox.stub(slpRoute.bchjs.SLP.Utils, 'tokenUtxoDetails').resolves([
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 3,
|
||||
value: '6816',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 6816,
|
||||
isValid: false
|
||||
},
|
||||
{
|
||||
txid:
|
||||
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||
vout: 2,
|
||||
value: '546',
|
||||
height: 606848,
|
||||
confirmations: 13,
|
||||
satoshis: 546,
|
||||
utxoType: 'token',
|
||||
transactionType: 'send',
|
||||
tokenId:
|
||||
'dd84ca78db4d617221b58eabc6667af8fe2f7eadbfcc213d35be9f1b419beb8d',
|
||||
tokenTicker: 'TAP',
|
||||
tokenName: 'Thoughts and Prayers',
|
||||
tokenDocumentUrl: '',
|
||||
tokenDocumentHash: '',
|
||||
decimals: 0,
|
||||
tokenType: 1,
|
||||
tokenQty: 5,
|
||||
isValid: true
|
||||
}
|
||||
])
|
||||
|
||||
req.body.utxos = utxos
|
||||
const result = await slpRoute.hydrateUtxos(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
// Test the general structure of the output.
|
||||
assert.isArray(result.slpUtxos)
|
||||
assert.equal(result.slpUtxos.length, 1)
|
||||
assert.equal(result.slpUtxos[0].utxos.length, 2)
|
||||
|
||||
// Test the non-slp UTXO.
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'txid')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'vout')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'value')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'height')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'confirmations')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'satoshis')
|
||||
assert.property(result.slpUtxos[0].utxos[0], 'isValid')
|
||||
assert.equal(result.slpUtxos[0].utxos[0].isValid, false)
|
||||
|
||||
// Test the slp UTXO.
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'txid')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'vout')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'value')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'height')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'confirmations')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'satoshis')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'isValid')
|
||||
assert.equal(result.slpUtxos[0].utxos[1].isValid, true)
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'transactionType')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenId')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenTicker')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenName')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentUrl')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentHash')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'decimals')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenType')
|
||||
assert.property(result.slpUtxos[0].utxos[1], 'tokenQty')
|
||||
})
|
||||
|
||||
it('should throw error for missing properties', async () => {
|
||||
const utxos = [
|
||||
{
|
||||
height: 639443,
|
||||
tx_hash:
|
||||
'30707fffb9b295a06a68d217f49c198e9e1dbe1edc3874a0928ca1905f1709df',
|
||||
tx_pos: 0,
|
||||
value: 6000
|
||||
},
|
||||
{
|
||||
height: 639443,
|
||||
tx_hash:
|
||||
'8962566e413501224d178a02effc89be5ac0d8e4195f617415d443dc4c38fe50',
|
||||
tx_pos: 1,
|
||||
value: 546
|
||||
}
|
||||
]
|
||||
|
||||
req.body.utxos = utxos
|
||||
const result = await slpRoute.hydrateUtxos(req, res)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(
|
||||
result.error,
|
||||
'Each element in array should have a utxos property'
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
/*
|
||||
|
||||
+31
-58
@@ -135,11 +135,12 @@ describe('#Util', () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.post((uri) => uri.includes('/'))
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
|
||||
req.params.address = 'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
req.params.address =
|
||||
'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
|
||||
const result = await validateAddress(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
@@ -255,7 +256,7 @@ describe('#Util', () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.post((uri) => uri.includes('/'))
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
|
||||
@@ -281,7 +282,7 @@ describe('#Util', () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.post((uri) => uri.includes('/'))
|
||||
.times(2)
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
@@ -356,17 +357,11 @@ describe('#Util', () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
sandbox
|
||||
@@ -389,51 +384,41 @@ describe('#Util', () => {
|
||||
|
||||
assert.equal(result, 'test-txid')
|
||||
})
|
||||
}
|
||||
|
||||
it('should return balance if balance-only is true', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
it('should return balance if balance-only is true', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
}
|
||||
|
||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||
// to the network.
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
||||
.resolves('test-txid')
|
||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||
// to the network.
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
||||
.resolves('test-txid')
|
||||
|
||||
req.body = {
|
||||
wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
|
||||
balanceOnly: true
|
||||
}
|
||||
req.body = {
|
||||
wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
|
||||
balanceOnly: true
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.isNumber(result)
|
||||
})
|
||||
assert.isNumber(result)
|
||||
})
|
||||
}
|
||||
|
||||
// Unit tests only
|
||||
if (process.env.TEST === 'unit') {
|
||||
it('should generate transaction for valid BCH-only sweep', async () => {
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
@@ -460,17 +445,11 @@ describe('#Util', () => {
|
||||
|
||||
it('should throw 422 error if no non-token UTXOs', async () => {
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
@@ -502,17 +481,11 @@ describe('#Util', () => {
|
||||
|
||||
it('should detect and throw error for multiple token classes', async () => {
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
||||
.resolves(mockData.mockThreeUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
|
||||
Reference in New Issue
Block a user