refactor for workspace

Rename config.json to template

Signed-off-by: noelwei <fan@scroll.io>

Cargo.toml

@@ -0,0 +1,62 @@
+[workspace]
+members = [
+  "common/libzkp/impl",
+  "zkvm-prover",
+]
+
+resolver = "2"
+
+[workspace.package]
+authors = ["Scroll developers"]
+edition = "2021"
+homepage = "https://scroll.io"
+readme = "README.md"
+repository = "https://github.com/scroll-tech/scroll"
+version = "4.5.8"
+
+[workspace.dependencies]
+scroll-zkvm-prover-euclid = { git = "https://github.com/scroll-tech/zkvm-prover", branch = "feat/sep_types", package = "scroll-zkvm-prover" }
+scroll-zkvm-verifier-euclid = { git = "https://github.com/scroll-tech/zkvm-prover", branch = "feat/sep_types", package = "scroll-zkvm-verifier" }
+
+sbv-primitives = { git = "https://github.com/scroll-tech/stateless-block-verifier", branch = "zkvm/euclid-upgrade", features = ["scroll"] }
+
+metrics = "0.23.0"
+metrics-util = "0.17"
+metrics-tracing-context = "0.16.0"
+
+anyhow = "1.0"
+alloy = { version = "0.11", default-features = false }
+alloy-primitives = { version = "0.8", default-features = false }
+# also use this to trigger "serde" feature for primitives
+alloy-serde = { version = "0.8", default-features = false }
+
+rkyv = "0.8"
+serde = { version = "1", default-features = false, features = ["derive"] }
+serde_json = { version = "1.0" }
+serde_derive = "1.0"
+serde_with = "3.11.0"
+itertools = "0.14"
+tiny-keccak = "2.0"
+tracing = "0.1"
+eyre = "0.6"
+bincode_v1 = { version = "1.3", package = "bincode"}
+snark-verifier-sdk = { version = "0.2.0", default-features = false, features = [
+    "loader_halo2",
+    "halo2-axiom",
+    "display",
+] }
+once_cell = "1.20"
+base64 = "0.22"
+
+#TODO: upgrade
+vm-zstd = { git = "https://github.com/scroll-tech/rust-zstd-decompressor.git", tag = "v0.1.1" }
+
+[patch.crates-io]
+alloy-primitives = { git = "https://github.com/scroll-tech/alloy-core", branch = "v0.8.18-euclid-upgrade" }
+ruint = { git = "https://github.com/scroll-tech/uint.git", branch = "v1.12.3" }
+tiny-keccak = { git = "https://github.com/scroll-tech/tiny-keccak", branch = "scroll-patch-v2.0.2-euclid-upgrade" }
+
+[profile.maxperf]
+inherits = "release"
+lto = "fat"
+codegen-units = 1

common/libzkp/impl/Cargo.toml

@@ -7,25 +7,18 @@ edition = "2021"
 [lib]
 crate-type = ["cdylib"]
 
-[patch.crates-io]
-# patched add rkyv support & MSRV 1.77
-alloy-primitives = { git = "https://github.com/scroll-tech/alloy-core", branch = "v0.8.21" }
-ruint = { git = "https://github.com/scroll-tech/uint.git", branch = "v1.12.3" }
-tiny-keccak = { git = "https://github.com/scroll-tech/tiny-keccak", branch = "scroll-patch-v2.0.2-openvm-v1.0.0-rc.1" }
-
 [dependencies]
-euclid_prover = { git = "https://github.com/scroll-tech/zkvm-prover.git", tag = "v0.4.2", package = "scroll-zkvm-prover" }
-euclid_verifier = { git = "https://github.com/scroll-tech/zkvm-prover.git", tag = "v0.4.2", package = "scroll-zkvm-verifier" }
+scroll-zkvm-verifier-euclid.workspace = true
+
+base64.workspace = true
+once_cell.workspace = true
+serde.workspace = true
+serde_derive.workspace = true
+serde_json.workspace = true
+anyhow.workspace = true
+tracing.workspace = true
 
