Flip defaults for txpool prewarming

Author: pepyakin

crates/engine/primitives/src/config.rs

@@ -230,7 +230,7 @@ impl Default for TreeConfig {
             always_compare_trie_updates: false,
             disable_state_cache: false,
             disable_prewarming: false,
-            txpool_prewarming: false,
+            txpool_prewarming: true,
             state_provider_metrics: false,
             cross_block_cache_size: DEFAULT_CROSS_BLOCK_CACHE_SIZE,
             has_enough_parallelism: has_enough_parallelism(),
@@ -307,7 +307,7 @@ impl TreeConfig {
             always_compare_trie_updates,
             disable_state_cache,
             disable_prewarming,
-            txpool_prewarming: false,
+            txpool_prewarming: true,
             state_provider_metrics,
             cross_block_cache_size,
             has_enough_parallelism,
@@ -534,6 +534,12 @@ impl TreeConfig {
         self
     }
 
+    /// Setter for whether to disable txpool transaction prewarming.
+    pub const fn without_txpool_prewarming(mut self, disabled: bool) -> Self {
+        self.txpool_prewarming = !disabled;
+        self
+    }
+
     /// Setter for whether to always compare trie updates from the state root task to the trie
     /// updates from the regular state root calculation.
     pub const fn with_always_compare_trie_updates(
@@ -797,6 +803,12 @@ impl TreeConfig {
 mod tests {
     use super::TreeConfig;
 
+    #[test]
+    fn txpool_prewarming_is_enabled_by_default_and_can_be_disabled() {
+        assert!(TreeConfig::default().txpool_prewarming());
+        assert!(!TreeConfig::default().without_txpool_prewarming(true).txpool_prewarming());
+    }
+
     #[test]
     fn state_root_task_requires_parallelism_without_overrides() {
         assert!(TreeConfig::default().with_has_enough_parallelism(true).use_state_root_task());

crates/ethereum/node/tests/e2e/selfdestruct.rs

@@ -141,7 +141,10 @@ fn selfdestruct_contract_init_code() -> Bytes {
 async fn test_selfdestruct_post_dencun() -> eyre::Result<()> {
     reth_tracing::init_test_tracing();
 
-    let tree_config = TreeConfig::default().without_prewarming(true).without_state_cache(false);
+    let tree_config = TreeConfig::default()
+        .without_prewarming(true)
+        .without_txpool_prewarming(true)
+        .without_state_cache(false);
     let (mut nodes, wallet) =
         setup_engine::<EthereumNode>(1, cancun_spec(), false, tree_config, eth_payload_attributes)
             .await?;
@@ -235,7 +238,10 @@ async fn test_selfdestruct_post_dencun() -> eyre::Result<()> {
 async fn test_selfdestruct_same_tx_post_dencun() -> eyre::Result<()> {
     reth_tracing::init_test_tracing();
 
-    let tree_config = TreeConfig::default().without_prewarming(true).without_state_cache(false);
+    let tree_config = TreeConfig::default()
+        .without_prewarming(true)
+        .without_txpool_prewarming(true)
+        .without_state_cache(false);
     let (mut nodes, wallet) =
         setup_engine::<EthereumNode>(1, cancun_spec(), false, tree_config, eth_payload_attributes)
             .await?;
@@ -310,7 +316,10 @@ async fn test_selfdestruct_same_tx_post_dencun() -> eyre::Result<()> {
 async fn test_selfdestruct_pre_dencun() -> eyre::Result<()> {
     reth_tracing::init_test_tracing();
 
-    let tree_config = TreeConfig::default().without_prewarming(true).without_state_cache(false);
+    let tree_config = TreeConfig::default()
+        .without_prewarming(true)
+        .without_txpool_prewarming(true)
+        .without_state_cache(false);
     let (mut nodes, wallet) = setup_engine::<EthereumNode>(
         1,
         shanghai_spec(),
@@ -420,7 +429,10 @@ async fn test_selfdestruct_pre_dencun() -> eyre::Result<()> {
 async fn test_selfdestruct_same_tx_preexisting_account_post_dencun() -> eyre::Result<()> {
     reth_tracing::init_test_tracing();
 
-    let tree_config = TreeConfig::default().without_prewarming(true).without_state_cache(false);
+    let tree_config = TreeConfig::default()
+        .without_prewarming(true)
+        .without_txpool_prewarming(true)
+        .without_state_cache(false);
     let (mut nodes, wallet) =
         setup_engine::<EthereumNode>(1, cancun_spec(), false, tree_config, eth_payload_attributes)
             .await?;

crates/node/core/src/args/engine.rs

@@ -32,7 +32,7 @@ pub struct DefaultEngineValues {
     invalid_header_hit_eviction_threshold: u8,
     state_cache_disabled: bool,
     prewarming_disabled: bool,
-    txpool_prewarming_enabled: bool,
+    txpool_prewarming_disabled: bool,
     state_provider_metrics: bool,
     cross_block_cache_size: usize,
     state_root_task_compare_updates: bool,
@@ -106,9 +106,9 @@ impl DefaultEngineValues {
         self
     }
 
-    /// Set whether to enable txpool prewarming by default
-    pub const fn with_txpool_prewarming_enabled(mut self, v: bool) -> Self {
-        self.txpool_prewarming_enabled = v;
+    /// Set whether to disable txpool prewarming by default
+    pub const fn with_txpool_prewarming_disabled(mut self, v: bool) -> Self {
+        self.txpool_prewarming_disabled = v;
         self
     }
 
@@ -269,7 +269,7 @@ impl Default for DefaultEngineValues {
             invalid_header_hit_eviction_threshold: DEFAULT_INVALID_HEADER_HIT_EVICTION_THRESHOLD,
             state_cache_disabled: false,
             prewarming_disabled: false,
-            txpool_prewarming_enabled: false,
+            txpool_prewarming_disabled: false,
             state_provider_metrics: false,
             cross_block_cache_size: DEFAULT_CROSS_BLOCK_CACHE_SIZE_MB,
             state_root_task_compare_updates: false,
@@ -358,9 +358,9 @@ pub struct EngineArgs {
     #[arg(long = "engine.disable-prewarming", alias = "engine.disable-caching-and-prewarming", default_value_t = DefaultEngineValues::get_global().prewarming_disabled)]
     pub prewarming_disabled: bool,
 
-    /// Enable best-effort txpool transaction prewarming between payloads.
-    #[arg(long = "engine.txpool-prewarming", default_value_t = DefaultEngineValues::get_global().txpool_prewarming_enabled)]
-    pub txpool_prewarming_enabled: bool,
+    /// Disable best-effort txpool transaction prewarming between payloads.
+    #[arg(long = "engine.disable-txpool-prewarming", default_value_t = DefaultEngineValues::get_global().txpool_prewarming_disabled)]
+    pub txpool_prewarming_disabled: bool,
 
     /// CAUTION: This CLI flag has no effect anymore. The parallel sparse trie is always enabled.
     #[deprecated]
@@ -567,7 +567,7 @@ impl Default for EngineArgs {
             invalid_header_hit_eviction_threshold,
             state_cache_disabled,
             prewarming_disabled,
-            txpool_prewarming_enabled,
+            txpool_prewarming_disabled,
             state_provider_metrics,
             cross_block_cache_size,
             state_root_task_compare_updates,
@@ -603,7 +603,7 @@ impl Default for EngineArgs {
             caching_and_prewarming_enabled: true,
             state_cache_disabled,
             prewarming_disabled,
-            txpool_prewarming_enabled,
+            txpool_prewarming_disabled,
             parallel_sparse_trie_enabled: true,
             parallel_sparse_trie_disabled: false,
             state_provider_metrics,
@@ -676,7 +676,7 @@ impl EngineArgs {
             .with_invalid_header_hit_eviction_threshold(self.invalid_header_hit_eviction_threshold)
             .without_state_cache(self.state_cache_disabled)
             .without_prewarming(self.prewarming_disabled)
-            .with_txpool_prewarming(self.txpool_prewarming_enabled)
+            .without_txpool_prewarming(self.txpool_prewarming_disabled)
             .with_state_provider_metrics(self.state_provider_metrics)
             .with_always_compare_trie_updates(self.state_root_task_compare_updates)
             .with_cross_block_cache_size(self.cross_block_cache_size * 1024 * 1024)
@@ -733,6 +733,19 @@ mod tests {
         );
     }
 
+    #[test]
+    fn txpool_prewarming_is_enabled_by_default_and_can_be_disabled() {
+        let args = CommandParser::<EngineArgs>::parse_from(["reth"]).args;
+        assert!(!args.txpool_prewarming_disabled);
+        assert!(args.tree_config().txpool_prewarming());
+
+        let args =
+            CommandParser::<EngineArgs>::parse_from(["reth", "--engine.disable-txpool-prewarming"])
+                .args;
+        assert!(args.txpool_prewarming_disabled);
+        assert!(!args.tree_config().txpool_prewarming());
+    }
+
     #[test]
     fn default_backpressure_threshold_uses_parsed_persistence_args() {
         let args = CommandParser::<EngineArgs>::parse_from([
@@ -795,7 +808,7 @@ mod tests {
             caching_and_prewarming_enabled: true,
             state_cache_disabled: true,
             prewarming_disabled: true,
-            txpool_prewarming_enabled: true,
+            txpool_prewarming_disabled: true,
             parallel_sparse_trie_enabled: true,
             parallel_sparse_trie_disabled: false,
             state_provider_metrics: true,
@@ -841,7 +854,7 @@ mod tests {
             "--engine.legacy-state-root",
             "--engine.disable-state-cache",
             "--engine.disable-prewarming",
-            "--engine.txpool-prewarming",
+            "--engine.disable-txpool-prewarming",
             "--engine.state-provider-metrics",
             "--engine.cross-block-cache-size",
             "256",

docs/vocs/docs/pages/cli/reth/node.mdx

@@ -1011,8 +1011,8 @@ Engine:
       --engine.disable-prewarming
           Disable parallel prewarming
 
-      --engine.txpool-prewarming
-          Enable best-effort txpool transaction prewarming between payloads
+      --engine.disable-txpool-prewarming
+          Disable best-effort txpool transaction prewarming between payloads
 
       --engine.state-provider-metrics
           Enable state provider latency metrics. This allows the engine to collect and report stats about how long state provider calls took during execution, but this does introduce slight overhead to state provider calls