Add comments to origin/Document-transactionl1_handler module

src/transaction/l1_handler.rs

@@ -24,6 +24,7 @@ use num_traits::Zero;
 
 #[allow(dead_code)]
 #[derive(Debug, Getters, Clone)]
+/// Represents an L1Handler transaction in the StarkNet network.
 pub struct L1Handler {
     #[getset(get = "pub")]
     hash_value: Felt252,
@@ -38,6 +39,7 @@ pub struct L1Handler {
 }
 
 impl L1Handler {
+    /// Constructor creates a new [L1Handler] instance.
     pub fn new(
         contract_address: Address,
         entry_point_selector: Felt252,
@@ -66,7 +68,12 @@ impl L1Handler {
             hash_value,
         )
     }
-
+    /// Creates a new [L1Handler] instance with a specified transaction hash.
+    ///
+    /// # Safety
+    ///
+    /// `tx_hash` will be assumed to be the same as would result from calling
+    /// `calculate_transaction_hash_common`. Non-compliance will result in silent misbehavior.
     pub fn new_with_tx_hash(
         contract_address: Address,
         entry_point_selector: Felt252,
@@ -191,6 +198,8 @@ impl L1Handler {
             L1_HANDLER_VERSION.into(),
         ))
     }
+
+    /// Creates a L1Handler for simulation purposes.
     pub(crate) fn create_for_simulation(
         &self,
         skip_validate: bool,
@@ -234,6 +243,7 @@ mod test {
         utils::Address,
     };
 
+    /// Test the correct execution of the L1Handler.
     #[test]
     fn test_execute_l1_handler() {
         let l1_handler = L1Handler::new(
@@ -293,6 +303,8 @@ mod test {
         assert_eq!(tx_exec, expected_tx_exec)
     }
 
+    /// Helper function to construct the expected transaction execution info.
+    /// Expected output of the L1Handler's execution.
     fn expected_tx_exec_info() -> TransactionExecutionInfo {
         TransactionExecutionInfo {
             validate_info: None,