-base64 = "0.13.0"
-env_logger = "0.9.0"
 libc = "0.2"
-log = "0.4"
-once_cell = "1.19"
-serde = "1.0"
-serde_derive = "1.0"
-serde_json = "1.0.66"
-anyhow = "1.0.86"
 
 [profile.test]
 opt-level = 3
@@ -33,34 +26,3 @@ opt-level = 3
 [profile.release]
 opt-level = 3
 
-[patch."https://github.com/openvm-org/stark-backend.git"]
-openvm-stark-backend = { git = "ssh://git@github.com/scroll-tech/openvm-stark-gpu.git", branch = "main", features = ["gpu"] }
-openvm-stark-sdk = { git = "ssh://git@github.com/scroll-tech/openvm-stark-gpu.git", branch = "main", features = ["gpu"] }
-
-[patch."https://github.com/Plonky3/Plonky3.git"]
-p3-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-field = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-commit = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-matrix = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-baby-bear = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", features = [
-    "nightly-features",
-], tag = "v0.2.0" }
-p3-koala-bear = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-util = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-challenger = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-dft = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-fri = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-goldilocks = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-keccak = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-keccak-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-blake3 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-mds = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-merkle-tree = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-monty-31 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon2 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon2-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-symmetric = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-uni-stark = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-maybe-rayon = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" } # the "parallel" feature is NOT on by default to allow single-threaded benchmarking
-p3-bn254-fr = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }

common/libzkp/impl/src/lib.rs

