chore: add docs to structs and events

Author: MarcosNicolau

batcher/aligned-sdk/src/beacon.rs

@@ -5,6 +5,7 @@ use reqwest::{Client, Url};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 
+// See https://eips.ethereum.org/EIPS/eip-4844#parameters
 pub const KZG_VERSIONED_HASH: u8 = 0x1;
 
 pub struct BeaconClient {
@@ -29,6 +30,7 @@ pub enum BeaconClientError {
 
 #[derive(Deserialize, Debug)]
 #[allow(dead_code)]
+// https://ethereum.github.io/beacon-APIs/#/Beacon/getBlobSidecars
 pub struct BlobData {
     pub index: String,
     pub blob: String,
@@ -39,13 +41,16 @@ pub struct BlobData {
 
 #[derive(Deserialize, Debug)]
 #[allow(dead_code)]
+
+// https://ethereum.github.io/beacon-APIs/#/Beacon/getBlockHeaders
 pub struct BeaconBlock {
     pub root: String,
     pub canonical: bool,
     pub header: BeaconBlockHeader,
 }
 
 #[derive(Deserialize, Debug)]
+
 pub struct BeaconBlockHeader {
     pub message: BeaconBlockMessage,
 }

batcher/aligned-sdk/src/sdk/aggregation.rs

@@ -93,9 +93,12 @@ pub async fn is_proof_verified_in_aggregation_mode(
 
     let logs = eth_rpc_provider.get_logs(&filter).await.unwrap();
     for log in logs {
+        // First 32 bytes of the data are the bytes of the blob versioned hash
         let blob_versioned_hash: [u8; 32] = log.data[0..32]
             .try_into()
             .map_err(|_| ProofVerificationAggModeError::EventDecoding)?;
+
+        // Event is indexed by merkle root
         let merkle_root = log.topics[1].0;
 
         // Block Number shouldn't be empty, in case it is,