onetrace 0.1.0__tar.gz

onetrace-0.1.0/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+Generated from `git log a1d46e1..HEAD -- src/ examples/` (this repository's first commit through
+the current commit) — the only diff basis that exists, since `onetrace` has not yet had a
+released version to diff against. Grouped by area below; every line traces to a real commit in
+that log, not written from memory. Once a first release is tagged, later entries will diff
+against it instead.
+
+## [Unreleased]
+
+### Breaking
+
+- **`onetrace-verify`: `import verify` and `import canonicalize` no longer work (`ce8e357`).**
+  Before this commit, `onetrace-verify`'s wheel installed `verify.py` and `canonicalize.py` as
+  loose top-level modules (`py-modules`) directly in site-packages, so a caller could
+  `import verify` after `pip install onetrace-verify`. Fixing
+  `onetrace.verifier_call.default_verifier_dir()` (a real product defect: it resolved to a
+  path that does not exist under a real wheel install) required these two files to live
+  somewhere `importlib.resources` can hand back a directory for, so they moved inside the
+  `onetrace_verify` package itself (`onetrace_verify/verify.py`,
+  `onetrace_verify/canonicalize.py`) as package data. They are not meant to be imported as
+  ordinary Python modules there — `onetrace.verifier_call.load()` reads their bytes, checks
+  them against `SHA256SUMS.shipped`, and executes exactly those checked bytes, the same
+  mechanism it always used. A caller that needs the raw source directly can do:
+
+  ```python
+  import importlib.resources
+  verify_py = importlib.resources.files("onetrace_verify") / "verify.py"
+  ```
+
+  No compatibility shim restores the bare `import verify` / `import canonicalize` form: the
+  only way to make it work again is either an import-time side effect that populates
+  `sys.modules["verify"]` whenever `onetrace_verify` happens to be imported (fragile — it
+  depends on import order a caller doesn't control) or asking every caller to change their own
+  code first (not "at no cost" either way). Pre-release, this break is accepted as-is rather
+  than papered over with something fragile.
+
+### SDK core and the three verbs
+
+- Stage-receipt emission (`onetrace.emit`), the record model (`onetrace.records`), and canonical
+  form (`onetrace.canonical`).
+- `diff`, `localize`, and `reproduce`, each calling the reference verifier before comparing
+  anything, never trusting a record the verifier hasn't checked.
+- `localize --doc`: one document's chunk sets under two runs, digest by digest.
+- Topology support: fan-out, fan-in, and loops as an additive extension over the original linear
+  chain — `stage.instance`, `receipt:<node id>` inputs, `edges`/`declared_edges` in the manifest,
+  and `diff`/`localize`/`reproduce` all extended to a DAG shape.
+- `reproduce`: an upstream COULD NOT CHECK stage never lets a downstream one report DIVERGED.
+- `localize` on a single run: an ambiguous bare stage name is refused, not guessed at.
+
+### Emission guarantees
+
+- The drop ledger (`rec.gap`) and boundaries (`rec.boundary`), and the "complete" claim's own
+  second half — `boundaries` empty, not just every declared stage present.
+- Instruments declared once at initialisation, shared across every instance of a repeated stage.
+- Verify-pin hooks: the reference verifier runs after a receipt (or after the whole run) and its
+  rows are written beside the record, never inside it.
+- Atomic writes for every receipt and the manifest (write-fsync-replace, so a crash mid-write
+  never leaves a half-written file where a reader expects a whole one).
+- `KeyboardInterrupt`/`CancelledError` during a stage are recorded as an error outcome, not
+  silently swallowed.
+- A run's own store-growth bound (`max_run_bytes`), refusing further writes past it rather than
+  writing an over-bound artifact.
+- The secrets guard: an input declared `trust_class: "secret"` is never digested, by the emitter
+  or by the verifier checking a hand-built record after the fact.
+- One run, one process: a lock file held for the run's lifetime.
+- Run identity: `run_id`, generated or caller-supplied, and `run_id_source` naming which; the
+  chain-manifest format moved to `stage-receipt-chain/0.2` to carry it.
+- `ctx.reference`/`onetrace.digest`: a streamed digest over a path, for an artifact a stage
+  doesn't need the bytes of in Python, with `digest_source` (`caller` vs `emitter`) on the
+  receipt.
+
+### The SDK-side build verifier (`onetrace.sdk_verify`)
+
+A second, independent implementation of every check the reference verifier performs, built to
+answer register requirement #9: `python -m onetrace.sdk_verify MANIFEST.json [OUT_DIR]` prints a
+row per check and writes the same report as JSON beside the text when `OUT_DIR` is given.
+
+- The full per-receipt check set (required fields, canonical form, duplicate keys, lone
+  surrogates, the format-version check, timestamps and their zones, instrument naming,
+  trust classes, outcome shape, coverage/completeness, anchor state) and the whole-chain checks
+  (digest and link integrity, chain head, emission order, plan conformance against declared
+  edges).
+- Five checks the format's own Internet-Draft names as missing from the preview verifier:
+  `"complete"` implies empty `boundaries`; `"ended"` does not precede `"started"`; `"prev"` is
+  null exactly when `"index"` is `"1"`; `"rederivable"` is one of its two literal string values;
+  the chain manifest's `run_id` equals every receipt's.
+- Merkle inclusion proofs for a corpus-manifest reference to one member, without needing the rest
+  of the corpus.
+- External effects (`effects`): each entry's `target` and one of three declared states.
+- A chain's `digest_source` count (caller vs. emitter), observational, never a refusal.
+- Malformed input FAILs cleanly instead of raising a host exception (an unhashable value where a
+  string was expected, a non-dict receipt, a malformed Merkle proof).
+- A real RFC 3339 offset pattern for the timestamp-zone check, replacing a coincidental
+  character-position match that let a bare date string (no time, no zone at all) pass.
+
+### Examples
+
+- `examples/golden`: a small, deterministic four-stage chain (retrieve, rerank, generate, verify)
+  with no network and no model, emitted through the SDK.
+- `examples/langchain_adapter`: a real LangChain-based pipeline over the same nine-stage,
+  thirteen-document contract, with its own pinned-version refusal and regression test.
+- `examples/langflow_adapter`: the same contract built with Langflow, including custom components
+  where the framework's own constructs needed infrastructure disproportionate to a small offline
+  demo.
+
+### Fixed
+
+- A two-root, run-scoped instrument case in the ladder/localize path.
+- A batch of malformed-input crashes, a coincidental timestamp-zone-check pass, a rejection-vector
+  text mismatch, and a vector-number mislabeling, found by a deliberate audit of this project's
+  own checks and rejection vectors and fixed in one pass.

onetrace-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

onetrace-0.1.0/MANIFEST.in

@@ -0,0 +1,16 @@
+# The sdist's own file list. Without this, setuptools' default rules include only src/ (the
+# installable package) plus a short list of root metadata files -- silently dropping exam/ and
+# verifier/, which tests/ring.py needs to run at all.
+include LICENSE
+include README.md
+include CHANGELOG.md
+include SECURITY.md
+recursive-include exam *
+recursive-include examples *
+recursive-include reference *
+recursive-include scripts *
+recursive-include tests *
+recursive-include verifier *
+recursive-include draft *
+prune */__pycache__
+global-exclude *.pyc

onetrace-0.1.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: onetrace
+Version: 0.1.0
+Summary: onetrace SDK: stage-receipt records and the verbs diff, localize, reproduce
+Author-email: Shamik Saha <shamik.saha.rcciit@gmail.com>
+License-Expression: Apache-2.0
+Keywords: provenance,reproducibility,data-lineage,stage-receipt,audit-trail
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: onetrace-verify>=0.1.0
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-timeout>=2.3; extra == "test"
+Requires-Dist: numpy<3,>=2.1; extra == "test"
+Provides-Extra: langchain
+Requires-Dist: beautifulsoup4==4.15.0; extra == "langchain"
+Requires-Dist: langchain==1.4.2; extra == "langchain"
+Requires-Dist: langchain-classic==1.0.8; extra == "langchain"
+Requires-Dist: langchain-community==0.4.2; extra == "langchain"
+Requires-Dist: langchain-core==1.6.5; extra == "langchain"
+Requires-Dist: langchain-protocol==0.0.19; extra == "langchain"
+Requires-Dist: langchain-text-splitters==1.1.2; extra == "langchain"
+Requires-Dist: numpy==2.5.3; extra == "langchain"
+Requires-Dist: pypdf==6.19.0; extra == "langchain"
+Provides-Extra: llamaindex
+Requires-Dist: llama-index-core==0.14.25; extra == "llamaindex"
+Requires-Dist: llama-index-readers-file==0.7.0; extra == "llamaindex"
+Requires-Dist: llama-index-instrumentation==0.6.0; extra == "llamaindex"
+Requires-Dist: llama-index-workflows==2.24.1; extra == "llamaindex"
+Requires-Dist: pypdf==6.19.0; extra == "llamaindex"
+Requires-Dist: numpy==2.4.6; extra == "llamaindex"
+Provides-Extra: langflow
+Requires-Dist: langflow-base==1.12.3; extra == "langflow"
+Requires-Dist: lfx==1.12.3; extra == "langflow"
+Dynamic: license-file
+
+# onetrace
+
+onetrace is an SDK for emitting and verifying *stage receipts*: a signed, chained record of what
+a pipeline actually did at each step, checkable independently of the code that produced it.
+onetrace does not check whether a pipeline's output is *true* — it checks what was recorded, and
+whether an independent verifier can confirm that record is internally consistent and unbroken.
+Truth is a claim about the world; onetrace only ever speaks to what was recorded and what a
+verifier could confirm about it.
+
+## Install and quickstart
+
+```
+pip install onetrace
+```
+
+`onetrace-verify` (the reference verifier, standard library only) comes along automatically —
+it is a declared dependency, not an extra step.
+
+Save this as `demo.py`. It emits a two-stage run with no network, no model, and no file beyond
+itself:
+
+```python
+#!/usr/bin/env python3
+"""onetrace quickstart demo: two stages, no network, no model, deterministic."""
+import json
+import sys
+from pathlib import Path
+
+from onetrace.emit import Instrument, Recorder
+
+QUESTION = "What does the warranty cover?"
+CORPUS = [
+    {"id": "p1", "text": "The warranty covers manufacturing defects for twelve months."},
+    {"id": "p2", "text": "Shipping delays are handled by the logistics partner, not the warranty."},
+    {"id": "p3", "text": "Batteries are covered by a separate six-month warranty."},
+]
+
+
+def main(out_dir: str, run_id: str) -> None:
+    out = Path(out_dir)
+    out.mkdir(parents=True, exist_ok=True)
+    corpus_path = out / "corpus.json"
+    corpus_path.write_text(json.dumps(CORPUS), encoding="utf-8")
+
+    rec = Recorder(out_dir, run_id=run_id, declared_stages=["retrieve", "answer"],
+                   manifest=Path(__file__), policy="fail-closed",
+                   anchor_reason="quickstart demo; epoch anchoring is not implemented")
+
+    retrieve_cfg = {"tokenizer": "lower-split", "top_k": "1"}
+
+    @rec.stage("retrieve", Instrument("word-overlap", "retriever", "1.0.0", retrieve_cfg))
+    def retrieve(ctx):
+        corpus = json.loads(
+            ctx.read_external(corpus_path, "application/json", name="corpus",
+                              trust_class="operator-authored").decode("utf-8"))
+        qwords = set(QUESTION.lower().split())
+        scored = [(p["id"], p["text"], len(qwords & set(p["text"].lower().split())))
+                 for p in corpus]
+        scored.sort(key=lambda s: (-s[2], s[0]))
+        best_id, best_text, _ = scored[0]
+        for k, v in retrieve_cfg.items():
+            ctx.constant(k, v)
+        ctx.assertion("candidate_count", str(len(corpus)))
+        return ctx.write_json("retrieved.json", {"id": best_id, "text": best_text})
+
+    answer_cfg = {"method": "extractive"}
+
+    @rec.stage("answer", Instrument("extractive", "answerer", "1.0.0", answer_cfg))
+    def answer(ctx, retrieved_artifact):
+        retrieved = ctx.read_json(retrieved_artifact)
+        for k, v in answer_cfg.items():
+            ctx.constant(k, v)
+        ctx.assertion("source", retrieved["id"])
+        return ctx.write_json("answer.json", {"answer": retrieved["text"], "cited": retrieved["id"]})
+
+    retrieved = retrieve()
+    answer(retrieved)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1], sys.argv[2])
+```
+
+Emit two runs of it:
+
+```
+python demo.py run_a run-a
+python demo.py run_b run-b
+```
+
+Verify one with the reference verifier:
+
+```
+cd run_a && onetrace-verify .
+```
+
+```
+[PASS   ] receipts/01-retrieve.json: bytes are canonical
+...
+[PASS   ] manifest: chain head matches the last receipt
+
+52 pass, 0 fail, 2 not-run  ->  PASS
+```
+
+The 2 `not-run` rows are `originality` — this run is unanchored (no epoch anchoring configured),
+so the verifier checks that the record is internally consistent, not that it is first-published.
+
+Compare the two runs:
+
+```
+onetrace diff run_a run_b --out diff_report
+```
+
+```
+baseline   run_a  run-a  (run)
+candidate  run_b  run-b  (run)
+
+diff: identical
+
+stage         baseline            candidate           verdict
+--------------------------------------------------------------------
+retrieve      51bd312473c4        51bd312473c4        same
+answer        35a281ec6835        35a281ec6835        same
+
+first difference  none
+comparisons performed 2; stages identical before the first difference 2
+```
+
+`onetrace localize` takes the same two runs (or just one, to find the first unclean stage in it
+alone) and finds the first point of divergence:
+
+```
+onetrace localize run_a run_b --out localize_report
+```
+
+```
+baseline   run_a  run-a  (run)
+candidate  run_b  run-b  (run)
+
+localize: identical
+
+stage         baseline            candidate           verdict
+--------------------------------------------------------------------
+retrieve      51bd312473c4        51bd312473c4        same
+answer        35a281ec6835        35a281ec6835        same
+
+first difference  none
+comparisons performed 2; stages identical before the first difference 2
+```
+
+`onetrace reproduce` re-executes a recorded stage and compares its output against what the
+receipt claims — it needs the original pipeline code available to re-run, so it isn't part of
+this quickstart.
+
+This transcript was run word for word in a fresh virtual environment (`pip install onetrace`
+from a locally-built wheel, no editable install, no repository checkout) before being written
+here.
+
+## Five verdicts
+
+Every stage in a comparison gets exactly one of five verdicts, and nothing else:
+
+- **same** — the stage's output digest matches on both sides.
+- **FIRST DIFFERENCE** — the first stage, in order, whose output digest does not match.
+- **downstream** — after the first difference, still different; the divergence propagated.
+- **reconverged** — after diverging, a later stage's output matches again (different work,
+  same result — this happens in practice and is reported honestly, not hidden).
+- **COULD NOT CHECK** — the stage can't be evaluated (an unimplemented format version, a
+  declared boundary, a file that can't be read). This is not a pass, and it is not silently
+  folded into "same."
+
+A verdict is always about a stage's **output**. A difference in the instrument, its
+configuration, or the declared constants never changes a verdict by itself — it appears as an
+annotation alongside the ladder, naming exactly what differs, so a `same` result never hides that
+something about *how* the output was produced changed even though the bytes didn't.
+
+`diff` and `localize` each also report one overall result word for the whole comparison
+(`identical`, `diverged`, `not comparable`, `refused`, or `could not check`, with exit codes
+0/1/2/3/4 respectively — `localize` on a single run instead reports `clean` or `located`, exit
+0 or 1); `reproduce` reports each stage as `REPRODUCED`, `DIVERGED`, or `COULD NOT CHECK`.
+
+## Links and the trust model
+
+- [Documentation](docs/) — the format in plain words, the five verdicts, the three verbs, one page per adapter, and what onetrace does not claim.
+- [The stage-receipt format (Internet-Draft)](draft/draft-saha-stage-receipts-00.txt)
+- [The reference verifier](verifier/)
+- [The rejection vectors](verifier/rejection/) — records a conforming verifier must refuse, and why
+
+**The verifier does not trust the SDK that emitted a record.** Every record this SDK produces is
+checked the same way a record from any other emitter would be — the verifier reads bytes, not
+intentions, and it owes nothing to the code that wrote them.
+
+## Stability
+
+The current record format is `stage-receipt/0.2` (format major version `0`), specified by an
+Internet-Draft that has not yet reached RFC status. Anything in the format — required members,
+canonical-form rules, the rejection vectors — may still change before major version `1`. Format
+major version is carried in every record: a manifest declaring one the reference verifier does
+not implement is refused outright, by name, rather than silently accepted (verify a manifest with
+an unrecognized `format` and it prints `[REFUSED] manifest: format -- ...` and exits non-zero); a
+verb comparing individual stages reports the stage's own verdict as `COULD NOT CHECK` for the
+same reason. Neither ever guesses.
+
+## License, security, and reporting a problem
+
+Licensed under [Apache-2.0](LICENSE).
+
+This is pre-release software (see the classifiers in `pyproject.toml`). See [SECURITY.md](SECURITY.md)
+for what's in scope and how to report a vulnerability; for anything else, open an issue against
+this repository.