mercurymesh-privacy-preserv.../AGENTS.md

26 lines
1.1 KiB
Markdown

MercuryMesh MVP Architecture
- Goal: Privacy-preserving market-data federation for cross-exchange analytics.
- Core primitives: MarketSignal, AggregatedSignal, PlanDelta, PrivacyBudget, AuditLog, ProvenanceProof.
- Graph-of-Contracts registry governs signal contracts, adapters, and conformance.
- Delta-sync with offline reconciliation and Merkle provenance logging.
- Lightweight TLS-based transport; plugin adapters for venue feeds.
- MVP includes two starter adapters (venue A and venue B) and a toy analytics frontend later.
Tech Stack (in this repo)
- Language: Python 3.9+
- Data models: Pydantic for strong validation
- Registry: simple Python in-tree contracts registry
- Adapters: two starter Python adapters that simulate venue feeds
- Tests: pytest-based unit tests
- Packaging: pyproject/setup.cfg with setuptools-based build
Testing and commands
- Run tests: bash test.sh
- Build package: python3 -m build
- Linting: optional (not included in MVP)
Contribution rules
- Keep interfaces stable; add adapters without touching core contracts unnecessarily.
- Add tests for new features; ensure existing tests stay green.
- Do not commit secrets or credentials.