@@ -30,12 +30,12 @@ fn verify_proof(proof: *const c_char, fork_name: *const c_char, task_type: TaskT
     let verifier = verifier::get_verifier(fork_name_str);
 
     if let Err(e) = verifier {
-        log::warn!("failed to get verifier, error: {:#}", e);
+        tracing::warn!("failed to get verifier, error: {:#}", e);
         return 0 as c_char;
     }
     match verifier.unwrap().verify(task_type, proof) {
         Err(e) => {
-            log::error!("{:?} verify failed, error: {:#}", task_type, e);
+            tracing::error!("{:?} verify failed, error: {:#}", task_type, e);
             false as c_char
         }
         Ok(result) => result as c_char,

common/libzkp/impl/src/verifier/euclidv2.rs

@@ -4,7 +4,7 @@ use anyhow::Result;
 
 use crate::utils::panic_catch;
 use euclid_prover::{BatchProof, BundleProof, ChunkProof};
-use euclid_verifier::verifier::{BatchVerifier, BundleVerifierEuclidV2, ChunkVerifier};
+use scroll_zkvm_verifier_euclid::verifier::{BatchVerifier, BundleVerifierEuclidV2, ChunkVerifier};
 use std::{fs::File, path::Path};
 
 pub struct EuclidV2Verifier {

rust-toolchain

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "nightly-2025-02-14"
+targets = ["riscv32im-unknown-none-elf", "x86_64-unknown-linux-gnu"]

zkvm-prover/.work/.gitignore

@@ -0,0 +1 @@
+*.vmexe

zkvm-prover/.work/batch/openvm.toml

@@ -0,0 +1,34 @@
+[app_fri_params.fri_params]
+log_blowup = 1
+log_final_poly_len = 0
+num_queries = 100
+proof_of_work_bits = 16
+
+[app_vm_config.rv32i]
+
+[app_vm_config.rv32m]
+
+[app_vm_config.io]
+
+[app_vm_config.keccak]
+
+[app_vm_config.castf]
+
+[app_vm_config.modular]
+supported_modulus = [
+    "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787",
+    "52435875175126190479447740508185965837690552500527637822603658699938581184513",
+]
+[app_vm_config.native]
+[app_vm_config.pairing]
+supported_curves = ["Bls12_381"]
+[app_vm_config.sha256]
+[app_vm_config.fp2]
+supported_modulus = [
+    "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787",
+]
+[[app_vm_config.ecc.supported_curves]]
+modulus = "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787"
+scalar = "52435875175126190479447740508185965837690552500527637822603658699938581184513"
+a = "0"
+b = "4"

zkvm-prover/.work/bundle/openvm.toml

@@ -0,0 +1,17 @@
+[app_fri_params.fri_params]
+log_blowup = 1
+log_final_poly_len = 0
+num_queries = 100
+proof_of_work_bits = 16
+
+[app_vm_config.rv32i]
+
+[app_vm_config.rv32m]
+
+[app_vm_config.io]
+
+[app_vm_config.keccak]
+
+[app_vm_config.castf]
+
+[app_vm_config.native]

zkvm-prover/.work/chunk/openvm.toml

@@ -0,0 +1,53 @@
+[app_fri_params.fri_params]
+log_blowup = 1
+log_final_poly_len = 0
+num_queries = 100
+proof_of_work_bits = 16
+
+[app_vm_config.rv32i]
+
+[app_vm_config.io]
+
+[app_vm_config.keccak]
+
+[app_vm_config.rv32m]
+range_tuple_checker_sizes = [256, 8192]
+
+[app_vm_config.bigint]
+range_tuple_checker_sizes = [256, 8192]
+
+[app_vm_config.modular]
+supported_modulus = [
+    "21888242871839275222246405745257275088696311157297823662689037894645226208583", 
+    "21888242871839275222246405745257275088548364400416034343698204186575808495617", 
+    "115792089237316195423570985008687907853269984665640564039457584007908834671663", 
+    "115792089237316195423570985008687907852837564279074904382605163141518161494337",
+    "115792089210356248762697446949407573530086143415290314195533631308867097853951",
+    "115792089210356248762697446949407573529996955224135760342422259061068512044369"
+]
+
+[app_vm_config.fp2]
+supported_modulus = ["21888242871839275222246405745257275088696311157297823662689037894645226208583"]
+
+[app_vm_config.pairing]
+supported_curves = ["Bn254"]
+
+[app_vm_config.sha256]
+
+[[app_vm_config.ecc.supported_curves]]
+modulus = "115792089237316195423570985008687907853269984665640564039457584007908834671663"
+scalar = "115792089237316195423570985008687907852837564279074904382605163141518161494337"
+a = "0"
+b = "7"
+
+[[app_vm_config.ecc.supported_curves]]
+modulus = "115792089210356248762697446949407573530086143415290314195533631308867097853951"
+scalar = "115792089210356248762697446949407573529996955224135760342422259061068512044369"
+a = "115792089210356248762697446949407573530086143415290314195533631308867097853948"
+b = "41058363725152142129326129780047268409114441015993725554835256314039467401291"
+
+[[app_vm_config.ecc.supported_curves]]
+modulus = "21888242871839275222246405745257275088696311157297823662689037894645226208583"
+scalar = "21888242871839275222246405745257275088548364400416034343698204186575808495617"
+a = "0"
+b = "3"

zkvm-prover/.work/download-release.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# release version
+if [ -z "${SCROLL_ZKVM_VERSION}" ]; then
+    SCROLL_ZKVM_VERSION=$($SHELL ./print_high_zkvm_version.sh | cut -d' ' -f1|cut -c2-)
+fi
+
+echo $SCROLL_ZKVM_VERSION
+
+# chunk-circuit exe
+wget https://circuit-release.s3.us-west-2.amazonaws.com/scroll-zkvm/releases/$SCROLL_ZKVM_VERSION/chunk/app.vmexe -O .work/chunk/app.vmexe
+
+# batch-circuit exe
+wget https://circuit-release.s3.us-west-2.amazonaws.com/scroll-zkvm/releases/$SCROLL_ZKVM_VERSION/batch/app.vmexe -O .work/batch/app.vmexe
+
+# bundle-circuit exe
+wget https://circuit-release.s3.us-west-2.amazonaws.com/scroll-zkvm/releases/$SCROLL_ZKVM_VERSION/bundle/app.vmexe -O .work/bundle/app.vmexe
+
+# bundle-circuit exe, legacy version, may not exist
+wget https://circuit-release.s3.us-west-2.amazonaws.com/scroll-zkvm/releases/$SCROLL_ZKVM_VERSION/bundle/app_euclidv1.vmexe -O .work/bundle/app_euclidv1.vmexe || echo "legacy app not exist for $SCROLL_ZKVM_VERSION"

zkvm-prover/Cargo.toml

@@ -5,38 +5,25 @@ edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
-[patch.crates-io]
-alloy-primitives = { git = "https://github.com/scroll-tech/alloy-core", branch = "v0.8.21" }
-ruint = { git = "https://github.com/scroll-tech/uint.git", branch = "v1.12.3" }
-tiny-keccak = { git = "https://github.com/scroll-tech/tiny-keccak", branch = "scroll-patch-v2.0.2-openvm-v1.0.0-rc.1" }
-
 [dependencies]
-anyhow = "1.0"
-log = "0.4"
-env_logger = "0.11.3"
-serde = { version = "1.0.198", features = ["derive"] }
-serde_json = "1.0.116"
+scroll-zkvm-prover-euclid.workspace = true
+sbv-primitives.workspace = true
+scroll-proving-sdk = { git = "https://github.com/scroll-tech/scroll-proving-sdk.git", branch = "refactor/scroll" }
+serde.workspace = true
+serde_json.workspace = true
+once_cell.workspace =true
+base64.workspace = true
+tiny-keccak = { workspace = true, features = ["sha3", "keccak"] }
+anyhow.workspace = true
+
 futures = "0.3.30"
 
-scroll-zkvm-prover-euclid = { git = "https://github.com/scroll-tech/zkvm-prover", tag = "v0.4.2", package = "scroll-zkvm-prover" }
-ethers-core = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
-ethers-providers = { git = "https://github.com/scroll-tech/ethers-rs.git", branch = "v2.0.7" }
-scroll-proving-sdk = { git = "https://github.com/scroll-tech/scroll-proving-sdk.git", branch = "main", features = [
-    "openvm",
-] }
-sbv-primitives = { git = "https://github.com/scroll-tech/stateless-block-verifier", branch = "zkvm/euclid-upgrade", features = [
-    "scroll",
-] }
-base64 = "0.13.1"
 reqwest = { version = "0.12.4", features = ["gzip"] }
 reqwest-middleware = "0.3"
 reqwest-retry = "0.5"
-once_cell = "1.19.0"
 hex = "0.4.3"
-tiny-keccak = { version = "2.0.0", features = ["sha3", "keccak"] }
+
 rand = "0.8.5"
-eth-keystore = "0.5.0"
-rlp = "0.5.2"
 tokio = "1.37.0"
 async-trait = "0.1"
 sled = "0.34.7"
@@ -45,35 +32,3 @@ clap = { version = "4.5", features = ["derive"] }
 ctor = "0.2.8"
 url = "2.5.4"
 serde_bytes = "0.11.15"
-
-[patch."https://github.com/openvm-org/stark-backend.git"]
-openvm-stark-backend = { git = "ssh://git@github.com/scroll-tech/openvm-stark-gpu.git", branch = "main", features = ["gpu"] }
-openvm-stark-sdk = { git = "ssh://git@github.com/scroll-tech/openvm-stark-gpu.git", branch = "main", features = ["gpu"] }
-
-[patch."https://github.com/Plonky3/Plonky3.git"]
-p3-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-field = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-commit = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-matrix = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-baby-bear = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", features = [
-    "nightly-features",
-], tag = "v0.2.0" }
-p3-koala-bear = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-util = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-challenger = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-dft = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-fri = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-goldilocks = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-keccak = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-keccak-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-blake3 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-mds = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-merkle-tree = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-monty-31 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon2 = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-poseidon2-air = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-symmetric = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-uni-stark = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }
-p3-maybe-rayon = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" } # the "parallel" feature is NOT on by default to allow single-threaded benchmarking
-p3-bn254-fr = { git = "ssh://git@github.com/scroll-tech/plonky3-gpu.git", tag = "v0.2.0" }

