special_public_inputs.hpp

Go to the documentation of this file.

// === AUDIT STATUS ===
// internal:    { status: Complete, auditors: [Sergei], commit: d1307bdee7f2ee0e737c19b77a26204a8dbafafc }
// external_1:  { status: not started, auditors: [], commit: }
// external_2:  { status: not started, auditors: [], commit: }
// =====================
//
// Special public inputs designed propagate data between Chonk and Rollup circuits.
//
// These structures are binding several Chonk components:
//   - KernelIO:        Standard kernel outputs (pairing points, databus, ecc_op_tables, accum hash)
//   - HidingKernelIO:  Final kernel outputs (no accum hash since folding terminates)
//   - AppIO/DefaultIO: App circuit outputs (just pairing points)
//   - RollupIO:        Rollup circuit outputs (pairing points + IPA claim)
//
#pragma once
 
#include "barretenberg/commitment_schemes/ipa/ipa.hpp"
#include "barretenberg/commitment_schemes/pairing_points.hpp"
#include "barretenberg/stdlib/primitives/circuit_builders/circuit_builders_fwd.hpp"
#include "barretenberg/stdlib/primitives/curves/bn254.hpp"
#include "barretenberg/stdlib/primitives/databus/databus.hpp"
#include "barretenberg/stdlib/primitives/pairing_points.hpp"
#include "barretenberg/stdlib/primitives/public_input_component/public_input_component.hpp"
namespace bb::stdlib::recursion::honk {
 
// Default coordinates of commitment to an ecc op table
// These are the coordinates that come from committing to the ecc ops that are added to the op_queue by finalize_circuit
static constexpr bb::fq DEFAULT_ECC_COMMITMENT_X("0x08434fa4480433735e7aeaccecb911eb7a06165ad70e5ced6ac6848296e59279");
static constexpr bb::fq DEFAULT_ECC_COMMITMENT_Y("0x0a13a1839ab95ef15be8d0710b2c8aa47cea0b0e62a8596e68cc0fd54a6ae73d");
static constexpr bb::curve::BN254::AffineElement DEFAULT_ECC_COMMITMENT(DEFAULT_ECC_COMMITMENT_X,
                                                                        DEFAULT_ECC_COMMITMENT_Y);
 
template <typename Builder>
std::array<typename bn254<Builder>::Group, Builder::NUM_WIRES> empty_ecc_op_tables(Builder& builder)
{
    std::array<typename bn254<Builder>::Group, Builder::NUM_WIRES> empty_tables;
    for (auto& table_commitment : empty_tables) {
        table_commitment = bn254<Builder>::Group::point_at_infinity(&builder);
        // Sanity check: Verify the native value is actually at infinity
        BB_ASSERT(table_commitment.get_value().is_point_at_infinity(),
                  "empty_ecc_op_tables: T_prev must be initialized to point at infinity");
    }
 
    return empty_tables;
}
 
class KernelIO {
  public:
    using Builder = MegaCircuitBuilder;   // kernel builder is always Mega
    using Curve = stdlib::bn254<Builder>; // curve is always bn254
    using G1 = Curve::Group;
    using FF = Curve::ScalarField;
    using PairingInputs = stdlib::recursion::PairingPoints<Curve>;
    // TODO(https://github.com/AztecProtocol/barretenberg/issues/1490): Make PublicInputComponent work with arrays
    using TableCommitments = std::array<G1, Builder::NUM_WIRES>;
 
    using PublicPoint = stdlib::PublicInputComponent<G1>;
    using PublicPairingPoints = stdlib::PublicInputComponent<PairingInputs>;
    using PublicFF = stdlib::PublicInputComponent<FF>;
 
    PairingInputs pairing_inputs;   // Inputs {P0, P1} to an EC pairing check
    G1 kernel_return_data;          // Commitment to the return data of a kernel circuit
    G1 app_return_data;             // Commitment to the return data of an app circuit
    TableCommitments ecc_op_tables; // commitments to merged tables obtained from recursive Merge verification
    FF output_hn_accum_hash;        // hash of the output HN verifier accumulator
 
