chore: improve comments

Author: uri-99

batcher/aligned-sdk/src/communication/messaging.rs

@@ -29,6 +29,9 @@ pub type ResponseStream = TryFilter<
     fn(&Message) -> Ready<bool>,
 >;
 
+// Sends the proofs to the batcher via WS
+// Stores the proofs sent in an array
+// Returns the array
 pub async fn send_messages(
     ws_write: Arc<Mutex<SplitSink<WebSocketStream<MaybeTlsStream<TcpStream>>, Message>>>,
     payment_service_addr: Address,
@@ -73,10 +76,16 @@ pub async fn send_messages(
 
 
 // Instead of using a channel, use a storage.
+// Using a 
 // From there, you can match received messages to the ones you sent.
 
 // TODO missing analyzing which is the last expected nonce.
 // When received message of last expected nonce, i can exit this function
+
+// Receives the array of proofs sent
+// Reads the WS responses
+// Matches each response with the corresponding proof sent
+// finishes when the last proof sent receives its response
 pub async fn receive(
     response_stream: Arc<Mutex<ResponseStream>>,
     mut sent_verification_data: Vec<NoncedVerificationData>,
@@ -217,8 +226,8 @@ async fn handle_batcher_response(
 }
 
 // Used to match the message received from the batcher,
-// a BatchInclusionData corresponding to the data you need to verify your proof is in a batch
-// with the NoncedVerificationData you sent, used to verify the proof was indeed included in the batch
+// with the NoncedVerificationData you sent
+// This is used to verify the proof you sent was indeed included in the batch
 fn match_batcher_response_with_stored_verification_data(
     batch_inclusion_data: &BatchInclusionData,
     sent_verification_data: &mut Vec<NoncedVerificationData>,
@@ -241,6 +250,9 @@ fn match_batcher_response_with_stored_verification_data(
     Err(SubmitError::InvalidProofInclusionData)
 }
 
+// Returns the biggest nonce from the sent verification data
+// Used to know which is the last proof sent to the Batcher,
+// to know when to stop reading the WS for responses
 fn get_biggest_nonce(sent_verification_data: &Vec<NoncedVerificationData>) -> U256 {
     let mut biggest_nonce = U256::zero();
     for verification_data in sent_verification_data.iter() {

batcher/aligned-sdk/src/core/errors.rs

@@ -212,7 +212,7 @@ impl fmt::Display for SubmitError {
             SubmitError::ProofQueueFlushed => write!(f, "Batch reset"),
             SubmitError::AddToBatchError => write!(f, "Error while adding entry to batch"),
             SubmitError::InvalidProofInclusionData => {
-                write!(f, "Batcher responded with invalid batch inclusion data. Your proof was not correctly included in the batch.")
+                write!(f, "Batcher responded with invalid batch inclusion data. Can't verify your proof was correctly included in the batch.")
             }
         }
     }

batcher/aligned-sdk/src/sdk.rs

@@ -96,7 +96,8 @@ pub async fn submit_multiple_and_wait_verification(
     )
     .await?;
 
-    // TODO maybe use a join to .await all at the same time, avoiding the loop
+    // TODO: open issue: use a join to .await all at the same time, avoiding the loop
+    // And await only once per batch, no need to await multiple proofs if they are in the same batch.
     for aligned_verification_data_item in aligned_verification_data.iter() {
         await_batch_verification(aligned_verification_data_item, eth_rpc_url, network).await?;
     }
@@ -296,7 +297,7 @@ async fn _submit_multiple(
             "verification_data".to_string(),
         ));
     }
-    if verification_data.len() > 10000 { //TODO unhardcode value
+    if verification_data.len() > 10000 { //TODO Magic number
         return Err(errors::SubmitError::GenericError(
             "Trying to submit too many proofs at once".to_string(),
         ));
@@ -311,11 +312,6 @@ async fn _submit_multiple(
 
     let payment_service_addr = get_payment_service_address(network);
 
-        // done sequencial
-        // added size check to avoid sequencial is too big
-        // done added nonce en la respuesta del batcher al sender
-        // done check last nonce to close connection.
-
     let result = async {
         let sent_verification_data = send_messages(ws_write, payment_service_addr, verification_data, max_fees, wallet, nonce).await?;
         receive(response_stream, sent_verification_data).await