mirror of
https://github.com/fullstack-cash/bch-api.git
synced 2026-09-21 16:52:04 -07:00
Forked from christroutner/bch-api
This commit is contained in:
Chris Troutner
@@ -0,0 +1,30 @@
|
||||
# http://editorconfig.org
|
||||
|
||||
# A special property that should be specified at the top of the file outside of
|
||||
# any sections. Set to true to stop .editor config file search on current file
|
||||
root = true
|
||||
|
||||
[*]
|
||||
# Indentation style
|
||||
# Possible values - tab, space
|
||||
indent_style = space
|
||||
|
||||
# Indentation size in single-spaced characters
|
||||
# Possible values - an integer, tab
|
||||
indent_size = 2
|
||||
|
||||
# Line ending file format
|
||||
# Possible values - lf, crlf, cr
|
||||
end_of_line = lf
|
||||
|
||||
# File character encoding
|
||||
# Possible values - latin1, utf-8, utf-16be, utf-16le
|
||||
charset = utf-8
|
||||
|
||||
# Denotes whether to trim whitespace at the end of lines
|
||||
# Possible values - true, false
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
# Denotes whether file should end with a newline
|
||||
# Possible values - true, false
|
||||
insert_final_newline = true
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "standard",
|
||||
"env": {
|
||||
"node": true,
|
||||
"mocha": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 10
|
||||
}
|
||||
}
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
node_modules/
|
||||
.nyc_output/*
|
||||
#.env
|
||||
start-local-server
|
||||
test-local-server
|
||||
start-decatur-main.sh
|
||||
start-decatur-test.sh
|
||||
test-decatur-main.sh
|
||||
start-bitcoincom.sh
|
||||
test-remote-server.sh
|
||||
start-bitcoincom-testnet.sh
|
||||
start-local-server.sh
|
||||
start-local-testnet-server.sh
|
||||
start-local-mainnet.sh
|
||||
start-local-testnet.sh
|
||||
test-fullstack-main.sh
|
||||
start-fullstack-main.sh
|
||||
start-fullstack-test.sh
|
||||
start-free-main.sh
|
||||
start-local-mainnet.sh.save
|
||||
start-local-testnet.sh.save
|
||||
|
||||
coverage
|
||||
start-my-infra
|
||||
dist/routes/**
|
||||
test-v1
|
||||
nohup.out
|
||||
slp-tx-db/
|
||||
logs/*
|
||||
docs/*
|
||||
docker/mainnet/start-local-mainnet.sh
|
||||
docker/testnet/start-local-testnet.sh
|
||||
|
||||
|
||||
!logs/README.md
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
language: node_js
|
||||
|
||||
node_js:
|
||||
- "10"
|
||||
|
||||
dist: trusty
|
||||
|
||||
sudo: required
|
||||
|
||||
services:
|
||||
- docker
|
||||
- redis-server
|
||||
|
||||
#before_install:
|
||||
# - ./install-redis.sh
|
||||
|
||||
script: "npm run test"
|
||||
|
||||
after_success:
|
||||
- npm run coverage
|
||||
|
||||
deploy:
|
||||
provider: script
|
||||
skip_cleanup: true
|
||||
script:
|
||||
- npx semantic-release && ./deploy-production.sh
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Chris Troutner
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,99 @@
|
||||
# bch-api
|
||||
|
||||
[](https://greenkeeper.io/)
|
||||
|
||||
[](https://travis-ci.org/christroutner/bch-api)
|
||||
|
||||
This is a fork and alternative implementation of
|
||||
the [rest.bitcoin.com](https://github.com/Bitcoin-com/rest.bitcoin.com) repository.
|
||||
The purpose of this code is to create a REST API server that provides a common
|
||||
interface for working with a Bitcoin Cash full node and various indexers. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) to learn about the 'Cash Stack'. Visit [FullStack.cash](https://fullstack.cash), sign up for a free account, and use this REST API right away with the [bch-js](https://github.com/christroutner/bch-js) JavaScript library.
|
||||
|
||||
This repository is intended to be paired with [bch-js](https://github.com/christroutner/bch-js),
|
||||
an npm JavaScript library, and an alternative implementation
|
||||
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.
|
||||
|
||||
Have questions? Need help? Join our community support
|
||||
[Telegram channel](https://t.me/bch_js_toolkit)
|
||||
|
||||
## Features
|
||||
The following features set this repository apart from rest.bitcoin.com:
|
||||
|
||||
- Address balance and UTXO queries use the [Blockbook](https://github.com/trezor/blockbook)
|
||||
indexer instead of Insight.
|
||||
- Fine grain access is controlled with a JWT token using
|
||||
[this back end auth server](https://github.com/Permissionless-Software-Foundation/jwt-bch-api) and [this front end](https://github.com/Permissionless-Software-Foundation/jwt-bch-frontend).
|
||||
- Default rate limits are set to 3 RPM for anonymous connections, 10 RPM for [free accounts](https://fullstack.cash/pricing), up to 100 RPM if a full-access JWT token is used.
|
||||
- Typescript removed and ES8 JavaScript used instead.
|
||||
- npm audit run on all dependencies.
|
||||
- [Greenkeeper](https://greenkeeper.io/) implemented for automatic dependency management
|
||||
and security updates.
|
||||
|
||||
## Live Demo
|
||||
You can test a live demo of the REST API by running the
|
||||
[bch-js examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples).
|
||||
Rate limits are 3 requests per minute, but you can increase them to 10 with a [free account](https://fullstack.cash/pricing).
|
||||
This is fast enough to try out the examples
|
||||
but these servers are not intended as a freemium service. You can run your own
|
||||
REST server by purchasing the hard drive at [bchjs.cash](https://bchjs.cash).
|
||||
|
||||
- Mainnet REST API server: https://api.fullstack.cash/v3/
|
||||
- Testnet REST API server: https://tapi.fullstack.cash/v3/
|
||||
- Check server status: https://metrics.fullstack.cash
|
||||
|
||||
## Installation
|
||||
There are two installation paths, depending if you want a *development* or
|
||||
*production* environment. You'll also need to set up the underlying infrastructure
|
||||
described [this page](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
|
||||
|
||||
This code targets the Ubuntu 18.04 LTS Linux OS.
|
||||
|
||||
### Development
|
||||
This is a standard node.js project. The installation is as follows:
|
||||
|
||||
- Clone this repository:
|
||||
|
||||
`git clone https://github.com/christroutner/bch-api && cd bch-api`
|
||||
|
||||
- Install dependencies:
|
||||
|
||||
`npm install`
|
||||
|
||||
- Customize the [start-dev-example.sh](start-dev-example.sh) shell script to
|
||||
point to the required infrastructure. Start the bch-api REST API by running
|
||||
this script:
|
||||
|
||||
`./start-dev-example.sh`
|
||||
|
||||
### Production
|
||||
For a production environment, a Docker container is provided in the
|
||||
[docker](docker) directory. One for mainnet and one for testnet. Again, these
|
||||
containers target the Ubuntu 18.04 LTS Linux OS.
|
||||
|
||||
- Install Docker and Docker Compose by following the commands on
|
||||
[this Dev Ops page](https://troutsblog.com/research/dev-ops/overview).
|
||||
|
||||
- Customize the [bash script](docker/mainnet/start-local-mainnet.sh) for your
|
||||
installation.
|
||||
|
||||
- Build the Docker container with:
|
||||
|
||||
`docker-compose build --no-cache`
|
||||
|
||||
- Run the Docker container with:
|
||||
|
||||
`docker-compose up`
|
||||
|
||||
## Support
|
||||
Have questions? Need help? Join our community support
|
||||
[Telegram channel](https://t.me/bch_js_toolkit)
|
||||
|
||||
## License
|
||||
[MIT](LICENSE.md)
|
||||
@@ -0,0 +1,9 @@
|
||||
/*
|
||||
Common configuration settings.
|
||||
*/
|
||||
|
||||
const config = {
|
||||
apiTokenSecret: process.env.TOKENSECRET ? process.env.TOKENSECRET : 'secret-jwt-token'
|
||||
}
|
||||
|
||||
module.exports = config
|
||||
Executable
+15
@@ -0,0 +1,15 @@
|
||||
# Triggers a webhook to update the staging server at staging.fullstack.cash.
|
||||
|
||||
#!/bin/bash
|
||||
#echo $DEPLOY_SECRET
|
||||
|
||||
echo "Deploy to production...."
|
||||
|
||||
export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
|
||||
|
||||
#echo $DATA
|
||||
|
||||
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
|
||||
|
||||
echo "...Finished deploying to production."
|
||||
@@ -0,0 +1 @@
|
||||
COMPOSE_PROJECT_NAME=bch-api-mainnet
|
||||
@@ -0,0 +1,29 @@
|
||||
FROM christroutner/ct-base-ubuntu
|
||||
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
||||
|
||||
RUN apt-get update -y
|
||||
|
||||
#Set the working directory to be the home directory
|
||||
WORKDIR /home/safeuser
|
||||
|
||||
# Switch to user account.
|
||||
USER safeuser
|
||||
# Prep 'sudo' commands.
|
||||
#RUN echo 'abcd8765' | sudo -S pwd
|
||||
|
||||
# Install Redis. TODO: Make this a separate container.
|
||||
|
||||
|
||||
# Clone the repository
|
||||
WORKDIR /home/safeuser
|
||||
RUN git clone https://github.com/christroutner/bch-api
|
||||
WORKDIR /home/safeuser/bch-api
|
||||
RUN npm install
|
||||
|
||||
# Generate documentation
|
||||
RUN npm run docs
|
||||
|
||||
EXPOSE 3000
|
||||
|
||||
COPY start-local-mainnet.sh start-local-mainnet.sh
|
||||
CMD ["./start-local-mainnet.sh"]
|
||||
@@ -0,0 +1,19 @@
|
||||
bch-api-main:
|
||||
build: .
|
||||
dockerfile: Dockerfile
|
||||
#image: bitcore
|
||||
container_name: bch-api-main
|
||||
links:
|
||||
- redis-main
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- ../../logs:/home/safeuser/bch-api/logs
|
||||
restart: always
|
||||
|
||||
redis-main:
|
||||
image: redis:latest
|
||||
container_name: redis-main
|
||||
restart: always
|
||||
ports:
|
||||
- "172.17.0.1:6379:6379"
|
||||
@@ -0,0 +1,2 @@
|
||||
# Logs
|
||||
This directory holds the logs for the mainnet docker container.
|
||||
@@ -0,0 +1 @@
|
||||
COMPOSE_PROJECT_NAME=bch-api-tesnet
|
||||
@@ -0,0 +1,26 @@
|
||||
FROM christroutner/ct-base-ubuntu
|
||||
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
||||
|
||||
RUN apt-get update -y
|
||||
|
||||
#Set the working directory to be the home directory
|
||||
WORKDIR /home/safeuser
|
||||
|
||||
# Switch to user account.
|
||||
USER safeuser
|
||||
# Prep 'sudo' commands.
|
||||
#RUN echo 'abcd8765' | sudo -S pwd
|
||||
|
||||
# Clone the repository
|
||||
WORKDIR /home/safeuser
|
||||
RUN git clone https://github.com/christroutner/bch-api
|
||||
WORKDIR /home/safeuser/bch-api
|
||||
RUN npm install
|
||||
|
||||
# Generate documentation
|
||||
RUN npm run docs
|
||||
|
||||
EXPOSE 3000
|
||||
|
||||
COPY start-local-testnet.sh start-local-testnet.sh
|
||||
CMD ["./start-local-testnet.sh"]
|
||||
@@ -0,0 +1,19 @@
|
||||
bch-api-test:
|
||||
build: .
|
||||
dockerfile: Dockerfile
|
||||
#image: bitcore
|
||||
container_name: bch-api-test
|
||||
links:
|
||||
- redis-test
|
||||
ports:
|
||||
- "4000:3000"
|
||||
volumes:
|
||||
- ../../logs:/home/safeuser/bch-api/logs
|
||||
restart: always
|
||||
|
||||
redis-test:
|
||||
image: redis:latest
|
||||
container_name: redis-test
|
||||
restart: always
|
||||
ports:
|
||||
- "172.17.0.1:6380:6379"
|
||||
@@ -0,0 +1,2 @@
|
||||
# Logs
|
||||
This directory holds logs.
|
||||
Generated
+17629
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,95 @@
|
||||
{
|
||||
"name": "bch-api",
|
||||
"version": "1.0.0",
|
||||
"description": "REST API based on rest.bitcoin.com",
|
||||
"author": "Chris Troutner <chris.troutner@gmail.com>",
|
||||
"contributors": [
|
||||
"Gabriel Cardona <gabriel@bitcoin.com>"
|
||||
],
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/christroutner/bch-api.git"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "node ./src/app.js",
|
||||
"dev": "nodemon ./dist/app.js",
|
||||
"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:integration": "mocha test/v3/integration",
|
||||
"test:integration:slpdb": "mocha --timeout 25000 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"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=10.15.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@chris.troutner/bch-js": "^3.0.1",
|
||||
"apidoc": "^0.23.0",
|
||||
"axios": "^0.19.0",
|
||||
"bitcore-lib-cash": "^8.20.3",
|
||||
"body-parser": "^1.18.3",
|
||||
"cookie-parser": "~1.4.3",
|
||||
"cors": "^2.8.3",
|
||||
"debug": "~4.1.1",
|
||||
"dotenv": "^8.0.0",
|
||||
"electrum-cash": "^1.0.1",
|
||||
"express": "^4.15.5",
|
||||
"express-basic-auth": "^1.1.3",
|
||||
"express-rate-limit": "^5.0.0",
|
||||
"helmet": "^3.21.2",
|
||||
"ioredis": "^4.14.1",
|
||||
"jsonwebtoken": "^8.5.1",
|
||||
"level": "^6.0.0",
|
||||
"mkdirp": "^1.0.0",
|
||||
"mocha": "^7.1.1",
|
||||
"morgan": "^1.9.1",
|
||||
"mqtt": "^4.0.0",
|
||||
"passport": "^0.4.0",
|
||||
"passport-anonymous": "^1.0.1",
|
||||
"passport-http": "^0.3.0",
|
||||
"pg": "^8.0.0",
|
||||
"pg-hstore": "^2.3.2",
|
||||
"rate-limiter-flexible": "^2.0.0",
|
||||
"winston": "^3.2.1",
|
||||
"winston-daily-rotate-file": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"bignumber.js": "^9.0.0",
|
||||
"chai": "^4.1.2",
|
||||
"coveralls": "^3.0.2",
|
||||
"eslint": "5.16.0",
|
||||
"eslint-config-prettier": "^6.0.0",
|
||||
"eslint-config-standard": "^13.0.1",
|
||||
"eslint-plugin-prettier": "^3.1.0",
|
||||
"eslint-plugin-standard": "^4.0.0",
|
||||
"fs-extra": "^9.0.0",
|
||||
"nock": "^12.0.0",
|
||||
"node-mocks-http": "^1.7.0",
|
||||
"nyc": "^15.0.0",
|
||||
"prettier": "^2.0.0",
|
||||
"proxyquire": "^2.1.0",
|
||||
"request": "^2.88.0",
|
||||
"request-promise": "^4.2.2",
|
||||
"semantic-release": "^17.0.0",
|
||||
"sinon": "^9.0.0",
|
||||
"standard": "^14.3.1",
|
||||
"typescript": "^3.1.4"
|
||||
},
|
||||
"release": {
|
||||
"publish": [
|
||||
{
|
||||
"path": "@semantic-release/npm",
|
||||
"npmPublish": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"apidoc": {
|
||||
"title": "bch-api",
|
||||
"url": "https://api.fullstack.cash/v3"
|
||||
}
|
||||
}
|
||||
+231
@@ -0,0 +1,231 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
|
||||
// Middleware
|
||||
// const { routeRateLimit } = require("./middleware/route-ratelimit")
|
||||
const RateLimits = require('./middleware/route-ratelimit')
|
||||
const rateLimits = new RateLimits()
|
||||
|
||||
const path = require('path')
|
||||
const logger = require('morgan')
|
||||
const wlogger = require('./util/winston-logging')
|
||||
const cookieParser = require('cookie-parser')
|
||||
const bodyParser = require('body-parser')
|
||||
// const basicAuth = require("express-basic-auth")
|
||||
const helmet = require('helmet')
|
||||
const debug = require('debug')('rest-cloud:server')
|
||||
const http = require('http')
|
||||
const cors = require('cors')
|
||||
|
||||
// Auth and rate limiting middleware libraries.
|
||||
const AuthMW = require('./middleware/auth')
|
||||
const jwtAuth = require('./middleware/jwt-auth')
|
||||
|
||||
// Logging for API requests.
|
||||
const logReqInfo = require('./middleware/req-logging')
|
||||
|
||||
// v3
|
||||
const healthCheckV3 = require('./routes/v3/health-check')
|
||||
const BlockchainV3 = require('./routes/v3/full-node/blockchain')
|
||||
const ControlV3 = require('./routes/v3/full-node/control')
|
||||
const MiningV3 = require('./routes/v3/full-node/mining')
|
||||
const networkV3 = require('./routes/v3/full-node/network')
|
||||
const RawtransactionsV3 = require('./routes/v3/full-node/rawtransactions')
|
||||
const utilV3 = require('./routes/v3/util')
|
||||
const SlpV3 = require('./routes/v3/slp')
|
||||
const xpubV3 = require('./routes/v3/xpub')
|
||||
const BlockbookV3 = require('./routes/v3/blockbook')
|
||||
const Ninsight = require('./routes/v3/ninsight')
|
||||
const ElectrumXV3 = require('./routes/v3/electrumx')
|
||||
const EncryptionV3 = require('./routes/v3/encryption')
|
||||
|
||||
require('dotenv').config()
|
||||
|
||||
// Instantiate route libraries.
|
||||
const blockchainV3 = new BlockchainV3()
|
||||
const controlV3 = new ControlV3()
|
||||
const miningV3 = new MiningV3()
|
||||
const rawtransactionsV3 = new RawtransactionsV3()
|
||||
const slpV3 = new SlpV3()
|
||||
const blockbookV3 = new BlockbookV3()
|
||||
const electrumxv3 = new ElectrumXV3()
|
||||
electrumxv3.connect()
|
||||
const encryptionv3 = new EncryptionV3()
|
||||
|
||||
const app = express()
|
||||
|
||||
app.locals.env = process.env
|
||||
|
||||
// app.use(swStats.getMiddleware({ swaggerSpec: apiSpec }))
|
||||
|
||||
app.use(helmet())
|
||||
|
||||
app.use(cors())
|
||||
app.enable('trust proxy')
|
||||
|
||||
// view engine setup
|
||||
app.set('views', path.join(__dirname, 'views'))
|
||||
app.set('view engine', 'jade')
|
||||
|
||||
// Mount the docs
|
||||
app.use('/docs', express.static(`${__dirname}/../docs`))
|
||||
|
||||
// Log each request to the console with IP addresses.
|
||||
// app.use(logger("dev"))
|
||||
const morganFormat =
|
||||
':remote-addr :remote-user :method :url :status :response-time ms - :res[content-length] :user-agent'
|
||||
app.use(logger(morganFormat))
|
||||
|
||||
// Log the same data to the winston logs.
|
||||
const logStream = {
|
||||
write: function (message, encoding) {
|
||||
wlogger.info(`request: ${message}`)
|
||||
}
|
||||
}
|
||||
app.use(logger(morganFormat, { stream: logStream }))
|
||||
|
||||
app.use(bodyParser.json())
|
||||
app.use(bodyParser.urlencoded({ extended: false }))
|
||||
app.use(cookieParser())
|
||||
app.use(express.static(path.join(__dirname, 'public')))
|
||||
|
||||
// Log requests for later analysis.
|
||||
app.use('/', logReqInfo)
|
||||
|
||||
// const v2prefix = "v2"
|
||||
const v3prefix = 'v3'
|
||||
|
||||
// Inspect the header for a JWT token.
|
||||
app.use(`/${v3prefix}/`, jwtAuth.getTokenFromHeaders)
|
||||
|
||||
// Instantiate the authorization middleware, used to implement pro-tier rate limiting.
|
||||
// Handles Anonymous and Basic Authorization schemes used by passport.js
|
||||
const auth = new AuthMW()
|
||||
app.use(`/${v3prefix}/`, auth.mw())
|
||||
|
||||
// Rate limit on all v3 routes
|
||||
// Establish and enforce rate limits.
|
||||
// app.use(`/${v3prefix}/`, rateLimits.routeRateLimit)
|
||||
app.use(`/${v3prefix}/`, rateLimits.rateLimitByResource)
|
||||
|
||||
app.use(`/${v3prefix}/` + 'health-check', healthCheckV3)
|
||||
app.use(`/${v3prefix}/` + 'blockchain', blockchainV3.router)
|
||||
app.use(`/${v3prefix}/` + 'control', controlV3.router)
|
||||
app.use(`/${v3prefix}/` + 'mining', miningV3.router)
|
||||
app.use(`/${v3prefix}/` + 'network', networkV3)
|
||||
app.use(`/${v3prefix}/` + 'rawtransactions', rawtransactionsV3.router)
|
||||
app.use(`/${v3prefix}/` + 'util', utilV3.router)
|
||||
app.use(`/${v3prefix}/` + 'slp', slpV3.router)
|
||||
app.use(`/${v3prefix}/` + 'xpub', xpubV3.router)
|
||||
app.use(`/${v3prefix}/` + 'blockbook', blockbookV3.router)
|
||||
app.use(`/${v3prefix}/` + 'electrumx', electrumxv3.router)
|
||||
app.use(`/${v3prefix}/` + 'encryption', encryptionv3.router)
|
||||
|
||||
const ninsight = new Ninsight()
|
||||
app.use(`/${v3prefix}/` + 'ninsight', ninsight.router)
|
||||
|
||||
// catch 404 and forward to error handler
|
||||
app.use((req, res, next) => {
|
||||
const err = {
|
||||
message: 'Not Found',
|
||||
status: 404
|
||||
}
|
||||
|
||||
next(err)
|
||||
})
|
||||
|
||||
// error handler
|
||||
app.use((err, req, res, next) => {
|
||||
const status = err.status || 500
|
||||
|
||||
// set locals, only providing error in development
|
||||
res.locals.message = err.message
|
||||
res.locals.error = req.app.get('env') === 'development' ? err : {}
|
||||
|
||||
// render the error page
|
||||
res.status(status)
|
||||
res.json({
|
||||
status: status,
|
||||
message: err.message
|
||||
})
|
||||
})
|
||||
|
||||
/**
|
||||
* Get port from environment and store in Express.
|
||||
*/
|
||||
const port = normalizePort(process.env.PORT || '3000')
|
||||
app.set('port', port)
|
||||
console.log(`bch-api started on port ${port}`)
|
||||
|
||||
/**
|
||||
* Create HTTP server.
|
||||
*/
|
||||
const server = http.createServer(app)
|
||||
|
||||
/**
|
||||
* Listen on provided port, on all network interfaces.
|
||||
*/
|
||||
|
||||
server.listen(port)
|
||||
server.on('error', onError)
|
||||
server.on('listening', onListening)
|
||||
|
||||
// Set the time before a timeout error is generated. This impacts testing and
|
||||
// the handling of timeout errors. Is 10 seconds too agressive?
|
||||
server.setTimeout(30 * 1000)
|
||||
|
||||
/**
|
||||
* Normalize a port into a number, string, or false.
|
||||
*/
|
||||
|
||||
function normalizePort (val) {
|
||||
const port = parseInt(val, 10)
|
||||
|
||||
if (isNaN(port)) {
|
||||
// named pipe
|
||||
return val
|
||||
}
|
||||
|
||||
if (port >= 0) {
|
||||
// port number
|
||||
return port
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
/**
|
||||
* Event listener for HTTP server "error" event.
|
||||
*/
|
||||
function onError (error) {
|
||||
if (error.syscall !== 'listen') throw error
|
||||
|
||||
const bind = typeof port === 'string' ? `Pipe ${port}` : `Port ${port}`
|
||||
|
||||
// handle specific listen errors with friendly messages
|
||||
switch (error.code) {
|
||||
case 'EACCES':
|
||||
console.error(`${bind} requires elevated privileges`)
|
||||
process.exit(1)
|
||||
break
|
||||
case 'EADDRINUSE':
|
||||
console.error(`${bind} is already in use`)
|
||||
process.exit(1)
|
||||
break
|
||||
default:
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Event listener for HTTP server "listening" event.
|
||||
*/
|
||||
|
||||
function onListening () {
|
||||
const addr = server.address()
|
||||
const bind = typeof addr === 'string' ? `pipe ${addr}` : `port ${addr.port}`
|
||||
debug(`Listening on ${bind}`)
|
||||
}
|
||||
//
|
||||
// module.exports = app;
|
||||
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
CT 2/4/20 Note: This library handles anonymous and Basic auth. This library
|
||||
can be phased out with the chage to JWT tokens and the new rate-limit library.
|
||||
|
||||
Handle authorization for bypassing rate limits.
|
||||
|
||||
1) Default is 'Anonymous Authentication', which unlocks the freemimum tier by
|
||||
default.
|
||||
2) Hard-coded 'Basic Authentication' is a token that does not expire and is
|
||||
provided to buisiness partners.
|
||||
3) JWT-based 'Local Authentication' is used for normal users that pay to
|
||||
access the premium pro-tier services.
|
||||
|
||||
This file uses the passport npm library to check the header of each REST API
|
||||
call for the prescence of a Basic authorization header:
|
||||
https://en.wikipedia.org/wiki/Basic_access_authentication
|
||||
|
||||
If the header is found and validated, the req.locals.proLimit Boolean value
|
||||
is set and passed to the route-ratelimits.ts middleware.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const passport = require('passport')
|
||||
const BasicStrategy = require('passport-http').BasicStrategy
|
||||
const AnonymousStrategy = require('passport-anonymous')
|
||||
const wlogger = require('../util/winston-logging')
|
||||
|
||||
// Used for debugging and iterrogating JS objects.
|
||||
const util = require('util')
|
||||
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'
|
||||
// Convert the pro-tier password string into an array split by ':'.
|
||||
const PRO_PASS = PRO_PASSES.split(':')
|
||||
|
||||
// wlogger.verbose(`PRO_PASS set to: ${PRO_PASS}`)
|
||||
|
||||
// Auth Middleware
|
||||
class AuthMW {
|
||||
constructor () {
|
||||
// _this = this
|
||||
|
||||
// Initialize passport for 'anonymous' authentication.
|
||||
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)
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
// Middleware called by the route.
|
||||
mw () {
|
||||
return passport.authenticate(['basic', 'anonymous'], {
|
||||
session: false
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = AuthMW
|
||||
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
This is a middleware library for handling and processing JWT tokens.
|
||||
|
||||
This middleware inspects the request header for a JWT token.
|
||||
If found, will populate req.locals.jwtToken with the JWT token.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
// This function searches the header for the a JWT token in the authorization header.
|
||||
// If one is found, this middleware passes the JWT token through the
|
||||
// req.locals.jwtToken property.
|
||||
const getTokenFromHeaders = (req, res, next) => {
|
||||
try {
|
||||
// Only executes if the authorization header exists.
|
||||
if (req.headers.authorization) {
|
||||
// Retrieve the auth string from the header object.
|
||||
const authStr = req.headers.authorization
|
||||
|
||||
// If the header is proceeded by the word 'Token'
|
||||
if (authStr.split(' ')[0] === 'Token') {
|
||||
const token = authStr.split(' ')[1]
|
||||
|
||||
// console.log(`JWT found: ${token}`)
|
||||
|
||||
// Create the req.locals property if it does not yet exist.
|
||||
if (!req.locals) {
|
||||
req.locals = {
|
||||
jwtToken: token,
|
||||
proLimit: false,
|
||||
apiLevel: 0
|
||||
}
|
||||
} else {
|
||||
req.locals.jwtToken = token
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
console.log('Error in getTokenFromHeaders: ', err)
|
||||
}
|
||||
|
||||
next()
|
||||
}
|
||||
|
||||
const jwtAuth = {
|
||||
getTokenFromHeaders
|
||||
}
|
||||
|
||||
module.exports = jwtAuth
|
||||
@@ -0,0 +1,52 @@
|
||||
/*
|
||||
This middleware logs connection information to local logs. It gives the ability
|
||||
to detect when the server is being DDOS attacked, and also to collect metrics,
|
||||
like the most popular endpoints.
|
||||
*/
|
||||
|
||||
// const express = require('express')
|
||||
const wlogger = require('../util/winston-logging')
|
||||
|
||||
// Used for debugging and iterrogating JS objects.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const logReqInfo = function (req, res, next) {
|
||||
try {
|
||||
/*
|
||||
// console.log(`req: ${util.inspect(req)}`)
|
||||
console.log(`req.headers: ${util.inspect(req.headers)}`)
|
||||
console.log(`req.url: ${req.url}`)
|
||||
console.log(`req.method: ${req.method}`)
|
||||
// console.log(`req.sws.ip: ${req.sws.ip}`)
|
||||
// console.log(`req.sws.real_ip: ${req.sws.real_ip}`)
|
||||
console.log(`req.body: ${util.inspect(req.body)}`)
|
||||
console.log(`req.connection.remoteAddress: ${util.inspect(req.connection.remoteAddress)}`)
|
||||
// console.log(`req: `, req)
|
||||
console.log(` `)
|
||||
console.log(` `)
|
||||
*/
|
||||
|
||||
// const ip = req.sws.real_ip
|
||||
const ip = req.header('x-forwarded-for') || req.connection.remoteAddress
|
||||
const method = req.method
|
||||
const url = req.url
|
||||
|
||||
const dataToLog = {
|
||||
headers: req.headers,
|
||||
url: url,
|
||||
method: method,
|
||||
ip: ip,
|
||||
body: req.body
|
||||
}
|
||||
|
||||
wlogger.verbose(`Request: ${ip} ${method} ${url}`, dataToLog)
|
||||
|
||||
next()
|
||||
} catch (err) {
|
||||
console.error('Error in req-logging.js middleware: ', err)
|
||||
next()
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = logReqInfo
|
||||
@@ -0,0 +1,230 @@
|
||||
'use strict'
|
||||
|
||||
const wlogger = require('../util/winston-logging')
|
||||
const config = require('../../config')
|
||||
|
||||
const jwt = require('jsonwebtoken')
|
||||
|
||||
// Redis
|
||||
const redisOptions = {
|
||||
enableOfflineQueue: false,
|
||||
port: process.env.REDIS_PORT ? process.env.REDIS_PORT : 6379,
|
||||
host: process.env.REDIS_HOST ? process.env.REDIS_HOST : '127.0.0.1'
|
||||
}
|
||||
console.log(`redisOptions: ${JSON.stringify(redisOptions, null, 2)}`)
|
||||
|
||||
const Redis = require('ioredis')
|
||||
const redisClient = new Redis(redisOptions)
|
||||
|
||||
// Rate limiter middleware lib.
|
||||
const { RateLimiterRedis } = require('rate-limiter-flexible')
|
||||
const rateLimitOptions = {
|
||||
storeClient: redisClient,
|
||||
points: 100, // Number of points
|
||||
duration: 60 // Per minute (per 60 seconds)
|
||||
}
|
||||
|
||||
let _this
|
||||
|
||||
class RateLimits {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
this.jwt = jwt
|
||||
this.rateLimiter = new RateLimiterRedis(rateLimitOptions)
|
||||
this.config = config
|
||||
}
|
||||
|
||||
// Used to disconnect from the Redis DB.
|
||||
// Called by unit tests so that node.js thread doesn't live forever.
|
||||
closeRedis () {
|
||||
redisClient.disconnect()
|
||||
}
|
||||
|
||||
async wipeRedis () {
|
||||
await redisClient.flushdb()
|
||||
}
|
||||
|
||||
// This is the new rate limit function that uses the rate-limiter-flexible npm
|
||||
// library. It uses fine-grain rate limiting based on the resources being
|
||||
// consumed.
|
||||
async rateLimitByResource (req, res, next) {
|
||||
try {
|
||||
let userId
|
||||
let decoded = {}
|
||||
|
||||
// Create a req.locals object if not passed in.
|
||||
if (!req.locals) {
|
||||
req.locals = {
|
||||
// default values
|
||||
jwtToken: '',
|
||||
proLimit: false,
|
||||
apiLevel: 0
|
||||
}
|
||||
}
|
||||
|
||||
// Create a res.locals object if it does not exist. This is used for
|
||||
// debugging.
|
||||
if (!res.locals) {
|
||||
res.locals = {
|
||||
rateLimitTriggered: false
|
||||
}
|
||||
}
|
||||
|
||||
// Decode the JWT token if one exists.
|
||||
if (req.locals.jwtToken) {
|
||||
try {
|
||||
decoded = _this.jwt.verify(
|
||||
req.locals.jwtToken,
|
||||
_this.config.apiTokenSecret
|
||||
)
|
||||
// console.log(`decoded: ${JSON.stringify(decoded, null, 2)}`)
|
||||
|
||||
userId = decoded.id
|
||||
} catch (err) {
|
||||
// This handler will be triggered if the JWT token does not match the
|
||||
// token secret.
|
||||
wlogger.error(
|
||||
`Last three letters of token secret: ${_this.config.apiTokenSecret.slice(
|
||||
-3
|
||||
)}`
|
||||
)
|
||||
wlogger.error(
|
||||
'Error trying to decode JWT token in route-ratelimit.js/newRateLimit(): ',
|
||||
err
|
||||
)
|
||||
}
|
||||
} else {
|
||||
wlogger.debug('No JWT token found!')
|
||||
}
|
||||
|
||||
// Used for displaying error message. Default value is 3.
|
||||
let rateLimit = 3
|
||||
|
||||
// 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
|
||||
try {
|
||||
// The resource being consumed: full node, indexer, SLPDB, etc.
|
||||
const resource = _this.getResource(req.url)
|
||||
wlogger.debug(`resource: ${resource}`)
|
||||
|
||||
let key = userId || req.ip
|
||||
res.locals.key = key // Feedback for tests.
|
||||
|
||||
// const pointsToConsume = userId ? 1 : 30
|
||||
decoded.resource = resource
|
||||
let pointsToConsume = _this.calcPoints(decoded)
|
||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||
|
||||
// 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)
|
||||
) {
|
||||
pointsToConsume = 1
|
||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||
}
|
||||
|
||||
wlogger.info(
|
||||
`User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
|
||||
)
|
||||
|
||||
rateLimit = Math.floor(100 / pointsToConsume)
|
||||
|
||||
// Update the key so that rate limits track both the user and the resource.
|
||||
key = `${key}-${resource}`
|
||||
|
||||
await _this.rateLimiter.consume(key, pointsToConsume)
|
||||
} catch (err) {
|
||||
// console.log('err: ', err)
|
||||
|
||||
// Used for returning data for tests.
|
||||
res.locals.rateLimitTriggered = true
|
||||
// console.log('res.locals: ', res.locals)
|
||||
|
||||
// Rate limited was triggered
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: `Too many requests. Your limits are currently ${rateLimit} requests per minute. Increase rate limits at https://fullstack.cash`
|
||||
})
|
||||
}
|
||||
} catch (err) {
|
||||
wlogger.error('Error in route-ratelimit.js/newRateLimit(): ', err)
|
||||
// throw err
|
||||
}
|
||||
|
||||
next()
|
||||
}
|
||||
|
||||
// Calculates the points consumed, based on the jwt information and the route
|
||||
// requested.
|
||||
calcPoints (jwtInfo) {
|
||||
let retVal = 30 // By default, use anonymous tier.
|
||||
|
||||
try {
|
||||
// console.log(`jwtInfo: ${JSON.stringify(jwtInfo, null, 2)}`)
|
||||
|
||||
const apiLevel = jwtInfo.apiLevel
|
||||
const resource = jwtInfo.resource
|
||||
|
||||
const level30Routes = ['insight', 'bitcore', 'blockbook', 'electrumx']
|
||||
const level40Routes = ['slp']
|
||||
|
||||
wlogger.debug(`apiLevel: ${apiLevel}`)
|
||||
|
||||
// Only evaluate if user is using a JWT token.
|
||||
if (jwtInfo.id) {
|
||||
// SLP indexer routes
|
||||
if (level40Routes.includes(resource)) {
|
||||
if (apiLevel >= 40) retVal = 1
|
||||
// else if (apiLevel >= 10) retVal = 10
|
||||
else retVal = 10
|
||||
|
||||
// Normal indexer routes
|
||||
} else if (level30Routes.includes(resource)) {
|
||||
if (apiLevel >= 30) retVal = 1
|
||||
else retVal = 10
|
||||
|
||||
// Full node tier
|
||||
} else if (apiLevel >= 20) {
|
||||
retVal = 1
|
||||
|
||||
// Free tier, full node only.
|
||||
} else {
|
||||
retVal = 10
|
||||
}
|
||||
}
|
||||
|
||||
return retVal
|
||||
} catch (err) {
|
||||
wlogger.error('Error in route-ratelimit.js/calcPoints()')
|
||||
// throw err
|
||||
retVal = 30
|
||||
}
|
||||
|
||||
return retVal
|
||||
}
|
||||
|
||||
// This function parses the req.url property to identify what resource
|
||||
// the user is requesting.
|
||||
// This was created as a function so that it can be unit tested. Not sure
|
||||
// what kind of variations will be seen in production.
|
||||
getResource (url) {
|
||||
try {
|
||||
wlogger.debug(`url: ${JSON.stringify(url, null, 2)}`)
|
||||
|
||||
const splitUrl = url.split('/')
|
||||
const resource = splitUrl[1]
|
||||
|
||||
return resource
|
||||
} catch (err) {
|
||||
wlogger.error('Error in getResource().')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = RateLimits
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 4.3 KiB |
@@ -0,0 +1,194 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<title>BCH API</title>
|
||||
<meta name="description" content="BCH API" />
|
||||
<meta name="author" content="Chris Troutner" />
|
||||
|
||||
<link rel="stylesheet" href="css/styles.css?v=1.0" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>BCH API</h1>
|
||||
<h4>The REST API for the Bitcoin Cash blockchain.</h4>
|
||||
<br />
|
||||
|
||||
<p>
|
||||
bch-api is a
|
||||
<a
|
||||
href="https://en.wikipedia.org/wiki/Representational_state_transfer"
|
||||
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
|
||||
<a
|
||||
href="https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer"
|
||||
target="_blank"
|
||||
>building full stack applications on BCH</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"
|
||||
target="_blank"
|
||||
>npm bch-js</a
|
||||
>
|
||||
JavaScript library.
|
||||
<a
|
||||
href="https://github.com/Permissionless-Software-Foundation/bch-js-examples"
|
||||
target="_blank"
|
||||
>Here is example code</a
|
||||
>
|
||||
for common BCH use cases.
|
||||
<a href="https://www.npmjs.com/package/slp-cli-wallet" target="_blank">
|
||||
slp-cli-wallet</a
|
||||
>
|
||||
is another npm library that provides common wallet functionality, to get
|
||||
your apps up and running as quickly as possible.
|
||||
</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"
|
||||
>sign-up for a free API key</a
|
||||
>
|
||||
in order to unlock higher rate limits.
|
||||
</p>
|
||||
|
||||
<br />
|
||||
<h2>Quick Links</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<h3>bch-api</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://account.bchjs.cash" target="_blank">
|
||||
Get an API key to increase rate limits
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="/docs">
|
||||
bch-api documentation
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://tapi.bchjs.cash">
|
||||
testnet REST API
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/christroutner/bch-api" target="_blank">
|
||||
bch-api GitHub repository
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://t.me/bch_js_toolkit" target="_blank">
|
||||
Community Telegram Channel
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<br /><br />
|
||||
<li>
|
||||
<h3>Bitcoin Cash</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer"
|
||||
target="_blank">
|
||||
How to become a BCH Full Stack Developer
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
<li>
|
||||
<a href="https://bchjs.cash/" target="_blank">
|
||||
Run your own infrastructure
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/bitcoinbook/bitcoinbook#chapters" target="_blank">
|
||||
Mastering Bitcoin (great free reference)
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://explorer.bitcoin.com/bch" target="_blank">
|
||||
Bitcoin Cash Block Explorer
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://developer.bitcoin.com/faucets/bch/" target="_blank">
|
||||
Testnet Faucet
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<br /><br />
|
||||
<li>
|
||||
<h3>bch-js</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://www.npmjs.com/package/@chris.troutner/bch-js"
|
||||
target="_blank">
|
||||
npm library
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/Permissionless-Software-Foundation/bch-js-examples" target="_blank">
|
||||
Code examples
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
|
||||
<li>
|
||||
<a href="https://github.com/christroutner/bch-js" target="_blank">
|
||||
GitHub code repository
|
||||
</a>
|
||||
</li>
|
||||
<br />
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<br />
|
||||
<h2>Credit</h2>
|
||||
<p>
|
||||
This web server is based on
|
||||
<a href="https://rest.bitcoin.com">rest.bitcoin.com</a>. Most endpoints
|
||||
are common between the two projects. You may want to plan with their
|
||||
interactive UI to explore the API endpoints.
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
View the original rest.bitcoin.com API documentation on
|
||||
<a href="https://developer.bitcoin.com/rest/docs/getting-started"
|
||||
>developer.bitcoin.com</a
|
||||
>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<script src="js/scripts.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,591 @@
|
||||
/*
|
||||
Blockbook API route
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const axios = require('axios')
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
|
||||
const RouteUtils = require('../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
// Library for easily switching the API paths to use different instances of
|
||||
// Blockbook.
|
||||
const BlockbookPath = require('../../util/blockbook-path')
|
||||
const BLOCKBOOKPATH = new BlockbookPath()
|
||||
// BLOCKBOOKPATH.toOpenBazaar()
|
||||
|
||||
const router = express.Router()
|
||||
|
||||
// Used for processing error messages before sending them to the user.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
|
||||
class Blockbook {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
_this.bchjs = bchjs
|
||||
_this.BLOCKBOOKPATH = BLOCKBOOKPATH
|
||||
|
||||
_this.router = router
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/balance/:address', _this.balanceSingle)
|
||||
_this.router.post('/balance', _this.balanceBulk)
|
||||
_this.router.get('/utxos/:address', _this.utxosSingle)
|
||||
_this.router.post('/utxos', _this.utxosBulk)
|
||||
_this.router.get('/tx/:txid', _this.txSingle)
|
||||
_this.router.post('/tx', _this.txBulk)
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
// Root API endpoint. Simply acknowledges that it exists.
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'address' })
|
||||
}
|
||||
|
||||
// Query the Blockbook Node API for a balance on a single BCH address.
|
||||
// Returns a Promise.
|
||||
async balanceFromBlockbook (thisAddress) {
|
||||
try {
|
||||
// console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
|
||||
|
||||
// Convert the address to a cashaddr without a prefix.
|
||||
const addr = _this.bchjs.Address.toCashAddress(thisAddress)
|
||||
|
||||
const path = `${_this.BLOCKBOOKPATH.addrPath}${addr}`
|
||||
// console.log(`path: ${path}`)
|
||||
|
||||
// Query the Blockbook Node API.
|
||||
const options = {
|
||||
method: 'get',
|
||||
baseURL: path
|
||||
}
|
||||
|
||||
const axiosResponse = await _this.axios.request(options)
|
||||
const retData = axiosResponse.data
|
||||
// console.log(`retData: ${util.inspect(retData)}`)
|
||||
|
||||
return retData
|
||||
} catch (err) {
|
||||
// Dev Note: Do not log error messages here. Throw them instead and let the
|
||||
// parent function handle it.
|
||||
wlogger.debug('Error in blockbook.js/balanceFromBlockbook()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockbook/balance/{addr} Get balance for a single address.
|
||||
* @apiName Balance for a single address
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Returns an object with balance and details about an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockbook/balance/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async balanceSingle (req, res, next) {
|
||||
try {
|
||||
const address = req.params.address
|
||||
|
||||
if (!address || address === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'address can not be empty' })
|
||||
}
|
||||
|
||||
// Reject if address is an array.
|
||||
if (Array.isArray(address)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'address can not be an array. Use POST for bulk upload.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockbook/balanceSingle with this address: ',
|
||||
address
|
||||
)
|
||||
|
||||
// Ensure the input is a valid BCH address.
|
||||
try {
|
||||
// const legacyAddr = bchjs.Address.toLegacyAddress(address)
|
||||
_this.bchjs.Address.toLegacyAddress(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 networkIsValid = _this.routeUtils.validateNetwork(address)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error:
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
|
||||
})
|
||||
}
|
||||
|
||||
// Query the Blockbook Node API.
|
||||
const retData = await _this.balanceFromBlockbook(address)
|
||||
|
||||
// Return the retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(retData)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in blockbook.js/balanceSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockbook/balance Get balance for an array of addresses.
|
||||
* @apiName Balance for an array of addresses
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Return balances and details for an array of addresses.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/blockbook/balance" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on address details
|
||||
async balanceBulk (req, res, next) {
|
||||
try {
|
||||
let addresses = req.body.addresses
|
||||
// const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
|
||||
|
||||
// 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 blockbook.js/balanceBulk 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}`)
|
||||
_this.balanceFromBlockbook(address)
|
||||
)
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const result = await _this.axios.all(addresses)
|
||||
|
||||
// Return the array of retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in blockbook.js/balanceBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Query the Blockbook API for utxos associated with a BCH address.
|
||||
// Returns a Promise.
|
||||
async utxosFromBlockbook (thisAddress) {
|
||||
try {
|
||||
// console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
|
||||
|
||||
// Convert the address to a cashaddr without a prefix.
|
||||
const addr = _this.bchjs.Address.toCashAddress(thisAddress)
|
||||
|
||||
const path = `${_this.BLOCKBOOKPATH.utxoPath}${addr}`
|
||||
// console.log(`path: ${path}`)
|
||||
|
||||
// Query the Blockbook API.
|
||||
// Query the Blockbook Node API.
|
||||
const options = {
|
||||
method: 'get',
|
||||
baseURL: path
|
||||
}
|
||||
const axiosResponse = await _this.axios.request(options)
|
||||
const retData = axiosResponse.data
|
||||
// console.log(`retData: ${util.inspect(retData)}`)
|
||||
|
||||
// Add the satoshis property to each UTXO.
|
||||
for (let i = 0; i < retData.length; i++) {
|
||||
retData[i].satoshis = Number(retData[i].value)
|
||||
}
|
||||
|
||||
return retData
|
||||
} catch (err) {
|
||||
// Dev Note: Do not log error messages here. Throw them instead and let the
|
||||
// parent function handle it.
|
||||
wlogger.debug('Error in blockbook.js/utxosFromBlockbook()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockbook/utxos/{addr} Get utxos for a single address.
|
||||
* @apiName UTXOs for a single address
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Returns an object with UTXOs associated with an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockbook/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async utxosSingle (req, res, next) {
|
||||
try {
|
||||
const address = req.params.address
|
||||
|
||||
if (!address || address === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'address can not be empty' })
|
||||
}
|
||||
|
||||
// Reject if address is an array.
|
||||
if (Array.isArray(address)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'address can not be an array. Use POST for bulk upload.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockbook/utxosSingle with this address: ',
|
||||
address
|
||||
)
|
||||
|
||||
// Ensure the input is a valid BCH address.
|
||||
try {
|
||||
// const legacyAddr = bchjs.Address.toLegacyAddress(address)
|
||||
_this.bchjs.Address.toLegacyAddress(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 networkIsValid = _this.routeUtils.validateNetwork(address)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error:
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
|
||||
})
|
||||
}
|
||||
|
||||
// Query the Blockbook API.
|
||||
const retData = await _this.utxosFromBlockbook(address)
|
||||
|
||||
// Return the retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(retData)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in blockbook.js/utxosSingle().', err)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockbook/utxos Get UTXOs for an array of addresses.
|
||||
* @apiName UTXOs for an array of addresses
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Return UTXOs associate with an array of addresses.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/blockbook/utxos" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3","bitcoincash:qzy8wnj0dz927eu6kvh8v2pqsr5w8jh33ys757tdtq"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on address utxos
|
||||
async utxosBulk (req, res, next) {
|
||||
try {
|
||||
let addresses = req.body.addresses
|
||||
// const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
|
||||
|
||||
// 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 blockbook.js/utxosBulk 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}`)
|
||||
_this.utxosFromBlockbook(address)
|
||||
)
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const result = await _this.axios.all(addresses)
|
||||
|
||||
// Return the array of retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in blockbook.js/utxosBulk().', err)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Query the Blockbook Node API for transactions on a single TXID.
|
||||
// Returns a Promise.
|
||||
async transactionsFromBlockbook (txid) {
|
||||
try {
|
||||
// console.log(`BLOCKBOOK_URL: ${BLOCKBOOK_URL}`)
|
||||
|
||||
const path = `${_this.BLOCKBOOKPATH.txPath}${txid}`
|
||||
// console.log(`path: ${path}`)
|
||||
|
||||
// Query the Blockbook Node API.
|
||||
const options = {
|
||||
method: 'get',
|
||||
baseURL: path
|
||||
}
|
||||
const axiosResponse = await _this.axios.request(options)
|
||||
const retPromise = axiosResponse.data
|
||||
// console.log(`retData: ${util.inspect(retData)}`)
|
||||
|
||||
return retPromise
|
||||
} catch (err) {
|
||||
// Dev Note: Do not log error messages here. Throw them instead and let the
|
||||
// parent function handle it.
|
||||
wlogger.debug('Error in blockbook.js/transactionsFromBlockbook()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockbook/tx/{txid} Get details for a single transaction.
|
||||
* @apiName Details for a single transaction
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Returns an object with details for a single transaction
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockbook/tx/6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single transaction details.
|
||||
async txSingle (req, res, next) {
|
||||
try {
|
||||
const txid = req.params.txid
|
||||
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
// Reject if address is an array.
|
||||
if (Array.isArray(txid)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'txid can not be an array. Use POST for bulk upload.'
|
||||
})
|
||||
}
|
||||
|
||||
// TODO: Add regex comparison of txid to ensure it's valid.
|
||||
if (txid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `txid must be of length 64 (not ${txid.length})`
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug('Executing blockbook/txSingle with this txid: ', txid)
|
||||
|
||||
// Query the Blockbook Node API.
|
||||
const retData = await _this.transactionsFromBlockbook(txid)
|
||||
|
||||
// Return the retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(retData)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in blockbook.js/txSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockbook/tx Get details for an array of transactions.
|
||||
* @apiName Details for an array of transactions
|
||||
* @apiGroup Blockbook
|
||||
* @apiDescription Return details for an array of transactions.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/blockbook/tx" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d","6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on tx details
|
||||
async txBulk (req, res, next) {
|
||||
try {
|
||||
let txids = req.body.txids
|
||||
// const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
|
||||
|
||||
// Reject if txids is not an array.
|
||||
if (!Array.isArray(txids)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'txids need to be an array. Use GET for single address.'
|
||||
})
|
||||
}
|
||||
|
||||
// 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({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug('Executing blockbook.js/txBulk with these txids: ', txids)
|
||||
|
||||
// Validate each element in the txids array.
|
||||
for (let i = 0; i < txids.length; i++) {
|
||||
const thisTxid = txids[i]
|
||||
|
||||
if (!thisTxid || thisTxid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
// TODO: Add regex comparison of txid to ensure it's valid.
|
||||
if (thisTxid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `txid must be of length 64 (not ${thisTxid.length})`
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Loops through each address and creates an array of Promises, querying
|
||||
// Insight API in parallel.
|
||||
txids = txids.map(async (txid, index) =>
|
||||
// console.log(`address: ${address}`)
|
||||
_this.transactionsFromBlockbook(txid)
|
||||
)
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const result = await _this.axios.all(txids)
|
||||
|
||||
// Return the array of retrieved address information.
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in blockbook.js/txBulk().', err)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Blockbook
|
||||
@@ -0,0 +1,735 @@
|
||||
/*
|
||||
Electrum API route
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
const axios = require('axios')
|
||||
const util = require('util')
|
||||
const bitcore = require('bitcore-lib-cash')
|
||||
|
||||
const ElectrumCash = require('electrum-cash').Client
|
||||
// const ElectrumCash = require('/home/trout/work/personal/electrum-cash/electrum.js').Client // eslint-disable-line
|
||||
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
const config = require('../../../config')
|
||||
|
||||
const RouteUtils = require('../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
|
||||
class Electrum {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
_this.config = config
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
_this.bchjs = bchjs
|
||||
_this.bitcore = bitcore
|
||||
|
||||
_this.electrumx = new ElectrumCash(
|
||||
'bch-api',
|
||||
'1.4.1',
|
||||
process.env.FULCRUM_URL,
|
||||
process.env.FULCRUM_PORT
|
||||
// '192.168.0.6',
|
||||
// '50002'
|
||||
)
|
||||
|
||||
_this.isReady = false
|
||||
// _this.connectToServers()
|
||||
|
||||
_this.router = router
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/utxos/:address', _this.getUtxos)
|
||||
_this.router.post('/utxos', _this.utxosBulk)
|
||||
_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)
|
||||
}
|
||||
|
||||
// Initializes a connection to electrum servers.
|
||||
async connect () {
|
||||
try {
|
||||
console.log('Attempting to connect to ElectrumX server...')
|
||||
|
||||
// console.log('_this.electrumx: ', _this.electrumx)
|
||||
|
||||
// Return immediately if a connection has already been established.
|
||||
if (_this.isReady) return true
|
||||
|
||||
// Connect to the server.
|
||||
await _this.electrumx.connect()
|
||||
|
||||
// Set the connection flag.
|
||||
_this.isReady = true
|
||||
|
||||
console.log('...Successfully connected to ElectrumX server.')
|
||||
|
||||
// console.log(`_this.isReady: ${_this.isReady}`)
|
||||
return _this.isReady
|
||||
} catch (err) {
|
||||
console.log('err: ', err)
|
||||
wlogger.error('Error in electrumx.js/connect(): ', err)
|
||||
// throw err
|
||||
}
|
||||
}
|
||||
|
||||
// Disconnect from the ElectrumX server.
|
||||
async disconnect () {
|
||||
try {
|
||||
// Return immediately if the isReady flag is false.
|
||||
if (!_this.isReady) return true
|
||||
|
||||
// Disconnect from the server.
|
||||
await _this.electrumx.disconnect()
|
||||
|
||||
// Clear the isReady flag.
|
||||
_this.isReady = false
|
||||
|
||||
// Return true to signal that the disconnection happened successfully.
|
||||
return true
|
||||
} catch (err) {
|
||||
// console.log(`err: `, err)
|
||||
wlogger.error('Error in electrumx.js/disconnect()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
// Handle error patterns specific to this route.
|
||||
if (err.message) {
|
||||
res.status(400)
|
||||
return res.json({ success: false, error: err.message })
|
||||
}
|
||||
|
||||
// If error can be handled, return the stack trace
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
// Root API endpoint. Simply acknowledges that it exists.
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'electrumx' })
|
||||
}
|
||||
|
||||
// Returns a promise that resolves to UTXO data for an address. Expects input
|
||||
// to be a cash address, and input validation to have already been done by
|
||||
// parent, calling function.
|
||||
async _utxosFromElectrumx (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 utxos from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.scripthash.listunspent',
|
||||
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/_utxosFromElectrumx(): ', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/utxos/{addr} Get utxos for a single address.
|
||||
* @apiName UTXOs for a single address
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an object with UTXOs associated with an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async getUtxos (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.'
|
||||
})
|
||||
}
|
||||
|
||||
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/getUtxos with this address: ',
|
||||
cashAddr
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._utxosFromElectrumx(cashAddr)
|
||||
// console.log(`_utxosFromElectrumx(): ${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/getUtxos().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/utxo Get utxos for an array of addresses.
|
||||
* @apiName UTXOs for an array of addresses
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of objects with UTXOs associated with an address.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/utxos" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on address details
|
||||
async utxosBulk (req, res, next) {
|
||||
try {
|
||||
let addresses = req.body.addresses
|
||||
// const currentPage = req.body.page ? parseInt(req.body.page, 10) : 0
|
||||
|
||||
// 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/utxoBulk 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._utxosFromElectrumx(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/utxoBulk().', 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.
|
||||
async _balanceFromElectrumx (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 address balance from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.scripthash.get_balance',
|
||||
scripthash
|
||||
)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err1: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/_utxosFromElectrumx(): ', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/balance/{addr} Get balance for a single address.
|
||||
* @apiName Balance for a single address
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an object with confirmed and unconfirmed balance associated with an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async getBalance (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/getBalance with this address: ',
|
||||
cashAddr
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._balanceFromElectrumx(cashAddr)
|
||||
// console.log(`_utxosFromElectrumx(): ${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,
|
||||
balance: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/getBalance().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/balance Get balances for an array of addresses.
|
||||
* @apiName Balances for an array of addresses
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of balanes associated with an array of address.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/balance" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on address balance
|
||||
async balanceBulk (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/balanceBulk 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
|
||||
// ElectrumX API in parallel.
|
||||
addresses = addresses.map(async (address, index) => {
|
||||
// console.log(`address: ${address}`)
|
||||
const balance = await _this._balanceFromElectrumx(address)
|
||||
|
||||
return {
|
||||
balance,
|
||||
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,
|
||||
balances: result
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/balanceBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a promise that resolves an array of transaction history for an
|
||||
// address. Expects input to be a cash address, and input validation to have
|
||||
// already been done by parent, calling function.
|
||||
async _transactionsFromElectrumx (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 address transaction history from the ElectrumX server.
|
||||
const electrumResponse = await _this.electrumx.request(
|
||||
'blockchain.scripthash.get_history',
|
||||
scripthash
|
||||
)
|
||||
// console.log(
|
||||
// `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
|
||||
// )
|
||||
|
||||
return electrumResponse
|
||||
} catch (err) {
|
||||
// console.log('err1: ', err)
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/_transactionsFromElectrumx(): ', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /electrumx/transactions/{addr} Get transaction history for a single address.
|
||||
* @apiName Transaction history for a single address
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of historical transactions associated with an address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/transactions/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
// GET handler for single balance
|
||||
async getTransactions (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/getTransactions with this address: ',
|
||||
cashAddr
|
||||
)
|
||||
|
||||
// Get data from ElectrumX server.
|
||||
const electrumResponse = await _this._transactionsFromElectrumx(cashAddr)
|
||||
// console.log(`_utxosFromElectrumx(): ${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,
|
||||
transactions: electrumResponse
|
||||
})
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in elecrumx.js/getTransactions().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /electrumx/transactions Get the transaction history for an array of addresses.
|
||||
* @apiName Transactions for an array of addresses
|
||||
* @apiGroup ElectrumX / Fulcrum
|
||||
* @apiDescription Returns an array of transactions associated with an array of address.
|
||||
* Limited to 20 items per request.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/transactions" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
// POST handler for bulk queries on transaction histories for addresses.
|
||||
async transactionsBulk (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/transactionsBulk 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
|
||||
// ElectrumX API in parallel.
|
||||
addresses = addresses.map(async (address, index) => {
|
||||
// console.log(`address: ${address}`)
|
||||
const transactions = await _this._transactionsFromElectrumx(address)
|
||||
|
||||
return {
|
||||
transactions,
|
||||
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,
|
||||
transactions: result
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/transactionsBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Convert a 'bitcoincash:...' address to a script hash used by ElectrumX.
|
||||
addressToScripthash (addrStr) {
|
||||
try {
|
||||
// console.log(`addrStr: ${addrStr}`)
|
||||
|
||||
const address = _this.bitcore.Address.fromString(addrStr)
|
||||
// console.log(`address: ${address}`)
|
||||
|
||||
const script = _this.bitcore.Script.buildPublicKeyHashOut(address)
|
||||
// console.log(`script: ${script}`)
|
||||
|
||||
const scripthash = _this.bitcore.crypto.Hash.sha256(script.toBuffer())
|
||||
.reverse()
|
||||
.toString('hex')
|
||||
// console.log(`scripthash: ${scripthash}`)
|
||||
|
||||
return scripthash
|
||||
} catch (err) {
|
||||
wlogger.error('Error in electrumx.js/addressToScripthash()')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Electrum
|
||||
@@ -0,0 +1,185 @@
|
||||
/*
|
||||
Encryption API route
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
const axios = require('axios')
|
||||
const util = require('util')
|
||||
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
const config = require('../../../config')
|
||||
|
||||
const RouteUtils = require('../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// Use Blockbook for getting indexer data.
|
||||
const Blockbook = require('./blockbook')
|
||||
const blockbook = new Blockbook()
|
||||
|
||||
// Use RawTransactions library for getting raw blockchain data.
|
||||
const RawTransactions = require('./full-node/rawtransactions')
|
||||
const rawTransactions = new RawTransactions()
|
||||
|
||||
let _this
|
||||
|
||||
class Encryption {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
_this.config = config
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
_this.bchjs = bchjs
|
||||
_this.blockbook = blockbook
|
||||
_this.rawTransactions = rawTransactions
|
||||
|
||||
_this.router = router
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/publickey/:address', _this.getPublicKey)
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
// Handle error patterns specific to this route.
|
||||
if (err.message) {
|
||||
res.status(400)
|
||||
return res.json({ success: false, error: err.message })
|
||||
}
|
||||
|
||||
wlogger.error('Unhandled error in Encryption library: ', err)
|
||||
|
||||
// If error can be handled, return the stack trace
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
// Root API endpoint. Simply acknowledges that it exists.
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'encryption' })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /encryption/publickey/{addr} Get public key for a BCH address.
|
||||
* @apiName Get encryption key for bch address
|
||||
* @apiGroup Encryption
|
||||
* @apiDescription Searches the blockchain for a public key associated with a
|
||||
* BCH address. Returns an object. If successful, the publicKey property will
|
||||
* contain a hexidecimal representation of the public key.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getPublicKey (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.'
|
||||
})
|
||||
}
|
||||
|
||||
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 encryption/getPublicKey with this address: ',
|
||||
cashAddr
|
||||
)
|
||||
|
||||
// Retrieve the transaction history for this address.
|
||||
const balance = await _this.blockbook.balanceFromBlockbook(cashAddr)
|
||||
// console.log(`balance: ${JSON.stringify(balance, null, 2)}`)
|
||||
|
||||
const txHistory = balance.txids
|
||||
// console.log(`txHistory: ${JSON.stringify(txHistory, null, 2)}`)
|
||||
|
||||
// throw error if there is no transaction history.
|
||||
if (!txHistory || txHistory.length === 0) {
|
||||
throw new Error('No transaction history.')
|
||||
}
|
||||
|
||||
// Loop through the transaction history and search for the public key.
|
||||
for (let i = 0; i < txHistory.length; i++) {
|
||||
const thisTx = txHistory[i]
|
||||
|
||||
const txDetails = await _this.rawTransactions.getRawTransactionsFromNode(
|
||||
thisTx,
|
||||
true
|
||||
)
|
||||
// console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
|
||||
|
||||
const vin = txDetails.vin
|
||||
|
||||
// Loop through each input.
|
||||
for (let j = 0; j < vin.length; j++) {
|
||||
const thisVin = vin[j]
|
||||
// console.log(`thisVin: ${JSON.stringify(thisVin, null, 2)}`)
|
||||
|
||||
// Extract the script signature.
|
||||
const scriptSig = thisVin.scriptSig.asm.split(' ')
|
||||
// console.log(`scriptSig: ${JSON.stringify(scriptSig, null, 2)}`)
|
||||
|
||||
// Extract the public key from the script signature.
|
||||
const pubKey = scriptSig[scriptSig.length - 1]
|
||||
// console.log(`pubKey: ${pubKey}`)
|
||||
|
||||
// Generate cash address from public key.
|
||||
const keyBuf = Buffer.from(pubKey, 'hex')
|
||||
const ec = _this.bchjs.ECPair.fromPublicKey(keyBuf)
|
||||
const cashAddr2 = _this.bchjs.ECPair.toCashAddress(ec)
|
||||
// console.log(`cashAddr2: ${cashAddr2}`)
|
||||
|
||||
// If public keys match, this is the correct public key.
|
||||
if (cashAddr === cashAddr2) {
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: true,
|
||||
publicKey: pubKey
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json({
|
||||
success: false,
|
||||
publicKey: 'not found'
|
||||
})
|
||||
} catch (err) {
|
||||
wlogger.error('Error in encryption.js/getPublicKey().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Encryption
|
||||
@@ -0,0 +1,942 @@
|
||||
/*
|
||||
A library for interacting with the Full Node
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
|
||||
const axios = require('axios')
|
||||
const wlogger = require('../../../util/winston-logging')
|
||||
|
||||
const RouteUtils = require('../../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
// Used to convert error messages to strings, to safely pass to users.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
let _this
|
||||
|
||||
class Blockchain {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
this.bchjs = bchjs
|
||||
this.axios = axios
|
||||
this.routeUtils = routeUtils
|
||||
|
||||
this.router = router
|
||||
this.router.get('/', this.root)
|
||||
this.router.get('/getBestBlockHash', this.getBestBlockHash)
|
||||
this.router.get('/getBlockchainInfo', this.getBlockchainInfo)
|
||||
this.router.get('/getBlockCount', this.getBlockCount)
|
||||
this.router.get('/getBlockHeader/:hash', this.getBlockHeaderSingle)
|
||||
this.router.post('/getBlockHeader', this.getBlockHeaderBulk)
|
||||
this.router.get('/getChainTips', this.getChainTips)
|
||||
this.router.get('/getDifficulty', this.getDifficulty)
|
||||
this.router.get('/getMempoolEntry/:txid', this.getMempoolEntrySingle)
|
||||
this.router.post('/getMempoolEntry', this.getMempoolEntryBulk)
|
||||
this.router.get(
|
||||
'/getMempoolAncestors/:txid',
|
||||
this.getMempoolAncestorsSingle
|
||||
)
|
||||
this.router.get('/getMempoolInfo', this.getMempoolInfo)
|
||||
this.router.get('/getRawMempool', this.getRawMempool)
|
||||
this.router.get('/getTxOut/:txid/:n', this.getTxOut)
|
||||
this.router.post('/getTxOut', this.getTxOutPost)
|
||||
this.router.get('/getTxOutProof/:txid', this.getTxOutProofSingle)
|
||||
this.router.post('/getTxOutProof', this.getTxOutProofBulk)
|
||||
this.router.get('/verifyTxOutProof/:proof', this.verifyTxOutProofSingle)
|
||||
this.router.post('/verifyTxOutProof', this.verifyTxOutProofBulk)
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'blockchain' })
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getBestBlockHash Get best block hash
|
||||
* @apiName GetBestBlockHash
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the hash of the best (tip) block in the longest
|
||||
* block chain.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBestBlockHash" -H "accept: application/json"
|
||||
*
|
||||
* @apiSuccess {String} bestBlockHash 000000000000000002bc884334336d99c9a9c616670a9244c6a8c1fc35aa91a1
|
||||
*/
|
||||
async getBestBlockHash (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
options.data.id = 'getbestblockhash'
|
||||
options.data.method = 'getbestblockhash'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in blockchain.ts/getBestBlockHash().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getBlockchainInfo Get blockchain info
|
||||
* @apiName GetBlockchainInfo
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns an object containing various state info regarding blockchain processing.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockchainInfo" -H "accept: application/json"
|
||||
*
|
||||
* @apiSuccess {Object} object Object containing data
|
||||
* @apiSuccess {String} object.chain "main"
|
||||
* @apiSuccess {Number} object.blocks 561838
|
||||
* @apiSuccess {Number} object.headers 561838
|
||||
* @apiSuccess {String} object.bestblockhash "000000000000000002307dd38cd01c7308b8febfcdf5772cf087b5bb023d55bc"
|
||||
* @apiSuccess {Number} object.difficulty 246585566638.1496
|
||||
* @apiSuccess {String} object.mediantime 1545402693
|
||||
* @apiSuccess {Number} object.verificationprogress 0.999998831622689
|
||||
* @apiSuccess {Boolean} object.chainwork "000000000000000000000000000000000000000000d8c09a8ab7262080266b3e"
|
||||
* @apiSuccess {Number} object.pruned false
|
||||
* @apiSuccess {Array} object.softforks Array of objects
|
||||
* @apiSuccess {String} object.softforks.id "bip34"
|
||||
* @apiSuccess {String} object.softforks.version 2
|
||||
* @apiSuccess {Object} object.softforks.reject
|
||||
* @apiSuccess {String} object.softforks.reject.status true
|
||||
*/
|
||||
async getBlockchainInfo (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
options.data.id = 'getblockchaininfo'
|
||||
options.data.method = 'getblockchaininfo'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in blockchain.ts/getBlockchainInfo().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getBlockCount Get Block Count
|
||||
* @apiName GetBlockCount
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the number of blocks in the longest blockchain.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockCount" -H "accept: application/json"
|
||||
*
|
||||
* @apiSuccess {Number} bestBlockCount 587665
|
||||
*/
|
||||
async getBlockCount (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
options.data.id = 'getblockcount'
|
||||
options.data.method = 'getblockcount'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getBlockCount().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getBlockHeader/:hash Get single block header
|
||||
* @apiName GetSingleBlockHeader
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription If verbose is false (default), returns a string that is
|
||||
* serialized, hex-encoded data for blockheader 'hash'. If verbose is true,
|
||||
* returns an Object with information about blockheader hash.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockHeader/000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201?verbose=true" -H "accept: application/json"
|
||||
*
|
||||
* @apiParam {String} hash block hash
|
||||
* @apiParam {Boolean} verbose Return verbose data
|
||||
*
|
||||
* @apiSuccess {Object} object Object containing data
|
||||
* @apiSuccess {String} object.hash "000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201"
|
||||
* @apiSuccess {Number} object.confirmations 61839
|
||||
* @apiSuccess {Number} object.height 500000
|
||||
* @apiSuccess {Number} object.version 536870912
|
||||
* @apiSuccess {String} object.versionHex "20000000"
|
||||
* @apiSuccess {String} object.merkleroot "4af279645e1b337e655ae3286fc2ca09f58eb01efa6ab27adedd1e9e6ec19091"
|
||||
* @apiSuccess {Number} object.time 1509343584
|
||||
* @apiSuccess {Number} object.mediantime 1509336533
|
||||
* @apiSuccess {Number} object.nonce 3604508752
|
||||
* @apiSuccess {String} object.bits "1809b91a"
|
||||
* @apiSuccess {Number} object.difficulty 113081236211.4533
|
||||
* @apiSuccess {String} object.chainwork "0000000000000000000000000000000000000000007ae48aca46e3b449ad9714"
|
||||
* @apiSuccess {String} object.previousblockhash "0000000000000000043831d6ebb013716f0580287ee5e5687e27d0ed72e6e523"
|
||||
* @apiSuccess {String} object.nextblockhash "00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3"
|
||||
*/
|
||||
async getBlockHeaderSingle (req, res, next) {
|
||||
try {
|
||||
let verbose = false
|
||||
if (req.query.verbose && req.query.verbose.toString() === 'true') {
|
||||
verbose = true
|
||||
}
|
||||
|
||||
const hash = req.params.hash
|
||||
if (!hash || hash === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hash can not be empty' })
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
options.data.id = 'getblockheader'
|
||||
options.data.method = 'getblockheader'
|
||||
options.data.params = [hash, verbose]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getBlockHeaderSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockchain/getBlockHeader Get multiple block headers
|
||||
* @apiName GetBulkBlockHeader
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription If verbose is false (default), returns a string that is
|
||||
* serialized, hex-encoded data for blockheader 'hash'. If verbose is true,
|
||||
* returns an Object with information about blockheader hash.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/blockchain/getBlockHeader" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"hashes\":[\"000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201\",\"00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3\"],\"verbose\":true}"
|
||||
*
|
||||
* @apiParam {String} hash block hash
|
||||
* @apiParam {Boolean} verbose Return verbose data
|
||||
*
|
||||
* @apiSuccess {Array} array array containing objects
|
||||
* @apiSuccess {String} object.hash "000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201"
|
||||
* @apiSuccess {Number} object.confirmations 61839
|
||||
* @apiSuccess {Number} object.height 500000
|
||||
* @apiSuccess {Number} object.version 536870912
|
||||
* @apiSuccess {String} object.versionHex "20000000"
|
||||
* @apiSuccess {String} object.merkleroot "4af279645e1b337e655ae3286fc2ca09f58eb01efa6ab27adedd1e9e6ec19091"
|
||||
* @apiSuccess {Number} object.time 1509343584
|
||||
* @apiSuccess {Number} object.mediantime 1509336533
|
||||
* @apiSuccess {Number} object.nonce 3604508752
|
||||
* @apiSuccess {String} object.bits "1809b91a"
|
||||
* @apiSuccess {Number} object.difficulty 113081236211.4533
|
||||
* @apiSuccess {String} object.chainwork "0000000000000000000000000000000000000000007ae48aca46e3b449ad9714"
|
||||
* @apiSuccess {String} object.previousblockhash "0000000000000000043831d6ebb013716f0580287ee5e5687e27d0ed72e6e523"
|
||||
* @apiSuccess {String} object.nextblockhash "00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3"
|
||||
*/
|
||||
async getBlockHeaderBulk (req, res, next) {
|
||||
try {
|
||||
const hashes = req.body.hashes
|
||||
const verbose = req.body.verbose ? req.body.verbose : false
|
||||
|
||||
if (!Array.isArray(hashes)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'hashes needs to be an array. Use GET for single hash.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!routeUtils.validateArraySize(req, hashes)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockchain/getBlockHeaderBulk with these hashes: ',
|
||||
hashes
|
||||
)
|
||||
|
||||
// Validate each hash in the array.
|
||||
for (let i = 0; i < hashes.length; i++) {
|
||||
const hash = hashes[i]
|
||||
|
||||
if (hash.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({ error: `This is not a hash: ${hash}` })
|
||||
}
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Loop through each hash and creates an array of requests to call in parallel
|
||||
const promises = hashes.map(async (hash) => {
|
||||
options.data.id = 'getblockheader'
|
||||
options.data.method = 'getblockheader'
|
||||
options.data.params = [hash, verbose]
|
||||
|
||||
return _this.axios.request(options)
|
||||
})
|
||||
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
// Extract the data component from the axios response.
|
||||
const result = axiosResult.map((x) => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getBlockHeaderBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getChainTips Get Chain Tips
|
||||
* @apiName getChainTips
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Return information about all known tips in the block tree,
|
||||
* including the main chain as well as orphaned branches.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getChainTips" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getChainTips (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getchaintips'
|
||||
options.data.method = 'getchaintips'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getChainTips().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getDifficulty Get difficulty
|
||||
* @apiName getDifficulty
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Get the current difficulty value, used to regulate mining
|
||||
* power on the network.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getDifficulty" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getDifficulty (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getdifficulty'
|
||||
options.data.method = 'getdifficulty'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getDifficulty().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getMempoolEntry/:txid Get single mempool entry
|
||||
* @apiName getMempoolEntry
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool data for given transaction. TXID must be in
|
||||
* mempool (unconfirmed)
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolEntry/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getMempoolEntrySingle (req, res, next) {
|
||||
try {
|
||||
// Validate input parameter
|
||||
const txid = req.params.txid
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getmempoolentry'
|
||||
options.data.method = 'getmempoolentry'
|
||||
options.data.params = [txid]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getMempoolEntrySingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockchain/getMempoolEntry Get bulk mempool entry
|
||||
* @apiName getMempoolEntryBulk
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool data for multiple transactions
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST https://api.fullstack.cash/v3/blockchain/getMempoolEntry -H "Content-Type: application/json" -d "{\"txids\":[\"a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1\",\"5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e\"]}"
|
||||
*/
|
||||
async getMempoolEntryBulk (req, res, next) {
|
||||
try {
|
||||
const txids = req.body.txids
|
||||
|
||||
if (!Array.isArray(txids)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'txids needs to be an array. Use GET for single txid.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!routeUtils.validateArraySize(req, txids)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockchain/getMempoolEntry with these txids: ',
|
||||
txids
|
||||
)
|
||||
|
||||
// Validate each element in the array
|
||||
for (let i = 0; i < txids.length; i++) {
|
||||
const txid = txids[i]
|
||||
|
||||
if (txid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({ error: 'This is not a txid' })
|
||||
}
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Loop through each txid and creates an array of requests to call in parallel
|
||||
const promises = txids.map(async (txid) => {
|
||||
options.data.id = 'getmempoolentry'
|
||||
options.data.method = 'getmempoolentry'
|
||||
options.data.params = [txid]
|
||||
|
||||
return _this.axios.request(options)
|
||||
})
|
||||
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
// Extract the data component from the axios response.
|
||||
const result = axiosResult.map((x) => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getMempoolEntryBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getMempoolAncestors/:txid Get Mempool Ancestors
|
||||
* @apiName getMempoolAncestors
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool ancestors data for given TXID. It must be in
|
||||
* mempool (unconfirmed). This call is handy to tell if a UTXO is bumping up
|
||||
* against the 25 ancestor chain-limit.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolAncestors/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getMempoolAncestorsSingle (req, res, next) {
|
||||
try {
|
||||
// Validate input parameter
|
||||
const txid = req.params.txid
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
let verbose = req.params.verbose
|
||||
if (verbose === undefined) verbose = false
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getmempoolancestors'
|
||||
options.data.method = 'getmempoolancestors'
|
||||
options.data.params = [txid, verbose]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
// console.log(`response: ${util.inspect(response)}`)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getMempoolAncestorsSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getMempoolInfo Get mempool info
|
||||
* @apiName getMempoolInfo
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details on the active state of the TX memory pool.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getMempoolInfo (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getmempoolinfo'
|
||||
options.data.method = 'getmempoolinfo'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getMempoolInfo().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getRawMempool Get mempool info
|
||||
* @apiName getMempoolInfo
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details on the active state of the TX memory pool.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getRawMempool/?verbose= Get raw mempool
|
||||
* @apiName getRawMempool
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns all transaction ids in memory pool as a json array
|
||||
* of string transaction ids.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/getRawMempool/?verbose=true" -H "accept: application/json"
|
||||
*
|
||||
* @apiParam {Boolean} verbose Return verbose data
|
||||
*
|
||||
*/
|
||||
async getRawMempool (req, res, next) {
|
||||
try {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
let verbose = false
|
||||
if (req.query.verbose && req.query.verbose === 'true') verbose = true
|
||||
|
||||
options.data.id = 'getrawmempool'
|
||||
options.data.method = 'getrawmempool'
|
||||
options.data.params = [verbose]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getRawMempool().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getTxOut/:txid/:n?mempool= Get Tx Out
|
||||
* @apiName getTxOut
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details about an unspent transaction output.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOut/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33/0?mempool=false" -H "accept: application/json"
|
||||
*
|
||||
* @apiParam {String} txid Transaction id (required)
|
||||
* @apiParam {Number} n Output number (required)
|
||||
* @apiParam {Boolean} mempool Check mempool or not (optional)
|
||||
*
|
||||
*/
|
||||
// Returns details about an unspent transaction output.
|
||||
async getTxOut (req, res, next) {
|
||||
try {
|
||||
// Validate input parameter
|
||||
const txid = req.params.txid
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
let n = req.params.n
|
||||
if (n === undefined || n === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'n can not be empty' })
|
||||
}
|
||||
n = parseInt(n)
|
||||
|
||||
let includeMempool = false
|
||||
if (req.query.includeMempool && req.query.includeMempool === 'true') {
|
||||
includeMempool = true
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'gettxout'
|
||||
options.data.method = 'gettxout'
|
||||
options.data.params = [txid, n, includeMempool]
|
||||
|
||||
// console.log(`requestConfig: ${JSON.stringify(requestConfig, null, 2)}`)
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getTxOut().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /blockchain/getTxOut Validate a UTXO
|
||||
* @apiName getTxOut
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details about an unspent transaction output (UTXO).
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl "https://api.fullstack.cash/v3/blockchain/getTxOut/" -X POST -H "Content-Type: application/json" --data-binary '{"txid":"d5228d2cdc77fbe5a9aa79f19b0933b6802f9f0067f42847fc4fe343664723e5","vout":0,"mempool":true}'
|
||||
*
|
||||
* @apiParam {String} txid Transaction id (required)
|
||||
* @apiParam {Number} vout of transaction (required)
|
||||
* @apiParam {Boolean} mempool Check mempool or not (optional)
|
||||
*
|
||||
*/
|
||||
// Returns details about an unspent transaction output.
|
||||
async getTxOutPost (req, res, next) {
|
||||
try {
|
||||
const txid = req.body.txid
|
||||
let n = req.body.vout
|
||||
const mempool = req.body.mempool ? req.body.mempool : true
|
||||
|
||||
// Validate input parameter
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
if (n === undefined || n === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'vout can not be empty' })
|
||||
}
|
||||
n = parseInt(n)
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'gettxout'
|
||||
options.data.method = 'gettxout'
|
||||
options.data.params = [txid, n, mempool]
|
||||
|
||||
// console.log(`requestConfig: ${JSON.stringify(requestConfig, null, 2)}`)
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getTxOutPost().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /blockchain/getTxOutProofSingle/:txid Get Tx Out Proof
|
||||
* @apiName getTxOutProofSingle
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns a hex-encoded proof that 'txid' was included in a block.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOutProofSingle/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||
*
|
||||
* @apiParam {String} txid Transaction id (required)
|
||||
*
|
||||
*/
|
||||
async getTxOutProofSingle (req, res, next) {
|
||||
try {
|
||||
// Validate input parameter
|
||||
const txid = req.params.txid
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'gettxoutproof'
|
||||
options.data.method = 'gettxoutproof'
|
||||
options.data.params = [[txid]]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getTxOutProofSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a hex-encoded proof that 'txid' was included in a block.
|
||||
async getTxOutProofBulk (req, res, next) {
|
||||
try {
|
||||
const txids = req.body.txids
|
||||
|
||||
// Reject if txids is not an array.
|
||||
if (!Array.isArray(txids)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'txids needs to be an array. Use GET for single txid.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!routeUtils.validateArraySize(req, txids)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Validate each element in the array.
|
||||
for (let i = 0; i < txids.length; i++) {
|
||||
const txid = txids[i]
|
||||
|
||||
if (txid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `Invalid txid. Double check your txid is valid: ${txid}`
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockchain/getTxOutProof with these txids: ',
|
||||
txids
|
||||
)
|
||||
|
||||
// Loop through each txid and creates an array of requests to call in parallel
|
||||
const promises = txids.map(async (txid) => {
|
||||
options.data.id = 'gettxoutproof'
|
||||
options.data.method = 'gettxoutproof'
|
||||
options.data.params = [[txid]]
|
||||
|
||||
return _this.axios.request(options)
|
||||
})
|
||||
|
||||
// Wait for all parallel promisses to resolve.
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
// Extract the data component from the axios response.
|
||||
const result = axiosResult.map((x) => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/getTxOutProofBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
async verifyTxOutProofSingle (req, res, next) {
|
||||
try {
|
||||
// Validate input parameter
|
||||
const proof = req.params.proof
|
||||
if (!proof || proof === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'proof can not be empty' })
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'verifytxoutproof'
|
||||
options.data.method = 'verifytxoutproof'
|
||||
options.data.params = [req.params.proof]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/verifyTxOutProofSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
async verifyTxOutProofBulk (req, res, next) {
|
||||
try {
|
||||
const proofs = req.body.proofs
|
||||
|
||||
// Reject if proofs is not an array.
|
||||
if (!Array.isArray(proofs)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'proofs needs to be an array. Use GET for single proof.'
|
||||
})
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!routeUtils.validateArraySize(req, proofs)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Validate each element in the array.
|
||||
for (let i = 0; i < proofs.length; i++) {
|
||||
const proof = proofs[i]
|
||||
|
||||
if (!proof || proof === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: `proof can not be empty: ${proof}` })
|
||||
}
|
||||
}
|
||||
|
||||
wlogger.debug(
|
||||
'Executing blockchain/verifyTxOutProof with these proofs: ',
|
||||
proofs
|
||||
)
|
||||
|
||||
// Loop through each proof and creates an array of requests to call in parallel
|
||||
const promises = proofs.map(async (proof) => {
|
||||
options.data.id = 'verifytxoutproof'
|
||||
options.data.method = 'verifytxoutproof'
|
||||
options.data.params = [proof]
|
||||
|
||||
return _this.axios.request(options)
|
||||
})
|
||||
|
||||
// Wait for all parallel promisses to resolve.
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
// Extract the data component from the axios response.
|
||||
const result = axiosResult.map((x) => x.data.result[0])
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error('Error in blockchain.ts/verifyTxOutProofBulk().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Blockchain
|
||||
@@ -0,0 +1,116 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
|
||||
const axios = require('axios')
|
||||
|
||||
// const routeUtils = require('../route-utils')
|
||||
const wlogger = require('../../../util/winston-logging')
|
||||
|
||||
const RouteUtils = require('../../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
// Used for processing error messages before sending them to the user.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
let _this
|
||||
|
||||
class Control {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
|
||||
_this.router = router
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/getNetworkInfo', _this.getNetworkInfo)
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'control' })
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /control/getnetworkinfo Get Network Info
|
||||
* @apiName GetNetworkInfo
|
||||
* @apiGroup Control
|
||||
* @apiDescription RPC call which gets basic full node information.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/control/getnetworkinfo" -H "accept: application/json"
|
||||
*
|
||||
*/
|
||||
async getNetworkInfo (req, res, next) {
|
||||
// Axios options
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getnetworkinfo'
|
||||
options.data.method = 'getnetworkinfo'
|
||||
options.data.params = []
|
||||
|
||||
try {
|
||||
// const response = await BitboxHTTP(requestConfig)
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (error) {
|
||||
wlogger.error('Error in control.ts/getNetworkInfo().', error)
|
||||
|
||||
return _this.errorHandler(error, res)
|
||||
}
|
||||
}
|
||||
// router.get('/getMemoryInfo', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getmemoryinfo",
|
||||
// method: "getmemoryinfo"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/help', (req, res, next) => {
|
||||
// BITBOX.Control.help()
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.post('/stop', (req, res, next) => {
|
||||
// BITBOX.Control.stop()
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
}
|
||||
|
||||
module.exports = Control
|
||||
@@ -0,0 +1,169 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
const axios = require('axios')
|
||||
|
||||
const RouteUtils = require('../../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const wlogger = require('../../../util/winston-logging')
|
||||
|
||||
// Used to convert error messages to strings, to safely pass to users.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
let _this
|
||||
|
||||
class Mining {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
_this.axios = axios
|
||||
_this.routeUtils = routeUtils
|
||||
|
||||
_this.router = router
|
||||
_this.router.get('/', _this.root)
|
||||
_this.router.get('/getMiningInfo', _this.getMiningInfo)
|
||||
_this.router.get('/getNetworkHashPS', _this.getNetworkHashPS)
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'mining' })
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
// router.get('/getBlockTemplate/:templateRequest', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getblocktemplate",
|
||||
// method: "getblocktemplate",
|
||||
// params: [
|
||||
// req.params.templateRequest
|
||||
// ]
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
|
||||
/**
|
||||
* @api {get} /mining/getMiningInfo Get Mining Info.
|
||||
* @apiName Mining info.
|
||||
* @apiGroup Mining
|
||||
* @apiDescription Returns a json object containing mining-related information.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/mining/getMiningInfo" -H "accept: application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
async getMiningInfo (req, res, next) {
|
||||
try {
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getmininginfo'
|
||||
options.data.method = 'getmininginfo'
|
||||
options.data.params = []
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in mining.ts/getMiningInfo().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /mining/getNetworkHashps?nblocks=&height= Get Estimated network hashes per second.
|
||||
* @apiName Estimated network hashes per second.
|
||||
* @apiGroup Mining
|
||||
* @apiDescription Returns the estimated network hashes per second based on the last n blocks. Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change. Pass in [height] to estimate the network speed at the time when a certain block was found.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/mining/getNetworkHashps?nblocks=120&height=-1" -H "accept: application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
async getNetworkHashPS (req, res, next) {
|
||||
try {
|
||||
let nblocks = 120 // Default
|
||||
let height = -1 // Default
|
||||
if (req.query.nblocks) nblocks = parseInt(req.query.nblocks)
|
||||
if (req.query.height) height = parseInt(req.query.height)
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getnetworkhashps'
|
||||
options.data.method = 'getnetworkhashps'
|
||||
options.data.params = [nblocks, height]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
wlogger.error('Error in mining.ts/getNetworkHashPS().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// router.post('/submitBlock/:hex', (req, res, next) => {
|
||||
// let parameters = '';
|
||||
// if(req.query.parameters && req.query.parameters !== '') {
|
||||
// parameters = true;
|
||||
// }
|
||||
//
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"submitblock",
|
||||
// method: "submitblock",
|
||||
// params: [
|
||||
// req.params.hex,
|
||||
// parameters
|
||||
// ]
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
}
|
||||
|
||||
module.exports = Mining
|
||||
@@ -0,0 +1,168 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
|
||||
router.get('/', async (req, res, next) => {
|
||||
res.json({ status: 'network' })
|
||||
})
|
||||
|
||||
// router.post('/addNode/:node/:command', (req, res, next) => {
|
||||
// BITBOX.Network.addNode(req.params.node, req.params.command)
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.post('/clearBanned', (req, res, next) => {
|
||||
// BITBOX.Network.clearBanned()
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.post('/disconnectNode/:address/:nodeid', (req, res, next) => {
|
||||
// BITBOX.Network.disconnectNode(req.params.address, req.params.nodeid)
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/getAddedNodeInfo/:node', (req, res, next) => {
|
||||
// BITBOX.Network.getAddedNodeInfo(req.params.node)
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/getConnectionCount', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getconnectioncount",
|
||||
// method: "getconnectioncount"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/getNetTotals', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getnettotals",
|
||||
// method: "getnettotals"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/getNetworkInfo', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getnetworkinfo",
|
||||
// method: "getnetworkinfo"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/getPeerInfo', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"getpeerinfo",
|
||||
// method: "getpeerinfo"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(response.data.result);
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.get('/ping', (req, res, next) => {
|
||||
// BitboxHTTP({
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: "1.0",
|
||||
// id:"ping",
|
||||
// method: "ping"
|
||||
// }
|
||||
// })
|
||||
// .then((response) => {
|
||||
// res.json(JSON.stringify(response.data.result));
|
||||
// })
|
||||
// .catch((error) => {
|
||||
// res.send(error.response.data.error.message);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.post('/setBan/:subnet/:command', (req, res, next) => {
|
||||
// // TODO finish this
|
||||
// BITBOX.Network.getConnectionCount(req.params.subnet, req.params.command)
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
//
|
||||
// router.post('/setNetworkActive/:state', (req, res, next) => {
|
||||
// let state = true;
|
||||
// if(req.params.state && req.params.state === 'false') {
|
||||
// state = false;
|
||||
// }
|
||||
// BITBOX.Network.getConnectionCount(state)
|
||||
// .then((result) => {
|
||||
// res.json(result);
|
||||
// }, (err) => { console.log(err);
|
||||
// });
|
||||
// });
|
||||
|
||||
module.exports = router
|
||||
@@ -0,0 +1,570 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
const axios = require('axios')
|
||||
|
||||
const RouteUtils = require('../../../util/route-utils')
|
||||
const routeUtils = new RouteUtils()
|
||||
|
||||
const wlogger = require('../../../util/winston-logging')
|
||||
|
||||
// Used to convert error messages to strings, to safely pass to users.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
let _this
|
||||
class RawTransactions {
|
||||
constructor () {
|
||||
_this = this
|
||||
|
||||
// Encapsulate external dependencies.
|
||||
this.axios = axios
|
||||
this.routeUtils = routeUtils
|
||||
|
||||
// Define Express routes.
|
||||
this.router = router
|
||||
this.router.get('/', this.root)
|
||||
this.router.get(
|
||||
'/decodeRawTransaction/:hex',
|
||||
this.decodeRawTransactionSingle
|
||||
)
|
||||
this.router.post('/decodeRawTransaction', this.decodeRawTransactionBulk)
|
||||
this.router.get('/decodeScript/:hex', this.decodeScriptSingle)
|
||||
this.router.post('/decodeScript', this.decodeScriptBulk)
|
||||
this.router.post('/getRawTransaction', this.getRawTransactionBulk)
|
||||
this.router.get('/getRawTransaction/:txid', this.getRawTransactionSingle)
|
||||
this.router.post('/sendRawTransaction', this.sendRawTransactionBulk)
|
||||
this.router.get('/sendRawTransaction/:hex', this.sendRawTransactionSingle)
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'rawtransactions' })
|
||||
}
|
||||
|
||||
// DRY error handler.
|
||||
errorHandler (err, res) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
|
||||
// Decode transaction hex into a JSON object.
|
||||
// GET
|
||||
/**
|
||||
* @api {get} /rawtransactions/decodeRawTransaction/{hex} Decode Single Raw Transaction.
|
||||
* @apiName Decode Single Raw Transaction
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Return a JSON object representing the serialized, hex-encoded transaction.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
|
||||
*/
|
||||
async decodeRawTransactionSingle (req, res, next) {
|
||||
try {
|
||||
const hex = req.params.hex
|
||||
|
||||
// Throw an error if hex is empty.
|
||||
if (!hex || hex === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hex can not be empty' })
|
||||
}
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'decoderawtransaction'
|
||||
options.data.method = 'decoderawtransaction'
|
||||
options.data.params = [hex]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeRawTransaction: `, err)
|
||||
wlogger.error(
|
||||
'Error in rawtransactions.ts/decodeRawTransactionSingle().',
|
||||
err
|
||||
)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /rawtransactions/decodeRawTransaction Decode Bulk Raw Transactions.
|
||||
* @apiName Decode Bulk Raw Transactions
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Return bulk hex encoded transaction.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/rawtransactions/decodeRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
async decodeRawTransactionBulk (req, res, next) {
|
||||
try {
|
||||
const hexes = req.body.hexes
|
||||
|
||||
if (!Array.isArray(hexes)) {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hexes must be an array' })
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// const results = []
|
||||
|
||||
// Validate each element in the address array.
|
||||
for (let i = 0; i < hexes.length; i++) {
|
||||
const thisHex = hexes[i]
|
||||
|
||||
// Reject if id is empty
|
||||
if (!thisHex || thisHex === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'Encountered empty hex' })
|
||||
}
|
||||
}
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Loop through each height and creates an array of requests to call in parallel
|
||||
const promises = hexes.map(async hex => {
|
||||
options.data.id = 'decoderawtransaction'
|
||||
options.data.method = 'decoderawtransaction'
|
||||
options.data.params = [hex]
|
||||
|
||||
return _this.axios.request(options)
|
||||
})
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
// Retrieve the data part of the result.
|
||||
const result = axiosResult.map(x => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/getRawTransaction: `, err)
|
||||
wlogger.error(
|
||||
'Error in rawtransactions.ts/decodeRawTransactionBulk().',
|
||||
err
|
||||
)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Decode a raw transaction from hex to assembly.
|
||||
// GET single
|
||||
/**
|
||||
* @api {get} /rawtransactions/decodeScript/{hex} Decode Single Script.
|
||||
* @apiName Decode Single Script
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Decode a hex-encoded script.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
async decodeScriptSingle (req, res, next) {
|
||||
try {
|
||||
const hex = req.params.hex
|
||||
|
||||
// Throw an error if hex is empty.
|
||||
if (!hex || hex === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hex can not be empty' })
|
||||
}
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'decodescript'
|
||||
options.data.method = 'decodescript'
|
||||
options.data.params = [hex]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeScript: `, err)
|
||||
wlogger.error('Error in rawtransactions.ts/decodeScriptSingle().', err)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Decode a raw transaction from hex to assembly.
|
||||
// POST bulk
|
||||
/**
|
||||
* @api {post} /rawtransactions/decodeScript Bulk Decode Script.
|
||||
* @apiName Bulk Decode Script
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Decode multiple hex-encoded scripts.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
*curl -X POST "https://api.fullstack.cash/v3/rawtransactions/decodeScript" -H "accept:" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
async decodeScriptBulk (req, res, next) {
|
||||
try {
|
||||
const hexes = req.body.hexes
|
||||
|
||||
// Validation
|
||||
if (!Array.isArray(hexes)) {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hexes must be an array' })
|
||||
}
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// Validate each hex in the array
|
||||
for (let i = 0; i < hexes.length; i++) {
|
||||
const hex = hexes[i]
|
||||
|
||||
// Throw an error if hex is empty.
|
||||
if (!hex || hex === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'Encountered empty hex' })
|
||||
}
|
||||
}
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Loop through each hex and create an array of promises
|
||||
const promises = hexes.map(async hex => {
|
||||
options.data.id = 'decodescript'
|
||||
options.data.method = 'decodescript'
|
||||
options.data.params = [hex]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
return response
|
||||
})
|
||||
|
||||
// Wait for all parallel promises to return.
|
||||
const resolved = await Promise.all(promises)
|
||||
|
||||
// Retrieve the data from each resolved promise.
|
||||
const result = resolved.map(x => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/decodeScript: `, err)
|
||||
wlogger.error('Error in rawtransactions.ts/decodeScriptBulk().', err)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Retrieve raw transactions details from the full node.
|
||||
|
||||
async getRawTransactionsFromNode (txid, verbose) {
|
||||
try {
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
options.data.id = 'getrawtransaction'
|
||||
options.data.method = 'getrawtransaction'
|
||||
options.data.params = [txid, verbose]
|
||||
|
||||
const response = await _this.axios.request(options)
|
||||
|
||||
return response.data.result
|
||||
} catch (err) {
|
||||
wlogger.error('Error in rawtransactions.ts/getRawTransactionsFromNode().')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
// Get a JSON object breakdown of transaction details.
|
||||
// POST
|
||||
/**
|
||||
* @api {post} /rawtransactions/getRawTransaction Get Bulk Raw Transactions.
|
||||
* @apiName Get Bulk Raw Transactions.
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Return the raw transaction data for multiple transactions. If verbose is 'true', returns an Object with information about 'txid'. If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/rawtransactions/getRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1","5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e"],"verbose":true}'
|
||||
*
|
||||
*/
|
||||
async getRawTransactionBulk (req, res, next) {
|
||||
try {
|
||||
let verbose = 0
|
||||
if (req.body.verbose) verbose = 1
|
||||
|
||||
const txids = req.body.txids
|
||||
if (!Array.isArray(txids)) {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txids must be an array' })
|
||||
}
|
||||
|
||||
// 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({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// stub response object
|
||||
// const returnResponse = {
|
||||
// status: 100,
|
||||
// json: {
|
||||
// error: ''
|
||||
// }
|
||||
// }
|
||||
|
||||
// Validate each txid in the array.
|
||||
for (let i = 0; i < txids.length; i++) {
|
||||
const txid = txids[i]
|
||||
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'Encountered empty TXID' })
|
||||
}
|
||||
|
||||
if (txid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `parameter 1 must be of length 64 (not ${txid.length})`
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Loop through each txid and create an array of promises
|
||||
const promises = txids.map(async txid =>
|
||||
_this.getRawTransactionsFromNode(txid, verbose)
|
||||
)
|
||||
|
||||
// Wait for all parallel promises to return.
|
||||
const axiosResult = await _this.axios.all(promises)
|
||||
|
||||
res.status(200)
|
||||
return res.json(axiosResult)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/getRawTransaction: `, err)
|
||||
wlogger.error('Error in rawtransactions.ts/getRawTransactionBulk().', err)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Get a JSON object breakdown of transaction details.
|
||||
// GET
|
||||
/**
|
||||
* @api {get} /rawtransactions/getRawTransaction/{txid} Return the raw transaction data.
|
||||
* @apiName Get Raw Transaction
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription return the raw transaction data. If verbose is 'true', returns an Object with information about 'txid'. If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
async getRawTransactionSingle (req, res, next) {
|
||||
try {
|
||||
let verbose = 0
|
||||
if (req.query.verbose === 'true') verbose = 1
|
||||
|
||||
const txid = req.params.txid
|
||||
if (!txid || txid === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'txid can not be empty' })
|
||||
}
|
||||
|
||||
if (txid.length !== 64) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: `parameter 1 must be of length 64 (not ${txid.length})`
|
||||
})
|
||||
}
|
||||
|
||||
const data = await _this.getRawTransactionsFromNode(txid, verbose)
|
||||
|
||||
return res.json(data)
|
||||
} catch (err) {
|
||||
// Write out error to error log.
|
||||
// logger.error(`Error in rawtransactions/getRawTransaction: `, err)
|
||||
wlogger.error(
|
||||
'Error in rawtransactions.ts/getRawTransactionSingle().',
|
||||
err
|
||||
)
|
||||
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Transmit a raw transaction to the BCH network.
|
||||
/**
|
||||
* @api {post} /rawtransactions/sendRawTransaction Send Bulk Raw Transactions.
|
||||
* @apiName Send Bulk Raw Transactions
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Submits multiple raw transaction (serialized, hex-encoded) to local node and network.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/rawtransactions/sendRawTransaction" -H "accept:application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
async sendRawTransactionBulk (req, res, next) {
|
||||
try {
|
||||
// Validation
|
||||
const hexes = req.body.hexes
|
||||
|
||||
// Reject if input is not an array
|
||||
if (!Array.isArray(hexes)) {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hex must be an array' })
|
||||
}
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// Enforce array size rate limits
|
||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// Validate each element
|
||||
for (let i = 0; i < hexes.length; i++) {
|
||||
const hex = hexes[i]
|
||||
|
||||
if (hex === '') {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'Encountered empty hex'
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Dev Note CT 1/31/2019:
|
||||
// Sending the 'sendrawtrnasaction' RPC call to a full node in parallel will
|
||||
// not work. Testing showed that the full node will return the same TXID for
|
||||
// different TX hexes. I believe this is by design, to prevent double spends.
|
||||
// In parallel, we are essentially asking the node to broadcast a new TX before
|
||||
// it's finished broadcast the previous one. Serial execution is required.
|
||||
|
||||
// How to send TX hexes in parallel the WRONG WAY:
|
||||
/*
|
||||
// Collect an array of promises.
|
||||
const promises = hexes.map(async (hex: any) => {
|
||||
requestConfig.data.id = "sendrawtransaction"
|
||||
requestConfig.data.method = "sendrawtransaction"
|
||||
requestConfig.data.params = [hex]
|
||||
return await BitboxHTTP(requestConfig)
|
||||
})
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const axiosResult: Array<any> = await axios.all(promises)
|
||||
// Retrieve the data part of the result.
|
||||
const result = axiosResult.map(x => x.data.result)
|
||||
*/
|
||||
|
||||
// Sending them serially.
|
||||
const result = []
|
||||
for (let i = 0; i < hexes.length; i++) {
|
||||
const hex = hexes[i]
|
||||
|
||||
options.data.id = 'sendrawtransaction'
|
||||
options.data.method = 'sendrawtransaction'
|
||||
options.data.params = [hex]
|
||||
|
||||
const rpcResult = await _this.axios.request(options)
|
||||
|
||||
result.push(rpcResult.data.result)
|
||||
}
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
wlogger.error(
|
||||
'Error in rawtransactions.ts/sendRawTransactionBulk().',
|
||||
err
|
||||
)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
// Transmit a raw transaction to the BCH network.
|
||||
/**
|
||||
* @api {get} /rawtransactions/sendRawTransaction/{hex} Send Single Raw Transaction.
|
||||
* @apiName Send Single Raw Transaction
|
||||
* @apiGroup Raw Transaction
|
||||
* @apiDescription Submits single raw transaction (serialized, hex-encoded) to local node and network.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: "
|
||||
*
|
||||
*
|
||||
*/
|
||||
async sendRawTransactionSingle (req, res, next) {
|
||||
try {
|
||||
const hex = req.params.hex // URL parameter
|
||||
|
||||
// Reject if input is not an array or a string
|
||||
if (typeof hex !== 'string') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'hex must be a string' })
|
||||
}
|
||||
|
||||
// Validation
|
||||
if (hex === '') {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'Encountered empty hex'
|
||||
})
|
||||
}
|
||||
|
||||
const options = _this.routeUtils.getAxiosOptions()
|
||||
|
||||
// RPC call
|
||||
options.data.id = 'sendrawtransaction'
|
||||
options.data.method = 'sendrawtransaction'
|
||||
options.data.params = [hex]
|
||||
|
||||
const rpcResult = await _this.axios.request(options)
|
||||
|
||||
const result = rpcResult.data.result
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
wlogger.error(
|
||||
'Error in rawtransactions.ts/sendRawTransactionSingle().',
|
||||
err
|
||||
)
|
||||
return _this.errorHandler(err, res)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = RawTransactions
|
||||
@@ -0,0 +1,16 @@
|
||||
/*
|
||||
This health-check API can be used to test the server for aliveness and
|
||||
readiness.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
|
||||
/* GET home page. */
|
||||
router.get('/', (req, res, next) => {
|
||||
res.json({ status: true })
|
||||
})
|
||||
|
||||
module.exports = router
|
||||
@@ -0,0 +1,32 @@
|
||||
/*
|
||||
A library for interacting with the Bitcoin.com ninsight (not Insight) indexer.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
// const axios = require('axios')
|
||||
// const routeUtils = require('./route-utils')
|
||||
// const wlogger = require('../../util/winston-logging')
|
||||
|
||||
const router = express.Router()
|
||||
|
||||
// const BCHJS = require('@chris.troutner/bch-js')
|
||||
// const bchjs = new BCHJS()
|
||||
|
||||
// let _this
|
||||
|
||||
class Ninsight {
|
||||
constructor () {
|
||||
// _this = this
|
||||
|
||||
this.router = router
|
||||
this.router.get('/', this.root)
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'ninsight' })
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Ninsight
|
||||
@@ -0,0 +1,183 @@
|
||||
/*
|
||||
A private library of utility functions used by several different routes.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const axios = require('axios')
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
module.exports = {
|
||||
validateNetwork, // Prevents a common user error
|
||||
setEnvVars, // Allows RPC variables to be set dynamically based on changing env vars.
|
||||
decodeError, // Extract and interpret error messages.
|
||||
validateArraySize, // Ensure the passed array meets rate limiting requirements.
|
||||
getAxiosOptions
|
||||
}
|
||||
|
||||
// This function expects the Request Express.js object and an array as input.
|
||||
// The array is then validated against freemium and pro-tier rate limiting
|
||||
// requirements. A boolean is returned to indicate if the array size if valid
|
||||
// or not.
|
||||
function validateArraySize (req, array) {
|
||||
const FREEMIUM_INPUT_SIZE = 20
|
||||
const PRO_INPUT_SIZE = 20
|
||||
|
||||
if (req.locals && req.locals.proLimit) {
|
||||
if (array.length <= PRO_INPUT_SIZE) return true
|
||||
} else if (array.length <= FREEMIUM_INPUT_SIZE) {
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// Returns true if user-provided cash address matches the correct network,
|
||||
// mainnet or testnet. If NETWORK env var is not defined, it returns false.
|
||||
// This prevent a common user-error issue that is easy to make: passing a
|
||||
// testnet address into rest.bitcoin.com or passing a mainnet address into
|
||||
// trest.bitcoin.com.
|
||||
function validateNetwork (addr) {
|
||||
try {
|
||||
const network = process.env.NETWORK
|
||||
|
||||
// Return false if NETWORK is not defined.
|
||||
if (!network || network === '') {
|
||||
console.log('Warning: NETWORK environment variable is not defined!')
|
||||
return false
|
||||
}
|
||||
|
||||
// Convert the user-provided address to a cashaddress, for easy detection
|
||||
// of the intended network.
|
||||
const cashAddr = bchjs.Address.toCashAddress(addr)
|
||||
|
||||
// Return true if the network and address both match testnet
|
||||
const addrIsTest = bchjs.Address.isTestnetAddress(cashAddr)
|
||||
if (network === 'testnet' && addrIsTest) return true
|
||||
|
||||
// Return true if the network and address both match mainnet
|
||||
const addrIsMain = bchjs.Address.isMainnetAddress(cashAddr)
|
||||
if (network === 'mainnet' && addrIsMain) return true
|
||||
|
||||
return false
|
||||
} catch (err) {
|
||||
wlogger.error('Error in validateNetwork()')
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// Dynamically set these based on env vars. Allows unit testing.
|
||||
function setEnvVars () {
|
||||
const BitboxHTTP = axios.create({
|
||||
baseURL: process.env.RPC_BASEURL,
|
||||
timeout: 15000
|
||||
})
|
||||
const username = process.env.RPC_USERNAME
|
||||
const password = process.env.RPC_PASSWORD
|
||||
|
||||
const requestConfig = {
|
||||
method: 'post',
|
||||
auth: {
|
||||
username: username,
|
||||
password: password
|
||||
},
|
||||
data: {
|
||||
jsonrpc: '1.0'
|
||||
}
|
||||
}
|
||||
|
||||
return { BitboxHTTP, username, password, requestConfig }
|
||||
}
|
||||
|
||||
// Axios options used when calling axios.post() to talk with a full node.
|
||||
function getAxiosOptions () {
|
||||
return {
|
||||
method: 'post',
|
||||
baseURL: process.env.RPC_BASEURL,
|
||||
timeout: 15000,
|
||||
auth: {
|
||||
username: process.env.RPC_USERNAME,
|
||||
password: process.env.RPC_PASSWORD
|
||||
},
|
||||
data: {
|
||||
jsonrpc: '1.0'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Error messages returned by a full node can be burried pretty deep inside the
|
||||
// error object returned by Axios. This function attempts to extract and interpret
|
||||
// error messages.
|
||||
// Returns an object. If successful, obj.msg is a string.
|
||||
// If there is a failure, obj.msg is false.
|
||||
function decodeError (err) {
|
||||
try {
|
||||
// Attempt to extract the full node error message.
|
||||
if (
|
||||
err.response &&
|
||||
err.response.data &&
|
||||
err.response.data.error &&
|
||||
err.response.data.error.message
|
||||
) {
|
||||
return { msg: err.response.data.error.message, status: 400 }
|
||||
}
|
||||
|
||||
// Attempt to extract the Insight error message
|
||||
if (err.response && err.response.data) {
|
||||
return { msg: err.response.data, status: err.response.status }
|
||||
}
|
||||
|
||||
// console.log(`err.message: ${err.message}`)
|
||||
// console.log(`err: `, err)
|
||||
|
||||
// Attempt to detect a network connection error.
|
||||
if (err.message && err.message.indexOf('ENOTFOUND') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Different kind of network error
|
||||
if (err.message && err.message.indexOf('ENETUNREACH') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Different kind of network error
|
||||
if (err.message && err.message.indexOf('EAI_AGAIN') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Axios timeout (aborted) error, or service is down (connection refused).
|
||||
if (
|
||||
err.code &&
|
||||
(err.code === 'ECONNABORTED' || err.code === 'ECONNREFUSED')
|
||||
) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
return { msg: false, status: 500 }
|
||||
} catch (err) {
|
||||
wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
|
||||
return { msg: false, status: 500 }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,351 @@
|
||||
const axios = require('axios')
|
||||
|
||||
const SLPSDK = require('@chris.troutner/bch-js')
|
||||
const SLP = new SLPSDK()
|
||||
|
||||
class Slpdb {
|
||||
// Gets transaction history for all tokens for an address. Can also specify
|
||||
// block height, but defaults to 0.
|
||||
async getHistoricalSlpTransactions (addressList, fromBlock = 0) {
|
||||
// Build SLPDB or query from addressList
|
||||
const orQueryArray = []
|
||||
for (const address of addressList) {
|
||||
const cashAddress = SLP.SLP.Address.toCashAddress(address)
|
||||
const slpAddress = SLP.SLP.Address.toSLPAddress(address)
|
||||
|
||||
const cashQuery = {
|
||||
'in.e.a': cashAddress.slice(12)
|
||||
}
|
||||
const slpQuery = {
|
||||
'slp.detail.outputs.address': slpAddress
|
||||
}
|
||||
|
||||
orQueryArray.push(cashQuery)
|
||||
orQueryArray.push(slpQuery)
|
||||
}
|
||||
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
find: {
|
||||
db: ['c', 'u'],
|
||||
$query: {
|
||||
$or: orQueryArray,
|
||||
'slp.valid': true,
|
||||
'blk.i': {
|
||||
$not: {
|
||||
$lte: fromBlock
|
||||
}
|
||||
}
|
||||
},
|
||||
$orderby: {
|
||||
'blk.i': -1
|
||||
}
|
||||
},
|
||||
project: {
|
||||
_id: 0,
|
||||
'tx.h': 1,
|
||||
'in.i': 1,
|
||||
'in.e': 1,
|
||||
'out.e': 1,
|
||||
'out.a': 1,
|
||||
'slp.detail': 1,
|
||||
blk: 1
|
||||
},
|
||||
limit: 500
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.runQuery(query)
|
||||
// console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
|
||||
|
||||
let transactions = []
|
||||
|
||||
// Add confirmed transactions
|
||||
if (result.data && result.data.c) {
|
||||
transactions = transactions.concat(result.data.c)
|
||||
}
|
||||
|
||||
// Add unconfirmed transactions
|
||||
if (result.data && result.data.u) {
|
||||
transactions = transactions.concat(result.data.u)
|
||||
}
|
||||
|
||||
return transactions
|
||||
}
|
||||
|
||||
async getTokenStats (tokenId) {
|
||||
const [
|
||||
totalMinted,
|
||||
totalBurned,
|
||||
tokenDetails,
|
||||
circulatingSupply
|
||||
] = await Promise.all([
|
||||
this.getTotalMinted(tokenId),
|
||||
this.getTotalBurned(tokenId),
|
||||
this.getTokenDetails(tokenId),
|
||||
this.getTotalCirculating(tokenId)
|
||||
])
|
||||
|
||||
tokenDetails.totalMinted = tokenDetails.initialTokenQty + totalMinted
|
||||
tokenDetails.totalBurned = totalBurned
|
||||
|
||||
// tokenDetails.circulatingSupply =
|
||||
// tokenDetails.totalMinted - tokenDetails.totalBurned
|
||||
tokenDetails.circulatingSupply = circulatingSupply
|
||||
|
||||
return tokenDetails
|
||||
}
|
||||
|
||||
generateCredentials () {
|
||||
// Generate the Basic Authentication header for a private instance of SLPDB.
|
||||
const SLPDB_PASS = process.env.SLPDB_PASS
|
||||
? process.env.SLPDB_PASS
|
||||
: 'BITBOX'
|
||||
const username = 'BITBOX'
|
||||
const password = SLPDB_PASS
|
||||
const combined = `${username}:${password}`
|
||||
var base64Credential = Buffer.from(combined).toString('base64')
|
||||
var readyCredential = `Basic ${base64Credential}`
|
||||
|
||||
const options = {
|
||||
headers: {
|
||||
authorization: readyCredential,
|
||||
timeout: 30000
|
||||
}
|
||||
}
|
||||
|
||||
return options
|
||||
}
|
||||
|
||||
async runQuery (query) {
|
||||
const queryString = JSON.stringify(query)
|
||||
const queryBase64 = Buffer.from(queryString).toString('base64')
|
||||
const url = `${process.env.SLPDB_URL}q/${queryBase64}`
|
||||
|
||||
const options = this.generateCredentials()
|
||||
|
||||
const response = await axios.get(url, options)
|
||||
return response
|
||||
}
|
||||
|
||||
async getTotalMinted (tokenId) {
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
db: ['g'],
|
||||
aggregate: [
|
||||
{
|
||||
$match: {
|
||||
'tokenDetails.tokenIdHex': tokenId,
|
||||
'graphTxn.outputs.status': {
|
||||
$in: [
|
||||
'BATON_SPENT_IN_MINT',
|
||||
'BATON_UNSPENT',
|
||||
'BATON_SPENT_NOT_IN_MINT'
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
$unwind: '$graphTxn.outputs'
|
||||
},
|
||||
{
|
||||
$group: {
|
||||
_id: null,
|
||||
count: {
|
||||
$sum: '$graphTxn.outputs.slpAmount'
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
limit: 1
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.runQuery(query)
|
||||
|
||||
if (!result.data.g.length) {
|
||||
return 0
|
||||
}
|
||||
|
||||
return parseFloat(result.data.g[0].count)
|
||||
}
|
||||
|
||||
async getTotalCirculating (tokenId) {
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
db: ['g'],
|
||||
aggregate: [
|
||||
{
|
||||
$match: {
|
||||
'tokenDetails.tokenIdHex': tokenId,
|
||||
'graphTxn.outputs': {
|
||||
$elemMatch: {
|
||||
status: 'UNSPENT',
|
||||
slpAmount: { $gte: 0 }
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{ $unwind: '$graphTxn.outputs' },
|
||||
{
|
||||
$match: {
|
||||
'graphTxn.outputs.status': 'UNSPENT',
|
||||
'graphTxn.outputs.slpAmount': { $gte: 0 }
|
||||
}
|
||||
},
|
||||
{
|
||||
$group: {
|
||||
_id: null,
|
||||
circulating_supply: {
|
||||
$sum: '$graphTxn.outputs.slpAmount'
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
limit: 100000
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.runQuery(query)
|
||||
// console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
|
||||
|
||||
if (!result.data.g.length) {
|
||||
return 0
|
||||
}
|
||||
|
||||
return parseFloat(result.data.g[0].circulating_supply)
|
||||
}
|
||||
|
||||
async getTotalBurned (tokenId) {
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
db: ['g'],
|
||||
aggregate: [
|
||||
{
|
||||
$match: {
|
||||
'tokenDetails.tokenIdHex': tokenId,
|
||||
'graphTxn.outputs.status': {
|
||||
$in: [
|
||||
'SPENT_NON_SLP',
|
||||
'BATON_SPENT_INVALID_SLP',
|
||||
'SPENT_INVALID_SLP',
|
||||
'BATON_SPENT_NON_SLP',
|
||||
'MISSING_BCH_VOUT',
|
||||
'BATON_MISSING_BCH_VOUT',
|
||||
'BATON_SPENT_NOT_IN_MINT',
|
||||
'EXCESS_INPUT_BURNED'
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
$unwind: '$graphTxn.outputs'
|
||||
},
|
||||
{
|
||||
$match: {
|
||||
'graphTxn.outputs.status': {
|
||||
$in: [
|
||||
'SPENT_NON_SLP',
|
||||
'BATON_SPENT_INVALID_SLP',
|
||||
'SPENT_INVALID_SLP',
|
||||
'BATON_SPENT_NON_SLP',
|
||||
'MISSING_BCH_VOUT',
|
||||
'BATON_MISSING_BCH_VOUT',
|
||||
'BATON_SPENT_NOT_IN_MINT',
|
||||
'EXCESS_INPUT_BURNED'
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
$group: {
|
||||
_id: null,
|
||||
count: {
|
||||
$sum: '$graphTxn.outputs.slpAmount'
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
limit: 1
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.runQuery(query)
|
||||
|
||||
if (!result.data.g.length) {
|
||||
return 0
|
||||
}
|
||||
|
||||
return parseFloat(result.data.g[0].count)
|
||||
}
|
||||
|
||||
async getTokenDetails (tokenId) {
|
||||
const query = {
|
||||
v: 3,
|
||||
q: {
|
||||
db: ['t'],
|
||||
find: {
|
||||
$query: {
|
||||
'tokenDetails.tokenIdHex': tokenId
|
||||
}
|
||||
},
|
||||
project: { tokenDetails: 1, tokenStats: 1, _id: 0 },
|
||||
limit: 1
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.runQuery(query)
|
||||
|
||||
if (!result.data.t.length) {
|
||||
throw new Error('Token could not be found')
|
||||
}
|
||||
|
||||
const token = this.formatTokenOutput(result.data.t[0])
|
||||
|
||||
return token
|
||||
}
|
||||
|
||||
formatTokenOutput (token) {
|
||||
// console.log(`token: ${JSON.stringify(token, null, 2)}`)
|
||||
|
||||
token.tokenDetails.id = token.tokenDetails.tokenIdHex
|
||||
delete token.tokenDetails.tokenIdHex
|
||||
token.tokenDetails.documentHash = token.tokenDetails.documentSha256Hex
|
||||
delete token.tokenDetails.documentSha256Hex
|
||||
token.tokenDetails.initialTokenQty = parseFloat(
|
||||
token.tokenDetails.genesisOrMintQuantity
|
||||
)
|
||||
delete token.tokenDetails.genesisOrMintQuantity
|
||||
delete token.tokenDetails.transactionType
|
||||
delete token.tokenDetails.batonVout
|
||||
delete token.tokenDetails.sendOutputs
|
||||
|
||||
token.tokenDetails.blockCreated = token.tokenStats.block_created
|
||||
token.tokenDetails.blockLastActiveSend =
|
||||
token.tokenStats.block_last_active_send
|
||||
token.tokenDetails.blockLastActiveMint =
|
||||
token.tokenStats.block_last_active_mint
|
||||
token.tokenDetails.txnsSinceGenesis =
|
||||
token.tokenStats.qty_valid_txns_since_genesis
|
||||
token.tokenDetails.validAddresses =
|
||||
token.tokenStats.qty_valid_token_addresses
|
||||
token.tokenDetails.mintingBatonStatus =
|
||||
token.tokenStats.minting_baton_status
|
||||
|
||||
delete token.tokenStats.block_last_active_send
|
||||
delete token.tokenStats.block_last_active_mint
|
||||
delete token.tokenStats.qty_valid_txns_since_genesis
|
||||
delete token.tokenStats.qty_valid_token_addresses
|
||||
|
||||
token.tokenDetails.timestampUnix = token.tokenDetails.timestamp_unix
|
||||
delete token.tokenDetails.timestamp_unix
|
||||
|
||||
return token.tokenDetails
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Slpdb
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,604 @@
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
const router = express.Router()
|
||||
const axios = require('axios')
|
||||
|
||||
const routeUtils = require('./route-utils')
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
const Blockbook = require('./blockbook')
|
||||
const blockbook = new Blockbook()
|
||||
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v3/'
|
||||
|
||||
// const bchjsHTTP = axios.create({
|
||||
// baseURL: process.env.RPC_BASEURL
|
||||
// })
|
||||
|
||||
// const username = process.env.RPC_USERNAME
|
||||
// const password = process.env.RPC_PASSWORD
|
||||
|
||||
// const requestConfig = {
|
||||
// method: 'post',
|
||||
// auth: {
|
||||
// username: username,
|
||||
// password: password
|
||||
// },
|
||||
// data: {
|
||||
// jsonrpc: '1.0'
|
||||
// }
|
||||
// }
|
||||
|
||||
let _this
|
||||
|
||||
class UtilRoute {
|
||||
constructor () {
|
||||
this.bchjs = bchjs
|
||||
this.blockbook = blockbook
|
||||
|
||||
_this = this
|
||||
}
|
||||
|
||||
root (req, res, next) {
|
||||
return res.json({ status: 'util' })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /util/validateAddress/{address} Get information about single bitcoin cash address.
|
||||
* @apiName Information about single bitcoin cash address
|
||||
* @apiGroup Util
|
||||
* @apiDescription Returns information about single bitcoin cash address.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v3/util/validateAddress/bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c" -H "accept: application/json"
|
||||
*
|
||||
*
|
||||
*/
|
||||
async validateAddressSingle (req, res, next) {
|
||||
try {
|
||||
const address = req.params.address
|
||||
if (!address || address === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'address can not be empty' })
|
||||
}
|
||||
|
||||
const {
|
||||
BitboxHTTP,
|
||||
// username,
|
||||
// password,
|
||||
requestConfig
|
||||
} = routeUtils.setEnvVars()
|
||||
|
||||
requestConfig.data.id = 'validateaddress'
|
||||
requestConfig.data.method = 'validateaddress'
|
||||
requestConfig.data.params = [address]
|
||||
|
||||
const response = await BitboxHTTP(requestConfig)
|
||||
|
||||
return res.json(response.data.result)
|
||||
} catch (err) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
wlogger.error('Error in util.ts/validateAddressSingle().', err)
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /util/validateAddress Get information about bulk bitcoin cash addresses..
|
||||
* @apiName Information about bulk bitcoin cash addresses.
|
||||
* @apiGroup Util
|
||||
* @apiDescription Returns information about bulk bitcoin cash addresses..
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"]}'
|
||||
* curl -X POST "https://api.fullstack.cash/v3/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"],"from": 1, "to": 5}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
async validateAddressBulk (req, res, next) {
|
||||
try {
|
||||
const 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 (!routeUtils.validateArraySize(req, addresses)) {
|
||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||
return res.json({
|
||||
error: 'Array too large.'
|
||||
})
|
||||
}
|
||||
|
||||
// Validate each element in the array.
|
||||
for (let i = 0; i < addresses.length; i++) {
|
||||
const address = addresses[i]
|
||||
|
||||
// Ensure the input is a valid BCH address.
|
||||
try {
|
||||
bchjs.Address.toLegacyAddress(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 networkIsValid = routeUtils.validateNetwork(address)
|
||||
if (!networkIsValid) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error:
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
wlogger.debug('Executing util/validate with these addresses: ', addresses)
|
||||
|
||||
const {
|
||||
BitboxHTTP,
|
||||
// username,
|
||||
// password,
|
||||
requestConfig
|
||||
} = routeUtils.setEnvVars()
|
||||
|
||||
// Loop through each address and creates an array of requests to call in parallel
|
||||
const promises = addresses.map(async address => {
|
||||
requestConfig.data.id = 'validateaddress'
|
||||
requestConfig.data.method = 'validateaddress'
|
||||
requestConfig.data.params = [address]
|
||||
|
||||
return BitboxHTTP(requestConfig)
|
||||
})
|
||||
|
||||
// Wait for all parallel Insight requests to return.
|
||||
const axiosResult = await axios.all(promises)
|
||||
|
||||
// Retrieve the data part of the result.
|
||||
const result = axiosResult.map(x => x.data.result)
|
||||
|
||||
res.status(200)
|
||||
return res.json(result)
|
||||
} catch (err) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
wlogger.error('Error in util.ts/validateAddressSingle().', err)
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /util/sweep Sweep BCH and tokens
|
||||
* @apiName Sweep BCH and tokens from a paper wallet
|
||||
* @apiGroup Util
|
||||
* @apiDescription This function can be used to check the BCH balance of a
|
||||
* paper wallet. It can also be used to sweep BCH and tokens from a paper
|
||||
* wallet and send them to a destination address.
|
||||
*
|
||||
* Note: It does not yet support multiple token classes on the same paper wallet.
|
||||
*
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X POST "https://api.fullstack.cash/v3/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "balanceOnly": true}'
|
||||
* curl -X POST "https://api.fullstack.cash/v3/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "toAddr": "bitcoincash:qpt8m4kqu963geedyrur6pdggqmv5kxwnq0rn322qu"}'
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
async sweepWif (req, res, next) {
|
||||
try {
|
||||
// Validate input
|
||||
const wif = req.body.wif
|
||||
const toAddr = req.body.toAddr
|
||||
const balanceOnly = req.body.balanceOnly
|
||||
|
||||
if (typeof wif !== 'string' || wif.length !== 52) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'WIF needs to a proper compressed WIF starting with K or L'
|
||||
})
|
||||
}
|
||||
|
||||
if (!balanceOnly) {
|
||||
// Only throw error if balanceOnly is false or undefined.
|
||||
if (!toAddr || toAddr === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'address can not be empty' })
|
||||
}
|
||||
}
|
||||
|
||||
wlogger.debug('Executing util/sweepWif with this address: ', toAddr)
|
||||
|
||||
// Generate a private and public key pair from the WIF.
|
||||
const ecPair = bchjs.ECPair.fromWIF(wif)
|
||||
const fromAddr = bchjs.ECPair.toCashAddress(ecPair)
|
||||
|
||||
// Get a balance on the public address
|
||||
const balances = await _this.blockbook.balanceFromBlockbook(fromAddr)
|
||||
// console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
|
||||
|
||||
// Total balance is the sum of the confirmed and unconfirmed balance.
|
||||
const totalBalance =
|
||||
Number(balances.balance) + Number(balances.unconfirmedBalance)
|
||||
|
||||
// Exit if balance is zero.
|
||||
if (isNaN(totalBalance) || totalBalance === 0) {
|
||||
res.status(422)
|
||||
return res.json({ error: 'No balance found at BCH address.' })
|
||||
}
|
||||
|
||||
// Exit if this is a balance-only call.
|
||||
if (balanceOnly) {
|
||||
res.status(200)
|
||||
return res.json(totalBalance)
|
||||
}
|
||||
|
||||
// Get all UTXOs help by the address.
|
||||
const utxos = await _this.blockbook.utxosFromBlockbook(fromAddr)
|
||||
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||
|
||||
const tokenUtxos = []
|
||||
const bchUtxos = []
|
||||
|
||||
// Exit if there are no UTXOs.
|
||||
if (utxos.length === 0) {
|
||||
res.status(422)
|
||||
return res.json({ error: 'No utxos found.' })
|
||||
}
|
||||
|
||||
// Figure out which UTXOs are associated with SLP tokens.
|
||||
const isTokenUtxo = await _this.bchjs.SLP.Utils.tokenUtxoDetails(utxos)
|
||||
// console.log(`isTokenUtxo: ${JSON.stringify(isTokenUtxo, null, 2)}`)
|
||||
|
||||
// Separate the bch and token UTXOs.
|
||||
for (let i = 0; i < utxos.length; i++) {
|
||||
// Filter based on isTokenUtxo.
|
||||
if (!isTokenUtxo[i]) bchUtxos.push(utxos[i])
|
||||
else tokenUtxos.push(isTokenUtxo[i])
|
||||
}
|
||||
// console.log(
|
||||
// `bchUtxos.length: ${bchUtxos.length}, tokenUtxos.length: ${tokenUtxos.length}`
|
||||
// )
|
||||
|
||||
// Throw error if no BCH to move tokens.
|
||||
if (bchUtxos.length === 0 && tokenUtxos.length > 0) {
|
||||
res.status(422)
|
||||
return res.json({
|
||||
error:
|
||||
'Tokens found, but no BCH UTXOs found. Add BCH to wallet to move tokens.'
|
||||
})
|
||||
}
|
||||
|
||||
// console.log(`tokenUtxos: ${JSON.stringify(tokenUtxos, null, 2)}`)
|
||||
|
||||
const options = {
|
||||
ecPair,
|
||||
utxos,
|
||||
fromAddr,
|
||||
toAddr,
|
||||
bchUtxos,
|
||||
tokenUtxos
|
||||
}
|
||||
|
||||
let hex
|
||||
|
||||
// Choose the sweeping algorithm, based on if there are tokens or not.
|
||||
if (tokenUtxos.length === 0) hex = await _this._sweepBCH(options)
|
||||
else hex = await _this._sweepTokens(options, bchUtxos, tokenUtxos)
|
||||
// console.log(`hex: ${hex}`)
|
||||
|
||||
// Throw error if there is more than one token class.
|
||||
|
||||
// Generate a transaction to move tokens and BCH.
|
||||
|
||||
// Broadcast the transaction.
|
||||
const txid = _this.bchjs.RawTransactions.sendRawTransaction([hex])
|
||||
|
||||
res.status(200)
|
||||
return res.json(txid)
|
||||
} catch (err) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
// Catch the specific case of multiple tokens.
|
||||
if (
|
||||
err.message &&
|
||||
err.message.indexOf('Multiple token classes detected') > -1
|
||||
) {
|
||||
res.status(422)
|
||||
return res.json({ error: err.message })
|
||||
}
|
||||
|
||||
wlogger.error('Error in util.js/sweepWif().', err)
|
||||
console.error('Error in util.js/sweepWif().', err)
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: err.message })
|
||||
}
|
||||
}
|
||||
|
||||
// Sweep BCH only from a private WIF.
|
||||
async _sweepBCH (options) {
|
||||
try {
|
||||
// const wif = flags.wif
|
||||
// const toAddr = flags.address
|
||||
|
||||
const ecPair = options.ecPair
|
||||
const toAddr = options.toAddr
|
||||
|
||||
// const fromAddr = this.BITBOX.ECPair.toCashAddress(ecPair)
|
||||
//
|
||||
// // Get the UTXOs for that address.
|
||||
// let utxos = await this.BITBOX.Blockbook.utxo(fromAddr)
|
||||
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||
|
||||
let utxos = options.utxos
|
||||
|
||||
// Ensure all utxos have the satoshis property.
|
||||
utxos = utxos.map(x => {
|
||||
x.satoshis = Number(x.value)
|
||||
return x
|
||||
})
|
||||
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||
|
||||
// instance of transaction builder
|
||||
let transactionBuilder
|
||||
if (options.testnet) {
|
||||
transactionBuilder = new _this.bchjs.TransactionBuilder('testnet')
|
||||
} else transactionBuilder = new _this.bchjs.TransactionBuilder()
|
||||
|
||||
let originalAmount = 0
|
||||
|
||||
// Loop through all UTXOs.
|
||||
for (let i = 0; i < utxos.length; i++) {
|
||||
const utxo = utxos[i]
|
||||
|
||||
originalAmount = originalAmount + utxo.satoshis
|
||||
|
||||
transactionBuilder.addInput(utxo.txid, utxo.vout)
|
||||
}
|
||||
|
||||
if (originalAmount < 546) {
|
||||
throw new Error(
|
||||
'Original amount less than the dust limit. Not enough BCH to send.'
|
||||
)
|
||||
}
|
||||
|
||||
// get byte count to calculate fee. paying 1 sat/byte
|
||||
const byteCount = _this.bchjs.BitcoinCash.getByteCount(
|
||||
{ P2PKH: utxos.length },
|
||||
{ P2PKH: 1 }
|
||||
)
|
||||
const fee = Math.ceil(1.1 * byteCount)
|
||||
|
||||
// amount to send to receiver. It's the original amount - 1 sat/byte for tx size
|
||||
const sendAmount = originalAmount - fee
|
||||
|
||||
// add output w/ address and amount to send
|
||||
transactionBuilder.addOutput(
|
||||
_this.bchjs.Address.toLegacyAddress(toAddr),
|
||||
sendAmount
|
||||
)
|
||||
|
||||
// Loop through each input and sign
|
||||
let redeemScript
|
||||
for (var i = 0; i < utxos.length; i++) {
|
||||
const utxo = utxos[i]
|
||||
|
||||
transactionBuilder.sign(
|
||||
i,
|
||||
ecPair,
|
||||
redeemScript,
|
||||
transactionBuilder.hashTypes.SIGHASH_ALL,
|
||||
utxo.satoshis
|
||||
)
|
||||
}
|
||||
|
||||
// build tx
|
||||
const tx = transactionBuilder.build()
|
||||
|
||||
// output rawhex
|
||||
const hex = tx.toHex()
|
||||
return hex
|
||||
} catch (err) {
|
||||
wlogger.error('Error in util.js/sweepBCH().')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
// Sweep BCH and tokens from a WIF.
|
||||
async _sweepTokens (options) {
|
||||
try {
|
||||
// const { ecPair, utxos, fromAddr, toAddr, bchUtxos, tokenUtxos } = options
|
||||
const { ecPair, utxos, toAddr, bchUtxos, tokenUtxos } = options
|
||||
|
||||
// Input validation
|
||||
if (!Array.isArray(bchUtxos) || bchUtxos.length === 0) {
|
||||
throw new Error('bchUtxos need to be an array with one UTXO.')
|
||||
}
|
||||
if (!Array.isArray(tokenUtxos) || tokenUtxos.length === 0) {
|
||||
throw new Error('tokenUtxos need to be an array with one UTXO.')
|
||||
}
|
||||
|
||||
// if (flags.testnet)
|
||||
// this.BITBOX = new config.BCHLIB({ restURL: config.TESTNET_REST })
|
||||
|
||||
// console.log(`tokenUtxos: ${JSON.stringify(tokenUtxos, null, 2)}`)
|
||||
|
||||
// Ensure there is only one class of token in the wallet. Throw an error if
|
||||
// there is more than one.
|
||||
const tokenId = tokenUtxos[0].tokenId
|
||||
const otherTokens = tokenUtxos.filter(x => x.tokenId !== tokenId)
|
||||
if (otherTokens.length > 0) {
|
||||
throw new Error(
|
||||
'Multiple token classes detected. This function only supports a single class of token.'
|
||||
)
|
||||
}
|
||||
|
||||
// instance of transaction builder
|
||||
let transactionBuilder
|
||||
if (options.testnet) {
|
||||
transactionBuilder = new _this.bchjs.TransactionBuilder('testnet')
|
||||
} else transactionBuilder = new _this.bchjs.TransactionBuilder()
|
||||
|
||||
// Combine all the UTXOs into a single array.
|
||||
const allUtxos = utxos
|
||||
// console.log(`allUtxos: ${JSON.stringify(allUtxos, null, 2)}`)
|
||||
|
||||
// Loop through all UTXOs.
|
||||
let originalAmount = 0
|
||||
for (let i = 0; i < allUtxos.length; i++) {
|
||||
const utxo = allUtxos[i]
|
||||
|
||||
originalAmount = originalAmount + utxo.satoshis
|
||||
|
||||
transactionBuilder.addInput(utxo.txid, utxo.vout)
|
||||
}
|
||||
|
||||
if (originalAmount < 300) {
|
||||
throw new Error(
|
||||
'Not enough BCH to send. Send more BCH to the wallet to pay miner fees.'
|
||||
)
|
||||
}
|
||||
|
||||
// get byte count to calculate fee. paying 1 sat
|
||||
// Note: This may not be totally accurate. Just guessing on the byteCount size.
|
||||
// const byteCount = this.BITBOX.BitcoinCash.getByteCount(
|
||||
// { P2PKH: 3 },
|
||||
// { P2PKH: 5 }
|
||||
// )
|
||||
// //console.log(`byteCount: ${byteCount}`)
|
||||
// const satoshisPerByte = 1.1
|
||||
// const txFee = Math.floor(satoshisPerByte * byteCount)
|
||||
// console.log(`txFee: ${txFee} satoshis\n`)
|
||||
const txFee = 500
|
||||
|
||||
// amount to send back to the sending address. It's the original amount - 1 sat/byte for tx size
|
||||
const remainder = originalAmount - txFee - 546
|
||||
if (remainder < 1) {
|
||||
throw new Error('Selected UTXO does not have enough satoshis')
|
||||
}
|
||||
// console.log(`remainder: ${remainder}`)
|
||||
|
||||
// Tally up the quantity of tokens
|
||||
let tokenQty = 0
|
||||
for (let i = 0; i < tokenUtxos.length; i++) {
|
||||
tokenQty += tokenUtxos[i].tokenQty
|
||||
}
|
||||
// console.log(`tokenQty: ${tokenQty}`)
|
||||
|
||||
// Generate the OP_RETURN entry for an SLP SEND transaction.
|
||||
// console.log(`Generating op-return.`)
|
||||
const {
|
||||
script,
|
||||
outputs
|
||||
} = _this.bchjs.SLP.TokenType1.generateSendOpReturn(tokenUtxos, tokenQty)
|
||||
// console.log(`token outputs: ${outputs}`)
|
||||
|
||||
// Since we are sweeping all tokens from the WIF, there generateOpReturn()
|
||||
// function should only compute 1 token output. If it returns 2, then there
|
||||
// is something unexpected happening.
|
||||
if (outputs > 1) {
|
||||
throw new Error(
|
||||
'More than one class of token detected. Sweep feature not supported.'
|
||||
)
|
||||
}
|
||||
|
||||
// Add OP_RETURN as first output.
|
||||
const data = _this.bchjs.Script.encode(script)
|
||||
transactionBuilder.addOutput(data, 0)
|
||||
|
||||
// Send dust transaction representing tokens being sent.
|
||||
transactionBuilder.addOutput(
|
||||
_this.bchjs.Address.toLegacyAddress(toAddr),
|
||||
546
|
||||
)
|
||||
|
||||
// Last output: send remaining BCH
|
||||
transactionBuilder.addOutput(
|
||||
_this.bchjs.Address.toLegacyAddress(toAddr),
|
||||
remainder
|
||||
)
|
||||
// console.log(`utxo: ${JSON.stringify(utxo, null, 2)}`)
|
||||
|
||||
// Sign each UTXO being consumed.
|
||||
let redeemScript
|
||||
for (let i = 0; i < allUtxos.length; i++) {
|
||||
const thisUtxo = allUtxos[i]
|
||||
// console.log(`thisUtxo: ${JSON.stringify(thisUtxo, null, 2)}`)
|
||||
|
||||
transactionBuilder.sign(
|
||||
i,
|
||||
ecPair,
|
||||
redeemScript,
|
||||
transactionBuilder.hashTypes.SIGHASH_ALL,
|
||||
thisUtxo.satoshis
|
||||
)
|
||||
}
|
||||
|
||||
// build tx
|
||||
const tx = transactionBuilder.build()
|
||||
|
||||
// output rawhex
|
||||
const hex = tx.toHex()
|
||||
// console.log(`Transaction raw hex: `)
|
||||
// console.log(hex)
|
||||
|
||||
return hex
|
||||
} catch (err) {
|
||||
wlogger.error('Error in util.js/sweepBCH().')
|
||||
throw err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const utilRoute = new UtilRoute()
|
||||
|
||||
router.get('/', utilRoute.root)
|
||||
router.get('/validateAddress/:address', utilRoute.validateAddressSingle)
|
||||
router.post('/validateAddress', utilRoute.validateAddressBulk)
|
||||
router.post('/sweep', utilRoute.sweepWif)
|
||||
|
||||
module.exports = {
|
||||
router,
|
||||
// testableComponents: {
|
||||
// root,
|
||||
// validateAddressSingle,
|
||||
// validateAddressBulk,
|
||||
// sweepWif
|
||||
// }
|
||||
UtilRoute
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
/*
|
||||
xpub route
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const express = require('express')
|
||||
// const axios = require('axios')
|
||||
const routeUtils = require('./route-utils')
|
||||
const wlogger = require('../../util/winston-logging')
|
||||
|
||||
// const router = express.Router()
|
||||
const router = express.Router()
|
||||
|
||||
// Used for processing error messages before sending them to the user.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// Connect the route endpoints to their handler functions.
|
||||
router.get('/', root)
|
||||
router.get('/fromXPub/:xpub', fromXPubSingle)
|
||||
|
||||
// Root API endpoint. Simply acknowledges that it exists.
|
||||
function root (req, res, next) {
|
||||
return res.json({ status: 'address' })
|
||||
}
|
||||
|
||||
async function fromXPubSingle (req, res, next) {
|
||||
try {
|
||||
const xpub = req.params.xpub
|
||||
const hdPath = req.query.hdPath ? req.query.hdPath : '0'
|
||||
|
||||
if (!xpub || xpub === '') {
|
||||
res.status(400)
|
||||
return res.json({ error: 'xpub can not be empty' })
|
||||
}
|
||||
|
||||
// Reject if xpub is an array.
|
||||
if (Array.isArray(xpub)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
error: 'xpub can not be an array. Use POST for bulk upload.'
|
||||
})
|
||||
}
|
||||
|
||||
wlogger.debug('Executing address/fromXPub with this xpub: ', xpub)
|
||||
|
||||
const cashAddr = bchjs.Address.fromXPub(xpub, hdPath)
|
||||
const legacyAddr = bchjs.Address.toLegacyAddress(cashAddr)
|
||||
res.status(200)
|
||||
return res.json({
|
||||
cashAddress: cashAddr,
|
||||
legacyAddress: legacyAddr
|
||||
})
|
||||
} catch (err) {
|
||||
// Attempt to decode the error message.
|
||||
const { msg, status } = routeUtils.decodeError(err)
|
||||
if (msg) {
|
||||
res.status(status)
|
||||
return res.json({ error: msg })
|
||||
}
|
||||
|
||||
// Write out error to error log.
|
||||
wlogger.error('Error in address.ts/fromXPubSingle().', err)
|
||||
|
||||
res.status(500)
|
||||
return res.json({ error: util.inspect(err) })
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
router,
|
||||
testableComponents: {
|
||||
root,
|
||||
fromXPubSingle
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
A utility library that allows bch-api to easily switch from a local or default
|
||||
installation of Blockbook to the public Blockbook cloud service offered by
|
||||
OpenBazaar. This will be expanded to other Blockbook indexer services.
|
||||
|
||||
CT 9/29/19 - Switching to OpenBazaar does not work because the integration tests
|
||||
use testnet and I don't think OpenBazaar has a testnet version of their BCH
|
||||
Blockbook.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
class BlockbookPath {
|
||||
constructor () {
|
||||
// defaults
|
||||
this.addrPath = `${process.env.BLOCKBOOK_URL}api/v2/address/`
|
||||
this.utxoPath = `${process.env.BLOCKBOOK_URL}api/v2/utxo/`
|
||||
this.txPath = `${process.env.BLOCKBOOK_URL}api/v2/tx/`
|
||||
}
|
||||
|
||||
toOpenBazaar () {
|
||||
if (process.env.NETWORK === 'testnet') {
|
||||
this.addrPath = 'https://tbch.blockbook.api.openbazaar.org/api/address/'
|
||||
this.utxoPath = 'https://tbch.blockbook.api.openbazaar.org/api/utxo/'
|
||||
this.txPath = 'https://tbch.blockbook.api.openbazaar.org/api/tx/'
|
||||
} else {
|
||||
this.addrPath = 'https://bch.blockbook.api.openbazaar.org/api/address/'
|
||||
this.utxoPath = 'https://bch.blockbook.api.openbazaar.org/api/utxo/'
|
||||
this.txPath = 'https://bch.blockbook.api.openbazaar.org/api/tx/'
|
||||
}
|
||||
}
|
||||
|
||||
toDefault () {
|
||||
this.addrPath = `${process.env.BLOCKBOOK_URL}api/v2/address/`
|
||||
this.utxoPath = `${process.env.BLOCKBOOK_URL}api/v2/utxo/`
|
||||
this.txPath = `${process.env.BLOCKBOOK_URL}api/v2/tx/`
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = BlockbookPath
|
||||
@@ -0,0 +1,165 @@
|
||||
/*
|
||||
A private library of utility functions used by several different routes.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const axios = require('axios')
|
||||
const wlogger = require('./winston-logging')
|
||||
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
const BCHJS = require('@chris.troutner/bch-js')
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
// let _this
|
||||
|
||||
class RouteUtils {
|
||||
constructor () {
|
||||
// _this = this
|
||||
|
||||
this.bchjs = bchjs
|
||||
this.axios = axios
|
||||
}
|
||||
|
||||
// This function expects the Request Express.js object and an array as input.
|
||||
// The array is then validated against freemium and pro-tier rate limiting
|
||||
// requirements. A boolean is returned to indicate if the array size if valid
|
||||
// or not.
|
||||
validateArraySize (req, array) {
|
||||
const FREEMIUM_INPUT_SIZE = 20
|
||||
const PRO_INPUT_SIZE = 20
|
||||
|
||||
if (req.locals && req.locals.proLimit) {
|
||||
if (array.length <= PRO_INPUT_SIZE) return true
|
||||
} else if (array.length <= FREEMIUM_INPUT_SIZE) {
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// Axios options used when calling axios.post() to talk with a full node.
|
||||
getAxiosOptions () {
|
||||
return {
|
||||
method: 'post',
|
||||
baseURL: process.env.RPC_BASEURL,
|
||||
timeout: 15000,
|
||||
auth: {
|
||||
username: process.env.RPC_USERNAME,
|
||||
password: process.env.RPC_PASSWORD
|
||||
},
|
||||
data: {
|
||||
jsonrpc: '1.0'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Returns true if user-provided cash address matches the correct network,
|
||||
// mainnet or testnet. If NETWORK env var is not defined, it returns false.
|
||||
// This prevent a common user-error issue that is easy to make: passing a
|
||||
// testnet address into rest.bitcoin.com or passing a mainnet address into
|
||||
// trest.bitcoin.com.
|
||||
validateNetwork (addr) {
|
||||
try {
|
||||
const network = process.env.NETWORK
|
||||
|
||||
// Return false if NETWORK is not defined.
|
||||
if (!network || network === '') {
|
||||
console.log('Warning: NETWORK environment variable is not defined!')
|
||||
return false
|
||||
}
|
||||
|
||||
// Convert the user-provided address to a cashaddress, for easy detection
|
||||
// of the intended network.
|
||||
const cashAddr = this.bchjs.Address.toCashAddress(addr)
|
||||
|
||||
// Return true if the network and address both match testnet
|
||||
const addrIsTest = this.bchjs.Address.isTestnetAddress(cashAddr)
|
||||
if (network === 'testnet' && addrIsTest) return true
|
||||
|
||||
// Return true if the network and address both match mainnet
|
||||
const addrIsMain = this.bchjs.Address.isMainnetAddress(cashAddr)
|
||||
if (network === 'mainnet' && addrIsMain) return true
|
||||
|
||||
return false
|
||||
} catch (err) {
|
||||
wlogger.error('Error in validateNetwork()')
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// Error messages returned by a full node can be burried pretty deep inside the
|
||||
// error object returned by Axios. This function attempts to extract and interpret
|
||||
// error messages.
|
||||
// Returns an object. If successful, obj.msg is a string.
|
||||
// If there is a failure, obj.msg is false.
|
||||
decodeError (err) {
|
||||
try {
|
||||
// Attempt to extract the full node error message.
|
||||
if (
|
||||
err.response &&
|
||||
err.response.data &&
|
||||
err.response.data.error &&
|
||||
err.response.data.error.message
|
||||
) {
|
||||
return { msg: err.response.data.error.message, status: 400 }
|
||||
}
|
||||
|
||||
// Attempt to extract the Insight error message
|
||||
if (err.response && err.response.data) {
|
||||
return { msg: err.response.data, status: err.response.status }
|
||||
}
|
||||
|
||||
// console.log(`err.message: ${err.message}`)
|
||||
// console.log(`err: `, err)
|
||||
|
||||
// Attempt to detect a network connection error.
|
||||
if (err.message && err.message.indexOf('ENOTFOUND') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Different kind of network error
|
||||
if (err.message && err.message.indexOf('ENETUNREACH') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Different kind of network error
|
||||
if (err.message && err.message.indexOf('EAI_AGAIN') > -1) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
// Axios timeout (aborted) error, or service is down (connection refused).
|
||||
if (
|
||||
err.code &&
|
||||
(err.code === 'ECONNABORTED' || err.code === 'ECONNREFUSED')
|
||||
) {
|
||||
return {
|
||||
msg:
|
||||
'Network error: Could not communicate with full node or other external service.',
|
||||
status: 503
|
||||
}
|
||||
}
|
||||
|
||||
return { msg: false, status: 500 }
|
||||
} catch (err) {
|
||||
wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
|
||||
return { msg: false, status: 500 }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = RouteUtils
|
||||
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
Instantiates and configures the Winston logging library. This utitlity library
|
||||
can be called by other parts of the application to conveniently tap into the
|
||||
logging library.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
var winston = require('winston')
|
||||
require('winston-daily-rotate-file')
|
||||
|
||||
var NETWORK = process.env.NETWORK
|
||||
|
||||
// Configure daily-rotation transport.
|
||||
var transport = new winston.transports.DailyRotateFile({
|
||||
filename: `${__dirname}/../../logs/rest-${NETWORK}-%DATE%.log`,
|
||||
datePattern: 'YYYY-MM-DD',
|
||||
zippedArchive: false,
|
||||
maxSize: '1m',
|
||||
maxFiles: '5d',
|
||||
format: winston.format.combine(
|
||||
winston.format.timestamp(),
|
||||
winston.format.json()
|
||||
)
|
||||
})
|
||||
|
||||
transport.on('rotate', function (oldFilename, newFilename) {
|
||||
wlogger.info('Rotating log files')
|
||||
})
|
||||
|
||||
// This controls what goes into the log FILES
|
||||
var wlogger = winston.createLogger({
|
||||
level: 'verbose',
|
||||
format: winston.format.json(),
|
||||
transports: [
|
||||
//
|
||||
// - Write to all logs with level `info` and below to `combined.log`
|
||||
// - Write all logs error (and below) to `error.log`.
|
||||
//
|
||||
// new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
|
||||
// new winston.transports.File({ filename: 'logs/combined.log' })
|
||||
transport
|
||||
]
|
||||
})
|
||||
|
||||
// This controls the logs to CONSOLE
|
||||
/*
|
||||
wlogger.add(
|
||||
new winston.transports.Console({
|
||||
format: winston.format.simple(),
|
||||
level: 'info'
|
||||
})
|
||||
)
|
||||
*/
|
||||
|
||||
module.exports = wlogger
|
||||
@@ -0,0 +1,64 @@
|
||||
doctype html
|
||||
// HTML for static distribution bundle build
|
||||
html(lang='en')
|
||||
head
|
||||
// Global site tag (gtag.js) - Google Analytics
|
||||
script(async='', src='https://www.googletagmanager.com/gtag/js?id=UA-115463658-5')
|
||||
script.
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
gtag('config', 'UA-115463658-5');
|
||||
|
||||
meta(charset='UTF-8')
|
||||
title REST V2 by Bitcoin.com - BCH RPC over HTTP
|
||||
link(href='https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700', rel='stylesheet')
|
||||
link(rel='stylesheet', type='text/css', href='../../public/swagger-ui-v2.css')
|
||||
link(rel='icon', type='image/png', href='../public/favicon.png', sizes='32x32')
|
||||
style.
|
||||
html
|
||||
{
|
||||
box-sizing: border-box;
|
||||
overflow: -moz-scrollbars-vertical;
|
||||
overflow-y: scroll;
|
||||
}
|
||||
*,
|
||||
*:before,
|
||||
*:after
|
||||
{
|
||||
box-sizing: inherit;
|
||||
}
|
||||
body
|
||||
{
|
||||
margin:0;
|
||||
background: #fafafa;
|
||||
}
|
||||
body
|
||||
#swagger-ui
|
||||
script(src='../public/swagger-ui-bundle.js')
|
||||
script(src='../public/swagger-ui-standalone-preset.js')
|
||||
script.
|
||||
window.onload = function() {
|
||||
let network = "#{env.NETWORK}"
|
||||
let path;
|
||||
if(network === 'mainnet') {
|
||||
path = "../public/bitcoin-com-mainnet-rest-v2.json"
|
||||
} else {
|
||||
path = "../public/bitcoin-com-testnet-rest-v2.json"
|
||||
}
|
||||
const ui = SwaggerUIBundle({
|
||||
|
||||
url: path,
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
plugins: [
|
||||
SwaggerUIBundle.plugins.DownloadUrl
|
||||
],
|
||||
layout: "StandaloneLayout"
|
||||
})
|
||||
window.ui = ui
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
doctype html
|
||||
// HTML for static distribution bundle build
|
||||
html(lang='en')
|
||||
head
|
||||
// Global site tag (gtag.js) - Google Analytics
|
||||
script(async='', src='https://www.googletagmanager.com/gtag/js?id=UA-115463658-5')
|
||||
script.
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
gtag('config', 'UA-115463658-5');
|
||||
|
||||
meta(charset='UTF-8')
|
||||
title REST by Bitcoin.com - BCH RPC over HTTP
|
||||
link(href='https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700', rel='stylesheet')
|
||||
link(rel='stylesheet', type='text/css', href='../public/swagger-ui.css')
|
||||
link(rel='icon', type='image/png', href='../public/favicon.png', sizes='32x32')
|
||||
style.
|
||||
html
|
||||
{
|
||||
box-sizing: border-box;
|
||||
overflow: -moz-scrollbars-vertical;
|
||||
overflow-y: scroll;
|
||||
}
|
||||
*,
|
||||
*:before,
|
||||
*:after
|
||||
{
|
||||
box-sizing: inherit;
|
||||
}
|
||||
body
|
||||
{
|
||||
margin:0;
|
||||
background: #fafafa;
|
||||
}
|
||||
body
|
||||
#swagger-ui
|
||||
script(src='../public/swagger-ui-bundle.js')
|
||||
script(src='../public/swagger-ui-standalone-preset.js')
|
||||
script.
|
||||
window.onload = function() {
|
||||
// Build a system
|
||||
const ui = SwaggerUIBundle({
|
||||
url: "../public/bitcoin-com-rest-v1.json",
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
plugins: [
|
||||
SwaggerUIBundle.plugins.DownloadUrl
|
||||
],
|
||||
layout: "StandaloneLayout"
|
||||
})
|
||||
window.ui = ui
|
||||
}
|
||||
Executable
+23
@@ -0,0 +1,23 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Full node
|
||||
export RPC_BASEURL=http://<full node ip>:8332/
|
||||
export RPC_USERNAME=<RPC username>
|
||||
export RPC_PASSWORD=<RPC password>
|
||||
export NETWORK=mainnet
|
||||
|
||||
# SLPDB
|
||||
export SLPDB_URL=http://<SLPDB IP>:12300/
|
||||
|
||||
# Blockbook
|
||||
export BLOCKBOOK_URL=https://<Blockbook IP>:9131/
|
||||
# Allow node.js to make network calls to https using self-signed certificate.
|
||||
export NODE_TLS_REJECT_UNAUTHORIZED=0
|
||||
|
||||
# Mainnet Fulcrum / ElectrumX
|
||||
export FULCRUM_URL=192.168.0.6
|
||||
export FULCRUM_PORT=50002
|
||||
|
||||
export TOKENSECRET=somelongpassword
|
||||
|
||||
npm start
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,164 @@
|
||||
/*
|
||||
TESTS FOR THE CONTROL.JS LIBRARY
|
||||
|
||||
This test file uses the environment variable TEST to switch between unit
|
||||
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||
to 'integration' to run the tests against BCH mainnet.
|
||||
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
const ControlRoute = require('../../src/routes/v3/full-node/control')
|
||||
const uut = new ControlRoute()
|
||||
const sinon = require('sinon')
|
||||
|
||||
let originalEnvVars // Used during transition from integration to unit tests.
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||
const mockData = require('./mocks/control-mock')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
describe('#ControlRouter', () => {
|
||||
let req, res
|
||||
let sandbox
|
||||
|
||||
before(() => {
|
||||
// Save existing environment variables.
|
||||
originalEnvVars = {
|
||||
BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
||||
RPC_BASEURL: process.env.RPC_BASEURL,
|
||||
RPC_USERNAME: process.env.RPC_USERNAME,
|
||||
RPC_PASSWORD: process.env.RPC_PASSWORD
|
||||
}
|
||||
|
||||
// Set default environment variables for unit tests.
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
|
||||
sandbox = sinon.createSandbox()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
// Restore Sandbox
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
after(() => {
|
||||
// Restore any pre-existing environment variables.
|
||||
process.env.BITCOINCOM_BASEURL = originalEnvVars.BITCOINCOM_BASEURL
|
||||
process.env.RPC_BASEURL = originalEnvVars.RPC_BASEURL
|
||||
process.env.RPC_USERNAME = originalEnvVars.RPC_USERNAME
|
||||
process.env.RPC_PASSWORD = originalEnvVars.RPC_PASSWORD
|
||||
})
|
||||
|
||||
describe('#root', async () => {
|
||||
// root route handler.
|
||||
// const root = controlRoute.testableComponents.root
|
||||
|
||||
it('should respond to GET for base route', async () => {
|
||||
const result = uut.root(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(result.status, 'control', 'Returns static string')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#GetNetworkInfo', () => {
|
||||
// const getNetworkInfo = controlRoute.testableComponents.getNetworkInfo
|
||||
|
||||
it('should throw 500 when network issues', async () => {
|
||||
// Save the existing RPC URL.
|
||||
const savedUrl = process.env.RPC_BASEURL
|
||||
|
||||
// Manipulate the URL to cause a 500 network error.
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||
|
||||
await uut.getNetworkInfo(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.RPC_BASEURL = savedUrl
|
||||
|
||||
assert.isAbove(
|
||||
res.statusCode,
|
||||
499,
|
||||
'HTTP status code 500 or greater expected.'
|
||||
)
|
||||
// assert.include(result.error, "ENOTFOUND", "Error message expected")
|
||||
})
|
||||
it('returns proper error when downstream service stalls', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||
|
||||
const result = await uut.getNetworkInfo(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('returns proper error when downstream service is down', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
|
||||
|
||||
const result = await uut.getNetworkInfo(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('should get info on the full node', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(uut.axios, 'request')
|
||||
.resolves({ data: { result: mockData.mockGetNetworkInfo } })
|
||||
}
|
||||
|
||||
const result = await uut.getNetworkInfo(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAnyKeys(result, [
|
||||
'version',
|
||||
'subversion',
|
||||
'protocolversion',
|
||||
'localservices',
|
||||
'localrelay',
|
||||
'timeoffset',
|
||||
'networkactive',
|
||||
'connections',
|
||||
'networks',
|
||||
'relayfee',
|
||||
'excessutxocharge',
|
||||
'localaddresses',
|
||||
'warnings'
|
||||
])
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,60 @@
|
||||
/*
|
||||
End-to-end tests for the Address endpoint.
|
||||
These tests assume that the repo is running locally and pointed at TESTNET
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const rp = require('request-promise')
|
||||
|
||||
// const rawtransactions = require('../../../dist/routes/v2/address')
|
||||
|
||||
/*
|
||||
This unconfirmed utxo test needs to be expanded in the future to automatically
|
||||
create a transaction. For now, that is done manually and the address provided
|
||||
as a constant.
|
||||
|
||||
1. Start rest running locally, pointed at TESTNET.
|
||||
2. Fund each address with a small amount of tBCH
|
||||
3. Run this program with `node address.js`
|
||||
4. If successful, it will return the unconfirmed UTXOs.
|
||||
*/
|
||||
const addr1 = 'bchtest:qpdcp5pv7qphu5tsjfgwezld9n9aq9ue6swgqpf45c'
|
||||
const addr2 = 'bchtest:qzpvx999fagau0xqmvu3xvll9evapge7u5hcgeknzv'
|
||||
|
||||
async function testSingleUnconfirmed () {
|
||||
try {
|
||||
const options = {
|
||||
method: 'GET',
|
||||
uri: `http://localhost:3000/v2/address/unconfirmed/${addr1}`,
|
||||
resolveWithFullResponse: true,
|
||||
json: true
|
||||
}
|
||||
|
||||
await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 2)}`)
|
||||
} catch (err) {
|
||||
// console.log(`Error: `, err)
|
||||
}
|
||||
}
|
||||
testSingleUnconfirmed()
|
||||
|
||||
async function testDoubleUnconfirmed () {
|
||||
try {
|
||||
const options = {
|
||||
method: 'POST',
|
||||
uri: 'http://localhost:3000/v2/address/unconfirmed',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
addresses: [addr1, addr2]
|
||||
}
|
||||
}
|
||||
|
||||
await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 2)}`)
|
||||
} catch (err) {
|
||||
// console.log(`Error: `, err)
|
||||
}
|
||||
}
|
||||
testDoubleUnconfirmed()
|
||||
@@ -0,0 +1,146 @@
|
||||
/*
|
||||
TESTS FOR THE ENCRYPTION.JS LIBRARY
|
||||
|
||||
This test file uses the environment variable TEST to switch between unit
|
||||
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||
to 'integration' to run the tests against BCH mainnet.
|
||||
|
||||
To-Do:
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
|
||||
const sinon = require('sinon')
|
||||
|
||||
// Set default environment variables for unit tests.
|
||||
if (!process.env.TEST) process.env.TEST = 'unit'
|
||||
|
||||
// Only load blockbook library after setting BLOCKBOOK_URL env var.
|
||||
const EncryptionRoute = require('../../src/routes/v3/encryption')
|
||||
const encryptionRoute = new EncryptionRoute()
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||
const mockData = require('./mocks/encryption-mocks')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
describe('#Encryption Router', () => {
|
||||
let req, res
|
||||
let sandbox
|
||||
before(() => {
|
||||
// console.log(`Testing type is: ${process.env.TEST}`)
|
||||
|
||||
if (!process.env.NETWORK) process.env.NETWORK = 'testnet'
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
|
||||
sandbox = sinon.createSandbox()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
after(() => {})
|
||||
|
||||
describe('#root', () => {
|
||||
// root route handler.
|
||||
const root = encryptionRoute.root
|
||||
|
||||
it('should respond to GET for base route', async () => {
|
||||
const result = root(req, res)
|
||||
|
||||
assert.equal(result.status, 'encryption', 'Returns static string')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getPublicKey', () => {
|
||||
it('should get public key from blockchain', async () => {
|
||||
req.params.address =
|
||||
'bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0'
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockBalance)
|
||||
sandbox
|
||||
.stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
|
||||
.resolves(mockData.mockTxDetails)
|
||||
}
|
||||
|
||||
const result = await encryptionRoute.getPublicKey(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, true)
|
||||
|
||||
assert.property(result, 'publicKey')
|
||||
assert.equal(
|
||||
result.publicKey,
|
||||
'044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
|
||||
)
|
||||
})
|
||||
|
||||
it('should return false for address with no tx history', async () => {
|
||||
req.params.address =
|
||||
'bitcoincash:qqwfpk04ecf69wuprj9yjys9rla5mk7rj5j8uthqel'
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockNoTxHistory)
|
||||
}
|
||||
|
||||
const result = await encryptionRoute.getPublicKey(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, 'No transaction history')
|
||||
})
|
||||
|
||||
it('should return false for address with no send history', async () => {
|
||||
req.params.address =
|
||||
'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg'
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(encryptionRoute.blockbook, 'balanceFromBlockbook')
|
||||
.resolves(mockData.mockNoSendBalance)
|
||||
sandbox
|
||||
.stub(encryptionRoute.rawTransactions, 'getRawTransactionsFromNode')
|
||||
.resolves(mockData.mockNoSendTx)
|
||||
}
|
||||
|
||||
const result = await encryptionRoute.getPublicKey(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.property(result, 'success')
|
||||
assert.equal(result.success, false)
|
||||
|
||||
assert.property(result, 'publicKey')
|
||||
assert.include(result.publicKey, 'not found')
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,29 @@
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* Read more about panda here: https://panda-suite.github.io/
|
||||
*/
|
||||
const panda = require('pandacash-core')
|
||||
|
||||
const runLocalNode = done => {
|
||||
const server = panda.server({
|
||||
// always the same mnemonic
|
||||
// mnemonic: "cigar magnet ocean purchase travel damp snack alone theme budget wagon wrong",
|
||||
seedAccounts: true,
|
||||
enableLogs: false,
|
||||
debug: false
|
||||
})
|
||||
|
||||
server.listen({
|
||||
port: 48332,
|
||||
walletPort: 48333
|
||||
}, (err, pandaCashCore) => {
|
||||
if (err) return console.error(err)
|
||||
|
||||
done()
|
||||
})
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
runLocalNode
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
This directory contains integration tests. To run them requires that
|
||||
a local copy of rest.bitcoin.com is running. The tests in this directory are
|
||||
exactly the same calls that end users would use for their app to interact
|
||||
directly with rest.bitcoin.com.
|
||||
|
||||
At present, this directory focuses on raw-transations. But more integration tests
|
||||
will be added.
|
||||
@@ -0,0 +1,165 @@
|
||||
/*
|
||||
This integration tests should be run against a live bch-api REST server. It
|
||||
tests to ensure the rate-limits are working as expected. Adjust the values
|
||||
in the tests below to match the rate limit setting in your own installation.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
const axios = require('axios')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// const SERVER = `http://192.168.0.36:12400/v3/`
|
||||
const SERVER = 'http://localhost:3000/v3/'
|
||||
|
||||
const TEST_JWT =
|
||||
'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlM2EwNDE1ZWIyOWE5NjJkYTI3MDhiNCIsImFwaUxldmVsIjowLCJyYXRlTGltaXQiOjEwLCJpYXQiOjE1ODA4NjA0NjcsImV4cCI6MTU4MzQ1MjQ2N30.fuY5S-YrF0J11h5uyMjPe7wiVkYRnIyXi4dL9-V-C6pLJm33p0dSq_pSheVVWw78n5kAvL_9kFHngbnmQiOJYQ'
|
||||
|
||||
describe('#rate limits', () => {
|
||||
it('should get control/getNetworkInfo() with no auth', async () => {
|
||||
const options = {
|
||||
method: 'GET',
|
||||
url: `${SERVER}control/getNetworkInfo`
|
||||
}
|
||||
|
||||
const result = await axios(options)
|
||||
// console.log(`result.status: ${result.status}`)
|
||||
// console.log(`result.data: ${util.inspect(result.data)}`)
|
||||
|
||||
assert.equal(result.status, 200)
|
||||
assert.hasAnyKeys(result.data, ['version'])
|
||||
})
|
||||
|
||||
it('should trigger rate-limit handler if rate limits exceeds 30 request per minute', async () => {
|
||||
try {
|
||||
// Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
|
||||
const options = {
|
||||
method: 'GET',
|
||||
url: `${SERVER}control/getNetworkInfo`
|
||||
}
|
||||
|
||||
const promises = []
|
||||
for (let i = 0; i < 30; 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 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?'
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
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 {
|
||||
// Actual rate limit is 60 per minute X 4 nodes = 240 rpm.
|
||||
const options = {
|
||||
method: 'GET',
|
||||
url: `${SERVER}control/`,
|
||||
headers: {
|
||||
Authorization: `Token ${TEST_JWT}`
|
||||
}
|
||||
}
|
||||
|
||||
const promises = []
|
||||
for (let i = 0; i < 60; i++) {
|
||||
const promise = axios(options)
|
||||
promises.push(promise)
|
||||
}
|
||||
|
||||
await Promise.all(promises)
|
||||
|
||||
// assert.equal(true, false, "Unexpected result!")
|
||||
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, 'Unexpected result!')
|
||||
}
|
||||
// Override default timeout for this test.
|
||||
}).timeout(20000)
|
||||
})
|
||||
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
These integration tests are intended to be run against a live local copy of
|
||||
rest.bitcoin.com. They exercise the endpoints in the same way the SDK or
|
||||
end-user application would. These tests were created to replace the parts
|
||||
removed from the swagger UI, that otherwise would have excersiced these endpoints.
|
||||
|
||||
TODO:
|
||||
-/rawtransactions/sendRawTransaction is more appropropriate for an e2e test,
|
||||
so it is omitted here.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
// const rawtransactions = require('../../../dist/routes/v2/rawtransactions')
|
||||
const rp = require('request-promise')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// const mockData = require('../mocks/raw-transactions-mocks')
|
||||
|
||||
describe('#Raw-Transactions', () => {
|
||||
describe('#root', () => {
|
||||
it('should return root', async () => {
|
||||
const options = {
|
||||
method: 'GET',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/',
|
||||
resolveWithFullResponse: true,
|
||||
json: true
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 0)}`)
|
||||
|
||||
assert.equal(result.body.status, 'rawtransactions')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#whCreateTx', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const minIn = {
|
||||
txid:
|
||||
'f7ed9cf23dee85910f6269c9a101a75fcfd2f3c6fc81f17fad824ff7aaf99ab2',
|
||||
vout: 1
|
||||
}
|
||||
|
||||
const options = {
|
||||
method: 'PUT',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/create',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
// inputs: [mockData.mockWHCreateInput],
|
||||
inputs: [minIn],
|
||||
outputs: {}
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 0)}`)
|
||||
|
||||
assert.equal(
|
||||
result.body,
|
||||
'0200000001b29af9aaf74f82ad7ff181fcc6f3d2cf5fa701a1c969620f9185ee3df29cedf70100000000ffffffff0000000000'
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#whOpReturn', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const options = {
|
||||
method: 'PUT',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/opreturn',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
rawtx: '01000000000000000000',
|
||||
payload: '00000000000000020000000006dac2c0'
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 0)}`)
|
||||
|
||||
assert.equal(
|
||||
result.body,
|
||||
'0100000000010000000000000000166a140877686300000000000000020000000006dac2c000000000'
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#whReference', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const options = {
|
||||
method: 'PUT',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/reference',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
rawtx:
|
||||
'0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff03aa0a0000000000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac5c0d0000000000004751210252ce4bdd3ce38b4ebbc5a6e1343608230da508ff12d23d85b58c964204c4cef3210294cc195fc096f87d0f813a337ae7e5f961b1c8a18f1f8604a909b3a5121f065b52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000',
|
||||
destination: 'bitcoincash:qrn60nerx5zug4u4hal06atep3lzhtecvy4pxk75lf',
|
||||
amount: 0.005
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 0)}`)
|
||||
|
||||
assert.isString(result.body)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#whChangeOutput', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const options = {
|
||||
method: 'PUT',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/change',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
rawtx:
|
||||
'0100000001b15ee60431ef57ec682790dec5a3c0d83a0c360633ea8308fbf6d5fc10a779670400000000ffffffff025c0d00000000000047512102f3e471222bb57a7d416c82bf81c627bfcd2bdc47f36e763ae69935bba4601ece21021580b888ff56feb27f17f08802ebed26258c23697d6a462d43fc13b565fda2dd52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000',
|
||||
destination: 'bitcoincash:qrn60nerx5zug4u4hal06atep3lzhtecvy4pxk75lf',
|
||||
prevtxs: [
|
||||
{
|
||||
txid:
|
||||
'6779a710fcd5f6fb0883ea3306360c3ad8c0a3c5de902768ec57ef3104e65eb1',
|
||||
vout: 4,
|
||||
scriptPubKey:
|
||||
'76a9147b25205fd98d462880a3e5b0541235831ae959e588ac',
|
||||
value: 0.00068257
|
||||
}
|
||||
],
|
||||
fee: 0.000035
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 0)}`)
|
||||
|
||||
assert.isString(result.body)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#whInput', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const options = {
|
||||
method: 'PUT',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/input',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
txid:
|
||||
'b006729017df05eda586df9ad3f8ccfee5be340aadf88155b784d1fc0e8342ee',
|
||||
n: 0
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${JSON.stringify(result.body, null, 0)}`)
|
||||
|
||||
assert.isString(result.body)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getRawTransaction', () => {
|
||||
it('should return tx hex', async () => {
|
||||
const options = {
|
||||
method: 'POST',
|
||||
uri: 'http://localhost:3000/v2/rawtransactions/getRawTransaction',
|
||||
resolveWithFullResponse: true,
|
||||
json: true,
|
||||
body: {
|
||||
txids: [
|
||||
'0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098'
|
||||
],
|
||||
verbose: true
|
||||
}
|
||||
}
|
||||
|
||||
const result = await rp(options)
|
||||
// console.log(`result.body: ${util.inspect(result.body)}`)
|
||||
|
||||
assert.isArray(result.body)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,124 @@
|
||||
/*
|
||||
These integration tests need to be run against a live SLPDB. They query
|
||||
against a live SLPDB and test the results against known token stats.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const assert = require('chai').assert
|
||||
// const axios = require('axios')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// Exit if SLPDB URL is not defined.
|
||||
if (!process.env.SLPDB_URL) {
|
||||
throw new Error(
|
||||
'SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.'
|
||||
)
|
||||
}
|
||||
|
||||
const SLP = require('../../../src/routes/v3/slp')
|
||||
const slp = new SLP()
|
||||
|
||||
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||
|
||||
describe('#slp', () => {
|
||||
let req, res
|
||||
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
})
|
||||
|
||||
describe('#tokenStats', () => {
|
||||
it('should get token stats for token with no mint baton', async () => {
|
||||
req.params.tokenId =
|
||||
'497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7'
|
||||
// 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
|
||||
|
||||
const result = await slp.tokenStats(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Assert that expected properties exist.
|
||||
assert.property(result, 'decimals')
|
||||
assert.property(result, 'timestamp')
|
||||
assert.property(result, 'versionType')
|
||||
assert.property(result, 'documentUri')
|
||||
assert.property(result, 'symbol')
|
||||
assert.property(result, 'name')
|
||||
assert.property(result, 'containsBaton')
|
||||
assert.property(result, 'id')
|
||||
assert.property(result, 'documentHash')
|
||||
assert.property(result, 'initialTokenQty')
|
||||
assert.property(result, 'blockCreated')
|
||||
assert.property(result, 'blockLastActiveSend')
|
||||
assert.property(result, 'blockLastActiveMint')
|
||||
assert.property(result, 'txnsSinceGenesis')
|
||||
assert.property(result, 'validAddresses')
|
||||
assert.property(result, 'mintingBatonStatus')
|
||||
assert.property(result, 'timestampUnix')
|
||||
assert.property(result, 'totalMinted')
|
||||
assert.property(result, 'totalBurned')
|
||||
assert.property(result, 'circulatingSupply')
|
||||
|
||||
// baton was never created.
|
||||
assert.equal(result.containsBaton, false)
|
||||
})
|
||||
|
||||
it('should get token stats for token with a mint baton', async () => {
|
||||
req.params.tokenId =
|
||||
'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
|
||||
|
||||
const result = await slp.tokenStats(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Assert that expected properties exist.
|
||||
assert.property(result, 'decimals')
|
||||
assert.property(result, 'timestamp')
|
||||
assert.property(result, 'versionType')
|
||||
assert.property(result, 'documentUri')
|
||||
assert.property(result, 'symbol')
|
||||
assert.property(result, 'name')
|
||||
assert.property(result, 'containsBaton')
|
||||
assert.property(result, 'id')
|
||||
assert.property(result, 'documentHash')
|
||||
assert.property(result, 'initialTokenQty')
|
||||
assert.property(result, 'blockCreated')
|
||||
assert.property(result, 'blockLastActiveSend')
|
||||
assert.property(result, 'blockLastActiveMint')
|
||||
assert.property(result, 'txnsSinceGenesis')
|
||||
assert.property(result, 'validAddresses')
|
||||
assert.property(result, 'mintingBatonStatus')
|
||||
assert.property(result, 'timestampUnix')
|
||||
assert.property(result, 'totalMinted')
|
||||
assert.property(result, 'totalBurned')
|
||||
assert.property(result, 'circulatingSupply')
|
||||
|
||||
// baton was created.
|
||||
assert.equal(result.containsBaton, true)
|
||||
})
|
||||
})
|
||||
|
||||
describe('generateSendOpReturn', () => {
|
||||
it('should return OP_RETURN script', async () => {
|
||||
req.body.tokenUtxos = [
|
||||
{
|
||||
tokenId:
|
||||
'0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1',
|
||||
decimals: 0,
|
||||
tokenQty: 2
|
||||
}
|
||||
]
|
||||
req.body.sendQty = 1.5
|
||||
|
||||
const result = await slp.generateSendOpReturn(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAllKeys(result, ['script', 'outputs'])
|
||||
assert.isNumber(result.outputs)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,31 @@
|
||||
/*
|
||||
These integration tests need to be run against a live SLPDB. They query
|
||||
against a live SLPDB and test the results against known token stats.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
// const chai = require('chai')
|
||||
// const assert = chai.assert
|
||||
// const axios = require('axios')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// Exit if SLPDB URL is not defined.
|
||||
if (!process.env.SLPDB_URL) {
|
||||
throw new Error('SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.')
|
||||
}
|
||||
|
||||
const SLPDB = require('../../../src/routes/v3/services/slpdb')
|
||||
const slpdb = new SLPDB()
|
||||
|
||||
describe('#slpdb', () => {
|
||||
describe('#getTotalCirculating', () => {
|
||||
it('should get circulating supply', async () => {
|
||||
const result = await slpdb.getTotalCirculating('b10677aef051b73e6b170c1c0824da33a3e0680ab5a01cd8d76aa77840fccfb4')
|
||||
console.log('result: ', result)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,224 @@
|
||||
/*
|
||||
TESTS FOR THE MINING.TS LIBRARY
|
||||
|
||||
This test file uses the environment variable TEST to switch between unit
|
||||
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||
to 'integration' to run the tests against BCH mainnet.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
const MiningRoute = require('../../src/routes/v3/full-node/mining')
|
||||
const uut = new MiningRoute()
|
||||
|
||||
// const nock = require('nock') // HTTP mocking
|
||||
const sinon = require('sinon')
|
||||
|
||||
let originalEnvVars // Used during transition from integration to unit tests.
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||
const mockData = require('./mocks/mining-mocks')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
describe('#Mining', () => {
|
||||
let req, res
|
||||
let sandbox
|
||||
before(() => {
|
||||
// Save existing environment variables.
|
||||
originalEnvVars = {
|
||||
BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
||||
RPC_BASEURL: process.env.RPC_BASEURL,
|
||||
RPC_USERNAME: process.env.RPC_USERNAME,
|
||||
RPC_PASSWORD: process.env.RPC_PASSWORD
|
||||
}
|
||||
|
||||
// Set default environment variables for unit tests.
|
||||
if (!process.env.TEST) process.env.TEST = 'unit'
|
||||
if (process.env.TEST === 'unit') {
|
||||
process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api'
|
||||
process.env.RPC_USERNAME = 'fakeusername'
|
||||
process.env.RPC_PASSWORD = 'fakepassword'
|
||||
}
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
|
||||
sandbox = sinon.createSandbox()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
// Restore Sandbox
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
after(() => {
|
||||
// Restore any pre-existing environment variables.
|
||||
process.env.BITCOINCOM_BASEURL = originalEnvVars.BITCOINCOM_BASEURL
|
||||
process.env.RPC_BASEURL = originalEnvVars.RPC_BASEURL
|
||||
process.env.RPC_USERNAME = originalEnvVars.RPC_USERNAME
|
||||
process.env.RPC_PASSWORD = originalEnvVars.RPC_PASSWORD
|
||||
})
|
||||
|
||||
describe('#root', async () => {
|
||||
// root route handler.
|
||||
it('should respond to GET for base route', async () => {
|
||||
const result = uut.root(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(result.status, 'mining', 'Returns static string')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getMiningInfo', async () => {
|
||||
it('should throw 503 when network issues', async () => {
|
||||
// Save the existing RPC URL.
|
||||
const savedUrl2 = process.env.RPC_BASEURL
|
||||
|
||||
// Manipulate the URL to cause a 500 network error.
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||
|
||||
await uut.getMiningInfo(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.RPC_BASEURL = savedUrl2
|
||||
|
||||
assert.isAbove(
|
||||
res.statusCode,
|
||||
499,
|
||||
'HTTP status code 500 or greater expected.'
|
||||
)
|
||||
// assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
|
||||
})
|
||||
it('returns proper error when downstream service stalls', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||
|
||||
const result = await uut.getMiningInfo(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('returns proper error when downstream service is down', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
|
||||
|
||||
const result = await uut.getMiningInfo(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('should GET mining information', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(uut.axios, 'request')
|
||||
.resolves({ data: { result: mockData.mockMiningInfo } })
|
||||
}
|
||||
|
||||
const result = await uut.getMiningInfo(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.property(result, 'blocks')
|
||||
assert.property(result, 'difficulty')
|
||||
assert.property(result, 'networkhashps')
|
||||
assert.property(result, 'pooledtx')
|
||||
assert.property(result, 'chain')
|
||||
assert.property(result, 'warnings')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getNetworkHashPS', async () => {
|
||||
it('should throw 503 when network issues', async () => {
|
||||
// Save the existing RPC URL.
|
||||
const savedUrl2 = process.env.RPC_BASEURL
|
||||
|
||||
// Manipulate the URL to cause a 500 network error.
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||
|
||||
await uut.getNetworkHashPS(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.RPC_BASEURL = savedUrl2
|
||||
|
||||
assert.isAbove(
|
||||
res.statusCode,
|
||||
499,
|
||||
'HTTP status code 500 or greater expected.'
|
||||
)
|
||||
// assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
|
||||
})
|
||||
it('returns proper error when downstream service stalls', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||
|
||||
const result = await uut.getNetworkHashPS(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('returns proper error when downstream service is down', async () => {
|
||||
// Mock the timeout error.
|
||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
|
||||
|
||||
const result = await uut.getNetworkHashPS(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'
|
||||
)
|
||||
})
|
||||
|
||||
it('should GET Network Hash per second', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
sandbox
|
||||
.stub(uut.axios, 'request')
|
||||
.resolves({ data: { result: 517604755.6648782 } })
|
||||
}
|
||||
|
||||
const result = await uut.getNetworkHashPS(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.isNumber(result)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,160 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockAddressDetails = {
|
||||
addrStr: '1Fg4r9iDrEkCcDmHTy2T79EusNfhyQpu7W',
|
||||
balance: 0.00126419,
|
||||
balanceSat: 126419,
|
||||
totalReceived: 0.02175868,
|
||||
totalReceivedSat: 2175868,
|
||||
totalSent: 0.02049449,
|
||||
totalSentSat: 2049449,
|
||||
unconfirmedBalance: 0,
|
||||
unconfirmedBalanceSat: 0,
|
||||
unconfirmedTxApperances: 0,
|
||||
txApperances: 3,
|
||||
transactions: [
|
||||
'2dc053f55a666a3d2a08b1c680b704d62a55506d14ad884add87edcc56b9277d',
|
||||
'544c15ce35c0f2e808d28f29d6587f1ec9276233e29856b7f2938cf0daef0026',
|
||||
'81039b1d7b855b133f359f9dc65f776bd105650153a941675fedc504228ddbd3'
|
||||
],
|
||||
legacyAddress: '1Fg4r9iDrEkCcDmHTy2T79EusNfhyQpu7W',
|
||||
cashAddress: 'bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
|
||||
}
|
||||
|
||||
const mockUtxoDetails = [
|
||||
{
|
||||
txid: '15f6a584080b04911121fbaca7bfcf3dd64ef2bfa5a01daf31e05a296c3e5e9e',
|
||||
vout: 286,
|
||||
amount: 0.00001,
|
||||
satoshis: 1000,
|
||||
height: 546083,
|
||||
confirmations: 3490
|
||||
},
|
||||
{
|
||||
txid: '15f6a584080b04911121fbaca7bfcf3dd64ef2bfa5a01daf31e05a296c3e5e9e',
|
||||
vout: 287,
|
||||
amount: 0.00001,
|
||||
satoshis: 1000,
|
||||
height: 546083,
|
||||
confirmations: 3490
|
||||
},
|
||||
{
|
||||
txid: '15f6a584080b04911121fbaca7bfcf3dd64ef2bfa5a01daf31e05a296c3e5e9e',
|
||||
vout: 288,
|
||||
amount: 0.00001,
|
||||
satoshis: 1000,
|
||||
height: 546083,
|
||||
confirmations: 3490
|
||||
}
|
||||
]
|
||||
|
||||
const mockUnconfirmed = [
|
||||
{
|
||||
address: '1EzdL6TBbkNhnB2fYiBaKmcs5fxaoqwdAp',
|
||||
txid: '000c00a90fb5031da6e02f7625df2f8b35a4c16e6feb9fc72293e67e5ff75786',
|
||||
vout: 0,
|
||||
scriptPubKey: '76a914997fabcd94a1e2aaa13a7664362e5e7b96c169a988ac',
|
||||
amount: 0.00999626,
|
||||
satoshis: 999626,
|
||||
confirmations: 0,
|
||||
ts: 1537989425
|
||||
}
|
||||
]
|
||||
|
||||
const mockTransactions = {
|
||||
pagesTotal: 1,
|
||||
txs: [
|
||||
{
|
||||
txid: '000c00a90fb5031da6e02f7625df2f8b35a4c16e6feb9fc72293e67e5ff75786',
|
||||
version: 2,
|
||||
locktime: 549565,
|
||||
vin: [
|
||||
{
|
||||
txid:
|
||||
'45c891c6d44619fc85716ba1b593aa83ebc1e500fe611b1ab98531ea203a0f21',
|
||||
vout: 209,
|
||||
sequence: 4294967294,
|
||||
n: 0,
|
||||
scriptSig: {
|
||||
hex:
|
||||
'47304402205b136f348bedae61a87c0500979d47ab02c76f0e4aba866b94c4931fccb5d7dc0220757a141660475b0cd4cb8b1f54b1ace95105f5bea775e817b115fb589fe4477541210246daec651c506f353daa7468714399c773df42ac4d663022d0e446a3331ac64a',
|
||||
asm:
|
||||
'304402205b136f348bedae61a87c0500979d47ab02c76f0e4aba866b94c4931fccb5d7dc0220757a141660475b0cd4cb8b1f54b1ace95105f5bea775e817b115fb589fe44775[ALL|FORKID] 0246daec651c506f353daa7468714399c773df42ac4d663022d0e446a3331ac64a'
|
||||
},
|
||||
addr: '14TdovsQUL69xL5g3zSzhLpmDb93d9rU9m',
|
||||
valueSat: 1979534,
|
||||
value: 0.01979534,
|
||||
doubleSpentTxID: null
|
||||
},
|
||||
{
|
||||
txid:
|
||||
'6e5fa79547112a912adf6082c975dc80e282045193512ea369adb6bac7420674',
|
||||
vout: 147,
|
||||
sequence: 4294967294,
|
||||
n: 1,
|
||||
scriptSig: {
|
||||
hex:
|
||||
'473044022056674ac83a37d54ffec2c6d33cfc2ae2256f821b8bd818e1b6783356b49f3d28022046d3dd147c8fc51f2da5d16996a3cea1d7314e327aa1ae1017418737ed20136a4121038f23af565f68d8455e07e5c33c5cfc5114de2f478f035db23eb02f8ff5fe7f6e',
|
||||
asm:
|
||||
'3044022056674ac83a37d54ffec2c6d33cfc2ae2256f821b8bd818e1b6783356b49f3d28022046d3dd147c8fc51f2da5d16996a3cea1d7314e327aa1ae1017418737ed20136a[ALL|FORKID] 038f23af565f68d8455e07e5c33c5cfc5114de2f478f035db23eb02f8ff5fe7f6e'
|
||||
},
|
||||
addr: '1CEtC2fjELvmAzTd6MWuHb1gvuSq8x3Xpb',
|
||||
valueSat: 10466,
|
||||
value: 0.00010466,
|
||||
doubleSpentTxID: null
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: '0.00999626',
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
hex: '76a914997fabcd94a1e2aaa13a7664362e5e7b96c169a988ac',
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 997fabcd94a1e2aaa13a7664362e5e7b96c169a9 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
addresses: ['1EzdL6TBbkNhnB2fYiBaKmcs5fxaoqwdAp'],
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
},
|
||||
{
|
||||
value: '0.00990000',
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
hex: '76a914e3335e4d6babe61ea58311293c1c6bfe802801cb88ac',
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 e3335e4d6babe61ea58311293c1c6bfe802801cb OP_EQUALVERIFY OP_CHECKSIG',
|
||||
addresses: ['1MiKvgaQTFCTEZbSDMZgw9ahaB52Cr4ofb'],
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
}
|
||||
],
|
||||
blockhash:
|
||||
'00000000000000000158b1a2883688873ec5ea076e3b0f576bcdfe1fd277880f',
|
||||
blockheight: 549601,
|
||||
confirmations: 5,
|
||||
time: 1537990026,
|
||||
blocktime: 1537990026,
|
||||
valueOut: 0.01989626,
|
||||
size: 372,
|
||||
valueIn: 0.0199,
|
||||
fees: 0.00000374
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockAddressDetails,
|
||||
mockUtxoDetails,
|
||||
mockUnconfirmed,
|
||||
mockTransactions
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the bitcore route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockBalance = {
|
||||
confirmed: 10000000,
|
||||
unconfirmed: 0,
|
||||
balance: 10000000
|
||||
}
|
||||
|
||||
const mockUtxos = [
|
||||
{
|
||||
_id: '5cf2c31a33bd46a95ec7e730',
|
||||
chain: 'BCH',
|
||||
network: 'testnet',
|
||||
coinbase: false,
|
||||
mintIndex: 1,
|
||||
spentTxid: '',
|
||||
mintTxid:
|
||||
'5fe9b74056319a8c87f45cc745030715a6180758b94938dbf90d639d55652392',
|
||||
mintHeight: 1265275,
|
||||
spentHeight: -2,
|
||||
address: 'qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4',
|
||||
script: '76a9140e5b4ad9008bb9a027b7e2d0ef958914e12db20788ac',
|
||||
value: 10000000,
|
||||
confirmations: -1
|
||||
}
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
mockBalance,
|
||||
mockUtxos
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockBlockDetails = {
|
||||
hash: '00000000000000645dec6503d3f5eafb0d2537a7a28f181d721dec7c44154c79',
|
||||
size: 1319,
|
||||
height: 1267544,
|
||||
version: 536870912,
|
||||
merkleroot:
|
||||
'c2cd01ec2cf149acc7631385f89ae103d1a2ad212ab810c862d9680a811618ce',
|
||||
tx: [
|
||||
'52bfa89d449fef8070ec33e7a61f5ec8b5417ff62b050cd6a144ebce9557e0fa',
|
||||
'8988e8742d2523f667c2d1374861919e3a82903e059fec75c10795da2303b93b',
|
||||
'41def004f22b196d675566a6983ecf97611e72c48375b8ba779983d5ccd369d7',
|
||||
'8ca8efb06abb94395f8331f87e101504dcf66aee828f2111922f056971fa7502',
|
||||
'9ab409cbb203be7cf22bd6598d787fcdd5b417d885b72207ecc7253470770649'
|
||||
],
|
||||
time: 1542048973,
|
||||
nonce: 3936284753,
|
||||
bits: '1a03c148',
|
||||
difficulty: 4467892.99177529,
|
||||
chainwork: '00000000000000000000000000000000000000000000003ee27b503a064045bd',
|
||||
confirmations: 3,
|
||||
previousblockhash:
|
||||
'00000000000001891202cbe18729a02a8763cf04da0ca7aded6e6c7d9b500785',
|
||||
nextblockhash:
|
||||
'000000000000039b93b3f3403a0eb21150904b15229d998cf3788fd8bf192cc2',
|
||||
reward: 0.78125,
|
||||
isMainChain: true,
|
||||
poolInfo: {}
|
||||
}
|
||||
|
||||
const mockBlockHash =
|
||||
'00000000000000645dec6503d3f5eafb0d2537a7a28f181d721dec7c44154c79'
|
||||
|
||||
module.exports = {
|
||||
mockBlockDetails,
|
||||
mockBlockHash
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the blockbook route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockBalance = {
|
||||
page: 1,
|
||||
totalPages: 1,
|
||||
itemsOnPage: 1000,
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf',
|
||||
balance: '10000000',
|
||||
totalReceived: '10000000',
|
||||
totalSent: '0',
|
||||
unconfirmedBalance: '0',
|
||||
unconfirmedTxs: 0,
|
||||
txs: 1,
|
||||
txids: ['5fe9b74056319a8c87f45cc745030715a6180758b94938dbf90d639d55652392']
|
||||
}
|
||||
|
||||
const mockUtxos = [
|
||||
{
|
||||
txid: '5fe9b74056319a8c87f45cc745030715a6180758b94938dbf90d639d55652392',
|
||||
vout: 1,
|
||||
value: '10000000',
|
||||
height: 1265275,
|
||||
confirmations: 42704
|
||||
}
|
||||
]
|
||||
|
||||
const mockTx = {
|
||||
txid: '5fe9b74056319a8c87f45cc745030715a6180758b94938dbf90d639d55652392',
|
||||
version: 2,
|
||||
vin: [
|
||||
{
|
||||
txid: '85ddb8215fc3701a493cf1c450644c5ef32c55aaa2f48ae2d008944394f3e4d3',
|
||||
sequence: 4294967295,
|
||||
n: 0,
|
||||
addresses: ['bchtest:qqmd9unmhkpx4pkmr6fkrr8rm6y77vckjvqe8aey35'],
|
||||
value: '16983000648',
|
||||
hex:
|
||||
'47304402202378e55f4d02bb932498deef22dfc1f7a4984858c3b55017e225dd567172252e0220373d27710b5d42a72ac9725959f1605a912fee0ae86a7ad36e7d6d796f14ca29412103c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792'
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: '16973000422',
|
||||
n: 0,
|
||||
spent: true,
|
||||
hex: '76a91436d2f27bbd826a86db1e93618ce3de89ef33169388ac',
|
||||
addresses: ['bchtest:qqmd9unmhkpx4pkmr6fkrr8rm6y77vckjvqe8aey35']
|
||||
},
|
||||
{
|
||||
value: '10000000',
|
||||
n: 1,
|
||||
hex: '76a9140e5b4ad9008bb9a027b7e2d0ef958914e12db20788ac',
|
||||
addresses: ['bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4']
|
||||
}
|
||||
],
|
||||
blockHash: '00000000005242edac4635ac2375a454e801cc1be8b131b622328089731e5e30',
|
||||
blockHeight: 1265275,
|
||||
confirmations: 65402,
|
||||
blockTime: 1540912733,
|
||||
value: '16983000422',
|
||||
valueIn: '16983000648',
|
||||
fees: '226',
|
||||
hex:
|
||||
'0200000001d3e4f394439408d0e28af4a2aa552cf35e4c6450c4f13c491a70c35f21b8dd85000000006a47304402202378e55f4d02bb932498deef22dfc1f7a4984858c3b55017e225dd567172252e0220373d27710b5d42a72ac9725959f1605a912fee0ae86a7ad36e7d6d796f14ca29412103c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792ffffffff02e66eabf3030000001976a91436d2f27bbd826a86db1e93618ce3de89ef33169388ac80969800000000001976a9140e5b4ad9008bb9a027b7e2d0ef958914e12db20788ac00000000'
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockBalance,
|
||||
mockUtxos,
|
||||
mockTx
|
||||
}
|
||||
@@ -0,0 +1,300 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockBlockHash =
|
||||
'00000000000000645dec6503d3f5eafb0d2537a7a28f181d721dec7c44154c79'
|
||||
|
||||
const mockBlockchainInfo = {
|
||||
chain: 'test',
|
||||
blocks: 1267694,
|
||||
headers: 1267694,
|
||||
bestblockhash:
|
||||
'000000000000013eaf80d1e157e32804c36a58ad0bb26ca59833880c80298780',
|
||||
difficulty: 4105763.969035785,
|
||||
mediantime: 1542131305,
|
||||
verificationprogress: 0.9999968911571566,
|
||||
chainwork: '00000000000000000000000000000000000000000000003f0443b0b5f02ce255',
|
||||
pruned: false,
|
||||
softforks: [
|
||||
{ id: 'bip34', version: 2, reject: { status: true } },
|
||||
{ id: 'bip66', version: 3, reject: { status: true } },
|
||||
{ id: 'bip65', version: 4, reject: { status: true } }
|
||||
],
|
||||
bip9_softforks: {
|
||||
csv: {
|
||||
status: 'active',
|
||||
startTime: 1456790400,
|
||||
timeout: 1493596800,
|
||||
since: 770112
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const mockChainTips = [
|
||||
{
|
||||
height: 1267696,
|
||||
hash: '000000000000035bfc43a642ebbff8cfc1e88b1d564de8b0a6c7e2797eeafb21',
|
||||
branchlen: 0,
|
||||
status: 'active'
|
||||
},
|
||||
{
|
||||
height: 1267581,
|
||||
hash: '000000000001bd12e4124207682563135b21353ca3087bc6b0c409f7f9e1da91',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1267375,
|
||||
hash: '00000000702036979df70236bcc45dfc72d43d5d0e6834007afa1fa627e49587',
|
||||
branchlen: 1036,
|
||||
status: 'headers-only'
|
||||
},
|
||||
{
|
||||
height: 1266979,
|
||||
hash: '00000000e851abbde2174ccdc5c2508b909f81f23c4b7abeac864eee1a4891c7',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266973,
|
||||
hash: '000000007e1324d2900ed70947f89ab8fd4a267e87c9244c333215659a7370d5',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266967,
|
||||
hash: '000000000f37f12843d4800f50ec4de44dce0432e4d448242d43ff04a7a2948d',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266963,
|
||||
hash: '00000000ae11ec99e88898cbd72567cb4cb79e7fc13243357bef79632769deb4',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266962,
|
||||
hash: '000000004f97851259b4460a049e44fa5bd4beadee04a85bf81bd2e90c4f24f9',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266950,
|
||||
hash: '00000000d12a0e4a827f73ecaadb563df7e99817294939f2be8e943079dc60b2',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266944,
|
||||
hash: '00000000612d16af273217818e8e7ac5014a19f68ed04e1bc897b1be0a9c744f',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266941,
|
||||
hash: '0000000000002b91cdb15cacf3368da2c9ffce511d64092193b507dad75f4a27',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266896,
|
||||
hash: '000000000002745f67a66617b1f9f65c2dfb4c4b8a9ed9b1320b98d3ca46cbe5',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266481,
|
||||
hash: '0000000000036babee3ba7654cddb29a9fe5e85c9fbeb44bb53d5ffb694b9670',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266452,
|
||||
hash: '00000000502c3ab1490e0839780a4b441bbe21507c454545941e6adcde73c2ff',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1266336,
|
||||
hash: '000000001c9a0b7cd9eb2210f69d5a9a3f4546ba3707deb40993d729190582d7',
|
||||
branchlen: 10,
|
||||
status: 'headers-only'
|
||||
},
|
||||
{
|
||||
height: 1266097,
|
||||
hash: '000000000028ac0fbd18afe6f001f70cb7549bd2b3082d754dde88ee236368a2',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1265522,
|
||||
hash: '00000000000000c6df7a2063030e6ce51399e470cc46e4bf6d67aa3f0feca98d',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1265470,
|
||||
hash: '0000000000168e6442a595a02340fccf8dc2b0e8912c632d39e1f870685f6d7c',
|
||||
branchlen: 2,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1265275,
|
||||
hash: '000000008bc2b37ae6af1b886b52e7e1c1122c12badc4ae6c13df64f789267cf',
|
||||
branchlen: 11027,
|
||||
status: 'headers-only'
|
||||
},
|
||||
{
|
||||
height: 1265257,
|
||||
hash: '00000000005bc3e9973d7273211eab02ae02549c7ebae48764c0bd648d4d7bbe',
|
||||
branchlen: 114,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1265254,
|
||||
hash: '0000000000e5b909d3541857315e9ee103b042d9ba661f25cc3e8fb25a96c8ce',
|
||||
branchlen: 111,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1265245,
|
||||
hash: '000000000066eb8832f6f990baceb379536f437216e22475a6c1b9133d250cb8',
|
||||
branchlen: 102,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1264455,
|
||||
hash: '00000000000001befc1bb17a23208d0b77b2449e37093ce8fbb5e346b19cafcc',
|
||||
branchlen: 1,
|
||||
status: 'valid-headers'
|
||||
},
|
||||
{
|
||||
height: 1264373,
|
||||
hash: '00000000000001ed3747e04fb95054cac0358fb4d8009d1999fc3ea34413e84a',
|
||||
branchlen: 175,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1263912,
|
||||
hash: '00000000000004635aecbcb97edcd6f5396483338838cb40da804eb354c68bde',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1262906,
|
||||
hash: '00000000b31643d92a3e7c38e9755844fc8607e3f1055580a8ff28854e8a8ece',
|
||||
branchlen: 1,
|
||||
status: 'valid-fork'
|
||||
},
|
||||
{
|
||||
height: 1255749,
|
||||
hash: '000000001dde5b015a99137f4cba87871370f4b6fcfbcc8b126547e6c33177da',
|
||||
branchlen: 129,
|
||||
status: 'headers-only'
|
||||
},
|
||||
{
|
||||
height: 1188789,
|
||||
hash: '00000000af942ce4eb60b3213cbcb7c98a7330f1f8f1adb4b6376f5e822e15b2',
|
||||
branchlen: 92,
|
||||
status: 'headers-only'
|
||||
}
|
||||
]
|
||||
|
||||
const mockMempoolInfo = {
|
||||
size: 87,
|
||||
bytes: 16816,
|
||||
usage: 66408,
|
||||
maxmempool: 300000000,
|
||||
mempoolminfee: 0
|
||||
}
|
||||
|
||||
const mockRawMempool = [
|
||||
'db045bc3bd1088fa91f5ebb05c35cb9e2a91a22377f79b465cc6920b9893123c',
|
||||
'6b3df7febf2b9834f1409155f88b866dd516b36376eae00e2b455df82e290405'
|
||||
]
|
||||
|
||||
const mockBlockHeaderConcise =
|
||||
'000000202ed2723e7590e2b937f6821a99d6764cb8799bf30f8e300000000000000000001d311c02df9a1e3f57b8dbdcf97ec8dbc3109a26779724c63e560b29ad9ea501e2af955d286403183049e39c'
|
||||
|
||||
const mockBlockHeader = {
|
||||
hash: '00000000000008c3679777df34f1a09565f98b2400a05b7c8da72525fdca3900',
|
||||
confirmations: 7,
|
||||
height: 1272859,
|
||||
version: 2147418112,
|
||||
versionHex: '7fff0000',
|
||||
merkleroot:
|
||||
'846f45604ec6cde2528933305dba80971e9ff0874f74d2811c7c690b2c32706d',
|
||||
time: 1544207139,
|
||||
mediantime: 1544202884,
|
||||
nonce: 641041470,
|
||||
bits: '1a09faea',
|
||||
difficulty: 1681035.704111868,
|
||||
chainwork: '00000000000000000000000000000000000000000000003fc4752e608403be04',
|
||||
previousblockhash:
|
||||
'0000000000003e467ebcb7e906645676c2f71b9ac520d6508bea45789b7c217d',
|
||||
nextblockhash:
|
||||
'00000000000006899041cdfd6c0b73a97730c362346dde479b77414ad7f25ace',
|
||||
nTx: 'some value'
|
||||
}
|
||||
|
||||
const mockTxOut = {
|
||||
bestblock: '00000000003a7f19730dd9f172d7466658a5c8833dd03ed8f4ba36e3d857b5e7',
|
||||
confirmations: 10,
|
||||
value: 0.0001,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 0ee020c07f39526ac5505c54fa1ab98490979b83 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a9140ee020c07f39526ac5505c54fa1ab98490979b8388ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: ['bchtest:qq8wqgxq0uu4y6k92pw9f7s6hxzfp9umsvtg39pzqf']
|
||||
},
|
||||
coinbase: false
|
||||
}
|
||||
|
||||
const mockTxOutProof =
|
||||
'000000200798039affceb7a381e15dc62443c286efe7cae852393b656807000000000000cf9a7d6c654fd1c4558229a619a550ff749b373fa0f0027eed68b1abf6175d5c07c50f5cffff001d0452403b34000000070d0765da76980d542b5670d27ccda9e717073270f8921ad017deb7ee83fe6c4c22830a48cc8392197f1742a3d81805bd2aa4eb7469f38c74f674429d682cb87efcff1713fd0c388a50f0d11adf05363397ef79d16cdb786d47c941c2cb89f2588f42aced9c05f4203b4440616a9e4266ec47909b9580a643f402b5d4e82cc3cddd73df05a33abf6af3975d973d3033d10c4168a73d58d01f685a96d5a2519cd0de9c77faf3f8725ddf155cbdc8ab8102f173e2d0a0d74767f3bff22f588158d6d5bc71c079c7659cc864819c43877635007650502eb4060fcc9feec3280a41d602ad0a'
|
||||
|
||||
const mockAncestors = [
|
||||
'070504de968fba8a23a1362fd7fc0546a420663f2bcc18099d894a41ecf9cce5',
|
||||
'20af6b7fcd21a3f38bb65d32fe2d66fb1ae554ed9c00eaf1b17d7e81362381a9',
|
||||
'227e08663a812cf44d91106b09fc8493fe1a2b7c146f30ca09ebd86c9b84b2a5',
|
||||
'228833be79d4a833165ea199be160efcaeb9325e71e9455f424b27abc9688ba8',
|
||||
'2de27df02001e7243435cef6d41ea2312b94a5964912eb21466b936852c0b822',
|
||||
'2ef76ae690d6f6c9559e20358a75a0ce02250b9b8e80e0aa6f782576239f292a',
|
||||
'3e314678f52d52694726e6da88b94c9f0ea086d2f9af297b01d014b62247839f',
|
||||
'4773f840d5255f16c0e5effce48316d8b8824a1d3ddd5da275c5fd99e7b3ee42',
|
||||
'4804b97112da07e2c187516a915dd4cbd4a3814f3c900b8d08eb1d508ab0ac47',
|
||||
'4ca69f31081a256cb4711315336fe4358d8f04b67792ca5ee17b5f4089a2446a',
|
||||
'6ac17dce10ae3a3d1d8e6f42546ad9a4bb981e62cba8d48bab03e01b9ea38ae3',
|
||||
'6ce71182ef341c481a90d8b081a99d9788bdd91a917f9a6594fdfad2c2024a14',
|
||||
'8413343ac973fb0968ae1809faa8f0ddf18252975481daa683e88b04afa66ccd',
|
||||
'9430300f3d7ecdabe39671b6fd0e9c36f763f01a202e619c070554ddc5e8713e',
|
||||
'94f82b5a2cd1647d8168807ccfdebe41931ea1ab789a050d615f08000a63b624',
|
||||
'9848db6a7d2835002ca7e1097a685d75eb629f44df94007674635b45d0e97199',
|
||||
'98d809993353df6c4d55fda5e7b0ed2e383601cef1180a9aa9c87e67e8f4dd94',
|
||||
'9f5513a35ae8fad3dd061865a97d8127c914e3464527641c089993c06d092535',
|
||||
'a7201ac90abd2aa42112faa809181c45047b6988a2f649a70a1d5bfb95f46884',
|
||||
'a9f1284710c655357412a062b01efaeb174820613784ccbfe44b33b86a8bdbc4',
|
||||
'b814f44c9c8ee24a218b9f295a8c1831106b70c15ffe8aeb7534e10d99935fd0',
|
||||
'e130ccdcc94dc5eaa4ae37fa50e3ee96283b0e157616bc6e28454b64bae34f48',
|
||||
'e68dad4a7292105cfa84fcaef7f99e5d4f2ece9613ca625d4d2ebf61efa84118',
|
||||
'fe94caf5da672be3772d2304a6272eb8bc3d3f5cb4a886f39b7981e1485cf74b'
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
mockBlockHash,
|
||||
mockBlockchainInfo,
|
||||
mockChainTips,
|
||||
mockMempoolInfo,
|
||||
mockRawMempool,
|
||||
mockBlockHeaderConcise,
|
||||
mockBlockHeader,
|
||||
mockTxOut,
|
||||
mockTxOutProof,
|
||||
mockAncestors
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockGetInfo = {
|
||||
version: 170200,
|
||||
protocolversion: 70015,
|
||||
walletversion: 160300,
|
||||
balance: 0,
|
||||
blocks: 1266726,
|
||||
timeoffset: 0,
|
||||
connections: 8,
|
||||
proxy: '',
|
||||
difficulty: 1,
|
||||
testnet: true,
|
||||
keypoololdest: 1536331195,
|
||||
keypoolsize: 2000,
|
||||
paytxfee: 0,
|
||||
relayfee: 0.00001,
|
||||
errors: 'Warning: unknown new rules activated (versionbit 28)'
|
||||
}
|
||||
|
||||
const mockGetNetworkInfo = {
|
||||
version: 190700,
|
||||
subversion: '/Bitcoin ABC:0.19.7(EB32.0)/',
|
||||
protocolversion: 70015,
|
||||
localservices: '0000000000000425',
|
||||
localrelay: true,
|
||||
timeoffset: 0,
|
||||
networkactive: true,
|
||||
connections: 23,
|
||||
networks: [{}, {}, {}],
|
||||
relayfee: 0.00001,
|
||||
excessutxocharge: 0,
|
||||
localaddresses: [],
|
||||
warnings:
|
||||
"Warning: Unknown block versions being mined! It's possible unknown rules are in effect"
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockGetInfo,
|
||||
mockGetNetworkInfo
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
/*
|
||||
Mocking data for electrumx unit tests
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const utxos = [
|
||||
{
|
||||
height: 604392,
|
||||
tx_hash: '7774e449c5a3065144cefbc4c0c21e6b69c987f095856778ef9f45ddd8ae1a41',
|
||||
tx_pos: 0,
|
||||
value: 1000
|
||||
},
|
||||
{
|
||||
height: 630834,
|
||||
tx_hash: '4fe60a51e0d8f5134bfd8e5f872d6e502d7f01b28a6afebb27f4438a4f638d53',
|
||||
tx_pos: 0,
|
||||
value: 6000
|
||||
}
|
||||
]
|
||||
|
||||
const balance = {
|
||||
confirmed: 7000,
|
||||
unconfirmed: 0
|
||||
}
|
||||
|
||||
const txHistory = [
|
||||
{
|
||||
height: 601861,
|
||||
tx_hash: '6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d'
|
||||
}
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
utxos,
|
||||
balance,
|
||||
txHistory
|
||||
}
|
||||
@@ -0,0 +1,179 @@
|
||||
/*
|
||||
Mock data for the encryption test library
|
||||
*/
|
||||
|
||||
const mockBalance = {
|
||||
page: 1,
|
||||
totalPages: 1,
|
||||
itemsOnPage: 1000,
|
||||
address: 'bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0',
|
||||
balance: '582434',
|
||||
totalReceived: '213083250',
|
||||
totalSent: '212500816',
|
||||
unconfirmedBalance: '0',
|
||||
unconfirmedTxs: 0,
|
||||
txs: 12,
|
||||
txids: [
|
||||
'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a',
|
||||
'1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
|
||||
'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f',
|
||||
'0f9b49cafeb9ae1d741cdb12137c92816aa8470944c270a78ba2e610bd59190d',
|
||||
'ceb0cab0e37b59caf3ca29e1a698d19ff47f2827dd09cb2f3b91b9100b1dad1c',
|
||||
'8bc2134c7e48e56e1769b3d7c4c1e3a0acc68e1e58160eee6fa67f3208c07262',
|
||||
'b3792d28377b975560e1b6f09e48aeff8438d4c6969ca578bd406393bd50bd7d',
|
||||
'ecc1b51bac767880382bf3190ff17abf78d0936843a022a943d871116ed50368',
|
||||
'9ea667bcfc9cd337bd6c5583d8094c1b1942bd2015d95b54189deac5070eeff0',
|
||||
'6960255abe64893073921e96bf3c053c82686e0fc22a565494fbe2a31e766975',
|
||||
'7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153',
|
||||
'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3'
|
||||
]
|
||||
}
|
||||
|
||||
const mockTxDetails = {
|
||||
txid: '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
|
||||
hash: '1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb',
|
||||
version: 1,
|
||||
size: 437,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: 'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a',
|
||||
vout: 0,
|
||||
scriptSig: {
|
||||
asm:
|
||||
'30450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da97[ALL|FORKID] 044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c',
|
||||
hex:
|
||||
'4830450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da974141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
|
||||
},
|
||||
sequence: 4294967295
|
||||
},
|
||||
{
|
||||
txid: 'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f',
|
||||
vout: 1,
|
||||
scriptSig: {
|
||||
asm:
|
||||
'3044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e[ALL|FORKID] 044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c',
|
||||
hex:
|
||||
'473044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2c'
|
||||
},
|
||||
sequence: 4294967295
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: 0.47,
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 7ab928d0b41194411a2e87a782b688c7cc69ba46 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a9147ab928d0b41194411a2e87a782b688c7cc69ba4688ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: ['bitcoincash:qpatj2xsksgegsg696r60q4k3rruc6d6gc3srp333v']
|
||||
}
|
||||
},
|
||||
{
|
||||
value: 0.00531373,
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 f3707320bbb4a28759a78a5ad63a77a2f5d462ec OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a914f3707320bbb4a28759a78a5ad63a77a2f5d462ec88ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: ['bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0']
|
||||
}
|
||||
}
|
||||
],
|
||||
hex:
|
||||
'01000000029a1c67eea78c7b8830dd8ed079239994e0df10f19ea83e34eea2bad3168f2fc4000000008b4830450221008052d3b067418d53585fb8f91e1b57cf3c040dc9c07a70f393ed663b3f7502c50220749aa8e09ac922e78cb474c8097873cfb2634108d7acaa7db32a73a35743da974141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2cffffffff0f501c1be6601b0ed29bd579ae5be8e54842d3a3a2172734fc423fff48aca0e4010000008a473044022050d7fe7cdcec81eefa0987b88ddb83274d8e9063d927090dc4c2d1db76c512d302207dc1eea439a627476265ed87f59cc9823fb572ffc2640f0218d7bddc9a621c6e4141044eb40b025df18409f2a5197b010dd62a9e65d9a74e415e5b10367721a9c4baa7ebfee22d14b8ece1c9bd70c0d9e5e8b00b61b81b88a1b5ce6f24eac6b8a34b2cffffffff02c029cd02000000001976a9147ab928d0b41194411a2e87a782b688c7cc69ba4688acad1b0800000000001976a914f3707320bbb4a28759a78a5ad63a77a2f5d462ec88ac00000000',
|
||||
blockhash: '0000000000000000045e5e52fb4f9746b3d15d3062855fd346aaef3debef4360',
|
||||
confirmations: 71465,
|
||||
time: 1545564654,
|
||||
blocktime: 1545564654
|
||||
}
|
||||
|
||||
const mockNoTxHistory = {
|
||||
page: 1,
|
||||
totalPages: 1,
|
||||
itemsOnPage: 1000,
|
||||
address: 'bitcoincash:qqwfpk04ecf69wuprj9yjys9rla5mk7rj5j8uthqel',
|
||||
balance: '0',
|
||||
totalReceived: '0',
|
||||
totalSent: '0',
|
||||
unconfirmedBalance: '0',
|
||||
unconfirmedTxs: 0,
|
||||
txs: 0
|
||||
}
|
||||
|
||||
const mockNoSendBalance = {
|
||||
page: 1,
|
||||
totalPages: 1,
|
||||
itemsOnPage: 1000,
|
||||
address: 'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg',
|
||||
balance: '0',
|
||||
totalReceived: '0',
|
||||
totalSent: '0',
|
||||
unconfirmedBalance: '600',
|
||||
unconfirmedTxs: 1,
|
||||
txs: 0,
|
||||
txids: [
|
||||
'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
|
||||
]
|
||||
}
|
||||
|
||||
const mockNoSendTx = {
|
||||
txid: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
|
||||
hash: 'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023',
|
||||
version: 2,
|
||||
size: 226,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: '681cc1d392975a7e78cbd490b8a940d7eb029c554f2cee332e3a7119d77fb189',
|
||||
vout: 1,
|
||||
scriptSig: {
|
||||
asm: '30450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f[ALL|FORKID] 02bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7',
|
||||
hex: '4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7'
|
||||
},
|
||||
sequence: 4294967295
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: 0.000006,
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
asm: 'OP_DUP OP_HASH160 3c79ba54317c4be9cbfa5aaf357f74b97f3d9696 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: [
|
||||
'bitcoincash:qq78nwj5x97yh6wtlfd27dtlwjuh70vkjc59h8tgtg'
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
value: 0.00003664,
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
asm: 'OP_DUP OP_HASH160 58502a73888e0a386fc69b44850af4b2a86ac9a6 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: [
|
||||
'bitcoincash:qpv9q2nn3z8q5wr0c6d5fpg27je2s6kf5cavp4ney0'
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
hex: '020000000189b17fd719713a2e33ee2c4f559c02ebd740a9b890d4cb787e5a9792d3c11c68010000006b4830450221008a7c86ce3a9f5765573440143a00631bb5afa9a58b24674a7fa794bb11ffffc30220397dd4c672c3e0dbe0c4eb6390b5727c5fdc3a42cf3ae275ac13b44d27bb234f412102bc9fc26ae2bd9a9a14e9baeda4b4fdd95a00bcbf375732c647488b3ce82a2fd7ffffffff0258020000000000001976a9143c79ba54317c4be9cbfa5aaf357f74b97f3d969688ac500e0000000000001976a91458502a73888e0a386fc69b44850af4b2a86ac9a688ac00000000'
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockBalance,
|
||||
mockTxDetails,
|
||||
mockNoTxHistory,
|
||||
mockNoSendBalance,
|
||||
mockNoSendTx
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
/*
|
||||
Contains mocks of Express req and res objects.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const sinon = require('sinon')
|
||||
|
||||
// Inspect JS Objects.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = {
|
||||
showHidden: true,
|
||||
colors: true
|
||||
}
|
||||
|
||||
// mock for res.send()
|
||||
function fakeSend (arg) {
|
||||
// console.log(`res.send: ${util.inspect(arg)}`);
|
||||
mockRes.output = arg
|
||||
return arg
|
||||
}
|
||||
|
||||
// mock for res.json()
|
||||
function fakeJson (arg) {
|
||||
// console.log(`res.json: ${util.inspect(arg)}`);
|
||||
mockRes.output = arg
|
||||
return arg
|
||||
}
|
||||
|
||||
// mock for res.setStatus(num)
|
||||
const setStatusCode = arg => {
|
||||
mockRes.statusCode = arg
|
||||
}
|
||||
|
||||
const mockReq = {
|
||||
accepts: sinon.stub().returns({}),
|
||||
acceptsCharsets: sinon.stub().returns({}),
|
||||
acceptsEncodings: sinon.stub().returns({}),
|
||||
acceptsLanguages: sinon.stub().returns({}),
|
||||
body: {},
|
||||
flash: sinon.stub().returns({}),
|
||||
get: sinon.stub().returns({}),
|
||||
is: sinon.stub().returns({}),
|
||||
params: {},
|
||||
query: {},
|
||||
session: {},
|
||||
locals: {},
|
||||
headers: {}
|
||||
}
|
||||
|
||||
const mockRes = {
|
||||
append: sinon.stub().returns({}),
|
||||
attachement: sinon.stub().returns({}),
|
||||
clearCookie: sinon.stub().returns({}),
|
||||
cookie: sinon.stub().returns({}),
|
||||
download: sinon.stub().returns({}),
|
||||
end: sinon.stub().returns({}),
|
||||
get: sinon.stub().returns({}),
|
||||
headersSent: sinon.stub().returns({}),
|
||||
json: sinon.stub().callsFake(fakeJson),
|
||||
jsonp: sinon.stub().returns({}),
|
||||
links: sinon.stub().returns({}),
|
||||
locals: {},
|
||||
location: sinon.stub().returns({}),
|
||||
output: null, // Used for retrieving output data.
|
||||
redirect: sinon.stub().returns({}),
|
||||
render: sinon.stub().returns({}),
|
||||
send: sinon.stub().callsFake(fakeSend),
|
||||
sendFile: sinon.stub().returns({}),
|
||||
sendStatus: sinon.stub().returns({}),
|
||||
set: sinon.stub().returns({}),
|
||||
status: sinon.stub().callsFake(setStatusCode),
|
||||
statusCode: null, // Default value before calling stats();
|
||||
type: sinon.stub().returns({}),
|
||||
vary: sinon.stub().returns({}),
|
||||
write: sinon.stub().returns({}),
|
||||
setHeader: sinon.stub().returns({}),
|
||||
format: sinon.stub().returns({})
|
||||
}
|
||||
|
||||
// Dev-Note on Rate Limits: Since next() is mocked, I can call the Sinon untility
|
||||
// functions on it, like called(), to see if this stub was called.
|
||||
const mockNext = sinon.stub().returns()
|
||||
|
||||
module.exports = {
|
||||
mockReq,
|
||||
mockRes,
|
||||
mockNext
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockMiningInfo = {
|
||||
blocks: 1270185,
|
||||
currentblocksize: 0,
|
||||
currentblocktx: 0,
|
||||
difficulty: 1,
|
||||
warnings:
|
||||
"Warning: Unknown block versions being mined! It's possible unknown rules are in effect",
|
||||
networkhashps: 517410290.9365583,
|
||||
pooledtx: 5,
|
||||
chain: 'test'
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockMiningInfo
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockDecodeRawTransaction = {
|
||||
txid: 'a332237d82a2543af1b0e1ae3c8cea1610c290ebcaf084a7e9894a61de0be988',
|
||||
hash: 'a332237d82a2543af1b0e1ae3c8cea1610c290ebcaf084a7e9894a61de0be988',
|
||||
size: 226,
|
||||
version: 2,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: '21cced645eab150585ed7ca7c96edebab5793cc0a3b3b286c42fd7d6d798b5b9',
|
||||
vout: 1,
|
||||
scriptSig: {
|
||||
asm:
|
||||
'3045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd41390[ALL|FORKID] 0360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413d',
|
||||
hex:
|
||||
'483045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413d'
|
||||
},
|
||||
sequence: 4294967295
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: 0.0001,
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 eb4b180def88e3f5625b2d8ae2c098ff7d85f664 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: [Array]
|
||||
}
|
||||
},
|
||||
{
|
||||
value: 0.09989752,
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 eb4b180def88e3f5625b2d8ae2c098ff7d85f664 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: [Array]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const mockDecodeScript = {
|
||||
asm:
|
||||
'0 0 -57 OP_NOP6 OP_LSHIFT OP_UNKNOWN OP_UNKNOWN OP_UNKNOWN c486b2b3a3c03c79b5bade6ec9a77ced850515ab5e64edcc21010000006b483045022100a7b1b08956abb8d6f322aa OP_2OVER OP_NUMEQUALVERIFY OP_OR OP_INVERT OP_UNKNOWN OP_UNKNOWN 2ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab 67c57b2786f51c413dffffffff0210270000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac786e9800000000001976a914eb4b180def88e3f5625b [error]',
|
||||
type: 'nonstandard',
|
||||
p2sh: 'bchtest:pzy6dwfy6yf373w0dr05a6flfqksurjhwcl3awhdvm'
|
||||
}
|
||||
|
||||
const mockRawTransactionConcise =
|
||||
'02000000014e6b52500110b1c30315b85805fb274f0f4afceffc1589f889b27709e59e987d000000006a473044022052762770baa71c1a0b9544ad0f1ea343d32c22aa87c5f8397b6852f464c15b1e02201f4390745cb470e21e0e3c14229f39fef55ea0643a4c997f99d9f3501eae09b7412103c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792ffffffff02d1778f950a0000001976a91436d2f27bbd826a86db1e93618ce3de89ef33169388ac80969800000000001976a914152ea3cd65f18cb8fa9146c84ea1a97af8f051de88ac00000000'
|
||||
|
||||
const mockRawTransactionVerbose = {
|
||||
hex:
|
||||
'02000000014e6b52500110b1c30315b85805fb274f0f4afceffc1589f889b27709e59e987d000000006a473044022052762770baa71c1a0b9544ad0f1ea343d32c22aa87c5f8397b6852f464c15b1e02201f4390745cb470e21e0e3c14229f39fef55ea0643a4c997f99d9f3501eae09b7412103c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792ffffffff02d1778f950a0000001976a91436d2f27bbd826a86db1e93618ce3de89ef33169388ac80969800000000001976a914152ea3cd65f18cb8fa9146c84ea1a97af8f051de88ac00000000',
|
||||
txid: 'bd320377db7026a3dd5c7ec444596c0ee18fc25c4f34ee944adc03e432ce1971',
|
||||
hash: 'bd320377db7026a3dd5c7ec444596c0ee18fc25c4f34ee944adc03e432ce1971',
|
||||
size: 225,
|
||||
version: 2,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: '7d989ee50977b289f88915fceffc4a0f4f27fb0558b81503c3b1100150526b4e',
|
||||
vout: 0,
|
||||
scriptSig: {
|
||||
asm:
|
||||
'3044022052762770baa71c1a0b9544ad0f1ea343d32c22aa87c5f8397b6852f464c15b1e02201f4390745cb470e21e0e3c14229f39fef55ea0643a4c997f99d9f3501eae09b7[ALL|FORKID] 03c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792',
|
||||
hex:
|
||||
'473044022052762770baa71c1a0b9544ad0f1ea343d32c22aa87c5f8397b6852f464c15b1e02201f4390745cb470e21e0e3c14229f39fef55ea0643a4c997f99d9f3501eae09b7412103c346eee77a77a8d3e073dacc0532ca7a5b9747bc06d88bf091cac9f4bc8bb792'
|
||||
},
|
||||
sequence: 4294967295
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: 454.58880465,
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 36d2f27bbd826a86db1e93618ce3de89ef331693 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a91436d2f27bbd826a86db1e93618ce3de89ef33169388ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: ['bchtest:qqmd9unmhkpx4pkmr6fkrr8rm6y77vckjvqe8aey35']
|
||||
}
|
||||
},
|
||||
{
|
||||
value: 0.1,
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 152ea3cd65f18cb8fa9146c84ea1a97af8f051de OP_EQUALVERIFY OP_CHECKSIG',
|
||||
hex: '76a914152ea3cd65f18cb8fa9146c84ea1a97af8f051de88ac',
|
||||
reqSigs: 1,
|
||||
type: 'pubkeyhash',
|
||||
addresses: ['bchtest:qq2jag7dvhccew86j9rvsn4p49a03uz3mcpw3d6aca']
|
||||
}
|
||||
}
|
||||
],
|
||||
blockhash: '000000000000026fa244de975ca89ea08008aa566564ce2e8ebb3144361b601b',
|
||||
confirmations: 125,
|
||||
time: 1542646373,
|
||||
blocktime: 1542646373
|
||||
}
|
||||
|
||||
const mockWHDecode = {
|
||||
txid: 'f8a9857fe3b8a288b5fcafb1b0fc196731f433add6d962f77acd7c10b970ff89',
|
||||
fee: '500',
|
||||
sendingaddress: 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
|
||||
referenceaddress: 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
|
||||
ismine: false,
|
||||
version: 0,
|
||||
type_int: 0,
|
||||
type: 'Simple Send',
|
||||
propertyid: 368,
|
||||
precision: '8',
|
||||
amount: '10.00000000',
|
||||
valid: true,
|
||||
blockhash: '0000000046ba0bcef78caaa4492622176bbc563cf249ab52340a0449bc8e26f6',
|
||||
blocktime: 1542814183,
|
||||
positioninblock: 57,
|
||||
block: 1269008,
|
||||
confirmations: 2
|
||||
}
|
||||
|
||||
const mockWHCreateInput = {
|
||||
txid: 'f7ed9cf23dee85910f6269c9a101a75fcfd2f3c6fc81f17fad824ff7aaf99ab2',
|
||||
vout: 1,
|
||||
scriptPubKey: '76a914a4b98b0c118de83e7d39c834445f51dce62425f588ac',
|
||||
amount: 0.09984138,
|
||||
satoshis: 9984138,
|
||||
height: 1269011,
|
||||
confirmations: 4,
|
||||
legacyAddress: 'mvXwPH74hW2yVTWwDwzsjGoaUAqJvWk7ZJ',
|
||||
cashAddress: 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
|
||||
value: 0.09984138
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockDecodeRawTransaction,
|
||||
mockDecodeScript,
|
||||
mockRawTransactionConcise,
|
||||
mockRawTransactionVerbose,
|
||||
mockWHDecode,
|
||||
mockWHCreateInput
|
||||
}
|
||||
@@ -0,0 +1,537 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockList = {
|
||||
t: [
|
||||
{
|
||||
tokenDetails: {
|
||||
tokenIdHex:
|
||||
'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
|
||||
documentUri: '',
|
||||
documentSha256: '',
|
||||
symbol: 'NAKAMOTO',
|
||||
name: 'NAKAMOTO',
|
||||
decimals: 8
|
||||
},
|
||||
tokenStats: {
|
||||
qty_valid_txns_since_genesis: 241,
|
||||
qty_valid_token_utxos: 151,
|
||||
qty_valid_token_addresses: 113,
|
||||
qty_token_circulating_supply: '20995990',
|
||||
qty_token_burned: '4010',
|
||||
qty_token_minted: '21000000',
|
||||
qty_satoshis_locked_up: 81900
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const mockSingleToken = {
|
||||
t: [
|
||||
{
|
||||
tokenDetails: {
|
||||
decimals: 0,
|
||||
tokenIdHex:
|
||||
'38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||
timestamp: '2019-06-14 06:31:37',
|
||||
timestamp_unix: 1560493897,
|
||||
transactionType: 'GENESIS',
|
||||
versionType: 1,
|
||||
documentUri: 'ot@ot.com',
|
||||
documentSha256Hex: null,
|
||||
symbol: 'OT',
|
||||
name: 'Test First SLP oasis Token',
|
||||
batonVout: 2,
|
||||
containsBaton: true,
|
||||
genesisOrMintQuantity: '10000',
|
||||
sendOutputs: null
|
||||
},
|
||||
tokenStats: {
|
||||
block_created: 1308634,
|
||||
block_last_active_send: 1308655,
|
||||
block_last_active_mint: 1308636,
|
||||
qty_valid_txns_since_genesis: 11,
|
||||
qty_valid_token_utxos: 9,
|
||||
qty_valid_token_addresses: 2,
|
||||
qty_token_minted: '20000',
|
||||
qty_token_burned: '0',
|
||||
qty_token_circulating_supply: '20000',
|
||||
qty_satoshis_locked_up: 4914,
|
||||
minting_baton_status: 'ALIVE'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const mockSingleTokenError = {
|
||||
t: []
|
||||
}
|
||||
|
||||
const mockSingleAddress = {
|
||||
g: [
|
||||
{
|
||||
_id: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
|
||||
balanceString: '0.002382',
|
||||
slpAddress: 'simpleledger:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5me5fdrdn'
|
||||
}
|
||||
],
|
||||
t: [
|
||||
{
|
||||
tokenDetails: {
|
||||
decimals: 6,
|
||||
tokenIdHex:
|
||||
'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const mockTx = {
|
||||
txid: '57b3082a2bf269b3d6f40fee7fb9c664e8256a88ca5ee2697c05b9457822d446',
|
||||
version: 2,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
|
||||
vout: 2,
|
||||
sequence: 4294967295,
|
||||
n: 0,
|
||||
scriptSig: {
|
||||
hex:
|
||||
'4730440220409e79fec552f01203f41d3d621ae3db89c720af261c8268ce5f0453de009f5d022001e7ffefeba7b0716d32ea55cb6ace267b6ee9cbcc8a017bb9c3b6acf7889418412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
|
||||
asm:
|
||||
'30440220409e79fec552f01203f41d3d621ae3db89c720af261c8268ce5f0453de009f5d022001e7ffefeba7b0716d32ea55cb6ace267b6ee9cbcc8a017bb9c3b6acf7889418[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
|
||||
},
|
||||
value: 546,
|
||||
legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
|
||||
cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
|
||||
},
|
||||
{
|
||||
txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
|
||||
vout: 1,
|
||||
sequence: 4294967295,
|
||||
n: 1,
|
||||
scriptSig: {
|
||||
hex:
|
||||
'483045022100a743bee56c99bd103be48a78fa4c7342100815d9d2448dbe6e1d338c3a13b241022066728b5279fc22eef5cd019582ff34771e29175835fc98aa3168a1548fd78ac8412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
|
||||
asm:
|
||||
'3045022100a743bee56c99bd103be48a78fa4c7342100815d9d2448dbe6e1d338c3a13b241022066728b5279fc22eef5cd019582ff34771e29175835fc98aa3168a1548fd78ac8[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
|
||||
},
|
||||
value: 546,
|
||||
legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
|
||||
cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
|
||||
},
|
||||
{
|
||||
txid: '61e71554a3dc18158f30d9e8f5c9b6641a789690b32302899f81cbea9fe3bb49',
|
||||
vout: 3,
|
||||
sequence: 4294967295,
|
||||
n: 2,
|
||||
scriptSig: {
|
||||
hex:
|
||||
'483045022100821473902eec5f1ce7d43b1ba7f9ec453bfe8b8dfc3de3e0723c883ab109922f02206162960e80618531fab2c16aee260fddd7979bab62471c8686af7de75f8732ec412103c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585',
|
||||
asm:
|
||||
'3045022100821473902eec5f1ce7d43b1ba7f9ec453bfe8b8dfc3de3e0723c883ab109922f02206162960e80618531fab2c16aee260fddd7979bab62471c8686af7de75f8732ec[ALL|FORKID] 03c87f0ec048a0771bdb60533d45cac88c6974afeb055a65edd663c2f947335585'
|
||||
},
|
||||
value: 9997521,
|
||||
legacyAddress: 'mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL',
|
||||
cashAddress: 'bchtest:qz4qnxcxwvmacgye8wlakhz0835x0w3vtvaga95c09'
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: '0.00000000',
|
||||
n: 0,
|
||||
scriptPubKey: {
|
||||
hex:
|
||||
'6a04534c500001010453454e44207ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796080000000049504f80080000001c71e64280',
|
||||
asm:
|
||||
'OP_RETURN 5262419 1 1145980243 7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796 0000000049504f80 0000001c71e64280'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
},
|
||||
{
|
||||
value: '0.00000546',
|
||||
n: 1,
|
||||
scriptPubKey: {
|
||||
hex: '76a914396b8e57ad0cb58d30e2992f22047b3c20377aa688ac',
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 396b8e57ad0cb58d30e2992f22047b3c20377aa6 OP_EQUALVERIFY OP_CHECKSIG',
|
||||
addresses: ['mkkZf7T3fU3vHSzNPy51HBmM46ghN1gnN9'],
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
},
|
||||
{
|
||||
value: '0.00000546',
|
||||
n: 2,
|
||||
scriptPubKey: {
|
||||
hex: '76a914aa099b067337dc20993bbfdb5c4f3c6867ba2c5b88ac',
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 aa099b067337dc20993bbfdb5c4f3c6867ba2c5b OP_EQUALVERIFY OP_CHECKSIG',
|
||||
addresses: ['mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL'],
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
},
|
||||
{
|
||||
value: '0.09996891',
|
||||
n: 3,
|
||||
scriptPubKey: {
|
||||
hex: '76a914aa099b067337dc20993bbfdb5c4f3c6867ba2c5b88ac',
|
||||
asm:
|
||||
'OP_DUP OP_HASH160 aa099b067337dc20993bbfdb5c4f3c6867ba2c5b OP_EQUALVERIFY OP_CHECKSIG',
|
||||
addresses: ['mw22g57T9YA7MZQQu5eBDKj3PKTdt99oDL'],
|
||||
type: 'pubkeyhash'
|
||||
},
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
}
|
||||
],
|
||||
blockhash: '000000000000ce978accc64a6bb567acf0c653c202309a0f8e220149bf0c6968',
|
||||
blockheight: 1287490,
|
||||
confirmations: 746,
|
||||
time: 1550855104,
|
||||
blocktime: 1550855104,
|
||||
valueOut: 0.09997983,
|
||||
size: 628,
|
||||
valueIn: 0.09998613,
|
||||
fees: 0.0000063,
|
||||
tokenInfo: {
|
||||
versionType: 1,
|
||||
transactionType: 'SEND',
|
||||
tokenIdHex:
|
||||
'7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796',
|
||||
sendOutputs: ['0', '1230000000', '122170000000']
|
||||
},
|
||||
tokenIsValid: true
|
||||
}
|
||||
|
||||
const mockConvert = {
|
||||
slpAddress: 'slptest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2shlcycvd5',
|
||||
cashAddress: 'bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf',
|
||||
legacyAddress: 'mvQPGnzRT6gMWASZBMg7NcT3vmvsSKSQtf'
|
||||
}
|
||||
|
||||
const mockTokenDetails = {
|
||||
tokenIdHex:
|
||||
'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
|
||||
documentUri: '',
|
||||
symbol: 'NAKAMOTO',
|
||||
name: 'NAKAMOTO',
|
||||
decimals: 8,
|
||||
timestamp: '',
|
||||
containsBaton: true,
|
||||
versionType: 1
|
||||
}
|
||||
|
||||
const mockTokenStats = {
|
||||
qty_valid_txns_since_genesis: 241,
|
||||
qty_valid_token_utxos: 151,
|
||||
qty_valid_token_addresses: 113,
|
||||
qty_token_circulating_supply: '20995990',
|
||||
qty_token_burned: '4010',
|
||||
qty_token_minted: '21000000',
|
||||
qty_satoshis_locked_up: 81900
|
||||
}
|
||||
|
||||
const mockBalance = {
|
||||
_id: 'simpleledger:qp9d8mn8ypryfvea2mev0ggc3wg6plpn4suuaeuss3',
|
||||
token_balance: '1000'
|
||||
}
|
||||
|
||||
const mockTransactions = [
|
||||
{
|
||||
txid: 'a302f045be8efa1cd982833a7f187ff4fac8baac36da0c887eb2787d8b45e2af',
|
||||
tokenDetails: {
|
||||
valid: true,
|
||||
detail: {
|
||||
decimals: null,
|
||||
tokenIdHex:
|
||||
'495322b37d6b2eae81f045eda612b95870a0c2b6069c58f70cf8ef4e6a9fd43a',
|
||||
timestamp: null,
|
||||
transactionType: 'MINT',
|
||||
versionType: 1,
|
||||
documentUri: null,
|
||||
documentSha256Hex: null,
|
||||
symbol: null,
|
||||
name: null,
|
||||
batonVout: 2,
|
||||
containsBaton: true,
|
||||
genesisOrMintQuantity: {
|
||||
$numberDecimal: '1000'
|
||||
},
|
||||
sendOutputs: null
|
||||
},
|
||||
invalidReason: null,
|
||||
schema_version: 30
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
const mockFoobar = {
|
||||
c: [],
|
||||
u: []
|
||||
}
|
||||
|
||||
const mockSingleValidTxid = {
|
||||
c: [
|
||||
{
|
||||
_id: '5d965fc27f1cf2184ca2fe73',
|
||||
tx: {
|
||||
h: '77872738b6bddee6c0cbdb9509603de20b15d4f6b26602f629417aec2f5d5e8d'
|
||||
},
|
||||
slp: {
|
||||
valid: true,
|
||||
invalidReason: null
|
||||
}
|
||||
}
|
||||
],
|
||||
u: []
|
||||
}
|
||||
|
||||
const mockTwoValidTxid = {
|
||||
c: [
|
||||
{
|
||||
_id: '5d965fc27f1cf2184ca2fe73',
|
||||
tx: {
|
||||
h: '77872738b6bddee6c0cbdb9509603de20b15d4f6b26602f629417aec2f5d5e8d'
|
||||
},
|
||||
slp: {
|
||||
valid: true,
|
||||
invalidReason: null
|
||||
}
|
||||
},
|
||||
{
|
||||
_id: '5d71e69758380a002c492a90',
|
||||
tx: {
|
||||
h: '552112f9e458dc7d1d8b328b0a6685e8af74a64b60b6846e7c86407f27f47e42'
|
||||
},
|
||||
slp: {
|
||||
valid: true,
|
||||
invalidReason: null
|
||||
}
|
||||
}
|
||||
],
|
||||
u: []
|
||||
}
|
||||
|
||||
const mockTwoRedundentTxid = {
|
||||
c: [
|
||||
{
|
||||
_id: '5db99c72a391ae2afd604bde',
|
||||
tx: {
|
||||
h: 'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56'
|
||||
},
|
||||
slp: {
|
||||
valid: true,
|
||||
invalidReason: null
|
||||
}
|
||||
}
|
||||
],
|
||||
u: []
|
||||
}
|
||||
|
||||
const mockTxHistory = [
|
||||
{
|
||||
tx: {
|
||||
h: '3a7646b3976a8745928c7192c8dde989bfa275fa6d7bce950180ab8002cf6cef'
|
||||
},
|
||||
in: [
|
||||
{
|
||||
i: 0,
|
||||
e: {
|
||||
h: '7bdd586ebd1e5f3dfd5295ab6e896c48b25855ab77a72c035ce1e7aacc965c2d',
|
||||
i: 1,
|
||||
s: 'RzBEAiAsu5o9EnxgZChjxKygxhGLhlfxJJbQfd4PP/vp2od3fAIgPpMqg+Sp4YpiInQZ6weJwELq8LEIrHXJpueBz7yF5gRBIQLsyL3809mRphc/+tPAcTQO5bi0kqZRFKpKIHXE3qN8Rw==',
|
||||
a: 'simpleledger:qrrrpqmdkggpnw0czwg0jgcjd7yhu25jy5zxh2gqdq'
|
||||
}
|
||||
},
|
||||
{
|
||||
i: 1,
|
||||
e: {
|
||||
h: 'df49feff24dc34a10a44a0cbd7c908d964801ec7218512c84574fbce698535f0',
|
||||
i: 3,
|
||||
s: 'SDBFAiEAhW3zbKTlPrOXD2E2oEcNof6vCMPGYIg8vOVSE9c8IakCIFLg/gxydG9eL8HMAzkScGElKWJRnfhVMpMHU3evNcrZQSEDRS7F+pSC8OxSldsT4FctJLZBU7f2+FDiE05ae1xqtN0=',
|
||||
a: 'simpleledger:qpkpeqfslejw5pptzcy25h2jxhsc9k0vts43n26up0'
|
||||
}
|
||||
}
|
||||
],
|
||||
out: [
|
||||
{
|
||||
e: {
|
||||
v: 0,
|
||||
i: 0,
|
||||
s: 'agRTTFAAAQEEU0VORCA46XxdfTWFosvz+VgMgsozmF+csIRdTcziIMtwn5U4sAgAAAAAAJiWgAgAAAAAJHfU+g=='
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 546,
|
||||
i: 1,
|
||||
s: 'dqkUqo4lVohqOK6rDd7nIIkFQ6Uf41aIrA==',
|
||||
a: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza'
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 546,
|
||||
i: 2,
|
||||
s: 'dqkUgYSfxf90wVkERCiOMyh16iB4d92IrA==',
|
||||
a: 'simpleledger:qzqcf879la6vzkgygs5guvegwh4zq7rhm5nu0pljjl'
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 21849,
|
||||
i: 3,
|
||||
s: 'dqkUxjCDbbIQGbn4E5D5IxJviX4qkiWIrA==',
|
||||
a: 'simpleledger:qrrrpqmdkggpnw0czwg0jgcjd7yhu25jy5zxh2gqdq'
|
||||
}
|
||||
}
|
||||
],
|
||||
slp: {
|
||||
detail: {
|
||||
decimals: 8,
|
||||
tokenIdHex: '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||
transactionType: 'SEND',
|
||||
versionType: 1,
|
||||
documentUri: 'psfoundation.cash',
|
||||
documentSha256Hex: null,
|
||||
symbol: 'PSF',
|
||||
name: 'Permissionless Software Foundation',
|
||||
txnBatonVout: null,
|
||||
txnContainsBaton: false,
|
||||
outputs: [
|
||||
{
|
||||
address: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza',
|
||||
amount: '0.1'
|
||||
},
|
||||
{
|
||||
address: 'simpleledger:qzqcf879la6vzkgygs5guvegwh4zq7rhm5nu0pljjl',
|
||||
amount: '6.11833082'
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
blk: {
|
||||
h: '000000000000000001a47bf337ca211c1e7218234d0d70117c64d6f213f5dacb',
|
||||
i: 634833,
|
||||
t: 1589300214
|
||||
}
|
||||
},
|
||||
{
|
||||
tx: {
|
||||
h: '3b11b48cab1e7c8384facf482b3f6bfe659a58245ab4aa4147b42b5cb2a5fac5'
|
||||
},
|
||||
in: [
|
||||
{
|
||||
i: 0,
|
||||
e: {
|
||||
h: 'e4e1e1f6b502cbd42f69b919634cea3e37fc8595e6ca800e0a7d8f6dcdfb249e',
|
||||
i: 3,
|
||||
s: 'SDBFAiEAjCGRmU28x24LMTwg5XqC+fLf3zGhTYCsSWpmF8Eshq0CIAJhxAKMbwKWC4ASmjWzplpno2ch+hGNUD6HNWOdbd4SQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
},
|
||||
{
|
||||
i: 1,
|
||||
e: {
|
||||
h: '438420345dd8b7fb4ea74aaf2e3090f44899bf3c71662243946a441de6dae720',
|
||||
i: 2,
|
||||
s: 'SDBFAiEAhmLYL4QY3mvZo3/i0XG9PJAYMruw3MaGOLJ3Z4si7hwCIAaaGwRnj/cZK3L/KKFBoMtItpGRZ10GowNN//vgn6PKQSECeRsZo5Fl29g0A9bfJo1E/WIdowWBsLblyxWnEB7ViFE=',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
}
|
||||
],
|
||||
out: [
|
||||
{
|
||||
e: {
|
||||
v: 0,
|
||||
i: 0,
|
||||
s: 'agRTTFAAAQEEU0VORCCk+1wtoaoGTiUBikP5FlBABx2emEuhkMIip/WQU6+EsggAAAAAAA9CQAgAAAAXQnHEwA=='
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 546,
|
||||
i: 1,
|
||||
s: 'dqkUqo4lVohqOK6rDd7nIIkFQ6Uf41aIrA==',
|
||||
a: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza'
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 546,
|
||||
i: 2,
|
||||
s: 'dqkUWQQVny9pv6Y+76cSYzoNltwufoiIrA==',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
},
|
||||
{
|
||||
e: {
|
||||
v: 43074,
|
||||
i: 3,
|
||||
s: 'dqkUWQQVny9pv6Y+76cSYzoNltwufoiIrA==',
|
||||
a: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7'
|
||||
}
|
||||
}
|
||||
],
|
||||
slp: {
|
||||
detail: {
|
||||
decimals: 2,
|
||||
tokenIdHex: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
|
||||
transactionType: 'SEND',
|
||||
versionType: 1,
|
||||
documentUri: 'troutsblog.com',
|
||||
documentSha256Hex: null,
|
||||
symbol: 'TROUT',
|
||||
name: "Trout's test token",
|
||||
txnBatonVout: null,
|
||||
txnContainsBaton: false,
|
||||
outputs: [
|
||||
{
|
||||
address: 'simpleledger:qz4guf2k3p4r3t4tph0wwgyfq4p628lr2c0cvqplza',
|
||||
amount: '10000'
|
||||
},
|
||||
{
|
||||
address: 'simpleledger:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qznkmw3s7',
|
||||
amount: '998990000'
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
blk: {
|
||||
h: '000000000000000002a4ee2ed6fe8a764ffef0b2556f545ca0b3ef39ecd2b7c4',
|
||||
i: 634832,
|
||||
t: 1589297145
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
mockList,
|
||||
mockSingleToken,
|
||||
mockConvert,
|
||||
mockTokenDetails,
|
||||
mockTokenStats,
|
||||
mockTx,
|
||||
mockBalance,
|
||||
mockTransactions,
|
||||
mockSingleTokenError,
|
||||
mockSingleAddress,
|
||||
mockFoobar,
|
||||
mockSingleValidTxid,
|
||||
mockTwoValidTxid,
|
||||
mockTwoRedundentTxid,
|
||||
mockTxHistory
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
/*
|
||||
Mocks used for unit tests that interact with slpjs.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
// const sinon = require('sinon')
|
||||
// const proxyquire = require('proxyquire')
|
||||
const BigNumber = require('bignumber.js')
|
||||
const slpMocks = require('./slp-mocks')
|
||||
|
||||
// Mock the BitboxNetwork class.
|
||||
class BitboxNetwork {
|
||||
// constructor () {}
|
||||
|
||||
async getAllSlpBalancesAndUtxos (address) {
|
||||
return {
|
||||
satoshis_available_bch: 9996891,
|
||||
satoshis_in_slp_baton: 546,
|
||||
satoshis_in_slp_token: 546,
|
||||
satoshis_in_invalid_token_dag: 0,
|
||||
satoshis_in_invalid_baton_dag: 0,
|
||||
slpTokenBalances: {
|
||||
'7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796': new BigNumber(
|
||||
123400000000
|
||||
)
|
||||
},
|
||||
slpTokenUtxos: {
|
||||
'7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796': []
|
||||
},
|
||||
slpBatonUtxos: {
|
||||
'7ac7f4bb50b019fe0f5c81e3fc13fc0720e130282ea460768cafb49785eb2796': []
|
||||
},
|
||||
nonSlpUtxos: [{}],
|
||||
invalidTokenUtxos: [],
|
||||
invalidBatonUtxos: []
|
||||
}
|
||||
}
|
||||
|
||||
async getTokenInformation (txid) {
|
||||
BigNumber.set({ DECIMAL_PLACES: 8, ROUNDING_MODE: 4 })
|
||||
|
||||
const obj = {
|
||||
versionType: 1,
|
||||
transactionType: 0,
|
||||
symbol: 'SLPSDK',
|
||||
name: 'SLP SDK example using BITBOX',
|
||||
documentUri: 'developer.bitcoin.com',
|
||||
documentSha256: null,
|
||||
decimals: 8,
|
||||
batonVout: 2,
|
||||
containsBaton: true,
|
||||
genesisOrMintQuantity: new BigNumber(123400000000)
|
||||
}
|
||||
|
||||
return obj
|
||||
}
|
||||
|
||||
async getTransactionDetails (txid) {
|
||||
return slpMocks.mockTx
|
||||
}
|
||||
}
|
||||
|
||||
// Mock the slpjs library.
|
||||
const slpjs = {
|
||||
BitboxNetwork,
|
||||
slp: {},
|
||||
validator: {}
|
||||
}
|
||||
|
||||
module.exports = slpjs
|
||||
@@ -0,0 +1,74 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
/*
|
||||
const mockDetails = {
|
||||
txid: "6f235bd3a689f03c11969cd649ccad592462ca958bc519a30194e7a67b349a40",
|
||||
version: 2,
|
||||
locktime: 0,
|
||||
vin: [Array],
|
||||
vout: [Array],
|
||||
blockhash: "00000000e7232ff12462dedf9c11985f5b54202515277c337ccc59812758f28b",
|
||||
blockheight: 1270188,
|
||||
confirmations: 2,
|
||||
time: 1543436253,
|
||||
blocktime: 1543436253,
|
||||
valueOut: 450.78867333,
|
||||
size: 226,
|
||||
valueIn: 450.78867559,
|
||||
fees: 0.00000226
|
||||
}
|
||||
*/
|
||||
|
||||
const mockDetails = {
|
||||
txid: '6f235bd3a689f03c11969cd649ccad592462ca958bc519a30194e7a67b349a40',
|
||||
version: 2,
|
||||
locktime: 0,
|
||||
vin: [
|
||||
{
|
||||
txid: '273d616d1c48f4b075c497f36ffdc79da5c8d6ed75485808b3599aac504f8525',
|
||||
vout: 0,
|
||||
sequence: 4294967295,
|
||||
n: 0,
|
||||
scriptSig: [{}],
|
||||
addr: 'bchtest:qqmd9unmhkpx4pkmr6fkrr8rm6y77vckjvqe8aey35',
|
||||
valueSat: 45078867559,
|
||||
value: 450.78867559,
|
||||
doubleSpentTxID: null
|
||||
}
|
||||
],
|
||||
vout: [
|
||||
{
|
||||
value: '450.68867333',
|
||||
n: 0,
|
||||
scriptPubKey: [{}],
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
},
|
||||
{
|
||||
value: '0.10000000',
|
||||
n: 1,
|
||||
scriptPubKey: [{}],
|
||||
spentTxId: null,
|
||||
spentIndex: null,
|
||||
spentHeight: null
|
||||
}
|
||||
],
|
||||
blockhash: '00000000e7232ff12462dedf9c11985f5b54202515277c337ccc59812758f28b',
|
||||
blockheight: 1270188,
|
||||
confirmations: 3,
|
||||
time: 1543436253,
|
||||
blocktime: 1543436253,
|
||||
valueOut: 450.78867333,
|
||||
size: 226,
|
||||
valueIn: 450.78867559,
|
||||
fees: 0.00000226
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
mockDetails
|
||||
}
|
||||
@@ -0,0 +1,130 @@
|
||||
/*
|
||||
This library contains mocking data for running unit tests on the address route.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const mockAddress = {
|
||||
isvalid: true,
|
||||
address: 'bchtest:qqqk4y6lsl5da64sg5qc3xezmplyu5kmpyz2ysaa5y',
|
||||
scriptPubKey: '76a914016a935f87e8deeab04501889b22d87e4e52db0988ac',
|
||||
ismine: false,
|
||||
iswatchonly: false,
|
||||
isscript: false
|
||||
}
|
||||
|
||||
const mockBalance = {
|
||||
page: 1,
|
||||
totalPages: 1,
|
||||
itemsOnPage: 1000,
|
||||
address: 'bitcoincash:qzp7gdl52edm24xlpkyqnza9rv33u3mdxyc77j3u6k',
|
||||
balance: '2546',
|
||||
totalReceived: '2546',
|
||||
totalSent: '0',
|
||||
unconfirmedBalance: '0',
|
||||
unconfirmedTxs: 0,
|
||||
txs: 2,
|
||||
txids: [
|
||||
'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||
'44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6'
|
||||
]
|
||||
}
|
||||
|
||||
const mockUtxos = [
|
||||
{
|
||||
txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||
vout: 0,
|
||||
value: '2000',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 2000
|
||||
},
|
||||
{
|
||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||
vout: 1,
|
||||
value: '546',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 546
|
||||
}
|
||||
]
|
||||
|
||||
const mockThreeUtxos = [
|
||||
{
|
||||
txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||
vout: 0,
|
||||
value: '2000',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 2000
|
||||
},
|
||||
{
|
||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||
vout: 1,
|
||||
value: '546',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 546
|
||||
},
|
||||
{
|
||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||
vout: 1,
|
||||
value: '546',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 546
|
||||
}
|
||||
]
|
||||
|
||||
const mockIsTokenUtxos = [
|
||||
false,
|
||||
{
|
||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||
vout: 1,
|
||||
value: '546',
|
||||
height: 605873,
|
||||
confirmations: 298,
|
||||
satoshis: 546,
|
||||
utxoType: 'token',
|
||||
transactionType: 'send',
|
||||
tokenId: '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
|
||||
tokenTicker: 'TOK-CH',
|
||||
tokenName: 'TokyoCash',
|
||||
tokenDocumentUrl: '',
|
||||
tokenDocumentHash: '',
|
||||
decimals: 8,
|
||||
tokenQty: 2
|
||||
}
|
||||
]
|
||||
|
||||
const tapUtxo = {
|
||||
txid: '2e030df12390186baf817fa2760540b886511e04bc520e88f6b4c2124cc2a7d4',
|
||||
vout: 1,
|
||||
value: '546',
|
||||
height: 606564,
|
||||
confirmations: 3,
|
||||
satoshis: 546,
|
||||
utxoType: 'token',
|
||||
transactionType: 'send',
|
||||
tokenId: 'dd84ca78db4d617221b58eabc6667af8fe2f7eadbfcc213d35be9f1b419beb8d',
|
||||
tokenTicker: 'TAP',
|
||||
tokenName: 'Thoughts and Prayers',
|
||||
tokenDocumentUrl: '',
|
||||
tokenDocumentHash: '',
|
||||
decimals: 0,
|
||||
tokenQty: 1
|
||||
}
|
||||
|
||||
const tokensOnly = [mockIsTokenUtxos[1], tapUtxo]
|
||||
|
||||
const multipleTokens = [false, mockIsTokenUtxos[1], tapUtxo]
|
||||
|
||||
module.exports = {
|
||||
mockAddress,
|
||||
mockBalance,
|
||||
mockUtxos,
|
||||
mockThreeUtxos,
|
||||
mockIsTokenUtxos,
|
||||
tokensOnly,
|
||||
multipleTokens
|
||||
}
|
||||
@@ -0,0 +1,460 @@
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
// const nock = require('nock') // HTTP mocking
|
||||
const sinon = require('sinon')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes, mockNext } = require('./mocks/express-mocks')
|
||||
|
||||
// Libraries under test
|
||||
const RateLimits = require('../../src/middleware/route-ratelimit')
|
||||
let rateLimits = new RateLimits()
|
||||
|
||||
// const controlRoute = require('../../src/routes/v3/full-node/control')
|
||||
const jwtAuth = require('../../src/middleware/jwt-auth')
|
||||
|
||||
let req, res, next
|
||||
// let originalEnvVars // Used during transition from integration to unit tests.
|
||||
|
||||
// JWT token used in tests.
|
||||
const jwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkYWRlM2Y1NzM5ZTZjMGZmMDM0YjlhMSIsImlhdCI6MTU3MTY3NzQ1MCwiZXhwIjoxNTc0MjY5NDUwfQ.SSz7F7ETyBB3eoNG2VKCzPOhddtB-vrtmEoj7PxicrQ'
|
||||
|
||||
describe('#route-ratelimits & jwt-auth', () => {
|
||||
let sandbox
|
||||
|
||||
before(async () => {
|
||||
// Save existing environment variables.
|
||||
// originalEnvVars = {
|
||||
// BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
||||
// RPC_BASEURL: process.env.RPC_BASEURL,
|
||||
// RPC_USERNAME: process.env.RPC_USERNAME,
|
||||
// RPC_PASSWORD: process.env.RPC_PASSWORD
|
||||
// }
|
||||
|
||||
if (!process.env.JWT_AUTH_SERVER) { process.env.JWT_AUTH_SERVER = 'http://fakeurl.com/' }
|
||||
|
||||
// Wipe the Redis DB, which prevents false negatives when running integration
|
||||
// tests back-to-back.
|
||||
await rateLimits.wipeRedis()
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = Object.assign({}, mockReq)
|
||||
res = Object.assign({}, mockRes)
|
||||
next = mockNext
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
req.locals = {}
|
||||
|
||||
sandbox = sinon.createSandbox()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
after(() => {
|
||||
rateLimits.closeRedis()
|
||||
})
|
||||
|
||||
describe('#jwt-auth.js', () => {
|
||||
describe('#getTokenFromHeaders', () => {
|
||||
it('should populate the req.locals object correctly', () => {
|
||||
// Initialize req.locals
|
||||
req.locals = {
|
||||
proLimit: false,
|
||||
apiLevel: 0
|
||||
}
|
||||
|
||||
const header = `Token ${jwt}`
|
||||
req.headers.authorization = header
|
||||
|
||||
jwtAuth.getTokenFromHeaders(req, res, next)
|
||||
|
||||
// console.log(`req.locals: ${JSON.stringify(req.locals, null, 2)}`)
|
||||
|
||||
assert.property(req.locals, 'proLimit')
|
||||
assert.property(req.locals, 'apiLevel')
|
||||
assert.property(req.locals, 'jwtToken')
|
||||
assert.equal(req.locals.jwtToken, jwt)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getResource', () => {
|
||||
it('should decode a blockchain request', () => {
|
||||
const url =
|
||||
'/blockchain/getTxOut/62a3ea958a463a372bc0caf2c374a7f60be9c624be63a0db8db78f05809df6d8/0?include_mempool=true'
|
||||
|
||||
const result = rateLimits.getResource(url)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result, 'blockchain')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#calcPoints', () => {
|
||||
it('should return 30 points for anonymous user', () => {
|
||||
const result = rateLimits.calcPoints()
|
||||
// console.log(`result: ${result}`)
|
||||
|
||||
assert.equal(result, 30)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'blockchain',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'blockbook',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 10 points for free tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
resource: 'slp',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 point for full node tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'blockchain',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
|
||||
it('should return 10 points for full-node tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'blockbook',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 10 points for full node tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
resource: 'slp',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 10)
|
||||
})
|
||||
|
||||
it('should return 1 point for indexer tier requesting full node access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 30,
|
||||
resource: 'blockchain',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
|
||||
it('should return 1 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', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'blockchain',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
|
||||
it('should return 1 points for SLP tier requesting indexer access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'blockbook',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
|
||||
it('should return 1 points for SLP tier requesting SLPDB access', () => {
|
||||
const jwtInfo = {
|
||||
apiLevel: 40,
|
||||
resource: 'slp',
|
||||
id: '5e3a0415eb29a962da2708b4'
|
||||
}
|
||||
|
||||
const result = rateLimits.calcPoints(jwtInfo)
|
||||
assert.equal(result, 1)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#rateLimitByResource', () => {
|
||||
// NOTE: this test will fail if you run multiple integration tests in a
|
||||
// short period. Because it talks to the Redis DB.
|
||||
it('should pass through rate-limit middleware', async () => {
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
// Call the route twice to trigger the rate handling.
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
|
||||
// next() will be called if rate-limit is not triggered
|
||||
assert.equal(next.called, true)
|
||||
})
|
||||
|
||||
it('should trigger rate-limit handler if rate limits exceeds 5 request per minute', async () => {
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
for (let i = 0; i < 5; i++) {
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
// console.log(`next() called: ${next.called}`)
|
||||
}
|
||||
|
||||
// Note: next() will be called unless the rate-limit kicks in.
|
||||
assert.equal(
|
||||
next.called,
|
||||
false,
|
||||
'next should not be called if rate limit was triggered.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should NOT trigger rate-limit for free-tier at 5 RPM', async () => {
|
||||
// Create a new instance of the rate limit so we start with zeroed tracking.
|
||||
rateLimits = new RateLimits()
|
||||
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
req.locals.jwtToken = 'some-token'
|
||||
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
id: '5e3a0415eb29a962da2708b1'
|
||||
}
|
||||
|
||||
// Mock the call to the jwt library.
|
||||
sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
|
||||
|
||||
for (let i = 0; i < 5; i++) {
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
// console.log(`next() called: ${next.called}`)
|
||||
}
|
||||
|
||||
// console.log(`req.locals after test: ${util.inspect(req.locals)}`)
|
||||
|
||||
// Note: next() will be called unless the rate-limit kicks in.
|
||||
assert.equal(
|
||||
next.called,
|
||||
true,
|
||||
'next should be called if rate limit was not triggered.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should trigger rate-limit for free tier after 10 RPM', async () => {
|
||||
// Create a new instance of the rate limit so we start with zeroed tracking.
|
||||
rateLimits = new RateLimits()
|
||||
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
req.locals.jwtToken = 'some-token'
|
||||
|
||||
const jwtInfo = {
|
||||
apiLevel: 10,
|
||||
id: '5e3a0415eb29a962da2708b2'
|
||||
}
|
||||
|
||||
// Mock the call to the jwt library.
|
||||
sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
|
||||
|
||||
for (let i = 0; i < 12; i++) {
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
// console.log(`next() called: ${next.called}`)
|
||||
}
|
||||
|
||||
// Note: next() will be called unless the rate-limit kicks in.
|
||||
assert.equal(
|
||||
next.called,
|
||||
false,
|
||||
'next should not be called if rate limit was triggered.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should NOT trigger rate-limit handler for indexer-tier at 25 RPM', async () => {
|
||||
// Create a new instance of the rate limit so we start with zeroed tracking.
|
||||
rateLimits = new RateLimits()
|
||||
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
req.locals.jwtToken = 'some-token'
|
||||
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
id: '5e3a0415eb29a962da2708b3'
|
||||
}
|
||||
|
||||
// Mock the call to the jwt library.
|
||||
sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
|
||||
|
||||
for (let i = 0; i < 25; i++) {
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
// console.log(`next() called: ${next.called}`)
|
||||
}
|
||||
|
||||
// console.log(`req.locals after test: ${util.inspect(req.locals)}`)
|
||||
|
||||
// Note: next() will be called unless the rate-limit kicks in.
|
||||
assert.equal(
|
||||
next.called,
|
||||
true,
|
||||
'next should be called if rate limit was not triggered.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should still rate-limit at a higher RPM for pro-tier', async () => {
|
||||
// Create a new instance of the rate limit so we start with zeroed tracking.
|
||||
rateLimits = new RateLimits()
|
||||
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
req.locals.jwtToken = 'some-token'
|
||||
|
||||
const jwtInfo = {
|
||||
apiLevel: 20,
|
||||
id: '5e3a0415eb29a962da2708b5'
|
||||
}
|
||||
|
||||
// Mock the call to the jwt library.
|
||||
sandbox.stub(rateLimits.jwt, 'verify').returns(jwtInfo)
|
||||
|
||||
for (let i = 0; i < 150; i++) {
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
// console.log(`next() called: ${next.called}`)
|
||||
}
|
||||
|
||||
// console.log(`req.locals after test: ${util.inspect(req.locals)}`)
|
||||
|
||||
// Note: next() will be called unless the rate-limit kicks in.
|
||||
assert.equal(
|
||||
next.called,
|
||||
false,
|
||||
'next should NOT be called if rate limit was triggered.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should handle misconfigured token secret', async () => {
|
||||
// Create a new instance of the rate limit so we start with zeroed tracking.
|
||||
rateLimits = new RateLimits()
|
||||
|
||||
req.baseUrl = '/v3'
|
||||
req.path = '/control/getNetworkInfo'
|
||||
req.url = req.path
|
||||
req.method = 'GET'
|
||||
|
||||
req.locals.jwtToken = 'some-token'
|
||||
|
||||
next.reset() // reset the stubbed next() function.
|
||||
|
||||
await rateLimits.rateLimitByResource(req, res, next)
|
||||
|
||||
// Issues with token secret should treat incoming requests as anonymous
|
||||
// calls with 30 points or 3 RPM.
|
||||
assert.equal(res.locals.pointsToConsume, 30)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
// Generates a Basic authorization header.
|
||||
// function generateAuthHeader (pass) {
|
||||
// // https://en.wikipedia.org/wiki/Basic_access_authentication
|
||||
// const username = 'BITBOX'
|
||||
// const combined = `${username}:${pass}`
|
||||
//
|
||||
// var base64Credential = Buffer.from(combined).toString('base64')
|
||||
// var readyCredential = `Basic ${base64Credential}`
|
||||
//
|
||||
// return readyCredential
|
||||
// }
|
||||
File diff suppressed because it is too large
Load Diff
+1405
File diff suppressed because it is too large
Load Diff
+546
@@ -0,0 +1,546 @@
|
||||
/*
|
||||
TESTS FOR THE UTIL.TS LIBRARY
|
||||
|
||||
This test file uses the environment variable TEST to switch between unit
|
||||
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||
to 'integration' to run the tests against BCH mainnet.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
const utilRoute = require('../../src/routes/v3/util')
|
||||
const nock = require('nock') // HTTP mocking
|
||||
const sinon = require('sinon')
|
||||
|
||||
let originalEnvVars // Used during transition from integration to unit tests.
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||
const mockData = require('./mocks/util-mocks')
|
||||
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
// const UtilRoute = utilRoute.UtilRoute
|
||||
const utilRouteInst = new utilRoute.UtilRoute()
|
||||
|
||||
describe('#Util', () => {
|
||||
let req, res
|
||||
let sandbox
|
||||
|
||||
before(() => {
|
||||
// Save existing environment variables.
|
||||
originalEnvVars = {
|
||||
BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
||||
RPC_BASEURL: process.env.RPC_BASEURL,
|
||||
RPC_USERNAME: process.env.RPC_USERNAME,
|
||||
RPC_PASSWORD: process.env.RPC_PASSWORD
|
||||
}
|
||||
|
||||
// Set default environment variables for unit tests.
|
||||
if (!process.env.TEST) process.env.TEST = 'unit'
|
||||
if (process.env.TEST === 'unit') {
|
||||
process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api'
|
||||
process.env.RPC_USERNAME = 'fakeusername'
|
||||
process.env.RPC_PASSWORD = 'fakepassword'
|
||||
}
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
|
||||
// Activate nock if it's inactive.
|
||||
if (!nock.isActive()) nock.activate()
|
||||
|
||||
sandbox = sinon.createSandbox()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
// Clean up HTTP mocks.
|
||||
nock.cleanAll() // clear interceptor list.
|
||||
nock.restore()
|
||||
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
after(() => {
|
||||
// Restore any pre-existing environment variables.
|
||||
process.env.BITCOINCOM_BASEURL = originalEnvVars.BITCOINCOM_BASEURL
|
||||
process.env.RPC_BASEURL = originalEnvVars.RPC_BASEURL
|
||||
process.env.RPC_USERNAME = originalEnvVars.RPC_USERNAME
|
||||
process.env.RPC_PASSWORD = originalEnvVars.RPC_PASSWORD
|
||||
})
|
||||
|
||||
describe('#root', async () => {
|
||||
// root route handler.
|
||||
const root = utilRouteInst.root
|
||||
|
||||
it('should respond to GET for base route', async () => {
|
||||
const result = root(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.equal(result.status, 'util', 'Returns static string')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#validateAddressSingle', async () => {
|
||||
const validateAddress = utilRouteInst.validateAddressSingle
|
||||
|
||||
it('should throw an error for an empty address', async () => {
|
||||
const result = await validateAddress(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'address can not be empty',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw 503 when network issues', async () => {
|
||||
// Save the existing RPC URL.
|
||||
const savedUrl2 = process.env.RPC_BASEURL
|
||||
|
||||
// Manipulate the URL to cause a 500 network error.
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||
|
||||
req.params.address = 'bchtest:qqqk4y6lsl5da64sg5qc3xezmplyu5kmpyz2ysaa5y'
|
||||
|
||||
await validateAddress(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.RPC_BASEURL = savedUrl2
|
||||
|
||||
assert.isAbove(
|
||||
res.statusCode,
|
||||
499,
|
||||
'HTTP status code 500 or greater expected.'
|
||||
)
|
||||
// assert.include(result.error,"Network error: Could not communicate with full node","Error message expected")
|
||||
})
|
||||
|
||||
it('should validate address', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
|
||||
req.params.address = 'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
|
||||
const result = await validateAddress(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAnyKeys(result, [
|
||||
'isvalid',
|
||||
'address',
|
||||
'scriptPubKey',
|
||||
'ismine',
|
||||
'iswatchonly',
|
||||
'isscript'
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe('#validateAddressBulk', async () => {
|
||||
const validateAddressBulk = utilRouteInst.validateAddressBulk
|
||||
|
||||
it('should throw an error for an empty body', async () => {
|
||||
const result = await validateAddressBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'addresses needs to be an array. Use GET for single address.',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should error on non-array single address', async () => {
|
||||
req.body = {
|
||||
addresses: 'bchtest:qqqk4y6lsl5da64sg5qc3xezmplyu5kmpyz2ysaa5y'
|
||||
}
|
||||
|
||||
const result = await validateAddressBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'addresses needs to be an array. Use GET for single address.',
|
||||
'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 validateAddressBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'Array too large')
|
||||
})
|
||||
|
||||
it('should error on invalid address', async () => {
|
||||
req.body = {
|
||||
addresses: ['bchtest:qqqk4y6lsl5da64sg5qc3xezmpl']
|
||||
}
|
||||
|
||||
const result = await validateAddressBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Invalid BCH address. Double check your address is valid',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should error on mainnet address when using testnet', async () => {
|
||||
req.body = {
|
||||
addresses: ['bchtest:qrls6vzjkkxlds7aqv9075u0fttwc7u9jvczn5fdt9']
|
||||
}
|
||||
|
||||
const result = await validateAddressBulk(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Invalid network. Trying to use a testnet address on mainnet, or vice versa.',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw 503 when network issues', async () => {
|
||||
// Save the existing RPC URL.
|
||||
const savedUrl2 = process.env.RPC_BASEURL
|
||||
|
||||
// Manipulate the URL to cause a 500 network error.
|
||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||
|
||||
req.body.addresses = [
|
||||
'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
]
|
||||
|
||||
await validateAddressBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.RPC_BASEURL = savedUrl2
|
||||
|
||||
assert.isAbove(
|
||||
res.statusCode,
|
||||
499,
|
||||
'HTTP status code 500 or greater expected.'
|
||||
)
|
||||
})
|
||||
|
||||
it('should validate a single address', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
|
||||
req.body.addresses = [
|
||||
'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
]
|
||||
|
||||
const result = await validateAddressBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.isArray(result)
|
||||
assert.hasAnyKeys(result[0], [
|
||||
'isvalid',
|
||||
'address',
|
||||
'scriptPubKey',
|
||||
'ismine',
|
||||
'iswatchonly',
|
||||
'isscript'
|
||||
])
|
||||
})
|
||||
|
||||
it('should validate a multiple addresses', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
if (process.env.TEST === 'unit') {
|
||||
nock(`${process.env.RPC_BASEURL}`)
|
||||
.post(uri => uri.includes('/'))
|
||||
.times(2)
|
||||
.reply(200, { result: mockData.mockAddress })
|
||||
}
|
||||
|
||||
req.body.addresses = [
|
||||
'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd',
|
||||
'bitcoincash:qpujxqra3jmdlzzapwmmt7uspr7q0c9ff5hzljcrnd'
|
||||
]
|
||||
|
||||
const result = await validateAddressBulk(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.isArray(result)
|
||||
assert.hasAnyKeys(result[0], [
|
||||
'isvalid',
|
||||
'address',
|
||||
'scriptPubKey',
|
||||
'ismine',
|
||||
'iswatchonly',
|
||||
'isscript'
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe('#sweepWif', () => {
|
||||
it('should throw 400 if WIF is not included', async () => {
|
||||
req.body = {}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'WIF needs to a proper compressed WIF starting with K or L',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw 400 if WIF is malformed', async () => {
|
||||
req.body = {
|
||||
wif: 'abc123'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'WIF needs to a proper compressed WIF starting with K or L',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
it('should throw 400 if destination address is not included', async () => {
|
||||
req.body = {
|
||||
wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'address can not be empty',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
|
||||
// Unit test only.
|
||||
if (process.env.TEST === 'unit') {
|
||||
it('should generate transaction for valid token sweep', async () => {
|
||||
// Mock the RPC call for unit tests.
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||
.resolves(mockData.mockIsTokenUtxos)
|
||||
|
||||
// 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',
|
||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
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') {
|
||||
sandbox
|
||||
.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')
|
||||
|
||||
req.body = {
|
||||
wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
|
||||
balanceOnly: true
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
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'
|
||||
)
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||
.resolves([false, false])
|
||||
|
||||
// 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',
|
||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(result, 'test-txid')
|
||||
})
|
||||
|
||||
it('should throw 422 error if no non-token UTXOs', async () => {
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||
.resolves(mockData.tokensOnly)
|
||||
|
||||
// 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',
|
||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(res.statusCode, 422)
|
||||
assert.property(result, 'error')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Tokens found, but no BCH UTXOs found. Add BCH to wallet to move tokens'
|
||||
)
|
||||
})
|
||||
|
||||
it('should detect and throw error for multiple token classes', async () => {
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'balanceFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockBalance)
|
||||
|
||||
sandbox
|
||||
.stub(
|
||||
utilRouteInst.blockbook,
|
||||
'utxosFromBlockbook'
|
||||
)
|
||||
.resolves(mockData.mockThreeUtxos)
|
||||
|
||||
// Force token utxo to appear as regular BCH utxo.
|
||||
sandbox
|
||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||
.resolves(mockData.multipleTokens)
|
||||
|
||||
// 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',
|
||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||
}
|
||||
|
||||
const result = await utilRouteInst.sweepWif(req, res)
|
||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||
|
||||
assert.equal(res.statusCode, 422)
|
||||
assert.property(result, 'error')
|
||||
assert.include(
|
||||
result.error,
|
||||
'Multiple token classes detected. This function only supports a single class of token'
|
||||
)
|
||||
})
|
||||
}
|
||||
})
|
||||
})
|
||||
+143
@@ -0,0 +1,143 @@
|
||||
/*
|
||||
TESTS FOR THE XPUB.JS LIBRARY
|
||||
|
||||
This test file uses the environment variable TEST to switch between unit
|
||||
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||
to 'integration' to run the tests against BCH mainnet.
|
||||
*/
|
||||
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const assert = chai.assert
|
||||
const xpubRoute = require('../../src/routes/v3/xpub')
|
||||
const nock = require('nock') // HTTP mocking
|
||||
|
||||
// let originalUrl // Used during transition from integration to unit tests.
|
||||
|
||||
// Mocking data.
|
||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||
// const mockData = require('./mocks/address-mock')
|
||||
|
||||
// Used for debugging.
|
||||
const util = require('util')
|
||||
util.inspect.defaultOptions = { depth: 1 }
|
||||
|
||||
describe('#XPUBRouter', () => {
|
||||
let req, res
|
||||
|
||||
before(() => {
|
||||
// Set default environment variables for unit tests.
|
||||
if (!process.env.TEST) process.env.TEST = 'unit'
|
||||
// if (process.env.TEST === "unit")
|
||||
// process.env.BITCOINCOM_BASEURL = "http://fakeurl/api
|
||||
})
|
||||
|
||||
// Setup the mocks before each test.
|
||||
beforeEach(() => {
|
||||
// Mock the req and res objects used by Express routes.
|
||||
req = mockReq
|
||||
res = mockRes
|
||||
|
||||
// Explicitly reset the parmas and body.
|
||||
req.params = {}
|
||||
req.body = {}
|
||||
req.query = {}
|
||||
|
||||
// Activate nock if it's inactive.
|
||||
if (!nock.isActive()) nock.activate()
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
// Clean up HTTP mocks.
|
||||
nock.cleanAll() // clear interceptor list.
|
||||
nock.restore()
|
||||
})
|
||||
|
||||
after(() => {
|
||||
// process.env.BITCOINCOM_BASEURL = originalUrl
|
||||
})
|
||||
|
||||
describe('#root', () => {
|
||||
// root route handler.
|
||||
const root = xpubRoute.testableComponents.root
|
||||
|
||||
it('should respond to GET for base route', async () => {
|
||||
const result = root(req, res)
|
||||
|
||||
assert.equal(result.status, 'address', 'Returns static string')
|
||||
})
|
||||
})
|
||||
|
||||
describe('#FromXPubSingle', () => {
|
||||
// details route handler.
|
||||
const fromXPubSingle = xpubRoute.testableComponents.fromXPubSingle
|
||||
|
||||
it('should throw 400 if xpub is empty', async () => {
|
||||
const result = await fromXPubSingle(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
assert.hasAllKeys(result, ['error'])
|
||||
assert.include(result.error, 'xpub can not be empty')
|
||||
})
|
||||
|
||||
it('should error on an array', async () => {
|
||||
req.params.xpub = [
|
||||
'tpubDHTK2jqg73w3GwoiHfAMbMYML1HN8FhrUxD9rFgbSgHXdwwrY6pAFqKDfUHhqw7vreaZty5hPGjb1S7ZPQeMmu6TFHAKfY9tJpYbvaGjPRM'
|
||||
]
|
||||
|
||||
const result = await fromXPubSingle(req, res)
|
||||
|
||||
assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
|
||||
assert.include(
|
||||
result.error,
|
||||
'xpub can not be an array',
|
||||
'Proper error message'
|
||||
)
|
||||
})
|
||||
/*
|
||||
it("should throw 500 when network issues", async () => {
|
||||
const savedUrl = process.env.BITCOINCOM_BASEURL
|
||||
|
||||
try {
|
||||
req.params.xpub = `tpubDHTK2jqg73w3GwoiHfAMbMYML1HN8FhrUxD9rFgbSgHXdwwrY6pAFqKDfUHhqw7vreaZty5hPGjb1S7ZPQeMmu6TFHAKfY9tJpYbvaGjPRM`
|
||||
|
||||
// Switch the Insight URL to something that will error out.
|
||||
process.env.BITCOINCOM_BASEURL = "http://fakeurl/api/"
|
||||
|
||||
const result = await fromXPubSingle(req, res)
|
||||
|
||||
// Restore the saved URL.
|
||||
process.env.BITCOINCOM_BASEURL = savedUrl
|
||||
|
||||
assert.equal(res.statusCode, 500, "HTTP status code 500 expected.")
|
||||
assert.include(result.error, "ENOTFOUND", "Error message expected")
|
||||
} catch (err) {
|
||||
// Restore the saved URL.
|
||||
process.env.BITCOINCOM_BASEURL = savedUrl
|
||||
}
|
||||
})
|
||||
*/
|
||||
it('should create an address from xpub', async () => {
|
||||
req.params.xpub = 'tpubDHTK2jqg73w3GwoiHfAMbMYML1HN8FhrUxD9rFgbSgHXdwwrY6pAFqKDfUHhqw7vreaZty5hPGjb1S7ZPQeMmu6TFHAKfY9tJpYbvaGjPRM'
|
||||
|
||||
// Mock the Insight URL for unit tests.
|
||||
// TODO add unit test
|
||||
// if (process.env.TEST === "unit") {
|
||||
// nock(`${process.env.BITCOINCOM_BASEURL}`)
|
||||
// .get(
|
||||
// `/txs/?address=bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4&pageNum=0`
|
||||
// )
|
||||
// .reply(200, mockData.mockTransactions)
|
||||
// }
|
||||
|
||||
// Call the details API.
|
||||
const result = await fromXPubSingle(req, res)
|
||||
// console.log(`result: ${util.inspect(result)}`)
|
||||
|
||||
// Assert that required fields exist in the returned object.
|
||||
assert.exists(result.legacyAddress)
|
||||
assert.exists(result.cashAddress)
|
||||
})
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user