Aderyn

🚀 Aderyn - 強大的Solidity靜態分析器

Aderyn是一款強大的Solidity靜態分析工具，它能讓你全面審視自己的智能合約，幫助協議工程師和安全研究人員發現Solidity代碼庫中的漏洞。

🚀 快速開始

你可以查看快速開始指南，其中還有視頻教程。

cd path/to/solidity/project/root
aderyn

這將生成一個report.md報告。

更多CLI選項的使用示例請參考這裡。

✨ 主要特性

• 原生支持Foundry項目。
• 原生支持Hardhat項目。（有時可能需要remappings.txt文件）
• 支持通過配置文件（adeyrn.toml）來適配自定義框架。
• 支持生成Markdown、JSON和Sarif格式的報告。

📦 安裝指南

⚠️ 重要提示

Windows用戶必須安裝WSL。

使用Cyfrinup

Cyfrinup是Cyfrin工具的跨平臺安裝管理器。

一次性設置。

運行aderyn --version來檢查安裝情況。

運行cyfrinup將所有工具升級到最新版本。

使用curl

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/cyfrin/aderyn/releases/latest/download/aderyn-installer.sh | bash

運行aderyn-update來升級舊版本。

使用Homebrew

brew install cyfrin/tap/aderyn

運行brew upgrade cyfrin/tap/aderyn來升級舊版本。

使用npm

npm install @cyfrin/aderyn -g

重新運行npm install @cyfrin/aderyn -g來升級舊版本。

如果你使用Curl、Homebrew或npm進行安裝，請確保你路徑中的Aderyn是來自Homebrew或npm全局包目錄的正確版本。如果~/.cyfrin/bin/aderyn存在舊版本，請使用rm -f ~/.cyfrin/bin/aderyn將其移除，因為這不再是默認的安裝位置。

📚 詳細文檔

你可以閱讀Cyfrin官方文檔來深入瞭解Aderyn的功能。

此外，還有官方支持的VSCode擴展。你可以從Visual Studio Marketplace下載該擴展，輕鬆識別Solidity代碼中的漏洞。

🔧 技術細節

Aderyn使得構建能夠適應任何Solidity代碼庫和協議的靜態分析檢測器變得簡單。本指南將教你如何構建、測試和運行自定義的Aderyn檢測器。 要了解如何創建自定義的Aderyn檢測器，請查看官方文檔。

📄 許可證

Aderyn是一款開源軟件，採用GPL - 3.0許可證。

如果你想幫助我們開發Aderyn，請參考我們的貢獻指南，其中包含詳細的開發環境設置和PR審批流程。

📝 致謝

本項目的成功離不開所有貢獻者的努力。

📌 參考來源

• AST訪問器代碼來自solc - ast - rs。
• 用於後端AST生成的Foundry編譯器foundry - compilers。
• 原始檢測器基於4naly3er的檢測器。
• 向靜態分析的先驅slither致敬。
• Solidity AST生成器solidity - ast - rs。