starknet_committer,starknet_patricia: add serialization utilities to node layout

Author: ArielElp

crates/starknet_committer/src/db/facts_db/db.rs

@@ -7,6 +7,7 @@ use starknet_patricia::db_layout::{NodeLayout, TrieType};
 use starknet_patricia::patricia_merkle_tree::filled_tree::node::{FactDbFilledNode, FilledNode};
 use starknet_patricia::patricia_merkle_tree::filled_tree::node_serde::FactNodeDeserializationContext;
 use starknet_patricia::patricia_merkle_tree::filled_tree::tree::FilledTree;
+use starknet_patricia::patricia_merkle_tree::node_data::inner_node::NodeData;
 use starknet_patricia::patricia_merkle_tree::node_data::leaf::{Leaf, LeafModifications};
 use starknet_patricia::patricia_merkle_tree::traversal::SubTreeTrait;
 use starknet_patricia::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
@@ -65,6 +66,17 @@ where
     fn get_filled_node(node_db_object: Self::NodeDbObject) -> FilledNode<L, Self::NodeData> {
         node_db_object
     }
+
+    fn get_db_object(
+        hash: HashOutput,
+        filled_node_data: NodeData<L, HashOutput>,
+    ) -> Self::NodeDbObject {
+        FilledNode { hash, data: filled_node_data }
+    }
+
+    fn get_node_suffix(_index: NodeIndex, node_db_object: &Self::NodeDbObject) -> Vec<u8> {
+        node_db_object.hash.0.to_bytes_be().to_vec()
+    }
 }
 
 pub struct FactsDb<S: Storage> {

crates/starknet_committer/src/db/index_db/db.rs

@@ -6,10 +6,15 @@ use starknet_api::hash::HashOutput;
 use starknet_patricia::db_layout::{NodeLayout, TrieType};
 use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
 use starknet_patricia::patricia_merkle_tree::filled_tree::tree::FilledTree;
+use starknet_patricia::patricia_merkle_tree::node_data::inner_node::{
+    BinaryData,
+    EdgeData,
+    NodeData,
+};
 use starknet_patricia::patricia_merkle_tree::node_data::leaf::{Leaf, LeafModifications};
 use starknet_patricia::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
 use starknet_patricia::patricia_merkle_tree::updated_skeleton_tree::hash_function::TreeHashFunction;
-use starknet_patricia_storage::db_object::{EmptyKeyContext, HasStaticPrefix};
+use starknet_patricia_storage::db_object::HasStaticPrefix;
 use starknet_patricia_storage::errors::SerializationResult;
 use starknet_patricia_storage::storage_trait::{DbHashMap, DbKey, Storage};
 
@@ -66,6 +71,17 @@ where
     fn get_filled_node(node_db_object: Self::NodeDbObject) -> FilledNode<L, Self::NodeData> {
         node_db_object.0
     }
+
+    fn get_db_object(
+        hash: HashOutput,
+        filled_node_data: NodeData<L, HashOutput>,
+    ) -> Self::NodeDbObject {
+        IndexFilledNode(FilledNode { hash, data: dump_child_hashes(filled_node_data) })
+    }
+
+    fn get_node_suffix(index: NodeIndex, _node_db_object: &Self::NodeDbObject) -> Vec<u8> {
+        index.0.to_be_bytes().to_vec()
+    }
 }
 
 // TODO(Ariel): define an IndexDbInitialRead empty type, and check whether each tree is empty inside
@@ -151,3 +167,15 @@ impl<S: Storage> ForestMetadata for IndexDb<S> {
         DbKey(vec![0])
     }
 }
+
+fn dump_child_hashes<L: Leaf>(data: NodeData<L, HashOutput>) -> NodeData<L, ()> {
+    match data {
+        NodeData::Leaf(leaf) => NodeData::Leaf(leaf),
+
+        NodeData::Binary(_) => NodeData::Binary(BinaryData { left_data: (), right_data: () }),
+
+        NodeData::Edge(edge_data) => {
+            NodeData::Edge(EdgeData { bottom_data: (), path_to_bottom: edge_data.path_to_bottom })
+        }
+    }
+}

crates/starknet_patricia/src/db_layout.rs

@@ -4,6 +4,7 @@ use starknet_patricia_storage::db_object::{DBObject, HasStaticPrefix};
 use starknet_patricia_storage::storage_trait::DbKeyPrefix;
 
 use crate::patricia_merkle_tree::filled_tree::node::FilledNode;
+use crate::patricia_merkle_tree::node_data::inner_node::NodeData;
 use crate::patricia_merkle_tree::node_data::leaf::Leaf;
 use crate::patricia_merkle_tree::traversal::SubTreeTrait;
 use crate::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
@@ -35,7 +36,10 @@ pub trait NodeLayout<'a, L: Leaf> {
     type NodeData: Clone;
 
     /// The storage representation of the node.
-    type NodeDbObject: DBObject<DeserializeContext = Self::DeserializationContext>;
+    type NodeDbObject: DBObject<
+            DeserializeContext = Self::DeserializationContext,
+            KeyContext = <L as HasStaticPrefix>::KeyContext,
+        >;
 
     /// The context needed to deserialize the node from a raw
     /// [starknet_patricia_storage::storage_trait::DbValue].
@@ -57,4 +61,16 @@ pub trait NodeLayout<'a, L: Leaf> {
     fn generate_key_context(trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext;
 
     fn get_filled_node(node_db_object: Self::NodeDbObject) -> FilledNode<L, Self::NodeData>;
+
+    /// Converts `FilledTree` nodes to db objects.
+    ///
+    /// During the construction of a `FilledTree` we computee the hashes and carry `FilledNode<L,
+    /// HashOutput>`, hence, the `FilledNode` type  is not necessarily what we want to store.
+    fn get_db_object(
+        hash: HashOutput,
+        filled_node_data: NodeData<L, HashOutput>,
+    ) -> Self::NodeDbObject;
+
+    /// Returns the db key suffix of the node db object.
+    fn get_node_suffix(index: NodeIndex, node_db_object: &Self::NodeDbObject) -> Vec<u8>;
 }