-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e88d71b
commit 2643ae5
Showing
5 changed files
with
150 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| // ANCHOR: dependencies | ||
| use std::{fs, sync::Arc}; | ||
|
|
||
| use eyre::Result; | ||
| use openvm::platform::memory::MEM_SIZE; | ||
| use openvm_build::GuestOptions; | ||
| use openvm_native_recursion::halo2::utils::CacheHalo2ParamsReader; | ||
| use openvm_sdk::{ | ||
| config::{AggConfig, AppConfig, SdkVmConfig}, | ||
| prover::AppProver, | ||
| Sdk, StdIn, | ||
| }; | ||
| use openvm_stark_sdk::config::FriParameters; | ||
| use openvm_transpiler::elf::Elf; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| #[derive(Serialize, Deserialize)] | ||
| pub struct SomeStruct { | ||
| pub a: u64, | ||
| pub b: u64, | ||
| } | ||
| // ANCHOR_END: dependencies | ||
|
|
||
| #[allow(dead_code, unused_variables)] | ||
| fn read_elf() -> Result<(), Box<dyn std::error::Error>> { | ||
| // ANCHOR: read_elf | ||
| // 2b. Load the ELF from a file | ||
| let elf_bytes = fs::read("your_path_to_elf")?; | ||
| let elf = Elf::decode(&elf_bytes, MEM_SIZE as u32)?; | ||
| // ANCHOR_END: read_elf | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[allow(unused_variables, unused_doc_comments)] | ||
| fn main() -> Result<(), Box<dyn std::error::Error>> { | ||
| // ANCHOR: vm_config | ||
| let vm_config = SdkVmConfig::builder() | ||
| .system(Default::default()) | ||
| .rv32i(Default::default()) | ||
| .rv32m(Default::default()) | ||
| .io(Default::default()) | ||
| .build(); | ||
| // ANCHOR_END: vm_config | ||
|
|
||
| /// to import example guest code in crate replace `target_path` for: | ||
| /// ``` | ||
| /// use std::path::PathBuf; | ||
| /// | ||
| /// let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).to_path_buf(); | ||
| /// path.push("guest"); | ||
| /// let target_path = path.to_str().unwrap(); | ||
| /// ``` | ||
| // ANCHOR: build | ||
| // 1. Build the VmConfig with the extensions needed. | ||
| let sdk = Sdk; | ||
|
|
||
| // 2a. Build the ELF with guest options and a target filter. | ||
| let guest_opts = GuestOptions::default(); | ||
| let target_path = "your_path_project_root"; | ||
| let elf = sdk.build(guest_opts, &target_path, &Default::default())?; | ||
| // ANCHOR_END: build | ||
|
|
||
| // ANCHOR: transpilation | ||
| // 3. Transpile the ELF into a VmExe | ||
| let exe = sdk.transpile(elf, vm_config.transpiler())?; | ||
| // ANCHOR_END: transpilation | ||
|
|
||
| // ANCHOR: execution | ||
| // 4. Format your input into StdIn | ||
| let my_input = SomeStruct { a: 1, b: 2 }; // anything that can be serialized | ||
| let mut stdin = StdIn::default(); | ||
| stdin.write(&my_input); | ||
|
|
||
| // 5. Run the program | ||
| let output = sdk.execute(exe.clone(), vm_config.clone(), stdin.clone())?; | ||
| println!("public values output: {:?}", output); | ||
| // ANCHOR_END: execution | ||
|
|
||
| // ANCHOR: proof_generation | ||
| // 6. Set app configuration | ||
| let app_log_blowup = 2; | ||
| let app_fri_params = FriParameters::standard_with_100_bits_conjectured_security(app_log_blowup); | ||
| let app_config = AppConfig::new(app_fri_params, vm_config); | ||
|
|
||
| // 7. Commit the exe | ||
| let app_committed_exe = sdk.commit_app_exe(app_fri_params, exe)?; | ||
|
|
||
| // 8. Generate an AppProvingKey | ||
| let app_pk = Arc::new(sdk.app_keygen(app_config)?); | ||
|
|
||
| // 9a. Generate a proof | ||
| let proof = sdk.generate_app_proof(app_pk.clone(), app_committed_exe.clone(), stdin.clone())?; | ||
| // 9b. Generate a proof with an AppProver with custom fields | ||
| let app_prover = AppProver::new(app_pk.app_vm_pk.clone(), app_committed_exe.clone()) | ||
| .with_program_name("test_program"); | ||
| let proof = app_prover.generate_app_proof(stdin.clone()); | ||
| // ANCHOR_END: proof_generation | ||
|
|
||
| // ANCHOR: verification | ||
| // 10. Verify your program | ||
| let app_vk = app_pk.get_vk(); | ||
| sdk.verify_app_proof(&app_vk, &proof)?; | ||
| // ANCHOR_END: verification | ||
|
|
||
| // ANCHOR: evm_verification | ||
| // 11. Generate the aggregation proving key | ||
| const DEFAULT_PARAMS_DIR: &str = concat!(env!("HOME"), "/.openvm/params/"); | ||
| let halo2_params_reader = CacheHalo2ParamsReader::new(DEFAULT_PARAMS_DIR); | ||
| let agg_config = AggConfig::default(); | ||
| let agg_pk = sdk.agg_keygen(agg_config, &halo2_params_reader)?; | ||
|
|
||
| // 12. Generate the SNARK verifier contract | ||
| let verifier = sdk.generate_snark_verifier_contract(&halo2_params_reader, &agg_pk)?; | ||
|
|
||
| // 13. Generate an EVM proof | ||
| let proof = sdk.generate_evm_proof( | ||
| &halo2_params_reader, | ||
| app_pk, | ||
| app_committed_exe, | ||
| agg_pk, | ||
| stdin, | ||
| )?; | ||
|
|
||
| // 14. Verify the EVM proof | ||
| let success = sdk.verify_evm_proof(&verifier, &proof); | ||
| assert!(success); | ||
| // ANCHOR_END: evm_verification | ||
|
|
||
| Ok(()) | ||
| } |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters