kcolbchain / docs / audit-checklist

audit-checklist

Executable checklist as Solidity test bases—import into Foundry, inherit the checks you need, run forge test. Patterns distilled from audits since 2019.

Install

forge install kcolbchain/audit-checklist

Minimal usage

import {ReentrancyCheck} from "audit-checklist/checks/ReentrancyCheck.sol";

contract MyVaultAudit is ReentrancyCheck {
    function setUp() public {
        targetContract = address(new MyVault());
    }
}
forge test

Checks

ModuleFocus
ReentrancyCheckCEI, cross-function reentrancy via callbacks
AccessControlCheckAdmin surfaces, initializers, roles
OracleCheckManipulable spot reads, TWAP gaps
UpgradeCheckProxy storage layout, uninitialized impl
FlashLoanCheckFlash-loan-driven price / state attacks

Package layout

src/ChecklistBase.sol
src/checks/*.sol
src/examples/VulnerableVault.sol
test/Example.t.sol

MIT · New patterns welcome via issues/PRs · GitHub

GitHub

Source and examples

All projects

Back to docs home