feat(rpc): Add flags to disable read tx timeout (paradigmxyz#11856)

elijahhampton · Oct 22, 2024 · 60337d9 · 60337d9
1 parent df57aed
commit 60337d9
Show file tree

Hide file tree

Showing 19 changed files with 67 additions and 1 deletion.
diff --git a/book/cli/reth/db.md b/book/cli/reth/db.md
@@ -81,6 +81,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/db/diff.md b/book/cli/reth/db/diff.md
@@ -45,6 +45,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
       --table <TABLE>
           The table name to diff. If not specified, all tables are diffed.
 

diff --git a/book/cli/reth/debug/build-block.md b/book/cli/reth/debug/build-block.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
       --trusted-setup-file <PATH>
           Overrides the KZG trusted setup by reading from the supplied file
 

diff --git a/book/cli/reth/debug/execution.md b/book/cli/reth/debug/execution.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Networking:
   -d, --disable-discovery
           Disable the discovery service

diff --git a/book/cli/reth/debug/in-memory-merkle.md b/book/cli/reth/debug/in-memory-merkle.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Networking:
   -d, --disable-discovery
           Disable the discovery service

diff --git a/book/cli/reth/debug/merkle.md b/book/cli/reth/debug/merkle.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Networking:
   -d, --disable-discovery
           Disable the discovery service

diff --git a/book/cli/reth/debug/replay-engine.md b/book/cli/reth/debug/replay-engine.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Networking:
   -d, --disable-discovery
           Disable the discovery service

diff --git a/book/cli/reth/import.md b/book/cli/reth/import.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
       --no-state
           Disables stages that require state.
 

diff --git a/book/cli/reth/init-state.md b/book/cli/reth/init-state.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
   <STATE_DUMP_FILE>
           JSONL file with state dump.
 

diff --git a/book/cli/reth/init.md b/book/cli/reth/init.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/node.md b/book/cli/reth/node.md
@@ -590,6 +590,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Dev testnet:
       --dev
           Start the node in dev mode

diff --git a/book/cli/reth/p2p.md b/book/cli/reth/p2p.md
@@ -247,6 +247,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/prune.md b/book/cli/reth/prune.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/recover/storage-tries.md b/book/cli/reth/recover/storage-tries.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/stage/drop.md b/book/cli/reth/stage/drop.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
   <STAGE>
           Possible values:
           - headers:         The headers stage within the pipeline

diff --git a/book/cli/reth/stage/dump.md b/book/cli/reth/stage/dump.md
@@ -76,6 +76,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Logging:
       --log.stdout.format <FORMAT>
           The format to use for logs written to stdout

diff --git a/book/cli/reth/stage/run.md b/book/cli/reth/stage/run.md
@@ -69,6 +69,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
       --metrics <SOCKET>
           Enable Prometheus metrics.
 

diff --git a/book/cli/reth/stage/unwind.md b/book/cli/reth/stage/unwind.md
@@ -74,6 +74,9 @@ Database:
 
           [possible values: true, false]
 
+      --db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>
+          Read transaction timeout in seconds, 0 means no timeout
+
 Networking:
   -d, --disable-discovery
           Disable the discovery service

diff --git a/crates/node/core/src/args/database.rs b/crates/node/core/src/args/database.rs
@@ -1,12 +1,14 @@
 //! clap [Args](clap::Args) for database configuration
 
+use std::time::Duration;
+
 use crate::version::default_client_version;
 use clap::{
     builder::{PossibleValue, TypedValueParser},
     error::ErrorKind,
     Arg, Args, Command, Error,
 };
-use reth_db::ClientVersion;
+use reth_db::{mdbx::MaxReadTransactionDuration, ClientVersion};
 use reth_storage_errors::db::LogLevel;
 
 /// Parameters for database configuration
@@ -20,6 +22,9 @@ pub struct DatabaseArgs {
     /// NFS volume.
     #[arg(long = "db.exclusive")]
     pub exclusive: Option<bool>,
+    /// Read transaction timeout in seconds, 0 means no timeout.
+    #[arg(long = "db.read-transaction-timeout")]
+    pub read_transaction_timeout: Option<u64>,
 }
 
 impl DatabaseArgs {
@@ -33,9 +38,16 @@ impl DatabaseArgs {
         &self,
         client_version: ClientVersion,
     ) -> reth_db::mdbx::DatabaseArguments {
+        let max_read_transaction_duration = match self.read_transaction_timeout {
+            None => None, // if not specified, use default value
+            Some(0) => Some(MaxReadTransactionDuration::Unbounded), // if 0, disable timeout
+            Some(secs) => Some(MaxReadTransactionDuration::Set(Duration::from_secs(secs))),
+        };
+
         reth_db::mdbx::DatabaseArguments::new(client_version)
             .with_log_level(self.log_level)
             .with_exclusive(self.exclusive)
+            .with_max_read_transaction_duration(max_read_transaction_duration)
     }
 }