Skip to content

Instantly share code, notes, and snippets.

@maurelian

maurelian/audit_prep_checklist.md

Last active July 13, 2023 02:38
Show Gist options
  • Star 9 You must be signed in to star a gist
  • Fork 7 You must be signed in to fork a gist
  • Save maurelian/13831f1940340e0dcd0482555eb5c4fe to your computer and use it in GitHub Desktop.
Save maurelian/13831f1940340e0dcd0482555eb5c4fe to your computer and use it in GitHub Desktop.
Download ZIP
Raw
audit_prep_checklist.md

Feel free to copy and paste this list into a README, issue or elsewhere in your project.

Audit prep checklist (reference)

  • Documentation (A plain english description of what you are building, and why you are building it. Should indicate the actions and states that should and should not be possible)
    • For the overall system
    • For each unique contract within the system
  • Clean code
    • Run a linter (like EthLint)
    • Fix compiler warnings
    • Remove TODO and FIXME comments
    • Delete unused code
  • Testing
    • README gives clear instructions for running tests
    • Testing dependencies are packaged with the code OR are listed including versions
  • Automated Analysis
  • Frozen code
    • Halt development of the contract code
    • Provide commit hash for the audit to target
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment