brk_state 0.0.71

Various states used in the Bitcoin Research Kit
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

use std::cmp::Ordering;

use brk_core::{CheckedSub, Dollars};

use super::SupplyState;

#[derive(Debug, Default, Clone)]
pub struct RealizedState {
    pub cap: Dollars,
    pub profit: Dollars,
    pub loss: Dollars,
    pub value_created: Dollars,
    pub adj_value_created: Dollars,
    pub value_destroyed: Dollars,
    pub adj_value_destroyed: Dollars,
}

impl RealizedState {
    pub const NAN: Self = Self {
        cap: Dollars::NAN,
        profit: Dollars::NAN,
        loss: Dollars::NAN,
        value_created: Dollars::NAN,
        adj_value_created: Dollars::NAN,
        value_destroyed: Dollars::NAN,
        adj_value_destroyed: Dollars::NAN,
    };

    pub fn reset_single_iteration_values(&mut self) {
        if self.cap != Dollars::NAN {
            self.profit = Dollars::ZERO;
            self.loss = Dollars::ZERO;
            self.value_created = Dollars::ZERO;
            self.adj_value_created = Dollars::ZERO;
            self.value_destroyed = Dollars::ZERO;
            self.adj_value_destroyed = Dollars::ZERO;
        }
    }

    pub fn increment(&mut self, supply_state: &SupplyState, price: Dollars) {
        if supply_state.value.is_zero() {
            return;
        }

        if self.cap == Dollars::NAN {
            self.cap = Dollars::ZERO;
            self.profit = Dollars::ZERO;
            self.loss = Dollars::ZERO;
            self.value_created = Dollars::ZERO;
            self.adj_value_created = Dollars::ZERO;
            self.value_destroyed = Dollars::ZERO;
            self.adj_value_destroyed = Dollars::ZERO;
        }

        let value = price * supply_state.value;
        self.cap += value;
    }

    pub fn decrement(&mut self, supply_state: &SupplyState, price: Dollars) {
        let value = price * supply_state.value;
        self.cap = self.cap.checked_sub(value).unwrap();
    }

    pub fn receive(&mut self, supply_state: &SupplyState, current_price: Dollars) {
        self.increment(supply_state, current_price);
    }

    pub fn send(
        &mut self,
        supply_state: &SupplyState,
        current_price: Dollars,
        prev_price: Dollars,
        older_than_hour: bool,
    ) {
        let current_value = current_price * supply_state.value;
        let prev_value = prev_price * supply_state.value;

        self.value_created += current_value;
        self.value_destroyed += prev_value;

        if older_than_hour {
            self.adj_value_created += current_value;
            self.adj_value_destroyed += prev_value;
        }

        match current_price.cmp(&prev_price) {
            Ordering::Greater => {
                self.profit += current_value.checked_sub(prev_value).unwrap();
            }
            Ordering::Less => {
                self.loss += prev_value.checked_sub(current_value).unwrap();
            }
            Ordering::Equal => {}
        }

        self.decrement(supply_state, prev_price);
    }
}