mirror of
https://github.com/Permissionless-Software-Foundation/psf-bch-api-base.git
synced 2026-09-21 16:52:00 -07:00
fixing merge conflicts
This commit is contained in:
@@ -138,7 +138,21 @@ Protected endpoints return `402 Payment Required` when no valid payment is attac
|
||||
|
||||
### 4) x402 + Bearer Bypass
|
||||
|
||||
```bash
|
||||
When `X402_ENABLED=true`, the server also exposes machine-discovery endpoints:
|
||||
|
||||
- `/.well-known/x402` - x402-bch v2 payment discovery manifest
|
||||
- `/openapi.json` - OpenAPI 3 projection generated from apiDoc annotations
|
||||
- `/swagger.json` - Swagger 2.0 compatibility projection
|
||||
- `/llms.txt` - LLM-oriented markdown index of service metadata
|
||||
- `/.well-known/agent.json` - draft agent manifest describing API actions
|
||||
|
||||
When `X402_ENABLED=false`, these discovery endpoints return `404`.
|
||||
|
||||
#### Combined: x402 + Bearer Token
|
||||
|
||||
You can enable both at the same time:
|
||||
|
||||
```
|
||||
X402_ENABLED=true
|
||||
USE_BASIC_AUTH=true
|
||||
BASIC_AUTH_TOKEN=my-secret-token
|
||||
@@ -182,6 +196,126 @@ npm test
|
||||
npm run test:integration
|
||||
npm run docs
|
||||
```
|
||||
X402_ENABLED=false
|
||||
USE_BASIC_AUTH=false
|
||||
```
|
||||
|
||||
5. Start the server:
|
||||
|
||||
`npm start`
|
||||
|
||||
The server will start on port `5942` by default (or whatever you set in `PORT`). API documentation is available at `http://localhost:5942/`.
|
||||
|
||||
### Generating API Docs
|
||||
|
||||
The API reference documentation is generated by [apiDoc](https://apidocjs.com/) from inline annotations in the source code. To regenerate:
|
||||
|
||||
`npm run docs`
|
||||
|
||||
The output is written to the `docs/` directory and served by the running server at its root URL.
|
||||
|
||||
To regenerate API docs plus discovery artifacts (`openapi.json`, `swagger.json`, `llms.txt`, and `agent.json` payload source):
|
||||
|
||||
`npm run docs:all`
|
||||
|
||||
This runs apiDoc first, then generates `docs/discovery-artifacts.json` from the same annotation source.
|
||||
|
||||
A live version can be found at [bch.fullstack.cash](https://bch.fullstack.cash/).
|
||||
|
||||
## Production (Docker)
|
||||
|
||||
A Docker setup is provided in the `production/docker/` directory for production deployments. The target OS is Ubuntu Linux.
|
||||
|
||||
1. Install [Docker and Docker Compose](https://docs.docker.com/engine/install/ubuntu/).
|
||||
|
||||
2. Navigate to the Docker directory:
|
||||
|
||||
`cd production/docker`
|
||||
|
||||
3. Create and configure the `.env` file. An example is provided:
|
||||
|
||||
`cp .env-example .env`
|
||||
|
||||
Edit `.env` to match your production infrastructure. Note that inside a Docker container, `localhost` refers to the container itself. Use `172.17.0.1` (the default Docker bridge gateway) to reach services running on the host machine:
|
||||
|
||||
```
|
||||
RPC_BASEURL=http://172.17.0.1:8332
|
||||
FULCRUM_API=http://172.17.0.1:3001/v1
|
||||
SLP_INDEXER_API=http://172.17.0.1:5010
|
||||
```
|
||||
|
||||
Set `APIDOC_URL` to the public base URL for your deployment (for example `https://api.example.com` or your subdomain). The container entrypoint applies this value to `apidoc.json` and the `apidoc` section of `package.json`, then runs `npm run docs` before starting the server so generated HTML matches each instance. The compose file mounts `./.env` to `/home/safeuser/psf-bch-api/.env` so it matches `dotenv.config()` in the app.
|
||||
|
||||
4. Build the Docker image:
|
||||
|
||||
`docker-compose build --no-cache`
|
||||
|
||||
5. Start the container:
|
||||
|
||||
`docker-compose up -d`
|
||||
|
||||
The container maps host port `5942` to container port `5942`. The `.env` file is mounted into the container as a volume, so you can update configuration without rebuilding.
|
||||
|
||||
To view logs:
|
||||
|
||||
`docker logs -f psf-bch-api`
|
||||
|
||||
To stop the container:
|
||||
|
||||
`docker-compose down`
|
||||
|
||||
A helper script `cleanup-images.sh` is provided to remove dangling Docker images after rebuilds.
|
||||
|
||||
## Testing
|
||||
|
||||
The project includes both unit tests and integration tests. Tests use [Mocha](https://mochajs.org/) as the test runner, [Chai](https://www.chaijs.com/) for assertions, and [Sinon](https://sinonjs.org/) for mocking. Code coverage is provided by [c8](https://github.com/bcoe/c8).
|
||||
|
||||
### Unit Tests
|
||||
|
||||
Unit tests are located in `test/unit/` and cover adapters, controllers, and use cases. They do not require any running infrastructure. To run:
|
||||
|
||||
`npm test`
|
||||
|
||||
This will first lint the code with [Standard](https://standardjs.com/), then execute all unit tests with code coverage.
|
||||
|
||||
To generate an HTML coverage report:
|
||||
|
||||
`npm run coverage`
|
||||
|
||||
The report is written to the `coverage/` directory.
|
||||
|
||||
### Integration Tests
|
||||
|
||||
Integration tests are located in `test/integration/` and require the back end infrastructure (full node, Fulcrum, SLP indexer) to be running. To run:
|
||||
|
||||
`npm run test:integration`
|
||||
|
||||
Integration tests have a 25-second timeout per test to accommodate network calls.
|
||||
|
||||
## Configuration Reference
|
||||
|
||||
All configuration values are read from environment variables (via the `.env` file). The complete list:
|
||||
|
||||
- `PORT` - Server listen port. Default: `5942`
|
||||
- `NODE_ENV` - Environment (`development` or `production`). Default: `development`
|
||||
- `API_PREFIX` - URL prefix for all REST endpoints. Default: `/v6`
|
||||
- `LOG_LEVEL` - Winston logging level. Default: `info`
|
||||
- `RPC_BASEURL` - Full node JSON-RPC URL. Default: `http://127.0.0.1:8332`
|
||||
- `RPC_USERNAME` - Full node RPC username.
|
||||
- `RPC_PASSWORD` - Full node RPC password.
|
||||
- `RPC_TIMEOUT_MS` - Full node RPC request timeout in ms. Default: `15000`
|
||||
- `FULCRUM_API` - Fulcrum indexer REST API URL.
|
||||
- `FULCRUM_TIMEOUT_MS` - Fulcrum API request timeout in ms. Default: `15000`
|
||||
- `SLP_INDEXER_API` - SLP Token Indexer REST API URL.
|
||||
- `SLP_INDEXER_TIMEOUT_MS` - SLP Indexer API request timeout in ms. Default: `15000`
|
||||
- `LOCAL_RESTURL` - Internal REST URL for wallet operations. Default: `http://127.0.0.1:5942/v6/`
|
||||
- `IPFS_GATEWAY` - IPFS gateway hostname. Default: `p2wdb-gateway-678.fullstack.cash`
|
||||
- `X402_ENABLED` - Enable x402-bch payment middleware. Default: `true`
|
||||
- `SERVER_BCH_ADDRESS` - BCH address for x402 payments. Default: `bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr`
|
||||
- `FACILITATOR_URL` - x402-bch facilitator service URL. Default: `http://localhost:4345/facilitator`
|
||||
- `X402_PRICE_SAT` - Satoshis charged per API call via x402. Default: `200`
|
||||
- `USE_BASIC_AUTH` - Enable Bearer token authentication. Default: `false`
|
||||
- `BASIC_AUTH_TOKEN` - Expected Bearer token value.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user