idea144-crossvenuearbx-fede.../README.md

1.9 KiB

CrossVenueArbX (MVP)

CrossVenueArbX is a lightweight, privacy-aware framework for federated discovery and execution of cross-venue equity arbitrage signals.

  • Core IR: LocalArbProblem, SharedSignals, PlanDelta, DualVariables, AuditLog, PrivacyBudget.
  • Lightweight coordination: Async ADMM-lite with deterministic replay and bounded staleness.
  • Privacy by design: secure aggregation stubs, optional local DP budgets, cryptographic attestation of adapters.
  • Adapters and data feeds: starter price-feed adapters and a minimal broker adapter for execution.
  • Governance and provenance: tamper-evident audit logs and a Graph-of-Contracts registry.
  • MVP pipeline: Phase 0 skeleton with 2 starter adapters; Phase 1 governance ledger; Phase 2 cross-venue demo; Phase 3 production-like testing and SDK.

Getting Started

  • Run tests and build: bash test.sh.
  • Run the demo locally: python -m crossvenue_arbx.demo --iterations 3.
  • View coverage and governance artefacts in crossvenue_arbx/governance.py and crossvenue_arbx/core.py.
  • Interoperability: a lightweight EnergiBridge (crossvenue_arbx.bridge) translates CrossVenueArbX primitives into a canonical CatOpt-IR for integration with external ecosystems.

Architecture Summary

  • Local signal discovery per venue; aggregated signals managed by a central coordinator.
  • PlanDelta encodes actionable cross-venue arb legs.
  • Graph-of-Contracts provides versioning for adapters and data contracts.
  • CRDT-like delta merges enable deterministic replay after reconnects.

Usage and API surface

  • LocalArbProblem: per-asset, per-venue problem statement.
  • SharedSignals: cross-venue deltas, correlations, liquidity estimates.
  • PlanDelta: incremental arb actions with timestamps and signatures.
  • AuditLog/PrivacyBudget: governance and data-leakage controls.

Notes

  • This release aims for a production-ready architecture rather than a bare MVP. See AGENTS.md for contribution rules and testing commands.