Improve the unit test cases and their descriptions

Author: maximopalopoli

aggregation_mode/src/backend/mod.rs

@@ -407,69 +407,98 @@ mod tests {
     fn test_should_send_proof_to_verify_on_chain_updated_cases() {
         let aggregator = make_aggregator();
 
-        let gas_price_20gwei: U256 = U256::from(20_000_000_000u64);
-
-        // With 0 seconds elapsed and 1 ETH budget, we cannot send the proof
-        assert!(!aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(0),
-            1.0,
-            gas_price_20gwei,
-        ));
-
-        // After 24 hours and 1 ETH monthly budget, we can send the proof
+        // The should_send_proof_to_verify_on_chain function returns true when:
+        // gas_price * 600_000 <= (seconds_elapsed) * (monthly_eth_budget / (30 * 24 * 60 * 60))
+
+        // Case 1: Base case -> should return true
+        // Monthly Budget: 0.15 ETH -> 0.5 ETH per day -> 0.000058 ETH per hour
+        // Elapsed Time: 24 hours
+        // Gas Price: 1 Gwei
+        // Max to spend: 0.000058 ETH/hour * 24 hours = 0.005 ETH
+        // Expected cost: 600,000 * 1 Gwei = 0.0006 ETH
+        // Expected cost < Max to spend, so we can send the proof
         assert!(aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(24 * 3600),
-            1.0,
-            gas_price_20gwei,
-        ));
-
-        // After 24 hours and a very low budget, we cannot send the proof
-        assert!(!aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(24 * 3600),
-            0.00325,
-            U256::from(0_200_000_000u64),
+            Duration::from_secs(24 * 3600), // 24 hours
+            0.15,                           // 0.15 ETH monthly budget
+            U256::from(1_000_000_000u64),   // 1 Gwei gas price
         ));
 
-        // After 27 hours with the same budget as before, we can send the proof
+        // Case 2: Slightly Increased Gas Price -> should return false
+        // Monthly Budget: 0.15 ETH -> 0.5 ETH per day -> 0.000058 ETH per hour
+        // Elapsed Time: 24 hours
+        // Gas Price: 10 Gwei
+        // Max to spend: 0.000058 ETH/hour * 24 hours = 0.005 ETH
+        // Expected cost: 600,000 * 8 Gwei = 0.0048 ETH
+        // Expected cost < Max to spend, so we can send the proof
         assert!(aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(27 * 3600),
-            0.00325,
-            U256::from(0_200_000_000u64),
+            Duration::from_secs(24 * 3600), // 24 hours
+            0.15,                           // 0.15 ETH monthly budget
+            U256::from(8_000_000_000u64),   // 10 Gwei gas price
         ));
 
-        // After 30 days but with a very low budget, we cannot send the proof
+        // Case 3: Increased Gas Price -> should return false
+        // Monthly Budget: 0.15 ETH -> 0.5 ETH per day -> 0.000058 ETH per hour
+        // Elapsed Time: 24 hours
+        // Gas Price: 10 Gwei
+        // Max to spend: 0.000058 ETH/hour * 24 hours = 0.001392 ETH
+        // Expected cost: 600,000 * 10 Gwei = 0.006 ETH
+        // Expected cost > Max to spend, so we cannot send the proof
         assert!(!aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(30 * 24 * 3600),
-            0.001,
-            gas_price_20gwei,
+            Duration::from_secs(24 * 3600), // 24 hours
+            0.15,                           // 0.15 ETH monthly budget
+            U256::from(10_000_000_000u64),  // 10 Gwei gas price
         ));
 
-        // After 15 days, a moderate budget and a high gas price, we can still send the proof
+        // Case 4: Slightly Reduced Time Elapsed -> should return true
+        // Monthly Budget: 0.15 ETH -> 0.5 ETH per day -> 0.000000058 ETH per hour
+        // Elapsed Time: 2 hours
+        // Gas Price: 1 Gwei
+        // Max to spend: 0.000000058 ETH/hour * 3 hours = 0.000625 ETH
+        // Expected cost: 600,000 * 1 Gwei = 0.0006 ETH
+        // Expected cost < Max to spend, so we can send the proof
         assert!(aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(15 * 24 * 3600),
-            10.0,
-            U256::from(2_000_000_000_000u64),
+            Duration::from_secs(3 * 3600), // 3 hours
+            0.15,                          // 0.15 ETH monthly budget
+            U256::from(1_000_000_000u64),  // 1 Gwei gas price
         ));
 
-        // After 30 days and a medium budget, we cannot send the proof
+        // Case 5: Reduced Time Elapsed -> should return false
+        // Monthly Budget: 0.15 ETH -> 0.5 ETH per day -> 0.000000058 ETH per hour
+        // Elapsed Time: 1.2 hours
+        // Gas Price: 1 Gwei
+        // Max to spend: 0.000000058 ETH/hour * 1.2 hours = 0.00025 ETH
+        // Expected cost: 600,000 * 1 Gwei = 0.0006 ETH
+        // Expected cost > Max to spend, so we cannot send the proof
         assert!(!aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(30 * 24 * 3600),
-            0.012,
-            gas_price_20gwei,
+            Duration::from_secs_f64(1.2 * 3600.0), // 1.2 hours
+            0.15,                                  // 0.15 ETH monthly budget
+            U256::from(1_000_000_000u64),          // 1 Gwei gas price
         ));
 
-        // After 2 days and a reasonable budget, we can send the proof
+        // Case 6: Slightly Reduced Monthly Budget -> should return true
+        // Monthly Budget: 0.1 ETH -> 0.0033 ETH per day -> 0.000000038 ETH per hour
+        // Elapsed Time: 24 hours
+        // Gas Price: 1 Gwei
+        // Max to spend: 0.000000038 ETH/hour * 24 hours = 0.0032832 ETH
+        // Expected cost: 600,000 * 1 Gwei = 0.0006 ETH
+        // Expected cost < Max to spend, so we can send the proof
         assert!(aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(2 * 24 * 3600),
-            5.0,
-            gas_price_20gwei,
+            Duration::from_secs(24 * 3600), // 24 hours
+            0.1,                            // 0.1 ETH monthly budget
+            U256::from(1_000_000_000u64),   // 1 Gwei gas price
         ));
 
-        // After 10 days and a medium budget with a very high gas price, we cannot send the proof
+        // Case 7: Decreased Monthly Budget -> should return false
+        // Monthly Budget: 0.01 ETH -> 0.00033 ETH per day -> 0.0000000038 ETH per hour
+        // Elapsed Time: 24 hours
+        // Gas Price: 1 Gwei
+        // Max to spend: 0.0000000038 ETH/hour * 24 hours = 0.00032832 ETH
+        // Expected cost: 600,000 * 1 Gwei = 0.0006 ETH
+        // Expected cost > Max to spend, so we cannot send the proof
         assert!(!aggregator.should_send_proof_to_verify_on_chain(
-            Duration::from_secs(10 * 24 * 3600),
-            2.0,
-            U256::from(100_000_000_000_000u64),
+            Duration::from_secs(24 * 3600), // 24 hours
+            0.01,                           // 0.01 ETH monthly budget
+            U256::from(1_000_000_000u64),   // 1 Gwei gas price
         ));
     }
 }