starknet_committer,starknet_patricia: move db_layout

Author: ArielElp

crates/starknet_committer/src/db.rs

@@ -1,4 +1,3 @@
-mod db_layout;
 #[cfg(any(feature = "testing", test))]
 pub mod external_test_utils;
 pub mod facts_db;

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

@@ -3,6 +3,7 @@ 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::FactDbFilledNode;
 use starknet_patricia::patricia_merkle_tree::filled_tree::node_serde::FactNodeDeserializationContext;
 use starknet_patricia::patricia_merkle_tree::filled_tree::tree::FilledTree;
@@ -14,10 +15,8 @@ use starknet_patricia_storage::map_storage::MapStorage;
 use starknet_patricia_storage::storage_trait::{DbHashMap, Storage};
 
 use crate::block_committer::input::{ReaderConfig, StarknetStorageValue};
-use crate::db::db_layout::NodeLayout;
 use crate::db::facts_db::types::{FactsDbInitialRead, FactsSubTree};
 use crate::db::forest_trait::{ForestReader, ForestWriter};
-use crate::db::index_db::leaves::TrieType;
 use crate::db::trie_traversal::{create_classes_trie, create_contracts_trie, create_storage_tries};
 use crate::forest::filled_forest::FilledForest;
 use crate::forest::forest_errors::ForestResult;

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

@@ -2,27 +2,29 @@ use std::collections::HashMap;
 
 use async_trait::async_trait;
 use starknet_api::core::ContractAddress;
-use starknet_api::hash::HashOutput;
-use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
+use starknet_patricia::db_layout::{NodeLayout, TrieType};
 use starknet_patricia::patricia_merkle_tree::filled_tree::tree::FilledTree;
 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::types::NodeIndex;
 use starknet_patricia::patricia_merkle_tree::updated_skeleton_tree::hash_function::TreeHashFunction;
 use starknet_patricia_storage::db_object::{EmptyKeyContext, HasStaticPrefix};
 use starknet_patricia_storage::errors::SerializationResult;
 use starknet_patricia_storage::storage_trait::{DbHashMap, Storage};
 
 use crate::block_committer::input::{ReaderConfig, StarknetStorageValue};
-use crate::db::db_layout::NodeLayout;
 use crate::db::facts_db::types::FactsDbInitialRead;
 use crate::db::forest_trait::{ForestReader, ForestWriter};
 use crate::db::index_db::leaves::{
     IndexLayoutCompiledClassHash,
     IndexLayoutContractState,
     IndexLayoutStarknetStorageValue,
-    TrieType,
 };
-use crate::db::index_db::types::{IndexFilledNode, IndexLayoutSubTree, IndexNodeContext};
+use crate::db::index_db::types::{
+    EmptyNodeData,
+    IndexFilledNode,
+    IndexLayoutSubTree,
+    IndexNodeContext,
+};
 use crate::db::trie_traversal::{create_classes_trie, create_contracts_trie, create_storage_tries};
 use crate::forest::filled_forest::FilledForest;
 use crate::forest::forest_errors::ForestResult;
