exoroute-cross-venue-order-.../README.md

35 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ExoRoute: Cross-Venue Order Routing Orchestrator (EnergiBridge skeleton)
This repository provides a production-ready skeleton for ExoRoute, a cross-venue order routing and hedging orchestrator with deterministic replay semantics and privacy-preserving data handling.
- Core primitives (LocalProblem, SharedVariables, PlanDelta, DualVariables, PrivacyBudget, AuditLog, GraphOfContractsRegistry)
- Minimal EnergiBridge mapping layer to a canonical Graph-of-Contracts IR
- Packaging scaffolding for a robust build and distribution (pyproject.toml)
Enhanced Overview
- Deterministic offline replay: store and replay deltas with provenance for auditability.
- Privacy-first signals: per-signal budgets and secure aggregation; raw data stays local.
- Lite Graph-of-Contracts registry to map adapters to data contracts and engines.
- End-to-end MVP: 2 starter adapters (FIX/WebSocket price feed and simulated venue) over TLS.
- EnergiBridge-like interoperability layer to enable cross-domain reuse and conformance testing.
MVP Plan (812 weeks)
- Phase 0: Protocol skeleton + 2 starter adapters over TLS; lightweight ADMM-lite local solver; end-to-end delta-sync with deterministic replay.
- Phase 1: Governance ledger and identity management; secure aggregation defaults for SharedVariables.
- Phase 2: Cross-venue demo with a toy two-asset setup; EnergiBridge SDK integration and toy adapters.
- Phase 3: SDKs, conformance tests, and lightweight audit dashboards.
Usage
- Run tests: ./test.sh
- Build package: python -m build
- Import and exercise core primitives:
- from exoroute import LocalProblem, SharedVariables, PlanDelta, DualVariables
Roadmap alignment
- Phase 0: protocol skeleton + 2 adapters (FIX/WebSocket price-feed, simulated venue) over TLS
- Phase 1: governance ledger and identity management
- Phase 2: cross-venue demo with toy two-asset setup
- Phase 3: SDKs, conformance tests, and audit dashboards
This repo adheres to the ExoRoute architecture described in AGENTS.md at the repository root.