refactor: add GenerateRav trait

Signed-off-by: Gustavo Inacio <[email protected]>

Author: gusinacio

tap_core/src/manager/tap_manager.rs

@@ -10,7 +10,7 @@ use super::{
     WithValueAndTimestamp,
 };
 use crate::{
-    rav::RAVRequest,
+    rav::{GenerateRav, RAVRequest},
     receipt::{
         checks::{CheckBatch, CheckList, TimestampCheck, UniqueCheck},
         state::{Failed, Reserved},
@@ -184,7 +184,7 @@ impl<E, T, R> Manager<E, T, R>
 where
     E: ReceiptRead<T> + RAVRead<R> + EscrowHandler,
     T: SolStruct + WithValueAndTimestamp + Sync,
-    R: SolStruct + WithValueAndTimestamp + Clone,
+    R: SolStruct + WithValueAndTimestamp + Clone + GenerateRav<T>,
 {
     /// Completes remaining checks on all receipts up to
     /// (current time - `timestamp_buffer_ns`). Returns them in two lists
@@ -206,10 +206,6 @@ where
         ctx: &Context,
         timestamp_buffer_ns: u64,
         receipts_limit: Option<u64>,
-        generate_rav: impl FnOnce(
-            &[ReceiptWithState<Reserved, T>],
-            Option<EIP712SignedMessage<R>>,
-        ) -> Result<R, Error>,
     ) -> Result<RAVRequest<T, R>, Error> {
         let previous_rav = self.get_previous_rav().await?;
         let min_timestamp_ns = previous_rav
@@ -221,7 +217,7 @@ where
             .collect_receipts(ctx, timestamp_buffer_ns, min_timestamp_ns, receipts_limit)
             .await?;
 
-        let expected_rav = generate_rav(&valid_receipts, previous_rav.clone());
+        let expected_rav = R::generate_rav(&valid_receipts, previous_rav.clone());
 
         Ok(RAVRequest {
             valid_receipts,

tap_core/src/rav.rs

@@ -41,7 +41,7 @@ mod request;
 
 use std::cmp;
 
-use alloy::{primitives::Address, sol};
+use alloy::{primitives::Address, sol, sol_types::SolStruct};
 use serde::{Deserialize, Serialize};
 
 use crate::{
@@ -55,6 +55,16 @@ use crate::{
 pub type SignedRAV = EIP712SignedMessage<ReceiptAggregateVoucher>;
 pub use request::RAVRequest;
 
+pub trait GenerateRav<T>: SolStruct
+where
+    T: SolStruct,
+{
+    fn generate_rav(
+        receipts: &[ReceiptWithState<Reserved, T>],
+        previous_rav: Option<EIP712SignedMessage<Self>>,
+    ) -> Result<Self, Error>;
+}
+
 sol! {
     /// Holds information needed for promise of payment signed with ECDSA
     ///
@@ -122,17 +132,23 @@ impl ReceiptAggregateVoucher {
     }
 }
 
-pub fn generate_expected_rav(
-    receipts: &[ReceiptWithState<Reserved, Receipt>],
-    previous_rav: Option<SignedRAV>,
-) -> Result<ReceiptAggregateVoucher, Error> {
-    if receipts.is_empty() {
-        return Err(Error::NoValidReceiptsForRAVRequest);
+impl GenerateRav<Receipt> for ReceiptAggregateVoucher {
+    fn generate_rav(
+        receipts: &[ReceiptWithState<Reserved, Receipt>],
+        previous_rav: Option<EIP712SignedMessage<Self>>,
+    ) -> Result<Self, Error> {
+        if receipts.is_empty() {
+            return Err(Error::NoValidReceiptsForRAVRequest);
+        }
+        let allocation_id = receipts[0].signed_receipt().message.allocation_id;
+        let receipts = receipts
+            .iter()
+            .map(|rx_receipt| rx_receipt.signed_receipt().clone())
+            .collect::<Vec<_>>();
+        ReceiptAggregateVoucher::aggregate_receipts(
+            allocation_id,
+            receipts.as_slice(),
+            previous_rav,
+        )
     }
-    let allocation_id = receipts[0].signed_receipt().message.allocation_id;
-    let receipts = receipts
-        .iter()
-        .map(|rx_receipt| rx_receipt.signed_receipt().clone())
-        .collect::<Vec<_>>();
-    ReceiptAggregateVoucher::aggregate_receipts(allocation_id, receipts.as_slice(), previous_rav)
 }

tap_core/tests/manager_test.rs

@@ -23,7 +23,7 @@ use tap_core::{
         },
         Manager,
     },
-    rav::{self, ReceiptAggregateVoucher},
+    rav::ReceiptAggregateVoucher,
     receipt::{
         checks::{Check, CheckError, CheckList, StatefulTimestampCheck},
         state::Checking,
@@ -189,9 +189,7 @@ async fn manager_create_rav_request_all_valid_receipts(
             .await
             .is_ok());
     }
-    let rav_request_result = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request_result = manager.create_rav_request(&Context::new(), 0, None).await;
     assert!(rav_request_result.is_ok());
 
     let rav_request = rav_request_result.unwrap();
@@ -287,9 +285,7 @@ async fn manager_create_multiple_rav_requests_all_valid_receipts(
             .is_ok());
         expected_accumulated_value += value;
     }
-    let rav_request_result = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request_result = manager.create_rav_request(&Context::new(), 0, None).await;
     assert!(rav_request_result.is_ok());
 
     let rav_request = rav_request_result.unwrap();
@@ -333,9 +329,7 @@ async fn manager_create_multiple_rav_requests_all_valid_receipts(
             .is_ok());
         expected_accumulated_value += value;
     }
-    let rav_request_result = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request_result = manager.create_rav_request(&Context::new(), 0, None).await;
     assert!(rav_request_result.is_ok());
 
     let rav_request = rav_request_result.unwrap();
@@ -410,9 +404,7 @@ async fn manager_create_multiple_rav_requests_all_valid_receipts_consecutive_tim
         manager.remove_obsolete_receipts().await.unwrap();
     }
 
-    let rav_request_1_result = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request_1_result = manager.create_rav_request(&Context::new(), 0, None).await;
     assert!(rav_request_1_result.is_ok());
 
     let rav_request_1 = rav_request_1_result.unwrap();
@@ -467,9 +459,7 @@ async fn manager_create_multiple_rav_requests_all_valid_receipts_consecutive_tim
         );
     }
 
-    let rav_request_2_result = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request_2_result = manager.create_rav_request(&Context::new(), 0, None).await;
     assert!(rav_request_2_result.is_ok());
 
     let rav_request_2 = rav_request_2_result.unwrap();
@@ -535,7 +525,7 @@ async fn manager_create_rav_and_ignore_invalid_receipts(
     }
 
     let rav_request = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
+        .create_rav_request(&Context::new(), 0, None)
         .await
         .unwrap();
     let expected_rav = rav_request.expected_rav.unwrap();
@@ -616,9 +606,7 @@ async fn test_retryable_checks(
 
     is_create_rav.store(true, std::sync::atomic::Ordering::SeqCst);
 
-    let rav_request = manager
-        .create_rav_request(&Context::new(), 0, None, rav::generate_expected_rav)
-        .await;
+    let rav_request = manager.create_rav_request(&Context::new(), 0, None).await;
 
     assert_eq!(
         rav_request.expect_err("Didn't fail").to_string(),

tap_integration_tests/tests/indexer_mock.rs

@@ -20,7 +20,7 @@ use tap_core::{
         adapters::{EscrowHandler, RAVRead, RAVStore, ReceiptRead, ReceiptStore},
         Manager,
     },
-    rav::{self, ReceiptAggregateVoucher, SignedRAV},
+    rav::{ReceiptAggregateVoucher, SignedRAV},
     receipt::{checks::CheckList, Context, Receipt, SignedReceipt},
 };
 /// Rpc trait represents a JSON-RPC server that has a single async method `request`.
@@ -192,12 +192,7 @@ where
 {
     // Create the aggregate_receipts request params
     let rav_request = manager
-        .create_rav_request(
-            &Context::new(),
-            time_stamp_buffer,
-            None,
-            rav::generate_expected_rav,
-        )
+        .create_rav_request(&Context::new(), time_stamp_buffer, None)
         .await?;
 
     // To-do: Need to add previous RAV, when tap_manager supports replacing receipts