From 233053bfaf9de03084d94bbfc2f58fab53cb6b88 Mon Sep 17 00:00:00 2001 From: Tilak Madichetti Date: Mon, 10 Mar 2025 22:19:38 +0530 Subject: [PATCH] Fix: aderyn.toml Template update (#823) --- aderyn/templates/aderyn.toml | 44 +++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/aderyn/templates/aderyn.toml b/aderyn/templates/aderyn.toml index 3cea87c9..148afb71 100644 --- a/aderyn/templates/aderyn.toml +++ b/aderyn/templates/aderyn.toml @@ -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"