starknet_committer,starknet_patricia: add serialization utilities to node layout

Author: ArielElp

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

@@ -4,9 +4,10 @@ use async_trait::async_trait;
 use starknet_api::core::ContractAddress;
 use starknet_api::hash::HashOutput;
 use starknet_patricia::db_layout::{NodeLayout, TrieType};
-use starknet_patricia::patricia_merkle_tree::filled_tree::node::FactDbFilledNode;
+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::{
     LeafModifications,
     LeafWithEmptyKeyContext,
@@ -46,6 +47,17 @@ impl<'a, L: LeafWithEmptyKeyContext> NodeLayout<'a, L> for FactsNodeLayout {
     fn generate_key_context(_trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext {
         EmptyKeyContext
     }
+
+    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

@@ -2,8 +2,15 @@ use std::collections::HashMap;
 
 use async_trait::async_trait;
 use starknet_api::core::ContractAddress;
+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;
 use starknet_patricia::patricia_merkle_tree::updated_skeleton_tree::hash_function::TreeHashFunction;
@@ -58,6 +65,17 @@ where
     fn generate_key_context(trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext {
         trie_type
     }
+
+    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
@@ -133,3 +151,18 @@ impl<S: Storage> ForestWriter for IndexDb<S> {
         n_updates
     }
 }
+
+fn dump_child_hashes<L: Leaf>(data: NodeData<L, HashOutput>) -> NodeData<L, EmptyNodeData> {
+    match data {
+        NodeData::Leaf(leaf) => NodeData::Leaf(leaf),
+
+        NodeData::Binary(_) => {
+            NodeData::Binary(BinaryData { left_data: EmptyNodeData, right_data: EmptyNodeData })
+        }
+
+        NodeData::Edge(edge_data) => NodeData::Edge(EdgeData {
+            bottom_data: EmptyNodeData,
+            path_to_bottom: edge_data.path_to_bottom,
+        }),
+    }
+}

crates/starknet_patricia/src/db_layout.rs

@@ -3,8 +3,10 @@ use starknet_api::hash::HashOutput;
 use starknet_patricia_storage::db_object::{DBObject, HasStaticPrefix};
 
 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;
 
 // TODO(Ariel): Delete this enum and use `CommitmentType` instead.
 #[derive(Debug, PartialEq)]
@@ -24,8 +26,10 @@ pub trait NodeLayout<'a, L: Leaf> {
     type DeserializationContext;
 
     /// The storage representation of the node.
-    type NodeDbObject: DBObject<DeserializeContext = Self::DeserializationContext>
-        + Into<FilledNode<L, Self::NodeData>>;
+    type NodeDbObject: DBObject<
+            DeserializeContext = Self::DeserializationContext,
+            KeyContext = <L as HasStaticPrefix>::KeyContext,
+        > + Into<FilledNode<L, Self::NodeData>>;
 
     /// The type of the subtree that is used to traverse the trie.
     type SubTree: SubTreeTrait<
@@ -37,4 +41,16 @@ pub trait NodeLayout<'a, L: Leaf> {
     /// Generates the key context for the given trie type. Used for reading nodes of a specific
     /// tree (contracts, classes, or storage), to construct a skeleton tree.
     fn generate_key_context(trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext;
+
+    /// 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>;
 }