proof-aggregation/codex-plonky2-circuits/src/recursion/inner_circuit.rs

use plonky2::iop::target::{BoolTarget, Target};
use plonky2::iop::witness::PartialWitness;
use plonky2::plonk::circuit_builder::CircuitBuilder;
use plonky2::plonk::circuit_data::CommonCircuitData;
use crate::recursion::params::{F,C,D};

/// InnerCircuit is the trait used to define the logic of the circuit and assign witnesses
/// to that circuit instance.
pub trait InnerCircuit<
    // TODO: make it generic for F and D ?
> {
    type Targets;
    type Input:Clone;

    /// build the circuit logic and return targets to be assigned later
    fn build(
        &self,
        builder: &mut CircuitBuilder<F, D>,
    ) -> anyhow::Result<Self::Targets>;

    /// assign the actual witness values for the current instance of the circuit.
    fn assign_targets(
        &self,
        pw: &mut PartialWitness<F>,
        targets: &Self::Targets,
        input: &Self::Input,
    ) -> anyhow::Result<()>;

    /// from the set of the targets, return only the targets which are public
    /// TODO: this can probably be replaced with enum for Public/Private targets
    fn get_pub_input_targets(
        targets: &Self::Targets,
    ) -> anyhow::Result<(Vec<Target>)>;

    /// from the set of the targets, return only the targets which are public
    /// TODO: this can probably be replaced with enum for Public/Private targets
    fn get_common_data(
        &self
    ) -> anyhow::Result<(CommonCircuitData<F, D>)>;
}