1.6 KiB
1.6 KiB
BeVault: Architecture and Contribution Guide
Overview
- BeVault is a modular backbone enforcing and proving Best Execution across multiple equity venues.
- The current package includes a Graph-of-Contracts (GoC) registry, two starter adapters, a canonical IR bridge, a tamper-evident governance ledger, and deterministic delta-sync with signed deltas.
Tech Stack (Production-Ready)
- Language: Python 3.8+
- Core: lightweight dataclasses for LocalArbProblem, SharedSignals, HedgeDelta, AuditLog, PrivacyBudget
- Bridge: CanonicalIR and stable payload serialization for replay and signing
- Ledger: GovernanceLedger with hash chaining for auditability
- Replay: DeltaSyncEngine with version vectors and signed envelopes
- Registry: GoCRegistry and GraphOfContracts with versioned adapters
- Adapters: PriceFeedAdapter, BrokerAdapter (starter)
- Crypto: HMAC-SHA256 based delta signing (pluggable key material)
- Data Contracts: toy DSL seeds as Python dataclasses
- Tests: pytest-based unit tests
Project Structure
- idea172_bevault_verifiable_best/
- init.py
- bridge.py
- core.py
- ledger.py
- replay.py
- signing.py
- registry.py
- adapters/
- init.py
- price_feed.py
- broker.py
- tests/
- test_basic.py
- README.md
- AGENTS.md (this file)
- test.sh
- pyproject.toml
- READY_TO_PUBLISH (empty when ready)
How to contribute
- Start by preserving determinism: keep signing, replay, and ledger hashes stable for identical inputs.
- Expand the GoC registry with new contracts/adapters following the toy DSL seeds.
- Ensure tests cover core contracts, registry operations, and adapter conformance checks.