cuprate/consensus/src/context/weight.rs

//! # Block Weights
//!
//! This module contains calculations for block weights, including calculating block weight
//! limits, effective medians and long term block weights.
//!
//! For more information please see the [block weights chapter](https://cuprate.github.io/monero-book/consensus_rules/blocks/weight_limit.html)
//! in the Monero Book.
//!
use std::{
    cmp::{max, min},
    collections::VecDeque,
    ops::Range,
};

use rayon::prelude::*;
use tower::ServiceExt;
use tracing::instrument;

use cuprate_consensus_rules::blocks::{penalty_free_zone, PENALTY_FREE_ZONE_5};
use cuprate_helper::{asynch::rayon_spawn_async, num::median};
use cuprate_types::blockchain::{BCReadRequest, BCResponse};

use crate::{Database, ExtendedConsensusError, HardFork};

/// The short term block weight window.
const SHORT_TERM_WINDOW: u64 = 100;
/// The long term block weight window.
const LONG_TERM_WINDOW: u64 = 100000;

/// Configuration for the block weight cache.
///
#[derive(Debug, Clone)]
pub struct BlockWeightsCacheConfig {
    short_term_window: u64,
    long_term_window: u64,
}

impl BlockWeightsCacheConfig {
    /// Creates a new [`BlockWeightsCacheConfig`]
    pub const fn new(short_term_window: u64, long_term_window: u64) -> BlockWeightsCacheConfig {
        BlockWeightsCacheConfig {
            short_term_window,
            long_term_window,
        }
    }

    /// Returns the [`BlockWeightsCacheConfig`] for all networks (They are all the same as mainnet).
    pub fn main_net() -> BlockWeightsCacheConfig {
        BlockWeightsCacheConfig {
            short_term_window: SHORT_TERM_WINDOW,
            long_term_window: LONG_TERM_WINDOW,
        }
    }
}

/// A cache used to calculate block weight limits, the effective median and
/// long term block weights.
///
/// These calculations require a lot of data from the database so by caching
/// this data it reduces the load on the database.
#[derive(Clone)]
pub struct BlockWeightsCache {
    /// The short term block weights.
    short_term_block_weights: VecDeque<usize>,
    /// The long term block weights.
    long_term_weights: VecDeque<usize>,

    /// The short term block weights sorted so we don't have to sort them every time we need
    /// the median.
    cached_sorted_long_term_weights: Vec<usize>,
    /// The long term block weights sorted so we don't have to sort them every time we need
    /// the median.
    cached_sorted_short_term_weights: Vec<usize>,

    /// The height of the top block.
    tip_height: u64,

    /// The block weight config.
    config: BlockWeightsCacheConfig,
}

impl BlockWeightsCache {
    /// Initialize the [`BlockWeightsCache`] at the the given chain height.
    #[instrument(name = "init_weight_cache", level = "info", skip(database, config))]
    pub async fn init_from_chain_height<D: Database + Clone>(
        chain_height: u64,
        config: BlockWeightsCacheConfig,
        database: D,
    ) -> Result<Self, ExtendedConsensusError> {
        tracing::info!("Initializing weight cache this may take a while.");

        let long_term_weights = get_long_term_weight_in_range(
            chain_height.saturating_sub(config.long_term_window)..chain_height,
            database.clone(),
        )
        .await?;

        let short_term_block_weights = get_blocks_weight_in_range(
            chain_height.saturating_sub(config.short_term_window)..chain_height,
            database,
        )
        .await?;

        tracing::info!("Initialized block weight cache, chain-height: {:?}, long term weights length: {:?}, short term weights length: {:?}", chain_height, long_term_weights.len(), short_term_block_weights.len());

        let mut cloned_short_term_weights = short_term_block_weights.clone();
        let mut cloned_long_term_weights = long_term_weights.clone();
        Ok(BlockWeightsCache {
            short_term_block_weights: short_term_block_weights.into(),
            long_term_weights: long_term_weights.into(),

            cached_sorted_long_term_weights: rayon_spawn_async(|| {
                cloned_long_term_weights.par_sort_unstable();
                cloned_long_term_weights
            })
            .await,
            cached_sorted_short_term_weights: rayon_spawn_async(|| {
                cloned_short_term_weights.par_sort_unstable();
                cloned_short_term_weights
            })
            .await,

            tip_height: chain_height - 1,
            config,
        })
    }

