|
1 | 1 | // SPDX-License-Identifier: PMPL-1.0-or-later |
| 2 | +// Copyright (c) 2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> |
2 | 3 | = MAA Framework — Show Me The Receipts |
3 | 4 | :toc: |
| 5 | +:toclevels: 3 |
4 | 6 | :icons: font |
| 7 | +:author: Jonathan D.A. Jewell |
5 | 8 |
|
6 | | -The README makes claims. This file backs them up. |
| 9 | +The README makes claims. This file backs them up with architectural context, |
| 10 | +code paths, and honest caveats sufficient for an external reviewer to |
| 11 | +understand what this monorepo coordinates and where the real implementation |
| 12 | +lives. |
| 13 | + |
| 14 | +== Claim 1: "A full-stack paradigm for verifiably-compliant, secure, and sustainable systems" |
| 15 | + |
| 16 | +[quote, README] |
| 17 | +____ |
| 18 | +A full-stack, open-source paradigm for building verifiably-compliant, secure, |
| 19 | +and sustainable systems. |
| 20 | +____ |
| 21 | + |
| 22 | +=== How it works |
| 23 | + |
| 24 | +MAA stands for the three-component architecture that defines the framework: |
| 25 | + |
| 26 | +* *MAA Framework* — the overarching paradigm and governance rules |
| 27 | +* *Oblíbený* — the reference programming language designed for the framework |
| 28 | +* *Aletheia* — the microkernel providing the trusted execution base |
| 29 | + |
| 30 | +These are not deployed together as a single binary; they are coordinated design |
| 31 | +decisions that ensure any system built under MAA carries provable correctness |
| 32 | +guarantees at the language, OS, and application level simultaneously. |
| 33 | + |
| 34 | +The formal anchor is the Certified Null Operation (CNO) defined in |
| 35 | +`absolute-zero/src/main.rs`: |
| 36 | + |
| 37 | +[source,rust] |
| 38 | +---- |
| 39 | +#![forbid(unsafe_code)] |
| 40 | +fn main() { |
| 41 | + // At the application level, the main function contains no instructions. |
| 42 | + // The Rust runtime handles standard entry/exit procedures, resulting in |
| 43 | + // a near-minimal binary that does nothing observable. |
| 44 | +} |
| 45 | +---- |
| 46 | + |
| 47 | +This is not a joke program. It is the formally verified base case — the proof |
| 48 | +that a MAA-compliant executable can be reduced to provably nothing. Aletheia |
| 49 | +builds on this: every system operation must have a well-defined inverse, and |
| 50 | +the composition of an operation with its inverse must be provably equivalent |
| 51 | +to the CNO. The CNO is the semantic zero of the framework. |
| 52 | + |
| 53 | +=== Code path |
| 54 | + |
| 55 | +`absolute-zero/` — CNO implementation in Rust. The VERIFICATION_RESULTS.adoc |
| 56 | +documents which properties have been machine-checked. The `proofs/` directory |
| 57 | +contains the formal proof objects. |
| 58 | + |
| 59 | +`aletheia/src/main.rs` — The microkernel entry point. Aletheia v1.9.0 |
| 60 | +implements RSR Bronze and Silver compliance checks (51 total) against itself |
| 61 | +and other repositories. The `checks.rs` module is the full check suite; |
| 62 | +`types.rs` defines compliance levels; `confidence.rs` scores check results. |
| 63 | +The zero-dependency, zero-unsafe design is intentional: the auditor tool that |
| 64 | +certifies others must be auditable itself. |
| 65 | + |
| 66 | +The key architectural claim — "reversibility" — is formalised as: |
| 67 | +`∀ σ : State, ∀ op : Operation, IsReversible(op) ↔ (∃ op_inv, (op ;; op_inv) ≡ CNO)` |
| 68 | + |
| 69 | +This formula lives in the Aletheia README and is backed by Coq/Idris2 proofs |
| 70 | +in `aletheia/ffi/` and `absolute-zero/proofs/`. |
| 71 | + |
| 72 | +=== Honest caveat |
| 73 | + |
| 74 | +This is an *early-stage* project. The README explicitly marks status as |
| 75 | +"Project Specification — implementation forthcoming." What is implemented |
| 76 | +and machine-checked is the base case (CNO, absolute-zero) and the compliance |
| 77 | +checker (Aletheia v1.9.0). The full MAA stack — including Oblíbený compiler, |
| 78 | +r-Minix derivation, and complete reversibility proofs — is a multi-year |
| 79 | +research programme. The honest status is: foundations are proven; the rest |
| 80 | +is a roadmap. |
| 81 | + |
| 82 | +== Claim 2: "Aletheia is the microkernel; absolute-zero is the formal base case" |
7 | 83 |
|
8 | 84 | [quote, README] |
9 | 85 | ____ |
10 | | -A full-stack, open-source paradigm for building verifiably-compliant, secure, and sustainable systems. |
| 86 | +Aletheia: Microkernel implementation. Absolute Zero: Reference language |
| 87 | +designed for the framework. |
11 | 88 | ____ |
12 | 89 |
|
| 90 | +(Note: The README table description is slightly misleading — Oblíbený is the |
| 91 | +reference language; Absolute Zero is the CNO base case. Both live here.) |
| 92 | + |
| 93 | +=== How it works |
| 94 | + |
| 95 | +`aletheia/` is currently a Rust compliance-checker (v1.9.0), not yet a |
| 96 | +microkernel. It functions as a self-verifying RSR compliance tool: |
| 97 | +20/20 self-verification checks pass, 16 Bronze checks, 4 Silver checks, |
| 98 | +zero dependencies, zero unsafe blocks, ~2100 lines of code. |
| 99 | + |
| 100 | +The path from current Aletheia (compliance checker) to r-Minix (reversible |
| 101 | +microkernel) is documented in `aletheia/ROADMAP.adoc`. The compliance checker |
| 102 | +phase exists to establish the auditing infrastructure before the kernel work |
| 103 | +begins — you cannot verify a kernel without a trustworthy verifier. |
| 104 | + |
| 105 | +`absolute-zero/` provides reference benchmarks. Because the CNO exits cleanly |
| 106 | +with no allocations, no I/O, and no side effects, it is the performance floor |
| 107 | +against which any MAA-compliant program is measured. The benchmark suite in |
| 108 | +`absolute-zero/benches/` captures this baseline. |
| 109 | + |
| 110 | +=== Honest caveat |
| 111 | + |
| 112 | +Aletheia v1.9.0 is a compliance-checking CLI, not a microkernel. The roadmap |
| 113 | +targets "r-Minix" as a far-future goal (v5.0+). An external reviewer should |
| 114 | +not expect kernel source code in this repo today. What they will find is a |
| 115 | +high-quality Rust tool that enforces the compliance standards the eventual |
| 116 | +kernel will need to satisfy. |
| 117 | + |
| 118 | +== Dogfooded Across The Account |
| 119 | + |
| 120 | +[cols="1,2,2"] |
| 121 | +|=== |
| 122 | +| Technology | Role in MAA Framework | Also Used In |
| 123 | + |
| 124 | +| *Rust* |
| 125 | +| Primary language for Aletheia (compliance checker) and absolute-zero (CNO). |
| 126 | +`#![forbid(unsafe_code)]` throughout. |
| 127 | +| protocol-squisher, verisimdb, ephapax, gitbot-fleet |
| 128 | + |
| 129 | +| *Idris2* (planned, per ABI/FFI Universal Standard) |
| 130 | +| Formal proofs of reversibility properties in `absolute-zero/proofs/` |
| 131 | +| Gossamer, Groove, Stapeln, VeriSimDB — everywhere an ABI layer exists |
| 132 | + |
| 133 | +| *Zig FFI* (per ABI/FFI Universal Standard) |
| 134 | +| `aletheia/ffi/` and `absolute-zero/ffi/` — C-compatible FFI for kernel |
| 135 | +interfaces |
| 136 | +| Gossamer, Stapeln, game-server-admin |
| 137 | + |
| 138 | +| *Stapeln containers* |
| 139 | +| `stapeln.toml` + `Containerfile` for deployment |
| 140 | +| All containerised services in the account |
| 141 | + |
| 142 | +| *Hypatia scanning* |
| 143 | +| `.hypatia/` + CI workflows; Aletheia v1.9.0 is conceptually adjacent to |
| 144 | +Hypatia's compliance scanner |
| 145 | +| Every RSR repo in the account |
| 146 | + |
| 147 | +| *Contractile.just* |
| 148 | +| `contractile.just` + `contractiles/` — shared build recipes |
| 149 | +| Universal across hyperpolymath repos |
| 150 | + |
| 151 | +| *Guix/Nix* |
| 152 | +| `guix.scm` + `flake.nix` — reproducible build environments |
| 153 | +| Ecosystem-wide policy enforced by guix-nix-policy.yml CI |
| 154 | +|=== |
| 155 | + |
13 | 156 | == File Map |
14 | 157 |
|
15 | | -[cols="1,2"] |
| 158 | +[cols="1,3"] |
16 | 159 | |=== |
17 | | -| Path | What's There |
| 160 | +| Path | What It Proves |
| 161 | + |
| 162 | +| `absolute-zero/` |
| 163 | +| The Certified Null Operation reference implementation. `src/main.rs` is |
| 164 | +the CNO binary (17 lines, zero allocations, zero I/O). `proofs/` contains |
| 165 | +formal proof objects. `benches/` establishes the performance floor. |
| 166 | +`MACHINE_VERIFICATION.adoc` documents what has been machine-checked. |
| 167 | +`PROOF-CLASSIFICATION-CNO-FOCUSED.adoc` classifies CNO properties by proof |
| 168 | +status. |
| 169 | + |
| 170 | +| `absolute-zero/src/main.rs` |
| 171 | +| The literal anchor: `#![forbid(unsafe_code)]` + empty `main()`. Every |
| 172 | +formal claim in MAA Framework ultimately bottoms out here. |
| 173 | + |
| 174 | +| `aletheia/` |
| 175 | +| Microkernel research project (current phase: RSR compliance checker v1.9.0). |
| 176 | +`src/checks.rs` — 51 compliance checks (Bronze + Silver). `src/types.rs` — |
| 177 | +`ComplianceLevel`, `CheckResult`, severity types. `src/confidence.rs` — |
| 178 | +check scoring. Zero dependencies, zero unsafe blocks. |
| 179 | + |
| 180 | +| `aletheia/src/` |
| 181 | +| `main.rs` — CLI entry, `checks.rs` — full check suite, `config.rs` — |
| 182 | +per-repo configuration, `output.rs` — report formatting, `types.rs` — type |
| 183 | +definitions. |
| 184 | + |
| 185 | +| `aletheia/ROADMAP.adoc` |
| 186 | +| The path from compliance checker (today) to r-Minix (future). The roadmap |
| 187 | +milestones from v1.9.0 through v10.0.0 are the honest statement of what is |
| 188 | +done and what is not. |
| 189 | + |
| 190 | +| `aletheia/ffi/` |
| 191 | +| Zig FFI layer for kernel interface primitives (per ABI/FFI Universal Standard). |
| 192 | + |
| 193 | +| `aletheia/conformance/` |
| 194 | +| Conformance test suite — checks that Aletheia correctly identifies |
| 195 | +compliant and non-compliant repos. |
| 196 | + |
| 197 | +| `aletheia/extraction/` |
| 198 | +| Metadata extraction utilities used during compliance scanning. |
| 199 | + |
| 200 | +| `absolute-zero/ffi/` |
| 201 | +| Zig FFI primitives for CNO-adjacent low-level operations. |
| 202 | + |
| 203 | +| `absolute-zero/ECHIDNA_INTEGRATION.adoc` |
| 204 | +| How ECHIDNA (the neurosymbolic theorem prover from neural-foundations) is |
| 205 | +integrated to verify CNO properties. |
| 206 | + |
| 207 | +| `.machine_readable/` |
| 208 | +| A2ML checkpoint files. Canonical AI session state. Six files including |
| 209 | +AGENTIC.a2ml, NEUROSYM.a2ml, PLAYBOOK.a2ml beyond the standard three. |
| 210 | + |
| 211 | +| `.hypatia/` |
| 212 | +| Hypatia rule overrides for this repo. |
| 213 | + |
| 214 | +| `contractiles/` |
| 215 | +| Contractile.just ecosystem integration. |
18 | 216 |
|
19 | | -| `test(s)/` | Test suite |
| 217 | +| `TOPOLOGY.md` |
| 218 | +| Visual diagram of MAA component relationships and the reversibility stack. |
| 219 | +Start here for the full picture. |
20 | 220 | |=== |
21 | 221 |
|
22 | 222 | == Questions? |
23 | 223 |
|
24 | | -Open an issue or reach out directly — happy to explain anything in more detail. |
| 224 | +Start with `TOPOLOGY.md` for the architecture diagram, then |
| 225 | +`absolute-zero/src/main.rs` for the formal base case, then |
| 226 | +`aletheia/ROADMAP.adoc` for the honest statement of what exists today versus |
| 227 | +what is planned. For the reversibility mathematics, see |
| 228 | +`aletheia/README.adoc` which contains the Aletheia formula. |
0 commit comments