Skip to content

starknet_committer: abstract original tree creation #10684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArielElp wants to merge 1 commit into
base: ariel/clean_skeleton_tree_configs
Choose a base branch
from
Open

starknet_committer: abstract original tree creation #10684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/starknet_committer/src/db.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ pub mod external_test_utils;
pub mod facts_db;
pub mod forest_trait;
pub mod index_db;
pub mod trie_traversal;
15 changes: 14 additions & 1 deletion crates/starknet_committer/src/db/db_layout.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
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::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
use starknet_patricia_storage::db_object::HasStaticPrefix;
use starknet_patricia_storage::errors::DeserializationError;
use starknet_patricia_storage::storage_trait::DbValue;

pub trait NodeLayout<L: Leaf> {
use crate::db::index_db::leaves::TrieType;

pub trait NodeLayout<'a, L: Leaf> {
type ChildData: Copy;
type DeserializationContext;
type SubTree: SubTreeTrait<'a, NodeData = Self::ChildData, NodeContext = Self::DeserializationContext>;
fn deserialize_node(
value: &DbValue,
deserialize_context: &Self::DeserializationContext,
) -> Result<FilledNode<L, Self::ChildData>, DeserializationError>;
fn create_subtree(
sorted_leaf_indices: SortedLeafIndices<'a>,
root_index: NodeIndex,
root_hash: HashOutput,
) -> Self::SubTree;
fn generate_key_context(trie_type: TrieType) -> <L as HasStaticPrefix>::KeyContext;
}
5 changes: 3 additions & 2 deletions crates/starknet_committer/src/db/external_test_utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ use starknet_patricia::patricia_merkle_tree::updated_skeleton_tree::tree::{
use starknet_patricia_storage::db_object::{EmptyKeyContext, HasStaticPrefix};
use starknet_patricia_storage::map_storage::MapStorage;

use crate::db::facts_db::create_facts_tree::create_original_skeleton_tree;
use crate::db::facts_db::db::FactsNodeLayout;
use crate::db::trie_traversal::create_original_skeleton_tree;

pub async fn tree_computation_flow<L, TH>(
leaf_modifications: LeafModifications<L>,
Expand All @@ -32,7 +33,7 @@ where
{
let mut sorted_leaf_indices: Vec<NodeIndex> = leaf_modifications.keys().copied().collect();
let sorted_leaf_indices = SortedLeafIndices::new(&mut sorted_leaf_indices);
let mut original_skeleton = create_original_skeleton_tree(
let mut original_skeleton = create_original_skeleton_tree::<L, FactsNodeLayout>(
storage,
root_hash,
sorted_leaf_indices,
Expand Down
271 changes: 11 additions & 260 deletions crates/starknet_committer/src/db/facts_db/create_facts_tree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,17 @@
use std::borrow::Borrow;
use std::collections::HashMap;
use std::fmt::Debug;

use starknet_api::hash::HashOutput;
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::original_skeleton_tree::config::{
NoCompareOriginalSkeletonTrieConfig,
OriginalSkeletonTreeConfig,
};
use starknet_patricia::patricia_merkle_tree::original_skeleton_tree::node::OriginalSkeletonNode;
use starknet_patricia::patricia_merkle_tree::original_skeleton_tree::config::OriginalSkeletonTreeConfig;
use starknet_patricia::patricia_merkle_tree::original_skeleton_tree::tree::{
OriginalSkeletonTreeImpl,
OriginalSkeletonTreeResult,
};
use starknet_patricia::patricia_merkle_tree::traversal::SubTreeTrait;
use starknet_patricia::patricia_merkle_tree::types::{NodeIndex, SortedLeafIndices};
use starknet_patricia_storage::db_object::HasStaticPrefix;
use starknet_patricia_storage::db_object::{EmptyKeyContext, HasStaticPrefix};
use starknet_patricia_storage::storage_trait::Storage;
use tracing::warn;

use crate::db::db_layout::NodeLayout;
use crate::db::facts_db::db::FactsNodeLayout;
use crate::db::facts_db::traversal::get_roots_from_storage;
use crate::db::facts_db::types::FactsSubTree;
use crate::db::trie_traversal::fetch_nodes;
use crate::patricia_merkle_tree::tree::OriginalSkeletonTrieDontCompareConfig;
Expand All @@ -35,188 +20,15 @@ use crate::patricia_merkle_tree::tree::OriginalSkeletonTrieDontCompareConfig;
#[path = "create_facts_tree_test.rs"]
pub mod create_facts_tree_test;

/// Logs out a warning of a trivial modification.
macro_rules! log_trivial_modification {
($index:expr, $value:expr) => {
warn!("Encountered a trivial modification at index {:?}, with value {:?}", $index, $value);
};
}

/// Fetches the Patricia witnesses, required to build the original skeleton tree from storage.
/// Given a list of subtrees, traverses towards their leaves and fetches all non-empty,
/// unmodified nodes. If `compare_modified_leaves` is set, function logs out a warning when
/// encountering a trivial modification. Fills the previous leaf values if it is not none.
async fn fetch_nodes<'a, L, Layout, SubTree>(
skeleton_tree: &mut OriginalSkeletonTreeImpl<'a>,
subtrees: Vec<SubTree>,
storage: &mut impl Storage,
leaf_modifications: &LeafModifications<L>,
config: &impl OriginalSkeletonTreeConfig<L>,
mut previous_leaves: Option<&mut HashMap<NodeIndex, L>>,
key_context: &<L as HasStaticPrefix>::KeyContext,
) -> OriginalSkeletonTreeResult<()>
where
L: Leaf,
Layout: NodeLayout<L>,
SubTree: SubTreeTrait<'a, NodeData = Layout::ChildData, NodeContext = Layout::DeserializationContext>,
{
let mut current_subtrees = subtrees;
let mut next_subtrees = Vec::new();
while !current_subtrees.is_empty() {
let should_fetch_modified_leaves =
config.compare_modified_leaves() || previous_leaves.is_some();
let filled_roots =
get_roots_from_storage::<L, Layout>(&current_subtrees, storage, key_context).await?;
for (filled_root, subtree) in filled_roots.into_iter().zip(current_subtrees.iter()) {
match filled_root.data {
// Binary node.
NodeData::Binary(BinaryData { left_data, right_data }) => {
if subtree.is_unmodified() {
skeleton_tree.nodes.insert(
subtree.get_root_index(),
OriginalSkeletonNode::UnmodifiedSubTree(filled_root.hash),
);
continue;
}
skeleton_tree
.nodes
.insert(subtree.get_root_index(), OriginalSkeletonNode::Binary);
let (left_subtree, right_subtree) =
subtree.get_children_subtrees(left_data, right_data);

handle_subtree(
skeleton_tree,
&mut next_subtrees,
left_subtree,
left_data,
should_fetch_modified_leaves,
);
handle_subtree(
skeleton_tree,
&mut next_subtrees,
right_subtree,
right_data,
should_fetch_modified_leaves,
)
}
// Edge node.
NodeData::Edge(EdgeData { bottom_data, path_to_bottom }) => {
skeleton_tree.nodes.insert(
subtree.get_root_index(),
OriginalSkeletonNode::Edge(path_to_bottom),
);

// Parse bottom.
let (bottom_subtree, previously_empty_leaves_indices) =
subtree.get_bottom_subtree(&path_to_bottom, bottom_data);

if subtree.is_unmodified() {
if !SubTree::should_traverse_unmodified_children() {
skeleton_tree.nodes.insert(
path_to_bottom.bottom_index(subtree.get_root_index()),
OriginalSkeletonNode::UnmodifiedSubTree(
SubTree::unmodified_child_hash(bottom_data).unwrap(),
),
);
} else {
// With index layout we need to traverse an unmodified bottom node.
next_subtrees.push(bottom_subtree)
}
continue;
}

if let Some(ref mut leaves) = previous_leaves {
leaves.extend(
previously_empty_leaves_indices
.iter()
.map(|idx| (*idx, L::default()))
.collect::<HashMap<NodeIndex, L>>(),
);
}
log_warning_for_empty_leaves(
&previously_empty_leaves_indices,
leaf_modifications,
config,
)?;

handle_subtree(
skeleton_tree,
&mut next_subtrees,
bottom_subtree,
bottom_data,
should_fetch_modified_leaves,
);
}
// Leaf node.
NodeData::Leaf(previous_leaf) => {
if subtree.is_unmodified() {
skeleton_tree.nodes.insert(
subtree.get_root_index(),
OriginalSkeletonNode::UnmodifiedSubTree(filled_root.hash),
);
} else {
let root_index = subtree.get_root_index();
// Modified leaf.
if config.compare_modified_leaves()
&& L::compare(leaf_modifications, &root_index, &previous_leaf)?
{
log_trivial_modification!(root_index, previous_leaf);
}
// If previous values of modified leaves are requested, add this leaf.
if let Some(ref mut leaves) = previous_leaves {
leaves.insert(root_index, previous_leaf);
}
}
}
}
}
current_subtrees = next_subtrees;
next_subtrees = Vec::new();
}
Ok(())
}

pub async fn create_original_skeleton_tree<'a, L: Leaf>(
storage: &mut impl Storage,
root_hash: HashOutput,
sorted_leaf_indices: SortedLeafIndices<'a>,
config: &impl OriginalSkeletonTreeConfig<L>,
leaf_modifications: &LeafModifications<L>,
key_context: &<L as HasStaticPrefix>::KeyContext,
) -> OriginalSkeletonTreeResult<OriginalSkeletonTreeImpl<'a>> {
if sorted_leaf_indices.is_empty() {
return Ok(OriginalSkeletonTreeImpl::create_unmodified(root_hash));
}
if root_hash == HashOutput::ROOT_OF_EMPTY_TREE {
log_warning_for_empty_leaves(
sorted_leaf_indices.get_indices(),
leaf_modifications,
config,
)?;
return Ok(OriginalSkeletonTreeImpl::create_empty(sorted_leaf_indices));
}
let main_subtree = FactsSubTree { sorted_leaf_indices, root_index: NodeIndex::ROOT, root_hash };
let mut skeleton_tree = OriginalSkeletonTreeImpl { nodes: HashMap::new(), sorted_leaf_indices };
fetch_nodes::<L, FactsNodeLayout, FactsSubTree<'a>>(
&mut skeleton_tree,
vec![main_subtree],
storage,
leaf_modifications,
config,
None,
key_context,
)
.await?;
Ok(skeleton_tree)
}

pub async fn create_original_skeleton_tree_and_get_previous_leaves<'a, L: Leaf>(
pub async fn create_original_skeleton_tree_and_get_previous_leaves<
'a,
L: Leaf + HasStaticPrefix<KeyContext = EmptyKeyContext>,
>(
storage: &mut impl Storage,
root_hash: HashOutput,
sorted_leaf_indices: SortedLeafIndices<'a>,
leaf_modifications: &LeafModifications<L>,
config: &impl OriginalSkeletonTreeConfig<L>,
key_context: &<L as HasStaticPrefix>::KeyContext,
config: &impl OriginalSkeletonTreeConfig,
) -> OriginalSkeletonTreeResult<(OriginalSkeletonTreeImpl<'a>, HashMap<NodeIndex, L>)> {
if sorted_leaf_indices.is_empty() {
let unmodified = OriginalSkeletonTreeImpl::create_unmodified(root_hash);
Expand All @@ -231,94 +43,33 @@ pub async fn create_original_skeleton_tree_and_get_previous_leaves<'a, L: Leaf>(
let main_subtree = FactsSubTree { sorted_leaf_indices, root_index: NodeIndex::ROOT, root_hash };
let mut skeleton_tree = OriginalSkeletonTreeImpl { nodes: HashMap::new(), sorted_leaf_indices };
let mut leaves = HashMap::new();
fetch_nodes::<L, FactsNodeLayout, FactsSubTree<'a>>(
fetch_nodes::<L, FactsNodeLayout>(
&mut skeleton_tree,
vec![main_subtree],
storage,
leaf_modifications,
config,
Some(&mut leaves),
key_context,
&EmptyKeyContext,
)
.await?;
Ok((skeleton_tree, leaves))
}

pub async fn get_leaves<'a, L: Leaf>(
pub async fn get_leaves<'a, L: Leaf + HasStaticPrefix<KeyContext = EmptyKeyContext>>(
storage: &mut impl Storage,
root_hash: HashOutput,
sorted_leaf_indices: SortedLeafIndices<'a>,
key_context: &<L as HasStaticPrefix>::KeyContext,
) -> OriginalSkeletonTreeResult<HashMap<NodeIndex, L>> {
let config = NoCompareOriginalSkeletonTrieConfig::default();
let config = OriginalSkeletonTrieDontCompareConfig;
let leaf_modifications = LeafModifications::new();
let (_, previous_leaves) = create_original_skeleton_tree_and_get_previous_leaves(
storage,
root_hash,
sorted_leaf_indices,
&leaf_modifications,
&config,
key_context,
)
.await?;
Ok(previous_leaves)
}

/// Handles a subtree referred by an edge or a binary node. Decides whether we deserialize the
/// referred subtree or not.
fn handle_subtree<'a, SubTree: SubTreeTrait<'a>>(
skeleton_tree: &mut OriginalSkeletonTreeImpl<'a>,
next_subtrees: &mut Vec<SubTree>,
subtree: SubTree,
subtree_data: SubTree::NodeData,
should_fetch_modified_leaves: bool,
) {
let is_leaf = subtree.is_leaf();
let is_unmodified = subtree.is_unmodified();

// 1. Internal node → always traverse.
if !is_leaf {
next_subtrees.push(subtree);
return;
}

// 2. Modified leaf.
if !is_unmodified {
if should_fetch_modified_leaves {
next_subtrees.push(subtree);
}
return;
}

// 3. Unmodified leaf sibling.
if !SubTree::should_traverse_unmodified_children() {
skeleton_tree.nodes.insert(
subtree.get_root_index(),
OriginalSkeletonNode::UnmodifiedSubTree(
SubTree::unmodified_child_hash(subtree_data).unwrap(),
),
);
} else {
next_subtrees.push(subtree);
}
}

/// Given leaf indices that were previously empty leaves, logs out a warning for trivial
/// modification if a leaf is modified to an empty leaf.
/// If this check is suppressed by configuration, does nothing.
fn log_warning_for_empty_leaves<L: Leaf, T: Borrow<NodeIndex> + Debug>(
leaf_indices: &[T],
leaf_modifications: &LeafModifications<L>,
config: &impl OriginalSkeletonTreeConfig<L>,
) -> OriginalSkeletonTreeResult<()> {
if !config.compare_modified_leaves() {
return Ok(());
}
let empty_leaf = L::default();
for leaf_index in leaf_indices {
if L::compare(leaf_modifications, leaf_index.borrow(), &empty_leaf)? {
log_trivial_modification!(leaf_index, empty_leaf);
}
}
Ok(())
}
5 changes: 3 additions & 2 deletions crates/starknet_committer/src/db/facts_db/create_facts_tree_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ use starknet_patricia_storage::map_storage::MapStorage;
use starknet_patricia_storage::storage_trait::{DbHashMap, DbKey, DbValue};
use starknet_types_core::felt::Felt;

use crate::db::facts_db::create_facts_tree::create_original_skeleton_tree;
use crate::db::facts_db::db::FactsNodeLayout;
use crate::db::trie_traversal::create_original_skeleton_tree;
use crate::patricia_merkle_tree::tree::OriginalSkeletonTrieConfig;

#[tokio::test]
Expand Down Expand Up @@ -211,7 +212,7 @@ async fn test_create_tree(
let config = OriginalSkeletonTrieConfig::new(compare_modified_leaves);
let mut sorted_leaf_indices: Vec<NodeIndex> = leaf_modifications.keys().copied().collect();
let sorted_leaf_indices = SortedLeafIndices::new(&mut sorted_leaf_indices);
let skeleton_tree = create_original_skeleton_tree(
let skeleton_tree = create_original_skeleton_tree::<MockLeaf, FactsNodeLayout>(
&mut storage,
root_hash,
sorted_leaf_indices,
Expand Down
Loading
Loading