psf-bch-api 1.3.0 → 7.2.0

package/.env-local

@@ -1,13 +1,34 @@
+# 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
+
+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
+

package/bin/server.js

@@ -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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "psf-bch-api",
-  "version": "1.3.0",
-  "main": "index.js",
+  "version": "7.2.0",
+  "main": "psf-bch-api.js",
   "type": "module",
   "scripts": {
     "start": "node bin/server.js",
@@ -15,12 +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",
+    "minimal-slp-wallet": "7.0.1",
+    "psffpp": "1.2.0",
     "slp-token-media": "1.2.10",
     "winston": "3.11.0",
     "winston-daily-rotate-file": "4.7.1",

package/production/docker/.env-local

@@ -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
+

package/production/docker/Dockerfile

@@ -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
-
-# 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
+COPY .env-local .env
 
-# Expose the port the API will be served on.
-#EXPOSE 5011
 
-# Start the application.
-#COPY start-production.sh start-production.sh
-VOLUME start-rest2nostr.sh
-CMD ["./start-rest2nostr.sh"]
+CMD ["npm", "start"]
 
-#CMD ["npm", "start"]
+# Used to debug the container.
+#COPY temp.js temp.js
+#CMD ["node", "temp.js"]

package/production/docker/docker-compose.yml

@@ -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

package/production/docker/temp.js

@@ -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...')

package/src/config/env/common.js

@@ -34,13 +34,18 @@ 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,
+  port: parseInt(process.env.PORT, 10) || 5942,
 
   // Environment
   env: process.env.NODE_ENV || 'development',
@@ -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
 }

package/src/config/x402.js

@@ -41,3 +41,10 @@ export function getX402Settings () {
     priceSat: config.x402?.priceSat
   }
 }
+
+export function getBasicAuthSettings () {
+  return {
+    enabled: Boolean(config.basicAuth?.enabled),
+    token: config.basicAuth?.token || ''
+  }
+}

package/src/controllers/rest-api/encryption/controller.js

@@ -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

package/src/controllers/rest-api/encryption/router.js

@@ -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

package/src/controllers/rest-api/fulcrum/controller.js

@@ -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 = {}) {

package/src/controllers/rest-api/index.js

@@ -10,8 +10,10 @@
 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'
 import RawTransactionsRouter from './full-node/rawtransactions/router.js'
 import SlpRouter from './slp/router.js'
 import config from '../../config/index.js'
@@ -69,12 +71,18 @@ 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)
 
     const miningRouter = new MiningRouter(dependencies)
     miningRouter.attach(app)
 
+    const priceRouter = new PriceRouter(dependencies)
+    priceRouter.attach(app)
+
     const rawtransactionsRouter = new RawTransactionsRouter(dependencies)
     rawtransactionsRouter.attach(app)
 

package/src/controllers/rest-api/price/controller.js

@@ -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

package/src/controllers/rest-api/price/router.js

@@ -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