feat: overwrite reth default cache directory (#238)

* feat: overwrite reth default cache directory

* doc: logs path

Author: julio4

Cargo.lock

@@ -93,6 +93,12 @@ To enable metrics, set the `--metrics` flag like in [reth](https://reth.rs/run/m
 
 To see the full list of op-rbuilder metrics, see [`src/metrics.rs`](./crates/op-rbuilder/src/metrics.rs).
 
+Default `debug` level trace logs can be found at:
+
+- `~/.cache/op-rbuilder/logs` on Linux
+- `~/Library/Caches/op-rbuilder/logs` on macOS
+- `%localAppData%/op-rbuilder/logs` on Windows
+
 ## Integration Testing
 
 op-rbuilder has an integration test framework that runs the builder against mock engine api payloads and ensures that the builder produces valid blocks.

README.md

@@ -136,6 +136,7 @@ ctor = { version = "0.4.2", optional = true }
 rlimit = { version = "0.10", optional = true }
 macros = { path = "src/tests/framework/macros", optional = true }
 testcontainers = "0.24.0"
+dirs-next = "2.0.0"
 
 [target.'cfg(unix)'.dependencies]
 tikv-jemallocator = { version = "0.6", optional = true }

crates/op-rbuilder/Cargo.toml

@@ -78,12 +78,17 @@ impl CliExt for Cli {
 
     /// Parses commands and overrides versions
     fn set_version() -> Self {
+        let logs_dir = dirs_next::cache_dir()
+            .map(|root| root.join("op-rbuilder/logs"))
+            .unwrap()
+            .into_os_string();
         let matches = Cli::command()
             .version(SHORT_VERSION)
             .long_version(LONG_VERSION)
             .about("Block builder designed for the Optimism stack")
             .author("Flashbots")
             .name("op-rbuilder")
+            .mut_arg("log_file_directory", |arg| arg.default_value(logs_dir))
             .get_matches();
         Cli::from_arg_matches(&matches).expect("Parsing args")
     }