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::unwrap_used,
28    clippy::expect_used,
29    clippy::panic,
30    clippy::arithmetic_side_effects
31)]
32mod tests {
33    use super::*;
34
35    fn make_vault(
36        timeframe_in_seconds: u64,
37        next_timeframe_reset_timestamp: u64,
38        spend_limit_per_timeframe: u64,
39        remaining_spend_limit_per_timeframe: u64,
40    ) -> Vault {
41        Vault {
42            owner: vec![0; 32],
43            bump: 0,
44            spend_limit_per_transaction: 0,
45            spend_limit_per_timeframe,
46            remaining_spend_limit_per_timeframe,
47            next_timeframe_reset_timestamp,
48            timeframe_in_seconds,
49        }
50    }
51
52    const NOW: u64 = 1_700_000_000;
53
54    #[test]
55    fn zero_timeframe_blocks_spending() {
56        let vault = make_vault(0, 0, 1_000_000, 500_000);
57        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 0);
58    }
59
60    #[test]
61    fn zero_timeframe_blocks_even_with_future_reset() {
62        let vault = make_vault(0, NOW + 9999, 1_000_000, 500_000);
63        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 0);
64    }
65
66    #[test]
67    fn expired_timeframe_returns_full_limit() {
68        let vault = make_vault(86_400, NOW - 100, 1_000_000, 200_000);
69        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 1_000_000);
70    }
71
72    #[test]
73    fn active_timeframe_returns_remaining() {
74        let vault = make_vault(86_400, NOW + 3600, 1_000_000, 300_000);
75        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 300_000);
76    }
77
78    #[test]
79    fn reset_at_exact_now_returns_remaining() {
80        // next_reset == now means the reset hasn't happened yet (< vs <=)
81        let vault = make_vault(86_400, NOW, 1_000_000, 400_000);
82        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 400_000);
83    }
84
85    #[test]
86    fn reset_one_second_before_now_returns_full() {
87        let vault = make_vault(86_400, NOW - 1, 1_000_000, 100_000);
88        assert_eq!(get_remaining_timeframe_limit(&vault, NOW), 1_000_000);
89    }
90}
pyra_margin/spend_limits.rs

pyra_margin/
spend_limits.rs
