Skip to content

Commit

Permalink
Update readme and run shell script (#26)
Browse files Browse the repository at this point in the history 
* debug sha2-rust

* update runxxx shell

* update the README

* update the fmt

* update the readme

* update readme

* update readme

* fix CI error and update host program

* add EXECUTE_ONLY=false in the run-xxx.sh

* update host program

* update run-xxx.sh

* fix CI error

* fix CI error

---------

Co-authored-by: [gavin-ygy] <[[email protected]]>
  • Loading branch information
@gavin-ygy
gavin-ygy and [gavin-ygy] authored Oct 9, 2024
1 parent bfca6ed commit 5f71e9d
Show file tree
Hide file tree
Showing 9 changed files with 310 additions and 317 deletions.
214 changes: 146 additions & 68 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,128 +87,206 @@ git clone https://github.com/zkMIPS/zkm-project-template.git

### 1. Build the guest program ELF

Please refer to [this](guest-program/README.md) guide
Please refer to [this](guest-program/README.md) guide.

### 2. Build the host program

```sh
cd zkm-project-template
sdk/src/local/libsnark/compile.sh # compile snark library
cargo build --release # build host programs
```

If the program executes successfully, it will generate one binary files in `target/release`: `zkm-prove`

> [!NOTE]
> The host program executes local proving when the environmental variable `ZKM_PROVER` is set to "local" and performs network proving when `ZKM_PROVER` is set to "network"
> You can run the guest program without generating a proof by setting the environmental variable `EXECUTE_ONLY` to "true".https://github.com/zkMIPS/zkm/issues/152
### 3. Generate groth16 proof and verifier contract

```sh
cd host-program
cd zkm-project-template/host-program
```

> [!NOTE]
> You can run the guest program without generating a proof by setting the environmental variable `EXECUTE_ONLY` to "true".https://github.com/zkMIPS/zkm/issues/152
> 1. The host program executes local proving when the environmental variable `ZKM_PROVER` is set to "local" and performs network proving when `ZKM_PROVER` is set to "network"
> 2. There are two script programs available: run_local_proving.sh and run_network_proving.sh. These scripts facilitate the
generation of proofs on the local machine and over the proof network, respectively.

> 3. There are three guest programs(sha2-rust, sha2-go, mem-alloc-vec), each capable of generating a SNARK proof on a machine
equipped with an AMD EPYC 7R13 processor and 250GB of memory. The following will use sha2-rust as an example to demonstrate local and network proofs.

> [!WARNING]
> The environmental variable `SEG_SIZE` in the run-xxx_proving.sh affects the final proof generation.
> The guest program's ELF with the input is split into segments according the SEG_SIZE, based on the cycle count.
> When generating proofs on the local machine, if the log shows "!!!*******seg_num: 1", please reduce SEG_SIZE or increase the input. If generating proofs through the proof network, SEG_SIZE must be within the range [65536, 262144].
### Example : `sha2-go`
### Example : `sha2-rust`

This program takes struct Data as public input
This host program sends the private input pri_input = vec![5u8; 1024] and its hash (hash(pri_input)) to the guest program for verification of the hash value.

#### Local Proving

Make any edits to [`run-local-proving.sh`](host-program/run-local-proving.sh) and run the program:

```sh
./run-local-proving.sh sha2-go
./run-local-proving.sh sha2-rust
```

If successful, it will output a similar log:

##### **`sha2-go-local-proving.log`**

```
[2024-10-07T08:11:59Z INFO zkm_prove] new prover client.
[2024-10-07T08:11:59Z INFO zkm_prove] new prover client,ok.
[2024-10-07T08:11:59Z INFO zkm_sdk::local::prover] calling request_proof.
[2024-10-07T08:11:59Z INFO zkm_sdk::local::prover] calling wait_proof, proof_id=f8a8243f-8631-4f92-916c-754a438d8c57
[2024-10-07T08:11:59Z INFO zkm_sdk::local::prover] waiting the proof result.
[2024-10-07T08:11:59Z INFO zkm_emulator::utils] Split done 347823 : 446125
[2024-10-07T08:12:51Z INFO zkm_sdk::local::util] Process segment /tmp/f8a8243f-8631-4f92-916c-754a438d8c57/input/segments/0
[2024-10-07T08:12:55Z INFO zkm_prover::cpu::bootstrap_kernel] Bootstrapping took 21159 cycles
[2024-10-07T08:12:55Z INFO zkm_prover::generation] CPU halted after 261370 cycles
[2024-10-07T08:12:55Z INFO zkm_prover::generation] CPU trace padded to 262144 cycles
[2024-10-07T08:12:55Z INFO zkm_prover::generation] Trace lengths (before padding): TraceCheckpoint { arithmetic_len: 131963, cpu_len: 262144, poseidon_len: 21158, poseidon_sponge_len: 21158, logic_len: 16739, memory_len: 1949524 }
[2024-10-07T08:13:42Z INFO plonky2::util::timing] 50.7883s to prove root first
[2024-10-07T08:13:42Z INFO zkm_sdk::local::util] Process segment /tmp/f8a8243f-8631-4f92-916c-754a438d8c57/input/segments/1
[2024-10-07T08:13:46Z INFO zkm_prover::cpu::bootstrap_kernel] Bootstrapping took 21804 cycles
[2024-10-07T08:13:46Z INFO zkm_prover::generation] CPU halted after 129420 cycles
[2024-10-07T08:13:46Z INFO zkm_prover::generation] CPU trace padded to 131072 cycles
[2024-10-07T08:13:46Z INFO zkm_prover::generation] Trace lengths (before padding): TraceCheckpoint { arithmetic_len: 44577, cpu_len: 131072, poseidon_len: 21803, poseidon_sponge_len: 21803, logic_len: 5164, memory_len: 1362331 }
[2024-10-07T08:14:20Z INFO plonky2::util::timing] 37.3177s to prove root second
[2024-10-07T08:14:21Z INFO plonky2::util::timing] 1.3277s to prove aggression
[2024-10-07T08:14:23Z INFO zkm_sdk::local::util] proof size: 412755
[2024-10-07T08:14:29Z INFO zkm_sdk::local::util] build finish
[2024-10-07T08:14:35Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote common circuit data to common_circuit_data.json
[2024-10-07T08:14:35Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote verifier data to verifier_only_circuit_data.json
[2024-10-07T08:14:35Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote proof to proof_with_public_inputs.json
[2024-10-07T08:14:35Z INFO plonky2::util::timing] 156.1002s to prove total time
08:14:39 INF compiling circuit
08:14:39 INF parsed circuit inputs nbPublic=1 nbSecret=11182
08:15:11 INF building constraint builder nbConstraints=5815132
Generating witness 2024-10-07 08:21:33.36586361 +0000 UTC m=+573.868286665
frontend.NewWitness cost time: 171 ms
Creating proof 2024-10-07 08:21:33.536971193 +0000 UTC m=+574.039394228
08:21:39 DBG constraint system solver done nbConstraints=5815132 took=5950.579212
08:21:47 DBG prover done acceleration=none backend=groth16 curve=bn254 nbConstraints=5815132 took=7963.861692
groth16.Prove cost time: 13914 ms
Verifying proof 2024-10-07 08:21:47.451908504 +0000 UTC m=+587.954331579
08:21:47 DBG verifier done backend=groth16 curve=bn254 took=1.707085
##### **`sha2-rust-local-proving.log`**

```
[2024-10-09T03:31:00Z INFO zkm_prove] new prover client.
[2024-10-09T03:31:00Z INFO zkm_prove] new prover client,ok.
[2024-10-09T03:31:00Z INFO zkm_sdk::local::prover] calling request_proof.
[2024-10-09T03:31:00Z INFO zkm_sdk::local::prover] calling wait_proof, proof_id=5c14330a-cc5a-4ad8-9ba4-3996ddafbc57
[2024-10-09T03:31:00Z INFO zkm_sdk::local::prover] waiting the proof result.
[2024-10-09T03:31:00Z INFO zkm_emulator::utils] Split done 66446 : 89443
[2024-10-09T03:31:00Z INFO zkm_sdk::local::stark] !!!*******seg_num:2
[2024-10-09T03:32:01Z INFO zkm_sdk::local::util] Process segment /tmp/5c14330a-cc5a-4ad8-9ba4-3996ddafbc57/input/segments/0
[2024-10-09T03:32:05Z INFO zkm_prover::cpu::bootstrap_kernel] Bootstrapping took 3228 cycles
[2024-10-09T03:32:05Z INFO zkm_prover::generation] CPU halted after 64762 cycles
[2024-10-09T03:32:05Z INFO zkm_prover::generation] CPU trace padded to 65536 cycles
[2024-10-09T03:32:05Z INFO zkm_prover::generation] Trace lengths (before padding): TraceCheckpoint { arithmetic_len: 18057, cpu_len: 65536, poseidon_len: 3227, poseidon_sponge_len: 3227, logic_len: 15372, memory_len: 390244 }
[2024-10-09T03:32:22Z INFO plonky2::util::timing] 20.9778s to prove root first
[2024-10-09T03:32:22Z INFO zkm_sdk::local::util] Process segment /tmp/5c14330a-cc5a-4ad8-9ba4-3996ddafbc57/input/segments/1
[2024-10-09T03:32:26Z INFO zkm_prover::cpu::bootstrap_kernel] Bootstrapping took 2583 cycles
[2024-10-09T03:32:26Z INFO zkm_prover::generation] CPU halted after 7530 cycles
[2024-10-09T03:32:26Z INFO zkm_prover::generation] CPU trace padded to 8192 cycles
[2024-10-09T03:32:26Z INFO zkm_prover::generation] Trace lengths (before padding): TraceCheckpoint { arithmetic_len: 1511, cpu_len: 8192, poseidon_len: 2582, poseidon_sponge_len: 2582, logic_len: 1157, memory_len: 123358 }
[2024-10-09T03:32:38Z INFO plonky2::util::timing] 15.7468s to prove root second
[2024-10-09T03:32:40Z INFO plonky2::util::timing] 1.4158s to prove aggression
[2024-10-09T03:32:42Z INFO zkm_sdk::local::util] proof size: 412960
[2024-10-09T03:32:48Z INFO zkm_sdk::local::util] build finish
[2024-10-09T03:32:55Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote common circuit data to common_circuit_data.json
[2024-10-09T03:32:55Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote verifier data to verifier_only_circuit_data.json
[2024-10-09T03:32:55Z INFO plonky2x::backend::wrapper::wrap] Succesfully wrote proof to proof_with_public_inputs.json
[2024-10-09T03:32:55Z INFO plonky2::util::timing] 114.2421s to prove total time
03:32:59 INF compiling circuit
03:32:59 INF parsed circuit inputs nbPublic=1 nbSecret=11182
03:33:39 INF building constraint builder nbConstraints=5815132
Generating witness 2024-10-09 03:40:27.357393651 +0000 UTC m=+565.926341691
frontend.NewWitness cost time: 130 ms
Creating proof 2024-10-09 03:40:27.487971493 +0000 UTC m=+566.056919503
03:40:32 DBG constraint system solver done nbConstraints=5815132 took=5409.755661
03:40:40 DBG prover done acceleration=none backend=groth16 curve=bn254 nbConstraints=5815132 took=7795.659351
groth16.Prove cost time: 13205 ms
Verifying proof 2024-10-09 03:40:40.69365127 +0000 UTC m=+579.262599280
03:40:40 DBG verifier done backend=groth16 curve=bn254 took=1.583203
groth16.Verify cost time: 1 ms
before len of publicWitness:1
after len of publicWitness:2
08:21:47 DBG verifier done backend=groth16 curve=bn254 took=1.244218
[2024-10-07T08:21:47Z INFO zkm_prove] Proof: successfully written 1260 bytes.
[2024-10-07T08:21:47Z INFO zkm_prove] Contract: successfully written 10330 bytes.
[2024-10-07T08:21:47Z INFO zkm_prove] Generating proof successfully .The proof file and verifier contract are in the the path contracts/verifier and contracts/src .
[2024-10-07T08:21:47Z INFO zkm_prove] Elapsed time: 587 secs
03:40:40 DBG verifier done backend=groth16 curve=bn254 took=1.247698
[2024-10-09T03:40:40Z INFO zkm_prove] Proof: successfully written 1265 bytes.
[2024-10-09T03:40:40Z INFO zkm_prove] Contract: successfully written 10334 bytes.
[2024-10-09T03:40:40Z INFO zkm_prove] Generating proof successfully .The proof file and verifier contract are in the the path contracts/verifier and contracts/src .
[2024-10-09T03:40:40Z INFO zkm_prove] Elapsed time: 579 secs
```

The proof and contract file will be in the contracts/verifier and contracts/src
The result proof and contract file will be in the contracts/verifier and contracts/src respectively.

#### Network Proving

Make any edits to [`run-network-proving.sh`](host-program/run-network-proving.sh) and run the program:
> [!NOTE]
> The proving network may sometimes experience high traffic, causing proof tasks to be queued for hours.
> The proving task requires several stages: queuing, splitting, proving, aggregating and finalizing. Each stage involves a varying duration.
Must set the `PRIVATE_KEY` in [`run-network-proving.sh`](host-program/run-network-proving.sh) and run the program:

```sh
./run-network-proving.sh sha2-go
./run-network-proving.sh sha2-rust
```

If successful, it will output a similar log:

##### **`sha2-go-network-proving.log`**
##### **`sha2-rust-network-proving.log`**

```
[2024-10-07T08:42:02Z INFO zkm_prove] new prover client.
[2024-10-07T08:42:02Z INFO zkm_prove] new prover client,ok.
[2024-10-07T08:42:02Z INFO zkm_sdk::network::prover] calling request_proof.
[2024-10-07T08:42:04Z INFO zkm_sdk::network::prover] calling wait_proof, proof_id=d9a9bf8f-aff5-4103-af9e-b14ac6556a45
[2024-10-07T08:42:05Z INFO zkm_sdk::network::prover] generate_proof : queuing the task.
[2024-10-07T08:42:35Z INFO zkm_sdk::network::prover] generate_proof : aggregating the proof.
[2024-10-07T08:43:07Z INFO zkm_prove] Proof: successfully written 1268 bytes.
[2024-10-07T08:43:07Z INFO zkm_prove] Contract: successfully written 10329 bytes.
[2024-10-07T08:43:07Z INFO zkm_prove] Generating proof successfully .The proof file and verifier contract are in the the path contracts/verifier and contracts/src .
[2024-10-07T08:43:07Z INFO zkm_prove] Elapsed time: 64 secs
[2024-10-09T03:55:06Z INFO zkm_prove] new prover client.
[2024-10-09T03:55:07Z INFO zkm_prove] new prover client,ok.
[2024-10-09T03:55:07Z INFO zkm_sdk::network::prover] calling request_proof.
[2024-10-09T03:55:10Z INFO zkm_sdk::network::prover] calling wait_proof, proof_id=fccd67f1-0bb3-498d-a048-50578b4a6360
[2024-10-09T03:55:10Z INFO zkm_sdk::network::prover] generate_proof : queuing the task.
[2024-10-09T03:55:40Z INFO zkm_sdk::network::prover] generate_proof : finalizing the proof.
[2024-10-09T03:56:14Z INFO zkm_prove] Proof: successfully written 1262 bytes.
[2024-10-09T03:56:14Z INFO zkm_prove] Contract: successfully written 10329 bytes.
[2024-10-09T03:56:14Z INFO zkm_prove] Generating proof successfully .The proof file and verifier contract are in the the path contracts/verifier and contracts/src .
[2024-10-09T03:56:14Z INFO zkm_prove] Elapsed time: 66 secs
```

The proof and contract file will be in the contracts/verifier and contracts/src
The result proof and contract file will be in the contracts/verifier and contracts/src.

#### 4. Deploy the Verifier Contract
### 4. Deploy the Verifier Contract

If your system does not has Foundry, please install it:

```sh
curl -L https://foundry.paradigm.xyz | bash
```
#### Verify the snark proof generateing in the step 3

```
cd zkm-project-template/contracts
forge test
```

If successful, it will output a similar log:

```
[⠊] Compiling...
[⠊] Compiling 2 files with Solc 0.8.26
[⠢] Solc 0.8.26 finished in 921.86ms
Compiler run successful!
Ran 1 test for test/verifier.t.sol:VerifierTest
[PASS] test_ValidProof() (gas: 286833)
Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 8.16ms (7.51ms CPU time)
Ran 1 test suite in 9.02ms (8.16ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests)
```

#### Deploy the contract generateing in the step 3

Please edit the following parameters according your aim blockchain.

```
forge script script/verifier.s.sol:VerifierScript --rpc-url https://eth-sepolia.g.alchemy.com/v2/RH793ZL_pQkZb7KttcWcTlOjPrN0BjOW --private-key df4bc5647fdb9600ceb4943d4adff3749956a8512e5707716357b13d5ee687d9
```

If successful, it will output a similar log:

```
[⠊] Compiling...
[⠘] Compiling 2 files with Solc 0.8.26
[⠊] Solc 0.8.26 finished in 699.26ms
Compiler run successful!
Script ran successfully.
## Setting up 1 EVM.
==========================
Chain 11155111
Estimated gas price: 0.000035894 gwei
Estimated total gas used for script: 1228147
Estimated amount required: 0.000000044083108418 ETH
==========================
SIMULATION COMPLETE. To broadcast these transactions, add --broadcast and wallet configuration(s) to the previous command. See forge script --help for more.
Transactions saved to: /mnt/data/zkm-project-template/contracts/broadcast/verifier.s.sol/11155111/dry-run/run-latest.json
Sensitive values saved to: /mnt/data/zkm-project-template/contracts/cache/verifier.s.sol/11155111/dry-run/run-latest.json
```

Next, deploy the contract as detailed in [this](contracts/README.md) guide
For more details, please refer to [this](contracts/README.md) guide.
Loading

0 comments on commit 5f71e9d

Please sign in to comment.