33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# BeVault: Verifiable Best-Execution Backbone
|
|
|
|
BeVault is a Python backbone for best-execution workflows across equity venues. It models local optimization problems, privacy-bounded market signals, signed hedge deltas, and tamper-evident governance logs in a small, testable package.
|
|
|
|
## What It Provides
|
|
|
|
- Canonical data contracts for `LocalArbProblem`, `SharedSignals`, `HedgeDelta`, `AuditLog`, and `PrivacyBudget`
|
|
- HMAC-SHA256 delta signing and verification
|
|
- A canonical IR bridge for replay and auditing
|
|
- A hash-chained governance ledger
|
|
- Deterministic delta-sync with version vectors
|
|
- A GoC registry plus starter price-feed and broker adapters
|
|
|
|
## Modules
|
|
|
|
- `core.py`: data contracts and toy DSL helpers
|
|
- `signing.py`: signing and verification
|
|
- `bridge.py`: canonical IR serialization
|
|
- `ledger.py`: append-only governance ledger
|
|
- `replay.py`: signed delta sync and replay
|
|
- `registry.py`: GoC registry and contract catalog
|
|
- `adapters/`: starter price-feed and broker adapters
|
|
|
|
## Verification
|
|
|
|
Run:
|
|
|
|
```bash
|
|
bash test.sh
|
|
```
|
|
|
|
This installs the package, runs pytest, and builds a source distribution and wheel with `python3 -m build`.
|