Struct Solc

pub struct Solc {
    pub solc: PathBuf,
    pub version: Version,
    pub base_path: Option<PathBuf>,
    pub allow_paths: BTreeSet<PathBuf>,
    pub include_paths: BTreeSet<PathBuf>,
    pub extra_args: Vec<String>,
}

Abstraction over solc command line utility

Supports sync and async functions.

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

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

Fields

solc: PathBuf

Path to the solc executable

version: Version

Compiler version.

base_path: Option<PathBuf>

Value for –base-path arg.

allow_paths: BTreeSet<PathBuf>

Value for –allow-paths arg.

include_paths: BTreeSet<PathBuf>

Value for –include-paths arg.

extra_args: Vec<String>

Additional arbitrary arguments.

Implementations

impl Solc

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

A new instance which points to solc. Invokes solc --version to determine the version.

Returns error if solc is not found in the system or if the version cannot be retrieved.

pub fn new_with_args( path: impl Into<PathBuf>, extra_args: impl IntoIterator<Item: Into<String>>, ) -> Result<Self>

A new instance which points to solc with additional cli arguments. Invokes solc --version to determine the version.

Returns error if solc is not found in the system or if the version cannot be retrieved.

pub fn new_with_version(path: impl Into<PathBuf>, version: Version) -> Self

A new instance which points to solc with the given version

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.

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

pub fn find_svm_installed_version(version: &Version) -> Result<Option<Self>>

Returns the path for a svm installed version.

Examples

use foundry_compilers::solc::Solc;
use semver::Version;

let solc = Solc::find_svm_installed_version(&Version::new(0, 8, 9))?;
assert_eq!(solc, Some(Solc::new("~/.svm/0.8.9/solc-0.8.9")?));

Ok::<_, Box<dyn std::error::Error>>(())

pub fn svm_home() -> Option<PathBuf>

Returns the directory in which svm stores all versions

This will be:

• ~/.svm on unix, if it exists
• $XDG_DATA_HOME (~/.local/share/svm) if the svm folder does not exist.

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

pub fn installed_versions() -> Vec<Version>

Returns the list of all solc instances installed at SVM_HOME

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

Convenience function for compiling all sources under the given path

pub fn compile_exact(&self, input: &SolcInput) -> 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.

Examples

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

Compiles with --standard-json and deserializes the output as CompilerOutput.

Examples

use foundry_compilers::{
    artifacts::{SolcInput, Source},
    compilers::{Compiler, CompilerInput},
    solc::Solc,
};

let solc = Solc::new("solc")?;
let input = SolcInput::resolve_and_build(
    Source::read_sol_yul_from("./contracts".as_ref()).unwrap(),
    Default::default(),
);
let output = solc.compile(&input)?;

pub fn compile_as<T: Serialize, D: DeserializeOwned>( &self, input: &T, ) -> Result<D>

Compiles with --standard-json and deserializes the output as the given D.

pub fn compile_output<T: Serialize>(&self, input: &T) -> Result<Vec<u8>>

Compiles with --standard-json and returns the raw stdout output.

pub fn version_short(&self) -> Version

Invokes solc --version and parses the output as a SemVer Version, stripping the pre-release and build metadata.

pub fn version(solc: impl Into<PathBuf>) -> Result<Version>

Invokes solc --version and parses the output as a SemVer Version.

pub fn version_with_args( solc: impl Into<PathBuf>, args: &[String], ) -> Result<Version>

Invokes solc --version and parses the output as a SemVer Version.

pub fn configure_cmd(&self) -> Command

Configures Command object depeending on settings and solc version used. Some features are only supported by newer versions of solc, so we have to disable them for older ones.

Trait Implementations

impl AsRef<Path> for Solc

fn as_ref(&self) -> &Path

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

impl Clone for Solc

fn clone(&self) -> Solc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Solc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Solc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Solc

fn cmp(&self, other: &Solc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Solc

fn eq(&self, other: &Solc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Solc

fn partial_cmp(&self, other: &Solc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Solc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Solc

impl StructuralPartialEq for Solc