A high-level merkle db that tracks side effects. More...

#include <side_effect_tracking_db.hpp>

Inheritance diagram for bb::avm2::simulation::SideEffectTrackingDB:

Public Member Functions
	SideEffectTrackingDB (const FF &first_nullifier, HighLevelMerkleDBInterface &merkle_db, SideEffectTrackerInterface &tracked_side_effects)

FF	storage_read (const AztecAddress &contract_address, const FF &slot) const 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

bool	note_hash_exists (uint64_t leaf_index, const FF &unique_note_hash) const override

bool	l1_to_l2_msg_exists (uint64_t leaf_index, const FF &msg_hash) const override

uint32_t	get_checkpoint_id () const override

TreeStates	get_tree_state () const override

LowLevelMerkleDBInterface &	as_unconstrained () const override

void	storage_write (const AztecAddress &contract_address, const FF &slot, const FF &value, bool is_protocol_write) override

void	nullifier_write (const AztecAddress &contract_address, const FF &nullifier) override

void	siloed_nullifier_write (const FF &nullifier) 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

void	pad_trees () override

void	create_checkpoint () override

void	commit_checkpoint () override

void	revert_checkpoint () override

Public Member Functions inherited from bb::avm2::simulation::HighLevelMerkleDBInterface
virtual	~HighLevelMerkleDBInterface ()=default

Private Attributes
FF	first_nullifier

HighLevelMerkleDBInterface &	merkle_db

SideEffectTrackerInterface &	tracked_side_effects

Detailed Description

A high-level merkle db that tracks side effects.

This class is a wrapper around a high-level merkle db that tracks side effects. It delegates all methods to the merkle db, and tracks side effects.

Definition at line 16 of file side_effect_tracking_db.hpp.

Constructor & Destructor Documentation

◆ SideEffectTrackingDB()

bb::avm2::simulation::SideEffectTrackingDB::SideEffectTrackingDB	(	const FF &	first_nullifier,
		HighLevelMerkleDBInterface &	merkle_db,
		SideEffectTrackerInterface &	tracked_side_effects
	)

inline

Definition at line 18 of file side_effect_tracking_db.hpp.

Member Function Documentation

◆ as_unconstrained()

LowLevelMerkleDBInterface & bb::avm2::simulation::SideEffectTrackingDB::as_unconstrained ( ) const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 47 of file side_effect_tracking_db.cpp.

◆ commit_checkpoint()

void bb::avm2::simulation::SideEffectTrackingDB::commit_checkpoint ( )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 104 of file side_effect_tracking_db.cpp.

◆ create_checkpoint()

void bb::avm2::simulation::SideEffectTrackingDB::create_checkpoint ( )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 98 of file side_effect_tracking_db.cpp.

◆ get_checkpoint_id()

uint32_t bb::avm2::simulation::SideEffectTrackingDB::get_checkpoint_id ( ) const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 37 of file side_effect_tracking_db.cpp.

◆ get_tree_state()

TreeStates bb::avm2::simulation::SideEffectTrackingDB::get_tree_state ( ) const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 42 of file side_effect_tracking_db.cpp.

◆ l1_to_l2_msg_exists()

bool bb::avm2::simulation::SideEffectTrackingDB::l1_to_l2_msg_exists	(	uint64_t	leaf_index,
		const FF &	msg_hash
	)		const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 32 of file side_effect_tracking_db.cpp.

◆ note_hash_exists()

bool bb::avm2::simulation::SideEffectTrackingDB::note_hash_exists	(	uint64_t	leaf_index,
		const FF &	unique_note_hash
	)		const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 27 of file side_effect_tracking_db.cpp.

◆ note_hash_write()

void bb::avm2::simulation::SideEffectTrackingDB::note_hash_write	(	const AztecAddress &	contract_address,
		const FF &	note_hash
	)

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 74 of file side_effect_tracking_db.cpp.

◆ nullifier_exists()

bool bb::avm2::simulation::SideEffectTrackingDB::nullifier_exists	(	const AztecAddress &	contract_address,
		const FF &	nullifier
	)		const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 17 of file side_effect_tracking_db.cpp.

◆ nullifier_write()

void bb::avm2::simulation::SideEffectTrackingDB::nullifier_write	(	const AztecAddress &	contract_address,
		const FF &	nullifier
	)

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 62 of file side_effect_tracking_db.cpp.

◆ pad_trees()

void bb::avm2::simulation::SideEffectTrackingDB::pad_trees ( )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 116 of file side_effect_tracking_db.cpp.

◆ revert_checkpoint()

void bb::avm2::simulation::SideEffectTrackingDB::revert_checkpoint ( )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 110 of file side_effect_tracking_db.cpp.

◆ siloed_note_hash_write()

void bb::avm2::simulation::SideEffectTrackingDB::siloed_note_hash_write ( const FF & note_hash )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 83 of file side_effect_tracking_db.cpp.

◆ siloed_nullifier_exists()

bool bb::avm2::simulation::SideEffectTrackingDB::siloed_nullifier_exists ( const FF & nullifier ) const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 22 of file side_effect_tracking_db.cpp.

◆ siloed_nullifier_write()

void bb::avm2::simulation::SideEffectTrackingDB::siloed_nullifier_write ( const FF & nullifier )

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 68 of file side_effect_tracking_db.cpp.

◆ storage_read()

FF bb::avm2::simulation::SideEffectTrackingDB::storage_read	(	const AztecAddress &	contract_address,
		const FF &	slot
	)		const

overridevirtual

Implements bb::avm2::simulation::HighLevelMerkleDBInterface.

Definition at line 7 of file side_effect_tracking_db.cpp.

◆ storage_write()

void bb::avm2::simulation::SideEffectTrackingDB::storage_write	(	const AztecAddress &	contract_address,
		const FF &	slot,
		const FF &	value,
		bool	is_protocol_write
	)