foundry_compilers/compilers/solc/
compiler.rs

1use crate::resolver::parse::SolData;
2use foundry_compilers_artifacts::{sources::Source, CompilerOutput, SolcInput};
3use foundry_compilers_core::{
4    error::{Result, SolcError},
5    utils::{SUPPORTS_BASE_PATH, SUPPORTS_INCLUDE_PATH},
6};
7use itertools::Itertools;
8use semver::{Version, VersionReq};
9use serde::{de::DeserializeOwned, Deserialize, Serialize};
10use std::{
11    collections::BTreeSet,
12    io::{self, Write},
13    path::{Path, PathBuf},
14    process::{Command, Output, Stdio},
15    str::FromStr,
16};
17
18/// Extensions acceptable by solc compiler.
19pub const SOLC_EXTENSIONS: &[&str] = &["sol", "yul"];
20
21/// take the lock in tests, we use this to enforce that
22/// a test does not run while a compiler version is being installed
23///
24/// This ensures that only one thread installs a missing `solc` exe.
25/// Instead of taking this lock in `Solc::blocking_install`, the lock should be taken before
26/// installation is detected.
27#[cfg(feature = "svm-solc")]
28#[cfg(any(test, feature = "test-utils"))]
29#[macro_export]
30macro_rules! take_solc_installer_lock {
31    ($lock:ident) => {
32        let lock_path = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join(".lock");
33        let lock_file = std::fs::OpenOptions::new()
34            .read(true)
35            .write(true)
36            .create(true)
37            .truncate(false)
38            .open(lock_path)
39            .unwrap();
40        let mut lock = fd_lock::RwLock::new(lock_file);
41        let $lock = lock.write().unwrap();
42    };
43}
44
45/// A list of upstream Solc releases, used to check which version
46/// we should download.
47/// The boolean value marks whether there was an error accessing the release list
48#[cfg(feature = "svm-solc")]
49pub static RELEASES: std::sync::LazyLock<(svm::Releases, Vec<Version>, bool)> =
50    std::sync::LazyLock::new(|| {
51        match serde_json::from_str::<svm::Releases>(svm_builds::RELEASE_LIST_JSON) {
52            Ok(releases) => {
53                let sorted_versions = releases.clone().into_versions();
54                (releases, sorted_versions, true)
55            }
56            Err(err) => {
57                error!("failed to deserialize SVM static RELEASES JSON: {err}");
58                Default::default()
59            }
60        }
61    });
62
63/// Abstraction over `solc` command line utility
64///
65/// Supports sync and async functions.
66///
67/// By default the solc path is configured as follows, with descending priority:
68///   1. `SOLC_PATH` environment variable
69///   2. [svm](https://github.com/roynalnaruto/svm-rs)'s  `global_version` (set via `svm use
70///      <version>`), stored at `<svm_home>/.global_version`
71///   3. `solc` otherwise
72#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
73pub struct Solc {
74    /// Path to the `solc` executable
75    pub solc: PathBuf,
76    /// Compiler version.
77    pub version: Version,
78    /// Value for --base-path arg.
79    pub base_path: Option<PathBuf>,
80    /// Value for --allow-paths arg.
81    pub allow_paths: BTreeSet<PathBuf>,
82    /// Value for --include-paths arg.
83    pub include_paths: BTreeSet<PathBuf>,
84    /// Additional arbitrary arguments.
85    pub extra_args: Vec<String>,
86}
87
88impl Solc {
89    /// A new instance which points to `solc`. Invokes `solc --version` to determine the version.
90    ///
91    /// Returns error if `solc` is not found in the system or if the version cannot be retrieved.
92    #[instrument(name = "Solc::new", skip_all)]
93    pub fn new(path: impl Into<PathBuf>) -> Result<Self> {
94        Self::new_with_args(path, Vec::<String>::new())
95    }
96
97    /// A new instance which points to `solc` with additional cli arguments. Invokes `solc
98    /// --version` to determine the version.
99    ///
100    /// Returns error if `solc` is not found in the system or if the version cannot be retrieved.
101    pub fn new_with_args(
102        path: impl Into<PathBuf>,
103        extra_args: impl IntoIterator<Item: Into<String>>,
104    ) -> Result<Self> {
105        let path = path.into();
106        let extra_args = extra_args.into_iter().map(Into::into).collect::<Vec<_>>();
107        let version = Self::version_with_args(path.clone(), &extra_args)?;
108        Ok(Self::_new(path, version, extra_args))
109    }
110
111    /// A new instance which points to `solc` with the given version
112    pub fn new_with_version(path: impl Into<PathBuf>, version: Version) -> Self {
113        Self::_new(path.into(), version, Default::default())
114    }
115
116    fn _new(path: PathBuf, version: Version, extra_args: Vec<String>) -> Self {
117        let this = Self {
118            solc: path,
119            version,
120            base_path: None,
121            allow_paths: Default::default(),
122            include_paths: Default::default(),
123            extra_args,
124        };
125        this.debug_assert();
126        this
127    }
128
129    fn debug_assert(&self) {
130        if !cfg!(debug_assertions) {
131            return;
132        }
133        if let Ok(v) = Self::version_with_args(&self.solc, &self.extra_args) {
134            assert_eq!(v.major, self.version.major);
135            assert_eq!(v.minor, self.version.minor);
136            assert_eq!(v.patch, self.version.patch);
137        }
138    }
139
140    /// Parses the given source looking for the `pragma` definition and
141    /// returns the corresponding SemVer version requirement.
142    pub fn source_version_req(source: &Source) -> Result<VersionReq> {
143        Ok(SolData::parse_version_pragma(&source.content).ok_or(SolcError::PragmaNotFound)??)
144    }
145
146    /// Given a Solidity source, it detects the latest compiler version which can be used
147    /// to build it, and returns it.
148    ///
149    /// If the required compiler version is not installed, it also proceeds to install it.
150    #[cfg(feature = "svm-solc")]
151    pub fn detect_version(source: &Source) -> Result<Version> {
152        // detects the required solc version
153        let sol_version = Self::source_version_req(source)?;
154        Self::ensure_installed(&sol_version)
155    }
156
157    /// Given a Solidity version requirement, it detects the latest compiler version which can be
158    /// used to build it, and returns it.
159    ///
160    /// If the required compiler version is not installed, it also proceeds to install it.
161    #[cfg(feature = "svm-solc")]
162    pub fn ensure_installed(sol_version: &VersionReq) -> Result<Version> {
163        #[cfg(test)]
164        take_solc_installer_lock!(_lock);
165
166        // load the local / remote versions
167        let versions = Self::installed_versions();
168
169        let local_versions = Self::find_matching_installation(&versions, sol_version);
170        let remote_versions = Self::find_matching_installation(&RELEASES.1, sol_version);
171
172        // if there's a better upstream version than the one we have, install it
173        Ok(match (local_versions, remote_versions) {
174            (Some(local), None) => local,
175            (Some(local), Some(remote)) => {
176                if remote > local {
177                    Self::blocking_install(&remote)?;
178                    remote
179                } else {
180                    local
181                }
182            }
183            (None, Some(version)) => {
184                Self::blocking_install(&version)?;
185                version
186            }
187            // do nothing otherwise
188            _ => return Err(SolcError::VersionNotFound),
189        })
190    }
191
192    /// Assuming the `versions` array is sorted, it returns the first element which satisfies
193    /// the provided [`VersionReq`]
194    pub fn find_matching_installation(
195        versions: &[Version],
196        required_version: &VersionReq,
197    ) -> Option<Version> {
198        // iterate in reverse to find the last match
199        versions.iter().rev().find(|version| required_version.matches(version)).cloned()
200    }
201
202    /// Returns the path for a [svm](https://github.com/roynalnaruto/svm-rs) installed version.
203    ///
204    /// # Examples
205    ///
206    /// ```no_run
207    /// use foundry_compilers::solc::Solc;
208    /// use semver::Version;
209    ///
210    /// let solc = Solc::find_svm_installed_version(&Version::new(0, 8, 9))?;
211    /// assert_eq!(solc, Some(Solc::new("~/.svm/0.8.9/solc-0.8.9")?));
212    ///
213    /// Ok::<_, Box<dyn std::error::Error>>(())
214    /// ```
215    #[instrument(skip_all)]
216    #[cfg(feature = "svm-solc")]
217    pub fn find_svm_installed_version(version: &Version) -> Result<Option<Self>> {
218        let version = Version::new(version.major, version.minor, version.patch);
219        let solc = svm::version_binary(&version.to_string());
220        if !solc.is_file() {
221            return Ok(None);
222        }
223        Ok(Some(Self::new_with_version(&solc, version)))
224    }
225
226    /// Returns the directory in which [svm](https://github.com/roynalnaruto/svm-rs) stores all versions
227    ///
228    /// This will be:
229    /// - `~/.svm` on unix, if it exists
230    /// - $XDG_DATA_HOME (~/.local/share/svm) if the svm folder does not exist.
231    #[cfg(feature = "svm-solc")]
232    pub fn svm_home() -> Option<PathBuf> {
233        Some(svm::data_dir().to_path_buf())
234    }
235
236    /// Returns the `semver::Version` [svm](https://github.com/roynalnaruto/svm-rs)'s `.global_version` is currently set to.
237    ///  `global_version` is configured with (`svm use <version>`)
238    ///
239    /// This will read the version string (eg: "0.8.9") that the  `~/.svm/.global_version` file
240    /// contains
241    #[cfg(feature = "svm-solc")]
242    pub fn svm_global_version() -> Option<Version> {
243        svm::get_global_version().ok().flatten()
244    }
245
246    /// Returns the list of all solc instances installed at `SVM_HOME`
247    #[cfg(feature = "svm-solc")]
248    pub fn installed_versions() -> Vec<Version> {
249        svm::installed_versions().unwrap_or_default()
250    }
251
252    /// Returns the list of all versions that are available to download
253    #[cfg(feature = "svm-solc")]
254    pub fn released_versions() -> Vec<Version> {
255        RELEASES.1.clone()
256    }
257
258    /// Installs the provided version of Solc in the machine under the svm dir and returns the
259    /// [Solc] instance pointing to the installation.
260    ///
261    /// # Examples
262    ///
263    /// ```no_run
264    /// use foundry_compilers::{solc::Solc, utils::ISTANBUL_SOLC};
265    ///
266    /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
267    /// let solc = Solc::install(&ISTANBUL_SOLC).await?;
268    /// # Ok(())
269    /// # }
270    /// ```
271    #[cfg(feature = "svm-solc")]
272    #[instrument(name = "Solc::install", skip_all)]
273    pub async fn install(version: &Version) -> std::result::Result<Self, svm::SvmError> {
274        trace!("installing solc version \"{}\"", version);
275        crate::report::solc_installation_start(version);
276        match svm::install(version).await {
277            Ok(path) => {
278                crate::report::solc_installation_success(version);
279                Ok(Self::new_with_version(path, version.clone()))
280            }
281            Err(err) => {
282                crate::report::solc_installation_error(version, &err.to_string());
283                Err(err)
284            }
285        }
286    }
287
288    /// Blocking version of `Self::install`
289    #[cfg(feature = "svm-solc")]
290    #[instrument(name = "Solc::blocking_install", skip_all)]
291    pub fn blocking_install(version: &Version) -> std::result::Result<Self, svm::SvmError> {
292        use foundry_compilers_core::utils::RuntimeOrHandle;
293
294        #[cfg(test)]
295        crate::take_solc_installer_lock!(_lock);
296
297        let version = if version.pre.is_empty() {
298            Version::new(version.major, version.minor, version.patch)
299        } else {
300            // Preserve version if it is a prerelease.
301            version.clone()
302        };
303
304        trace!("blocking installing solc version \"{}\"", version);
305        crate::report::solc_installation_start(&version);
306        // The async version `svm::install` is used instead of `svm::blocking_install`
307        // because the underlying `reqwest::blocking::Client` does not behave well
308        // inside of a Tokio runtime. See: https://github.com/seanmonstar/reqwest/issues/1017
309        match RuntimeOrHandle::new().block_on(svm::install(&version)) {
310            Ok(path) => {
311                crate::report::solc_installation_success(&version);
312                Ok(Self::new_with_version(path, version.clone()))
313            }
314            Err(err) => {
315                crate::report::solc_installation_error(&version, &err.to_string());
316                Err(err)
317            }
318        }
319    }
320
321    /// Verify that the checksum for this version of solc is correct. We check against the SHA256
322    /// checksum from the build information published by [binaries.soliditylang.org](https://binaries.soliditylang.org/)
323    #[cfg(feature = "svm-solc")]
324    #[instrument(name = "Solc::verify_checksum", skip_all)]
325    pub fn verify_checksum(&self) -> Result<()> {
326        let version = self.version_short();
327        let mut version_path = svm::version_path(version.to_string().as_str());
328        version_path.push(format!("solc-{}", version.to_string().as_str()));
329        trace!(target:"solc", "reading solc binary for checksum {:?}", version_path);
330        let content =
331            std::fs::read(&version_path).map_err(|err| SolcError::io(err, version_path.clone()))?;
332
333        if !RELEASES.2 {
334            // we skip checksum verification because the underlying request to fetch release info
335            // failed so we have nothing to compare against
336            return Ok(());
337        }
338
339        #[cfg(windows)]
340        {
341            // Prior to 0.7.2, binaries are released as exe files which are hard to verify: <https://github.com/foundry-rs/foundry/issues/5601>
342            // <https://binaries.soliditylang.org/windows-amd64/list.json>
343            const V0_7_2: Version = Version::new(0, 7, 2);
344            if version < V0_7_2 {
345                return Ok(());
346            }
347        }
348
349        use sha2::Digest;
350        let mut hasher = sha2::Sha256::new();
351        hasher.update(content);
352        let checksum_calc = &hasher.finalize()[..];
353
354        let checksum_found = &RELEASES
355            .0
356            .get_checksum(&version)
357            .ok_or_else(|| SolcError::ChecksumNotFound { version: version.clone() })?;
358
359        if checksum_calc == checksum_found {
360            Ok(())
361        } else {
362            use alloy_primitives::hex;
363            let expected = hex::encode(checksum_found);
364            let detected = hex::encode(checksum_calc);
365            warn!(target: "solc", "checksum mismatch for {:?}, expected {}, but found {} for file {:?}", version, expected, detected, version_path);
366            Err(SolcError::ChecksumMismatch { version, expected, detected, file: version_path })
367        }
368    }
369
370    /// Convenience function for compiling all sources under the given path
371    pub fn compile_source(&self, path: &Path) -> Result<CompilerOutput> {
372        let mut res: CompilerOutput = Default::default();
373        for input in
374            SolcInput::resolve_and_build(Source::read_sol_yul_from(path)?, Default::default())
375        {
376            let input = input.sanitized(&self.version);
377            let output = self.compile(&input)?;
378            res.merge(output)
379        }
380
381        Ok(res)
382    }
383
384    /// Same as [`Self::compile()`], but only returns those files which are included in the
385    /// `CompilerInput`.
386    ///
387    /// In other words, this removes those files from the `CompilerOutput` that are __not__ included
388    /// in the provided `CompilerInput`.
389    ///
390    /// # Examples
391    pub fn compile_exact(&self, input: &SolcInput) -> Result<CompilerOutput> {
392        let mut out = self.compile(input)?;
393        out.retain_files(input.sources.keys().map(|p| p.as_path()));
394        Ok(out)
395    }
396
397    /// Compiles with `--standard-json` and deserializes the output as [`CompilerOutput`].
398    ///
399    /// # Examples
400    ///
401    /// ```no_run
402    /// use foundry_compilers::{
403    ///     artifacts::{SolcInput, Source},
404    ///     compilers::{Compiler, CompilerInput},
405    ///     solc::Solc,
406    /// };
407    ///
408    /// let solc = Solc::new("solc")?;
409    /// let input = SolcInput::resolve_and_build(
410    ///     Source::read_sol_yul_from("./contracts".as_ref()).unwrap(),
411    ///     Default::default(),
412    /// );
413    /// let output = solc.compile(&input)?;
414    /// # Ok::<_, Box<dyn std::error::Error>>(())
415    /// ```
416    pub fn compile<T: Serialize>(&self, input: &T) -> Result<CompilerOutput> {
417        self.compile_as(input)
418    }
419
420    /// Compiles with `--standard-json` and deserializes the output as the given `D`.
421    #[instrument(name = "Solc::compile", skip_all)]
422    pub fn compile_as<T: Serialize, D: DeserializeOwned>(&self, input: &T) -> Result<D> {
423        let output = self.compile_output(input)?;
424
425        // Only run UTF-8 validation once.
426        let output = std::str::from_utf8(&output).map_err(|_| SolcError::InvalidUtf8)?;
427
428        Ok(serde_json::from_str(output)?)
429    }
430
431    /// Compiles with `--standard-json` and returns the raw `stdout` output.
432    #[instrument(name = "Solc::compile_raw", skip_all)]
433    pub fn compile_output<T: Serialize>(&self, input: &T) -> Result<Vec<u8>> {
434        let mut cmd = self.configure_cmd();
435
436        trace!(input=%serde_json::to_string(input).unwrap_or_else(|e| e.to_string()));
437        debug!(?cmd, "compiling");
438
439        let mut child = cmd.spawn().map_err(self.map_io_err())?;
440        debug!("spawned");
441
442        {
443            let mut stdin = io::BufWriter::new(child.stdin.take().unwrap());
444            serde_json::to_writer(&mut stdin, input)?;
445            stdin.flush().map_err(self.map_io_err())?;
446        }
447        debug!("wrote JSON input to stdin");
448
449        let output = child.wait_with_output().map_err(self.map_io_err())?;
450        debug!(%output.status, output.stderr = ?String::from_utf8_lossy(&output.stderr), "finished");
451
452        compile_output(output)
453    }
454
455    /// Returns the SemVer [`Version`], stripping the pre-release and build metadata.
456    pub fn version_short(&self) -> Version {
457        Version::new(self.version.major, self.version.minor, self.version.patch)
458    }
459
460    /// Invokes `solc --version` and parses the output as a SemVer [`Version`].
461    pub fn version(solc: impl Into<PathBuf>) -> Result<Version> {
462        Self::version_with_args(solc, &[])
463    }
464
465    /// Invokes `solc --version` and parses the output as a SemVer [`Version`].
466    pub fn version_with_args(solc: impl Into<PathBuf>, args: &[String]) -> Result<Version> {
467        crate::cache_version(solc.into(), args, |solc| Self::version_impl(solc, args))
468    }
469
470    fn version_impl(solc: &Path, args: &[String]) -> Result<Version> {
471        let mut cmd = Command::new(solc);
472        cmd.args(args)
473            .arg("--version")
474            .stdin(Stdio::piped())
475            .stderr(Stdio::piped())
476            .stdout(Stdio::piped());
477        debug!(?cmd, "getting Solc version");
478        let output = cmd.output().map_err(|e| SolcError::io(e, solc))?;
479        trace!(?output);
480        let version = version_from_output(output)?;
481        debug!(%version);
482        Ok(version)
483    }
484
485    fn map_io_err(&self) -> impl FnOnce(std::io::Error) -> SolcError + '_ {
486        move |err| SolcError::io(err, &self.solc)
487    }
488
489    /// Configures [Command] object depending on settings and solc version used.
490    /// Some features are only supported by newer versions of solc, so we have to disable them for
491    /// older ones.
492    pub fn configure_cmd(&self) -> Command {
493        let mut cmd = Command::new(&self.solc);
494        cmd.stdin(Stdio::piped()).stderr(Stdio::piped()).stdout(Stdio::piped());
495        cmd.args(&self.extra_args);
496
497        if !self.allow_paths.is_empty() {
498            cmd.arg("--allow-paths");
499            cmd.arg(self.allow_paths.iter().map(|p| p.display()).join(","));
500        }
501        if let Some(base_path) = &self.base_path {
502            if SUPPORTS_BASE_PATH.matches(&self.version) {
503                if SUPPORTS_INCLUDE_PATH.matches(&self.version) {
504                    // `--base-path` and `--include-path` conflict if set to the same path, so
505                    // as a precaution, we ensure here that the `--base-path` is not also used
506                    // for `--include-path`
507                    for path in
508                        self.include_paths.iter().filter(|p| p.as_path() != base_path.as_path())
509                    {
510                        cmd.arg("--include-path").arg(path);
511                    }
512                }
513
514                cmd.arg("--base-path").arg(base_path);
515            }
516
517            cmd.current_dir(base_path);
518        }
519
520        cmd.arg("--standard-json");
521
522        cmd
523    }
524
525    /// Either finds an installed Solc version or installs it if it's not found.
526    #[cfg(feature = "svm-solc")]
527    pub fn find_or_install(version: &Version) -> Result<Self> {
528        let solc = if let Some(solc) = Self::find_svm_installed_version(version)? {
529            solc
530        } else {
531            Self::blocking_install(version)?
532        };
533
534        Ok(solc)
535    }
536}
537
538#[cfg(feature = "async")]
539impl Solc {
540    /// Convenience function for compiling all sources under the given path
541    pub async fn async_compile_source(&self, path: &Path) -> Result<CompilerOutput> {
542        self.async_compile(&SolcInput::resolve_and_build(
543            Source::async_read_all_from(path, SOLC_EXTENSIONS).await?,
544            Default::default(),
545        ))
546        .await
547    }
548
549    /// Run `solc --stand-json` and return the `solc`'s output as
550    /// `CompilerOutput`
551    pub async fn async_compile<T: Serialize>(&self, input: &T) -> Result<CompilerOutput> {
552        self.async_compile_as(input).await
553    }
554
555    /// Run `solc --stand-json` and return the `solc`'s output as the given json
556    /// output
557    pub async fn async_compile_as<T: Serialize, D: DeserializeOwned>(
558        &self,
559        input: &T,
560    ) -> Result<D> {
561        let output = self.async_compile_output(input).await?;
562        Ok(serde_json::from_slice(&output)?)
563    }
564
565    pub async fn async_compile_output<T: Serialize>(&self, input: &T) -> Result<Vec<u8>> {
566        use tokio::{io::AsyncWriteExt, process::Command};
567
568        let mut cmd: Command = self.configure_cmd().into();
569        let mut child = cmd.spawn().map_err(self.map_io_err())?;
570        let stdin = child.stdin.as_mut().unwrap();
571
572        let content = serde_json::to_vec(input)?;
573
574        stdin.write_all(&content).await.map_err(self.map_io_err())?;
575        stdin.flush().await.map_err(self.map_io_err())?;
576
577        compile_output(child.wait_with_output().await.map_err(self.map_io_err())?)
578    }
579
580    pub async fn async_version(solc: &Path) -> Result<Version> {
581        let mut cmd = tokio::process::Command::new(solc);
582        cmd.arg("--version").stdin(Stdio::piped()).stderr(Stdio::piped()).stdout(Stdio::piped());
583        debug!(?cmd, "getting version");
584        let output = cmd.output().await.map_err(|e| SolcError::io(e, solc))?;
585        let version = version_from_output(output)?;
586        debug!(%version);
587        Ok(version)
588    }
589
590    /// Compiles all `CompilerInput`s with their associated `Solc`.
591    ///
592    /// This will buffer up to `n` `solc` processes and then return the `CompilerOutput`s in the
593    /// order in which they complete. No more than `n` futures will be buffered at any point in
594    /// time, and less than `n` may also be buffered depending on the state of each future.
595    pub async fn compile_many<I>(jobs: I, n: usize) -> crate::many::CompiledMany
596    where
597        I: IntoIterator<Item = (Self, SolcInput)>,
598    {
599        use futures_util::stream::StreamExt;
600
601        let outputs = futures_util::stream::iter(
602            jobs.into_iter()
603                .map(|(solc, input)| async { (solc.async_compile(&input).await, solc, input) }),
604        )
605        .buffer_unordered(n)
606        .collect::<Vec<_>>()
607        .await;
608
609        crate::many::CompiledMany::new(outputs)
610    }
611}
612
613fn compile_output(output: Output) -> Result<Vec<u8>> {
614    if output.status.success() {
615        Ok(output.stdout)
616    } else {
617        Err(SolcError::solc_output(&output))
618    }
619}
620
621fn version_from_output(output: Output) -> Result<Version> {
622    if output.status.success() {
623        let stdout = String::from_utf8_lossy(&output.stdout);
624        let version = stdout
625            .lines()
626            .rfind(|l| !l.trim().is_empty())
627            .ok_or_else(|| SolcError::msg("Version not found in Solc output"))?;
628        // NOTE: semver doesn't like `+` in g++ in build metadata which is invalid semver
629        Ok(Version::from_str(&version.trim_start_matches("Version: ").replace(".g++", ".gcc"))?)
630    } else {
631        Err(SolcError::solc_output(&output))
632    }
633}
634
635impl AsRef<Path> for Solc {
636    fn as_ref(&self) -> &Path {
637        &self.solc
638    }
639}
640
641#[cfg(test)]
642#[cfg(feature = "svm-solc")]
643mod tests {
644    use super::*;
645    use crate::{resolver::parse::SolData, Artifact};
646
647    #[test]
648    fn test_version_parse() {
649        let req = SolData::parse_version_req(">=0.6.2 <0.8.21").unwrap();
650        let semver_req: VersionReq = ">=0.6.2,<0.8.21".parse().unwrap();
651        assert_eq!(req, semver_req);
652    }
653
654    fn solc() -> Solc {
655        if let Some(solc) = Solc::find_svm_installed_version(&Version::new(0, 8, 18)).unwrap() {
656            solc
657        } else {
658            Solc::blocking_install(&Version::new(0, 8, 18)).unwrap()
659        }
660    }
661
662    #[test]
663    fn solc_version_works() {
664        Solc::version(solc().solc).unwrap();
665    }
666
667    #[test]
668    fn can_parse_version_metadata() {
669        let _version = Version::from_str("0.6.6+commit.6c089d02.Linux.gcc").unwrap();
670    }
671
672    #[cfg(feature = "async")]
673    #[tokio::test(flavor = "multi_thread")]
674    async fn async_solc_version_works() {
675        Solc::async_version(&solc().solc).await.unwrap();
676    }
677
678    #[test]
679    fn solc_compile_works() {
680        let input = include_str!("../../../../../test-data/in/compiler-in-1.json");
681        let input: SolcInput = serde_json::from_str(input).unwrap();
682        let out = solc().compile(&input).unwrap();
683        let other = solc().compile(&serde_json::json!(input)).unwrap();
684        assert_eq!(out, other);
685    }
686
687    #[test]
688    fn solc_metadata_works() {
689        let input = include_str!("../../../../../test-data/in/compiler-in-1.json");
690        let mut input: SolcInput = serde_json::from_str(input).unwrap();
691        input.settings.push_output_selection("metadata");
692        let out = solc().compile(&input).unwrap();
693        for (_, c) in out.split().1.contracts_iter() {
694            assert!(c.metadata.is_some());
695        }
696    }
697
698    #[test]
699    fn can_compile_with_remapped_links() {
700        let input: SolcInput = serde_json::from_str(include_str!(
701            "../../../../../test-data/library-remapping-in.json"
702        ))
703        .unwrap();
704        let out = solc().compile(&input).unwrap();
705        let (_, mut contracts) = out.split();
706        let contract = contracts.remove("LinkTest").unwrap();
707        let bytecode = &contract.get_bytecode().unwrap().object;
708        assert!(!bytecode.is_unlinked());
709    }
710
711    #[test]
712    fn can_compile_with_remapped_links_temp_dir() {
713        let input: SolcInput = serde_json::from_str(include_str!(
714            "../../../../../test-data/library-remapping-in-2.json"
715        ))
716        .unwrap();
717        let out = solc().compile(&input).unwrap();
718        let (_, mut contracts) = out.split();
719        let contract = contracts.remove("LinkTest").unwrap();
720        let bytecode = &contract.get_bytecode().unwrap().object;
721        assert!(!bytecode.is_unlinked());
722    }
723
724    #[cfg(feature = "async")]
725    #[tokio::test(flavor = "multi_thread")]
726    async fn async_solc_compile_works() {
727        let input = include_str!("../../../../../test-data/in/compiler-in-1.json");
728        let input: SolcInput = serde_json::from_str(input).unwrap();
729        let out = solc().async_compile(&input).await.unwrap();
730        let other = solc().async_compile(&serde_json::json!(input)).await.unwrap();
731        assert_eq!(out, other);
732    }
733
734    #[cfg(feature = "async")]
735    #[tokio::test(flavor = "multi_thread")]
736    async fn async_solc_compile_works2() {
737        let input = include_str!("../../../../../test-data/in/compiler-in-2.json");
738        let input: SolcInput = serde_json::from_str(input).unwrap();
739        let out = solc().async_compile(&input).await.unwrap();
740        let other = solc().async_compile(&serde_json::json!(input)).await.unwrap();
741        assert_eq!(out, other);
742        let sync_out = solc().compile(&input).unwrap();
743        assert_eq!(out, sync_out);
744    }
745
746    #[test]
747    fn test_version_req() {
748        let versions = ["=0.1.2", "^0.5.6", ">=0.7.1", ">0.8.0"];
749
750        versions.iter().for_each(|version| {
751            let version_req = SolData::parse_version_req(version).unwrap();
752            assert_eq!(version_req, VersionReq::from_str(version).unwrap());
753        });
754
755        // Solidity defines version ranges with a space, whereas the semver package
756        // requires them to be separated with a comma
757        let version_range = ">=0.8.0 <0.9.0";
758        let version_req = SolData::parse_version_req(version_range).unwrap();
759        assert_eq!(version_req, VersionReq::from_str(">=0.8.0,<0.9.0").unwrap());
760    }
761
762    #[test]
763    #[cfg(feature = "full")]
764    fn test_find_installed_version_path() {
765        // This test does not take the lock by default, so we need to manually add it here.
766        take_solc_installer_lock!(_lock);
767        let version = Version::new(0, 8, 6);
768        if svm::installed_versions()
769            .map(|versions| !versions.contains(&version))
770            .unwrap_or_default()
771        {
772            Solc::blocking_install(&version).unwrap();
773        }
774        drop(_lock);
775        let res = Solc::find_svm_installed_version(&version).unwrap().unwrap();
776        let expected = svm::data_dir().join(version.to_string()).join(format!("solc-{version}"));
777        assert_eq!(res.solc, expected);
778    }
779
780    #[test]
781    #[cfg(feature = "svm-solc")]
782    fn can_install_solc_in_tokio_rt() {
783        let version = Version::from_str("0.8.6").unwrap();
784        let rt = tokio::runtime::Runtime::new().unwrap();
785        let result = rt.block_on(async { Solc::blocking_install(&version) });
786        assert!(result.is_ok());
787    }
788
789    #[test]
790    fn does_not_find_not_installed_version() {
791        let ver = Version::new(1, 1, 1);
792        let res = Solc::find_svm_installed_version(&ver).unwrap();
793        assert!(res.is_none());
794    }
795}
foundry_compilers/compilers/solc/compiler.rs

foundry_compilers/compilers/solc/
compiler.rs
