fix: the extra_metadata serialization

Author: hedgar2017

CHANGELOG.md

@@ -36,7 +36,7 @@
 
 ### Fixed
 
-- The compilation pipeline that was not run without output parameters
+- Skipped compilation if no output parameters are provided
 - Broken `--output-dir` output paths for non-Solidity contracts
 - `solc` that was not picked up from `${PATH}` in standard JSON mode
 - `solc` exit code check which is now before the output parsing
@@ -337,7 +337,7 @@
 
 ### Changed
 
-- Internal function pointers now trigger a compile-time error with the EVMLA pipeline
+- Internal function pointers now trigger a compile-time error with the EVMLA codegen
 - Calldata instructions now return 0 in deploy code
 
 ### Removed
@@ -356,7 +356,7 @@
 
 ### Added
 
-- Better errors for unsupported `type(X).runtimeCode` with the Yul pipeline
+- Better errors for unsupported `type(X).runtimeCode` with the Yul codegen
 - An option to disable the `solc` optimizer
 
 ### Changed
@@ -366,9 +366,9 @@
 
 ### Fixed
 
-- Another stack overflow issue with the EVMLA pipeline
-- `CODECOPY` in runtime code now does not copy calldata with the EVMLA pipeline
-- `CODESIZE` in runtime code now returns 0 with the EVMLA pipeline
+- Another stack overflow issue with the EVMLA codegen
+- `CODECOPY` in runtime code now does not copy calldata with the EVMLA codegen
+- `CODESIZE` in runtime code now returns 0 with the EVMLA codegen
 - Hexadecimal arguments in EVMLA are now parsed as case-insensitive
 
 ## [1.3.7] - 2023-03-15
@@ -421,7 +421,7 @@
 ### Fixed
 
 - The `send` and `transfer` now produce a warning again due to false-positives
-- Malfunctioned `CODECOPY` in some cases with the EVMLA pipeline
+- Malfunctioned `CODECOPY` in some cases with the EVMLA codegen
 - The near call exception handling for the requests to system contracts
 
 ## [1.3.2] - 2023-02-14

era-compiler-solidity/src/evmla/assembly/mod.rs

@@ -40,7 +40,7 @@ pub struct Assembly {
     #[serde(default)]
     pub factory_dependencies: HashSet<String>,
     /// The EVMLA extra metadata.
-    #[serde(skip_serializing)]
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub extra_metadata: Option<ExtraMetadata>,
 }
 

era-compiler-solidity/src/lib.rs

