Struct TempProject

pub struct TempProject<T: ArtifactOutput = ConfigurableArtifacts> { /* private fields */ }

Available on crate feature project-util only.

A Project wrapper that lives in a new temporary directory

Once TempProject is dropped, the temp dir is automatically removed, see TempDir::drop()

Implementations

impl<T: ArtifactOutput> TempProject<T>

pub fn create_new(root: TempDir, inner: Project<T>) -> Result<Self, SolcIoError>

Makes sure all resources are created

pub fn with_artifacts( paths: ProjectPathsConfigBuilder, artifacts: T, ) -> Result<Self>

Creates a new temp project using the provided paths and artifacts handler. sets the project root to a temp dir

pub fn prefixed_with_artifacts( prefix: &str, paths: ProjectPathsConfigBuilder, artifacts: T, ) -> Result<Self>

Creates a new temp project inside a tempdir with a prefixed directory and the given artifacts handler

pub fn with_settings(self, settings: impl Into<Settings>) -> Self

Overwrites the settings to pass to solc

pub fn set_solc(&mut self, solc: impl AsRef<str>) -> &mut Self

Available on crate feature svm-solc and non-WebAssembly only.

Explicitly sets the solc version for the project

pub fn project(&self) -> &Project<T>

pub fn compile(&self) -> Result<ProjectCompileOutput<T>>

pub fn compile_sparse<F: FileFilter + 'static>( &self, filter: F, ) -> Result<ProjectCompileOutput<T>>

pub fn flatten(&self, target: &Path) -> Result<String>

pub fn project_mut(&mut self) -> &mut Project<T>

pub fn paths(&self) -> &ProjectPathsConfig

The configured paths of the project

pub fn paths_mut(&mut self) -> &mut ProjectPathsConfig

The configured paths of the project

pub fn artifacts_path(&self) -> &PathBuf

Returns the path to the artifacts directory

pub fn sources_path(&self) -> &PathBuf

Returns the path to the sources directory

pub fn cache_path(&self) -> &PathBuf

Returns the path to the cache file

pub fn root(&self) -> &Path

The root path of the temporary workspace

pub fn copy_source(&self, source: impl AsRef<Path>) -> Result<()>

Copies a single file into the projects source

pub fn copy_sources<I, S>(&self, sources: I) -> Result<()>

where I: IntoIterator<Item = S>, S: AsRef<Path>,

pub fn copy_lib(&self, lib: impl AsRef<Path>) -> Result<()>

Copies a single file into the project’s main library directory

pub fn copy_libs<I, S>(&self, libs: I) -> Result<()>

where I: IntoIterator<Item = S>, S: AsRef<Path>,

Copy a series of files into the main library dir

pub fn add_lib( &self, name: impl AsRef<str>, content: impl AsRef<str>, ) -> Result<PathBuf>

Adds a new library file

pub fn add_basic_lib( &self, name: impl AsRef<str>, version: impl AsRef<str>, ) -> Result<PathBuf>

Adds a basic lib contract contract <name> {} as a new file

pub fn add_test( &self, name: impl AsRef<str>, content: impl AsRef<str>, ) -> Result<PathBuf>

Adds a new test file inside the project’s test dir

pub fn add_script( &self, name: impl AsRef<str>, content: impl AsRef<str>, ) -> Result<PathBuf>

Adds a new script file inside the project’s script dir

pub fn add_source( &self, name: impl AsRef<str>, content: impl AsRef<str>, ) -> Result<PathBuf>

Adds a new source file inside the project’s source dir

pub fn add_basic_source( &self, name: impl AsRef<str>, version: impl AsRef<str>, ) -> Result<PathBuf>

Adds a basic source contract contract <name> {} as a new file

pub fn add_contract( &self, name: impl AsRef<str>, content: impl AsRef<str>, ) -> Result<PathBuf>

Adds a solidity contract in the project’s root dir. This will also create all intermediary dirs.

pub fn artifacts_snapshot(&self) -> Result<ArtifactsSnapshot<T::Artifact>>

Returns a snapshot of all cached artifacts

pub fn mock( &self, gen: &MockProjectGenerator, version: impl AsRef<str>, ) -> Result<()>

Populate the project with mock files

pub fn ensure_no_errors(&self) -> Result<&Self>

Compiles the project and ensures that the output does not contain errors

pub fn ensure_unchanged(&self) -> Result<&Self>

Compiles the project and ensures that the output is unchanged

pub fn ensure_changed(&self) -> Result<&Self>

Compiles the project and ensures that the output has changed

pub fn ensure_no_errors_recompile_unchanged(&self) -> Result<&Self>

Compiles the project and ensures that the output does not contain errors and no changes exists on recompiled.

This is a convenience function for

use ethers_solc::project_util::TempProject;
let project = TempProject::dapptools().unwrap();

pub fn assert_no_errors_recompile_unchanged(&self) -> &Self

Compiles the project and asserts that the output does not contain errors and no changes exists on recompiled.

This is a convenience function for

use ethers_solc::project_util::TempProject;
let project = TempProject::dapptools().unwrap();

pub fn assert_no_errors(&self) -> &Self

Compiles the project and asserts that the output does not contain errors

pub fn assert_unchanged(&self) -> &Self

Compiles the project and asserts that the output is unchanged

pub fn assert_changed(&self) -> &Self

Compiles the project and asserts that the output is changed

pub fn list_source_files(&self) -> Vec<PathBuf>

Returns a list of all source files in the project’s src directory

impl<T: ArtifactOutput + Default> TempProject<T>

pub fn prefixed(prefix: &str, paths: ProjectPathsConfigBuilder) -> Result<Self>

Creates a new temp project inside a tempdir with a prefixed directory

pub fn with_style(prefix: &str, style: PathStyle) -> Result<Self>

Creates a new temp project for the given PathStyle

pub fn new(paths: ProjectPathsConfigBuilder) -> Result<Self>

Creates a new temp project using the provided paths and setting the project root to a temp dir

impl TempProject<HardhatArtifacts>

pub fn hardhat() -> Result<Self>

Creates an empty new hardhat style workspace in a new temporary dir

impl TempProject<ConfigurableArtifacts>

pub fn dapptools() -> Result<Self>

Creates an empty new dapptools style workspace in a new temporary dir

pub fn dapptools_init() -> Result<Self>

Creates an initialized dapptools style workspace in a new temporary dir

pub fn checkout(repo: impl AsRef<str>) -> Result<Self>

Clones the given repo into a temp dir, initializes it recursively and configures it.

Example

use ethers_solc::project_util::TempProject;
let project = TempProject::checkout("transmissions11/solmate").unwrap();

pub fn mocked( settings: &MockProjectSettings, version: impl AsRef<str>, ) -> Result<Self>

Create a new temporary project and populate it with mock files

use ethers_solc::project_util::mock::MockProjectSettings;
use ethers_solc::project_util::TempProject;
let tmp = TempProject::mocked(&MockProjectSettings::default(), "^0.8.10").unwrap();

pub fn mocked_random(version: impl AsRef<str>) -> Result<Self>

Create a new temporary project and populate it with a random layout

use ethers_solc::project_util::TempProject;
let tmp = TempProject::mocked_random("^0.8.10").unwrap();

This is a convenience function for:

use ethers_solc::project_util::mock::MockProjectSettings;
use ethers_solc::project_util::TempProject;
let tmp = TempProject::mocked(&MockProjectSettings::random(), "^0.8.10").unwrap();

Trait Implementations

impl<T: ArtifactOutput> AsRef<Project<T>> for TempProject<T>

fn as_ref(&self) -> &Project<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ArtifactOutput> Debug for TempProject<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.