note_hash_tree_check.hpp

Go to the documentation of this file.

#pragma once
 
#include "barretenberg/vm2/common/aztec_types.hpp"
#include "barretenberg/vm2/common/field.hpp"
#include "barretenberg/vm2/simulation/events/note_hash_tree_check_event.hpp"
#include "barretenberg/vm2/simulation/merkle_check.hpp"
#include "barretenberg/vm2/simulation/poseidon2.hpp"
 
namespace bb::avm2::simulation {
 
class NoteHashTreeCheckInterface {
  public:
    virtual ~NoteHashTreeCheckInterface() = default;
 
    virtual bool note_hash_exists(const FF& unique_note_hash,
                                  const FF& leaf_value,
                                  uint64_t leaf_index,
                                  std::span<const FF> sibling_path,
                                  const AppendOnlyTreeSnapshot& snapshot) = 0;
    virtual FF get_first_nullifier() const = 0;
    virtual AppendOnlyTreeSnapshot append_note_hash(const FF& note_hash,
                                                    AztecAddress contract_address,
                                                    uint64_t note_hash_counter,
                                                    std::span<const FF> sibling_path,
                                                    const AppendOnlyTreeSnapshot& prev_snapshot) = 0;
    virtual AppendOnlyTreeSnapshot append_siloed_note_hash(const FF& siloed_note_hash,
                                                           uint64_t note_hash_counter,
                                                           std::span<const FF> sibling_path,
                                                           const AppendOnlyTreeSnapshot& prev_snapshot) = 0;
    virtual AppendOnlyTreeSnapshot append_unique_note_hash(const FF& unique_note_hash,
                                                           uint64_t note_hash_counter,
                                                           std::span<const FF> sibling_path,
                                                           const AppendOnlyTreeSnapshot& prev_snapshot) = 0;
};
 
class NoteHashTreeCheck : public NoteHashTreeCheckInterface, public CheckpointNotifiable {
  public:
    NoteHashTreeCheck(const FF& first_nullifier,
                      Poseidon2Interface& poseidon2,
                      MerkleCheckInterface& merkle_check,
                      EventEmitterInterface<NoteHashTreeCheckEvent>& event_emitter)
        : first_nullifier(first_nullifier)
        , events(event_emitter)
        , poseidon2(poseidon2)
        , merkle_check(merkle_check)
    {}
 
    FF get_first_nullifier() const override { return first_nullifier; }
 
    bool note_hash_exists(const FF& unique_note_hash,
                          const FF& leaf_value,
                          uint64_t leaf_index,
                          std::span<const FF> sibling_path,
                          const AppendOnlyTreeSnapshot& snapshot) override;
    AppendOnlyTreeSnapshot append_note_hash(const FF& note_hash,
                                            AztecAddress contract_address,
                                            uint64_t note_hash_counter,
                                            std::span<const FF> sibling_path,
                                            const AppendOnlyTreeSnapshot& prev_snapshot) override;
    AppendOnlyTreeSnapshot append_siloed_note_hash(const FF& siloed_note_hash,
                                                   uint64_t note_hash_counter,
                                                   std::span<const FF> sibling_path,
                                                   const AppendOnlyTreeSnapshot& prev_snapshot) override;
    AppendOnlyTreeSnapshot append_unique_note_hash(const FF& unique_note_hash,
                                                   uint64_t note_hash_counter,
                                                   std::span<const FF> sibling_path,
                                                   const AppendOnlyTreeSnapshot& prev_snapshot) override;
 
    void on_checkpoint_created() override;
    void on_checkpoint_committed() override;
    void on_checkpoint_reverted() override;
 
  private:
    FF make_siloed(AztecAddress contract_address, const FF& note_hash) const;
    FF make_nonce(uint64_t note_hash_counter) const;
    FF make_unique(const FF& siloed_note_hash, const FF& nonce) const;
    AppendOnlyTreeSnapshot append_note_hash_internal(FF note_hash,
                                                     std::optional<AztecAddress> contract_address,
                                                     bool should_make_unique,
                                                     uint64_t note_hash_counter,
                                                     std::span<const FF> sibling_path,
                                                     const AppendOnlyTreeSnapshot& prev_snapshot);
 
    FF first_nullifier;
    EventEmitterInterface<NoteHashTreeCheckEvent>& events;
    Poseidon2Interface& poseidon2;
    MerkleCheckInterface& merkle_check;
};
 
} // namespace bb::avm2::simulation