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

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

use crate::utils::multihash::MultihashCode;
use crate::{
    blocks::TipsetKey,
    db::{EthBlockBloomStore, EthMappingsStore, SettingsStore, SettingsStoreExt as _},
};
use cid::Cid;
use fvm_ipld_encoding::DAG_CBOR;
use multihash_derive::MultihashDigest;

pub fn write_bin<DB>(db: &DB)
where
    DB: SettingsStore,
{
    let key = "1";
    let value = [1];
    db.write_bin(key, &value).unwrap();
}

pub fn read_bin<DB>(db: &DB)
where
    DB: SettingsStore,
{
    let key = "0";
    let value = [1];
    db.write_bin(key, &value).unwrap();
    let res = db.read_bin(key).unwrap().unwrap();
    assert_eq!(value.as_ref(), res.as_slice());
}

pub fn write_read_obj<DB>(db: &DB)
where
    DB: SettingsStore,
{
    let key = "Cthulhu";
    let value = 42;
    db.write_obj(key, &value).unwrap();
    let res: i32 = db.read_obj(key).unwrap().unwrap();
    assert_eq!(value, res);

    // ensure that we are able to overwrite the value.
    // this is to ensure we don't enable settings such as
    // `preimage` for the settings column which would
    // assume that the value is immutable.
    let value = 1337;
    db.write_obj(key, &value).unwrap();
    let res: i32 = db.read_obj(key).unwrap().unwrap();
    assert_eq!(value, res);
}

pub fn exists<DB>(db: &DB)
where
    DB: SettingsStore,
{
    let key = "0";
    let value = [1];
    db.write_bin(key, &value).unwrap();
    let res = db.exists(key).unwrap();
    assert!(res);
}

pub fn does_not_exist<DB>(db: &DB)
where
    DB: SettingsStore,
{
    let key = "Azathoth";

    assert!(!db.exists(key).unwrap());
    assert!(db.read_obj::<i32>(key).unwrap().is_none());
    assert!(db.require_obj::<i32>(key).is_err());
}

pub fn tipset_lookup_read_write_delete<DB>(db: &DB)
where
    DB: EthMappingsStore,
{
    let tsk = TipsetKey::from(nunny::vec![Cid::default()]);
    let epoch = 0;

    // read from empty db should fail
    assert_eq!(db.tipset_key_by_epoch(epoch).unwrap(), None);

    // write should succeed
    db.set_tipset_key_at_epoch_raw(epoch, &tsk).unwrap();

    // read after write should succeed
    assert_eq!(db.tipset_key_by_epoch(epoch).unwrap().as_ref(), Some(&tsk));

    // delete should succed
    db.delete_tipset_key_at_epoch(epoch).unwrap();

    // read after delete from empty db should fail
    assert_eq!(db.tipset_key_by_epoch(epoch).unwrap(), None);

    // delete again should succed
    db.delete_tipset_key_at_epoch(epoch).unwrap();
}

pub fn block_bloom_prune<DB>(db: &DB)
where
    DB: EthBlockBloomStore,
{
    let a = Cid::new_v1(DAG_CBOR, MultihashCode::Blake2b256.digest(b"a"));
    let b = Cid::new_v1(DAG_CBOR, MultihashCode::Blake2b256.digest(b"b"));
    let missing = Cid::new_v1(DAG_CBOR, MultihashCode::Blake2b256.digest(b"missing"));
    let bloom_a = [0x11; 256];
    let bloom_b = [0x22; 256];

    db.write_bloom(&a, 100, &bloom_a).unwrap();
    db.write_bloom(&b, 200, &bloom_b).unwrap();
    assert_eq!(db.read_bloom(&a).unwrap(), Some(bloom_a));
    assert_eq!(db.read_bloom(&b).unwrap(), Some(bloom_b));
    assert_eq!(db.read_bloom(&missing).unwrap(), None);

    // Only entries at or above the cutoff survive.
    db.delete_blooms_before_height(150).unwrap();
    assert_eq!(db.read_bloom(&a).unwrap(), None);
    assert_eq!(db.read_bloom(&b).unwrap(), Some(bloom_b));
}