privacy-scaling-explorations / halo2

https://privacy-scaling-explorations.github.io/halo2/
Other
207 stars 129 forks source link

feat: refactor the verify api #359

Closed guorong009 closed 1 month ago

guorong009 commented 3 months ago

Description

Improve the verify api - verify_proof, in a way that it does return the bool value indicating proof is valid or not. This way, we remove the confusion or misuse, related to verify_proof api.

Related issues

Changes

codecov-commenter commented 3 months ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 68.85246% with 19 lines in your changes missing coverage. Please review.

Project coverage is 85.01%. Comparing base (7c368af) to head (6061bf6).

Files with missing lines Patch % Lines
halo2_backend/src/plonk/verifier/batch.rs 0.00% 10 Missing :warning:
halo2_backend/src/poly/ipa/strategy.rs 14.28% 6 Missing :warning:
halo2_backend/src/plonk/prover.rs 66.66% 2 Missing :warning:
halo2_backend/src/plonk/verifier.rs 96.29% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #359 +/- ## ========================================== + Coverage 84.99% 85.01% +0.02% ========================================== Files 85 85 Lines 18684 18711 +27 ========================================== + Hits 15880 15907 +27 Misses 2804 2804 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

guorong009 commented 1 month ago

I think that is really nice, anything that de-obfuscates halo2 is welcomed! thanks for taking care about it! I request changes. I think that there's a missing CHANGES.TXT (or whatever) describing the breaking changes.

Currently, the halo2_proofs crate includes the CHANGELOG.md which seems not used at all. I think the changes are just summarized in release PR. Maybe, do we need explicit CHANGELOG file for documentation? cc @davidnevadoc

adria0 commented 1 month ago

I think that is really nice, anything that de-obfuscates halo2 is welcomed! thanks for taking care about it! I request changes. I think that there's a missing CHANGES.TXT (or whatever) describing the breaking changes.

Currently, the halo2_proofs crate includes the CHANGELOG.md which seems not used at all. I think the changes are just summarized in release PR. Maybe, do we need explicit CHANGELOG file for documentation? cc @davidnevadoc

Mmmmmm... yes, I see. Updating the halo2_proofs/CHANGELOG.md should be enough. Let's do it when doing a release!

I also think that we have to move CHANGELOG.md to repo root, wdyt @guorong009 ?