Skip to content

Formspec-Labs/recordspec

Repository files navigation

Trellis

Trellis is the cryptographic integrity substrate for the Formspec (intake) + WOS (governance) stack. It specifies the envelope, chain, checkpoint, and export-bundle format by which a Formspec response and its downstream WOS governance events become a single append-only, signed, offline-verifiable record.

Trellis does not replace Formspec or WOS. It concretely answers two already-written deferrals: the Respondent Ledger §13 LedgerCheckpoint seam and the WOS custodyHook (§10.5). What survives when the system, the vendor, and the years go away is the Trellis export.

Paths below are relative to trellis/.


Status

Trellis now has ratified 1.0.0 normative specs under specs/: trellis-core.md and trellis-operational-companion.md. The repository also contains active strategy and follow-on design work under thoughts/, plus prior research that informed the ratified surface.

Trellis remains greenfield for follow-on phases and cross-stack contracts: no production legacy to preserve, no backwards-compatibility obligation beyond the ratified 1.0.0 surface.

Operating lens: compute is cheap, time is cheaper, development is near-free next to the long-term cost of architectural debt. Expensive mistakes are architectural (data model, crypto boundaries, event taxonomy, sync contracts), not editorial. Prefer clean rethink over carrying a weak compromise forward. The product vision and the Phase 1 envelope invariants encode this: Phase 1 must name byte-exact decisions now because each is cheap to include and wire-breaking to retrofit.


Licensing

Trellis is part of the Formspec monorepo. All specification documents, drafts, and research materials here are licensed under Apache-2.0. See the root LICENSE and LICENSING.md.


The four top-level documents

Start here. Read in order.

Document Role
thoughts/product-vision.md Authoritative product roadmap. Four-phase arc, 15 non-negotiable Phase 1 envelope invariants, ledger/log vocabulary, delivery shape, tracks A–E.
specs/trellis-agreement.md Non-normative decision gate. Scope, primitives, seams, delivery shape, success criterion. A sign-off here authorizes the rest of Track A.
specs/trellis-core.md Normative. Phase 1 byte protocol: envelope, canonical encoding, signature profile, chain, checkpoint, export, verification.
specs/trellis-operational-companion.md Normative. Phase 2+ operator obligations: custody models, projection discipline, metadata budgets, delegated-compute honesty, sidecars.

Supporting:

Completed handoff log — Groups A/B/C resolved in commit 3a143a1. See thoughts/archive/specs/2026-04-17-trellis-normalization-handoff.md for the original task breakdown and evidence.


Research and reviews (reference material, not normative)

These informed the current specs and remain cited where their insights survive. None are normative.


Upstream-owned (referenced, not authored here)

  • thoughts/formspec/specs/respondent-ledger-spec.md — Formspec Respondent Ledger add-on (v0.1). Owns Profile A/B/C (privacy × identity × integrity-anchoring posture). Trellis binds to its §6.2 eventHash/priorEventHash and §13 LedgerCheckpoint seams; a Track E §21 spec extension adds normative case-ledger and agency-log objects.
  • Formspec Core, WOS Kernel, WOS Assurance, WOS Governance — referenced by Trellis Core composition sections (§22, §23) and by the cross-reference map for upstream-rehomed requirements.

Historical material (archived, not normative)


Process

  • TODO.md — Tactical work list. Near-term items, open ratification gates, parked work. Check here before starting anything.
  • ratification/ — Readiness gates and evidence for moving the two normative specs toward ratification.
  • fixtures/vectors/ — Byte-exact test vectors for the stranger test (G-3). Directory-per-vector layout with TOML manifest, narrative derivation evidence citing Core prose only, and committed cryptographic intermediates. First reference vector lives at append/001-minimal-inline-payload/. Governed by thoughts/specs/2026-04-18-trellis-g3-fixture-system-design.md; historical 12-task scaffold plan (landed) at thoughts/archive/specs/2026-04-18-trellis-g3-fixture-scaffold-plan.md.
  • scripts/check-specs.py — Lint enforcing forbidden patterns (signature zero-fill prose, JCS references, stale version strings, unarchived per-family paths, Profile-namespace hygiene) plus fixture coverage rules (testable-row-has-vector, declared-vs-derived, invariant coverage, generator-import discipline). TRELLIS_SKIP_COVERAGE=1 bypasses coverage rules during batched vector rollout; planned replacement is a per-invariant allowlist.

Reading order by goal

If you want to… Start here
Understand the roadmap and why the architecture looks the way it does thoughts/product-vision.md
Gate the project for sign-off specs/trellis-agreement.md
Implement append/verify/export against fixtures specs/trellis-core.md
Understand operator obligations (custody, projections, sidecars) specs/trellis-operational-companion.md
Trace a legacy ULCR/ULCOMP-R row to its current home specs/trellis-requirements-matrix.md + specs/cross-reference-map.md
See outstanding work TODO.md
Understand how the crypto choices were reached Research + reviews folders

Heading-level inventories for every active document live in REFERENCE.md.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors