tokenomics-simulator 0.5.12

//! # Report module
//!
//! This module contains the simulation report struct and its methods.
//! The simulation report contains the results of a simulation.

use chrono::Utc;
use rust_decimal::Decimal;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::User;

/// Report containing the results of a simulation.
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub struct SimulationReport {
    /// Timestamp of the simulation interval.
    pub interval: i64,

    /// List of users and their balances, behaviors, etc.
    /// Only available in the final report.
    #[cfg_attr(feature = "serde", serde(skip))]
    pub users: Option<Vec<User>>,

    /// Profit or loss for the interval.
    /// Positive value indicates profit, negative value indicates loss.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub profit_loss: Decimal,

    /// Number of trades made in the interval.
    /// This includes both successful and failed trades.
    pub trades: u64,

    /// Number of successful trades made in the interval.
    /// A trade is considered successful if the user has a positive balance.
    pub successful_trades: u64,

    /// Number of failed trades made in the interval.
    /// A trade is considered failed if the user has a zero balance.
    pub failed_trades: u64,

    /// Market volatility during the simulation.
    /// This is the standard deviation of token prices.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub market_volatility: Decimal,

    /// Liquidity of the token during the simulation.
    /// Liquidity is the number of trades per second.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub liquidity: Decimal,

    /// Adoption rate of the token.
    /// Adoption rate is the percentage of users who have a positive balance.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub adoption_rate: Decimal,

    /// Total number of tokens burned during the simulation.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub total_burned: Decimal,

    /// Burn rate of the token.
    /// Burn rate is the number of tokens burned per user.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub burn_rate: Decimal,

    /// Inflation rate of the token.
    /// Inflation rate is the number of new tokens created per user.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub inflation_rate: Decimal,

    /// User retention rate.
    /// User retention rate is the percentage of users who have a positive balance.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub user_retention: Decimal,

    /// Network activity (e.g., transactions per second).
    /// This is the number of transactions made in the interval.
    pub network_activity: u64,

    /// Actual token price during the simulation.
    /// This is the price of the token at the end of the simulation.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub token_price: Decimal,

    /// Total number of new tokens created during the simulation.
    #[cfg_attr(feature = "serde", serde(with = "rust_decimal::serde::float"))]
    pub total_new_tokens: Decimal,
}

impl Default for SimulationReport {
    /// Create a new simulation report with default values.
    ///
    /// # Returns
    ///
    /// A new simulation report with default values.
    fn default() -> Self {
        Self {
            users: None,
            interval: Utc::now().timestamp(),
            profit_loss: Decimal::default(),
            trades: 0,
            successful_trades: 0,
            failed_trades: 0,
            market_volatility: Decimal::default(),
            liquidity: Decimal::default(),
            adoption_rate: Decimal::default(),
            total_burned: Decimal::default(),
            burn_rate: Decimal::default(),
            inflation_rate: Decimal::default(),
            user_retention: Decimal::default(),
            token_price: Decimal::default(),
            total_new_tokens: Decimal::default(),
            network_activity: 0,
        }
    }
}

impl SimulationReport {
    /// Calculate the liquidity of the token.
    /// Liquidity is the number of trades per second.
    ///
    /// # Arguments
    ///
    /// * `trades` - Number of trades made in the interval.
    /// * `interval_duration` - Duration of the interval in seconds.
    /// * `decimals` - Number of decimal places to round to.
    ///
    /// # Returns
    ///
    /// The liquidity of the token as trades per second.
    pub fn calculate_liquidity(
        &self,
        trades: Decimal,
        interval_duration: Decimal,
        decimals: u32,
    ) -> Decimal {
        #[cfg(feature = "log")]
        log::debug!(
            "Calculating liquidity: trades={}, interval_duration={}",
            trades,
            interval_duration
        );

        (trades / interval_duration).round_dp(decimals)
    }

    /// Calculate the adoption rate.
    /// Adoption rate is the percentage of users who have a positive balance.
    ///
    /// # Arguments
    ///
    /// * `users` - A list of users.
    /// * `decimals` - Number of decimal places to round to.
    ///
    /// # Returns
    ///
    /// The adoption rate as a percentage.
    pub fn calculate_adoption_rate(&self, users: &[User], decimals: u32) -> Decimal {
        #[cfg(feature = "log")]
        log::debug!("Calculating adoption rate: users={:?}", users.len());

        let total_users = Decimal::new(users.len() as i64, 0);
        let new_users = Decimal::new(
            users
                .iter()
                .filter(|u| u.balance > Decimal::default())
                .count() as i64,
            0,
        );

        (new_users / total_users).round_dp(decimals)
    }

