doc(full-recursion): documents the prover and verifier actions

Author: AlexandreBelling

prover/protocol/compiler/fullrecursion/actions.go

@@ -8,14 +8,44 @@ import (
 	"github.com/consensys/linea-monorepo/prover/protocol/wizard"
 )
 
+// CircuitAssignment is an implementation of [wizard.ProverAction]. As such, it
+// embodies the action of assigning the full-recursion Plonk circuit columns.
 type CircuitAssignment fullRecursionCtx
 
-func (c CircuitAssignment) Run(run *wizard.ProverRuntime) {
-	c.PlonkInWizard.ProverAction.Run(run, WitnessAssigner(c))
+// ConsistencyCheck is an implementation of [wizard.VerifierAction]. As such it
+// is responsible for checking that the public inputs of the full-recursion
+// Plonk circuit are assigned to values that are consistent with (1) the public
+// inputs of the wrapping wizard protocol and with the inputs of the
+// self-recursion wizard.
+type ConsistencyCheck struct {
+	fullRecursionCtx
+	isSkipped bool
 }
 
+// ReplacementAssignment is a [wizard.ProverAction] implementation. It assigns
+// the queries and columns that are "replaced" in the wizard. In essence, this
+// concerns the main grail polynomial evaluation (the grail query) and the
+// Merkle roots assignment. These have to be replaced so that they can be
+// refered to by the self-recursion. Otherwise, they would be swallowed by the
+// recursion Plonk circuit.
 type ReplacementAssignment fullRecursionCtx
 
+// LocalOpeningAssignment assigns the local openings made over the Plonk PI.
+// These are needed in order to (1) perform the consistency check (2) replace
+// the "old" and recursed public inputs of the original wizard by new ones.
+type LocalOpeningAssignment fullRecursionCtx
+
+// ResetFsActions is a [wizard.FsHook] responsible for tweaking the FS state as
+// required by the self-recursion process.
+type ResetFsActions struct {
+	fullRecursionCtx
+	isSkipped bool
+}
+
+func (c CircuitAssignment) Run(run *wizard.ProverRuntime) {
+	c.PlonkInWizard.ProverAction.Run(run, WitnessAssigner(c))
+}
+
 func (c ReplacementAssignment) Run(run *wizard.ProverRuntime) {
 	params := run.GetUnivariateParams(c.PolyQuery.QueryID)
 	run.AssignUnivariate(c.PolyQueryReplacement.QueryID, params.X, params.Ys...)
@@ -34,8 +64,6 @@ func (c ReplacementAssignment) Run(run *wizard.ProverRuntime) {
 	}
 }
 
-type LocalOpeningAssignment fullRecursionCtx
-
 func (c LocalOpeningAssignment) Run(run *wizard.ProverRuntime) {
 	for i := range c.LocalOpenings {
 		run.AssignLocalPoint(
@@ -45,11 +73,6 @@ func (c LocalOpeningAssignment) Run(run *wizard.ProverRuntime) {
 	}
 }
 
-type ConsistencyCheck struct {
-	fullRecursionCtx
-	isSkipped bool
-}
-
 func (c *ConsistencyCheck) Run(run *wizard.VerifierRuntime) error {
 
 	var (
@@ -168,11 +191,6 @@ func (c *ConsistencyCheck) IsSkipped() bool {
 	return c.isSkipped
 }
 
-type ResetFsActions struct {
-	fullRecursionCtx
-	isSkipped bool
-}
-
 func (r *ResetFsActions) Run(run *wizard.VerifierRuntime) error {
 	finalFsCirc := run.GetLocalPointEvalParams(r.LocalOpenings[1].ID).Y
 	run.FS.SetState([]field.Element{finalFsCirc})