    // Total size of the kernel IO public inputs
    static constexpr size_t PUBLIC_INPUTS_SIZE = KERNEL_PUBLIC_INPUTS_SIZE;
 
    void reconstruct_from_public(const std::vector<FF>& public_inputs)
    {
        // Assumes that the kernel-io public inputs are at the end of the public_inputs vector
        uint32_t index = static_cast<uint32_t>(public_inputs.size() - PUBLIC_INPUTS_SIZE);
 
        pairing_inputs = PublicPairingPoints::reconstruct(public_inputs, PublicComponentKey{ index });
        index += PairingInputs::PUBLIC_INPUTS_SIZE;
        kernel_return_data = PublicPoint::reconstruct(public_inputs, PublicComponentKey{ index });
        index += G1::PUBLIC_INPUTS_SIZE;
        app_return_data = PublicPoint::reconstruct(public_inputs, PublicComponentKey{ index });
        index += G1::PUBLIC_INPUTS_SIZE;
        for (auto& table_commitment : ecc_op_tables) {
            table_commitment = PublicPoint::reconstruct(public_inputs, PublicComponentKey{ index });
            index += G1::PUBLIC_INPUTS_SIZE;
        }
        output_hn_accum_hash = PublicFF::reconstruct(public_inputs, PublicComponentKey{ index });
        index += FF::PUBLIC_INPUTS_SIZE;
    }
 
    void set_public()
    {
        Builder* builder = output_hn_accum_hash.get_context();
 
        if (pairing_inputs.P0.get_context() == nullptr) {
            // Add the default pairing points to the public inputs
            PairingInputs::set_default_to_public(builder);
        } else {
            pairing_inputs.set_public();
        }
        kernel_return_data.set_public();
        app_return_data.set_public();
        for (auto& table_commitment : ecc_op_tables) {
            table_commitment.set_public();
        }
        output_hn_accum_hash.set_public();
 
        // Record that pairing points have been set to public
        builder->pairing_points_tagging.set_public_pairing_points();
        // Finalize the public inputs to ensure no more public inputs can be added hereafter.
        builder->finalize_public_inputs();
    }
 
    static void add_default(Builder& builder)
    {
        KernelIO inputs;
 
        inputs.pairing_inputs = PairingInputs::construct_default();
        inputs.kernel_return_data = DataBusDepot<Builder>::construct_default_commitment(builder);
        inputs.app_return_data = DataBusDepot<Builder>::construct_default_commitment(builder);
        for (auto& table_commitment : inputs.ecc_op_tables) {
            table_commitment = G1(DEFAULT_ECC_COMMITMENT);
            table_commitment.convert_constant_to_fixed_witness(&builder);
        }
        inputs.output_hn_accum_hash = FF::from_witness(&builder, typename FF::native(0));
        inputs.set_public();
    }
};
 
template <typename Builder_> class DefaultIO {
  public:
    using Builder = Builder_;
    using Curve = stdlib::bn254<Builder>; // curve is always bn254
    using FF = Curve::ScalarField;
    using PairingInputs = stdlib::recursion::PairingPoints<Curve>;
 
    using PublicPairingPoints = stdlib::PublicInputComponent<PairingInputs>;
 
    PairingInputs pairing_inputs;
 
    // Total size of the IO public inputs
    static constexpr size_t PUBLIC_INPUTS_SIZE = DEFAULT_PUBLIC_INPUTS_SIZE;
 
    void reconstruct_from_public(const std::vector<FF>& public_inputs)
    {
        // Assumes that the app-io public inputs are at the end of the public_inputs vector
        uint32_t index = static_cast<uint32_t>(public_inputs.size() - PUBLIC_INPUTS_SIZE);
        pairing_inputs = PublicPairingPoints::reconstruct(public_inputs, PublicComponentKey{ index });
    }
 
    void set_public()
    {
        Builder* builder = pairing_inputs.P0.get_context();
        BB_ASSERT_NEQ(builder, nullptr, "Trying to set constant PairingPoints to public.");
 
        pairing_inputs.set_public();
 
        // Record that pairing points have been set to public
        builder->pairing_points_tagging.set_public_pairing_points();
        // Finalize the public inputs to ensure no more public inputs can be added hereafter.
        builder->finalize_public_inputs();
    }
 
    static void add_default(Builder& builder)
    {
        PairingInputs::set_default_to_public(&builder);
        builder.finalize_public_inputs();
    };
};
 
using AppIO = DefaultIO<MegaCircuitBuilder>; // app IO is always Mega
 
template <typename Builder_> class GoblinAvmIO {
  public:
    using Builder = Builder_;
    using Curve = stdlib::bn254<Builder>; // curve is always bn254
    using FF = Curve::ScalarField;
    using PairingInputs = stdlib::recursion::PairingPoints<Curve>;
 
    using PublicFF = stdlib::PublicInputComponent<FF>;
    using PublicPairingPoints = stdlib::PublicInputComponent<PairingInputs>;
 
    FF mega_hash;
    PairingInputs pairing_inputs;
 
    // Total size of the IO public inputs
    static constexpr size_t PUBLIC_INPUTS_SIZE = GOBLIN_AVM_PUBLIC_INPUTS_SIZE;
 
    void reconstruct_from_public(const std::vector<FF>& public_inputs)
    {
        // Assumes that the GoblinAvm-io public inputs are at the end of the public_inputs vector
        uint32_t index = static_cast<uint32_t>(public_inputs.size() - PUBLIC_INPUTS_SIZE);
        mega_hash = PublicFF::reconstruct(public_inputs, PublicComponentKey{ index });
        index += FF::PUBLIC_INPUTS_SIZE;
        pairing_inputs = PublicPairingPoints::reconstruct(public_inputs, PublicComponentKey{ index });
    }
 
    void set_public()
    {
        Builder* builder = pairing_inputs.P0.get_context();
 
        mega_hash.set_public();
        pairing_inputs.set_public();
 
        // Record that pairing points have been set to public
        builder->pairing_points_tagging.set_public_pairing_points();
        // Finalize the public inputs to ensure no more public inputs can be added hereafter.
        builder->finalize_public_inputs();
    }
};
 
template <class Builder_> class HidingKernelIO {
  public:
    using Builder = Builder_;
    using Curve = stdlib::bn254<Builder>; // curve is always bn254
    using G1 = Curve::Group;
    using FF = Curve::ScalarField;
    using PairingInputs = stdlib::recursion::PairingPoints<Curve>;
    using TableCommitments = std::array<G1, Builder::NUM_WIRES>;
 
    using PublicPoint = stdlib::PublicInputComponent<G1>;
    using PublicPairingPoints = stdlib::PublicInputComponent<PairingInputs>;
 
    PairingInputs pairing_inputs;   // Inputs {P0, P1} to an EC pairing check
    G1 kernel_return_data;          // Commitment to the return data of the tail kernel circuit
    TableCommitments ecc_op_tables; // commitments to merged tables obtained from final Merge verification
 
    // Total size of the IO public inputs
    static constexpr size_t PUBLIC_INPUTS_SIZE = HIDING_KERNEL_PUBLIC_INPUTS_SIZE;
 
    void reconstruct_from_public(const std::vector<FF>& public_inputs)
    {
        // Assumes that the app-io public inputs are at the end of the public_inputs vector
        uint32_t index = static_cast<uint32_t>(public_inputs.size() - PUBLIC_INPUTS_SIZE);
        pairing_inputs = PublicPairingPoints::reconstruct(public_inputs, PublicComponentKey{ index });
        index += PairingInputs::PUBLIC_INPUTS_SIZE;
        kernel_return_data = PublicPoint::reconstruct(public_inputs, PublicComponentKey{ index });
        index += G1::PUBLIC_INPUTS_SIZE;
        for (auto& commitment : ecc_op_tables) {
            commitment = PublicPoint::reconstruct(public_inputs, PublicComponentKey{ index });
            index += G1::PUBLIC_INPUTS_SIZE;
        }
    }
 
    void set_public()
    {
        Builder* builder = ecc_op_tables[0].get_context();
 
        if (pairing_inputs.P0.get_context() == nullptr) {
            // Add the default pairing points to the public inputs
            PairingInputs::set_default_to_public(builder);
        } else {
            pairing_inputs.set_public();
        }
        kernel_return_data.set_public();
        for (auto& commitment : ecc_op_tables) {
            commitment.set_public();
        }
 
        // Record that pairing points have been set to public
        builder->pairing_points_tagging.set_public_pairing_points();
        // Finalize the public inputs to ensure no more public inputs can be added hereafter.
        builder->finalize_public_inputs();
    }
 
    static void add_default(Builder& builder)
    {
        HidingKernelIO inputs;
        inputs.pairing_inputs = PairingInputs::construct_default();
        inputs.kernel_return_data = G1(DEFAULT_ECC_COMMITMENT);
        inputs.kernel_return_data.convert_constant_to_fixed_witness(&builder);
        for (auto& table_commitment : inputs.ecc_op_tables) {
            table_commitment = G1(DEFAULT_ECC_COMMITMENT);
            table_commitment.convert_constant_to_fixed_witness(&builder);
        }
        inputs.set_public();
    };
};
 
class RollupIO {
  public:
    using Builder = UltraCircuitBuilder;  // rollup circuits are always Ultra
    using Curve = stdlib::bn254<Builder>; // curve is always bn254
    using FF = stdlib::bn254<Builder>::ScalarField;
    using PairingInputs = stdlib::recursion::PairingPoints<Curve>;
    using IpaClaim = OpeningClaim<stdlib::grumpkin<Builder>>;
 
