brk_computer 0.11.2

A Bitcoin dataset computer built on top of brk_indexer
Documentation
use brk_traversable::Traversable;
use brk_types::{Height, StoredU64, Version};
use vecdb::{BinaryTransform, CachedBoxedVec, ReadableCloneableVec, UnaryTransform};

use crate::{
    indexes,
    internal::{
        CachedBlockCountReader, CachedWindowStartVec, FixedRatio, LazyPercentPerBlock,
        LazyPercentRollingWindows, LazyRatioWithCachedBlockCount,
        LazyRollingRatioWithCachedBlockCount, NumericValue, RatioU64, Windows,
    },
};

/// Fully lazy variant of `PercentCumulativeRolling` — no stored vecs.
///
/// Mirrors the flat shape of `PercentCumulativeRolling`: cumulative and
/// rolling window fields are both flattened to the same tree level, so
/// consumers see `{ ppm, percent, ratio, _24h, _1w, _1m, _1y }`.
#[derive(Clone, Traversable)]
pub struct LazyPercentCumulativeRolling<B: FixedRatio> {
    #[traversable(flatten)]
    pub cumulative: LazyPercentPerBlock<B>,
    #[traversable(flatten)]
    pub rolling: LazyPercentRollingWindows<B>,
}

impl<B: FixedRatio> LazyPercentCumulativeRolling<B> {
    pub(crate) fn from_cached_block_count(
        name: &str,
        version: Version,
        numerator: &(impl ReadableCloneableVec<Height, StoredU64> + 'static),
        denominator: CachedBlockCountReader,
        cached_starts: &Windows<&CachedWindowStartVec>,
        indexes: &indexes::Vecs,
    ) -> Self {
        let source_name = format!("{name}_{}_source", B::SUFFIX);
        let cumulative = LazyPercentPerBlock::from_height_source(
            name,
            version,
            LazyRatioWithCachedBlockCount::<B, RatioU64<B>>::new(
                &source_name,
                version,
                numerator.read_only_boxed_clone(),
                denominator.clone(),
            ),
            indexes,
        );
        let numerator = numerator.read_only_boxed_clone();
        let rolling =
            LazyPercentRollingWindows(cached_starts.map_with_suffix(|suffix, cached_start| {
                let full_name = format!("{name}_{suffix}");
                LazyPercentPerBlock::from_height_source(
                    &full_name,
                    version,
                    LazyRollingRatioWithCachedBlockCount::<B, RatioU64<B>>::new(
                        &format!("{full_name}_{}_source", B::SUFFIX),
                        version,
                        numerator.clone(),
                        denominator.clone(),
                        cached_start.read_only_cached_boxed_clone(),
                    ),
                    indexes,
                )
            }));

        Self {
            cumulative,
            rolling,
        }
    }

    /// Derive cumulative and rolling ratios from one potentially disk-backed
    /// cumulative numerator. The denominator and window starts are pinned
    /// metadata, so range reads touch only the numerator source.
    pub(crate) fn from_cumulative_ratio<S, D, F>(
        name: &str,
        version: Version,
        numerator: &(impl ReadableCloneableVec<Height, S> + 'static),
        denominator: CachedBoxedVec<Height, D>,
        cached_starts: &Windows<&CachedWindowStartVec>,
        indexes: &indexes::Vecs,
    ) -> Self
    where
        S: NumericValue,
        D: NumericValue,
        F: BinaryTransform<S, D, B> + Send + Sync + 'static,
    {
        let cumulative = LazyPercentPerBlock::from_cached_ratio::<S, D, F>(
            name,
            version,
            numerator,
            denominator.clone(),
            indexes,
        );
        let rolling = LazyPercentRollingWindows::from_cumulative_ratio::<S, D, F>(
            name,
            version,
            numerator,
            denominator,
            cached_starts,
            indexes,
        );
        Self {
            cumulative,
            rolling,
        }
    }

    pub(crate) fn from_cumulative_ratio_with_denominator_transform<S, D, F>(
        name: &str,
        version: Version,
        numerator: &(impl ReadableCloneableVec<Height, S> + 'static),
        denominator: CachedBoxedVec<Height, D>,
        denominator_transform: fn(Height, D) -> D,
        cached_starts: &Windows<&CachedWindowStartVec>,
        indexes: &indexes::Vecs,
    ) -> Self
    where
        S: NumericValue,
        D: NumericValue,
        F: BinaryTransform<S, D, B> + Send + Sync + 'static,
    {
        let cumulative = LazyPercentPerBlock::from_cached_ratio_with_denominator_transform::<S, D, F>(
            name,
            version,
            numerator,
            denominator.clone(),
            denominator_transform,
            indexes,
        );
        let rolling =
            LazyPercentRollingWindows::from_cumulative_ratio_with_denominator_transform::<S, D, F>(
                name,
                version,
                numerator,
                denominator,
                denominator_transform,
                cached_starts,
                indexes,
            );
        Self {
            cumulative,
            rolling,
        }
    }

    /// Same ratio, with the pinned value as numerator and the sole
    /// potentially disk-backed source as denominator.
    pub(crate) fn from_cumulative_ratio_with_cached_numerator<S, D, F>(
        name: &str,
        version: Version,
        numerator: CachedBoxedVec<Height, S>,
        denominator: &(impl ReadableCloneableVec<Height, D> + 'static),
        cached_starts: &Windows<&CachedWindowStartVec>,
        indexes: &indexes::Vecs,
    ) -> Self
    where
        S: NumericValue,
        D: NumericValue,
        F: BinaryTransform<S, D, B> + Send + Sync + 'static,
    {
        let cumulative = LazyPercentPerBlock::from_ratio_with_cached_numerator::<S, D, F>(
            name,
            version,
            numerator.clone(),
            denominator,
            indexes,
        );
        let rolling =
            LazyPercentRollingWindows::from_cumulative_ratio_with_cached_numerator::<S, D, F>(
                name,
                version,
                numerator,
                denominator,
                cached_starts,
                indexes,
            );
        Self {
            cumulative,
            rolling,
        }
    }

    pub(crate) fn from_lazy_source<F: UnaryTransform<B, B>>(
        name: &str,
        version: Version,
        source: &Self,
    ) -> Self {
        let cumulative =
            LazyPercentPerBlock::from_lazy_percent::<F>(name, version, &source.cumulative);
        let rolling =
            LazyPercentRollingWindows::from_lazy_rolling::<F>(name, version, &source.rolling);
        Self {
            cumulative,
            rolling,
        }
    }
}