Repository files navigation

A powerful Solidity static analyzer that takes a bird's eye view over your smart contracts.

DocsDiscordTwitter

Aderyn is an open-source public good developer tool. It is a Rust-based solidity smart contract static analyzer designed to help protocol engineers and security researchers find vulnerabilities in Solidity code bases.

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

There is also an officially supportedVSCode extension for Aderyn. Download from theVisual Studio Marketplace and start identifying vulnerabilities in your Soliditycode with ease.

• Off the shelf support for Foundry projects.
• Off the shelf support for Hardhat projects. (Sometimesremappings.txt maybe required)
• Configuration file (adeyrn.toml) needed to support custom frameworks.
• Markdown, JSON and Sarif reports

NOTE Windows users must have WSL installed

Cyfrinup is the cross platform installation manager for Cyfrin tools.

One time setup.

Runaderyn --version to check the installation.

Runcyfrinup to upgrade everything to the latest version.

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

brew install cyfrin/tap/aderyn

npm install @cyfrin/aderyn -g

If you are installing with Curl or Homebrew or npm, ensure that 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 usingrm -f ~/.cyfrin/bin/aderyn, as this is no longer the default installation location.

Quick Start example with video guide.

cd path/to/solidity/project/rootaderyn

This generates areport.md

See examples using more CLI optionshere

Officially supportedVSCode extension for Aderyn.Download fromVisual Studio Marketplace

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

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,checkout the official docs

This project exists thanks to all the people whocontribute.

• AST Visitor code fromsolc-ast-rs.
• Foundry Compilers for backend AST generationfoundry-compilers
• Original detectors based on4naly3er detectors.
• Shoutout to the original king of static analysisslither.
• Solidity AST Generatorsolidity-ast-rs.