https://github.com/cyfrin/aderyn
Aderyn 🦜 Rust-based Solidity AST analyzer.
https://github.com/cyfrin/aderyn
abstract-syntax-tree rust solidity static-code-analyzer vulnerability-scanners
Last synced: 8 days ago
JSON representation
Aderyn 🦜 Rust-based Solidity AST analyzer.
- Host: GitHub
- URL: https://github.com/cyfrin/aderyn
- Owner: Cyfrin
- License: gpl-2.0
- Created: 2023-08-26T14:43:32.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2025-04-10T05:32:15.000Z (12 days ago)
- Last Synced: 2025-04-10T05:34:32.859Z (12 days ago)
- Topics: abstract-syntax-tree, rust, solidity, static-code-analyzer, vulnerability-scanners
- Language: Rust
- Homepage: https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/readme
- Size: 26.5 MB
- Stars: 490
- Watchers: 6
- Forks: 76
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
A powerful Solidity static analyzer that takes a bird's eye view over your smart contracts.
---
[![Stargazers][stars-shield]][stars-url] [![Forks][forks-shield]][forks-url]
[![Contributors][contributors-shield]][contributors-url]
[![Issues][issues-shield]][issues-url]
[![GPL-3.0 License][license-shield]][license-url]
## 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](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/readme) for an in-depth look at Aderyn's functionalities.
There is also an officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) for Aderyn. Download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Cyfrin.aderyn&ssr=false#overview) and start identifying vulnerabilities in your Solidity code with ease.
## Features
- Off the shelf support for Foundry projects.
- Off the shelf support for Hardhat projects. (Sometimes `remappings.txt` maybe required)
- Configuration file (`adeyrn.toml`) needed to support custom frameworks.
- Markdown, JSON and Sarif reports
## Installation
> **NOTE** Windows users must have WSL installed
### Using Cyfrinup
**Cyfrinup** is the cross platform installation manager for Cyfrin tools.
[One time setup](https://github.com/Cyfrin/up).
Run `aderyn --version` to check the installation.
Run `cyfrinup` to upgrade everything to the latest version.
---
### Using curl
```sh
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
```sh
brew install cyfrin/tap/aderyn
```
##### Upgrade older versions by running: `brew upgrade cyfrin/tap/aderyn`
---
### Using npm
```sh
npm install @cyfrin/aderyn -g
```
##### Upgrade older versions by (re)running: `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 using `rm -f ~/.cyfrin/bin/aderyn`, as this is no longer the default installation location.
## Quick Start
[Quick Start](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/quickstart) example with video guide.
```
cd path/to/solidity/project/root
aderyn
```
This generates a [report.md](https://github.com/Cyfrin/aderyn/blob/dev/reports/report.md)
See examples using more CLI options [here](https://cyfrin.gitbook.io/cyfrin-docs/cli-options)
## VS Code extension
Officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) for Aderyn.
Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Cyfrin.aderyn&ssr=false#overview)
## Contributing & License
Help us build Aderyn 🦜 Please see our [contribution guidelines](./CONTRIBUTING.md) for in-depth developer environment setup and PR approval process.
Aderyn is an open-source software licensed under the [GPL-3.0 License](./LICENSE).
## Building a custom Aderyn detector
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](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/detectors-quickstart)
## Credits
This project exists thanks to all the people who [contribute](/CONTRIBUTING.md).
## Attribution
- AST Visitor code from [solc-ast-rs](https://github.com/hrkrshnn/solc-ast-rs).
- Foundry Compilers for backend AST generation [foundry-compilers](https://github.com/foundry-rs/compilers)
- Original detectors based on [4naly3er](https://github.com/Picodes/4naly3er) detectors.
- Shoutout to the original king of static analysis [slither](https://github.com/crytic/slither).
- Solidity AST Generator [solidity-ast-rs](https://github.com/Cyfrin/solidity-ast-rs).
[contributors-shield]: https://img.shields.io/github/contributors/cyfrin/aderyn
[contributors-url]: https://github.com/cyfrin/aderyn/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/cyfrin/aderyn
[forks-url]: https://github.com/cyfrin/aderyn/network/members
[stars-shield]: https://img.shields.io/github/stars/cyfrin/aderyn
[stars-url]: https://github.com/cyfrin/aderyn/stargazers
[issues-shield]: https://img.shields.io/github/issues/cyfrin/aderyn
[issues-url]: https://github.com/cyfrin/aderyn/issues
[license-shield]: https://img.shields.io/github/license/cyfrin/aderyn?logoColor=%23fff&color=blue
[license-url]: https://github.com/cyfrin/aderyn/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555