From 6d8fa7a97bfea84d95582ee369dc9a61efd09a8e Mon Sep 17 00:00:00 2001
From: steviez <steven@anza.xyz>
Date: Thu, 13 Jun 2024 12:13:39 -0500
Subject: [PATCH] ledger-tool: Deprecate bank-hash command (#1710)

ledger-tool has a somewhat cluttered interface. The bank-hash command
offers little extra functionality compared to what the verify command
does, and could instead be an optional flag for the verify command.

This change leaves the bank-hash command present, but prints an error
message and tells the user to instead use verify --print-bank-hash. The
command will be removed altogether in the future.
---
 ledger-tool/src/main.rs | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

diff --git a/ledger-tool/src/main.rs b/ledger-tool/src/main.rs
index 00255581f79052..fee913c82b593d 100644
--- a/ledger-tool/src/main.rs
+++ b/ledger-tool/src/main.rs
@@ -1047,6 +1047,14 @@ fn main() {
                              stores",
                         ),
                 )
+                .arg(
+                    Arg::with_name("print_bank_hash")
+                        .long("print-bank-hash")
+                        .takes_value(false)
+                        .help(
+                            "After verifying the ledger, print the working bank's hash"
+                        ),
+                )
                 .arg(
                     Arg::with_name("write_bank_file")
                         .long("write-bank-file")
@@ -1620,24 +1628,11 @@ fn main() {
                         )
                     );
                 }
-                ("bank-hash", Some(arg_matches)) => {
-                    let process_options = parse_process_options(&ledger_path, arg_matches);
-                    let genesis_config = open_genesis_config_by(&ledger_path, arg_matches);
-                    let blockstore = open_blockstore(
-                        &ledger_path,
-                        arg_matches,
-                        get_access_type(&process_options),
+                ("bank-hash", Some(_)) => {
+                    eprintln!(
+                        "The bank-hash command has been deprecated, use \
+                        agave-ledger-tool verify --print-bank-hash ... instead"
                     );
-                    let (bank_forks, _) = load_and_process_ledger_or_exit(
-                        arg_matches,
-                        &genesis_config,
-                        Arc::new(blockstore),
-                        process_options,
-                        snapshot_archive_path,
-                        incremental_snapshot_archive_path,
-                        None,
-                    );
-                    println!("{}", &bank_forks.read().unwrap().working_bank().hash());
                 }
                 ("verify", Some(arg_matches)) => {
                     let exit_signal = Arc::new(AtomicBool::new(false));
@@ -1797,6 +1792,7 @@ fn main() {
                     process_options.slot_callback = slot_callback;
 
                     let print_accounts_stats = arg_matches.is_present("print_accounts_stats");
+                    let print_bank_hash = arg_matches.is_present("print_bank_hash");
                     let write_bank_file = arg_matches.is_present("write_bank_file");
                     let genesis_config = open_genesis_config_by(&ledger_path, arg_matches);
                     info!("genesis hash: {}", genesis_config.hash());
@@ -1816,12 +1812,18 @@ fn main() {
                         transaction_status_sender,
                     );
 
+                    let working_bank = bank_forks.read().unwrap().working_bank();
                     if print_accounts_stats {
-                        let working_bank = bank_forks.read().unwrap().working_bank();
                         working_bank.print_accounts_stats();
                     }
+                    if print_bank_hash {
+                        println!(
+                            "Bank hash for slot {}: {}",
+                            working_bank.slot(),
+                            working_bank.hash()
+                        );
+                    }
                     if write_bank_file {
-                        let working_bank = bank_forks.read().unwrap().working_bank();
                         bank_hash_details::write_bank_hash_details_file(&working_bank)
                             .map_err(|err| {
                                 warn!("Unable to write bank hash_details file: {err}");