feat: add support for preprocessing sources (#252)

Implements a preprocessor allowing us to skip recompiling tests on
non-interface source file changes. See the companion Foundry PR
foundry-rs/foundry#10010 for benchmarks and more
details.

Supersedes #198:
- uses solar AST instead solang-parser to compute interface
representation
- uses solar HIR instead of solc AST to find bytecode dependencies
- handles more edge cases, like deploying with salt/value

Closes #197.

### TODO
- [x] use solar HIR (deps to review and include
paradigmxyz/solar#210)
- [x] unit tests
- [x] opt-in caching changes
- [x] autodetect mocks
- [x] figure out how to parse when building from different dir
- [x] additional testing (tested with uniswap v4-core and simpler
projects)

### Depends on
- [x] merge solar PR (paradigmxyz/solar#210)
- [x] solar release

---------

Co-authored-by: Arsenii Kulikov <[email protected]>
Co-authored-by: zerosnacks <[email protected]>
Co-authored-by: DaniPopes <[email protected]>

Author: 4 people

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: full
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}

.gitignore

@@ -2,7 +2,8 @@
 /target
 /Cargo.lock
 
-cache/
+/cache
+test-data/**/cache/
 
 .vscode
 /.envrc
@@ -12,4 +13,4 @@ cache/
 devenv.local.nix
 .direnv
 .pre-commit-config.yaml
-.lock
+.lock

Cargo.toml

@@ -22,8 +22,9 @@ manual-string-new = "warn"
 uninlined-format-args = "warn"
 use-self = "warn"
 redundant-clone = "warn"
-# until <https://github.com/rust-lang/rust-clippy/issues/13885> is fixed
-literal-string-with-formatting-args = "allow"
+
+result-large-err = "allow"
+large-enum-variant = "allow"
 
 [workspace.lints.rust]
 rust-2018-idioms = "warn"
@@ -54,7 +55,8 @@ semver = { version = "1.0", features = ["serde"] }
 serde = { version = "1", features = ["derive", "rc"] }
 serde_json = "1.0"
 similar-asserts = "1"
-solar-parse = { version = "=0.1.1", default-features = false }
+solar-parse = { version = "=0.1.2", default-features = false }
+solar-sema = { version = "=0.1.2", default-features = false }
 svm = { package = "svm-rs", version = "0.5", default-features = false }
 tempfile = "3.9"
 thiserror = "2"

crates/artifacts/solc/src/ast/misc.rs

@@ -4,7 +4,7 @@ use std::{fmt, fmt::Write, str::FromStr};
 /// Represents the source location of a node: `<start byte>:<length>:<source index>`.
 ///
 /// The `start`, `length` and `index` can be -1 which is represented as `None`
-#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct SourceLocation {
     pub start: Option<usize>,
     pub length: Option<usize>,

crates/artifacts/solc/src/sources.rs

@@ -198,7 +198,13 @@ impl Source {
     /// Generate a non-cryptographically secure checksum of the file's content.
     #[cfg(feature = "checksum")]
     pub fn content_hash(&self) -> String {
-        alloy_primitives::hex::encode(<md5::Md5 as md5::Digest>::digest(self.content.as_bytes()))
+        Self::content_hash_of(&self.content)
+    }
+
+    /// Generate a non-cryptographically secure checksum of the given source.
+    #[cfg(feature = "checksum")]
+    pub fn content_hash_of(src: &str) -> String {
+        alloy_primitives::hex::encode(<md5::Md5 as md5::Digest>::digest(src))
     }
 }
 

crates/compilers/Cargo.toml

@@ -33,6 +33,7 @@ thiserror.workspace = true
 path-slash.workspace = true
 yansi.workspace = true
 solar-parse.workspace = true
+solar-sema.workspace = true
 futures-util = { workspace = true, optional = true }
 tokio = { workspace = true, optional = true }