fix(cli): fix naming

zkmopro · Oct 25, 2024 · 59b3b2b · 59b3b2b
1 parent af5e4a8
commit 59b3b2b
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 30 deletions.
diff --git a/cli/src/init.rs b/cli/src/init.rs
@@ -187,7 +187,7 @@ fn circom_build_template(file_path: &str) -> Result<(), Box<dyn Error>> {
 
 fn halo2_dependencies_template(file_path: &str) -> Result<(), Box<dyn Error>> {
     let replacement =
-        "halo2-fibonacci = { git = \"https://github.com/ElusAegis/halo2-fibonacci-sample.git\" }";
+        "plonk-fibonacci = { package = \"plonk-fibonacci\", git = \"https://github.com/sifnoc/plonkish-fibonacci-sample.git\" }";
     let target = "# HALO2_DEPENDENCIES";
     replace_string_in_file(file_path, target, replacement)
 }

diff --git a/cli/src/template/android/app/src/main/java/com/example/moproapp/FibonacciComponent.kt b/cli/src/template/android/app/src/main/java/com/example/moproapp/FibonacciComponent.kt
@@ -30,9 +30,9 @@ fun FibonacciComponent() {
         )
     }
 
-    val srsPath = getFilePathFromAssets("fibonacci_srs.bin")
-    val provingKeyPath = getFilePathFromAssets("fibonacci_pk.bin")
-    val verifyingKeyPath = getFilePathFromAssets("fibonacci_vk.bin")
+    val srsPath = getFilePathFromAssets("plonk_fibonacci_srs.bin")
+    val provingKeyPath = getFilePathFromAssets("plonk_fibonacci_pk.bin")
+    val verifyingKeyPath = getFilePathFromAssets("plonk_fibonacci_vk.bin")
 
 
     val inputs = mutableMapOf<String, List<String>>()

diff --git a/cli/src/template/halo2/lib.rs b/cli/src/template/halo2/lib.rs
@@ -3,5 +3,5 @@
 // Module containing the Halo2 circuit logic (FibonacciMoproCircuit)
 
 mopro_ffi::set_halo2_circuits! {
-    ("fibonacci_pk.bin", halo2_fibonacci::prove, "fibonacci_vk.bin", halo2_fibonacci::verify),
+    ("plonk_fibonacci_pk.bin", plonk_fibonacci::prove, "plonk_fibonacci_vk.bin", plonk_fibonacci::verify),
 }
diff --git a/cli/src/template/init/test-vectors/halo2/fibonacci_pk.bin b/cli/src/template/init/test-vectors/halo2/fibonacci_pk.bin
diff --git a/cli/src/template/init/test-vectors/halo2/fibonacci_srs.bin b/cli/src/template/init/test-vectors/halo2/fibonacci_srs.bin
diff --git a/cli/src/template/init/test-vectors/halo2/fibonacci_vk.bin b/cli/src/template/init/test-vectors/halo2/fibonacci_vk.bin
diff --git a/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_pk.bin b/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_pk.bin
diff --git a/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_srs.bin b/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_srs.bin
diff --git a/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_vk.bin b/cli/src/template/init/test-vectors/halo2/plonk_fibonacci_vk.bin
diff --git a/cli/src/template/ios/MoproApp.xcodeproj/project.pbxproj b/cli/src/template/ios/MoproApp.xcodeproj/project.pbxproj
@@ -8,9 +8,9 @@
 
 /* Begin PBXBuildFile section */
 		2A59922F2CC7750200135402 /* multiplier2_final.zkey in Resources */ = {isa = PBXBuildFile; fileRef = 2A59922E2CC7750200135402 /* multiplier2_final.zkey */; };
-		2A5992332CC7750C00135402 /* fibonacci_vk.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992322CC7750C00135402 /* fibonacci_vk.bin */; };
-		2A5992342CC7750C00135402 /* fibonacci_srs.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992312CC7750C00135402 /* fibonacci_srs.bin */; };
-		2A5992352CC7750C00135402 /* fibonacci_pk.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992302CC7750C00135402 /* fibonacci_pk.bin */; };
+		2A5992332CC7750C00135402 /* plonk_fibonacci_vk.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992322CC7750C00135402 /* plonk_fibonacci_vk.bin */; };
+		2A5992342CC7750C00135402 /* plonk_fibonacci_srs.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992312CC7750C00135402 /* plonk_fibonacci_srs.bin */; };
+		2A5992352CC7750C00135402 /* plonk_fibonacci_pk.bin in Resources */ = {isa = PBXBuildFile; fileRef = 2A5992302CC7750C00135402 /* plonk_fibonacci_pk.bin */; };
 		2A5992392CC77A7E00135402 /* MoproBindings.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2A5992372CC77A7E00135402 /* MoproBindings.xcframework */; };
 		2A59923A2CC77A7E00135402 /* mopro.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2A5992362CC77A7E00135402 /* mopro.swift */; };
 /* End PBXBuildFile section */
