Struct ethers_solc::Solc

source ·

pub struct Solc {
    pub solc: PathBuf,
    pub base_path: Option<PathBuf>,
    pub args: Vec<String>,
}

Expand description

Abstraction over solc command line utility

Supports sync and async functions.

By default the solc path is configured as follows, with descending priority:

SOLC_PATH environment variable
svm’s global_version (set via svm use <version>), stored at <svm_home>/.global_version
solc otherwise

Fields

solc: PathBuf

Path to the solc executable

base_path: Option<PathBuf>

The base path to set when invoking solc, see also https://docs.soliditylang.org/en/v0.8.11/path-resolution.html#base-path-and-include-paths

args: Vec<String>

Additional arguments passed to the solc exectuable

Implementations

source

impl Solc

source

pub fn new(path: impl Into<PathBuf>) -> Self

A new instance which points to solc

source

pub fn with_base_path(self, base_path: impl Into<PathBuf>) -> Self

Sets solc’s base path

Ref: https://docs.soliditylang.org/en/v0.8.11/path-resolution.html#base-path-and-include-paths

source

pub fn arg<T: Into<String>>(self, arg: T) -> Self

Adds an argument to pass to the solc command.

source

pub fn args<I, S>(self, args: I) -> Selfwhere
I: IntoIterator<Item = S>,
S: Into<String>,

Adds multiple arguments to pass to the solc.

source

pub fn svm_home() -> Option<PathBuf>

Returns the directory in which svm stores all versions

This will be ~/.svm on unix

source

pub fn svm_global_version() -> Option<Version>

Returns the semver::Version svm’s .global_version is currently set to. global_version is configured with (svm use <version>)

This will read the version string (eg: “0.8.9”) that the ~/.svm/.global_version file contains

source

pub fn installed_versions() -> Vec<SolcVersion> ⓘ

Returns the list of all solc instances installed at SVM_HOME

source

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

Returns the path for a svm installed version.

Example

 use ethers_solc::Solc;
let solc = Solc::find_svm_installed_version("0.8.9").unwrap();
assert_eq!(solc, Some(Solc::new("~/.svm/0.8.9/solc-0.8.9")));

source

pub fn find_matching_installation(
versions: &[Version],
required_version: &VersionReq
) -> Option<Version>

Assuming the versions array is sorted, it returns the first element which satisfies the provided VersionReq

source

pub fn source_version_req(source: &Source) -> Result<VersionReq>

Parses the given source looking for the pragma definition and returns the corresponding SemVer version requirement.

source

pub fn version_req(version: &str) -> Result<VersionReq>

Returns the corresponding SemVer version requirement for the solidity version

source

pub fn compile_source(&self, path: impl AsRef<Path>) -> Result<CompilerOutput>

Convenience function for compiling all sources under the given path

source

pub fn compile_exact(&self, input: &CompilerInput) -> Result<CompilerOutput>

Same as Self::compile(), but only returns those files which are included in the CompilerInput.

In other words, this removes those files from the CompilerOutput that are not included in the provided CompilerInput.

Example

 use ethers_solc::{CompilerInput, Solc};
let solc = Solc::default();
let input = CompilerInput::new("./contracts")?[0].clone();
let output = solc.compile_exact(&input)?;

source

pub fn compile<T: Serialize>(&self, input: &T) -> Result<CompilerOutput>

Run solc --stand-json and return the solc’s output as CompilerOutput

Example

 use ethers_solc::{CompilerInput, Solc};
let solc = Solc::default();
let input = CompilerInput::new("./contracts")?;
let output = solc.compile(&input)?;

source