Repository navigation
docs(vindex): update tlog-vindex spec and add applications and architecture docs - #177
Merged
mhutchinson merged 1 commit intoOct 27, 2026
Merged
Conversation
…ecture docs - Simplify c2sp.org/tlog-vindex-state@v1 to 6 lines (omitting embedded input log checkpoint signatures and shelving in-band map-fn commitment pre-1.0) and clarify empty-range, MPT topology, and verification rules in docs/tlog-vindex.md. - Add docs/APPLICATIONS.md illustrating how CT, MTC, Go SumDB, Sigstore, and Sigsum map onto VIndex (who monitors each log, canonical key shapes, prefix queries, and epoch rotation). - Add docs/ARCHITECTURE.md defining the high-level 5-stage Map Sandwich pipeline, checkpoint promotion invariants, crash consistency, auditing boundaries, and architectural trade-offs. - Update vindex/README.md to align terminology and index the high-level documentation.
patflynn
approved these changes
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Part 2a in the
vindexv1 upstreaming stack (extracted from #172 so the spec, ecosystem vision, and high-level architecture can be reviewed before the individual subcomponent design docs in #172 / Part 2b).vindex/docs/tlog-vindex.md:c2sp.org/tlog-vindex-state@v1to a strict 6-line unsigned input state commitment (input-origin,from,input-size,input-root,mpt-root), decoupling/keysverification from Input Log signature schemes and witness policies while advising operators to retain signed Input Log checkpoints out-of-band.map-fncommitment (recorded in## Design Logpending ecosystem discussion on encoding and verification).<output-log-origin>and a checkpoint verification policy (droppingtlog-policyfrom the spec).limitquery parameter onGET <index-url>/valuesfor deterministic HTTP caching, drops the cross-lookup stateful commitment cache requirement, clarifies empty-range (from = input_size)empty_mpt_hashverification, and adds an explicit caller coverage-horizon check forfrom.vindex/docs/APPLICATIONS.md: Illustrates how Certificate Transparency, Merkle Tree Certificates, Go SumDB, Sigstore, and Sigsum map onto VIndex—who monitors each log, canonical key shapes, query-time prefix proofs, and epoch rotation (from > 0).vindex/docs/ARCHITECTURE.md: Defines the high-level 5-stage Map Sandwich pipeline, checkpoint promotion invariants, crash consistency model, auditing boundaries, operational characteristics, and architectural trade-offs.vindex/README.md: Aligns high-level terminology and indexes the core specification, applications, and architecture documents.PR Stack Roadmap
(docs(vindex): retire legacy MVP and add C2SP tlog-vindex specification #171)docs(vindex): retire legacy MVP and add C2SP tlog-vindex specificationdocs(vindex): update tlog-vindex spec and add applications and architecture docs(this PR)2b:
docs(vindex): add subcomponent design documentation(docs(vindex): add subcomponent design documentation #172, stacked on 2a)feat(vindex): add wire codecs and metrics leaf packagesfeat(vindex/mapfn): add WASM guest SDK, wazero sandbox host, examples, and CLIfeat(vindex/ingest): add tile-cached ingestion pipelinefeat(vindex/kvstore): add Pebble inverted chunk storage enginefeat(vindex/tree): add variable-length MPT state trie and output log publisherfeat(vindex): add sync coordinator and C2SP HTTP read serverfeat(vindex/client): add verifiable C2SP client SDK and top-level Engine APIfeat(vindex/auditor): add independent full-log auditorfeat(vindex/hammer): add continuous load-testing and verification hammerfeat(vindex/cmd): add vindexd daemon, client CLI, dashboards, and e2e suitefeat(vindex/sumdb): add Go SumDB index/verify binaries, Docker stack, and quickstartfeat(vindex/mtc): add MTC and Static-CT personalities, clonelog, and auditor CLI