feat: add reth db checksum <TABLE> command (#7257)

Co-authored-by: Dan Cline <6798349+Rjected@users.noreply.github.com>
2026-04-30 03:01:58 -04:00 · 2024-04-11 00:04:08 +02:00
parent dd83c9c4f8
commit b8b735e8e6
4 changed files with 99 additions and 29 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -84,7 +84,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011"
 dependencies = [
 "cfg-if",
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 "once_cell",
 "version_check",
 "zerocopy",
@@ -131,9 +131,9 @@ checksum = "0942ffc6dcaadf03badf6e6a2d0228460359d5e34b57ccdc720b7382dfbd5ec5"

 [[package]]
 name = "alloy-chains"
-version = "0.1.15"
+version = "0.1.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e96c81b05c893348760f232c4cc6a6a77fd91cfb09885d4eaad25cd03bd7732e"
+checksum = "40646aa7f01e396139cf0d6c3a7475eeb8094a0f41d8199f10860c8aef09d2f1"
 dependencies = [
 "alloy-rlp",
 "arbitrary",
@@ -271,7 +271,7 @@ dependencies = [
 "derive_arbitrary",
 "derive_more",
 "ethereum_ssz",
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 "hex-literal",
 "itoa",
 "k256",
@@ -622,9 +622,9 @@ dependencies = [

 [[package]]
 name = "anyhow"
-version = "1.0.81"
+version = "1.0.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0952808a6c2afd1aa8947271f3a60f1a6763c7b912d210184c5149b5cf147247"
+checksum = "f538837af36e6f6a9be0faa67f9a314f8119e4e4b5867c6ab40ed60360142519"

 [[package]]
 name = "aquamarine"
@@ -911,9 +911,9 @@ checksum = "f1fdabc7756949593fe60f30ec81974b613357de856987752631dea1e3394c80"

 [[package]]
 name = "backon"
-version = "0.4.3"
+version = "0.4.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c491fa80d69c03084223a4e73c378dd9f9a1e612eb54051213f88b2d5249b458"
+checksum = "d67782c3f868daa71d3533538e98a8e13713231969def7536e8039606fc46bf0"
 dependencies = [
 "fastrand 2.0.2",
 "futures-core",
@@ -1307,9 +1307,9 @@ dependencies = [

 [[package]]
 name = "bumpalo"
-version = "3.15.4"
+version = "3.16.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ff69b9dd49fd426c69a0db9fc04dd934cdb6645ff000864d98f7e2af8830eaa"
+checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c"

 [[package]]
 name = "byte-slice-cast"
@@ -1752,9 +1752,9 @@ dependencies = [

 [[package]]
 name = "crc"
-version = "3.0.1"
+version = "3.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "86ec7a15cbe22e59248fc7eadb1907dab5ba09372595da4d73dd805ed4417dfe"
+checksum = "69e6e4d7b33a94f0991c26729976b10ebde1d34c3ee82408fb536164fa10d636"
 dependencies = [
 "crc-catalog",
 ]
@@ -2565,9 +2565,9 @@ checksum = "a357d28ed41a50f9c765dbfe56cbc04a64e53e5fc58ba79fbc34c10ef3df831f"

 [[package]]
 name = "encoding_rs"
-version = "0.8.33"
+version = "0.8.34"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7268b386296a025e474d5140678f75d6de9493ae55a5d709eeb9dd08149945e1"
+checksum = "b45de904aa0b010bce2ab45264d0631681847fa7b6f2eaa7dab7619943bc4f59"
 dependencies = [
 "cfg-if",
 ]
@@ -3033,9 +3033,9 @@ dependencies = [

 [[package]]
 name = "getrandom"
-version = "0.2.13"
+version = "0.2.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a06fddc2749e0528d2813f95e050e87e52c8cbbae56223b9babf73b3e53b0cc6"
+checksum = "94b22e06ecb0110981051723910cbf0b5f5e09a2062dd7663334ee79a9d1286c"
 dependencies = [
 "cfg-if",
 "libc",
@@ -3426,7 +3426,7 @@ dependencies = [
 "httpdate",
 "itoa",
 "pin-project-lite",
- "socket2 0.4.10",
+ "socket2 0.5.6",
 "tokio",
 "tower-service",
 "tracing",
@@ -4233,7 +4233,7 @@ dependencies = [
 "either",
 "futures",
 "futures-timer",
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 "instant",
 "libp2p-allow-block-list",
 "libp2p-connection-limits",
@@ -4979,7 +4979,7 @@ version = "0.7.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "681030a937600a36906c185595136d26abfebb4aa9c65701cefcaf8578bb982b"
 dependencies = [
- "proc-macro-crate 2.0.0",
+ "proc-macro-crate 3.1.0",
 "proc-macro2",
 "quote",
 "syn 2.0.58",
@@ -5648,9 +5648,9 @@ dependencies = [

 [[package]]
 name = "quote"
-version = "1.0.35"
+version = "1.0.36"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "291ec9ab5efd934aaf503a6466c5d5251535d108ee747472c3977cc5acc868ef"
+checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7"
 dependencies = [
 "proc-macro2",
 ]
@@ -5730,7 +5730,7 @@ version = "0.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
 dependencies = [
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 ]

 [[package]]
@@ -5823,7 +5823,7 @@ version = "0.4.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bd283d9651eeda4b2a83a43c1c91b266c40fd76ecd39a50a8c630ae69dc72891"
 dependencies = [
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 "libredox",
 "thiserror",
 ]
@@ -5974,6 +5974,7 @@ dependencies = [
 name = "reth"
 version = "0.2.0-beta.5"
 dependencies = [
+ "ahash",
 "alloy-rlp",
 "aquamarine",
 "assert_matches",
@@ -7541,7 +7542,7 @@ checksum = "c17fa4cb658e3583423e915b9f3acc01cceaee1860e33d59ebae66adc3a2dc0d"
 dependencies = [
 "cc",
 "cfg-if",
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 "libc",
 "spin 0.9.8",
 "untrusted 0.9.0",
@@ -8756,9 +8757,9 @@ dependencies = [

 [[package]]
 name = "time"
-version = "0.3.34"
+version = "0.3.35"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c8248b6521bb14bc45b4067159b9b6ad792e2d6d754d6c41fb50e29fefe38749"
+checksum = "ef89ece63debf11bc32d1ed8d078ac870cbeb44da02afb02a9ff135ae7ca0582"
 dependencies = [
 "deranged",
 "itoa",
@@ -8780,9 +8781,9 @@ checksum = "ef927ca75afb808a4d64dd374f00a2adf8d0fcff8e7b184af886c3c87ec4a3f3"

 [[package]]
 name = "time-macros"
-version = "0.2.17"
+version = "0.2.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ba3a3ef41e6672a2f0f001392bb5dcd3ff0a9992d618ca761a11c3121547774"
+checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf"
 dependencies = [
 "num-conv",
 "time-core",
@@ -9427,7 +9428,7 @@ version = "1.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a183cf7feeba97b4dd1c0d46788634f6221d87fa961b305bed08c851829efcc0"
 dependencies = [
- "getrandom 0.2.13",
+ "getrandom 0.2.14",
 ]

 [[package]]
--- a/bin/reth/Cargo.toml
+++ b/bin/reth/Cargo.toml
@@ -92,6 +92,7 @@ similar-asserts.workspace = true
 itertools.workspace = true
 rayon.workspace = true
 boyer-moore-magiclen = "0.2.16"
+ahash = "0.8"

 [target.'cfg(unix)'.dependencies]
 tikv-jemallocator = { version = "0.5.0", optional = true }
--- a/bin/reth/src/commands/db/checksum.rs
+++ b/bin/reth/src/commands/db/checksum.rs
@@ -0,0 +1,60 @@
+use crate::utils::DbTool;
+use ahash::AHasher;
+use clap::Parser;
+use reth_db::{
+    cursor::DbCursorRO, database::Database, table::Table, transaction::DbTx, DatabaseEnv, RawKey,
+    RawTable, RawValue, TableViewer, Tables,
+};
+use std::{hash::Hasher, time::Instant};
+use tracing::{info, warn};
+
+#[derive(Parser, Debug)]
+/// The arguments for the `reth db checksum` command
+pub struct Command {
+    /// The table name
+    table: Tables,
+}
+
+impl Command {
+    /// Execute `db checksum` command
+    pub fn execute(self, tool: &DbTool<DatabaseEnv>) -> eyre::Result<()> {
+        self.table.view(&ChecksumViewer { tool })
+    }
+}
+
+struct ChecksumViewer<'a, DB: Database> {
+    tool: &'a DbTool<DB>,
+}
+
+impl<DB: Database> TableViewer<()> for ChecksumViewer<'_, DB> {
+    type Error = eyre::Report;
+
+    fn view<T: Table>(&self) -> Result<(), Self::Error> {
+        warn!("This command should be run without the node running!");
+
+        let provider =
+            self.tool.provider_factory.provider()?.disable_long_read_transaction_safety();
+        let tx = provider.tx_ref();
+
+        let mut cursor = tx.cursor_read::<RawTable<T>>()?;
+        let walker = cursor.walk(None)?;
+
+        let start_time = Instant::now();
+        let mut hasher = AHasher::default();
+        for (index, entry) in walker.enumerate() {
+            let (k, v): (RawKey<T::Key>, RawValue<T::Value>) = entry?;
+
+            if index % 100_000 == 0 {
+                info!("Hashed {index} entries.");
+            }
+
+            hasher.write(k.raw_key());
+            hasher.write(v.raw_value());
+        }
+
+        let elapsed = start_time.elapsed();
+        info!("{} checksum: {:x}, took {:?}", T::NAME, hasher.finish(), elapsed);
+
+        Ok(())
+    }
+}
--- a/bin/reth/src/commands/db/mod.rs
+++ b/bin/reth/src/commands/db/mod.rs
@@ -20,6 +20,7 @@ use std::{
    sync::Arc,
 };

+mod checksum;
 mod clear;
 mod diff;
 mod get;
@@ -69,6 +70,8 @@ pub enum Subcommands {
    Stats(stats::Command),
    /// Lists the contents of a table
    List(list::Command),
+    /// Calculates the content checksum of a table
+    Checksum(checksum::Command),
    /// Create a diff between two database tables or two entire databases.
    Diff(diff::Command),
    /// Gets the content of a table for the given key
@@ -121,6 +124,11 @@ impl Command {
                    command.execute(&tool)?;
                });
            }
+            Subcommands::Checksum(command) => {
+                db_ro_exec!(self.chain, &db_path, db_args, static_files_path, tool, {
+                    command.execute(&tool)?;
+                });
+            }
            Subcommands::Diff(command) => {
                db_ro_exec!(self.chain, &db_path, db_args, static_files_path, tool, {
                    command.execute(&tool)?;