docs: add production Solidity translation patterns#1888
Merged
Conversation
…ranslation-patterns # Conflicts: # docs-site/content/guides/_meta.js
5 tasks
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
llms.txtso agents discover it before inventing parallel helpersVerity vs package-local boundaries
The guide explicitly keeps generic Solidity/EVM modeling in Verity core: call mechanics, precompile wrappers, ABI/hash helpers, loop assignment, helper returns, storage/layout patterns, and trust reporting.
It also explicitly keeps Poseidon, Permit2, Lazy-IMT high-level assumptions, Groth16 verifier correctness, and the full Unlink model in
unlink-verityor another dependent package as narrow linked externals, package-local ECMs, or spec oracles with precise trust-report names.Docs changed
docs-site/content/guides/production-solidity-patterns.mdxdocs-site/content/guides/solidity-to-verity.mdxdocs-site/content/guides/_meta.jsdocs-site/public/llms.txtValidation
npm cinpm run buildpython3 scripts/check_docs_workflow_sync.pyNote
Low Risk
Low risk: documentation-only changes that add a new guide and cross-links; no compiler/proof/runtime code paths are modified.
Overview
Adds a new agent-facing guide,
production-solidity-patterns, documenting recommended patterns for porting non-trivial Solidity contracts into Verity (storage flattening, modifiers/guards, loops/arrays, external call boundaries, and when to model cryptography/verifiers as oracles).Updates existing docs to surface this guide earlier: links it from
Solidity to Verity,Add a Contract, the docs index,README.md, guides metadata, anddocs-site/public/llms.txtso translators see the checklist before introducing custom helpers.Reviewed by Cursor Bugbot for commit 8ad4263. Bugbot is set up for automated code reviews on this repo. Configure here.