feat(ui): Add a terminal-based progress bar to Zebra (#6235)

* Implement Display and to_string() for NetworkUpgrade * Add a progress-bar feature to zebrad * Add the progress bar writer to the tracing component * Add a block progress bar transmitter * Correctly shut down the progress bar, and shut it down on an interrupt * Make it clearer that the progress task never exits * Add a config for writing logs to a file * Add a progress-bar feature to zebra-network * Add a progress bar for the address book size * Add progress bars for never attempted and failed peers * Add an optional limit and label to connection counters * Add open connection progress bars * Improve CheckpointList API and CheckpointVerifier debugging * Add checkpoint index and checkpoint queue progress bars * Security: Limit the number of non-finalized chains tracked by Zebra * Make some NonFinalizedState methods available with proptest-impl * Add a non-finalized chain count progress bar * Track the last fork height for newly forked chains * Add a should_count_metrics to Chain * Add a display method for PartialCumulativeWork * Add a progress bar for each chain fork * Add a NonFinalizedState::disable_metrics() method and switch to using it * Move metrics out of Chain because we can't update Arc<Chain> * Fix: consistently use best chain order when searching chains * Track Chain progress bars in NonFinalizedState * Display work as bits, not a multiple of the target difficulty * Handle negative fork lengths by reporting "No fork" * Correctly disable unused fork bars * clippy: rewrite using `match _.cmp(_) { ... }` * Initial mempool progress bar implementation * Update Cargo.lock * Add the actual transaction size as a description to the cost bar * Only show mempool progress bars after first activation * Add queued and rejected mempool progress bars * Clarify cost note is actual size * Add tracing.log_file config and progress-bar feature to zebrad docs * Derive Clone for Chain * Upgrade to howudoin 0.1.2 and remove some bug workarounds * Directly call the debug formatter to Display a Network Co-authored-by: Arya <[email protected]> * Rename the address count metric to num_addresses Co-authored-by: Arya <[email protected]> * Simplify reverse checkpoint lookup Co-authored-by: Arya <[email protected]> * Simplify progress bar shutdown code Co-authored-by: Arya <[email protected]> * Remove unused MIN_TRANSPARENT_TX_MEMPOOL_SIZE * Document that the progress task runs forever * Fix progress log formatting * If progress-bar is on, log to a file by default * Create missing directories for log files * Add file security docs for running Zebra with elevated permissions * Document automatic log file, spell progress-bar correctly --------- Co-authored-by: Arya <[email protected]>
ZcashFoundation · Apr 13, 2023 · 166526a · 166526a
1 parent 804b635
commit 166526a
Show file tree

Hide file tree

Showing 32 changed files with 1,149 additions and 87 deletions.
diff --git a/Cargo.lock b/Cargo.lock
@@ -806,6 +806,7 @@ dependencies = [
  "encode_unicode",
  "lazy_static",
  "libc",
+ "unicode-width",
  "windows-sys 0.42.0",
 ]
 
@@ -1456,6 +1457,19 @@ dependencies = [
  "miniz_oxide",
 ]
 
+[[package]]
+name = "flume"
+version = "0.10.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1657b4441c3403d9f7b3409e47575237dac27b1b5726df654a6ecbf92f0f7577"
+dependencies = [
+ "futures-core",
+ "futures-sink",
+ "nanorand",
+ "pin-project",
+ "spin 0.9.7",
+]
+
 [[package]]
 name = "fnv"
 version = "1.0.7"
@@ -1632,8 +1646,10 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c05aeb6a22b8f62540c194aac980f2115af067bfe15a0734d7277a768d396b31"
 dependencies = [
  "cfg-if 1.0.0",
+ "js-sys",
  "libc",
  "wasi 0.11.0+wasi-snapshot-preview1",
+ "wasm-bindgen",
 ]
 
 [[package]]
@@ -1890,6 +1906,17 @@ dependencies = [
  "winapi",
 ]
 
+[[package]]
+name = "howudoin"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f34059280f617a59ee59a0455e93460d67e5c76dec42dd262d38f0f390f437b2"
+dependencies = [
+ "flume",
+ "indicatif",
+ "parking_lot 0.12.1",
+]
+
 [[package]]
 name = "http"
 version = "0.2.9"
@@ -2088,6 +2115,18 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "indicatif"
+version = "0.17.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cef509aa9bc73864d6756f0d34d35504af3cf0844373afe9b8669a5b8005a729"
+dependencies = [
+ "console",
+ "number_prefix",
+ "portable-atomic",
+ "unicode-width",
+]
+
 [[package]]
 name = "inferno"
 version = "0.11.15"
@@ -2604,6 +2643,15 @@ version = "0.8.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e5ce46fe64a9d73be07dcbe690a38ce1b293be448fd8ce1e6c1b8062c9f72c6a"
 
+[[package]]
+name = "nanorand"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a51313c5820b0b02bd422f4b44776fbf47961755c74ce64afc73bfad10226c3"
+dependencies = [
+ "getrandom 0.2.8",
+]
+
 [[package]]
 name = "native-tls"
 version = "0.2.11"
@@ -2710,6 +2758,12 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "number_prefix"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830b246a0e5f20af87141b25c173cd1b609bd7779a4617d6ec582abaf90870f3"
+
 [[package]]
 name = "object"
 version = "0.30.3"
@@ -3676,7 +3730,7 @@ dependencies = [
  "cc",
  "libc",
  "once_cell",
- "spin",
+ "spin 0.5.2",
  "untrusted",
  "web-sys",
  "winapi",
@@ -4273,6 +4327,15 @@ version = "0.5.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
 
+[[package]]
+name = "spin"
+version = "0.9.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c0959fd6f767df20b231736396e4f602171e00d95205676286e79d4a4eb67bef"
+dependencies = [
+ "lock_api",
+]
+
 [[package]]
 name = "stable_deref_trait"
 version = "1.2.0"
@@ -5732,6 +5795,7 @@ dependencies = [
  "futures-util",
  "halo2_proofs",
  "hex",
+ "howudoin",
  "jubjub 0.9.0",
  "lazy_static",
  "metrics",
@@ -5771,6 +5835,7 @@ dependencies = [
  "chrono",
  "futures",
  "hex",
+ "howudoin",
  "humantime-serde",
  "indexmap",
  "lazy_static",
@@ -5861,6 +5926,7 @@ dependencies = [
  "futures",
  "halo2_proofs",
  "hex",
+ "howudoin",
  "indexmap",
  "insta",
  "itertools",
@@ -5948,9 +6014,11 @@ dependencies = [
  "futures",
  "gumdrop",
  "hex",
+ "howudoin",
  "humantime-serde",
  "hyper",
  "indexmap",
+ "indicatif",
  "inferno",
  "jsonrpc-core",
  "lazy_static",

diff --git a/zebra-chain/src/parameters/network_upgrade.rs b/zebra-chain/src/parameters/network_upgrade.rs
@@ -50,6 +50,13 @@ pub enum NetworkUpgrade {
     Nu5,
 }
 
+impl fmt::Display for NetworkUpgrade {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        // Same as the debug representation for now
+        fmt::Debug::fmt(self, f)
+    }
+}
+
 /// Mainnet network upgrade activation heights.
 ///
 /// This is actually a bijective map, but it is const, so we use a vector, and

diff --git a/zebra-chain/src/transaction.rs b/zebra-chain/src/transaction.rs
@@ -29,9 +29,12 @@ pub use joinsplit::JoinSplitData;
 pub use lock_time::LockTime;
 pub use memo::Memo;
 pub use sapling::FieldNotPresent;
-pub use serialize::SerializedTransaction;
+pub use serialize::{
+    SerializedTransaction, MIN_TRANSPARENT_TX_SIZE, MIN_TRANSPARENT_TX_V4_SIZE,
+    MIN_TRANSPARENT_TX_V5_SIZE,
+};
 pub use sighash::{HashType, SigHash};
-pub use unmined::{UnminedTx, UnminedTxId, VerifiedUnminedTx};
+pub use unmined::{UnminedTx, UnminedTxId, VerifiedUnminedTx, MEMPOOL_TRANSACTION_COST_THRESHOLD};
 
 use crate::{
     amount::{Amount, Error as AmountError, NegativeAllowed, NonNegative},

diff --git a/zebra-chain/src/transaction/serialize.rs b/zebra-chain/src/transaction/serialize.rs
@@ -962,9 +962,19 @@ pub(crate) const MIN_TRANSPARENT_OUTPUT_SIZE: u64 = 8 + 1;
 ///
 /// Shielded transfers are much larger than transparent transfers,
 /// so this is the minimum transaction size.
-pub(crate) const MIN_TRANSPARENT_TX_SIZE: u64 =
+pub const MIN_TRANSPARENT_TX_SIZE: u64 =
     MIN_TRANSPARENT_INPUT_SIZE + 4 + MIN_TRANSPARENT_OUTPUT_SIZE;
 
+/// The minimum transaction size for v4 transactions.
+///
+/// v4 transactions also have an expiry height.
+pub const MIN_TRANSPARENT_TX_V4_SIZE: u64 = MIN_TRANSPARENT_TX_SIZE + 4;
+
+/// The minimum transaction size for v5 transactions.
+///
+/// v5 transactions also have an expiry height and a consensus branch ID.
+pub const MIN_TRANSPARENT_TX_V5_SIZE: u64 = MIN_TRANSPARENT_TX_SIZE + 4 + 4;
+
 /// No valid Zcash message contains more transactions than can fit in a single block
 ///
 /// `tx` messages contain a single transaction, and `block` messages are limited to the maximum

diff --git a/zebra-chain/src/transaction/unmined.rs b/zebra-chain/src/transaction/unmined.rs
@@ -54,7 +54,7 @@ mod zip317;
 /// > transparent transactions because of their size.
 ///
 /// [ZIP-401]: https://zips.z.cash/zip-0401
-const MEMPOOL_TRANSACTION_COST_THRESHOLD: u64 = 4000;
+pub const MEMPOOL_TRANSACTION_COST_THRESHOLD: u64 = 4000;
 
 /// When a transaction pays a fee less than the conventional fee,
 /// this low fee penalty is added to its cost for mempool eviction.

diff --git a/zebra-chain/src/work/difficulty.rs b/zebra-chain/src/work/difficulty.rs
@@ -664,6 +664,34 @@ impl PartialCumulativeWork {
     pub fn as_u128(self) -> u128 {
         self.0
     }
+
+    /// Returns a floating-point work multiplier that can be used for display.
+    /// The returned value is the work as a multiple of the target difficulty limit for `network`.
+    pub fn difficulty_multiplier_for_display(&self, network: Network) -> f64 {
+        // This calculation is similar to the `getdifficulty` RPC, see that code for details.
+
+        let pow_limit = ExpandedDifficulty::target_difficulty_limit(network)
+            .to_compact()
+            .to_work()
+            .expect("target difficult limit is valid work");
+
+        // Convert to u128 then f64.
+        let pow_limit = pow_limit.as_u128() as f64;
+        let work = self.as_u128() as f64;
+
+        work / pow_limit
+    }
+
+    /// Returns floating-point work bits that can be used for display.
+    /// The returned value is the number of hash bits represented by the work.
+    pub fn difficulty_bits_for_display(&self) -> f64 {
+        // This calculation is similar to `zcashd`'s bits display in its logs.
+
+        // Convert to u128 then f64.
+        let work = self.as_u128() as f64;
+
+        work.log2()
+    }
 }
 
 impl From<Work> for PartialCumulativeWork {

diff --git a/zebra-consensus/Cargo.toml b/zebra-consensus/Cargo.toml
@@ -10,6 +10,11 @@ default = []
 
 # Production features that activate extra dependencies, or extra features in dependencies
 
+progress-bar = [
+    "howudoin",
+    "zebra-state/progress-bar",
+]
+
 # Experimental mining RPC support
 getblocktemplate-rpcs = [
      "zebra-state/getblocktemplate-rpcs",
@@ -56,6 +61,9 @@ zebra-state = { path = "../zebra-state" }
 zebra-node-services = { path = "../zebra-node-services" }
 zebra-chain = { path = "../zebra-chain" }
 
+# prod feature progress-bar
+howudoin = { version = "0.1.2", optional = true }
+
 # Test-only dependencies
 proptest = { version = "1.1.0", optional = true }
 proptest-derive = { version = "0.3.0", optional = true }