mirror of
https://github.com/Permissionless-Software-Foundation/psf-bch-api.git
synced 2026-09-22 09:02:01 -07:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ea815868ab | ||
|
|
d17e3aa2d8 | ||
|
|
1cd57a8bd7 | ||
|
|
50db4be890 | ||
|
|
908911fba6 | ||
|
|
f6726c79bf | ||
|
|
8b12938e6c | ||
|
|
d204f78fa4 | ||
|
|
58e831b22c | ||
|
|
6451736f26 | ||
|
|
571acbec59 | ||
|
|
394ab73276 | ||
|
|
ca0fcdd60a | ||
|
|
98576e5ff2 |
@@ -19,6 +19,8 @@ LOCAL_RESTURL=http://localhost:5942/v6
|
||||
|
||||
# START ACCESS CONTROL
|
||||
|
||||
PORT=5942
|
||||
|
||||
# x402 payments required to access this API?
|
||||
X402_ENABLED=true
|
||||
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
|
||||
|
||||
Generated
+583
-318
File diff suppressed because it is too large
Load Diff
+3
-3
@@ -15,13 +15,13 @@
|
||||
"license": "MIT",
|
||||
"description": "REST API proxy to Bitcoin Cash infrastructure",
|
||||
"dependencies": {
|
||||
"@psf/bch-js": "6.8.3",
|
||||
"@psf/bch-js": "7.1.0",
|
||||
"axios": "1.7.7",
|
||||
"cors": "2.8.5",
|
||||
"dotenv": "16.3.1",
|
||||
"express": "5.1.0",
|
||||
"minimal-slp-wallet": "5.13.3",
|
||||
"psffpp": "1.2.0",
|
||||
"minimal-slp-wallet": "7.0.1",
|
||||
"psffpp": "1.2.1",
|
||||
"slp-token-media": "1.2.10",
|
||||
"winston": "3.11.0",
|
||||
"winston-daily-rotate-file": "4.7.1",
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# START INFRASTRUCTURE SETUP
|
||||
|
||||
# Full Node Connection
|
||||
RPC_BASEURL=http://172.17.0.1:8332
|
||||
RPC_USERNAME=bitcoin
|
||||
RPC_PASSWORD=password
|
||||
|
||||
# Fulcrum Indexer
|
||||
FULCRUM_API=http://172.17.0.1:3001/v1
|
||||
|
||||
# SLP Indexer
|
||||
SLP_INDEXER_API=http://localhost:5010
|
||||
|
||||
# REST API URL for wallet operations
|
||||
LOCAL_RESTURL=http://localhost:5942/v6
|
||||
|
||||
# END INFRASTRUCTURE SETUP
|
||||
|
||||
|
||||
# START ACCESS CONTROL
|
||||
|
||||
PORT=5942
|
||||
|
||||
# x402 payments required to access this API?
|
||||
X402_ENABLED=true
|
||||
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
|
||||
FACILITATOR_URL=http://localhost:4345/facilitator
|
||||
|
||||
# Basic Authentication required to access this API?
|
||||
USE_BASIC_AUTH=true
|
||||
BASIC_AUTH_TOKEN=some-random-token
|
||||
|
||||
# END ACCESS CONTROL
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
#
|
||||
|
||||
#IMAGE BUILD COMMANDS
|
||||
# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
|
||||
#FROM christroutner/ct-base-ubuntu
|
||||
FROM ubuntu:22.04
|
||||
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
||||
|
||||
@@ -47,39 +45,24 @@ RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
|
||||
|
||||
# Clone the rest.bitcoin.com repository
|
||||
WORKDIR /home/safeuser
|
||||
RUN git clone https://github.com/christroutner/REST2NOSTR
|
||||
RUN git clone https://github.com/Permissionless-Software-Foundation/psf-bch-api
|
||||
|
||||
# Switch to the desired branch. `master` is usually stable,
|
||||
# and `stage` has the most up-to-date changes.
|
||||
WORKDIR /home/safeuser/REST2NOSTR
|
||||
|
||||
# For development: switch to unstable branch
|
||||
#RUN git checkout pin-ipfs
|
||||
WORKDIR /home/safeuser/psf-bch-api
|
||||
|
||||
# Install dependencies
|
||||
RUN npm install
|
||||
RUN npm install minimal-slp-wallet
|
||||
|
||||
# Generate the API docs
|
||||
RUN npm run docs
|
||||
|
||||
#VOLUME /home/safeuser/keys
|
||||
COPY .env-local .env
|
||||
|
||||
# Make leveldb folders
|
||||
#RUN mkdir leveldb
|
||||
#WORKDIR /home/safeuser/psf-slp-indexer/leveldb
|
||||
#RUN mkdir current
|
||||
#RUN mkdir zips
|
||||
#RUN mkdir backup
|
||||
#WORKDIR /home/safeuser/psf-slp-indexer/leveldb/zips
|
||||
#COPY restore-auto.sh restore-auto.sh
|
||||
#WORKDIR /home/safeuser/psf-slp-indexer
|
||||
|
||||
# Expose the port the API will be served on.
|
||||
#EXPOSE 5011
|
||||
CMD ["npm", "start"]
|
||||
|
||||
# Start the application.
|
||||
#COPY start-production.sh start-production.sh
|
||||
VOLUME start-rest2nostr.sh
|
||||
CMD ["./start-rest2nostr.sh"]
|
||||
|
||||
#CMD ["npm", "start"]
|
||||
# Used to debug the container.
|
||||
#COPY temp.js temp.js
|
||||
#CMD ["node", "temp.js"]
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Start the service with the command 'docker-compose up -d'
|
||||
|
||||
services:
|
||||
rest2nostr:
|
||||
psf-bch-api:
|
||||
build: .
|
||||
container_name: rest2nostr
|
||||
container_name: psf-bch-api
|
||||
logging:
|
||||
driver: 'json-file'
|
||||
options:
|
||||
@@ -15,5 +15,6 @@ services:
|
||||
ports:
|
||||
- '5942:5942' # <host port>:<container port>
|
||||
volumes:
|
||||
- ./start-rest2nostr.sh:/home/safeuser/REST2NOSTR/start-rest2nostr.sh
|
||||
#- ./start-rest2nostr.sh:/home/safeuser/REST2NOSTR/start-rest2nostr.sh
|
||||
- ./.env:/home/safeuser/.env
|
||||
restart: always
|
||||
@@ -0,0 +1,7 @@
|
||||
// Simple Node.js app that prints 'hello world' every 10 seconds
|
||||
|
||||
setInterval(() => {
|
||||
console.log('hello world')
|
||||
}, 10000)
|
||||
|
||||
console.log('Timer started. Printing "hello world" every 10 seconds...')
|
||||
Vendored
+1
-1
@@ -45,7 +45,7 @@ const basicAuthDefaults = {
|
||||
|
||||
export default {
|
||||
// Server port
|
||||
port: process.env.PORT || 5942,
|
||||
port: parseInt(process.env.PORT, 10) || 5942,
|
||||
|
||||
// Environment
|
||||
env: process.env.NODE_ENV || 'development',
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
/*
|
||||
REST API Controller for the /encryption routes.
|
||||
*/
|
||||
|
||||
import wlogger from '../../../adapters/wlogger.js'
|
||||
|
||||
class EncryptionRESTController {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating Encryption REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases || !this.useCases.encryption) {
|
||||
throw new Error(
|
||||
'Instance of Encryption use cases required when instantiating Encryption REST Controller.'
|
||||
)
|
||||
}
|
||||
|
||||
this.encryptionUseCases = this.useCases.encryption
|
||||
|
||||
// Bind functions
|
||||
this.root = this.root.bind(this)
|
||||
this.getPublicKey = this.getPublicKey.bind(this)
|
||||
this.handleError = this.handleError.bind(this)
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/encryption/ Service status
|
||||
* @apiName EncryptionRoot
|
||||
* @apiGroup Encryption
|
||||
*
|
||||
* @apiDescription Returns the status of the encryption service.
|
||||
*
|
||||
* @apiSuccess {String} status Service identifier
|
||||
*/
|
||||
async root (req, res) {
|
||||
return res.status(200).json({ status: 'encryption' })
|
||||
}
|
||||
|
||||
/**
|
||||
* @api {get} /v6/encryption/publickey/:address Get public key for a BCH address
|
||||
* @apiName GetPublicKey
|
||||
* @apiGroup Encryption
|
||||
* @apiDescription Searches the blockchain for a public key associated with a
|
||||
* BCH address. Returns an object. If successful, the publicKey property will
|
||||
* contain a hexadecimal representation of the public key.
|
||||
*
|
||||
* @apiParam {String} address BCH address (cash address or legacy format)
|
||||
*
|
||||
* @apiExample Example usage:
|
||||
* curl -X GET "https://api.fullstack.cash/v6/encryption/publickey/bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf" -H "accept: application/json"
|
||||
*
|
||||
* @apiSuccess {Boolean} success Indicates if the operation was successful
|
||||
* @apiSuccess {String} publicKey The public key in hexadecimal format, or "not found"
|
||||
*/
|
||||
async getPublicKey (req, res) {
|
||||
try {
|
||||
const address = req.params.address
|
||||
|
||||
// Reject if address is an array
|
||||
if (Array.isArray(address)) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'address can not be an array.'
|
||||
})
|
||||
}
|
||||
|
||||
// Reject if address is missing
|
||||
if (!address) {
|
||||
res.status(400)
|
||||
return res.json({
|
||||
success: false,
|
||||
error: 'address is required.'
|
||||
})
|
||||
}
|
||||
|
||||
const result = await this.encryptionUseCases.getPublicKey({ address })
|
||||
|
||||
return res.status(200).json(result)
|
||||
} catch (err) {
|
||||
return this.handleError(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
handleError (err, res) {
|
||||
wlogger.error('Error in EncryptionRESTController:', err)
|
||||
|
||||
const status = err.status || 500
|
||||
const message = err.message || 'Internal server error'
|
||||
|
||||
return res.status(status).json({ success: false, error: message })
|
||||
}
|
||||
}
|
||||
|
||||
export default EncryptionRESTController
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
REST API router for /encryption routes.
|
||||
*/
|
||||
|
||||
import express from 'express'
|
||||
import EncryptionRESTController from './controller.js'
|
||||
|
||||
class EncryptionRouter {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error(
|
||||
'Instance of Adapters library required when instantiating Encryption REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases) {
|
||||
throw new Error(
|
||||
'Instance of Use Cases library required when instantiating Encryption REST Router.'
|
||||
)
|
||||
}
|
||||
|
||||
const dependencies = {
|
||||
adapters: this.adapters,
|
||||
useCases: this.useCases
|
||||
}
|
||||
|
||||
this.encryptionController = new EncryptionRESTController(dependencies)
|
||||
|
||||
this.apiPrefix = (localConfig.apiPrefix || '').replace(/\/$/, '')
|
||||
this.baseUrl = `${this.apiPrefix}/encryption`
|
||||
if (!this.baseUrl.startsWith('/')) {
|
||||
this.baseUrl = `/${this.baseUrl}`
|
||||
}
|
||||
this.router = express.Router()
|
||||
}
|
||||
|
||||
attach (app) {
|
||||
if (!app) {
|
||||
throw new Error('Must pass app object when attaching REST API controllers.')
|
||||
}
|
||||
|
||||
this.router.get('/', this.encryptionController.root)
|
||||
this.router.get('/publickey/:address', this.encryptionController.getPublicKey)
|
||||
|
||||
app.use(this.baseUrl, this.router)
|
||||
}
|
||||
}
|
||||
|
||||
export default EncryptionRouter
|
||||
@@ -4,8 +4,9 @@
|
||||
|
||||
import wlogger from '../../../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
import config from '../../../config/index.js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||
|
||||
class FulcrumRESTController {
|
||||
constructor (localConfig = {}) {
|
||||
|
||||
@@ -10,6 +10,7 @@
|
||||
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 EncryptionRouter from './encryption/router.js'
|
||||
import FulcrumRouter from './fulcrum/router.js'
|
||||
import MiningRouter from './full-node/mining/router.js'
|
||||
import PriceRouter from './price/router.js'
|
||||
@@ -70,6 +71,9 @@ class RESTControllers {
|
||||
const dsproofRouter = new DSProofRouter(dependencies)
|
||||
dsproofRouter.attach(app)
|
||||
|
||||
const encryptionRouter = new EncryptionRouter(dependencies)
|
||||
encryptionRouter.attach(app)
|
||||
|
||||
const fulcrumRouter = new FulcrumRouter(dependencies)
|
||||
fulcrumRouter.attach(app)
|
||||
|
||||
|
||||
@@ -4,8 +4,9 @@
|
||||
|
||||
import wlogger from '../../../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
import config from '../../../config/index.js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||
|
||||
class SlpRESTController {
|
||||
constructor (localConfig = {}) {
|
||||
@@ -201,6 +202,7 @@ class SlpRESTController {
|
||||
const result = await this.slpUseCases.getTokenData({ tokenId, withTxHistory })
|
||||
return res.status(200).json(result)
|
||||
} catch (err) {
|
||||
console.log('Error in /v6/slp/token/data getTokenData(): ', err)
|
||||
return this.handleError(err, res)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
/*
|
||||
Use cases for encryption-related operations.
|
||||
Retrieves public keys from the blockchain for BCH addresses.
|
||||
*/
|
||||
|
||||
// Global npm libraries
|
||||
import BCHJS from '@psf/bch-js'
|
||||
|
||||
// Local libraries
|
||||
import wlogger from '../adapters/wlogger.js'
|
||||
import config from '../config/index.js'
|
||||
|
||||
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||
|
||||
class EncryptionUseCases {
|
||||
constructor (localConfig = {}) {
|
||||
this.adapters = localConfig.adapters
|
||||
if (!this.adapters) {
|
||||
throw new Error('Adapters instance required when instantiating Encryption use cases.')
|
||||
}
|
||||
|
||||
this.useCases = localConfig.useCases
|
||||
if (!this.useCases) {
|
||||
throw new Error('UseCases instance required when instantiating Encryption use cases.')
|
||||
}
|
||||
|
||||
// Allow bchjs to be injected for testing
|
||||
this.bchjs = localConfig.bchjs || bchjs
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the public key for a BCH address by searching the blockchain.
|
||||
* Searches the transaction history of the address for a transaction input
|
||||
* that contains the public key.
|
||||
*
|
||||
* @param {Object} params - Parameters object
|
||||
* @param {string} params.address - BCH address (cash address or legacy format)
|
||||
* @returns {Promise<Object>} Object with success status and publicKey if found
|
||||
*/
|
||||
async getPublicKey ({ address }) {
|
||||
try {
|
||||
// Convert to cash address format
|
||||
const cashAddr = this.bchjs.Address.toCashAddress(address)
|
||||
|
||||
// Get transaction history for the address
|
||||
const txHistory = await this.useCases.fulcrum.getTransactions({ address: cashAddr })
|
||||
|
||||
// Extract just the TXIDs
|
||||
const txids = txHistory.transactions.map((elem) => elem.tx_hash)
|
||||
|
||||
// Throw error if there is no transaction history
|
||||
if (!txids || txids.length === 0) {
|
||||
throw new Error('No transaction history.')
|
||||
}
|
||||
|
||||
// Loop through the transaction history and search for the public key
|
||||
for (let i = 0; i < txids.length; i++) {
|
||||
const thisTx = txids[i]
|
||||
|
||||
// Get verbose transaction details
|
||||
const txDetails = await this.useCases.rawtransactions.getRawTransaction({
|
||||
txid: thisTx,
|
||||
verbose: true
|
||||
})
|
||||
|
||||
const vin = txDetails.vin
|
||||
|
||||
// Loop through each input
|
||||
for (let j = 0; j < vin.length; j++) {
|
||||
const thisVin = vin[j]
|
||||
|
||||
// Skip if no scriptSig (e.g., coinbase transactions)
|
||||
if (!thisVin.scriptSig || !thisVin.scriptSig.asm) {
|
||||
continue
|
||||
}
|
||||
|
||||
// Extract the script signature
|
||||
const scriptSig = thisVin.scriptSig.asm.split(' ')
|
||||
|
||||
// Extract the public key from the script signature (last element)
|
||||
const pubKey = scriptSig[scriptSig.length - 1]
|
||||
|
||||
// Skip if pubKey is not a valid hex string (basic validation)
|
||||
if (!pubKey || !/^[0-9a-fA-F]+$/.test(pubKey)) {
|
||||
continue
|
||||
}
|
||||
|
||||
try {
|
||||
// Generate cash address from public key
|
||||
const keyBuf = Buffer.from(pubKey, 'hex')
|
||||
const ec = this.bchjs.ECPair.fromPublicKey(keyBuf)
|
||||
const cashAddr2 = this.bchjs.ECPair.toCashAddress(ec)
|
||||
|
||||
// If public keys match, this is the correct public key
|
||||
if (cashAddr === cashAddr2) {
|
||||
return {
|
||||
success: true,
|
||||
publicKey: pubKey
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
// Skip invalid public keys - continue searching
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Public key not found in any transaction
|
||||
return {
|
||||
success: false,
|
||||
publicKey: 'not found'
|
||||
}
|
||||
} catch (err) {
|
||||
wlogger.error('Error in EncryptionUseCases.getPublicKey()', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default EncryptionUseCases
|
||||
@@ -4,8 +4,9 @@
|
||||
|
||||
import wlogger from '../adapters/wlogger.js'
|
||||
import BCHJS from '@psf/bch-js'
|
||||
import config from '../config/index.js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||
|
||||
class FulcrumUseCases {
|
||||
constructor (localConfig = {}) {
|
||||
@@ -53,7 +54,14 @@ class FulcrumUseCases {
|
||||
}
|
||||
|
||||
async getTransactionDetails ({ txid }) {
|
||||
return this.fulcrum.get(`electrumx/tx/data/${txid}`)
|
||||
try {
|
||||
const response = await this.fulcrum.get(`electrumx/tx/data/${txid}`)
|
||||
console.log(`getTransactionDetails() TXID ${txid}: ${JSON.stringify(response, null, 2)}`)
|
||||
return response
|
||||
} catch (err) {
|
||||
wlogger.error('Error in FulcrumUseCases.getTransactionDetails()', err)
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
async getTransactionDetailsBulk ({ txids, verbose }) {
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
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 EncryptionUseCases from './encryption-use-cases.js'
|
||||
import FulcrumUseCases from './fulcrum-use-cases.js'
|
||||
import MiningUseCases from './full-node-mining-use-cases.js'
|
||||
import PriceUseCases from './price-use-cases.js'
|
||||
@@ -31,6 +32,12 @@ class UseCases {
|
||||
this.price = new PriceUseCases({ adapters: this.adapters })
|
||||
this.rawtransactions = new RawTransactionsUseCases({ adapters: this.adapters })
|
||||
this.slp = new SlpUseCases({ adapters: this.adapters })
|
||||
|
||||
// Encryption use cases require access to other use cases (fulcrum, rawtransactions)
|
||||
this.encryption = new EncryptionUseCases({
|
||||
adapters: this.adapters,
|
||||
useCases: this
|
||||
})
|
||||
}
|
||||
|
||||
// Run any startup Use Cases at the start of the app.
|
||||
|
||||
@@ -9,7 +9,7 @@ import SlpTokenMedia from 'slp-token-media'
|
||||
import axios from 'axios'
|
||||
import config from '../config/index.js'
|
||||
|
||||
const bchjs = new BCHJS()
|
||||
const bchjs = new BCHJS({ restURL: config.restURL })
|
||||
|
||||
class SlpUseCases {
|
||||
constructor (localConfig = {}) {
|
||||
@@ -259,6 +259,7 @@ class SlpUseCases {
|
||||
|
||||
return mutableCid
|
||||
} catch (err) {
|
||||
console.log('Error in SlpUseCases.getMutableCid()', err)
|
||||
wlogger.error('Error in SlpUseCases.getMutableCid()', err)
|
||||
return false
|
||||
}
|
||||
@@ -271,7 +272,9 @@ class SlpUseCases {
|
||||
}
|
||||
|
||||
// Get transaction data
|
||||
console.log('Decoding OP_RETURN for TXID: ', txid)
|
||||
const txData = await this.bchjs.Electrumx.txData(txid)
|
||||
console.log(`TXID ${txid}: ${JSON.stringify(txData, null, 2)}`)
|
||||
let data = false
|
||||
|
||||
// Map the vout of the transaction in search of an OP_RETURN
|
||||
@@ -291,6 +294,7 @@ class SlpUseCases {
|
||||
|
||||
return data
|
||||
} catch (error) {
|
||||
console.log('Error in SlpUseCases.decodeOpReturn()', error)
|
||||
wlogger.error('Error in SlpUseCases.decodeOpReturn()', error)
|
||||
throw error
|
||||
}
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
/*
|
||||
Unit tests for EncryptionRESTController.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
import sinon from 'sinon'
|
||||
|
||||
import EncryptionRESTController from '../../../src/controllers/rest-api/encryption/controller.js'
|
||||
import { createMockRequest, createMockResponse, createMockRequestWithParams } from '../mocks/controller-mocks.js'
|
||||
|
||||
describe('#encryption-controller.js', () => {
|
||||
let sandbox
|
||||
let mockAdapters
|
||||
let mockUseCases
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.createSandbox()
|
||||
mockAdapters = {}
|
||||
mockUseCases = {
|
||||
encryption: {
|
||||
getPublicKey: sandbox.stub().resolves({
|
||||
success: true,
|
||||
publicKey: '02abc123def456789'
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
uut = new EncryptionRESTController({
|
||||
adapters: mockAdapters,
|
||||
useCases: mockUseCases
|
||||
})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new EncryptionRESTController({ useCases: mockUseCases })
|
||||
}, /Adapters library required/)
|
||||
})
|
||||
|
||||
it('should require encryption use cases', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new EncryptionRESTController({ adapters: mockAdapters, useCases: {} })
|
||||
}, /Encryption use cases required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#root()', () => {
|
||||
it('should return encryption status', async () => {
|
||||
const req = createMockRequest()
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.root(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, { status: 'encryption' })
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getPublicKey()', () => {
|
||||
it('should return public key on success', async () => {
|
||||
const req = createMockRequestWithParams({
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: true,
|
||||
publicKey: '02abc123def456789'
|
||||
})
|
||||
assert.isTrue(mockUseCases.encryption.getPublicKey.calledOnce)
|
||||
assert.isTrue(mockUseCases.encryption.getPublicKey.calledWith({
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
}))
|
||||
})
|
||||
|
||||
it('should return not found when public key is not found', async () => {
|
||||
mockUseCases.encryption.getPublicKey.resolves({
|
||||
success: false,
|
||||
publicKey: 'not found'
|
||||
})
|
||||
|
||||
const req = createMockRequestWithParams({
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 200)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
publicKey: 'not found'
|
||||
})
|
||||
})
|
||||
|
||||
it('should reject array addresses', async () => {
|
||||
const req = createMockRequestWithParams({
|
||||
address: ['addr1', 'addr2']
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 400)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'address can not be an array.'
|
||||
})
|
||||
assert.isFalse(mockUseCases.encryption.getPublicKey.called)
|
||||
})
|
||||
|
||||
it('should reject missing address', async () => {
|
||||
const req = createMockRequestWithParams({})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 400)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'address is required.'
|
||||
})
|
||||
assert.isFalse(mockUseCases.encryption.getPublicKey.called)
|
||||
})
|
||||
|
||||
it('should handle errors via handleError', async () => {
|
||||
const error = new Error('No transaction history.')
|
||||
error.status = 400
|
||||
mockUseCases.encryption.getPublicKey.rejects(error)
|
||||
|
||||
const req = createMockRequestWithParams({
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 400)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'No transaction history.'
|
||||
})
|
||||
})
|
||||
|
||||
it('should default to 500 status for errors without status', async () => {
|
||||
const error = new Error('Internal error')
|
||||
mockUseCases.encryption.getPublicKey.rejects(error)
|
||||
|
||||
const req = createMockRequestWithParams({
|
||||
address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
|
||||
})
|
||||
const res = createMockResponse()
|
||||
|
||||
await uut.getPublicKey(req, res)
|
||||
|
||||
assert.equal(res.statusValue, 500)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'Internal error'
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('#handleError()', () => {
|
||||
it('should use error status and message when provided', () => {
|
||||
const error = new Error('Custom error')
|
||||
error.status = 422
|
||||
const res = createMockResponse()
|
||||
|
||||
uut.handleError(error, res)
|
||||
|
||||
assert.equal(res.statusValue, 422)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'Custom error'
|
||||
})
|
||||
})
|
||||
|
||||
it('should default to 500 and Internal server error', () => {
|
||||
const error = {}
|
||||
const res = createMockResponse()
|
||||
|
||||
uut.handleError(error, res)
|
||||
|
||||
assert.equal(res.statusValue, 500)
|
||||
assert.deepEqual(res.jsonData, {
|
||||
success: false,
|
||||
error: 'Internal server error'
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -9,6 +9,7 @@ import RESTControllers from '../../../src/controllers/rest-api/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 EncryptionRouter from '../../../src/controllers/rest-api/encryption/router.js'
|
||||
import MiningRouter from '../../../src/controllers/rest-api/full-node/mining/router.js'
|
||||
import PriceRouter from '../../../src/controllers/rest-api/price/router.js'
|
||||
import RawTransactionsRouter from '../../../src/controllers/rest-api/full-node/rawtransactions/router.js'
|
||||
@@ -100,6 +101,9 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
getMutableCid: () => {},
|
||||
decodeOpReturn: () => {},
|
||||
getCIDData: () => {}
|
||||
},
|
||||
encryption: {
|
||||
getPublicKey: () => {}
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -129,6 +133,7 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
const blockchainAttachStub = sandbox.stub(BlockchainRouter.prototype, 'attach')
|
||||
const controlAttachStub = sandbox.stub(ControlRouter.prototype, 'attach')
|
||||
const dsproofAttachStub = sandbox.stub(DSProofRouter.prototype, 'attach')
|
||||
const encryptionAttachStub = sandbox.stub(EncryptionRouter.prototype, 'attach')
|
||||
const fulcrumAttachStub = sandbox.stub(FulcrumRouter.prototype, 'attach')
|
||||
const miningAttachStub = sandbox.stub(MiningRouter.prototype, 'attach')
|
||||
const priceAttachStub = sandbox.stub(PriceRouter.prototype, 'attach')
|
||||
@@ -148,6 +153,8 @@ describe('#controllers/rest-api/index.js', () => {
|
||||
assert.equal(controlAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(dsproofAttachStub.calledOnce)
|
||||
assert.equal(dsproofAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(encryptionAttachStub.calledOnce)
|
||||
assert.equal(encryptionAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(fulcrumAttachStub.calledOnce)
|
||||
assert.equal(fulcrumAttachStub.getCall(0).args[0], app)
|
||||
assert.isTrue(miningAttachStub.calledOnce)
|
||||
|
||||
@@ -0,0 +1,247 @@
|
||||
/*
|
||||
Unit tests for EncryptionUseCases.
|
||||
*/
|
||||
|
||||
import { assert } from 'chai'
|
||||
import sinon from 'sinon'
|
||||
|
||||
import EncryptionUseCases from '../../../src/use-cases/encryption-use-cases.js'
|
||||
|
||||
describe('#encryption-use-cases.js', () => {
|
||||
let sandbox
|
||||
let mockAdapters
|
||||
let mockUseCases
|
||||
let mockBchjs
|
||||
let uut
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.createSandbox()
|
||||
mockAdapters = {}
|
||||
|
||||
// Mock bchjs
|
||||
mockBchjs = {
|
||||
Address: {
|
||||
toCashAddress: sandbox.stub().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||
},
|
||||
ECPair: {
|
||||
fromPublicKey: sandbox.stub().returns({}),
|
||||
toCashAddress: sandbox.stub().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||
}
|
||||
}
|
||||
|
||||
// Mock use cases
|
||||
mockUseCases = {
|
||||
fulcrum: {
|
||||
getTransactions: sandbox.stub().resolves({
|
||||
transactions: [
|
||||
{ tx_hash: 'abc123def456' }
|
||||
]
|
||||
})
|
||||
},
|
||||
rawtransactions: {
|
||||
getRawTransaction: sandbox.stub().resolves({
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'signature 02abc123def456789'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
uut = new EncryptionUseCases({
|
||||
adapters: mockAdapters,
|
||||
useCases: mockUseCases,
|
||||
bchjs: mockBchjs
|
||||
})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
sandbox.restore()
|
||||
})
|
||||
|
||||
describe('#constructor()', () => {
|
||||
it('should require adapters', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new EncryptionUseCases({ useCases: mockUseCases })
|
||||
}, /Adapters instance required/)
|
||||
})
|
||||
|
||||
it('should require useCases', () => {
|
||||
assert.throws(() => {
|
||||
// eslint-disable-next-line no-new
|
||||
new EncryptionUseCases({ adapters: mockAdapters })
|
||||
}, /UseCases instance required/)
|
||||
})
|
||||
})
|
||||
|
||||
describe('#getPublicKey()', () => {
|
||||
it('should return public key when found', async () => {
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isTrue(result.success)
|
||||
assert.equal(result.publicKey, '02abc123def456789')
|
||||
assert.isTrue(mockBchjs.Address.toCashAddress.calledOnce)
|
||||
assert.isTrue(mockUseCases.fulcrum.getTransactions.calledOnce)
|
||||
assert.isTrue(mockUseCases.rawtransactions.getRawTransaction.calledOnce)
|
||||
})
|
||||
|
||||
it('should return not found when public key does not match', async () => {
|
||||
// Make the ECPair.toCashAddress return a different address
|
||||
mockBchjs.ECPair.toCashAddress.returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isFalse(result.success)
|
||||
assert.equal(result.publicKey, 'not found')
|
||||
})
|
||||
|
||||
it('should throw error when no transaction history', async () => {
|
||||
mockUseCases.fulcrum.getTransactions.resolves({
|
||||
transactions: []
|
||||
})
|
||||
|
||||
try {
|
||||
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
assert.fail('Should have thrown an error')
|
||||
} catch (err) {
|
||||
assert.equal(err.message, 'No transaction history.')
|
||||
}
|
||||
})
|
||||
|
||||
it('should handle transactions without scriptSig', async () => {
|
||||
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||
vin: [
|
||||
{ txid: 'coinbase' } // No scriptSig
|
||||
]
|
||||
})
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isFalse(result.success)
|
||||
assert.equal(result.publicKey, 'not found')
|
||||
})
|
||||
|
||||
it('should handle invalid public key hex gracefully', async () => {
|
||||
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'signature NOT_VALID_HEX'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isFalse(result.success)
|
||||
assert.equal(result.publicKey, 'not found')
|
||||
})
|
||||
|
||||
it('should handle ECPair.fromPublicKey throwing error', async () => {
|
||||
mockBchjs.ECPair.fromPublicKey.throws(new Error('Invalid public key'))
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isFalse(result.success)
|
||||
assert.equal(result.publicKey, 'not found')
|
||||
})
|
||||
|
||||
it('should search through multiple transactions', async () => {
|
||||
// First transaction has no matching public key
|
||||
mockUseCases.fulcrum.getTransactions.resolves({
|
||||
transactions: [
|
||||
{ tx_hash: 'tx1' },
|
||||
{ tx_hash: 'tx2' }
|
||||
]
|
||||
})
|
||||
|
||||
// Return different data for each tx - first tx has input with non-matching key
|
||||
mockUseCases.rawtransactions.getRawTransaction
|
||||
.onFirstCall().resolves({
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'sig 02aaa111bbb222ccc'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
.onSecondCall().resolves({
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'sig 02abc123def456789'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
|
||||
// First tx doesn't match, second tx matches
|
||||
mockBchjs.ECPair.toCashAddress
|
||||
.onFirstCall().returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||
.onSecondCall().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isTrue(result.success)
|
||||
assert.equal(result.publicKey, '02abc123def456789')
|
||||
assert.equal(mockUseCases.rawtransactions.getRawTransaction.callCount, 2)
|
||||
})
|
||||
|
||||
it('should search through multiple inputs in a transaction', async () => {
|
||||
mockUseCases.rawtransactions.getRawTransaction.resolves({
|
||||
vin: [
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'sig 02aaa111bbb222ccc'
|
||||
}
|
||||
},
|
||||
{
|
||||
scriptSig: {
|
||||
asm: 'sig 02abc123def456789'
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
|
||||
// First input doesn't match, second input matches
|
||||
mockBchjs.ECPair.toCashAddress
|
||||
.onFirstCall().returns('bitcoincash:qqq000000000000000000000000000000000000000')
|
||||
.onSecondCall().returns('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf')
|
||||
|
||||
const result = await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
|
||||
assert.isTrue(result.success)
|
||||
assert.equal(result.publicKey, '02abc123def456789')
|
||||
})
|
||||
|
||||
it('should propagate fulcrum errors', async () => {
|
||||
const error = new Error('Fulcrum API error')
|
||||
mockUseCases.fulcrum.getTransactions.rejects(error)
|
||||
|
||||
try {
|
||||
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
assert.fail('Should have thrown an error')
|
||||
} catch (err) {
|
||||
assert.equal(err.message, 'Fulcrum API error')
|
||||
}
|
||||
})
|
||||
|
||||
it('should propagate rawtransactions errors', async () => {
|
||||
const error = new Error('RawTransactions API error')
|
||||
mockUseCases.rawtransactions.getRawTransaction.rejects(error)
|
||||
|
||||
try {
|
||||
await uut.getPublicKey({ address: 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf' })
|
||||
assert.fail('Should have thrown an error')
|
||||
} catch (err) {
|
||||
assert.equal(err.message, 'RawTransactions API error')
|
||||
}
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -24,7 +24,7 @@ describe('#fulcrum-use-cases.js', () => {
|
||||
}
|
||||
|
||||
// Create a mock BCHJS instance with stubbed sortAllTxs method
|
||||
const mockBchjs = new BCHJS()
|
||||
const mockBchjs = new BCHJS({ restURL: 'http://localhost:5942/v6/' })
|
||||
if (!mockBchjs.Electrumx) {
|
||||
mockBchjs.Electrumx = {}
|
||||
}
|
||||
|
||||
@@ -32,7 +32,7 @@ describe('#slp-use-cases.js', () => {
|
||||
}
|
||||
|
||||
// Create mock BCHJS
|
||||
mockBchjs = new BCHJS()
|
||||
mockBchjs = new BCHJS({ restURL: 'http://localhost:5942/v6/' })
|
||||
mockBchjs.Electrumx = {
|
||||
txData: sandbox.stub().resolves({
|
||||
details: {
|
||||
|
||||
Reference in New Issue
Block a user