apollo_l1_provider: remove some panics in the L1 Provider

Author: guy-starkware

crates/apollo_l1_provider/src/l1_provider.rs

@@ -169,6 +169,8 @@ impl L1Provider {
                     if let Err(previously_consumed_at) =
                         self.tx_manager.consume_tx(tx_hash, consumed_at, self.clock.unix_now())
                     {
+                        // TODO(guyn): need to check if this is really a critical bug, or if we can
+                        // log and ignore.
                         panic!(
                             "Double consumption of {tx_hash} at {consumed_at}, previously \
                              consumed at {previously_consumed_at}."
@@ -228,12 +230,10 @@ impl L1Provider {
                 );
                 Ok(txs)
             }
-            ProviderState::Pending => {
-                panic!(
-                    "get_txs called while in pending state. Panicking in order to restart the \
-                     provider and bootstrap again."
-                );
-            }
+            ProviderState::Pending => Err(L1ProviderError::UnexpectedProviderState {
+                expected: ProviderState::Propose,
+                found: self.state,
+            }),
             ProviderState::Bootstrap => Err(L1ProviderError::OutOfSessionGetTransactions),
             ProviderState::Validate => Err(L1ProviderError::GetTransactionConsensusBug),
             ProviderState::Uninitialized => Err(L1ProviderError::Uninitialized),
@@ -259,12 +259,10 @@ impl L1Provider {
                 Ok(self.tx_manager.validate_tx(tx_hash, self.clock.unix_now()))
             }
             ProviderState::Propose => Err(L1ProviderError::ValidateTransactionConsensusBug),
-            ProviderState::Pending => {
-                panic!(
-                    "validate called while in pending state. Panicking in order to restart the \
-                     provider and bootstrap again."
-                );
-            }
+            ProviderState::Pending => Err(L1ProviderError::UnexpectedProviderState {
+                expected: ProviderState::Validate,
+                found: self.state,
+            }),
             ProviderState::Bootstrap => Err(L1ProviderError::OutOfSessionValidate),
             ProviderState::Uninitialized => Err(L1ProviderError::Uninitialized),
         }

crates/apollo_l1_provider/src/l1_provider_tests.rs

@@ -1,5 +1,4 @@
 use std::collections::HashMap;
-use std::panic::{catch_unwind, AssertUnwindSafe};
 use std::sync::{Arc, Mutex};
 use std::time::Duration;
 
@@ -210,19 +209,27 @@ fn process_events_committed_txs() {
 }
 
 #[test]
-fn pending_state_panics() {
+fn pending_state_returns_error() {
     // Setup.
     let mut l1_provider = L1ProviderContentBuilder::new()
         .with_state(ProviderState::Pending)
         .with_txs([l1_handler(1)])
         .build_into_l1_provider();
 
     // Test.
-    assert!(catch_unwind(AssertUnwindSafe(|| { l1_provider.get_txs(1, BlockNumber(0)) })).is_err());
-
-    assert!(
-        catch_unwind(AssertUnwindSafe(|| { l1_provider.validate(tx_hash!(1), BlockNumber(0)) }))
-            .is_err()
+    assert_eq!(
+        l1_provider.get_txs(1, BlockNumber(0)),
+        Err(L1ProviderError::UnexpectedProviderState {
+            expected: ProviderState::Propose,
+            found: ProviderState::Pending
+        })
+    );
+    assert_eq!(
+        l1_provider.validate(tx_hash!(1), BlockNumber(0)),
+        Err(L1ProviderError::UnexpectedProviderState {
+            expected: ProviderState::Validate,
+            found: ProviderState::Pending
+        })
     );
 }
 

crates/apollo_l1_provider_types/src/errors.rs

@@ -5,6 +5,8 @@ use serde::{Deserialize, Serialize};
 use starknet_api::block::BlockNumber;
 use thiserror::Error;
 
+use crate::ProviderState;
+
 #[derive(Clone, Debug, Error, PartialEq, Eq, Serialize, Deserialize)]
 pub enum L1ProviderError {
     #[error("`get_txs` while in `Validate` state")]
@@ -22,6 +24,8 @@ pub enum L1ProviderError {
     Uninitialized,
     #[error("Unexpected height: expected {expected_height}, got {got}")]
     UnexpectedHeight { expected_height: BlockNumber, got: BlockNumber },
+    #[error("Unexpected provider state: {expected}, got: {found}")]
+    UnexpectedProviderState { expected: ProviderState, found: ProviderState },
     #[error("Cannot transition from {from} to {to}")]
     UnexpectedProviderStateTransition { from: String, to: String },
     #[error("`validate` called while in `Propose` state")]