apollo_l1_provider: add verification that tx is pending when getting it from proposable index

Author: guy-starkware

crates/apollo_l1_provider/src/l1_provider_tests.rs

@@ -223,6 +223,23 @@ fn add_tx_double_scraped_doesnt_update_scrape_timestamp() {
     assert_eq!(l1_provider, expected_l1_provider);
 }
 
+#[test]
+#[should_panic(expected = "Only Pending transactions should be in the proposable index.")]
+fn get_txs_panics_if_transaction_on_proposable_index_is_not_pending() {
+    // Setup.
+    let mut l1_provider = L1ProviderContentBuilder::new()
+        .with_txs([l1_handler(1)])
+        .with_wrongly_committing_txs_in_proposable_index()
+        .with_state(ProviderState::Pending)
+        .build_into_l1_provider();
+
+    // Put the provider in the right mood for a proposal.
+    l1_provider.start_block(BlockNumber(0), ProposeSession).unwrap();
+
+    // Test.
+    l1_provider.get_txs(1, BlockNumber(0)).unwrap();
+}
+
 #[test]
 fn pending_state_returns_error() {
     // Setup.

crates/apollo_l1_provider/src/test_utils.rs

@@ -258,6 +258,11 @@ impl L1ProviderContentBuilder {
         self
     }
 
+    pub fn with_wrongly_committing_txs_in_proposable_index(mut self) -> Self {
+        self.tx_manager_content_builder.use_wrongly_committing_txs_in_proposable_index = true;
+        self
+    }
+
     pub fn build(mut self) -> L1ProviderContent {
         if let Some(config) = self.config {
             self.tx_manager_content_builder =
@@ -308,6 +313,7 @@ struct TransactionManagerContent {
     pub consumed: Option<Vec<ConsumedTransaction>>,
     pub cancel_requested: Option<Vec<CancellationRequest>>,
     pub config: Option<TransactionManagerConfig>,
+    pub use_wrongly_committing_txs_in_proposable_index: bool,
 }
 
 impl TransactionManagerContent {
@@ -426,6 +432,11 @@ impl From<TransactionManagerContent> for TransactionManager {
         }
 
         let current_epoch = StagingEpoch::new();
+        if content.use_wrongly_committing_txs_in_proposable_index {
+            for (_tx_hash, record) in records.iter_mut() {
+                record.mark_committed();
+            }
+        }
         TransactionManager::create_for_testing(
             records.into(),
             proposable_index,
@@ -444,6 +455,7 @@ struct TransactionManagerContentBuilder {
     consumed: Option<Vec<ConsumedTransaction>>,
     config: Option<TransactionManagerConfig>,
     cancel_requested: Option<Vec<CancellationRequest>>,
+    use_wrongly_committing_txs_in_proposable_index: bool,
 }
 
 impl TransactionManagerContentBuilder {
@@ -532,6 +544,8 @@ impl TransactionManagerContentBuilder {
             rejected: self.rejected,
             cancel_requested: self.cancel_requested,
             config: self.config,
+            use_wrongly_committing_txs_in_proposable_index: self
+                .use_wrongly_committing_txs_in_proposable_index,
         })
     }
 

crates/apollo_l1_provider/src/transaction_manager.rs

@@ -84,6 +84,17 @@ impl TransactionManager {
             .copied()
             .collect();
 
+        for &tx_hash in unstaged_tx_hashes.iter() {
+            let record = self.records.get(&tx_hash).expect("transaction should exist");
+            if record.state != TransactionState::Pending {
+                panic!(
+                    "Transaction {tx_hash} has state {:?}. Only Pending transactions should be in \
+                     the proposable index.",
+                    record.state
+                );
+            }
+        }
+
         let mut txs = Vec::with_capacity(n_txs);
         let current_staging_epoch = self.current_staging_epoch; // borrow-checker constraint.
         for tx_hash in unstaged_tx_hashes {