    /// Calculate the burn rate.
    /// Burn rate is the number of tokens burned per user.
    ///
    /// # Arguments
    ///
    /// * `total_burned` - Total number of tokens burned.
    /// * `total_users` - Total number of users.
    /// * `decimals` - Number of decimal places to round to.
    ///
    /// # Returns
    ///
    /// The burn rate as a percentage.
    pub fn calculate_burn_rate(
        &self,
        total_burned: Decimal,
        total_users: Decimal,
        decimals: u32,
    ) -> Decimal {
        #[cfg(feature = "log")]
        log::debug!(
            "Calculating burn rate: total_burned={}, total_users={}",
            total_burned,
            total_users
        );

        (total_burned / total_users).round_dp(decimals)
    }

    /// Calculate the inflation rate.
    /// Inflation rate is the number of new tokens created per user.
    ///
    /// # Arguments
    ///
    /// * `total_new_tokens` - Total number of new tokens created.
    /// * `total_users` - Total number of users.
    /// * `decimals` - Number of decimal places to round to.
    ///
    /// # Returns
    ///
    /// The inflation rate as a percentage.
    pub fn calculate_inflation_rate(
        &self,
        total_new_tokens: Decimal,
        total_users: Decimal,
        decimals: u32,
    ) -> Decimal {
        #[cfg(feature = "log")]
        log::debug!(
            "Calculating inflation rate: total_new_tokens={}, total_users={}",
            total_new_tokens,
            total_users
        );

        (total_new_tokens / total_users).round_dp(decimals)
    }

    /// Calculate the user retention rate.
    /// User retention rate is the percentage of users who have a positive balance.
    ///
    /// # Arguments
    ///
    /// * `users` - A list of users.
    /// * `decimals` - Number of decimal places to round to.
    ///
    /// # Returns
    ///
    /// The user retention rate as a percentage.
    pub fn calculate_user_retention(&self, users: &[User], decimals: u32) -> Decimal {
        #[cfg(feature = "log")]
        log::debug!("Calculating user retention rate: users={:?}", users.len());

        let total_users = Decimal::new(users.len() as i64, 0);
        let retained_users = Decimal::new(
            users
                .iter()
                .filter(|u| u.balance > Decimal::default())
                .count() as i64,
            0,
        );

        (retained_users / total_users).round_dp(decimals)
    }
}

#[cfg(test)]
mod tests {
    use uuid::Uuid;

    use super::*;

    #[test]
    fn test_default() {
        let report = SimulationReport::default();

        assert!(report.users.is_none());
        assert_eq!(report.profit_loss, Decimal::default());
        assert_eq!(report.trades, 0);
        assert_eq!(report.successful_trades, 0);
        assert_eq!(report.failed_trades, 0);
        assert_eq!(report.market_volatility, Decimal::default());
        assert_eq!(report.liquidity, Decimal::default());
        assert_eq!(report.adoption_rate, Decimal::default());
        assert_eq!(report.burn_rate, Decimal::default());
        assert_eq!(report.inflation_rate, Decimal::default());
        assert_eq!(report.user_retention, Decimal::default());
        assert_eq!(report.network_activity, 0);
    }

    #[test]
    fn test_calculate_liquidity() {
        let report = SimulationReport::default();
        let trades = Decimal::new(100, 0);
        let interval_duration = Decimal::new(10, 0);

        assert_eq!(
            report.calculate_liquidity(trades, interval_duration, 4),
            Decimal::new(10, 0)
        );
    }

    #[test]
    fn test_calculate_adoption_rate() {
        let report = SimulationReport::default();
        let users = vec![
            User::new(Uuid::new_v4(), Decimal::default()),
            User::new(Uuid::new_v4(), Decimal::new(10, 0)),
            User::new(Uuid::new_v4(), Decimal::default()),
            User::new(Uuid::new_v4(), Decimal::new(5, 0)),
        ];

        assert_eq!(
            report.calculate_adoption_rate(&users, 4),
            Decimal::new(5, 1),
        );
    }

    #[test]
    fn test_calculate_burn_rate() {
        let report = SimulationReport::default();
        let total_burned = Decimal::new(100, 0);
        let total_users = Decimal::new(10, 0);

        assert_eq!(
            report.calculate_burn_rate(total_burned, total_users, 4),
            Decimal::new(10, 0)
        );
    }

    #[test]
    fn test_calculate_inflation_rate() {
        let report = SimulationReport::default();
        let total_new_tokens = Decimal::new(100, 0);
        let total_users = Decimal::new(10, 0);

        assert_eq!(
            report.calculate_inflation_rate(total_new_tokens, total_users, 4),
            Decimal::new(10, 0)
        );
    }

    #[test]
    fn test_calculate_user_retention() {
        let report = SimulationReport::default();
        let users = vec![
            User::new(Uuid::new_v4(), Decimal::default()),
            User::new(Uuid::new_v4(), Decimal::new(10, 0)),
            User::new(Uuid::new_v4(), Decimal::default()),
            User::new(Uuid::new_v4(), Decimal::new(5, 0)),
        ];

        assert_eq!(
            report.calculate_user_retention(&users, 4),
            Decimal::new(5, 1),
        );
    }
}