These are current specs, plans, and reference material.
| Document | Description |
|---|---|
| PLAN.md | Authoritative implementation plan for all phases |
| DESIGN.md | Target protocol design (post-PLAN end state) |
| CURRENT_RUNTIME_DIAGRAM.md | Engineer-facing runtime diagrams (node, sync session, ingest/projection flow) |
| ../TODO.md | Current discrepancy/remediation backlog and execution ordering |
| PERF.md | Benchmark results and testing guide |
| CONTRIBUTING.md | Local developer setup (git hooks, formatting gate) |
| tla/projector_spec.md | Runtime-to-model mapping for projector semantics |
| planning/DISCREPANCY-MATRIX.md | Current design/plan/code discrepancy matrix |
| planning/IDENTITY_TRANSPORT_BOUNDARY_EXECUTION_PLAN.md | Active boundary plan for identity workflow vs transport materialization |
| planning/EVENT_PIPELINE_PHASE_BOUNDARY_EXECUTION_PLAN.md | Active plan for explicit ingest phase boundaries and command-driven post-commit effects |
| planning/COORDINATED_DOWNLOAD_ONLY_EXECUTION_PLAN.md | Active plan to remove all non-coordinated initiator download paths |
These are the current source module names. Active docs should use these names exclusively.
| Module | Path | Description |
|---|---|---|
peering |
src/peering/ |
Transport runtime, peer lifecycle, accept/connect loops, NAT traversal, mDNS discovery |
sync |
src/sync/ |
Negentropy reconciliation, sync session handler |
protocol |
src/protocol/ |
Wire frame encoding/decoding (wire.rs) |
event_modules |
src/event_modules/ |
Per-event-type wire format, projectors, commands, queries |
event_pipeline |
src/event_pipeline.rs |
Ingest runtime (batch_writer), projection queue draining, SQLite adapters |
projection/apply |
src/projection/apply/ |
Projection pipeline: project_one, cascade, context, dispatch, stages |
projection |
src/projection/ |
Projection create, encrypted, signer, decision, emit helpers |
identity |
src/identity/ |
Transport identity, identity ops (bootstrap, invite, accept) |
transport |
src/transport/ |
Cert generation, mTLS, SQL trust policy reads, exact transport-target cert resolver |
db |
src/db/ |
Schema, migrations, queues, trust, removal watch |
| Old name | Current name |
|---|---|
src/network/ |
src/peering/ |
src/replication/ |
src/sync/ |
src/event_runtime/ |
src/event_pipeline.rs |
src/events/ |
src/event_modules/ |
src/sync/protocol.rs |
src/protocol.rs |
src/projection/pipeline.rs |
src/projection/apply/ |
src/projection/projectors.rs |
deleted; projectors live in src/event_modules/<type>/projector.rs |
src/projection/identity.rs |
deleted; identity projectors live in event modules |
src/sync/engine.rs |
split into src/peering/loops/ and src/peering/runtime/ |
src/identity_ops.rs |
src/identity/ops.rs |
src/transport_identity.rs |
src/identity/transport.rs |
src/discovery.rs |
src/peering/discovery.rs |
event_runtime_contract.rs |
event_pipeline_contract.rs |
network_contract.rs |
peering_contract.rs |
ReplicationStore |
SyncStore |
SqliteReplicationStore |
SqliteSyncStore |
ReplicationSessionHandler |
SyncConnectionHandler |
tests/replication_contract_tests/ |
tests/sync_contract_tests/ |
Archived docs (docs/archive/) may contain historically inaccurate module names and file paths. They are retained for context but should not be used as implementation source of truth. Only active documents (listed above) reflect the current source tree.
Historical feedback artifacts, completed execution plans, and superseded planning docs. Retained for context, not active guidance.
| Directory | Description |
|---|---|
planning/ |
Execution plans and discrepancy tracking for active workstreams |
tla/ |
TLA+ formal models and configs (EventGraphSchema, transport lifecycle, unified bridge planning) |
archive/ |
Historical plans, feedback docs, and superseded material |