edge-latency-aware-cross-ve.../AGENTS.md

1.7 KiB

ELAC-Plan Agents

Architecture and MVP changes

  • Added a FastAPI-based MVP API (elac_plan.api) exposing /problems, /status, and /deltas endpoints to drive the LocalProblem -> PlanDelta flow locally.
  • In-memory MVP storage for LocalProblem and PlanDelta with a toy LocalSolver and two starter adapters (NBBOFeedAdapter, BrokerGatewayAdapter).
  • Public Python package surface updated: elac_plan.api is importable via elac_plan.api.app (FastAPI app), and re-exported from elac_plan for convenience.
  • Tests: Added tests/test_api.py to validate problem creation and status endpoints using FastAPI TestClient.
  • Test runner: test.sh added to execute pytest and python -m build for packaging validation.
  • Documentation: README updated with MVP overview (next iteration to expand with Phase 1 governance, phase 2 cross-venue demos, etc.).

Architecture overview:

  • Primitives: LocalProblem, SharedVariables, DualVariables, PlanDelta, Governance/AuditLog
  • Adapters: NBBOFeedAdapter (data feed), BrokerGatewayAdapter (execution gateway)
  • Solver: LocalSolver (toy solver to generate PlanDelta from LocalProblem)
  • API: FastAPI app exposing /problems and /status
  • Audit: Governance/AuditLog stubs for future crypto-signed logging

Tech stack:

  • Python 3.8+
  • FastAPI + Uvicorn for REST API
  • Pydantic for data modeling
  • Lightweight, in-process Fed-Coord topology (ADMM-lite) via PlanDelta and DualVariables placeholders

Tests & packaging:

  • Pytest for unit tests
  • Build via python -m build
  • Packaging metadata in pyproject.toml with package name edge_latency_aware_cross_venue_execution

How to contribute:

  • Implement real adapters, enhance solver, and hook up a real consensus/secure-aggregation layer
  • Add integration tests for end-to-end edge-to-edge flow