halo2 icon indicating copy to clipboard operation
halo2 copied to clipboard

feat: refactor the verify api

Open guorong009 opened this issue 1 year ago • 1 comments

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

  • Resolve #184

Changes

  • Update several VerificationStrategy impls
  • Update the verify_proof so that it returns the bool
  • Update the related tests

guorong009 avatar Jul 09 '24 02:07 guorong009

: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
@@            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.

codecov-commenter avatar Jul 09 '24 02:07 codecov-commenter

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

guorong009 avatar Sep 25 '24 03:09 guorong009

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 ?

adria0 avatar Sep 25 '24 06:09 adria0