feat(avm): include initial tree roots in DB (#11360)

We'll need the roots for the context and other stuff. I expect that `get_tree_roots()` will not lay constraints. I expect that the roots will be advanced via hints in, e.g, `emit_nullifier` (root before, root after).

barretenberg/cpp/src/barretenberg/vm2/common/avm_inputs.hpp

@@ -50,13 +50,25 @@ struct ContractClassHint {
     MSGPACK_FIELDS(artifactHash, privateFunctionsRoot, publicBytecodeCommitment, packedBytecode);
 };
 
+struct TreeRoots {
+    FF publicDataTree;
+    FF nullifierTree;
+    FF noteHashTree;
+    FF l1ToL2MessageTree;
+
+    bool operator==(const TreeRoots& other) const = default;
+
+    MSGPACK_FIELDS(publicDataTree, nullifierTree, noteHashTree, l1ToL2MessageTree);
+};
+
 struct ExecutionHints {
     std::vector<ContractInstanceHint> contractInstances;
     std::vector<ContractClassHint> contractClasses;
+    TreeRoots initialTreeRoots;
 
     bool operator==(const ExecutionHints& other) const = default;
 
-    MSGPACK_FIELDS(contractInstances, contractClasses);
+    MSGPACK_FIELDS(contractInstances, contractClasses, initialTreeRoots);
 };
 
 struct PublicExecutionRequest {

barretenberg/cpp/src/barretenberg/vm2/common/avm_inputs.test.cpp

@@ -106,6 +106,12 @@ TEST(AvmInputsTest, Deserialization)
                     .packedBytecode = string_to_buffer("secondbuffer"),
                 },
             },
+            .initialTreeRoots = {
+                .publicDataTree = FF(0x1),
+                .nullifierTree = FF(0x2),
+                .noteHashTree = FF(0x3),
+                .l1ToL2MessageTree = FF(0x4),
+            },
         },
     };
 
@@ -115,6 +121,7 @@ TEST(AvmInputsTest, Deserialization)
     EXPECT_EQ(inputs.publicInputs, expected.publicInputs);
     EXPECT_EQ(inputs.hints.contractClasses, expected.hints.contractClasses);
     EXPECT_EQ(inputs.hints.contractInstances, expected.hints.contractInstances);
+    EXPECT_EQ(inputs.hints.initialTreeRoots, expected.hints.initialTreeRoots);
     EXPECT_EQ(inputs, expected); // Catch all.
 }
 

barretenberg/cpp/src/barretenberg/vm2/simulation/bytecode_manager.cpp

@@ -35,7 +35,8 @@ BytecodeId TxBytecodeManager::get_bytecode(const AztecAddress& address)
         .address = address,
         .siloed_address = address, // FIXME: compute, check.
         .contract_instance = instance,
-        .contract_class = klass // WARNING: this class has the whole bytecode.
+        .contract_class = klass, // WARNING: this class has the whole bytecode.
+        .nullifier_root = db.get_tree_roots().nullifierTree,
     });
 
     return bytecode_id;

barretenberg/cpp/src/barretenberg/vm2/simulation/events/bytecode_events.hpp

@@ -27,6 +27,7 @@ struct BytecodeRetrievalEvent {
     AztecAddress siloed_address;
     ContractInstance contract_instance;
     ContractClass contract_class;
+    FF nullifier_root;
     bool error = false;
 };
 

barretenberg/cpp/src/barretenberg/vm2/simulation/lib/raw_data_db.cpp

@@ -8,6 +8,7 @@ namespace bb::avm2::simulation {
 HintedRawDataDB::HintedRawDataDB(const ExecutionHints& hints)
     : contract_instances(hints.contractInstances)
     , contract_classes(hints.contractClasses)
+    , tree_roots(hints.initialTreeRoots)
 {}
 
 ContractInstance HintedRawDataDB::get_contract_instance(const AztecAddress& address) const

barretenberg/cpp/src/barretenberg/vm2/simulation/lib/raw_data_db.hpp

@@ -12,6 +12,7 @@ class RawDataDBInterface {
 
     virtual ContractInstance get_contract_instance(const AztecAddress& address) const = 0;
     virtual ContractClass get_contract_class(const ContractClassId& class_id) const = 0;
+    virtual const TreeRoots& get_tree_roots() const = 0;
 };
 
 class HintedRawDataDB : public RawDataDBInterface {
@@ -20,10 +21,12 @@ class HintedRawDataDB : public RawDataDBInterface {
 
     ContractInstance get_contract_instance(const AztecAddress& address) const override;
     ContractClass get_contract_class(const ContractClassId& class_id) const override;
+    const TreeRoots& get_tree_roots() const override { return tree_roots; }
 
   private:
     std::vector<ContractInstanceHint> contract_instances;
     std::vector<ContractClassHint> contract_classes;
+    TreeRoots tree_roots;
     mutable size_t contract_instances_idx = 0;
     mutable size_t contract_classes_idx = 0;
 };

yarn-project/circuits.js/src/structs/avm/avm.test.ts

@@ -93,6 +93,12 @@ describe('Avm circuit inputs', () => {
           packedBytecode: Buffer.from('secondbuffer'),
         },
       ],
+      initialTreeRoots: {
+        publicDataTree: new Fr(1),
+        nullifierTree: new Fr(2),
+        noteHashTree: new Fr(3),
+        l1ToL2MessageTree: new Fr(4),
+      },
     };
 
     const enqueuedCalls = [
@@ -125,7 +131,7 @@ describe('Avm circuit inputs', () => {
 
     // Run with AZTEC_GENERATE_TEST_DATA=1 to update test data
     const path = 'barretenberg/cpp/src/barretenberg/vm2/common/avm_inputs.testdata.bin';
-    writeTestData(path, buffer);
+    writeTestData(path, buffer, /*raw=*/ true);
 
     const expected = readTestData(path);
     expect(buffer).toEqual(expected);

yarn-project/circuits.js/src/structs/avm/avm.ts

@@ -955,6 +955,12 @@ export class AvmCircuitInputs {
     const hints = {
       contractInstances: [] as any[],
       contractClasses: [] as any[],
+      initialTreeRoots: {
+        publicDataTree: this.output.startTreeSnapshots.publicDataTree.root,
+        nullifierTree: this.output.startTreeSnapshots.nullifierTree.root,
+        noteHashTree: this.output.startTreeSnapshots.noteHashTree.root,
+        l1ToL2MessageTree: this.output.startTreeSnapshots.l1ToL2MessageTree.root,
+      },
     };
     const inputs = {
       hints: hints,

yarn-project/foundation/src/testing/files/index.ts

@@ -6,12 +6,12 @@ import { fileURLToPath } from '../../url/index.js';
 import { isGenerateTestDataEnabled } from '../test_data.js';
 
 /** Writes the contents specified to the target file if test data generation is enabled. */
-export function writeTestData(targetFileFromRepoRoot: string, contents: string | Buffer) {
+export function writeTestData(targetFileFromRepoRoot: string, contents: string | Buffer, raw: boolean = false) {
   if (!isGenerateTestDataEnabled()) {
     return;
   }
   const targetFile = getPathToFile(targetFileFromRepoRoot);
-  const toWrite = typeof contents === 'string' ? contents : contents.toString('hex');
+  const toWrite = raw ? contents : typeof contents === 'string' ? contents : contents.toString('hex');
   writeFileSync(targetFile, toWrite);
   const logger = createConsoleLogger('aztec:testing:test_data');
   logger(`Wrote test data to ${targetFile}`);