apollo_l1_provider: add flow test for finality (#10894)

Author: guy-starkware

crates/apollo_l1_provider/tests/flow_test_cancellation.rs

@@ -33,7 +33,7 @@ async fn new_l1_handler_tx_propose_validate_cancellation_timelock() {
     let (l2_hash, nonce) = send_message_from_l1_to_l2(&mut base_layer, CALL_DATA).await;
 
     let l1_provider_client =
-        setup_scraper_and_provider(base_layer.ethereum_base_layer.clone()).await;
+        setup_scraper_and_provider(base_layer.ethereum_base_layer.clone(), None).await;
 
     // Test.
     tokio::time::pause();

crates/apollo_l1_provider/tests/flow_test_consumed.rs

@@ -99,7 +99,7 @@ async fn l1_handler_tx_consumed_txs() {
         Ok(all_events[start..end_exclusive].to_vec())
     });
 
-    let l1_provider_client = setup_scraper_and_provider(base_layer).await;
+    let l1_provider_client = setup_scraper_and_provider(base_layer, None).await;
 
     tokio::time::pause();
     let snapshot = l1_provider_client.get_l1_provider_snapshot().await.unwrap();

crates/apollo_l1_provider/tests/flow_test_finality.rs

@@ -0,0 +1,79 @@
+#![cfg(any(test, feature = "testing"))]
+mod utils;
+
+use apollo_l1_provider_types::{
+    InvalidValidationStatus,
+    L1ProviderClient,
+    SessionState,
+    ValidationStatus,
+};
+use apollo_l1_scraper_config::config::L1ScraperConfig;
+use starknet_api::block::BlockNumber;
+use utils::{
+    send_message_from_l1_to_l2,
+    setup_anvil_base_layer,
+    setup_scraper_and_provider,
+    CALL_DATA,
+    CALL_DATA_2,
+    CHAIN_ID,
+    POLLING_INTERVAL_DURATION,
+    ROUND_TO_SEC_MARGIN_DURATION,
+    TARGET_L2_HEIGHT,
+    WAIT_FOR_ASYNC_PROCESSING_DURATION,
+};
+
+#[tokio::test]
+async fn only_scrape_after_finality() {
+    // Setup.
+    const FINALITY: u64 = 3;
+
+    // Setup the base layer.
+    let mut base_layer = setup_anvil_base_layer().await;
+
+    let (l2_hash, _nonce) = send_message_from_l1_to_l2(&mut base_layer, CALL_DATA).await;
+
+    let l1_scraper_config = L1ScraperConfig {
+        finality: FINALITY,
+        polling_interval_seconds: POLLING_INTERVAL_DURATION,
+        chain_id: CHAIN_ID,
+        ..Default::default()
+    };
+    let l1_provider_client =
+        setup_scraper_and_provider(base_layer.ethereum_base_layer.clone(), Some(l1_scraper_config))
+            .await;
+
+    tokio::time::pause();
+
+    // Test.
+    let next_block_height = BlockNumber(TARGET_L2_HEIGHT.0 + 1);
+
+    // The transaction is not yet scraped, it hasn't got enough blocks after it.
+    l1_provider_client.start_block(SessionState::Validate, next_block_height).await.unwrap();
+    assert_eq!(
+        l1_provider_client.validate(l2_hash, next_block_height).await.unwrap(),
+        ValidationStatus::Invalid(InvalidValidationStatus::NotFound)
+    );
+
+    // Send few more blocks (by sending more txs).
+    for _ in 0..FINALITY {
+        let (other_l2_hash, _nonce) =
+            send_message_from_l1_to_l2(&mut base_layer, CALL_DATA_2).await;
+        assert_ne!(l2_hash, other_l2_hash);
+    }
+
+    // Wait for another scraping.
+    tokio::time::advance(POLLING_INTERVAL_DURATION + ROUND_TO_SEC_MARGIN_DURATION).await;
+    for _i in 0..100 {
+        let snapshot = l1_provider_client.get_l1_provider_snapshot().await.unwrap();
+        if snapshot.uncommitted_transactions.contains(&l2_hash) {
+            break;
+        }
+        tokio::time::sleep(WAIT_FOR_ASYNC_PROCESSING_DURATION).await;
+    }
+
+    // Check that we can validate the message now.
+    assert_eq!(
+        l1_provider_client.validate(l2_hash, next_block_height).await.unwrap(),
+        ValidationStatus::Validated
+    );
+}

crates/apollo_l1_provider/tests/flow_test_happy_flow.rs

@@ -31,7 +31,7 @@ async fn new_l1_handler_tx_propose_validate_cooldown() {
     let (l2_hash, _nonce) = send_message_from_l1_to_l2(&mut base_layer, CALL_DATA).await;
 
     let l1_provider_client =
-        setup_scraper_and_provider(base_layer.ethereum_base_layer.clone()).await;
+        setup_scraper_and_provider(base_layer.ethereum_base_layer.clone(), None).await;
 
     tokio::time::pause();
 

crates/apollo_l1_provider/tests/utils/mod.rs

@@ -49,7 +49,7 @@ pub(crate) const COOLDOWN_DURATION: Duration = Duration::from_secs(30);
 pub(crate) const TIMELOCK_DURATION: Duration = Duration::from_secs(30);
 pub(crate) const WAIT_FOR_ASYNC_PROCESSING_DURATION: Duration = Duration::from_millis(50);
 const NUMBER_OF_BLOCKS_TO_MINE: u64 = 100;
-const CHAIN_ID: ChainId = ChainId::Mainnet;
+pub(crate) const CHAIN_ID: ChainId = ChainId::Mainnet;
 pub(crate) const L1_CONTRACT_ADDRESS: u64 = 1;
 pub(crate) const L2_ENTRY_POINT: u64 = 34;
 pub(crate) const CALL_DATA: &[u8] = &[1_u8, 2_u8];
@@ -82,6 +82,7 @@ pub(crate) async fn setup_scraper_and_provider<
     E: Error + Send + Sync + Debug + 'static,
 >(
     base_layer: T,
+    l1_scraper_config: Option<L1ScraperConfig>,
 ) -> LocalComponentClient<L1ProviderRequest, L1ProviderResponse> {
     let fake_clock = Arc::new(TokioLinkedClock::new());
 
@@ -123,11 +124,11 @@ pub(crate) async fn setup_scraper_and_provider<
     });
 
     // Set up the L1 scraper and run it as a server.
-    let l1_scraper_config = L1ScraperConfig {
+    let l1_scraper_config = l1_scraper_config.unwrap_or_else(|| L1ScraperConfig {
         polling_interval_seconds: POLLING_INTERVAL_DURATION,
         chain_id: CHAIN_ID,
         ..Default::default()
-    };
+    });
     let mut scraper = L1Scraper::new(
         l1_scraper_config,
         Arc::new(l1_provider_client.clone()),