zakura 1.0.0

Zakura, an independent, consensus-compatible implementation of a Zcash node
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! `prune-state` subcommand - prune finalized raw transaction data on disk.

use std::path::PathBuf;

use abscissa_core::{Application, Command, Runnable};
use clap::Parser;
use color_eyre::eyre::Result;

use zakura_chain::parameters::Network;
use zakura_state::{PruneFinalizedStateOptions, PruneFinalizedStateSummary};

use crate::prelude::APPLICATION;

/// Prune historical raw transaction data from Zebra's finalized state
#[derive(Command, Debug, Default, Parser)]
pub struct PruneStateCmd {
    /// Number of recent finalized blocks below the tip whose raw transaction data is retained.
    #[clap(long, help = "recent finalized blocks below the tip to keep")]
    tx_retention: u32,

    /// Path to Zebra's cached state.
    ///
    /// The `zakurad prune-state` subcommand defaults to `state.cache_dir` from the loaded
    /// `zakura.toml`, while the standalone `zakura-prune-state` binary defaults to
    /// `zakura_state::Config::default()`. Pass `--cache-dir` to be explicit and avoid pruning the
    /// wrong (or an empty) state directory.
    #[clap(long, short, help = "path to directory with the Zebra chain state")]
    cache_dir: Option<PathBuf>,

    /// The network of the chain to prune.
    #[clap(
        long,
        short,
        required = true,
        help = "the network of the chain to load"
    )]
    network: Network,

    /// Actually prune the database. Without this flag, the command only previews the plan.
    #[clap(long, help = "apply the pruning plan instead of only previewing it")]
    confirm: bool,
}

impl Runnable for PruneStateCmd {
    /// `prune-state` sub-command entrypoint.
    fn run(&self) {
        let config = APPLICATION.config();

        if let Err(error) = self.run_with_config(config.state.clone()) {
            tracing::error!("Failed to prune finalized state: {error}");
            // Exit non-zero so scripts can detect failures.
            std::process::exit(1);
        }
    }
}

impl PruneStateCmd {
    /// Runs pruning using `state_config` as the base state configuration.
    #[allow(clippy::print_stdout)]
    pub fn run_with_config(&self, mut state_config: zakura_state::Config) -> Result<()> {
        if let Some(cache_dir) = self.cache_dir.clone() {
            state_config.cache_dir = cache_dir;
        }

        let options = PruneFinalizedStateOptions {
            tx_retention: self.tx_retention,
        };

        if self.confirm {
            let summary =
                zakura_state::prune_finalized_state(state_config, &self.network, options)?;
            print_summary("pruning complete", &summary);
        } else {
            let preview =
                zakura_state::preview_prune_finalized_state(state_config, &self.network, options)?;
            print_summary("pruning plan", &preview);
            println!("  no changes written: pass --confirm to apply this plan");
        }

        Ok(())
    }
}

#[allow(clippy::print_stdout)]
fn print_summary(label: &str, summary: &PruneFinalizedStateSummary) {
    println!("{label}:");
    println!(
        "  finalized tip: height {}, hash {}",
        summary.tip.0 .0, summary.tip.1
    );
    println!("  tx retention: {} blocks", summary.tx_retention);
    println!(
        "  previous lowest retained height: {}",
        optional_height(summary.previous_lowest_retained_height)
    );
    println!(
        "  new lowest retained height: {}",
        optional_height(summary.new_lowest_retained_height)
    );

    if summary.pruned_height_ranges.is_empty() {
        println!("  pruned height ranges: none");
    } else {
        println!(
            "  pruned height ranges: {} ({} heights)",
            summary.pruned_height_ranges.len(),
            summary.pruned_height_count
        );

        for (from, until) in &summary.pruned_height_ranges {
            println!("    [{}..{})", from.0, until.0);
        }
    }

    if let Some((from, until)) = summary.compacted_height_range {
        println!("  compacted raw tx range: [{}..{})", from.0, until.0);
    } else {
        println!("  compacted raw tx range: none");
    }
}

fn optional_height(height: Option<zakura_chain::block::Height>) -> String {
    height.map_or_else(|| "none".to_string(), |height| height.0.to_string())
}