fix: examples and deps (#142)

* fix: examples * fix: example sha2
zkMIPS · Jul 6, 2024 · 10dcb75 · 10dcb75
1 parent 07bd0d2
commit 10dcb75
Show file tree

Hide file tree

Showing 37 changed files with 45 additions and 39 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 /target
 /Cargo.lock
 /output
+/examples/target
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,19 @@
 [workspace]
 members = [
   "runtime/*",
-  "prover",
+  "prover"
 ]
 resolver = "2"
+
+
+[profile.release]
+opt-level = 3
+
+[profile.bench]
+opt-level = 3
+
+[profile.fast]
+inherits = "release"
+debug = true
+debug-assertions = true
+
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ In order to build the application, zkm requires a latest nightly toolchain. Just
 
 # Running the examples
 
-An end-to-end example has been presented in [examples](./examples).
+An end-to-end example has been presented in [examples](./prover/examples).
 
 # Guidance for external contributors
 

diff --git a/prover/Cargo.toml b/prover/Cargo.toml
@@ -30,22 +30,20 @@ rand = "0.8.5"
 rand_chacha = "0.3.1"
 once_cell = "1.13.0"
 static_assertions = "1.1.0"
-keccak-hash = "0.10.0"
 byteorder = "1.5.0"
 hex = "0.4"
 hashbrown = { version = "0.14.0", default-features = false, features = ["ahash", "serde"] } # NOTE: When upgrading, see `ahash` dependency.
 lazy_static = "1.4.0"
 
 elf = { version = "0.7", default-features = false }
 
-sysinfo = "0.30.7"
 
 [dev-dependencies]
 env_logger = "0.10.0"
 keccak-hash = "0.10.0"
 plonky2x = { git = "https://github.com/zkMIPS/succinctx.git", package = "plonky2x",  branch = "zkm" }
 plonky2x-derive = { git = "https://github.com/zkMIPS/succinctx.git", package = "plonky2x-derive",  branch = "zkm" }
-curta = { git ="https://github.com/zkMIPS/curta.git", branch = "zkm" }
+
 
 [features]
 test = []
diff --git a/examples/README.md → prover/examples/README.md b/examples/README.md → prover/examples/README.md
diff --git a/examples/sha2/Cargo.lock → prover/examples/sha2/Cargo.lock b/examples/sha2/Cargo.lock → prover/examples/sha2/Cargo.lock
diff --git a/examples/sha2/Cargo.toml → prover/examples/sha2/Cargo.toml b/examples/sha2/Cargo.toml → prover/examples/sha2/Cargo.toml
@@ -5,5 +5,5 @@ name = "sha2-bench"
 edition = "2021"
 
 [dependencies]
-zkm-runtime = { path = "../../runtime/entrypoint" }
+zkm-runtime = { path = "../../../runtime/entrypoint" }
 sha2 = { version = "0.10.8", default-features = false }
diff --git a/examples/sha2/rust-toolchain.toml → prover/examples/sha2/rust-toolchain.toml b/examples/sha2/rust-toolchain.toml → prover/examples/sha2/rust-toolchain.toml
diff --git a/examples/sha2/src/main.rs → prover/examples/sha2/src/main.rs b/examples/sha2/src/main.rs → prover/examples/sha2/src/main.rs
diff --git a/examples/zkmips.rs → prover/examples/zkmips.rs b/examples/zkmips.rs → prover/examples/zkmips.rs
@@ -12,16 +12,16 @@ use plonky2x::backend::circuit::Groth16WrapperParameters;
 use plonky2x::backend::wrapper::wrap::WrappedCircuit;
 use plonky2x::frontend::builder::CircuitBuilder as WrapperBuilder;
 use plonky2x::prelude::DefaultParameters;
-use zkm::all_stark::AllStark;
-use zkm::config::StarkConfig;
-use zkm::cpu::kernel::assembler::segment_kernel;
-use zkm::fixed_recursive_verifier::AllRecursiveCircuits;
-use zkm::mips_emulator::state::{InstrumentedState, State, SEGMENT_STEPS};
-use zkm::mips_emulator::utils::get_block_path;
-use zkm::proof;
-use zkm::proof::PublicValues;
-use zkm::prover::prove;
-use zkm::verifier::verify_proof;
+use zkm_prover::all_stark::AllStark;
+use zkm_prover::config::StarkConfig;
+use zkm_prover::cpu::kernel::assembler::segment_kernel;
+use zkm_prover::fixed_recursive_verifier::AllRecursiveCircuits;
+use zkm_prover::mips_emulator::state::{InstrumentedState, State, SEGMENT_STEPS};
+use zkm_prover::mips_emulator::utils::get_block_path;
+use zkm_prover::proof;
+use zkm_prover::proof::PublicValues;
+use zkm_prover::prover::prove;
+use zkm_prover::verifier::verify_proof;
 
 const DEGREE_BITS_RANGE: [Range<usize>; 6] = [10..21, 12..22, 12..21, 8..21, 6..21, 13..23];
 

diff --git a/prover/src/cpu/kernel/elf.rs b/prover/src/cpu/kernel/elf.rs
@@ -350,14 +350,14 @@ mod test {
     #[test]
     fn load_and_check_mips_elf() {
         env_logger::try_init().unwrap_or_default();
-        let mut reader = BufReader::new(File::open("../test-vectors/hello").unwrap());
+        let mut reader = BufReader::new(File::open("test-vectors/hello").unwrap());
         let mut buffer = Vec::new();
         reader.read_to_end(&mut buffer).unwrap();
         let max_mem = 0x80000000;
         let mut p: Program = Program::load_elf(&buffer, max_mem).unwrap();
         log::info!("entry: {}", p.entry);
 
-        let real_blockpath = get_block_path("../test-vectors", "13284491", "input");
+        let real_blockpath = get_block_path("test-vectors", "13284491", "input");
         log::info!("real block path: {}", real_blockpath);
         p.load_block(&real_blockpath).unwrap();
 

diff --git a/prover/src/mips_emulator/tests.rs b/prover/src/mips_emulator/tests.rs
@@ -54,7 +54,7 @@ mod tests {
 
     #[test]
     fn test_execute_hello() {
-        let path = PathBuf::from("../test-vectors/hello");
+        let path = PathBuf::from("test-vectors/hello");
         let data = fs::read(path).expect("could not read file");
         let file =
             ElfBytes::<AnyEndian>::minimal_parse(data.as_slice()).expect("opening elf file failed");
@@ -75,7 +75,7 @@ mod tests {
 
     #[test]
     fn test_execute_rust_fib() {
-        let path = PathBuf::from("../test-vectors/rust_fib");
+        let path = PathBuf::from("test-vectors/rust_fib");
         let data = fs::read(path).expect("could not read file");
         let file =
             ElfBytes::<AnyEndian>::minimal_parse(data.as_slice()).expect("opening elf file failed");
@@ -96,7 +96,7 @@ mod tests {
     #[test]
     #[ignore]
     fn test_execute_minigeth() {
-        let path = PathBuf::from("../test-vectors/minigeth");
+        let path = PathBuf::from("test-vectors/minigeth");
         let data = fs::read(path).expect("could not read file");
         let file =
             ElfBytes::<AnyEndian>::minimal_parse(data.as_slice()).expect("opening elf file failed");
@@ -131,7 +131,7 @@ mod tests {
 
     #[test]
     fn test_execute_split_hello() {
-        let path = PathBuf::from("../test-vectors/hello");
+        let path = PathBuf::from("test-vectors/hello");
         let data = fs::read(path).expect("could not read file");
         let file =
             ElfBytes::<AnyEndian>::minimal_parse(data.as_slice()).expect("opening elf file failed");

diff --git a/...7b6ccd41ad312451b948a7413f0a142fd40d49347 → ...7b6ccd41ad312451b948a7413f0a142fd40d49347 b/...7b6ccd41ad312451b948a7413f0a142fd40d49347 → ...7b6ccd41ad312451b948a7413f0a142fd40d49347
diff --git a/...bd76ca20def7ed5ceb8ed25760337bb7e385e2a41 → ...bd76ca20def7ed5ceb8ed25760337bb7e385e2a41 b/...bd76ca20def7ed5ceb8ed25760337bb7e385e2a41 → ...bd76ca20def7ed5ceb8ed25760337bb7e385e2a41
diff --git a/...8a2aafcca3ef21077f81a32f8da73502fdc4bfc78 → ...8a2aafcca3ef21077f81a32f8da73502fdc4bfc78 b/...8a2aafcca3ef21077f81a32f8da73502fdc4bfc78 → ...8a2aafcca3ef21077f81a32f8da73502fdc4bfc78
diff --git a/...e36f9654d8b8513f7ae1b58192ca175df6708e23f → ...e36f9654d8b8513f7ae1b58192ca175df6708e23f b/...e36f9654d8b8513f7ae1b58192ca175df6708e23f → ...e36f9654d8b8513f7ae1b58192ca175df6708e23f
diff --git a/...11dc9ad12e30a9110f3ab3e5b0291849679cec55e → ...11dc9ad12e30a9110f3ab3e5b0291849679cec55e b/...11dc9ad12e30a9110f3ab3e5b0291849679cec55e → ...11dc9ad12e30a9110f3ab3e5b0291849679cec55e
diff --git a/...e51ee468048bde37585f6b3231d0ee193cba708f4 → ...e51ee468048bde37585f6b3231d0ee193cba708f4 b/...e51ee468048bde37585f6b3231d0ee193cba708f4 → ...e51ee468048bde37585f6b3231d0ee193cba708f4
diff --git a/...38096114a9ab9520e6d36dce1ed4c2565d4cfc161 → ...38096114a9ab9520e6d36dce1ed4c2565d4cfc161 b/...38096114a9ab9520e6d36dce1ed4c2565d4cfc161 → ...38096114a9ab9520e6d36dce1ed4c2565d4cfc161
diff --git a/...2ea69f329bac6570faaca9f096a36c4753a753db1 → ...2ea69f329bac6570faaca9f096a36c4753a753db1 b/...2ea69f329bac6570faaca9f096a36c4753a753db1 → ...2ea69f329bac6570faaca9f096a36c4753a753db1
diff --git a/...4ceffa6036f085734f438cd0f17757c75727942e5 → ...4ceffa6036f085734f438cd0f17757c75727942e5 b/...4ceffa6036f085734f438cd0f17757c75727942e5 → ...4ceffa6036f085734f438cd0f17757c75727942e5
diff --git a/...2d4777bcabfadf5b91dab85d7305008a6a75d5cc8 → ...2d4777bcabfadf5b91dab85d7305008a6a75d5cc8 b/...2d4777bcabfadf5b91dab85d7305008a6a75d5cc8 → ...2d4777bcabfadf5b91dab85d7305008a6a75d5cc8
diff --git a/...8d21b8f51d7fd1214d98d29228691f07f86a5896e → ...8d21b8f51d7fd1214d98d29228691f07f86a5896e b/...8d21b8f51d7fd1214d98d29228691f07f86a5896e → ...8d21b8f51d7fd1214d98d29228691f07f86a5896e
diff --git a/test-vectors/0_13284491/input → prover/test-vectors/0_13284491/input b/test-vectors/0_13284491/input → prover/test-vectors/0_13284491/input
diff --git a/...95c533f7e56b6ad20d45233894142563589e919e6 → ...95c533f7e56b6ad20d45233894142563589e919e6 b/...95c533f7e56b6ad20d45233894142563589e919e6 → ...95c533f7e56b6ad20d45233894142563589e919e6
diff --git a/...f228ca7c4715b61f4d43feb295de61eba664b4799 → ...f228ca7c4715b61f4d43feb295de61eba664b4799 b/...f228ca7c4715b61f4d43feb295de61eba664b4799 → ...f228ca7c4715b61f4d43feb295de61eba664b4799
diff --git a/...a6874fb37ca2d033e4fa301e0998b855359dc0952 → ...a6874fb37ca2d033e4fa301e0998b855359dc0952 b/...a6874fb37ca2d033e4fa301e0998b855359dc0952 → ...a6874fb37ca2d033e4fa301e0998b855359dc0952
diff --git a/...41c03d16e4809401c1a9290ab986c7ca0ddbda6ed → ...41c03d16e4809401c1a9290ab986c7ca0ddbda6ed b/...41c03d16e4809401c1a9290ab986c7ca0ddbda6ed → ...41c03d16e4809401c1a9290ab986c7ca0ddbda6ed
diff --git a/...d63331a2fc03e260699e56d6983e73b0a28159dd2 → ...d63331a2fc03e260699e56d6983e73b0a28159dd2 b/...d63331a2fc03e260699e56d6983e73b0a28159dd2 → ...d63331a2fc03e260699e56d6983e73b0a28159dd2
diff --git a/test-vectors/0_13284491/output → prover/test-vectors/0_13284491/output b/test-vectors/0_13284491/output → prover/test-vectors/0_13284491/output
diff --git a/test-vectors/hello → prover/test-vectors/hello b/test-vectors/hello → prover/test-vectors/hello
diff --git a/test-vectors/hello.go → prover/test-vectors/hello.go b/test-vectors/hello.go → prover/test-vectors/hello.go
diff --git a/test-vectors/minigeth → prover/test-vectors/minigeth b/test-vectors/minigeth → prover/test-vectors/minigeth
diff --git a/test-vectors/rust_fib → prover/test-vectors/rust_fib b/test-vectors/rust_fib → prover/test-vectors/rust_fib
diff --git a/tests/simple_recursion.rs → prover/tests/simple_recursion.rs b/tests/simple_recursion.rs → prover/tests/simple_recursion.rs
@@ -10,13 +10,13 @@ use plonky2::plonk::circuit_builder::CircuitBuilder;
 use plonky2::plonk::circuit_data::CircuitConfig;
 use plonky2::plonk::config::PoseidonGoldilocksConfig;
 use std::io::BufReader;
-use zkm::all_stark::AllStark;
-use zkm::config::StarkConfig;
-use zkm::cpu::kernel::assembler::segment_kernel;
-use zkm::fixed_recursive_verifier::AllRecursiveCircuits;
-use zkm::mips_emulator::state::{InstrumentedState, State};
-use zkm::mips_emulator::utils::get_block_path;
-use zkm::proof::PublicValues;
+use zkm_prover::all_stark::AllStark;
+use zkm_prover::config::StarkConfig;
+use zkm_prover::cpu::kernel::assembler::segment_kernel;
+use zkm_prover::fixed_recursive_verifier::AllRecursiveCircuits;
+use zkm_prover::mips_emulator::state::{InstrumentedState, State};
+use zkm_prover::mips_emulator::utils::get_block_path;
+use zkm_prover::proof::PublicValues;
 
 use plonky2::util::timing::TimingTree;
 
@@ -32,7 +32,9 @@ fn split_elf_into_segs(
     seg_size: usize,
 ) {
     // 1. split ELF into segs
-    let data = fs::read(elf_path).expect("could not read file");
+    let data = fs::read(elf_path)
+        .map_err(|_| panic!("could not read file, {}", elf_path))
+        .unwrap();
     let file =
         ElfBytes::<AnyEndian>::minimal_parse(data.as_slice()).expect("opening elf file failed");
     let (mut state, _) = State::load_elf(&file);
@@ -66,7 +68,6 @@ fn split_elf_into_segs(
 
 // Tests proving two transactions, one of which with logs, and aggregating them.
 #[test]
-#[ignore = "Too slow"]
 fn test_mips_with_aggreg_fibo() -> anyhow::Result<()> {
     use plonky2x::backend::circuit::Groth16WrapperParameters;
     use plonky2x::backend::wrapper::wrap::WrappedCircuit;
@@ -138,7 +139,7 @@ fn test_mips_with_aggreg_fibo() -> anyhow::Result<()> {
 }
 
 #[test]
-#[ignore = "Too slow"]
+#[ignore = "Two slow"]
 fn test_mips_with_aggreg() -> anyhow::Result<()> {
     use plonky2x::backend::circuit::Groth16WrapperParameters;
     use plonky2x::backend::wrapper::wrap::WrappedCircuit;

diff --git a/runtime/entrypoint/Cargo.toml b/runtime/entrypoint/Cargo.toml
@@ -8,11 +8,9 @@ zkm-precompiles = { path = "../precompiles" }
 bincode = "1.3.3"
 cfg-if = "1.0.0"
 getrandom = { version = "0.2.14", features = ["custom"] }
-once_cell = "1.19.0"
 rand = "0.8.5"
 serde = { version = "1.0.201", features = ["derive"] }
 libm = { version = "0.2.8", optional = true }
-sha2 = { version = "0.10.8" }
 lazy_static = "1.4.0"
 
 [features]

diff --git a/runtime/precompiles/Cargo.toml b/runtime/precompiles/Cargo.toml
@@ -4,11 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-anyhow = "1.0.83"
 bincode = "1.3.3"
 cfg-if = "1.0.0"
-getrandom = { version = "0.2.14", features = ["custom"] }
-hex = "0.4.3"
-rand = "0.8.5"
 serde = { version = "1.0.201", features = ["derive"] }
-num = { version = "0.4.3" }