@@ -48,18 +50,14 @@ where
     L: HasStaticPrefix<KeyContext = TrieType>,
     TreeHashFunctionImpl: TreeHashFunction<L>,
 {
-    type NodeData = ();
+    type NodeData = EmptyNodeData;
     type NodeDbObject = IndexFilledNode<L>;
     type DeserializationContext = IndexNodeContext;
     type SubTree = IndexLayoutSubTree<'a>;
 
     fn generate_key_context(trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext {
         trie_type
     }
-
-    fn get_filled_node(node_db_object: Self::NodeDbObject) -> FilledNode<L, Self::NodeData> {
-        node_db_object.0
-    }
 }
 
 // TODO(Ariel): define an IndexDbInitialRead empty type, and check whether each tree is empty inside

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

@@ -1,7 +1,8 @@
 use std::sync::LazyLock;
 
-use starknet_api::core::{ClassHash, ContractAddress, Nonce, PATRICIA_KEY_UPPER_BOUND};
+use starknet_api::core::{ClassHash, Nonce, PATRICIA_KEY_UPPER_BOUND};
 use starknet_api::hash::HashOutput;
+use starknet_patricia::db_layout::TrieType;
 use starknet_patricia::patricia_merkle_tree::node_data::errors::LeafResult;
 use starknet_patricia::patricia_merkle_tree::node_data::leaf::Leaf;
 use starknet_patricia_storage::db_object::{
@@ -16,7 +17,6 @@ use starknet_types_core::felt::Felt;
 use crate::block_committer::input::StarknetStorageValue;
 use crate::patricia_merkle_tree::leaf::leaf_impl::ContractState;
 use crate::patricia_merkle_tree::types::CompiledClassHash;
-
 // Wrap the leaves types so that we can implement the [DBObject] trait differently in index
 // layout.
 #[derive(
@@ -46,23 +46,13 @@ static CONTRACTS_TREE_PREFIX: LazyLock<[u8; 32]> =
 static CLASSES_TREE_PREFIX: LazyLock<[u8; 32]> =
     LazyLock::new(|| (*FIRST_AVAILABLE_PREFIX_FELT + Felt::ONE).to_bytes_be());
 
-// TODO(Ariel): Delete this enum and use `CommitmentType` instead.
-#[derive(Debug, PartialEq)]
-pub enum TrieType {
-    ContractsTrie,
-    ClassesTrie,
-    StorageTrie(ContractAddress),
-}
-
-impl TrieType {
-    fn db_prefix(&self) -> DbKeyPrefix {
-        match self {
-            Self::ContractsTrie => DbKeyPrefix::new((&CONTRACTS_TREE_PREFIX[..]).into()),
-            Self::ClassesTrie => DbKeyPrefix::new((&CLASSES_TREE_PREFIX[..]).into()),
-            Self::StorageTrie(contract_address) => {
-                let prefix = contract_address.to_bytes_be().to_vec();
-                DbKeyPrefix::new(prefix.into())
-            }
+fn db_prefix(trie_type: &TrieType) -> DbKeyPrefix {
+    match trie_type {
+        TrieType::ContractsTrie => DbKeyPrefix::new((&CONTRACTS_TREE_PREFIX[..]).into()),
+        TrieType::ClassesTrie => DbKeyPrefix::new((&CLASSES_TREE_PREFIX[..]).into()),
+        TrieType::StorageTrie(contract_address) => {
+            let prefix = contract_address.to_bytes_be().to_vec();
+            DbKeyPrefix::new(prefix.into())
         }
     }
 }
@@ -73,7 +63,7 @@ macro_rules! impl_has_static_prefix_for_index_layouts {
             impl HasStaticPrefix for $ty {
                 type KeyContext = TrieType;
                 fn get_static_prefix(key_context: &Self::KeyContext) -> DbKeyPrefix {
-                    key_context.db_prefix()
+                    db_prefix(key_context)
                 }
             }
         )*

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

@@ -37,7 +37,7 @@ impl From<HashOutput> for EmptyNodeData {
     }
 }
 
-#[derive(PartialEq, Debug)]
+#[derive(PartialEq, Debug, derive_more::Into)]
 pub struct IndexFilledNode<L: Leaf>(pub FilledNode<L, EmptyNodeData>);
 
 pub struct IndexNodeContext {
@@ -148,7 +148,7 @@ pub struct IndexLayoutSubTree<'a> {
 }
 
 impl<'a> SubTreeTrait<'a> for IndexLayoutSubTree<'a> {
-    type NodeData = ();
+    type NodeData = EmptyNodeData;
     type NodeDeserializeContext = IndexNodeContext;
 
     fn create(

crates/starknet_committer/src/db/trie_traversal.rs

@@ -4,6 +4,7 @@ use std::fmt::Debug;
 
 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::node_data::inner_node::{
     BinaryData,
@@ -33,8 +34,6 @@ use crate::block_committer::input::{
     ReaderConfig,
     StarknetStorageValue,
 };
-use crate::db::db_layout::NodeLayout;
-use crate::db::index_db::leaves::TrieType;
 use crate::forest::forest_errors::{ForestError, ForestResult};
 use crate::patricia_merkle_tree::leaf::leaf_impl::ContractState;
 use crate::patricia_merkle_tree::tree::OriginalSkeletonTrieConfig;

…s/starknet_committer/src/db/db_layout.rs crates/starknet_patricia/src/db_layout.rscrates/starknet_committer/src/db/db_layout.rs renamed to crates/starknet_patricia/src/db_layout.rs crates/starknet_committer/src/db/db_layout.rs renamed to crates/starknet_patricia/src/db_layout.rs

@@ -1,10 +1,18 @@
+use starknet_api::core::ContractAddress;
 use starknet_api::hash::HashOutput;
-use starknet_patricia::patricia_merkle_tree::filled_tree::node::FilledNode;
-use starknet_patricia::patricia_merkle_tree::node_data::leaf::Leaf;
-use starknet_patricia::patricia_merkle_tree::traversal::SubTreeTrait;
 use starknet_patricia_storage::db_object::{DBObject, HasStaticPrefix};
 
-use crate::db::index_db::leaves::TrieType;
+use crate::patricia_merkle_tree::filled_tree::node::FilledNode;
+use crate::patricia_merkle_tree::node_data::leaf::Leaf;
+use crate::patricia_merkle_tree::traversal::SubTreeTrait;
+
+// TODO(Ariel): Delete this enum and use `CommitmentType` instead.
+#[derive(Debug, PartialEq)]
+pub enum TrieType {
+    ContractsTrie,
+    ClassesTrie,
+    StorageTrie(ContractAddress),
+}
 
 /// Specifies the trie db layout.
 pub trait NodeLayout<'a, L: Leaf> {

crates/starknet_patricia/src/lib.rs

@@ -1,2 +1,3 @@
+pub mod db_layout;
 pub mod felt;
 pub mod patricia_merkle_tree;