Adding more comments

Author: snorochevskiy

grpc/src/asseturls.rs

@@ -90,7 +90,8 @@ impl DownloadError {
 /// Generated client implementations.
 pub mod asset_url_service_client {
     #![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
-    use tonic::codegen::{http::Uri, *};
+    use tonic::codegen::http::Uri;
+    use tonic::codegen::*;
     #[derive(Debug, Clone)]
     pub struct AssetUrlServiceClient<T> {
         inner: tonic::client::Grpc<T>,

grpc/src/consistencyapi.rs

@@ -305,6 +305,7 @@ pub mod bbgm_consistency_service_client {
             ));
             self.inner.unary(req, path, codec).await
         }
+        /// Request all the bubblegum grand epochs checksums for the given tree
         pub async fn get_bbgm_grand_epochs_for_tree(
             &mut self,
             request: impl tonic::IntoRequest<super::GetBbgmGrandEpochsForTreeReq>,
@@ -604,6 +605,7 @@ pub mod bbgm_consistency_service_server {
             &self,
             request: tonic::Request<()>,
         ) -> std::result::Result<tonic::Response<super::BbgmEarlistGrandEpoch>, tonic::Status>;
+        /// Request all the bubblegum grand epochs checksums for the given tree
         async fn get_bbgm_grand_epochs_for_tree(
             &self,
             request: tonic::Request<super::GetBbgmGrandEpochsForTreeReq>,

nft_ingester/src/bin/ingester/main.rs

@@ -217,6 +217,8 @@ pub async fn main() -> Result<(), IngesterError> {
 
     let rpc_client = Arc::new(RpcClient::new(config.rpc_host.clone()));
 
+    // Manages event related to epochs changes and notifications (new epoch started, late data - epoch invalidation).
+    // Producers are processors (bubblegum and account), consumer - consistency calculator.
     let (nft_change_snd, nft_change_rcv) = mpsc::channel(NTF_CHANGES_NOTIFICATION_QUEUE_SIZE);
     let changes_tracker = Arc::new(NftChangesTracker::new(Some(nft_change_snd.clone())));
 

nft_ingester/src/consistency_calculator.rs

@@ -13,7 +13,7 @@ use rocks_db::{
         AccountNft, AccountNftBucket, AccountNftBucketKey, AccountNftChange, AccountNftChangeKey,
         AccountNftGrandBucket, AccountNftGrandBucketKey, AccountNftKey, BubblegumChange,
         BubblegumChangeKey, BubblegumEpoch, BubblegumEpochKey, BubblegumGrandEpoch,
-        BubblegumGrandEpochKey, ACC_BUCKET_INVALIDATE, ACC_GRAND_BUCKET_INVALIDATE,
+        BubblegumGrandEpochKey, ACC_BUCKET_INVALIDATE, ACC_GRAND_BUCKET_INVALIDATED,
         BUBBLEGUM_GRAND_EPOCH_INVALIDATED,
     },
     Storage,
@@ -103,7 +103,7 @@ impl NftChangesTracker {
         NftChangesTracker { sender }
     }
 
-    /// Persists given account NFT change into the sotrage, and, if the change is from the epoch
+    /// Persists given account NFT change into the storage, and, if the change is from the epoch
     /// that is previous to the current epoch, then also notifies checksums calculator
     /// about late data.
     ///
@@ -138,7 +138,7 @@ impl NftChangesTracker {
             let grand_bucket = grand_bucket_for_bucket(bucket);
             let _ = batch_storage.put_acc_grand_bucket(
                 AccountNftGrandBucketKey::new(grand_bucket),
-                ACC_GRAND_BUCKET_INVALIDATE,
+                ACC_GRAND_BUCKET_INVALIDATED,
             );
             let _ = batch_storage
                 .put_acc_bucket(AccountNftBucketKey::new(bucket), ACC_BUCKET_INVALIDATE);
@@ -752,7 +752,7 @@ async fn update_acc_if_needed(
                 .acc_nft_grand_buckets
                 .put_async(
                     AccountNftGrandBucketKey::new(grand_bucket),
-                    ACC_GRAND_BUCKET_INVALIDATE,
+                    ACC_GRAND_BUCKET_INVALIDATED,
                 )
                 .await;
             invalidated_grand_buckets.insert(grand_bucket);

rocks-db/src/storage_consistency.rs

@@ -28,19 +28,23 @@ use crate::{column::TypedColumn, transaction::TreeUpdate, Storage};
 
 use std::{collections::HashSet, sync::atomic::AtomicU64, u64};
 
+/// Last slot seen by any of solana blocks processors.
 static LAST_SLOT: AtomicU64 = AtomicU64::new(0);
 
+/// Returns current epoch based on the last seen solana slot
 pub fn current_estimated_epoch() -> u32 {
     epoch_of_slot(LAST_SLOT.load(std::sync::atomic::Ordering::Relaxed))
 }
 
 pub fn last_tracked_slot() -> u64 {
+    // Doesn't guarantee to be fully accurate, which is fine
     LAST_SLOT.load(std::sync::atomic::Ordering::Relaxed)
 }
 
 pub fn track_slot_counter(slot: u64) -> u64 {
     let prev = LAST_SLOT.load(std::sync::atomic::Ordering::Relaxed);
     if slot > prev {
+        // This code does not guaranteed to store the top slot processed, rather one of the top slots.
         LAST_SLOT.store(slot, std::sync::atomic::Ordering::Relaxed);
     }
     prev
@@ -123,7 +127,7 @@ pub const ACC_BUCKET_INVALIDATE: AccountNftBucket = AccountNftBucket {
     checksum: Checksum::Invalidated,
 };
 
-pub const ACC_GRAND_BUCKET_INVALIDATE: AccountNftGrandBucket = AccountNftGrandBucket {
+pub const ACC_GRAND_BUCKET_INVALIDATED: AccountNftGrandBucket = AccountNftGrandBucket {
     checksum: Checksum::Invalidated,
 };