forest-filecoin 0.34.1

Rust Filecoin implementation.
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

// Copyright 2019-2026 ChainSafe Systems
// SPDX-License-Identifier: Apache-2.0, MIT

//! Migration logic for databases with the v0.34.0 schema to v0.34.1.
//! An `EthBlockBloom` column has been added to store per-tipset Ethereum block logs blooms.

use super::migration_map::MigrationOperation;
use crate::Config;
use crate::db::migration::migration_map::MigrationOperationExt as _;
use anyhow::Context;
use semver::Version;
use std::path::{Path, PathBuf};
use tracing::info;

pub(super) struct Migration0_34_0_0_34_1 {
    from: Version,
    to: Version,
}

/// Migrates the database from version 0.34.0 to 0.34.1
impl MigrationOperation for Migration0_34_0_0_34_1 {
    fn new(from: Version, to: Version) -> Self
    where
        Self: Sized,
    {
        Self { from, to }
    }

    fn from(&self) -> &Version {
        &self.from
    }

    fn to(&self) -> &Version {
        &self.to
    }

    fn migrate_core(&self, chain_data_path: &Path, _: &Config) -> anyhow::Result<PathBuf> {
        let old_db = self.old_db_path(chain_data_path);
        let temp_db = self.temporary_db_path(chain_data_path);

        info!(
            "Renaming database directory from {} to {}",
            old_db.display(),
            temp_db.display()
        );
        std::fs::rename(&old_db, &temp_db).context("failed to rename database directory")?;

        info!("Adding EthBlockBloom column to database");
        let mut opts = paritydb_0_34_0::to_options(temp_db.clone());
        if let Err(e) =
            parity_db::Db::add_column(&mut opts, paritydb_0_34_0::eth_block_bloom_column_options())
        {
            // Restore the original database so a failed migration never strands the only copy in temp.
            if let Err(restore) = std::fs::rename(&temp_db, &old_db) {
                tracing::error!(
                    "failed to restore database to {}; data is preserved at {}: {restore}",
                    old_db.display(),
                    temp_db.display()
                );
            }
            return Err(e).context("failed to add EthBlockBloom column");
        }

        // Create a placeholder so the delete step in `migrate` succeeds.
        std::fs::create_dir_all(&old_db).context("failed to create placeholder directory")?;

        info!("Migration completed successfully");
        Ok(temp_db)
    }
}

/// Database settings from Forest `v0.34.0`
mod paritydb_0_34_0 {
    use parity_db::{ColumnOptions, CompressionType, Options};
    use std::path::PathBuf;
    use strum::{Display, EnumIter, IntoEnumIterator};

    #[derive(Copy, Clone, Debug, PartialEq, EnumIter, Display)]
    #[repr(u8)]
    pub(super) enum DbColumn {
        GraphDagCborBlake2b256,
        GraphFull,
        Settings,
        EthMappings,
        PersistentGraph,
    }

    impl DbColumn {
        fn create_column_options(compression: CompressionType) -> Vec<ColumnOptions> {
            DbColumn::iter()
                .map(|col| match col {
                    DbColumn::GraphDagCborBlake2b256 | DbColumn::PersistentGraph => ColumnOptions {
                        preimage: true,
                        compression,
                        ..Default::default()
                    },
                    DbColumn::GraphFull => ColumnOptions {
                        preimage: true,
                        btree_index: true,
                        compression,
                        ..Default::default()
                    },
                    DbColumn::Settings => ColumnOptions {
                        preimage: false,
                        btree_index: true,
                        compression,
                        ..Default::default()
                    },
                    DbColumn::EthMappings => ColumnOptions {
                        preimage: false,
                        btree_index: false,
                        compression,
                        ..Default::default()
                    },
                })
                .collect()
        }
    }

    /// Options for the `EthBlockBloom` column introduced in v0.34.1.
    pub(super) fn eth_block_bloom_column_options() -> ColumnOptions {
        ColumnOptions {
            preimage: false,
            btree_index: true,
            compression: CompressionType::Lz4,
            ..Default::default()
        }
    }

    pub(super) fn to_options(path: PathBuf) -> Options {
        Options {
            path,
            sync_wal: true,
            sync_data: true,
            stats: false,
            salt: None,
            columns: DbColumn::create_column_options(CompressionType::Lz4),
            compression_threshold: [(0, 128)].into_iter().collect(),
        }
    }
}