Merge pull request #22 from zksecurity/noir-runner

Implement Noir runner

Author: StefanosChaliasos

README.md

@@ -35,6 +35,49 @@ pytest
 python scripts/lint_and_tests.py
 ```
 
+### Circom
+
+In order to target Circom implementation, you need to install Circom and SnarkJS (optional)
+
+Circom:
+
+```
+git clone https://github.com/iden3/circom.git
+cargo build --release
+cargo install --path circom
+```
+
+SnarkJS: 
+
+```
+npm install -g snarkjs@latest
+```
+
+### Noir
+
+In order to target Noir implementation, you need to install Noir as follows:
+
+```
+curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash
+noirup
+```
+
+Also, you need to custom installation of zk-regex as follows:
+
+```
+git clone git@github.com:Mach-34/noir-zk-regex.git
+cd noir-zk-regex
+git checkout fix/efficient-substrings
+cargo install --path packages/compiler/
+```
+
+Optionally, install Barretenberg if we want to test the proving/verification as well:
+
+```
+curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash
+bbup
+```
+
 ## Example Run
 
 ### Fuzzing
@@ -70,3 +113,13 @@ python src/zkregex_fuzzer/cli.py fuzz \
     --fuzzer grammar \
     --circom-library ../zk-regex/node_modules/circomlib ../zk-regex/node_modules/
 ```
+
+or for noir with the database fuzzer
+
+```
+python src/zkregex_fuzzer/cli.py fuzz \
+    --oracle valid \
+    --target noir \
+    --valid-input-generator exrex \
+    --fuzzer database
+```

src/zkregex_fuzzer/cli.py

@@ -19,6 +19,7 @@
     SnarkjsSubprocess,
     ZkRegexSubprocess,
 )
+from zkregex_fuzzer.runner.subprocess import BarretenbergSubprocess, NoirSubprocess
 
 
 def fuzz_parser():
@@ -50,6 +51,11 @@ def fuzz_parser():
         choices=list(VALID_INPUT_GENERATORS.keys()),
         help=f"The valid input generator to use for the fuzzer (options: {list(VALID_INPUT_GENERATORS.keys())}).",
     )
+    parser.add_argument(
+        "--seed",
+        default=str(uuid.uuid4()),
+        help="Seed for random generator (default: UUIDv4)",
+    )
     parser.add_argument(
         "--save",
         choices=[status.name for status in HarnessStatus],
@@ -75,7 +81,7 @@ def fuzz_parser():
         help="Maximum depth of recursion in the grammar (default: 5).",
     )
     parser.add_argument(
-        "--circom-max-input-size",
+        "--max-input-size",
         type=int,
         default=600,
         help="Maximum size of the circuit input (default: 600).",
@@ -99,6 +105,19 @@ def fuzz_parser():
         help="Path to the ptau (powers-of-tau) file for the proving step",
     )
 
+    parser.add_argument(
+        "--noir-prove",
+        action="store_true",
+        help="Run the proving and verification step with Barretenberg.",
+    )
+
+    parser.add_argument(
+        "--logger-level",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="INFO",
+        help="Set the logger level (default: INFO).",
+    )
+
     return parser
 
 
@@ -112,6 +131,12 @@ def reproduce_parser():
         help="Path to the target directory output that want to be reproduced (support wildcard pattern).",
         required=True,
     )
+    parser.add_argument(
+        "--logger-level",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="INFO",
+        help="Set the logger level (default: INFO).",
+    )
 
     return parser
 
@@ -123,13 +148,15 @@ def do_fuzz(args):
 
     if args.target == "circom":
         try:
-            circom_version = CircomSubprocess.get_installed_version()
-            snarkjs_version = SnarkjsSubprocess.get_installed_version()
             zk_regex_version = ZkRegexSubprocess.get_installed_version()
+            circom_version = CircomSubprocess.get_installed_version()
             print("-" * 80)
-            print(f"Circom: {circom_version}")
-            print(f"SnarkJS: {snarkjs_version}")
             print(f"zk-regex: {zk_regex_version}")
+            print(f"Circom: {circom_version}")
+            if args.circom_prove:
+                snarkjs_version = SnarkjsSubprocess.get_installed_version()
+                print(f"SnarkJS: {snarkjs_version}")
+
         except ValueError as e:
             print(e)
             exit(1)
@@ -159,6 +186,20 @@ def do_fuzz(args):
                 print(f"Path to ptau file {ptau_path} does not exist.")
                 exit(1)
 
+    elif args.target == "noir":
+        try:
+            zk_regex_version = ZkRegexSubprocess.get_installed_version()
+            noir_version = NoirSubprocess.get_installed_version()
+            print("-" * 80)
+            print(f"zk-regex: {zk_regex_version}")
+            print(f"Noir: {noir_version}")
+            if args.noir_prove:
+                bb_version = BarretenbergSubprocess.get_installed_version()
+                print(f"Barretenberg: {bb_version}")
+        except ValueError as e:
+            print(e)
+            exit(1)
+
     print("-" * 80)
     print(f"Fuzzing with {args.fuzzer} fuzzer.")
     print("=" * 80)
@@ -173,9 +214,7 @@ def do_fuzz(args):
     kwargs = vars(args)
 
     # set global seed
-    seed = str(uuid.uuid4())
-    kwargs["seed"] = seed
-    random.seed(seed)
+    random.seed(args.seed)
 
     if args.fuzzer == "grammar":
         fuzz_with_grammar(
@@ -203,12 +242,6 @@ def do_reproduce(args):
 
 def main():
     parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "--logger-level",
-        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
-        default="INFO",
-        help="Set the logger level (default: INFO).",
-    )
 
     subparser = parser.add_subparsers(dest="subcommand")
     subparser.add_parser(

src/zkregex_fuzzer/configs.py

@@ -1,10 +1,11 @@
 from zkregex_fuzzer.grammar import REGEX_GRAMMAR
 from zkregex_fuzzer.regexgen import DatabaseRegexGenerator, GrammarRegexGenerator
-from zkregex_fuzzer.runner import CircomRunner, PythonReRunner
+from zkregex_fuzzer.runner import CircomRunner, NoirRunner, PythonReRunner
 from zkregex_fuzzer.vinpgen import ExrexGenerator, GrammarBasedGenerator, RstrGenerator
 
 TARGETS = {
     "circom": CircomRunner,
+    "noir": NoirRunner,
     "python_re": PythonReRunner,
 }
 

src/zkregex_fuzzer/fuzzer.py

@@ -65,7 +65,7 @@ def fuzz_with_regexes(
     """
     Fuzz test with pre-seeded regexes.
     """
-    max_input_size = kwargs.get("circom_max_input_size", None)
+    max_input_size = kwargs.get("max_input_size", None)
     oracle, oracle_generator = oracle_params
     if oracle:
         generator = VALID_INPUT_GENERATORS[oracle_generator]

src/zkregex_fuzzer/grammar.py

@@ -19,6 +19,7 @@
 TODO:
  - Add more grammars.
 """
+
 import string
 from typing import List
 

src/zkregex_fuzzer/report.py

@@ -1,4 +1,5 @@
 """
 Implements the logic for generating a report from the fuzzing results.
 """
+
 from zkregex_fuzzer.harness import HarnessResult

src/zkregex_fuzzer/runner/__init__.py

@@ -1,3 +1,4 @@
 from .base_runner import RegexCompileError, RegexRunError, Runner
 from .circom import CircomRunner
+from .noir import NoirRunner
 from .python import PythonReRunner