feat: upgrade project template (#71)

* feat: add zkMIPS template structure

* feat: add network prover.

* style: refactor code.

* docs: update docs

* chore: remove unused file.

* feat: add CI

* fix: CI

* chore: remove clippy

* fix: remove runner

Author: VanhGer

.env.example

@@ -0,0 +1,12 @@
+# Proof modes are `mock`, `local` and`network`.
+# `mock` is for generating mock proofs locally.
+# `local` is for generating proofs locally using the CPU.
+# `network` is for generating proofs using the ZKM Prover Network.
+# The default value is `local`.
+ZKM_PROVER=local
+
+# Network configuration
+# See more: https://docs.zkm.io/dev/prover.html#network-prover
+ZKM_PRIVATE_KEY=
+CERT_PATH=
+KEY_PATH=

.github/workflows/ci.yml

@@ -13,50 +13,12 @@ env:
   ZKM_SKIP_PROGRAM_BUILD: true
 
 jobs:
-  build_and_test:
-    name: Rust project - latest
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        toolchain:
-          - nightly
-    steps:
-      - uses: actions/checkout@v2
-      - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
-      - name: Install Dependencies
-        run: sudo apt install protobuf-compiler
-      - name: Install Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: '1.22'
-      - name: Cargo build
-        run: cargo build --verbose --release
-      - name: Cargo test
-        run: cargo test --release --verbose
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          profile: minimal
-          toolchain: nightly-2024-12-05
-          override: true
-      - run: rustup component add rustfmt
-      - run: cargo fmt --all -- --check
-  clippy:
-    name: Clippy
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: nightly-2024-12-05
-          override: true
-      - name: Install Dependencies
-        run: sudo apt install protobuf-compiler
-      - run: rustup component add clippy
-      - run: cargo clippy --all-targets -- -D warnings
-
+          components: rustfmt
+      - run: cargo fmt --all -- --check

.github/workflows/foundry-test.yml

@@ -0,0 +1,40 @@
+name: Foundry Test
+
+on: 
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+  pull_request:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          cd contracts
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          cd contracts
+          forge test -vvv
+        id: test

.github/workflows/prove.yml

@@ -0,0 +1,36 @@
+name: Build Program
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Build and Execute
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.85.0
+
+      - name: Install zkMIPS toolchain
+        run: curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/zkMIPS/toolchain/refs/heads/main/setup.sh | sh
+      - name: Install Dependencies
+        run: sudo apt install protobuf-compiler
+      - name: Execute zkMIPS program
+        run: |
+          source ~/.zkm-toolchain/env && cargo run --release -- --execute

.gitignore

@@ -7,3 +7,4 @@ libsnark.h
 libsnark.so
 *.log
 Cargo.lock
+.env

Cargo.toml

@@ -1,32 +1,10 @@
-[workspace]
-members = [
-   "host-program/sha2-go",
-   "host-program/sha2-rust",
-   "host-program/revme",
-   "host-program/mem-alloc-vec",
-   "host-program/sha2-composition",
-   "sdk"
-  ]
-resolver = "2"
-
-[workspace.dependencies]
-zkm-prover    = { git = "https://github.com/zkMIPS/zkm", branch = "main", default-features = false }
-zkm-emulator  = { git = "https://github.com/zkMIPS/zkm", branch = "main", default-features = false }
-zkm-recursion = { git = "https://github.com/zkMIPS/zkm", branch = "main", default-features = false }
-zkm-build     = { git = "https://github.com/zkMIPS/zkm", branch = "main", default-features = false }
-
-#zkm-prover    = { path = "../zkm/prover", default-features = false }
-#zkm-emulator  = { path = "../zkm/emulator", default-features = false }
-#zkm-recursion = { path = "../zkm/recursion", default-features = false }
-#zkm-build     = { path = "../zkm/build", default-features = false }
-
-[profile.release]
-opt-level = 3
-
-[profile.bench]
-opt-level = 3
-
-[profile.fast]
-inherits = "release"
-debug = true
-debug-assertions = true
+[workspace]
+members = [
+  "guest",
+   "host",
+   "lib"
+]
+resolver = "2"
+
+[workspace.dependencies]
+alloy-sol-types = "1.0"