pyra_margin/
spend_limits.rs

1use pyra_types::Vault;
2
3/// Returns the effective remaining spend limit for the current timeframe in base units.
4///
5/// - If `timeframe_in_seconds == 0`, spending is disabled — returns 0.
6/// - If the timeframe has expired (`next_timeframe_reset_timestamp < now_unix`),
7///   returns the full `spend_limit_per_timeframe`.
8/// - Otherwise, returns `remaining_spend_limit_per_timeframe`.
9///
10/// `now_unix` is the current Unix timestamp in seconds (e.g. `Utc::now().timestamp() as u64`).
11/// It is passed as a parameter instead of calling `Utc::now()` directly to keep this
12/// function pure and testable without time mocking.
13pub fn get_remaining_timeframe_limit(vault: &Vault, now_unix: u64) -> u64 {
14    if vault.timeframe_in_seconds == 0 {
15        return 0;
16    }
17
18    if vault.next_timeframe_reset_timestamp < now_unix {
19        vault.spend_limit_per_timeframe
20    } else {
21        vault.remaining_spend_limit_per_timeframe
22    }
23}
24
25#[cfg(test)]
26#[allow(
27    clippy::allow_attributes,
28    clippy::allow_attributes_without_reason,
29    clippy::unwrap_used,
30    clippy::expect_used,
31    clippy::panic,
32    clippy::arithmetic_side_effects
33)]
34mod tests {
35    use super::*;
36
37    fn make_vault(
38        timeframe_in_seconds: u64,
39        next_timeframe_reset_timestamp: u64,
40        spend_limit_per_timeframe: u64,
41        remaining_spend_limit_per_timeframe: u64,
42    ) -> Vault {
43        Vault {
44            owner: vec![0; 32],
45            bump: 0,
46            spend_limit_per_transaction: 0,
47            spend_limit_per_timeframe,
48            remaining_spend_limit_per_timeframe,
49            next_timeframe_reset_timestamp,
50            timeframe_in_seconds,
51        }
52    }
53
54    const NOW: u64 = 1_700_000_000;
55
56    #[test]
57    fn zero_timeframe_blocks_spending() {
58        let vault = make_vault(0, 0, 1_000_000, 500_000);
59        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 0);
60    }
61
62    #[test]
63    fn zero_timeframe_blocks_even_with_future_reset() {
64        let vault = make_vault(0, NOW + 9999, 1_000_000, 500_000);
65        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 0);
66    }
67
68    #[test]
69    fn expired_timeframe_returns_full_limit() {
70        let vault = make_vault(86_400, NOW - 100, 1_000_000, 200_000);
71        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 1_000_000);
72    }
73
74    #[test]
75    fn active_timeframe_returns_remaining() {
76        let vault = make_vault(86_400, NOW + 3600, 1_000_000, 300_000);
77        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 300_000);
78    }
79
80    #[test]
81    fn reset_at_exact_now_returns_remaining() {
82        // next_reset == now means the reset hasn't happened yet (< vs <=)
83        let vault = make_vault(86_400, NOW, 1_000_000, 400_000);
84        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 400_000);
85    }
86
87    #[test]
88    fn reset_one_second_before_now_returns_full() {
89        let vault = make_vault(86_400, NOW - 1, 1_000_000, 100_000);
90        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 1_000_000);
91    }
92}
pyra_margin/spend_limits.rs

pyra_margin/
spend_limits.rs
