starknet_committer,starknet_patricia: move node_serde to facts db

Author: ArielElp

crates/starknet_committer/src/block_committer/random_structs.rs

@@ -19,7 +19,7 @@ use starknet_patricia::patricia_merkle_tree::external_test_utils::{
     get_random_u256,
     u256_try_into_felt,
 };
-use starknet_patricia::patricia_merkle_tree::filled_tree::node::FactDbFilledNode;
+use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
 use starknet_patricia::patricia_merkle_tree::node_data::inner_node::{
     BinaryData,
     EdgeData,
@@ -34,6 +34,7 @@ use starknet_types_core::felt::Felt;
 use strum::IntoEnumIterator;
 
 use crate::block_committer::input::StarknetStorageValue;
+use crate::db::facts_db::db::FactDbFilledNode;
 use crate::forest::filled_forest::FilledForest;
 use crate::patricia_merkle_tree::leaf::leaf_impl::ContractState;
 use crate::patricia_merkle_tree::types::{
@@ -180,7 +181,10 @@ macro_rules! random_filled_node {
     ($leaf:ty) => {
         impl RandomValue for FactDbFilledNode<$leaf> {
             fn random<R: Rng>(rng: &mut R, max: Option<U256>) -> Self {
-                Self { data: NodeData::random(rng, max), hash: HashOutput::random(rng, max) }
+                Self(FilledNode {
+                    data: NodeData::random(rng, max),
+                    hash: HashOutput::random(rng, max),
+                })
             }
         }
     };
@@ -225,7 +229,7 @@ macro_rules! random_filled_tree {
                 nodes.push((NodeIndex::ROOT, FactDbFilledNode::random(rng, max_size)));
 
                 Self {
-                    tree_map: nodes.into_iter().collect(),
+                    tree_map: nodes.into_iter().map(|(index, node)| (index, node.0)).collect(),
                     root_hash: HashOutput(Felt::random(rng, max_size)),
                 }
             }

crates/starknet_committer/src/db/facts_db.rs

@@ -1,6 +1,7 @@
 pub mod create_facts_tree;
 pub mod db;
+pub mod node_serde;
 pub mod traversal;
 pub mod types;
 
-pub use db::{FactsDb, FactsNodeLayout};
+pub use db::{FactDbFilledNode, FactsDb, FactsNodeLayout};

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

@@ -4,8 +4,7 @@ use async_trait::async_trait;
 use starknet_api::core::ContractAddress;
 use starknet_api::hash::HashOutput;
 use starknet_patricia::db_layout::{NodeLayout, NodeLayoutFor};
-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::node::FilledNode;
 use starknet_patricia::patricia_merkle_tree::node_data::leaf::{Leaf, LeafModifications};
 use starknet_patricia::patricia_merkle_tree::types::NodeIndex;
 use starknet_patricia_storage::db_object::{DBObject, HasStaticPrefix};
@@ -15,6 +14,7 @@ use starknet_patricia_storage::storage_trait::{DbHashMap, DbKey, Storage};
 
 use crate::block_committer::input::{ReaderConfig, StarknetStorageValue};
 use crate::db::db_layout::DbLayout;
+use crate::db::facts_db::node_serde::FactNodeDeserializationContext;
 use crate::db::facts_db::types::{FactsDbInitialRead, FactsSubTree};
 use crate::db::forest_trait::{read_forest, serialize_forest, ForestReader, ForestWriter};
 use crate::forest::filled_forest::FilledForest;
@@ -23,6 +23,10 @@ use crate::forest::original_skeleton_forest::{ForestSortedIndices, OriginalSkele
 use crate::patricia_merkle_tree::leaf::leaf_impl::ContractState;
 use crate::patricia_merkle_tree::types::CompiledClassHash;
 
+/// DB representation of a trie node in facts layout.
+#[derive(PartialEq, Debug, derive_more::Into)]
+pub struct FactDbFilledNode<L: Leaf>(pub FilledNode<L, HashOutput>);
+
 /// Facts DB node layout.
 ///
 /// In a facts DB, the storage keys are node hashes and the values are preimages. In particular,
@@ -44,12 +48,13 @@ impl<'a, L: Leaf> NodeLayout<'a, L> for FactsNodeLayout {
         key_context: &<L as HasStaticPrefix>::KeyContext,
         filled_node: FilledNode<LeafBase, HashOutput>,
     ) -> (DbKey, Self::NodeDbObject) {
-        let db_filled_node = Self::convert_node_data_and_leaf(filled_node);
+        let hash_filled_node = Self::convert_node_data_and_leaf(filled_node);
 
-        let suffix = &db_filled_node.hash.0.to_bytes_be();
-        let key = db_filled_node.get_db_key(key_context, suffix);
+        let suffix = &hash_filled_node.hash.0.to_bytes_be();
+        let db_node = FactDbFilledNode(hash_filled_node);
+        let key = db_node.get_db_key(key_context, suffix);
 
-        (key, db_filled_node)
+        (key, db_node)
     }
 }
 

…ia_merkle_tree/filled_tree/node_serde.rs …_committer/src/db/facts_db/node_serde.rscrates/starknet_patricia/src/patricia_merkle_tree/filled_tree/node_serde.rs renamed to crates/starknet_committer/src/db/facts_db/node_serde.rs crates/starknet_patricia/src/patricia_merkle_tree/filled_tree/node_serde.rs renamed to crates/starknet_committer/src/db/facts_db/node_serde.rs

@@ -1,5 +1,14 @@
 use ethnum::U256;
 use starknet_api::hash::HashOutput;
+use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
+use starknet_patricia::patricia_merkle_tree::node_data::inner_node::{
+    BinaryData,
+    EdgeData,
+    EdgePathLength,
+    NodeData,
+    PathToBottom,
+};
+use starknet_patricia::patricia_merkle_tree::node_data::leaf::Leaf;
 use starknet_patricia_storage::db_object::{
     DBObject,
     EmptyDeserializationContext,
@@ -10,15 +19,7 @@ use starknet_patricia_storage::errors::{DeserializationError, SerializationResul
 use starknet_patricia_storage::storage_trait::{create_db_key, DbKey, DbKeyPrefix, DbValue};
 use starknet_types_core::felt::Felt;
 
-use crate::patricia_merkle_tree::filled_tree::node::{FactDbFilledNode, FilledNode};
-use crate::patricia_merkle_tree::node_data::inner_node::{
-    BinaryData,
-    EdgeData,
-    EdgePathLength,
-    NodeData,
-    PathToBottom,
-};
-use crate::patricia_merkle_tree::node_data::leaf::Leaf;
+use crate::db::facts_db::db::FactDbFilledNode;
 
 // Const describe the size of the serialized node.
 pub const SERIALIZE_HASH_BYTES: usize = 32;
@@ -44,12 +45,12 @@ impl From<PatriciaPrefix> for DbKeyPrefix {
     }
 }
 
-impl<L: Leaf> HasDynamicPrefix for FilledNode<L, HashOutput> {
+impl<L: Leaf> HasDynamicPrefix for FactDbFilledNode<L> {
     // Inherit the KeyContext from the HasStaticPrefix implementation of the leaf.
     type KeyContext = <L as HasStaticPrefix>::KeyContext;
 
     fn get_prefix(&self, key_context: &Self::KeyContext) -> DbKeyPrefix {
-        match &self.data {
+        match &self.0.data {
             NodeData::Binary(_) | NodeData::Edge(_) => PatriciaPrefix::InnerNode,
             NodeData::Leaf(_) => PatriciaPrefix::Leaf(L::get_static_prefix(key_context)),
         }
@@ -71,7 +72,7 @@ impl<L: Leaf> DBObject for FactDbFilledNode<L> {
     /// - For edge nodes: Concatenates bottom hash, path, and path length.
     /// - For leaf nodes: use leaf.serialize() method.
     fn serialize(&self) -> SerializationResult<DbValue> {
-        match &self.data {
+        match &self.0.data {
             NodeData::Binary(BinaryData { left_data: left_hash, right_data: right_hash }) => {
                 // Serialize left and right hashes to byte arrays.
                 let left: [u8; SERIALIZE_HASH_BYTES] = left_hash.0.to_bytes_be();
@@ -103,14 +104,14 @@ impl<L: Leaf> DBObject for FactDbFilledNode<L> {
         deserialize_context: &Self::DeserializeContext,
     ) -> Result<Self, DeserializationError> {
         if deserialize_context.is_leaf {
-            return Ok(Self {
+            return Ok(Self(FilledNode {
                 hash: deserialize_context.node_hash,
                 data: NodeData::Leaf(L::deserialize(value, &EmptyDeserializationContext)?),
-            });
+            }));
         }
 
         if value.0.len() == BINARY_BYTES {
-            Ok(Self {
+            Ok(Self(FilledNode {
                 hash: deserialize_context.node_hash,
                 data: NodeData::Binary(BinaryData {
                     left_data: HashOutput(Felt::from_bytes_be_slice(
@@ -120,7 +121,7 @@ impl<L: Leaf> DBObject for FactDbFilledNode<L> {
                         &value.0[SERIALIZE_HASH_BYTES..],
                     )),
                 }),
-            })
+            }))
         } else {
             assert_eq!(
                 value.0.len(),
@@ -130,7 +131,7 @@ impl<L: Leaf> DBObject for FactDbFilledNode<L> {
                 EDGE_BYTES,
                 BINARY_BYTES
             );
-            Ok(Self {
+            Ok(Self(FilledNode {
                 hash: deserialize_context.node_hash,
                 data: NodeData::Edge(EdgeData {
                     bottom_data: HashOutput(Felt::from_bytes_be_slice(
@@ -148,7 +149,7 @@ impl<L: Leaf> DBObject for FactDbFilledNode<L> {
                     )
                     .map_err(|error| DeserializationError::ValueError(Box::new(error)))?,
                 }),
-            })
+            }))
         }
     }
 

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

@@ -1,15 +1,12 @@
 use starknet_api::hash::{HashOutput, StateRoots};
-use starknet_patricia::patricia_merkle_tree::filled_tree::node_serde::{
-    FactNodeDeserializationContext,
-    PatriciaPrefix,
-};
 use starknet_patricia::patricia_merkle_tree::node_data::leaf::Leaf;
 use starknet_patricia::patricia_merkle_tree::traversal::{SubTreeTrait, UnmodifiedChildTraversal};
 use starknet_patricia::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
 use starknet_patricia_storage::db_object::HasStaticPrefix;
 use starknet_patricia_storage::storage_trait::{create_db_key, DbKey, DbKeyPrefix};
 
 use crate::block_committer::input::InputContext;
+use crate::db::facts_db::node_serde::{FactNodeDeserializationContext, PatriciaPrefix};
 
 #[derive(Debug, PartialEq)]
 pub struct FactsSubTree<'a> {

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

@@ -1,11 +1,7 @@
 use async_recursion::async_recursion;
 use starknet_api::core::ContractAddress;
 use starknet_api::hash::{HashOutput, StateRoots};
-use starknet_patricia::patricia_merkle_tree::filled_tree::node::{FactDbFilledNode, FilledNode};
-use starknet_patricia::patricia_merkle_tree::filled_tree::node_serde::{
-    FactNodeDeserializationContext,
-    PatriciaPrefix,
-};
+use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
 use starknet_patricia::patricia_merkle_tree::node_data::inner_node::{
     BinaryData,
     EdgeData,
@@ -25,6 +21,8 @@ use starknet_patricia_storage::storage_trait::{
 };
 
 use crate::block_committer::input::{try_node_index_into_contract_address, StarknetStorageValue};
+use crate::db::facts_db::db::FactDbFilledNode;
+use crate::db::facts_db::node_serde::{FactNodeDeserializationContext, PatriciaPrefix};
 use crate::db::index_db::leaves::{
     IndexLayoutCompiledClassHash,
     IndexLayoutContractState,
@@ -222,7 +220,7 @@ async fn traverse_and_convert<FactsLeaf, IndexLeaf, KeyContext>(
     )
     .unwrap();
 
-    let index_filled_node: IndexFilledNode<IndexLeaf> = match facts_filled_node.data {
+    let index_filled_node: IndexFilledNode<IndexLeaf> = match facts_filled_node.0.data {
         NodeData::Binary(binary_data) => {
             let children_indices = current_index.get_children_indices();
             traverse_and_convert::<FactsLeaf, IndexLeaf, KeyContext>(

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

@@ -1,7 +1,6 @@
 use ethnum::U256;
 use starknet_api::hash::HashOutput;
 use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
-use starknet_patricia::patricia_merkle_tree::filled_tree::node_serde::SERIALIZE_HASH_BYTES;
 use starknet_patricia::patricia_merkle_tree::node_data::inner_node::{
     BinaryData,
     EdgeData,
@@ -23,6 +22,7 @@ use starknet_patricia_storage::errors::{DeserializationError, SerializationResul
 use starknet_patricia_storage::storage_trait::{create_db_key, DbKey, DbKeyPrefix, DbValue};
 use starknet_types_core::felt::Felt;
 
+use crate::db::facts_db::node_serde::SERIALIZE_HASH_BYTES;
 use crate::hash_function::hash::TreeHashFunctionImpl;
 
 // In index layout, for binary nodes, only the hash is stored.