docs: add Reentrancy Model explanation page (rely-guarantee framework)#2098
Merged
Conversation
…amework Documents all four reentrancy mechanisms in one Explanation page (disposition gate, nonreentrant guard, reentrancy_trusted, ReentrancySpec), including the adversary-hole model, schedule_preserves, the lock-as-disjunct strong/weak layering, and the honest trust limits tracked in #2094. Cross-links from functions, proof-techniques, trust-model, and glossary, and fixes the outdated "reentrancy is not modeled" limitation note.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_c981255e-85a3-4665-87db-a651a7c06e5f) |
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
docs-site/content/reentrancy.mdxdocumenting all four reentrancy mechanisms in one place: the fail-closed disposition gate, thenonreentrant(lock)runtime guard,reentrancy_trusted, and theReentrancySpecrely-guarantee proof framework (adversary holes,schedule_preserves, nested reentry, the lock-as-disjunct strong/weak invariant layering, and the honest trust limits fromTRUST_ASSUMPTIONS.md)._meta.js(new Explanation entry),edsl/functions.mdx(link from the disposition section),proof-techniques.mdx(fixes the outdated "reentrancy is not modeled via cross-call semantics" limitation note),trust-model.mdx(new bullet for the three rely-guarantee author obligations),glossary.mdx(new entries: Reentry schedule, Rely-guarantee (ReentrancySpec), Strong vs weak invariant).AUDIT.md/TRUST_ASSUMPTIONS.md/AXIOMS.mdare untouched; the page links to them as the authoritative sources.Related: #2094 (macro-emitted adversary holes + entrypoint registry), which the page and trust-model bullet reference as the planned mitigation for the registry-completeness and hole-placement obligations.
Validation
make check— All checks passed (607 Python tests OK in 443.9s, docsync/macro-health/selector/path checks passed).cd docs-site && npm ci && npm run build— Next.js production build succeeded; Pagefind indexed 27 pages including the new/reentrancypage.Test plan
/reentrancyrenders, sidebar shows "Reentrancy Model" first under Explanation, and internal links (/edsl/functions#reentrancy-disposition,/trust-model,/glossary) resolve.main.Note
Low Risk
Documentation-only changes with no runtime, compiler, or proof boundary impact.
Overview
Adds a new Explanation page at
/reentrancythat documents Verity’s reentrancy story end-to-end: the fail-closed disposition gate,nonreentrant(lock),reentrancy_trusted, and theReentrancySpecrely-guarantee proof path (adversary holes,schedule_preserves, lock-as-disjunct strong/weak layering, multi-contract schedules, and documented trust limits).Navigation and cross-links:
_meta.jslists Reentrancy Model under Explanation;edsl/functions,proof-techniques,trust-model, andglossarynow point at the new page and refresh wording (e.g. proof-techniques no longer says reentrancy is unmodeled; trust-model adds rely-guarantee author obligations; glossary adds reentry schedule, rely-guarantee, strong vs weak invariant).Docs-only — no compiler, proof, or trust-artifact changes.
Reviewed by Cursor Bugbot for commit c91952c. Bugbot is set up for automated code reviews on this repo. Configure here.