zkvm-prover/Makefile

@@ -1,5 +1,10 @@
 .PHONY: prover lint tests_binary
 
+RUST_MIN_STACK ?= 16777216
+export RUST_MIN_STACK
+
+CIRCUIT_STUFF = .work/chunk/app.vmexe .work/batch/app.vmexe .work/bundle/app.vmexe
+
 ifeq (4.3,$(firstword $(sort $(MAKE_VERSION) 4.3)))
     PLONKY3_VERSION=$(shell grep -m 1 "Plonky3.git" ./Cargo.lock | cut -d "#" -f2 | cut -c-7)
 else
@@ -46,3 +51,9 @@ lint:
 	cargo check --all-features
 	cargo clippy --all-features --all-targets -- -D warnings
 	cargo fmt --all
+
+$(CIRCUIT_STUFF):
+	bash .work/download-release.sh
+
+test_run: $(CIRCUIT_STUFF)
+	GO_TAG=${GO_TAG} GIT_REV=${GIT_REV} ZK_VERSION=${ZK_VERSION} cargo run --release -- --config ./config.json

zkvm-prover/README.md

@@ -0,0 +1,11 @@
+## Prover
+
+A runnable zkvm prover which can communicate with coordinator, receving proving task and generate proof
+
+## Testing
+
++ Get the url of the endpoint of coordinator and a rpc endpoint response to the cooresponding chain
+
++ Build a `config.json` file with previous knowledge from the template in current directory
+
++ Call `make test_run`

