feat(zink): clean primitives and workspace (#329)

* chore(zint): move zint out of crates

* feat(zink): rename zink-abi-macro to zabi-codegen

* feat(zink): rename ffi to isa

* feat(zink): goodbye unsafe

* chore(zink): revert safe_impl

* feat(zink): remove trait asm

* feat(zink): use asm instead of ffi

* feat(zink): move u256 ffi to ext

* chore(clippy): make clippy happy

* docs(README): correct the bounty link

* chore(zink): remove outdated proc-macro for safe impl

* chore(codegen): redirect the calls of u256 to namespace ext

* chore(workspace): move the examples to zink folder

* chore(codegen): fix missed tests

* ci(foundry): update the path in founry tests

Author: clearloop

.github/workflows/main.yml

@@ -28,14 +28,14 @@ jobs:
       - name: Build and Install zint-cli
         run: |
           cargo build --release -p zint-cli
-          cargo install --path crates/zint/cli
+          cargo install --path zint/cli
 
       - name: Run Tests
         run: cargo nextest run --workspace --no-fail-fast --release
 
       - name: Run Example Tests
         run: cargo nextest run --workspace --no-fail-fast --release --examples
-        
+
       - name: Test Elko Addition Example
         run: |
           cargo run -p elko -- new addition
@@ -45,7 +45,7 @@ jobs:
 
       - name: Test Foundry Integration
         run: |
-          cd crates/zint/storage
+          cd zint/storage
           forge build
           cargo zint new
           cargo zint run

Cargo.lock

@@ -1,20 +1,16 @@
-[profile]
-dev = { panic = "abort" }
-release = { panic = "unwind" }
-
 [workspace]
 members = [
   "codegen",
   "compiler",
   "compiler/filetests",
-  "crates/zint",
-  "crates/zint/cli",
   "evm/opcodes",
   "evm/abi",
   "zink/abi",
+  "zink/abi/codegen",
   "zink/codegen",
   "zink/elko",
-  "zink/abi-macro",
+  "zint",
+  "zint/cli",
 ]
 resolver = "2"
 
@@ -68,73 +64,23 @@ sol-abi = { path = "evm/abi", version = "=0.0.1" }
 elko = { path = "elko", version = "0.1.12" }
 filetests = { package = "zinkc-filetests", path = "compiler/filetests", version = "0.1.12" }
 zabi = { path = "zink/abi", version = "0.1.12" }
+zabi-codegen = { path = "zink/abi/codegen", version = "0.1.12" }
 zingen = { path = "codegen", version = "0.1.12" }
-zink = { path = ".", version = "0.1.12" }
-zink-abi-macro = { path = "zink/abi-macro", version = "0.1.12" }
+zink = { path = "zink", version = "0.1.12" }
 zink-codegen = { path = "zink/codegen", version = "0.1.12" }
 zinkc = { path = "compiler", version = "0.1.12" }
-zint = { path = "crates/zint", version = "0.1.12" }
+zint = { path = "zint", version = "0.1.12" }
 
 [workspace.metadata.conta]
 packages = [
   "zabi",
+  "zabi-codegen",
   "zingen",
   "zinkc",
   "filetests",
   "zint",
   "zink-codegen",
-  "zink-abi-macro",
   "zink",
   "cargo-zint",
   "elko",
 ]
-
-# Zink Programming Language
-# -------------------------
-
-[package]
-name = "zink"
-description = "Standard library for zink projects."
-documentation = "https://docs.rs/zink"
-version.workspace = true
-authors.workspace = true
-edition.workspace = true
-license.workspace = true
-homepage.workspace = true
-repository.workspace = true
-readme = "zink/README.md"
-
-[lib]
-path = "zink/src/lib.rs"
-
-[dependencies]
-fmt = "0.1.0"
-paste.workspace = true
-zink-codegen.workspace = true
-zink-abi-macro = { workspace = true, optional = true }
-zabi.workspace = true
-smallvec.workspace = true
-clap.workspace = true
-
-[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-tiny-keccak.workspace = true
-
-[target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
-anyhow.workspace = true
-filetests.workspace = true
-opcodes = { workspace = true, features = ["data"] }
-tracing.workspace = true
-zint.workspace = true
-hex.workspace = true
-serde_json.workspace = true
-tempfile.workspace = true
-
-[target.'cfg(target_arch = "wasm32")'.dependencies]
-dlmalloc = { version = "0.2", optional = true, features = ["global"] }
-
-[features]
-# default = [ "evm" ]
-# evm = [  ]
-abi-import = ["zink-abi-macro", "zabi/encoding"]
-wasm-alloc = ["dep:dlmalloc"]
-default = ["wasm-alloc"]

Cargo.toml

@@ -10,7 +10,7 @@
 [![ci][ci-badge]][ci-link]
 [![telegram][telegram-badge]][telegram-group]
 
-Welcome to the Zink Language! [Bounty issues](https://zink-lang.org/budgets) are now available, join the development of Zink by reading the [book](https://zink-lang.org/).
+Welcome to the Zink Language! [Bounty issues](https://zink-lang.org/bounties) are now available, join the development of Zink by reading the [book](https://zink-lang.org/).
 
 ```rust
 //! ERC20 Example (WIP)

README.md

@@ -1,7 +1,8 @@
 [default]
-extend-ignore-re = [
-    "\\w{44,52}",
-]
+extend-ignore-re = ["\\w{44,52}"]
 
 [default.extend-words]
 zink = "zink"
+
+[files]
+extend-exclude = ["docs/theme/*"]

_typos.toml

@@ -85,7 +85,7 @@ impl Function {
     }
 
     /// The select instruction selects one of its first two operands based
-    /// on whether its third oprand is zero or not.
+    /// on whether its third operand is zero or not.
     ///
     /// STACK: [cond, val2, val1] -> \[val1\] if cond is non-zero, \[val2\] otherwise.
     pub fn _select(&mut self) -> Result<()> {

codegen/src/visitor/control.rs

@@ -57,8 +57,8 @@ impl<'f> Functions<'f> {
     /// Remove all selector functions
     pub fn drain_selectors(&mut self, exports: &Exports) -> Self {
         let mut functions = Self::default();
-
-        for index in exports.selectors() {
+        let selectors = exports.selectors();
+        for index in selectors {
             if let Some(function) = self.0.remove(&index) {
                 functions.0.insert(index, function);
             }

codegen/src/wasm/func.rs

@@ -50,12 +50,6 @@ impl TryFrom<(&str, &str)> for HostFunc {
         match import {
             ("zinkc", name) => match name {
                 "emit_abi" => Ok(Self::EmitABI),
-                "u256_add" => Ok(Self::Evm(OpCode::ADD)),
-                "u256_sub" => Ok(Self::Evm(OpCode::SUB)),
-                "u256_lt" => Ok(Self::Evm(OpCode::LT)),
-                "u256_max" => Ok(Self::U256MAX),
-                "u256_addmod" => Ok(Self::Evm(OpCode::ADDMOD)),
-                "u256_mulmod" => Ok(Self::Evm(OpCode::MULMOD)),
                 "label_reserve_mem_32" => Ok(Self::Label(CompilerLabel::ReserveMemory32)),
                 "label_reserve_mem_64" => Ok(Self::Label(CompilerLabel::ReserveMemory64)),
                 _ => Err(Error::HostFuncNotFound(module.into(), name.into())),
@@ -64,7 +58,13 @@ impl TryFrom<(&str, &str)> for HostFunc {
                 tracing::error!("Failed to load host function: {:?}", import);
                 Error::HostFuncNotFound(module.into(), name.into())
             })?)),
-            ("asm", name) => match name {
+            ("ext", name) => match name {
+                "u256_add" => Ok(Self::Evm(OpCode::ADD)),
+                "u256_sub" => Ok(Self::Evm(OpCode::SUB)),
+                "u256_lt" => Ok(Self::Evm(OpCode::LT)),
+                "u256_max" => Ok(Self::U256MAX),
+                "u256_addmod" => Ok(Self::Evm(OpCode::ADDMOD)),
+                "u256_mulmod" => Ok(Self::Evm(OpCode::MULMOD)),
                 n if n.starts_with("sload") => Ok(Self::Evm(OpCode::SLOAD)),
                 n if n.starts_with("tload") => Ok(Self::Evm(OpCode::TLOAD)),
                 n if n.starts_with("revert") => {
@@ -101,18 +101,15 @@ pub enum CompilerLabel {
 
 #[cfg(test)]
 mod tests {
-    use anyhow::Ok;
-
     use super::*;
 
     #[test]
     fn test_addmod_mulmod_host_functions() -> anyhow::Result<()> {
-        let addmod_func = HostFunc::try_from(("zinkc", "u256_addmod"))?;
-
+        let addmod_func = HostFunc::try_from(("ext", "u256_addmod"))?;
         assert_eq!(addmod_func, HostFunc::Evm(OpCode::ADDMOD));
 
         // Test MULMOD host function conversion
-        let mulmod_func = HostFunc::try_from(("zinkc", "u256_mulmod"));
+        let mulmod_func = HostFunc::try_from(("ext", "u256_mulmod"));
         assert!(mulmod_func.is_ok());
         Ok(())
     }

codegen/src/wasm/host.rs

@@ -118,7 +118,6 @@ impl Env {
 
     /// Check if the input function is external function
     pub fn is_external(&self, index: u32) -> bool {
-        // self.exports.get(&index).is_some()
         let Some(name) = self.exports.get(&index) else {
             return false;
         };

codegen/src/wasm/mod.rs

@@ -96,7 +96,6 @@ impl Compiler {
 
         tracing::debug!("compile function {func_index} {:?}, abi: {abi:#?}", sig);
         let is_main = !self.config.dispatcher && env.is_main(func_index);
-
         let mut codegen = Function::new(env, sig, abi, is_main)?;
         let mut locals_reader = func.body.get_locals_reader()?;
         let mut ops_reader = func.body.get_operators_reader()?;