feat: Client IVC API by codygunton · Pull Request #10217 · AztecProtocol/aztec-packages

codygunton · 2024-11-26T17:43:25Z

Establish API in purely virtual class
- This is just a first pass. I will continue to work on this before showing dev rel and others to get buy-in.
Implement some API functions for ClientIVC: prove, verify, prove_and_verify
Support for constructing CIVC proof for input a single circuit
- This is interpreted as a "compiletime stack"
- Produces ECCVM and Translator proofs from dummy/empty data; future optimization could avoid.
- Add one_circuit to CIVC to encode whether the MH part of the CIVC proof should be a hiding circuit (which takes a folding proof) or a proof for the single circuit.
Run almost all ACIR tests against ClientIVC
- Previously only ran MegaHonk tests, which are not totally meaningful.
- Four are skipped because they fail. These failures are expected to be superficial (see Support for compile-time folding: deprecate? barretenberg#1164 and the references to it in the PR's new code).
fold_and_verify and mega honk flows go away in bb, but remain until bb.js alignment.
Delete large log file that should not be track (accounts for big negative diff).

github-actions · 2024-11-30T05:16:40Z

Changes to circuit sizes

Generated at commit: 6abb1875eeb12d0b31075349aa2d583fa2652259, compared to commit: da1470d074f4884e61b51e450a661432c6f0a10f

🧾 Summary (100% most significant diffs)

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
parity_root	0 ➖	0.00%	-8 ✅	-0.00%
rollup_block_root	0 ➖	0.00%	-9 ✅	-0.00%
rollup_block_merge	0 ➖	0.00%	-8 ✅	-0.00%
rollup_root	0 ➖	0.00%	-8 ✅	-0.00%
rollup_merge	0 ➖	0.00%	-8 ✅	-0.00%
private_kernel_empty	-350 ✅	-36.34%	-358 ✅	-0.04%
private_kernel_reset	-5,459 ✅	-5.74%	-5,038 ✅	-0.78%
private_kernel_inner	-7,834 ✅	-17.56%	-6,125 ✅	-9.88%
private_kernel_init	-5,673 ✅	-21.54%	-4,623 ✅	-12.12%
private_kernel_tail_to_public	-2,249 ✅	-12.85%	-4,091 ✅	-13.39%
private_kernel_tail	-1,200 ✅	-22.53%	-2,667 ✅	-17.57%
rollup_base_public	-107,265 ✅	-23.61%	-1,144,794 ✅	-22.96%
rollup_base_private	-54,054 ✅	-24.55%	-989,829 ✅	-27.51%

Full diff report 👇

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
parity_root	4,782 (0)	0.00%	3,636,536 (-8)	-0.00%
rollup_block_root	4,192 (0)	0.00%	2,739,373 (-9)	-0.00%
rollup_block_merge	11,544 (0)	0.00%	1,858,073 (-8)	-0.00%
rollup_root	11,528 (0)	0.00%	1,858,059 (-8)	-0.00%
rollup_merge	3,252 (0)	0.00%	1,826,915 (-8)	-0.00%
private_kernel_empty	613 (-350)	-36.34%	901,640 (-358)	-0.04%
private_kernel_reset	89,662 (-5,459)	-5.74%	637,479 (-5,038)	-0.78%
private_kernel_inner	36,767 (-7,834)	-17.56%	55,848 (-6,125)	-9.88%
private_kernel_init	20,668 (-5,673)	-21.54%	33,520 (-4,623)	-12.12%
private_kernel_tail_to_public	15,253 (-2,249)	-12.85%	26,461 (-4,091)	-13.39%
private_kernel_tail	4,127 (-1,200)	-22.53%	12,509 (-2,667)	-17.57%
rollup_base_public	347,034 (-107,265)	-23.61%	3,841,978 (-1,144,794)	-22.96%
rollup_base_private	166,132 (-54,054)	-24.55%	2,608,307 (-989,829)	-27.51%

maramihali

Nice work, left some small request for clarification/docs and a question.

maramihali · 2024-12-03T12:34:16Z

    "node": ">=18"
  }
-}
+}


extra lines in the two json files could be removed

The formatter added those for me, not sure why--maybe formatting config has changed since the last time those files changed?

