concrete_dbs.hpp

Go to the documentation of this file.

#pragma once
 
#include "barretenberg/vm2/common/avm_inputs.hpp"
#include "barretenberg/vm2/common/aztec_types.hpp"
#include "barretenberg/vm2/simulation/address_derivation.hpp"
#include "barretenberg/vm2/simulation/class_id_derivation.hpp"
#include "barretenberg/vm2/simulation/l1_to_l2_message_tree_check.hpp"
#include "barretenberg/vm2/simulation/lib/db_interfaces.hpp"
#include "barretenberg/vm2/simulation/lib/raw_data_dbs.hpp"
#include "barretenberg/vm2/simulation/note_hash_tree_check.hpp"
#include "barretenberg/vm2/simulation/nullifier_tree_check.hpp"
#include "barretenberg/vm2/simulation/public_data_tree_check.hpp"
#include "barretenberg/vm2/simulation/written_public_data_slots_tree_check.hpp"
 
namespace bb::avm2::simulation {
 
struct TreeCounters {
    uint32_t note_hash_counter;
    uint32_t nullifier_counter;
    uint32_t l2_to_l1_msg_counter;
    // public data tree counter is tracked via the written public data slots tree
 
    bool operator==(const TreeCounters& other) const = default;
};
 
// Generates events.
class ContractDB final : public ContractDBInterface {
  public:
    ContractDB(ContractDBInterface& raw_contract_db,
               AddressDerivationInterface& address_derivation,
               ClassIdDerivationInterface& class_id_derivation)
        : raw_contract_db(raw_contract_db)
        , address_derivation(address_derivation)
        , class_id_derivation(class_id_derivation)
    {}
 
    // Gets an instance from the DB and proves address derivation from the result.
    // This does NOT prove that the address is in the nullifier tree.
    // Silo the address and use the MerkleDB to prove that.
    std::optional<ContractInstance> get_contract_instance(const AztecAddress& address) const override;
    // Gets a class from the DB and proves class id derivation from the result.
    // This does NOT prove that the class id is in the nullifier tree.
    // Silo the class id and use the MerkleDB to prove that.
    std::optional<ContractClass> get_contract_class(const ContractClassId& class_id) const override;
 
  private:
    ContractDBInterface& raw_contract_db;
    AddressDerivationInterface& address_derivation;
    ClassIdDerivationInterface& class_id_derivation;
    // TODO: EventEmitters.
};
 
// Generates events.
class MerkleDB final : public HighLevelMerkleDBInterface {
  public:
    MerkleDB(LowLevelMerkleDBInterface& raw_merkle_db,
             PublicDataTreeCheckInterface& public_data_tree_check,
             NullifierTreeCheckInterface& nullifier_tree_check,
             NoteHashTreeCheckInterface& note_hash_tree_check,
             WrittenPublicDataSlotsInterface& written_public_data_slots,
             L1ToL2MessageTreeCheckInterface& l1_to_l2_msg_tree_check)
        : raw_merkle_db(raw_merkle_db)
        , public_data_tree_check(public_data_tree_check)
        , nullifier_tree_check(nullifier_tree_check)
        , note_hash_tree_check(note_hash_tree_check)
        , written_public_data_slots(written_public_data_slots)
        , l1_to_l2_msg_tree_check(l1_to_l2_msg_tree_check)
    {}
 
    // Unconstrained.
    TreeStates get_tree_state() const override;
    void create_checkpoint() override;
    void commit_checkpoint() override;
    void revert_checkpoint() override;
    uint32_t get_checkpoint_id() const override;
 
    // Constrained.
    FF storage_read(const AztecAddress& contract_address, const FF& slot) const override;
    void storage_write(const AztecAddress& contract_address,
                       const FF& slot,
                       const FF& value,
                       bool is_protocol_write) override;
    bool was_storage_written(const AztecAddress& contract_address, const FF& slot) const override;
 
    bool nullifier_exists(const AztecAddress& contract_address, const FF& nullifier) const override;
    bool siloed_nullifier_exists(const FF& nullifier) const override;
    // Returns false if the nullifier already exists, performing a membership proof instead.
    bool nullifier_write(const AztecAddress& contract_address, const FF& nullifier) override;
    bool siloed_nullifier_write(const FF& nullifier) override;
 
    // Returns a unique note hash stored in the tree at leaf_index.
    bool note_hash_exists(uint64_t leaf_index, const FF& unique_note_hash) const override;
    void note_hash_write(const AztecAddress& contract_address, const FF& note_hash) override;
    void siloed_note_hash_write(const FF& note_hash) override;
    void unique_note_hash_write(const FF& note_hash) override;
    bool l1_to_l2_msg_exists(uint64_t leaf_index, const FF& msg_hash) const override;
 
    void pad_trees() override;
 
    void add_checkpoint_listener(CheckpointNotifiable& listener) { checkpoint_listeners.push_back(&listener); }
 
    LowLevelMerkleDBInterface& as_unconstrained() const override { return raw_merkle_db; }
 
  private:
    bool nullifier_exists_internal(std::optional<AztecAddress> contract_address, const FF& nullifier) const;
    bool nullifier_write_internal(std::optional<AztecAddress> contract_address, const FF& nullifier);
 
    LowLevelMerkleDBInterface& raw_merkle_db;
    // TODO: when you have a merkle gadget, consider marking it "mutable" so that read can be const.
    // It's usually ok for mutexes but a gadget is big...
    PublicDataTreeCheckInterface& public_data_tree_check;
    NullifierTreeCheckInterface& nullifier_tree_check;
    NoteHashTreeCheckInterface& note_hash_tree_check;
    WrittenPublicDataSlotsInterface& written_public_data_slots;
    L1ToL2MessageTreeCheckInterface& l1_to_l2_msg_tree_check;
 
    // Set for semantics.
    using Slot = FF;
    std::vector<CheckpointNotifiable*> checkpoint_listeners;
 
    // Stack of tree counters for checkpoints. Starts empty.
    std::stack<TreeCounters> tree_counters_stack{
        { { .note_hash_counter = 0, .nullifier_counter = 0, .l2_to_l1_msg_counter = 0 } }
    };
};
 
} // namespace bb::avm2::simulation