9db720add8
Some checks failed
Documentation Validation / validate-docs (push) Has been cancelled
Python Tests / test-python (push) Has been cancelled
API Endpoint Tests / test-api-endpoints (push) Has been cancelled
CLI Tests / test-cli (push) Has been cancelled
Integration Tests / test-service-integration (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-agent-sdk path:packages/py/aitbc-agent-sdk]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-core path:packages/py/aitbc-core]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-crypto path:packages/py/aitbc-crypto]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-sdk path:packages/py/aitbc-sdk]) (push) Has been cancelled
Package Tests / test-javascript-packages (map[name:aitbc-sdk-js path:packages/js/aitbc-sdk]) (push) Has been cancelled
Package Tests / test-javascript-packages (map[name:aitbc-token path:packages/solidity/aitbc-token]) (push) Has been cancelled
Security Scanning / security-scan (push) Has been cancelled
Systemd Sync / sync-systemd (push) Has been cancelled
- Add Code Quality Module section with pre-commit hooks and quality checks - Add Type Checking CI/CD Module section with MyPy workflow and coverage - Update README with code quality achievements and project structure - Migrate FastAPI apps from deprecated on_event to lifespan context manager - Update pyproject.toml files to reference consolidated dependencies - Remove unused app.py import in coordinator-api - Add type hints to agent
Coordinator API
Purpose & Scope
FastAPI service that accepts client compute jobs, matches miners, and tracks job lifecycle for the AITBC network.
Marketplace Extensions
Stage 2 introduces public marketplace endpoints exposed under /v1/marketplace:
GET /v1/marketplace/offers– list available provider offers (filterable by status).GET /v1/marketplace/stats– aggregated supply/demand metrics surfaced in the marketplace web dashboard.POST /v1/marketplace/bids– accept bid submissions for matching (mock-friendly; returns202 Accepted).
These endpoints serve the apps/marketplace-web/ dashboard via VITE_MARKETPLACE_DATA_MODE=live.
Explorer Endpoints
The coordinator now exposes read-only explorer data under /v1/explorer for apps/explorer-web/ live mode:
GET /v1/explorer/blocks– block summaries derived from recent job activity.GET /v1/explorer/transactions– transaction-like records for coordinator jobs.GET /v1/explorer/addresses– aggregated address activity and balances.GET /v1/explorer/receipts– latest job receipts (filterable byjob_id).
Set VITE_DATA_MODE=live and VITE_COORDINATOR_API in the explorer web app to consume these APIs.
Development Setup
- Create a virtual environment in
apps/coordinator-api/.venv. - Install dependencies listed in
pyproject.tomlonce added. - Run the FastAPI app via
uvicorn app.main:app --reload.
Configuration
Expects environment variables defined in .env (see docs/bootstrap/coordinator_api.md).
Signed receipts (optional)
- Generate an Ed25519 key:
python - <<'PY' from nacl.signing import SigningKey sk = SigningKey.generate() print(sk.encode().hex()) PY - Set
RECEIPT_SIGNING_KEY_HEXin the.envfile to the printed hex string to enable signed receipts returned by/v1/miners/{job_id}/resultand retrievable via/v1/jobs/{job_id}/receipt. - Receipt history is available at
/v1/jobs/{job_id}/receipts(requires client API key) and returns all stored signed payloads. - To enable coordinator attestations, set
RECEIPT_ATTESTATION_KEY_HEXto a separate Ed25519 private key; responses include anattestationsarray alongside the miner signature. - Clients can verify
signatureobjects using theaitbc_cryptopackage (seeprotocols/receipts/spec.md).
Systemd
Service name: aitbc-coordinator-api (to be defined under configs/systemd/).