Aderyn

🚀 Aderyn - A Powerful Solidity Static Analyzer

Aderyn is an open - source public good developer tool. It's a Rust - based Solidity smart contract static analyzer that helps protocol engineers and security researchers find vulnerabilities in Solidity code bases.

🚀 Quick Start

Check out the Quick Start example with a video guide.

cd path/to/solidity/project/root
aderyn

This will generate a report.md.

You can see examples using more CLI options here.

✨ Features

• Off - the - shelf support for Foundry projects.
• Off - the - shelf support for Hardhat projects. (Sometimes remappings.txt may be required)
• A configuration file (adeyrn.toml) is needed to support custom frameworks.
• Markdown, JSON and Sarif reports

📦 Installation

⚠️ Important Note

Windows users must have WSL installed.

Using Cyfrinup

Cyfrinup is the cross - platform installation manager for Cyfrin tools.

Do the one - time setup.

Run aderyn --version to check the installation.

Run cyfrinup to upgrade everything to the latest version.

Using curl

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

Upgrade older versions by running: aderyn - update

Using Homebrew

brew install cyfrin/tap/aderyn

Upgrade older versions by running: brew upgrade cyfrin/tap/aderyn

Using npm

npm install @cyfrin/aderyn -g

Upgrade older versions by (re)running: npm install @cyfrin/aderyn -g

If you are installing with Curl, Homebrew, or npm, make sure the correct version of Aderyn in your path comes from either the Homebrew or npm global packages directory. If an older version exists at ~/.cyfrin/bin/aderyn, remove it using rm -f ~/.cyfrin/bin/aderyn, as this is no longer the default installation location.

💻 Usage Examples

Basic Usage

cd path/to/solidity/project/root
aderyn

📚 Documentation

You can read the Cyfrin official documentation for an in - depth look at Aderyn's functionalities.

There is also an officially supported VSCode extension for Aderyn. Download it from the Visual Studio Marketplace and start identifying vulnerabilities in your Solidity code with ease.

🔧 Technical Details

Aderyn makes it easy to build Static Analysis detectors that can adapt to any Solidity codebase and protocol. This guide will teach you how to build, test, and run your custom Aderyn detectors. To learn how to create your custom Aderyn detectors, check out the official docs

📄 License

Help us build Aderyn 🦜 Please see our contribution guidelines for in - depth developer environment setup and PR approval process. Aderyn is an open - source software licensed under the GPL - 3.0 License.

Credits

This project exists thanks to all the people who contribute.

Attribution

• AST Visitor code from solc - ast - rs.
• Foundry Compilers for backend AST generation foundry - compilers
• Original detectors based on 4naly3er detectors.
• Shoutout to the original king of static analysis slither.
• Solidity AST Generator solidity - ast - rs.