.env-example

# 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

# Public base URL for apiDoc HTML (optional; used by Docker entrypoint before `npm run docs`).
#APIDOC_URL=https://api.example.com


# START ACCESS CONTROL

PORT=5942

# x402 payments required to access this API?
X402_ENABLED=true
# Also gates discovery endpoints:
# /.well-known/x402, /openapi.json, /swagger.json, /llms.txt, /.well-known/agent.json
SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d
FACILITATOR_URL=http://localhost:4345/facilitator
X402_PRICE_SAT=200

# Basic Authentication required to access this API?
USE_BASIC_AUTH=true
BASIC_AUTH_TOKEN=some-random-token

# END ACCESS CONTROL

# PSF token liquidity price proxy (GET /v6/price/psf). Off by default.
#PSF_LIQUIDITY_PROXY_ENABLED=true
#PSF_LIQUIDITY_URL=http://192.168.0.126:5000
feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00			`# START INFRASTRUCTURE SETUP`

feat(blockchain): Adding blockchain full-node endpoints 2025-11-09 19:18:39 -08:00			`# Full Node Connection`
			`RPC_BASEURL=http://172.17.0.1:8332`
			`RPC_USERNAME=bitcoin`
			`RPC_PASSWORD=password`
Renaming fulcrum libraries 2025-11-15 07:03:13 -08:00
			`# Fulcrum Indexer`
fix(basic auth): Rejecting API calls that do not include basic auth header 2025-11-25 08:27:35 -08:00			`FULCRUM_API=http://172.17.0.1:3001/v1`
feat(slp): Ported SLP endpoints from bch-api 2025-11-15 17:03:02 -08:00
			`# SLP Indexer`
fix(basic auth): Rejecting API calls that do not include basic auth header 2025-11-25 08:27:35 -08:00			`SLP_INDEXER_API=http://localhost:5010`
feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00
fix(.env): Updating .env-local example 2025-11-23 10:16:21 -08:00			`# REST API URL for wallet operations`
fix(basic auth): Rejecting API calls that do not include basic auth header 2025-11-25 08:27:35 -08:00			`LOCAL_RESTURL=http://localhost:5942/v6`
fix(.env): Updating .env-local example 2025-11-23 10:16:21 -08:00
feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00			`# END INFRASTRUCTURE SETUP`

fix(Docker): Can change URL in api docs 2026-04-01 08:57:10 -07:00			# Public base URL for apiDoc HTML (optional; used by Docker entrypoint before `npm run docs`).
			`#APIDOC_URL=https://api.example.com`

feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00
			`# START ACCESS CONTROL`

fix(port): Adding port config to .env-local file 2025-11-28 06:00:02 -08:00			`PORT=5942`

feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00			`# x402 payments required to access this API?`
fix(x402): Setting default server address to PSF burn addr 2025-11-25 08:57:23 -08:00			`X402_ENABLED=true`
fix(x402 docs): Adding common LLM discovery documentation 2026-04-01 08:36:47 -07:00			`# Also gates discovery endpoints:`
			`# /.well-known/x402, /openapi.json, /swagger.json, /llms.txt, /.well-known/agent.json`
fix(x402): Setting default server address to PSF burn addr 2025-11-25 08:57:23 -08:00			`SERVER_BCH_ADDRESS=bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d`
			`FACILITATOR_URL=http://localhost:4345/facilitator`
Changing default cost to 200 sats per call 2025-12-21 11:22:44 -07:00			`X402_PRICE_SAT=200`
feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00
			`# Basic Authentication required to access this API?`
fix(basic auth): Rejecting API calls that do not include basic auth header 2025-11-25 08:27:35 -08:00			`USE_BASIC_AUTH=true`
			`BASIC_AUTH_TOKEN=some-random-token`

			`# END ACCESS CONTROL`
feat(basic auth): Allowing basic authentication for API access 2025-11-23 09:58:08 -08:00
feat(PSF Liquidity): Off by default, new endpoint reports PSF token price in BCH 2026-03-28 19:23:10 -07:00			`# PSF token liquidity price proxy (GET /v6/price/psf). Off by default.`
			`#PSF_LIQUIDITY_PROXY_ENABLED=true`
			`#PSF_LIQUIDITY_URL=http://192.168.0.126:5000`