28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# GreeksHub: Federated Cross-Venue Greeks MVP
|
|
|
|
Architecture overview
|
|
- Local primitives: LocalHedgeProblem, SharedGreeks, DualVariables, PlanDelta, AuditLog, PrivacyBudget.
|
|
- Graph-of-Contracts (GoC): lightweight in-process registry to version adapters and data contracts.
|
|
- Adapters: two starter adapters (price/vol feed, broker/execution) with TLS transport concept.
|
|
- ADMM-lite coordinator: edge-friendly coordinator that aggregates locally computed signals with secure summaries.
|
|
- Deterministic replay: plan deltas and signals are replayable for backtests and audits.
|
|
- Governance ledger: signed events, lightweight DID-based identity, policy checks.
|
|
|
|
Scope and testing
|
|
- Language: Python (production-ready, strong typing, tests).
|
|
- Testing: pytest with a small test suite; test.sh orchestrates tests and packaging sanity checks.
|
|
|
|
Development workflow
|
|
- Add small, composable components first; extend registry and adapters later.
|
|
- Run tests locally; ensure packaging metadata compiles (python build) as part of test.sh.
|
|
|
|
Contribution rules
|
|
- Follow minimal, well-documented changes; preserve existing contracts.
|
|
- Write tests for any new public API surface.
|
|
|
|
Checklist for publishing (to be checked by the final phase):
|
|
- README.md with marketing and usage detail.
|
|
- AGENTS.md present.
|
|
- test.sh runs pytest and python -m build for packaging sanity.
|
|
- READY_TO_PUBLISH present (empty file to signal completion).
|