aderyn

<p align="center"> <br /> <a href="https://cyfrin.io/"> <img src="https://github.com/Cyfrin/aderyn/blob/dev/.github/images/aderyn_logo.png" width="400" alt=""/></a> <br /> </p> <p align="center"><strong>A powerful Solidity static analyzer that takes a bird's eye view over your smart contracts. </strong></p> <p align="center"> <br /> <a href="https://cyfrin.io/"> <img src="https://github.com/Cyfrin/aderyn/blob/dev/.github/images/poweredbycyfrinblue.png" width="145" alt=""/></a> <br /> </p> <p align="center"> <a href="https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/readme">Docs</a> <a href="https://discord.gg/cyfrin">Discord</a> <a href="https://x.com/cyfrin">X/Twitter</a> <p>

---

<div align="center">

[![Stargazers][stars-shield]][stars-url] [![Forks][forks-shield]][forks-url] [![Contributors][contributors-shield]][contributors-url] [![Release][release-shield]][release-url] [![Issues][issues-shield]][issues-url] [![GPL-3.0 License][license-shield]][license-url]

</div>

What is Aderyn?

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 the Cyfrin official documentation for an in-depth look at Aderyn's functionalities.

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

Features

• Runs without need for any configuration support for Foundry and Hardhat projects.
• Creates Markdown, JSON and Sarif reports.
• Powers our officially supported VSCode extension (1800+ downloads)
• List of supported detectors
• Contributor Friendly
• Downloaded more than 45K times.

Installation

NOTE Windows users must have WSL installed

Cyfrinup - All in one cross platform installation manager for Cyfrin tools.

One time setup. - Run cyfrinup

Re-run cyfrinup to upgrade all Cyfrin tools to the latest version.

Curl

Once installed, run aderyn-update to upgrade.

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

Homebrew

Once installed, run brew upgrade cyfrin/tap/aderyn to upgrade.

brew install cyfrin/tap/aderyn

npm

Once installed, re-run npm install @cyfrin/aderyn -g to upgrade.

npm install @cyfrin/aderyn -g

If you are installing with Curl or Homebrew or npm, ensure that the correct version of Aderyn in your pa...