brk_computer 0.2.5

A Bitcoin dataset computer built on top of brk_indexer
Documentation
use brk_error::Result;
use brk_traversable::Traversable;
use brk_types::{
    Cents, Close, Day1, Day3, Epoch, Halving, High, Hour1, Hour4, Hour12, Indexes, Low, Minute10,
    Minute30, Month1, Month3, Month6, OHLCCents, Open, Version, Week1, Year1, Year10,
};
use derive_more::{Deref, DerefMut};
use schemars::JsonSchema;
use serde::Serialize;
use vecdb::{
    BytesVec, BytesVecValue, Database, EagerVec, Exit, Formattable, ImportableVec, LazyVecFrom1,
    ReadableCloneableVec, ReadableVec, Rw, StorageMode, UnaryTransform,
};

use crate::{
    indexes,
    internal::{EagerIndexes, PerResolution, Resolutions},
};

#[derive(Deref, DerefMut, Traversable)]
#[traversable(merge)]
pub struct OhlcVecs<T, M: StorageMode = Rw>(
    #[allow(clippy::type_complexity)]
    pub  PerResolution<
        <M as StorageMode>::Stored<EagerVec<BytesVec<Minute10, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Minute30, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Hour1, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Hour4, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Hour12, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Day1, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Day3, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Week1, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Month1, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Month3, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Month6, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Year1, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Year10, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Halving, T>>>,
        <M as StorageMode>::Stored<EagerVec<BytesVec<Epoch, T>>>,
    >,
)
where
    T: BytesVecValue + Formattable + Serialize + JsonSchema;

const EAGER_VERSION: Version = Version::ONE;

impl<T> OhlcVecs<T>
where
    T: BytesVecValue + Formattable + Serialize + JsonSchema,
{
    pub(crate) fn forced_import(db: &Database, name: &str, version: Version) -> Result<Self> {
        let v = version + EAGER_VERSION;

        macro_rules! per_period {
            () => {
                ImportableVec::forced_import(db, name, v)?
            };
        }

        Ok(Self(PerResolution {
            minute10: per_period!(),
            minute30: per_period!(),
            hour1: per_period!(),
            hour4: per_period!(),
            hour12: per_period!(),
            day1: per_period!(),
            day3: per_period!(),
            week1: per_period!(),
            month1: per_period!(),
            month3: per_period!(),
            month6: per_period!(),
            year1: per_period!(),
            year10: per_period!(),
            halving: per_period!(),
            epoch: per_period!(),
        }))
    }
}

impl OhlcVecs<OHLCCents> {
    #[allow(clippy::too_many_arguments)]
    pub(crate) fn compute_from_split(
        &mut self,
        starting_indexes: &Indexes,
        indexes: &indexes::Vecs,
        open: &EagerIndexes<Cents>,
        high: &EagerIndexes<Cents>,
        low: &EagerIndexes<Cents>,
        close: &Resolutions<Cents>,
        exit: &Exit,
    ) -> Result<()> {
        let prev_height = starting_indexes.height.decremented().unwrap_or_default();

        macro_rules! period {
            ($field:ident) => {
                self.0.$field.compute_transform4(
                    indexes
                        .height
                        .$field
                        .collect_one(prev_height)
                        .unwrap_or_default(),
                    &open.$field,
                    &high.$field,
                    &low.$field,
                    &close.$field,
                    |(idx, o, h, l, c, this)| {
                        (
                            idx,
                            if let Some(c) = c {
                                OHLCCents {
                                    open: Open::new(o),
                                    high: High::new(h),
                                    low: Low::new(l),
                                    close: Close::new(c),
                                }
                            } else {
                                // Empty period (no blocks): flat candle at previous close
                                let prev_close =
                                    Close::new(this.collect_last().map_or(o, |prev| *prev.close));
                                OHLCCents::from(prev_close)
                            },
                        )
                    },
                    exit,
                )?;
            };
        }

        macro_rules! epoch {
            ($field:ident) => {
                self.0.$field.compute_transform4(
                    indexes
                        .height
                        .$field
                        .collect_one(prev_height)
                        .unwrap_or_default(),
                    &open.$field,
                    &high.$field,
                    &low.$field,
                    &close.$field,
                    |(idx, o, h, l, c, _)| {
                        (
                            idx,
                            OHLCCents {
                                open: Open::new(o),
                                high: High::new(h),
                                low: Low::new(l),
                                close: Close::new(c),
                            },
                        )
                    },
                    exit,
                )?;
            };
        }

        period!(minute10);
        period!(minute30);
        period!(hour1);
        period!(hour4);
        period!(hour12);
        period!(day1);
        period!(day3);
        period!(week1);
        period!(month1);
        period!(month3);
        period!(month6);
        period!(year1);
        period!(year10);
        epoch!(halving);
        epoch!(epoch);

        Ok(())
    }
}

#[derive(Clone, Deref, DerefMut, Traversable)]
#[traversable(merge)]
pub struct LazyOhlcVecs<T, S>(
    #[allow(clippy::type_complexity)]
    pub  PerResolution<
        LazyVecFrom1<Minute10, T, Minute10, S>,
        LazyVecFrom1<Minute30, T, Minute30, S>,
        LazyVecFrom1<Hour1, T, Hour1, S>,
        LazyVecFrom1<Hour4, T, Hour4, S>,
        LazyVecFrom1<Hour12, T, Hour12, S>,
        LazyVecFrom1<Day1, T, Day1, S>,
        LazyVecFrom1<Day3, T, Day3, S>,
        LazyVecFrom1<Week1, T, Week1, S>,
        LazyVecFrom1<Month1, T, Month1, S>,
        LazyVecFrom1<Month3, T, Month3, S>,
        LazyVecFrom1<Month6, T, Month6, S>,
        LazyVecFrom1<Year1, T, Year1, S>,
        LazyVecFrom1<Year10, T, Year10, S>,
        LazyVecFrom1<Halving, T, Halving, S>,
        LazyVecFrom1<Epoch, T, Epoch, S>,
    >,
)
where
    T: BytesVecValue + Formattable + Serialize + JsonSchema,
    S: BytesVecValue;

impl<T, S> LazyOhlcVecs<T, S>
where
    T: BytesVecValue + Formattable + Serialize + JsonSchema,
    S: BytesVecValue + Formattable + Serialize + JsonSchema,
{
    pub(crate) fn from_eager_ohlc_indexes<Transform: UnaryTransform<S, T>>(
        name: &str,
        version: Version,
        source: &OhlcVecs<S>,
    ) -> Self {
        macro_rules! period {
            ($idx:ident) => {
                LazyVecFrom1::transformed::<Transform>(
                    name,
                    version,
                    source.$idx.read_only_boxed_clone(),
                )
            };
        }

        Self(PerResolution {
            minute10: period!(minute10),
            minute30: period!(minute30),
            hour1: period!(hour1),
            hour4: period!(hour4),
            hour12: period!(hour12),
            day1: period!(day1),
            day3: period!(day3),
            week1: period!(week1),
            month1: period!(month1),
            month3: period!(month3),
            month6: period!(month6),
            year1: period!(year1),
            year10: period!(year10),
            halving: period!(halving),
            epoch: period!(epoch),
        })
    }
}