dannydoodlesstory/evm-audit-helpersCollezione di frammenti Solidity e script Foundry per audit di sicurezza degli smart contract
evm-audit-helpers è una raccolta curata di frammenti Solidity, script Foundry e modelli di test progettati per accelerare gli audit di sicurezza degli smart contract EVM. Il repository raggruppa blocchi riutilizzabili per problematiche di audit comuni come reentrancy, discrepanze nel layout di storage e insidie legate all'ottimizzazione del gas, consentendo ad auditor e sviluppatori di concentrarsi sulla logica piuttosto che sul codice ripetitivo.
Obiettivi principali:
| Categoria | Descrizione | File principali |
|---|---|---|
| Controlli di Reentrancy | Modificatori helper, pattern nonReentrant e script di rilevamento a runtime. | src/helpers/Reentrancy.sol, scripts/reentrancy_check.sol |
| Analizzatore di Layout di Storage | Utility per confrontare slot di storage, generare diagrammi di layout e rilevare upgrade non sicuri. | src/helpers/StorageLayout.sol, scripts/storage_analyzer.sol |
| Modelli di Test Foundry | Suite di test boilerplate che coprono vulnerabilità comuni (controllo accessi, aritmetica, delegatecall, ecc.). | test/templates/* |
| Audit di Gas e Opcode | Script per profilare l'uso del gas e segnalare opcode costosi. | scripts/gas_profiler.sol |
| Helper per Report | Reporter JSON/Markdown che possono essere integrati in dashboard CI. | scripts/report_generator.sol |
| Integrazione CI | Esempio di workflow GitHub Actions per esecuzioni di audit automatizzate. | .github/workflows/ci.yml |
Tutti gli helper sono scritti per Solidity ^0.8.20 e sono compatibili con Foundry (forge, cast).
# 1️⃣ Clona il repository
git clone https://github.com/your-org/evm-audit-helpers.git
cd evm-audit-helpers
# 2️⃣ Installa Foundry (se non già installato)
curl -L https://foundry.paradigm.xyz | bash
foundryup
# 3️⃣ Installa le dipendenze
forge install
# 4️⃣ Esegui la suite di test predefinita (include controlli di reentrancy, storage e gas)
forge test
Suggerimento: Aggiungi
export FOUNDRY_PROFILE=cialla tua shell per utilizzare le impostazioni del compilatore ottimizzate per CI.
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "evm-audit-helpers/src/helpers/Reentrancy.sol";
contract MyVault is ReentrancyGuard {
mapping(address => uint256) private balances;
function deposit() external payable nonReentrant {
balances[msg.sender] += msg.value;
}
function withdraw(uint256 amount) external nonReentrant {
require(balances[msg.sender] >= amount, "Insufficient");
balances[msg.sender] -= amount;
(bool ok,) = msg.sender.call{value: amount}("");
require(ok, "Transfer failed");
}
}
Esegui il rilevatore a runtime su un contratto compilato:
forge script scripts/reentrancy_check.sol:ReentrancyChecker --rpc-url $RPC_URL --broadcast
# Genera una descrizione JSON del layout di storage di un contratto compilato
cast abi-storage --contract MyUpgradeable.sol:MyUpgradeable > storage.json
# Confronta con un layout di riferimento (ad es., da una versione precedente)
forge script scripts/storage_analyzer.sol:StorageComparator \
--sig "compare(string memory, string memory)" storage.json reference.json
Lo script restituirà slot non corrispondenti, potenziali shadowing e suggerimenti per annotazioni @custom:oz-upgrades-unsafe-allow.
Copia un modello nel tuo repository di audit:
cp -r test/templates/reentrancy/ my-audit/tests/
Modifica MyContract.t.sol per importare il contratto sotto audit ed esegui:
forge test --match-contract MyContract
Aggiungi il workflow fornito al tuo repository:
# .github/workflows/audit.yml
name: EVM Audit
on:
push:
branches: [main]
pull_request:
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Foundry
run: curl -L https://foundry.paradigm.xyz | bash && foundryup
- name: Run Audit Suite
run: |
forge install
forge test -vv
forge script scripts/reentrancy_check.sol:ReentrancyChecker --rpc-url ${{ secrets.RPC_URL }}
forge script scripts/storage_analyzer.sol:StorageComparator --sig "compare(string,string)" storage.json reference.json
Il workflow segnalerà automaticamente gli errori e pubblicherà un report markdown come commento sulla PR.
Accogliamo con piacere i contributi! Segui questi passaggi:
git checkout -b feat/<nome>).forge coverage).npm run lint – utilizza solhint e prettier).pragma solidity ^0.8.20;snake_case per le funzioni interne, camelCase per quelle pubbliche/esterne.///).# Installa gli strumenti di linting
npm install
# Esegui solhint
npx solhint 'src/**/*.sol' 'test/**/*.sol'
# Formattazione automatica
npx prettier --write '**/*.sol'
evm-audit-helpers è distribuito sotto la Licenza MIT. Consulta il file LICENSE per i dettagli.
Buon audit!