@@ -37,9 +37,9 @@
 		2A5991FC2CC7722A00135402 /* MoproAppTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MoproAppTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		2A5992062CC7722A00135402 /* MoproAppUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MoproAppUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		2A59922E2CC7750200135402 /* multiplier2_final.zkey */ = {isa = PBXFileReference; lastKnownFileType = file; path = multiplier2_final.zkey; sourceTree = "<group>"; };
-		2A5992302CC7750C00135402 /* fibonacci_pk.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = fibonacci_pk.bin; sourceTree = "<group>"; };
-		2A5992312CC7750C00135402 /* fibonacci_srs.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = fibonacci_srs.bin; sourceTree = "<group>"; };
-		2A5992322CC7750C00135402 /* fibonacci_vk.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = fibonacci_vk.bin; sourceTree = "<group>"; };
+		2A5992302CC7750C00135402 /* plonk_fibonacci_pk.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = plonk_fibonacci_pk.bin; sourceTree = "<group>"; };
+		2A5992312CC7750C00135402 /* plonk_fibonacci_srs.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = plonk_fibonacci_srs.bin; sourceTree = "<group>"; };
+		2A5992322CC7750C00135402 /* plonk_fibonacci_vk.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; path = plonk_fibonacci_vk.bin; sourceTree = "<group>"; };
 		2A5992362CC77A7E00135402 /* mopro.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = mopro.swift; sourceTree = "<group>"; };
 		2A5992372CC77A7E00135402 /* MoproBindings.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; path = MoproBindings.xcframework; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -97,9 +97,9 @@
 				2A5991ED2CC7722900135402 /* Products */,
 				2A5992382CC77A7E00135402 /* MoproiOSBindings */,
 				2A59922E2CC7750200135402 /* multiplier2_final.zkey */,
-				2A5992302CC7750C00135402 /* fibonacci_pk.bin */,
-				2A5992312CC7750C00135402 /* fibonacci_srs.bin */,
-				2A5992322CC7750C00135402 /* fibonacci_vk.bin */,
+				2A5992302CC7750C00135402 /* plonk_fibonacci_pk.bin */,
+				2A5992312CC7750C00135402 /* plonk_fibonacci_srs.bin */,
+				2A5992322CC7750C00135402 /* plonk_fibonacci_vk.bin */,
 			);
 			sourceTree = "<group>";
 		};
