NeuroWealth Backend

Express + TypeScript REST API for the NeuroWealth platform — AI-assisted portfolio management backed by Stellar smart contracts.

Documentation

• API Documentation: docs/openapi.yaml - Full OpenAPI 3.1 specification
• SLO Guidance: docs/SLO_GUIDANCE.md - Latency budgets and performance targets
• Observability: docs/OBSERVABILITY.md - Monitoring and alerting guidance
• Runbook: docs/RUNBOOK.md - Production operations and incident response
• Troubleshooting: docs/TROUBLESHOOTING.md - Local development troubleshooting guide

API Documentation

The full OpenAPI 3.1 specification lives at docs/openapi.yaml.

It covers:

Tag	Base path	Auth
health	/health	None
auth	/api/auth	None (issues JWT)
portfolio	/api/portfolio	Bearer JWT
transactions	/api/transactions	Bearer JWT
deposit	/api/deposit	Bearer JWT
withdraw	/api/withdraw	Bearer JWT
vault	/api/vault	Bearer JWT
admin	/api/admin	X-Admin-Token header

Viewing the docs locally

npx @redocly/cli preview-docs docs/openapi.yaml

Updating the spec

When you add or change a route, update docs/openapi.yaml in the same PR. The api-contract CI job will lint the spec and run smoke tests automatically.

Breaking-change policy

This API follows semantic versioning. Breaking changes (removed fields, changed response shapes, new required parameters) increment the major version and are announced at least two weeks before release.

Development

cp .env.example .env
npm install
npm run dev

Troubleshooting: If you encounter issues during setup, see the Troubleshooting Guide for common problems and solutions.

Running tests

npm test

Smoke test

Run a health-check smoke test against a running server:

npm run smoke

smoke:health is also available as a named alias for the startup health check. Both run the same script.