maramihali · 2024-12-03T12:36:54Z

 * @param precomputed_vk
 */
 void ClientIVC::accumulate(ClientCircuit& circuit,
+                           const bool _one_circuit,


will you add a comment explaining the point of this boolean?

maramihali · 2024-12-03T12:38:14Z

-    // proof
-    if (!initialized) {
-        OinkProver<Flavor> oink_prover{ proving_key };
+    if (_one_circuit) {


would be helpful to begin with a comment saying this is handling the edge case where there's a single circuit in the IVC schme

Committed in next PR 7de211c#diff-57571567d685a0f68a791ab06cdf88e4cc63f497549b9119e3d99c0bacf14a04R157

maramihali · 2024-12-03T12:40:53Z

+
+namespace bb {
+
+acir_format::WitnessVector get_witness(std::string const& witness_path)


it would be great to have docs for each of this getter but not part of the focus of this PR.

maramihali · 2024-12-03T13:05:09Z

+    return content;
+}
+
+class ClientIVCAPI : public API {


it would be great overall if this class had a bit more documentation

maramihali · 2024-12-03T13:06:00Z

+
+        std::vector<AcirProgram> folding_stack;
+
+        // TODO(https://github.com/AztecProtocol/barretenberg/issues/1162): Efficiently unify ACIR stack parsing


nit: we should uniformly either use - or _ in input type

I think I did achieve this, but I see that some of the comments about deprecation weren't updated to refer to the _ version of things. I suspect this is what you're referring to?

maramihali · 2024-12-03T13:08:13Z

+        return verified;
+    };
+
+    void gates([[maybe_unused]] const API::Flags& flags,


add a TODO for this three functions

or actually I guess they are not client ivc related but as a next step we should create an ultra honk api class as well?

maramihali · 2024-12-03T13:20:35Z

+               const std::filesystem::path& output_dir) override
+    {
+        if (!flags.output_type || *flags.output_type != "fields_msgpack") {
+            throw_or_abort("No output_type or output_type not supported");


why do flags need to be dereferenced?

That's one way of accessing the value in a std::optional when the optional actually does contain a value.

In any case, this validation is going to be replaced with the more robust functionality in https://github.com/CLIUtils/CLI11

codygunton added 8 commits November 25, 2024 16:25

WIP exposing CIVC

58fad33

Fix common typo

1960bdf

Attaching attempt doesn't work

15b0ea4

const

96c9690

This works; next make robut

c263ba0

Split out folding stack building

6388a0b

Pare down writes

ec10320

Handle case of one circuit

410a829

codygunton self-assigned this Nov 26, 2024

codygunton added 7 commits November 26, 2024 17:45

revert typo

cac38b5

Fix prove_then_verify

2fbd248

Merge remote-tracking branch 'origin/master' into cg/api-civc

28a9906

Fix after merge, resolving vk interface TODO

07cc89e

Merge remote-tracking branch 'origin/master' into cg/api-civc

202bd25

Uniformize interface with flags var

dea89e0

remove bad debug launch

ed993ca

codygunton added e2e labels Nov 27, 2024

codygunton added 3 commits November 29, 2024 03:35

Client IVC unified

52760b2

Merge branch 'master' into cg/api-civc

9595f28

Don't default --scheme

361da96

codygunton force-pushed the cg/api-civc branch from 057414e to 361da96 Compare November 29, 2024 11:00

codygunton added 2 commits November 29, 2024 11:54

bootstrap formatted

6c721a2

Remove use of fold_and_verify; try to fix e2e

4903b8d

AztecProtocol deleted a comment from github-actions Bot Nov 29, 2024

codygunton added 5 commits November 29, 2024 16:14

use _ not - in command line params

6954daf

Revert for bb.js

902c4ec

delete stray log

a67d8d6

Update verify method ff call

ba6cd30

Clean up

7c00eb1

codygunton added 6 commits December 2, 2024 15:29

single_circuit is a compiletime_stack; dep mega flows

dab17b3

Comments

57d602a

mega ~> civc in gh workflow

d7614e4

More mega removal

26e3876

Skip failing compiletime folding tests

a6ce141

Skip ram_blowup_regression (redundant, needs more SRS)

7a1e22c

maramihali approved these changes Dec 3, 2024

View reviewed changes

codygunton merged commit cc54a1e into master Dec 3, 2024

codygunton deleted the cg/api-civc branch December 3, 2024 14:18

AztecBot mentioned this pull request Dec 3, 2024

chore(master): Release 0.66.0 #10282

Merged

codygunton mentioned this pull request Feb 7, 2025

fix: Add missing return in main #11786

Merged


		namespace bb {

		acir_format::WitnessVector get_witness(std::string const& witness_path)


		std::vector<AcirProgram> folding_stack;

		// TODO(https://github.com/AztecProtocol/barretenberg/issues/1162): Efficiently unify ACIR stack parsing

Conversation

codygunton commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes to circuit sizes

🧾 Summary (100% most significant diffs)

Uh oh!

maramihali left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codygunton Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codygunton commented Nov 26, 2024 •

edited

Loading

github-actions Bot commented Nov 30, 2024 •

edited

Loading

codygunton Dec 3, 2024 •

edited

Loading