mirror of
https://github.com/Permissionless-Software-Foundation/psf-bch-api.git
synced 2026-09-22 01:01:59 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
73d94f6d82 | ||
|
|
550c763df6 | ||
|
|
8fe5a0b22d | ||
|
|
5cd2e9fa2d | ||
|
|
c338fd38ea | ||
|
|
f59ca87f1e | ||
|
|
1914e6f985 | ||
|
|
5a5119716a | ||
|
|
a37d088b52 | ||
|
|
81a1241b5d | ||
|
|
d104405f17 | ||
|
|
ca25e33517 | ||
|
|
2af4b0a943 | ||
|
|
e5c8fa9321 | ||
|
|
4f89335768 | ||
|
|
f2e61fde35 | ||
|
|
5ab5547bf3 | ||
|
|
e794685981 | ||
|
|
eb57a7c773 | ||
|
|
b41fa29c36 | ||
|
|
865993c1a9 |
@@ -2,3 +2,12 @@
|
||||
RPC_BASEURL=http://172.17.0.1:8332
|
||||
RPC_USERNAME=bitcoin
|
||||
RPC_PASSWORD=password
|
||||
|
||||
# x402 payments required to access this API?
|
||||
X402_ENABLED=false
|
||||
|
||||
# Fulcrum Indexer
|
||||
FULCRUM_API=http://192.168.2.127:3001
|
||||
|
||||
# SLP Indexer
|
||||
SLP_INDEXER_API=http://192.168.2.127:5010
|
||||
@@ -6,3 +6,25 @@ This is a REST API for communicating with Bitcoin Cash infrastructure. It replac
|
||||
|
||||
[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).
|
||||
|
||||
|
||||
+24
-1
@@ -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.
|
||||
*/
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
import express from 'express'
|
||||
import cors from 'cors'
|
||||
import dotenv from 'dotenv'
|
||||
import { paymentMiddleware as x402PaymentMiddleware } from 'x402-bch-express'
|
||||
import { fileURLToPath } from 'url'
|
||||
import { dirname, join } from 'path'
|
||||
|
||||
@@ -14,6 +15,7 @@ import { dirname, join } from 'path'
|
||||
import config from '../src/config/index.js'
|
||||
import Controllers from '../src/controllers/index.js'
|
||||
import wlogger from '../src/adapters/wlogger.js'
|
||||
import { buildX402Routes, getX402Settings } from '../src/config/x402.js'
|
||||
|
||||
// Load environment variables
|
||||
dotenv.config()
|
||||
@@ -57,6 +59,8 @@ class Server {
|
||||
// Create an Express instance.
|
||||
const app = express()
|
||||
|
||||
const x402Settings = getX402Settings()
|
||||
|
||||
// MIDDLEWARE START
|
||||
app.use(express.json())
|
||||
app.use(express.urlencoded({ extended: true }))
|
||||
@@ -68,6 +72,25 @@ class Server {
|
||||
allowedHeaders: ['Content-Type', 'Authorization', 'X-Requested-With']
|
||||
}))
|
||||
|
||||
// Wrap all endpoints in x402 middleware. This handles payments for the API calls.
|
||||
if (x402Settings.enabled) {
|
||||
const routes = buildX402Routes(this.config.apiPrefix)
|
||||
const facilitatorOptions = x402Settings.facilitatorUrl
|
||||
? { url: x402Settings.facilitatorUrl }
|
||||
: undefined
|
||||
|
||||
wlogger.info(`x402 middleware enabled; enforcing ${x402Settings.priceSat} satoshis per request`)
|
||||
app.use(
|
||||
x402PaymentMiddleware(
|
||||
x402Settings.serverAddress,
|
||||
routes,
|
||||
facilitatorOptions
|
||||
)
|
||||
)
|
||||
} else {
|
||||
wlogger.info('x402 middleware disabled via configuration')
|
||||
}
|
||||
|
||||
// Endpoint logging middleware
|
||||
app.use((req, res, next) => {
|
||||
console.log(`Endpoint called: ${req.method} ${req.path}`)
|
||||
|
||||
Generated
+2234
-263
File diff suppressed because it is too large
Load Diff
+7
-3
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "psf-bch-api",
|
||||
"version": "1.0.0",
|
||||
"main": "index.js",
|
||||
"version": "7.0.0",
|
||||
"main": "psf-bch-api.js",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"start": "node bin/server.js",
|
||||
@@ -15,12 +15,16 @@
|
||||
"license": "MIT",
|
||||
"description": "REST API proxy to Bitcoin Cash infrastructure",
|
||||
"dependencies": {
|
||||
"@psf/bch-js": "6.8.3",
|
||||
"axios": "1.7.7",
|
||||
"cors": "2.8.5",
|
||||
"dotenv": "16.3.1",
|
||||
"express": "5.1.0",
|
||||
"minimal-slp-wallet": "5.13.3",
|
||||
"slp-token-media": "1.2.10",
|
||||
"winston": "3.11.0",
|
||||
"winston-daily-rotate-file": "4.7.1"
|
||||
"winston-daily-rotate-file": "4.7.1",
|
||||
"x402-bch-express": "1.1.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"apidoc": "1.2.0",
|
||||
|
||||
@@ -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 = {}) {
|
||||
const { isProUser = false } = options
|
||||
const freemiumLimit = Number(this.config.fullNode?.freemiumArrayLimit || 20)
|
||||
const proLimit = Number(this.config.fullNode?.proArrayLimit || freemiumLimit)
|
||||
|
||||
const limit = isProUser ? proLimit : freemiumLimit
|
||||
validateArraySize (length) {
|
||||
const limit = 20
|
||||
return length <= limit
|
||||
}
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
// Load individual adapter libraries.
|
||||
// import NostrRelayAdapter from './nostr-relay.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'
|
||||
|
||||
class Adapters {
|
||||
@@ -33,6 +35,8 @@ class Adapters {
|
||||
// this.nostrRelay = this.nostrRelays[0]
|
||||
|
||||
this.fullNode = new FullNodeRPCAdapter({ config: this.config })
|
||||
this.fulcrum = new FulcrumAPIAdapter({ config: this.config })
|
||||
this.slpIndexer = new SlpIndexerAPIAdapter({ config: this.config })
|
||||
}
|
||||
|
||||
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
+45
-24
@@ -16,6 +16,28 @@ const pkgInfo = JSON.parse(readFileSync(`${__dirname.toString()}/../../../packag
|
||||
|
||||
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) => {
|
||||
if (value === undefined || value === null || value === '') return defaultValue
|
||||
|
||||
const normalized = String(value).trim().toLowerCase()
|
||||
if (['false', '0', 'no', 'off'].includes(normalized)) return false
|
||||
if (['true', '1', 'yes', 'on'].includes(normalized)) return true
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
// By default, the price per API call is 2000 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 priceSat = Number.isFinite(parsedPriceSat) && parsedPriceSat > 0 ? parsedPriceSat : 2000
|
||||
|
||||
const x402Defaults = {
|
||||
enabled: normalizeBoolean(process.env.X402_ENABLED, true),
|
||||
facilitatorUrl: process.env.FACILITATOR_URL || 'http://localhost:4345/facilitator',
|
||||
serverAddress: process.env.SERVER_BCH_ADDRESS || 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d',
|
||||
priceSat
|
||||
}
|
||||
|
||||
export default {
|
||||
// Server port
|
||||
port: process.env.PORT || 5942,
|
||||
@@ -23,33 +45,12 @@ export default {
|
||||
// Environment
|
||||
env: process.env.NODE_ENV || 'development',
|
||||
|
||||
// API prefix for REST controllers
|
||||
apiPrefix: process.env.API_PREFIX || '/v6',
|
||||
|
||||
// Logging level
|
||||
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
|
||||
fullNode: {
|
||||
rpcBaseUrl: process.env.RPC_BASEURL || 'http://127.0.0.1:8332',
|
||||
@@ -59,6 +60,26 @@ export default {
|
||||
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:3000/v5/',
|
||||
|
||||
// IPFS Gateway URL
|
||||
ipfsGateway: process.env.IPFS_GATEWAY || 'p2wdb-gateway-678.fullstack.cash',
|
||||
|
||||
x402: x402Defaults,
|
||||
|
||||
// Version
|
||||
version
|
||||
}
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
import config from './index.js'
|
||||
|
||||
const DEFAULT_DESCRIPTION = 'Access to protected psf-bch-api resources'
|
||||
const DEFAULT_TIMEOUT_SECONDS = 60
|
||||
const NETWORK = 'bch'
|
||||
|
||||
/**
|
||||
* Builds a route configuration map for x402-bch middleware.
|
||||
*
|
||||
* @param {string} apiPrefix Express API prefix (e.g., "/v6")
|
||||
* @returns {Object} Routes configuration compatible with x402-bch-express
|
||||
*/
|
||||
export function buildX402Routes (apiPrefix = '/v6') {
|
||||
const normalizedPrefix = apiPrefix.endsWith('/')
|
||||
? apiPrefix.slice(0, -1)
|
||||
: apiPrefix
|
||||
const prefixWithSlash = normalizedPrefix.startsWith('/')
|
||||
? normalizedPrefix
|
||||
: `/${normalizedPrefix}`
|
||||
|
||||
const routeKey = `${prefixWithSlash}/*`
|
||||
|
||||
return {
|
||||
network: NETWORK,
|
||||
[routeKey]: {
|
||||
price: config.x402.priceSat,
|
||||
network: NETWORK,
|
||||
config: {
|
||||
description: `${DEFAULT_DESCRIPTION} (2000 satoshis)`,
|
||||
maxTimeoutSeconds: DEFAULT_TIMEOUT_SECONDS
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getX402Settings () {
|
||||
return {
|
||||
enabled: Boolean(config.x402?.enabled),
|
||||
facilitatorUrl: config.x402?.facilitatorUrl,
|
||||
serverAddress: config.x402?.serverAddress,
|
||||
priceSat: config.x402?.priceSat
|
||||
}
|
||||
}
|
||||
@@ -18,6 +18,7 @@ class Controllers {
|
||||
this.useCases = new UseCases({ adapters: this.adapters })
|
||||
this.config = config
|
||||
this.timerController = new TimerController({ adapters: this.adapters, useCases: this.useCases })
|
||||
this.apiPrefix = this.config.apiPrefix || '/v6'
|
||||
|
||||
// Bind 'this' object to all subfunctions
|
||||
this.initAdapters = this.initAdapters.bind(this)
|
||||
@@ -45,7 +46,8 @@ class Controllers {
|
||||
attachRESTControllers (app) {
|
||||
const restControllers = new RESTControllers({
|
||||
adapters: this.adapters,
|
||||
useCases: this.useCases
|
||||
useCases: this.useCases,
|
||||
apiPrefix: this.apiPrefix
|
||||
})
|
||||
|
||||
// Attach the REST API Controllers to the Express app.
|
||||
|
||||
@@ -0,0 +1,563 @@
|
||||
/*
|
||||
REST API Controller for the /fulcrum routes.
|
||||
*/
|
||||
|
||||
import wlogger from '../../../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
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)
|
||||
|
||||
const result = await this.fulcrumUseCases.getTransactions({ address: cashAddr, allTxs })
|
||||
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
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const result = await this.fulcrumUseCases.getTransactionsBulk({
|
||||
addresses: validatedAddresses,
|
||||
allTxs
|
||||
})
|
||||
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
|
||||
@@ -48,7 +48,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/ Service status
|
||||
* @api {get} /v6/full-node/blockchain/ Service status
|
||||
* @apiName BlockchainRoot
|
||||
* @apiGroup Blockchain
|
||||
*
|
||||
@@ -61,13 +61,13 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getBestBlockHash Get best block hash
|
||||
* @api {get} /v6/full-node/blockchain/getBestBlockHash Get best block hash
|
||||
* @apiName GetBestBlockHash
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the hash of the best (tip) block in the longest block chain.
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v5/blockchain/getBestBlockHash" -H "accept: application/json"
|
||||
* curl -X GET "https://api.fullstack.cash/v6/full-node/blockchain/getBestBlockHash" -H "accept: application/json"
|
||||
*
|
||||
* @apiSuccess {String} bestBlockHash Hash of the best block
|
||||
*/
|
||||
@@ -81,7 +81,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getBlockchainInfo Get blockchain info
|
||||
* @api {get} /v6/full-node/blockchain/getBlockchainInfo Get blockchain info
|
||||
* @apiName GetBlockchainInfo
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns various state info regarding blockchain processing.
|
||||
@@ -96,7 +96,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getBlockCount Get block count
|
||||
* @api {get} /v6/full-node/blockchain/getBlockCount Get block count
|
||||
* @apiName GetBlockCount
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the number of blocks in the longest blockchain.
|
||||
@@ -111,7 +111,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getBlockHeader/:hash Get single block header
|
||||
* @api {get} /v6/full-node/blockchain/getBlockHeader/:hash Get single block header
|
||||
* @apiName GetSingleBlockHeader
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns serialized block header data.
|
||||
@@ -136,7 +136,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/getBlockHeader Get multiple block headers
|
||||
* @api {post} /v6/full-node/blockchain/getBlockHeader Get multiple block headers
|
||||
* @apiName GetBulkBlockHeader
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns serialized block header data for multiple hashes.
|
||||
@@ -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.' })
|
||||
}
|
||||
|
||||
@@ -173,7 +173,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getChainTips Get chain tips
|
||||
* @api {get} /v6/full-node/blockchain/getChainTips Get chain tips
|
||||
* @apiName GetChainTips
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns information about known tips in the block tree.
|
||||
@@ -188,7 +188,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getDifficulty Get difficulty
|
||||
* @api {get} /v6/full-node/blockchain/getDifficulty Get difficulty
|
||||
* @apiName GetDifficulty
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the current difficulty value.
|
||||
@@ -203,7 +203,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getMempoolEntry/:txid Get single mempool entry
|
||||
* @api {get} /v6/full-node/blockchain/getMempoolEntry/:txid Get single mempool entry
|
||||
* @apiName GetMempoolEntry
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool data for a transaction.
|
||||
@@ -223,7 +223,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/getMempoolEntry Get bulk mempool entry
|
||||
* @api {post} /v6/full-node/blockchain/getMempoolEntry Get bulk mempool entry
|
||||
* @apiName GetMempoolEntryBulk
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool data for multiple transactions.
|
||||
@@ -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.' })
|
||||
}
|
||||
|
||||
@@ -256,7 +256,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getMempoolAncestors/:txid Get mempool ancestors
|
||||
* @api {get} /v6/full-node/blockchain/getMempoolAncestors/:txid Get mempool ancestors
|
||||
* @apiName GetMempoolAncestors
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns mempool ancestor data for a transaction.
|
||||
@@ -281,7 +281,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getMempoolInfo Get mempool info
|
||||
* @api {get} /v6/full-node/blockchain/getMempoolInfo Get mempool info
|
||||
* @apiName GetMempoolInfo
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details on the state of the mempool.
|
||||
@@ -296,7 +296,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getRawMempool Get raw mempool
|
||||
* @api {get} /v6/full-node/blockchain/getRawMempool Get raw mempool
|
||||
* @apiName GetRawMempool
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns all transaction ids in the mempool.
|
||||
@@ -314,7 +314,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getTxOut/:txid/:n Get transaction output
|
||||
* @api {get} /v6/full-node/blockchain/getTxOut/:txid/:n Get transaction output
|
||||
* @apiName GetTxOut
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details about an unspent transaction output.
|
||||
@@ -347,7 +347,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/getTxOut Validate a UTXO
|
||||
* @api {post} /v6/full-node/blockchain/getTxOut Validate a UTXO
|
||||
* @apiName GetTxOutPost
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns details about an unspent transaction output.
|
||||
@@ -380,7 +380,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getTxOutProof/:txid Get TxOut proof
|
||||
* @api {get} /v6/full-node/blockchain/getTxOutProof/:txid Get TxOut proof
|
||||
* @apiName GetTxOutProofSingle
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns a hex-encoded proof that the transaction was included in a block.
|
||||
@@ -400,7 +400,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/getTxOutProof Get TxOut proofs
|
||||
* @api {post} /v6/full-node/blockchain/getTxOutProof Get TxOut proofs
|
||||
* @apiName GetTxOutProofBulk
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns hex-encoded proofs for transactions.
|
||||
@@ -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.' })
|
||||
}
|
||||
|
||||
@@ -435,7 +435,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/verifyTxOutProof/:proof Verify TxOut proof
|
||||
* @api {get} /v6/full-node/blockchain/verifyTxOutProof/:proof Verify TxOut proof
|
||||
* @apiName VerifyTxOutProofSingle
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Verifies a hex-encoded proof was included in a block.
|
||||
@@ -455,7 +455,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/verifyTxOutProof Verify TxOut proofs
|
||||
* @api {post} /v6/full-node/blockchain/verifyTxOutProof Verify TxOut proofs
|
||||
* @apiName VerifyTxOutProofBulk
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Verifies hex-encoded proofs were included in blocks.
|
||||
@@ -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.' })
|
||||
}
|
||||
|
||||
@@ -490,7 +490,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {post} /full-node/blockchain/getBlock Get block details
|
||||
* @api {post} /v6/full-node/blockchain/getBlock Get block details
|
||||
* @apiName GetBlock
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns block details for a hash.
|
||||
@@ -519,7 +519,7 @@ class BlockchainRESTController {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /full-node/blockchain/getBlockHash/:height Get block hash
|
||||
* @api {get} /v6/full-node/blockchain/getBlockHash/:height Get block hash
|
||||
* @apiName GetBlockHash
|
||||
* @apiGroup Blockchain
|
||||
* @apiDescription Returns the hash of a block by height.
|
||||
|
||||
+5
-1
@@ -28,7 +28,11 @@ class BlockchainRouter {
|
||||
|
||||
this.blockchainController = new BlockchainRESTController(dependencies)
|
||||
|
||||
this.baseUrl = '/full-node/blockchain'
|
||||
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||
this.baseUrl = `${this.apiPrefix}/full-node/blockchain`
|
||||
if (!this.baseUrl.startsWith('/')) {
|
||||
this.baseUrl = `/${this.baseUrl}`
|
||||
}
|
||||
this.router = express.Router()
|
||||
}
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
REST API Controller for the /full-node/control routes.
|
||||
*/
|
||||
|
||||
import wlogger from '../../../../adapters/wlogger.js'
|
||||
|
||||
class ControlRESTController {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating Control REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases || !this.useCases.control) {
|
||||
throw new Error(
|
||||
'Instance of Control use cases required when instantiating Control REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.controlUseCases = this.useCases.control
|
||||
|
||||
this.root = this.root.bind(this)
|
||||
this.getNetworkInfo = this.getNetworkInfo.bind(this)
|
||||
this.handleError = this.handleError.bind(this)
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/full-node/control/ Service status
|
||||
* @apiName ControlRoot
|
||||
* @apiGroup Control
|
||||
*
|
||||
* @apiDescription Returns the status of the control service.
|
||||
*
|
||||
* @apiSuccess {String} status Service identifier
|
||||
*/
|
||||
async root (req, res) {
|
||||
return res.status(200).json({ status: 'control' })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/full-node/control/getNetworkInfo Get Network Info
|
||||
* @apiName GetNetworkInfo
|
||||
* @apiGroup Control
|
||||
* @apiDescription RPC call that gets basic full node information.
|
||||
*/
|
||||
async getNetworkInfo (req, res) {
|
||||
try {
|
||||
const result = await this.controlUseCases.getNetworkInfo()
|
||||
return res.status(200).json(result)
|
||||
} catch (err) {
|
||||
return this.handleError(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
handleError (err, res) {
|
||||
wlogger.error('Error in ControlRESTController:', err)
|
||||
|
||||
const status = err.status || 500
|
||||
const message = err.message || 'Internal server error'
|
||||
|
||||
return res.status(status).json({ error: message })
|
||||
}
|
||||
}
|
||||
|
||||
export default ControlRESTController
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
REST API router for /full-node/control routes.
|
||||
*/
|
||||
|
||||
import express from 'express'
|
||||
import ControlRESTController from './controller.js'
|
||||
|
||||
class ControlRouter {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating Control REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases) {
|
||||
throw new Error(
|
||||
'Instance of Use Cases library required when instantiating Control REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
const dependencies = {
|
||||
adapters: this.adapters,
|
||||
useCases: this.useCases
|
||||
}
|
||||
|
||||
this.controlController = new ControlRESTController(dependencies)
|
||||
|
||||
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||
this.baseUrl = `${this.apiPrefix}/full-node/control`
|
||||
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.controlController.root)
|
||||
this.router.get('/getNetworkInfo', this.controlController.getNetworkInfo)
|
||||
|
||||
app.use(this.baseUrl, this.router)
|
||||
}
|
||||
}
|
||||
|
||||
export default ControlRouter
|
||||
@@ -0,0 +1,90 @@
|
||||
/*
|
||||
REST API Controller for the /full-node/dsproof routes.
|
||||
*/
|
||||
|
||||
import wlogger from '../../../../adapters/wlogger.js'
|
||||
|
||||
class DSProofRESTController {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating DSProof REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases || !this.useCases.dsproof) {
|
||||
throw new Error(
|
||||
'Instance of DSProof use cases required when instantiating DSProof REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.dsproofUseCases = this.useCases.dsproof
|
||||
|
||||
this.root = this.root.bind(this)
|
||||
this.getDSProof = this.getDSProof.bind(this)
|
||||
this.handleError = this.handleError.bind(this)
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/full-node/dsproof/ Service status
|
||||
* @apiName DSProofRoot
|
||||
* @apiGroup DSProof
|
||||
*
|
||||
* @apiDescription Returns the status of the dsproof service.
|
||||
*
|
||||
* @apiSuccess {String} status Service identifier
|
||||
*/
|
||||
async root (req, res) {
|
||||
return res.status(200).json({ status: 'dsproof' })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/full-node/dsproof/getDSProof/:txid Get Double-Spend Proof
|
||||
* @apiName GetDSProof
|
||||
* @apiGroup DSProof
|
||||
* @apiDescription Get information for a double-spend proof.
|
||||
*
|
||||
* @apiParam {String} txid Transaction ID
|
||||
* @apiParam {String} verbose Verbose level (`false`, `true`) for compatibility with legacy API
|
||||
*/
|
||||
async getDSProof (req, res) {
|
||||
try {
|
||||
const txid = req.params.txid
|
||||
|
||||
if (!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: `txid must be of length 64 (not ${txid.length})`
|
||||
})
|
||||
}
|
||||
|
||||
let verbose = 2
|
||||
if (req.query.verbose === 'true') verbose = 3
|
||||
|
||||
const result = await this.dsproofUseCases.getDSProof({ txid, verbose })
|
||||
return res.status(200).json(result)
|
||||
} catch (err) {
|
||||
return this.handleError(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
handleError (err, res) {
|
||||
wlogger.error('Error in DSProofRESTController:', err)
|
||||
|
||||
const status = err.status || 500
|
||||
const message = err.message || 'Internal server error'
|
||||
|
||||
return res.status(status).json({ error: message })
|
||||
}
|
||||
}
|
||||
|
||||
export default DSProofRESTController
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
REST API router for /full-node/dsproof routes.
|
||||
*/
|
||||
|
||||
import express from 'express'
|
||||
import DSProofRESTController from './controller.js'
|
||||
|
||||
class DSProofRouter {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating DSProof REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases) {
|
||||
throw new Error(
|
||||
'Instance of Use Cases library required when instantiating DSProof REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
const dependencies = {
|
||||
adapters: this.adapters,
|
||||
useCases: this.useCases
|
||||
}
|
||||
|
||||
this.dsproofController = new DSProofRESTController(dependencies)
|
||||
|
||||
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||
this.baseUrl = `${this.apiPrefix}/full-node/dsproof`
|
||||
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.dsproofController.root)
|
||||
this.router.get('/getDSProof/:txid', this.dsproofController.getDSProof)
|
||||
|
||||
app.use(this.baseUrl, this.router)
|
||||
}
|
||||
}
|
||||
|
||||
export default DSProofRouter
|
||||
@@ -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,7 +7,13 @@
|
||||
// Local libraries
|
||||
// import EventRouter from './event/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/router.js'
|
||||
import DSProofRouter from './full-node/dsproof/router.js'
|
||||
import FulcrumRouter from './fulcrum/router.js'
|
||||
import MiningRouter from './full-node/mining/router.js'
|
||||
import RawTransactionsRouter from './full-node/rawtransactions/router.js'
|
||||
import SlpRouter from './slp/router.js'
|
||||
import config from '../../config/index.js'
|
||||
|
||||
class RESTControllers {
|
||||
@@ -26,6 +32,12 @@ class RESTControllers {
|
||||
)
|
||||
}
|
||||
|
||||
// Allow overriding the API prefix for testing, default to v6.
|
||||
this.apiPrefix = localConfig.apiPrefix || '/v6'
|
||||
if (this.apiPrefix.length > 1 && this.apiPrefix.endsWith('/')) {
|
||||
this.apiPrefix = this.apiPrefix.slice(0, -1)
|
||||
}
|
||||
|
||||
// Bind 'this' object to all subfunctions.
|
||||
this.attachRESTControllers = this.attachRESTControllers.bind(this)
|
||||
|
||||
@@ -36,7 +48,8 @@ class RESTControllers {
|
||||
attachRESTControllers (app) {
|
||||
const dependencies = {
|
||||
adapters: this.adapters,
|
||||
useCases: this.useCases
|
||||
useCases: this.useCases,
|
||||
apiPrefix: this.apiPrefix
|
||||
}
|
||||
|
||||
// Attach the REST API Controllers associated with the /event route
|
||||
@@ -49,6 +62,24 @@ class RESTControllers {
|
||||
|
||||
const blockchainRouter = new BlockchainRouter(dependencies)
|
||||
blockchainRouter.attach(app)
|
||||
|
||||
const controlRouter = new ControlRouter(dependencies)
|
||||
controlRouter.attach(app)
|
||||
|
||||
const dsproofRouter = new DSProofRouter(dependencies)
|
||||
dsproofRouter.attach(app)
|
||||
|
||||
const fulcrumRouter = new FulcrumRouter(dependencies)
|
||||
fulcrumRouter.attach(app)
|
||||
|
||||
const miningRouter = new MiningRouter(dependencies)
|
||||
miningRouter.attach(app)
|
||||
|
||||
const rawtransactionsRouter = new RawTransactionsRouter(dependencies)
|
||||
rawtransactionsRouter.attach(app)
|
||||
|
||||
const slpRouter = new SlpRouter(dependencies)
|
||||
slpRouter.attach(app)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
/*
|
||||
REST API Controller for the /slp routes.
|
||||
*/
|
||||
|
||||
import wlogger from '../../../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
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) {
|
||||
return this.handleError(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
handleError (err, res) {
|
||||
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
|
||||
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
|
||||
|
||||
// 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,155 @@
|
||||
/*
|
||||
Use cases for interacting with the Fulcrum API service.
|
||||
*/
|
||||
|
||||
import wlogger from '../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
|
||||
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 }) {
|
||||
return this.fulcrum.get(`electrumx/tx/data/${txid}`)
|
||||
}
|
||||
|
||||
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 }) {
|
||||
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)) {
|
||||
response.transactions = await this.bchjs.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 }) {
|
||||
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)) {
|
||||
for (let i = 0; i < response.transactions.length; i++) {
|
||||
const thisEntry = response.transactions[i]
|
||||
if (thisEntry.transactions && Array.isArray(thisEntry.transactions)) {
|
||||
thisEntry.transactions = await this.bchjs.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,24 @@
|
||||
/*
|
||||
Use cases for interacting with the BCH full node control RPC interface.
|
||||
*/
|
||||
|
||||
class ControlUseCases {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
|
||||
if (!this.adapters) {
|
||||
throw new Error('Adapters instance required when instantiating Control use cases.')
|
||||
}
|
||||
|
||||
this.fullNode = this.adapters.fullNode
|
||||
if (!this.fullNode) {
|
||||
throw new Error('Full node adapter required when instantiating Control use cases.')
|
||||
}
|
||||
}
|
||||
|
||||
async getNetworkInfo () {
|
||||
return this.fullNode.call('getnetworkinfo')
|
||||
}
|
||||
}
|
||||
|
||||
export default ControlUseCases
|
||||
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
Use cases for interacting with the BCH full node double-spend proof RPC interface.
|
||||
*/
|
||||
|
||||
class DSProofUseCases {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
|
||||
if (!this.adapters) {
|
||||
throw new Error('Adapters instance required when instantiating DSProof use cases.')
|
||||
}
|
||||
|
||||
this.fullNode = this.adapters.fullNode
|
||||
if (!this.fullNode) {
|
||||
throw new Error('Full node adapter required when instantiating DSProof use cases.')
|
||||
}
|
||||
}
|
||||
|
||||
async getDSProof ({ txid, verbose }) {
|
||||
return this.fullNode.call('getdsproof', [txid, verbose])
|
||||
}
|
||||
}
|
||||
|
||||
export default DSProofUseCases
|
||||
@@ -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
|
||||
@@ -6,6 +6,12 @@
|
||||
|
||||
// Local libraries
|
||||
import BlockchainUseCases from './full-node-blockchain-use-cases.js'
|
||||
import ControlUseCases from './full-node-control-use-cases.js'
|
||||
import DSProofUseCases from './full-node-dsproof-use-cases.js'
|
||||
import FulcrumUseCases from './fulcrum-use-cases.js'
|
||||
import MiningUseCases from './full-node-mining-use-cases.js'
|
||||
import RawTransactionsUseCases from './full-node-rawtransactions-use-cases.js'
|
||||
import SlpUseCases from './slp-use-cases.js'
|
||||
|
||||
class UseCases {
|
||||
constructor (localConfig = {}) {
|
||||
@@ -17,6 +23,12 @@ class UseCases {
|
||||
}
|
||||
|
||||
this.blockchain = new BlockchainUseCases({ adapters: this.adapters })
|
||||
this.control = new ControlUseCases({ 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.rawtransactions = new RawTransactionsUseCases({ adapters: this.adapters })
|
||||
this.slp = new SlpUseCases({ adapters: this.adapters })
|
||||
}
|
||||
|
||||
// Run any startup Use Cases at the start of the app.
|
||||
|
||||
@@ -0,0 +1,321 @@
|
||||
/*
|
||||
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()
|
||||
|
||||
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) {
|
||||
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) {
|
||||
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
|
||||
const txData = await this.bchjs.Electrumx.txData(txid)
|
||||
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) {
|
||||
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 () => {
|
||||
const hash = 'a'.repeat(64)
|
||||
const req = createMockRequest({
|
||||
body: { hashes: [hash], verbose: true },
|
||||
locals: { proLimit: false }
|
||||
body: { hashes: [hash], verbose: true }
|
||||
})
|
||||
const res = createMockResponse()
|
||||
mockUseCases.blockchain.getBlockHeaders.resolves(['result'])
|
||||
@@ -172,7 +171,7 @@ describe('#blockchain-controller.js', () => {
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, ['result'])
|
||||
assert.isTrue(
|
||||
mockAdapters.fullNode.validateArraySize.calledOnceWithExactly(1, { isProUser: false })
|
||||
mockAdapters.fullNode.validateArraySize.calledOnceWithExactly(1)
|
||||
)
|
||||
assert.isTrue(
|
||||
mockUseCases.blockchain.getBlockHeaders.calledOnceWithExactly({
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
Unit tests for ControlRESTController.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
import sinon from 'sinon'
|
||||
|
||||
import ControlRESTController from '../../../src/controllers/rest-api/full-node/control/controller.js'
|
||||
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
|
||||
|
||||
describe('#control-controller.js', () => {
|
||||
let sandbox
|
||||
let mockAdapters
|
||||
let mockUseCases
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.createSandbox()
|
||||
mockAdapters = {}
|
||||
mockUseCases = {
|
||||
control: {
|
||||
getNetworkInfo: sandbox.stub().resolves({ version: 1 })
|
||||
}
|
||||
}
|
||||
|
||||
uut = new ControlRESTController({
|
||||
adapters: mockAdapters,
|
||||
useCases: mockUseCases
|
||||
})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new ControlRESTController({ useCases: mockUseCases })
|
||||
}, /Adapters library required/)
|
||||
})
|
||||
|
||||
it('should require control use cases', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new ControlRESTController({ adapters: mockAdapters, useCases: {} })
|
||||
}, /Control use cases required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#root()', () => {
|
||||
it('should return control status', async () => {
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.root(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, { status: 'control' })
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getNetworkInfo()', () => {
|
||||
it('should return network info on success', async () => {
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getNetworkInfo(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, { version: 1 })
|
||||
})
|
||||
|
||||
it('should handle errors via handleError', async () => {
|
||||
const error = new Error('failure')
|
||||
error.status = 503
|
||||
mockUseCases.control.getNetworkInfo.rejects(error)
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getNetworkInfo(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 503)
|
||||
assert.deepEqual(res.jsonData, { error: 'failure' })
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
Unit tests for DSProofRESTController.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
import sinon from 'sinon'
|
||||
|
||||
import DSProofRESTController from '../../../src/controllers/rest-api/full-node/dsproof/controller.js'
|
||||
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
|
||||
|
||||
describe('#dsproof-controller.js', () => {
|
||||
let sandbox
|
||||
let mockAdapters
|
||||
let mockUseCases
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.createSandbox()
|
||||
mockAdapters = {}
|
||||
mockUseCases = {
|
||||
dsproof: {
|
||||
getDSProof: sandbox.stub().resolves({ proof: true })
|
||||
}
|
||||
}
|
||||
|
||||
uut = new DSProofRESTController({
|
||||
adapters: mockAdapters,
|
||||
useCases: mockUseCases
|
||||
})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new DSProofRESTController({ useCases: mockUseCases })
|
||||
}, /Adapters library required/)
|
||||
})
|
||||
|
||||
it('should require dsproof use cases', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new DSProofRESTController({ adapters: mockAdapters, useCases: {} })
|
||||
}, /DSProof use cases required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#root()', () => {
|
||||
it('should return dsproof status', async () => {
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.root(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, { status: 'dsproof' })
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getDSProof()', () => {
|
||||
it('should validate txid presence', async () => {
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getDSProof(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 400)
|
||||
assert.include(res.jsonData.error, 'txid can not be empty')
|
||||
})
|
||||
|
||||
it('should validate txid length', async () => {
|
||||
const req = createMockRequest({ params: { txid: 'abc' } })
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getDSProof(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 400)
|
||||
assert.include(res.jsonData.error, 'txid must be of length 64')
|
||||
})
|
||||
|
||||
it('should call use case with derived verbose when valid', async () => {
|
||||
const txid = 'a'.repeat(64)
|
||||
const req = createMockRequest({
|
||||
params: { txid },
|
||||
query: { verbose: 'true' }
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getDSProof(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.isTrue(mockUseCases.dsproof.getDSProof.calledOnceWithExactly({
|
||||
txid,
|
||||
verbose: 3
|
||||
}))
|
||||
assert.deepEqual(res.jsonData, { proof: true })
|
||||
})
|
||||
|
||||
it('should handle errors via handleError', async () => {
|
||||
const txid = 'a'.repeat(64)
|
||||
const error = new Error('failure')
|
||||
error.status = 422
|
||||
mockUseCases.dsproof.getDSProof.rejects(error)
|
||||
const req = createMockRequest({ params: { txid } })
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getDSProof(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 422)
|
||||
assert.deepEqual(res.jsonData, { error: 'failure' })
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -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,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,7 +6,13 @@ import { assert } from 'chai'
|
||||
import sinon from 'sinon'
|
||||
|
||||
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/router.js'
|
||||
import DSProofRouter from '../../../src/controllers/rest-api/full-node/dsproof/router.js'
|
||||
import MiningRouter from '../../../src/controllers/rest-api/full-node/mining/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', () => {
|
||||
let sandbox
|
||||
@@ -43,7 +49,53 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
}
|
||||
}
|
||||
mockUseCases = {
|
||||
blockchain: createBlockchainUseCaseStubs()
|
||||
blockchain: createBlockchainUseCaseStubs(),
|
||||
control: {
|
||||
getNetworkInfo: () => {}
|
||||
},
|
||||
dsproof: {
|
||||
getDSProof: () => {}
|
||||
},
|
||||
fulcrum: {
|
||||
getBalance: () => {},
|
||||
getBalances: () => {},
|
||||
getUtxos: () => {},
|
||||
getUtxosBulk: () => {},
|
||||
getTransactionDetails: () => {},
|
||||
getTransactionDetailsBulk: () => {},
|
||||
broadcastTransaction: () => {},
|
||||
getBlockHeaders: () => {},
|
||||
getBlockHeadersBulk: () => {},
|
||||
getTransactions: () => {},
|
||||
getTransactionsBulk: () => {},
|
||||
getMempool: () => {},
|
||||
getMempoolBulk: () => {}
|
||||
},
|
||||
mining: {
|
||||
getMiningInfo: () => {},
|
||||
getNetworkHashPS: () => {}
|
||||
},
|
||||
rawtransactions: {
|
||||
decodeRawTransaction: () => {},
|
||||
decodeRawTransactions: () => {},
|
||||
decodeScript: () => {},
|
||||
decodeScripts: () => {},
|
||||
getRawTransaction: () => {},
|
||||
getRawTransactionWithHeight: () => {},
|
||||
getRawTransactions: () => {},
|
||||
sendRawTransaction: () => {},
|
||||
sendRawTransactions: () => {}
|
||||
},
|
||||
slp: {
|
||||
getStatus: () => {},
|
||||
getAddress: () => {},
|
||||
getTxid: () => {},
|
||||
getTokenStats: () => {},
|
||||
getTokenData: () => {},
|
||||
getMutableCid: () => {},
|
||||
decodeOpReturn: () => {},
|
||||
getCIDData: () => {}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
@@ -68,8 +120,14 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
})
|
||||
|
||||
describe('#attachRESTControllers()', () => {
|
||||
it('should instantiate blockchain router and attach to app', () => {
|
||||
const attachStub = sandbox.stub(BlockchainRouter.prototype, 'attach')
|
||||
it('should instantiate routers and attach to app', () => {
|
||||
const blockchainAttachStub = sandbox.stub(BlockchainRouter.prototype, 'attach')
|
||||
const controlAttachStub = sandbox.stub(ControlRouter.prototype, 'attach')
|
||||
const dsproofAttachStub = sandbox.stub(DSProofRouter.prototype, 'attach')
|
||||
const fulcrumAttachStub = sandbox.stub(FulcrumRouter.prototype, 'attach')
|
||||
const miningAttachStub = sandbox.stub(MiningRouter.prototype, 'attach')
|
||||
const rawtransactionsAttachStub = sandbox.stub(RawTransactionsRouter.prototype, 'attach')
|
||||
const slpAttachStub = sandbox.stub(SlpRouter.prototype, 'attach')
|
||||
const restControllers = new RESTControllers({
|
||||
adapters: mockAdapters,
|
||||
useCases: mockUseCases
|
||||
@@ -78,8 +136,20 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
|
||||
restControllers.attachRESTControllers(app)
|
||||
|
||||
assert.isTrue(attachStub.calledOnce)
|
||||
assert.equal(attachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(blockchainAttachStub.calledOnce)
|
||||
assert.equal(blockchainAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(controlAttachStub.calledOnce)
|
||||
assert.equal(controlAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(dsproofAttachStub.calledOnce)
|
||||
assert.equal(dsproofAttachStub.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(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,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()
|
||||
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,53 @@
|
||||
/*
|
||||
Unit tests for ControlUseCases.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
|
||||
import ControlUseCases from '../../../src/use-cases/full-node-control-use-cases.js'
|
||||
|
||||
describe('#full-node-control-use-cases.js', () => {
|
||||
let mockAdapters
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
mockAdapters = {
|
||||
fullNode: {
|
||||
call: async () => ({})
|
||||
}
|
||||
}
|
||||
|
||||
uut = new ControlUseCases({ adapters: mockAdapters })
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new ControlUseCases()
|
||||
}, /Adapters instance required/)
|
||||
})
|
||||
|
||||
it('should require full node adapter', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new ControlUseCases({ adapters: {} })
|
||||
}, /Full node adapter required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getNetworkInfo()', () => {
|
||||
it('should call full node adapter with correct method', async () => {
|
||||
let capturedMethod = ''
|
||||
mockAdapters.fullNode.call = async method => {
|
||||
capturedMethod = method
|
||||
return { version: 1 }
|
||||
}
|
||||
|
||||
const result = await uut.getNetworkInfo()
|
||||
|
||||
assert.equal(capturedMethod, 'getnetworkinfo')
|
||||
assert.deepEqual(result, { version: 1 })
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
Unit tests for DSProofUseCases.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
|
||||
import DSProofUseCases from '../../../src/use-cases/full-node-dsproof-use-cases.js'
|
||||
|
||||
describe('#full-node-dsproof-use-cases.js', () => {
|
||||
let mockAdapters
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
mockAdapters = {
|
||||
fullNode: {
|
||||
call: async () => ({})
|
||||
}
|
||||
}
|
||||
|
||||
uut = new DSProofUseCases({ adapters: mockAdapters })
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new DSProofUseCases()
|
||||
}, /Adapters instance required/)
|
||||
})
|
||||
|
||||
it('should require full node adapter', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new DSProofUseCases({ adapters: {} })
|
||||
}, /Full node adapter required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getDSProof()', () => {
|
||||
it('should pass txid and verbose parameters to adapter', async () => {
|
||||
let capturedArgs = null
|
||||
mockAdapters.fullNode.call = async (method, params) => {
|
||||
capturedArgs = { method, params }
|
||||
return { success: true }
|
||||
}
|
||||
|
||||
const result = await uut.getDSProof({ txid: 'a'.repeat(64), verbose: 2 })
|
||||
|
||||
assert.equal(capturedArgs.method, 'getdsproof')
|
||||
assert.deepEqual(capturedArgs.params, ['a'.repeat(64), 2])
|
||||
assert.deepEqual(result, { success: true })
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -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,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()
|
||||
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