feat: add assemblycreate for warning suppression for zksolc 1.5.10 (#840)

* feat: add assemblycreate for error suppression for zksolc 1.5.9

* chore: remove warning and error enums in favour of era-solc dep

* chore: bump default version to 1.5.9 and set flag

* feat: bumps to 1.5.10 and updates assemblycreate to warningtype

* fix: remove missing libs logic from handling output

* chore: make use of commit 7000890 for object_format to get proper is_unlinked

* chore: run make pr for lint / formatting

* chore: make use of commit 0314731 to resolve null value error

Author: dutterbutter

Cargo.lock

@@ -256,6 +256,7 @@ zksync_vm_interface = { git = "https://github.com/matter-labs/zksync-era.git", r
 zksync_multivm = { git = "https://github.com/matter-labs/zksync-era.git", rev = "core-v25.4.0" }
 zksync_utils = { git = "https://github.com/matter-labs/zksync-era.git", rev = "core-v25.4.0" }
 zksync_contracts = { git = "https://github.com/matter-labs/zksync-era.git", rev = "core-v25.4.0" }
+era-solc = { git = "https://github.com/matter-labs/era-compiler-solidity.git", tag = "1.5.10", package = "era-solc" }
 
 # macros
 proc-macro2 = "1.0"
@@ -303,7 +304,7 @@ regex = { version = "1", default-features = false }
 reqwest = { version = "0.12", default-features = false }
 semver = "1"
 serde = { version = "1.0", features = ["derive"] }
-serde_json = { version = "1.0", features = ["arbitrary_precision"] }
+serde_json = { version = "=1.0.128", features = ["arbitrary_precision"] }
 similar-asserts = "1.6"
 soldeer-commands = "=0.5.2"
 strum = "0.26"

Cargo.toml

@@ -54,6 +54,7 @@ tracing-tracy = { version = "0.11", optional = true }
 
 # zk
 foundry-zksync-compilers.workspace = true
+era-solc.workspace = true
 
 [dev-dependencies]
 tempfile.workspace = true

crates/cli/Cargo.toml

@@ -2,8 +2,8 @@ use std::{collections::HashSet, path::PathBuf};
 
 use alloy_primitives::{hex, Address, Bytes};
 use clap::Parser;
+use era_solc::standard_json::input::settings::{error_type::ErrorType, warning_type::WarningType};
 use foundry_config::zksync::ZkSyncConfig;
-use foundry_zksync_compilers::compilers::zksolc::settings::{ZkSolcError, ZkSolcWarning};
 use serde::Serialize;
 
 #[derive(Clone, Debug, Default, Serialize, Parser)]
@@ -117,22 +117,24 @@ pub struct ZkSyncArgs {
     /// Set the warnings to suppress for zksolc.
     #[clap(
         long = "zk-suppressed-warnings",
-        visible_alias = "suppressed-warnings",
+        alias = "suppressed-warnings",
+        visible_alias = "suppress-warnings",
         value_delimiter = ',',
-        help = "Set the warnings to suppress for zksolc, possible values: [txorigin]"
+        help = "Set the warnings to suppress for zksolc, possible values: [txorigin, assemblycreate]"
     )]
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub suppressed_warnings: Option<Vec<ZkSolcWarning>>,
+    pub suppressed_warnings: Option<Vec<WarningType>>,
 
     /// Set the errors to suppress for zksolc.
     #[clap(
         long = "zk-suppressed-errors",
-        visible_alias = "suppressed-errors",
+        alias = "suppressed-errors",
+        visible_alias = "suppress-errors",
         value_delimiter = ',',
         help = "Set the errors to suppress for zksolc, possible values: [sendtransfer]"
     )]
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub suppressed_errors: Option<Vec<ZkSolcError>>,
+    pub suppressed_errors: Option<Vec<ErrorType>>,
 }
 
 impl ZkSyncArgs {

crates/cli/src/opts/build/zksync.rs

@@ -19,17 +19,14 @@ use foundry_compilers::{
     solc::SolcSettings,
     Artifact, Project, ProjectBuilder, ProjectCompileOutput, ProjectPathsConfig, SolcConfig,
 };
-use foundry_zksync_compilers::{
-    compilers::{
-        artifact_output::zk::ZkArtifactOutput,
-        zksolc::{ZkSolc, ZkSolcCompiler},
-    },
-    libraries::{self, ZkMissingLibrary},
+use foundry_zksync_compilers::compilers::{
+    artifact_output::zk::ZkArtifactOutput,
+    zksolc::{ZkSolc, ZkSolcCompiler},
 };
 
 use num_format::{Locale, ToFormattedString};
 use std::{
-    collections::{BTreeMap, HashSet},
+    collections::BTreeMap,
     fmt::Display,
     io::IsTerminal,
     path::{Path, PathBuf},
@@ -336,7 +333,7 @@ impl ProjectCompiler {
             let zksolc_version = ZkSolc::get_version_for_path(&project.compiler.zksolc)?;
             Report::new(SpinnerReporter::spawn_with(format!("Using zksolc-{zksolc_version}")));
         }
-        self.zksync_compile_with(&project.paths.root, || {
+        self.zksync_compile_with(|| {
             let files_to_compile =
                 if !files.is_empty() { files } else { project.paths.input_files() };
             let sources = Source::read_all(files_to_compile)?;
@@ -349,7 +346,6 @@ impl ProjectCompiler {
     #[instrument(target = "forge::compile", skip_all)]
     fn zksync_compile_with<F>(
         self,
-        root_path: impl AsRef<Path>,
         f: F,
     ) -> Result<ProjectCompileOutput<ZkSolcCompiler, ZkArtifactOutput>>
     where
@@ -394,7 +390,7 @@ impl ProjectCompiler {
                 sh_println!("{output}")?;
             }
 
-            self.zksync_handle_output(root_path, &output)?;
+            self.zksync_handle_output(&output)?;
         }
 
         Ok(output)
@@ -403,71 +399,11 @@ impl ProjectCompiler {
     /// If configured, this will print sizes or names
     fn zksync_handle_output(
         &self,
-        root_path: impl AsRef<Path>,
         output: &ProjectCompileOutput<ZkSolcCompiler, ZkArtifactOutput>,
     ) -> Result<()> {
         let print_names = self.print_names.unwrap_or(false);
         let print_sizes = self.print_sizes.unwrap_or(false);
 
-        // Process missing libraries
-        // TODO: skip this if project was not compiled using --detect-missing-libraries
-        let mut missing_libs_unique: HashSet<String> = HashSet::new();
-        for (artifact_id, artifact) in output.artifact_ids() {
-            // TODO: when compiling specific files, the output might still add cached artifacts
-            // that are not part of the file list to the output, which may cause missing libraries
-            // error to trigger for files that were not intended to be compiled.
-            // This behaviour needs to be investigated better on the foundry-compilers side.
-            // For now we filter, checking only the files passed to compile.
-            let is_target_file =
-                self.files.is_empty() || self.files.iter().any(|f| artifact_id.path == *f);
-            if is_target_file {
-                if let Some(mls) = artifact.missing_libraries() {
-                    missing_libs_unique.extend(mls.clone());
-                }
-            }
-        }
-
-        let missing_libs: Vec<ZkMissingLibrary> = missing_libs_unique
-            .into_iter()
-            .map(|ml| {
-                let mut split = ml.split(':');
-                let contract_path =
-                    split.next().expect("Failed to extract contract path for missing library");
-                let contract_name =
-                    split.next().expect("Failed to extract contract name for missing library");
-
-                let mut abs_path_buf = PathBuf::new();
-                abs_path_buf.push(root_path.as_ref());
-                abs_path_buf.push(contract_path);
-
-                let art = output.find(abs_path_buf.as_path(), contract_name).unwrap_or_else(|| {
-                    panic!(
-                        "Could not find contract {contract_name} at path {contract_path} for compilation output"
-                    )
-                });
-
-                ZkMissingLibrary {
-                    contract_path: contract_path.to_string(),
-                    contract_name: contract_name.to_string(),
-                    missing_libraries: art.missing_libraries().cloned().unwrap_or_default(),
-                }
-            })
-            .collect();
-
-        if !missing_libs.is_empty() {
-            libraries::add_dependencies_to_missing_libraries_cache(
-                root_path,
-                missing_libs.as_slice(),
-            )
-            .expect("Error while adding missing libraries");
-            let missing_libs_list = missing_libs
-                .iter()
-                .map(|ml| format!("{}:{}", ml.contract_path, ml.contract_name))
-                .collect::<Vec<String>>()
-                .join(", ");
-            eyre::bail!("Missing libraries detected: {missing_libs_list}\n\nRun the following command in order to deploy each missing library:\n\nforge create <LIBRARY> --private-key <PRIVATE_KEY> --rpc-url <RPC_URL> --chain <CHAIN_ID> --zksync\n\nThen pass the library addresses using the --libraries option");
-        }
-
         // print any sizes or names
         if print_names {
             let mut artifacts: BTreeMap<_, Vec<_>> = BTreeMap::new();

crates/common/src/compile.rs

@@ -48,6 +48,7 @@ yansi.workspace = true
 
 # zksync
 foundry-zksync-compilers.workspace = true
+era-solc.workspace = true
 
 [target.'cfg(target_os = "windows")'.dependencies]
 path-slash = "0.2"

crates/config/Cargo.toml

@@ -1,3 +1,4 @@
+use era_solc::standard_json::input::settings::{error_type::ErrorType, warning_type::WarningType};
 use foundry_compilers::{
     artifacts::{EvmVersion, Libraries, Severity},
     error::SolcError,
@@ -11,14 +12,13 @@ use foundry_zksync_compilers::{
         zksolc::{
             get_solc_version_info,
             settings::{
-                BytecodeHash, Codegen, Optimizer, OptimizerDetails, SettingsMetadata, ZkSolcError,
-                ZkSolcSettings, ZkSolcWarning,
+                BytecodeHash, Codegen, Optimizer, OptimizerDetails, SettingsMetadata,
+                ZkSolcSettings,
             },
             ZkSettings, ZkSolc, ZkSolcCompiler,
         },
     },
 };
-
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use std::{collections::HashSet, path::PathBuf};
@@ -70,10 +70,10 @@ pub struct ZkSyncConfig {
     pub optimizer_details: Option<OptimizerDetails>,
 
     // zksolc suppressed warnings.
-    pub suppressed_warnings: HashSet<ZkSolcWarning>,
+    pub suppressed_warnings: HashSet<WarningType>,
 
     // zksolc suppressed errors.
-    pub suppressed_errors: HashSet<ZkSolcError>,
+    pub suppressed_errors: HashSet<ErrorType>,
 }
 
 impl Default for ZkSyncConfig {
@@ -198,7 +198,7 @@ pub fn config_create_project(
     {
         zksolc
     } else if !config.offline {
-        let default_version = semver::Version::new(1, 5, 7);
+        let default_version = semver::Version::new(1, 5, 10);
         let mut zksolc = ZkSolc::find_installed_version(&default_version)?;
         if zksolc.is_none() {
             ZkSolc::blocking_install(&default_version)?;

crates/config/src/zksync.rs

@@ -201,7 +201,7 @@ impl ForgeTestProfile {
         zk_config.zksync.startup = true;
         zk_config.zksync.fallback_oz = true;
         zk_config.zksync.optimizer_mode = '3';
-        zk_config.zksync.zksolc = Some(foundry_config::SolcReq::Version(Version::new(1, 5, 7)));
+        zk_config.zksync.zksolc = Some(foundry_config::SolcReq::Version(Version::new(1, 5, 10)));
         zk_config.fuzz.no_zksync_reserved_addresses = true;
         zk_config.invariant.depth = 15;
 

crates/forge/tests/it/test_helpers.rs

@@ -31,6 +31,7 @@ path-slash = "0.2"
 
 # zk
 zksync_types.workspace = true
+era-solc.workspace = true
 
 [dev-dependencies]
 similar-asserts.workspace = true

crates/zksync/compilers/Cargo.toml

@@ -8,6 +8,45 @@ use foundry_compilers_artifacts_solc::{
 use serde::{Deserialize, Serialize};
 use std::{borrow::Cow, collections::BTreeMap};
 
+/// zksolc: Binary object format.
+#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(try_from = "String", into = "String")]
+pub enum ObjectFormat {
+    /// Linked
+    #[default]
+    Raw,
+    /// Unlinked
+    Elf,
+}
+
+impl From<ObjectFormat> for String {
+    fn from(val: ObjectFormat) -> Self {
+        match val {
+            ObjectFormat::Raw => "raw",
+            ObjectFormat::Elf => "elf",
+        }
+        .to_string()
+    }
+}
+
+impl TryFrom<String> for ObjectFormat {
+    type Error = String;
+    fn try_from(s: String) -> Result<Self, Self::Error> {
+        match s.as_str() {
+            "raw" => Ok(Self::Raw),
+            "elf" => Ok(Self::Elf),
+            s => Err(format!("Unknown zksolc object format: {s}")),
+        }
+    }
+}
+
+impl ObjectFormat {
+    /// Returns `true` if the bytecode is unlinked
+    pub fn is_unlinked(&self) -> bool {
+        matches!(self, Self::Elf)
+    }
+}
+
 /// Represents a compiled solidity contract
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
@@ -44,6 +83,14 @@ pub struct Contract {
     /// The contract's unlinked libraries
     #[serde(default)]
     pub missing_libraries: Vec<String>,
+    /// zksolc's binary object format
+    ///
+    /// Tells whether the bytecode has been linked.
+    ///
+    /// Introduced in 1.5.8, beforehand we can assume the bytecode
+    /// was always fully linked
+    #[serde(default)]
+    pub object_format: Option<ObjectFormat>,
 }
 
 fn storage_layout_is_empty(storage_layout: &StorageLayout) -> bool {
@@ -53,7 +100,7 @@ fn storage_layout_is_empty(storage_layout: &StorageLayout) -> bool {
 impl Contract {
     /// Returns true if contract is not linked
     pub fn is_unlinked(&self) -> bool {
-        self.hash.is_none() || !self.missing_libraries.is_empty()
+        self.object_format.as_ref().map(|format| format.is_unlinked()).unwrap_or_default()
     }
 
     /// takes missing libraries output and transforms into link references