@@ -242,9 +242,9 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				2A5992332CC7750C00135402 /* fibonacci_vk.bin in Resources */,
-				2A5992342CC7750C00135402 /* fibonacci_srs.bin in Resources */,
-				2A5992352CC7750C00135402 /* fibonacci_pk.bin in Resources */,
+				2A5992332CC7750C00135402 /* plonk_fibonacci_vk.bin in Resources */,
+				2A5992342CC7750C00135402 /* plonk_fibonacci_srs.bin in Resources */,
+				2A5992352CC7750C00135402 /* plonk_fibonacci_pk.bin in Resources */,
 				2A59922F2CC7750200135402 /* multiplier2_final.zkey in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

diff --git a/cli/src/template/ios/MoproApp/ContentView.swift b/cli/src/template/ios/MoproApp/ContentView.swift
@@ -42,9 +42,9 @@ struct ContentView: View {
     @State private var generatedHalo2Proof: Data?
     @State private var halo2PublicInputs: Data?
     private let zkeyPath = Bundle.main.path(forResource: "multiplier2_final", ofType: "zkey")!
-    private let srsPath = Bundle.main.path(forResource: "fibonacci_srs.bin", ofType: "")!
-    private let vkPath = Bundle.main.path(forResource: "fibonacci_vk.bin", ofType: "")!
-    private let pkPath = Bundle.main.path(forResource: "fibonacci_pk.bin", ofType: "")!
+    private let srsPath = Bundle.main.path(forResource: "plonk_fibonacci_srs.bin", ofType: "")!
+    private let vkPath = Bundle.main.path(forResource: "plonk_fibonacci_vk.bin", ofType: "")!
+    private let pkPath = Bundle.main.path(forResource: "plonk_fibonacci_pk.bin", ofType: "")!
 
     var body: some View {
         VStack(spacing: 10) {

diff --git a/docs/docs/adapters/halo2.md b/docs/docs/adapters/halo2.md
@@ -65,7 +65,7 @@ For example:
 
 ```rust
 mopro_ffi::set_halo2_circuits! {
-    ("fibonacci_pk.bin", halo2_fibonacci::prove, "fibonacci_vk.bin", halo2_fibonacci::verify),
+    ("plonk_fibonacci_pk.bin", plonk_fibonacci::prove, "plonk_fibonacci_vk.bin", plonk_fibonacci::verify),
 }
 ```
 
@@ -80,14 +80,14 @@ For example:
 ```rust
 fn get_halo2_proving_circuit(circuit: &str) -> Result<Halo2ProveFn, MoproError> {
     match circuit {
-        "fibonacci_pk.bin" => Ok(halo2_fibonacci::prove),
+        "plonk_fibonacci_pk.bin" => Ok(plonk_fibonacci::prove),
         _ => Err(MoproError::CircuitNotFound),
     }
 }
 
 fn get_halo2_verifying_circuit(circuit: &str) -> Result<Halo2VerifyFn, MoproError> {
     match circuit {
-        "fibonacci_vk.bin" => Ok(halo2_fibonacci::verify),
+        "plonk_fibonacci_vk.bin" => Ok(plonk_fibonacci::verify),
         _ => Err(MoproError::CircuitNotFound),
     }
 }

diff --git a/docs/docs/adapters/overview.md b/docs/docs/adapters/overview.md
@@ -51,7 +51,7 @@ mopro_ffi::set_circom_circuits! {
 
 // Halo2 adapter
 mopro_ffi::set_halo2_circuits! {
-    ("fibonacci_pk.bin", halo2_fibonacci::prove, "fibonacci_vk.bin", halo2_fibonacci::verify),
+    ("plonk_fibonacci_pk.bin", plonk_fibonacci::prove, "plonk_fibonacci_vk.bin", plonk_fibonacci::verify),
 }
 ```
 

diff --git a/docs/versioned_docs/version-0.1.0/adapters/halo2.md b/docs/versioned_docs/version-0.1.0/adapters/halo2.md
@@ -65,7 +65,7 @@ For example:
 
 ```rust
 mopro_ffi::set_halo2_circuits! {
-    ("fibonacci_pk.bin", halo2_fibonacci::prove, "fibonacci_vk.bin", halo2_fibonacci::verify),
+    ("plonk_fibonacci_pk.bin", plonk_fibonacci::prove, "plonk_fibonacci_vk.bin", plonk_fibonacci::verify),
 }
 ```
 
@@ -80,14 +80,14 @@ For example:
 ```rust
 fn get_halo2_proving_circuit(circuit: &str) -> Result<Halo2ProveFn, MoproError> {
     match circuit {
-        "fibonacci_pk.bin" => Ok(halo2_fibonacci::prove),
+        "plonk_fibonacci_pk.bin" => Ok(plonk_fibonacci::prove),
         _ => Err(MoproError::CircuitNotFound),
     }
 }
 
 fn get_halo2_verifying_circuit(circuit: &str) -> Result<Halo2VerifyFn, MoproError> {
     match circuit {
-        "fibonacci_vk.bin" => Ok(halo2_fibonacci::verify),
+        "fibonacci_vk.bin" => Ok(plonk_fibonacci::verify),
         _ => Err(MoproError::CircuitNotFound),
     }
 }

diff --git a/docs/versioned_docs/version-0.1.0/adapters/overview.md b/docs/versioned_docs/version-0.1.0/adapters/overview.md
@@ -51,7 +51,7 @@ mopro_ffi::set_circom_circuits! {
 
 // Halo2 adapter
 mopro_ffi::set_halo2_circuits! {
-    ("fibonacci_pk.bin", halo2_fibonacci::prove, "fibonacci_vk.bin", halo2_fibonacci::verify),
+    ("plonk_fibonacci_pk.bin", plonk_fibonacci::prove, "plonk_fibonacci_vk.bin", plonk_fibonacci::verify),
 }
 ```
 

diff --git a/mopro-ffi/src/lib.rs b/mopro-ffi/src/lib.rs
@@ -156,10 +156,10 @@ pub struct ProofCalldata {
 /// use crate::halo2::FibonacciMoproCircuit;
 ///
 /// // Add `Fibonacci` circuit to generate proofs
-/// mopro_ffi::set_halo2_proving_circuits!("fibonacci_pk.bin", FibonacciMoproCircuit::prove);
+/// mopro_ffi::set_halo2_proving_circuits!("plonk_fibonacci_pk.bin", FibonacciMoproCircuit::prove);
 ///
 /// // Add `Fibonacci` circuit to verify proofs
-// mopro_ffi::set_halo2_verifying_circuits!("fibonacci_vk.bin", FibonacciMoproCircuit::verify);
+// mopro_ffi::set_halo2_verifying_circuits!("plonk_fibonacci_vk.bin", FibonacciMoproCircuit::verify);
 ///
 ///
 #[macro_export]