Repository navigation
docs(contracts): document the contract security audit process (#187) - #553
Open
olaams-tech wants to merge 1 commit into
Open
olaams-tech wants to merge 1 commit into
olaams-tech wants to merge 1 commit into
Conversation
…r-Search#187) Adds contracts/SECURITY_AUDIT_PROCESS.md so the audit methodology behind the existing SECURITY.md records can be re-run whenever a contract changes materially. Documents the triggers, the seven-point checklist (CEI, checked arithmetic, access control, front-running, event safety, edge cases, storage lifecycle), the severity scale, the finding-record template, the complementary checks (cargo audit, lints, property tests) and sign-off. Links the process from each of the three contract audit records, which already track and fix the CEI-ordering and voting-power findings.
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.
Closes #187.
Context
Two of the three acceptance items were already satisfied on
main:escrow-contractanddao-governance-contracteach have aSECURITY.mdfollowinggreenpay-contract's methodology, and the findings those audits surfaced are tracked and fixed with regression tests (escrow H-01 CEI reorder and H-02 dispute-timeout recovery; dao H-01 snapshot voting-power inflation and H-02 proportional quorum). The remaining gap was the third item: a documented process for re-running the audit when either contract changes.What this adds
contracts/SECURITY_AUDIT_PROCESS.md— the repeatable process:make audit,make lint, property tests), and sign-off.greenpay-contract,escrow-contract,dao-governance-contract) to the process via a new Re-running this audit section.No contract code changed.
Acceptance criteria → evidence
SECURITY.mdfollow the documented methodologycontracts/escrow-contract/SECURITY.md,contracts/dao-governance-contract/SECURITY.mdcontracts/SECURITY_AUDIT_PROCESS.md+ the Re-running this audit linksNotes
make auditremains the dependency-vulnerability check (cargo audit); the process above is the contract-level audit methodology and is complementary to it.