zkvm-prover/config.json.template

@@ -1,15 +1,15 @@
 {
   "sdk_config": {
-    "prover_name_prefix": "prover-1",
-    "keys_dir": "keys",
+    "prover_name_prefix": "test-prover",
+    "keys_dir": ".work",
     "coordinator": {
-      "base_url": "http://localhost:8555",
+      "base_url": "<the url of coordinator>",
       "retry_count": 10,
       "retry_wait_time_sec": 10,
       "connection_timeout_sec": 30
     },
     "l2geth": {
-      "endpoint": "http://localhost:9999"
+      "endpoint": "<the url of rpc endpoint>"
     },
     "prover": {
       "circuit_type": 2,
@@ -20,12 +20,12 @@
       ],
       "circuit_version": "v0.13.1"
     },
-    "db_path": "unique-db-path-for-prover-1"
+    "db_path": ".work/db"
   },
   "circuits": {
     "euclidV2": {
       "hard_fork_name": "euclidV2",
-      "workspace_path": "/home/ubuntu/prover-workdir"
+      "workspace_path": ".work"
     }
   }
 }

zkvm-prover/rust-toolchain

@@ -1 +0,0 @@
-nightly-2024-12-06

zkvm-prover/src/types.rs

@@ -1,11 +1,8 @@
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
-use scroll_proving_sdk::prover::types::CircuitType;
-
 #[derive(Serialize, Deserialize, Default)]
 pub struct Task {
     #[serde(rename = "type", default)]
-    pub task_type: CircuitType,
     pub task_data: String,
     #[serde(default)]
     pub hard_fork_name: String,
@@ -15,7 +12,6 @@ pub struct Task {
 pub struct ProofDetail {
     pub id: String,
     #[serde(rename = "type", default)]
-    pub proof_type: CircuitType,
     pub proof_data: String,
     pub error: String,
 }