|
| 1 | +<!-- SPDX-License-Identifier: PMPL-1.0-or-later --> |
| 2 | +<!-- TOPOLOGY.md — Project architecture map and completion dashboard --> |
| 3 | +<!-- Last updated: 2026-02-19 --> |
| 4 | + |
| 5 | +# JanusKey — Project Topology |
| 6 | + |
| 7 | +## System Architecture |
| 8 | + |
| 9 | +``` |
| 10 | + ┌─────────────────────────────────────────┐ |
| 11 | + │ OPERATOR / CLI │ |
| 12 | + │ (jk delete, jk modify, jk undo) │ |
| 13 | + └───────────────────┬─────────────────────┘ |
| 14 | + │ |
| 15 | + ▼ |
| 16 | + ┌─────────────────────────────────────────┐ |
| 17 | + │ JANUSKEY CORE (RUST) │ |
| 18 | + │ (Operation Layer / Inverse Meta) │ |
| 19 | + └──────────┬───────────────────┬──────────┘ |
| 20 | + │ │ |
| 21 | + ▼ ▼ |
| 22 | + ┌───────────────────────┐ ┌────────────────────────────────┐ |
| 23 | + │ TRANSACTION MANAGER │ │ REVERSIBILITY ENGINE │ |
| 24 | + │ - begin / commit │ │ - Maximal Principle Reduction │ |
| 25 | + │ - rollback logic │ │ - Inverse Metadata Gen │ |
| 26 | + └──────────┬────────────┘ └──────────┬─────────────────────┘ |
| 27 | + │ │ |
| 28 | + └────────────┬─────────────┘ |
| 29 | + ▼ |
| 30 | + ┌─────────────────────────────────────────┐ |
| 31 | + │ DATA LAYER │ |
| 32 | + │ ┌───────────┐ ┌───────────────────┐ │ |
| 33 | + │ │ Metadata │ │ Content-Addressed │ │ |
| 34 | + │ │ Store │ │ Storage (SHA256) │ │ |
| 35 | + │ └───────────┘ └───────────────────┘ │ |
| 36 | + └───────────────────┬─────────────────────┘ |
| 37 | + │ |
| 38 | + ▼ |
| 39 | + ┌─────────────────────────────────────────┐ |
| 40 | + │ TARGET FILESYSTEM │ |
| 41 | + │ (Provably Reversible State) │ |
| 42 | + └─────────────────────────────────────────┘ |
| 43 | +
|
| 44 | + ┌─────────────────────────────────────────┐ |
| 45 | + │ REPO INFRASTRUCTURE │ |
| 46 | + │ Justfile / Cargo .machine_readable/ │ |
| 47 | + │ MAAF Integration 0-AI-MANIFEST.a2ml │ |
| 48 | + └─────────────────────────────────────────┘ |
| 49 | +``` |
| 50 | + |
| 51 | +## Completion Dashboard |
| 52 | + |
| 53 | +``` |
| 54 | +COMPONENT STATUS NOTES |
| 55 | +───────────────────────────────── ────────────────── ───────────────────────────────── |
| 56 | +CORE ENGINE (RUST) |
| 57 | + Operation Layer ██████████ 100% Delete/Modify/Move stable |
| 58 | + Inverse Metadata Gen ██████████ 100% Perfect inversion verified |
| 59 | + Transaction Manager ██████████ 100% Begin/Commit/Rollback active |
| 60 | + Content-Addressed Storage ██████████ 100% SHA256 deduplication verified |
| 61 | +
|
| 62 | +INTERFACES & RESEARCH |
| 63 | + CLI Interface (jk) ██████████ 100% Full command set verified |
| 64 | + MPR Methodology ██████████ 100% Security by construction proven |
| 65 | + Testing Report (SCM) ██████████ 100% Audit trail validated |
| 66 | +
|
| 67 | +REPO INFRASTRUCTURE |
| 68 | + Justfile Automation ██████████ 100% Standard build/lint tasks |
| 69 | + .machine_readable/ ██████████ 100% STATE tracking active |
| 70 | + 0-AI-MANIFEST.a2ml ██████████ 100% AI entry point verified |
| 71 | +
|
| 72 | +───────────────────────────────────────────────────────────────────────────── |
| 73 | +OVERALL: ██████████ 100% v1.0 Production Ready |
| 74 | +``` |
| 75 | + |
| 76 | +## Key Dependencies |
| 77 | + |
| 78 | +``` |
| 79 | +jk command ──────► Inverse Meta ──────► Transaction Mgr ──────► Commit |
| 80 | + │ │ │ │ |
| 81 | + ▼ ▼ ▼ ▼ |
| 82 | +Source File ─────► SHA256 Store ─────► Metadata Log ───────► Rollback |
| 83 | +``` |
| 84 | + |
| 85 | +## Update Protocol |
| 86 | + |
| 87 | +This file is maintained by both humans and AI agents. When updating: |
| 88 | + |
| 89 | +1. **After completing a component**: Change its bar and percentage |
| 90 | +2. **After adding a component**: Add a new row in the appropriate section |
| 91 | +3. **After architectural changes**: Update the ASCII diagram |
| 92 | +4. **Date**: Update the `Last updated` comment at the top of this file |
| 93 | + |
| 94 | +Progress bars use: `█` (filled) and `░` (empty), 10 characters wide. |
| 95 | +Percentages: 0%, 10%, 20%, ... 100% (in 10% increments). |
0 commit comments