docs: add concise AI contract review guide#5880
Open
moul wants to merge 3 commits into
Open
Conversation
Collaborator
🛠 PR Checks SummaryAll Automated Checks passed. ✅ Manual Checks (for Reviewers):
Read More🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers. ✅ Automated Checks (for Contributors):No automated checks match this pull request. ☑️ Contributor Actions:
☑️ Reviewer Actions:
📚 Resources:Debug
|
…unsafe.PreviousRealm, Render injection
…ousRealm cases; update AGENTS.md
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
Adds
docs/resources/gno-ai-contract-review.md— a short, checklist-style guide specifically for AI agents reviewing Gno realm code.The guide covers the seven highest-yield issues:
cur realm, not attacker-controlledaddressparametersIsUserCall()notIsUser()realmvalues (storeAddress()strings instead)/p/-embedded types with callback iterators must stay unexportedRelationship to existing work
This is intentionally more minimal than the other security resources:
gno-security-guide.mdmisc/audit-pattern-harness/(#5835)gno testexecution, Markdown/JSON reportsThe audit harness and gno-mcp skill are powerful when you want to run automated checks. This guide fills the lighter-weight use case: an AI agent reading a contract and knowing what to look for, without needing a separate tool invocation.