Skip to content

README.md

Latest commit

 

History

History
76 lines (60 loc) · 3.76 KB

README.md

File metadata and controls

76 lines (60 loc) · 3.76 KB

Documentation Index

Overview

The Entanglement Transfer Protocol documentation is organized into six categories.

Category Document Description
Getting Started Contributing Development setup, code style, PR workflow
Changelog Version history v1.0.0 through v5.0.0
Security Policy Vulnerability reporting and contract security scope
Specification Whitepaper Full protocol design — three-phase COMMIT/LATTICE/MATERIALIZE
Technical Report 13-section architecture, deployment, and governance report
Architecture Architecture System components, data flow, security layers
Commitment Network Options Custom L1 vs Ethereum L1/L2 analysis
Streaming Protocol Chunked streaming, bandwidth amortization, backpressure
Enforcement Mechanisms PDP proofs, programmable slashing, progressive decentralization
Cross-Deployment Federation Network discovery, trust levels, cross-network materialization
ZK Transfer Mode Hiding commitments, Groth16 proofs, post-quantum upgrade path
Operations Production Plan PoC to production roadmap — 7 phases, 14 weeks
Deployment Guide Docker, Kubernetes, CI/CD, key management, monitoring
Bridge MVP L1-L2 cross-chain bridge scope and components
Security Security Review Formal security review (2026-02-24)
Shard Exposure Analysis Attack chain analysis and Option A-D comparison
Reviews Review #1 Formal whitepaper review
Review #2 Formal whitepaper review
Review #3 Formal whitepaper review
Eastern Research Landscape Asian blockchain research landscape for ETP expansion

Document Relationships

flowchart TD
    WP[Whitepaper] --> ARCH[Architecture]
    WP --> PP[Production Plan]
    WP --> ZK[ZK Transfer Mode]
    WP --> FED[Federation]
    WP --> ENF[Enforcement]
    WP --> STR[Streaming]

    ARCH --> CNO[Commitment Network Options]
    ARCH --> SEC[Security Review]
    ARCH --> SHARD[Shard Exposure Analysis]

    PP --> DG[Deployment Guide]
    PP --> BRIDGE[Bridge MVP]

    CNO --> DG

    SEC --> SHARD

    REPORT[Technical Report] --> ARCH
    REPORT --> PP

    CONTRIB[Contributing] -.-> ARCH
    CONTRIB -.-> WP

    SECURITY[Security Policy] -.-> SEC
    SECURITY -.-> SHARD

    R1[Review #1] -.-> WP
    R2[Review #2] -.-> WP
    R3[Review #3] -.-> WP
    R4[Eastern Research] -.-> WP
Loading

Quick Start

New to ETP? Read in this order:

  1. Contributing — Clone, install, run tests
  2. Whitepaper — Understand the core protocol
  3. Architecture — See how it's built
  4. Technical Report — Full system deep dive
  5. Security Review — Understand the threat model
  6. Production Plan — See the path to production