brk_computer 0.3.0-beta.6

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

use brk_error::Result;
use brk_traversable::Traversable;
use brk_types::{Height, Sats, StoredU64, Version};
use vecdb::{AnyStoredVec, Database, Exit, ReadableVec, Rw, StorageMode, WritableVec};

use crate::{indexes, internal::ValuePerBlock, prices};

/// Average amount held per UTXO and per funded address.
///
/// `utxo = supply / utxo_count`, `addr = supply / funded_addr_count`.
#[derive(Traversable)]
pub struct AvgAmountMetrics<M: StorageMode = Rw> {
    pub utxo: ValuePerBlock<M>,
    pub addr: ValuePerBlock<M>,
}

impl AvgAmountMetrics {
    pub(crate) fn forced_import(
        db: &Database,
        prefix: &str,
        version: Version,
        indexes: &indexes::Vecs,
    ) -> Result<Self> {
        let name = |suffix: &str| {
            if prefix.is_empty() {
                suffix.to_string()
            } else {
                format!("{prefix}_{suffix}")
            }
        };
        Ok(Self {
            utxo: ValuePerBlock::forced_import(db, &name("avg_utxo_amount"), version, indexes)?,
            addr: ValuePerBlock::forced_import(db, &name("avg_addr_amount"), version, indexes)?,
        })
    }

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

    pub(crate) fn reset_height(&mut self) -> Result<()> {
        self.utxo.sats.height.reset()?;
        self.utxo.cents.height.reset()?;
        self.addr.sats.height.reset()?;
        self.addr.cents.height.reset()?;
        Ok(())
    }

    pub(crate) fn compute(
        &mut self,
        prices: &prices::Vecs,
        supply_sats: &impl ReadableVec<Height, Sats>,
        utxo_count: &impl ReadableVec<Height, StoredU64>,
        funded_addr_count: &impl ReadableVec<Height, StoredU64>,
        max_from: Height,
        exit: &Exit,
    ) -> Result<()> {
        self.utxo
            .sats
            .height
            .compute_divide(max_from, supply_sats, utxo_count, exit)?;
        self.utxo.compute(prices, max_from, exit)?;

        self.addr
            .sats
            .height
            .compute_divide(max_from, supply_sats, funded_addr_count, exit)?;
        self.addr.compute(prices, max_from, exit)?;

        Ok(())
    }
}