29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# AGENTS.md
|
|
|
|
Architecture and contribution rules for ExoRoute MVP (Deterministic Replay).
|
|
|
|
Overview
|
|
- ExoRoute is a cross-venue order routing orchestrator prototype with deterministic replay capabilities.
|
|
- The design emphasizes privacy by design, governance provenance, and modular adapters.
|
|
|
|
Tech Stack (current):
|
|
- Language: Python 3.9+ (production-ready scaffolding)
|
|
- Core concepts: LocalProblem, SharedVariables, PlanDelta, DualVariables, PrivacyBudget, AuditLog, GraphOfContractsRegistry
|
|
- Adapters: exoroute.adapters.* (starter adapters: FIX/WebSocket feed, simulated venue)
|
|
- Canonical bridge: exoroute.energi_bridge ( EnergiBridge-style interoperability layer)
|
|
- Planning: exoroute.planner (naive ADMM-lite placeholder for MVP)
|
|
- Delta storage: exoroute.delta_store (filesystem-based log of deltas)
|
|
- API: exoroute.api (FastAPI endpoints) and exoroute.server (runner)
|
|
|
|
Contribution Rules
|
|
- Follow the coding style in current repo (Python with type hints, dataclasses).
|
|
- Add unit tests where feasible; ensure test.sh passes.
|
|
- Update AGENTS.md if architecture or testing requirements change.
|
|
|
|
Testing and Local Run
|
|
- To run API locally: python -m exoroute.server # via entrypoint or uvicorn
|
|
- Use test.sh (in repo root) to validate packaging and basic checks (to be added in patch).
|
|
|
|
Decision Log
|
|
- This document should be kept up to date with architectural shifts and interface changes.
|