Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update aggregator doc #1365

Merged
merged 10 commits into from
Jul 16, 2024
Merged

Update aggregator doc #1365

merged 10 commits into from
Jul 16, 2024

Conversation

roynalnaruto
Copy link

Update aggregator crate's documentation

darth-cy and others added 3 commits July 16, 2024 09:33
To emphase the "continuous" in aggregated data
Copy link
Author

@roynalnaruto roynalnaruto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit-picks, minor suggestions

aggregator/README.md Outdated Show resolved Hide resolved
aggregator/README.md Outdated Show resolved Hide resolved
aggregator/README.md Outdated Show resolved Hide resolved
aggregator/README.md Outdated Show resolved Hide resolved
aggregator/README.md Outdated Show resolved Hide resolved
aggregator/README.md Outdated Show resolved Hide resolved
@darth-cy darth-cy merged commit 6f199a1 into develop Jul 16, 2024
17 checks passed
@darth-cy darth-cy deleted the doc/readme-update branch July 16, 2024 13:42
type As = KzgAs<Pcs>;

/// Select condition ? LHS : RHS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add some more detail: both this and the below entry are helpers to construct corresponding circuits inside of the ecc_chip which is maintained in the loader argument.

select_accumulator select the lhs or rhs according to the condition and return the cells for ec point represent the result of selection.

accumulate put all the accumulators in argument into circuit and accumulate them into a new pair of ec point and return it.

It may be better also to note that change the size of the vec of accumulators argument would lead to a new circuit (vk changed).

@@ -68,21 +76,39 @@ fn accumulate<'a>(

#[derive(Clone)]
pub struct RecursionCircuit<ST> {
/// The verifying key for the circuit.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basicaly it is not the verifying key but the common params of the recursion circuit. The so called "vk" part which identify the circuit is passed via preprocessed_digest PI.

svk: Svk,
/// The default accumulator to initialise the circuit.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the accumulator that recursion circuit begin with when the "previous" snark is not avaliable (aka. round = 0)

app: SnarkWitness,
/// The SNARK witness from the (k-1)-th BatchCircuit.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from the previous RecursionCircuit, i.e. the RecursionCircuit which has aggregated (k-1) snarks from BatchCircuit

instances: Vec<Fr>,
/// The accumulation of the SNARK proofs recursed over thus far.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should say "the proofs of AppCircuit's snark under accumulation scheme"?

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.

3 participants