Skip to content

docs, tests, benchmarks: improve trustworthiness and usability#44

Merged
gabriel-barrett merged 2 commits intomainfrom
ap/improvements
Mar 19, 2026
Merged

docs, tests, benchmarks: improve trustworthiness and usability#44
gabriel-barrett merged 2 commits intomainfrom
ap/improvements

Conversation

@arthurpaulino
Copy link
Member

@arthurpaulino arthurpaulino commented Mar 19, 2026

Soundness & documentation:

  • Add protocol documentation to prover and verifier modules
  • Add full soundness argument to verifier with notation, per-component bounds (FRI, constraint folding, OOD, lookup, Fiat-Shamir), and overall soundness error formula
  • Annotate each verification step with inline soundness comments
  • Add security parameter docs to FriParameters
  • Document unused InvalidClaim variant

Testing:

  • Replace ignored 2^20-row benchmark test with fast 2^4-row test including serialization round-trip
  • Add adversarial verifier tests: wrong claim, tampered stage-1 values, tampered accumulator, truncated proof, serialization round-trip
  • Trim blake3 test_all_claims from 9 redundant runs to 6 minimal ones
  • CI: run tests with --features parallel, add --all-features to clippy

Benchmarks & examples:

  • Add Criterion benchmarks (prove/verify)
  • Add examples: simple_proof (no lookups), preprocessed_proof (preprocessed trace with lookups), and lookup_proof (multi-circuit)

Repo cleanup:

  • Rename chips/ to test_circuits/, move Blake3 helpers into blake3.rs
  • Drop the "chip" terminology elsewhere
  • Gate test_circuits module with #[cfg(test)]
  • Add .cargo/config.toml with target-cpu=native
  • Rewrite README with crypto setup, quick start, and soundness reference

@arthurpaulino arthurpaulino force-pushed the ap/improvements branch 2 times, most recently from ca39a6f to 69adcbe Compare March 19, 2026 15:11
arthurpaulino and others added 2 commits March 19, 2026 13:05
Soundness & documentation:
- Add protocol documentation to prover and verifier modules
- Add full soundness argument to verifier with notation, per-component
  bounds (FRI, constraint folding, OOD, lookup, Fiat-Shamir), and overall
  soundness error formula
- Annotate each verification step with inline soundness comments
- Add security parameter docs to FriParameters
- Document unused InvalidClaim variant

Testing:
- Replace ignored 2^20-row benchmark test with fast 2^4-row test
  including serialization round-trip
- Add adversarial verifier tests: wrong claim, tampered stage-1 values,
  tampered accumulator, truncated proof, serialization round-trip
- Trim blake3 test_all_claims from 9 redundant runs to 6 minimal ones
- CI: run tests with --features parallel, add --all-features to clippy

Benchmarks & examples:
- Add Criterion benchmarks (prove/verify)
- Add examples: simple_proof (no lookups), preprocessed_proof (preprocessed
  trace with lookups), and lookup_proof (multi-circuit)

Repo cleanup:
- Rename chips/ to test_circuits/, move Blake3 helpers into blake3.rs
- Drop the "chip" terminology elsewhere
- Gate test_circuits module with #[cfg(test)]
- Add .cargo/config.toml with target-cpu=native
- Rewrite README with crypto setup, quick start, and soundness reference
@gabriel-barrett gabriel-barrett merged commit b1c9b9c into main Mar 19, 2026
3 checks passed
@gabriel-barrett gabriel-barrett deleted the ap/improvements branch March 19, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants