Rename ImmutableNumber to ImmutableFileNumber

Author: Alenar

mithril-aggregator/src/http_server.rs

@@ -199,7 +199,7 @@ mod handlers {
                 let digest = message.clone();
                 let certificate_hash = message;
                 let previous_hash = "".to_string();
-                let block = beacon.immutable_number;
+                let block = beacon.immutable_file_number;
                 let timestamp: DateTime<Utc> = Utc::now();
                 let started_at = format!("{:?}", timestamp);
                 let completed_at = started_at.clone();

mithril-aggregator/src/runtime.rs

@@ -52,7 +52,7 @@ impl AggregatorRuntime {
             Ok(digest_result) => {
                 let mut beacon_store = self.beacon_store.write().await;
                 let mut beacon = fake_data::beacon();
-                beacon.immutable_number = digest_result.last_immutable_number;
+                beacon.immutable_file_number = digest_result.last_immutable_file_number;
                 beacon_store.set_current_beacon(beacon).await?;
                 snapshotter
                     .snapshot(digest_result.digest)

mithril-common/src/entities.rs

@@ -3,7 +3,7 @@
 
 use serde::{Deserialize, Serialize};
 
-pub type ImmutableNumber = u64;
+pub type ImmutableFileNumber = u64;
 
 /// Beacon represents a point in the Cardano chain at which a Mithril certificate should be produced
 #[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
@@ -16,18 +16,18 @@ pub struct Beacon {
     #[serde(rename = "epoch")]
     pub epoch: u64,
 
-    /// Cardano chain block number
-    #[serde(rename = "immutable_number")]
-    pub immutable_number: ImmutableNumber,
+    /// Number of the last included immutable files for the digest computation
+    #[serde(rename = "immutable_file_number")]
+    pub immutable_file_number: ImmutableFileNumber,
 }
 
 impl Beacon {
     /// Beacon factory
-    pub fn new(network: String, epoch: u64, immutable_number: u64) -> Beacon {
+    pub fn new(network: String, epoch: u64, immutable_file_number: u64) -> Beacon {
         Beacon {
             network,
             epoch,
-            immutable_number,
+            immutable_file_number,
         }
     }
 }

mithril-common/src/fake_data.rs

@@ -22,7 +22,7 @@ pub fn digest() -> Vec<u8> {
     let beacon = beacon();
     format!(
         "digest-{}-{}-{}",
-        beacon.network, beacon.epoch, beacon.immutable_number
+        beacon.network, beacon.epoch, beacon.immutable_file_number
     )
     .as_bytes()
     .to_vec()
@@ -67,7 +67,7 @@ pub fn certificate(certificate_hash: String) -> entities::Certificate {
 
     // Certificate
     let previous_hash = format!("{}0", certificate_hash);
-    let block = beacon.immutable_number;
+    let block = beacon.immutable_file_number;
     let digest = format!("1{}", block).repeat(20);
     let started_at = "2006-01-02T15:04:05Z".to_string();
     let completed_at = "2006-01-02T15:04:05Z".to_string();

mithril-common/src/immutable_digester.rs

@@ -1,4 +1,4 @@
-use crate::entities::ImmutableNumber;
+use crate::entities::ImmutableFileNumber;
 
 use sha2::{Digest, Sha256};
 use slog::{info, Logger};
@@ -37,7 +37,7 @@ pub struct ImmutableDigesterResult {
     pub digest: String,
 
     /// The number of the last immutable file used to compute the digest
-    pub last_immutable_number: ImmutableNumber,
+    pub last_immutable_file_number: ImmutableFileNumber,
 }
 
 impl ImmutableDigester {
@@ -65,7 +65,7 @@ impl ImmutableDigester {
 
         Ok(ImmutableDigesterResult {
             digest,
-            last_immutable_number: last_immutable.number,
+            last_immutable_file_number: last_immutable.number,
         })
     }
 
@@ -120,7 +120,7 @@ fn is_immutable(path: &Path) -> bool {
 #[derive(Debug)]
 struct ImmutableFile {
     path: PathBuf,
-    number: ImmutableNumber,
+    number: ImmutableFileNumber,
 }
 
 impl ImmutableFile {
@@ -132,13 +132,13 @@ impl ImmutableFile {
             "Couldn't extract the filename as string for '{:?}'",
             path
         ))?;
-        let immutable_number = filename
-            .parse::<ImmutableNumber>()
+        let immutable_file_number = filename
+            .parse::<ImmutableFileNumber>()
             .map_err(|e| e.to_string())?;
 
         Ok(Self {
             path,
-            number: immutable_number,
+            number: immutable_file_number,
         })
     }
 

openapi.yaml

@@ -202,7 +202,7 @@ components:
       required:
         - network
         - epoch
-        - immutable_number
+        - immutable_file_number
       properties:
         network:
           description: Cardano network
@@ -211,11 +211,11 @@ components:
           description: Cardano chain epoch number
           type: integer
           format: int64
-        immutable_number:
+        immutable_file_number:
           description: Number of the last immutable file that should be included the snapshot
           type: integer
           format: int64
-      example: { "network": "mainnet", "epoch": 329, "immutable_number": 7060000 }
+      example: { "network": "mainnet", "epoch": 329, "immutable_file_number": 7060000 }
 
     CertificatePending:
       description: CertificatePending represents all the informations related to the certificate currently expecting to receive quorum of single signatures