psf-bch-api 1.1.0 → 1.3.0

package/.env-local

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

package/README.md

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

package/bin/server.js

@@ -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}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "psf-bch-api",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "main": "index.js",
   "type": "module",
   "scripts": {
@@ -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",

package/src/adapters/fulcrum-api.js

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

package/src/adapters/full-node-rpc.js

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

package/src/adapters/index.js

@@ -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 () {

package/src/adapters/slp-indexer-api.js

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

package/src/config/env/common.js

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

package/src/config/x402.js

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

package/src/controllers/index.js

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