Expand description
§Foundry Compilers
| Docs |
Originally part of ethers-rs as ethers-solc, Foundry Compilers is the compilation backend for Foundry.
ethers-rs’s ethers-solc is considered to be in maintenance mode, and any fixes to it will also be reflected on Foundry Compilers. No action is currently needed from devs, although we heavily recommend using Foundry Compilers instead of ethers-solc.
§Supported Rust Versions
Foundry Compilers will keep a rolling MSRV (minimum supported rust version) policy of at least 6 months. When increasing the MSRV, the new Rust version must have been released at least six months ago. The current MSRV is 1.83.0.
Note that the MSRV is not increased automatically, and only as part of a minor release.
§Contributing
Thanks for your help in improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the Foundry Compilers project.
Pull requests will not be merged unless CI passes, so please ensure that your contribution follows the linting rules and passes clippy.
§Overview
To install, simply add foundry-compilers to your cargo dependencies.
[dependencies]
foundry-compilers = "0.10.1"Example usage:
use foundry_compilers::{Project, ProjectPathsConfig};
use std::path::Path;
// configure the project with all its paths, solc, cache etc.
let project = Project::builder()
.paths(ProjectPathsConfig::hardhat(Path::new(env!("CARGO_MANIFEST_DIR"))).unwrap())
.build(Default::default())
.unwrap();
let output = project.compile().unwrap();
// Tell Cargo that if a source file changes, to rerun this build script.
project.rerun_if_sources_changed();Re-exports§
pub use resolver::Graph;pub use foundry_compilers_artifacts as artifacts;pub use compilers::*;
Modules§
- buildinfo
- Represents an entire build
- cache
- Support for compiling contracts.
- compilers
- contracts
- error
- flatten
- info
- Commonly used identifiers for contracts in the compiled output.
- many
- output
- The output of a compiled project
- project
- Manages compiling of a
Project - report
- Subscribe to events in the compiler pipeline
- resolver
- Resolution of the entire dependency graph for a project.
- sources
- utils
- Utility functions
Structs§
- Aggregated
Compiler Output - The aggregated output of (multiple) compile jobs
- Artifact
File - Represents an artifact file representing a
crate::compilers::CompilerContract - Artifact
Id - Represents unique artifact metadata for identifying artifacts on output
- Artifacts
- Represents a set of Artifacts
- Configurable
Artifacts - An
Artifactimplementation that can be configured to include additional content and emit additional files - Extra
Output Files - Determines what to emit as an additional file
- Extra
Output Values - Determines the additional values to include in the contract’s artifact file
- Hardhat
Artifacts - Hardhat style artifacts handler
- Minimal
Combined Artifacts - An
Artifactimplementation that uses a compact representation - Minimal
Combined Artifacts Hardhat Fallback - An Artifacts handler implementation that works the same as
MinimalCombinedArtifactsbut also supports reading hardhat artifacts if an initial attempt to deserialize an artifact failed - Output
Context - Additional context to use during
ArtifactOutput::on_output() - Project
- Represents a project workspace and handles
solccompiling of all contracts in that workspace. - Project
Builder - Project
Compile Output - Contains a mixture of already compiled/cached artifacts and the input set of sources that still need to be compiled.
- Project
Paths - This is a subset of ProjectPathsConfig that contains all relevant folders in the project
- Project
Paths Config - Where to find all files or where to write them
- Solc
Config - The config to use when compiling the contracts
- Test
File Filter - An FileFilter that matches all solidity files that end with
.t.sol
Enums§
- Path
Style - Sparse
Output Filter - A type that can apply a filter to a set of preprocessed Sources in order to set sparse output for specific files
Traits§
- Artifact
- A trait representation for a
crate::compilers::CompilerContractartifact - Artifact
Output - Handler invoked with the output of
solc - File
Filter - A predicate property that determines whether a file satisfies a certain condition
Functions§
- apply_
updates - Utility function to apply a set of updates to provided sources.
- replace_
source_ content - Utility function to change source content ranges with provided updates. Assumes that the updates are sorted.
Type Aliases§
- Updates
- Updates to be applied to the sources.