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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use brk_types::{Cents, Sats, StoredF64};
use vecdb::unlikely;

pub(crate) mod coinflow;
pub(crate) mod cointime;
mod compute;
mod import;
mod vecs;

pub use vecs::Vecs;

pub const DB_NAME: &str = "frameworks";

#[derive(Clone, Copy, Default)]
pub(crate) struct WeightedRatio {
    numerator: f64,
    denominator: f64,
}

impl WeightedRatio {
    #[inline]
    pub(crate) fn add(&mut self, numerator: f64, denominator: f64, weight: f64) {
        if weight.is_finite() && weight > 0.0 {
            self.numerator += numerator * weight;
            self.denominator += denominator * weight;
        }
    }

    #[inline]
    pub(crate) fn merge(&mut self, other: Self) {
        self.numerator += other.numerator;
        self.denominator += other.denominator;
    }

    #[inline]
    pub(crate) fn value(&self) -> StoredF64 {
        if self.denominator > 0.0 {
            StoredF64::from((self.numerator / self.denominator).clamp(0.0, 1.0))
        } else {
            StoredF64::NAN
        }
    }
}

#[derive(Clone, Copy)]
pub(crate) struct WeightedCohortContribution {
    pub weighted_supply: Sats,
    pub complement_supply: Sats,
    pub weighted_cap: Cents,
}

#[derive(Clone, Copy, Default)]
pub(crate) struct WeightedCohortState {
    pub weighted_supply: Sats,
    pub complement_supply: Sats,
    pub weighted_cap: Cents,
    pub supply_in_loss: WeightedRatio,
}

impl WeightedCohortState {
    #[inline]
    pub(crate) fn add(
        &mut self,
        total_supply: Sats,
        loss_supply: Sats,
        total_cap: Cents,
        weight: StoredF64,
    ) -> WeightedCohortContribution {
        let contribution = WeightedCohortContribution {
            weighted_supply: weight * total_supply,
            complement_supply: (StoredF64::from(1.0) - weight) * total_supply,
            weighted_cap: if total_supply.is_zero() {
                Cents::ZERO
            } else {
                weight * total_cap
            },
        };

        self.weighted_supply += contribution.weighted_supply;
        self.complement_supply += contribution.complement_supply;
        self.weighted_cap += contribution.weighted_cap;
        self.supply_in_loss.add(
            loss_supply.as_u128() as f64,
            total_supply.as_u128() as f64,
            f64::from(weight),
        );

        contribution
    }

    #[inline]
    pub(crate) fn merged(mut self, other: Self) -> Self {
        self.weighted_supply += other.weighted_supply;
        self.complement_supply += other.complement_supply;
        self.weighted_cap += other.weighted_cap;
        self.supply_in_loss.merge(other.supply_in_loss);
        self
    }
}

#[inline]
pub(crate) fn realized_price(cap: Cents, supply: Sats) -> Cents {
    if unlikely(cap.is_nan()) {
        return Cents::NAN;
    }

    (cap.as_u128() * Sats::ONE_BTC_U128)
        .checked_div(supply.as_u128())
        .map(Cents::from)
        .unwrap_or(Cents::ZERO)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn empty_nan_cap_contributes_zero() {
        let mut state = WeightedCohortState::default();

        let contribution = state.add(Sats::ZERO, Sats::ZERO, Cents::NAN, StoredF64::from(0.5));

        assert_eq!(contribution.weighted_cap, Cents::ZERO);
        assert_eq!(state.weighted_cap, Cents::ZERO);
        assert_eq!(
            realized_price(state.weighted_cap, state.weighted_supply),
            Cents::ZERO
        );
    }

    #[test]
    fn nonempty_nan_cap_remains_nan() {
        let mut state = WeightedCohortState::default();

        state.add(
            Sats::from(100_u64),
            Sats::ZERO,
            Cents::NAN,
            StoredF64::from(0.5),
        );

        assert!(state.weighted_cap.is_nan());
        assert!(realized_price(state.weighted_cap, state.weighted_supply).is_nan());
    }
}