mirror of
https://github.com/fullstack-cash/bch-api.git
synced 2026-09-22 09:12:05 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84df2be3b8 | ||
|
|
17376d9dba | ||
|
|
4289cf4f7c | ||
|
|
f04449be72 | ||
|
|
a0f9d065f9 | ||
|
|
20f2e20bcb | ||
|
|
b410b501a1 | ||
|
|
31d430e30e | ||
|
|
82d8e39ca4 | ||
|
|
e60f4ff144 | ||
|
|
156ea0ef30 | ||
|
|
7ec6435f37 | ||
|
|
6da385c90e | ||
|
|
7eca556322 | ||
|
|
99a6f88a92 | ||
|
|
ef4a3299ed | ||
|
|
be2fd18f5c | ||
|
|
cfcbdb0429 | ||
|
|
9463afcbc3 | ||
|
|
13a1e1b1db | ||
|
|
6e19738d1e | ||
|
|
2a3baf39b9 | ||
|
|
d58c98030d | ||
|
|
5c4f6802b3 | ||
|
|
fd51f82dbc | ||
|
|
a77cb3c249 | ||
|
|
015c33faff | ||
|
|
738c643c1b | ||
|
|
69ce039882 | ||
|
|
1642603b78 | ||
|
|
85a170073d | ||
|
|
a8882bd618 | ||
|
|
a6b139e0c4 | ||
|
|
5880f14e07 | ||
|
|
9bf271b4c2 | ||
|
|
82af58e8b3 | ||
|
|
6d00681d6e | ||
|
|
59043bc154 | ||
|
|
ffb63125e1 | ||
|
|
a3cd832c63 | ||
|
|
12d88e8846 | ||
|
|
17fe219773 | ||
|
|
d76c663f25 | ||
|
|
b1655e843e | ||
|
|
af5d44c278 | ||
|
|
0d9caca8b0 | ||
|
|
0cdb9572f1 | ||
|
|
8507abd5db | ||
|
|
fae9a75f6a | ||
|
|
fc6da588ee | ||
|
|
6f8c00bab9 | ||
|
|
a2ab88adab | ||
|
|
60528dbd6e | ||
|
|
cebf1ea1d6 | ||
|
|
11a62af39b | ||
|
|
83aeabd913 | ||
|
|
7acb778470 | ||
|
|
766925c9a8 | ||
|
|
51c37e1371 | ||
|
|
244acfb26b | ||
|
|
d03303728c | ||
|
|
9fa16aea78 | ||
|
|
29864bcf66 | ||
|
|
03a5d8076e | ||
|
|
9d8f214098 | ||
|
|
4b68a75a41 | ||
|
|
901189ae42 | ||
|
|
62bba1d79f | ||
|
|
9c735e3c5a | ||
|
|
62600fdd62 | ||
|
|
27e5fb8728 | ||
|
|
93811ca331 | ||
|
|
e37858fd19 | ||
|
|
3ddbb728b4 | ||
|
|
ef49b85495 | ||
|
|
be6550686f | ||
|
|
8de2e9e10b | ||
|
|
5650afb22f | ||
|
|
6540171263 | ||
|
|
fa1f87c5c8 | ||
|
|
13580d1081 | ||
|
|
0aa4d0ecd4 | ||
|
|
a475aca8bb | ||
|
|
f792c8d90f | ||
|
|
ca9dd314dc | ||
|
|
00a36ec509 | ||
|
|
2fa911c04e | ||
|
|
8345311284 | ||
|
|
137cacd1da | ||
|
|
cf86e390fb | ||
|
|
ff52ca9418 | ||
|
|
154229d5f5 | ||
|
|
f7125be3c8 | ||
|
|
d38746dcbd | ||
|
|
a1ce8bf742 | ||
|
|
57a69eee5b | ||
|
|
9de3436a61 | ||
|
|
ddd379b3d5 | ||
|
|
2e1c5a0d61 | ||
|
|
8383818c51 | ||
|
|
8a28652c4d | ||
|
|
72ba3c86c7 | ||
|
|
e6d4bb5443 | ||
|
|
bcfe503aa6 | ||
|
|
bb3d020646 | ||
|
|
ff5554ab68 | ||
|
|
7cafb11c0d | ||
|
|
dce665b174 | ||
|
|
43c1ee9b69 | ||
|
|
4b95fa127c | ||
|
|
65314439d7 | ||
|
|
36a84726af | ||
|
|
78f462c9ec | ||
|
|
b97d94edaf | ||
|
|
b4d29a5856 | ||
|
|
64e59f607a | ||
|
|
fca0b50a2a | ||
|
|
47ddc6f186 | ||
|
|
1f1e3c781f | ||
|
|
09f0cb6b6e | ||
|
|
fb43b3f390 | ||
|
|
f76f00d235 | ||
|
|
ac96860c27 | ||
|
|
c51290acf5 | ||
|
|
2f520dcaec | ||
|
|
e0be1d308a | ||
|
|
9cd06630ea | ||
|
|
6b281e2842 | ||
|
|
2e143d5a9e | ||
|
|
eb817da044 | ||
|
|
1c88aa7d72 | ||
|
|
a9e976cc24 | ||
|
|
5644b53cf8 | ||
|
|
236637f0e0 | ||
|
|
fb1bb0b7ed | ||
|
|
8a91f3ae3a | ||
|
|
80dc296dee | ||
|
|
f01c82631b | ||
|
|
ef2a681edb | ||
|
|
44ce5f2aa9 | ||
|
|
f52a04a337 | ||
|
|
9aa3e5b52a | ||
|
|
71452f4834 | ||
|
|
96f1cb6ad4 | ||
|
|
36dd64db22 | ||
|
|
05de04a569 | ||
|
|
c661799095 | ||
|
|
4f416d6423 | ||
|
|
58dc4da92c | ||
|
|
7b8710d3da | ||
|
|
7976909dbb | ||
|
|
24b85e410d | ||
|
|
ae13d2c42e | ||
|
|
bf0fc2437a | ||
|
|
88d3dd12a1 | ||
|
|
cb8b4a5586 | ||
|
|
ec0ef24508 | ||
|
|
5a16e69719 | ||
|
|
154dbe8151 | ||
|
|
785d3059c3 | ||
|
|
21b19b59c9 | ||
|
|
588feff5db | ||
|
|
9fafc6fba3 | ||
|
|
8412da15db | ||
|
|
54c299e7fe | ||
|
|
a06399cfda | ||
|
|
e49c488e06 | ||
|
|
be07ffab33 | ||
|
|
41a5b24faf | ||
|
|
2172d0feff | ||
|
|
c4664ca173 | ||
|
|
11a7915cb8 | ||
|
|
06b944f36a | ||
|
|
9a8886121d | ||
|
|
89c6d48dfd | ||
|
|
4525b99f33 | ||
|
|
3d04507948 | ||
|
|
7e3a447973 | ||
|
|
bdde3a271d | ||
|
|
9450c3969b | ||
|
|
23d66da792 | ||
|
|
cb430c20e2 | ||
|
|
58ce0e0604 | ||
|
|
61485dfe99 | ||
|
|
ab4c80b674 | ||
|
|
dbd5dd53c2 | ||
|
|
e2fa671964 | ||
|
|
02818da317 | ||
|
|
9804ea8c3a | ||
|
|
4bfe198a62 | ||
|
|
453cbacf9d | ||
|
|
42d88a149a | ||
|
|
2e97430856 | ||
|
|
60bf587031 | ||
|
|
68d1226ded | ||
|
|
f6dc788492 | ||
|
|
a515334a94 | ||
|
|
6be1369182 | ||
|
|
6455522ba6 | ||
|
|
d9a8999239 | ||
|
|
ae0f556f75 | ||
|
|
cdca9b84a4 | ||
|
|
24a6a6d423 | ||
|
|
8a7b391486 | ||
|
|
25bd9ce4c9 | ||
|
|
b408b048c1 | ||
|
|
4ec36358ad | ||
|
|
19b40c54e7 | ||
|
|
3e09b63a55 | ||
|
|
9580a30ba5 | ||
|
|
af47a3a37f | ||
|
|
d61ea0831a | ||
|
|
f2c0cd6feb | ||
|
|
d93d20321d | ||
|
|
ff1c37ddb6 | ||
|
|
a260f7506a | ||
|
|
9684441d92 | ||
|
|
e793c2a8a9 | ||
|
|
1bf8e59097 | ||
|
|
105ecd6305 | ||
|
|
314040453b | ||
|
|
cbcf5c1d2b | ||
|
|
e881b68ca5 | ||
|
|
f54c69a664 | ||
|
|
319281c096 | ||
|
|
7dee8c0604 | ||
|
|
efbcbc5deb | ||
|
|
c742518612 | ||
|
|
6a0ed46413 | ||
|
|
5ea71bc89b | ||
|
|
84701e90dc | ||
|
|
34ed5ddc4c |
@@ -16,6 +16,7 @@ start-local-testnet.sh
|
|||||||
test-fullstack-main.sh
|
test-fullstack-main.sh
|
||||||
start-fullstack-main.sh
|
start-fullstack-main.sh
|
||||||
start-fullstack-test.sh
|
start-fullstack-test.sh
|
||||||
|
start-fullstack-testnet.sh
|
||||||
start-free-main.sh
|
start-free-main.sh
|
||||||
start-local-mainnet.sh.save
|
start-local-mainnet.sh.save
|
||||||
start-local-testnet.sh.save
|
start-local-testnet.sh.save
|
||||||
@@ -27,6 +28,9 @@ test-fullstack-abc.sh
|
|||||||
test-fullstack-bchn.sh
|
test-fullstack-bchn.sh
|
||||||
start-fullstack-abc.sh
|
start-fullstack-abc.sh
|
||||||
start-fullstack-bchn.sh
|
start-fullstack-bchn.sh
|
||||||
|
start-ss-main.sh
|
||||||
|
start-decatur-bchn.sh
|
||||||
|
shell-scripts/
|
||||||
|
|
||||||
coverage
|
coverage
|
||||||
start-my-infra
|
start-my-infra
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2020 Chris Troutner
|
Copyright (c) 2021 Permissionless Software Foundation
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
# bch-api
|
# bch-api
|
||||||
|
|
||||||
This is a node.js JavaScript REST API server using Express.js. 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/Permissionless-Software-Foundation/bch-js) JavaScript library.
|
[](https://github.com/Permissionless-Software-Foundation/bch-js/blob/master/LICENSE.md)
|
||||||
|
[](https://github.com/feross/standard)
|
||||||
|
|
||||||
|
This is a REST API server, written in node.js JavaScript, using [Express.js](https://expressjs.com/) framework. 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://psfoundation.cash/blog/cash-stack) 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/Permissionless-Software-Foundation/bch-js) JavaScript library.
|
||||||
|
|
||||||
This repository is intended to be paired with [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js), an npm JavaScript library for building Bitcoin Cash apps.
|
This repository is intended to be paired with [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js), an npm JavaScript library for building Bitcoin Cash apps.
|
||||||
|
|
||||||
@@ -20,7 +23,7 @@ The following features set this repository apart from rest.bitcoin.com:
|
|||||||
- Fine grain access is controlled with a JWT token using
|
- 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). Can be used to monetize access to the REST API.
|
[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). Can be used to monetize access to the REST API.
|
||||||
- Typescript removed and ES8 JavaScript used instead.
|
- Typescript removed and ES8 JavaScript used instead.
|
||||||
- npm audit run on all dependencies.
|
- `npm audit fix` frequently run to fix dependencies.
|
||||||
|
|
||||||
## Live Demo
|
## Live Demo
|
||||||
You can test a live demo of the REST API by running the
|
You can test a live demo of the REST API by running the
|
||||||
@@ -31,17 +34,17 @@ You can bootstrap your own REST API server by downloading and installing the inf
|
|||||||
### Configure bch-js
|
### Configure bch-js
|
||||||
The live servers can be used by [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) by settings the `restURL` config property to one of these servers:
|
The live servers can be used by [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) by settings the `restURL` config property to one of these servers:
|
||||||
|
|
||||||
- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v3/
|
- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v4/
|
||||||
- ABC Mainnet REST API server: https://abc.fullstack.cash/v3/
|
- ABC Mainnet REST API server: https://abc.fullstack.cash/v4/
|
||||||
- Testnet3 REST API server: https://testnet3.fullstack.cash/v3/
|
- Testnet3 REST API server: https://testnet3.fullstack.cash/v4/
|
||||||
- Check server status: https://metrics.fullstack.cash
|
- Check server status: https://metrics.fullstack.cash
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
There are two installation paths, depending if you want a *development* or
|
There are two installation paths, depending if you want a *development* or
|
||||||
*production* environment. You'll also need to set up the underlying infrastructure
|
*production* environment. You'll also need to set up the underlying infrastructure
|
||||||
described on [this page](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
|
described on [this page](https://psfoundation.cash/blog/cash-stack).
|
||||||
|
|
||||||
This code targets the Ubuntu 18.04 LTS Linux OS.
|
This code targets the Ubuntu 18.04 LTS Linux OS or higher.
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
This is a standard node.js project. The installation is as follows:
|
This is a standard node.js project. The installation is as follows:
|
||||||
@@ -79,6 +82,20 @@ installation.
|
|||||||
|
|
||||||
`docker-compose up`
|
`docker-compose up`
|
||||||
|
|
||||||
|
## Rate Limits
|
||||||
|
The rate limits for [api.fullstack.cash](https://api.fullstack.cash) are controlled by a JWT token. You can increase your rate limits by [purchasing a JWT token](https://https://fullstack.cash). If you're using bch-js, [check the readme for instructions on increasing rate limits](https://github.com/Permissionless-Software-Foundation/bch-js#api-key). For interacting with bch-api directly, you can then include the JWT token in the HTTP header like this:
|
||||||
|
|
||||||
|
- `Authorization: Token <JWT token>`
|
||||||
|
|
||||||
|
### cURL example
|
||||||
|
Here is an example using curl for using the JWT token when making a call to the REST API:
|
||||||
|
|
||||||
|
```
|
||||||
|
export BCHJSTOKEN=eyJhbGciOiJ....
|
||||||
|
|
||||||
|
curl "https://bchn.fullstack.cash/v4/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -X GET -H "Content-Type: application/json" -H "Authorization: Token ${BCHJSTOKEN}"
|
||||||
|
```
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
Have questions? Need help? Join our community support
|
Have questions? Need help? Join our community support
|
||||||
[Telegram channel](https://t.me/bch_js_toolkit)
|
[Telegram channel](https://t.me/bch_js_toolkit)
|
||||||
@@ -86,7 +103,8 @@ Have questions? Need help? Join our community support
|
|||||||
## IPFS
|
## IPFS
|
||||||
Copies of this repository will occasionally be uploaded and hosted on [IPFS](https://ipfs.io):
|
Copies of this repository will occasionally be uploaded and hosted on [IPFS](https://ipfs.io):
|
||||||
|
|
||||||
- v1.15.4: QmSAerFmDJm6KQp2HC8jsRR5MdL5X39hoUsJYvWNDvrD8m
|
- v1.25.1: [QmXFzFJHenymhReDc9oGAxbpmvK2fJYnisQ2pJn3gGyKKX](https://ipfs.io/ipfs/QmXFzFJHenymhReDc9oGAxbpmvK2fJYnisQ2pJn3gGyKKX)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
[MIT](./LICENSE.md)
|
[MIT](./LICENSE.md)
|
||||||
|
a
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"sampleUrl": null
|
||||||
|
|
||||||
|
}
|
||||||
+20
-1
@@ -1,11 +1,30 @@
|
|||||||
/*
|
/*
|
||||||
Common configuration settings.
|
Common configuration settings.
|
||||||
|
Default settings in this file can be overridden by an environment variable.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
|
// This is the same secret used by jwt-bch-api
|
||||||
apiTokenSecret: process.env.TOKENSECRET
|
apiTokenSecret: process.env.TOKENSECRET
|
||||||
? process.env.TOKENSECRET
|
? process.env.TOKENSECRET
|
||||||
: 'secret-jwt-token'
|
: 'secret-jwt-token',
|
||||||
|
|
||||||
|
// Rate Limits
|
||||||
|
anonRateLimit: process.env.ANON_RATE_LIMIT
|
||||||
|
? Number(process.env.ANON_RATE_LIMIT)
|
||||||
|
: 500,
|
||||||
|
whitelistRateLimit: process.env.WHITELIST_RATE_LIMIT
|
||||||
|
? Number(process.env.WHITELIST_RATE_LIMIT)
|
||||||
|
: 10,
|
||||||
|
internalRateLimit: process.env.INTERNAL_RATE_LIMIT
|
||||||
|
? Number(process.env.INTERNAL_RATE_LIMIT)
|
||||||
|
: 10,
|
||||||
|
pointsPerMinute: process.env.POINTS_PER_MINUTE
|
||||||
|
? Number(process.env.POINTS_PER_MINUTE)
|
||||||
|
: 10000,
|
||||||
|
whitelistDomains: process.env.WHITELIST_DOMAINS
|
||||||
|
? process.env.WHITELIST_DOMAINS.split(',')
|
||||||
|
: ['fullstack.cash', 'psfoundation.cash', '10.0.']
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = config
|
module.exports = config
|
||||||
|
|||||||
@@ -1,33 +1,64 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# test
|
# Docker containers for the below infrastructure is described here:
|
||||||
|
# https://psfoundation.cash/blog/cash-stack
|
||||||
|
# Pre-synced databases can be downloaded on the CashStrap page:
|
||||||
|
# https://fullstack.cash/cashstrap
|
||||||
|
|
||||||
|
# Which network are you using?
|
||||||
|
export NETWORK=mainnet
|
||||||
|
#export NETWORK=testnet
|
||||||
|
|
||||||
# Full node
|
# Full node
|
||||||
export RPC_BASEURL=http://172.17.0.1:8332/
|
export RPC_IP=172.17.0.1:8332
|
||||||
|
export RPC_BASEURL=http://$RPC_IP/
|
||||||
export RPC_USERNAME=bitcoin
|
export RPC_USERNAME=bitcoin
|
||||||
export RPC_PASSWORD=password
|
export RPC_PASSWORD=password
|
||||||
export NETWORK=mainnet
|
|
||||||
|
|
||||||
# SLPDB
|
# SLPDB
|
||||||
|
export SLPDB_PASS_GP=somelongpassword
|
||||||
export SLPDB_URL=http://172.17.0.1:12300/
|
export SLPDB_URL=http://172.17.0.1:12300/
|
||||||
export SLPDB_PASS=somelongpassword
|
# Use the same address as SLPDB_URL if you don't have a separate whitelist server.
|
||||||
|
export SLPDB_PASS_WL=somelongpassword
|
||||||
|
export SLPDB_WHITELIST_URL=http://172.17.0.1:12300/
|
||||||
|
# slp-api alternative SLP validator using slp-validate:
|
||||||
|
# https://github.com/Permissionless-Software-Foundation/slp-api
|
||||||
|
export SLP_API_URL=http://10.0.0.5:5001/
|
||||||
|
|
||||||
# Blockbook Indexer
|
# Mainnet Fulcrum / ElectrumX
|
||||||
export BLOCKBOOK_URL=https://172.17.0.1:9131/
|
export FULCRUM_URL=172.17.0.1
|
||||||
# Allow node.js to make network calls to https using self-signed certificate.
|
export FULCRUM_PORT=50002
|
||||||
export NODE_TLS_REJECT_UNAUTHORIZED=0
|
|
||||||
|
|
||||||
# Redis DB
|
# Redis DB - Used for rate limiting
|
||||||
export REDIS_PORT=6379
|
export REDIS_PORT=6379
|
||||||
export REDIS_HOST=172.17.0.1
|
export REDIS_HOST=172.17.0.1
|
||||||
|
|
||||||
# JWT Token Secret
|
# JWT Token Secret
|
||||||
|
# This is used to verify JWT tokens generated with jwt-bch-api:
|
||||||
|
# https://github.com/Permissionless-Software-Foundation/jwt-bch-api
|
||||||
export TOKENSECRET=somelongsecretvalue
|
export TOKENSECRET=somelongsecretvalue
|
||||||
|
|
||||||
# So that bch-api can call bch-js locally.
|
# So that bch-api can call bch-js locally.
|
||||||
export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
|
export LOCAL_RESTURL=http://127.0.0.1:3000/v4/
|
||||||
|
|
||||||
# slp-api alternative SLP validator.
|
# Basic Authentication password
|
||||||
export SLP_API_URL=http://10.0.0.5:5001/
|
export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
|
||||||
|
|
||||||
|
# Whitelisted domains. Automatically give pro-tier rate limit access to apps
|
||||||
|
# that originate froma domain on the whitelist.
|
||||||
|
export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
|
||||||
|
|
||||||
|
# Rate Limits. Numbers are divided into 1000. e.g. 1000 / 50 = 20 RPM for ANON.
|
||||||
|
# Requests use the ANON rate limit if they fail to pass in a JWT token.
|
||||||
|
# ANON = 20 requests per minute (RPM)
|
||||||
|
export ANON_RATE_LIMIT=50
|
||||||
|
# 10 = 100 RPM
|
||||||
|
export WHITELIST_RATE_LIMIT=10
|
||||||
|
|
||||||
|
# Set logging parameters
|
||||||
|
#1m means no more than 1 megabyte
|
||||||
|
export LOG_MAX_SIZE=1m
|
||||||
|
#5d means store no more than 5 days
|
||||||
|
export LOG_MAX_FILES=5d
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
|
|||||||
@@ -1,18 +1,32 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Docker containers for the below infrastructure is described here:
|
||||||
|
# https://psfoundation.cash/blog/cash-stack
|
||||||
|
# Pre-synced databases can be downloaded on the CashStrap page:
|
||||||
|
# https://fullstack.cash/cashstrap
|
||||||
|
|
||||||
|
# Which network are you using?
|
||||||
|
#export NETWORK=mainnet
|
||||||
|
export NETWORK=testnet
|
||||||
|
|
||||||
# Full node
|
# Full node
|
||||||
export RPC_BASEURL=http://172.17.0.1:18332/
|
export RPC_IP=172.17.0.1:18332
|
||||||
|
export RPC_BASEURL=http://$RPC_IP/
|
||||||
export RPC_USERNAME=bitcoin
|
export RPC_USERNAME=bitcoin
|
||||||
export RPC_PASSWORD=password
|
export RPC_PASSWORD=password
|
||||||
export NETWORK=testnet
|
|
||||||
|
|
||||||
# SLPDB
|
# SLPDB
|
||||||
export SLPDB_URL=http://172.17.0.1:13300/
|
export SLPDB_URL=http://172.17.0.1:13300/
|
||||||
|
export SLPDB_PASS=somelongpassword
|
||||||
|
# Use the same address as SLPDB_URL if you don't have a separate whitelist server.
|
||||||
|
export SLPDB_WHITELIST_URL=http://172.17.0.1:13300/
|
||||||
|
# slp-api alternative SLP validator using slp-validate:
|
||||||
|
# https://github.com/Permissionless-Software-Foundation/slp-api
|
||||||
|
export SLP_API_URL=http://10.0.0.5:5001/
|
||||||
|
|
||||||
# Blockbook Indexer
|
# Mainnet Fulcrum / ElectrumX
|
||||||
export BLOCKBOOK_URL=https://172.17.0.1:19131/
|
export FULCRUM_URL=172.17.0.1
|
||||||
# Allow node.js to make network calls to https using self-signed certificate.
|
export FULCRUM_PORT=60002
|
||||||
export NODE_TLS_REJECT_UNAUTHORIZED=0
|
|
||||||
|
|
||||||
# Redis DB
|
# Redis DB
|
||||||
export REDIS_PORT=6380
|
export REDIS_PORT=6380
|
||||||
@@ -22,9 +36,20 @@ export REDIS_HOST=172.17.0.1
|
|||||||
export TOKENSECRET=somelongsecretvalue
|
export TOKENSECRET=somelongsecretvalue
|
||||||
|
|
||||||
# So that bch-api can call bch-js locally.
|
# So that bch-api can call bch-js locally.
|
||||||
export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
|
export LOCAL_RESTURL=http://127.0.0.1:3000/v4/
|
||||||
|
|
||||||
# slp-api alternative SLP validator.
|
# Basic Authentication password (optional)
|
||||||
export SLP_API_URL=http://10.0.0.5:5001/
|
export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
|
||||||
|
|
||||||
|
# Whitelisted domains. Automatically give pro-tier rate limit access to apps
|
||||||
|
# that originate froma domain on the whitelist.
|
||||||
|
export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
|
||||||
|
|
||||||
|
# Rate Limits. Numbers are divided into 1000. e.g. 1000 / 50 = 20 RPM for ANON.
|
||||||
|
# Requests use the ANON rate limit if they fail to pass in a JWT token.
|
||||||
|
# ANON = 20 requests per minute (RPM)
|
||||||
|
export ANON_RATE_LIMIT=50
|
||||||
|
# 10 = 100 RPM
|
||||||
|
export WHITELIST_RATE_LIMIT=10
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
|
|||||||
Generated
+4342
-9825
File diff suppressed because it is too large
Load Diff
+19
-23
@@ -14,24 +14,27 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node ./src/app.js",
|
"start": "node ./src/app.js",
|
||||||
"dev": "nodemon ./dist/app.js",
|
"dev": "nodemon ./dist/app.js",
|
||||||
"test": "npm run lint && npm run test-v3",
|
"test": "npm run lint && npm run test-v4",
|
||||||
"lint": "standard --env mocha --fix",
|
"lint": "standard --env mocha --fix",
|
||||||
"test-v3": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v3/",
|
"test-v4": "export NETWORK=mainnet && nyc --reporter=text mocha --exit --timeout 60000 test/v4/",
|
||||||
"test:temp": "export NETWORK=mainnet && export TEST=integration && mocha --timeout 25000 test/v3/integration/price.js",
|
"test-v5": "export NETWORK=mainnet && nyc --reporter=text mocha --exit --timeout 60000 test/v5/",
|
||||||
"test:integration": "mocha test/v3/integration",
|
"test:integration": "mocha test/v4/integration",
|
||||||
"test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v3/integration/slp*.js",
|
"test:integration:slpdb": "mocha --timeout 25000 -g '#validate2Single' test/v4/integration/slp*.js",
|
||||||
|
"test:integration:nft": "mocha --timeout 25000 -g '#nft' test/v4/integration/nft.js",
|
||||||
"coverage": "nyc report --reporter=text-lcov | coveralls",
|
"coverage": "nyc report --reporter=text-lcov | coveralls",
|
||||||
"coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v3/",
|
"coverage:report": "export NETWORK=mainnet && nyc --reporter=html mocha --timeout 25000 test/v4/",
|
||||||
"docs": "./node_modules/.bin/apidoc -i src/routes/v3 -o docs"
|
"docs": "./node_modules/.bin/apidoc -i src/routes/v4 -o docs",
|
||||||
|
"test:temp1": "export NETWORK=mainnet && export TEST=integration && mocha -g '#utxosBulk' --exit --timeout 30000 test/v5/",
|
||||||
|
"test:temp2": "export NETWORK=mainnet && mocha -g '#utxosBulk' --exit --timeout 30000 test/v5/"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=10.15.1"
|
"node": ">=10.15.1"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@psf/bch-js": "^3.7.1",
|
"@psf/bch-js": "^4.18.0",
|
||||||
"apidoc": "^0.23.0",
|
"apidoc": "^0.26.0",
|
||||||
"axios": "^0.19.0",
|
"axios": "^0.21.1",
|
||||||
"bitcore-lib-cash": "^8.20.3",
|
"bitcore-lib-cash": "^8.23.1",
|
||||||
"body-parser": "^1.18.3",
|
"body-parser": "^1.18.3",
|
||||||
"cookie-parser": "~1.4.3",
|
"cookie-parser": "~1.4.3",
|
||||||
"cors": "^2.8.3",
|
"cors": "^2.8.3",
|
||||||
@@ -44,7 +47,6 @@
|
|||||||
"helmet": "^3.21.2",
|
"helmet": "^3.21.2",
|
||||||
"ioredis": "^4.14.1",
|
"ioredis": "^4.14.1",
|
||||||
"jsonwebtoken": "^8.5.1",
|
"jsonwebtoken": "^8.5.1",
|
||||||
"level": "^6.0.0",
|
|
||||||
"mkdirp": "^1.0.0",
|
"mkdirp": "^1.0.0",
|
||||||
"mocha": "^7.1.1",
|
"mocha": "^7.1.1",
|
||||||
"morgan": "^1.9.1",
|
"morgan": "^1.9.1",
|
||||||
@@ -52,8 +54,6 @@
|
|||||||
"passport": "^0.4.0",
|
"passport": "^0.4.0",
|
||||||
"passport-anonymous": "^1.0.1",
|
"passport-anonymous": "^1.0.1",
|
||||||
"passport-http": "^0.3.0",
|
"passport-http": "^0.3.0",
|
||||||
"pg": "^8.0.0",
|
|
||||||
"pg-hstore": "^2.3.2",
|
|
||||||
"rate-limiter-flexible": "^2.0.0",
|
"rate-limiter-flexible": "^2.0.0",
|
||||||
"winston": "^3.2.1",
|
"winston": "^3.2.1",
|
||||||
"winston-daily-rotate-file": "^4.0.0"
|
"winston-daily-rotate-file": "^4.0.0"
|
||||||
@@ -68,17 +68,13 @@
|
|||||||
"eslint-plugin-prettier": "^3.1.0",
|
"eslint-plugin-prettier": "^3.1.0",
|
||||||
"eslint-plugin-standard": "^4.0.0",
|
"eslint-plugin-standard": "^4.0.0",
|
||||||
"fs-extra": "^9.0.0",
|
"fs-extra": "^9.0.0",
|
||||||
"nock": "^12.0.0",
|
"lodash.clonedeep": "^4.5.0",
|
||||||
"node-mocks-http": "^1.7.0",
|
"nock": "^13.0.5",
|
||||||
"nyc": "^15.0.0",
|
"nyc": "^15.0.0",
|
||||||
"prettier": "^2.0.0",
|
"prettier": "^2.0.0",
|
||||||
"proxyquire": "^2.1.0",
|
"semantic-release": "^17.4.2",
|
||||||
"request": "^2.88.0",
|
|
||||||
"request-promise": "^4.2.2",
|
|
||||||
"semantic-release": "^17.0.0",
|
|
||||||
"sinon": "^9.0.0",
|
"sinon": "^9.0.0",
|
||||||
"standard": "^14.3.1",
|
"standard": "^14.3.1"
|
||||||
"typescript": "^3.1.4"
|
|
||||||
},
|
},
|
||||||
"release": {
|
"release": {
|
||||||
"publish": [
|
"publish": [
|
||||||
@@ -90,6 +86,6 @@
|
|||||||
},
|
},
|
||||||
"apidoc": {
|
"apidoc": {
|
||||||
"title": "bch-api",
|
"title": "bch-api",
|
||||||
"url": "https://api.fullstack.cash/v3"
|
"url": "https://api.fullstack.cash/v4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+123
-58
@@ -3,7 +3,6 @@
|
|||||||
const express = require('express')
|
const express = require('express')
|
||||||
|
|
||||||
// Middleware
|
// Middleware
|
||||||
// const { routeRateLimit } = require("./middleware/route-ratelimit")
|
|
||||||
const RateLimits = require('./middleware/route-ratelimit')
|
const RateLimits = require('./middleware/route-ratelimit')
|
||||||
const rateLimits = new RateLimits()
|
const rateLimits = new RateLimits()
|
||||||
|
|
||||||
@@ -25,35 +24,60 @@ const jwtAuth = require('./middleware/jwt-auth')
|
|||||||
// Logging for API requests.
|
// Logging for API requests.
|
||||||
const logReqInfo = require('./middleware/req-logging')
|
const logReqInfo = require('./middleware/req-logging')
|
||||||
|
|
||||||
// v3
|
// v4
|
||||||
const healthCheckV3 = require('./routes/v3/health-check')
|
const healthCheckV4 = require('./routes/v4/health-check')
|
||||||
const BlockchainV3 = require('./routes/v3/full-node/blockchain')
|
const BlockchainV4 = require('./routes/v4/full-node/blockchain')
|
||||||
const ControlV3 = require('./routes/v3/full-node/control')
|
const ControlV4 = require('./routes/v4/full-node/control')
|
||||||
const MiningV3 = require('./routes/v3/full-node/mining')
|
const MiningV4 = require('./routes/v4/full-node/mining')
|
||||||
const networkV3 = require('./routes/v3/full-node/network')
|
const networkV4 = require('./routes/v4/full-node/network')
|
||||||
const RawtransactionsV3 = require('./routes/v3/full-node/rawtransactions')
|
const RawtransactionsV4 = require('./routes/v4/full-node/rawtransactions')
|
||||||
const utilV3 = require('./routes/v3/util')
|
const UtilV4 = require('./routes/v4/util')
|
||||||
const SlpV3 = require('./routes/v3/slp')
|
const SlpV4 = require('./routes/v4/slp')
|
||||||
const xpubV3 = require('./routes/v3/xpub')
|
const xpubV4 = require('./routes/v4/xpub')
|
||||||
const BlockbookV3 = require('./routes/v3/blockbook')
|
const ElectrumXV4 = require('./routes/v4/electrumx')
|
||||||
const Ninsight = require('./routes/v3/ninsight')
|
const EncryptionV4 = require('./routes/v4/encryption')
|
||||||
const ElectrumXV3 = require('./routes/v3/electrumx')
|
const PriceV4 = require('./routes/v4/price')
|
||||||
const EncryptionV3 = require('./routes/v3/encryption')
|
const Ninsight = require('./routes/v4/ninsight')
|
||||||
const PriceV3 = require('./routes/v3/price')
|
|
||||||
|
// v5
|
||||||
|
const healthCheckV5 = require('./routes/v5/health-check')
|
||||||
|
const BlockchainV5 = require('./routes/v5/full-node/blockchain')
|
||||||
|
const ControlV5 = require('./routes/v5/full-node/control')
|
||||||
|
const MiningV5 = require('./routes/v5/full-node/mining')
|
||||||
|
const networkV5 = require('./routes/v5/full-node/network')
|
||||||
|
const RawtransactionsV5 = require('./routes/v5/full-node/rawtransactions')
|
||||||
|
const UtilV5 = require('./routes/v5/util')
|
||||||
|
const SlpV5 = require('./routes/v5/slp')
|
||||||
|
const xpubV5 = require('./routes/v5/xpub')
|
||||||
|
const ElectrumXV5 = require('./routes/v5/electrumx')
|
||||||
|
const EncryptionV5 = require('./routes/v5/encryption')
|
||||||
|
const PriceV5 = require('./routes/v5/price')
|
||||||
|
// const Ninsight = require('./routes/v5/ninsight')
|
||||||
|
|
||||||
require('dotenv').config()
|
require('dotenv').config()
|
||||||
|
|
||||||
// Instantiate route libraries.
|
// Instantiate v4 route libraries.
|
||||||
const blockchainV3 = new BlockchainV3()
|
const blockchainV4 = new BlockchainV4()
|
||||||
const controlV3 = new ControlV3()
|
const controlV4 = new ControlV4()
|
||||||
const miningV3 = new MiningV3()
|
const miningV4 = new MiningV4()
|
||||||
const rawtransactionsV3 = new RawtransactionsV3()
|
const rawtransactionsV4 = new RawtransactionsV4()
|
||||||
const slpV3 = new SlpV3()
|
const slpV4 = new SlpV4()
|
||||||
const blockbookV3 = new BlockbookV3()
|
const electrumxv4 = new ElectrumXV4()
|
||||||
const electrumxv3 = new ElectrumXV3()
|
electrumxv4.connect()
|
||||||
electrumxv3.connect()
|
const encryptionv4 = new EncryptionV4()
|
||||||
const encryptionv3 = new EncryptionV3()
|
const pricev4 = new PriceV4()
|
||||||
const pricev3 = new PriceV3()
|
const utilV4 = new UtilV4({ electrumx: electrumxv4 })
|
||||||
|
|
||||||
|
// Instantiate v5 route libraries.
|
||||||
|
const blockchainV5 = new BlockchainV5()
|
||||||
|
const controlV5 = new ControlV5()
|
||||||
|
const miningV5 = new MiningV5()
|
||||||
|
const rawtransactionsV5 = new RawtransactionsV5()
|
||||||
|
const slpV5 = new SlpV5()
|
||||||
|
const electrumxv5 = new ElectrumXV5()
|
||||||
|
const encryptionv5 = new EncryptionV5()
|
||||||
|
const pricev5 = new PriceV5()
|
||||||
|
const utilV5 = new UtilV5({ electrumx: electrumxv5 })
|
||||||
|
|
||||||
const app = express()
|
const app = express()
|
||||||
|
|
||||||
@@ -95,38 +119,77 @@ app.use(express.static(path.join(__dirname, 'public')))
|
|||||||
// Log requests for later analysis.
|
// Log requests for later analysis.
|
||||||
app.use('/', logReqInfo)
|
app.use('/', logReqInfo)
|
||||||
|
|
||||||
// const v2prefix = "v2"
|
const v4prefix = 'v4'
|
||||||
const v3prefix = 'v3'
|
const v5prefix = 'v5'
|
||||||
|
|
||||||
// Inspect the header for a JWT token.
|
// START Rate Limits
|
||||||
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()
|
const auth = new AuthMW()
|
||||||
app.use(`/${v3prefix}/`, auth.mw())
|
|
||||||
|
|
||||||
// Rate limit on all v3 routes
|
// Ensure req.locals and res.locals objects exist.
|
||||||
// Establish and enforce rate limits.
|
app.use(`/${v4prefix}/`, rateLimits.populateLocals)
|
||||||
// app.use(`/${v3prefix}/`, rateLimits.routeRateLimit)
|
app.use(`/${v5prefix}/`, rateLimits.populateLocals)
|
||||||
app.use(`/${v3prefix}/`, rateLimits.rateLimitByResource)
|
|
||||||
|
|
||||||
app.use(`/${v3prefix}/` + 'health-check', healthCheckV3)
|
// Allow users to turn off rate limits with an environment variable.
|
||||||
app.use(`/${v3prefix}/` + 'blockchain', blockchainV3.router)
|
const DO_NOT_USE_RATE_LIMITS = process.env.DO_NOT_USE_RATE_LIMITS || false
|
||||||
app.use(`/${v3prefix}/` + 'control', controlV3.router)
|
|
||||||
app.use(`/${v3prefix}/` + 'mining', miningV3.router)
|
console.log(`DO_NOT_USE_RATE_LIMITS: ${DO_NOT_USE_RATE_LIMITS}`)
|
||||||
app.use(`/${v3prefix}/` + 'network', networkV3)
|
|
||||||
app.use(`/${v3prefix}/` + 'rawtransactions', rawtransactionsV3.router)
|
if (!DO_NOT_USE_RATE_LIMITS) {
|
||||||
app.use(`/${v3prefix}/` + 'util', utilV3.router)
|
console.log('Rate limits are being used')
|
||||||
app.use(`/${v3prefix}/` + 'slp', slpV3.router)
|
// Inspect the header for a JWT token.
|
||||||
app.use(`/${v3prefix}/` + 'xpub', xpubV3.router)
|
app.use(`/${v4prefix}/`, jwtAuth.getTokenFromHeaders)
|
||||||
app.use(`/${v3prefix}/` + 'blockbook', blockbookV3.router)
|
app.use(`/${v5prefix}/`, jwtAuth.getTokenFromHeaders)
|
||||||
app.use(`/${v3prefix}/` + 'electrumx', electrumxv3.router)
|
|
||||||
app.use(`/${v3prefix}/` + 'encryption', encryptionv3.router)
|
// Instantiate the authorization middleware, used to implement pro-tier rate limiting.
|
||||||
app.use(`/${v3prefix}/` + 'price', pricev3.router)
|
// Handles Anonymous and Basic Authorization schemes used by passport.js
|
||||||
|
app.use(`/${v4prefix}/`, auth.mw())
|
||||||
|
app.use(`/${v5prefix}/`, auth.mw())
|
||||||
|
|
||||||
|
// Experimental rate limits
|
||||||
|
app.use(`/${v4prefix}/`, rateLimits.applyRateLimits)
|
||||||
|
app.use(`/${v5prefix}/`, rateLimits.applyRateLimits)
|
||||||
|
|
||||||
|
// Rate limit on all v4 routes
|
||||||
|
// Establish and enforce rate limits.
|
||||||
|
// app.use(`/${v4prefix}/`, rateLimits.rateLimitByResource)
|
||||||
|
} else {
|
||||||
|
console.log('Rate limits are NOT being used')
|
||||||
|
}
|
||||||
|
// END Rate Limits
|
||||||
|
|
||||||
|
// Connect v4 routes
|
||||||
|
app.use(`/${v4prefix}/` + 'health-check', healthCheckV4)
|
||||||
|
app.use(`/${v4prefix}/` + 'blockchain', blockchainV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'control', controlV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'mining', miningV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'network', networkV4)
|
||||||
|
app.use(`/${v4prefix}/` + 'rawtransactions', rawtransactionsV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'slp', slpV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'xpub', xpubV4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'electrumx', electrumxv4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'encryption', encryptionv4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'price', pricev4.router)
|
||||||
|
app.use(`/${v4prefix}/` + 'util', utilV4.router)
|
||||||
|
|
||||||
const ninsight = new Ninsight()
|
const ninsight = new Ninsight()
|
||||||
app.use(`/${v3prefix}/` + 'ninsight', ninsight.router)
|
app.use(`/${v4prefix}/` + 'ninsight', ninsight.router)
|
||||||
|
|
||||||
|
// Connect v5 routes
|
||||||
|
app.use(`/${v5prefix}/` + 'health-check', healthCheckV5)
|
||||||
|
app.use(`/${v5prefix}/` + 'blockchain', blockchainV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'control', controlV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'mining', miningV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'network', networkV5)
|
||||||
|
app.use(`/${v5prefix}/` + 'rawtransactions', rawtransactionsV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'slp', slpV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'xpub', xpubV5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'electrumx', electrumxv5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'encryption', encryptionv5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'price', pricev5.router)
|
||||||
|
app.use(`/${v5prefix}/` + 'util', utilV5.router)
|
||||||
|
|
||||||
|
// const ninsight = new Ninsight()
|
||||||
|
app.use(`/${v5prefix}/` + 'ninsight', ninsight.router)
|
||||||
|
|
||||||
// catch 404 and forward to error handler
|
// catch 404 and forward to error handler
|
||||||
app.use((req, res, next) => {
|
app.use((req, res, next) => {
|
||||||
@@ -174,9 +237,11 @@ server.listen(port)
|
|||||||
server.on('error', onError)
|
server.on('error', onError)
|
||||||
server.on('listening', onListening)
|
server.on('listening', onListening)
|
||||||
|
|
||||||
// Set the time before a timeout error is generated. This impacts testing and
|
// Set the time before a timeout error is generated.
|
||||||
// the handling of timeout errors. Is 10 seconds too agressive?
|
// 10 seconds is way too agressive. 30 Seconds was used for a while, but with
|
||||||
server.setTimeout(30 * 1000)
|
// being able to set a timeout between UTXOs for tokenUtxoDetails, the timeout
|
||||||
|
// needed to be extended.
|
||||||
|
server.setTimeout(1000 * 60 * 5) // 5 minutes
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize a port into a number, string, or false.
|
* Normalize a port into a number, string, or false.
|
||||||
@@ -211,11 +276,11 @@ function onError (error) {
|
|||||||
case 'EACCES':
|
case 'EACCES':
|
||||||
console.error(`${bind} requires elevated privileges`)
|
console.error(`${bind} requires elevated privileges`)
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
break
|
// break
|
||||||
case 'EADDRINUSE':
|
case 'EADDRINUSE':
|
||||||
console.error(`${bind} is already in use`)
|
console.error(`${bind} is already in use`)
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
break
|
// break
|
||||||
default:
|
default:
|
||||||
throw error
|
throw error
|
||||||
}
|
}
|
||||||
|
|||||||
+12
-8
@@ -1,22 +1,25 @@
|
|||||||
/*
|
/*
|
||||||
CT 2/4/20 Note: This library handles anonymous and Basic auth. This library
|
This library handles anonymous and Basic Authentication.
|
||||||
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
|
1) Default is 'Anonymous Authentication', which unlocks the freemimum tier by
|
||||||
default.
|
default.
|
||||||
|
|
||||||
2) Hard-coded 'Basic Authentication' is a token that does not expire and is
|
2) Hard-coded 'Basic Authentication' is a token that does not expire and is
|
||||||
provided to buisiness partners.
|
provided for clients who run their own isolated infrastructure without rate
|
||||||
|
limits, but still need a way from preventing the random public from using
|
||||||
|
their API.
|
||||||
|
|
||||||
3) JWT-based 'Local Authentication' is used for normal users that pay to
|
3) JWT-based 'Local Authentication' is used for normal users that pay to
|
||||||
access the premium pro-tier services.
|
access the premium pro-tier services.
|
||||||
|
|
||||||
This file uses the passport npm library to check the header of each REST API
|
This file uses the passport npm library to check the header of each REST API
|
||||||
call for the prescence of a Basic authorization header:
|
call for the prescence of a Basic Authentication header:
|
||||||
https://en.wikipedia.org/wiki/Basic_access_authentication
|
https://en.wikipedia.org/wiki/Basic_access_authentication
|
||||||
|
|
||||||
If the header is found and validated, the req.locals.proLimit Boolean value
|
If the header is found and validated, the req.locals.proLimit Boolean value
|
||||||
is set and passed to the route-ratelimits.ts middleware.
|
is set and passed to the route-ratelimit.js middleware. route-ratelimit.js
|
||||||
|
is for fine-grain JWT-based rate limits. If req.locals.proLimit is set to
|
||||||
|
true, then those rate limits will be skipped.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'use strict'
|
'use strict'
|
||||||
@@ -76,8 +79,9 @@ class AuthMW {
|
|||||||
req.locals.proLimit = false
|
req.locals.proLimit = false
|
||||||
|
|
||||||
// Evaluate the username and password and set the rate limit accordingly.
|
// Evaluate the username and password and set the rate limit accordingly.
|
||||||
// if (username === "BITBOX" && password === PRO_PASS) {
|
|
||||||
if (username === 'fullstackcash') {
|
if (username === 'fullstackcash') {
|
||||||
|
// Can set several different passwords in the environment variable.
|
||||||
|
// Loop through each one to see if one matches.
|
||||||
for (let i = 0; i < PRO_PASS.length; i++) {
|
for (let i = 0; i < PRO_PASS.length; i++) {
|
||||||
const thisPass = PRO_PASS[i]
|
const thisPass = PRO_PASS[i]
|
||||||
|
|
||||||
|
|||||||
+366
-205
@@ -1,44 +1,62 @@
|
|||||||
/*
|
/*
|
||||||
Sets the rate limits for the anonymous and paid tiers. Current rate limits:
|
This file will replace the original rate-limit.js file.
|
||||||
- 1000 points in 60 seconds
|
|
||||||
- 10 points per call for paid tier (100 RPM)
|
|
||||||
- 50 points per call for anonymous tier (20 RPM)
|
|
||||||
|
|
||||||
Background:
|
Sets the rate limits for the anonymous and paid tiers. Current rate limits:
|
||||||
The rate limits below were originially coded with the idea of charging on a
|
- 10000 points in 60 seconds
|
||||||
per-resource basis. However, that was confusing to end users trying to purchase
|
- 500 points per call for anonymous tier (20 RPM)
|
||||||
a subscription. So everything was simplied to two tiers: paid and anonymous
|
- 100 points per call for tier 40 (100 RPM)
|
||||||
|
- 40 points per call for tier 50 (250 RPM)
|
||||||
|
- 16 points per call for tier 60 (625 RPM)
|
||||||
|
|
||||||
|
The rate limit handling is designed for these four use cases:
|
||||||
|
- Users who want to buy a JWT token for 24 hour access.
|
||||||
|
- Users who want to buy different RPM tiers: 100, 250, 600
|
||||||
|
- Basic Authentication which should not have any rate limits applied.
|
||||||
|
- Local installations that do not want any authentication or rate limits at all.
|
||||||
|
|
||||||
|
The Basic Auth use cases is considered when determining internal rate limits.
|
||||||
|
The internal rate limits should not be applied to calls from those users.
|
||||||
|
|
||||||
|
A lot of attention has been paid to passing rate-limit information for the user
|
||||||
|
when they trigger an endpoint that makes a lot of internal API calls. Examples
|
||||||
|
are hydrateUtxos() and getPublicKey(). These keeps things fair by charging the
|
||||||
|
same for 'light' API calls and 'heavy' API calls.
|
||||||
|
|
||||||
|
TODO:
|
||||||
|
- Add code for applying rate limits to whitelist domains.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'use strict'
|
// Public npm libraries.
|
||||||
|
|
||||||
const jwt = require('jsonwebtoken')
|
const jwt = require('jsonwebtoken')
|
||||||
|
const Redis = require('ioredis')
|
||||||
|
const { RateLimiterRedis } = require('rate-limiter-flexible')
|
||||||
|
|
||||||
|
// local libraries.
|
||||||
const wlogger = require('../util/winston-logging')
|
const wlogger = require('../util/winston-logging')
|
||||||
const config = require('../../config')
|
const config = require('../../config')
|
||||||
|
|
||||||
const ANON_LIMITS = 50
|
let _this // Global pointer to instance of class, when 'this' context is lost.
|
||||||
|
|
||||||
// Redis
|
// Setup Redis to track rate limits for each user.
|
||||||
const redisOptions = {
|
const redisOptions = {
|
||||||
enableOfflineQueue: false,
|
enableOfflineQueue: false,
|
||||||
port: process.env.REDIS_PORT ? process.env.REDIS_PORT : 6379,
|
port: process.env.REDIS_PORT ? process.env.REDIS_PORT : 6379,
|
||||||
host: process.env.REDIS_HOST ? process.env.REDIS_HOST : '127.0.0.1'
|
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)
|
const redisClient = new Redis(redisOptions)
|
||||||
|
|
||||||
// Rate limiter middleware lib.
|
|
||||||
const { RateLimiterRedis } = require('rate-limiter-flexible')
|
|
||||||
const rateLimitOptions = {
|
const rateLimitOptions = {
|
||||||
storeClient: redisClient,
|
storeClient: redisClient,
|
||||||
points: 1000, // Number of points
|
points: config.pointsPerMinute, // Number of points
|
||||||
duration: 60 // Per minute (per 60 seconds)
|
duration: 60 // Per minute (per 60 seconds)
|
||||||
}
|
}
|
||||||
|
|
||||||
let _this
|
// Constants
|
||||||
|
const ANON_LIMITS = config.anonRateLimit
|
||||||
|
// const WHITELIST_RATE_LIMIT = config.whitelistRateLimit
|
||||||
|
const WHITELIST_DOMAINS = config.whitelistDomains
|
||||||
|
const WHITELIST_POINTS_TO_CONSUME = config.whitelistRateLimit
|
||||||
|
const POINTS_PER_MINUTE = config.pointsPerMinute
|
||||||
|
const INTERNAL_POINTS_TO_CONSUME = config.internalRateLimit
|
||||||
|
|
||||||
class RateLimits {
|
class RateLimits {
|
||||||
constructor () {
|
constructor () {
|
||||||
@@ -49,25 +67,343 @@ class RateLimits {
|
|||||||
this.config = config
|
this.config = config
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This is the main middleware funciton of this library. All other functions
|
||||||
|
// support this function.
|
||||||
|
async applyRateLimits (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Exit if the user has already authenticated with Basic Authentication.
|
||||||
|
if (req.locals.proLimit) {
|
||||||
|
console.log('External call, basic auth, skipping rate limits.')
|
||||||
|
wlogger.debug(
|
||||||
|
'req.locals.proLimit = true; Using Basic Authentication instead of rate limits'
|
||||||
|
)
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine if the call is an external or internal API call.
|
||||||
|
const isInternal = _this.checkInternalIp(req)
|
||||||
|
// console.log(`isInternal: ${isInternal}`)
|
||||||
|
|
||||||
|
// Determine if the call originates from another computer on the intranet.
|
||||||
|
const isWhitelistOrigin = _this.isInWhitelist(req)
|
||||||
|
// console.log('isWhitelistOrigin: ', isWhitelistOrigin)
|
||||||
|
|
||||||
|
// Handle the use case of internally-generated requests.
|
||||||
|
if (isInternal) {
|
||||||
|
// Internal API calls should pass the authentication data in through the
|
||||||
|
// the usrObj in the body.
|
||||||
|
if (req.body && req.body.usrObj) {
|
||||||
|
if (req.body.usrObj.proLimit) {
|
||||||
|
// console.log('Internal call, basic auth, skipping rate limits.')
|
||||||
|
|
||||||
|
// If this is an internal call that originated from a user using
|
||||||
|
// Basic Authentication, then skip rate-limits.
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
// console.log(
|
||||||
|
// 'Internal call, applying rate limits. Using JWT if available.'
|
||||||
|
// )
|
||||||
|
|
||||||
|
// Determine if user has exceeded their rate limits. Pass in the
|
||||||
|
// JWT token if one exists.
|
||||||
|
const hasExceededRateLimit = await _this.trackRateLimits(
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
req.body.usrObj.jwtToken
|
||||||
|
)
|
||||||
|
|
||||||
|
if (!hasExceededRateLimit) {
|
||||||
|
// Rate limits have not been exceeded. Processing can continue.
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
// trackRateLimits() returns the 'res' object with an error message
|
||||||
|
// and status code.
|
||||||
|
return hasExceededRateLimit
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// This should be a corner case. Calls should not be going into this
|
||||||
|
// code path, so the system should throw up big warning signs when they
|
||||||
|
// do.
|
||||||
|
// This code path happens when an internal call is made but does not
|
||||||
|
// pass the usrObj. Legacy code needs to be refactored to use the usrObj
|
||||||
|
// and avoid this code path. This code path is 'pooled': all users
|
||||||
|
// share the same rate limits. Even at 1000 RPM, this pool will get
|
||||||
|
// exhausted easily.
|
||||||
|
// const warnMsg =
|
||||||
|
// 'Internal call. req.body.usrObj does not exist. Applying high-speed internal rate limits.'
|
||||||
|
// console.log(warnMsg)
|
||||||
|
// wlogger.info(warnMsg)
|
||||||
|
|
||||||
|
const defaultPayload = {
|
||||||
|
id: '98.76.54.32',
|
||||||
|
email: 'internal@bchtest.net',
|
||||||
|
apiLevel: 40,
|
||||||
|
rateLimit: 100,
|
||||||
|
pointsToConsume: INTERNAL_POINTS_TO_CONSUME,
|
||||||
|
duration: 30
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default values, in case there is an error.
|
||||||
|
const defaultJwt = _this.generateJwtToken(defaultPayload)
|
||||||
|
|
||||||
|
// Track the rate limit for this user. Pass in the JWT token, if one
|
||||||
|
// is available.
|
||||||
|
const hasExceededRateLimit = await _this.trackRateLimits(
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
defaultJwt
|
||||||
|
)
|
||||||
|
// console.log(`hasExceededRateLimit: `, hasExceededRateLimit)
|
||||||
|
|
||||||
|
if (!hasExceededRateLimit) {
|
||||||
|
// Rate limits have not been exceeded. Processing can continue.
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
// trackRateLimits() returns the 'res' object with an error message
|
||||||
|
// and status code.
|
||||||
|
return hasExceededRateLimit
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//
|
||||||
|
//
|
||||||
|
} else {
|
||||||
|
// Handle the normal use-case of external requests
|
||||||
|
// console.log(
|
||||||
|
// 'External call, applying rate limits. Using JWT if available.'
|
||||||
|
// )
|
||||||
|
|
||||||
|
// For calls originating from a whitelist domain, apply a high-RPM
|
||||||
|
// JWT token to the call.
|
||||||
|
if (isWhitelistOrigin) {
|
||||||
|
const defaultPayload = {
|
||||||
|
id: '77.77.77.77',
|
||||||
|
email: 'whitelist@bchtest.net',
|
||||||
|
apiLevel: 40,
|
||||||
|
rateLimit: 100,
|
||||||
|
pointsToConsume: WHITELIST_POINTS_TO_CONSUME,
|
||||||
|
duration: 30
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inject the high-RPM JWT token into the call.
|
||||||
|
req.locals.jwtToken = _this.generateJwtToken(defaultPayload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Track the rate limit for this user. Pass in the JWT token, if one
|
||||||
|
// is available.
|
||||||
|
const hasExceededRateLimit = await _this.trackRateLimits(
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
req.locals.jwtToken
|
||||||
|
)
|
||||||
|
// console.log('hasExceededRateLimit: ', hasExceededRateLimit)
|
||||||
|
|
||||||
|
if (!hasExceededRateLimit) {
|
||||||
|
// Rate limits have not been exceeded. Processing can continue.
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
// trackRateLimits() returns the 'res' object with an error message
|
||||||
|
// and status code.
|
||||||
|
return hasExceededRateLimit
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in route-ratelimit2.js/applyRateLimits(): ', err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// By default, move to the next middleware.
|
||||||
|
next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// A wrapper for Redis-based rate limiter.
|
||||||
|
// Will return false if the user has not exceeded the rate limit. Otherwise
|
||||||
|
// it will return the 'res' object with an error status and message, which
|
||||||
|
// should be returned by the middleware.
|
||||||
|
async trackRateLimits (req, res, jwtToken) {
|
||||||
|
// Anonymous rate limits are used by default.
|
||||||
|
let pointsToConsume = ANON_LIMITS
|
||||||
|
// console.log('pointsToConsume: ', pointsToConsume)
|
||||||
|
|
||||||
|
let key = req.ip // Use the IP address as the key, by default.
|
||||||
|
|
||||||
|
// console.log('jwtToken: ', jwtToken)
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Decode the JWT token if it exists
|
||||||
|
if (jwtToken) {
|
||||||
|
const decoded = _this.decodeJwtToken(jwtToken)
|
||||||
|
// console.log(`decoded: ${JSON.stringify(decoded, null, 2)}`)
|
||||||
|
|
||||||
|
// Preferentially use the decoded ID in the JWT payload, as the key.
|
||||||
|
key = decoded.id
|
||||||
|
|
||||||
|
pointsToConsume = decoded.pointsToConsume
|
||||||
|
}
|
||||||
|
// console.log(`rate limit key: ${key}`)
|
||||||
|
|
||||||
|
// This function will throw an error if the user exceeds the rate limit.
|
||||||
|
// The 429 error response is handled by the catch().
|
||||||
|
await _this.rateLimiter.consume(key, pointsToConsume)
|
||||||
|
|
||||||
|
// Debugging
|
||||||
|
// const rateLimitData = await _this.rateLimiter.consume(key, pointsToConsume)
|
||||||
|
// console.log(`rateLimitData: `, rateLimitData)
|
||||||
|
|
||||||
|
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
||||||
|
|
||||||
|
// Signal that the user has not exceeded their rate limits.
|
||||||
|
return false
|
||||||
|
} catch (err) {
|
||||||
|
// console.log('err: ', err)
|
||||||
|
|
||||||
|
const rateLimit = Math.floor(POINTS_PER_MINUTE / pointsToConsume)
|
||||||
|
|
||||||
|
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`
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Attempts to decode a JWT token. Returns default values if it fails.
|
||||||
|
decodeJwtToken (jwtToken) {
|
||||||
|
const defaultPayload = {
|
||||||
|
id: '123.456.789.10',
|
||||||
|
email: 'test@bchtest.net',
|
||||||
|
apiLevel: 10,
|
||||||
|
rateLimit: 3,
|
||||||
|
pointsToConsume: ANON_LIMITS,
|
||||||
|
duration: 30
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Default values, in case there is an error.
|
||||||
|
const defaultJwt = _this.generateJwtToken(defaultPayload)
|
||||||
|
|
||||||
|
// Generate a default payload to use, if the decoding of the user-provided
|
||||||
|
// jwt fails.
|
||||||
|
let decoded = _this.jwt.verify(defaultJwt, _this.config.apiTokenSecret)
|
||||||
|
|
||||||
|
try {
|
||||||
|
decoded = _this.jwt.verify(jwtToken, _this.config.apiTokenSecret)
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in route-ratelimit2.js/decodeJwtTokens(): ', err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return decoded
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error(
|
||||||
|
'Unhandled error in route-ratelimit2.js/deocdeJwtToken: ',
|
||||||
|
err
|
||||||
|
)
|
||||||
|
|
||||||
|
// Making sure there is an exp property. Not sure if this will cause an
|
||||||
|
// issue, using a hard-coded value.
|
||||||
|
defaultPayload.exp = 1574269450
|
||||||
|
|
||||||
|
return defaultPayload
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns a boolean if the origin of the request matches a domain in the
|
||||||
|
// whitelist.
|
||||||
|
isInWhitelist (req) {
|
||||||
|
try {
|
||||||
|
const retVal = false // Default value.
|
||||||
|
|
||||||
|
// Retrieve the origin.
|
||||||
|
const origin = req.get('origin')
|
||||||
|
|
||||||
|
if (!process.env.TEST) console.log('origin:', origin)
|
||||||
|
|
||||||
|
// If the origin is not determinable, return false.
|
||||||
|
if (!origin) return false
|
||||||
|
|
||||||
|
// console.log(`WHITELIST_DOMAINS: ${JSON.stringify(WHITELIST_DOMAINS, null, 2)}`)
|
||||||
|
|
||||||
|
for (let i = 0; i < WHITELIST_DOMAINS.length; i++) {
|
||||||
|
const thisDomain = WHITELIST_DOMAINS[i]
|
||||||
|
|
||||||
|
if (origin.includes(thisDomain)) return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return retVal
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error(
|
||||||
|
'Error in route-ratelimit.js/isInWhitelist(). Returning false by default.'
|
||||||
|
)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Checks the request object to see if it's IP address matches an internal
|
||||||
|
// IP address. That means the call is an internal API call and should be
|
||||||
|
// treated differently than an external API call.
|
||||||
|
checkInternalIp (req) {
|
||||||
|
try {
|
||||||
|
// Default value
|
||||||
|
let isInternal = false
|
||||||
|
|
||||||
|
const ip = req.ip
|
||||||
|
|
||||||
|
if (ip.includes('127.0.0.1')) isInternal = true
|
||||||
|
|
||||||
|
if (ip.includes('172.17.')) isInternal = true
|
||||||
|
|
||||||
|
// TODO: Add 192.168.
|
||||||
|
|
||||||
|
return isInternal
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error(
|
||||||
|
'Error in checkInternalIp(). Returning false be default. Err: ',
|
||||||
|
err
|
||||||
|
)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Used to disconnect from the Redis DB.
|
// Used to disconnect from the Redis DB.
|
||||||
// Called by unit tests so that node.js thread doesn't live forever.
|
// Called by unit tests so that node.js thread doesn't live forever.
|
||||||
closeRedis () {
|
closeRedis () {
|
||||||
redisClient.disconnect()
|
redisClient.disconnect()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Clear the redis database. Used by unit tests.
|
||||||
async wipeRedis () {
|
async wipeRedis () {
|
||||||
await redisClient.flushdb()
|
await redisClient.flushdb()
|
||||||
}
|
}
|
||||||
|
|
||||||
// This is the new rate limit function that uses the rate-limiter-flexible npm
|
// Generates a JWT token for testing purposes. This is not used in production.
|
||||||
// library. It uses fine-grain rate limiting based on the resources being
|
// This function mirrors the kind of JWT token that would be generated by
|
||||||
// consumed.
|
// jwt-bch-api.
|
||||||
async rateLimitByResource (req, res, next) {
|
generateJwtToken (payload) {
|
||||||
try {
|
try {
|
||||||
let userId
|
const jwtOptions = {
|
||||||
let decoded = {}
|
expiresIn: '30 days'
|
||||||
|
}
|
||||||
|
|
||||||
// Create a req.locals object if not passed in.
|
const token = _this.jwt.sign(
|
||||||
|
payload,
|
||||||
|
_this.config.apiTokenSecret,
|
||||||
|
jwtOptions
|
||||||
|
)
|
||||||
|
|
||||||
|
return token
|
||||||
|
} catch (err) {
|
||||||
|
console.error('Error in generateJwtToken()')
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Called when rate limits are not used.
|
||||||
|
populateLocals (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Create a re*Q*.locals object if not passed in.
|
||||||
|
// req.locals.proLimit will be true if the user is using Basic Authentication.
|
||||||
if (!req.locals) {
|
if (!req.locals) {
|
||||||
req.locals = {
|
req.locals = {
|
||||||
// default values
|
// default values
|
||||||
@@ -77,191 +413,16 @@ class RateLimits {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a res.locals object if it does not exist. This is used for
|
// Create a re*S*.locals object if it does not exist.
|
||||||
// debugging.
|
|
||||||
if (!res.locals) {
|
if (!res.locals) {
|
||||||
res.locals = {
|
res.locals = {
|
||||||
rateLimitTriggered: false
|
rateLimitTriggered: false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Decode the JWT token if one exists.
|
next()
|
||||||
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!')
|
|
||||||
}
|
|
||||||
|
|
||||||
// Default value is 50 points per request = 20 RPM
|
|
||||||
let rateLimit = ANON_LIMITS
|
|
||||||
|
|
||||||
// Only evaluate the JWT token if the user is not using Basic Authentication.
|
|
||||||
if (!req.locals.proLimit) {
|
|
||||||
// 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.
|
|
||||||
|
|
||||||
// Retrieve the origin.
|
|
||||||
let origin = req.get('origin')
|
|
||||||
|
|
||||||
// Handle calls coming from the intranet.
|
|
||||||
if (origin === undefined && key.indexOf('10.0.0.5') > -1) {
|
|
||||||
origin = 'slp-api'
|
|
||||||
}
|
|
||||||
|
|
||||||
wlogger.info(`origin: ${origin}`)
|
|
||||||
|
|
||||||
// If the request originates from one of the approved wallet apps, then
|
|
||||||
// apply paid-access rate limits.
|
|
||||||
if (
|
|
||||||
origin &&
|
|
||||||
(origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
|
|
||||||
origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
|
|
||||||
origin.toString().indexOf('splitbch.com') > -1 ||
|
|
||||||
origin === 'slp-api')
|
|
||||||
) {
|
|
||||||
pointsToConsume = 10
|
|
||||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
|
||||||
}
|
|
||||||
|
|
||||||
// For internal calls, increase rate limits to as fast as possible.
|
|
||||||
if (
|
|
||||||
// Comment out the line below when running bch-js e2e rate limit tests.
|
|
||||||
key.toString().indexOf('::ffff:127.0.0.1') > -1 ||
|
|
||||||
|
|
||||||
// Do not comment out this line.
|
|
||||||
key.toString().indexOf('172.17.') > -1
|
|
||||||
) {
|
|
||||||
pointsToConsume = 1
|
|
||||||
res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
|
|
||||||
}
|
|
||||||
|
|
||||||
wlogger.info(
|
|
||||||
`User ${key} consuming ${pointsToConsume} point for resource ${resource}.`
|
|
||||||
)
|
|
||||||
|
|
||||||
rateLimit = Math.floor(1000 / 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) {
|
} catch (err) {
|
||||||
wlogger.error('Error in route-ratelimit.js/newRateLimit(): ', err)
|
console.error('Error in populateLocals(): ', err)
|
||||||
// throw err
|
|
||||||
}
|
|
||||||
|
|
||||||
next()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Calculates the points consumed, based on the jwt information and the route
|
|
||||||
// requested.
|
|
||||||
calcPoints (jwtInfo) {
|
|
||||||
let retVal = ANON_LIMITS // 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 = 10
|
|
||||||
// else if (apiLevel >= 10) retVal = 10
|
|
||||||
else retVal = ANON_LIMITS
|
|
||||||
|
|
||||||
// Normal indexer routes
|
|
||||||
} else if (level30Routes.includes(resource)) {
|
|
||||||
if (apiLevel >= 30) retVal = 10
|
|
||||||
else retVal = ANON_LIMITS
|
|
||||||
|
|
||||||
// Full node tier
|
|
||||||
} else if (apiLevel >= 20) {
|
|
||||||
retVal = 10
|
|
||||||
|
|
||||||
// Free tier, full node only.
|
|
||||||
} else {
|
|
||||||
retVal = ANON_LIMITS
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return retVal
|
|
||||||
} catch (err) {
|
|
||||||
wlogger.error('Error in route-ratelimit.js/calcPoints()')
|
|
||||||
// throw err
|
|
||||||
retVal = ANON_LIMITS
|
|
||||||
}
|
|
||||||
|
|
||||||
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
|
throw err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,521 +0,0 @@
|
|||||||
/*
|
|
||||||
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('@psf/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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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
|
|
||||||
@@ -1,183 +0,0 @@
|
|||||||
/*
|
|
||||||
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('@psf/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 }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -79,6 +79,21 @@ class Electrum {
|
|||||||
// Set the connection flag.
|
// Set the connection flag.
|
||||||
_this.isReady = true
|
_this.isReady = true
|
||||||
|
|
||||||
|
// Periodically check the connection. If it's not connected, attempt to
|
||||||
|
// reconnect.
|
||||||
|
_this.reconnectIntervalHandle = setInterval(async function () {
|
||||||
|
const status = _this.electrumx.connection.status
|
||||||
|
// console.log(`Electrumx status: ${status}`)
|
||||||
|
|
||||||
|
// 1 = connected. If we're not connected, attemp to reconnect.
|
||||||
|
if (status !== 1) {
|
||||||
|
wlogger.info(`Electrumx not connectes. Status: ${status}`)
|
||||||
|
wlogger.info('Attempting to reconnect...')
|
||||||
|
await _this.electrumx.connect()
|
||||||
|
wlogger.info('...reconnected.')
|
||||||
|
}
|
||||||
|
}, 30000)
|
||||||
|
|
||||||
console.log('...Successfully connected to ElectrumX server.')
|
console.log('...Successfully connected to ElectrumX server.')
|
||||||
|
|
||||||
// console.log(`_this.isReady: ${_this.isReady}`)
|
// console.log(`_this.isReady: ${_this.isReady}`)
|
||||||
@@ -96,6 +111,9 @@ class Electrum {
|
|||||||
// Return immediately if the isReady flag is false.
|
// Return immediately if the isReady flag is false.
|
||||||
if (!_this.isReady) return true
|
if (!_this.isReady) return true
|
||||||
|
|
||||||
|
// Disable the reconnect timer.
|
||||||
|
clearInterval(_this.reconnectIntervalHandle)
|
||||||
|
|
||||||
// Disconnect from the server.
|
// Disconnect from the server.
|
||||||
await _this.electrumx.disconnect()
|
await _this.electrumx.disconnect()
|
||||||
|
|
||||||
@@ -117,7 +135,7 @@ class Electrum {
|
|||||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||||
if (msg) {
|
if (msg) {
|
||||||
res.status(status)
|
res.status(status)
|
||||||
return res.json({ error: msg })
|
return res.json({ success: false, error: msg })
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handle error patterns specific to this route.
|
// Handle error patterns specific to this route.
|
||||||
@@ -177,7 +195,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single balance
|
// GET handler for single balance
|
||||||
@@ -246,7 +264,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/utxos" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -266,7 +284,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -371,7 +389,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/tx/data/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/tx/data/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single transaction
|
// GET handler for single transaction
|
||||||
@@ -431,7 +449,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/tx/data" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d","a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], "verbose":false}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/tx/data" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d","a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], "verbose":false}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -452,7 +470,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, txids)) {
|
if (!_this.routeUtils.validateArraySize(req, txids)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
success: false,
|
success: false,
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
@@ -532,7 +550,7 @@ class Electrum {
|
|||||||
* @apiDescription Broadcast a raw transaction and return the transaction ID on success or error on failure.
|
* @apiDescription Broadcast a raw transaction and return the transaction ID on success or error on failure.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/tx/broadcast" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txHex":"020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000"}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/tx/broadcast" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txHex":"020000000265d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667010000006441dd1dd72770cadede1a7fd0363574846c48468a398ddfa41a9677c74cac8d2652b682743725a3b08c6c2021a629011e11a264d9036e9d5311e35b5f4937ca7b4e4121020797d8fd4d2fa6fd7cdeabe2526bfea2b90525d6e8ad506ec4ee3c53885aa309ffffffff65d13ef402840c8a51f39779afb7ae4d49e4b0a3c24a3d0e7742038f2c679667000000006441347d7f218c11c04487c1ad8baac28928fb10e5054cd4494b94d078cfa04ccf68e064fb188127ff656c0b98e9ce87f036d183925d0d0860605877d61e90375f774121028a53f95eb631b460854fc836b2e5d31cad16364b4dc3d970babfbdcc3f2e4954ffffffff035ac355000000000017a914189ce02e332548f4804bac65cba68202c9dbf822878dfd0800000000001976a914285bb350881b21ac89724c6fb6dc914d096cd53b88acf9ef3100000000001976a91445f1f1c4a9b9419a5088a3e9c24a293d7a150e6488ac00000000"}'
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// POST handler for broadcasting a single transaction
|
// POST handler for broadcasting a single transaction
|
||||||
@@ -623,7 +641,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/block/header/42?count=2" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/block/header/42?count=2" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single block headers
|
// GET handler for single block headers
|
||||||
@@ -689,7 +707,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/block/headers" -H "accept: application/json" -H "Content-Type: application/json" -d '{"heights":[{ "height": 42, count: 2 }, { "height": 100, count: 5 }]}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/block/headers" -H "accept: application/json" -H "Content-Type: application/json" -d '{"heights":[{ "height": 42, count: 2 }, { "height": 100, count: 5 }]}'
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// POST handler for bulk queries on block headers
|
// POST handler for bulk queries on block headers
|
||||||
@@ -708,7 +726,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, heights)) {
|
if (!_this.routeUtils.validateArraySize(req, heights)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
success: false,
|
success: false,
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
@@ -788,7 +806,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/balance/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single balance
|
// GET handler for single balance
|
||||||
@@ -858,7 +876,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/balance" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -877,7 +895,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -981,7 +999,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/transactions/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/transactions/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single balance
|
// GET handler for single balance
|
||||||
@@ -1051,7 +1069,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/transactions" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -1070,7 +1088,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -1174,7 +1192,7 @@ class Electrum {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/electrumx/unconfirmed/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/electrumx/unconfirmed/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// GET handler for single balance
|
// GET handler for single balance
|
||||||
@@ -1244,7 +1262,7 @@ class Electrum {
|
|||||||
* Limited to 20 items per request.
|
* Limited to 20 items per request.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X POST "https://api.fullstack.cash/v3/electrumx/unconfirmed" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/electrumx/unconfirmed" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -1263,7 +1281,7 @@ class Electrum {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
if (!_this.routeUtils.validateArraySize(req, addresses)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -18,7 +18,7 @@ const routeUtils = new RouteUtils()
|
|||||||
const BCHJS = require('@psf/bch-js')
|
const BCHJS = require('@psf/bch-js')
|
||||||
const restURL = process.env.LOCAL_RESTURL
|
const restURL = process.env.LOCAL_RESTURL
|
||||||
? process.env.LOCAL_RESTURL
|
? process.env.LOCAL_RESTURL
|
||||||
: 'https://api.fullstack.cash/v3/'
|
: 'https://api.fullstack.cash/v4/'
|
||||||
const bchjs = new BCHJS({ restURL })
|
const bchjs = new BCHJS({ restURL })
|
||||||
|
|
||||||
let _this
|
let _this
|
||||||
@@ -45,7 +45,7 @@ class Encryption {
|
|||||||
const { msg, status } = _this.routeUtils.decodeError(err)
|
const { msg, status } = _this.routeUtils.decodeError(err)
|
||||||
if (msg) {
|
if (msg) {
|
||||||
res.status(status)
|
res.status(status)
|
||||||
return res.json({ error: msg })
|
return res.json({ success: false, error: msg })
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handle error patterns specific to this route.
|
// Handle error patterns specific to this route.
|
||||||
@@ -76,7 +76,7 @@ class Encryption {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getPublicKey (req, res, next) {
|
async getPublicKey (req, res, next) {
|
||||||
@@ -92,6 +92,15 @@ class Encryption {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Generate a user object that can be passed along with internal calls
|
||||||
|
// from bch-js.
|
||||||
|
const usrObj = {
|
||||||
|
ip: req._remoteAddress,
|
||||||
|
jwtToken: req.locals.jwtToken,
|
||||||
|
proLimit: req.locals.proLimit,
|
||||||
|
apiLevel: req.locals.apiLevel
|
||||||
|
}
|
||||||
|
|
||||||
const cashAddr = _this.bchjs.Address.toCashAddress(address)
|
const cashAddr = _this.bchjs.Address.toCashAddress(address)
|
||||||
|
|
||||||
// Prevent a common user error. Ensure they are using the correct network address.
|
// Prevent a common user error. Ensure they are using the correct network address.
|
||||||
@@ -105,16 +114,17 @@ class Encryption {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// console.log(
|
||||||
wlogger.debug(
|
wlogger.debug(
|
||||||
'Executing encryption/getPublicKey with this address: ',
|
'Executing encryption/getPublicKey with this address: ',
|
||||||
cashAddr
|
cashAddr
|
||||||
)
|
)
|
||||||
|
|
||||||
const rawTxData = await _this.bchjs.Electrumx.transactions(cashAddr)
|
const rawTxData = await _this.bchjs.Electrumx.transactions([cashAddr], usrObj)
|
||||||
// console.log(`rawTxData: ${JSON.stringify(rawTxData, null, 2)}`)
|
// console.log(`rawTxData: ${JSON.stringify(rawTxData, null, 2)}`)
|
||||||
|
|
||||||
// Extract just the TXIDs
|
// Extract just the TXIDs
|
||||||
const txids = rawTxData.transactions.map((elem) => elem.tx_hash)
|
const txids = rawTxData.transactions[0].transactions.map((elem) => elem.tx_hash)
|
||||||
// console.log(`txids: ${JSON.stringify(txids, null, 2)}`)
|
// console.log(`txids: ${JSON.stringify(txids, null, 2)}`)
|
||||||
|
|
||||||
// throw error if there is no transaction history.
|
// throw error if there is no transaction history.
|
||||||
@@ -127,12 +137,13 @@ class Encryption {
|
|||||||
const thisTx = txids[i]
|
const thisTx = txids[i]
|
||||||
|
|
||||||
const txDetails = await _this.bchjs.RawTransactions.getRawTransaction(
|
const txDetails = await _this.bchjs.RawTransactions.getRawTransaction(
|
||||||
thisTx,
|
[thisTx],
|
||||||
true
|
true,
|
||||||
|
usrObj
|
||||||
)
|
)
|
||||||
// console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
|
// console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
|
||||||
|
|
||||||
const vin = txDetails.vin
|
const vin = txDetails[0].vin
|
||||||
|
|
||||||
// Loop through each input.
|
// Loop through each input.
|
||||||
for (let j = 0; j < vin.length; j++) {
|
for (let j = 0; j < vin.length; j++) {
|
||||||
@@ -170,6 +181,7 @@ class Encryption {
|
|||||||
publicKey: 'not found'
|
publicKey: 'not found'
|
||||||
})
|
})
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
// console.log('Error in encryption.js/getPublicKey().', err)
|
||||||
wlogger.error('Error in encryption.js/getPublicKey().', err)
|
wlogger.error('Error in encryption.js/getPublicKey().', err)
|
||||||
|
|
||||||
return _this.errorHandler(err, res)
|
return _this.errorHandler(err, res)
|
||||||
@@ -53,6 +53,7 @@ class Blockchain {
|
|||||||
this.router.post('/getTxOutProof', this.getTxOutProofBulk)
|
this.router.post('/getTxOutProof', this.getTxOutProofBulk)
|
||||||
this.router.get('/verifyTxOutProof/:proof', this.verifyTxOutProofSingle)
|
this.router.get('/verifyTxOutProof/:proof', this.verifyTxOutProofSingle)
|
||||||
this.router.post('/verifyTxOutProof', this.verifyTxOutProofBulk)
|
this.router.post('/verifyTxOutProof', this.verifyTxOutProofBulk)
|
||||||
|
this.router.post('/getBlock', this.getBlock)
|
||||||
}
|
}
|
||||||
|
|
||||||
root (req, res, next) {
|
root (req, res, next) {
|
||||||
@@ -80,7 +81,7 @@ class Blockchain {
|
|||||||
* block chain.
|
* block chain.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBestBlockHash" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getBestBlockHash" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiSuccess {String} bestBlockHash 000000000000000002bc884334336d99c9a9c616670a9244c6a8c1fc35aa91a1
|
* @apiSuccess {String} bestBlockHash 000000000000000002bc884334336d99c9a9c616670a9244c6a8c1fc35aa91a1
|
||||||
*/
|
*/
|
||||||
@@ -111,7 +112,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns an object containing various state info regarding blockchain processing.
|
* @apiDescription Returns an object containing various state info regarding blockchain processing.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockchainInfo" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getBlockchainInfo" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiSuccess {Object} object Object containing data
|
* @apiSuccess {Object} object Object containing data
|
||||||
* @apiSuccess {String} object.chain "main"
|
* @apiSuccess {String} object.chain "main"
|
||||||
@@ -155,7 +156,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns the number of blocks in the longest blockchain.
|
* @apiDescription Returns the number of blocks in the longest blockchain.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockCount" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getBlockCount" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiSuccess {Number} bestBlockCount 587665
|
* @apiSuccess {Number} bestBlockCount 587665
|
||||||
*/
|
*/
|
||||||
@@ -188,7 +189,7 @@ class Blockchain {
|
|||||||
* returns an Object with information about blockheader hash.
|
* returns an Object with information about blockheader hash.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getBlockHeader/000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201?verbose=true" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getBlockHeader/000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201?verbose=true" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiParam {String} hash block hash
|
* @apiParam {String} hash block hash
|
||||||
* @apiParam {Boolean} verbose Return verbose data
|
* @apiParam {Boolean} verbose Return verbose data
|
||||||
@@ -249,7 +250,7 @@ class Blockchain {
|
|||||||
* returns an Object with information about blockheader hash.
|
* returns an Object with information about blockheader hash.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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}"
|
* curl -X POST "https://api.fullstack.cash/v4/blockchain/getBlockHeader" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"hashes\":[\"000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201\",\"00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3\"],\"verbose\":true}"
|
||||||
*
|
*
|
||||||
* @apiParam {String} hash block hash
|
* @apiParam {String} hash block hash
|
||||||
* @apiParam {Boolean} verbose Return verbose data
|
* @apiParam {Boolean} verbose Return verbose data
|
||||||
@@ -284,7 +285,7 @@ class Blockchain {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!routeUtils.validateArraySize(req, hashes)) {
|
if (!routeUtils.validateArraySize(req, hashes)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -341,7 +342,7 @@ class Blockchain {
|
|||||||
* including the main chain as well as orphaned branches.
|
* including the main chain as well as orphaned branches.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getChainTips" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getChainTips" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getChainTips (req, res, next) {
|
async getChainTips (req, res, next) {
|
||||||
@@ -372,7 +373,7 @@ class Blockchain {
|
|||||||
* power on the network.
|
* power on the network.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getDifficulty" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getDifficulty" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getDifficulty (req, res, next) {
|
async getDifficulty (req, res, next) {
|
||||||
@@ -404,7 +405,7 @@ class Blockchain {
|
|||||||
* mempool (unconfirmed)
|
* mempool (unconfirmed)
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolEntry/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getMempoolEntry/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getMempoolEntrySingle (req, res, next) {
|
async getMempoolEntrySingle (req, res, next) {
|
||||||
@@ -442,7 +443,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns mempool data for multiple transactions
|
* @apiDescription Returns mempool data for multiple transactions
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X POST https://api.fullstack.cash/v3/blockchain/getMempoolEntry -H "Content-Type: application/json" -d "{\"txids\":[\"a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1\",\"5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e\"]}"
|
* curl -X POST https://api.fullstack.cash/v4/blockchain/getMempoolEntry -H "Content-Type: application/json" -d "{\"txids\":[\"a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1\",\"5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e\"]}"
|
||||||
*/
|
*/
|
||||||
async getMempoolEntryBulk (req, res, next) {
|
async getMempoolEntryBulk (req, res, next) {
|
||||||
try {
|
try {
|
||||||
@@ -457,7 +458,7 @@ class Blockchain {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!routeUtils.validateArraySize(req, txids)) {
|
if (!routeUtils.validateArraySize(req, txids)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -515,7 +516,7 @@ class Blockchain {
|
|||||||
* against the 25 ancestor chain-limit.
|
* against the 25 ancestor chain-limit.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getMempoolAncestors/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getMempoolAncestors/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getMempoolAncestorsSingle (req, res, next) {
|
async getMempoolAncestorsSingle (req, res, next) {
|
||||||
@@ -557,7 +558,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns details on the active state of the TX memory pool.
|
* @apiDescription Returns details on the active state of the TX memory pool.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
|
* curl -X GET https://api.fullstack.cash/v4/getMempoolInfo -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getMempoolInfo (req, res, next) {
|
async getMempoolInfo (req, res, next) {
|
||||||
@@ -587,7 +588,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns details on the active state of the TX memory pool.
|
* @apiDescription Returns details on the active state of the TX memory pool.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET https://api.fullstack.cash/v3/getMempoolInfo -H "accept: application/json"
|
* curl -X GET https://api.fullstack.cash/v4/getMempoolInfo -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -599,7 +600,7 @@ class Blockchain {
|
|||||||
* of string transaction ids.
|
* of string transaction ids.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/getRawMempool/?verbose=true" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/getRawMempool/?verbose=true" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiParam {Boolean} verbose Return verbose data
|
* @apiParam {Boolean} verbose Return verbose data
|
||||||
*
|
*
|
||||||
@@ -635,7 +636,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns details about an unspent transaction output.
|
* @apiDescription Returns details about an unspent transaction output.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOut/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33/0?mempool=false" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getTxOut/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33/0?mempool=false" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiParam {String} txid Transaction id (required)
|
* @apiParam {String} txid Transaction id (required)
|
||||||
* @apiParam {Number} n Output number (required)
|
* @apiParam {Number} n Output number (required)
|
||||||
@@ -692,7 +693,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns details about an unspent transaction output (UTXO).
|
* @apiDescription Returns details about an unspent transaction output (UTXO).
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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}'
|
* curl "https://api.fullstack.cash/v4/blockchain/getTxOut/" -X POST -H "Content-Type: application/json" --data-binary '{"txid":"d5228d2cdc77fbe5a9aa79f19b0933b6802f9f0067f42847fc4fe343664723e5","vout":0,"mempool":true}'
|
||||||
*
|
*
|
||||||
* @apiParam {String} txid Transaction id (required)
|
* @apiParam {String} txid Transaction id (required)
|
||||||
* @apiParam {Number} vout of transaction (required)
|
* @apiParam {Number} vout of transaction (required)
|
||||||
@@ -746,7 +747,7 @@ class Blockchain {
|
|||||||
* @apiDescription Returns a hex-encoded proof that 'txid' was included in a block.
|
* @apiDescription Returns a hex-encoded proof that 'txid' was included in a block.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/blockchain/getTxOutProofSingle/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/blockchain/getTxOutProofSingle/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
* @apiParam {String} txid Transaction id (required)
|
* @apiParam {String} txid Transaction id (required)
|
||||||
*
|
*
|
||||||
@@ -794,7 +795,7 @@ class Blockchain {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!routeUtils.validateArraySize(req, txids)) {
|
if (!routeUtils.validateArraySize(req, txids)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -888,7 +889,7 @@ class Blockchain {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!routeUtils.validateArraySize(req, proofs)) {
|
if (!routeUtils.validateArraySize(req, proofs)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/api.fullstack.cash/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -937,6 +938,52 @@ class Blockchain {
|
|||||||
return _this.errorHandler(err, res)
|
return _this.errorHandler(err, res)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /blockchain/getBlock/ Get block details
|
||||||
|
* @apiName getBlock
|
||||||
|
* @apiGroup Blockchain
|
||||||
|
* @apiDescription Returns block details
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl "https://api.fullstack.cash/v4/blockchain/getblock/" -X POST -H "Content-Type: application/json" --data-binary '{"blockhash":"000000000000000002a5fe0bdd6e3f04342a975c0f55e57f97e73bb90041676b","verbosity":0 }'
|
||||||
|
*
|
||||||
|
* @apiParam {String} blockhash Block hash (required)
|
||||||
|
* @apiParam {Number} verbosity Default 1 (optional)
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getBlock (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Validate input parameter
|
||||||
|
const blockhash = req.body.blockhash
|
||||||
|
let verbosity = req.body.verbosity
|
||||||
|
|
||||||
|
// Default to a value of 1 if another verbosity level is not defined.
|
||||||
|
if (!verbosity && verbosity !== 0) verbosity = 1
|
||||||
|
|
||||||
|
if (!blockhash || blockhash === '') {
|
||||||
|
res.status(400)
|
||||||
|
return res.json({ error: 'blockhash can not be empty' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Axios options
|
||||||
|
const options = _this.routeUtils.getAxiosOptions()
|
||||||
|
|
||||||
|
options.data.id = 'getblock'
|
||||||
|
options.data.method = 'getblock'
|
||||||
|
options.data.params = [blockhash, verbosity]
|
||||||
|
|
||||||
|
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.js/getBlock()', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = Blockchain
|
module.exports = Blockchain
|
||||||
@@ -53,7 +53,7 @@ class Control {
|
|||||||
* @apiDescription RPC call which gets basic full node information.
|
* @apiDescription RPC call which gets basic full node information.
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/control/getnetworkinfo" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/control/getnetworkinfo" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getNetworkInfo (req, res, next) {
|
async getNetworkInfo (req, res, next) {
|
||||||
@@ -77,7 +77,7 @@ class Mining {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/mining/getMiningInfo" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/mining/getMiningInfo" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -107,7 +107,7 @@ class Mining {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/mining/getNetworkHashps?nblocks=120&height=-1" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/mining/getNetworkHashps?nblocks=120&height=-1" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
+46
-27
@@ -65,7 +65,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
|
||||||
*/
|
*/
|
||||||
async decodeRawTransactionSingle (req, res, next) {
|
async decodeRawTransactionSingle (req, res, next) {
|
||||||
try {
|
try {
|
||||||
@@ -103,7 +103,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/rawtransactions/decodeRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -118,7 +118,7 @@ class RawTransactions {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -140,7 +140,7 @@ class RawTransactions {
|
|||||||
const options = _this.routeUtils.getAxiosOptions()
|
const options = _this.routeUtils.getAxiosOptions()
|
||||||
|
|
||||||
// Loop through each height and creates an array of requests to call in parallel
|
// Loop through each height and creates an array of requests to call in parallel
|
||||||
const promises = hexes.map(async hex => {
|
const promises = hexes.map(async (hex) => {
|
||||||
options.data.id = 'decoderawtransaction'
|
options.data.id = 'decoderawtransaction'
|
||||||
options.data.method = 'decoderawtransaction'
|
options.data.method = 'decoderawtransaction'
|
||||||
options.data.params = [hex]
|
options.data.params = [hex]
|
||||||
@@ -152,7 +152,7 @@ class RawTransactions {
|
|||||||
const axiosResult = await _this.axios.all(promises)
|
const axiosResult = await _this.axios.all(promises)
|
||||||
|
|
||||||
// Retrieve the data part of the result.
|
// Retrieve the data part of the result.
|
||||||
const result = axiosResult.map(x => x.data.result)
|
const result = axiosResult.map((x) => x.data.result)
|
||||||
|
|
||||||
res.status(200)
|
res.status(200)
|
||||||
return res.json(result)
|
return res.json(result)
|
||||||
@@ -177,7 +177,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -218,7 +218,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
*curl -X POST "https://api.fullstack.cash/v3/rawtransactions/decodeScript" -H "accept:" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
*curl -X POST "https://api.fullstack.cash/v4/rawtransactions/decodeScript" -H "accept:" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -234,7 +234,7 @@ class RawTransactions {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -254,7 +254,7 @@ class RawTransactions {
|
|||||||
const options = _this.routeUtils.getAxiosOptions()
|
const options = _this.routeUtils.getAxiosOptions()
|
||||||
|
|
||||||
// Loop through each hex and create an array of promises
|
// Loop through each hex and create an array of promises
|
||||||
const promises = hexes.map(async hex => {
|
const promises = hexes.map(async (hex) => {
|
||||||
options.data.id = 'decodescript'
|
options.data.id = 'decodescript'
|
||||||
options.data.method = 'decodescript'
|
options.data.method = 'decodescript'
|
||||||
options.data.params = [hex]
|
options.data.params = [hex]
|
||||||
@@ -267,7 +267,7 @@ class RawTransactions {
|
|||||||
const resolved = await Promise.all(promises)
|
const resolved = await Promise.all(promises)
|
||||||
|
|
||||||
// Retrieve the data from each resolved promise.
|
// Retrieve the data from each resolved promise.
|
||||||
const result = resolved.map(x => x.data.result)
|
const result = resolved.map((x) => x.data.result)
|
||||||
|
|
||||||
res.status(200)
|
res.status(200)
|
||||||
return res.json(result)
|
return res.json(result)
|
||||||
@@ -308,7 +308,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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}'
|
* curl -X POST "https://api.fullstack.cash/v4/rawtransactions/getRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1","5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e"],"verbose":true}'
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getRawTransactionBulk (req, res, next) {
|
async getRawTransactionBulk (req, res, next) {
|
||||||
@@ -324,20 +324,12 @@ class RawTransactions {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, txids)) {
|
if (!_this.routeUtils.validateArraySize(req, txids)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// stub response object
|
|
||||||
// const returnResponse = {
|
|
||||||
// status: 100,
|
|
||||||
// json: {
|
|
||||||
// error: ''
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
|
|
||||||
// Validate each txid in the array.
|
// Validate each txid in the array.
|
||||||
for (let i = 0; i < txids.length; i++) {
|
for (let i = 0; i < txids.length; i++) {
|
||||||
const txid = txids[i]
|
const txid = txids[i]
|
||||||
@@ -356,7 +348,7 @@ class RawTransactions {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Loop through each txid and create an array of promises
|
// Loop through each txid and create an array of promises
|
||||||
const promises = txids.map(async txid =>
|
const promises = txids.map(async (txid) =>
|
||||||
_this.getRawTransactionsFromNode(txid, verbose)
|
_this.getRawTransactionsFromNode(txid, verbose)
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -383,7 +375,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -429,7 +421,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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"]}'
|
* curl -X POST "https://api.fullstack.cash/v4/rawtransactions/sendRawTransaction" -H "accept:application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000","01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -444,11 +436,12 @@ class RawTransactions {
|
|||||||
return res.json({ error: 'hex must be an array' })
|
return res.json({ error: 'hex must be an array' })
|
||||||
}
|
}
|
||||||
|
|
||||||
const options = _this.routeUtils.getAxiosOptions()
|
let options = _this.routeUtils.getAxiosOptions()
|
||||||
|
options = _this.sendTxOptions(options)
|
||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -522,7 +515,7 @@ class RawTransactions {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: "
|
* curl -X GET "https://api.fullstack.cash/v4/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: "
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -544,7 +537,8 @@ class RawTransactions {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
const options = _this.routeUtils.getAxiosOptions()
|
let options = _this.routeUtils.getAxiosOptions()
|
||||||
|
options = _this.sendTxOptions(options)
|
||||||
|
|
||||||
// RPC call
|
// RPC call
|
||||||
options.data.id = 'sendrawtransaction'
|
options.data.id = 'sendrawtransaction'
|
||||||
@@ -565,6 +559,31 @@ class RawTransactions {
|
|||||||
return _this.errorHandler(err, res)
|
return _this.errorHandler(err, res)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This method modifies the default axios options. It attempts to inject
|
||||||
|
// a specific full node to use when broadcasting transactions. This is useful
|
||||||
|
// because it leverages the built-in protections that a full node has against
|
||||||
|
// accidental double spends. It mitigates a corner-case when rapidly spending
|
||||||
|
// TXs on load balanced nodes. By piping all TX sends through a single node,
|
||||||
|
// accidental double spends can be reduced.
|
||||||
|
sendTxOptions (options) {
|
||||||
|
try {
|
||||||
|
const sendUrl = process.env.RPC_SENDURL
|
||||||
|
|
||||||
|
if (sendUrl !== 'undefined' && sendUrl !== undefined) {
|
||||||
|
// console.log(`original options: ${JSON.stringify(options, null, 2)}`)
|
||||||
|
|
||||||
|
options.baseURL = process.env.RPC_SENDURL
|
||||||
|
|
||||||
|
// console.log(`modified options: ${JSON.stringify(options, null, 2)}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return options
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in rawtransactions.js/sendTxOptions()')
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = RawTransactions
|
module.exports = RawTransactions
|
||||||
@@ -27,11 +27,15 @@ class Price {
|
|||||||
this.coinexPriceUrl =
|
this.coinexPriceUrl =
|
||||||
'https://api.coinex.com/v1/market/ticker?market=bchausdt'
|
'https://api.coinex.com/v1/market/ticker?market=bchausdt'
|
||||||
|
|
||||||
|
this.bchCoinexPriceUrl =
|
||||||
|
'https://api.coinex.com/v1/market/ticker?market=bchusdt'
|
||||||
|
|
||||||
this.router = express.Router()
|
this.router = express.Router()
|
||||||
this.router.get('/', _this.root)
|
this.router.get('/', _this.root)
|
||||||
this.router.get('/usd', _this.getUSD)
|
this.router.get('/usd', _this.getUSD)
|
||||||
this.router.get('/rates', _this.getBCHRate)
|
this.router.get('/rates', _this.getBCHRate)
|
||||||
this.router.get('/bchausd', _this.getBCHAUSD)
|
this.router.get('/bchausd', _this.getBCHAUSD)
|
||||||
|
this.router.get('/bchusd', _this.getBCHUSD)
|
||||||
}
|
}
|
||||||
|
|
||||||
// DRY error handler.
|
// DRY error handler.
|
||||||
@@ -60,7 +64,7 @@ class Price {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/price/usd" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/price/usd" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getUSD (req, res, next) {
|
async getUSD (req, res, next) {
|
||||||
@@ -92,7 +96,7 @@ class Price {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/price/rates" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/price/rates" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
// Get rates for several different currencies
|
// Get rates for several different currencies
|
||||||
@@ -125,7 +129,7 @@ class Price {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/price/bchausd" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/price/bchausd" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
async getBCHAUSD (req, res, next) {
|
async getBCHAUSD (req, res, next) {
|
||||||
@@ -133,7 +137,7 @@ class Price {
|
|||||||
// Request options
|
// Request options
|
||||||
const opt = {
|
const opt = {
|
||||||
method: 'get',
|
method: 'get',
|
||||||
baseURL: this.coinexPriceUrl,
|
baseURL: _this.coinexPriceUrl,
|
||||||
timeout: 15000
|
timeout: 15000
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -150,6 +154,40 @@ class Price {
|
|||||||
return _this.errorHandler(err, res)
|
return _this.errorHandler(err, res)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /price/bchusd Get the USD price of BCH
|
||||||
|
* @apiName Get the USD price of BCH
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the USD price of BCH from Coinex.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v4/price/bchusd" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getBCHUSD (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: _this.bchCoinexPriceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await axios.request(opt)
|
||||||
|
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||||
|
|
||||||
|
const price = Number(response.data.data.ticker.last)
|
||||||
|
|
||||||
|
return res.json({ usd: price })
|
||||||
|
} catch (err) {
|
||||||
|
// Write out error to error log.
|
||||||
|
wlogger.error('Error in price.js/getBCHUSD().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = Price
|
module.exports = Price
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -4,17 +4,17 @@ const express = require('express')
|
|||||||
const router = express.Router()
|
const router = express.Router()
|
||||||
const axios = require('axios')
|
const axios = require('axios')
|
||||||
|
|
||||||
const routeUtils = require('./route-utils')
|
const RouteUtils = require('../../util/route-utils')
|
||||||
|
const routeUtils = new RouteUtils()
|
||||||
|
|
||||||
const wlogger = require('../../util/winston-logging')
|
const wlogger = require('../../util/winston-logging')
|
||||||
const Blockbook = require('./blockbook')
|
|
||||||
const blockbook = new Blockbook()
|
|
||||||
|
|
||||||
const util = require('util')
|
const util = require('util')
|
||||||
util.inspect.defaultOptions = { depth: 1 }
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
const BCHJS = require('@psf/bch-js')
|
const BCHJS = require('@psf/bch-js')
|
||||||
const bchjs = new BCHJS()
|
const bchjs = new BCHJS()
|
||||||
// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v3/'
|
// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v4/'
|
||||||
|
|
||||||
// const bchjsHTTP = axios.create({
|
// const bchjsHTTP = axios.create({
|
||||||
// baseURL: process.env.RPC_BASEURL
|
// baseURL: process.env.RPC_BASEURL
|
||||||
@@ -37,9 +37,28 @@ const bchjs = new BCHJS()
|
|||||||
let _this
|
let _this
|
||||||
|
|
||||||
class UtilRoute {
|
class UtilRoute {
|
||||||
constructor () {
|
constructor (utilConfig) {
|
||||||
this.bchjs = bchjs
|
this.bchjs = bchjs
|
||||||
this.blockbook = blockbook
|
// this.blockbook = blockbook
|
||||||
|
|
||||||
|
if (!utilConfig) {
|
||||||
|
throw new Error(
|
||||||
|
'Must pass a config object when instantiating the Util library.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
if (!utilConfig.electrumx) {
|
||||||
|
throw new Error(
|
||||||
|
'Must pass an instance of Electrumx when instantiating the Util library.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.electrumx = utilConfig.electrumx
|
||||||
|
|
||||||
|
this.router = router
|
||||||
|
this.router.get('/', this.root)
|
||||||
|
this.router.get('/validateAddress/:address', this.validateAddressSingle)
|
||||||
|
this.router.post('/validateAddress', this.validateAddressBulk)
|
||||||
|
this.router.post('/sweep', this.sweepWif)
|
||||||
|
|
||||||
_this = this
|
_this = this
|
||||||
}
|
}
|
||||||
@@ -56,7 +75,7 @@ class UtilRoute {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @apiExample Example usage:
|
||||||
* curl -X GET "https://api.fullstack.cash/v3/util/validateAddress/bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c" -H "accept: application/json"
|
* curl -X GET "https://api.fullstack.cash/v4/util/validateAddress/bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c" -H "accept: application/json"
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -105,8 +124,8 @@ class UtilRoute {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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/v4/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}'
|
* curl -X POST "https://api.fullstack.cash/v4/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"],"from": 1, "to": 5}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -124,7 +143,7 @@ class UtilRoute {
|
|||||||
|
|
||||||
// Enforce array size rate limits
|
// Enforce array size rate limits
|
||||||
if (!routeUtils.validateArraySize(req, addresses)) {
|
if (!routeUtils.validateArraySize(req, addresses)) {
|
||||||
res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
res.status(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
return res.json({
|
return res.json({
|
||||||
error: 'Array too large.'
|
error: 'Array too large.'
|
||||||
})
|
})
|
||||||
@@ -165,7 +184,7 @@ class UtilRoute {
|
|||||||
} = routeUtils.setEnvVars()
|
} = routeUtils.setEnvVars()
|
||||||
|
|
||||||
// Loop through each address and creates an array of requests to call in parallel
|
// Loop through each address and creates an array of requests to call in parallel
|
||||||
const promises = addresses.map(async address => {
|
const promises = addresses.map(async (address) => {
|
||||||
requestConfig.data.id = 'validateaddress'
|
requestConfig.data.id = 'validateaddress'
|
||||||
requestConfig.data.method = 'validateaddress'
|
requestConfig.data.method = 'validateaddress'
|
||||||
requestConfig.data.params = [address]
|
requestConfig.data.params = [address]
|
||||||
@@ -177,7 +196,7 @@ class UtilRoute {
|
|||||||
const axiosResult = await axios.all(promises)
|
const axiosResult = await axios.all(promises)
|
||||||
|
|
||||||
// Retrieve the data part of the result.
|
// Retrieve the data part of the result.
|
||||||
const result = axiosResult.map(x => x.data.result)
|
const result = axiosResult.map((x) => x.data.result)
|
||||||
|
|
||||||
res.status(200)
|
res.status(200)
|
||||||
return res.json(result)
|
return res.json(result)
|
||||||
@@ -208,8 +227,8 @@ class UtilRoute {
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @apiExample Example usage:
|
* @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/v4/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"}'
|
* curl -X POST "https://api.fullstack.cash/v4/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "toAddr": "bitcoincash:qpt8m4kqu963geedyrur6pdggqmv5kxwnq0rn322qu"}'
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -243,12 +262,11 @@ class UtilRoute {
|
|||||||
const fromAddr = bchjs.ECPair.toCashAddress(ecPair)
|
const fromAddr = bchjs.ECPair.toCashAddress(ecPair)
|
||||||
|
|
||||||
// Get a balance on the public address
|
// Get a balance on the public address
|
||||||
const balances = await _this.blockbook.balanceFromBlockbook(fromAddr)
|
const balances = await _this.electrumx._balanceFromElectrumx(fromAddr)
|
||||||
// console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
|
// console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
|
||||||
|
|
||||||
// Total balance is the sum of the confirmed and unconfirmed balance.
|
// Total balance is the sum of the confirmed and unconfirmed balance.
|
||||||
const totalBalance =
|
const totalBalance = balances.confirmed + balances.unconfirmed
|
||||||
Number(balances.balance) + Number(balances.unconfirmedBalance)
|
|
||||||
|
|
||||||
// Exit if balance is zero.
|
// Exit if balance is zero.
|
||||||
if (isNaN(totalBalance) || totalBalance === 0) {
|
if (isNaN(totalBalance) || totalBalance === 0) {
|
||||||
@@ -263,7 +281,7 @@ class UtilRoute {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Get all UTXOs help by the address.
|
// Get all UTXOs help by the address.
|
||||||
const utxos = await _this.blockbook.utxosFromBlockbook(fromAddr)
|
const utxos = await _this.electrumx._utxosFromElectrumx(fromAddr)
|
||||||
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||||
|
|
||||||
const tokenUtxos = []
|
const tokenUtxos = []
|
||||||
@@ -368,7 +386,7 @@ class UtilRoute {
|
|||||||
let utxos = options.utxos
|
let utxos = options.utxos
|
||||||
|
|
||||||
// Ensure all utxos have the satoshis property.
|
// Ensure all utxos have the satoshis property.
|
||||||
utxos = utxos.map(x => {
|
utxos = utxos.map((x) => {
|
||||||
x.satoshis = Number(x.value)
|
x.satoshis = Number(x.value)
|
||||||
return x
|
return x
|
||||||
})
|
})
|
||||||
@@ -386,9 +404,9 @@ class UtilRoute {
|
|||||||
for (let i = 0; i < utxos.length; i++) {
|
for (let i = 0; i < utxos.length; i++) {
|
||||||
const utxo = utxos[i]
|
const utxo = utxos[i]
|
||||||
|
|
||||||
originalAmount = originalAmount + utxo.satoshis
|
originalAmount = originalAmount + utxo.value
|
||||||
|
|
||||||
transactionBuilder.addInput(utxo.txid, utxo.vout)
|
transactionBuilder.addInput(utxo.tx_hash, utxo.tx_pos)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (originalAmount < 546) {
|
if (originalAmount < 546) {
|
||||||
@@ -423,7 +441,7 @@ class UtilRoute {
|
|||||||
ecPair,
|
ecPair,
|
||||||
redeemScript,
|
redeemScript,
|
||||||
transactionBuilder.hashTypes.SIGHASH_ALL,
|
transactionBuilder.hashTypes.SIGHASH_ALL,
|
||||||
utxo.satoshis
|
utxo.value
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -461,7 +479,7 @@ class UtilRoute {
|
|||||||
// Ensure there is only one class of token in the wallet. Throw an error if
|
// Ensure there is only one class of token in the wallet. Throw an error if
|
||||||
// there is more than one.
|
// there is more than one.
|
||||||
const tokenId = tokenUtxos[0].tokenId
|
const tokenId = tokenUtxos[0].tokenId
|
||||||
const otherTokens = tokenUtxos.filter(x => x.tokenId !== tokenId)
|
const otherTokens = tokenUtxos.filter((x) => x.tokenId !== tokenId)
|
||||||
if (otherTokens.length > 0) {
|
if (otherTokens.length > 0) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'Multiple token classes detected. This function only supports a single class of token.'
|
'Multiple token classes detected. This function only supports a single class of token.'
|
||||||
@@ -483,9 +501,9 @@ class UtilRoute {
|
|||||||
for (let i = 0; i < allUtxos.length; i++) {
|
for (let i = 0; i < allUtxos.length; i++) {
|
||||||
const utxo = allUtxos[i]
|
const utxo = allUtxos[i]
|
||||||
|
|
||||||
originalAmount = originalAmount + utxo.satoshis
|
originalAmount = originalAmount + utxo.value
|
||||||
|
|
||||||
transactionBuilder.addInput(utxo.txid, utxo.vout)
|
transactionBuilder.addInput(utxo.tx_hash, utxo.tx_pos)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (originalAmount < 300) {
|
if (originalAmount < 300) {
|
||||||
@@ -565,7 +583,7 @@ class UtilRoute {
|
|||||||
ecPair,
|
ecPair,
|
||||||
redeemScript,
|
redeemScript,
|
||||||
transactionBuilder.hashTypes.SIGHASH_ALL,
|
transactionBuilder.hashTypes.SIGHASH_ALL,
|
||||||
thisUtxo.satoshis
|
thisUtxo.value
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -585,20 +603,4 @@ class UtilRoute {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const utilRoute = new UtilRoute()
|
module.exports = 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
|
|
||||||
}
|
|
||||||
@@ -5,8 +5,10 @@
|
|||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const express = require('express')
|
const express = require('express')
|
||||||
// const axios = require('axios')
|
|
||||||
const routeUtils = require('./route-utils')
|
const RouteUtils = require('../../util/route-utils')
|
||||||
|
const routeUtils = new RouteUtils()
|
||||||
|
|
||||||
const wlogger = require('../../util/winston-logging')
|
const wlogger = require('../../util/winston-logging')
|
||||||
|
|
||||||
// const router = express.Router()
|
// const router = express.Router()
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,192 @@
|
|||||||
|
/*
|
||||||
|
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('@psf/bch-js')
|
||||||
|
const restURL = process.env.LOCAL_RESTURL
|
||||||
|
? process.env.LOCAL_RESTURL
|
||||||
|
: 'https://api.fullstack.cash/v4/'
|
||||||
|
const bchjs = new BCHJS({ restURL })
|
||||||
|
|
||||||
|
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({ success: false, 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/v4/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.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generate a user object that can be passed along with internal calls
|
||||||
|
// from bch-js.
|
||||||
|
const usrObj = {
|
||||||
|
ip: req._remoteAddress,
|
||||||
|
jwtToken: req.locals.jwtToken,
|
||||||
|
proLimit: req.locals.proLimit,
|
||||||
|
apiLevel: req.locals.apiLevel
|
||||||
|
}
|
||||||
|
|
||||||
|
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.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// console.log(
|
||||||
|
wlogger.debug(
|
||||||
|
'Executing encryption/getPublicKey with this address: ',
|
||||||
|
cashAddr
|
||||||
|
)
|
||||||
|
|
||||||
|
const rawTxData = await _this.bchjs.Electrumx.transactions([cashAddr], usrObj)
|
||||||
|
// console.log(`rawTxData: ${JSON.stringify(rawTxData, null, 2)}`)
|
||||||
|
|
||||||
|
// Extract just the TXIDs
|
||||||
|
const txids = rawTxData.transactions[0].transactions.map((elem) => elem.tx_hash)
|
||||||
|
// console.log(`txids: ${JSON.stringify(txids, null, 2)}`)
|
||||||
|
|
||||||
|
// throw error if there is no transaction history.
|
||||||
|
if (!txids || txids.length === 0) {
|
||||||
|
throw new Error('No transaction history.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Loop through the transaction history and search for the public key.
|
||||||
|
for (let i = 0; i < txids.length; i++) {
|
||||||
|
const thisTx = txids[i]
|
||||||
|
|
||||||
|
const txDetails = await _this.bchjs.RawTransactions.getRawTransaction(
|
||||||
|
[thisTx],
|
||||||
|
true,
|
||||||
|
usrObj
|
||||||
|
)
|
||||||
|
// console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
|
||||||
|
|
||||||
|
const vin = txDetails[0].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) {
|
||||||
|
// console.log('Error in encryption.js/getPublicKey().', err)
|
||||||
|
wlogger.error('Error in encryption.js/getPublicKey().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = Encryption
|
||||||
@@ -0,0 +1,989 @@
|
|||||||
|
/*
|
||||||
|
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('@psf/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)
|
||||||
|
this.router.post('/getBlock', this.getBlock)
|
||||||
|
}
|
||||||
|
|
||||||
|
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/v4/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/v4/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/v4/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/v4/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/v4/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(400) // 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/v4/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/v4/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/v4/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/v4/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(400) // 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/v4/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/v4/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/v4/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/v4/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/v4/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/v4/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/v4/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(400) // 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(400) // 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /blockchain/getBlock/ Get block details
|
||||||
|
* @apiName getBlock
|
||||||
|
* @apiGroup Blockchain
|
||||||
|
* @apiDescription Returns block details
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl "https://api.fullstack.cash/v4/blockchain/getblock/" -X POST -H "Content-Type: application/json" --data-binary '{"blockhash":"000000000000000002a5fe0bdd6e3f04342a975c0f55e57f97e73bb90041676b","verbosity":0 }'
|
||||||
|
*
|
||||||
|
* @apiParam {String} blockhash Block hash (required)
|
||||||
|
* @apiParam {Number} verbosity Default 1 (optional)
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getBlock (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Validate input parameter
|
||||||
|
const blockhash = req.body.blockhash
|
||||||
|
let verbosity = req.body.verbosity
|
||||||
|
|
||||||
|
// Default to a value of 1 if another verbosity level is not defined.
|
||||||
|
if (!verbosity && verbosity !== 0) verbosity = 1
|
||||||
|
|
||||||
|
if (!blockhash || blockhash === '') {
|
||||||
|
res.status(400)
|
||||||
|
return res.json({ error: 'blockhash can not be empty' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Axios options
|
||||||
|
const options = _this.routeUtils.getAxiosOptions()
|
||||||
|
|
||||||
|
options.data.id = 'getblock'
|
||||||
|
options.data.method = 'getblock'
|
||||||
|
options.data.params = [blockhash, verbosity]
|
||||||
|
|
||||||
|
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.js/getBlock()', 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/v4/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/v4/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/v4/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,589 @@
|
|||||||
|
'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/v4/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/v4/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(400) // 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/v4/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/v4/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(400) // 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/v4/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(400) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
|
||||||
|
return res.json({
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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/v4/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/v4/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' })
|
||||||
|
}
|
||||||
|
|
||||||
|
let options = _this.routeUtils.getAxiosOptions()
|
||||||
|
options = _this.sendTxOptions(options)
|
||||||
|
|
||||||
|
// Enforce array size rate limits
|
||||||
|
if (!_this.routeUtils.validateArraySize(req, hexes)) {
|
||||||
|
res.status(400) // 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/v4/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'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
let options = _this.routeUtils.getAxiosOptions()
|
||||||
|
options = _this.sendTxOptions(options)
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// This method modifies the default axios options. It attempts to inject
|
||||||
|
// a specific full node to use when broadcasting transactions. This is useful
|
||||||
|
// because it leverages the built-in protections that a full node has against
|
||||||
|
// accidental double spends. It mitigates a corner-case when rapidly spending
|
||||||
|
// TXs on load balanced nodes. By piping all TX sends through a single node,
|
||||||
|
// accidental double spends can be reduced.
|
||||||
|
sendTxOptions (options) {
|
||||||
|
try {
|
||||||
|
const sendUrl = process.env.RPC_SENDURL
|
||||||
|
|
||||||
|
if (sendUrl !== 'undefined' && sendUrl !== undefined) {
|
||||||
|
// console.log(`original options: ${JSON.stringify(options, null, 2)}`)
|
||||||
|
|
||||||
|
options.baseURL = process.env.RPC_SENDURL
|
||||||
|
|
||||||
|
// console.log(`modified options: ${JSON.stringify(options, null, 2)}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return options
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in rawtransactions.js/sendTxOptions()')
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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('@psf/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,193 @@
|
|||||||
|
/*
|
||||||
|
This price route is really just a wrapper for another API price endpoint.
|
||||||
|
The main reason for hosting this price wrapper is so that the price can
|
||||||
|
be accessible over Tor. Tor is typically blocked by other REST API servers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
const express = require('express')
|
||||||
|
const axios = require('axios')
|
||||||
|
const wlogger = require('../../util/winston-logging')
|
||||||
|
const util = require('util')
|
||||||
|
|
||||||
|
const RouteUtils = require('../../util/route-utils')
|
||||||
|
const routeUtils = new RouteUtils()
|
||||||
|
|
||||||
|
let _this // Global context for 'this' instance of the Class.
|
||||||
|
|
||||||
|
class Price {
|
||||||
|
constructor () {
|
||||||
|
_this = this
|
||||||
|
|
||||||
|
this.axios = axios
|
||||||
|
this.routeUtils = routeUtils
|
||||||
|
|
||||||
|
this.priceUrl = 'https://api.coinbase.com/v2/exchange-rates?currency=BCH'
|
||||||
|
this.coinexPriceUrl =
|
||||||
|
'https://api.coinex.com/v1/market/ticker?market=bchausdt'
|
||||||
|
|
||||||
|
this.bchCoinexPriceUrl =
|
||||||
|
'https://api.coinex.com/v1/market/ticker?market=bchusdt'
|
||||||
|
|
||||||
|
this.router = express.Router()
|
||||||
|
this.router.get('/', _this.root)
|
||||||
|
this.router.get('/usd', _this.getUSD)
|
||||||
|
this.router.get('/rates', _this.getBCHRate)
|
||||||
|
this.router.get('/bchausd', _this.getBCHAUSD)
|
||||||
|
this.router.get('/bchusd', _this.getBCHUSD)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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: 'price' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /price/usd Get the USD price of BCH
|
||||||
|
* @apiName Get the USD price of BCH
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the USD price of BCH from Coinbase.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v4/price/usd" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getUSD (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: _this.priceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await axios.request(opt)
|
||||||
|
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||||
|
|
||||||
|
return res.json({ usd: Number(response.data.data.rates.USD) })
|
||||||
|
} catch (err) {
|
||||||
|
// Write out error to error log.
|
||||||
|
wlogger.error('Error in price.js/getUSD().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /price/usd Get rates for several different currencies
|
||||||
|
* @apiName Get rates for several different currencies
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get rates for several different currencies from Coinbase.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v4/price/rates" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
// Get rates for several different currencies
|
||||||
|
async getBCHRate (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: _this.priceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await axios.request(opt)
|
||||||
|
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||||
|
|
||||||
|
return res.json(response.data.data.rates)
|
||||||
|
} catch (err) {
|
||||||
|
// Write out error to error log.
|
||||||
|
wlogger.error('Error in price.js/getUSD().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /price/bchausd Get the USD price of BCHA
|
||||||
|
* @apiName Get the USD price of BCHA
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the USD price of BCHA from Coinex.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v4/price/bchausd" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getBCHAUSD (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: _this.coinexPriceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await axios.request(opt)
|
||||||
|
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||||
|
|
||||||
|
const price = Number(response.data.data.ticker.last)
|
||||||
|
|
||||||
|
return res.json({ usd: price })
|
||||||
|
} catch (err) {
|
||||||
|
// Write out error to error log.
|
||||||
|
wlogger.error('Error in price.js/getBCHAUSD().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /price/bchusd Get the USD price of BCH
|
||||||
|
* @apiName Get the USD price of BCH
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the USD price of BCH from Coinex.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v4/price/bchusd" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
async getBCHUSD (req, res, next) {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: _this.bchCoinexPriceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await axios.request(opt)
|
||||||
|
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
|
||||||
|
|
||||||
|
const price = Number(response.data.data.ticker.last)
|
||||||
|
|
||||||
|
return res.json({ usd: price })
|
||||||
|
} catch (err) {
|
||||||
|
// Write out error to error log.
|
||||||
|
wlogger.error('Error in price.js/getBCHUSD().', err)
|
||||||
|
|
||||||
|
return _this.errorHandler(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = Price
|
||||||
@@ -0,0 +1,351 @@
|
|||||||
|
const axios = require('axios')
|
||||||
|
|
||||||
|
const SLPSDK = require('@psf/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,606 @@
|
|||||||
|
'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')
|
||||||
|
|
||||||
|
const util = require('util')
|
||||||
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
|
const BCHJS = require('@psf/bch-js')
|
||||||
|
const bchjs = new BCHJS()
|
||||||
|
// const BCHJS_TESTNET = 'https://testnet.bchjs.cash/v4/'
|
||||||
|
|
||||||
|
// 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 (utilConfig) {
|
||||||
|
this.bchjs = bchjs
|
||||||
|
// this.blockbook = blockbook
|
||||||
|
|
||||||
|
if (!utilConfig) {
|
||||||
|
throw new Error(
|
||||||
|
'Must pass a config object when instantiating the Util library.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
if (!utilConfig.electrumx) {
|
||||||
|
throw new Error(
|
||||||
|
'Must pass an instance of Electrumx when instantiating the Util library.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.electrumx = utilConfig.electrumx
|
||||||
|
|
||||||
|
this.router = router
|
||||||
|
this.router.get('/', this.root)
|
||||||
|
this.router.get('/validateAddress/:address', this.validateAddressSingle)
|
||||||
|
this.router.post('/validateAddress', this.validateAddressBulk)
|
||||||
|
this.router.post('/sweep', this.sweepWif)
|
||||||
|
|
||||||
|
_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/v4/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/v4/util/validateAddress" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c","bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0"]}'
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v4/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(400) // 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/v4/util/sweep" -H "accept: application/json" -H "Content-Type: application/json" -d '{"wif":"Kz52sdXLAiKtH82iAFRi6aTZanWtW5Eyv37KWdpY6tTv7pjoHste", "balanceOnly": true}'
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v4/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.electrumx._balanceFromElectrumx(fromAddr)
|
||||||
|
// console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
|
||||||
|
|
||||||
|
// Total balance is the sum of the confirmed and unconfirmed balance.
|
||||||
|
const totalBalance = balances.confirmed + balances.unconfirmed
|
||||||
|
|
||||||
|
// 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.electrumx._utxosFromElectrumx(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.value
|
||||||
|
|
||||||
|
transactionBuilder.addInput(utxo.tx_hash, utxo.tx_pos)
|
||||||
|
}
|
||||||
|
|
||||||
|
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.value
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.value
|
||||||
|
|
||||||
|
transactionBuilder.addInput(utxo.tx_hash, utxo.tx_pos)
|
||||||
|
}
|
||||||
|
|
||||||
|
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.value
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = UtilRoute
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
/*
|
||||||
|
xpub route
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
const express = require('express')
|
||||||
|
|
||||||
|
const RouteUtils = require('../../util/route-utils')
|
||||||
|
const routeUtils = new RouteUtils()
|
||||||
|
|
||||||
|
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('@psf/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
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -154,12 +154,68 @@ class RouteUtils {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Handle 429 errors
|
||||||
|
if (err.error) {
|
||||||
|
console.log('decodeError: err: ', err)
|
||||||
|
|
||||||
|
// Error thrown by nginx (usually the SLPDB load balancer.)
|
||||||
|
if (err.error.includes('429 Too Many Requests')) {
|
||||||
|
const internalMsg =
|
||||||
|
'429 error thrown by nginx caught by route-utils.js/decodeError()'
|
||||||
|
console.error(internalMsg)
|
||||||
|
wlogger.error(internalMsg)
|
||||||
|
|
||||||
|
return {
|
||||||
|
msg: '429 Too Many Requests',
|
||||||
|
status: 429
|
||||||
|
}
|
||||||
|
} else if (err.error.includes('Too many requests')) {
|
||||||
|
// Error is being thrown by bch-api rate limit middleware.
|
||||||
|
return {
|
||||||
|
msg: '429 Too Many Requests',
|
||||||
|
status: 429
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle general Error objects.
|
||||||
|
if (err.message) {
|
||||||
|
return {
|
||||||
|
msg: err.message,
|
||||||
|
status: 422
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return { msg: false, status: 500 }
|
return { msg: false, status: 500 }
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
console.error('unhandled error in route-utils.js/decodeError(): ', err)
|
||||||
wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
|
wlogger.error('unhandled error in route-utils.js/decodeError(): ', err)
|
||||||
return { msg: false, status: 500 }
|
return { msg: false, status: 500 }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Dynamically set these based on env vars. Allows unit testing.
|
||||||
|
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 }
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = RouteUtils
|
module.exports = RouteUtils
|
||||||
|
|||||||
@@ -11,13 +11,23 @@ require('winston-daily-rotate-file')
|
|||||||
|
|
||||||
var NETWORK = process.env.NETWORK
|
var NETWORK = process.env.NETWORK
|
||||||
|
|
||||||
|
// Default 1 Megabyte
|
||||||
|
var LOG_MAX_SIZE = process.env.LOG_MAX_SIZE ? process.env.LOG_MAX_SIZE : '1m'
|
||||||
|
|
||||||
|
// Default 5 days.
|
||||||
|
// This was causing a problem with popularity. Creating over a gigabyte of files.
|
||||||
|
// var LOG_MAX_FILES = process.env.LOG_MAX_FILES ? process.env.LOG_MAX_FILES : '5d'
|
||||||
|
|
||||||
|
// 250 files @ 1Meg each = 250 megs
|
||||||
|
var LOG_MAX_FILES = process.env.LOG_MAX_FILES ? process.env.LOG_MAX_FILES : '250'
|
||||||
|
|
||||||
// Configure daily-rotation transport.
|
// Configure daily-rotation transport.
|
||||||
var transport = new winston.transports.DailyRotateFile({
|
var transport = new winston.transports.DailyRotateFile({
|
||||||
filename: `${__dirname}/../../logs/rest-${NETWORK}-%DATE%.log`,
|
filename: `${__dirname}/../../logs/rest-${NETWORK}-%DATE%.log`,
|
||||||
datePattern: 'YYYY-MM-DD',
|
datePattern: 'YYYY-MM-DD',
|
||||||
zippedArchive: false,
|
zippedArchive: false,
|
||||||
maxSize: '1m',
|
maxSize: LOG_MAX_SIZE,
|
||||||
maxFiles: '5d',
|
maxFiles: LOG_MAX_FILES,
|
||||||
format: winston.format.combine(
|
format: winston.format.combine(
|
||||||
winston.format.timestamp(),
|
winston.format.timestamp(),
|
||||||
winston.format.json()
|
winston.format.json()
|
||||||
|
|||||||
+50
-13
@@ -1,32 +1,69 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# Full node
|
# Docker containers for the below infrastructure is described here:
|
||||||
export RPC_BASEURL=http://<full node ip>:8332/
|
# https://psfoundation.cash/blog/cash-stack
|
||||||
export RPC_USERNAME=<RPC username>
|
# Pre-synced databases can be downloaded on the CashStrap page:
|
||||||
export RPC_PASSWORD=<RPC password>
|
# https://fullstack.cash/cashstrap
|
||||||
|
|
||||||
|
# Which network are you using?
|
||||||
export NETWORK=mainnet
|
export NETWORK=mainnet
|
||||||
|
#export NETWORK=testnet
|
||||||
|
|
||||||
|
# Full node
|
||||||
|
export RPC_IP=<ip>:8332
|
||||||
|
export RPC_BASEURL=http://$RPC_IP/
|
||||||
|
export RPC_USERNAME=bitcoin
|
||||||
|
export RPC_PASSWORD=password
|
||||||
|
|
||||||
|
# (optional) If load-balancing multiple full nodes, it's best to pick a single
|
||||||
|
# one for broadcasting transactions to the network. Prevents accidental
|
||||||
|
# double spends.
|
||||||
|
#export RPC_SENDURL=http://$RPC_IP/
|
||||||
|
|
||||||
# SLPDB
|
# SLPDB
|
||||||
|
export SLPDB_PASS_GP=somelongpassword
|
||||||
export SLPDB_URL=http://<SLPDB IP>:12300/
|
export SLPDB_URL=http://<SLPDB IP>:12300/
|
||||||
|
# Use the same address as SLPDB_URL if you don't have a separate whitelist server.
|
||||||
# Blockbook
|
export SLPDB_PASS_WL=somelongpassword
|
||||||
export BLOCKBOOK_URL=https://<Blockbook IP>:9131/
|
export SLPDB_WHITELIST_URL=http://<SLPDB IP>:12300/
|
||||||
# Allow node.js to make network calls to https using self-signed certificate.
|
# slp-api alternative SLP validator using slp-validate:
|
||||||
export NODE_TLS_REJECT_UNAUTHORIZED=0
|
# https://github.com/Permissionless-Software-Foundation/slp-api
|
||||||
|
export SLP_API_URL=http://10.0.0.5:5001/
|
||||||
|
|
||||||
# Mainnet Fulcrum / ElectrumX
|
# Mainnet Fulcrum / ElectrumX
|
||||||
export FULCRUM_URL=192.168.0.6
|
export FULCRUM_URL=192.168.0.6
|
||||||
export FULCRUM_PORT=50002
|
export FULCRUM_PORT=50002
|
||||||
|
|
||||||
|
# Redis DB - Used for rate limiting - customize to your own Redis installation.
|
||||||
|
export REDIS_PORT=6379
|
||||||
|
export REDIS_HOST=172.17.0.1
|
||||||
|
|
||||||
|
# JWT Token Secret
|
||||||
|
# This is used to verify JWT tokens generated with jwt-bch-api:
|
||||||
|
# https://github.com/Permissionless-Software-Foundation/jwt-bch-api
|
||||||
export TOKENSECRET=somelongpassword
|
export TOKENSECRET=somelongpassword
|
||||||
|
|
||||||
# So that bch-api can call bch-js locally.
|
# So that bch-api can call bch-js locally.
|
||||||
export LOCAL_RESTURL=http://127.0.0.1:3000/v3/
|
export LOCAL_RESTURL=http://127.0.0.1:3000/v4/
|
||||||
|
|
||||||
# slp-api alternative SLP validator.
|
|
||||||
export SLP_API_URL=http://10.0.0.5:5001/
|
|
||||||
|
|
||||||
# Basic Authentication password
|
# Basic Authentication password
|
||||||
export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
|
export PRO_PASS=somerandomepassword:someotherrandompassword:aThirdPassword
|
||||||
|
|
||||||
|
# Whitelisted domains. Automatically give pro-tier rate limit access to apps
|
||||||
|
# that originate froma domain on the whitelist.
|
||||||
|
export WHITELIST_DOMAINS=fullstack.cash,psfoundation.cash,torlist.cash
|
||||||
|
|
||||||
|
# Rate Limits. Numbers are divided into 1000. e.g. 10000 / 500 = 20 RPM for ANON.
|
||||||
|
# Requests use the ANON rate limit if they fail to pass in a JWT token.
|
||||||
|
# ANON = 20 requests per minute (RPM)
|
||||||
|
export ANON_RATE_LIMIT=500
|
||||||
|
# 10 = 1000 RPM
|
||||||
|
export WHITELIST_RATE_LIMIT=100
|
||||||
|
|
||||||
|
# Set logging parameters
|
||||||
|
#1m means no more than 1 megabyte
|
||||||
|
export LOG_MAX_SIZE=1m
|
||||||
|
#5d means store no more than 5 days
|
||||||
|
export LOG_MAX_FILES=5d
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,545 +0,0 @@
|
|||||||
/*
|
|
||||||
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
|
|
||||||
}
|
|
||||||
@@ -1,460 +0,0 @@
|
|||||||
'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 50 points for anonymous user', () => {
|
|
||||||
const result = rateLimits.calcPoints()
|
|
||||||
// console.log(`result: ${result}`)
|
|
||||||
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for free tier requesting full node access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 10,
|
|
||||||
resource: 'blockchain',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for free tier requesting indexer access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 10,
|
|
||||||
resource: 'blockbook',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for free tier requesting SLPDB access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 10,
|
|
||||||
resource: 'slp',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 points for full node tier requesting full node access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 20,
|
|
||||||
resource: 'blockchain',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for full-node tier requesting indexer access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 20,
|
|
||||||
resource: 'blockbook',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for full node tier requesting SLPDB access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 20,
|
|
||||||
resource: 'slp',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 point for indexer tier requesting full node access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 30,
|
|
||||||
resource: 'blockchain',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 points for indexer tier requesting indexer access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 30,
|
|
||||||
resource: 'blockbook',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 50 points for indexer tier requesting SLPDB access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 30,
|
|
||||||
resource: 'slp',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 50)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 point for SLP tier requesting full node access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 40,
|
|
||||||
resource: 'blockchain',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 points for SLP tier requesting indexer access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 40,
|
|
||||||
resource: 'blockbook',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 10 points for SLP tier requesting SLPDB access', () => {
|
|
||||||
const jwtInfo = {
|
|
||||||
apiLevel: 40,
|
|
||||||
resource: 'slp',
|
|
||||||
id: '5e3a0415eb29a962da2708b4'
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = rateLimits.calcPoints(jwtInfo)
|
|
||||||
assert.equal(result, 10)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
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 20 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 < 22; 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, 50)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
// 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
|
|
||||||
// }
|
|
||||||
@@ -20,7 +20,7 @@ const assert = chai.assert
|
|||||||
|
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
const ElecrumxRoute = require('../../src/routes/v3/electrumx')
|
const ElecrumxRoute = require('../../src/routes/v4/electrumx')
|
||||||
|
|
||||||
// Mocking data.
|
// Mocking data.
|
||||||
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
const { mockReq, mockRes } = require('./mocks/express-mocks')
|
||||||
@@ -42,7 +42,7 @@ function expectRouteError (res, result, expectedError, code = 400) {
|
|||||||
assert.equal(result.success, false)
|
assert.equal(result.success, false)
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('#ElectrumX Router', () => {
|
describe('#Electrumx', () => {
|
||||||
let req, res
|
let req, res
|
||||||
let sandbox
|
let sandbox
|
||||||
const electrumxRoute = new ElecrumxRoute()
|
const electrumxRoute = new ElecrumxRoute()
|
||||||
@@ -199,11 +199,11 @@ describe('#ElectrumX Router', () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
describe('#getUtxos', () => {
|
describe('#getUtxos', () => {
|
||||||
it('should throw 400 if address is empty', async () => {
|
it('should throw 422 if address is empty', async () => {
|
||||||
const result = await electrumxRoute.getUtxos(req, res)
|
const result = await electrumxRoute.getUtxos(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -233,7 +233,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getUtxos(req, res)
|
const result = await electrumxRoute.getUtxos(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -594,7 +594,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
assert.isArray(result.transactions)
|
assert.isArray(result.transactions)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should throw 429 error if txid array is too large', async () => {
|
it('should throw 400 error if txid array is too large', async () => {
|
||||||
const testArray = []
|
const testArray = []
|
||||||
for (var i = 0; i < 25; i++) testArray.push('')
|
for (var i = 0; i < 25; i++) testArray.push('')
|
||||||
|
|
||||||
@@ -603,7 +603,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
const result = await electrumxRoute.transactionDetailsBulk(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
expectRouteError(res, result, 'Array too large', 429)
|
expectRouteError(res, result, 'Array too large', 400)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should get details for a single txid', async () => {
|
it('should get details for a single txid', async () => {
|
||||||
@@ -841,7 +841,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
assert.isArray(result.headers)
|
assert.isArray(result.headers)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should throw 429 error if heights array is too large', async () => {
|
it('should throw 400 error if heights array is too large', async () => {
|
||||||
const testArray = []
|
const testArray = []
|
||||||
for (var i = 0; i < 25; i++) testArray.push('')
|
for (var i = 0; i < 25; i++) testArray.push('')
|
||||||
|
|
||||||
@@ -849,7 +849,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
|
|
||||||
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
const result = await electrumxRoute.blockHeadersBulk(req, res)
|
||||||
|
|
||||||
expectRouteError(res, result, 'Array too large', 429)
|
expectRouteError(res, result, 'Array too large', 400)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should get details for a single height', async () => {
|
it('should get details for a single height', async () => {
|
||||||
@@ -1063,7 +1063,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getBalance(req, res)
|
const result = await electrumxRoute.getBalance(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -1093,7 +1093,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getBalance(req, res)
|
const result = await electrumxRoute.getBalance(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -1350,7 +1350,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getTransactions(req, res)
|
const result = await electrumxRoute.getTransactions(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -1380,7 +1380,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getTransactions(req, res)
|
const result = await electrumxRoute.getTransactions(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -1645,7 +1645,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getMempool(req, res)
|
const result = await electrumxRoute.getMempool(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -1675,7 +1675,7 @@ describe('#ElectrumX Router', () => {
|
|||||||
const result = await electrumxRoute.getMempool(req, res)
|
const result = await electrumxRoute.getMempool(req, res)
|
||||||
// console.log(`result: ${util.inspect(result)}`)
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 400, 'Expect 400 status code')
|
assert.equal(res.statusCode, 422, 'Expect 422 status code')
|
||||||
|
|
||||||
assert.property(result, 'error')
|
assert.property(result, 'error')
|
||||||
assert.include(result.error, 'Unsupported address format')
|
assert.include(result.error, 'Unsupported address format')
|
||||||
@@ -12,7 +12,7 @@ const chai = require('chai')
|
|||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
const Blockchain = require('../../src/routes/v3/full-node/blockchain')
|
const Blockchain = require('../../src/routes/v4/full-node/blockchain')
|
||||||
const uut = new Blockchain()
|
const uut = new Blockchain()
|
||||||
|
|
||||||
const util = require('util')
|
const util = require('util')
|
||||||
@@ -821,6 +821,7 @@ describe('#BlockchainRouter', () => {
|
|||||||
])
|
])
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('getRawMempool()', () => {
|
describe('getRawMempool()', () => {
|
||||||
it('should throw 503 when network issues', async () => {
|
it('should throw 503 when network issues', async () => {
|
||||||
// Save the existing RPC URL.
|
// Save the existing RPC URL.
|
||||||
@@ -842,6 +843,7 @@ describe('#BlockchainRouter', () => {
|
|||||||
'Error message expected'
|
'Error message expected'
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('returns proper error when downstream service stalls', async () => {
|
it('returns proper error when downstream service stalls', async () => {
|
||||||
// Mock the timeout error.
|
// Mock the timeout error.
|
||||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||||
@@ -856,6 +858,7 @@ describe('#BlockchainRouter', () => {
|
|||||||
'Error message expected'
|
'Error message expected'
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('returns proper error when downstream service is down', async () => {
|
it('returns proper error when downstream service is down', async () => {
|
||||||
// Mock the timeout error.
|
// Mock the timeout error.
|
||||||
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
|
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNREFUSED' })
|
||||||
@@ -871,7 +874,7 @@ describe('#BlockchainRouter', () => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should GET /getMempoolInfo', async () => {
|
it('should GET /getRawMempool', async () => {
|
||||||
// Mock the RPC call for unit tests.
|
// Mock the RPC call for unit tests.
|
||||||
if (process.env.TEST === 'unit') {
|
if (process.env.TEST === 'unit') {
|
||||||
sandbox
|
sandbox
|
||||||
@@ -886,6 +889,7 @@ describe('#BlockchainRouter', () => {
|
|||||||
// Not sure what other assertions should be made here.
|
// Not sure what other assertions should be made here.
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('getMempoolEntrySingle()', () => {
|
describe('getMempoolEntrySingle()', () => {
|
||||||
it('should throw 400 if txid is empty', async () => {
|
it('should throw 400 if txid is empty', async () => {
|
||||||
const result = await uut.getMempoolEntrySingle(req, res)
|
const result = await uut.getMempoolEntrySingle(req, res)
|
||||||
@@ -1819,4 +1823,204 @@ describe('#BlockchainRouter', () => {
|
|||||||
assert.equal(result.length, 2)
|
assert.equal(result.length, 2)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe('#getBlock()', () => {
|
||||||
|
it('returns proper error when downstream service stalls', async () => {
|
||||||
|
// Mock the timeout error.
|
||||||
|
sandbox.stub(uut.axios, 'request').throws({ code: 'ECONNABORTED' })
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'000000202ed2723e7590e2b937f6821a99d6764cb8799bf30f8e300000000000000000001d311c02df9a1e3f57b8dbdcf97ec8dbc3109a26779724c63e560b29ad9ea501e2af955d286403183049e39c1e000000067139f230701a2819a76795564bd2f67ded7eeae68596f368eddb3dd5bc54e59320e896f71d61cfc3ae3d4a90fca08b1aa35ba91256d8939d2cad11e638c0081f66724abdef55cf7b8b9fed064bce0369171434f8b289c1330ccef765f8e97a2c0d794d81aafb535855f7daa6bb51e40f77c6b59d7af7f62d0eb726a4fc4df82353d56fcbda7c7ea6bd935d61af8fb3b295637e6f323b10231135b3f10a034cfb238f635830c0595e52c6c31247cf677b555f7a287076e20cd0e1d3cc9af7260f02b700'
|
||||||
|
|
||||||
|
const result = await uut.getBlock(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' })
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'000000202ed2723e7590e2b937f6821a99d6764cb8799bf30f8e300000000000000000001d311c02df9a1e3f57b8dbdcf97ec8dbc3109a26779724c63e560b29ad9ea501e2af955d286403183049e39c1e000000067139f230701a2819a76795564bd2f67ded7eeae68596f368eddb3dd5bc54e59320e896f71d61cfc3ae3d4a90fca08b1aa35ba91256d8939d2cad11e638c0081f66724abdef55cf7b8b9fed064bce0369171434f8b289c1330ccef765f8e97a2c0d794d81aafb535855f7daa6bb51e40f77c6b59d7af7f62d0eb726a4fc4df82353d56fcbda7c7ea6bd935d61af8fb3b295637e6f323b10231135b3f10a034cfb238f635830c0595e52c6c31247cf677b555f7a287076e20cd0e1d3cc9af7260f02b700'
|
||||||
|
const result = await uut.getBlock(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 throw 400 if blockhash is empty', async () => {
|
||||||
|
const result = await uut.getBlock(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.hasAllKeys(result, ['error'])
|
||||||
|
assert.include(result.error, 'blockhash can not be empty')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return block info with verbosity 0', async () => {
|
||||||
|
// Mock the RPC call for unit tests.
|
||||||
|
if (process.env.TEST === 'unit') {
|
||||||
|
sandbox
|
||||||
|
.stub(uut.axios, 'request')
|
||||||
|
.resolves({ data: { result: mockData.mockBlockInfo.verbosity0 } })
|
||||||
|
}
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
|
||||||
|
req.body.verbosity = 0
|
||||||
|
|
||||||
|
const result = await uut.getBlock(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.isString(result)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return block info with verbosity 1', async () => {
|
||||||
|
// Mock the RPC call for unit tests.
|
||||||
|
if (process.env.TEST === 'unit') {
|
||||||
|
sandbox
|
||||||
|
.stub(uut.axios, 'request')
|
||||||
|
.resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
|
||||||
|
}
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
|
||||||
|
req.body.verbosity = 1
|
||||||
|
|
||||||
|
const result = await uut.getBlock(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.property(result, 'hash', 'hash property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'confirmations',
|
||||||
|
'confirmations property expected'
|
||||||
|
)
|
||||||
|
assert.property(result, 'size', 'size property expected')
|
||||||
|
assert.property(result, 'height', 'height property expected')
|
||||||
|
assert.property(result, 'version', 'version property expected')
|
||||||
|
assert.property(result, 'versionHex', 'versionHex property expected')
|
||||||
|
assert.property(result, 'merkleroot', 'merkleroot property expected')
|
||||||
|
assert.property(result, 'tx', 'tx property expected')
|
||||||
|
assert.property(result, 'time', 'time property expected')
|
||||||
|
assert.property(result, 'mediantime', 'mediantime property expected')
|
||||||
|
assert.property(result, 'nonce', 'nonce property expected')
|
||||||
|
assert.property(result, 'bits', 'bits property expected')
|
||||||
|
assert.property(result, 'difficulty', 'difficulty property expected')
|
||||||
|
assert.property(result, 'chainwork', 'chainwork property expected')
|
||||||
|
assert.property(result, 'nTx', 'nTx property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'previousblockhash',
|
||||||
|
'previousblockhash property expected'
|
||||||
|
)
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'nextblockhash',
|
||||||
|
'nextblockhash property expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return block info with verbosity 2', async () => {
|
||||||
|
// Mock the RPC call for unit tests.
|
||||||
|
if (process.env.TEST === 'unit') {
|
||||||
|
sandbox
|
||||||
|
.stub(uut.axios, 'request')
|
||||||
|
.resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
|
||||||
|
}
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
|
||||||
|
req.body.verbosity = 2
|
||||||
|
|
||||||
|
const result = await uut.getBlock(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.property(result, 'hash', 'hash property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'confirmations',
|
||||||
|
'confirmations property expected'
|
||||||
|
)
|
||||||
|
assert.property(result, 'size', 'size property expected')
|
||||||
|
assert.property(result, 'height', 'height property expected')
|
||||||
|
assert.property(result, 'version', 'version property expected')
|
||||||
|
assert.property(result, 'versionHex', 'versionHex property expected')
|
||||||
|
assert.property(result, 'merkleroot', 'merkleroot property expected')
|
||||||
|
assert.property(result, 'tx', 'tx property expected')
|
||||||
|
assert.property(result, 'time', 'time property expected')
|
||||||
|
assert.property(result, 'mediantime', 'mediantime property expected')
|
||||||
|
assert.property(result, 'nonce', 'nonce property expected')
|
||||||
|
assert.property(result, 'bits', 'bits property expected')
|
||||||
|
assert.property(result, 'difficulty', 'difficulty property expected')
|
||||||
|
assert.property(result, 'chainwork', 'chainwork property expected')
|
||||||
|
assert.property(result, 'nTx', 'nTx property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'previousblockhash',
|
||||||
|
'previousblockhash property expected'
|
||||||
|
)
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'nextblockhash',
|
||||||
|
'nextblockhash property expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return block info without verbosity especified', async () => {
|
||||||
|
// Mock the RPC call for unit tests.
|
||||||
|
if (process.env.TEST === 'unit') {
|
||||||
|
sandbox
|
||||||
|
.stub(uut.axios, 'request')
|
||||||
|
.resolves({ data: { result: mockData.mockBlockInfo.verbosity1 } })
|
||||||
|
}
|
||||||
|
|
||||||
|
req.body.blockhash =
|
||||||
|
'0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
|
||||||
|
|
||||||
|
const result = await uut.getBlock(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.property(result, 'hash', 'hash property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'confirmations',
|
||||||
|
'confirmations property expected'
|
||||||
|
)
|
||||||
|
assert.property(result, 'size', 'size property expected')
|
||||||
|
assert.property(result, 'height', 'height property expected')
|
||||||
|
assert.property(result, 'version', 'version property expected')
|
||||||
|
assert.property(result, 'versionHex', 'versionHex property expected')
|
||||||
|
assert.property(result, 'merkleroot', 'merkleroot property expected')
|
||||||
|
assert.property(result, 'tx', 'tx property expected')
|
||||||
|
assert.property(result, 'time', 'time property expected')
|
||||||
|
assert.property(result, 'mediantime', 'mediantime property expected')
|
||||||
|
assert.property(result, 'nonce', 'nonce property expected')
|
||||||
|
assert.property(result, 'bits', 'bits property expected')
|
||||||
|
assert.property(result, 'difficulty', 'difficulty property expected')
|
||||||
|
assert.property(result, 'chainwork', 'chainwork property expected')
|
||||||
|
assert.property(result, 'nTx', 'nTx property expected')
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'previousblockhash',
|
||||||
|
'previousblockhash property expected'
|
||||||
|
)
|
||||||
|
assert.property(
|
||||||
|
result,
|
||||||
|
'nextblockhash',
|
||||||
|
'nextblockhash property expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
const chai = require('chai')
|
const chai = require('chai')
|
||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const ControlRoute = require('../../src/routes/v3/full-node/control')
|
const ControlRoute = require('../../src/routes/v4/full-node/control')
|
||||||
const uut = new ControlRoute()
|
const uut = new ControlRoute()
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
@@ -19,7 +19,7 @@ const sinon = require('sinon')
|
|||||||
if (!process.env.TEST) process.env.TEST = 'unit'
|
if (!process.env.TEST) process.env.TEST = 'unit'
|
||||||
|
|
||||||
// Only load blockbook library after setting BLOCKBOOK_URL env var.
|
// Only load blockbook library after setting BLOCKBOOK_URL env var.
|
||||||
const EncryptionRoute = require('../../src/routes/v3/encryption')
|
const EncryptionRoute = require('../../src/routes/v4/encryption')
|
||||||
const encryptionRoute = new EncryptionRoute()
|
const encryptionRoute = new EncryptionRoute()
|
||||||
|
|
||||||
// Mocking data.
|
// Mocking data.
|
||||||
@@ -82,7 +82,7 @@ describe('#Encryption Router', () => {
|
|||||||
.resolves(mockData.mockFulcrumTxHistory)
|
.resolves(mockData.mockFulcrumTxHistory)
|
||||||
sandbox
|
sandbox
|
||||||
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
||||||
.resolves(mockData.mockTxDetails2)
|
.resolves([mockData.mockTxDetails2])
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await encryptionRoute.getPublicKey(req, res)
|
const result = await encryptionRoute.getPublicKey(req, res)
|
||||||
@@ -110,7 +110,7 @@ describe('#Encryption Router', () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const result = await encryptionRoute.getPublicKey(req, res)
|
const result = await encryptionRoute.getPublicKey(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.property(result, 'success')
|
assert.property(result, 'success')
|
||||||
assert.equal(result.success, false)
|
assert.equal(result.success, false)
|
||||||
@@ -130,7 +130,7 @@ describe('#Encryption Router', () => {
|
|||||||
.resolves(mockData.mockFulcrumNoSendBalance)
|
.resolves(mockData.mockFulcrumNoSendBalance)
|
||||||
sandbox
|
sandbox
|
||||||
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
||||||
.resolves(mockData.mockNoSendTx)
|
.resolves([mockData.mockNoSendTx])
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await encryptionRoute.getPublicKey(req, res)
|
const result = await encryptionRoute.getPublicKey(req, res)
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
/*
|
||||||
|
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 SLP = require('../../../src/routes/v4/slp')
|
||||||
|
const slp = new SLP()
|
||||||
|
|
||||||
|
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||||
|
|
||||||
|
describe('#nft', () => {
|
||||||
|
let req, res
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
// Mock the req and res objects used by Express routes.
|
||||||
|
req = mockReq
|
||||||
|
res = mockRes
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNftChildren', () => {
|
||||||
|
it('should return error on non-existing NFT group token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0b'
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT group does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should return error on non-group NFT token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT group does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should get NFT children list', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
|
||||||
|
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isArray(result.nftChildren)
|
||||||
|
assert.equal(result.nftChildren.length, 2)
|
||||||
|
assert.equal(
|
||||||
|
result.nftChildren[0],
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
)
|
||||||
|
assert.equal(
|
||||||
|
result.nftChildren[1],
|
||||||
|
'928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNftGroup', () => {
|
||||||
|
it('should return error on non-existing NFT child token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a8'
|
||||||
|
const result = await slp.getNftGroup(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT child does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should get NFT group token info', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
// req.params.tokenId = '928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
|
||||||
|
const result = await slp.getNftGroup(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
assert.property(result, 'nftGroup')
|
||||||
|
assert.property(result.nftGroup, 'id')
|
||||||
|
assert.property(result.nftGroup, 'versionType')
|
||||||
|
assert.property(result.nftGroup, 'symbol')
|
||||||
|
assert.equal(
|
||||||
|
result.nftGroup.id,
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
|
||||||
|
)
|
||||||
|
assert.equal(result.nftGroup.versionType, 129)
|
||||||
|
assert.equal(result.nftGroup.symbol, 'PSF.TEST.GROUP')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -11,7 +11,7 @@ const assert = require('chai').assert
|
|||||||
const util = require('util')
|
const util = require('util')
|
||||||
util.inspect.defaultOptions = { depth: 1 }
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
const Price = require('../../../src/routes/v3/price')
|
const Price = require('../../../src/routes/v4/price')
|
||||||
const price = new Price()
|
const price = new Price()
|
||||||
|
|
||||||
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||||
@@ -39,6 +39,14 @@ describe('#price', () => {
|
|||||||
const result = await price.getBCHAUSD(req, res)
|
const result = await price.getBCHAUSD(req, res)
|
||||||
console.log(`result: ${util.inspect(result)}`)
|
console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isNumber(result.usd)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
describe('#getBCHUSD', () => {
|
||||||
|
it('should get the USD price of BCH', async () => {
|
||||||
|
const result = await price.getBCHUSD(req, res)
|
||||||
|
console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
assert.isNumber(result.usd)
|
assert.isNumber(result.usd)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
@@ -13,9 +13,9 @@ const axios = require('axios')
|
|||||||
const util = require('util')
|
const util = require('util')
|
||||||
util.inspect.defaultOptions = { depth: 1 }
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
// const SERVER = `http://192.168.0.36:12400/v3/`
|
// const SERVER = `http://192.168.0.36:12400/v4/`
|
||||||
const SERVER = 'http://localhost:3000/v3/'
|
const SERVER = 'http://localhost:3000/v4/'
|
||||||
// const SERVER = 'https://api.fullstack.cash/v3/'
|
// const SERVER = 'https://api.fullstack.cash/v4/'
|
||||||
//
|
//
|
||||||
// const TEST_JWT =
|
// const TEST_JWT =
|
||||||
// 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
|
// 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
|
||||||
@@ -7,21 +7,22 @@
|
|||||||
TODO:
|
TODO:
|
||||||
-/rawtransactions/sendRawTransaction is more appropropriate for an e2e test,
|
-/rawtransactions/sendRawTransaction is more appropropriate for an e2e test,
|
||||||
so it is omitted here.
|
so it is omitted here.
|
||||||
|
- Replace request-promise with axios.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const chai = require('chai')
|
// const chai = require('chai')
|
||||||
const assert = chai.assert
|
// const assert = chai.assert
|
||||||
// const rawtransactions = require('../../../dist/routes/v2/rawtransactions')
|
// const rawtransactions = require('../../../dist/routes/v2/rawtransactions')
|
||||||
const rp = require('request-promise')
|
// const rp = require('request-promise')
|
||||||
|
|
||||||
// Used for debugging.
|
// Used for debugging.
|
||||||
const util = require('util')
|
const util = require('util')
|
||||||
util.inspect.defaultOptions = { depth: 1 }
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
// const mockData = require('../mocks/raw-transactions-mocks')
|
// const mockData = require('../mocks/raw-transactions-mocks')
|
||||||
|
/*
|
||||||
describe('#Raw-Transactions', () => {
|
describe('#Raw-Transactions', () => {
|
||||||
describe('#root', () => {
|
describe('#root', () => {
|
||||||
it('should return root', async () => {
|
it('should return root', async () => {
|
||||||
@@ -189,3 +190,4 @@ describe('#Raw-Transactions', () => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
*/
|
||||||
@@ -19,7 +19,7 @@ if (!process.env.SLPDB_URL) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
const SLP = require('../../../src/routes/v3/slp')
|
const SLP = require('../../../src/routes/v4/slp')
|
||||||
const slp = new SLP()
|
const slp = new SLP()
|
||||||
|
|
||||||
const BCHJS = require('@psf/bch-js')
|
const BCHJS = require('@psf/bch-js')
|
||||||
@@ -110,8 +110,8 @@ describe('#slp', () => {
|
|||||||
req.body.tokenUtxos = [
|
req.body.tokenUtxos = [
|
||||||
{
|
{
|
||||||
tokenId:
|
tokenId:
|
||||||
'0a321bff9761f28e06a268b14711274bb77617410a16807bd0437ef234a072b1',
|
'38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||||
decimals: 0,
|
decimals: 8,
|
||||||
tokenQty: 2
|
tokenQty: 2
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -214,6 +214,39 @@ describe('#slp', () => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe('#hydrateUtxosWL', () => {
|
||||||
|
it('should return utxo details', async () => {
|
||||||
|
const utxos = [
|
||||||
|
{
|
||||||
|
utxos: [
|
||||||
|
{
|
||||||
|
tx_hash:
|
||||||
|
'89b3f0c84efe8b01b24e2d7ac08636de5781f31dbb84478e3de868ca0a7ed93a',
|
||||||
|
tx_pos: 1,
|
||||||
|
value: 546
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.utxos = utxos
|
||||||
|
const result = await slp.hydrateUtxosWL(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// Test the general structure of the output.
|
||||||
|
assert.isArray(result.slpUtxos)
|
||||||
|
assert.equal(result.slpUtxos.length, 1)
|
||||||
|
assert.equal(result.slpUtxos[0].utxos.length, 1)
|
||||||
|
|
||||||
|
// Test the non-slp UTXO.
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'tx_hash')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'tx_pos')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'value')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'isValid')
|
||||||
|
assert.equal(result.slpUtxos[0].utxos[0].isValid, true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
describe('#validate2Single', () => {
|
describe('#validate2Single', () => {
|
||||||
it('should invalidate a known invalid TXID', async () => {
|
it('should invalidate a known invalid TXID', async () => {
|
||||||
const txid =
|
const txid =
|
||||||
@@ -258,4 +291,171 @@ describe('#slp', () => {
|
|||||||
// )
|
// )
|
||||||
// })
|
// })
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe('#validateBulk', () => {
|
||||||
|
it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
|
||||||
|
const txids = [
|
||||||
|
// Malformed SLP tx
|
||||||
|
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
|
||||||
|
// Normal TX (non-SLP)
|
||||||
|
'01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
|
||||||
|
// Valid PSF SLP tx
|
||||||
|
'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
|
||||||
|
// Valid SLP token not in whitelist
|
||||||
|
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
|
||||||
|
// Token send on BCHN network.
|
||||||
|
'402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
|
||||||
|
// Token send on ABC network.
|
||||||
|
'336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
|
||||||
|
// Known invalid SLP token send of PSF tokens.
|
||||||
|
'2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.txids = txids
|
||||||
|
const result = await slp.validateBulk(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// BCHN expected results
|
||||||
|
if (process.env.ISBCHN) {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
// Note: This should change from null to true once SLPDB finishes indexing.
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#validate3Bulk', () => {
|
||||||
|
it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
|
||||||
|
const txids = [
|
||||||
|
// Malformed SLP tx
|
||||||
|
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
|
||||||
|
// Normal TX (non-SLP)
|
||||||
|
'01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
|
||||||
|
// Valid PSF SLP tx
|
||||||
|
'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
|
||||||
|
// Valid SLP token not in whitelist
|
||||||
|
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
|
||||||
|
// Token send on BCHN network.
|
||||||
|
'402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
|
||||||
|
// Token send on ABC network.
|
||||||
|
'336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
|
||||||
|
// Known invalid SLP token send of PSF tokens.
|
||||||
|
'2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.txids = txids
|
||||||
|
const result = await slp.validate3Bulk(req, res)
|
||||||
|
console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// BCHN expected results
|
||||||
|
if (process.env.ISBCHN) {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, null)
|
||||||
|
|
||||||
|
// Note: This should change from null to true once SLPDB finishes indexing.
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getStatus', () => {
|
||||||
|
it('should get the SLPDB status', async () => {
|
||||||
|
const result = await slp.getStatus(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.property(result, 'bchBlockHeight')
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
@@ -18,7 +18,7 @@ if (!process.env.SLPDB_URL) {
|
|||||||
throw new Error('SLPDB_URL and SLPDB_PASS must be defined in order to run these tests.')
|
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 = require('../../../src/routes/v4/services/slpdb')
|
||||||
const slpdb = new SLPDB()
|
const slpdb = new SLPDB()
|
||||||
|
|
||||||
describe('#slpdb', () => {
|
describe('#slpdb', () => {
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
const chai = require('chai')
|
const chai = require('chai')
|
||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const MiningRoute = require('../../src/routes/v3/full-node/mining')
|
const MiningRoute = require('../../src/routes/v4/full-node/mining')
|
||||||
const uut = new MiningRoute()
|
const uut = new MiningRoute()
|
||||||
|
|
||||||
// const nock = require('nock') // HTTP mocking
|
// const nock = require('nock') // HTTP mocking
|
||||||
@@ -285,7 +285,86 @@ const mockAncestors = [
|
|||||||
'e68dad4a7292105cfa84fcaef7f99e5d4f2ece9613ca625d4d2ebf61efa84118',
|
'e68dad4a7292105cfa84fcaef7f99e5d4f2ece9613ca625d4d2ebf61efa84118',
|
||||||
'fe94caf5da672be3772d2304a6272eb8bc3d3f5cb4a886f39b7981e1485cf74b'
|
'fe94caf5da672be3772d2304a6272eb8bc3d3f5cb4a886f39b7981e1485cf74b'
|
||||||
]
|
]
|
||||||
|
const mockBlockInfo = {
|
||||||
|
verbosity0: '20000000',
|
||||||
|
verbosity1: {
|
||||||
|
hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
|
||||||
|
confirmations: 1,
|
||||||
|
size: 3725,
|
||||||
|
strippedsize: 3725,
|
||||||
|
weight: 3725,
|
||||||
|
height: 6725,
|
||||||
|
version: 1,
|
||||||
|
versionHex: '00000000',
|
||||||
|
merkleroot: 'xxxx',
|
||||||
|
tx: [
|
||||||
|
'2afb8264508e2bf3e5288ccad01ed2ab766745b6b9747666b519d59212012c01',
|
||||||
|
'18f40b1ae56bba3fa1934b737fbe46ed8d5ca40fa9aed95073eeb5a119530cd3',
|
||||||
|
'349720d878547752607a69eb19e330592fee271fb5376cdfd811bee423558ed8',
|
||||||
|
'35571c80e7d0e9247b467454ef147d1d5833c775bc2d4164b1bebd4c1f69164f',
|
||||||
|
'480937e8efacdafeeb97d401ff0dd9ea8e8ddb27244cefa67a03621315bdb0e6',
|
||||||
|
'523327469d0b90c0de9a905c2fe6e227278fc5b55b9d9911ca151e1c26647065',
|
||||||
|
'61de4af971d94dbc741762f21dcef08b74b62863a56a1cb3496becdd8d47a858',
|
||||||
|
'69f70a288403b5bba23030ccd05d2e5cb00394620fdae3b050cff9432cc590ce',
|
||||||
|
'94472a90fbdba2eb2cba68308415181faedf3585c66b89efcbdb927a0c10ba23',
|
||||||
|
'bc6f781f9e2f2df460f89995c5e1c7224e48ccbe1aa2a575961f3f5330259864',
|
||||||
|
'f2d945a79bec5454a9ab4d570a150d81124daa308f1c81106a977d6413476944'
|
||||||
|
],
|
||||||
|
time: 111,
|
||||||
|
mediantime: 111,
|
||||||
|
nonce: 111,
|
||||||
|
bits: '1d00ffff',
|
||||||
|
difficulty: 99.999,
|
||||||
|
chainwork: 'xxxx',
|
||||||
|
nTx: 1,
|
||||||
|
previousblockhash:
|
||||||
|
'00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
|
||||||
|
nextblockhash:
|
||||||
|
'00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
|
||||||
|
},
|
||||||
|
verbosity2: {
|
||||||
|
hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
|
||||||
|
confirmations: 1,
|
||||||
|
size: 3725,
|
||||||
|
strippedsize: 3725,
|
||||||
|
weight: 3725,
|
||||||
|
height: 6725,
|
||||||
|
version: 1,
|
||||||
|
versionHex: '00000000',
|
||||||
|
merkleroot: 'xxxx',
|
||||||
|
tx: [
|
||||||
|
{
|
||||||
|
hex:
|
||||||
|
'01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000',
|
||||||
|
txid:
|
||||||
|
'0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',
|
||||||
|
hash:
|
||||||
|
'0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',
|
||||||
|
size: 134,
|
||||||
|
version: 1,
|
||||||
|
locktime: 0,
|
||||||
|
vin: [],
|
||||||
|
vout: [],
|
||||||
|
blockhash:
|
||||||
|
'00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048',
|
||||||
|
confirmations: 581882,
|
||||||
|
time: 1231469665,
|
||||||
|
blocktime: 1231469665
|
||||||
|
}
|
||||||
|
],
|
||||||
|
time: 111,
|
||||||
|
mediantime: 111,
|
||||||
|
nonce: 111,
|
||||||
|
bits: '1d00ffff',
|
||||||
|
difficulty: 99.999,
|
||||||
|
chainwork: 'xxxx',
|
||||||
|
nTx: 1,
|
||||||
|
previousblockhash:
|
||||||
|
'00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
|
||||||
|
nextblockhash:
|
||||||
|
'00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
|
||||||
|
}
|
||||||
|
}
|
||||||
module.exports = {
|
module.exports = {
|
||||||
mockBlockHash,
|
mockBlockHash,
|
||||||
mockBlockchainInfo,
|
mockBlockchainInfo,
|
||||||
@@ -296,5 +375,6 @@ module.exports = {
|
|||||||
mockBlockHeader,
|
mockBlockHeader,
|
||||||
mockTxOut,
|
mockTxOut,
|
||||||
mockTxOutProof,
|
mockTxOutProof,
|
||||||
mockAncestors
|
mockAncestors,
|
||||||
|
mockBlockInfo
|
||||||
}
|
}
|
||||||
@@ -55,64 +55,68 @@ const mockFulcrumTxHistory = {
|
|||||||
success: true,
|
success: true,
|
||||||
transactions: [
|
transactions: [
|
||||||
{
|
{
|
||||||
height: 511463,
|
transactions: [
|
||||||
tx_hash:
|
{
|
||||||
'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3'
|
height: 511463,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'eff00a9538487ff44243c75fb13de19b5783454c42c81b9aff9afbfd09cbaec3'
|
||||||
height: 511464,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153'
|
height: 511464,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'7e9aa7a74de2b30200a2d6fc748ff35a0c753221444194f720bb7f61ef1d9153'
|
||||||
height: 513373,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'6960255abe64893073921e96bf3c053c82686e0fc22a565494fbe2a31e766975'
|
height: 513373,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'6960255abe64893073921e96bf3c053c82686e0fc22a565494fbe2a31e766975'
|
||||||
height: 513373,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'9ea667bcfc9cd337bd6c5583d8094c1b1942bd2015d95b54189deac5070eeff0'
|
height: 513373,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'9ea667bcfc9cd337bd6c5583d8094c1b1942bd2015d95b54189deac5070eeff0'
|
||||||
height: 560481,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'ecc1b51bac767880382bf3190ff17abf78d0936843a022a943d871116ed50368'
|
height: 560481,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'ecc1b51bac767880382bf3190ff17abf78d0936843a022a943d871116ed50368'
|
||||||
height: 560615,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'b3792d28377b975560e1b6f09e48aeff8438d4c6969ca578bd406393bd50bd7d'
|
height: 560615,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'b3792d28377b975560e1b6f09e48aeff8438d4c6969ca578bd406393bd50bd7d'
|
||||||
height: 561568,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'8bc2134c7e48e56e1769b3d7c4c1e3a0acc68e1e58160eee6fa67f3208c07262'
|
height: 561568,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'8bc2134c7e48e56e1769b3d7c4c1e3a0acc68e1e58160eee6fa67f3208c07262'
|
||||||
height: 561569,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'ceb0cab0e37b59caf3ca29e1a698d19ff47f2827dd09cb2f3b91b9100b1dad1c'
|
height: 561569,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'ceb0cab0e37b59caf3ca29e1a698d19ff47f2827dd09cb2f3b91b9100b1dad1c'
|
||||||
height: 561572,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'0f9b49cafeb9ae1d741cdb12137c92816aa8470944c270a78ba2e610bd59190d'
|
height: 561572,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'0f9b49cafeb9ae1d741cdb12137c92816aa8470944c270a78ba2e610bd59190d'
|
||||||
height: 561582,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f'
|
height: 561582,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'e4a0ac48ff3f42fc342717a2a3d34248e5e85bae79d59bd20e1b60e61b1c500f'
|
||||||
height: 562106,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb'
|
height: 562106,
|
||||||
},
|
tx_hash:
|
||||||
{
|
'1afcc63b244182647909539ebe3f4a44b8ea4120a95edb8d9eebe5347b9491bb'
|
||||||
height: 562106,
|
},
|
||||||
tx_hash:
|
{
|
||||||
'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a'
|
height: 562106,
|
||||||
|
tx_hash:
|
||||||
|
'c42f8f16d3baa2ee343ea89ef110dfe094992379d08edd30887b8ca7ee671c9a'
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -159,16 +163,25 @@ const mockTxDetails2 = {
|
|||||||
|
|
||||||
const mockFulcrumNoTxHistory = {
|
const mockFulcrumNoTxHistory = {
|
||||||
success: true,
|
success: true,
|
||||||
transactions: []
|
transactions: [
|
||||||
|
{
|
||||||
|
transactions: [],
|
||||||
|
address: 'bitcoincash:qrgqqkky28jdkv3w0ctrah0mz3jcsnsklc34gtukrh'
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
const mockFulcrumNoSendBalance = {
|
const mockFulcrumNoSendBalance = {
|
||||||
success: true,
|
success: true,
|
||||||
transactions: [
|
transactions: [
|
||||||
{
|
{
|
||||||
height: 633578,
|
transactions: [
|
||||||
tx_hash:
|
{
|
||||||
'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
|
height: 633578,
|
||||||
|
tx_hash:
|
||||||
|
'a3b62cd4f4c56ba52139179db14bffd4ab22a2e077f3c62bd5cf0541bfcaf023'
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -13,75 +13,70 @@ const mockAddress = {
|
|||||||
isscript: false
|
isscript: false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// const mockBalance = {
|
||||||
|
// page: 1,
|
||||||
|
// totalPages: 1,
|
||||||
|
// itemsOnPage: 1000,
|
||||||
|
// address: 'bitcoincash:qzp7gdl52edm24xlpkyqnza9rv43u3mdxyc77j3u6k',
|
||||||
|
// balance: '2546',
|
||||||
|
// totalReceived: '2546',
|
||||||
|
// totalSent: '0',
|
||||||
|
// unconfirmedBalance: '0',
|
||||||
|
// unconfirmedTxs: 0,
|
||||||
|
// txs: 2,
|
||||||
|
// txids: [
|
||||||
|
// 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||||
|
// '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6'
|
||||||
|
// ]
|
||||||
|
// }
|
||||||
|
|
||||||
const mockBalance = {
|
const mockBalance = {
|
||||||
page: 1,
|
confirmed: 2546,
|
||||||
totalPages: 1,
|
unconfirmed: 0
|
||||||
itemsOnPage: 1000,
|
|
||||||
address: 'bitcoincash:qzp7gdl52edm24xlpkyqnza9rv33u3mdxyc77j3u6k',
|
|
||||||
balance: '2546',
|
|
||||||
totalReceived: '2546',
|
|
||||||
totalSent: '0',
|
|
||||||
unconfirmedBalance: '0',
|
|
||||||
unconfirmedTxs: 0,
|
|
||||||
txs: 2,
|
|
||||||
txids: [
|
|
||||||
'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
|
||||||
'44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6'
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const mockUtxos = [
|
const mockUtxos = [
|
||||||
{
|
{
|
||||||
txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
tx_hash: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||||
vout: 0,
|
tx_pos: 0,
|
||||||
value: '2000',
|
value: 2000,
|
||||||
height: 605873,
|
height: 605873
|
||||||
confirmations: 298,
|
|
||||||
satoshis: 2000
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||||
vout: 1,
|
tx_pos: 1,
|
||||||
value: '546',
|
value: 546,
|
||||||
height: 605873,
|
height: 605873
|
||||||
confirmations: 298,
|
|
||||||
satoshis: 546
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
const mockThreeUtxos = [
|
const mockThreeUtxos = [
|
||||||
{
|
{
|
||||||
txid: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
tx_hash: 'e190d13b88578132608ab912a4d2be3e55aa2792d6042d481ae21d700639de56',
|
||||||
vout: 0,
|
tx_pos: 0,
|
||||||
value: '2000',
|
value: 2000,
|
||||||
height: 605873,
|
height: 605873
|
||||||
confirmations: 298,
|
|
||||||
satoshis: 2000
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||||
vout: 1,
|
tx_pos: 1,
|
||||||
value: '546',
|
value: 546,
|
||||||
height: 605873,
|
height: 605873
|
||||||
confirmations: 298,
|
|
||||||
satoshis: 546
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||||
vout: 1,
|
tx_pos: 1,
|
||||||
value: '546',
|
value: 546,
|
||||||
height: 605873,
|
height: 605873
|
||||||
confirmations: 298,
|
|
||||||
satoshis: 546
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
const mockIsTokenUtxos = [
|
const mockIsTokenUtxos = [
|
||||||
false,
|
false,
|
||||||
{
|
{
|
||||||
txid: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
tx_hash: '44e1f48c4093fc61db1a8fa206aa402fc34e482b3f788cb38c123ca0e1a35db6',
|
||||||
vout: 1,
|
tx_out: 1,
|
||||||
value: '546',
|
value: 546,
|
||||||
height: 605873,
|
height: 605873,
|
||||||
confirmations: 298,
|
confirmations: 298,
|
||||||
satoshis: 546,
|
satoshis: 546,
|
||||||
@@ -13,7 +13,7 @@ const chai = require('chai')
|
|||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
const Price = require('../../src/routes/v3/price')
|
const Price = require('../../src/routes/v4/price')
|
||||||
let uut
|
let uut
|
||||||
|
|
||||||
// Mocking data.
|
// Mocking data.
|
||||||
@@ -277,4 +277,70 @@ describe('#PriceRouter', () => {
|
|||||||
assert.isNumber(result.usd)
|
assert.isNumber(result.usd)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe('#getBCHUSD', () => {
|
||||||
|
// const getNetworkInfo = controlRoute.testableComponents.getNetworkInfo
|
||||||
|
|
||||||
|
it('should throw 500 when network issues', async () => {
|
||||||
|
uut.bchCoinexPriceUrl = 'http://fakeurl/api/'
|
||||||
|
|
||||||
|
await uut.getBCHUSD(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
res.statusCode,
|
||||||
|
499,
|
||||||
|
'HTTP status code 500 or greater expected.'
|
||||||
|
)
|
||||||
|
// console.log(res)
|
||||||
|
assert.include(
|
||||||
|
res.output.error,
|
||||||
|
'Network error: Could not communicate with full node or other external service'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
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.getBCHUSD(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.getBCHUSD(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 the USD price of BCH', async () => {
|
||||||
|
// Mock the RPC call for unit tests.
|
||||||
|
if (process.env.TEST === 'unit') {
|
||||||
|
sandbox
|
||||||
|
.stub(uut.axios, 'request')
|
||||||
|
.resolves({ data: mockData.mockCoinexFeed })
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getBCHUSD(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isNumber(result.usd)
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
@@ -0,0 +1,506 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for the route-ratelimit2.js middleware.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
// Public npm libraries.
|
||||||
|
const assert = require('chai').assert
|
||||||
|
const sinon = require('sinon')
|
||||||
|
const cloneDeep = require('lodash.clonedeep')
|
||||||
|
|
||||||
|
const config = require('../../config')
|
||||||
|
|
||||||
|
// Mocking data.
|
||||||
|
const { mockReq, mockRes, mockNext } = require('./mocks/express-mocks')
|
||||||
|
|
||||||
|
// Libraries under test
|
||||||
|
const RateLimits = require('../../src/middleware/route-ratelimit')
|
||||||
|
let uut = new RateLimits()
|
||||||
|
|
||||||
|
let req, res, next
|
||||||
|
|
||||||
|
describe('#rate-routelimit', () => {
|
||||||
|
let sandbox
|
||||||
|
|
||||||
|
before(async () => {
|
||||||
|
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 uut.wipeRedis()
|
||||||
|
})
|
||||||
|
|
||||||
|
// Setup the mocks before each test.
|
||||||
|
beforeEach(() => {
|
||||||
|
// Mock the req and res objects used by Express routes.
|
||||||
|
req = cloneDeep(mockReq)
|
||||||
|
res = cloneDeep(mockRes)
|
||||||
|
next = mockNext
|
||||||
|
|
||||||
|
// Explicitly reset the parmas and body.
|
||||||
|
req.params = {}
|
||||||
|
req.body = {}
|
||||||
|
req.query = {}
|
||||||
|
req.locals = {}
|
||||||
|
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
|
||||||
|
uut = new RateLimits()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
after(() => {
|
||||||
|
uut.closeRedis()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#checkInternalIp', () => {
|
||||||
|
it('should return true for a request from localhost', () => {
|
||||||
|
req.ip = '::ffff:127.0.0.1'
|
||||||
|
|
||||||
|
const result = uut.checkInternalIp(req)
|
||||||
|
|
||||||
|
assert.equal(result, true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return true for a request from a Docker container', () => {
|
||||||
|
req.ip = '172.17.0.3'
|
||||||
|
|
||||||
|
const result = uut.checkInternalIp(req)
|
||||||
|
|
||||||
|
assert.equal(result, true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return false for a random ip address', () => {
|
||||||
|
req.ip = '123.456.7.8'
|
||||||
|
|
||||||
|
const result = uut.checkInternalIp(req)
|
||||||
|
|
||||||
|
assert.equal(result, false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return false when an error is encountered', () => {
|
||||||
|
req.ip = 4
|
||||||
|
|
||||||
|
const result = uut.checkInternalIp(req)
|
||||||
|
|
||||||
|
assert.equal(result, false)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#isInWhitelist', () => {
|
||||||
|
it('should return false when no argument is passed in', () => {
|
||||||
|
const result = uut.isInWhitelist()
|
||||||
|
|
||||||
|
assert.equal(result, false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return false when origin is not in the whitelist', () => {
|
||||||
|
req.origin = 'blah.com'
|
||||||
|
req.get = sandbox.stub().returns(req.origin)
|
||||||
|
|
||||||
|
const result = uut.isInWhitelist(req)
|
||||||
|
|
||||||
|
assert.equal(result, false)
|
||||||
|
|
||||||
|
// Used to appease linter. Remove these.
|
||||||
|
res.blah = 4
|
||||||
|
next()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return true when origin is in the whitelist', () => {
|
||||||
|
req.origin = 'message.fullstack.cash'
|
||||||
|
req.get = sandbox.stub().returns(req.origin)
|
||||||
|
|
||||||
|
const result = uut.isInWhitelist(req)
|
||||||
|
|
||||||
|
assert.equal(result, true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeJwtToken', () => {
|
||||||
|
it('should return the default JWT payload if decoding fails', () => {
|
||||||
|
const jwt =
|
||||||
|
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYxNTE1NzA4NywiZXhwIjoxNjE3NzQ5MDg3fQ.RLNGuYAa-CcLdhTGD27tDeaxT6-GIdeR8T4JWZZLDZA'
|
||||||
|
|
||||||
|
const result = uut.decodeJwtToken(jwt)
|
||||||
|
// console.log('result: ', result)
|
||||||
|
|
||||||
|
assert.property(result, 'id')
|
||||||
|
// assert.equal(result.id, '123.456.789.10')
|
||||||
|
assert.property(result, 'email')
|
||||||
|
// assert.equal(result.email, 'test@bchtest.net')
|
||||||
|
// assert.property(result, 'pointsToConsume')
|
||||||
|
// assert.equal(result.pointsToConsume, config.anonRateLimit)
|
||||||
|
// assert.property(result, 'duration')
|
||||||
|
// assert.equal(result.duration, 30)
|
||||||
|
assert.property(result, 'exp')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return the default JWT payload if no input is given', () => {
|
||||||
|
const result = uut.decodeJwtToken()
|
||||||
|
// console.log('result: ', result)
|
||||||
|
|
||||||
|
assert.property(result, 'id')
|
||||||
|
assert.equal(result.id, '123.456.789.10')
|
||||||
|
assert.property(result, 'email')
|
||||||
|
assert.equal(result.email, 'test@bchtest.net')
|
||||||
|
assert.property(result, 'pointsToConsume')
|
||||||
|
assert.equal(result.pointsToConsume, config.anonRateLimit)
|
||||||
|
assert.property(result, 'duration')
|
||||||
|
assert.equal(result.duration, 30)
|
||||||
|
assert.property(result, 'exp')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should correctly decode a JWT token', () => {
|
||||||
|
// Generate a new JWT token for the test.
|
||||||
|
const jwtPayload = {
|
||||||
|
id: '5dade3f5739e6c0ff034b9a1',
|
||||||
|
pointsToConsume: 10,
|
||||||
|
email: 'gooduser@test.com',
|
||||||
|
apiLevel: 40,
|
||||||
|
rateLimit: 100,
|
||||||
|
duration: 30
|
||||||
|
}
|
||||||
|
const jwtToken = uut.generateJwtToken(jwtPayload)
|
||||||
|
|
||||||
|
const result = uut.decodeJwtToken(jwtToken)
|
||||||
|
// console.log('result: ', result)
|
||||||
|
|
||||||
|
assert.property(result, 'id')
|
||||||
|
assert.equal(result.id, jwtPayload.id)
|
||||||
|
assert.property(result, 'email')
|
||||||
|
assert.equal(result.email, jwtPayload.email)
|
||||||
|
assert.property(result, 'pointsToConsume')
|
||||||
|
assert.equal(result.pointsToConsume, jwtPayload.pointsToConsume)
|
||||||
|
assert.property(result, 'duration')
|
||||||
|
assert.equal(result.duration, jwtPayload.duration)
|
||||||
|
assert.property(result, 'exp')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return the default payload if there is an unhandled error', () => {
|
||||||
|
// Force an error.
|
||||||
|
sandbox.stub(uut, 'generateJwtToken').throws(new Error('test error'))
|
||||||
|
|
||||||
|
const result = uut.decodeJwtToken()
|
||||||
|
// console.log('result: ', result)
|
||||||
|
|
||||||
|
assert.property(result, 'id')
|
||||||
|
assert.equal(result.id, '123.456.789.10')
|
||||||
|
assert.property(result, 'email')
|
||||||
|
assert.equal(result.email, 'test@bchtest.net')
|
||||||
|
assert.property(result, 'pointsToConsume')
|
||||||
|
assert.equal(result.pointsToConsume, config.anonRateLimit)
|
||||||
|
assert.property(result, 'duration')
|
||||||
|
assert.equal(result.duration, 30)
|
||||||
|
assert.property(result, 'exp')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#trackRateLimits', () => {
|
||||||
|
it('should apply anonymous rate limits if no JWT token is provided', async () => {
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
|
||||||
|
const result = await uut.trackRateLimits(req, res)
|
||||||
|
// console.log(`result: `, result)
|
||||||
|
|
||||||
|
// console.log('res.locals.pointsToConsume: ', res.locals.pointsToConsume)
|
||||||
|
|
||||||
|
assert.equal(result, false, 'Rate limits not exceeded')
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
config.anonRateLimit,
|
||||||
|
'Anonymous rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply 100 RPM rate limits when JWT token is provided', async () => {
|
||||||
|
// Generate a new JWT token for the test.
|
||||||
|
const jwtPayload = {
|
||||||
|
id: '5dade3f5739e6c0ff034b9a1',
|
||||||
|
pointsToConsume: 10
|
||||||
|
}
|
||||||
|
const jwtToken = uut.generateJwtToken(jwtPayload)
|
||||||
|
|
||||||
|
const result = await uut.trackRateLimits(req, res, jwtToken)
|
||||||
|
// console.log(`result: `, result)
|
||||||
|
|
||||||
|
// console.log('res.locals.pointsToConsume: ', res.locals.pointsToConsume)
|
||||||
|
|
||||||
|
assert.equal(result, false, 'Rate limits not exceeded')
|
||||||
|
assert.equal(res.locals.pointsToConsume, 10, '100 RPM limits applied')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#applyRateLimits', () => {
|
||||||
|
it('should skip rate limits if basic auth token is used', async () => {
|
||||||
|
req.locals.proLimit = true
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should skip rate limits if internal call passes basic auth token', async () => {
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
req.body.usrObj = {
|
||||||
|
proLimit: true
|
||||||
|
}
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply rate limits to anonymous users', async () => {
|
||||||
|
req.ip = '123.456.7.8'
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
config.anonRateLimit,
|
||||||
|
'Anonymous rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 429 error when anonymous users exceed rate limit', async () => {
|
||||||
|
req.ip = '123.456.7.8'
|
||||||
|
|
||||||
|
// force req.locals.jwtToken to be empty.
|
||||||
|
req.locals.jwtToken = undefined
|
||||||
|
|
||||||
|
let val
|
||||||
|
for (let i = 0; i < 25; i++) {
|
||||||
|
// console.log('req.locals: ', req.locals)
|
||||||
|
val = await uut.applyRateLimits(req, res, next)
|
||||||
|
}
|
||||||
|
// console.log('val: ', val)
|
||||||
|
|
||||||
|
assert.property(val, 'error')
|
||||||
|
assert.include(
|
||||||
|
val.error,
|
||||||
|
'Too many requests. Your limits are currently 20 requests per minute.'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(res.locals.rateLimitTriggered, true, 'Rate limits triggered')
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
config.anonRateLimit,
|
||||||
|
'Anonymous rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply rate limits when JWT token is provided', async () => {
|
||||||
|
// Generate a new JWT token for the test.
|
||||||
|
const jwtPayload = {
|
||||||
|
id: '5dade3f5739e6c0ff034b9a1',
|
||||||
|
pointsToConsume: 10
|
||||||
|
}
|
||||||
|
const jwtToken = uut.generateJwtToken(jwtPayload)
|
||||||
|
|
||||||
|
req.ip = '123.456.7.8'
|
||||||
|
req.locals.jwtToken = jwtToken
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
10,
|
||||||
|
'Anonymous rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply internal rate limits to internal calls', async () => {
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
10,
|
||||||
|
'Internal rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 429 error when internal calls exceed interal rate limit', async () => {
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
|
||||||
|
let val
|
||||||
|
for (let i = 0; i < 1025; i++) {
|
||||||
|
val = await uut.applyRateLimits(req, res, next)
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.property(val, 'error')
|
||||||
|
assert.include(
|
||||||
|
val.error,
|
||||||
|
'Too many requests. Your limits are currently 1000 requests per minute.'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(res.locals.rateLimitTriggered, true, 'Rate limits triggered')
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
10,
|
||||||
|
'Internal rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply JWT rate limits to internal calls when JWT passes through', async () => {
|
||||||
|
// Generate a new JWT token for the test.
|
||||||
|
const jwtPayload = {
|
||||||
|
id: '5dade3f5739e6c0ff034b9a1',
|
||||||
|
pointsToConsume: 10
|
||||||
|
}
|
||||||
|
const jwtToken = uut.generateJwtToken(jwtPayload)
|
||||||
|
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
req.body.usrObj = {
|
||||||
|
jwtToken
|
||||||
|
}
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
10,
|
||||||
|
'User JWT rate limits applied'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 429 error when internal calls using JWT pass-through exceeds rate limit', async () => {
|
||||||
|
// Generate a new JWT token for the test.
|
||||||
|
const jwtPayload = {
|
||||||
|
id: '5dade3f5739e6c0ff034b9a1',
|
||||||
|
pointsToConsume: 100
|
||||||
|
}
|
||||||
|
const jwtToken = uut.generateJwtToken(jwtPayload)
|
||||||
|
|
||||||
|
req.ip = '127.0.0.1'
|
||||||
|
req.body.usrObj = {
|
||||||
|
jwtToken
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
let val
|
||||||
|
for (let i = 0; i < 120; i++) {
|
||||||
|
val = await uut.applyRateLimits(req, res, next)
|
||||||
|
}
|
||||||
|
// console.log('val: ', val)
|
||||||
|
|
||||||
|
assert.property(val, 'error')
|
||||||
|
assert.include(
|
||||||
|
val.error,
|
||||||
|
'Too many requests. Your limits are currently 100 requests per minute.'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
res.locals.pointsToConsume,
|
||||||
|
100,
|
||||||
|
'User JWT rate limits applied'
|
||||||
|
)
|
||||||
|
} catch (err) {
|
||||||
|
console.log('err: ', err)
|
||||||
|
assert.fail('Unexpected result')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should move to the next middleware when encountering an unexpected internal error', async () => {
|
||||||
|
// Force the creation of the res and req locals property. Covers an
|
||||||
|
// otherwise untested code path.
|
||||||
|
req.locals = undefined
|
||||||
|
res.locals = undefined
|
||||||
|
|
||||||
|
// Force an error
|
||||||
|
sandbox.stub(uut, 'checkInternalIp').throws(new Error('test error'))
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const startCallCount = next.callCount
|
||||||
|
|
||||||
|
await uut.applyRateLimits(req, res, next)
|
||||||
|
|
||||||
|
// console.log('next.callCount: ', next.callCount)
|
||||||
|
const endCallCount = next.callCount
|
||||||
|
|
||||||
|
assert.isAbove(
|
||||||
|
endCallCount,
|
||||||
|
startCallCount,
|
||||||
|
'Expecting next() to be called'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -14,7 +14,7 @@
|
|||||||
|
|
||||||
const chai = require('chai')
|
const chai = require('chai')
|
||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const Rawtransactions = require('../../src/routes/v3/full-node/rawtransactions')
|
const Rawtransactions = require('../../src/routes/v4/full-node/rawtransactions')
|
||||||
const uut = new Rawtransactions()
|
const uut = new Rawtransactions()
|
||||||
|
|
||||||
// const nock = require('nock') // HTTP mocking
|
// const nock = require('nock') // HTTP mocking
|
||||||
@@ -250,6 +250,7 @@ describe('#Raw-Transactions', () => {
|
|||||||
'Proper error message'
|
'Proper error message'
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('returns proper error when downstream service stalls', async () => {
|
it('returns proper error when downstream service stalls', async () => {
|
||||||
req.body.hexes = [
|
req.body.hexes = [
|
||||||
'0200000001b9b598d7d6d72fc486b2b3a3c03c79b5bade6ec9a77ced850515ab5e64edcc21010000006b483045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413dffffffff0210270000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac786e9800000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000'
|
'0200000001b9b598d7d6d72fc486b2b3a3c03c79b5bade6ec9a77ced850515ab5e64edcc21010000006b483045022100a7b1b08956abb8d6f322aa709d8583c8ea492ba0585f1a6f4f9983520af74a5a0220411aee4a9a54effab617b0508c504c31681b15f9b187179b4874257badd4139041210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413dffffffff0210270000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac786e9800000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000'
|
||||||
@@ -1046,10 +1047,12 @@ describe('#Raw-Transactions', () => {
|
|||||||
// Save the existing RPC URL.
|
// Save the existing RPC URL.
|
||||||
const savedUrl = process.env.BITCOINCOM_BASEURL
|
const savedUrl = process.env.BITCOINCOM_BASEURL
|
||||||
const savedUrl2 = process.env.RPC_BASEURL
|
const savedUrl2 = process.env.RPC_BASEURL
|
||||||
|
const savedUrl3 = process.env.RPC_SENDURL
|
||||||
|
|
||||||
// Manipulate the URL to cause a 500 network error.
|
// Manipulate the URL to cause a 500 network error.
|
||||||
process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
|
process.env.BITCOINCOM_BASEURL = 'http://fakeurl/api/'
|
||||||
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
process.env.RPC_BASEURL = 'http://fakeurl/api/'
|
||||||
|
process.env.RPC_SENDURL = 'http://fakeurl/api/'
|
||||||
|
|
||||||
req.params.hex =
|
req.params.hex =
|
||||||
'020000000136697692fed77bc4f5b6885295d0c56d1d0280fb578f445ce42be4eb6db381f2010000006a4730440220473adba0e7da14f0abf4817bbd591741ecb8da6544b998f10341f6704f5f05280220405221c626cb7edcf333367ebd469aff3f5a2169e37ee58eebb811ffc2fbc9e0412102202ff86325c5d903171fa5a2895c4efb3765105115460dc96f113048ddb69b47feffffff027a621b00000000001976a914e0a8ffc3b91e35f46618d6db90f66397989abf0588ac38041300000000001976a914a741f282af390bc7ea8c4375a3a56401d668564288ac2c330900'
|
'020000000136697692fed77bc4f5b6885295d0c56d1d0280fb578f445ce42be4eb6db381f2010000006a4730440220473adba0e7da14f0abf4817bbd591741ecb8da6544b998f10341f6704f5f05280220405221c626cb7edcf333367ebd469aff3f5a2169e37ee58eebb811ffc2fbc9e0412102202ff86325c5d903171fa5a2895c4efb3765105115460dc96f113048ddb69b47feffffff027a621b00000000001976a914e0a8ffc3b91e35f46618d6db90f66397989abf0588ac38041300000000001976a914a741f282af390bc7ea8c4375a3a56401d668564288ac2c330900'
|
||||||
@@ -1059,6 +1062,7 @@ describe('#Raw-Transactions', () => {
|
|||||||
// Restore the saved URL.
|
// Restore the saved URL.
|
||||||
process.env.BITCOINCOM_BASEURL = savedUrl
|
process.env.BITCOINCOM_BASEURL = savedUrl
|
||||||
process.env.RPC_BASEURL = savedUrl2
|
process.env.RPC_BASEURL = savedUrl2
|
||||||
|
process.env.RPC_SENDURL = savedUrl3
|
||||||
|
|
||||||
assert.isAbove(
|
assert.isAbove(
|
||||||
res.statusCode,
|
res.statusCode,
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for the route-utils.js library.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const assert = require('chai').assert
|
||||||
|
|
||||||
|
const RouteUtils = require('../../src/util/route-utils.js')
|
||||||
|
|
||||||
|
describe('#route-utils', () => {
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
uut = new RouteUtils()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeError', () => {
|
||||||
|
it('should decode a 429 error from nginx', () => {
|
||||||
|
const err = {
|
||||||
|
error: '<html>\r\n<head><title>429 Too Many Requests</title></head>\r\n<body>\r\n<center><h1>429 Too Many Requests</h1></center>\r\n<hr><center>nginx/1.18.0 (Ubuntu)</center>\r\n</body>\r\n</html>\r\n',
|
||||||
|
level: 'error',
|
||||||
|
message: 'Error in slp.js/hydrateUtxos().',
|
||||||
|
timestamp: '2021-03-31T04:13:36.662Z'
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = uut.decodeError(err)
|
||||||
|
// console.log('result: ', result)
|
||||||
|
|
||||||
|
assert.property(result, 'msg')
|
||||||
|
assert.equal(result.msg, '429 Too Many Requests')
|
||||||
|
assert.property(result, 'status')
|
||||||
|
assert.equal(result.status, 429)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
+945
-52
File diff suppressed because it is too large
Load Diff
@@ -4,16 +4,24 @@
|
|||||||
This test file uses the environment variable TEST to switch between unit
|
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
|
and integration tests. By default, TEST is set to 'unit'. Set this variable
|
||||||
to 'integration' to run the tests against BCH mainnet.
|
to 'integration' to run the tests against BCH mainnet.
|
||||||
|
|
||||||
|
These tests use this private key:
|
||||||
|
L1wAGEN721LHDoiN8pLwwBb87bYrU6Gs21UPcCRR7LjKypQyVaCq
|
||||||
|
Which corresponds to this address:
|
||||||
|
bitcoincash:qp2g4cnekxsjspccmtvh5k73mczz6273js4mjr353r
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const chai = require('chai')
|
// Public npm libraries
|
||||||
const assert = chai.assert
|
const assert = require('chai').assert
|
||||||
const utilRoute = require('../../src/routes/v3/util')
|
|
||||||
const nock = require('nock') // HTTP mocking
|
const nock = require('nock') // HTTP mocking
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
|
// Local libraries
|
||||||
|
const Electrumx = require('../../src/routes/v4/electrumx')
|
||||||
|
const UtilRoute = require('../../src/routes/v4/util')
|
||||||
|
|
||||||
let originalEnvVars // Used during transition from integration to unit tests.
|
let originalEnvVars // Used during transition from integration to unit tests.
|
||||||
|
|
||||||
// Mocking data.
|
// Mocking data.
|
||||||
@@ -24,13 +32,16 @@ const util = require('util')
|
|||||||
util.inspect.defaultOptions = { depth: 1 }
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
// const UtilRoute = utilRoute.UtilRoute
|
// const UtilRoute = utilRoute.UtilRoute
|
||||||
const utilRouteInst = new utilRoute.UtilRoute()
|
// const electrumx = new Electrumx()
|
||||||
|
const utilRouteInst = new UtilRoute({ electrumx: {} })
|
||||||
|
|
||||||
describe('#Util', () => {
|
describe('#Util', () => {
|
||||||
let req, res
|
let req, res
|
||||||
let sandbox
|
let sandbox
|
||||||
|
let electrumx
|
||||||
|
let utilRoute
|
||||||
|
|
||||||
before(() => {
|
before(async () => {
|
||||||
// Save existing environment variables.
|
// Save existing environment variables.
|
||||||
originalEnvVars = {
|
originalEnvVars = {
|
||||||
BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
BITCOINCOM_BASEURL: process.env.BITCOINCOM_BASEURL,
|
||||||
@@ -47,6 +58,9 @@ describe('#Util', () => {
|
|||||||
process.env.RPC_USERNAME = 'fakeusername'
|
process.env.RPC_USERNAME = 'fakeusername'
|
||||||
process.env.RPC_PASSWORD = 'fakepassword'
|
process.env.RPC_PASSWORD = 'fakepassword'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
electrumx = new Electrumx()
|
||||||
|
// await electrumx.connect()
|
||||||
})
|
})
|
||||||
|
|
||||||
// Setup the mocks before each test.
|
// Setup the mocks before each test.
|
||||||
@@ -64,6 +78,8 @@ describe('#Util', () => {
|
|||||||
if (!nock.isActive()) nock.activate()
|
if (!nock.isActive()) nock.activate()
|
||||||
|
|
||||||
sandbox = sinon.createSandbox()
|
sandbox = sinon.createSandbox()
|
||||||
|
|
||||||
|
utilRoute = new UtilRoute({ electrumx })
|
||||||
})
|
})
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
@@ -357,29 +373,29 @@ describe('#Util', () => {
|
|||||||
// Mock the RPC call for unit tests.
|
// Mock the RPC call for unit tests.
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
.stub(utilRoute.electrumx, '_balanceFromElectrumx')
|
||||||
.resolves(mockData.mockBalance)
|
.resolves(mockData.mockBalance)
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
.stub(utilRoute.electrumx, '_utxosFromElectrumx')
|
||||||
.resolves(mockData.mockUtxos)
|
.resolves(mockData.mockUtxos)
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
.stub(utilRoute.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||||
.resolves(mockData.mockIsTokenUtxos)
|
.resolves(mockData.mockIsTokenUtxos)
|
||||||
|
|
||||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||||
// to the network.
|
// to the network.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
.stub(utilRoute.bchjs.RawTransactions, 'sendRawTransaction')
|
||||||
.resolves('test-txid')
|
.resolves('test-txid')
|
||||||
|
|
||||||
req.body = {
|
req.body = {
|
||||||
wif: 'L5GEFg1tETLWBugmhSo9Zc4ms968qVmfmTroDxsJ982AiudAQGyt',
|
wif: 'L1wAGEN721LHDoiN8pLwwBb87bYrU6Gs21UPcCRR7LjKypQyVaCq',
|
||||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
toAddr: 'bitcoincash:qp2g4cnekxsjspccmtvh5k73mczz6273js4mjr353r'
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await utilRouteInst.sweepWif(req, res)
|
const result = await utilRoute.sweepWif(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.equal(result, 'test-txid')
|
assert.equal(result, 'test-txid')
|
||||||
@@ -389,13 +405,13 @@ describe('#Util', () => {
|
|||||||
// Mock the RPC call for unit tests.
|
// Mock the RPC call for unit tests.
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
.stub(utilRoute.electrumx, '_balanceFromElectrumx')
|
||||||
.resolves(mockData.mockBalance)
|
.resolves(mockData.mockBalance)
|
||||||
|
|
||||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||||
// to the network.
|
// to the network.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
.stub(utilRoute.bchjs.RawTransactions, 'sendRawTransaction')
|
||||||
.resolves('test-txid')
|
.resolves('test-txid')
|
||||||
|
|
||||||
req.body = {
|
req.body = {
|
||||||
@@ -403,33 +419,30 @@ describe('#Util', () => {
|
|||||||
balanceOnly: true
|
balanceOnly: true
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await utilRouteInst.sweepWif(req, res)
|
const result = await utilRoute.sweepWif(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.isNumber(result)
|
assert.isNumber(result)
|
||||||
})
|
})
|
||||||
}
|
|
||||||
|
|
||||||
// Unit tests only
|
|
||||||
if (process.env.TEST === 'unit') {
|
|
||||||
it('should generate transaction for valid BCH-only sweep', async () => {
|
it('should generate transaction for valid BCH-only sweep', async () => {
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
.stub(utilRoute.electrumx, '_balanceFromElectrumx')
|
||||||
.resolves(mockData.mockBalance)
|
.resolves(mockData.mockBalance)
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
.stub(utilRoute.electrumx, '_utxosFromElectrumx')
|
||||||
.resolves(mockData.mockUtxos)
|
.resolves(mockData.mockUtxos)
|
||||||
|
|
||||||
// Force token utxo to appear as regular BCH utxo.
|
// Force token utxo to appear as regular BCH utxo.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
.stub(utilRoute.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||||
.resolves([false, false])
|
.resolves([false, false])
|
||||||
|
|
||||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||||
// to the network.
|
// to the network.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
.stub(utilRoute.bchjs.RawTransactions, 'sendRawTransaction')
|
||||||
.resolves('test-txid')
|
.resolves('test-txid')
|
||||||
|
|
||||||
req.body = {
|
req.body = {
|
||||||
@@ -437,7 +450,7 @@ describe('#Util', () => {
|
|||||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await utilRouteInst.sweepWif(req, res)
|
const result = await utilRoute.sweepWif(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.equal(result, 'test-txid')
|
assert.equal(result, 'test-txid')
|
||||||
@@ -445,22 +458,22 @@ describe('#Util', () => {
|
|||||||
|
|
||||||
it('should throw 422 error if no non-token UTXOs', async () => {
|
it('should throw 422 error if no non-token UTXOs', async () => {
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
.stub(utilRoute.electrumx, '_balanceFromElectrumx')
|
||||||
.resolves(mockData.mockBalance)
|
.resolves(mockData.mockBalance)
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
.stub(utilRoute.electrumx, '_utxosFromElectrumx')
|
||||||
.resolves(mockData.mockUtxos)
|
.resolves(mockData.mockUtxos)
|
||||||
|
|
||||||
// Force token utxo to appear as regular BCH utxo.
|
// Force token utxo to appear as regular BCH utxo.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
.stub(utilRoute.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||||
.resolves(mockData.tokensOnly)
|
.resolves(mockData.tokensOnly)
|
||||||
|
|
||||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||||
// to the network.
|
// to the network.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
.stub(utilRoute.bchjs.RawTransactions, 'sendRawTransaction')
|
||||||
.resolves('test-txid')
|
.resolves('test-txid')
|
||||||
|
|
||||||
req.body = {
|
req.body = {
|
||||||
@@ -468,7 +481,7 @@ describe('#Util', () => {
|
|||||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await utilRouteInst.sweepWif(req, res)
|
const result = await utilRoute.sweepWif(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 422)
|
assert.equal(res.statusCode, 422)
|
||||||
@@ -481,22 +494,22 @@ describe('#Util', () => {
|
|||||||
|
|
||||||
it('should detect and throw error for multiple token classes', async () => {
|
it('should detect and throw error for multiple token classes', async () => {
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'balanceFromBlockbook')
|
.stub(utilRoute.electrumx, '_balanceFromElectrumx')
|
||||||
.resolves(mockData.mockBalance)
|
.resolves(mockData.mockBalance)
|
||||||
|
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.blockbook, 'utxosFromBlockbook')
|
.stub(utilRoute.electrumx, '_utxosFromElectrumx')
|
||||||
.resolves(mockData.mockThreeUtxos)
|
.resolves(mockData.mockThreeUtxos)
|
||||||
|
|
||||||
// Force token utxo to appear as regular BCH utxo.
|
// Force token utxo to appear as regular BCH utxo.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
.stub(utilRoute.bchjs.SLP.Utils, 'tokenUtxoDetails')
|
||||||
.resolves(mockData.multipleTokens)
|
.resolves(mockData.multipleTokens)
|
||||||
|
|
||||||
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
// Mock sendRawTransaction() so that the hex does not actually get broadcast
|
||||||
// to the network.
|
// to the network.
|
||||||
sandbox
|
sandbox
|
||||||
.stub(utilRouteInst.bchjs.RawTransactions, 'sendRawTransaction')
|
.stub(utilRoute.bchjs.RawTransactions, 'sendRawTransaction')
|
||||||
.resolves('test-txid')
|
.resolves('test-txid')
|
||||||
|
|
||||||
req.body = {
|
req.body = {
|
||||||
@@ -504,7 +517,7 @@ describe('#Util', () => {
|
|||||||
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
toAddr: 'bitcoincash:qz2qn6zt4qmacf4r6c0e2pdcqsgnkxaa3ql2xpee6p'
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await utilRouteInst.sweepWif(req, res)
|
const result = await utilRoute.sweepWif(req, res)
|
||||||
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
assert.equal(res.statusCode, 422)
|
assert.equal(res.statusCode, 422)
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
const chai = require('chai')
|
const chai = require('chai')
|
||||||
const assert = chai.assert
|
const assert = chai.assert
|
||||||
const xpubRoute = require('../../src/routes/v3/xpub')
|
const xpubRoute = require('../../src/routes/v4/xpub')
|
||||||
const nock = require('nock') // HTTP mocking
|
const nock = require('nock') // HTTP mocking
|
||||||
|
|
||||||
// let originalUrl // Used during transition from integration to unit tests.
|
// let originalUrl // Used during transition from integration to unit tests.
|
||||||
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/v5/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/v5/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.bchjs.Electrumx, 'transactions')
|
||||||
|
.resolves(mockData.mockFulcrumTxHistory)
|
||||||
|
sandbox
|
||||||
|
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
||||||
|
.resolves([mockData.mockTxDetails2])
|
||||||
|
}
|
||||||
|
|
||||||
|
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.bchjs.Electrumx, 'transactions')
|
||||||
|
.resolves(mockData.mockFulcrumNoTxHistory)
|
||||||
|
}
|
||||||
|
|
||||||
|
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.bchjs.Electrumx, 'transactions')
|
||||||
|
.resolves(mockData.mockFulcrumNoSendBalance)
|
||||||
|
sandbox
|
||||||
|
.stub(encryptionRoute.bchjs.RawTransactions, 'getRawTransaction')
|
||||||
|
.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,114 @@
|
|||||||
|
/*
|
||||||
|
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 SLP = require('../../../src/routes/v4/slp')
|
||||||
|
const slp = new SLP()
|
||||||
|
|
||||||
|
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||||
|
|
||||||
|
describe('#nft', () => {
|
||||||
|
let req, res
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
// Mock the req and res objects used by Express routes.
|
||||||
|
req = mockReq
|
||||||
|
res = mockRes
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNftChildren', () => {
|
||||||
|
it('should return error on non-existing NFT group token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0b'
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT group does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should return error on non-group NFT token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT group does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should get NFT children list', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
|
||||||
|
|
||||||
|
const result = await slp.getNftChildren(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isArray(result.nftChildren)
|
||||||
|
assert.equal(result.nftChildren.length, 2)
|
||||||
|
assert.equal(
|
||||||
|
result.nftChildren[0],
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
)
|
||||||
|
assert.equal(
|
||||||
|
result.nftChildren[1],
|
||||||
|
'928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNftGroup', () => {
|
||||||
|
it('should return error on non-existing NFT child token', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a8'
|
||||||
|
const result = await slp.getNftGroup(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.include(
|
||||||
|
result.error,
|
||||||
|
'NFT child does not exists',
|
||||||
|
'Error message expected'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
it('should get NFT group token info', async () => {
|
||||||
|
req.params.tokenId =
|
||||||
|
'45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
|
||||||
|
// req.params.tokenId = '928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
|
||||||
|
const result = await slp.getNftGroup(req, res)
|
||||||
|
// console.log(`result: ${util.inspect(result)}`)
|
||||||
|
assert.property(result, 'nftGroup')
|
||||||
|
assert.property(result.nftGroup, 'id')
|
||||||
|
assert.property(result.nftGroup, 'versionType')
|
||||||
|
assert.property(result.nftGroup, 'symbol')
|
||||||
|
assert.equal(
|
||||||
|
result.nftGroup.id,
|
||||||
|
'68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
|
||||||
|
)
|
||||||
|
assert.equal(result.nftGroup.versionType, 129)
|
||||||
|
assert.equal(result.nftGroup.symbol, 'PSF.TEST.GROUP')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
/*
|
||||||
|
Integration tests for the price library.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
const assert = require('chai').assert
|
||||||
|
// const axios = require('axios')
|
||||||
|
|
||||||
|
// Used for debugging.
|
||||||
|
const util = require('util')
|
||||||
|
util.inspect.defaultOptions = { depth: 1 }
|
||||||
|
|
||||||
|
const Price = require('../../../src/routes/v4/price')
|
||||||
|
const price = new Price()
|
||||||
|
|
||||||
|
const { mockReq, mockRes } = require('../mocks/express-mocks')
|
||||||
|
|
||||||
|
describe('#price', () => {
|
||||||
|
let req, res
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
// Mock the req and res objects used by Express routes.
|
||||||
|
req = mockReq
|
||||||
|
res = mockRes
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getUSD', () => {
|
||||||
|
it('should get the USD price', async () => {
|
||||||
|
const result = await price.getUSD(req, res)
|
||||||
|
console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isNumber(result.usd)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBCHAUSD', () => {
|
||||||
|
it('should get the USD price of BCHA', async () => {
|
||||||
|
const result = await price.getBCHAUSD(req, res)
|
||||||
|
console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isNumber(result.usd)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
describe('#getBCHUSD', () => {
|
||||||
|
it('should get the USD price of BCH', async () => {
|
||||||
|
const result = await price.getBCHUSD(req, res)
|
||||||
|
console.log(`result: ${util.inspect(result)}`)
|
||||||
|
|
||||||
|
assert.isNumber(result.usd)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
/*
|
||||||
|
These tests have been deprecated. To test bch-api rate limits, run the e2e
|
||||||
|
tests in the bch-js repository.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'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/v4/`
|
||||||
|
const SERVER = 'http://localhost:3000/v4/'
|
||||||
|
// const SERVER = 'https://api.fullstack.cash/v4/'
|
||||||
|
//
|
||||||
|
// const TEST_JWT =
|
||||||
|
// 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2JmMDIyMWMxMDAxMmFkOTNmZiIsImVtYWlsIjoiY2hyaXMudHJvdXRuZXJAZ21haWwuY29tIiwiYXBpTGV2ZWwiOjQwLCJyYXRlTGltaXQiOjMsImlhdCI6MTYwMDYyODk1MSwiZXhwIjoxNjAzMjIwOTUxfQ.JPXDJQsxJFtCGZjHOd-hRfJuY41Ef_FQ4ET06CtYdNk'
|
||||||
|
|
||||||
|
describe('#JWT 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 20 request per minute', async () => {
|
||||||
|
try {
|
||||||
|
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.fail('Unexpected result!')
|
||||||
|
} catch (err) {
|
||||||
|
console.log('err: ', err)
|
||||||
|
|
||||||
|
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,193 @@
|
|||||||
|
/*
|
||||||
|
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.
|
||||||
|
- Replace request-promise with axios.
|
||||||
|
*/
|
||||||
|
|
||||||
|
'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,461 @@
|
|||||||
|
/*
|
||||||
|
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/v4/slp')
|
||||||
|
const slp = new SLP()
|
||||||
|
|
||||||
|
const BCHJS = require('@psf/bch-js')
|
||||||
|
const bchjs = new BCHJS()
|
||||||
|
|
||||||
|
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:
|
||||||
|
'38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0',
|
||||||
|
decimals: 8,
|
||||||
|
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)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#hydrateUtxos', () => {
|
||||||
|
it('should return utxo details', async () => {
|
||||||
|
const utxos = [
|
||||||
|
{
|
||||||
|
utxos: [
|
||||||
|
{
|
||||||
|
txid:
|
||||||
|
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||||
|
vout: 3,
|
||||||
|
value: '6816',
|
||||||
|
height: 606848,
|
||||||
|
confirmations: 13,
|
||||||
|
satoshis: 6816
|
||||||
|
},
|
||||||
|
{
|
||||||
|
txid:
|
||||||
|
'd56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56',
|
||||||
|
vout: 2,
|
||||||
|
value: '546',
|
||||||
|
height: 606848,
|
||||||
|
confirmations: 13,
|
||||||
|
satoshis: 546
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.utxos = utxos
|
||||||
|
const result = await slp.hydrateUtxos(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// Test the general structure of the output.
|
||||||
|
assert.isArray(result.slpUtxos)
|
||||||
|
assert.equal(result.slpUtxos.length, 1)
|
||||||
|
assert.equal(result.slpUtxos[0].utxos.length, 2)
|
||||||
|
|
||||||
|
// Test the non-slp UTXO.
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'txid')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'vout')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'value')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'height')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'confirmations')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'satoshis')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'isValid')
|
||||||
|
assert.equal(result.slpUtxos[0].utxos[0].isValid, false)
|
||||||
|
|
||||||
|
// Test the slp UTXO.
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'txid')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'vout')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'value')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'height')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'confirmations')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'satoshis')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'isValid')
|
||||||
|
assert.equal(result.slpUtxos[0].utxos[1].isValid, true)
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'transactionType')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenId')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenTicker')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenName')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentUrl')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenDocumentHash')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'decimals')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenType')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[1], 'tokenQty')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should process data directly from Electrumx', async () => {
|
||||||
|
const addrs = [
|
||||||
|
'bitcoincash:qq6mvsm7l92d77zpymmltvaw09p5uzghyuyx7spygg',
|
||||||
|
'bitcoincash:qpjdrs8qruzh8xvusdfmutjx62awcepnhyperm3g89',
|
||||||
|
'bitcoincash:qzygn28zpgeemnptkn26xzyuzzfu9l8f9vfvq7kptk'
|
||||||
|
]
|
||||||
|
|
||||||
|
const utxos = await bchjs.Electrumx.utxo(addrs)
|
||||||
|
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
|
||||||
|
|
||||||
|
req.body.utxos = utxos.utxos
|
||||||
|
const result = await slp.hydrateUtxos(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// Test the general structure of the output.
|
||||||
|
assert.isArray(result.slpUtxos)
|
||||||
|
assert.equal(result.slpUtxos.length, 3)
|
||||||
|
assert.equal(result.slpUtxos[0].utxos.length, 1)
|
||||||
|
assert.equal(result.slpUtxos[1].utxos.length, 1)
|
||||||
|
assert.equal(result.slpUtxos[2].utxos.length, 2)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#hydrateUtxosWL', () => {
|
||||||
|
it('should return utxo details', async () => {
|
||||||
|
const utxos = [
|
||||||
|
{
|
||||||
|
utxos: [
|
||||||
|
{
|
||||||
|
tx_hash:
|
||||||
|
'89b3f0c84efe8b01b24e2d7ac08636de5781f31dbb84478e3de868ca0a7ed93a',
|
||||||
|
tx_pos: 1,
|
||||||
|
value: 546
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.utxos = utxos
|
||||||
|
const result = await slp.hydrateUtxosWL(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// Test the general structure of the output.
|
||||||
|
assert.isArray(result.slpUtxos)
|
||||||
|
assert.equal(result.slpUtxos.length, 1)
|
||||||
|
assert.equal(result.slpUtxos[0].utxos.length, 1)
|
||||||
|
|
||||||
|
// Test the non-slp UTXO.
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'tx_hash')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'tx_pos')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'value')
|
||||||
|
assert.property(result.slpUtxos[0].utxos[0], 'isValid')
|
||||||
|
assert.equal(result.slpUtxos[0].utxos[0].isValid, true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#validate2Single', () => {
|
||||||
|
it('should invalidate a known invalid TXID', async () => {
|
||||||
|
const txid =
|
||||||
|
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
|
||||||
|
|
||||||
|
req.params.txid = txid
|
||||||
|
const result = await slp.validate2Single(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.equal(result.txid, txid)
|
||||||
|
assert.equal(result.isValid, false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should validate a known valid TXID', async () => {
|
||||||
|
const txid =
|
||||||
|
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
|
||||||
|
|
||||||
|
req.params.txid = txid
|
||||||
|
const result = await slp.validate2Single(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.equal(result.txid, txid)
|
||||||
|
assert.equal(result.isValid, true)
|
||||||
|
})
|
||||||
|
|
||||||
|
// CT 10-11-2020: This test is valid, but because of the cacheing built
|
||||||
|
// into slp-validate, it will not consistently pass or fail. To manually
|
||||||
|
// Run this test, re-start slp-api or find a token txid with a long DAG.
|
||||||
|
// it('should cancel if validation takes too long', async () => {
|
||||||
|
// const txid =
|
||||||
|
// 'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
|
||||||
|
//
|
||||||
|
// req.params.txid = txid
|
||||||
|
// const result = await slp.validate2Single(req, res)
|
||||||
|
// // console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
//
|
||||||
|
// assert.isAbove(res.statusCode, 499, 'HTTP status code 503 expected.')
|
||||||
|
// assert.include(
|
||||||
|
// result.error,
|
||||||
|
// 'Could not communicate with full node',
|
||||||
|
// 'Error message expected'
|
||||||
|
// )
|
||||||
|
// })
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#validateBulk', () => {
|
||||||
|
it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
|
||||||
|
const txids = [
|
||||||
|
// Malformed SLP tx
|
||||||
|
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
|
||||||
|
// Normal TX (non-SLP)
|
||||||
|
'01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
|
||||||
|
// Valid PSF SLP tx
|
||||||
|
'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
|
||||||
|
// Valid SLP token not in whitelist
|
||||||
|
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
|
||||||
|
// Token send on BCHN network.
|
||||||
|
'402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
|
||||||
|
// Token send on ABC network.
|
||||||
|
'336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
|
||||||
|
// Known invalid SLP token send of PSF tokens.
|
||||||
|
'2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.txids = txids
|
||||||
|
const result = await slp.validateBulk(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// BCHN expected results
|
||||||
|
if (process.env.ISBCHN) {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
// Note: This should change from null to true once SLPDB finishes indexing.
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#validate3Bulk', () => {
|
||||||
|
it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
|
||||||
|
const txids = [
|
||||||
|
// Malformed SLP tx
|
||||||
|
'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
|
||||||
|
// Normal TX (non-SLP)
|
||||||
|
'01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
|
||||||
|
// Valid PSF SLP tx
|
||||||
|
'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
|
||||||
|
// Valid SLP token not in whitelist
|
||||||
|
'3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
|
||||||
|
// Token send on BCHN network.
|
||||||
|
'402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
|
||||||
|
// Token send on ABC network.
|
||||||
|
'336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
|
||||||
|
// Known invalid SLP token send of PSF tokens.
|
||||||
|
'2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74'
|
||||||
|
]
|
||||||
|
|
||||||
|
req.body.txids = txids
|
||||||
|
const result = await slp.validate3Bulk(req, res)
|
||||||
|
console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
// BCHN expected results
|
||||||
|
if (process.env.ISBCHN) {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, null)
|
||||||
|
|
||||||
|
// Note: This should change from null to true once SLPDB finishes indexing.
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
assert.equal(result[0].txid, txids[0])
|
||||||
|
assert.equal(result[0].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[1].txid, txids[1])
|
||||||
|
assert.equal(result[1].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[2].txid, txids[2])
|
||||||
|
assert.equal(result[2].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[3].txid, txids[3])
|
||||||
|
assert.equal(result[3].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[4].txid, txids[4])
|
||||||
|
assert.equal(result[4].valid, null)
|
||||||
|
|
||||||
|
assert.equal(result[5].txid, txids[5])
|
||||||
|
assert.equal(result[5].valid, true)
|
||||||
|
|
||||||
|
assert.equal(result[6].txid, txids[6])
|
||||||
|
assert.equal(result[6].valid, false)
|
||||||
|
assert.include(
|
||||||
|
result[6].invalidReason,
|
||||||
|
'Token outputs are greater than valid token inputs'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getStatus', () => {
|
||||||
|
it('should get the SLPDB status', async () => {
|
||||||
|
const result = await slp.getStatus(req, res)
|
||||||
|
// console.log(`result: ${JSON.stringify(result, null, 2)}`)
|
||||||
|
|
||||||
|
assert.property(result, 'bchBlockHeight')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -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/v4/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/v5/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
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user