Skip to content

Fix: Template update #823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions aderyn/templates/aderyn.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,38 +11,40 @@ version = 1
root = "."

# Path of source directory containing the contracts, relative to root (above)
# Aderyn traverse all the nested files inside scanning for vulnerabilities
# If not specified, Aderyn will try to extract it from the framework that is being used. (Foundry / Hardhat)
# That would be "contracts/" in case of Hardhat and in case of Foundry, it depends on foundry.toml and
# many other factors like FOUNDRY_PROFILE environment variable used when starting VS Code, etc.
# Please feel free to always specify the values explicitly.
# Aderyn will traverse all the nested files inside to scan and report vulnerabilities found inside.
# - If not specified, Aderyn will try to extract it from the framework that is being used. (Foundry / Hardhat).
# That would be "contracts/" in case of Hardhat and in case of Foundry, it depends on foundry.toml and
# many other factors like FOUNDRY_PROFILE environment variable, etc.
# Example:
# src = "src/"

# Path segments of contract files to include in the analysis.
# It can be a partial match like "/interfaces/", which will include all files with "/interfaces/" in the file path.
# Or it can be a full match like "src/counters/Counter.sol", which will include only the file with the exact path.
# If not specified, all contract files in the source directory will be included.
# Example:
# - It can be a partial match like "/interfaces/", which will include all files with "/interfaces/" in the file path.
# Or it can be a full match like "src/counters/Counter.sol", which will include only the file with the exact path.
# - If not specified, all contract files in the source directory will be included.
# Examples:
# include = ["src/counters/Counter.sol", "src/others/"]
# include = ["/interfaces/"]

# Path segments of contract files to exclude in the analysis.
# It can be a partial match like "/interfaces/", which will exclude all files with "/interfaces/" in the file path.
# Or it can be a full match like "src/counters/Counter.sol", which will exclude only the file with the exact path.
# If not specified, no contract files will be excluded.
# Example:
# - It can be a partial match like "/interfaces/", which will exclude all files with "/interfaces/" in the file path.
# Or it can be a full match like "src/counters/Counter.sol", which will exclude only the file with the exact path.
# - If not specified, no contract files will be excluded.
# Examples:
# exclude = ["src/counters/Counter.sol", "src/others/"]
# exclude = ["/interfaces/"]

# Remappings used for compiling the contracts.
# If not specified, Aderyn will try to derive the values from foundry.toml (if present.)
# That would be the result of calling `foundry remappings`
# Example:
# remappings = ["@oz/contracts=lib/openzeppelin-contracts/contracts"]
# For advanced use cases, leverage the following

# Environment variables that would help aderyn detect src, etc.
# In a medium sized foundry project, the profile can determine the values to be read from `foundry.toml`. For example, if different profiles have different src declaration in `foundry.toml`, these env variables can help decide which ones to read.
# Remappings
# - It can be specified in `remappings.txt` within the root folder of the project.
# - If not specified, Aderyn will try to derive the values from foundry.toml (if present.)

# Environment
# - These are ususally all the FOUNDRY_, DAPP_ environment variables that are used during development.
# - For example, if different profiles have different `src` declaration in `foundry.toml`, FOUNDRY_PROFILE can dictate the correct `src` value.
# Env variables and their values can be specified below.

[env]
# FOUNDRY_PROFILE = "profile_name"
# Example:
# FOUNDRY_PROFILE = "default"
Loading