@@ -272,7 +272,7 @@ pub fn standard_output_eravm(
     debug_config: Option<era_compiler_llvm_context::DebugConfig>,
 ) -> anyhow::Result<EraVMBuild> {
     let solc_version = solc_compiler.version.to_owned();
-    let solc_pipeline = SolcCodegen::new(&solc_version, codegen);
+    let solc_codegen = SolcCodegen::new(&solc_version, codegen);
 
     let mut solc_input = SolcStandardJsonInput::try_from_solidity_paths(
         paths,
@@ -282,7 +282,7 @@ pub fn standard_output_eravm(
         codegen,
         evm_version,
         enable_eravm_extensions,
-        SolcStandardJsonInputSettingsSelection::new_required(Some(solc_pipeline)),
+        SolcStandardJsonInputSettingsSelection::new_required(Some(solc_codegen)),
         SolcStandardJsonInputSettingsMetadata::new(use_literal_content, metadata_hash_type),
         llvm_options.clone(),
         suppressed_errors,
@@ -293,7 +293,7 @@ pub fn standard_output_eravm(
     let libraries = solc_input.settings.libraries.clone();
     let mut solc_output = solc_compiler.standard_json(
         &mut solc_input,
-        Some(solc_pipeline),
+        Some(solc_codegen),
         messages,
         base_path,
         include_paths,
@@ -304,7 +304,7 @@ pub fn standard_output_eravm(
 
     let project = Project::try_from_solc_output(
         libraries,
-        solc_pipeline,
+        solc_codegen,
         &mut solc_output,
         solc_compiler,
         debug_config.as_ref(),
@@ -347,7 +347,7 @@ pub fn standard_output_evm(
     debug_config: Option<era_compiler_llvm_context::DebugConfig>,
 ) -> anyhow::Result<EVMBuild> {
     let solc_version = solc_compiler.version.to_owned();
-    let solc_pipeline = SolcCodegen::new(&solc_version, codegen);
+    let solc_codegen = SolcCodegen::new(&solc_version, codegen);
 
     let mut solc_input = SolcStandardJsonInput::try_from_solidity_paths(
         paths,
@@ -357,7 +357,7 @@ pub fn standard_output_evm(
         codegen,
         evm_version,
         false,
-        SolcStandardJsonInputSettingsSelection::new_required(Some(solc_pipeline)),
+        SolcStandardJsonInputSettingsSelection::new_required(Some(solc_codegen)),
         SolcStandardJsonInputSettingsMetadata::new(use_literal_content, metadata_hash_type),
         llvm_options.clone(),
         vec![],
@@ -368,7 +368,7 @@ pub fn standard_output_evm(
     let libraries = solc_input.settings.libraries.clone();
     let mut solc_output = solc_compiler.standard_json(
         &mut solc_input,
-        Some(solc_pipeline),
+        Some(solc_codegen),
         messages,
         base_path,
         include_paths,
@@ -379,7 +379,7 @@ pub fn standard_output_evm(
 
     let project = Project::try_from_solc_output(
         libraries,
-        solc_pipeline,
+        solc_codegen,
         &mut solc_output,
         solc_compiler,
         debug_config.as_ref(),
@@ -447,12 +447,12 @@ pub fn standard_json_eravm(
                 None => SolcCompiler::new(SolcCompiler::DEFAULT_EXECUTABLE_NAME)?,
             };
 
-            let solc_pipeline = SolcCodegen::new(&solc_compiler.version, codegen);
-            solc_input.normalize(Some(solc_pipeline));
+            let solc_codegen = SolcCodegen::new(&solc_compiler.version, codegen);
+            solc_input.normalize(Some(solc_codegen));
 
             let mut solc_output = solc_compiler.standard_json(
                 &mut solc_input,
-                Some(solc_pipeline),
+                Some(solc_codegen),
                 messages,
                 base_path,
                 include_paths,
@@ -464,7 +464,7 @@ pub fn standard_json_eravm(
 
             let project = Project::try_from_solc_output(
                 libraries,
-                solc_pipeline,
+                solc_codegen,
                 &mut solc_output,
                 &solc_compiler,
                 debug_config.as_ref(),
@@ -594,12 +594,12 @@ pub fn standard_json_evm(
                 None => SolcCompiler::new(SolcCompiler::DEFAULT_EXECUTABLE_NAME)?,
             };
 
-            let solc_pipeline = SolcCodegen::new(&solc_compiler.version, codegen);
-            solc_input.normalize(Some(solc_pipeline));
+            let solc_codegen = SolcCodegen::new(&solc_compiler.version, codegen);
+            solc_input.normalize(Some(solc_codegen));
 
             let mut solc_output = solc_compiler.standard_json(
                 &mut solc_input,
-                Some(solc_pipeline),
+                Some(solc_codegen),
                 messages,
                 base_path,
                 include_paths,
@@ -611,7 +611,7 @@ pub fn standard_json_evm(
 
             let project = Project::try_from_solc_output(
                 libraries,
-                solc_pipeline,
+                solc_codegen,
                 &mut solc_output,
                 &solc_compiler,
                 debug_config.as_ref(),

era-compiler-solidity/src/project/contract/mod.rs

@@ -145,7 +145,7 @@ impl Contract {
                 let solc_version = dependency_data
                     .solc_version
                     .clone()
-                    .expect("The EVM assembly pipeline cannot be executed without `solc`");
+                    .expect("The EVM assembly codegen cannot be executed without `solc`");
 
                 let module = llvm.create_module(self.name.full_path.as_str());
                 let mut context = era_compiler_llvm_context::EraVMContext::new(

era-compiler-solidity/src/project/mod.rs

@@ -85,12 +85,12 @@ impl Project {
     ///
     pub fn try_from_solc_output(
         libraries: BTreeMap<String, BTreeMap<String, String>>,
-        pipeline: SolcCodegen,
+        codegen: SolcCodegen,
         solc_output: &mut SolcStandardJsonOutput,
         solc_compiler: &SolcCompiler,
         debug_config: Option<&era_compiler_llvm_context::DebugConfig>,
     ) -> anyhow::Result<Self> {
-        if let SolcCodegen::EVMLA = pipeline {
+        if let SolcCodegen::EVMLA = codegen {
             solc_output.preprocess_dependencies()?;
         }
 
@@ -123,7 +123,7 @@ impl Project {
                         );
                         let full_path = name.full_path.clone();
 
-                        let result = match pipeline {
+                        let result = match codegen {
                             SolcCodegen::Yul => ContractYul::try_from_source(
                                 &name,
                                 contract.ir_optimized.as_deref(),

era-compiler-solidity/src/solc/mod.rs

@@ -88,7 +88,7 @@ impl Compiler {
     pub fn standard_json(
         &self,
         input: &mut StandardJsonInput,
-        pipeline: Option<Codegen>,
+        codegen: Option<Codegen>,
         messages: &mut Vec<StandardJsonOutputError>,
         base_path: Option<String>,
         include_paths: Vec<String>,
@@ -179,7 +179,7 @@ impl Compiler {
             ));
         }
 
-        if let Some(pipeline) = pipeline {
+        if let Some(codegen) = codegen {
             let mut suppressed_errors = input.suppressed_errors.clone();
             suppressed_errors.extend_from_slice(input.settings.suppressed_errors.as_slice());
 
@@ -190,7 +190,7 @@ impl Compiler {
             solc_output.preprocess_ast(
                 &input.sources,
                 &self.version,
-                pipeline,
+                codegen,
                 suppressed_errors.as_slice(),
                 suppressed_warnings.as_slice(),
             )?;

era-compiler-solidity/src/solc/standard_json/input/mod.rs

@@ -222,8 +222,8 @@ impl Input {
     ///
     /// Sets the necessary defaults for EraVM compilation.
     ///
-    pub fn normalize(&mut self, pipeline: Option<SolcCodegen>) {
-        self.settings.normalize(pipeline);
+    pub fn normalize(&mut self, codegen: Option<SolcCodegen>) {
+        self.settings.normalize(codegen);
     }
 
     ///

era-compiler-solidity/src/solc/standard_json/input/settings/mod.rs

@@ -128,10 +128,10 @@ impl Settings {
     ///
     /// Sets the necessary defaults for EraVM compilation.
     ///
-    pub fn normalize(&mut self, pipeline: Option<SolcCodegen>) {
+    pub fn normalize(&mut self, codegen: Option<SolcCodegen>) {
         self.output_selection
             .get_or_insert_with(Selection::default)
-            .extend_with_required(pipeline);
+            .extend_with_required(codegen);
     }
 
     ///

era-compiler-solidity/src/solc/standard_json/input/settings/selection/file/flag.rs

@@ -45,8 +45,8 @@ pub enum Flag {
 }
 
 impl From<SolcCodegen> for Flag {
-    fn from(pipeline: SolcCodegen) -> Self {
-        match pipeline {
+    fn from(codegen: SolcCodegen) -> Self {
+        match codegen {
             SolcCodegen::Yul => Self::Yul,
             SolcCodegen::EVMLA => Self::EVMLA,
         }

era-compiler-solidity/src/solc/standard_json/input/settings/selection/file/mod.rs

@@ -27,16 +27,16 @@ impl File {
     ///
     /// Creates the selection required by EraVM compilation process.
     ///
-    pub fn new_required(pipeline: Option<SolcCodegen>) -> Self {
-        let pipeline_ir_flag = pipeline
+    pub fn new_required(codegen: Option<SolcCodegen>) -> Self {
+        let codegen_ir_flag = codegen
             .map(SelectionFlag::from)
             .unwrap_or(SelectionFlag::Yul);
 
         let per_file = HashSet::from_iter([SelectionFlag::AST]);
         let per_contract = HashSet::from_iter([
             SelectionFlag::MethodIdentifiers,
             SelectionFlag::Metadata,
-            pipeline_ir_flag,
+            codegen_ir_flag,
         ]);
         Self {
             per_file: Some(per_file),
@@ -67,8 +67,8 @@ impl File {
     ///
     /// Extends the output selection with flag required by EraVM compilation process.
     ///
-    pub fn extend_with_required(&mut self, pipeline: Option<SolcCodegen>) -> &mut Self {
-        let required = Self::new_required(pipeline);
+    pub fn extend_with_required(&mut self, codegen: Option<SolcCodegen>) -> &mut Self {
+        let required = Self::new_required(codegen);
         self.per_file
             .get_or_insert_with(HashSet::default)
             .extend(required.per_file.unwrap_or_default());

era-compiler-solidity/src/solc/standard_json/input/settings/selection/mod.rs

@@ -25,9 +25,9 @@ impl Selection {
     ///
     /// Creates the selection required by EraVM compilation process.
     ///
-    pub fn new_required(pipeline: Option<SolcCodegen>) -> Self {
+    pub fn new_required(codegen: Option<SolcCodegen>) -> Self {
         Self {
-            all: Some(FileSelection::new_required(pipeline)),
+            all: Some(FileSelection::new_required(codegen)),
         }
     }
 
@@ -52,10 +52,10 @@ impl Selection {
     ///
     /// Extends the output selection with flag required by EraVM compilation process.
     ///
-    pub fn extend_with_required(&mut self, pipeline: Option<SolcCodegen>) -> &mut Self {
+    pub fn extend_with_required(&mut self, codegen: Option<SolcCodegen>) -> &mut Self {
         self.all
-            .get_or_insert_with(|| FileSelection::new_required(pipeline))
-            .extend_with_required(pipeline);
+            .get_or_insert_with(|| FileSelection::new_required(codegen))
+            .extend_with_required(codegen);
         self
     }
 

era-compiler-solidity/src/solc/standard_json/output/error/mod.rs

@@ -187,10 +187,10 @@ You may disable this error with:
         sources: &BTreeMap<String, StandardJSONInputSource>,
     ) -> Self {
         let message = r#"
-Internal function pointers are not supported in the EVM assembly pipeline.
+Internal function pointers are not supported in the EVM assembly codegen.
 Please do one of the following:
     1. Use the ZKsync fork of the Solidity compiler: https://github.com/matter-labs/era-solidity/releases
-    2. Switch to the latest solc with Yul assembly pipeline: https://docs.soliditylang.org/en/latest/yul.html
+    2. Switch to the latest solc with Yul assembly codegen: https://docs.soliditylang.org/en/latest/yul.html
 "#;
 
         Self::new_error(

era-compiler-solidity/src/solc/standard_json/output/mod.rs

@@ -223,7 +223,7 @@ impl Output {
         &mut self,
         sources: &BTreeMap<String, StandardJSONInputSource>,
         version: &SolcVersion,
-        pipeline: SolcCodegen,
+        codegen: SolcCodegen,
         suppressed_errors: &[ErrorType],
         suppressed_warnings: &[WarningType],
     ) -> anyhow::Result<()> {
@@ -248,7 +248,7 @@ impl Output {
                             &id_paths,
                             sources,
                             version,
-                            pipeline,
+                            codegen,
                             suppressed_errors,
                             suppressed_warnings,
                         )

era-compiler-solidity/src/solc/standard_json/output/source.rs

@@ -220,7 +220,7 @@ impl Source {
         id_paths: &BTreeMap<usize, &String>,
         sources: &BTreeMap<String, StandardJSONInputSource>,
         solc_version: &SolcVersion,
-        solc_pipeline: SolcCodegen,
+        solc_codegen: SolcCodegen,
         suppressed_errors: &[ErrorType],
         suppressed_warnings: &[WarningType],
     ) -> Vec<SolcStandardJsonOutputError> {
@@ -235,7 +235,7 @@ impl Source {
         if let Some(message) = Self::check_runtime_code(ast, id_paths, sources) {
             messages.push(message);
         }
-        if SolcCodegen::EVMLA == solc_pipeline && solc_version.l2_revision.is_none() {
+        if SolcCodegen::EVMLA == solc_codegen && solc_version.l2_revision.is_none() {
             if let Some(message) = Self::check_internal_function_pointer(ast, id_paths, sources) {
                 messages.push(message);
             }
@@ -258,7 +258,7 @@ impl Source {
                         id_paths,
                         sources,
                         solc_version,
-                        solc_pipeline,
+                        solc_codegen,
                         suppressed_errors,
                         suppressed_warnings,
                     ));
@@ -271,7 +271,7 @@ impl Source {
                         id_paths,
                         sources,
                         solc_version,
-                        solc_pipeline,
+                        solc_codegen,
                         suppressed_errors,
                         suppressed_warnings,
                     ));