Revive markdown reporting

Author: asn-d6

results.md

@@ -19,7 +19,7 @@ The cell values are the bits of security for each such component.
 - Trace length (H): $2^{22}$
 - Batching: Powers
 
-**Proof Size Estimate:** 1352 KiB, where 1 KiB = 1024 bytes
+**Proof Size Estimate:** 992 KiB, where 1 KiB = 1024 bytes
 
 | regime | total | ALI | DEEP | FRI batching round | FRI commit rounds (×5) | FRI query phase |
 | --- | --- | --- | --- | --- | --- | --- |
@@ -37,7 +37,7 @@ The cell values are the bits of security for each such component.
 - Trace length (H): $2^{18}$
 - Batching: Powers
 
-**Proof Size Estimate:** 114 KiB, where 1 KiB = 1024 bytes
+**Proof Size Estimate:** 175 KiB, where 1 KiB = 1024 bytes
 
 | regime | total | ALI | DEEP | FRI batching round | FRI commit rounds (×7) | FRI query phase |
 | --- | --- | --- | --- | --- | --- | --- |
@@ -55,7 +55,7 @@ The cell values are the bits of security for each such component.
 - Trace length (H): $2^{21}$
 - Batching: Powers
 
-**Proof Size Estimate:** 223 KiB, where 1 KiB = 1024 bytes
+**Proof Size Estimate:** 576 KiB, where 1 KiB = 1024 bytes
 
 | regime | total | ALI | DEEP | FRI batching round | FRI commit rounds (×4) | FRI query phase |
 | --- | --- | --- | --- | --- | --- | --- |

soundcalc/main.py

@@ -2,13 +2,9 @@
 import json
 
 from soundcalc.common.utils import KIB
-from soundcalc.regimes.best_attack import best_attack_security
-from soundcalc.zkvms.fri_based_vm import get_DEEP_ALI_errors
 from soundcalc.zkvms.risc0 import Risc0Preset
 from soundcalc.zkvms.miden import MidenPreset
 from soundcalc.zkvms.zisk import ZiskPreset
-from soundcalc.regimes.johnson_bound import JohnsonBoundRegime
-from soundcalc.regimes.unique_decoding import UniqueDecodingRegime
 from soundcalc.report import build_markdown_report
 from soundcalc.zkvms.zkvm import zkVM
 
@@ -27,7 +23,7 @@ def generate_and_save_md_report(sections) -> None:
     print(f"wrote :: {md_path}")
 
 
-def print_summary_for_zkvm(zkvm: zkVM) -> None:
+def print_summary_for_zkvm(zkvm: zkVM, security_levels: dict | None = None) -> None:
     """
     Print a summary of security results for a single zkVM.
     """
@@ -41,7 +37,9 @@ def print_summary_for_zkvm(zkvm: zkVM) -> None:
     print("")
     print(f"parameters: \n {zkvm.get_parameter_summary()}")
     print("")
-    print(f"security levels (rbr): \n {json.dumps(zkvm.get_security_levels(), indent=4)}")
+    if security_levels is None:
+        security_levels = zkvm.get_security_levels()
+    print(f"security levels (rbr): \n {json.dumps(security_levels, indent=4)}")
     print("")
     print("")
     print("")
@@ -55,6 +53,8 @@ def main() -> None:
     generate reports, and save results to disk.
     """
 
+    sections: dict[str, tuple[zkVM, dict[str, dict]]] = {}
+
     # We consider the following zkVMs
     zkvms = [
         ZiskPreset.default(),
@@ -64,11 +64,12 @@ def main() -> None:
 
     # Analyze each zkVM
     for zkvm in zkvms:
-        print_summary_for_zkvm(zkvm)
+        security_levels = zkvm.get_security_levels()
+        print_summary_for_zkvm(zkvm, security_levels)
+        sections[zkvm.get_name()] = (zkvm, security_levels)
 
     # Generate and save markdown report
-    # TODO. re-integrate
-    # generate_and_save_md_report(sections)
+    generate_and_save_md_report(sections)
 
 if __name__ == "__main__":
     main()

soundcalc/report.py

@@ -29,38 +29,38 @@ def build_markdown_report(sections) -> str:
         lines.append(f"## {zkevm}")
         lines.append("")
 
-        (zkevm_params, results) = sections[zkevm]
+        (zkvm_obj, results) = sections[zkevm]
         display_results: dict[str, Any] = {
             name: data.copy() if isinstance(data, dict) else data
             for name, data in results.items()
         }
 
         # Add parameter information
         lines.append(f"**Parameters:**")
-        lines.append(f"- Number of queries: {zkevm_params.num_queries}")
-        lines.append(f"- Grinding (bits): {zkevm_params.grinding_query_phase}")
+        lines.append(f"- Number of queries: {zkvm_obj.num_queries}")
+        lines.append(f"- Grinding (bits): {zkvm_obj.grinding_query_phase}")
         # Get field name from the field extension degree and base field
         field_name = "Unknown"
-        if hasattr(zkevm_params, 'field_extension_degree'):
-            if zkevm_params.field_extension_degree == 2:
+        if hasattr(zkvm_obj, 'field_extension_degree'):
+            if zkvm_obj.field_extension_degree == 2:
                 field_name = "Goldilocks²"
-            elif zkevm_params.field_extension_degree == 3:
+            elif zkvm_obj.field_extension_degree == 3:
                 field_name = "Goldilocks³"
-            elif zkevm_params.field_extension_degree == 4:
+            elif zkvm_obj.field_extension_degree == 4:
                 field_name = "BabyBear⁴"
-            elif zkevm_params.field_extension_degree == 5:
+            elif zkvm_obj.field_extension_degree == 5:
                 field_name = "BabyBear⁵"
         lines.append(f"- Field: {field_name}")
-        lines.append(f"- Rate (ρ): {zkevm_params.rho}")
-        lines.append(f"- Trace length (H): $2^{{{zkevm_params.h}}}$")
-        if zkevm_params.power_batching:
+        lines.append(f"- Rate (ρ): {zkvm_obj.rho}")
+        lines.append(f"- Trace length (H): $2^{{{zkvm_obj.h}}}$")
+        if zkvm_obj.power_batching:
             lines.append(f"- Batching: Powers")
         else:
             lines.append(f"- Batching: Affine")
         lines.append("")
 
         # Proof size
-        proof_size_kib = zkevm_params.proof_size_bits // KIB
+        proof_size_kib = zkvm_obj.get_proof_size_bits() // KIB
         lines.append(f"**Proof Size Estimate:** {proof_size_kib} KiB, where 1 KiB = 1024 bytes")
         lines.append("")