    /// Add a new block to the cache.
    ///
    /// The block_height **MUST** be one more than the last height the cache has
    /// seen.
    pub fn new_block(&mut self, block_height: u64, block_weight: usize, long_term_weight: usize) {
        assert_eq!(self.tip_height + 1, block_height);
        self.tip_height += 1;
        tracing::debug!(
            "Adding new block's {} weights to block cache, weight: {}, long term weight: {}",
            self.tip_height,
            block_weight,
            long_term_weight
        );

        // add the new block to the `long_term_weights` list and the sorted `cached_sorted_long_term_weights` list.
        self.long_term_weights.push_back(long_term_weight);
        match self
            .cached_sorted_long_term_weights
            .binary_search(&long_term_weight)
        {
            Ok(idx) | Err(idx) => self
                .cached_sorted_long_term_weights
                .insert(idx, long_term_weight),
        }

        // If the list now has too many entries remove the oldest.
        if u64::try_from(self.long_term_weights.len()).unwrap() > self.config.long_term_window {
            let val = self
                .long_term_weights
                .pop_front()
                .expect("long term window can't be negative");

            match self.cached_sorted_long_term_weights.binary_search(&val) {
                Ok(idx) => self.cached_sorted_long_term_weights.remove(idx),
                Err(_) => panic!("Long term cache has incorrect values!"),
            };
        }

        // add the block to the short_term_block_weights and the sorted cached_sorted_short_term_weights list.
        self.short_term_block_weights.push_back(block_weight);
        match self
            .cached_sorted_short_term_weights
            .binary_search(&block_weight)
        {
            Ok(idx) | Err(idx) => self
                .cached_sorted_short_term_weights
                .insert(idx, block_weight),
        }

        // If there are now too many entries remove the oldest.
        if u64::try_from(self.short_term_block_weights.len()).unwrap()
            > self.config.short_term_window
        {
            let val = self
                .short_term_block_weights
                .pop_front()
                .expect("short term window can't be negative");

            match self.cached_sorted_short_term_weights.binary_search(&val) {
                Ok(idx) => self.cached_sorted_short_term_weights.remove(idx),
                Err(_) => panic!("Short term cache has incorrect values"),
            };
        }

        debug_assert_eq!(
            self.cached_sorted_long_term_weights.len(),
            self.long_term_weights.len()
        );
        debug_assert_eq!(
            self.cached_sorted_short_term_weights.len(),
            self.short_term_block_weights.len()
        );
    }

    /// Returns the median long term weight over the last [`LONG_TERM_WINDOW`] blocks, or custom amount of blocks in the config.
    pub fn median_long_term_weight(&self) -> usize {
        median(&self.cached_sorted_long_term_weights)
    }

    /// Returns the median weight over the last [`SHORT_TERM_WINDOW`] blocks, or custom amount of blocks in the config.
    pub fn median_short_term_weight(&self) -> usize {
        median(&self.cached_sorted_short_term_weights)
    }

    /// Returns the effective median weight, used for block reward calculations and to calculate
    /// the block weight limit.
    ///
    /// See: https://cuprate.github.io/monero-book/consensus_rules/blocks/weight_limit.html#calculating-effective-median-weight
    pub fn effective_median_block_weight(&self, hf: &HardFork) -> usize {
        calculate_effective_median_block_weight(
            hf,
            self.median_short_term_weight(),
            self.median_long_term_weight(),
        )
    }

    /// Returns the median weight used to calculate block reward punishment.
    ///
    /// https://cuprate.github.io/monero-book/consensus_rules/blocks/reward.html#calculating-block-reward
    pub fn median_for_block_reward(&self, hf: &HardFork) -> usize {
        if hf < &HardFork::V12 {
            self.median_short_term_weight()
        } else {
            self.effective_median_block_weight(hf)
        }
        .max(penalty_free_zone(hf))
    }
}

/// Calculates the effective median with the long term and short term median.
fn calculate_effective_median_block_weight(
    hf: &HardFork,
    median_short_term_weight: usize,
    median_long_term_weight: usize,
) -> usize {
    if hf < &HardFork::V10 {
        return median_short_term_weight.max(penalty_free_zone(hf));
    }

    let long_term_median = median_long_term_weight.max(PENALTY_FREE_ZONE_5);
    let short_term_median = median_short_term_weight;
    let effective_median = if hf >= &HardFork::V10 && hf < &HardFork::V15 {
        min(
            max(PENALTY_FREE_ZONE_5, short_term_median),
            50 * long_term_median,
        )
    } else {
        min(
            max(long_term_median, short_term_median),
            50 * long_term_median,
        )
    };

    effective_median.max(penalty_free_zone(hf))
}

/// Calculates a blocks long term weight.
pub fn calculate_block_long_term_weight(
    hf: &HardFork,
    block_weight: usize,
    long_term_median: usize,
) -> usize {
    if hf < &HardFork::V10 {
        return block_weight;
    }

    let long_term_median = max(penalty_free_zone(hf), long_term_median);

    let (short_term_constraint, adjusted_block_weight) =
        if hf >= &HardFork::V10 && hf < &HardFork::V15 {
            let stc = long_term_median + long_term_median * 2 / 5;
            (stc, block_weight)
        } else {
            let stc = long_term_median + long_term_median * 7 / 10;
            (stc, max(block_weight, long_term_median * 10 / 17))
        };

    min(short_term_constraint, adjusted_block_weight)
}

/// Gets the block weights from the blocks with heights in the range provided.
#[instrument(name = "get_block_weights", skip(database))]
async fn get_blocks_weight_in_range<D: Database + Clone>(
    range: Range<u64>,
    database: D,
) -> Result<Vec<usize>, ExtendedConsensusError> {
    tracing::info!("getting block weights.");

    let BCResponse::BlockExtendedHeaderInRange(ext_headers) = database
        .oneshot(BCReadRequest::BlockExtendedHeaderInRange(range))
        .await?
    else {
        panic!("Database sent incorrect response!")
    };

    Ok(ext_headers
        .into_iter()
        .map(|info| info.block_weight)
        .collect())
}

/// Gets the block long term weights from the blocks with heights in the range provided.
#[instrument(name = "get_long_term_weights", skip(database), level = "info")]
async fn get_long_term_weight_in_range<D: Database + Clone>(
    range: Range<u64>,
    database: D,
) -> Result<Vec<usize>, ExtendedConsensusError> {
    tracing::info!("getting block long term weights.");

    let BCResponse::BlockExtendedHeaderInRange(ext_headers) = database
        .oneshot(BCReadRequest::BlockExtendedHeaderInRange(range))
        .await?
    else {
        panic!("Database sent incorrect response!")
    };

    Ok(ext_headers
        .into_iter()
        .map(|info| info.long_term_weight)
        .collect())
}