zebra-state 5.0.0

State contextual verification and storage code for Zebra
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

//! An implementation of [`DiskFormatUpgrade`] for marking the database as upgraded to a new format version.

use crossbeam_channel::Receiver;

use semver::Version;
use zebra_chain::block::Height;

use crate::service::finalized_state::ZebraDb;

use super::{CancelFormatChange, DiskFormatUpgrade};

/// Implements [`DiskFormatUpgrade`] for in-place upgrades that do not involve any migration
/// of existing data into the new format.
pub struct NoMigration {
    description: &'static str,
    version: Version,
}

impl NoMigration {
    /// Creates a new instance of the [`NoMigration`] upgrade.
    pub fn new(description: &'static str, version: Version) -> Self {
        Self {
            description,
            version,
        }
    }
}

impl DiskFormatUpgrade for NoMigration {
    fn version(&self) -> Version {
        self.version.clone()
    }

    fn description(&self) -> &'static str {
        self.description
    }

    #[allow(clippy::unwrap_in_result)]
    fn run(
        &self,
        _initial_tip_height: Height,
        _db: &ZebraDb,
        _cancel_receiver: &Receiver<CancelFormatChange>,
    ) -> Result<(), CancelFormatChange> {
        Ok(())
    }

    fn needs_migration(&self) -> bool {
        false
    }
}