psf/psf-bch-api-base
1
0
Fork 0
mirror of https://github.com/Permissionless-Software-Foundation/psf-bch-api-base.git synced 2026-09-22 09:11:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from Permissionless-Software-Foundation/ct-unstable

Browse Source 
Authentication - basic & x402
This commit is contained in:
Chris Troutner
2025-11-25 14:31:17 -08:00
committed by GitHub
parent 73d94f6d82 3aeb23ba17
commit 39144116a9
15 changed files with 753 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env-local
+24 -5
View File
@@ -1,13 +1,32 @@
# START INFRASTRUCTURE SETUP
# Full Node Connection
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
FULCRUM_API=http://172.17.0.1:3001/v1
# SLP Indexer
SLP_INDEXER_API=http://192.168.2.127:5010
SLP_INDEXER_API=http://localhost:5010
# REST API URL for wallet operations
LOCAL_RESTURL=http://localhost:5942/v6
# END INFRASTRUCTURE SETUP
# START ACCESS CONTROL
# x402 payments required to access this API?
X402_ENABLED=true
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
FACILITATOR_URL=http://localhost:4345/facilitator
# Basic Authentication required to access this API?
USE_BASIC_AUTH=true
BASIC_AUTH_TOKEN=some-random-token
# END ACCESS CONTROL
bin/server.js
+60 -9
View File
@@ -15,7 +15,8 @@ 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'
import { buildX402Routes, getX402Settings, getBasicAuthSettings } from '../src/config/x402.js'
import { basicAuthMiddleware } from '../src/middleware/basic-auth.js'
// Load environment variables
dotenv.config()
@@ -60,6 +61,7 @@ class Server {
const app = express()
const x402Settings = getX402Settings()
const basicAuthSettings = getBasicAuthSettings()
// MIDDLEWARE START
app.use(express.json())
@@ -72,23 +74,72 @@ 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) {
// Apply basic auth middleware if enabled
// This must run before x402 middleware to set req.locals.basicAuthValid
if (basicAuthSettings.enabled) {
wlogger.info('Basic auth middleware enabled')
app.use(basicAuthMiddleware)
}
// Apply x402 middleware based on configuration
// Logic:
// - If X402_ENABLED=false OR USE_BASIC_AUTH=false: Don't apply x402 (no rate limits)
// - If X402_ENABLED=true AND USE_BASIC_AUTH=true: Apply x402 conditionally (bypass if basic auth valid)
// Apply access control middleware based on configuration
if (x402Settings.enabled && basicAuthSettings.enabled) {
// X402_ENABLED=true AND USE_BASIC_AUTH=true: Apply x402 conditionally
const routes = buildX402Routes(this.config.apiPrefix)
const facilitatorOptions = x402Settings.facilitatorUrl
? { url: x402Settings.facilitatorUrl }
: undefined
wlogger.info(`x402 middleware enabled; enforcing ${x402Settings.priceSat} satoshis per request`)
app.use(
x402PaymentMiddleware(
wlogger.info(`x402 middleware enabled with basic auth bypass; enforcing ${x402Settings.priceSat} satoshis per request (unless basic auth provided)`)
// Create conditional x402 middleware that bypasses if basic auth is valid
const conditionalX402Middleware = (req, res, next) => {
// If basic auth is valid, bypass x402
if (req.locals?.basicAuthValid === true) {
return next()
}
// Otherwise, apply x402 middleware
return x402PaymentMiddleware(
x402Settings.serverAddress,
routes,
facilitatorOptions
)
)
)(req, res, next)
}
app.use(conditionalX402Middleware)
} else if (basicAuthSettings.enabled && !x402Settings.enabled) {
// USE_BASIC_AUTH=true AND X402_ENABLED=false: Require basic auth, reject unauthenticated requests
wlogger.info('Basic auth enforcement enabled (x402 disabled)')
// Middleware that rejects requests without valid basic auth
const requireBasicAuthMiddleware = (req, res, next) => {
// Skip auth check for health endpoint and root
if (req.path === '/health' || req.path === '/') {
return next()
}
// If basic auth is valid, allow the request
if (req.locals?.basicAuthValid === true) {
return next()
}
// Reject unauthenticated requests
wlogger.warn(`Unauthenticated request rejected: ${req.method} ${req.path}`)
return res.status(401).json({
error: 'Unauthorized',
message: 'Valid Bearer token required in Authorization header'
})
}
app.use(requireBasicAuthMiddleware)
} else {
wlogger.info('x402 middleware disabled via configuration')
// X402_ENABLED=false AND USE_BASIC_AUTH=false: No access control middleware
wlogger.info('No access control middleware enabled')
}
// Endpoint logging middleware
package-lock.json
Generated
+127 -2
View File
@@ -1,12 +1,12 @@
{
"name": "psf-bch-api",
"version": "1.0.0",
"version": "7.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "psf-bch-api",
"version": "1.0.0",
"version": "7.0.0",
"license": "MIT",
"dependencies": {
"@psf/bch-js": "6.8.3",
@@ -15,6 +15,7 @@
"dotenv": "16.3.1",
"express": "5.1.0",
"minimal-slp-wallet": "5.13.3",
"psffpp": "1.2.0",
"slp-token-media": "1.2.10",
"winston": "3.11.0",
"winston-daily-rotate-file": "4.7.1",
@@ -52,6 +53,33 @@
"node": ">=10.15.1"
}
},
"node_modules/@chris.troutner/bitcore-lib-cash": {
"version": "8.25.26",
"resolved": "https://registry.npmjs.org/@chris.troutner/bitcore-lib-cash/-/bitcore-lib-cash-8.25.26.tgz",
"integrity": "sha512-WPLW2od7VJsAifN1gPa01XPWpVbDC4pPEVwYXbXZ764NFF6qq1mEcAqnmhWVS1ov130qEx3wjdKpRkEJGoqlVg==",
"license": "MIT",
"dependencies": {
"bitcore-lib": "^8.25.25",
"bn.js": "=4.11.8",
"bs58": "^4.0.1",
"buffer-compare": "=1.1.1",
"elliptic": "^6.5.3",
"inherits": "=2.0.1",
"lodash": "^4.17.20"
}
},
"node_modules/@chris.troutner/bitcore-lib-cash/node_modules/bn.js": {
"version": "4.11.8",
"resolved": "https://registry.npmjs.org/bn.js/-/bn.js-4.11.8.tgz",
"integrity": "sha512-ItfYfPLkWHUjckQCk8xC+LwxgK8NYcXywGigJgSwOP8Y2iyWT4f2vsZnoOXTTbo+o5yXmIUJ4gn5538SO5S3gA==",
"license": "MIT"
},
"node_modules/@chris.troutner/bitcore-lib-cash/node_modules/inherits": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz",
"integrity": "sha512-8nWq2nLTAwd02jTqJExUYFSD/fKq6VH9Y/oG2accc/kdI0V98Bag8d5a4gi3XHz73rDWa2PvTtvcWYquKqSENA==",
"license": "ISC"
},
"node_modules/@chris.troutner/retry-queue-commonjs": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/@chris.troutner/retry-queue-commonjs/-/retry-queue-commonjs-1.0.8.tgz",
@@ -2343,6 +2371,56 @@
"node": ">=0.10"
}
},
"node_modules/bitcore-lib": {
"version": "8.25.47",
"resolved": "https://registry.npmjs.org/bitcore-lib/-/bitcore-lib-8.25.47.tgz",
"integrity": "sha512-qDZr42HuP4P02I8kMGZUx/vvwuDsz8X3rQxXLfM0BtKzlQBcbSM7ycDkDN99Xc5jzpd4fxNQyyFXOmc6owUsrQ==",
"license": "MIT",
"dependencies": {
"bech32": "=2.0.0",
"bip-schnorr": "=0.6.4",
"bn.js": "=4.11.8",
"bs58": "^4.0.1",
"buffer-compare": "=1.1.1",
"elliptic": "^6.5.3",
"inherits": "=2.0.1",
"lodash": "^4.17.20"
}
},
"node_modules/bitcore-lib/node_modules/bech32": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/bech32/-/bech32-2.0.0.tgz",
"integrity": "sha512-LcknSilhIGatDAsY1ak2I8VtGaHNhgMSYVxFrGLXv+xLHytaKZKcaUJJUE7qmBr7h33o5YQwP55pMI0xmkpJwg==",
"license": "MIT"
},
"node_modules/bitcore-lib/node_modules/bip-schnorr": {
"version": "0.6.4",
"resolved": "https://registry.npmjs.org/bip-schnorr/-/bip-schnorr-0.6.4.tgz",
"integrity": "sha512-dNKw7Lea8B0wMIN4OjEmOk/Z5qUGqoPDY0P2QttLqGk1hmDPytLWW8PR5Pb6Vxy6CprcdEgfJpOjUu+ONQveyg==",
"license": "MIT",
"dependencies": {
"bigi": "^1.4.2",
"ecurve": "^1.0.6",
"js-sha256": "^0.9.0",
"randombytes": "^2.1.0",
"safe-buffer": "^5.2.1"
},
"engines": {
"node": ">=8.0.0"
}
},
"node_modules/bitcore-lib/node_modules/bn.js": {
"version": "4.11.8",
"resolved": "https://registry.npmjs.org/bn.js/-/bn.js-4.11.8.tgz",
"integrity": "sha512-ItfYfPLkWHUjckQCk8xC+LwxgK8NYcXywGigJgSwOP8Y2iyWT4f2vsZnoOXTTbo+o5yXmIUJ4gn5538SO5S3gA==",
"license": "MIT"
},
"node_modules/bitcore-lib/node_modules/inherits": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz",
"integrity": "sha512-8nWq2nLTAwd02jTqJExUYFSD/fKq6VH9Y/oG2accc/kdI0V98Bag8d5a4gi3XHz73rDWa2PvTtvcWYquKqSENA==",
"license": "ISC"
},
"node_modules/bn.js": {
"version": "4.12.2",
"resolved": "https://registry.npmjs.org/bn.js/-/bn.js-4.12.2.tgz",
@@ -2481,6 +2559,11 @@
"safe-buffer": "^5.1.2"
}
},
"node_modules/buffer-compare": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/buffer-compare/-/buffer-compare-1.1.1.tgz",
"integrity": "sha512-O6NvNiHZMd3mlIeMDjP6t/gPG75OqGPeiRZXoMQZJ6iy9GofCls4Ijs5YkPZZwoysizLiedhticmdyx/GyHghA=="
},
"node_modules/buffer-equals": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/buffer-equals/-/buffer-equals-1.0.4.tgz",
@@ -7712,6 +7795,48 @@
"integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==",
"license": "MIT"
},
"node_modules/psf-multisig-approval": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/psf-multisig-approval/-/psf-multisig-approval-2.1.0.tgz",
"integrity": "sha512-QLlOnYzeOx6OQXu5MGRlSP/IhS+X1Y7v3WxUse9riqYHOvvz3WeUPZUB8TVnSsUR6lH5W8Ckshl1lnaWXcPs7Q==",
"license": "MIT",
"dependencies": {
"@chris.troutner/bitcore-lib-cash": "8.25.26",
"axios": "1.3.5"
}
},
"node_modules/psf-multisig-approval/node_modules/axios": {
"version": "1.3.5",
"resolved": "https://registry.npmjs.org/axios/-/axios-1.3.5.tgz",
"integrity": "sha512-glL/PvG/E+xCWwV8S6nCHcrfg1exGx7vxyUIivIA1iL7BIh6bePylCfVHwp6k13ao7SATxB6imau2kqY+I67kw==",
"license": "MIT",
"dependencies": {
"follow-redirects": "^1.15.0",
"form-data": "^4.0.0",
"proxy-from-env": "^1.1.0"
}
},
"node_modules/psffpp": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/psffpp/-/psffpp-1.2.0.tgz",
"integrity": "sha512-F3KDh6pzI5ZRxkek6KWFpwIcgx9tocnAKJie0HwNwTBuuS40/LsUnkmhVMghufF603Fp0vO6o3P4vgbTTzw6pg==",
"license": "MIT",
"dependencies": {
"axios": "1.3.5",
"psf-multisig-approval": "2.1.0"
}
},
"node_modules/psffpp/node_modules/axios": {
"version": "1.3.5",
"resolved": "https://registry.npmjs.org/axios/-/axios-1.3.5.tgz",
"integrity": "sha512-glL/PvG/E+xCWwV8S6nCHcrfg1exGx7vxyUIivIA1iL7BIh6bePylCfVHwp6k13ao7SATxB6imau2kqY+I67kw==",
"license": "MIT",
"dependencies": {
"follow-redirects": "^1.15.0",
"form-data": "^4.0.0",
"proxy-from-env": "^1.1.0"
}
},
"node_modules/pstree.remy": {
"version": "1.1.8",
"resolved": "https://registry.npmjs.org/pstree.remy/-/pstree.remy-1.1.8.tgz",
package.json
+1
View File
@@ -21,6 +21,7 @@
"dotenv": "16.3.1",
"express": "5.1.0",
"minimal-slp-wallet": "5.13.3",
"psffpp": "1.2.0",
"slp-token-media": "1.2.10",
"winston": "3.11.0",
"winston-daily-rotate-file": "4.7.1",
src/config/env/common.js
Vendored
+9 -2
View File
@@ -34,10 +34,15 @@ const priceSat = Number.isFinite(parsedPriceSat) && parsedPriceSat > 0 ? parsedP
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',
serverAddress: process.env.SERVER_BCH_ADDRESS || 'bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr',
priceSat
}
const basicAuthDefaults = {
enabled: normalizeBoolean(process.env.USE_BASIC_AUTH, false),
token: process.env.BASIC_AUTH_TOKEN || ''
}
export default {
// Server port
port: process.env.PORT || 5942,
@@ -73,13 +78,15 @@ export default {
},
// REST API URL for wallet operations
restURL: process.env.REST_URL || process.env.LOCAL_RESTURL || 'http://127.0.0.1:3000/v5/',
restURL: process.env.REST_URL || process.env.LOCAL_RESTURL || 'http://127.0.0.1:5942/v6/',
// IPFS Gateway URL
ipfsGateway: process.env.IPFS_GATEWAY || 'p2wdb-gateway-678.fullstack.cash',
x402: x402Defaults,
basicAuth: basicAuthDefaults,
// Version
version
}
src/config/x402.js
+7
View File
@@ -41,3 +41,10 @@ export function getX402Settings () {
priceSat: config.x402?.priceSat
}
}
export function getBasicAuthSettings () {
return {
enabled: Boolean(config.basicAuth?.enabled),
token: config.basicAuth?.token || ''
}
}
src/controllers/rest-api/index.js
+4
View File
@@ -12,6 +12,7 @@ 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 PriceRouter from './price/router.js'
import RawTransactionsRouter from './full-node/rawtransactions/router.js'
import SlpRouter from './slp/router.js'
import config from '../../config/index.js'
@@ -75,6 +76,9 @@ class RESTControllers {
const miningRouter = new MiningRouter(dependencies)
miningRouter.attach(app)
const priceRouter = new PriceRouter(dependencies)
priceRouter.attach(app)
const rawtransactionsRouter = new RawTransactionsRouter(dependencies)
rawtransactionsRouter.attach(app)
src/controllers/rest-api/price/controller.js
+96
View File
@@ -0,0 +1,96 @@
/*
REST API Controller for the /price routes.
*/
import wlogger from '../../../adapters/wlogger.js'
class PriceRESTController {
constructor (localConfig = {}) {
this.adapters = localConfig.adapters
if (!this.adapters) {
throw new Error(
'Instance of Adapters library required when instantiating Price REST Controller.'
)
}
this.useCases = localConfig.useCases
if (!this.useCases || !this.useCases.price) {
throw new Error(
'Instance of Price use cases required when instantiating Price REST Controller.'
)
}
this.priceUseCases = this.useCases.price
// Bind functions
this.root = this.root.bind(this)
this.getBCHUSD = this.getBCHUSD.bind(this)
this.getPsffppWritePrice = this.getPsffppWritePrice.bind(this)
this.handleError = this.handleError.bind(this)
}
/**
* @api {get} /v6/price/ Service status
* @apiName PriceRoot
* @apiGroup Price
*
* @apiDescription Returns the status of the price service.
*
* @apiSuccess {String} status Service identifier
*/
async root (req, res) {
return res.status(200).json({ status: 'price' })
}
/**
* @api {get} /v6/price/bchusd Get the USD price of BCH
* @apiName GetBCHUSD
* @apiGroup Price
* @apiDescription Get the USD price of BCH from Coinex.
*
* @apiExample Example usage:
* curl -X GET "https://api.fullstack.cash/v6/price/bchusd" -H "accept: application/json"
*
* @apiSuccess {Number} usd The USD price of BCH
*/
async getBCHUSD (req, res) {
try {
const price = await this.priceUseCases.getBCHUSD()
return res.status(200).json({ usd: price })
} catch (err) {
return this.handleError(err, res)
}
}
/**
* @api {get} /v6/price/psffpp Get the PSF price for writing to the PSFFPP
* @apiName GetPsffppWritePrice
* @apiGroup Price
* @apiDescription Get the price to pin 1MB of content to the PSFFPP pinning
* network on IPFS. The price is denominated in PSF tokens.
*
* @apiExample Example usage:
* curl -X GET "https://api.fullstack.cash/v6/price/psffpp" -H "accept: application/json"
*
* @apiSuccess {Number} writePrice The price in PSF tokens to write 1MB to PSFFPP
*/
async getPsffppWritePrice (req, res) {
try {
const writePrice = await this.priceUseCases.getPsffppWritePrice()
return res.status(200).json({ writePrice })
} catch (err) {
return this.handleError(err, res)
}
}
handleError (err, res) {
wlogger.error('Error in PriceRESTController:', err)
const status = err.status || 500
const message = err.message || 'Internal server error'
return res.status(status).json({ error: message })
}
}
export default PriceRESTController
src/controllers/rest-api/price/router.js
+52
View File
@@ -0,0 +1,52 @@
/*
REST API router for /price routes.
*/
import express from 'express'
import PriceRESTController from './controller.js'
class PriceRouter {
constructor (localConfig = {}) {
this.adapters = localConfig.adapters
if (!this.adapters) {
throw new Error(
'Instance of Adapters library required when instantiating Price REST Router.'
)
}
this.useCases = localConfig.useCases
if (!this.useCases) {
throw new Error(
'Instance of Use Cases library required when instantiating Price REST Router.'
)
}
const dependencies = {
adapters: this.adapters,
useCases: this.useCases
}
this.priceController = new PriceRESTController(dependencies)
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
this.baseUrl = `${this.apiPrefix}/price`
if (!this.baseUrl.startsWith('/')) {
this.baseUrl = `/${this.baseUrl}`
}
this.router = express.Router()
}
attach (app) {
if (!app) {
throw new Error('Must pass app object when attaching REST API controllers.')
}
this.router.get('/', this.priceController.root)
this.router.get('/bchusd', this.priceController.getBCHUSD)
this.router.get('/psffpp', this.priceController.getPsffppWritePrice)
app.use(this.baseUrl, this.router)
}
}
export default PriceRouter
src/middleware/basic-auth.js
+61
View File
@@ -0,0 +1,61 @@
/*
Basic Authentication Middleware
This middleware validates Bearer tokens from the Authorization header.
When a valid token is provided, it sets req.locals.basicAuthValid = true
to allow bypassing x402 middleware.
*/
import config from '../config/index.js'
import wlogger from '../adapters/wlogger.js'
/**
* Middleware function that validates Bearer token authentication
* @param {Object} req - Express request object
* @param {Object} res - Express response object
* @param {Function} next - Express next middleware function
*/
export function basicAuthMiddleware (req, res, next) {
// Initialize req.locals if it doesn't exist
if (!req.locals) {
req.locals = {}
}
// Default to false
req.locals.basicAuthValid = false
// Get the configured token
const configuredToken = config.basicAuth?.token
// If no token is configured, skip validation
if (!configuredToken) {
wlogger.warn('Basic auth enabled but no BASIC_AUTH_TOKEN configured')
return next()
}
// Get the Authorization header
const authHeader = req.headers.authorization
// If no Authorization header, continue (x402 will handle unauthorized requests)
if (!authHeader) {
return next()
}
// Check if it's a Bearer token
const parts = authHeader.split(' ')
if (parts.length !== 2 || parts[0] !== 'Bearer') {
return next()
}
const providedToken = parts[1]
// Compare tokens
if (providedToken === configuredToken) {
req.locals.basicAuthValid = true
wlogger.verbose(`Basic auth validated for request to ${req.path}`)
}
// Always continue to next middleware
// If auth failed, x402 middleware will handle the request
next()
}
src/use-cases/index.js
+2
View File
@@ -10,6 +10,7 @@ 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 PriceUseCases from './price-use-cases.js'
import RawTransactionsUseCases from './full-node-rawtransactions-use-cases.js'
import SlpUseCases from './slp-use-cases.js'
@@ -27,6 +28,7 @@ class UseCases {
this.dsproof = new DSProofUseCases({ adapters: this.adapters })
this.fulcrum = new FulcrumUseCases({ adapters: this.adapters })
this.mining = new MiningUseCases({ adapters: this.adapters })
this.price = new PriceUseCases({ adapters: this.adapters })
this.rawtransactions = new RawTransactionsUseCases({ adapters: this.adapters })
this.slp = new SlpUseCases({ adapters: this.adapters })
}
src/use-cases/price-use-cases.js
+83
View File
@@ -0,0 +1,83 @@
/*
Use cases for price-related operations.
*/
// Global npm libraries
import axios from 'axios'
import SlpWallet from 'minimal-slp-wallet'
import PSFFPP from 'psffpp'
// Local libraries
import wlogger from '../adapters/wlogger.js'
import config from '../config/index.js'
class PriceUseCases {
constructor (localConfig = {}) {
this.adapters = localConfig.adapters
if (!this.adapters) {
throw new Error('Adapters instance required when instantiating Price use cases.')
}
// Get config
this.config = localConfig.config || config
// Coinex API URL for BCH/USDT
this.bchCoinexPriceUrl =
'https://api.coinex.com/v1/market/ticker?market=bchusdt'
// Allow axios to be injected for testing
this.axios = localConfig.axios || axios
}
/**
* Get the USD price of BCH from Coinex.
* @returns {Promise<number>} The USD price of BCH
*/
async getBCHUSD () {
try {
// Request options
const opt = {
method: 'get',
baseURL: this.bchCoinexPriceUrl,
timeout: 15000
}
const response = await this.axios.request(opt)
const price = Number(response.data.data.ticker.last)
return price
} catch (err) {
wlogger.error('Error in PriceUseCases.getBCHUSD()', err)
throw err
}
}
/**
* Get the PSF price for writing to the PSFFPP.
* Returns the price to pin 1MB of content to the PSFFPP pinning
* network on IPFS. The price is denominated in PSF tokens.
* @returns {Promise<number>} The write price in PSF tokens
*/
async getPsffppWritePrice () {
try {
const wallet = new SlpWallet(undefined, {
interface: 'rest-api',
restURL: this.config.restURL
})
await wallet.walletInfoPromise
const psffpp = new PSFFPP({ wallet })
const writePrice = await psffpp.getMcWritePrice()
return writePrice
} catch (err) {
wlogger.error('Error in PriceUseCases.getPsffppWritePrice()', err)
throw err
}
}
}
export default PriceUseCases
test/unit/controllers/price-controller-unit.js
+116
View File
@@ -0,0 +1,116 @@
/*
Unit tests for PriceRESTController.
*/
import { assert } from 'chai'
import sinon from 'sinon'
import PriceRESTController from '../../../src/controllers/rest-api/price/controller.js'
import { createMockRequest, createMockResponse } from '../mocks/controller-mocks.js'
describe('#price-controller.js', () => {
let sandbox
let mockAdapters
let mockUseCases
let uut
beforeEach(() => {
sandbox = sinon.createSandbox()
mockAdapters = {}
mockUseCases = {
price: {
getBCHUSD: sandbox.stub().resolves(250.5),
getPsffppWritePrice: sandbox.stub().resolves(0.08335233)
}
}
uut = new PriceRESTController({
adapters: mockAdapters,
useCases: mockUseCases
})
})
afterEach(() => {
sandbox.restore()
})
describe('#constructor()', () => {
it('should require adapters', () => {
assert.throws(() => {
// eslint-disable-next-line no-new
new PriceRESTController({ useCases: mockUseCases })
}, /Adapters library required/)
})
it('should require price use cases', () => {
assert.throws(() => {
// eslint-disable-next-line no-new
new PriceRESTController({ adapters: mockAdapters, useCases: {} })
}, /Price use cases required/)
})
})
describe('#root()', () => {
it('should return price status', async () => {
const req = createMockRequest()
const res = createMockResponse()
await uut.root(req, res)
assert.equal(res.statusValue, 200)
assert.deepEqual(res.jsonData, { status: 'price' })
})
})
describe('#getBCHUSD()', () => {
it('should return BCH USD price on success', async () => {
const req = createMockRequest()
const res = createMockResponse()
await uut.getBCHUSD(req, res)
assert.equal(res.statusValue, 200)
assert.deepEqual(res.jsonData, { usd: 250.5 })
assert.isTrue(mockUseCases.price.getBCHUSD.calledOnce)
})
it('should handle errors via handleError', async () => {
const error = new Error('API failure')
error.status = 503
mockUseCases.price.getBCHUSD.rejects(error)
const req = createMockRequest()
const res = createMockResponse()
await uut.getBCHUSD(req, res)
assert.equal(res.statusValue, 503)
assert.deepEqual(res.jsonData, { error: 'API failure' })
})
})
describe('#getPsffppWritePrice()', () => {
it('should return PSFFPP write price on success', async () => {
const req = createMockRequest()
const res = createMockResponse()
await uut.getPsffppWritePrice(req, res)
assert.equal(res.statusValue, 200)
assert.deepEqual(res.jsonData, { writePrice: 0.08335233 })
assert.isTrue(mockUseCases.price.getPsffppWritePrice.calledOnce)
})
it('should handle errors via handleError', async () => {
const error = new Error('PSFFPP failure')
error.status = 500
mockUseCases.price.getPsffppWritePrice.rejects(error)
const req = createMockRequest()
const res = createMockResponse()
await uut.getPsffppWritePrice(req, res)
assert.equal(res.statusValue, 500)
assert.deepEqual(res.jsonData, { error: 'PSFFPP failure' })
})
})
})
test/unit/controllers/rest-api-index-unit.js
+8
View File
@@ -10,6 +10,7 @@ import BlockchainRouter from '../../../src/controllers/rest-api/full-node/blockc
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 PriceRouter from '../../../src/controllers/rest-api/price/router.js'
import RawTransactionsRouter from '../../../src/controllers/rest-api/full-node/rawtransactions/router.js'
import FulcrumRouter from '../../../src/controllers/rest-api/fulcrum/router.js'
import SlpRouter from '../../../src/controllers/rest-api/slp/router.js'
@@ -75,6 +76,10 @@ describe('#controllers/rest-api/index.js', () => {
getMiningInfo: () => {},
getNetworkHashPS: () => {}
},
price: {
getBCHUSD: () => {},
getPsffppWritePrice: () => {}
},
rawtransactions: {
decodeRawTransaction: () => {},
decodeRawTransactions: () => {},
@@ -126,6 +131,7 @@ describe('#controllers/rest-api/index.js', () => {
const dsproofAttachStub = sandbox.stub(DSProofRouter.prototype, 'attach')
const fulcrumAttachStub = sandbox.stub(FulcrumRouter.prototype, 'attach')
const miningAttachStub = sandbox.stub(MiningRouter.prototype, 'attach')
const priceAttachStub = sandbox.stub(PriceRouter.prototype, 'attach')
const rawtransactionsAttachStub = sandbox.stub(RawTransactionsRouter.prototype, 'attach')
const slpAttachStub = sandbox.stub(SlpRouter.prototype, 'attach')
const restControllers = new RESTControllers({
@@ -146,6 +152,8 @@ describe('#controllers/rest-api/index.js', () => {
assert.equal(fulcrumAttachStub.getCall(0).args[0], app)
assert.isTrue(miningAttachStub.calledOnce)
assert.equal(miningAttachStub.getCall(0).args[0], app)
assert.isTrue(priceAttachStub.calledOnce)
assert.equal(priceAttachStub.getCall(0).args[0], app)
assert.isTrue(rawtransactionsAttachStub.calledOnce)
assert.equal(rawtransactionsAttachStub.getCall(0).args[0], app)
assert.isTrue(slpAttachStub.calledOnce)
test/unit/use-cases/price-use-cases-unit.js
+103
View File
@@ -0,0 +1,103 @@
/*
Unit tests for PriceUseCases.
*/
import { assert } from 'chai'
import sinon from 'sinon'
import PriceUseCases from '../../../src/use-cases/price-use-cases.js'
describe('#price-use-cases.js', () => {
let sandbox
let mockAdapters
let mockAxios
let mockConfig
let uut
beforeEach(() => {
sandbox = sinon.createSandbox()
mockAdapters = {}
mockConfig = {
restURL: 'http://localhost:3000/v5/'
}
// Mock axios
mockAxios = {
request: sandbox.stub()
}
uut = new PriceUseCases({
adapters: mockAdapters,
axios: mockAxios,
config: mockConfig
})
})
afterEach(() => {
sandbox.restore()
})
describe('#constructor()', () => {
it('should require adapters', () => {
assert.throws(() => {
// eslint-disable-next-line no-new
new PriceUseCases()
}, /Adapters instance required/)
})
})
describe('#getBCHUSD()', () => {
it('should return BCH price from Coinex API', async () => {
const mockPrice = 250.5
mockAxios.request.resolves({
data: {
data: {
ticker: {
last: mockPrice.toString()
}
}
}
})
const result = await uut.getBCHUSD()
assert.equal(result, mockPrice)
assert.isTrue(mockAxios.request.calledOnce)
const callArgs = mockAxios.request.getCall(0).args[0]
assert.equal(callArgs.method, 'get')
assert.equal(callArgs.baseURL, 'https://api.coinex.com/v1/market/ticker?market=bchusdt')
assert.equal(callArgs.timeout, 15000)
})
it('should handle errors', async () => {
const error = new Error('API error')
mockAxios.request.rejects(error)
try {
await uut.getBCHUSD()
assert.fail('Should have thrown an error')
} catch (err) {
assert.equal(err.message, 'API error')
}
})
})
describe('#getPsffppWritePrice()', () => {
it('should handle errors properly', async () => {
// Note: Full unit testing of getPsffppWritePrice is difficult due to dynamic imports
// of SlpWallet and PSFFPP. Integration tests should verify the full flow.
// This test verifies that errors are properly handled and propagated.
try {
// This will likely fail in unit test environment without proper setup
// but we verify error handling works correctly
await uut.getPsffppWritePrice()
// If it succeeds, that's also acceptable
} catch (err) {
// Verify error is properly formatted
assert.isTrue(err instanceof Error)
// Verify error was logged (indirectly through wlogger)
}
})
})
})