@aztec/simulator 0.0.0-test.1 → 0.0.1-commit.5476d83

package/dest/public/public_db_sources.js

@@ -1,264 +1,291 @@
+import { L1_TO_L2_MSG_TREE_LEAF_COUNT, NOTE_HASH_TREE_LEAF_COUNT, NULLIFIER_SUBTREE_HEIGHT, PUBLIC_DATA_SUBTREE_HEIGHT } from '@aztec/constants';
 import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
-import { ContractClassRegisteredEvent } from '@aztec/protocol-contracts/class-registerer';
-import { ContractInstanceDeployedEvent } from '@aztec/protocol-contracts/instance-deployer';
+import { ContractClassPublishedEvent } from '@aztec/protocol-contracts/class-registry';
+import { ContractInstancePublishedEvent } from '@aztec/protocol-contracts/instance-registry';
 import { PublicDataWrite } from '@aztec/stdlib/avm';
-import { computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
+import { AllContractDeploymentData, computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
 import { computePublicDataTreeLeafSlot } from '@aztec/stdlib/hash';
-import { MerkleTreeId } from '@aztec/stdlib/trees';
-import { TxContractCache } from './tx_contract_cache.js';
+import { MerkleTreeId, NullifierLeaf, PublicDataTreeLeaf, getTreeName } from '@aztec/stdlib/trees';
+import { TreeSnapshots } from '@aztec/stdlib/tx';
+import { strict as assert } from 'assert';
+import { ContractsDbCheckpoint } from './contracts_db_checkpoint.js';
+import { L1ToL2MessageIndexOutOfRangeError, NoteHashIndexOutOfRangeError } from './side_effect_errors.js';
 /**
- * Implements the PublicContractsDB using a ContractDataSource.
- * Progressively records contracts in transaction as they are processed in a block.
- * Separates block-level contract information (from processed/included txs) from the
- * current tx's contract information (which may be cleared on tx revert/death).
- */ export class ContractsDataSourcePublicDB {
+ * Implements the PublicContractsDBInterface using a ContractDataSource.
+ * Uses a stack-based checkpoint model for managing contract state.
+ */ export class PublicContractsDB {
     dataSource;
-    // Two caching layers for contract classes and instances.
-    // Tx-level cache:
-    //   - The current tx's new contract information is cached
-    //     in currentTxNonRevertibleCache and currentTxRevertibleCache.
-    // Block-level cache:
-    //   - Contract information from earlier in the block, usable by later txs.
-    // When a tx succeeds, that tx's caches are merged into the block cache and cleared.
-    currentTxNonRevertibleCache;
-    currentTxRevertibleCache;
-    blockCache;
-    // Separate flat cache for bytecode commitments.
-    bytecodeCommitmentCache;
+    contractStateStack;
     log;
     constructor(dataSource){
         this.dataSource = dataSource;
-        this.currentTxNonRevertibleCache = new TxContractCache();
-        this.currentTxRevertibleCache = new TxContractCache();
-        this.blockCache = new TxContractCache();
-        this.bytecodeCommitmentCache = new Map();
+        this.contractStateStack = [
+            new ContractsDbCheckpoint()
+        ];
         this.log = createLogger('simulator:contracts-data-source');
     }
-    /**
-   * Add new contracts from a transaction
-   * @param tx - The transaction to add contracts from.
-   */ async addNewContracts(tx) {
-        await this.addNonRevertibleContractClasses(tx);
-        await this.addRevertibleContractClasses(tx);
-        this.addNonRevertibleContractInstances(tx);
-        this.addRevertibleContractInstances(tx);
-    }
-    /**
-   * Add non revertible contracts from a transaction
-   * @param tx - The transaction to add non revertible contracts from.
-   */ async addNewNonRevertibleContracts(tx) {
-        await this.addNonRevertibleContractClasses(tx);
-        this.addNonRevertibleContractInstances(tx);
-    }
-    /**
-   * Add revertible contracts from a transaction
-   * @param tx - The transaction to add revertible contracts from.
-   */ async addNewRevertibleContracts(tx) {
-        await this.addRevertibleContractClasses(tx);
-        this.addRevertibleContractInstances(tx);
-    }
-    /**
-   * Add non-revertible contract classes from a transaction
-   * For private-only txs, this will be all contract classes (found in tx.data.forPublic)
-   * @param tx - The transaction to add non-revertible contract classes from.
-   */ async addNonRevertibleContractClasses(tx) {
-        const siloedContractClassLogs = tx.data.forPublic ? await tx.filterContractClassLogs(tx.data.forPublic.nonRevertibleAccumulatedData.contractClassLogsHashes, /*siloed=*/ true) : await tx.filterContractClassLogs(tx.data.forRollup.end.contractClassLogsHashes, /*siloed=*/ true);
-        await this.addContractClassesFromLogs(siloedContractClassLogs, this.currentTxNonRevertibleCache, 'non-revertible');
-    }
-    /**
-   * Add revertible contract classes from a transaction
-   * None for private-only txs.
-   * @param tx - The transaction to add revertible contract classes from.
-   */ async addRevertibleContractClasses(tx) {
-        const siloedContractClassLogs = tx.data.forPublic ? await tx.filterContractClassLogs(tx.data.forPublic.revertibleAccumulatedData.contractClassLogsHashes, /*siloed=*/ true) : [];
-        await this.addContractClassesFromLogs(siloedContractClassLogs, this.currentTxRevertibleCache, 'revertible');
-    }
-    /**
-   * Add non-revertible contract instances from a transaction
-   * For private-only txs, this will be all contract instances (found in tx.data.forRollup)
-   * @param tx - The transaction to add non-revertible contract instances from.
-   */ addNonRevertibleContractInstances(tx) {
-        const contractInstanceLogs = tx.data.forPublic ? tx.data.forPublic.nonRevertibleAccumulatedData.privateLogs.filter((l)=>!l.isEmpty()) : tx.data.forRollup.end.privateLogs.filter((l)=>!l.isEmpty());
-        this.addContractInstancesFromLogs(contractInstanceLogs, this.currentTxNonRevertibleCache, 'non-revertible');
+    async addContracts(contractDeploymentData) {
+        const currentState = this.getCurrentState();
+        await this.addContractClassesFromEvents(ContractClassPublishedEvent.extractContractClassEvents(contractDeploymentData.getContractClassLogs()), currentState);
+        this.addContractInstancesFromEvents(ContractInstancePublishedEvent.extractContractInstanceEvents(contractDeploymentData.getPrivateLogs()), currentState);
     }
-    /**
-   * Add revertible contract instances from a transaction
-   * None for private-only txs.
-   * @param tx - The transaction to add revertible contract instances from.
-   */ addRevertibleContractInstances(tx) {
-        const contractInstanceLogs = tx.data.forPublic ? tx.data.forPublic.revertibleAccumulatedData.privateLogs.filter((l)=>!l.isEmpty()) : [];
-        this.addContractInstancesFromLogs(contractInstanceLogs, this.currentTxRevertibleCache, 'revertible');
+    async addNewContracts(tx) {
+        const contractDeploymentData = AllContractDeploymentData.fromTx(tx);
+        await this.addContracts(contractDeploymentData.getNonRevertibleContractDeploymentData());
+        await this.addContracts(contractDeploymentData.getRevertibleContractDeploymentData());
     }
     /**
-   * Given a tx's siloed contract class logs, add the contract classes to the cache
-   * @param siloedContractClassLogs - Contract class logs to process
-   * @param cache - The cache to store the contract classes in
-   * @param cacheType - Type of cache (for logging)
-   */ async addContractClassesFromLogs(siloedContractClassLogs, cache, cacheType) {
-        const contractClassEvents = siloedContractClassLogs.filter((log)=>ContractClassRegisteredEvent.isContractClassRegisteredEvent(log)).map((log)=>ContractClassRegisteredEvent.fromLog(log));
-        // Cache contract classes
-        await Promise.all(contractClassEvents.map(async (event)=>{
-            this.log.debug(`Adding class ${event.contractClassId.toString()} to contract's ${cacheType} tx cache`);
-            const contractClass = await event.toContractClassPublic();
-            cache.addClass(event.contractClassId, contractClass);
-        }));
+   * Creates a new checkpoint, copying the current state for upcoming modifications,
+   * and enabling rollbacks to current state in case of a revert.
+   */ createCheckpoint() {
+        const currentState = this.getCurrentState();
+        const newState = currentState.deepCopy();
+        this.contractStateStack.push(newState);
     }
     /**
-   * Given a tx's contract instance logs, add the contract instances to the cache
-   * @param contractInstanceLogs - Contract instance logs to process
-   * @param cache - The cache to store the contract instances in
-   * @param cacheType - Type of cache (for logging)
-   */ addContractInstancesFromLogs(contractInstanceLogs, cache, cacheType) {
-        const contractInstanceEvents = contractInstanceLogs.filter((log)=>ContractInstanceDeployedEvent.isContractInstanceDeployedEvent(log)).map((log)=>ContractInstanceDeployedEvent.fromLog(log));
-        // Cache contract instances
-        contractInstanceEvents.forEach((e)=>{
-            this.log.debug(`Adding instance ${e.address.toString()} with class ${e.contractClassId.toString()} to ${cacheType} tx contract cache`);
-            cache.addInstance(e.address, e.toContractInstance());
-        });
+   * Commits the current checkpoint, accepting its state latest.
+   */ commitCheckpoint() {
+        if (this.contractStateStack.length <= 1) {
+            throw new Error('No checkpoint to commit');
+        }
+        const topState = this.contractStateStack.pop();
+        this.contractStateStack[this.contractStateStack.length - 1] = topState;
     }
     /**
-   * Clear new contracts from the current tx's cache
-   */ clearContractsForTx() {
-        this.currentTxRevertibleCache.clear();
-        this.currentTxRevertibleCache.clear();
-        this.currentTxNonRevertibleCache.clear();
+   * Commits the current checkpoint, not erroring if there is no checkpoint
+   * to commit. This is useful to do a sanity commit at the end of tx execution,
+   * doing nothing if the checkpoint was already reverted, but truly committing
+   * otherwise.
+   */ commitCheckpointOkIfNone() {
+        if (this.contractStateStack.length <= 1) {
+            return;
+        }
+        const topState = this.contractStateStack.pop();
+        this.contractStateStack[this.contractStateStack.length - 1] = topState;
     }
     /**
-   * Commits the current transaction's cached contracts to the block-level cache.
-   * Then, clears the tx cache.
-   */ commitContractsForTx(onlyNonRevertibles = false) {
-        // Merge non-revertible tx cache into block cache
-        this.blockCache.mergeFrom(this.currentTxNonRevertibleCache);
-        if (!onlyNonRevertibles) {
-            // Merge revertible tx cache into block cache
-            this.blockCache.mergeFrom(this.currentTxRevertibleCache);
+   * Reverts the current checkpoint, discarding its state and rolling back
+   * to the state as of the latest checkpoint.
+   */ revertCheckpoint() {
+        if (this.contractStateStack.length <= 1) {
+            throw new Error('No checkpoint to revert');
         }
-        // Clear the tx's caches
-        this.currentTxNonRevertibleCache.clear();
-        this.currentTxRevertibleCache.clear();
+        this.contractStateStack.pop();
+    }
+    getCurrentState() {
+        return this.contractStateStack[this.contractStateStack.length - 1];
     }
-    async getContractInstance(address) {
-        // Check caches in order: tx revertible -> tx non-revertible -> block -> data source
-        return this.currentTxRevertibleCache.getInstance(address) ?? this.currentTxNonRevertibleCache.getInstance(address) ?? this.blockCache.getInstance(address) ?? await this.dataSource.getContract(address);
+    // TODO(fcarreiro/alvaro): This method currently needs a blockNumber. Since this class
+    // is only ever used for a given block, it should be possible to construct it with the
+    // block number and then forget about it. However, since this class (and interface) is
+    // currently more externally exposed than we'd want to, Facundo preferred to not add it
+    // to the constructor right now. If we can make this class more private, we should
+    // reconsider this. A litmus test is in how many places we need to initialize with a
+    // dummy block number (tests or not) and pass block numbers to `super`.
+    // Note: Block number got changed to timestamp so this comment ^ is outdated. Keeping
+    // the comment as is as I am not part of the AVM cabal.
+    async getContractInstance(address, timestamp) {
+        const currentState = this.getCurrentState();
+        return currentState.getInstance(address) ?? await this.dataSource.getContract(address, timestamp);
     }
     async getContractClass(contractClassId) {
-        // Check caches in order: tx revertible -> tx non-revertible -> block -> data source
-        return this.currentTxRevertibleCache.getClass(contractClassId) ?? this.currentTxNonRevertibleCache.getClass(contractClassId) ?? this.blockCache.getClass(contractClassId) ?? await this.dataSource.getContractClass(contractClassId);
+        const currentState = this.getCurrentState();
+        return currentState.getClass(contractClassId) ?? await this.dataSource.getContractClass(contractClassId);
     }
     async getBytecodeCommitment(contractClassId) {
-        // Try and retrieve from cache
-        const key = contractClassId.toString();
-        const result = this.bytecodeCommitmentCache.get(key);
-        if (result !== undefined) {
-            return result;
+        const currentState = this.getCurrentState();
+        const commitment = currentState.getBytecodeCommitment(contractClassId) ?? await this.dataSource.getBytecodeCommitment(contractClassId);
+        if (commitment !== undefined) {
+            return commitment;
         }
-        // Now try from the store
-        const fromStore = await this.dataSource.getBytecodeCommitment(contractClassId);
-        if (fromStore !== undefined) {
-            this.bytecodeCommitmentCache.set(key, fromStore);
-            return fromStore;
-        }
-        // Not in either the store or the cache, build it here and cache
+        // Not in the current state or the store, compute it here
+        // Get the contract class
         const contractClass = await this.getContractClass(contractClassId);
         if (contractClass === undefined) {
+            // cannot compute bytecode commitment if contract class is not found
             return undefined;
         }
         const value = await computePublicBytecodeCommitment(contractClass.packedBytecode);
-        this.bytecodeCommitmentCache.set(key, value);
+        // Add to cache (current checkpoint state) so we don't compute again
+        currentState.addBytecodeCommitment(contractClassId, value);
         return value;
     }
     async getDebugFunctionName(address, selector) {
-        return await this.dataSource.getContractFunctionName(address, selector);
+        return await this.dataSource.getDebugFunctionName(address, selector);
+    }
+    async addContractClassesFromEvents(contractClassEvents, state) {
+        await Promise.all(contractClassEvents.map(async (event)=>{
+            this.log.debug(`Adding class ${event.contractClassId.toString()} to contract state`);
+            const contractClass = await event.toContractClassPublic();
+            state.addClass(event.contractClassId, contractClass);
+        }));
+    }
+    addContractInstancesFromEvents(contractInstanceEvents, state) {
+        contractInstanceEvents.forEach((e)=>{
+            this.log.debug(`Adding instance ${e.address.toString()} with class ${e.contractClassId.toString()} to contract state`);
+            state.addInstance(e.address, e.toContractInstance());
+        });
     }
 }
 /**
- * A public state DB that reads and writes to the world state.
- */ export class WorldStateDB extends ContractsDataSourcePublicDB {
+ * A high-level class that provides access to the merkle trees.
+ *
+ * This class is just a helper wrapper around a merkle db. Anything that you can do with it
+ * can also be done directly with the merkle db. This class should NOT be exposed or used
+ * outside of `simulator/src/public`.
+ *
+ * NOTE: This class is currently written in such a way that it would generate the
+ * necessary hints if used with a hinting merkle db. This is a bit of a leak of concepts.
+ * Eventually we can have everything depend on a config/factory at the TxSimulator level
+ * to decide whether to use hints or not (same with tracing, etc).
+ */ export class PublicTreesDB {
     db;
     logger;
-    constructor(db, dataSource){
-        super(dataSource), this.db = db, this.logger = createLogger('simulator:world-state-db');
+    constructor(db){
+        this.db = db;
+        this.logger = createLogger('simulator:public-trees-db');
     }
-    /**
-   * Checkpoints the current fork state
-   */ async createCheckpoint() {
-        await this.db.createCheckpoint();
-    }
-    /**
-   * Commits the current checkpoint
-   */ async commitCheckpoint() {
-        await this.db.commitCheckpoint();
-    }
-    /**
-   * Reverts the current checkpoint
-   */ async revertCheckpoint() {
-        await this.db.revertCheckpoint();
-    }
-    getMerkleInterface() {
-        return this.db;
-    }
-    /**
-   * Reads a value from public storage, returning zero if none.
-   * @param contract - Owner of the storage.
-   * @param slot - Slot to read in the contract storage.
-   * @returns The current value in the storage slot.
-   */ async storageRead(contract, slot) {
-        return await readPublicState(this.db, contract, slot);
+    async storageRead(contract, slot) {
+        const timer = new Timer();
+        const leafSlot = (await computePublicDataTreeLeafSlot(contract, slot)).toBigInt();
+        const lowLeafResult = await this.db.getPreviousValueIndex(MerkleTreeId.PUBLIC_DATA_TREE, leafSlot);
+        if (!lowLeafResult) {
+            throw new Error('Low leaf not found');
+        }
+        // TODO: We need this for the hints. See class comment for more details.
+        await this.db.getSiblingPath(MerkleTreeId.PUBLIC_DATA_TREE, lowLeafResult.index);
+        // Unconditionally fetching the preimage for the hints. Move it to the hinting layer?
+        const preimage = await this.db.getLeafPreimage(MerkleTreeId.PUBLIC_DATA_TREE, lowLeafResult.index);
+        const result = lowLeafResult.alreadyPresent ? preimage.leaf.value : Fr.ZERO;
+        this.logger.debug(`Storage read (contract=${contract}, slot=${slot}, value=${result})`, {
+            eventName: 'public-db-access',
+            duration: timer.ms(),
+            operation: 'storage-read'
+        });
+        return result;
     }
-    /**
-   * Records a write to public storage.
-   * @param contract - Owner of the storage.
-   * @param slot - Slot to read in the contract storage.
-   * @param newValue - The new value to store.
-   * @returns The slot of the written leaf in the public data tree.
-   */ async storageWrite(contract, slot, newValue) {
+    async storageWrite(contract, slot, newValue) {
+        const timer = new Timer();
         const leafSlot = await computePublicDataTreeLeafSlot(contract, slot);
         const publicDataWrite = new PublicDataWrite(leafSlot, newValue);
         await this.db.sequentialInsert(MerkleTreeId.PUBLIC_DATA_TREE, [
             publicDataWrite.toBuffer()
         ]);
+        this.logger.debug(`Storage write (contract=${contract}, slot=${slot}, value=${newValue})`, {
+            eventName: 'public-db-access',
+            duration: timer.ms(),
+            operation: 'storage-write'
+        });
     }
     async getL1ToL2LeafValue(leafIndex) {
         const timer = new Timer();
+        if (leafIndex > L1_TO_L2_MSG_TREE_LEAF_COUNT) {
+            throw new L1ToL2MessageIndexOutOfRangeError(Number(leafIndex));
+        }
         const leafValue = await this.db.getLeafValue(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, leafIndex);
-        this.logger.debug(`[DB] Fetched L1 to L2 message leaf value`, {
+        assert(leafValue !== undefined, 'Unexpected null response from l1 to l2 message tree');
+        // TODO: We need this for the hints. See class comment for more details.
+        await this.db.getSiblingPath(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, leafIndex);
+        this.logger.debug(`Fetched L1 to L2 message leaf value (leafIndex=${leafIndex}, value=${leafValue})`, {
             eventName: 'public-db-access',
             duration: timer.ms(),
             operation: 'get-l1-to-l2-message-leaf-value'
         });
         return leafValue;
     }
-    async getCommitmentValue(leafIndex) {
+    async getNoteHash(leafIndex) {
         const timer = new Timer();
+        if (leafIndex > NOTE_HASH_TREE_LEAF_COUNT) {
+            throw new NoteHashIndexOutOfRangeError(Number(leafIndex));
+        }
         const leafValue = await this.db.getLeafValue(MerkleTreeId.NOTE_HASH_TREE, leafIndex);
-        this.logger.debug(`[DB] Fetched commitment leaf value`, {
+        assert(leafValue !== undefined, 'Unexpected null response from note hash tree');
+        // TODO: We need this for the hints. See class comment for more details.
+        await this.db.getSiblingPath(MerkleTreeId.NOTE_HASH_TREE, leafIndex);
+        this.logger.debug(`Fetched note hash leaf value (leafIndex=${leafIndex}, value=${leafValue})`, {
             eventName: 'public-db-access',
             duration: timer.ms(),
-            operation: 'get-commitment-leaf-value'
+            operation: 'get-note-hash'
         });
         return leafValue;
     }
-    async getNullifierIndex(nullifier) {
+    async writeNoteHash(noteHash) {
         const timer = new Timer();
-        const index = (await this.db.findLeafIndices(MerkleTreeId.NULLIFIER_TREE, [
-            nullifier.toBuffer()
-        ]))[0];
-        this.logger.debug(`[DB] Fetched nullifier index`, {
+        await this.db.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, [
+            noteHash
+        ]);
+        this.logger.debug(`Wrote note hash (noteHash=${noteHash})`, {
             eventName: 'public-db-access',
             duration: timer.ms(),
-            operation: 'get-nullifier-index'
+            operation: 'write-note-hash'
         });
-        return index;
     }
-}
-export async function readPublicState(db, contract, slot) {
-    const leafSlot = (await computePublicDataTreeLeafSlot(contract, slot)).toBigInt();
-    const lowLeafResult = await db.getPreviousValueIndex(MerkleTreeId.PUBLIC_DATA_TREE, leafSlot);
-    if (!lowLeafResult || !lowLeafResult.alreadyPresent) {
-        return Fr.ZERO;
+    async checkNullifierExists(nullifier) {
+        const timer = new Timer();
+        const lowLeafResult = await this.db.getPreviousValueIndex(MerkleTreeId.NULLIFIER_TREE, nullifier.toBigInt());
+        if (!lowLeafResult) {
+            throw new Error('Low leaf not found');
+        }
+        // TODO: We need this for the hints. See class comment for more details.
+        await this.db.getSiblingPath(MerkleTreeId.NULLIFIER_TREE, lowLeafResult.index);
+        // TODO: We need this for the hints. See class comment for more details.
+        await this.db.getLeafPreimage(MerkleTreeId.NULLIFIER_TREE, lowLeafResult.index);
+        const exists = lowLeafResult.alreadyPresent;
+        this.logger.debug(`Checked nullifier exists (nullifier=${nullifier}, exists=${exists})`, {
+            eventName: 'public-db-access',
+            duration: timer.ms(),
+            operation: 'check-nullifier-exists'
+        });
+        return exists;
+    }
+    async writeNullifier(siloedNullifier) {
+        const timer = new Timer();
+        await this.db.sequentialInsert(MerkleTreeId.NULLIFIER_TREE, [
+            siloedNullifier.toBuffer()
+        ]);
+        this.logger.debug(`Wrote nullifier (nullifier=${siloedNullifier})`, {
+            eventName: 'public-db-access',
+            duration: timer.ms(),
+            operation: 'write-nullifier'
+        });
+    }
+    async padTree(treeId, leavesToInsert) {
+        const timer = new Timer();
+        switch(treeId){
+            // Indexed trees.
+            case MerkleTreeId.NULLIFIER_TREE:
+                await this.db.batchInsert(treeId, Array(leavesToInsert).fill(NullifierLeaf.empty().toBuffer()), NULLIFIER_SUBTREE_HEIGHT);
+                break;
+            case MerkleTreeId.PUBLIC_DATA_TREE:
+                await this.db.batchInsert(treeId, Array(leavesToInsert).fill(PublicDataTreeLeaf.empty().toBuffer()), PUBLIC_DATA_SUBTREE_HEIGHT);
+                break;
+            // Append-only trees.
+            case MerkleTreeId.L1_TO_L2_MESSAGE_TREE:
+            case MerkleTreeId.NOTE_HASH_TREE:
+                await this.db.appendLeaves(treeId, Array(leavesToInsert).fill(Fr.ZERO));
+                break;
+            default:
+                throw new Error(`Padding not supported for tree ${treeId}`);
+        }
+        this.logger.debug(`Padded tree (tree=${getTreeName(treeId)}, leavesToInsert=${leavesToInsert})`, {
+            eventName: 'public-db-access',
+            duration: timer.ms(),
+            operation: 'pad-tree'
+        });
+    }
+    async createCheckpoint() {
+        await this.db.createCheckpoint();
+    }
+    async commitCheckpoint() {
+        await this.db.commitCheckpoint();
+    }
+    async revertCheckpoint() {
+        await this.db.revertCheckpoint();
+    }
+    async getTreeSnapshots() {
+        const stateReference = await this.db.getStateReference();
+        return new TreeSnapshots(stateReference.l1ToL2MessageTree, stateReference.partial.noteHashTree, stateReference.partial.nullifierTree, stateReference.partial.publicDataTree);
     }
-    const preimage = await db.getLeafPreimage(MerkleTreeId.PUBLIC_DATA_TREE, lowLeafResult.index);
-    return preimage.value;
 }

package/dest/public/public_errors.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Any known (and checked) error that can be thrown during public execution.
+ * Includes AvmExecutionErrors and SideEffectErrors.
+ *
+ * AvmSimulator catches any checked errors before returning a boolean "reverted".
+ * Unchecked errors are generally the result of a bug. They are propagated and
+ * ultimately will be the resonsibility of PublicProcessor to handle.
+ */
+export declare abstract class CheckedPublicExecutionError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljX2Vycm9ycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3B1YmxpYy9wdWJsaWNfZXJyb3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7O0dBT0c7QUFDSCw4QkFBc0IsMkJBQTRCLFNBQVEsS0FBSztJQUM3RCxZQUFZLE9BQU8sRUFBRSxNQUFNLEVBRzFCO0NBQ0YifQ==

package/dest/public/public_errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_errors.d.ts","sourceRoot":"","sources":["../../src/public/public_errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,8BAAsB,2BAA4B,SAAQ,KAAK;IAC7D,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF"}

package/dest/public/public_errors.js

@@ -0,0 +1,13 @@
+/**
+ * Any known (and checked) error that can be thrown during public execution.
+ * Includes AvmExecutionErrors and SideEffectErrors.
+ *
+ * AvmSimulator catches any checked errors before returning a boolean "reverted".
+ * Unchecked errors are generally the result of a bug. They are propagated and
+ * ultimately will be the resonsibility of PublicProcessor to handle.
+ */ export class CheckedPublicExecutionError extends Error {
+    constructor(message){
+        super(message);
+        this.name = 'CheckedPublicExecutionError';
+    }
+}

package/dest/public/public_processor/guarded_merkle_tree.d.ts

@@ -0,0 +1,49 @@
+import type { IndexedTreeLeafPreimage, SiblingPath } from '@aztec/foundation/trees';
+import type { BatchInsertionResult, IndexedTreeId, MerkleTreeId, MerkleTreeLeafType, MerkleTreeWriteOperations, SequentialInsertionResult, TreeHeights, TreeInfo } from '@aztec/stdlib/trees';
+import type { BlockHeader, StateReference } from '@aztec/stdlib/tx';
+import type { WorldStateRevision, WorldStateRevisionWithHandle } from '@aztec/stdlib/world-state';
+/**
+ * Wraps an instance of `MerkleTreeWriteOperations` to allow the sequencer to gate access.
+ * If transactions execution goes past the deadline, the simulator will continue to execute and update the world state
+ * The public processor however requires that the world state remain constant after the deadline in order to finalize the block
+ * The public processor provides this implementation of MerkleTreeWriteOperations to the simulator
+ */
+export declare class GuardedMerkleTreeOperations implements MerkleTreeWriteOperations {
+    private target;
+    private isStopped;
+    private serialQueue;
+    constructor(target: MerkleTreeWriteOperations);
+    private guard;
+    private guardAndPush;
+    getUnderlyingFork(): MerkleTreeWriteOperations;
+    stop(): Promise<void>;
+    appendLeaves<ID extends MerkleTreeId>(treeId: ID, leaves: MerkleTreeLeafType<ID>[]): Promise<void>;
+    updateArchive(header: BlockHeader): Promise<void>;
+    batchInsert<TreeHeight extends number, SubtreeSiblingPathHeight extends number, ID extends IndexedTreeId>(treeId: ID, leaves: Buffer[], subtreeHeight: number): Promise<BatchInsertionResult<TreeHeight, SubtreeSiblingPathHeight>>;
+    sequentialInsert<TreeHeight extends number, ID extends IndexedTreeId>(treeId: ID, leaves: Buffer[]): Promise<SequentialInsertionResult<TreeHeight>>;
+    close(): Promise<void>;
+    getTreeInfo(treeId: MerkleTreeId): Promise<TreeInfo>;
+    getStateReference(): Promise<StateReference>;
+    getInitialHeader(): BlockHeader;
+    getRevision(): WorldStateRevision | WorldStateRevisionWithHandle;
+    getSiblingPath<ID extends MerkleTreeId>(treeId: ID, index: bigint): Promise<SiblingPath<TreeHeights[ID]>>;
+    getPreviousValueIndex<ID extends IndexedTreeId>(treeId: ID, value: bigint): Promise<{
+        index: bigint;
+        alreadyPresent: boolean;
+    } | undefined>;
+    getLeafPreimage<ID extends IndexedTreeId>(treeId: ID, index: bigint): Promise<IndexedTreeLeafPreimage | undefined>;
+    findLeafIndices<ID extends MerkleTreeId>(treeId: ID, values: MerkleTreeLeafType<ID>[]): Promise<(bigint | undefined)[]>;
+    findLeafIndicesAfter<ID extends MerkleTreeId>(treeId: ID, values: MerkleTreeLeafType<ID>[], startIndex: bigint): Promise<(bigint | undefined)[]>;
+    getLeafValue<ID extends MerkleTreeId>(treeId: ID, index: bigint): Promise<MerkleTreeLeafType<typeof treeId> | undefined>;
+    getBlockNumbersForLeafIndices<ID extends MerkleTreeId>(treeId: ID, leafIndices: bigint[]): Promise<(bigint | undefined)[]>;
+    createCheckpoint(): Promise<void>;
+    commitCheckpoint(): Promise<void>;
+    revertCheckpoint(): Promise<void>;
+    commitAllCheckpoints(): Promise<void>;
+    revertAllCheckpoints(): Promise<void>;
+    findSiblingPaths<ID extends MerkleTreeId>(treeId: ID, values: MerkleTreeLeafType<ID>[]): Promise<({
+        path: SiblingPath<TreeHeights[ID]>;
+        index: bigint;
+    } | undefined)[]>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3VhcmRlZF9tZXJrbGVfdHJlZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3B1YmxpYy9wdWJsaWNfcHJvY2Vzc29yL2d1YXJkZWRfbWVya2xlX3RyZWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLEVBQUUsdUJBQXVCLEVBQUUsV0FBVyxFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFDcEYsT0FBTyxLQUFLLEVBQ1Ysb0JBQW9CLEVBQ3BCLGFBQWEsRUFDYixZQUFZLEVBQ1osa0JBQWtCLEVBQ2xCLHlCQUF5QixFQUN6Qix5QkFBeUIsRUFDekIsV0FBVyxFQUNYLFFBQVEsRUFDVCxNQUFNLHFCQUFxQixDQUFDO0FBQzdCLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxjQUFjLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUNwRSxPQUFPLEtBQUssRUFBRSxrQkFBa0IsRUFBRSw0QkFBNEIsRUFBRSxNQUFNLDJCQUEyQixDQUFDO0FBRWxHOzs7OztHQUtHO0FBRUgscUJBQWEsMkJBQTRCLFlBQVcseUJBQXlCO0lBSS9ELE9BQU8sQ0FBQyxNQUFNO0lBSDFCLE9BQU8sQ0FBQyxTQUFTLENBQVM7SUFDMUIsT0FBTyxDQUFDLFdBQVcsQ0FBcUI7SUFFeEMsWUFBb0IsTUFBTSxFQUFFLHlCQUF5QixFQUVwRDtJQUVELE9BQU8sQ0FBQyxLQUFLO0lBT2IsT0FBTyxDQUFDLFlBQVk7SUFRYixpQkFBaUIsSUFBSSx5QkFBeUIsQ0FFcEQ7SUFHSyxJQUFJLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQU0xQjtJQUdELFlBQVksQ0FBQyxFQUFFLFNBQVMsWUFBWSxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUUsTUFBTSxFQUFFLGtCQUFrQixDQUFDLEVBQUUsQ0FBQyxFQUFFLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUVqRztJQUVELGFBQWEsQ0FBQyxNQUFNLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFaEQ7SUFDRCxXQUFXLENBQUMsVUFBVSxTQUFTLE1BQU0sRUFBRSx3QkFBd0IsU0FBUyxNQUFNLEVBQUUsRUFBRSxTQUFTLGFBQWEsRUFDdEcsTUFBTSxFQUFFLEVBQUUsRUFDVixNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQ2hCLGFBQWEsRUFBRSxNQUFNLEdBQ3BCLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxVQUFVLEVBQUUsd0JBQXdCLENBQUMsQ0FBQyxDQUVyRTtJQUNELGdCQUFnQixDQUFDLFVBQVUsU0FBUyxNQUFNLEVBQUUsRUFBRSxTQUFTLGFBQWEsRUFDbEUsTUFBTSxFQUFFLEVBQUUsRUFDVixNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQ2YsT0FBTyxDQUFDLHlCQUF5QixDQUFDLFVBQVUsQ0FBQyxDQUFDLENBRWhEO0lBQ0QsS0FBSyxJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFckI7SUFDRCxXQUFXLENBQUMsTUFBTSxFQUFFLFlBQVksR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBRW5EO0lBQ0QsaUJBQWlCLElBQUksT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUUzQztJQUNELGdCQUFnQixJQUFJLFdBQVcsQ0FFOUI7SUFDTSxXQUFXLElBQUksa0JBQWtCLEdBQUcsNEJBQTRCLENBRXRFO0lBQ0QsY0FBYyxDQUFDLEVBQUUsU0FBUyxZQUFZLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FFeEc7SUFDRCxxQkFBcUIsQ0FBQyxFQUFFLFNBQVMsYUFBYSxFQUM1QyxNQUFNLEVBQUUsRUFBRSxFQUNWLEtBQUssRUFBRSxNQUFNLEdBQ1osT0FBTyxDQUFDO1FBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQztRQUFDLGNBQWMsRUFBRSxPQUFPLENBQUE7S0FBRSxHQUFHLFNBQVMsQ0FBQyxDQUVqRTtJQUNELGVBQWUsQ0FBQyxFQUFFLFNBQVMsYUFBYSxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsdUJBQXVCLEdBQUcsU0FBUyxDQUFDLENBRWpIO0lBQ0QsZUFBZSxDQUFDLEVBQUUsU0FBUyxZQUFZLEVBQ3JDLE1BQU0sRUFBRSxFQUFFLEVBQ1YsTUFBTSxFQUFFLGtCQUFrQixDQUFDLEVBQUUsQ0FBQyxFQUFFLEdBQy9CLE9BQU8sQ0FBQyxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUMsRUFBRSxDQUFDLENBRWpDO0lBQ0Qsb0JBQW9CLENBQUMsRUFBRSxTQUFTLFlBQVksRUFDMUMsTUFBTSxFQUFFLEVBQUUsRUFDVixNQUFNLEVBQUUsa0JBQWtCLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFDaEMsVUFBVSxFQUFFLE1BQU0sR0FDakIsT0FBTyxDQUFDLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxFQUFFLENBQUMsQ0FFakM7SUFDRCxZQUFZLENBQUMsRUFBRSxTQUFTLFlBQVksRUFDbEMsTUFBTSxFQUFFLEVBQUUsRUFDVixLQUFLLEVBQUUsTUFBTSxHQUNaLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxPQUFPLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxDQUV4RDtJQUNELDZCQUE2QixDQUFDLEVBQUUsU0FBUyxZQUFZLEVBQ25ELE1BQU0sRUFBRSxFQUFFLEVBQ1YsV0FBVyxFQUFFLE1BQU0sRUFBRSxHQUNwQixPQUFPLENBQUMsQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLEVBQUUsQ0FBQyxDQUVqQztJQUNELGdCQUFnQixJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFaEM7SUFDRCxnQkFBZ0IsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBRWhDO0lBQ0QsZ0JBQWdCLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQUVoQztJQUNELG9CQUFvQixJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFcEM7SUFDRCxvQkFBb0IsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBRXBDO0lBQ0QsZ0JBQWdCLENBQUMsRUFBRSxTQUFTLFlBQVksRUFDdEMsTUFBTSxFQUFFLEVBQUUsRUFDVixNQUFNLEVBQUUsa0JBQWtCLENBQUMsRUFBRSxDQUFDLEVBQUUsR0FDL0IsT0FBTyxDQUFDLENBQUM7UUFBRSxJQUFJLEVBQUUsV0FBVyxDQUFDLFdBQVcsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQUMsS0FBSyxFQUFFLE1BQU0sQ0FBQTtLQUFFLEdBQUcsU0FBUyxDQUFDLEVBQUUsQ0FBQyxDQUVoRjtDQUNGIn0=

package/dest/public/public_processor/guarded_merkle_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guarded_merkle_tree.d.ts","sourceRoot":"","sources":["../../../src/public/public_processor/guarded_merkle_tree.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EACV,oBAAoB,EACpB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,yBAAyB,EACzB,yBAAyB,EACzB,WAAW,EACX,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AAElG;;;;;GAKG;AAEH,qBAAa,2BAA4B,YAAW,yBAAyB;IAI/D,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAqB;IAExC,YAAoB,MAAM,EAAE,yBAAyB,EAEpD;IAED,OAAO,CAAC,KAAK;IAOb,OAAO,CAAC,YAAY;IAQb,iBAAiB,IAAI,yBAAyB,CAEpD;IAGK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAM1B;IAGD,YAAY,CAAC,EAAE,SAAS,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;IAED,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhD;IACD,WAAW,CAAC,UAAU,SAAS,MAAM,EAAE,wBAAwB,SAAS,MAAM,EAAE,EAAE,SAAS,aAAa,EACtG,MAAM,EAAE,EAAE,EACV,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,oBAAoB,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC,CAErE;IACD,gBAAgB,CAAC,UAAU,SAAS,MAAM,EAAE,EAAE,SAAS,aAAa,EAClE,MAAM,EAAE,EAAE,EACV,MAAM,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAEhD;IACD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAErB;IACD,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAEnD;IACD,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC,CAE3C;IACD,gBAAgB,IAAI,WAAW,CAE9B;IACM,WAAW,IAAI,kBAAkB,GAAG,4BAA4B,CAEtE;IACD,cAAc,CAAC,EAAE,SAAS,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAExG;IACD,qBAAqB,CAAC,EAAE,SAAS,aAAa,EAC5C,MAAM,EAAE,EAAE,EACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC,CAEjE;IACD,eAAe,CAAC,EAAE,SAAS,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAEjH;IACD,eAAe,CAAC,EAAE,SAAS,YAAY,EACrC,MAAM,EAAE,EAAE,EACV,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAAE,GAC/B,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAEjC;IACD,oBAAoB,CAAC,EAAE,SAAS,YAAY,EAC1C,MAAM,EAAE,EAAE,EACV,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAChC,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAEjC;IACD,YAAY,CAAC,EAAE,SAAS,YAAY,EAClC,MAAM,EAAE,EAAE,EACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,CAAC,OAAO,MAAM,CAAC,GAAG,SAAS,CAAC,CAExD;IACD,6BAA6B,CAAC,EAAE,SAAS,YAAY,EACnD,MAAM,EAAE,EAAE,EACV,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAEjC;IACD,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEhC;IACD,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEhC;IACD,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEhC;IACD,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEpC;IACD,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEpC;IACD,gBAAgB,CAAC,EAAE,SAAS,YAAY,EACtC,MAAM,EAAE,EAAE,EACV,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAAE,GAC/B,OAAO,CAAC,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,EAAE,CAAC,CAEhF;CACF"}