mirror of
https://github.com/Permissionless-Software-Foundation/psf-bch-api.git
synced 2026-09-21 16:52:00 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cc78aad785 | ||
|
|
91f99405c1 | ||
|
|
a959416b10 | ||
|
|
562a196998 | ||
|
|
e006a7ad86 | ||
|
|
f36cd2a8aa | ||
|
|
8b2cf64f1b | ||
|
|
95ae06fada | ||
|
|
188dc939b3 | ||
|
|
7d566beea3 | ||
|
|
6c42f47e15 | ||
|
|
d19a9e64cd | ||
|
|
7c96d72f7b | ||
|
|
7f1770ab70 | ||
|
|
b25f55ce6a | ||
|
|
6e32723b29 | ||
|
|
3b08fc3b62 | ||
|
|
2c1f02d6c7 | ||
|
|
6cf03ca0fe | ||
|
|
5ea7bc9c29 | ||
|
|
39021aba46 | ||
|
|
de34547951 | ||
|
|
b8f34fb40e | ||
|
|
3778894ce2 | ||
|
|
02eb8afd21 | ||
|
|
e708fc1228 | ||
|
|
fed4b2da59 | ||
|
|
f30c2ede04 | ||
|
|
09e05d51e5 | ||
|
|
22cbc54dee | ||
|
|
6fe0e01e8b | ||
|
|
f33b39ef01 | ||
|
|
6d27630393 | ||
|
|
eac4916415 | ||
|
|
baa1170b89 | ||
|
|
23ce276e19 | ||
|
|
f28e2c6a1a | ||
|
|
50a1a83a82 | ||
|
|
eb2dda6955 | ||
|
|
fe8d2ab051 | ||
|
|
66123de679 | ||
|
|
e2860d08b1 | ||
|
|
fa14af624f | ||
|
|
1eb787e0d4 | ||
|
|
ea815868ab | ||
|
|
d17e3aa2d8 | ||
|
|
1cd57a8bd7 | ||
|
|
50db4be890 | ||
|
|
908911fba6 | ||
|
|
f6726c79bf | ||
|
|
8b12938e6c | ||
|
|
d204f78fa4 | ||
|
|
58e831b22c | ||
|
|
6451736f26 | ||
|
|
571acbec59 | ||
|
|
394ab73276 | ||
|
|
ca0fcdd60a | ||
|
|
98576e5ff2 | ||
|
|
39144116a9 | ||
|
|
3aeb23ba17 | ||
|
|
c79c3fa59d | ||
|
|
0461db96c1 | ||
|
|
ca666f7c56 | ||
|
|
a23c4d9328 | ||
|
|
b5ed86e914 | ||
|
|
6b09a3a172 | ||
|
|
73d94f6d82 | ||
|
|
550c763df6 | ||
|
|
8fe5a0b22d | ||
|
|
5cd2e9fa2d | ||
|
|
c338fd38ea | ||
|
|
f59ca87f1e | ||
|
|
1914e6f985 | ||
|
|
5a5119716a | ||
|
|
a37d088b52 | ||
|
|
81a1241b5d | ||
|
|
d104405f17 | ||
|
|
ca25e33517 | ||
|
|
2af4b0a943 | ||
|
|
e5c8fa9321 | ||
|
|
4f89335768 | ||
|
|
f2e61fde35 | ||
|
|
5ab5547bf3 |
@@ -0,0 +1,35 @@
|
|||||||
|
# START INFRASTRUCTURE SETUP
|
||||||
|
|
||||||
|
# Full Node Connection
|
||||||
|
RPC_BASEURL=http://172.17.0.1:8332
|
||||||
|
RPC_USERNAME=bitcoin
|
||||||
|
RPC_PASSWORD=password
|
||||||
|
|
||||||
|
# Fulcrum Indexer
|
||||||
|
FULCRUM_API=http://172.17.0.1:3001/v1
|
||||||
|
|
||||||
|
# SLP Indexer
|
||||||
|
SLP_INDEXER_API=http://localhost:5010
|
||||||
|
|
||||||
|
# REST API URL for wallet operations
|
||||||
|
LOCAL_RESTURL=http://localhost:5942/v6
|
||||||
|
|
||||||
|
# END INFRASTRUCTURE SETUP
|
||||||
|
|
||||||
|
|
||||||
|
# START ACCESS CONTROL
|
||||||
|
|
||||||
|
PORT=5942
|
||||||
|
|
||||||
|
# x402 payments required to access this API?
|
||||||
|
X402_ENABLED=true
|
||||||
|
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
|
||||||
|
FACILITATOR_URL=http://localhost:4345/facilitator
|
||||||
|
X402_PRICE_SAT=200
|
||||||
|
|
||||||
|
# Basic Authentication required to access this API?
|
||||||
|
USE_BASIC_AUTH=true
|
||||||
|
BASIC_AUTH_TOKEN=some-random-token
|
||||||
|
|
||||||
|
# END ACCESS CONTROL
|
||||||
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
# Full Node Connection
|
|
||||||
RPC_BASEURL=http://172.17.0.1:8332
|
|
||||||
RPC_USERNAME=bitcoin
|
|
||||||
RPC_PASSWORD=password
|
|
||||||
@@ -1,30 +1,247 @@
|
|||||||
# psf-bch-api
|
# psf-bch-api
|
||||||
|
|
||||||
This is a REST API for communicating with Bitcoin Cash infrastructure. It replaces [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api), and it implements [x402-bch protocol](https://github.com/x402-bch/x402-bch) to handle payments to access the API.
|
[](https://github.com/Permissionless-Software-Foundation/psf-bch-api/blob/master/LICENSE.md)
|
||||||
|
[](https://github.com/feross/standard)
|
||||||
|
|
||||||
|
This is a REST API server for communicating with Bitcoin Cash (BCH) blockchain infrastructure. It is written in node.js JavaScript using the [Express.js](https://expressjs.com/) framework and follows the [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) design pattern. It replaces the legacy [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) and implements the [x402-bch protocol](https://github.com/x402-bch/x402-bch) for optional per-call payments.
|
||||||
|
|
||||||
|
psf-bch-api is the heart of the [Cash Stack](https://cashstack.info), a full software stack for building blockchain-based applications. It creates a single web2 REST API interface that abstracts away the complexity of the underlying blockchain infrastructure, so that application developers can interact with the blockchain through simple HTTP calls.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
psf-bch-api depends on three pieces of back end infrastructure:
|
||||||
|
|
||||||
|
- **[BCHN Full Node](https://cashstack.info/docs/back-end/bchn-full-node)** - the base blockchain node that validates transactions and blocks.
|
||||||
|
- **[Fulcrum Indexer](https://cashstack.info/docs/back-end/fulcrum-indexer)** - an address indexer that tracks balances, transaction histories, and UTXOs.
|
||||||
|
- **[SLP Token Indexer](https://cashstack.info/docs/back-end/slp-indexer/slp-indexer-software)** - tracks all SLP tokens on the blockchain.
|
||||||
|
|
||||||
|
Front-end applications interact with psf-bch-api through libraries such as [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) or [bch-consumer](https://www.npmjs.com/package/bch-consumer).
|
||||||
|
|
||||||
|
High-level documentation about the full Cash Stack is available at [CashStack.info](https://cashstack.info). Interactive API reference documentation is served by the running server at its root URL (e.g. `http://localhost:5942/`), and a live version can be found at [bch.fullstack.cash](https://bch.fullstack.cash/).
|
||||||
|
|
||||||
|
## The .env File
|
||||||
|
|
||||||
|
All runtime configuration is driven by a `.env` file in the project root. An example is provided at `.env-example`. To get started:
|
||||||
|
|
||||||
|
`cp .env-example .env`
|
||||||
|
|
||||||
|
Then edit `.env` to match your environment. The file is organized into two sections:
|
||||||
|
|
||||||
|
### Infrastructure Setup
|
||||||
|
|
||||||
|
These variables tell psf-bch-api where to find the back end services it depends on:
|
||||||
|
|
||||||
|
- `RPC_BASEURL` - URL of the BCHN full node JSON-RPC interface. Default: `http://127.0.0.1:8332`
|
||||||
|
- `RPC_USERNAME` - RPC username for the full node.
|
||||||
|
- `RPC_PASSWORD` - RPC password for the full node.
|
||||||
|
- `FULCRUM_API` - URL of the Fulcrum indexer REST API.
|
||||||
|
- `SLP_INDEXER_API` - URL of the SLP Token Indexer REST API.
|
||||||
|
- `LOCAL_RESTURL` - The REST API URL used internally for wallet operations. Default: `http://127.0.0.1:5942/v6/`
|
||||||
|
|
||||||
|
### Access Control Settings
|
||||||
|
|
||||||
|
These variables control who can access the API and how they pay for it. The three access-control use cases are described in detail in the [Access Control](#access-control) section below.
|
||||||
|
|
||||||
|
- `PORT` - Port the server listens on. Default: `5942`
|
||||||
|
- `X402_ENABLED` - Enable x402-bch per-call payment middleware. Default: `true`
|
||||||
|
- `SERVER_BCH_ADDRESS` - BCH address that receives x402 payments. Default: `bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr`
|
||||||
|
- `FACILITATOR_URL` - URL of the x402-bch facilitator service. Default: `http://localhost:4345/facilitator`
|
||||||
|
- `X402_PRICE_SAT` - Price in satoshis charged per API call via x402. Default: `200`
|
||||||
|
- `USE_BASIC_AUTH` - Enable Bearer token authentication middleware. Default: `false`
|
||||||
|
- `BASIC_AUTH_TOKEN` - The expected Bearer token value.
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
|
||||||
|
psf-bch-api supports three major access-control configurations. Which one you choose depends on your deployment scenario. The behavior is controlled entirely by the `X402_ENABLED` and `USE_BASIC_AUTH` environment variables.
|
||||||
|
|
||||||
|
### 1. No Rate Limits (Open Access)
|
||||||
|
|
||||||
|
Set both access-control flags to `false`:
|
||||||
|
|
||||||
|
```
|
||||||
|
X402_ENABLED=false
|
||||||
|
USE_BASIC_AUTH=false
|
||||||
|
```
|
||||||
|
|
||||||
|
All API endpoints are publicly accessible without any authentication or payment. This is the simplest configuration, ideal for **local development** or **private, trusted networks** where access control is handled at the network level (e.g. behind a firewall or VPN).
|
||||||
|
|
||||||
|
### 2. Bearer Token Authentication
|
||||||
|
|
||||||
|
Set `USE_BASIC_AUTH=true` and `X402_ENABLED=false`:
|
||||||
|
|
||||||
|
```
|
||||||
|
X402_ENABLED=false
|
||||||
|
USE_BASIC_AUTH=true
|
||||||
|
BASIC_AUTH_TOKEN=my-secret-token
|
||||||
|
```
|
||||||
|
|
||||||
|
Every API request (except `/health` and `/`) must include an `Authorization` header with a valid Bearer token:
|
||||||
|
|
||||||
|
```
|
||||||
|
Authorization: Bearer my-secret-token
|
||||||
|
```
|
||||||
|
|
||||||
|
Requests without a valid token receive an HTTP `401 Unauthorized` response. This is the best option when you want to **restrict access to a known set of users or services** (e.g. an organization's internal apps) without requiring cryptocurrency payments.
|
||||||
|
|
||||||
|
### 3. x402-bch Per-Call Payments
|
||||||
|
|
||||||
|
Set `X402_ENABLED=true`:
|
||||||
|
|
||||||
|
```
|
||||||
|
X402_ENABLED=true
|
||||||
|
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
|
||||||
|
FACILITATOR_URL=http://localhost:4345/facilitator
|
||||||
|
X402_PRICE_SAT=200
|
||||||
|
```
|
||||||
|
|
||||||
|
Every API call under the `/v6` prefix requires a BCH micro-payment. When a request arrives without a valid `X-PAYMENT` header, the server responds with HTTP `402 Payment Required` and includes the payment details. Client libraries that support the x402-bch protocol (like [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js)) can handle payments automatically.
|
||||||
|
|
||||||
|
This is the right choice for **public, monetized APIs** where you want to charge per call.
|
||||||
|
|
||||||
|
#### Combined: x402 + Bearer Token
|
||||||
|
|
||||||
|
You can enable both at the same time:
|
||||||
|
|
||||||
|
```
|
||||||
|
X402_ENABLED=true
|
||||||
|
USE_BASIC_AUTH=true
|
||||||
|
BASIC_AUTH_TOKEN=my-secret-token
|
||||||
|
```
|
||||||
|
|
||||||
|
In this mode, requests that present a valid Bearer token bypass the x402 payment requirement. All other requests must pay. This allows you to give **free access to trusted clients** (via the Bearer token) while still **monetizing public access** via x402.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
This is a standard node.js project. To set up a development environment:
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
|
||||||
|
`git clone https://github.com/Permissionless-Software-Foundation/psf-bch-api && cd psf-bch-api`
|
||||||
|
|
||||||
|
2. Install dependencies:
|
||||||
|
|
||||||
|
`npm install`
|
||||||
|
|
||||||
|
3. Create your configuration file:
|
||||||
|
|
||||||
|
`cp .env-example .env`
|
||||||
|
|
||||||
|
4. Edit `.env` to point to your back end infrastructure (full node, Fulcrum, SLP indexer). For local development you will likely want to disable access control:
|
||||||
|
|
||||||
|
```
|
||||||
|
X402_ENABLED=false
|
||||||
|
USE_BASIC_AUTH=false
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Start the server:
|
||||||
|
|
||||||
|
`npm start`
|
||||||
|
|
||||||
|
The server will start on port `5942` by default (or whatever you set in `PORT`). API documentation is available at `http://localhost:5942/`.
|
||||||
|
|
||||||
|
### Generating API Docs
|
||||||
|
|
||||||
|
The API reference documentation is generated by [apiDoc](https://apidocjs.com/) from inline annotations in the source code. To regenerate:
|
||||||
|
|
||||||
|
`npm run docs`
|
||||||
|
|
||||||
|
The output is written to the `docs/` directory and served by the running server at its root URL.
|
||||||
|
|
||||||
|
A live version can be found at [bch.fullstack.cash](https://bch.fullstack.cash/).
|
||||||
|
|
||||||
|
## Production (Docker)
|
||||||
|
|
||||||
|
A Docker setup is provided in the `production/docker/` directory for production deployments. The target OS is Ubuntu Linux.
|
||||||
|
|
||||||
|
1. Install [Docker and Docker Compose](https://docs.docker.com/engine/install/ubuntu/).
|
||||||
|
|
||||||
|
2. Navigate to the Docker directory:
|
||||||
|
|
||||||
|
`cd production/docker`
|
||||||
|
|
||||||
|
3. Create and configure the `.env` file. An example is provided:
|
||||||
|
|
||||||
|
`cp .env-example .env`
|
||||||
|
|
||||||
|
Edit `.env` to match your production infrastructure. Note that inside a Docker container, `localhost` refers to the container itself. Use `172.17.0.1` (the default Docker bridge gateway) to reach services running on the host machine:
|
||||||
|
|
||||||
|
```
|
||||||
|
RPC_BASEURL=http://172.17.0.1:8332
|
||||||
|
FULCRUM_API=http://172.17.0.1:3001/v1
|
||||||
|
SLP_INDEXER_API=http://172.17.0.1:5010
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Build the Docker image:
|
||||||
|
|
||||||
|
`docker-compose build --no-cache`
|
||||||
|
|
||||||
|
5. Start the container:
|
||||||
|
|
||||||
|
`docker-compose up -d`
|
||||||
|
|
||||||
|
The container maps host port `5942` to container port `5942`. The `.env` file is mounted into the container as a volume, so you can update configuration without rebuilding.
|
||||||
|
|
||||||
|
To view logs:
|
||||||
|
|
||||||
|
`docker logs -f psf-bch-api`
|
||||||
|
|
||||||
|
To stop the container:
|
||||||
|
|
||||||
|
`docker-compose down`
|
||||||
|
|
||||||
|
A helper script `cleanup-images.sh` is provided to remove dangling Docker images after rebuilds.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
The project includes both unit tests and integration tests. Tests use [Mocha](https://mochajs.org/) as the test runner, [Chai](https://www.chaijs.com/) for assertions, and [Sinon](https://sinonjs.org/) for mocking. Code coverage is provided by [c8](https://github.com/bcoe/c8).
|
||||||
|
|
||||||
|
### Unit Tests
|
||||||
|
|
||||||
|
Unit tests are located in `test/unit/` and cover adapters, controllers, and use cases. They do not require any running infrastructure. To run:
|
||||||
|
|
||||||
|
`npm test`
|
||||||
|
|
||||||
|
This will first lint the code with [Standard](https://standardjs.com/), then execute all unit tests with code coverage.
|
||||||
|
|
||||||
|
To generate an HTML coverage report:
|
||||||
|
|
||||||
|
`npm run coverage`
|
||||||
|
|
||||||
|
The report is written to the `coverage/` directory.
|
||||||
|
|
||||||
|
### Integration Tests
|
||||||
|
|
||||||
|
Integration tests are located in `test/integration/` and require the back end infrastructure (full node, Fulcrum, SLP indexer) to be running. To run:
|
||||||
|
|
||||||
|
`npm run test:integration`
|
||||||
|
|
||||||
|
Integration tests have a 25-second timeout per test to accommodate network calls.
|
||||||
|
|
||||||
|
## Configuration Reference
|
||||||
|
|
||||||
|
All configuration values are read from environment variables (via the `.env` file). The complete list:
|
||||||
|
|
||||||
|
- `PORT` - Server listen port. Default: `5942`
|
||||||
|
- `NODE_ENV` - Environment (`development` or `production`). Default: `development`
|
||||||
|
- `API_PREFIX` - URL prefix for all REST endpoints. Default: `/v6`
|
||||||
|
- `LOG_LEVEL` - Winston logging level. Default: `info`
|
||||||
|
- `RPC_BASEURL` - Full node JSON-RPC URL. Default: `http://127.0.0.1:8332`
|
||||||
|
- `RPC_USERNAME` - Full node RPC username.
|
||||||
|
- `RPC_PASSWORD` - Full node RPC password.
|
||||||
|
- `RPC_TIMEOUT_MS` - Full node RPC request timeout in ms. Default: `15000`
|
||||||
|
- `FULCRUM_API` - Fulcrum indexer REST API URL.
|
||||||
|
- `FULCRUM_TIMEOUT_MS` - Fulcrum API request timeout in ms. Default: `15000`
|
||||||
|
- `SLP_INDEXER_API` - SLP Token Indexer REST API URL.
|
||||||
|
- `SLP_INDEXER_TIMEOUT_MS` - SLP Indexer API request timeout in ms. Default: `15000`
|
||||||
|
- `LOCAL_RESTURL` - Internal REST URL for wallet operations. Default: `http://127.0.0.1:5942/v6/`
|
||||||
|
- `IPFS_GATEWAY` - IPFS gateway hostname. Default: `p2wdb-gateway-678.fullstack.cash`
|
||||||
|
- `X402_ENABLED` - Enable x402-bch payment middleware. Default: `true`
|
||||||
|
- `SERVER_BCH_ADDRESS` - BCH address for x402 payments. Default: `bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr`
|
||||||
|
- `FACILITATOR_URL` - x402-bch facilitator service URL. Default: `http://localhost:4345/facilitator`
|
||||||
|
- `X402_PRICE_SAT` - Satoshis charged per API call via x402. Default: `200`
|
||||||
|
- `USE_BASIC_AUTH` - Enable Bearer token authentication. Default: `false`
|
||||||
|
- `BASIC_AUTH_TOKEN` - Expected Bearer token value.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](./LICENSE.md)
|
[MIT](./LICENSE.md)
|
||||||
|
|
||||||
## x402-bch Payments
|
|
||||||
|
|
||||||
All REST endpoints exposed under the `/v6` prefix are protected by the [`x402-bch-express`](https://www.npmjs.com/package/x402-bch-express) middleware. Each API call requires a BCH payment authorization for **2000 satoshis**. The middleware advertises payment requirements via HTTP 402 responses and validates incoming `X-PAYMENT` headers with a configured Facilitator.
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
|
|
||||||
Environment variables control the payment flow:
|
|
||||||
|
|
||||||
- `X402_ENABLED` — set to `false` (case-insensitive) to disable the middleware. Defaults to enabled.
|
|
||||||
- `SERVER_BCH_ADDRESS` — BCH cash address that receives funding transactions. Defaults to `bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d`.
|
|
||||||
- `FACILITATOR_URL` — Root URL of the facilitator service (e.g., `http://localhost:4345/facilitator`).
|
|
||||||
- `X402_PRICE_SAT` — Optional; override the satoshi price per call (defaults to `2000`).
|
|
||||||
|
|
||||||
When `X402_ENABLED=false`, the server continues to operate without payment headers for local development or trusted deployments.
|
|
||||||
|
|
||||||
### Manual Verification
|
|
||||||
|
|
||||||
1. Start or point to an `x402-bch` facilitator service (the example facilitator listens at `http://localhost:4345/facilitator`).
|
|
||||||
2. Run the API server with the default configuration: `npm start`.
|
|
||||||
3. Call a protected endpoint without an `X-PAYMENT` header, e.g. `curl -i http://localhost:5942/v6/full-node/control/getNetworkInfo`. The server will respond with HTTP `402` and include payment requirements.
|
|
||||||
4. Restart the server with `X402_ENABLED=false npm start` to confirm that the same request now bypasses the middleware (useful for local development without payments).
|
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
+97
-10
@@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
Express server for REST2NOSTR Proxy API.
|
Express server for psf-bch-api REST API.
|
||||||
The architecture of the code follows the Clean Architecture pattern.
|
The architecture of the code follows the Clean Architecture pattern.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -15,7 +15,8 @@ import { dirname, join } from 'path'
|
|||||||
import config from '../src/config/index.js'
|
import config from '../src/config/index.js'
|
||||||
import Controllers from '../src/controllers/index.js'
|
import Controllers from '../src/controllers/index.js'
|
||||||
import wlogger from '../src/adapters/wlogger.js'
|
import wlogger from '../src/adapters/wlogger.js'
|
||||||
import { buildX402Routes, getX402Settings } from '../src/config/x402.js'
|
import { buildX402Routes, getX402Settings, getBasicAuthSettings } from '../src/config/x402.js'
|
||||||
|
import { basicAuthMiddleware } from '../src/middleware/basic-auth.js'
|
||||||
|
|
||||||
// Load environment variables
|
// Load environment variables
|
||||||
dotenv.config()
|
dotenv.config()
|
||||||
@@ -60,6 +61,7 @@ class Server {
|
|||||||
const app = express()
|
const app = express()
|
||||||
|
|
||||||
const x402Settings = getX402Settings()
|
const x402Settings = getX402Settings()
|
||||||
|
const basicAuthSettings = getBasicAuthSettings()
|
||||||
|
|
||||||
// MIDDLEWARE START
|
// MIDDLEWARE START
|
||||||
app.use(express.json())
|
app.use(express.json())
|
||||||
@@ -72,27 +74,107 @@ class Server {
|
|||||||
allowedHeaders: ['Content-Type', 'Authorization', 'X-Requested-With']
|
allowedHeaders: ['Content-Type', 'Authorization', 'X-Requested-With']
|
||||||
}))
|
}))
|
||||||
|
|
||||||
if (x402Settings.enabled) {
|
// URL normalization middleware - collapse multiple slashes
|
||||||
|
app.use((req, res, next) => {
|
||||||
|
if (req.url && req.url.includes('//')) {
|
||||||
|
// Split URL into path and query string
|
||||||
|
const [path, queryString] = req.url.split('?')
|
||||||
|
// Collapse multiple consecutive slashes into a single slash
|
||||||
|
const normalizedPath = path.replace(/\/+/g, '/')
|
||||||
|
// Reconstruct req.url with normalized path (req.path is read-only and will auto-update)
|
||||||
|
req.url = queryString ? `${normalizedPath}?${queryString}` : normalizedPath
|
||||||
|
}
|
||||||
|
next()
|
||||||
|
})
|
||||||
|
|
||||||
|
// Apply basic auth middleware if enabled
|
||||||
|
// This must run before x402 middleware to set req.locals.basicAuthValid
|
||||||
|
if (basicAuthSettings.enabled) {
|
||||||
|
wlogger.info('Basic auth middleware enabled')
|
||||||
|
app.use(basicAuthMiddleware)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Apply x402 middleware based on configuration
|
||||||
|
// Logic:
|
||||||
|
// - If X402_ENABLED=true AND USE_BASIC_AUTH=true: Apply x402 conditionally (bypass if basic auth valid)
|
||||||
|
// - If X402_ENABLED=true AND USE_BASIC_AUTH=false: Apply x402 unconditionally (no basic auth bypass)
|
||||||
|
// - If X402_ENABLED=false AND USE_BASIC_AUTH=true: Require basic auth only
|
||||||
|
// - If X402_ENABLED=false AND USE_BASIC_AUTH=false: No access control
|
||||||
|
|
||||||
|
// Apply access control middleware based on configuration
|
||||||
|
if (x402Settings.enabled && basicAuthSettings.enabled) {
|
||||||
|
// X402_ENABLED=true AND USE_BASIC_AUTH=true: Apply x402 conditionally
|
||||||
const routes = buildX402Routes(this.config.apiPrefix)
|
const routes = buildX402Routes(this.config.apiPrefix)
|
||||||
const facilitatorOptions = x402Settings.facilitatorUrl
|
const facilitatorOptions = x402Settings.facilitatorUrl
|
||||||
? { url: x402Settings.facilitatorUrl }
|
? { url: x402Settings.facilitatorUrl }
|
||||||
: undefined
|
: undefined
|
||||||
|
|
||||||
wlogger.info(`x402 middleware enabled; enforcing ${x402Settings.priceSat} satoshis per request`)
|
wlogger.info(`x402 middleware enabled with basic auth bypass; enforcing ${x402Settings.priceSat} satoshis per request (unless basic auth provided)`)
|
||||||
app.use(
|
|
||||||
x402PaymentMiddleware(
|
// Create conditional x402 middleware that bypasses if basic auth is valid
|
||||||
|
const conditionalX402Middleware = (req, res, next) => {
|
||||||
|
// If basic auth is valid, bypass x402
|
||||||
|
if (req.locals?.basicAuthValid === true) {
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Otherwise, apply x402 middleware
|
||||||
|
return x402PaymentMiddleware(
|
||||||
x402Settings.serverAddress,
|
x402Settings.serverAddress,
|
||||||
routes,
|
routes,
|
||||||
facilitatorOptions
|
facilitatorOptions
|
||||||
)
|
)(req, res, next)
|
||||||
)
|
}
|
||||||
|
|
||||||
|
app.use(conditionalX402Middleware)
|
||||||
|
} else if (x402Settings.enabled && !basicAuthSettings.enabled) {
|
||||||
|
// X402_ENABLED=true AND USE_BASIC_AUTH=false: Apply x402 unconditionally (no basic auth bypass)
|
||||||
|
const routes = buildX402Routes(this.config.apiPrefix)
|
||||||
|
const facilitatorOptions = x402Settings.facilitatorUrl
|
||||||
|
? { url: x402Settings.facilitatorUrl }
|
||||||
|
: undefined
|
||||||
|
|
||||||
|
wlogger.info(`x402 middleware enabled (basic auth disabled); enforcing ${x402Settings.priceSat} satoshis per request`)
|
||||||
|
|
||||||
|
// Apply x402 middleware unconditionally - no basic auth bypass
|
||||||
|
app.use(x402PaymentMiddleware(
|
||||||
|
x402Settings.serverAddress,
|
||||||
|
routes,
|
||||||
|
facilitatorOptions
|
||||||
|
))
|
||||||
|
} else if (basicAuthSettings.enabled && !x402Settings.enabled) {
|
||||||
|
// USE_BASIC_AUTH=true AND X402_ENABLED=false: Require basic auth, reject unauthenticated requests
|
||||||
|
wlogger.info('Basic auth enforcement enabled (x402 disabled)')
|
||||||
|
|
||||||
|
// Middleware that rejects requests without valid basic auth
|
||||||
|
const requireBasicAuthMiddleware = (req, res, next) => {
|
||||||
|
// Skip auth check for health endpoint and root
|
||||||
|
if (req.path === '/health' || req.path === '/') {
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// If basic auth is valid, allow the request
|
||||||
|
if (req.locals?.basicAuthValid === true) {
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reject unauthenticated requests
|
||||||
|
wlogger.warn(`Unauthenticated request rejected: ${req.method} ${req.path}`)
|
||||||
|
return res.status(401).json({
|
||||||
|
error: 'Unauthorized',
|
||||||
|
message: 'Valid Bearer token required in Authorization header'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
app.use(requireBasicAuthMiddleware)
|
||||||
} else {
|
} else {
|
||||||
wlogger.info('x402 middleware disabled via configuration')
|
// X402_ENABLED=false AND USE_BASIC_AUTH=false: No access control middleware
|
||||||
|
wlogger.info('No access control middleware enabled')
|
||||||
}
|
}
|
||||||
|
|
||||||
// Endpoint logging middleware
|
// Endpoint logging middleware
|
||||||
app.use((req, res, next) => {
|
app.use((req, res, next) => {
|
||||||
console.log(`Endpoint called: ${req.method} ${req.path}`)
|
console.log(`Endpoint called: ${req.method} ${req.path} by ${req.ip}`)
|
||||||
res.on('finish', () => {
|
res.on('finish', () => {
|
||||||
console.log(`Endpoint responded: ${req.method} ${req.path} - ${res.statusCode}`)
|
console.log(`Endpoint responded: ${req.method} ${req.path} - ${res.statusCode}`)
|
||||||
})
|
})
|
||||||
@@ -164,6 +246,11 @@ class Server {
|
|||||||
wlogger.info(`Server started on port ${this.config.port}`)
|
wlogger.info(`Server started on port ${this.config.port}`)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Explicit timeout settings reduce stale keep-alive socket reuse races.
|
||||||
|
this.server.keepAliveTimeout = this.config.serverKeepAliveTimeoutMs
|
||||||
|
this.server.headersTimeout = this.config.serverHeadersTimeoutMs
|
||||||
|
this.server.requestTimeout = this.config.serverRequestTimeoutMs
|
||||||
|
|
||||||
this.server.on('error', (err) => {
|
this.server.on('error', (err) => {
|
||||||
console.error('Server error:', err)
|
console.error('Server error:', err)
|
||||||
wlogger.error('Server error:', err)
|
wlogger.error('Server error:', err)
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# 2026-03-16 Update Log
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Reduced noisy error logging for common SLP transaction misses in the `/v6/slp/txid` path.
|
||||||
|
|
||||||
|
## Changes Made
|
||||||
|
|
||||||
|
- Updated `src/use-cases/slp-use-cases.js` in `getTxid()`:
|
||||||
|
- Added a guard for expected missing-record errors (`404` + `Key not found in database`).
|
||||||
|
- Skips `wlogger.error()` for that specific, common case.
|
||||||
|
- Still rethrows the error so API response behavior is unchanged.
|
||||||
|
- Updated `src/controllers/rest-api/slp/controller.js` in `handleError()`:
|
||||||
|
- Added the same guard to suppress duplicate error-level logs for the same expected case.
|
||||||
|
- Keeps normal error logging for all other errors.
|
||||||
|
|
||||||
|
## Outcome
|
||||||
|
|
||||||
|
- The common "Key not found in database" case no longer pollutes error logs.
|
||||||
|
- Unexpected failures continue to be logged at error level.
|
||||||
|
- Client-facing status and error message behavior remains unchanged.
|
||||||
Generated
+2221
-437
File diff suppressed because it is too large
Load Diff
+7
-3
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "psf-bch-api",
|
"name": "psf-bch-api",
|
||||||
"version": "1.0.0",
|
"version": "7.0.0",
|
||||||
"main": "index.js",
|
"main": "psf-bch-api.js",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node bin/server.js",
|
"start": "node bin/server.js",
|
||||||
@@ -15,13 +15,17 @@
|
|||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"description": "REST API proxy to Bitcoin Cash infrastructure",
|
"description": "REST API proxy to Bitcoin Cash infrastructure",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@psf/bch-js": "7.1.14",
|
||||||
"axios": "1.7.7",
|
"axios": "1.7.7",
|
||||||
"cors": "2.8.5",
|
"cors": "2.8.5",
|
||||||
"dotenv": "16.3.1",
|
"dotenv": "16.3.1",
|
||||||
"express": "5.1.0",
|
"express": "5.1.0",
|
||||||
|
"minimal-slp-wallet": "7.1.5",
|
||||||
|
"psffpp": "1.2.1",
|
||||||
|
"slp-token-media": "1.2.10",
|
||||||
"winston": "3.11.0",
|
"winston": "3.11.0",
|
||||||
"winston-daily-rotate-file": "4.7.1",
|
"winston-daily-rotate-file": "4.7.1",
|
||||||
"x402-bch-express": "1.1.1"
|
"x402-bch-express": "2.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"apidoc": "1.2.0",
|
"apidoc": "1.2.0",
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# START INFRASTRUCTURE SETUP
|
||||||
|
|
||||||
|
# Full Node Connection
|
||||||
|
RPC_BASEURL=http://172.17.0.1:8332
|
||||||
|
RPC_USERNAME=bitcoin
|
||||||
|
RPC_PASSWORD=password
|
||||||
|
|
||||||
|
# Fulcrum Indexer
|
||||||
|
FULCRUM_API=http://172.17.0.1:3001/v1
|
||||||
|
|
||||||
|
# SLP Indexer
|
||||||
|
SLP_INDEXER_API=http://172.17.0.1:5020
|
||||||
|
|
||||||
|
# REST API URL for wallet operations
|
||||||
|
LOCAL_RESTURL=http://172.17.0.1:5942/v6
|
||||||
|
|
||||||
|
# END INFRASTRUCTURE SETUP
|
||||||
|
|
||||||
|
|
||||||
|
# START ACCESS CONTROL
|
||||||
|
|
||||||
|
PORT=5942
|
||||||
|
|
||||||
|
# x402 payments required to access this API?
|
||||||
|
X402_ENABLED=false
|
||||||
|
#X402_ENABLED=true
|
||||||
|
#SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
|
||||||
|
#FACILITATOR_URL=http://localhost:4345/facilitator
|
||||||
|
#X402_PRICE_SAT=200
|
||||||
|
|
||||||
|
# Basic Authentication required to access this API?
|
||||||
|
USE_BASIC_AUTH=false
|
||||||
|
#USE_BASIC_AUTH=true
|
||||||
|
#BASIC_AUTH_TOKEN=some-random-token
|
||||||
|
|
||||||
|
# END ACCESS CONTROL
|
||||||
|
|
||||||
@@ -2,8 +2,6 @@
|
|||||||
#
|
#
|
||||||
|
|
||||||
#IMAGE BUILD COMMANDS
|
#IMAGE BUILD COMMANDS
|
||||||
# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
|
|
||||||
#FROM christroutner/ct-base-ubuntu
|
|
||||||
FROM ubuntu:22.04
|
FROM ubuntu:22.04
|
||||||
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
||||||
|
|
||||||
@@ -47,39 +45,26 @@ RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
|
|||||||
|
|
||||||
# Clone the rest.bitcoin.com repository
|
# Clone the rest.bitcoin.com repository
|
||||||
WORKDIR /home/safeuser
|
WORKDIR /home/safeuser
|
||||||
RUN git clone https://github.com/christroutner/REST2NOSTR
|
RUN git clone https://github.com/Permissionless-Software-Foundation/psf-bch-api
|
||||||
|
|
||||||
# Switch to the desired branch. `master` is usually stable,
|
# Switch to the desired branch. `master` is usually stable,
|
||||||
# and `stage` has the most up-to-date changes.
|
# and `stage` has the most up-to-date changes.
|
||||||
WORKDIR /home/safeuser/REST2NOSTR
|
WORKDIR /home/safeuser/psf-bch-api
|
||||||
|
|
||||||
# For development: switch to unstable branch
|
RUN git checkout ct-unstable
|
||||||
#RUN git checkout pin-ipfs
|
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
RUN npm install
|
RUN npm install
|
||||||
|
RUN npm install minimal-slp-wallet
|
||||||
|
|
||||||
# Generate the API docs
|
# Generate the API docs
|
||||||
RUN npm run docs
|
RUN npm run docs
|
||||||
|
|
||||||
#VOLUME /home/safeuser/keys
|
COPY .env .env
|
||||||
|
|
||||||
# Make leveldb folders
|
|
||||||
#RUN mkdir leveldb
|
|
||||||
#WORKDIR /home/safeuser/psf-slp-indexer/leveldb
|
|
||||||
#RUN mkdir current
|
|
||||||
#RUN mkdir zips
|
|
||||||
#RUN mkdir backup
|
|
||||||
#WORKDIR /home/safeuser/psf-slp-indexer/leveldb/zips
|
|
||||||
#COPY restore-auto.sh restore-auto.sh
|
|
||||||
#WORKDIR /home/safeuser/psf-slp-indexer
|
|
||||||
|
|
||||||
# Expose the port the API will be served on.
|
CMD ["npm", "start"]
|
||||||
#EXPOSE 5011
|
|
||||||
|
|
||||||
# Start the application.
|
# Used to debug the container.
|
||||||
#COPY start-production.sh start-production.sh
|
#COPY temp.js temp.js
|
||||||
VOLUME start-rest2nostr.sh
|
#CMD ["node", "temp.js"]
|
||||||
CMD ["./start-rest2nostr.sh"]
|
|
||||||
|
|
||||||
#CMD ["npm", "start"]
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# Start the service with the command 'docker-compose up -d'
|
# Start the service with the command 'docker-compose up -d'
|
||||||
|
|
||||||
services:
|
services:
|
||||||
rest2nostr:
|
psf-bch-api:
|
||||||
build: .
|
build: .
|
||||||
container_name: rest2nostr
|
container_name: psf-bch-api
|
||||||
logging:
|
logging:
|
||||||
driver: 'json-file'
|
driver: 'json-file'
|
||||||
options:
|
options:
|
||||||
@@ -15,5 +15,8 @@ services:
|
|||||||
ports:
|
ports:
|
||||||
- '5942:5942' # <host port>:<container port>
|
- '5942:5942' # <host port>:<container port>
|
||||||
volumes:
|
volumes:
|
||||||
- ./start-rest2nostr.sh:/home/safeuser/REST2NOSTR/start-rest2nostr.sh
|
#- ./start-rest2nostr.sh:/home/safeuser/REST2NOSTR/start-rest2nostr.sh
|
||||||
|
- ./.env:/home/safeuser/.env
|
||||||
|
- ../data:/home/safeuser/psf-bch-api/production/data
|
||||||
|
- ../data/logs:/home/safeuser/psf-bch-api/logs
|
||||||
restart: always
|
restart: always
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
npm start
|
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
/*
|
||||||
|
Adapter library for interacting with Fulcrum API service over HTTP.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import axios from 'axios'
|
||||||
|
import wlogger from './wlogger.js'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
class FulcrumAPIAdapter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.config = localConfig.config || config
|
||||||
|
|
||||||
|
// Allow missing config for testing environments
|
||||||
|
if (!this.config.fulcrumApi || !this.config.fulcrumApi.baseUrl) {
|
||||||
|
if (process.env.NODE_ENV === 'test' || process.env.TEST) {
|
||||||
|
// In test environment, create a mock baseURL
|
||||||
|
this.config.fulcrumApi = {
|
||||||
|
baseUrl: 'http://localhost:50001',
|
||||||
|
timeoutMs: 15000
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw new Error('FULCRUM_API env var not set. Can not connect to Fulcrum indexer.')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const {
|
||||||
|
baseUrl,
|
||||||
|
timeoutMs = 15000
|
||||||
|
} = this.config.fulcrumApi
|
||||||
|
|
||||||
|
this.http = axios.create({
|
||||||
|
baseURL: baseUrl,
|
||||||
|
timeout: timeoutMs
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async get (path) {
|
||||||
|
try {
|
||||||
|
const response = await this.http.get(path)
|
||||||
|
return response.data
|
||||||
|
} catch (err) {
|
||||||
|
throw this._handleError(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async post (path, data) {
|
||||||
|
try {
|
||||||
|
const response = await this.http.post(path, data)
|
||||||
|
return response.data
|
||||||
|
} catch (err) {
|
||||||
|
throw this._handleError(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_handleError (err) {
|
||||||
|
const { status, message } = this.decodeError(err)
|
||||||
|
const error = new Error(message)
|
||||||
|
error.status = status
|
||||||
|
error.originalError = err
|
||||||
|
return error
|
||||||
|
}
|
||||||
|
|
||||||
|
decodeError (err) {
|
||||||
|
try {
|
||||||
|
// Attempt to extract error message from response data
|
||||||
|
if (err.response && err.response.data) {
|
||||||
|
const data = err.response.data
|
||||||
|
// Handle structured error responses
|
||||||
|
if (data.error) {
|
||||||
|
return this._formatError(data.error, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Handle string error messages
|
||||||
|
if (typeof data === 'string') {
|
||||||
|
return this._formatError(data, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Handle object responses that might contain error info
|
||||||
|
if (typeof data === 'object' && data.message) {
|
||||||
|
return this._formatError(data.message, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Fallback to returning the status
|
||||||
|
return this._formatError('Fulcrum API error', err.response.status || 500)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Network errors
|
||||||
|
if (err.message) {
|
||||||
|
if (err.message.includes('ENOTFOUND') || err.message.includes('ENETUNREACH') || err.message.includes('EAI_AGAIN')) {
|
||||||
|
return this._formatError(
|
||||||
|
'Network error: Could not communicate with Fulcrum API service.',
|
||||||
|
503
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.code && (err.code === 'ECONNABORTED' || err.code === 'ECONNREFUSED')) {
|
||||||
|
return this._formatError(
|
||||||
|
'Network error: Could not communicate with Fulcrum API service.',
|
||||||
|
503
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.error && typeof err.error === 'string' && err.error.includes('429')) {
|
||||||
|
return this._formatError('429 Too Many Requests', 429)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.message) {
|
||||||
|
return this._formatError(err.message, err.status || 422)
|
||||||
|
}
|
||||||
|
|
||||||
|
return this._formatError('Unhandled Fulcrum API error', 500)
|
||||||
|
} catch (decodeError) {
|
||||||
|
wlogger.error('Unhandled error in FulcrumAPIAdapter.decodeError()', decodeError)
|
||||||
|
return this._formatError('Internal server error', 500)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_formatError (message, status = 500) {
|
||||||
|
return {
|
||||||
|
message: message || 'Internal server error',
|
||||||
|
status: status || 500
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default FulcrumAPIAdapter
|
||||||
@@ -113,12 +113,8 @@ class FullNodeRPCAdapter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
validateArraySize (length, options = {}) {
|
validateArraySize (length) {
|
||||||
const { isProUser = false } = options
|
const limit = 20
|
||||||
const freemiumLimit = Number(this.config.fullNode?.freemiumArrayLimit || 20)
|
|
||||||
const proLimit = Number(this.config.fullNode?.proArrayLimit || freemiumLimit)
|
|
||||||
|
|
||||||
const limit = isProUser ? proLimit : freemiumLimit
|
|
||||||
return length <= limit
|
return length <= limit
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -7,6 +7,8 @@
|
|||||||
// Load individual adapter libraries.
|
// Load individual adapter libraries.
|
||||||
// import NostrRelayAdapter from './nostr-relay.js'
|
// import NostrRelayAdapter from './nostr-relay.js'
|
||||||
import FullNodeRPCAdapter from './full-node-rpc.js'
|
import FullNodeRPCAdapter from './full-node-rpc.js'
|
||||||
|
import FulcrumAPIAdapter from './fulcrum-api.js'
|
||||||
|
import SlpIndexerAPIAdapter from './slp-indexer-api.js'
|
||||||
import config from '../config/index.js'
|
import config from '../config/index.js'
|
||||||
|
|
||||||
class Adapters {
|
class Adapters {
|
||||||
@@ -33,6 +35,8 @@ class Adapters {
|
|||||||
// this.nostrRelay = this.nostrRelays[0]
|
// this.nostrRelay = this.nostrRelays[0]
|
||||||
|
|
||||||
this.fullNode = new FullNodeRPCAdapter({ config: this.config })
|
this.fullNode = new FullNodeRPCAdapter({ config: this.config })
|
||||||
|
this.fulcrum = new FulcrumAPIAdapter({ config: this.config })
|
||||||
|
this.slpIndexer = new SlpIndexerAPIAdapter({ config: this.config })
|
||||||
}
|
}
|
||||||
|
|
||||||
async start () {
|
async start () {
|
||||||
|
|||||||
@@ -0,0 +1,124 @@
|
|||||||
|
/*
|
||||||
|
Adapter library for interacting with SLP Indexer API service over HTTP.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import axios from 'axios'
|
||||||
|
import wlogger from './wlogger.js'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
class SlpIndexerAPIAdapter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.config = localConfig.config || config
|
||||||
|
|
||||||
|
// Allow missing config for testing environments
|
||||||
|
if (!this.config.slpIndexerApi || !this.config.slpIndexerApi.baseUrl) {
|
||||||
|
if (process.env.NODE_ENV === 'test' || process.env.TEST) {
|
||||||
|
// In test environment, create a mock baseURL
|
||||||
|
this.config.slpIndexerApi = {
|
||||||
|
baseUrl: 'http://localhost:5021',
|
||||||
|
timeoutMs: 15000
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw new Error('SLP_INDEXER_API env var not set. Can not connect to PSF SLP indexer.')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const {
|
||||||
|
baseUrl,
|
||||||
|
timeoutMs = 15000
|
||||||
|
} = this.config.slpIndexerApi
|
||||||
|
|
||||||
|
this.http = axios.create({
|
||||||
|
baseURL: baseUrl,
|
||||||
|
timeout: timeoutMs
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async get (path) {
|
||||||
|
try {
|
||||||
|
const response = await this.http.get(path)
|
||||||
|
return response.data
|
||||||
|
} catch (err) {
|
||||||
|
throw this._handleError(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async post (path, data) {
|
||||||
|
try {
|
||||||
|
const response = await this.http.post(path, data)
|
||||||
|
return response.data
|
||||||
|
} catch (err) {
|
||||||
|
throw this._handleError(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_handleError (err) {
|
||||||
|
const { status, message } = this.decodeError(err)
|
||||||
|
const error = new Error(message)
|
||||||
|
error.status = status
|
||||||
|
error.originalError = err
|
||||||
|
return error
|
||||||
|
}
|
||||||
|
|
||||||
|
decodeError (err) {
|
||||||
|
try {
|
||||||
|
// Attempt to extract error message from response data
|
||||||
|
if (err.response && err.response.data) {
|
||||||
|
const data = err.response.data
|
||||||
|
// Handle structured error responses
|
||||||
|
if (data.error) {
|
||||||
|
return this._formatError(data.error, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Handle string error messages
|
||||||
|
if (typeof data === 'string') {
|
||||||
|
return this._formatError(data, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Handle object responses that might contain error info
|
||||||
|
if (typeof data === 'object' && data.message) {
|
||||||
|
return this._formatError(data.message, err.response.status || 400)
|
||||||
|
}
|
||||||
|
// Fallback to returning the status
|
||||||
|
return this._formatError('SLP Indexer API error', err.response.status || 500)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Network errors
|
||||||
|
if (err.message) {
|
||||||
|
if (err.message.includes('ENOTFOUND') || err.message.includes('ENETUNREACH') || err.message.includes('EAI_AGAIN')) {
|
||||||
|
return this._formatError(
|
||||||
|
'Network error: Could not communicate with SLP Indexer API service.',
|
||||||
|
503
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.code && (err.code === 'ECONNABORTED' || err.code === 'ECONNREFUSED')) {
|
||||||
|
return this._formatError(
|
||||||
|
'Network error: Could not communicate with SLP Indexer API service.',
|
||||||
|
503
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.error && typeof err.error === 'string' && err.error.includes('429')) {
|
||||||
|
return this._formatError('429 Too Many Requests', 429)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (err.message) {
|
||||||
|
return this._formatError(err.message, err.status || 422)
|
||||||
|
}
|
||||||
|
|
||||||
|
return this._formatError('Unhandled SLP Indexer API error', 500)
|
||||||
|
} catch (decodeError) {
|
||||||
|
wlogger.error('Unhandled error in SlpIndexerAPIAdapter.decodeError()', decodeError)
|
||||||
|
return this._formatError('Internal server error', 500)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_formatError (message, status = 500) {
|
||||||
|
return {
|
||||||
|
message: message || 'Internal server error',
|
||||||
|
status: status || 500
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default SlpIndexerAPIAdapter
|
||||||
Vendored
+36
-27
@@ -16,6 +16,7 @@ const pkgInfo = JSON.parse(readFileSync(`${__dirname.toString()}/../../../packag
|
|||||||
|
|
||||||
const version = pkgInfo.version
|
const version = pkgInfo.version
|
||||||
|
|
||||||
|
// This function is used to convert the string input of an environment variable to a boolean value.
|
||||||
const normalizeBoolean = (value, defaultValue) => {
|
const normalizeBoolean = (value, defaultValue) => {
|
||||||
if (value === undefined || value === null || value === '') return defaultValue
|
if (value === undefined || value === null || value === '') return defaultValue
|
||||||
|
|
||||||
@@ -25,19 +26,31 @@ const normalizeBoolean = (value, defaultValue) => {
|
|||||||
return defaultValue
|
return defaultValue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// By default, the price per API call is 200 satoshis.
|
||||||
|
// But the user can override this value by setting the X402_PRICE_SAT environment variable.
|
||||||
const parsedPriceSat = Number(process.env.X402_PRICE_SAT)
|
const parsedPriceSat = Number(process.env.X402_PRICE_SAT)
|
||||||
const priceSat = Number.isFinite(parsedPriceSat) && parsedPriceSat > 0 ? parsedPriceSat : 2000
|
const priceSat = Number.isFinite(parsedPriceSat) && parsedPriceSat > 0 ? parsedPriceSat : 200
|
||||||
|
|
||||||
const x402Defaults = {
|
const x402Defaults = {
|
||||||
enabled: normalizeBoolean(process.env.X402_ENABLED, true),
|
enabled: normalizeBoolean(process.env.X402_ENABLED, true),
|
||||||
facilitatorUrl: process.env.FACILITATOR_URL || 'http://localhost:4345/facilitator',
|
facilitatorUrl: process.env.FACILITATOR_URL || 'http://localhost:4345/facilitator',
|
||||||
serverAddress: process.env.SERVER_BCH_ADDRESS || 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d',
|
serverAddress: process.env.SERVER_BCH_ADDRESS || 'bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr',
|
||||||
priceSat
|
priceSat
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const basicAuthDefaults = {
|
||||||
|
enabled: normalizeBoolean(process.env.USE_BASIC_AUTH, false),
|
||||||
|
token: process.env.BASIC_AUTH_TOKEN || ''
|
||||||
|
}
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
// Server port
|
// Server port
|
||||||
port: process.env.PORT || 5942,
|
port: parseInt(process.env.PORT, 10) || 5942,
|
||||||
|
|
||||||
|
// HTTP server connection lifecycle configuration.
|
||||||
|
serverKeepAliveTimeoutMs: Number(process.env.SERVER_KEEPALIVE_TIMEOUT_MS || 3000),
|
||||||
|
serverHeadersTimeoutMs: Number(process.env.SERVER_HEADERS_TIMEOUT_MS || 65000),
|
||||||
|
serverRequestTimeoutMs: Number(process.env.SERVER_REQUEST_TIMEOUT_MS || 120000),
|
||||||
|
|
||||||
// Environment
|
// Environment
|
||||||
env: process.env.NODE_ENV || 'development',
|
env: process.env.NODE_ENV || 'development',
|
||||||
@@ -48,30 +61,6 @@ export default {
|
|||||||
// Logging level
|
// Logging level
|
||||||
logLevel: process.env.LOG_LEVEL || 'info',
|
logLevel: process.env.LOG_LEVEL || 'info',
|
||||||
|
|
||||||
// Nostr relay configuration (array of relay URLs)
|
|
||||||
nostrRelayUrls: (() => {
|
|
||||||
// Support NOSTR_RELAY_URLS (plural) as comma-separated string or JSON array
|
|
||||||
if (process.env.NOSTR_RELAY_URLS) {
|
|
||||||
try {
|
|
||||||
// Try parsing as JSON array first
|
|
||||||
const parsed = JSON.parse(process.env.NOSTR_RELAY_URLS)
|
|
||||||
if (Array.isArray(parsed)) {
|
|
||||||
return parsed.filter(url => url && typeof url === 'string')
|
|
||||||
}
|
|
||||||
} catch (e) {
|
|
||||||
// Not JSON, treat as comma-separated string
|
|
||||||
return process.env.NOSTR_RELAY_URLS.split(',').map(url => url.trim()).filter(url => url.length > 0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Backward compatibility: support NOSTR_RELAY_URL (singular)
|
|
||||||
if (process.env.NOSTR_RELAY_URL) {
|
|
||||||
return [process.env.NOSTR_RELAY_URL]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Default
|
|
||||||
return ['wss://nostr-relay.psfoundation.info', 'wss://relay.damus.io']
|
|
||||||
})(),
|
|
||||||
|
|
||||||
// Full node RPC configuration
|
// Full node RPC configuration
|
||||||
fullNode: {
|
fullNode: {
|
||||||
rpcBaseUrl: process.env.RPC_BASEURL || 'http://127.0.0.1:8332',
|
rpcBaseUrl: process.env.RPC_BASEURL || 'http://127.0.0.1:8332',
|
||||||
@@ -81,8 +70,28 @@ export default {
|
|||||||
rpcRequestIdPrefix: process.env.RPC_REQUEST_ID_PREFIX || 'psf-bch-api'
|
rpcRequestIdPrefix: process.env.RPC_REQUEST_ID_PREFIX || 'psf-bch-api'
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// Fulcrum API configuration
|
||||||
|
fulcrumApi: {
|
||||||
|
baseUrl: process.env.FULCRUM_API || '',
|
||||||
|
timeoutMs: Number(process.env.FULCRUM_TIMEOUT_MS || 15000)
|
||||||
|
},
|
||||||
|
|
||||||
|
// SLP Indexer API configuration
|
||||||
|
slpIndexerApi: {
|
||||||
|
baseUrl: process.env.SLP_INDEXER_API || '',
|
||||||
|
timeoutMs: Number(process.env.SLP_INDEXER_TIMEOUT_MS || 15000)
|
||||||
|
},
|
||||||
|
|
||||||
|
// REST API URL for wallet operations
|
||||||
|
restURL: process.env.REST_URL || process.env.LOCAL_RESTURL || 'http://127.0.0.1:5942/v6/',
|
||||||
|
|
||||||
|
// IPFS Gateway URL
|
||||||
|
ipfsGateway: process.env.IPFS_GATEWAY || 'p2wdb-gateway-678.fullstack.cash',
|
||||||
|
|
||||||
x402: x402Defaults,
|
x402: x402Defaults,
|
||||||
|
|
||||||
|
basicAuth: basicAuthDefaults,
|
||||||
|
|
||||||
// Version
|
// Version
|
||||||
version
|
version
|
||||||
}
|
}
|
||||||
|
|||||||
+8
-1
@@ -26,7 +26,7 @@ export function buildX402Routes (apiPrefix = '/v6') {
|
|||||||
price: config.x402.priceSat,
|
price: config.x402.priceSat,
|
||||||
network: NETWORK,
|
network: NETWORK,
|
||||||
config: {
|
config: {
|
||||||
description: `${DEFAULT_DESCRIPTION} (2000 satoshis)`,
|
description: `${DEFAULT_DESCRIPTION} (${config.x402.priceSat} satoshis)`,
|
||||||
maxTimeoutSeconds: DEFAULT_TIMEOUT_SECONDS
|
maxTimeoutSeconds: DEFAULT_TIMEOUT_SECONDS
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -41,3 +41,10 @@ export function getX402Settings () {
|
|||||||
priceSat: config.x402?.priceSat
|
priceSat: config.x402?.priceSat
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function getBasicAuthSettings () {
|
||||||
|
return {
|
||||||
|
enabled: Boolean(config.basicAuth?.enabled),
|
||||||
|
token: config.basicAuth?.token || ''
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /encryption routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../adapters/wlogger.js'
|
||||||
|
|
||||||
|
class EncryptionRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Encryption REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.encryption) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Encryption use cases required when instantiating Encryption REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.encryptionUseCases = this.useCases.encryption
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.getPublicKey = this.getPublicKey.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/encryption/ Service status
|
||||||
|
* @apiName EncryptionRoot
|
||||||
|
* @apiGroup Encryption
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the encryption service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'encryption' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/encryption/publickey/:address Get public key for a BCH address
|
||||||
|
* @apiName GetPublicKey
|
||||||
|
* @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 hexadecimal representation of the public key.
|
||||||
|
*
|
||||||
|
* @apiParam {String} address BCH address (cash address or legacy format)
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
* @apiSuccess {Boolean} success Indicates if the operation was successful
|
||||||
|
* @apiSuccess {String} publicKey The public key in hexadecimal format, or "not found"
|
||||||
|
*/
|
||||||
|
async getPublicKey (req, res) {
|
||||||
|
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.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reject if address is missing
|
||||||
|
if (!address) {
|
||||||
|
res.status(400)
|
||||||
|
return res.json({
|
||||||
|
success: false,
|
||||||
|
error: 'address is required.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.encryptionUseCases.getPublicKey({ address })
|
||||||
|
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
wlogger.error('Error in EncryptionRESTController:', err)
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ success: false, error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default EncryptionRESTController
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /encryption routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import EncryptionRESTController from './controller.js'
|
||||||
|
|
||||||
|
class EncryptionRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Encryption REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating Encryption REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.encryptionController = new EncryptionRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/encryption`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.encryptionController.root)
|
||||||
|
this.router.get('/publickey/:address', this.encryptionController.getPublicKey)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default EncryptionRouter
|
||||||
@@ -0,0 +1,587 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /fulcrum routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../adapters/wlogger.js'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
import config from '../../../config/index.js'
|
||||||
|
|
||||||
|
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||||
|
|
||||||
|
class FulcrumRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Fulcrum REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.fulcrum) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Fulcrum use cases required when instantiating Fulcrum REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fulcrumUseCases = this.useCases.fulcrum
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.getBalance = this.getBalance.bind(this)
|
||||||
|
this.balanceBulk = this.balanceBulk.bind(this)
|
||||||
|
this.getUtxos = this.getUtxos.bind(this)
|
||||||
|
this.utxosBulk = this.utxosBulk.bind(this)
|
||||||
|
this.getTransactionDetails = this.getTransactionDetails.bind(this)
|
||||||
|
this.transactionDetailsBulk = this.transactionDetailsBulk.bind(this)
|
||||||
|
this.broadcastTransaction = this.broadcastTransaction.bind(this)
|
||||||
|
this.getBlockHeaders = this.getBlockHeaders.bind(this)
|
||||||
|
this.blockHeadersBulk = this.blockHeadersBulk.bind(this)
|
||||||
|
this.getTransactions = this.getTransactions.bind(this)
|
||||||
|
this.transactionsBulk = this.transactionsBulk.bind(this)
|
||||||
|
this.getMempool = this.getMempool.bind(this)
|
||||||
|
this.mempoolBulk = this.mempoolBulk.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/ Service status
|
||||||
|
* @apiName FulcrumRoot
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the fulcrum service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'fulcrum' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates and converts an address to cash address format
|
||||||
|
* @param {string} address - Address to validate and convert
|
||||||
|
* @returns {string} Cash address
|
||||||
|
* @throws {Error} If address is invalid or not mainnet
|
||||||
|
*/
|
||||||
|
_validateAndConvertAddress (address) {
|
||||||
|
if (!address) {
|
||||||
|
throw new Error('address is empty')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert legacy to cash address
|
||||||
|
const cashAddr = bchjs.Address.toCashAddress(address)
|
||||||
|
|
||||||
|
// Ensure it's a valid BCH address
|
||||||
|
try {
|
||||||
|
bchjs.Address.toLegacyAddress(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
throw new Error(`Invalid BCH address. Double check your address is valid: ${address}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure it's mainnet (no testnet support)
|
||||||
|
const isMainnet = bchjs.Address.isMainnetAddress(cashAddr)
|
||||||
|
if (!isMainnet) {
|
||||||
|
throw new Error('Invalid network. Only mainnet addresses are supported.')
|
||||||
|
}
|
||||||
|
|
||||||
|
return cashAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/balance/:address Get balance for a single address
|
||||||
|
* @apiName GetBalance
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an object with confirmed and unconfirmed balance associated with an address.
|
||||||
|
*/
|
||||||
|
async getBalance (req, res) {
|
||||||
|
try {
|
||||||
|
const address = req.params.address
|
||||||
|
|
||||||
|
if (Array.isArray(address)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be an array. Use POST for bulk upload.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const cashAddr = this._validateAndConvertAddress(address)
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getBalance({ address: cashAddr })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/balance Get balances for an array of addresses
|
||||||
|
* @apiName GetBalances
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of balances associated with an array of addresses. Limited to 20 items per request.
|
||||||
|
*/
|
||||||
|
async balanceBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const addresses = req.body.addresses
|
||||||
|
|
||||||
|
if (!Array.isArray(addresses)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'addresses needs to be an array. Use GET for single address.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(addresses.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate and convert all addresses
|
||||||
|
const validatedAddresses = []
|
||||||
|
for (let i = 0; i < addresses.length; i++) {
|
||||||
|
try {
|
||||||
|
const cashAddr = this._validateAndConvertAddress(addresses[i])
|
||||||
|
validatedAddresses.push(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: err.message
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getBalances({ addresses: validatedAddresses })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/utxos/:address Get utxos for a single address
|
||||||
|
* @apiName GetUtxos
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an object with UTXOs associated with an address.
|
||||||
|
*/
|
||||||
|
async getUtxos (req, res) {
|
||||||
|
try {
|
||||||
|
const address = req.params.address
|
||||||
|
|
||||||
|
if (Array.isArray(address)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be an array. Use POST for bulk upload.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const cashAddr = this._validateAndConvertAddress(address)
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getUtxos({ address: cashAddr })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/utxos Get utxos for an array of addresses
|
||||||
|
* @apiName GetUtxosBulk
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of objects with UTXOs associated with an address. Limited to 20 items per request.
|
||||||
|
*/
|
||||||
|
async utxosBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const addresses = req.body.addresses
|
||||||
|
|
||||||
|
if (!Array.isArray(addresses)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'addresses needs to be an array. Use GET for single address.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(addresses.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate and convert all addresses
|
||||||
|
const validatedAddresses = []
|
||||||
|
for (let i = 0; i < addresses.length; i++) {
|
||||||
|
try {
|
||||||
|
const cashAddr = this._validateAndConvertAddress(addresses[i])
|
||||||
|
validatedAddresses.push(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: err.message
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getUtxosBulk({ addresses: validatedAddresses })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/tx/data/:txid Get transaction details for a TXID
|
||||||
|
* @apiName GetTransactionDetails
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an object with transaction details of the TXID
|
||||||
|
*/
|
||||||
|
async getTransactionDetails (req, res) {
|
||||||
|
try {
|
||||||
|
const txid = req.params.txid
|
||||||
|
|
||||||
|
if (typeof txid !== 'string') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'txid must be a string'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getTransactionDetails({ txid })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/tx/data Get transaction details for an array of TXIDs
|
||||||
|
* @apiName GetTransactionDetailsBulk
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of objects with transaction details of an array of TXIDs. Limited to 20 items per request.
|
||||||
|
*/
|
||||||
|
async transactionDetailsBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const txids = req.body.txids
|
||||||
|
const verbose = req.body.verbose !== undefined ? req.body.verbose : true
|
||||||
|
|
||||||
|
if (!Array.isArray(txids)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'txids needs to be an array. Use GET for single txid.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(txids.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getTransactionDetailsBulk({ txids, verbose })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/tx/broadcast Broadcast a raw transaction
|
||||||
|
* @apiName BroadcastTransaction
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Broadcast a raw transaction and return the transaction ID on success or error on failure.
|
||||||
|
*/
|
||||||
|
async broadcastTransaction (req, res) {
|
||||||
|
try {
|
||||||
|
const txHex = req.body.txHex
|
||||||
|
|
||||||
|
if (typeof txHex !== 'string') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'txHex must be a string'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.broadcastTransaction({ txHex })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/block/headers/:height Get block headers
|
||||||
|
* @apiName GetBlockHeaders
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array with block headers starting at the block height
|
||||||
|
*
|
||||||
|
* @apiParam {Number} height Block height
|
||||||
|
* @apiParam {Number} count Number of block headers to return (query parameter, default: 1)
|
||||||
|
*/
|
||||||
|
async getBlockHeaders (req, res) {
|
||||||
|
try {
|
||||||
|
const heightRaw = req.params.height
|
||||||
|
const countRaw = req.query.count
|
||||||
|
|
||||||
|
const height = Number(heightRaw)
|
||||||
|
const count = countRaw === undefined ? 1 : Number(countRaw)
|
||||||
|
|
||||||
|
if (Number.isNaN(height) || height < 0) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'height must be a positive number'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Number.isNaN(count) || count < 0) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'count must be a positive number'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getBlockHeaders({ height, count })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/block/headers Get block headers for an array of height + count pairs
|
||||||
|
* @apiName GetBlockHeadersBulk
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of objects with block headers. Limited to 20 items per request.
|
||||||
|
*/
|
||||||
|
async blockHeadersBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const heights = req.body.heights
|
||||||
|
|
||||||
|
if (!Array.isArray(heights)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'heights needs to be an array. Use GET for single height.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(heights.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each height object
|
||||||
|
for (const item of heights) {
|
||||||
|
if (!item || typeof item.height !== 'number' || typeof item.count !== 'number') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Each height object must have numeric height and count properties'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if (item.height < 0 || item.count < 0) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'height and count must be positive numbers'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getBlockHeadersBulk({ heights })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/transactions/:address Get transaction history for a single address
|
||||||
|
* @apiName GetTransactions
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of historical transactions associated with an address. Results are returned in descending order (most recent TX first). Passing allTxs=true will return the entire transaction history, otherwise, only the last 100 TXIDs will be returned.
|
||||||
|
*
|
||||||
|
* @apiParam {String} address Address
|
||||||
|
* @apiParam {Boolean} allTxs Optional: return all transactions (default: false, limited to 100)
|
||||||
|
*/
|
||||||
|
async getTransactions (req, res) {
|
||||||
|
try {
|
||||||
|
const address = req.params.address
|
||||||
|
let allTxs = false
|
||||||
|
|
||||||
|
// Check if allTxs is in params or query
|
||||||
|
if (req.params.allTxs) {
|
||||||
|
allTxs = req.params.allTxs === 'true'
|
||||||
|
} else if (req.query.allTxs) {
|
||||||
|
allTxs = req.query.allTxs === 'true'
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(address)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be an array. Use POST for bulk upload.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const cashAddr = this._validateAndConvertAddress(address)
|
||||||
|
|
||||||
|
// Extract bearer token from request header if present
|
||||||
|
let bearerToken = null
|
||||||
|
if (req.headers && req.headers.authorization) {
|
||||||
|
const parts = req.headers.authorization.split(' ')
|
||||||
|
if (parts.length === 2 && parts[0] === 'Bearer') {
|
||||||
|
bearerToken = parts[1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getTransactions({
|
||||||
|
address: cashAddr,
|
||||||
|
allTxs,
|
||||||
|
bearerToken
|
||||||
|
})
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/transactions Get the transaction history for an array of addresses
|
||||||
|
* @apiName GetTransactionsBulk
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of transactions associated with an array of addresses. Limited to 20 items per request. Passing allTxs=true will return the entire transaction history, otherwise, only the last 100 TXIDs will be returned.
|
||||||
|
*/
|
||||||
|
async transactionsBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const addresses = req.body.addresses
|
||||||
|
const allTxs = req.body.allTxs === true
|
||||||
|
|
||||||
|
if (!Array.isArray(addresses)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'addresses needs to be an array. Use GET for single address.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(addresses.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate and convert all addresses
|
||||||
|
const validatedAddresses = []
|
||||||
|
for (let i = 0; i < addresses.length; i++) {
|
||||||
|
try {
|
||||||
|
const cashAddr = this._validateAndConvertAddress(addresses[i])
|
||||||
|
validatedAddresses.push(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: err.message
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract bearer token from request header if present
|
||||||
|
let bearerToken = null
|
||||||
|
if (req.headers && req.headers.authorization) {
|
||||||
|
const parts = req.headers.authorization.split(' ')
|
||||||
|
if (parts.length === 2 && parts[0] === 'Bearer') {
|
||||||
|
bearerToken = parts[1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getTransactionsBulk({
|
||||||
|
addresses: validatedAddresses,
|
||||||
|
allTxs,
|
||||||
|
bearerToken
|
||||||
|
})
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/fulcrum/unconfirmed/:address Get unconfirmed utxos for a single address
|
||||||
|
* @apiName GetMempool
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an object with unconfirmed UTXOs associated with an address.
|
||||||
|
*/
|
||||||
|
async getMempool (req, res) {
|
||||||
|
try {
|
||||||
|
const address = req.params.address
|
||||||
|
|
||||||
|
if (Array.isArray(address)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be an array. Use POST for bulk upload.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const cashAddr = this._validateAndConvertAddress(address)
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getMempool({ address: cashAddr })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/fulcrum/unconfirmed Get unconfirmed utxos for an array of addresses
|
||||||
|
* @apiName GetMempoolBulk
|
||||||
|
* @apiGroup Fulcrum
|
||||||
|
* @apiDescription Returns an array of objects with unconfirmed UTXOs associated with an address. Limited to 20 items per request.
|
||||||
|
*/
|
||||||
|
async mempoolBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const addresses = req.body.addresses
|
||||||
|
|
||||||
|
if (!Array.isArray(addresses)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'addresses needs to be an array. Use GET for single address.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(addresses.length)) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'Array too large.'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate and convert all addresses
|
||||||
|
const validatedAddresses = []
|
||||||
|
for (let i = 0; i < addresses.length; i++) {
|
||||||
|
try {
|
||||||
|
const cashAddr = this._validateAndConvertAddress(addresses[i])
|
||||||
|
validatedAddresses.push(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: err.message
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.fulcrumUseCases.getMempoolBulk({ addresses: validatedAddresses })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
wlogger.error('Error in FulcrumRESTController:', err)
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default FulcrumRESTController
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /full-node/fulcrum routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import FulcrumRESTController from './controller.js'
|
||||||
|
|
||||||
|
class FulcrumRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Fulcrum REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating Fulcrum REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fulcrumController = new FulcrumRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/fulcrum`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.fulcrumController.root)
|
||||||
|
this.router.get('/balance/:address', this.fulcrumController.getBalance)
|
||||||
|
this.router.post('/balance', this.fulcrumController.balanceBulk)
|
||||||
|
this.router.get('/utxos/:address', this.fulcrumController.getUtxos)
|
||||||
|
this.router.post('/utxos', this.fulcrumController.utxosBulk)
|
||||||
|
this.router.get('/tx/data/:txid', this.fulcrumController.getTransactionDetails)
|
||||||
|
this.router.post('/tx/data', this.fulcrumController.transactionDetailsBulk)
|
||||||
|
this.router.post('/tx/broadcast', this.fulcrumController.broadcastTransaction)
|
||||||
|
this.router.get('/block/headers/:height', this.fulcrumController.getBlockHeaders)
|
||||||
|
this.router.post('/block/headers', this.fulcrumController.blockHeadersBulk)
|
||||||
|
this.router.get('/transactions/:address', this.fulcrumController.getTransactions)
|
||||||
|
this.router.get('/transactions/:address/:allTxs', this.fulcrumController.getTransactions)
|
||||||
|
this.router.post('/transactions', this.fulcrumController.transactionsBulk)
|
||||||
|
this.router.get('/unconfirmed/:address', this.fulcrumController.getMempool)
|
||||||
|
this.router.post('/unconfirmed', this.fulcrumController.mempoolBulk)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default FulcrumRouter
|
||||||
@@ -155,7 +155,7 @@ class BlockchainRESTController {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.adapters.fullNode.validateArraySize(hashes.length, { isProUser: Boolean(req.locals?.proLimit) })) {
|
if (!this.adapters.fullNode.validateArraySize(hashes.length)) {
|
||||||
return res.status(400).json({ error: 'Array too large.' })
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -238,7 +238,7 @@ class BlockchainRESTController {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.adapters.fullNode.validateArraySize(txids.length, { isProUser: Boolean(req.locals?.proLimit) })) {
|
if (!this.adapters.fullNode.validateArraySize(txids.length)) {
|
||||||
return res.status(400).json({ error: 'Array too large.' })
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -415,7 +415,7 @@ class BlockchainRESTController {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.adapters.fullNode.validateArraySize(txids.length, { isProUser: Boolean(req.locals?.proLimit) })) {
|
if (!this.adapters.fullNode.validateArraySize(txids.length)) {
|
||||||
return res.status(400).json({ error: 'Array too large.' })
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -470,7 +470,7 @@ class BlockchainRESTController {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.adapters.fullNode.validateArraySize(proofs.length, { isProUser: Boolean(req.locals?.proLimit) })) {
|
if (!this.adapters.fullNode.validateArraySize(proofs.length)) {
|
||||||
return res.status(400).json({ error: 'Array too large.' })
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,99 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /full-node/mining routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../../adapters/wlogger.js'
|
||||||
|
|
||||||
|
class MiningRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Mining REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.mining) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Mining use cases required when instantiating Mining REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.miningUseCases = this.useCases.mining
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.getMiningInfo = this.getMiningInfo.bind(this)
|
||||||
|
this.getNetworkHashPS = this.getNetworkHashPS.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/mining/ Service status
|
||||||
|
* @apiName MiningRoot
|
||||||
|
* @apiGroup Mining
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the mining service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'mining' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/mining/getMiningInfo Get Mining Info
|
||||||
|
* @apiName GetMiningInfo
|
||||||
|
* @apiGroup Mining
|
||||||
|
* @apiDescription Returns a json object containing mining-related information.
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/mining/getMiningInfo" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async getMiningInfo (req, res) {
|
||||||
|
try {
|
||||||
|
const result = await this.miningUseCases.getMiningInfo()
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/mining/getNetworkHashPS Get Estimated network hashes per second
|
||||||
|
* @apiName GetNetworkHashPS
|
||||||
|
* @apiGroup Mining
|
||||||
|
* @apiDescription Returns the estimated network hashes per second based on the last n blocks. Pass in [nblocks] 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.
|
||||||
|
*
|
||||||
|
* @apiParam {Number} nblocks Number of blocks to use for estimation (default: 120)
|
||||||
|
* @apiParam {Number} height Block height to estimate at (default: -1)
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/mining/getNetworkHashPS?nblocks=120&height=-1" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async getNetworkHashPS (req, res) {
|
||||||
|
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 result = await this.miningUseCases.getNetworkHashPS({ nblocks, height })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
wlogger.error('Error in MiningRESTController:', err)
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default MiningRESTController
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /full-node/mining routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import MiningRESTController from './controller.js'
|
||||||
|
|
||||||
|
class MiningRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Mining REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating Mining REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.miningController = new MiningRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/full-node/mining`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.miningController.root)
|
||||||
|
this.router.get('/getMiningInfo', this.miningController.getMiningInfo)
|
||||||
|
this.router.get('/getNetworkHashPS', this.miningController.getNetworkHashPS)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default MiningRouter
|
||||||
@@ -0,0 +1,333 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /full-node/rawtransactions routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../../adapters/wlogger.js'
|
||||||
|
|
||||||
|
class RawTransactionsRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating RawTransactions REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.rawtransactions) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of RawTransactions use cases required when instantiating RawTransactions REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.rawtransactionsUseCases = this.useCases.rawtransactions
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.decodeRawTransactionSingle = this.decodeRawTransactionSingle.bind(this)
|
||||||
|
this.decodeRawTransactionBulk = this.decodeRawTransactionBulk.bind(this)
|
||||||
|
this.decodeScriptSingle = this.decodeScriptSingle.bind(this)
|
||||||
|
this.decodeScriptBulk = this.decodeScriptBulk.bind(this)
|
||||||
|
this.getRawTransactionSingle = this.getRawTransactionSingle.bind(this)
|
||||||
|
this.getRawTransactionBulk = this.getRawTransactionBulk.bind(this)
|
||||||
|
this.sendRawTransactionSingle = this.sendRawTransactionSingle.bind(this)
|
||||||
|
this.sendRawTransactionBulk = this.sendRawTransactionBulk.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/rawtransactions/ Service status
|
||||||
|
* @apiName RawTransactionsRoot
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the rawtransactions service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'rawtransactions' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/rawtransactions/decodeRawTransaction/:hex Decode Single Raw Transaction
|
||||||
|
* @apiName DecodeSingleRawTransaction
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Return a JSON object representing the serialized, hex-encoded transaction.
|
||||||
|
*
|
||||||
|
* @apiParam {String} hex Hex-encoded transaction
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/rawtransactions/decodeRawTransaction/02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async decodeRawTransactionSingle (req, res) {
|
||||||
|
try {
|
||||||
|
const hex = req.params.hex
|
||||||
|
|
||||||
|
if (!hex || hex === '') {
|
||||||
|
return res.status(400).json({ error: 'hex can not be empty' })
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.decodeRawTransaction({ hex })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/full-node/rawtransactions/decodeRawTransaction Decode Bulk Raw Transactions
|
||||||
|
* @apiName DecodeBulkRawTransactions
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Return bulk hex encoded transaction.
|
||||||
|
*
|
||||||
|
* @apiParam {String[]} hexes Array of hex-encoded transactions
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v6/full-node/rawtransactions/decodeRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
|
*/
|
||||||
|
async decodeRawTransactionBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const hexes = req.body.hexes
|
||||||
|
|
||||||
|
if (!Array.isArray(hexes)) {
|
||||||
|
return res.status(400).json({ error: 'hexes must be an array' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(hexes.length)) {
|
||||||
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each element in the array
|
||||||
|
for (const hex of hexes) {
|
||||||
|
if (!hex || hex === '') {
|
||||||
|
return res.status(400).json({ error: 'Encountered empty hex' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.decodeRawTransactions({ hexes })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/rawtransactions/decodeScript/:hex Decode Single Script
|
||||||
|
* @apiName DecodeSingleScript
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Decode a hex-encoded script.
|
||||||
|
*
|
||||||
|
* @apiParam {String} hex Hex-encoded script
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/rawtransactions/decodeScript/4830450221009a51e00ec3524a7389592bc27bea4af5104a59510f5f0cfafa64bbd5c164ca2e02206c2a8bbb47eabdeed52f17d7df668d521600286406930426e3a9415fe10ed592012102e6e1423f7abde8b70bca3e78a7d030e5efabd3eb35c19302542b5fe7879c1a16" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async decodeScriptSingle (req, res) {
|
||||||
|
try {
|
||||||
|
const hex = req.params.hex
|
||||||
|
|
||||||
|
if (!hex || hex === '') {
|
||||||
|
return res.status(400).json({ error: 'hex can not be empty' })
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.decodeScript({ hex })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/full-node/rawtransactions/decodeScript Bulk Decode Script
|
||||||
|
* @apiName DecodeBulkScript
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Decode multiple hex-encoded scripts.
|
||||||
|
*
|
||||||
|
* @apiParam {String[]} hexes Array of hex-encoded scripts
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v6/full-node/rawtransactions/decodeScript" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
|
*/
|
||||||
|
async decodeScriptBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const hexes = req.body.hexes
|
||||||
|
|
||||||
|
if (!Array.isArray(hexes)) {
|
||||||
|
return res.status(400).json({ error: 'hexes must be an array' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(hexes.length)) {
|
||||||
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each hex in the array
|
||||||
|
for (const hex of hexes) {
|
||||||
|
if (!hex || hex === '') {
|
||||||
|
return res.status(400).json({ error: 'Encountered empty hex' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.decodeScripts({ hexes })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/rawtransactions/getRawTransaction/:txid Get Raw Transaction
|
||||||
|
* @apiName GetRawTransaction
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @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'.
|
||||||
|
*
|
||||||
|
* @apiParam {String} txid Transaction ID
|
||||||
|
* @apiParam {Boolean} verbose Return verbose data (default false)
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/rawtransactions/getRawTransaction/fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33?verbose=true" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async getRawTransactionSingle (req, res) {
|
||||||
|
try {
|
||||||
|
const txid = req.params.txid
|
||||||
|
const verbose = req.query.verbose === 'true'
|
||||||
|
|
||||||
|
if (!txid || txid === '') {
|
||||||
|
return res.status(400).json({ error: 'txid can not be empty' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (txid.length !== 64) {
|
||||||
|
return res.status(400).json({
|
||||||
|
error: `parameter 1 must be of length 64 (not ${txid.length})`
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.getRawTransactionWithHeight({ txid, verbose })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/full-node/rawtransactions/getRawTransaction Get Bulk Raw Transactions
|
||||||
|
* @apiName GetBulkRawTransactions
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @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'.
|
||||||
|
*
|
||||||
|
* @apiParam {String[]} txids Array of transaction IDs
|
||||||
|
* @apiParam {Boolean} verbose Return verbose data (default false)
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v6/full-node/rawtransactions/getRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"txids":["a5f972572ee1753e2fd2457dd61ce5f40fa2f8a30173d417e49feef7542c96a1","5165dc531aad05d1149bb0f0d9b7bda99c73e2f05e314bcfb5b4bb9ca5e1af5e"],"verbose":true}'
|
||||||
|
*/
|
||||||
|
async getRawTransactionBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const txids = req.body.txids
|
||||||
|
const verbose = !!req.body.verbose
|
||||||
|
|
||||||
|
if (!Array.isArray(txids)) {
|
||||||
|
return res.status(400).json({ error: 'txids must be an array' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(txids.length)) {
|
||||||
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each txid in the array
|
||||||
|
for (const txid of txids) {
|
||||||
|
if (!txid || txid === '') {
|
||||||
|
return res.status(400).json({ error: 'Encountered empty TXID' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (txid.length !== 64) {
|
||||||
|
return res.status(400).json({
|
||||||
|
error: `parameter 1 must be of length 64 (not ${txid.length})`
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.getRawTransactions({ txids, verbose })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/full-node/rawtransactions/sendRawTransaction/:hex Send Single Raw Transaction
|
||||||
|
* @apiName SendSingleRawTransaction
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Submits single raw transaction (serialized, hex-encoded) to local node and network.
|
||||||
|
*
|
||||||
|
* @apiParam {String} hex Hex-encoded transaction
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/full-node/rawtransactions/sendRawTransaction/01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000" -H "accept: application/json"
|
||||||
|
*/
|
||||||
|
async sendRawTransactionSingle (req, res) {
|
||||||
|
try {
|
||||||
|
const hex = req.params.hex
|
||||||
|
|
||||||
|
if (typeof hex !== 'string') {
|
||||||
|
return res.status(400).json({ error: 'hex must be a string' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hex === '') {
|
||||||
|
return res.status(400).json({ error: 'Encountered empty hex' })
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.sendRawTransaction({ hex })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/full-node/rawtransactions/sendRawTransaction Send Bulk Raw Transactions
|
||||||
|
* @apiName SendBulkRawTransactions
|
||||||
|
* @apiGroup RawTransactions
|
||||||
|
* @apiDescription Submits multiple raw transaction (serialized, hex-encoded) to local node and network.
|
||||||
|
*
|
||||||
|
* @apiParam {String[]} hexes Array of hex-encoded transactions
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X POST "https://api.fullstack.cash/v6/full-node/rawtransactions/sendRawTransaction" -H "accept: application/json" -H "Content-Type: application/json" -d '{"hexes":["01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"]}'
|
||||||
|
*/
|
||||||
|
async sendRawTransactionBulk (req, res) {
|
||||||
|
try {
|
||||||
|
const hexes = req.body.hexes
|
||||||
|
|
||||||
|
if (!Array.isArray(hexes)) {
|
||||||
|
return res.status(400).json({ error: 'hex must be an array' })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.adapters.fullNode.validateArraySize(hexes.length)) {
|
||||||
|
return res.status(400).json({ error: 'Array too large.' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each element
|
||||||
|
for (const hex of hexes) {
|
||||||
|
if (hex === '') {
|
||||||
|
return res.status(400).json({ error: 'Encountered empty hex' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.rawtransactionsUseCases.sendRawTransactions({ hexes })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
wlogger.error('Error in RawTransactionsRESTController:', err)
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default RawTransactionsRESTController
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /full-node/rawtransactions routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import RawTransactionsRESTController from './controller.js'
|
||||||
|
|
||||||
|
class RawTransactionsRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating RawTransactions REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating RawTransactions REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.rawtransactionsController = new RawTransactionsRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/full-node/rawtransactions`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.rawtransactionsController.root)
|
||||||
|
this.router.get('/decodeRawTransaction/:hex', this.rawtransactionsController.decodeRawTransactionSingle)
|
||||||
|
this.router.post('/decodeRawTransaction', this.rawtransactionsController.decodeRawTransactionBulk)
|
||||||
|
this.router.get('/decodeScript/:hex', this.rawtransactionsController.decodeScriptSingle)
|
||||||
|
this.router.post('/decodeScript', this.rawtransactionsController.decodeScriptBulk)
|
||||||
|
this.router.get('/getRawTransaction/:txid', this.rawtransactionsController.getRawTransactionSingle)
|
||||||
|
this.router.post('/getRawTransaction', this.rawtransactionsController.getRawTransactionBulk)
|
||||||
|
this.router.get('/sendRawTransaction/:hex', this.rawtransactionsController.sendRawTransactionSingle)
|
||||||
|
this.router.post('/sendRawTransaction', this.rawtransactionsController.sendRawTransactionBulk)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default RawTransactionsRouter
|
||||||
@@ -7,9 +7,15 @@
|
|||||||
// Local libraries
|
// Local libraries
|
||||||
// import EventRouter from './event/index.js'
|
// import EventRouter from './event/index.js'
|
||||||
// import ReqRouter from './req/index.js'
|
// import ReqRouter from './req/index.js'
|
||||||
import BlockchainRouter from './full-node/blockchain/index.js'
|
import BlockchainRouter from './full-node/blockchain/router.js'
|
||||||
import ControlRouter from './full-node/control/index.js'
|
import ControlRouter from './full-node/control/router.js'
|
||||||
import DSProofRouter from './full-node/dsproof/index.js'
|
import DSProofRouter from './full-node/dsproof/router.js'
|
||||||
|
import EncryptionRouter from './encryption/router.js'
|
||||||
|
import FulcrumRouter from './fulcrum/router.js'
|
||||||
|
import MiningRouter from './full-node/mining/router.js'
|
||||||
|
import PriceRouter from './price/router.js'
|
||||||
|
import RawTransactionsRouter from './full-node/rawtransactions/router.js'
|
||||||
|
import SlpRouter from './slp/router.js'
|
||||||
import config from '../../config/index.js'
|
import config from '../../config/index.js'
|
||||||
|
|
||||||
class RESTControllers {
|
class RESTControllers {
|
||||||
@@ -64,6 +70,24 @@ class RESTControllers {
|
|||||||
|
|
||||||
const dsproofRouter = new DSProofRouter(dependencies)
|
const dsproofRouter = new DSProofRouter(dependencies)
|
||||||
dsproofRouter.attach(app)
|
dsproofRouter.attach(app)
|
||||||
|
|
||||||
|
const encryptionRouter = new EncryptionRouter(dependencies)
|
||||||
|
encryptionRouter.attach(app)
|
||||||
|
|
||||||
|
const fulcrumRouter = new FulcrumRouter(dependencies)
|
||||||
|
fulcrumRouter.attach(app)
|
||||||
|
|
||||||
|
const miningRouter = new MiningRouter(dependencies)
|
||||||
|
miningRouter.attach(app)
|
||||||
|
|
||||||
|
const priceRouter = new PriceRouter(dependencies)
|
||||||
|
priceRouter.attach(app)
|
||||||
|
|
||||||
|
const rawtransactionsRouter = new RawTransactionsRouter(dependencies)
|
||||||
|
rawtransactionsRouter.attach(app)
|
||||||
|
|
||||||
|
const slpRouter = new SlpRouter(dependencies)
|
||||||
|
slpRouter.attach(app)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,96 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /price routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../adapters/wlogger.js'
|
||||||
|
|
||||||
|
class PriceRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Price REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.price) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Price use cases required when instantiating Price REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.priceUseCases = this.useCases.price
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.getBCHUSD = this.getBCHUSD.bind(this)
|
||||||
|
this.getPsffppWritePrice = this.getPsffppWritePrice.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/price/ Service status
|
||||||
|
* @apiName PriceRoot
|
||||||
|
* @apiGroup Price
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the price service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'price' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/price/bchusd Get the USD price of BCH
|
||||||
|
* @apiName GetBCHUSD
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the USD price of BCH from Coinex.
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/price/bchusd" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
* @apiSuccess {Number} usd The USD price of BCH
|
||||||
|
*/
|
||||||
|
async getBCHUSD (req, res) {
|
||||||
|
try {
|
||||||
|
const price = await this.priceUseCases.getBCHUSD()
|
||||||
|
return res.status(200).json({ usd: price })
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/price/psffpp Get the PSF price for writing to the PSFFPP
|
||||||
|
* @apiName GetPsffppWritePrice
|
||||||
|
* @apiGroup Price
|
||||||
|
* @apiDescription Get the price to pin 1MB of content to the PSFFPP pinning
|
||||||
|
* network on IPFS. The price is denominated in PSF tokens.
|
||||||
|
*
|
||||||
|
* @apiExample Example usage:
|
||||||
|
* curl -X GET "https://api.fullstack.cash/v6/price/psffpp" -H "accept: application/json"
|
||||||
|
*
|
||||||
|
* @apiSuccess {Number} writePrice The price in PSF tokens to write 1MB to PSFFPP
|
||||||
|
*/
|
||||||
|
async getPsffppWritePrice (req, res) {
|
||||||
|
try {
|
||||||
|
const writePrice = await this.priceUseCases.getPsffppWritePrice()
|
||||||
|
return res.status(200).json({ writePrice })
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
wlogger.error('Error in PriceRESTController:', err)
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PriceRESTController
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /price routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import PriceRESTController from './controller.js'
|
||||||
|
|
||||||
|
class PriceRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating Price REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating Price REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.priceController = new PriceRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/price`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.priceController.root)
|
||||||
|
this.router.get('/bchusd', this.priceController.getBCHUSD)
|
||||||
|
this.router.get('/psffpp', this.priceController.getPsffppWritePrice)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PriceRouter
|
||||||
@@ -0,0 +1,227 @@
|
|||||||
|
/*
|
||||||
|
REST API Controller for the /slp routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../../../adapters/wlogger.js'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
import config from '../../../config/index.js'
|
||||||
|
|
||||||
|
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||||
|
|
||||||
|
class SlpRESTController {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating SLP REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases || !this.useCases.slp) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of SLP use cases required when instantiating SLP REST Controller.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.slpUseCases = this.useCases.slp
|
||||||
|
|
||||||
|
// Bind functions
|
||||||
|
this.root = this.root.bind(this)
|
||||||
|
this.getStatus = this.getStatus.bind(this)
|
||||||
|
this.getAddress = this.getAddress.bind(this)
|
||||||
|
this.getTxid = this.getTxid.bind(this)
|
||||||
|
this.getTokenStats = this.getTokenStats.bind(this)
|
||||||
|
this.getTokenData = this.getTokenData.bind(this)
|
||||||
|
this.handleError = this.handleError.bind(this)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/slp/ Service status
|
||||||
|
* @apiName SlpRoot
|
||||||
|
* @apiGroup SLP
|
||||||
|
*
|
||||||
|
* @apiDescription Returns the status of the SLP service.
|
||||||
|
*
|
||||||
|
* @apiSuccess {String} status Service identifier
|
||||||
|
*/
|
||||||
|
async root (req, res) {
|
||||||
|
return res.status(200).json({ status: 'psf-slp-indexer' })
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates and converts an address to cash address format
|
||||||
|
* @param {string} address - Address to validate and convert
|
||||||
|
* @returns {string} Cash address
|
||||||
|
* @throws {Error} If address is invalid or not mainnet
|
||||||
|
*/
|
||||||
|
_validateAndConvertAddress (address) {
|
||||||
|
if (!address) {
|
||||||
|
throw new Error('address is empty')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert legacy to cash address
|
||||||
|
const cashAddr = bchjs.SLP.Address.toCashAddress(address)
|
||||||
|
|
||||||
|
// Ensure it's a valid BCH address
|
||||||
|
try {
|
||||||
|
bchjs.SLP.Address.toLegacyAddress(cashAddr)
|
||||||
|
} catch (err) {
|
||||||
|
throw new Error(`Invalid BCH address. Double check your address is valid: ${address}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure it's mainnet (no testnet support)
|
||||||
|
const isMainnet = bchjs.Address.isMainnetAddress(cashAddr)
|
||||||
|
if (!isMainnet) {
|
||||||
|
throw new Error('Invalid network. Only mainnet addresses are supported.')
|
||||||
|
}
|
||||||
|
|
||||||
|
return cashAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /v6/slp/status Get indexer status
|
||||||
|
* @apiName GetStatus
|
||||||
|
* @apiGroup SLP
|
||||||
|
* @apiDescription Returns the status of the SLP indexer.
|
||||||
|
*/
|
||||||
|
async getStatus (req, res) {
|
||||||
|
try {
|
||||||
|
const result = await this.slpUseCases.getStatus()
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/slp/address Get SLP balance for address
|
||||||
|
* @apiName GetAddress
|
||||||
|
* @apiGroup SLP
|
||||||
|
* @apiDescription Returns SLP balance for an address.
|
||||||
|
*/
|
||||||
|
async getAddress (req, res) {
|
||||||
|
try {
|
||||||
|
const address = req.body.address
|
||||||
|
|
||||||
|
if (!address || address === '') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be empty'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate and convert address
|
||||||
|
const cashAddr = this._validateAndConvertAddress(address)
|
||||||
|
|
||||||
|
const result = await this.slpUseCases.getAddress({ address: cashAddr })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/slp/txid Get SLP transaction data
|
||||||
|
* @apiName GetTxid
|
||||||
|
* @apiGroup SLP
|
||||||
|
* @apiDescription Returns SLP transaction data for a TXID.
|
||||||
|
*/
|
||||||
|
async getTxid (req, res) {
|
||||||
|
try {
|
||||||
|
const txid = req.body.txid
|
||||||
|
|
||||||
|
if (!txid || txid === '') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'txid can not be empty'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (txid.length !== 64) {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'This is not a txid'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await this.slpUseCases.getTxid({ txid })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/slp/token Get token statistics
|
||||||
|
* @apiName GetTokenStats
|
||||||
|
* @apiGroup SLP
|
||||||
|
* @apiDescription Returns statistics for a single SLP token.
|
||||||
|
*/
|
||||||
|
async getTokenStats (req, res) {
|
||||||
|
try {
|
||||||
|
const tokenId = req.body.tokenId
|
||||||
|
|
||||||
|
if (!tokenId || tokenId === '') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'tokenId can not be empty'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flag to toggle tx history of the token
|
||||||
|
const withTxHistory = req.body.withTxHistory === true
|
||||||
|
|
||||||
|
const result = await this.slpUseCases.getTokenStats({ tokenId, withTxHistory })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {post} /v6/slp/token/data Get token data
|
||||||
|
* @apiName GetTokenData
|
||||||
|
* @apiGroup SLP
|
||||||
|
* @apiDescription Get mutable and immutable data if the token contains them.
|
||||||
|
*/
|
||||||
|
async getTokenData (req, res) {
|
||||||
|
try {
|
||||||
|
const tokenId = req.body.tokenId
|
||||||
|
|
||||||
|
if (!tokenId || tokenId === '') {
|
||||||
|
return res.status(400).json({
|
||||||
|
success: false,
|
||||||
|
error: 'tokenId can not be empty'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flag to toggle tx history of the token
|
||||||
|
const withTxHistory = req.body.withTxHistory === true
|
||||||
|
|
||||||
|
const result = await this.slpUseCases.getTokenData({ tokenId, withTxHistory })
|
||||||
|
return res.status(200).json(result)
|
||||||
|
} catch (err) {
|
||||||
|
console.log('Error in /v6/slp/token/data getTokenData(): ', err)
|
||||||
|
return this.handleError(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError (err, res) {
|
||||||
|
const isCommonMissingTxError =
|
||||||
|
err?.status === 404 &&
|
||||||
|
typeof err?.message === 'string' &&
|
||||||
|
err.message.includes('Key not found in database')
|
||||||
|
|
||||||
|
if (!isCommonMissingTxError) {
|
||||||
|
wlogger.error('Error in SlpRESTController:', err)
|
||||||
|
}
|
||||||
|
|
||||||
|
const status = err.status || 500
|
||||||
|
const message = err.message || 'Internal server error'
|
||||||
|
|
||||||
|
return res.status(status).json({ error: message })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default SlpRESTController
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
/*
|
||||||
|
REST API router for /slp routes.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import express from 'express'
|
||||||
|
import SlpRESTController from './controller.js'
|
||||||
|
|
||||||
|
class SlpRouter {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Adapters library required when instantiating SLP REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error(
|
||||||
|
'Instance of Use Cases library required when instantiating SLP REST Router.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const dependencies = {
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this.useCases
|
||||||
|
}
|
||||||
|
|
||||||
|
this.slpController = new SlpRESTController(dependencies)
|
||||||
|
|
||||||
|
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||||
|
this.baseUrl = `${this.apiPrefix}/slp`
|
||||||
|
if (!this.baseUrl.startsWith('/')) {
|
||||||
|
this.baseUrl = `/${this.baseUrl}`
|
||||||
|
}
|
||||||
|
this.router = express.Router()
|
||||||
|
}
|
||||||
|
|
||||||
|
attach (app) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.router.get('/', this.slpController.root)
|
||||||
|
this.router.get('/status', this.slpController.getStatus)
|
||||||
|
this.router.post('/address', this.slpController.getAddress)
|
||||||
|
this.router.post('/txid', this.slpController.getTxid)
|
||||||
|
this.router.post('/token', this.slpController.getTokenStats)
|
||||||
|
this.router.post('/token/data', this.slpController.getTokenData)
|
||||||
|
|
||||||
|
app.use(this.baseUrl, this.router)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default SlpRouter
|
||||||
@@ -23,7 +23,7 @@ class TimerController {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Constants
|
// Constants
|
||||||
this.SHUTDOWN_INTERVAL_MS = 10 * 60 * 1000 // 10 minutes in milliseconds
|
this.SHUTDOWN_INTERVAL_MS = 10 * 60 * 60 * 1000 // 10 hours in milliseconds
|
||||||
this.LIVENESS_CHECK_INTERVAL_MS = 1 * 60 * 1000 // 1 minute in milliseconds
|
this.LIVENESS_CHECK_INTERVAL_MS = 1 * 60 * 1000 // 1 minute in milliseconds
|
||||||
|
|
||||||
// Handlers
|
// Handlers
|
||||||
|
|||||||
@@ -1,71 +0,0 @@
|
|||||||
/*
|
|
||||||
Event entity - represents a Nostr event.
|
|
||||||
This is a domain model following Clean Architecture principles.
|
|
||||||
*/
|
|
||||||
|
|
||||||
class Event {
|
|
||||||
constructor (data) {
|
|
||||||
this.id = data.id
|
|
||||||
this.pubkey = data.pubkey
|
|
||||||
this.created_at = data.created_at
|
|
||||||
this.kind = data.kind
|
|
||||||
this.tags = data.tags || []
|
|
||||||
this.content = data.content
|
|
||||||
this.sig = data.sig
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Validates the event structure
|
|
||||||
* @returns {boolean} True if valid
|
|
||||||
*/
|
|
||||||
isValid () {
|
|
||||||
if (!this.id || !this.pubkey || !this.created_at || this.kind === undefined || !this.sig) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Basic type checks
|
|
||||||
if (typeof this.id !== 'string' || this.id.length !== 64) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof this.pubkey !== 'string' || this.pubkey.length !== 64) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof this.created_at !== 'number') {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof this.kind !== 'number' || this.kind < 0 || this.kind > 65535) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof this.sig !== 'string' || this.sig.length !== 128) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Array.isArray(this.tags)) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert to plain object
|
|
||||||
* @returns {Object} Plain event object
|
|
||||||
*/
|
|
||||||
toJSON () {
|
|
||||||
return {
|
|
||||||
id: this.id,
|
|
||||||
pubkey: this.pubkey,
|
|
||||||
created_at: this.created_at,
|
|
||||||
kind: this.kind,
|
|
||||||
tags: this.tags,
|
|
||||||
content: this.content,
|
|
||||||
sig: this.sig
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export default Event
|
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
/*
|
||||||
|
Basic Authentication Middleware
|
||||||
|
|
||||||
|
This middleware validates Bearer tokens from the Authorization header.
|
||||||
|
When a valid token is provided, it sets req.locals.basicAuthValid = true
|
||||||
|
to allow bypassing x402 middleware.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import config from '../config/index.js'
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Middleware function that validates Bearer token authentication
|
||||||
|
* @param {Object} req - Express request object
|
||||||
|
* @param {Object} res - Express response object
|
||||||
|
* @param {Function} next - Express next middleware function
|
||||||
|
*/
|
||||||
|
export function basicAuthMiddleware (req, res, next) {
|
||||||
|
// Initialize req.locals if it doesn't exist
|
||||||
|
if (!req.locals) {
|
||||||
|
req.locals = {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default to false
|
||||||
|
req.locals.basicAuthValid = false
|
||||||
|
|
||||||
|
// Get the configured token
|
||||||
|
const configuredToken = config.basicAuth?.token
|
||||||
|
|
||||||
|
// If no token is configured, skip validation
|
||||||
|
if (!configuredToken) {
|
||||||
|
wlogger.warn('Basic auth enabled but no BASIC_AUTH_TOKEN configured')
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get the Authorization header
|
||||||
|
const authHeader = req.headers.authorization
|
||||||
|
|
||||||
|
// If no Authorization header, continue (x402 will handle unauthorized requests)
|
||||||
|
if (!authHeader) {
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if it's a Bearer token
|
||||||
|
const parts = authHeader.split(' ')
|
||||||
|
if (parts.length !== 2 || parts[0] !== 'Bearer') {
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
|
||||||
|
const providedToken = parts[1]
|
||||||
|
|
||||||
|
// Compare tokens
|
||||||
|
if (providedToken === configuredToken) {
|
||||||
|
req.locals.basicAuthValid = true
|
||||||
|
wlogger.verbose(`Basic auth validated for request to ${req.path}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Always continue to next middleware
|
||||||
|
// If auth failed, x402 middleware will handle the request
|
||||||
|
next()
|
||||||
|
}
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
/*
|
||||||
|
Use cases for encryption-related operations.
|
||||||
|
Retrieves public keys from the blockchain for BCH addresses.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Global npm libraries
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
|
||||||
|
// Local libraries
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||||
|
|
||||||
|
class EncryptionUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating Encryption use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.useCases = localConfig.useCases
|
||||||
|
if (!this.useCases) {
|
||||||
|
throw new Error('UseCases instance required when instantiating Encryption use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allow bchjs to be injected for testing
|
||||||
|
this.bchjs = localConfig.bchjs || bchjs
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the public key for a BCH address by searching the blockchain.
|
||||||
|
* Searches the transaction history of the address for a transaction input
|
||||||
|
* that contains the public key.
|
||||||
|
*
|
||||||
|
* @param {Object} params - Parameters object
|
||||||
|
* @param {string} params.address - BCH address (cash address or legacy format)
|
||||||
|
* @returns {Promise<Object>} Object with success status and publicKey if found
|
||||||
|
*/
|
||||||
|
async getPublicKey ({ address }) {
|
||||||
|
try {
|
||||||
|
// Convert to cash address format
|
||||||
|
const cashAddr = this.bchjs.Address.toCashAddress(address)
|
||||||
|
|
||||||
|
// Get transaction history for the address
|
||||||
|
const txHistory = await this.useCases.fulcrum.getTransactions({ address: cashAddr })
|
||||||
|
|
||||||
|
// Extract just the TXIDs
|
||||||
|
const txids = txHistory.transactions.map((elem) => elem.tx_hash)
|
||||||
|
|
||||||
|
// 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]
|
||||||
|
|
||||||
|
// Get verbose transaction details
|
||||||
|
const txDetails = await this.useCases.rawtransactions.getRawTransaction({
|
||||||
|
txid: thisTx,
|
||||||
|
verbose: true
|
||||||
|
})
|
||||||
|
|
||||||
|
const vin = txDetails.vin
|
||||||
|
|
||||||
|
// Loop through each input
|
||||||
|
for (let j = 0; j < vin.length; j++) {
|
||||||
|
const thisVin = vin[j]
|
||||||
|
|
||||||
|
// Skip if no scriptSig (e.g., coinbase transactions)
|
||||||
|
if (!thisVin.scriptSig || !thisVin.scriptSig.asm) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract the script signature
|
||||||
|
const scriptSig = thisVin.scriptSig.asm.split(' ')
|
||||||
|
|
||||||
|
// Extract the public key from the script signature (last element)
|
||||||
|
const pubKey = scriptSig[scriptSig.length - 1]
|
||||||
|
|
||||||
|
// Skip if pubKey is not a valid hex string (basic validation)
|
||||||
|
if (!pubKey || !/^[0-9a-fA-F]+$/.test(pubKey)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 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)
|
||||||
|
|
||||||
|
// If public keys match, this is the correct public key
|
||||||
|
if (cashAddr === cashAddr2) {
|
||||||
|
return {
|
||||||
|
success: true,
|
||||||
|
publicKey: pubKey
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
// Skip invalid public keys - continue searching
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Public key not found in any transaction
|
||||||
|
return {
|
||||||
|
success: false,
|
||||||
|
publicKey: 'not found'
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in EncryptionUseCases.getPublicKey()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default EncryptionUseCases
|
||||||
@@ -0,0 +1,197 @@
|
|||||||
|
/*
|
||||||
|
Use cases for interacting with the Fulcrum API service.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
// Use RESTURL (from test) or REST_URL (from psf-bch-api config) or fallback to config
|
||||||
|
const restURL = process.env.RESTURL || process.env.REST_URL || process.env.LOCAL_RESTURL || config.restURL
|
||||||
|
// Use BCHJSBEARERTOKEN (from test) or BASIC_AUTH_TOKEN (from psf-bch-api config) or fallback to config
|
||||||
|
const bearerToken = process.env.BCHJSBEARERTOKEN || process.env.BASIC_AUTH_TOKEN || config.basicAuth.token
|
||||||
|
|
||||||
|
const bchjs = new BCHJS({
|
||||||
|
restURL,
|
||||||
|
bearerToken
|
||||||
|
})
|
||||||
|
|
||||||
|
class FulcrumUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating Fulcrum use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fulcrum = this.adapters.fulcrum
|
||||||
|
if (!this.fulcrum) {
|
||||||
|
throw new Error('Fulcrum adapter required when instantiating Fulcrum use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allow bchjs to be injected for testing
|
||||||
|
this.bchjs = localConfig.bchjs || bchjs
|
||||||
|
}
|
||||||
|
|
||||||
|
async getBalance ({ address }) {
|
||||||
|
return this.fulcrum.get(`electrumx/balance/${address}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
async getBalances ({ addresses }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/balance/', { addresses })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getBalances()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getUtxos ({ address }) {
|
||||||
|
return this.fulcrum.get(`electrumx/utxos/${address}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
async getUtxosBulk ({ addresses }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/utxos/', { addresses })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getUtxosBulk()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTransactionDetails ({ txid }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.get(`electrumx/tx/data/${txid}`)
|
||||||
|
// console.log(`getTransactionDetails() TXID ${txid}: ${JSON.stringify(response, null, 2)}`)
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getTransactionDetails()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTransactionDetailsBulk ({ txids, verbose }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/tx/data', { txids, verbose })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getTransactionDetailsBulk()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async broadcastTransaction ({ txHex }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/tx/broadcast', { txHex })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.broadcastTransaction()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getBlockHeaders ({ height, count }) {
|
||||||
|
return this.fulcrum.get(`electrumx/block/headers/${height}?count=${count}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
async getBlockHeadersBulk ({ heights }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/block/headers', { heights })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getBlockHeadersBulk()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTransactions ({ address, allTxs, bearerToken = null }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.get(`electrumx/transactions/${address}`)
|
||||||
|
|
||||||
|
// Sort transactions in descending order, so that newest transactions are first.
|
||||||
|
if (response.transactions && Array.isArray(response.transactions)) {
|
||||||
|
// Use bearer token from request if provided, otherwise use the default bchjs instance
|
||||||
|
let bchjsInstance = this.bchjs
|
||||||
|
if (bearerToken) {
|
||||||
|
// Create a temporary bchjs instance with the bearer token from the request
|
||||||
|
const restURL = process.env.RESTURL || process.env.REST_URL || process.env.LOCAL_RESTURL || config.restURL
|
||||||
|
bchjsInstance = new BCHJS({
|
||||||
|
restURL,
|
||||||
|
bearerToken
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
response.transactions = await bchjsInstance.Electrumx.sortAllTxs(response.transactions, 'DESCENDING')
|
||||||
|
|
||||||
|
if (!allTxs) {
|
||||||
|
// Return only the first 100 transactions of the history.
|
||||||
|
response.transactions = response.transactions.slice(0, 100)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getTransactions()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTransactionsBulk ({ addresses, allTxs, bearerToken = null }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/transactions/', { addresses })
|
||||||
|
|
||||||
|
// Sort transactions in descending order for each address entry.
|
||||||
|
if (response.transactions && Array.isArray(response.transactions)) {
|
||||||
|
// Use bearer token from request if provided, otherwise use the default bchjs instance
|
||||||
|
let bchjsInstance = this.bchjs
|
||||||
|
|
||||||
|
// console.log('getTransactionsBulk() bearerToken: ', bearerToken)
|
||||||
|
if (bearerToken) {
|
||||||
|
// Create a temporary bchjs instance with the bearer token from the request
|
||||||
|
const restURL = config.restURL
|
||||||
|
|
||||||
|
// console.log('getTransactionsBulk() restURL: ', restURL)
|
||||||
|
bchjsInstance = new BCHJS({
|
||||||
|
restURL,
|
||||||
|
bearerToken
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
for (let i = 0; i < response.transactions.length; i++) {
|
||||||
|
const thisEntry = response.transactions[i]
|
||||||
|
if (thisEntry.transactions && Array.isArray(thisEntry.transactions)) {
|
||||||
|
thisEntry.transactions = await bchjsInstance.Electrumx.sortAllTxs(thisEntry.transactions, 'DESCENDING')
|
||||||
|
|
||||||
|
if (!allTxs && thisEntry.transactions.length > 100) {
|
||||||
|
// Extract only the first 100 transactions.
|
||||||
|
thisEntry.transactions = thisEntry.transactions.slice(0, 100)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getTransactionsBulk()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getMempool ({ address }) {
|
||||||
|
return this.fulcrum.get(`electrumx/unconfirmed/${address}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
async getMempoolBulk ({ addresses }) {
|
||||||
|
try {
|
||||||
|
const response = await this.fulcrum.post('electrumx/unconfirmed/', { addresses })
|
||||||
|
return response
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in FulcrumUseCases.getMempoolBulk()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default FulcrumUseCases
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
/*
|
||||||
|
Use cases for interacting with the BCH full node mining RPC interface.
|
||||||
|
*/
|
||||||
|
|
||||||
|
class MiningUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating Mining use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fullNode = this.adapters.fullNode
|
||||||
|
if (!this.fullNode) {
|
||||||
|
throw new Error('Full node adapter required when instantiating Mining use cases.')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getMiningInfo () {
|
||||||
|
return this.fullNode.call('getmininginfo')
|
||||||
|
}
|
||||||
|
|
||||||
|
async getNetworkHashPS ({ nblocks, height }) {
|
||||||
|
return this.fullNode.call('getnetworkhashps', [nblocks, height])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default MiningUseCases
|
||||||
@@ -0,0 +1,121 @@
|
|||||||
|
/*
|
||||||
|
Use cases for interacting with the BCH full node raw transactions RPC interface.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
|
||||||
|
class RawTransactionsUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating RawTransactions use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fullNode = this.adapters.fullNode
|
||||||
|
if (!this.fullNode) {
|
||||||
|
throw new Error('Full node adapter required when instantiating RawTransactions use cases.')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async decodeRawTransaction ({ hex }) {
|
||||||
|
return this.fullNode.call('decoderawtransaction', [hex])
|
||||||
|
}
|
||||||
|
|
||||||
|
async decodeRawTransactions ({ hexes }) {
|
||||||
|
try {
|
||||||
|
const promises = hexes.map(hex =>
|
||||||
|
this.fullNode.call('decoderawtransaction', [hex], `decoderawtransaction-${hex.slice(0, 16)}`)
|
||||||
|
)
|
||||||
|
|
||||||
|
return await Promise.all(promises)
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in RawTransactionsUseCases.decodeRawTransactions()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async decodeScript ({ hex }) {
|
||||||
|
return this.fullNode.call('decodescript', [hex])
|
||||||
|
}
|
||||||
|
|
||||||
|
async decodeScripts ({ hexes }) {
|
||||||
|
try {
|
||||||
|
const promises = hexes.map(hex =>
|
||||||
|
this.fullNode.call('decodescript', [hex], `decodescript-${hex.slice(0, 16)}`)
|
||||||
|
)
|
||||||
|
|
||||||
|
return await Promise.all(promises)
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in RawTransactionsUseCases.decodeScripts()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getRawTransaction ({ txid, verbose = false }) {
|
||||||
|
const verboseInt = verbose ? 1 : 0
|
||||||
|
return this.fullNode.call('getrawtransaction', [txid, verboseInt])
|
||||||
|
}
|
||||||
|
|
||||||
|
async getRawTransactions ({ txids, verbose = false }) {
|
||||||
|
try {
|
||||||
|
const verboseInt = verbose ? 1 : 0
|
||||||
|
const promises = txids.map(txid =>
|
||||||
|
this.fullNode.call('getrawtransaction', [txid, verboseInt], `getrawtransaction-${txid}`)
|
||||||
|
)
|
||||||
|
|
||||||
|
return await Promise.all(promises)
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in RawTransactionsUseCases.getRawTransactions()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getRawTransactionWithHeight ({ txid, verbose = false }) {
|
||||||
|
const verboseInt = verbose ? 1 : 0
|
||||||
|
const data = await this.fullNode.call('getrawtransaction', [txid, verboseInt])
|
||||||
|
|
||||||
|
if (verbose && data && data.blockhash) {
|
||||||
|
data.height = null
|
||||||
|
try {
|
||||||
|
// Look up the block height and append it to the TX response.
|
||||||
|
const blockHeader = await this.fullNode.call('getblockheader', [data.blockhash, true])
|
||||||
|
data.height = blockHeader.height
|
||||||
|
} catch (err) {
|
||||||
|
// Exit quietly if block header lookup fails
|
||||||
|
wlogger.debug('Could not fetch block header for height lookup', err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return data
|
||||||
|
}
|
||||||
|
|
||||||
|
async getBlockHeader ({ blockHash, verbose = false }) {
|
||||||
|
return this.fullNode.call('getblockheader', [blockHash, verbose])
|
||||||
|
}
|
||||||
|
|
||||||
|
async sendRawTransaction ({ hex }) {
|
||||||
|
return this.fullNode.call('sendrawtransaction', [hex])
|
||||||
|
}
|
||||||
|
|
||||||
|
async sendRawTransactions ({ hexes }) {
|
||||||
|
// Dev Note: Sending the 'sendrawtransaction' 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 broadcasting the previous one. Serial execution is required.
|
||||||
|
try {
|
||||||
|
const result = []
|
||||||
|
for (const hex of hexes) {
|
||||||
|
const txid = await this.fullNode.call('sendrawtransaction', [hex], `sendrawtransaction-${hex.slice(0, 16)}`)
|
||||||
|
result.push(txid)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in RawTransactionsUseCases.sendRawTransactions()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default RawTransactionsUseCases
|
||||||
@@ -8,6 +8,12 @@
|
|||||||
import BlockchainUseCases from './full-node-blockchain-use-cases.js'
|
import BlockchainUseCases from './full-node-blockchain-use-cases.js'
|
||||||
import ControlUseCases from './full-node-control-use-cases.js'
|
import ControlUseCases from './full-node-control-use-cases.js'
|
||||||
import DSProofUseCases from './full-node-dsproof-use-cases.js'
|
import DSProofUseCases from './full-node-dsproof-use-cases.js'
|
||||||
|
import EncryptionUseCases from './encryption-use-cases.js'
|
||||||
|
import FulcrumUseCases from './fulcrum-use-cases.js'
|
||||||
|
import MiningUseCases from './full-node-mining-use-cases.js'
|
||||||
|
import PriceUseCases from './price-use-cases.js'
|
||||||
|
import RawTransactionsUseCases from './full-node-rawtransactions-use-cases.js'
|
||||||
|
import SlpUseCases from './slp-use-cases.js'
|
||||||
|
|
||||||
class UseCases {
|
class UseCases {
|
||||||
constructor (localConfig = {}) {
|
constructor (localConfig = {}) {
|
||||||
@@ -21,6 +27,17 @@ class UseCases {
|
|||||||
this.blockchain = new BlockchainUseCases({ adapters: this.adapters })
|
this.blockchain = new BlockchainUseCases({ adapters: this.adapters })
|
||||||
this.control = new ControlUseCases({ adapters: this.adapters })
|
this.control = new ControlUseCases({ adapters: this.adapters })
|
||||||
this.dsproof = new DSProofUseCases({ adapters: this.adapters })
|
this.dsproof = new DSProofUseCases({ adapters: this.adapters })
|
||||||
|
this.fulcrum = new FulcrumUseCases({ adapters: this.adapters })
|
||||||
|
this.mining = new MiningUseCases({ adapters: this.adapters })
|
||||||
|
this.price = new PriceUseCases({ adapters: this.adapters })
|
||||||
|
this.rawtransactions = new RawTransactionsUseCases({ adapters: this.adapters })
|
||||||
|
this.slp = new SlpUseCases({ adapters: this.adapters })
|
||||||
|
|
||||||
|
// Encryption use cases require access to other use cases (fulcrum, rawtransactions)
|
||||||
|
this.encryption = new EncryptionUseCases({
|
||||||
|
adapters: this.adapters,
|
||||||
|
useCases: this
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run any startup Use Cases at the start of the app.
|
// Run any startup Use Cases at the start of the app.
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
/*
|
||||||
|
Use cases for price-related operations.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Global npm libraries
|
||||||
|
import axios from 'axios'
|
||||||
|
import SlpWallet from 'minimal-slp-wallet'
|
||||||
|
import PSFFPP from 'psffpp'
|
||||||
|
|
||||||
|
// Local libraries
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
class PriceUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating Price use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get config
|
||||||
|
this.config = localConfig.config || config
|
||||||
|
|
||||||
|
// Coinex API URL for BCH/USDT
|
||||||
|
this.bchCoinexPriceUrl =
|
||||||
|
'https://api.coinex.com/v1/market/ticker?market=bchusdt'
|
||||||
|
|
||||||
|
// Allow axios to be injected for testing
|
||||||
|
this.axios = localConfig.axios || axios
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the USD price of BCH from Coinex.
|
||||||
|
* @returns {Promise<number>} The USD price of BCH
|
||||||
|
*/
|
||||||
|
async getBCHUSD () {
|
||||||
|
try {
|
||||||
|
// Request options
|
||||||
|
const opt = {
|
||||||
|
method: 'get',
|
||||||
|
baseURL: this.bchCoinexPriceUrl,
|
||||||
|
timeout: 15000
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await this.axios.request(opt)
|
||||||
|
|
||||||
|
const price = Number(response.data.data.ticker.last)
|
||||||
|
|
||||||
|
return price
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in PriceUseCases.getBCHUSD()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the PSF price for writing to the PSFFPP.
|
||||||
|
* Returns the price to pin 1MB of content to the PSFFPP pinning
|
||||||
|
* network on IPFS. The price is denominated in PSF tokens.
|
||||||
|
* @returns {Promise<number>} The write price in PSF tokens
|
||||||
|
*/
|
||||||
|
async getPsffppWritePrice () {
|
||||||
|
try {
|
||||||
|
const wallet = new SlpWallet(undefined, {
|
||||||
|
interface: 'rest-api',
|
||||||
|
restURL: this.config.restURL
|
||||||
|
})
|
||||||
|
await wallet.walletInfoPromise
|
||||||
|
|
||||||
|
const psffpp = new PSFFPP({ wallet })
|
||||||
|
|
||||||
|
const writePrice = await psffpp.getMcWritePrice()
|
||||||
|
|
||||||
|
return writePrice
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in PriceUseCases.getPsffppWritePrice()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PriceUseCases
|
||||||
@@ -0,0 +1,332 @@
|
|||||||
|
/*
|
||||||
|
Use cases for interacting with the SLP Indexer API service.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import wlogger from '../adapters/wlogger.js'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
import SlpWallet from 'minimal-slp-wallet'
|
||||||
|
import SlpTokenMedia from 'slp-token-media'
|
||||||
|
import axios from 'axios'
|
||||||
|
import config from '../config/index.js'
|
||||||
|
|
||||||
|
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||||
|
|
||||||
|
class SlpUseCases {
|
||||||
|
constructor (localConfig = {}) {
|
||||||
|
this.adapters = localConfig.adapters
|
||||||
|
|
||||||
|
if (!this.adapters) {
|
||||||
|
throw new Error('Adapters instance required when instantiating SLP use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
this.slpIndexer = this.adapters.slpIndexer
|
||||||
|
if (!this.slpIndexer) {
|
||||||
|
throw new Error('SLP Indexer adapter required when instantiating SLP use cases.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allow bchjs to be injected for testing
|
||||||
|
this.bchjs = localConfig.bchjs || bchjs
|
||||||
|
|
||||||
|
// Get config
|
||||||
|
this.config = localConfig.config || config
|
||||||
|
|
||||||
|
// Initialize wallet (lazy initialization)
|
||||||
|
this.wallet = null
|
||||||
|
this.slpTokenMedia = null
|
||||||
|
this.walletInitialized = false
|
||||||
|
this.initializationPromise = null
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize wallet and SlpTokenMedia asynchronously
|
||||||
|
async _ensureInitialized () {
|
||||||
|
if (this.walletInitialized) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.initializationPromise) {
|
||||||
|
return this.initializationPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
this.initializationPromise = this._initialize()
|
||||||
|
return this.initializationPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
async _initialize () {
|
||||||
|
try {
|
||||||
|
// Initialize wallet
|
||||||
|
this.wallet = new SlpWallet(undefined, {
|
||||||
|
restURL: this.config.restURL,
|
||||||
|
interface: 'rest-api'
|
||||||
|
})
|
||||||
|
|
||||||
|
// Wait for wallet to initialize
|
||||||
|
await this.wallet.walletInfoPromise
|
||||||
|
|
||||||
|
// Initialize SlpTokenMedia
|
||||||
|
this.slpTokenMedia = new SlpTokenMedia({
|
||||||
|
wallet: this.wallet,
|
||||||
|
ipfsGatewayUrl: this.config.ipfsGateway
|
||||||
|
})
|
||||||
|
|
||||||
|
this.walletInitialized = true
|
||||||
|
wlogger.info('SLP wallet and token media initialized')
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error initializing SLP wallet:', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getStatus () {
|
||||||
|
try {
|
||||||
|
return await this.slpIndexer.get('slp/status/')
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getStatus()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getAddress ({ address }) {
|
||||||
|
try {
|
||||||
|
return await this.slpIndexer.post('slp/address/', { address })
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getAddress()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTxid ({ txid }) {
|
||||||
|
try {
|
||||||
|
return await this.slpIndexer.post('slp/tx/', { txid })
|
||||||
|
} catch (err) {
|
||||||
|
const isCommonMissingTxError =
|
||||||
|
err?.status === 404 &&
|
||||||
|
typeof err?.message === 'string' &&
|
||||||
|
err.message.includes('Key not found in database')
|
||||||
|
|
||||||
|
if (!isCommonMissingTxError) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getTxid()', err)
|
||||||
|
}
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTokenStats ({ tokenId, withTxHistory = false }) {
|
||||||
|
try {
|
||||||
|
return await this.slpIndexer.post('slp/token/', { tokenId, withTxHistory })
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getTokenStats()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getTokenData ({ tokenId, withTxHistory = false }) {
|
||||||
|
try {
|
||||||
|
const tokenData = {}
|
||||||
|
|
||||||
|
// Get token stats from the Genesis TX of the token
|
||||||
|
const response = await this.slpIndexer.post('slp/token/', { tokenId, withTxHistory })
|
||||||
|
const tokenStats = response.tokenData
|
||||||
|
|
||||||
|
tokenData.genesisData = tokenStats
|
||||||
|
|
||||||
|
// Try to get immutable data
|
||||||
|
try {
|
||||||
|
const immutableData = tokenStats.documentUri
|
||||||
|
tokenData.immutableData = immutableData || ''
|
||||||
|
} catch (error) {
|
||||||
|
tokenData.immutableData = ''
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try to get mutable data
|
||||||
|
try {
|
||||||
|
const mutableData = await this.getMutableCid({ tokenStats })
|
||||||
|
tokenData.mutableData = mutableData || ''
|
||||||
|
} catch (error) {
|
||||||
|
wlogger.warn('Error getting mutable data:', error)
|
||||||
|
tokenData.mutableData = ''
|
||||||
|
}
|
||||||
|
|
||||||
|
return tokenData
|
||||||
|
} catch (err) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getTokenData()', err)
|
||||||
|
throw err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getMutableCid ({ tokenStats }) {
|
||||||
|
// Validate input - this should throw, not be caught
|
||||||
|
if (!tokenStats || !tokenStats.documentHash) {
|
||||||
|
throw new Error('No documentHash property found in tokenStats')
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this._ensureInitialized()
|
||||||
|
|
||||||
|
// Get the OP_RETURN data and decode it
|
||||||
|
const mutableData = await this.decodeOpReturn({ txid: tokenStats.documentHash })
|
||||||
|
const jsonData = JSON.parse(mutableData)
|
||||||
|
|
||||||
|
// mda = mutable data address
|
||||||
|
const mda = jsonData.mda
|
||||||
|
|
||||||
|
// Get the mda transaction history
|
||||||
|
const transactions = await this.wallet.getTransactions(mda)
|
||||||
|
wlogger.info(`MDA has ${transactions.length} transactions in its history.`)
|
||||||
|
|
||||||
|
const mdaTxs = transactions
|
||||||
|
|
||||||
|
let data = false
|
||||||
|
|
||||||
|
// These are used to filter blockchain data to find the most recent
|
||||||
|
// update to the MDA
|
||||||
|
let largestBlock = 700000
|
||||||
|
let largestTimestamp = 1666107111271
|
||||||
|
let bestEntry
|
||||||
|
|
||||||
|
// Used to track the number of transactions before the best candidate is found
|
||||||
|
let txCnt = 0
|
||||||
|
|
||||||
|
// Map each transaction of the mda
|
||||||
|
// If it finds an OP_RETURN, decode it and exit the loop
|
||||||
|
for (let i = 0; i < mdaTxs.length; i++) {
|
||||||
|
const tx = mdaTxs[i]
|
||||||
|
const txid = tx.tx_hash
|
||||||
|
txCnt++
|
||||||
|
|
||||||
|
data = await this.decodeOpReturn({ txid })
|
||||||
|
|
||||||
|
// Try parse the OP_RETURN data to a JSON object
|
||||||
|
if (data) {
|
||||||
|
try {
|
||||||
|
// Convert the OP_RETURN data to a JSON object
|
||||||
|
const obj = JSON.parse(data)
|
||||||
|
|
||||||
|
// Keep searching if this TX does not have a cid value
|
||||||
|
if (!obj.cid) continue
|
||||||
|
|
||||||
|
// Ensure data was generated by the MDA
|
||||||
|
const txData = await this.wallet.getTxData([txid])
|
||||||
|
const vinAddress = txData[0].vin[0].address
|
||||||
|
|
||||||
|
// Skip entry if it was not made by the MDA private key
|
||||||
|
if (mda !== vinAddress) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// First best entry found
|
||||||
|
if (!bestEntry) {
|
||||||
|
bestEntry = data
|
||||||
|
largestBlock = tx.height
|
||||||
|
|
||||||
|
if (obj.ts) {
|
||||||
|
largestTimestamp = obj.ts
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// One candidate already found. Looking for potentially better entry
|
||||||
|
|
||||||
|
if (tx.height < largestBlock) {
|
||||||
|
// Exit loop if next candidate has an older block height
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
if (obj.ts && obj.ts < largestTimestamp) {
|
||||||
|
// Continue looping through entries if the current entry in
|
||||||
|
// the same block has a smaller timestamp
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
bestEntry = data
|
||||||
|
largestBlock = tx.height
|
||||||
|
if (obj.ts) {
|
||||||
|
largestTimestamp = obj.ts
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
wlogger.info(`${txCnt} transactions reviewed to find mutable data.`)
|
||||||
|
|
||||||
|
if (!bestEntry) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get the CID
|
||||||
|
const obj = JSON.parse(bestEntry)
|
||||||
|
const cid = obj.cid
|
||||||
|
|
||||||
|
if (!cid) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assuming that CID starts with ipfs://. Cutting out that prefix
|
||||||
|
const mutableCid = cid.substring(7)
|
||||||
|
|
||||||
|
return mutableCid
|
||||||
|
} catch (err) {
|
||||||
|
console.log('Error in SlpUseCases.getMutableCid()', err)
|
||||||
|
wlogger.error('Error in SlpUseCases.getMutableCid()', err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async decodeOpReturn ({ txid }) {
|
||||||
|
try {
|
||||||
|
if (!txid || typeof txid !== 'string') {
|
||||||
|
throw new Error('txid must be a string.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get transaction data
|
||||||
|
console.log('Decoding OP_RETURN for TXID: ', txid)
|
||||||
|
const txData = await this.bchjs.Electrumx.txData(txid)
|
||||||
|
// console.log(`TXID ${txid}: ${JSON.stringify(txData, null, 2)}`)
|
||||||
|
let data = false
|
||||||
|
|
||||||
|
// Map the vout of the transaction in search of an OP_RETURN
|
||||||
|
for (let i = 0; i < txData.details.vout.length; i++) {
|
||||||
|
const vout = txData.details.vout[i]
|
||||||
|
|
||||||
|
const script = this.bchjs.Script.toASM(
|
||||||
|
Buffer.from(vout.scriptPubKey.hex, 'hex')
|
||||||
|
).split(' ')
|
||||||
|
|
||||||
|
// Exit on the first OP_RETURN found
|
||||||
|
if (script[0] === 'OP_RETURN') {
|
||||||
|
data = Buffer.from(script[1], 'hex').toString('ascii')
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return data
|
||||||
|
} catch (error) {
|
||||||
|
console.log('Error in SlpUseCases.decodeOpReturn()', error)
|
||||||
|
wlogger.error('Error in SlpUseCases.decodeOpReturn()', error)
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getCIDData ({ cid }) {
|
||||||
|
try {
|
||||||
|
if (!cid || typeof cid !== 'string') {
|
||||||
|
throw new Error('cid must be a string.')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assuming that CID starts with ipfs://. Cutting out that prefix
|
||||||
|
const cidWithoutPrefix = cid.substring(7)
|
||||||
|
|
||||||
|
const dataUrl = `https://${cidWithoutPrefix}.ipfs.dweb.link/data.json`
|
||||||
|
wlogger.info(`Fetching IPFS data from: ${dataUrl}`)
|
||||||
|
|
||||||
|
const response = await axios.get(dataUrl)
|
||||||
|
|
||||||
|
return response.data
|
||||||
|
} catch (error) {
|
||||||
|
wlogger.error('Error in SlpUseCases.getCIDData()', error)
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default SlpUseCases
|
||||||
@@ -1,250 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for POST /event endpoint.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Server from '../../../bin/server.js'
|
|
||||||
import { finalizeEvent, getPublicKey, generateSecretKey } from 'nostr-tools/pure'
|
|
||||||
import { hexToBytes } from '@noble/hashes/utils.js'
|
|
||||||
|
|
||||||
describe('#event-integration.js', () => {
|
|
||||||
let server
|
|
||||||
const baseUrl = 'http://localhost:3001' // Use different port for tests
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Start test server
|
|
||||||
server = new Server()
|
|
||||||
server.config.port = 3001
|
|
||||||
await server.startServer()
|
|
||||||
|
|
||||||
// Wait for server to be ready
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 1000))
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async () => {
|
|
||||||
// Stop server
|
|
||||||
if (server && server.server) {
|
|
||||||
await new Promise((resolve) => {
|
|
||||||
server.server.close(() => {
|
|
||||||
resolve()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('POST /event', () => {
|
|
||||||
it('should publish kind 0 event (profile metadata) - covers example 01', async () => {
|
|
||||||
// Generate keys
|
|
||||||
const sk = generateSecretKey()
|
|
||||||
|
|
||||||
// Create profile metadata event (kind 0)
|
|
||||||
const profileMetadata = {
|
|
||||||
name: 'Test User',
|
|
||||||
about: 'Integration test user',
|
|
||||||
picture: 'https://example.com/test.jpg'
|
|
||||||
}
|
|
||||||
|
|
||||||
const eventTemplate = {
|
|
||||||
kind: 0,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
tags: [],
|
|
||||||
content: JSON.stringify(profileMetadata)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sign the event
|
|
||||||
const signedEvent = finalizeEvent(eventTemplate, sk)
|
|
||||||
|
|
||||||
// Publish to REST API
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(signedEvent)
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.property(result, 'accepted')
|
|
||||||
assert.property(result, 'eventId')
|
|
||||||
assert.equal(result.eventId, signedEvent.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should publish kind 1 event (text post) - covers example 03', async () => {
|
|
||||||
// Alice's private key from examples
|
|
||||||
const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
|
|
||||||
const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
|
|
||||||
const alicePubKey = getPublicKey(alicePrivKeyBin)
|
|
||||||
|
|
||||||
// Generate a post
|
|
||||||
const eventTemplate = {
|
|
||||||
kind: 1,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
tags: [],
|
|
||||||
content: 'Integration test post'
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sign the post
|
|
||||||
const signedEvent = finalizeEvent(eventTemplate, alicePrivKeyBin)
|
|
||||||
|
|
||||||
// Publish to REST API
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(signedEvent)
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.property(result, 'accepted')
|
|
||||||
assert.property(result, 'eventId')
|
|
||||||
assert.equal(result.eventId, signedEvent.id)
|
|
||||||
assert.equal(signedEvent.pubkey, alicePubKey)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should publish kind 3 event (follow list) - covers example 06', async () => {
|
|
||||||
// Alice's private key
|
|
||||||
const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
|
|
||||||
const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
|
|
||||||
|
|
||||||
// Bob's public key
|
|
||||||
const bobPrivKeyHex = 'd2e71a977bc3900d6b0f787421e3d1a666cd12ca625482b0d9eeffd23489c99f'
|
|
||||||
const bobPrivKeyBin = hexToBytes(bobPrivKeyHex)
|
|
||||||
const bobPubKey = getPublicKey(bobPrivKeyBin)
|
|
||||||
|
|
||||||
const psf = 'wss://nostr-relay.psfoundation.info'
|
|
||||||
|
|
||||||
const followList = [
|
|
||||||
['p', bobPubKey, psf, 'bob']
|
|
||||||
]
|
|
||||||
|
|
||||||
// Generate a follow list event (kind 3)
|
|
||||||
const eventTemplate = {
|
|
||||||
kind: 3,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
tags: followList,
|
|
||||||
content: ''
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sign the event
|
|
||||||
const signedEvent = finalizeEvent(eventTemplate, alicePrivKeyBin)
|
|
||||||
|
|
||||||
// Publish to REST API
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(signedEvent)
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.property(result, 'accepted')
|
|
||||||
assert.property(result, 'eventId')
|
|
||||||
assert.equal(result.eventId, signedEvent.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should publish kind 7 event (reaction/like) - covers example 07', async () => {
|
|
||||||
// Bob's private key
|
|
||||||
const bobPrivKeyHex = 'd2e71a977bc3900d6b0f787421e3d1a666cd12ca625482b0d9eeffd23489c99f'
|
|
||||||
const bobPrivKeyBin = hexToBytes(bobPrivKeyHex)
|
|
||||||
const bobPubKey = getPublicKey(bobPrivKeyBin)
|
|
||||||
|
|
||||||
const psf = 'wss://nostr-relay.psfoundation.info'
|
|
||||||
|
|
||||||
// Use a test event ID
|
|
||||||
const evIdToLike = 'd09b4c5da59be3cd2768aa53fa78b77bf4859084c94f3bf26d401f004a9c8167'
|
|
||||||
const evIdAuthorPubKey = '2c7e76c0f8dc1dca9d0197c7d19be580a8d074ccada6a2f6ebe056ae41092e92'
|
|
||||||
|
|
||||||
// Generate like event (kind 7)
|
|
||||||
const likeEventTemplate = {
|
|
||||||
kind: 7,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
pubkey: bobPubKey,
|
|
||||||
tags: [
|
|
||||||
['e', evIdToLike, psf],
|
|
||||||
['p', evIdAuthorPubKey, psf]
|
|
||||||
],
|
|
||||||
content: '+'
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sign the event
|
|
||||||
const signedEvent = finalizeEvent(likeEventTemplate, bobPrivKeyBin)
|
|
||||||
|
|
||||||
// Publish to REST API
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(signedEvent)
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.property(result, 'accepted')
|
|
||||||
assert.property(result, 'eventId')
|
|
||||||
assert.equal(result.eventId, signedEvent.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should reject invalid event', async () => {
|
|
||||||
const invalidEvent = {
|
|
||||||
id: 'invalid',
|
|
||||||
pubkey: 'invalid',
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
kind: 1,
|
|
||||||
tags: [],
|
|
||||||
content: 'Test',
|
|
||||||
sig: 'invalid'
|
|
||||||
}
|
|
||||||
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(invalidEvent)
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
// Should reject invalid event - error response format
|
|
||||||
assert.equal(response.status, 400)
|
|
||||||
assert.property(result, 'error')
|
|
||||||
assert.include(result.error, 'Invalid event structure')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when event data is missing', async () => {
|
|
||||||
// Send empty body - Express will parse as undefined, controller should handle it
|
|
||||||
const response = await fetch(`${baseUrl}/event`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: ''
|
|
||||||
})
|
|
||||||
|
|
||||||
// Empty body should be parsed as undefined by Express
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
assert.equal(response.status, 400)
|
|
||||||
assert.property(result, 'error')
|
|
||||||
assert.include(result.error, 'Event data is required')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,173 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for GET /req/:subId endpoint.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Server from '../../../bin/server.js'
|
|
||||||
import { getPublicKey } from 'nostr-tools/pure'
|
|
||||||
import { hexToBytes } from '@noble/hashes/utils.js'
|
|
||||||
|
|
||||||
describe('#req-integration.js', () => {
|
|
||||||
let server
|
|
||||||
const baseUrl = 'http://localhost:3002' // Use different port for tests
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Start test server
|
|
||||||
server = new Server()
|
|
||||||
server.config.port = 3002
|
|
||||||
await server.startServer()
|
|
||||||
|
|
||||||
// Wait for server to be ready
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 1000))
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async () => {
|
|
||||||
// Stop server
|
|
||||||
if (server && server.server) {
|
|
||||||
await new Promise((resolve) => {
|
|
||||||
server.server.close(() => {
|
|
||||||
resolve()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('GET /req/:subId', () => {
|
|
||||||
it('should query kind 1 events (posts) - covers examples 02, 04', async () => {
|
|
||||||
// JB55's public key from example 02
|
|
||||||
const jb55 = '32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
|
|
||||||
|
|
||||||
// Create subscription ID
|
|
||||||
const subId = 'read-posts-' + Date.now()
|
|
||||||
|
|
||||||
// Create filters - read posts from JB55
|
|
||||||
const filters = {
|
|
||||||
limit: 2,
|
|
||||||
kinds: [1],
|
|
||||||
authors: [jb55]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Query events using GET /req/:subId
|
|
||||||
const filtersJson = encodeURIComponent(JSON.stringify([filters]))
|
|
||||||
const url = `${baseUrl}/req/${subId}?filters=${filtersJson}`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
const events = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.isArray(events)
|
|
||||||
// May be empty if no events exist, but structure should be correct
|
|
||||||
if (events.length > 0) {
|
|
||||||
assert.property(events[0], 'id')
|
|
||||||
assert.property(events[0], 'pubkey')
|
|
||||||
assert.property(events[0], 'created_at')
|
|
||||||
assert.property(events[0], 'kind')
|
|
||||||
assert.property(events[0], 'content')
|
|
||||||
assert.equal(events[0].kind, 1)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should query Alice posts - covers example 04', async () => {
|
|
||||||
// Alice's public key
|
|
||||||
const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
|
|
||||||
const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
|
|
||||||
const alicePubKey = getPublicKey(alicePrivKeyBin)
|
|
||||||
|
|
||||||
// Create subscription ID
|
|
||||||
const subId = 'read-alice-posts-' + Date.now()
|
|
||||||
|
|
||||||
// Create filters - read posts from Alice
|
|
||||||
const filters = {
|
|
||||||
limit: 2,
|
|
||||||
kinds: [1],
|
|
||||||
authors: [alicePubKey]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Query events using GET /req/:subId
|
|
||||||
const filtersJson = encodeURIComponent(JSON.stringify([filters]))
|
|
||||||
const url = `${baseUrl}/req/${subId}?filters=${filtersJson}`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
const events = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.isArray(events)
|
|
||||||
if (events.length > 0) {
|
|
||||||
assert.equal(events[0].pubkey, alicePubKey)
|
|
||||||
assert.equal(events[0].kind, 1)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should query kind 3 events (follow list) - covers example 05', async () => {
|
|
||||||
// Alice's public key
|
|
||||||
const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
|
|
||||||
const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
|
|
||||||
const alicePubKey = getPublicKey(alicePrivKeyBin)
|
|
||||||
|
|
||||||
// Create subscription ID
|
|
||||||
const subId = 'get-follow-list-' + Date.now()
|
|
||||||
|
|
||||||
// Create filters - get follow list (kind 3) from Alice
|
|
||||||
const filters = {
|
|
||||||
limit: 5,
|
|
||||||
kinds: [3],
|
|
||||||
authors: [alicePubKey]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Query events using GET /req/:subId
|
|
||||||
const filtersJson = encodeURIComponent(JSON.stringify([filters]))
|
|
||||||
const url = `${baseUrl}/req/${subId}?filters=${filtersJson}`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
const events = await response.json()
|
|
||||||
|
|
||||||
// Assert response
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.isArray(events)
|
|
||||||
if (events.length > 0) {
|
|
||||||
assert.equal(events[0].kind, 3)
|
|
||||||
assert.equal(events[0].pubkey, alicePubKey)
|
|
||||||
assert.isArray(events[0].tags)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should handle filters as individual query params', async () => {
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
const url = `${baseUrl}/req/${subId}?kinds=[1]&limit=10`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
const events = await response.json()
|
|
||||||
|
|
||||||
assert.equal(response.status, 200)
|
|
||||||
assert.isArray(events)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when subscription ID is missing', async () => {
|
|
||||||
const url = `${baseUrl}/req/?filters=${encodeURIComponent(JSON.stringify([{ kinds: [1] }]))}`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
await response.json()
|
|
||||||
|
|
||||||
// Should return 404 or 400
|
|
||||||
assert.isAtLeast(response.status, 400)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when filters JSON is invalid', async () => {
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
const url = `${baseUrl}/req/${subId}?filters=invalid-json{`
|
|
||||||
|
|
||||||
const response = await fetch(url)
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
assert.equal(response.status, 400)
|
|
||||||
assert.property(result, 'error')
|
|
||||||
assert.include(result.error, 'Invalid filters JSON')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,198 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for POST /req/:subId SSE subscription and DELETE /req/:subId.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Server from '../../../bin/server.js'
|
|
||||||
|
|
||||||
describe('#subscription-integration.js', () => {
|
|
||||||
let server
|
|
||||||
const baseUrl = 'http://localhost:3003' // Use different port for tests
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Start test server
|
|
||||||
server = new Server()
|
|
||||||
server.config.port = 3003
|
|
||||||
await server.startServer()
|
|
||||||
|
|
||||||
// Wait for server to be ready
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 1000))
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async function () {
|
|
||||||
this.timeout(10000) // Increase timeout for cleanup
|
|
||||||
// Stop server
|
|
||||||
if (server && server.server) {
|
|
||||||
// Close all connections forcefully if available
|
|
||||||
if (server.server.closeAllConnections) {
|
|
||||||
server.server.closeAllConnections()
|
|
||||||
}
|
|
||||||
|
|
||||||
await new Promise((resolve) => {
|
|
||||||
const timeout = setTimeout(() => {
|
|
||||||
resolve() // Force resolve after 2 seconds
|
|
||||||
}, 2000)
|
|
||||||
|
|
||||||
server.server.close(() => {
|
|
||||||
clearTimeout(timeout)
|
|
||||||
resolve()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('POST /req/:subId', () => {
|
|
||||||
it('should create SSE subscription', async () => {
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
const filters = { kinds: [1], limit: 10 }
|
|
||||||
|
|
||||||
const response = await fetch(`${baseUrl}/req/${subId}`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(filters)
|
|
||||||
})
|
|
||||||
|
|
||||||
// Assert SSE headers
|
|
||||||
assert.equal(response.headers.get('content-type'), 'text/event-stream')
|
|
||||||
assert.equal(response.headers.get('cache-control'), 'no-cache')
|
|
||||||
assert.equal(response.headers.get('connection'), 'keep-alive')
|
|
||||||
|
|
||||||
// Read initial connection message
|
|
||||||
const reader = response.body.getReader()
|
|
||||||
const decoder = new TextDecoder()
|
|
||||||
|
|
||||||
try {
|
|
||||||
const { value } = await reader.read()
|
|
||||||
const text = decoder.decode(value)
|
|
||||||
assert.include(text, 'connected')
|
|
||||||
assert.include(text, subId)
|
|
||||||
} finally {
|
|
||||||
reader.releaseLock()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when subscription ID is missing', async () => {
|
|
||||||
const filters = { kinds: [1] }
|
|
||||||
|
|
||||||
const response = await fetch(`${baseUrl}/req/`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(filters)
|
|
||||||
})
|
|
||||||
|
|
||||||
// Should return 404 or 400
|
|
||||||
assert.isAtLeast(response.status, 400)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when filters are missing', async () => {
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
|
|
||||||
const response = await fetch(`${baseUrl}/req/${subId}`, {
|
|
||||||
method: 'POST',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify({})
|
|
||||||
})
|
|
||||||
|
|
||||||
const result = await response.json()
|
|
||||||
|
|
||||||
assert.equal(response.status, 400)
|
|
||||||
assert.property(result, 'error')
|
|
||||||
assert.include(result.error, 'Filters are required')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('DELETE /req/:subId', () => {
|
|
||||||
it('should close a subscription', async () => {
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
|
|
||||||
const response = await fetch(`${baseUrl}/req/${subId}`, {
|
|
||||||
method: 'DELETE'
|
|
||||||
})
|
|
||||||
|
|
||||||
// May return 200 if subscription exists, or 500 if it doesn't
|
|
||||||
// The important thing is it doesn't crash
|
|
||||||
assert.isAtMost(response.status, 500)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return 400 when subscription ID is missing', async () => {
|
|
||||||
const response = await fetch(`${baseUrl}/req/`, {
|
|
||||||
method: 'DELETE'
|
|
||||||
})
|
|
||||||
|
|
||||||
// Should return 404 or 400
|
|
||||||
assert.isAtLeast(response.status, 400)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('PUT /req/:subId', () => {
|
|
||||||
it('should create SSE subscription (alternative method)', async function () {
|
|
||||||
this.timeout(10000) // Increase timeout for this test
|
|
||||||
|
|
||||||
const subId = 'test-sub-' + Date.now()
|
|
||||||
const filters = { kinds: [1], limit: 10 }
|
|
||||||
|
|
||||||
const controller = new AbortController()
|
|
||||||
const timeoutId = setTimeout(() => controller.abort(), 8000)
|
|
||||||
|
|
||||||
let response
|
|
||||||
try {
|
|
||||||
response = await fetch(`${baseUrl}/req/${subId}`, {
|
|
||||||
method: 'PUT',
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
},
|
|
||||||
body: JSON.stringify(filters),
|
|
||||||
signal: controller.signal
|
|
||||||
})
|
|
||||||
|
|
||||||
// Assert SSE headers
|
|
||||||
assert.equal(response.headers.get('content-type'), 'text/event-stream')
|
|
||||||
|
|
||||||
clearTimeout(timeoutId)
|
|
||||||
|
|
||||||
// Consume the stream to prevent hanging
|
|
||||||
const reader = response.body.getReader()
|
|
||||||
const decoder = new TextDecoder()
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Read initial connection message with timeout
|
|
||||||
const readPromise = reader.read()
|
|
||||||
const timeoutPromise = new Promise((resolve) => setTimeout(() => resolve({ value: null, done: true }), 2000))
|
|
||||||
const { value, done } = await Promise.race([readPromise, timeoutPromise])
|
|
||||||
|
|
||||||
if (value && !done) {
|
|
||||||
const text = decoder.decode(value)
|
|
||||||
assert.include(text, 'connected')
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
reader.releaseLock()
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
// AbortController aborted - this is expected
|
|
||||||
if (err.name !== 'AbortError') {
|
|
||||||
throw err
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
clearTimeout(timeoutId)
|
|
||||||
// Always close the subscription
|
|
||||||
try {
|
|
||||||
await fetch(`${baseUrl}/req/${subId}`, {
|
|
||||||
method: 'DELETE'
|
|
||||||
})
|
|
||||||
} catch (err) {
|
|
||||||
// Ignore errors when closing
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,163 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for ManageSubscriptionUseCase with real adapter.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Adapters from '../../../src/adapters/index.js'
|
|
||||||
import ManageSubscriptionUseCase from '../../../src/use-cases/manage-subscription.js'
|
|
||||||
|
|
||||||
describe('#manage-subscription-integration.js', () => {
|
|
||||||
let adapters
|
|
||||||
let uut
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Initialize adapters (will connect to real relay)
|
|
||||||
adapters = new Adapters()
|
|
||||||
await adapters.start()
|
|
||||||
|
|
||||||
uut = new ManageSubscriptionUseCase({ adapters })
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async () => {
|
|
||||||
// Clean up all subscriptions and disconnect from all relays
|
|
||||||
// Note: This is a simplified cleanup - in production you'd track all subscriptions
|
|
||||||
if (adapters && adapters.nostrRelays) {
|
|
||||||
await Promise.allSettled(
|
|
||||||
adapters.nostrRelays.map(relay => relay.disconnect())
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#createSubscription()', () => {
|
|
||||||
it('should successfully create a subscription', async () => {
|
|
||||||
const subscriptionId = 'test-sub-' + Date.now()
|
|
||||||
const filters = [{ kinds: [1], limit: 5 }]
|
|
||||||
|
|
||||||
let eventReceived = false
|
|
||||||
let eoseReceived = false
|
|
||||||
|
|
||||||
const onEvent = (event) => {
|
|
||||||
eventReceived = true
|
|
||||||
assert.property(event, 'id')
|
|
||||||
assert.property(event, 'kind')
|
|
||||||
}
|
|
||||||
|
|
||||||
const onEose = () => {
|
|
||||||
eoseReceived = true
|
|
||||||
}
|
|
||||||
|
|
||||||
const onClosed = () => {
|
|
||||||
// Handler for closed events
|
|
||||||
}
|
|
||||||
|
|
||||||
await uut.createSubscription(subscriptionId, filters, onEvent, onEose, onClosed)
|
|
||||||
|
|
||||||
// Assert subscription exists
|
|
||||||
assert.isTrue(uut.hasSubscription(subscriptionId))
|
|
||||||
|
|
||||||
// Wait a bit for events/EOSE
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 2000))
|
|
||||||
|
|
||||||
// EOSE should be received (or events)
|
|
||||||
// Note: May not receive events if none exist, but EOSE should come
|
|
||||||
assert.isTrue(eoseReceived || eventReceived)
|
|
||||||
|
|
||||||
// Clean up
|
|
||||||
if (uut.hasSubscription(subscriptionId)) {
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should prevent duplicate subscriptions', async () => {
|
|
||||||
const subscriptionId = 'test-dup-' + Date.now()
|
|
||||||
const filters = [{ kinds: [1] }]
|
|
||||||
|
|
||||||
await uut.createSubscription(subscriptionId, filters)
|
|
||||||
|
|
||||||
try {
|
|
||||||
await uut.createSubscription(subscriptionId, filters)
|
|
||||||
assert.equal(true, false, 'unexpected result')
|
|
||||||
} catch (err) {
|
|
||||||
assert.include(err.message, 'already exists')
|
|
||||||
}
|
|
||||||
|
|
||||||
// Clean up
|
|
||||||
if (uut.hasSubscription(subscriptionId)) {
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should handle subscription with no events', async () => {
|
|
||||||
const subscriptionId = 'test-empty-' + Date.now()
|
|
||||||
const filters = [{ kinds: [99999], limit: 1 }] // Unlikely to have events
|
|
||||||
|
|
||||||
let eoseReceived = false
|
|
||||||
|
|
||||||
const onEose = () => {
|
|
||||||
eoseReceived = true
|
|
||||||
}
|
|
||||||
|
|
||||||
await uut.createSubscription(subscriptionId, filters, null, onEose, null)
|
|
||||||
|
|
||||||
// Wait for EOSE
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 2000))
|
|
||||||
|
|
||||||
// Should receive EOSE even with no events
|
|
||||||
assert.isTrue(eoseReceived)
|
|
||||||
|
|
||||||
// Clean up
|
|
||||||
if (uut.hasSubscription(subscriptionId)) {
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#closeSubscription()', () => {
|
|
||||||
it('should successfully close a subscription', async () => {
|
|
||||||
const subscriptionId = 'test-close-' + Date.now()
|
|
||||||
const filters = [{ kinds: [1] }]
|
|
||||||
|
|
||||||
await uut.createSubscription(subscriptionId, filters)
|
|
||||||
assert.isTrue(uut.hasSubscription(subscriptionId))
|
|
||||||
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
|
|
||||||
// Assert subscription is removed
|
|
||||||
assert.isFalse(uut.hasSubscription(subscriptionId))
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return successfully when closing non-existent subscription (idempotent)', async () => {
|
|
||||||
const subscriptionId = 'non-existent-sub'
|
|
||||||
|
|
||||||
// Should not throw - idempotent operation
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
|
|
||||||
// Should return successfully without error
|
|
||||||
assert.isTrue(true, 'closeSubscription should succeed for non-existent subscription')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#hasSubscription()', () => {
|
|
||||||
it('should return false for non-existent subscription', () => {
|
|
||||||
assert.isFalse(uut.hasSubscription('non-existent'))
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return true for existing subscription', async () => {
|
|
||||||
const subscriptionId = 'test-has-' + Date.now()
|
|
||||||
const filters = [{ kinds: [1] }]
|
|
||||||
|
|
||||||
assert.isFalse(uut.hasSubscription(subscriptionId))
|
|
||||||
await uut.createSubscription(subscriptionId, filters)
|
|
||||||
assert.isTrue(uut.hasSubscription(subscriptionId))
|
|
||||||
|
|
||||||
// Clean up
|
|
||||||
if (uut.hasSubscription(subscriptionId)) {
|
|
||||||
await uut.closeSubscription(subscriptionId)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for PublishEventUseCase with real adapter.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Adapters from '../../../src/adapters/index.js'
|
|
||||||
import PublishEventUseCase from '../../../src/use-cases/publish-event.js'
|
|
||||||
import { finalizeEvent, generateSecretKey } from 'nostr-tools/pure'
|
|
||||||
|
|
||||||
describe('#publish-event-integration.js', () => {
|
|
||||||
let adapters
|
|
||||||
let uut
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Initialize adapters (will connect to real relay)
|
|
||||||
adapters = new Adapters()
|
|
||||||
await adapters.start()
|
|
||||||
|
|
||||||
uut = new PublishEventUseCase({ adapters })
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async () => {
|
|
||||||
// Clean up adapters - disconnect from all relays
|
|
||||||
if (adapters && adapters.nostrRelays) {
|
|
||||||
await Promise.allSettled(
|
|
||||||
adapters.nostrRelays.map(relay => relay.disconnect())
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#execute()', () => {
|
|
||||||
it('should successfully publish a valid event', async () => {
|
|
||||||
// Generate keys
|
|
||||||
const sk = generateSecretKey()
|
|
||||||
|
|
||||||
// Create event template
|
|
||||||
const eventTemplate = {
|
|
||||||
kind: 1,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
tags: [],
|
|
||||||
content: 'Integration test post from use case'
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sign the event
|
|
||||||
const signedEvent = finalizeEvent(eventTemplate, sk)
|
|
||||||
|
|
||||||
// Execute use case
|
|
||||||
const result = await uut.execute(signedEvent)
|
|
||||||
|
|
||||||
// Assert result
|
|
||||||
assert.property(result, 'accepted')
|
|
||||||
assert.property(result, 'message')
|
|
||||||
assert.property(result, 'eventId')
|
|
||||||
assert.equal(result.eventId, signedEvent.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should reject invalid event structure', async () => {
|
|
||||||
const invalidEvent = {
|
|
||||||
id: 'invalid',
|
|
||||||
pubkey: 'invalid',
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
kind: 1,
|
|
||||||
tags: [],
|
|
||||||
content: 'Test',
|
|
||||||
sig: 'invalid'
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
await uut.execute(invalidEvent)
|
|
||||||
assert.equal(true, false, 'unexpected result')
|
|
||||||
} catch (err) {
|
|
||||||
assert.include(err.message, 'Invalid event structure')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should handle relay rejection', async () => {
|
|
||||||
// Generate keys
|
|
||||||
const sk = generateSecretKey()
|
|
||||||
|
|
||||||
// Create a duplicate event (if we send same event twice)
|
|
||||||
const eventTemplate = {
|
|
||||||
kind: 1,
|
|
||||||
created_at: Math.floor(Date.now() / 1000),
|
|
||||||
tags: [],
|
|
||||||
content: 'Duplicate test post'
|
|
||||||
}
|
|
||||||
|
|
||||||
const signedEvent = finalizeEvent(eventTemplate, sk)
|
|
||||||
|
|
||||||
// Publish first time
|
|
||||||
const result1 = await uut.execute(signedEvent)
|
|
||||||
assert.property(result1, 'accepted')
|
|
||||||
|
|
||||||
// Try to publish again (may be rejected as duplicate)
|
|
||||||
const result2 = await uut.execute(signedEvent)
|
|
||||||
assert.property(result2, 'accepted')
|
|
||||||
// Result may be accepted or rejected depending on relay
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
/*
|
|
||||||
Integration tests for QueryEventsUseCase with real adapter.
|
|
||||||
These tests require a running Nostr relay.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Adapters from '../../../src/adapters/index.js'
|
|
||||||
import QueryEventsUseCase from '../../../src/use-cases/query-events.js'
|
|
||||||
|
|
||||||
describe('#query-events-integration.js', () => {
|
|
||||||
let adapters
|
|
||||||
let uut
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
// Initialize adapters (will connect to real relay)
|
|
||||||
adapters = new Adapters()
|
|
||||||
await adapters.start()
|
|
||||||
|
|
||||||
uut = new QueryEventsUseCase({ adapters })
|
|
||||||
})
|
|
||||||
|
|
||||||
after(async () => {
|
|
||||||
// Clean up adapters - disconnect from all relays
|
|
||||||
if (adapters && adapters.nostrRelays) {
|
|
||||||
await Promise.allSettled(
|
|
||||||
adapters.nostrRelays.map(relay => relay.disconnect())
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#execute()', () => {
|
|
||||||
it('should successfully query events', async () => {
|
|
||||||
const filters = [{ kinds: [1], limit: 5 }]
|
|
||||||
const subscriptionId = 'test-query-' + Date.now()
|
|
||||||
|
|
||||||
const events = await uut.execute(filters, subscriptionId)
|
|
||||||
|
|
||||||
// Assert result is an array
|
|
||||||
assert.isArray(events)
|
|
||||||
|
|
||||||
// If events are returned, verify structure
|
|
||||||
if (events.length > 0) {
|
|
||||||
assert.property(events[0], 'id')
|
|
||||||
assert.property(events[0], 'pubkey')
|
|
||||||
assert.property(events[0], 'created_at')
|
|
||||||
assert.property(events[0], 'kind')
|
|
||||||
assert.property(events[0], 'content')
|
|
||||||
assert.equal(events[0].kind, 1)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should handle empty results', async () => {
|
|
||||||
// Query for events that likely don't exist
|
|
||||||
const filters = [{ kinds: [99999], limit: 1 }]
|
|
||||||
const subscriptionId = 'test-empty-' + Date.now()
|
|
||||||
|
|
||||||
const events = await uut.execute(filters, subscriptionId)
|
|
||||||
|
|
||||||
// Should return empty array, not throw
|
|
||||||
assert.isArray(events)
|
|
||||||
assert.equal(events.length, 0)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should handle multiple filters', async function () {
|
|
||||||
// Increase timeout for this test - needs to be longer than use case timeout (30s)
|
|
||||||
this.timeout(35000)
|
|
||||||
|
|
||||||
const filters = [
|
|
||||||
{ kinds: [1], limit: 2 },
|
|
||||||
{ kinds: [3], limit: 2 }
|
|
||||||
]
|
|
||||||
const subscriptionId = 'test-multi-' + Date.now()
|
|
||||||
|
|
||||||
const events = await uut.execute(filters, subscriptionId)
|
|
||||||
|
|
||||||
// Should return array (may be empty)
|
|
||||||
assert.isArray(events)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should timeout if EOSE not received', async () => {
|
|
||||||
// This test may take up to 30 seconds
|
|
||||||
// Use a filter that might not return EOSE quickly
|
|
||||||
const filters = [{ kinds: [1] }] // No limit, might timeout
|
|
||||||
const subscriptionId = 'test-timeout-' + Date.now()
|
|
||||||
|
|
||||||
// Should eventually return (even if empty)
|
|
||||||
const events = await uut.execute(filters, subscriptionId)
|
|
||||||
|
|
||||||
assert.isArray(events)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -161,8 +161,7 @@ describe('#blockchain-controller.js', () => {
|
|||||||
it('should validate array size and call use case', async () => {
|
it('should validate array size and call use case', async () => {
|
||||||
const hash = 'a'.repeat(64)
|
const hash = 'a'.repeat(64)
|
||||||
const req = createMockRequest({
|
const req = createMockRequest({
|
||||||
body: { hashes: [hash], verbose: true },
|
body: { hashes: [hash], verbose: true }
|
||||||
locals: { proLimit: false }
|
|
||||||
})
|
})
|
||||||
const res = createMockResponse()
|
const res = createMockResponse()
|
||||||
mockUseCases.blockchain.getBlockHeaders.resolves(['result'])
|
mockUseCases.blockchain.getBlockHeaders.resolves(['result'])
|
||||||
@@ -172,7 +171,7 @@ describe('#blockchain-controller.js', () => {
|
|||||||
assert.equal(res.statusValue, 200)
|
assert.equal(res.statusValue, 200)
|
||||||
assert.deepEqual(res.jsonData, ['result'])
|
assert.deepEqual(res.jsonData, ['result'])
|
||||||
assert.isTrue(
|
assert.isTrue(
|
||||||
mockAdapters.fullNode.validateArraySize.calledOnceWithExactly(1, { isProUser: false })
|
mockAdapters.fullNode.validateArraySize.calledOnceWithExactly(1)
|
||||||
)
|
)
|
||||||
assert.isTrue(
|
assert.isTrue(
|
||||||
mockUseCases.blockchain.getBlockHeaders.calledOnceWithExactly({
|
mockUseCases.blockchain.getBlockHeaders.calledOnceWithExactly({
|
||||||
|
|||||||
@@ -0,0 +1,203 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for EncryptionRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import EncryptionRESTController from '../../../src/controllers/rest-api/encryption/controller.js'
|
||||||
|
import { createMockRequest, createMockResponse, createMockRequestWithParams } from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
describe('#encryption-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockUseCases
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
mockUseCases = {
|
||||||
|
encryption: {
|
||||||
|
getPublicKey: sandbox.stub().resolves({
|
||||||
|
success: true,
|
||||||
|
publicKey: '02abc123def456789'
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new EncryptionRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new EncryptionRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require encryption use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new EncryptionRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /Encryption use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return encryption status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'encryption' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getPublicKey()', () => {
|
||||||
|
it('should return public key on success', async () => {
|
||||||
|
const req = createMockRequestWithParams({
|
||||||
|
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: true,
|
||||||
|
publicKey: '02abc123def456789'
|
||||||
|
})
|
||||||
|
assert.isTrue(mockUseCases.encryption.getPublicKey.calledOnce)
|
||||||
|
assert.isTrue(mockUseCases.encryption.getPublicKey.calledWith({
|
||||||
|
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return not found when public key is not found', async () => {
|
||||||
|
mockUseCases.encryption.getPublicKey.resolves({
|
||||||
|
success: false,
|
||||||
|
publicKey: 'not found'
|
||||||
|
})
|
||||||
|
|
||||||
|
const req = createMockRequestWithParams({
|
||||||
|
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
publicKey: 'not found'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should reject array addresses', async () => {
|
||||||
|
const req = createMockRequestWithParams({
|
||||||
|
address: ['addr1', 'addr2']
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'address can not be an array.'
|
||||||
|
})
|
||||||
|
assert.isFalse(mockUseCases.encryption.getPublicKey.called)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should reject missing address', async () => {
|
||||||
|
const req = createMockRequestWithParams({})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'address is required.'
|
||||||
|
})
|
||||||
|
assert.isFalse(mockUseCases.encryption.getPublicKey.called)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('No transaction history.')
|
||||||
|
error.status = 400
|
||||||
|
mockUseCases.encryption.getPublicKey.rejects(error)
|
||||||
|
|
||||||
|
const req = createMockRequestWithParams({
|
||||||
|
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'No transaction history.'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should default to 500 status for errors without status', async () => {
|
||||||
|
const error = new Error('Internal error')
|
||||||
|
mockUseCases.encryption.getPublicKey.rejects(error)
|
||||||
|
|
||||||
|
const req = createMockRequestWithParams({
|
||||||
|
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPublicKey(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'Internal error'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#handleError()', () => {
|
||||||
|
it('should use error status and message when provided', () => {
|
||||||
|
const error = new Error('Custom error')
|
||||||
|
error.status = 422
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
uut.handleError(error, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 422)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'Custom error'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should default to 500 and Internal server error', () => {
|
||||||
|
const error = {}
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
uut.handleError(error, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, {
|
||||||
|
success: false,
|
||||||
|
error: 'Internal server error'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,481 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for FulcrumRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import FulcrumRESTController from '../../../src/controllers/rest-api/fulcrum/controller.js'
|
||||||
|
import {
|
||||||
|
createMockRequest,
|
||||||
|
createMockResponse
|
||||||
|
} from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
// Valid mainnet cash address for testing
|
||||||
|
const VALID_MAINNET_ADDRESS = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
|
||||||
|
describe('#fulcrum-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockUseCases
|
||||||
|
let mockAdapters
|
||||||
|
let uut
|
||||||
|
|
||||||
|
const createFulcrumUseCaseStubs = () => ({
|
||||||
|
getBalance: sandbox.stub().resolves({ balance: 1000 }),
|
||||||
|
getBalances: sandbox.stub().resolves({ balances: [] }),
|
||||||
|
getUtxos: sandbox.stub().resolves({ utxos: [] }),
|
||||||
|
getUtxosBulk: sandbox.stub().resolves({ utxos: [] }),
|
||||||
|
getTransactionDetails: sandbox.stub().resolves({ txid: 'abc' }),
|
||||||
|
getTransactionDetailsBulk: sandbox.stub().resolves({ transactions: [] }),
|
||||||
|
broadcastTransaction: sandbox.stub().resolves({ txid: 'abc' }),
|
||||||
|
getBlockHeaders: sandbox.stub().resolves({ headers: [] }),
|
||||||
|
getBlockHeadersBulk: sandbox.stub().resolves({ headers: [] }),
|
||||||
|
getTransactions: sandbox.stub().resolves({ transactions: [] }),
|
||||||
|
getTransactionsBulk: sandbox.stub().resolves({ transactions: [] }),
|
||||||
|
getMempool: sandbox.stub().resolves({ mempool: [] }),
|
||||||
|
getMempoolBulk: sandbox.stub().resolves({ mempool: [] })
|
||||||
|
})
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {
|
||||||
|
fullNode: {
|
||||||
|
validateArraySize: sandbox.stub().returns(true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mockUseCases = {
|
||||||
|
fulcrum: createFulcrumUseCaseStubs()
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new FulcrumRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new FulcrumRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require fulcrum use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new FulcrumRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /Fulcrum use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return service status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'fulcrum' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBalance()', () => {
|
||||||
|
it('should return balance on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBalance(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { balance: 1000 })
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getBalance.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if address is array', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: [] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBalance(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('failure')
|
||||||
|
error.status = 503
|
||||||
|
mockUseCases.fulcrum.getBalance.rejects(error)
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBalance(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 503)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'failure' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#balanceBulk()', () => {
|
||||||
|
it('should return error if addresses is not array', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: 'not-an-array' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.balanceBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should validate array size and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: [VALID_MAINNET_ADDRESS] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.balanceBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockAdapters.fullNode.validateArraySize.calledOnce)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getBalances.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if array size invalid', async () => {
|
||||||
|
mockAdapters.fullNode.validateArraySize.returns(false)
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: [VALID_MAINNET_ADDRESS] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.balanceBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.equal(res.jsonData.error, 'Array too large.')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getUtxos()', () => {
|
||||||
|
it('should return utxos on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getUtxos(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { utxos: [] })
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getUtxos.calledOnce)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#utxosBulk()', () => {
|
||||||
|
it('should validate array and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: [VALID_MAINNET_ADDRESS] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.utxosBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getUtxosBulk.calledOnce)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactionDetails()', () => {
|
||||||
|
it('should return transaction details on success', async () => {
|
||||||
|
const txid = 'a'.repeat(64)
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { txid }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTransactionDetails(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { txid: 'abc' })
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getTransactionDetails.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if txid is not string', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { txid: 123 }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTransactionDetails(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#transactionDetailsBulk()', () => {
|
||||||
|
it('should validate array and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txids: ['a'.repeat(64)], verbose: true }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.transactionDetailsBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getTransactionDetailsBulk.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should default verbose to true', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txids: ['a'.repeat(64)] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.transactionDetailsBulk(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockUseCases.fulcrum.getTransactionDetailsBulk.calledWithMatch({
|
||||||
|
txids: ['a'.repeat(64)],
|
||||||
|
verbose: true
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#broadcastTransaction()', () => {
|
||||||
|
it('should broadcast transaction on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txHex: '010203' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.broadcastTransaction(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { txid: 'abc' })
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.broadcastTransaction.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if txHex is not string', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txHex: 123 }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.broadcastTransaction(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBlockHeaders()', () => {
|
||||||
|
it('should return block headers on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { height: '100' },
|
||||||
|
query: { count: '2' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBlockHeaders(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(
|
||||||
|
mockUseCases.fulcrum.getBlockHeaders.calledWithMatch({
|
||||||
|
height: 100,
|
||||||
|
count: 2
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should default count to 1', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { height: '100' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBlockHeaders(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockUseCases.fulcrum.getBlockHeaders.calledWithMatch({
|
||||||
|
height: 100,
|
||||||
|
count: 1
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if height is invalid', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { height: 'invalid' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBlockHeaders(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#blockHeadersBulk()', () => {
|
||||||
|
it('should validate heights array and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { heights: [{ height: 100, count: 2 }] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.blockHeadersBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getBlockHeadersBulk.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if heights is not array', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { heights: 'not-an-array' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.blockHeadersBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should validate height objects', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { heights: [{ height: 'invalid', count: 2 }] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.blockHeadersBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactions()', () => {
|
||||||
|
it('should return transactions on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTransactions(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getTransactions.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle allTxs from params', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS, allTxs: 'true' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTransactions(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockUseCases.fulcrum.getTransactions.calledWithMatch({
|
||||||
|
address: VALID_MAINNET_ADDRESS,
|
||||||
|
allTxs: true
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle allTxs from query', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS },
|
||||||
|
query: { allTxs: 'true' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTransactions(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockUseCases.fulcrum.getTransactions.calledWithMatch({
|
||||||
|
allTxs: true
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#transactionsBulk()', () => {
|
||||||
|
it('should validate addresses and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: [VALID_MAINNET_ADDRESS], allTxs: true }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.transactionsBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getTransactionsBulk.calledOnce)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMempool()', () => {
|
||||||
|
it('should return mempool on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
params: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getMempool(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { mempool: [] })
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getMempool.calledOnce)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#mempoolBulk()', () => {
|
||||||
|
it('should validate addresses and call use case', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { addresses: [VALID_MAINNET_ADDRESS] }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.mempoolBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getMempoolBulk.calledOnce)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#handleError()', () => {
|
||||||
|
it('should handle errors with status', async () => {
|
||||||
|
const error = new Error('test error')
|
||||||
|
error.status = 400
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
uut.handleError(error, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'test error' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should default status to 500', async () => {
|
||||||
|
const error = new Error('test error')
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
uut.handleError(error, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'test error' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for MiningRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import MiningRESTController from '../../../src/controllers/rest-api/full-node/mining/controller.js'
|
||||||
|
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
describe('#mining-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockUseCases
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
mockUseCases = {
|
||||||
|
mining: {
|
||||||
|
getMiningInfo: sandbox.stub().resolves({ blocks: 100, difficulty: 1.5 }),
|
||||||
|
getNetworkHashPS: sandbox.stub().resolves(1234567890)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new MiningRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new MiningRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require mining use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new MiningRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /Mining use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return mining status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'mining' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMiningInfo()', () => {
|
||||||
|
it('should return mining info on success', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getMiningInfo(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { blocks: 100, difficulty: 1.5 })
|
||||||
|
assert.isTrue(mockUseCases.mining.getMiningInfo.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('failure')
|
||||||
|
error.status = 503
|
||||||
|
mockUseCases.mining.getMiningInfo.rejects(error)
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getMiningInfo(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 503)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'failure' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNetworkHashPS()', () => {
|
||||||
|
it('should return network hash PS with default params', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getNetworkHashPS(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.equal(res.jsonData, 1234567890)
|
||||||
|
assert.isTrue(mockUseCases.mining.getNetworkHashPS.calledOnce)
|
||||||
|
assert.deepEqual(mockUseCases.mining.getNetworkHashPS.firstCall.args[0], {
|
||||||
|
nblocks: 120,
|
||||||
|
height: -1
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should parse query params for nblocks and height', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
query: {
|
||||||
|
nblocks: '240',
|
||||||
|
height: '1000'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getNetworkHashPS(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.isTrue(mockUseCases.mining.getNetworkHashPS.calledOnce)
|
||||||
|
assert.deepEqual(mockUseCases.mining.getNetworkHashPS.firstCall.args[0], {
|
||||||
|
nblocks: 240,
|
||||||
|
height: 1000
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('RPC error')
|
||||||
|
error.status = 500
|
||||||
|
mockUseCases.mining.getNetworkHashPS.rejects(error)
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getNetworkHashPS(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'RPC error' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for PriceRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import PriceRESTController from '../../../src/controllers/rest-api/price/controller.js'
|
||||||
|
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
describe('#price-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockUseCases
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
mockUseCases = {
|
||||||
|
price: {
|
||||||
|
getBCHUSD: sandbox.stub().resolves(250.5),
|
||||||
|
getPsffppWritePrice: sandbox.stub().resolves(0.08335233)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new PriceRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new PriceRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require price use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new PriceRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /Price use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return price status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'price' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBCHUSD()', () => {
|
||||||
|
it('should return BCH USD price on success', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBCHUSD(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { usd: 250.5 })
|
||||||
|
assert.isTrue(mockUseCases.price.getBCHUSD.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('API failure')
|
||||||
|
error.status = 503
|
||||||
|
mockUseCases.price.getBCHUSD.rejects(error)
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getBCHUSD(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 503)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'API failure' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getPsffppWritePrice()', () => {
|
||||||
|
it('should return PSFFPP write price on success', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPsffppWritePrice(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { writePrice: 0.08335233 })
|
||||||
|
assert.isTrue(mockUseCases.price.getPsffppWritePrice.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('PSFFPP failure')
|
||||||
|
error.status = 500
|
||||||
|
mockUseCases.price.getPsffppWritePrice.rejects(error)
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getPsffppWritePrice(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'PSFFPP failure' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,388 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for RawTransactionsRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import RawTransactionsRESTController from '../../../src/controllers/rest-api/full-node/rawtransactions/controller.js'
|
||||||
|
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
describe('#rawtransactions-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockUseCases
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {
|
||||||
|
fullNode: {
|
||||||
|
validateArraySize: sandbox.stub().returns(true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mockUseCases = {
|
||||||
|
rawtransactions: {
|
||||||
|
decodeRawTransaction: sandbox.stub().resolves({ txid: 'abc123' }),
|
||||||
|
decodeRawTransactions: sandbox.stub().resolves([{ txid: 'abc123' }]),
|
||||||
|
decodeScript: sandbox.stub().resolves({ asm: 'OP_DUP' }),
|
||||||
|
decodeScripts: sandbox.stub().resolves([{ asm: 'OP_DUP' }]),
|
||||||
|
getRawTransaction: sandbox.stub().resolves({ txid: 'abc123' }),
|
||||||
|
getRawTransactionWithHeight: sandbox.stub().resolves({ txid: 'abc123', height: 100 }),
|
||||||
|
getRawTransactions: sandbox.stub().resolves([{ txid: 'abc123' }]),
|
||||||
|
sendRawTransaction: sandbox.stub().resolves('txid123'),
|
||||||
|
sendRawTransactions: sandbox.stub().resolves(['txid1', 'txid2'])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new RawTransactionsRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new RawTransactionsRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require rawtransactions use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new RawTransactionsRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /RawTransactions use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return rawtransactions status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'rawtransactions' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeRawTransactionSingle()', () => {
|
||||||
|
it('should return decoded transaction on success', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '01000000' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { txid: 'abc123' })
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.decodeRawTransaction.calledOnce)
|
||||||
|
assert.deepEqual(mockUseCases.rawtransactions.decodeRawTransaction.firstCall.args[0], { hex: '01000000' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hex is empty', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'hex can not be empty' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('RPC error')
|
||||||
|
error.status = 500
|
||||||
|
mockUseCases.rawtransactions.decodeRawTransaction.rejects(error)
|
||||||
|
const req = createMockRequest({ params: { hex: '01000000' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 500)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'RPC error' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeRawTransactionBulk()', () => {
|
||||||
|
it('should return decoded transactions on success', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: ['hex1', 'hex2'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, [{ txid: 'abc123' }])
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.decodeRawTransactions.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hexes is not an array', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: 'not-array' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'hexes must be an array' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if array is too large', async () => {
|
||||||
|
mockAdapters.fullNode.validateArraySize.returns(false)
|
||||||
|
const req = createMockRequest({ body: { hexes: new Array(25).fill('hex') } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Array too large.' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if empty hex encountered', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: ['hex1', '', 'hex2'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Encountered empty hex' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeScriptSingle()', () => {
|
||||||
|
it('should return decoded script on success', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '76a914' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeScriptSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { asm: 'OP_DUP' })
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.decodeScript.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hex is empty', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeScriptSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'hex can not be empty' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeScriptBulk()', () => {
|
||||||
|
it('should return decoded scripts on success', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: ['script1', 'script2'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeScriptBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, [{ asm: 'OP_DUP' }])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if array is too large', async () => {
|
||||||
|
mockAdapters.fullNode.validateArraySize.returns(false)
|
||||||
|
const req = createMockRequest({ body: { hexes: new Array(25).fill('script') } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.decodeScriptBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Array too large.' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getRawTransactionSingle()', () => {
|
||||||
|
it('should return raw transaction on success', async () => {
|
||||||
|
const req = createMockRequest({ params: { txid: 'a'.repeat(64) }, query: {} })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { txid: 'abc123', height: 100 })
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.getRawTransactionWithHeight.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should pass verbose=true when query param is set', async () => {
|
||||||
|
const req = createMockRequest({ params: { txid: 'a'.repeat(64) }, query: { verbose: 'true' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.getRawTransactionWithHeight.calledOnce)
|
||||||
|
assert.deepEqual(mockUseCases.rawtransactions.getRawTransactionWithHeight.firstCall.args[0], {
|
||||||
|
txid: 'a'.repeat(64),
|
||||||
|
verbose: true
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if txid is empty', async () => {
|
||||||
|
const req = createMockRequest({ params: { txid: '' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'txid can not be empty' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if txid length is not 64', async () => {
|
||||||
|
const req = createMockRequest({ params: { txid: 'short' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'parameter 1 must be of length 64 (not 5)' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getRawTransactionBulk()', () => {
|
||||||
|
it('should return raw transactions on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: {
|
||||||
|
txids: ['a'.repeat(64), 'b'.repeat(64)],
|
||||||
|
verbose: true
|
||||||
|
}
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, [{ txid: 'abc123' }])
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.getRawTransactions.calledOnce)
|
||||||
|
assert.deepEqual(mockUseCases.rawtransactions.getRawTransactions.firstCall.args[0], {
|
||||||
|
txids: ['a'.repeat(64), 'b'.repeat(64)],
|
||||||
|
verbose: true
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if txids is not an array', async () => {
|
||||||
|
const req = createMockRequest({ body: { txids: 'not-array' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'txids must be an array' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if array is too large', async () => {
|
||||||
|
mockAdapters.fullNode.validateArraySize.returns(false)
|
||||||
|
const req = createMockRequest({ body: { txids: new Array(25).fill('a'.repeat(64)) } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Array too large.' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if empty txid encountered', async () => {
|
||||||
|
const req = createMockRequest({ body: { txids: ['a'.repeat(64), ''] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Encountered empty TXID' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if txid length is not 64', async () => {
|
||||||
|
const req = createMockRequest({ body: { txids: ['short'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'parameter 1 must be of length 64 (not 5)' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#sendRawTransactionSingle()', () => {
|
||||||
|
it('should return txid on success', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '01000000' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.equal(res.jsonData, 'txid123')
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.sendRawTransaction.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hex is empty', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: '' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Encountered empty hex' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hex is not a string', async () => {
|
||||||
|
const req = createMockRequest({ params: { hex: 123 } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionSingle(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'hex must be a string' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#sendRawTransactionBulk()', () => {
|
||||||
|
it('should return txids on success', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: ['hex1', 'hex2'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, ['txid1', 'txid2'])
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.sendRawTransactions.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if hexes is not an array', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: 'not-array' } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'hex must be an array' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if array is too large', async () => {
|
||||||
|
mockAdapters.fullNode.validateArraySize.returns(false)
|
||||||
|
const req = createMockRequest({ body: { hexes: new Array(25).fill('hex') } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Array too large.' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return 400 if empty hex encountered', async () => {
|
||||||
|
const req = createMockRequest({ body: { hexes: ['hex1', '', 'hex2'] } })
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.sendRawTransactionBulk(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Encountered empty hex' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -6,9 +6,15 @@ import { assert } from 'chai'
|
|||||||
import sinon from 'sinon'
|
import sinon from 'sinon'
|
||||||
|
|
||||||
import RESTControllers from '../../../src/controllers/rest-api/index.js'
|
import RESTControllers from '../../../src/controllers/rest-api/index.js'
|
||||||
import BlockchainRouter from '../../../src/controllers/rest-api/full-node/blockchain/index.js'
|
import BlockchainRouter from '../../../src/controllers/rest-api/full-node/blockchain/router.js'
|
||||||
import ControlRouter from '../../../src/controllers/rest-api/full-node/control/index.js'
|
import ControlRouter from '../../../src/controllers/rest-api/full-node/control/router.js'
|
||||||
import DSProofRouter from '../../../src/controllers/rest-api/full-node/dsproof/index.js'
|
import DSProofRouter from '../../../src/controllers/rest-api/full-node/dsproof/router.js'
|
||||||
|
import EncryptionRouter from '../../../src/controllers/rest-api/encryption/router.js'
|
||||||
|
import MiningRouter from '../../../src/controllers/rest-api/full-node/mining/router.js'
|
||||||
|
import PriceRouter from '../../../src/controllers/rest-api/price/router.js'
|
||||||
|
import RawTransactionsRouter from '../../../src/controllers/rest-api/full-node/rawtransactions/router.js'
|
||||||
|
import FulcrumRouter from '../../../src/controllers/rest-api/fulcrum/router.js'
|
||||||
|
import SlpRouter from '../../../src/controllers/rest-api/slp/router.js'
|
||||||
|
|
||||||
describe('#controllers/rest-api/index.js', () => {
|
describe('#controllers/rest-api/index.js', () => {
|
||||||
let sandbox
|
let sandbox
|
||||||
@@ -51,6 +57,53 @@ describe('#controllers/rest-api/index.js', () => {
|
|||||||
},
|
},
|
||||||
dsproof: {
|
dsproof: {
|
||||||
getDSProof: () => {}
|
getDSProof: () => {}
|
||||||
|
},
|
||||||
|
fulcrum: {
|
||||||
|
getBalance: () => {},
|
||||||
|
getBalances: () => {},
|
||||||
|
getUtxos: () => {},
|
||||||
|
getUtxosBulk: () => {},
|
||||||
|
getTransactionDetails: () => {},
|
||||||
|
getTransactionDetailsBulk: () => {},
|
||||||
|
broadcastTransaction: () => {},
|
||||||
|
getBlockHeaders: () => {},
|
||||||
|
getBlockHeadersBulk: () => {},
|
||||||
|
getTransactions: () => {},
|
||||||
|
getTransactionsBulk: () => {},
|
||||||
|
getMempool: () => {},
|
||||||
|
getMempoolBulk: () => {}
|
||||||
|
},
|
||||||
|
mining: {
|
||||||
|
getMiningInfo: () => {},
|
||||||
|
getNetworkHashPS: () => {}
|
||||||
|
},
|
||||||
|
price: {
|
||||||
|
getBCHUSD: () => {},
|
||||||
|
getPsffppWritePrice: () => {}
|
||||||
|
},
|
||||||
|
rawtransactions: {
|
||||||
|
decodeRawTransaction: () => {},
|
||||||
|
decodeRawTransactions: () => {},
|
||||||
|
decodeScript: () => {},
|
||||||
|
decodeScripts: () => {},
|
||||||
|
getRawTransaction: () => {},
|
||||||
|
getRawTransactionWithHeight: () => {},
|
||||||
|
getRawTransactions: () => {},
|
||||||
|
sendRawTransaction: () => {},
|
||||||
|
sendRawTransactions: () => {}
|
||||||
|
},
|
||||||
|
slp: {
|
||||||
|
getStatus: () => {},
|
||||||
|
getAddress: () => {},
|
||||||
|
getTxid: () => {},
|
||||||
|
getTokenStats: () => {},
|
||||||
|
getTokenData: () => {},
|
||||||
|
getMutableCid: () => {},
|
||||||
|
decodeOpReturn: () => {},
|
||||||
|
getCIDData: () => {}
|
||||||
|
},
|
||||||
|
encryption: {
|
||||||
|
getPublicKey: () => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -80,6 +133,12 @@ describe('#controllers/rest-api/index.js', () => {
|
|||||||
const blockchainAttachStub = sandbox.stub(BlockchainRouter.prototype, 'attach')
|
const blockchainAttachStub = sandbox.stub(BlockchainRouter.prototype, 'attach')
|
||||||
const controlAttachStub = sandbox.stub(ControlRouter.prototype, 'attach')
|
const controlAttachStub = sandbox.stub(ControlRouter.prototype, 'attach')
|
||||||
const dsproofAttachStub = sandbox.stub(DSProofRouter.prototype, 'attach')
|
const dsproofAttachStub = sandbox.stub(DSProofRouter.prototype, 'attach')
|
||||||
|
const encryptionAttachStub = sandbox.stub(EncryptionRouter.prototype, 'attach')
|
||||||
|
const fulcrumAttachStub = sandbox.stub(FulcrumRouter.prototype, 'attach')
|
||||||
|
const miningAttachStub = sandbox.stub(MiningRouter.prototype, 'attach')
|
||||||
|
const priceAttachStub = sandbox.stub(PriceRouter.prototype, 'attach')
|
||||||
|
const rawtransactionsAttachStub = sandbox.stub(RawTransactionsRouter.prototype, 'attach')
|
||||||
|
const slpAttachStub = sandbox.stub(SlpRouter.prototype, 'attach')
|
||||||
const restControllers = new RESTControllers({
|
const restControllers = new RESTControllers({
|
||||||
adapters: mockAdapters,
|
adapters: mockAdapters,
|
||||||
useCases: mockUseCases
|
useCases: mockUseCases
|
||||||
@@ -94,6 +153,18 @@ describe('#controllers/rest-api/index.js', () => {
|
|||||||
assert.equal(controlAttachStub.getCall(0).args[0], app)
|
assert.equal(controlAttachStub.getCall(0).args[0], app)
|
||||||
assert.isTrue(dsproofAttachStub.calledOnce)
|
assert.isTrue(dsproofAttachStub.calledOnce)
|
||||||
assert.equal(dsproofAttachStub.getCall(0).args[0], app)
|
assert.equal(dsproofAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(encryptionAttachStub.calledOnce)
|
||||||
|
assert.equal(encryptionAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(fulcrumAttachStub.calledOnce)
|
||||||
|
assert.equal(fulcrumAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(miningAttachStub.calledOnce)
|
||||||
|
assert.equal(miningAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(priceAttachStub.calledOnce)
|
||||||
|
assert.equal(priceAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(rawtransactionsAttachStub.calledOnce)
|
||||||
|
assert.equal(rawtransactionsAttachStub.getCall(0).args[0], app)
|
||||||
|
assert.isTrue(slpAttachStub.calledOnce)
|
||||||
|
assert.equal(slpAttachStub.getCall(0).args[0], app)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -0,0 +1,312 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for SlpRESTController.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import SlpRESTController from '../../../src/controllers/rest-api/slp/controller.js'
|
||||||
|
import {
|
||||||
|
createMockRequest,
|
||||||
|
createMockResponse
|
||||||
|
} from '../mocks/controller-mocks.js'
|
||||||
|
|
||||||
|
// Valid mainnet cash address for testing
|
||||||
|
const VALID_MAINNET_ADDRESS = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
|
||||||
|
describe('#slp-controller.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockUseCases
|
||||||
|
let mockAdapters
|
||||||
|
let uut
|
||||||
|
|
||||||
|
const createSlpUseCaseStubs = () => ({
|
||||||
|
getStatus: sandbox.stub().resolves({ status: 'ok' }),
|
||||||
|
getAddress: sandbox.stub().resolves({ balance: 1000 }),
|
||||||
|
getTxid: sandbox.stub().resolves({ txid: 'abc' }),
|
||||||
|
getTokenStats: sandbox.stub().resolves({ tokenData: {} }),
|
||||||
|
getTokenData: sandbox.stub().resolves({ genesisData: {}, immutableData: '', mutableData: '' })
|
||||||
|
})
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
mockUseCases = {
|
||||||
|
slp: createSlpUseCaseStubs()
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new SlpRESTController({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new SlpRESTController({ useCases: mockUseCases })
|
||||||
|
}, /Adapters library required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require slp use cases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new SlpRESTController({ adapters: mockAdapters, useCases: {} })
|
||||||
|
}, /SLP use cases required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#root()', () => {
|
||||||
|
it('should return service status', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.root(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'psf-slp-indexer' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getStatus()', () => {
|
||||||
|
it('should return status on success', async () => {
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getStatus(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { status: 'ok' })
|
||||||
|
assert.isTrue(mockUseCases.slp.getStatus.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('failure')
|
||||||
|
error.status = 503
|
||||||
|
mockUseCases.slp.getStatus.rejects(error)
|
||||||
|
const req = createMockRequest()
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getStatus(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 503)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'failure' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getAddress()', () => {
|
||||||
|
it('should return address balance on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getAddress(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { balance: 1000 })
|
||||||
|
assert.isTrue(mockUseCases.slp.getAddress.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if address is empty', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { address: '' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getAddress(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
assert.include(res.jsonData.error, 'can not be empty')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if address is missing', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: {}
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getAddress(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('Invalid address')
|
||||||
|
error.status = 400
|
||||||
|
mockUseCases.slp.getAddress.rejects(error)
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { address: VALID_MAINNET_ADDRESS }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getAddress(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Invalid address' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTxid()', () => {
|
||||||
|
it('should return transaction data on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txid: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTxid(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { txid: 'abc' })
|
||||||
|
assert.isTrue(mockUseCases.slp.getTxid.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if txid is empty', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txid: '' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTxid(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
assert.include(res.jsonData.error, 'can not be empty')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if txid is not 64 characters', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txid: 'abc' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTxid(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
assert.include(res.jsonData.error, 'not a txid')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('Transaction not found')
|
||||||
|
error.status = 404
|
||||||
|
mockUseCases.slp.getTxid.rejects(error)
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { txid: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTxid(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 404)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Transaction not found' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTokenStats()', () => {
|
||||||
|
it('should return token stats on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenStats(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.deepEqual(res.jsonData, { tokenData: {} })
|
||||||
|
assert.isTrue(mockUseCases.slp.getTokenStats.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should pass withTxHistory flag', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: 'a'.repeat(64), withTxHistory: true }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenStats(req, res)
|
||||||
|
|
||||||
|
assert.isTrue(mockUseCases.slp.getTokenStats.calledWith({
|
||||||
|
tokenId: 'a'.repeat(64),
|
||||||
|
withTxHistory: true
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if tokenId is empty', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: '' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenStats(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('Token not found')
|
||||||
|
error.status = 404
|
||||||
|
mockUseCases.slp.getTokenStats.rejects(error)
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenStats(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 404)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Token not found' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTokenData()', () => {
|
||||||
|
it('should return token data on success', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenData(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 200)
|
||||||
|
assert.property(res.jsonData, 'genesisData')
|
||||||
|
assert.property(res.jsonData, 'immutableData')
|
||||||
|
assert.property(res.jsonData, 'mutableData')
|
||||||
|
assert.isTrue(mockUseCases.slp.getTokenData.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return error if tokenId is empty', async () => {
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: '' }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenData(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 400)
|
||||||
|
assert.property(res.jsonData, 'error')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors via handleError', async () => {
|
||||||
|
const error = new Error('Token data not found')
|
||||||
|
error.status = 404
|
||||||
|
mockUseCases.slp.getTokenData.rejects(error)
|
||||||
|
const req = createMockRequest({
|
||||||
|
body: { tokenId: 'a'.repeat(64) }
|
||||||
|
})
|
||||||
|
const res = createMockResponse()
|
||||||
|
|
||||||
|
await uut.getTokenData(req, res)
|
||||||
|
|
||||||
|
assert.equal(res.statusValue, 404)
|
||||||
|
assert.deepEqual(res.jsonData, { error: 'Token data not found' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,139 +0,0 @@
|
|||||||
/*
|
|
||||||
Unit tests for the Event entity.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// npm libraries
|
|
||||||
import { assert } from 'chai'
|
|
||||||
|
|
||||||
// Mocking data libraries
|
|
||||||
import {
|
|
||||||
mockKind0Event,
|
|
||||||
mockKind1Event,
|
|
||||||
mockKind3Event,
|
|
||||||
mockKind7Event,
|
|
||||||
mockInvalidEventMissingId,
|
|
||||||
mockInvalidEventWrongIdLength,
|
|
||||||
mockInvalidEventMissingPubkey,
|
|
||||||
mockInvalidEventWrongPubkeyLength,
|
|
||||||
mockInvalidEventMissingCreatedAt,
|
|
||||||
mockInvalidEventWrongCreatedAtType,
|
|
||||||
mockInvalidEventMissingKind,
|
|
||||||
mockInvalidEventKindOutOfRange,
|
|
||||||
mockInvalidEventMissingSig,
|
|
||||||
mockInvalidEventWrongSigLength,
|
|
||||||
mockInvalidEventTagsNotArray
|
|
||||||
} from '../mocks/event-mocks.js'
|
|
||||||
|
|
||||||
// Unit under test
|
|
||||||
import Event from '../../../src/entities/event.js'
|
|
||||||
|
|
||||||
describe('#event.js', () => {
|
|
||||||
describe('#isValid()', () => {
|
|
||||||
it('should return true for valid kind 0 event', () => {
|
|
||||||
const event = new Event(mockKind0Event)
|
|
||||||
assert.isTrue(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return true for valid kind 1 event', () => {
|
|
||||||
const event = new Event(mockKind1Event)
|
|
||||||
assert.isTrue(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return true for valid kind 3 event', () => {
|
|
||||||
const event = new Event(mockKind3Event)
|
|
||||||
assert.isTrue(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return true for valid kind 7 event', () => {
|
|
||||||
const event = new Event(mockKind7Event)
|
|
||||||
assert.isTrue(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event missing id', () => {
|
|
||||||
const event = new Event(mockInvalidEventMissingId)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with wrong id length', () => {
|
|
||||||
const event = new Event(mockInvalidEventWrongIdLength)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event missing pubkey', () => {
|
|
||||||
const event = new Event(mockInvalidEventMissingPubkey)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with wrong pubkey length', () => {
|
|
||||||
const event = new Event(mockInvalidEventWrongPubkeyLength)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event missing created_at', () => {
|
|
||||||
const event = new Event(mockInvalidEventMissingCreatedAt)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with wrong created_at type', () => {
|
|
||||||
const event = new Event(mockInvalidEventWrongCreatedAtType)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event missing kind', () => {
|
|
||||||
const event = new Event(mockInvalidEventMissingKind)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with kind out of range', () => {
|
|
||||||
const event = new Event(mockInvalidEventKindOutOfRange)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event missing sig', () => {
|
|
||||||
const event = new Event(mockInvalidEventMissingSig)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with wrong sig length', () => {
|
|
||||||
const event = new Event(mockInvalidEventWrongSigLength)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return false for event with tags not an array', () => {
|
|
||||||
const event = new Event(mockInvalidEventTagsNotArray)
|
|
||||||
assert.isFalse(event.isValid())
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('#toJSON()', () => {
|
|
||||||
it('should serialize event to JSON correctly', () => {
|
|
||||||
const event = new Event(mockKind1Event)
|
|
||||||
const json = event.toJSON()
|
|
||||||
|
|
||||||
assert.property(json, 'id')
|
|
||||||
assert.property(json, 'pubkey')
|
|
||||||
assert.property(json, 'created_at')
|
|
||||||
assert.property(json, 'kind')
|
|
||||||
assert.property(json, 'tags')
|
|
||||||
assert.property(json, 'content')
|
|
||||||
assert.property(json, 'sig')
|
|
||||||
|
|
||||||
assert.equal(json.id, mockKind1Event.id)
|
|
||||||
assert.equal(json.pubkey, mockKind1Event.pubkey)
|
|
||||||
assert.equal(json.created_at, mockKind1Event.created_at)
|
|
||||||
assert.equal(json.kind, mockKind1Event.kind)
|
|
||||||
assert.deepEqual(json.tags, mockKind1Event.tags)
|
|
||||||
assert.equal(json.content, mockKind1Event.content)
|
|
||||||
assert.equal(json.sig, mockKind1Event.sig)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should serialize event with tags correctly', () => {
|
|
||||||
const event = new Event(mockKind3Event)
|
|
||||||
const json = event.toJSON()
|
|
||||||
|
|
||||||
assert.isArray(json.tags)
|
|
||||||
assert.equal(json.tags.length, 1)
|
|
||||||
assert.deepEqual(json.tags, mockKind3Event.tags)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -0,0 +1,247 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for EncryptionUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import EncryptionUseCases from '../../../src/use-cases/encryption-use-cases.js'
|
||||||
|
|
||||||
|
describe('#encryption-use-cases.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockUseCases
|
||||||
|
let mockBchjs
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
|
||||||
|
// Mock bchjs
|
||||||
|
mockBchjs = {
|
||||||
|
Address: {
|
||||||
|
toCashAddress: sandbox.stub().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||||
|
},
|
||||||
|
ECPair: {
|
||||||
|
fromPublicKey: sandbox.stub().returns({}),
|
||||||
|
toCashAddress: sandbox.stub().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mock use cases
|
||||||
|
mockUseCases = {
|
||||||
|
fulcrum: {
|
||||||
|
getTransactions: sandbox.stub().resolves({
|
||||||
|
transactions: [
|
||||||
|
{ tx_hash: 'abc123def456' }
|
||||||
|
]
|
||||||
|
})
|
||||||
|
},
|
||||||
|
rawtransactions: {
|
||||||
|
getRawTransaction: sandbox.stub().resolves({
|
||||||
|
vin: [
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'signature 02abc123def456789'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new EncryptionUseCases({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
useCases: mockUseCases,
|
||||||
|
bchjs: mockBchjs
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new EncryptionUseCases({ useCases: mockUseCases })
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require useCases', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new EncryptionUseCases({ adapters: mockAdapters })
|
||||||
|
}, /UseCases instance required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getPublicKey()', () => {
|
||||||
|
it('should return public key when found', async () => {
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isTrue(result.success)
|
||||||
|
assert.equal(result.publicKey, '02abc123def456789')
|
||||||
|
assert.isTrue(mockBchjs.Address.toCashAddress.calledOnce)
|
||||||
|
assert.isTrue(mockUseCases.fulcrum.getTransactions.calledOnce)
|
||||||
|
assert.isTrue(mockUseCases.rawtransactions.getRawTransaction.calledOnce)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return not found when public key does not match', async () => {
|
||||||
|
// Make the ECPair.toCashAddress return a different address
|
||||||
|
mockBchjs.ECPair.toCashAddress.returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isFalse(result.success)
|
||||||
|
assert.equal(result.publicKey, 'not found')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should throw error when no transaction history', async () => {
|
||||||
|
mockUseCases.fulcrum.getTransactions.resolves({
|
||||||
|
transactions: []
|
||||||
|
})
|
||||||
|
|
||||||
|
try {
|
||||||
|
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.equal(err.message, 'No transaction history.')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle transactions without scriptSig', async () => {
|
||||||
|
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||||
|
vin: [
|
||||||
|
{ txid: 'coinbase' } // No scriptSig
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isFalse(result.success)
|
||||||
|
assert.equal(result.publicKey, 'not found')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle invalid public key hex gracefully', async () => {
|
||||||
|
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||||
|
vin: [
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'signature NOT_VALID_HEX'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isFalse(result.success)
|
||||||
|
assert.equal(result.publicKey, 'not found')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle ECPair.fromPublicKey throwing error', async () => {
|
||||||
|
mockBchjs.ECPair.fromPublicKey.throws(new Error('Invalid public key'))
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isFalse(result.success)
|
||||||
|
assert.equal(result.publicKey, 'not found')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should search through multiple transactions', async () => {
|
||||||
|
// First transaction has no matching public key
|
||||||
|
mockUseCases.fulcrum.getTransactions.resolves({
|
||||||
|
transactions: [
|
||||||
|
{ tx_hash: 'tx1' },
|
||||||
|
{ tx_hash: 'tx2' }
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
// Return different data for each tx - first tx has input with non-matching key
|
||||||
|
mockUseCases.rawtransactions.getRawTransaction
|
||||||
|
.onFirstCall().resolves({
|
||||||
|
vin: [
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'sig 02aaa111bbb222ccc'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
.onSecondCall().resolves({
|
||||||
|
vin: [
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'sig 02abc123def456789'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
// First tx doesn't match, second tx matches
|
||||||
|
mockBchjs.ECPair.toCashAddress
|
||||||
|
.onFirstCall().returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||||
|
.onSecondCall().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isTrue(result.success)
|
||||||
|
assert.equal(result.publicKey, '02abc123def456789')
|
||||||
|
assert.equal(mockUseCases.rawtransactions.getRawTransaction.callCount, 2)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should search through multiple inputs in a transaction', async () => {
|
||||||
|
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||||
|
vin: [
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'sig 02aaa111bbb222ccc'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
scriptSig: {
|
||||||
|
asm: 'sig 02abc123def456789'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
// First input doesn't match, second input matches
|
||||||
|
mockBchjs.ECPair.toCashAddress
|
||||||
|
.onFirstCall().returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||||
|
.onSecondCall().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||||
|
|
||||||
|
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
|
||||||
|
assert.isTrue(result.success)
|
||||||
|
assert.equal(result.publicKey, '02abc123def456789')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should propagate fulcrum errors', async () => {
|
||||||
|
const error = new Error('Fulcrum API error')
|
||||||
|
mockUseCases.fulcrum.getTransactions.rejects(error)
|
||||||
|
|
||||||
|
try {
|
||||||
|
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.equal(err.message, 'Fulcrum API error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should propagate rawtransactions errors', async () => {
|
||||||
|
const error = new Error('RawTransactions API error')
|
||||||
|
mockUseCases.rawtransactions.getRawTransaction.rejects(error)
|
||||||
|
|
||||||
|
try {
|
||||||
|
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.equal(err.message, 'RawTransactions API error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,297 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for FulcrumUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
|
||||||
|
import FulcrumUseCases from '../../../src/use-cases/fulcrum-use-cases.js'
|
||||||
|
|
||||||
|
describe('#fulcrum-use-cases.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let uut
|
||||||
|
let sortAllTxsStub
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {
|
||||||
|
fulcrum: {
|
||||||
|
get: sandbox.stub().resolves({}),
|
||||||
|
post: sandbox.stub().resolves({})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a mock BCHJS instance with stubbed sortAllTxs method
|
||||||
|
const mockBchjs = new BCHJS({ restURL: 'http://localhost:5942/v6/' })
|
||||||
|
if (!mockBchjs.Electrumx) {
|
||||||
|
mockBchjs.Electrumx = {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a stub that sorts transactions
|
||||||
|
sortAllTxsStub = sandbox.stub(mockBchjs.Electrumx, 'sortAllTxs')
|
||||||
|
sortAllTxsStub.callsFake(async (txs, order) => {
|
||||||
|
const sorted = [...txs].sort((a, b) => {
|
||||||
|
if (order === 'DESCENDING') {
|
||||||
|
return (b.height || 0) - (a.height || 0)
|
||||||
|
}
|
||||||
|
return (a.height || 0) - (b.height || 0)
|
||||||
|
})
|
||||||
|
return sorted
|
||||||
|
})
|
||||||
|
|
||||||
|
// Inject the mocked bchjs instance into the use cases
|
||||||
|
uut = new FulcrumUseCases({ adapters: mockAdapters, bchjs: mockBchjs })
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new FulcrumUseCases()
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require fulcrum adapter', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new FulcrumUseCases({ adapters: {} })
|
||||||
|
}, /Fulcrum adapter required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBalance()', () => {
|
||||||
|
it('should call fulcrum adapter get method', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
mockAdapters.fulcrum.get.resolves({ balance: 1000 })
|
||||||
|
|
||||||
|
const result = await uut.getBalance({ address })
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/balance/${address}`))
|
||||||
|
assert.deepEqual(result, { balance: 1000 })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBalances()', () => {
|
||||||
|
it('should call fulcrum adapter post method', async () => {
|
||||||
|
const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
|
||||||
|
mockAdapters.fulcrum.post.resolves({ balances: [] })
|
||||||
|
|
||||||
|
const result = await uut.getBalances({ addresses })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/balance/', { addresses })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { balances: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getUtxos()', () => {
|
||||||
|
it('should call fulcrum adapter get method', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
mockAdapters.fulcrum.get.resolves({ utxos: [] })
|
||||||
|
|
||||||
|
const result = await uut.getUtxos({ address })
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/utxos/${address}`))
|
||||||
|
assert.deepEqual(result, { utxos: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getUtxosBulk()', () => {
|
||||||
|
it('should call fulcrum adapter post method', async () => {
|
||||||
|
const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
|
||||||
|
mockAdapters.fulcrum.post.resolves({ utxos: [] })
|
||||||
|
|
||||||
|
const result = await uut.getUtxosBulk({ addresses })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/utxos/', { addresses })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { utxos: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactionDetails()', () => {
|
||||||
|
it('should call fulcrum adapter get method', async () => {
|
||||||
|
const txid = 'a'.repeat(64)
|
||||||
|
mockAdapters.fulcrum.get.resolves({ txid })
|
||||||
|
|
||||||
|
const result = await uut.getTransactionDetails({ txid })
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/tx/data/${txid}`))
|
||||||
|
assert.deepEqual(result, { txid })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactionDetailsBulk()', () => {
|
||||||
|
it('should call fulcrum adapter post method with verbose', async () => {
|
||||||
|
const txids = ['a'.repeat(64)]
|
||||||
|
const verbose = true
|
||||||
|
mockAdapters.fulcrum.post.resolves({ transactions: [] })
|
||||||
|
|
||||||
|
const result = await uut.getTransactionDetailsBulk({ txids, verbose })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/tx/data', { txids, verbose })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { transactions: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#broadcastTransaction()', () => {
|
||||||
|
it('should call fulcrum adapter post method', async () => {
|
||||||
|
const txHex = '010203'
|
||||||
|
mockAdapters.fulcrum.post.resolves({ txid: 'abc' })
|
||||||
|
|
||||||
|
const result = await uut.broadcastTransaction({ txHex })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/tx/broadcast', { txHex })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { txid: 'abc' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBlockHeaders()', () => {
|
||||||
|
it('should call fulcrum adapter get method with height and count', async () => {
|
||||||
|
const height = 100
|
||||||
|
const count = 2
|
||||||
|
mockAdapters.fulcrum.get.resolves({ headers: [] })
|
||||||
|
|
||||||
|
const result = await uut.getBlockHeaders({ height, count })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.get.calledOnceWith(`electrumx/block/headers/${height}?count=${count}`)
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { headers: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBlockHeadersBulk()', () => {
|
||||||
|
it('should call fulcrum adapter post method', async () => {
|
||||||
|
const heights = [{ height: 100, count: 2 }]
|
||||||
|
mockAdapters.fulcrum.post.resolves({ headers: [] })
|
||||||
|
|
||||||
|
const result = await uut.getBlockHeadersBulk({ heights })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/block/headers', { heights })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { headers: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactions()', () => {
|
||||||
|
it('should call fulcrum adapter and sort transactions when allTxs is false', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
const allTxs = false
|
||||||
|
const mockTransactions = [
|
||||||
|
{ tx_hash: 'aaa', height: 100 },
|
||||||
|
{ tx_hash: 'bbb', height: 200 },
|
||||||
|
{ tx_hash: 'ccc', height: 150 }
|
||||||
|
]
|
||||||
|
mockAdapters.fulcrum.get.resolves({
|
||||||
|
transactions: mockTransactions
|
||||||
|
})
|
||||||
|
|
||||||
|
const result = await uut.getTransactions({ address, allTxs })
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/transactions/${address}`))
|
||||||
|
assert.property(result, 'transactions')
|
||||||
|
// Transactions should be sorted and limited to 100
|
||||||
|
if (result.transactions && result.transactions.length > 100) {
|
||||||
|
assert.isAtMost(result.transactions.length, 100)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return all transactions when allTxs is true', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
const allTxs = true
|
||||||
|
const mockTransactions = Array(150).fill({ tx_hash: 'aaa', height: 100 })
|
||||||
|
mockAdapters.fulcrum.get.resolves({
|
||||||
|
transactions: mockTransactions
|
||||||
|
})
|
||||||
|
|
||||||
|
const result = await uut.getTransactions({ address, allTxs })
|
||||||
|
|
||||||
|
assert.property(result, 'transactions')
|
||||||
|
// All transactions should be returned when allTxs is true
|
||||||
|
assert.equal(result.transactions.length, 150)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTransactionsBulk()', () => {
|
||||||
|
it('should call fulcrum adapter and sort transactions for each address', async () => {
|
||||||
|
const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
|
||||||
|
const allTxs = false
|
||||||
|
const mockResponse = {
|
||||||
|
transactions: [
|
||||||
|
{
|
||||||
|
transactions: [
|
||||||
|
{ tx_hash: 'aaa', height: 100 },
|
||||||
|
{ tx_hash: 'bbb', height: 200 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
mockAdapters.fulcrum.post.resolves(mockResponse)
|
||||||
|
|
||||||
|
const result = await uut.getTransactionsBulk({ addresses, allTxs })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/transactions/', { addresses })
|
||||||
|
)
|
||||||
|
assert.property(result, 'transactions')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should limit to 100 transactions when allTxs is false', async () => {
|
||||||
|
const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
|
||||||
|
const allTxs = false
|
||||||
|
const mockTransactions = Array(150).fill({ tx_hash: 'aaa', height: 100 })
|
||||||
|
const mockResponse = {
|
||||||
|
transactions: [
|
||||||
|
{
|
||||||
|
transactions: mockTransactions
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
mockAdapters.fulcrum.post.resolves(mockResponse)
|
||||||
|
|
||||||
|
const result = await uut.getTransactionsBulk({ addresses, allTxs })
|
||||||
|
|
||||||
|
assert.isAtMost(result.transactions[0].transactions.length, 100)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMempool()', () => {
|
||||||
|
it('should call fulcrum adapter get method', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
mockAdapters.fulcrum.get.resolves({ mempool: [] })
|
||||||
|
|
||||||
|
const result = await uut.getMempool({ address })
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/unconfirmed/${address}`))
|
||||||
|
assert.deepEqual(result, { mempool: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMempoolBulk()', () => {
|
||||||
|
it('should call fulcrum adapter post method', async () => {
|
||||||
|
const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
|
||||||
|
mockAdapters.fulcrum.post.resolves({ mempool: [] })
|
||||||
|
|
||||||
|
const result = await uut.getMempoolBulk({ addresses })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.fulcrum.post.calledOnceWith('electrumx/unconfirmed/', { addresses })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { mempool: [] })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for MiningUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
|
||||||
|
import MiningUseCases from '../../../src/use-cases/full-node-mining-use-cases.js'
|
||||||
|
|
||||||
|
describe('#full-node-mining-use-cases.js', () => {
|
||||||
|
let mockAdapters
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
mockAdapters = {
|
||||||
|
fullNode: {
|
||||||
|
call: async () => ({})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new MiningUseCases({ adapters: mockAdapters })
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new MiningUseCases()
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require full node adapter', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new MiningUseCases({ adapters: {} })
|
||||||
|
}, /Full node adapter required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMiningInfo()', () => {
|
||||||
|
it('should call full node adapter with correct method', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
mockAdapters.fullNode.call = async method => {
|
||||||
|
capturedMethod = method
|
||||||
|
return { blocks: 100, difficulty: 1.5 }
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getMiningInfo()
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'getmininginfo')
|
||||||
|
assert.deepEqual(result, { blocks: 100, difficulty: 1.5 })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getNetworkHashPS()', () => {
|
||||||
|
it('should call full node adapter with correct method and default params', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedMethod = method
|
||||||
|
capturedParams = params
|
||||||
|
return 1234567890
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getNetworkHashPS({ nblocks: 120, height: -1 })
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'getnetworkhashps')
|
||||||
|
assert.deepEqual(capturedParams, [120, -1])
|
||||||
|
assert.equal(result, 1234567890)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should call full node adapter with custom params', async () => {
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedParams = params
|
||||||
|
return 9876543210
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getNetworkHashPS({ nblocks: 240, height: 1000 })
|
||||||
|
|
||||||
|
assert.deepEqual(capturedParams, [240, 1000])
|
||||||
|
assert.equal(result, 9876543210)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,267 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for RawTransactionsUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
|
||||||
|
import RawTransactionsUseCases from '../../../src/use-cases/full-node-rawtransactions-use-cases.js'
|
||||||
|
|
||||||
|
describe('#full-node-rawtransactions-use-cases.js', () => {
|
||||||
|
let mockAdapters
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
mockAdapters = {
|
||||||
|
fullNode: {
|
||||||
|
call: async () => ({})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new RawTransactionsUseCases({ adapters: mockAdapters })
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new RawTransactionsUseCases()
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require full node adapter', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new RawTransactionsUseCases({ adapters: {} })
|
||||||
|
}, /Full node adapter required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeRawTransaction()', () => {
|
||||||
|
it('should call full node adapter with correct method', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedMethod = method
|
||||||
|
capturedParams = params
|
||||||
|
return { txid: 'abc123', version: 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.decodeRawTransaction({ hex: '01000000' })
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'decoderawtransaction')
|
||||||
|
assert.deepEqual(capturedParams, ['01000000'])
|
||||||
|
assert.deepEqual(result, { txid: 'abc123', version: 2 })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeRawTransactions()', () => {
|
||||||
|
it('should call full node adapter for each hex in parallel', async () => {
|
||||||
|
const callCount = { count: 0 }
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callCount.count++
|
||||||
|
return { txid: `tx${callCount.count}`, hex: params[0] }
|
||||||
|
}
|
||||||
|
|
||||||
|
const hexes = ['hex1', 'hex2', 'hex3']
|
||||||
|
const result = await uut.decodeRawTransactions({ hexes })
|
||||||
|
|
||||||
|
assert.equal(callCount.count, 3)
|
||||||
|
assert.equal(result.length, 3)
|
||||||
|
assert.equal(result[0].txid, 'tx1')
|
||||||
|
assert.equal(result[1].txid, 'tx2')
|
||||||
|
assert.equal(result[2].txid, 'tx3')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeScript()', () => {
|
||||||
|
it('should call full node adapter with correct method', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedMethod = method
|
||||||
|
capturedParams = params
|
||||||
|
return { asm: 'OP_DUP OP_HASH160', type: 'pubkeyhash' }
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.decodeScript({ hex: '76a914' })
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'decodescript')
|
||||||
|
assert.deepEqual(capturedParams, ['76a914'])
|
||||||
|
assert.deepEqual(result, { asm: 'OP_DUP OP_HASH160', type: 'pubkeyhash' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeScripts()', () => {
|
||||||
|
it('should call full node adapter for each hex in parallel', async () => {
|
||||||
|
const callCount = { count: 0 }
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callCount.count++
|
||||||
|
return { asm: `script${callCount.count}`, hex: params[0] }
|
||||||
|
}
|
||||||
|
|
||||||
|
const hexes = ['script1', 'script2']
|
||||||
|
const result = await uut.decodeScripts({ hexes })
|
||||||
|
|
||||||
|
assert.equal(callCount.count, 2)
|
||||||
|
assert.equal(result.length, 2)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getRawTransaction()', () => {
|
||||||
|
it('should call full node adapter with verbose=false by default', async () => {
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedParams = params
|
||||||
|
return '01000000'
|
||||||
|
}
|
||||||
|
|
||||||
|
await uut.getRawTransaction({ txid: 'abc123' })
|
||||||
|
|
||||||
|
assert.deepEqual(capturedParams, ['abc123', 0])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should call full node adapter with verbose=true when specified', async () => {
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedParams = params
|
||||||
|
return { txid: 'abc123', version: 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
await uut.getRawTransaction({ txid: 'abc123', verbose: true })
|
||||||
|
|
||||||
|
assert.deepEqual(capturedParams, ['abc123', 1])
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getRawTransactions()', () => {
|
||||||
|
it('should call full node adapter for each txid in parallel', async () => {
|
||||||
|
const callCount = { count: 0 }
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callCount.count++
|
||||||
|
return { txid: params[0], version: 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
const txids = ['tx1', 'tx2']
|
||||||
|
const result = await uut.getRawTransactions({ txids, verbose: true })
|
||||||
|
|
||||||
|
assert.equal(callCount.count, 2)
|
||||||
|
assert.equal(result.length, 2)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getRawTransactionWithHeight()', () => {
|
||||||
|
it('should return transaction without height when verbose=false', async () => {
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
if (method === 'getrawtransaction') {
|
||||||
|
return '01000000'
|
||||||
|
}
|
||||||
|
return {}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: false })
|
||||||
|
|
||||||
|
assert.equal(result, '01000000')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should fetch and append height when verbose=true and blockhash exists', async () => {
|
||||||
|
let callCount = 0
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callCount++
|
||||||
|
if (method === 'getrawtransaction') {
|
||||||
|
return { txid: 'abc123', blockhash: 'block123' }
|
||||||
|
}
|
||||||
|
if (method === 'getblockheader') {
|
||||||
|
return { height: 100, hash: 'block123' }
|
||||||
|
}
|
||||||
|
return {}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: true })
|
||||||
|
|
||||||
|
assert.equal(callCount, 2)
|
||||||
|
assert.equal(result.height, 100)
|
||||||
|
assert.equal(result.txid, 'abc123')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle block header lookup failure gracefully', async () => {
|
||||||
|
let callCount = 0
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callCount++
|
||||||
|
if (method === 'getrawtransaction') {
|
||||||
|
return { txid: 'abc123', blockhash: 'block123' }
|
||||||
|
}
|
||||||
|
if (method === 'getblockheader') {
|
||||||
|
throw new Error('Block not found')
|
||||||
|
}
|
||||||
|
return {}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: true })
|
||||||
|
|
||||||
|
assert.equal(callCount, 2)
|
||||||
|
assert.isNull(result.height)
|
||||||
|
assert.equal(result.txid, 'abc123')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBlockHeader()', () => {
|
||||||
|
it('should call full node adapter with correct method', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedMethod = method
|
||||||
|
capturedParams = params
|
||||||
|
return { height: 100, hash: 'block123' }
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.getBlockHeader({ blockHash: 'block123', verbose: true })
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'getblockheader')
|
||||||
|
assert.deepEqual(capturedParams, ['block123', true])
|
||||||
|
assert.deepEqual(result, { height: 100, hash: 'block123' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#sendRawTransaction()', () => {
|
||||||
|
it('should call full node adapter with correct method', async () => {
|
||||||
|
let capturedMethod = ''
|
||||||
|
let capturedParams = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
capturedMethod = method
|
||||||
|
capturedParams = params
|
||||||
|
return 'txid123'
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await uut.sendRawTransaction({ hex: '01000000' })
|
||||||
|
|
||||||
|
assert.equal(capturedMethod, 'sendrawtransaction')
|
||||||
|
assert.deepEqual(capturedParams, ['01000000'])
|
||||||
|
assert.equal(result, 'txid123')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#sendRawTransactions()', () => {
|
||||||
|
it('should send transactions serially, not in parallel', async () => {
|
||||||
|
const callOrder = []
|
||||||
|
mockAdapters.fullNode.call = async (method, params) => {
|
||||||
|
callOrder.push(params[0])
|
||||||
|
// Simulate some async work
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 10))
|
||||||
|
return `txid-${params[0]}`
|
||||||
|
}
|
||||||
|
|
||||||
|
const hexes = ['hex1', 'hex2', 'hex3']
|
||||||
|
const startTime = Date.now()
|
||||||
|
const result = await uut.sendRawTransactions({ hexes })
|
||||||
|
const endTime = Date.now()
|
||||||
|
|
||||||
|
// Should take at least 30ms if serial (3 * 10ms)
|
||||||
|
assert.isAtLeast(endTime - startTime, 25)
|
||||||
|
assert.deepEqual(callOrder, ['hex1', 'hex2', 'hex3'])
|
||||||
|
assert.equal(result.length, 3)
|
||||||
|
assert.equal(result[0], 'txid-hex1')
|
||||||
|
assert.equal(result[1], 'txid-hex2')
|
||||||
|
assert.equal(result[2], 'txid-hex3')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for PriceUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
|
||||||
|
import PriceUseCases from '../../../src/use-cases/price-use-cases.js'
|
||||||
|
|
||||||
|
describe('#price-use-cases.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockAxios
|
||||||
|
let mockConfig
|
||||||
|
let uut
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockAdapters = {}
|
||||||
|
|
||||||
|
mockConfig = {
|
||||||
|
restURL: 'http://localhost:3000/v5/'
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mock axios
|
||||||
|
mockAxios = {
|
||||||
|
request: sandbox.stub()
|
||||||
|
}
|
||||||
|
|
||||||
|
uut = new PriceUseCases({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
axios: mockAxios,
|
||||||
|
config: mockConfig
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new PriceUseCases()
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getBCHUSD()', () => {
|
||||||
|
it('should return BCH price from Coinex API', async () => {
|
||||||
|
const mockPrice = 250.5
|
||||||
|
mockAxios.request.resolves({
|
||||||
|
data: {
|
||||||
|
data: {
|
||||||
|
ticker: {
|
||||||
|
last: mockPrice.toString()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const result = await uut.getBCHUSD()
|
||||||
|
|
||||||
|
assert.equal(result, mockPrice)
|
||||||
|
assert.isTrue(mockAxios.request.calledOnce)
|
||||||
|
const callArgs = mockAxios.request.getCall(0).args[0]
|
||||||
|
assert.equal(callArgs.method, 'get')
|
||||||
|
assert.equal(callArgs.baseURL, 'https://api.coinex.com/v1/market/ticker?market=bchusdt')
|
||||||
|
assert.equal(callArgs.timeout, 15000)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors', async () => {
|
||||||
|
const error = new Error('API error')
|
||||||
|
mockAxios.request.rejects(error)
|
||||||
|
|
||||||
|
try {
|
||||||
|
await uut.getBCHUSD()
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.equal(err.message, 'API error')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getPsffppWritePrice()', () => {
|
||||||
|
it('should handle errors properly', async () => {
|
||||||
|
// Note: Full unit testing of getPsffppWritePrice is difficult due to dynamic imports
|
||||||
|
// of SlpWallet and PSFFPP. Integration tests should verify the full flow.
|
||||||
|
// This test verifies that errors are properly handled and propagated.
|
||||||
|
try {
|
||||||
|
// This will likely fail in unit test environment without proper setup
|
||||||
|
// but we verify error handling works correctly
|
||||||
|
await uut.getPsffppWritePrice()
|
||||||
|
// If it succeeds, that's also acceptable
|
||||||
|
} catch (err) {
|
||||||
|
// Verify error is properly formatted
|
||||||
|
assert.isTrue(err instanceof Error)
|
||||||
|
// Verify error was logged (indirectly through wlogger)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,296 @@
|
|||||||
|
/*
|
||||||
|
Unit tests for SlpUseCases.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { assert } from 'chai'
|
||||||
|
import sinon from 'sinon'
|
||||||
|
import BCHJS from '@psf/bch-js'
|
||||||
|
|
||||||
|
import SlpUseCases from '../../../src/use-cases/slp-use-cases.js'
|
||||||
|
|
||||||
|
describe('#slp-use-cases.js', () => {
|
||||||
|
let sandbox
|
||||||
|
let mockAdapters
|
||||||
|
let mockConfig
|
||||||
|
let uut
|
||||||
|
let mockBchjs
|
||||||
|
let mockWallet
|
||||||
|
let mockSlpTokenMedia
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
sandbox = sinon.createSandbox()
|
||||||
|
mockConfig = {
|
||||||
|
restURL: 'http://localhost:3000/v5/',
|
||||||
|
ipfsGateway: 'p2wdb-gateway-678.fullstack.cash'
|
||||||
|
}
|
||||||
|
|
||||||
|
mockAdapters = {
|
||||||
|
slpIndexer: {
|
||||||
|
get: sandbox.stub().resolves({}),
|
||||||
|
post: sandbox.stub().resolves({})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create mock BCHJS
|
||||||
|
mockBchjs = new BCHJS({ restURL: 'http://localhost:5942/v6/' })
|
||||||
|
mockBchjs.Electrumx = {
|
||||||
|
txData: sandbox.stub().resolves({
|
||||||
|
details: {
|
||||||
|
vout: [
|
||||||
|
{
|
||||||
|
scriptPubKey: {
|
||||||
|
hex: '6a0c48656c6c6f20576f726c6421'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
mockBchjs.Script = {
|
||||||
|
toASM: sandbox.stub().returns('OP_RETURN 48656c6c6f20576f726c6421')
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create mock wallet
|
||||||
|
mockWallet = {
|
||||||
|
walletInfoPromise: Promise.resolve(),
|
||||||
|
getTransactions: sandbox.stub().resolves([]),
|
||||||
|
getTxData: sandbox.stub().resolves([{
|
||||||
|
vin: [{
|
||||||
|
address: 'bitcoincash:test123'
|
||||||
|
}]
|
||||||
|
}])
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create mock SlpTokenMedia
|
||||||
|
mockSlpTokenMedia = {
|
||||||
|
getIcon: sandbox.stub().resolves({ tokenIcon: 'test-icon.png' })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mock the imports
|
||||||
|
uut = new SlpUseCases({
|
||||||
|
adapters: mockAdapters,
|
||||||
|
bchjs: mockBchjs,
|
||||||
|
config: mockConfig
|
||||||
|
})
|
||||||
|
|
||||||
|
// Replace the wallet initialization with our mocks
|
||||||
|
uut.wallet = mockWallet
|
||||||
|
uut.slpTokenMedia = mockSlpTokenMedia
|
||||||
|
uut.walletInitialized = true
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
sandbox.restore()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#constructor()', () => {
|
||||||
|
it('should require adapters', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new SlpUseCases()
|
||||||
|
}, /Adapters instance required/)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require slpIndexer adapter', () => {
|
||||||
|
assert.throws(() => {
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
new SlpUseCases({ adapters: {} })
|
||||||
|
}, /SLP Indexer adapter required/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getStatus()', () => {
|
||||||
|
it('should call slpIndexer adapter get method', async () => {
|
||||||
|
mockAdapters.slpIndexer.get.resolves({ status: 'ok' })
|
||||||
|
|
||||||
|
const result = await uut.getStatus()
|
||||||
|
|
||||||
|
assert.isTrue(mockAdapters.slpIndexer.get.calledOnceWith('slp/status/'))
|
||||||
|
assert.deepEqual(result, { status: 'ok' })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getAddress()', () => {
|
||||||
|
it('should call slpIndexer adapter post method', async () => {
|
||||||
|
const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||||
|
mockAdapters.slpIndexer.post.resolves({ balance: 1000 })
|
||||||
|
|
||||||
|
const result = await uut.getAddress({ address })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.slpIndexer.post.calledOnceWith('slp/address/', { address })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { balance: 1000 })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTxid()', () => {
|
||||||
|
it('should call slpIndexer adapter post method', async () => {
|
||||||
|
const txid = 'a'.repeat(64)
|
||||||
|
mockAdapters.slpIndexer.post.resolves({ txid })
|
||||||
|
|
||||||
|
const result = await uut.getTxid({ txid })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.slpIndexer.post.calledOnceWith('slp/tx/', { txid })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { txid })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTokenStats()', () => {
|
||||||
|
it('should call slpIndexer adapter post method', async () => {
|
||||||
|
const tokenId = 'a'.repeat(64)
|
||||||
|
const withTxHistory = false
|
||||||
|
mockAdapters.slpIndexer.post.resolves({ tokenData: {} })
|
||||||
|
|
||||||
|
const result = await uut.getTokenStats({ tokenId, withTxHistory })
|
||||||
|
|
||||||
|
assert.isTrue(
|
||||||
|
mockAdapters.slpIndexer.post.calledOnceWith('slp/token/', { tokenId, withTxHistory })
|
||||||
|
)
|
||||||
|
assert.deepEqual(result, { tokenData: {} })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getTokenData()', () => {
|
||||||
|
it('should get token data with mutable and immutable data', async () => {
|
||||||
|
const tokenId = 'a'.repeat(64)
|
||||||
|
const tokenStats = {
|
||||||
|
tokenData: {
|
||||||
|
documentUri: 'ipfs://test123',
|
||||||
|
documentHash: 'b'.repeat(64)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mockAdapters.slpIndexer.post.resolves(tokenStats)
|
||||||
|
|
||||||
|
// Mock decodeOpReturn to return JSON with mda
|
||||||
|
sandbox.stub(uut, 'decodeOpReturn').resolves(JSON.stringify({ mda: 'bitcoincash:test123' }))
|
||||||
|
sandbox.stub(uut, 'getMutableCid').resolves('mutable-cid-123')
|
||||||
|
|
||||||
|
const result = await uut.getTokenData({ tokenId })
|
||||||
|
|
||||||
|
assert.property(result, 'genesisData')
|
||||||
|
assert.property(result, 'immutableData')
|
||||||
|
assert.property(result, 'mutableData')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle errors when getting mutable data', async () => {
|
||||||
|
const tokenId = 'a'.repeat(64)
|
||||||
|
const tokenStats = {
|
||||||
|
tokenData: {
|
||||||
|
documentUri: 'ipfs://test123',
|
||||||
|
documentHash: 'b'.repeat(64)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mockAdapters.slpIndexer.post.resolves(tokenStats)
|
||||||
|
|
||||||
|
sandbox.stub(uut, 'getMutableCid').rejects(new Error('Test error'))
|
||||||
|
|
||||||
|
const result = await uut.getTokenData({ tokenId })
|
||||||
|
|
||||||
|
assert.property(result, 'genesisData')
|
||||||
|
assert.property(result, 'immutableData')
|
||||||
|
assert.equal(result.mutableData, '')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#decodeOpReturn()', () => {
|
||||||
|
it('should decode OP_RETURN data from transaction', async () => {
|
||||||
|
const txid = 'a'.repeat(64)
|
||||||
|
const mockTxData = {
|
||||||
|
details: {
|
||||||
|
vout: [
|
||||||
|
{
|
||||||
|
scriptPubKey: {
|
||||||
|
hex: '6a0c48656c6c6f20576f726c6421'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mockBchjs.Electrumx.txData.resolves(mockTxData)
|
||||||
|
mockBchjs.Script.toASM.returns('OP_RETURN 48656c6c6f20576f726c6421')
|
||||||
|
|
||||||
|
const result = await uut.decodeOpReturn({ txid })
|
||||||
|
|
||||||
|
assert.isTrue(mockBchjs.Electrumx.txData.calledOnceWith(txid))
|
||||||
|
assert.isString(result)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should throw error if txid is not a string', async () => {
|
||||||
|
try {
|
||||||
|
await uut.decodeOpReturn({ txid: null })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.include(err.message, 'txid must be a string')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getCIDData()', () => {
|
||||||
|
it('should fetch IPFS data from CID', async () => {
|
||||||
|
const cid = 'ipfs://test123'
|
||||||
|
const mockData = { name: 'Test Token' }
|
||||||
|
|
||||||
|
// Mock axios
|
||||||
|
const axios = await import('axios')
|
||||||
|
sandbox.stub(axios.default, 'get').resolves({ data: mockData })
|
||||||
|
|
||||||
|
const result = await uut.getCIDData({ cid })
|
||||||
|
|
||||||
|
assert.deepEqual(result, mockData)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should throw error if cid is not a string', async () => {
|
||||||
|
try {
|
||||||
|
await uut.getCIDData({ cid: null })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.include(err.message, 'cid must be a string')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('#getMutableCid()', () => {
|
||||||
|
it('should extract mutable CID from token stats', async () => {
|
||||||
|
const tokenStats = {
|
||||||
|
documentHash: 'a'.repeat(64)
|
||||||
|
}
|
||||||
|
|
||||||
|
const mockOpReturn = JSON.stringify({ mda: 'bitcoincash:test123' })
|
||||||
|
sandbox.stub(uut, 'decodeOpReturn').resolves(mockOpReturn)
|
||||||
|
|
||||||
|
mockWallet.getTransactions.resolves([
|
||||||
|
{
|
||||||
|
tx_hash: 'b'.repeat(64),
|
||||||
|
height: 100
|
||||||
|
}
|
||||||
|
])
|
||||||
|
|
||||||
|
mockWallet.getTxData.resolves([{
|
||||||
|
vin: [{
|
||||||
|
address: 'bitcoincash:test123'
|
||||||
|
}]
|
||||||
|
}])
|
||||||
|
|
||||||
|
// Mock decodeOpReturn for the transaction
|
||||||
|
uut.decodeOpReturn.onSecondCall().resolves(JSON.stringify({ cid: 'ipfs://mutable-cid-123', ts: 1234567890 }))
|
||||||
|
|
||||||
|
const result = await uut.getMutableCid({ tokenStats })
|
||||||
|
|
||||||
|
assert.isString(result)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return false if no documentHash in tokenStats', async () => {
|
||||||
|
const tokenStats = {}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await uut.getMutableCid({ tokenStats })
|
||||||
|
assert.fail('Should have thrown an error')
|
||||||
|
} catch (err) {
|
||||||
|
assert.include(err.message, 'No documentHash property found')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
Reference in New Issue
Block a user