brk_query 0.3.0-beta.2

An interface to find and format data from BRK
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::{fs, path::PathBuf};

use brk_error::{Error, Result};
use brk_types::{
    CostBasisBucket, CostBasisDistribution, CostBasisFormatted, CostBasisValue, Date, Day1,
};
use vecdb::ReadableOptionVec;

use crate::Query;

impl Query {
    /// List available cohorts for cost basis distribution.
    pub fn cost_basis_cohorts(&self) -> Result<Vec<String>> {
        let states_path = &self.computer().distribution.states_path;

        let mut cohorts: Vec<String> = fs::read_dir(states_path)?
            .filter_map(|entry| {
                let name = entry.ok()?.file_name().into_string().ok()?;
                let cohort = name.strip_prefix("utxo_")?.strip_suffix("_cost_basis")?;
                states_path
                    .join(&name)
                    .join("by_date")
                    .exists()
                    .then(|| cohort.to_string())
            })
            .collect();

        cohorts.sort();
        Ok(cohorts)
    }

    fn cost_basis_dir(&self, cohort: &str) -> Result<PathBuf> {
        let dir = self
            .computer()
            .distribution
            .states_path
            .join(format!("utxo_{cohort}_cost_basis/by_date"));

        if !dir.exists() {
            let valid = self.cost_basis_cohorts().unwrap_or_default().join(", ");
            return Err(Error::NotFound(format!(
                "Unknown cohort '{cohort}'. Available: {valid}"
            )));
        }

        Ok(dir)
    }

    /// Get the cost basis distribution for a cohort on a specific date.
    pub fn cost_basis_distribution(
        &self,
        cohort: &str,
        date: Date,
    ) -> Result<CostBasisDistribution> {
        let path = self.cost_basis_dir(cohort)?.join(date.to_string());

        if !path.exists() {
            return Err(Error::NotFound(format!(
                "No data for cohort '{cohort}' on {date}"
            )));
        }

        CostBasisDistribution::deserialize(&fs::read(&path)?)
    }

    /// List available dates for a cohort's cost basis distribution.
    pub fn cost_basis_dates(&self, cohort: &str) -> Result<Vec<Date>> {
        let dir = self.cost_basis_dir(cohort)?;

        let mut dates: Vec<Date> = fs::read_dir(&dir)?
            .filter_map(|entry| entry.ok()?.file_name().to_str()?.parse().ok())
            .collect();

        dates.sort();
        Ok(dates)
    }

    /// Get the formatted cost basis distribution.
    pub fn cost_basis_formatted(
        &self,
        cohort: &str,
        date: Date,
        bucket: CostBasisBucket,
        value: CostBasisValue,
    ) -> Result<CostBasisFormatted> {
        let distribution = self.cost_basis_distribution(cohort, date)?;
        let day1 = Day1::try_from(date).map_err(|e| Error::Parse(e.to_string()))?;
        let price = &self.computer().prices;
        let spot = price
            .split
            .close
            .cents
            .day1
            .collect_one_flat(day1)
            .ok_or_else(|| Error::NotFound(format!("No price data for {date}")))?;
        Ok(distribution.format(bucket, value, spot))
    }
}