Expand description
Β§foundry-config
Foundry configuration.
Re-exportsΒ§
pub use resolve::UnresolvedEnvVarError;
pub use fmt::FormatterConfig;
pub use lint::LinterConfig;
pub use lint::Severity as LintSeverity;
pub use fs_permissions::FsPermissions;
pub use error::SolidityErrorCode;
pub use doc::DocConfig;
pub use filter::SkipBuildFilters;
pub use providers::Remappings;
pub use figment;
pub use semver;
pub use utils::*;
ModulesΒ§
- bind_
json π - cache
- Support types for configuring storage caching
- compilation π
- doc
- Configuration specific to the
forge doc
command and theforge_doc
package - endpoints π
- Support for multiple RPC-endpoints
- error
- error handling and solc error codes
- etherscan π
- Support for multiple Etherscan keys.
- extend
- filter
- Helpers for constructing and using [FileFilter]s.
- fix
- Helpers to automatically fix configuration warnings.
- fmt
- Configuration specific to the
forge fmt
command and theforge_fmt
package - from_
opt_ πglob - Ser/de
globset::Glob
explicitly to handleOption<Glob>
properly - from_
str_ πlowercase - fs_
permissions - Support for controlling fs access
- fuzz π
- Configuration for fuzz testing.
- inline π
- invariant π
- Configuration for invariant testing
- lint
- Configuration specific to the
forge lint
command and theforge_lint
package - macros π
- providers
- Config providers.
- resolve
- Helper for resolving env vars
- serde_
regex π - soldeer
- Configuration specific to the
forge soldeer
command and theforge_soldeer
package - utils
- Utility functions
- vyper π
- Vyper specific configuration types.
- warning π
MacrosΒ§
- impl_
figment_ convert - A macro to implement converters from a type to
Config
and [figment::Figment
]. - impl_
figment_ convert_ basic - Same as
impl_figment_convert
but also impliesProvider
for the givenSerialize
type for convenience. TheProvider
only provides the βrootβ value for the current profile - impl_
figment_ convert_ cast - A macro to implement converters from a type to
Config
and [figment::Figment
]. - merge_
impl_ figment_ convert - Same as
impl_figment_convert
but also merges the type itself into the figment
StructsΒ§
- Basic
Config - A subset of the foundry
Config
used to initialize afoundry.toml
file - Chain
- Either a known
NamedChain
or a EIP-155 chain ID. - Compilation
Restrictions - Restrictions for compilation of given paths.
- Config
- Foundry configuration
- Fuzz
Config - Contains for fuzz testing
- Fuzz
Corpus Config - Fuzz
Dictionary Config - Contains for fuzz testing
- GasLimit
- Wrapper for the configβs
gas_limit
value necessary because toml-rs canβt handle larger number because integers are stored signed: https://github.com/alexcrichton/toml-rs/issues/256 - Inline
Config - Represents per-test configurations, declared inline as structured comments in Solidity test files. This allows to create configs directly bound to a solidity test.
- Inline
Config Error - Wrapper error struct that catches config parsing errors, enriching them with context information reporting the misconfigured line.
- Invariant
Config - Contains for invariant testing
- NatSpec
- Convenient struct to hold in-line per-test configurations
- Regex
Wrapper - Wrapper type for [
regex::Regex
] that implementsPartialEq
andserde
traits. - Resolved
RpcEndpoint - Rpc endpoint with environment variables resolved to values, see
RpcEndpoint::resolve
. - Resolved
RpcEndpoints - Container type for resolved endpoints.
- RpcEndpoint
- Rpc endpoint configuration variant
- RpcEndpoints
- Container type for API endpoints, like various RPC endpoints
- Settings
Overrides - Keeps possible overrides for default settings which users may configure to construct additional settings profile.
- Vyper
Config
EnumsΒ§
- Figment
Providers - Determines what providers should be used when loading the [
Figment
] for aConfig
. - Named
Chain - An Ethereum EIP-155 chain.
- RpcEndpoint
Url - Represents a single endpoint
- SolcReq
- Variants for selecting the [
Solc
] instance - Warning
- Warnings emitted during loading or managing Configuration
ConstantsΒ§
- DEPRECATIONS
- Deprecated keys and their replacements.
- STANDALONE_
FALLBACK_ SECTIONS - Mapping of fallback standalone sections. See
FallbackProfileProvider
.
FunctionsΒ§
- canonic π
- parse_
with_ profile - Parses a config profile
- root_
default π