Skip to content

docs: add production Solidity translation patterns#1888

Merged
Th0rgal merged 2 commits into
mainfrom
docs/agent-solidity-translation-patterns
May 16, 2026
Merged

docs: add production Solidity translation patterns#1888
Th0rgal merged 2 commits into
mainfrom
docs/agent-solidity-translation-patterns

Conversation

@Th0rgal
Copy link
Copy Markdown
Member

@Th0rgal Th0rgal commented May 16, 2026

Summary

  • add an agent-facing Production Solidity Patterns guide for porting non-trivial Solidity contracts into Verity
  • document Unlink-inspired translation shapes: flattened inheritance/storage, modifiers, nonreentrant entrypoints, accumulator loops, array filtering, registry reads, cryptographic boundaries, and standard ECM usage
  • link the new guide from the Solidity-to-Verity guide and llms.txt so agents discover it before inventing parallel helpers

Verity 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-verity or 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.mdx
  • docs-site/content/guides/solidity-to-verity.mdx
  • docs-site/content/guides/_meta.js
  • docs-site/public/llms.txt

Validation

  • npm ci
  • npm run build
  • python3 scripts/check_docs_workflow_sync.py

Note

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, and docs-site/public/llms.txt so 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.

@Th0rgal Th0rgal merged commit edd145e into main May 16, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant