feat: read-requests generated by app circuit, checked in private kernel

circuits/cpp/src/aztec3/circuits/abis/combined_historic_tree_roots.hpp

@@ -12,7 +12,6 @@ namespace aztec3::circuits::abis {
 using aztec3::circuits::abis::PrivateHistoricTreeRoots;
 using aztec3::utils::types::CircuitTypes;
 using aztec3::utils::types::NativeTypes;
-using plonk::stdlib::witness_t;
 using std::is_same;
 
 template <typename NCT> struct CombinedHistoricTreeRoots {

circuits/cpp/src/aztec3/circuits/abis/kernel_circuit_public_inputs.hpp

@@ -12,8 +12,6 @@ namespace aztec3::circuits::abis {
 
 using aztec3::utils::types::CircuitTypes;
 using aztec3::utils::types::NativeTypes;
-using plonk::stdlib::witness_t;
-using std::conditional;
 using std::is_same;
 
 template <typename NCT> struct KernelCircuitPublicInputs {

circuits/cpp/src/aztec3/circuits/abis/private_circuit_public_inputs.hpp

@@ -32,6 +32,8 @@ template <typename NCT> class PrivateCircuitPublicInputs {
 
     std::array<fr, EMITTED_EVENTS_LENGTH> emitted_events = zero_array<fr, EMITTED_EVENTS_LENGTH>();
 
+    std::array<fr, READ_REQUESTS_LENGTH> read_requests = zero_array<fr, READ_REQUESTS_LENGTH>();
+
     std::array<fr, NEW_COMMITMENTS_LENGTH> new_commitments = zero_array<fr, NEW_COMMITMENTS_LENGTH>();
     std::array<fr, NEW_NULLIFIERS_LENGTH> new_nullifiers = zero_array<fr, NEW_NULLIFIERS_LENGTH>();
 
@@ -49,9 +51,10 @@ template <typename NCT> class PrivateCircuitPublicInputs {
     boolean operator==(PrivateCircuitPublicInputs<NCT> const& other) const
     {
         return call_context == other.call_context && args == other.args && return_values == other.return_values &&
-               emitted_events == other.emitted_events && new_commitments == other.new_commitments &&
-               new_nullifiers == other.new_nullifiers && private_call_stack == other.private_call_stack &&
-               public_call_stack == other.public_call_stack && new_l2_to_l1_msgs == other.new_l2_to_l1_msgs &&
+               emitted_events == other.emitted_events && read_requests == other.read_requests &&
+               new_commitments == other.new_commitments && new_nullifiers == other.new_nullifiers &&
+               private_call_stack == other.private_call_stack && public_call_stack == other.public_call_stack &&
+               new_l2_to_l1_msgs == other.new_l2_to_l1_msgs &&
                historic_private_data_tree_root == other.historic_private_data_tree_root &&
                historic_nullifier_tree_root == other.historic_nullifier_tree_root &&
                historic_contract_tree_root == other.historic_contract_tree_root &&
@@ -76,6 +79,8 @@ template <typename NCT> class PrivateCircuitPublicInputs {
 
             to_ct(emitted_events),
 
+            to_ct(read_requests),
+
             to_ct(new_commitments),
             to_ct(new_nullifiers),
 
@@ -108,6 +113,8 @@ template <typename NCT> class PrivateCircuitPublicInputs {
 
             to_nt(emitted_events),
 
+            to_nt(read_requests),
+
             to_nt(new_commitments),
             to_nt(new_nullifiers),
 
@@ -139,6 +146,8 @@ template <typename NCT> class PrivateCircuitPublicInputs {
 
         spread_arr_into_vec(emitted_events, inputs);
 
+        spread_arr_into_vec(read_requests, inputs);
+
         spread_arr_into_vec(new_commitments, inputs);
         spread_arr_into_vec(new_nullifiers, inputs);
 
@@ -172,6 +181,7 @@ template <typename NCT> void read(uint8_t const*& it, PrivateCircuitPublicInputs
     read(it, pis.args);
     read(it, pis.return_values);
     read(it, pis.emitted_events);
+    read(it, pis.read_requests);
     read(it, pis.new_commitments);
     read(it, pis.new_nullifiers);
     read(it, pis.private_call_stack);
@@ -195,6 +205,7 @@ void write(std::vector<uint8_t>& buf, PrivateCircuitPublicInputs<NCT> const& pri
     write(buf, pis.args);
     write(buf, pis.return_values);
     write(buf, pis.emitted_events);
+    write(buf, pis.read_requests);
     write(buf, pis.new_commitments);
     write(buf, pis.new_nullifiers);
     write(buf, pis.private_call_stack);
@@ -217,6 +228,7 @@ std::ostream& operator<<(std::ostream& os, PrivateCircuitPublicInputs<NCT> const
               << "args: " << pis.args << "\n"
               << "return_values: " << pis.return_values << "\n"
               << "emitted_events: " << pis.emitted_events << "\n"
+              << "read_requests: " << pis.read_requests << "\n"
               << "new_commitments: " << pis.new_commitments << "\n"
               << "new_nullifiers: " << pis.new_nullifiers << "\n"
               << "private_call_stack: " << pis.private_call_stack << "\n"
@@ -245,6 +257,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
     std::array<opt_fr, EMITTED_EVENTS_LENGTH> emitted_events;
 
+    std::array<opt_fr, READ_REQUESTS_LENGTH> read_requests;
+
     std::array<opt_fr, NEW_COMMITMENTS_LENGTH> new_commitments;
     std::array<opt_fr, NEW_NULLIFIERS_LENGTH> new_nullifiers;
 
@@ -268,6 +282,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
                                             std::array<opt_fr, EMITTED_EVENTS_LENGTH> const& emitted_events,
 
+                                            std::array<opt_fr, READ_REQUESTS_LENGTH> const& read_requests,
+
                                             std::array<opt_fr, NEW_COMMITMENTS_LENGTH> const& new_commitments,
                                             std::array<opt_fr, NEW_NULLIFIERS_LENGTH> const& new_nullifiers,
 
@@ -285,6 +301,7 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
         , args(args)
         , return_values(return_values)
         , emitted_events(emitted_events)
+        , read_requests(read_requests)
         , new_commitments(new_commitments)
         , new_nullifiers(new_nullifiers)
         , private_call_stack(private_call_stack)
@@ -309,6 +326,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
         new_inputs.emitted_events.fill(std::nullopt);
 
+        new_inputs.read_requests.fill(std::nullopt);
+
         new_inputs.new_commitments.fill(std::nullopt);
         new_inputs.new_nullifiers.fill(std::nullopt);
 
@@ -357,6 +376,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
         make_unused_array_elements_zero(composer, emitted_events);
 
+        make_unused_array_elements_zero(composer, read_requests);
+
         make_unused_array_elements_zero(composer, new_commitments);
         make_unused_array_elements_zero(composer, new_nullifiers);
 
@@ -389,6 +410,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
         set_array_public(emitted_events);
 
+        set_array_public(read_requests);
+
         set_array_public(new_commitments);
         set_array_public(new_nullifiers);
 
@@ -423,6 +446,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
             to_ct(emitted_events),
 
+            to_ct(read_requests),
+
             to_ct(new_commitments),
             to_ct(new_nullifiers),
 
@@ -458,6 +483,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
             to_nt(emitted_events),
 
+            to_nt(read_requests),
+
             to_nt(new_commitments),
             to_nt(new_nullifiers),
 
@@ -494,6 +521,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
         spread_arr_opt_into_vec(emitted_events, inputs);
 
+        spread_arr_opt_into_vec(read_requests, inputs);
+
         spread_arr_opt_into_vec(new_commitments, inputs);
         spread_arr_opt_into_vec(new_nullifiers, inputs);
 
@@ -524,6 +553,8 @@ template <typename NCT> class OptionalPrivateCircuitPublicInputs {
 
             .emitted_events = map(emitted_events, get_value),
 
+            .read_requests = map(read_requests, get_value),
+
             .new_commitments = map(new_commitments, get_value),
             .new_nullifiers = map(new_nullifiers, get_value),
 
@@ -618,6 +649,7 @@ void read(uint8_t const*& it, OptionalPrivateCircuitPublicInputs<NCT>& private_c
     read(it, pis.args);
     read(it, pis.return_values);
     read(it, pis.emitted_events);
+    read(it, pis.read_requests);
     read(it, pis.new_commitments);
     read(it, pis.new_nullifiers);
     read(it, pis.private_call_stack);
@@ -641,6 +673,7 @@ void write(std::vector<uint8_t>& buf, OptionalPrivateCircuitPublicInputs<NCT> co
     write(buf, pis.args);
     write(buf, pis.return_values);
     write(buf, pis.emitted_events);
+    write(buf, pis.read_requests);
     write(buf, pis.new_commitments);
     write(buf, pis.new_nullifiers);
     write(buf, pis.private_call_stack);
@@ -662,6 +695,7 @@ std::ostream& operator<<(std::ostream& os, OptionalPrivateCircuitPublicInputs<NC
               << "args: " << pis.args << "\n"
               << "return_values: " << pis.return_values << "\n"
               << "emitted_events: " << pis.emitted_events << "\n"
+              << "read_requests: " << pis.read_requests << "\n"
               << "new_commitments: " << pis.new_commitments << "\n"
               << "new_nullifiers: " << pis.new_nullifiers << "\n"
               << "private_call_stack: " << pis.private_call_stack << "\n"

circuits/cpp/src/aztec3/circuits/abis/private_kernel/private_call_data.hpp

@@ -6,7 +6,6 @@
 #include "../types.hpp"
 
 #include "aztec3/constants.hpp"
-#include "aztec3/utils/array.hpp"
 #include <aztec3/utils/types/circuit_types.hpp>
 #include <aztec3/utils/types/convert.hpp>
 #include <aztec3/utils/types/native_types.hpp>
@@ -18,7 +17,6 @@ namespace aztec3::circuits::abis::private_kernel {
 
 using aztec3::utils::types::CircuitTypes;
 using aztec3::utils::types::NativeTypes;
-using plonk::stdlib::witness_t;
 using std::is_same;
 
 template <typename NCT> struct PrivateCallData {
@@ -39,6 +37,9 @@ template <typename NCT> struct PrivateCallData {
     MembershipWitness<NCT, FUNCTION_TREE_HEIGHT> function_leaf_membership_witness{};
     MembershipWitness<NCT, CONTRACT_TREE_HEIGHT> contract_leaf_membership_witness{};
 
+    std::array<MembershipWitness<NCT, PRIVATE_DATA_TREE_HEIGHT>, READ_REQUESTS_LENGTH>
+        read_request_membership_witnesses{};
+
     fr portal_contract_address = 0;  // an ETH address
     fr acir_hash = 0;
 
@@ -49,6 +50,7 @@ template <typename NCT> struct PrivateCallData {
                private_call_stack_preimages == other.private_call_stack_preimages && vk == other.vk &&
                function_leaf_membership_witness == other.function_leaf_membership_witness &&
                contract_leaf_membership_witness == other.contract_leaf_membership_witness &&
+               read_request_membership_witnesses == other.read_request_membership_witnesses &&
                portal_contract_address == other.portal_contract_address && acir_hash == other.acir_hash;
     };
 
@@ -75,6 +77,9 @@ template <typename NCT> struct PrivateCallData {
             to_circuit_type(function_leaf_membership_witness),
             to_circuit_type(contract_leaf_membership_witness),
 
+            aztec3::utils::types::to_ct<Composer, MembershipWitness<CT, PRIVATE_DATA_TREE_HEIGHT>>(
+                composer, read_request_membership_witnesses),
+
             to_ct(portal_contract_address),
             to_ct(acir_hash),
         };
@@ -93,6 +98,7 @@ template <typename NCT> void read(uint8_t const*& it, PrivateCallData<NCT>& obj)
     read(it, obj.vk);
     read(it, obj.function_leaf_membership_witness);
     read(it, obj.contract_leaf_membership_witness);
+    read(it, obj.read_request_membership_witnesses);
     read(it, obj.portal_contract_address);
     read(it, obj.acir_hash);
 };
@@ -107,6 +113,7 @@ template <typename NCT> void write(std::vector<uint8_t>& buf, PrivateCallData<NC
     write(buf, *obj.vk);
     write(buf, obj.function_leaf_membership_witness);
     write(buf, obj.contract_leaf_membership_witness);
+    write(buf, obj.read_request_membership_witnesses);
     write(buf, obj.portal_contract_address);
     write(buf, obj.acir_hash);
 };
@@ -125,6 +132,8 @@ template <typename NCT> std::ostream& operator<<(std::ostream& os, PrivateCallDa
               << obj.function_leaf_membership_witness << "\n"
               << "contract_leaf_membership_witness:\n"
               << obj.contract_leaf_membership_witness << "\n"
+              << "read_request_membership_witnesses:\n"
+              << obj.read_request_membership_witnesses << "\n"
               << "portal_contract_address: " << obj.portal_contract_address << "\n"
               << "acir_hash: " << obj.acir_hash << "\n";
 }

circuits/cpp/src/aztec3/circuits/hash.hpp

@@ -7,6 +7,7 @@
 #include <aztec3/utils/circuit_errors.hpp>
 
 #include "barretenberg/crypto/sha256/sha256.hpp"
+#include <barretenberg/stdlib/merkle_tree/memory_tree.hpp>
 
 #include <array>
 
@@ -15,6 +16,7 @@ namespace aztec3::circuits {
 using abis::FunctionData;
 using aztec3::circuits::abis::ContractLeafPreimage;
 using aztec3::circuits::abis::FunctionLeafPreimage;
+using MerkleTree = stdlib::merkle_tree::MemoryTree;
 
 template <typename NCT> typename NCT::fr compute_args_hash(std::array<typename NCT::fr, ARGS_LENGTH> args)
 {
@@ -151,6 +153,23 @@ typename NCT::fr root_from_sibling_path(typename NCT::fr const& leaf,
     return node;  // root
 }
 
+template <size_t N>
+std::array<fr, N> get_sibling_path(MerkleTree& tree, size_t leafIndex, size_t const& subtree_depth_to_skip)
+{
+    std::array<fr, N> siblingPath;
+    auto path = tree.get_hash_path(leafIndex);
+    // slice out the skip
+    leafIndex = leafIndex >> (subtree_depth_to_skip);
+    for (size_t i = 0; i < N; i++) {
+        if (leafIndex & (1 << i)) {
+            siblingPath[i] = path[subtree_depth_to_skip + i].first;
+        } else {
+            siblingPath[i] = path[subtree_depth_to_skip + i].second;
+        }
+    }
+    return siblingPath;
+}
+
 template <typename NCT, typename Composer, size_t SIZE>
 void check_membership(Composer& composer,
                       typename NCT::fr const& value,