fix(cardano-chain-follower): comments

Signed-off-by: bkioshn <[email protected]>

Author: bkioshn

rust/cardano-chain-follower/src/mithril_snapshot_data.rs

@@ -26,7 +26,7 @@ impl SnapshotData {
 }
 
 impl default::Default for SnapshotData {
-    /// The default snapshot data represents there is no latest snapshot.
+    /// The default snapshot data represents, there is no latest snapshot.
     fn default() -> Self {
         SnapshotData {
             id: SnapshotId::default(),
@@ -41,7 +41,6 @@ static CURRENT_MITHRIL_SNAPSHOT: LazyLock<DashMap<Network, SnapshotData>> =
 /// Get the current latest snapshot data we have recorded.
 pub(crate) fn latest_mithril_snapshot_data(chain: Network) -> SnapshotData {
     // There should ALWAYS be a snapshot for the chain if this is called.
-
     match CURRENT_MITHRIL_SNAPSHOT.get(&chain) {
         Some(snapshot_data) => snapshot_data.value().clone(),
         None => SnapshotData::default(),

rust/cardano-chain-follower/src/mithril_snapshot_iterator.rs

@@ -23,9 +23,9 @@ const BACKWARD_SEARCH_SLOT_INTERVAL: u64 = 60;
 
 /// Synchronous Inner Iterator state
 struct MithrilSnapshotIteratorInner {
-    /// The chain being iterated
+    /// The blockchain network being iterated
     chain: Network,
-    /// Where we really want to start iterating from
+    /// Point we want to start iterating from
     start: Point,
     /// Previous iteration point.
     previous: Point,

rust/cardano-chain-follower/src/mithril_snapshot_sync.rs

@@ -73,7 +73,7 @@ async fn get_latest_snapshots(
     Some((latest_snapshot.clone(), chronologically_previous.clone()))
 }
 
-/// Given a particular snapshot ID, find the Actual Snapshot for it.
+/// Given a particular snapshot ID, find the actual snapshot for it.
 async fn get_snapshot_by_id(
     client: &Client, network: Network, snapshot_id: &SnapshotId,
 ) -> Option<SnapshotListItem> {
@@ -205,11 +205,7 @@ async fn download_and_verify_snapshot_certificate(
 ///
 /// # Arguments
 ///
-/// * `network` - The network type for the client to connect to.
-/// * `aggregator_url` - A reference to the URL of an aggregator that can be used to
-///   create the client.
-/// * `genesis_vkey` - The genesis verification key, which is needed to authenticate with
-///   the server.
+/// * `cfg` - Mithril snapshot configuration.
 ///
 /// # Returns
 ///
@@ -238,6 +234,7 @@ pub(crate) const MITHRIL_IMMUTABLE_SUB_DIRECTORY: &str = "immutable";
 ///
 /// # Arguments
 ///
+/// * `chain` - The network chain to get the tip block from.
 /// * `path` - The path where the immutable chain is stored.
 ///
 /// # Returns
@@ -676,11 +673,8 @@ macro_rules! next_iteration {
 /// networks.
 /// # Arguments
 ///
-/// * `network` - The network type for the client to connect to.
-/// * `aggregator_url` - A reference to the URL of an aggregator that can be used to
-///   create the client.
-/// * `genesis_vkey` - The genesis verification key, which is needed to authenticate with
-///   the server.
+/// * `cfg` - The configuration for the Mithril snapshot.
+/// * `tx` - The message to be sent when Mithril Snapshot updates.
 ///
 /// # Returns
 ///

rust/cardano-chain-follower/src/snapshot_id.rs

@@ -11,19 +11,19 @@ use cardano_blockchain_types::{Network, Point};
 use tracing::debug;
 
 use crate::mithril_snapshot_sync::{get_mithril_tip, MITHRIL_IMMUTABLE_SUB_DIRECTORY};
-/// A Representation of a Snapshot Path and its represented Immutable File Number.
+/// A representation of a Snapshot Path and its represented immutable file number.
 #[derive(Clone, Debug)]
 pub(crate) struct SnapshotId {
-    /// The Snapshot Path
+    /// The snapshot path
     path: PathBuf,
-    /// The largest Immutable File Number
+    /// The largest immutable file number
     file: u64,
-    /// The Tip of the Snapshot
+    /// The tip of the Snapshot
     tip: Point,
 }
 
 impl SnapshotId {
-    /// See if we can Parse the path into an immutable file number.
+    /// See if we can parse the path into an immutable file number.
     pub(crate) fn parse_path(path: &Path) -> Option<u64> {
         // Path must actually exist, and be a directory.
         if !path.is_dir() {
@@ -42,7 +42,7 @@ impl SnapshotId {
     }
 
     /// Try and create a new `SnapshotID` from a given path.
-    /// Immutable TIP must be provided.
+    /// Immutable tip must be provided.
     pub(crate) fn new(path: &Path, tip: Point) -> Option<Self> {
         debug!("Trying to Get SnapshotID of: {}", path.to_string_lossy());
         let immutable_file = SnapshotId::parse_path(path)?;
@@ -56,7 +56,7 @@ impl SnapshotId {
     }
 
     /// Try and create a new `SnapshotID` from a given path.
-    /// Includes properly getting the Immutable TIP.
+    /// Includes properly getting the immutable TIP.
     pub(crate) async fn try_new(chain: Network, path: &Path) -> Option<Self> {
         let Ok(tip) = get_mithril_tip(chain, path).await else {
             return None;
@@ -65,28 +65,28 @@ impl SnapshotId {
         SnapshotId::new(path, tip.point())
     }
 
-    /// Get the Immutable Blockchain path from this `SnapshotId`
+    /// Get the immutable blockchain path from this `SnapshotId`
     pub(crate) fn immutable_path(&self) -> PathBuf {
         let mut immutable = self.path.clone();
         immutable.push(MITHRIL_IMMUTABLE_SUB_DIRECTORY);
 
         immutable
     }
 
-    /// Get the Blockchain path from this `SnapshotId`
+    /// Get the blockchain path from this `SnapshotId`
     pub(crate) fn path(&self) -> PathBuf {
         self.path.clone()
     }
 
-    /// Get the Blockchain path from this `SnapshotId` only if it actually exists.
+    /// Get the blockchain path from this `SnapshotId` only if it actually exists.
     pub(crate) fn path_if_exists(&self) -> Option<PathBuf> {
         if self.tip.is_unknown() {
             return None;
         }
         Some(self.path.clone())
     }
 
-    /// Get the Tip of the Immutable Blockchain from this `SnapshotId`
+    /// Get the tip of the immutable blockchain from this `SnapshotId`
     pub(crate) fn tip(&self) -> Point {
         self.tip.clone()
     }
@@ -122,27 +122,24 @@ impl Display for SnapshotId {
     }
 }
 
-// Normal Comparisons to simplify code.
+// Normal comparisons to simplify code.
 impl PartialEq for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn eq(&self, other: &Self) -> bool {
         self.file == other.file
     }
 }
 
 impl PartialOrd for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
         self.file.partial_cmp(&other.file)
     }
 }
 
-// Allows us to compare a SnapshotID against Some(SnapshotID).
+// Allows us to compare a `SnapshotID` against Some(`SnapshotID`).
 impl PartialEq<Option<SnapshotId>> for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn eq(&self, other: &Option<Self>) -> bool {
         match other {
             None => false,
@@ -152,8 +149,7 @@ impl PartialEq<Option<SnapshotId>> for SnapshotId {
 }
 
 impl PartialOrd<Option<SnapshotId>> for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn partial_cmp(&self, other: &Option<Self>) -> Option<Ordering> {
         match other {
             None => Some(Ordering::Greater), // Anything is always greater than None.
@@ -162,18 +158,16 @@ impl PartialOrd<Option<SnapshotId>> for SnapshotId {
     }
 }
 
-// Allows us to compare a SnapshotID against u64 (Just the Immutable File Number).
+// Allows us to compare a `SnapshotID` against u64 (just the immutable file number).
 impl PartialEq<u64> for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn eq(&self, other: &u64) -> bool {
         self.file == *other
     }
 }
 
 impl PartialOrd<u64> for SnapshotId {
-    // Equality ONLY checks the Immutable File Number, not the path.
-    // This is because the Filename is already the ImmutableFileNumber
+    // Equality ONLY checks the `file` (immutable file number), not the path.
     fn partial_cmp(&self, other: &u64) -> Option<Ordering> {
         self.file.partial_cmp(other)
     }