Emerge Yul recompiler (#1)

Provide a modified (and incomplete) version of ZKSync zksolc that can compile the most basic contracts

crates/solidity/src/project/contract/ir/evmla.rs

@@ -0,0 +1,58 @@
+//!
+//! The contract EVM legacy assembly source code.
+//!
+
+use std::collections::HashSet;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+use crate::evmla::assembly::Assembly;
+use crate::solc::standard_json::output::contract::evm::extra_metadata::ExtraMetadata;
+
+///
+/// The contract EVM legacy assembly source code.
+///
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[allow(non_camel_case_types)]
+#[allow(clippy::upper_case_acronyms)]
+pub struct EVMLA {
+    /// The EVM legacy assembly source code.
+    pub assembly: Assembly,
+}
+
+impl EVMLA {
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new(mut assembly: Assembly, extra_metadata: ExtraMetadata) -> Self {
+        assembly.extra_metadata = Some(extra_metadata);
+        Self { assembly }
+    }
+
+    ///
+    /// Get the list of missing deployable libraries.
+    ///
+    pub fn get_missing_libraries(&self) -> HashSet<String> {
+        self.assembly.get_missing_libraries()
+    }
+}
+
+impl<D> era_compiler_llvm_context::EraVMWriteLLVM<D> for EVMLA
+where
+    D: era_compiler_llvm_context::EraVMDependency + Clone,
+{
+    fn declare(
+        &mut self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        self.assembly.declare(context)
+    }
+
+    fn into_llvm(
+        self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        self.assembly.into_llvm(context)
+    }
+}

crates/solidity/src/project/contract/ir/llvm_ir.rs

@@ -0,0 +1,27 @@
+//!
+//! The contract LLVM IR source code.
+//!
+
+use serde::Deserialize;
+use serde::Serialize;
+
+///
+/// The contract LLVM IR source code.
+///
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[allow(clippy::upper_case_acronyms)]
+pub struct LLVMIR {
+    /// The LLVM IR file path.
+    pub path: String,
+    /// The LLVM IR source code.
+    pub source: String,
+}
+
+impl LLVMIR {
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new(path: String, source: String) -> Self {
+        Self { path, source }
+    }
+}

crates/solidity/src/project/contract/ir/mod.rs

@@ -0,0 +1,111 @@
+//!
+//! The contract source code.
+//!
+
+pub mod evmla;
+pub mod llvm_ir;
+pub mod yul;
+pub mod zkasm;
+
+use std::collections::HashSet;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+use crate::evmla::assembly::Assembly;
+use crate::solc::standard_json::output::contract::evm::extra_metadata::ExtraMetadata;
+use crate::yul::parser::statement::object::Object;
+
+use self::evmla::EVMLA;
+use self::llvm_ir::LLVMIR;
+use self::yul::Yul;
+use self::zkasm::ZKASM;
+
+///
+/// The contract source code.
+///
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[allow(non_camel_case_types)]
+#[allow(clippy::upper_case_acronyms)]
+#[allow(clippy::enum_variant_names)]
+pub enum IR {
+    /// The Yul source code.
+    Yul(Yul),
+    /// The EVM legacy assembly source code.
+    EVMLA(EVMLA),
+    /// The LLVM IR source code.
+    LLVMIR(LLVMIR),
+    /// The EraVM assembly source code.
+    ZKASM(ZKASM),
+}
+
+impl IR {
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new_yul(source_code: String, object: Object) -> Self {
+        Self::Yul(Yul::new(source_code, object))
+    }
+
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new_evmla(assembly: Assembly, extra_metadata: ExtraMetadata) -> Self {
+        Self::EVMLA(EVMLA::new(assembly, extra_metadata))
+    }
+
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new_llvm_ir(path: String, source: String) -> Self {
+        Self::LLVMIR(LLVMIR::new(path, source))
+    }
+
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new_zkasm(path: String, source: String) -> Self {
+        Self::ZKASM(ZKASM::new(path, source))
+    }
+
+    ///
+    /// Get the list of missing deployable libraries.
+    ///
+    pub fn get_missing_libraries(&self) -> HashSet<String> {
+        match self {
+            Self::Yul(inner) => inner.get_missing_libraries(),
+            Self::EVMLA(inner) => inner.get_missing_libraries(),
+            Self::LLVMIR(_inner) => HashSet::new(),
+            Self::ZKASM(_inner) => HashSet::new(),
+        }
+    }
+}
+
+impl<D> era_compiler_llvm_context::EraVMWriteLLVM<D> for IR
+where
+    D: era_compiler_llvm_context::EraVMDependency + Clone,
+{
+    fn declare(
+        &mut self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        match self {
+            Self::Yul(inner) => inner.declare(context),
+            Self::EVMLA(inner) => inner.declare(context),
+            Self::LLVMIR(_inner) => Ok(()),
+            Self::ZKASM(_inner) => Ok(()),
+        }
+    }
+
+    fn into_llvm(
+        self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        match self {
+            Self::Yul(inner) => inner.into_llvm(context),
+            Self::EVMLA(inner) => inner.into_llvm(context),
+            Self::LLVMIR(_inner) => Ok(()),
+            Self::ZKASM(_inner) => Ok(()),
+        }
+    }
+}

crates/solidity/src/project/contract/ir/yul.rs

@@ -0,0 +1,59 @@
+//!
+//! The contract Yul source code.
+//!
+
+use std::collections::HashSet;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+use crate::yul::parser::statement::object::Object;
+
+///
+/// The contract Yul source code.
+///
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct Yul {
+    /// The Yul source code.
+    pub source_code: String,
+    /// The Yul AST object.
+    pub object: Object,
+}
+
+impl Yul {
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new(source_code: String, object: Object) -> Self {
+        Self {
+            source_code,
+            object,
+        }
+    }
+
+    ///
+    /// Get the list of missing deployable libraries.
+    ///
+    pub fn get_missing_libraries(&self) -> HashSet<String> {
+        self.object.get_missing_libraries()
+    }
+}
+
+impl<D> era_compiler_llvm_context::EraVMWriteLLVM<D> for Yul
+where
+    D: era_compiler_llvm_context::EraVMDependency + Clone,
+{
+    fn declare(
+        &mut self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        self.object.declare(context)
+    }
+
+    fn into_llvm(
+        self,
+        context: &mut era_compiler_llvm_context::EraVMContext<D>,
+    ) -> anyhow::Result<()> {
+        self.object.into_llvm(context)
+    }
+}

crates/solidity/src/project/contract/ir/zkasm.rs

@@ -0,0 +1,27 @@
+//!
+//! The contract EraVM assembly source code.
+//!
+
+use serde::Deserialize;
+use serde::Serialize;
+
+///
+/// The contract EraVM assembly source code.
+///
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[allow(clippy::upper_case_acronyms)]
+pub struct ZKASM {
+    /// The EraVM assembly file path.
+    pub path: String,
+    /// The EraVM assembly source code.
+    pub source: String,
+}
+
+impl ZKASM {
+    ///
+    /// A shortcut constructor.
+    ///
+    pub fn new(path: String, source: String) -> Self {
+        Self { path, source }
+    }
+}