    using PublicPairingPoints = stdlib::PublicInputComponent<PairingInputs>;
    using PublicIpaClaim = stdlib::PublicInputComponent<IpaClaim>;
 
    PairingInputs pairing_inputs;
    IpaClaim ipa_claim;
 
    // Total size of the IO public inputs
    static constexpr size_t PUBLIC_INPUTS_SIZE = ROLLUP_PUBLIC_INPUTS_SIZE;
 
    void reconstruct_from_public(const std::vector<FF>& public_inputs)
    {
        uint32_t index = static_cast<uint32_t>(public_inputs.size() - PUBLIC_INPUTS_SIZE);
        pairing_inputs = PublicPairingPoints::reconstruct(public_inputs, PublicComponentKey{ index });
        index += PairingInputs::PUBLIC_INPUTS_SIZE;
        ipa_claim = PublicIpaClaim::reconstruct(public_inputs, PublicComponentKey{ index });
    }
 
    void set_public()
    {
        Builder* builder = ipa_claim.commitment.get_context();
 
        if (pairing_inputs.P0.get_context() == nullptr) {
            // Add the default pairing points to the public inputs
            PairingInputs::set_default_to_public(builder);
        } else {
            BB_ASSERT_EQ(builder, pairing_inputs.P0.get_context());
            pairing_inputs.set_public();
        }
        ipa_claim.set_public();
 
        // Record that pairing points have been set to public
        builder->pairing_points_tagging.set_public_pairing_points();
        // Finalize the public inputs to ensure no more public inputs can be added hereafter.
        builder->finalize_public_inputs();
    }
 
    static void add_default(Builder& builder)
    {
        RollupIO inputs;
        inputs.pairing_inputs = PairingInputs::construct_default();
        auto [stdlib_opening_claim, ipa_proof] =
            IPA<grumpkin<Builder>>::create_random_valid_ipa_claim_and_proof(builder);
        inputs.ipa_claim = stdlib_opening_claim;
        inputs.set_public();
 
        builder.ipa_proof = ipa_proof;
    };
};
 
// Default IO type for recursive verifiers: RollupIO for IPA flavors, DefaultIO<Builder> otherwise
template <typename Flavor>
using DefaultRecursiveIO =
    std::conditional_t<HasIPAAccumulator<Flavor>, RollupIO, DefaultIO<typename Flavor::CircuitBuilder>>;
 
} // namespace bb::stdlib::recursion::honk