tradecipher-blockchain-back.../README.md

1.6 KiB

tradecipher-blockchain-backed-privacy-pr

A modular, open-source platform enabling end-to-end trade lifecycle auditing across venues (options, equities) with cryptographic provenance, zero-knowledge privacy, and offline-first capabilities. The system anchors attestations of orders, fills, and post-trade events to a tamper-evident ledger while keeping sensitive payloads off-chain.

This repository provides a minimal MVP implementation in Python to satisfy tests and demonstrate the core concepts (contracts, a tamper-evident ledger, and placeholder ZK proofs). See AGENTS.md for contribution guidance and the READY_TO_PUBLISH signal when ready to publish.

New in this iteration:

  • contract_registry.py: lightweight, in-memory registry for versioned data contracts (LocalTrade, SharedSignals, PlanDelta, etc.).
  • bridge.py: EnergiBridge skeleton to map between venue payloads and canonical TradeCipher objects.
  • adapters.py: two stub venue adapters (VenueAAdapter, VenueBAdapter) with bootstrap wiring.
  • README: updated to reflect enhanced interoperability and governance considerations.

How to run (local MVP)

  • Install Python 3.8+
  • Install build tooling: "python3 -m pip install build"
  • Run tests: ./test.sh
  • Build package: python3 -m build

Project layout

  • tradecipher_blockchain_backed_privacy_pr/: Python package with contracts, ledger, zk_proofs, and adapters
  • tests/: pytest test suite for core MVP
  • pyproject.toml: packaging metadata for the MVP package tradecipher_blockchain_backed_privacy_pr
  • AGENTS.md: architecture and contribution guidelines
  • test.sh: test runner that executes tests and packaging build
  • README.md: this file