brk_computer 0.11.2

A Bitcoin dataset computer built on top of brk_indexer
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

use brk_error::Result;
use brk_indexer::Lengths;
use brk_traversable::Traversable;
use brk_types::{PartsPerMillionSigned64, StoredI64, StoredU64, Version};
use derive_more::{Deref, DerefMut};
use vecdb::{AnyStoredVec, AnyVec, Exit, Rw, StorageMode, WritableVec};

use crate::{
    distribution::{
        metrics::ImportConfig,
        state::{CohortState, CostBasisOps, RealizedOps},
    },
    internal::{PerBlockCumulativeRolling, PerBlockWithDeltas},
};

/// Unspent output metrics.
#[derive(Traversable)]
pub struct OutputsUnspent<M: StorageMode = Rw> {
    pub unspent_count: PerBlockWithDeltas<StoredU64, StoredI64, PartsPerMillionSigned64, M>,
}

impl OutputsUnspent {
    pub(crate) fn forced_import(cfg: &ImportConfig) -> Result<Self> {
        Ok(Self {
            unspent_count: PerBlockWithDeltas::forced_import(
                cfg.db,
                &cfg.name("utxo_count"),
                cfg.version,
                Version::TWO,
                cfg.indexes,
                cfg.cached_starts,
            )?,
        })
    }

    pub(crate) fn min_len(&self) -> usize {
        self.unspent_count.height.len()
    }

    #[inline(always)]
    pub(crate) fn push_state(&mut self, state: &CohortState<impl RealizedOps, impl CostBasisOps>) {
        self.unspent_count
            .height
            .push(StoredU64::from(state.supply.utxo_count));
    }

    pub(crate) fn collect_vecs_mut(&mut self) -> Vec<&mut dyn AnyStoredVec> {
        vec![&mut self.unspent_count.height as &mut dyn AnyStoredVec]
    }

    pub(crate) fn compute_from_stateful(
        &mut self,
        starting_lengths: &Lengths,
        others: &[&Self],
        exit: &Exit,
    ) -> Result<()> {
        self.unspent_count.height.compute_sum_of_others(
            starting_lengths.height,
            &others
                .iter()
                .map(|v| &v.unspent_count.height)
                .collect::<Vec<_>>(),
            exit,
        )?;
        Ok(())
    }
}

/// Base output metrics: unspent and spent output counts.
#[derive(Deref, DerefMut, Traversable)]
pub struct OutputsBase<M: StorageMode = Rw> {
    #[deref]
    #[deref_mut]
    #[traversable(flatten)]
    pub unspent: OutputsUnspent<M>,
    pub spent_count: PerBlockCumulativeRolling<StoredU64, M>,
}

impl OutputsBase {
    pub(crate) fn forced_import(cfg: &ImportConfig) -> Result<Self> {
        let v1 = Version::ONE;
        Ok(Self {
            unspent: OutputsUnspent::forced_import(cfg)?,
            spent_count: cfg.import("spent_utxo_count", v1)?,
        })
    }

    pub(crate) fn min_len(&self) -> usize {
        self.unspent.min_len().min(self.spent_count.block.len())
    }

    #[inline(always)]
    pub(crate) fn push_state(&mut self, state: &CohortState<impl RealizedOps, impl CostBasisOps>) {
        self.unspent.push_state(state);
        self.spent_count
            .push_block(StoredU64::from(state.spent_utxo_count));
    }

    pub(crate) fn collect_vecs_mut(&mut self) -> Vec<&mut dyn AnyStoredVec> {
        let mut vecs = self.unspent.collect_vecs_mut();
        vecs.push(self.spent_count.stored_mut());
        vecs
    }

    pub(crate) fn compute_from_stateful(
        &mut self,
        starting_lengths: &Lengths,
        others: &[&Self],
        exit: &Exit,
    ) -> Result<()> {
        let unspent: Vec<_> = others.iter().map(|v| &v.unspent).collect();
        self.unspent
            .compute_from_stateful(starting_lengths, &unspent, exit)?;
        sum_others!(self, starting_lengths, others, exit; spent_count.cumulative.height);
        Ok(())
    }
}