feat: scroll parallel state root (#100)

* feat: add parallel trie for Scroll Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * wip: `ParallelStateRoot` abstraction Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * chore: remove abstraction Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * fix: wasm check Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * fix: answer comments Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * test: add trie input test for `ParallelStateRoot` Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> --------- Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com>
scroll-tech · Dec 24, 2024 · 944bfd0 · 944bfd0
1 parent 4554b75
commit 944bfd0
Show file tree

Hide file tree

Showing 12 changed files with 445 additions and 31 deletions.
diff --git a/.github/assets/check_wasm.sh b/.github/assets/check_wasm.sh
@@ -74,6 +74,9 @@ exclude_crates=(
   reth-scroll-cli # tokio
   reth-scroll-node # tokio
   reth-scroll # tokio
+  reth-scroll-state-commitment # tokio
+  reth-scroll-chainspec # tokio
+  reth-scroll-evm # tokio
 )
 
 # Array to hold the results

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/blockchain-tree/Cargo.toml b/crates/blockchain-tree/Cargo.toml
@@ -35,6 +35,7 @@ alloy-primitives.workspace = true
 alloy-eips.workspace = true
 
 # scroll
+reth-scroll-state-commitment = { workspace = true, optional = true }
 reth-scroll-storage = { workspace = true, optional = true }
 
 # common
@@ -82,7 +83,8 @@ test-utils = [
 	"reth-provider/test-utils",
 	"reth-trie-db/test-utils",
 	"reth-trie/test-utils",
-	"revm/test-utils"
+	"revm/test-utils",
+	"reth-scroll-state-commitment?/test-utils"
 ]
 optimism = [
 	"reth-primitives/optimism",
@@ -103,5 +105,6 @@ scroll = [
 	"reth-testing-utils/scroll",
 	"reth-trie/scroll",
 	"revm/scroll",
-	"reth-scroll-storage/scroll"
+	"reth-scroll-storage/scroll",
+	"reth-scroll-state-commitment/scroll"
 ]
diff --git a/crates/blockchain-tree/src/chain.rs b/crates/blockchain-tree/src/chain.rs
@@ -22,7 +22,6 @@ use reth_provider::{
     StateRootProvider, TryIntoHistoricalStateProvider,
 };
 use reth_trie::{updates::TrieUpdates, TrieInput};
-use reth_trie_parallel::root::ParallelStateRoot;
 use std::{
     collections::BTreeMap,
     ops::{Deref, DerefMut},
@@ -228,13 +227,20 @@ impl AppendableChain {
                 let mut execution_outcome =
                     provider.block_execution_data_provider.execution_outcome().clone();
                 execution_outcome.extend(initial_execution_outcome.clone());
-                ParallelStateRoot::new(
+                #[cfg(feature = "scroll")]
+                let parallel_state_root = reth_scroll_state_commitment::ParallelStateRoot::new(
                     consistent_view,
                     TrieInput::from_state(provider.hashed_post_state(execution_outcome.state())),
-                )
-                .incremental_root_with_updates()
-                .map(|(root, updates)| (root, Some(updates)))
-                .map_err(ProviderError::from)?
+                );
+                #[cfg(not(feature = "scroll"))]
+                let parallel_state_root = reth_trie_parallel::root::ParallelStateRoot::new(
+                    consistent_view,
+                    TrieInput::from_state(provider.hashed_post_state(execution_outcome.state())),
+                );
+                parallel_state_root
+                    .incremental_root_with_updates()
+                    .map(|(root, updates)| (root, Some(updates)))
+                    .map_err(ProviderError::from)?
             } else {
                 let hashed_state = provider.hashed_post_state(initial_execution_outcome.state());
                 let state_root = provider.state_root_from_state(hashed_state)?;

diff --git a/crates/blockchain-tree/src/lib.rs b/crates/blockchain-tree/src/lib.rs
@@ -19,6 +19,7 @@
 #![cfg_attr(not(test), warn(unused_crate_dependencies))]
 
 use reth_revm as _;
+use reth_trie_parallel as _;
 
 /// Re-export of the blockchain tree API.
 pub use reth_blockchain_tree_api::*;

diff --git a/crates/engine/tree/Cargo.toml b/crates/engine/tree/Cargo.toml
@@ -39,6 +39,7 @@ reth-trie-sparse.workspace = true
 reth-trie.workspace = true
 
 # scroll
+reth-scroll-state-commitment = { workspace = true, optional = true }
 reth-scroll-storage = { workspace = true, optional = true }
 
 # alloy
@@ -125,8 +126,10 @@ test-utils = [
     "reth-trie/test-utils",
     "reth-prune-types?/test-utils",
     "reth-trie-db/test-utils",
+    "reth-scroll-state-commitment?/test-utils"
 ]
 scroll = [
     "reth-scroll-primitives",
-    "reth-scroll-storage/scroll"
+    "reth-scroll-storage/scroll",
+    "reth-scroll-state-commitment/scroll"
 ]
diff --git a/crates/engine/tree/src/tree/mod.rs b/crates/engine/tree/src/tree/mod.rs
@@ -47,7 +47,7 @@ use reth_provider::{
 };
 use reth_stages_api::ControlFlow;
 use reth_trie::{updates::TrieUpdates, HashedPostState, TrieInput};
-use reth_trie_parallel::root::{ParallelStateRoot, ParallelStateRootError};
+use reth_trie_parallel::root::ParallelStateRootError;
 use revm_primitives::EvmState;
 use std::{
     cmp::Ordering,
@@ -2374,7 +2374,13 @@ where
         // Extend with block we are validating root for.
         input.append_ref(hashed_state);
 
-        ParallelStateRoot::new(consistent_view, input).incremental_root_with_updates()
+        #[cfg(feature = "scroll")]
+        let parallel_state_root =
+            reth_scroll_state_commitment::ParallelStateRoot::new(consistent_view, input);
+        #[cfg(not(feature = "scroll"))]
+        let parallel_state_root =
+            reth_trie_parallel::root::ParallelStateRoot::new(consistent_view, input);
+        parallel_state_root.incremental_root_with_updates()
     }
 
     /// Handles an error that occurred while inserting a block.

diff --git a/crates/scroll/state-commitment/Cargo.toml b/crates/scroll/state-commitment/Cargo.toml
@@ -12,15 +12,21 @@ exclude.workspace = true
 workspace = true
 
 [dependencies]
-reth-db.workspace = true 
+# reth
+reth-db.workspace = true
 reth-execution-errors.workspace = true
 reth-primitives.workspace = true
 reth-primitives-traits.workspace = true
+reth-provider.workspace = true
+reth-storage-api.workspace = true
+reth-trie.workspace = true
+reth-trie-db.workspace = true
+reth-trie-parallel.workspace = true
+
+# scroll
 reth-scroll-execution.workspace = true
 reth-scroll-primitives.workspace = true
 reth-scroll-trie.workspace = true
-reth-trie.workspace = true
-reth-trie-db.workspace = true
 
 # alloy
 alloy-consensus.workspace = true
@@ -38,23 +44,26 @@ zktrie_rust = { git = "https://github.com/scroll-tech/zktrie.git", rev = "309160
 zktrie = { git = "https://github.com/scroll-tech/zktrie.git", rev = "309160464c1cd2b87a578ed6d9b6e98205ae4640", features = ["rs_zktrie"], optional = true }
 
 # misc
-tracing.workspace = true
 itertools.workspace = true
+rayon.workspace = true
+tracing.workspace = true
 
 [dev-dependencies]
 reth-db-api.workspace = true
 reth-primitives = { workspace = true, features = ["test-utils", "arbitrary"] }
+reth-node-types.workspace = true
 reth-scroll-state-commitment = { workspace = true, features = ["test-utils"] }
-reth-trie = { workspace = true, features = ["test-utils" ] }
+reth-trie = { workspace = true, features = ["test-utils"] }
 reth-trie-common = { workspace = true, features = ["test-utils", "arbitrary"] }
-reth-provider = { workspace = true, features = ["test-utils" ] }
+reth-provider = { workspace = true, features = ["test-utils"] }
 alloy-consensus.workspace = true
 zktrie_rust = { git = "https://github.com/scroll-tech/zktrie.git", rev = "309160464c1cd2b87a578ed6d9b6e98205ae4640" }
 zktrie = { git = "https://github.com/scroll-tech/zktrie.git", rev = "309160464c1cd2b87a578ed6d9b6e98205ae4640", features = ["rs_zktrie"] }
 proptest.workspace = true
 proptest-arbitrary-interop.workspace = true
 
 [features]
+default = ["metrics"]
 scroll = [
     "reth-trie/scroll",
     "reth-primitives-traits/scroll",
@@ -76,6 +85,10 @@ test-utils = [
     "reth-trie-common/test-utils",
     "reth-trie-db/test-utils"
 ]
-metrics = ["reth-metrics", "dep:metrics"]
+metrics = [
+    "reth-metrics",
+    "dep:metrics",
+    "reth-trie-parallel/metrics"
+]
 
 
diff --git a/crates/scroll/state-commitment/src/commitment.rs b/crates/scroll/state-commitment/src/commitment.rs
@@ -8,7 +8,6 @@ use reth_trie_db::{DatabaseHashedCursorFactory, DatabaseTrieCursorFactory, State
 pub struct BinaryMerklePatriciaTrie;
 
 impl StateCommitment for BinaryMerklePatriciaTrie {
-    type KeyHasher = PoseidonKeyHasher;
     type StateRoot<'a, TX: DbTx + 'a> =
         StateRoot<DatabaseTrieCursorFactory<'a, TX>, DatabaseHashedCursorFactory<'a, TX>>;
     type StorageRoot<'a, TX: DbTx + 'a> =
@@ -23,4 +22,5 @@ impl StateCommitment for BinaryMerklePatriciaTrie {
         DatabaseTrieCursorFactory<'a, TX>,
         DatabaseHashedCursorFactory<'a, TX>,
     >;
+    type KeyHasher = PoseidonKeyHasher;
 }
diff --git a/crates/scroll/state-commitment/src/root/mod.rs b/crates/scroll/state-commitment/src/root/mod.rs
@@ -20,6 +20,9 @@ use tracing::{debug, trace};
 #[cfg(feature = "metrics")]
 use reth_trie::metrics::{StateRootMetrics, TrieRootMetrics, TrieType};
 
+mod parallel;
+pub use parallel::ParallelStateRoot;
+
 mod utils;
 pub use utils::*;