Move epoch offset constants to the Epoch type

+ All offset computation that can lead to negative values must now
use the safe `Epoch::offset_by` method

Author: Alenar

mithril-aggregator/src/multi_signer.rs

@@ -726,8 +726,9 @@ mod tests {
         ProtocolParametersStore,
     };
     use mithril_common::{
-        crypto_helper::tests_setup::*, fake_data, store::adapter::MemoryAdapter, store::StakeStore,
-        SIGNER_EPOCH_RECORDING_OFFSET, SIGNER_EPOCH_RETRIEVAL_OFFSET,
+        crypto_helper::tests_setup::*,
+        fake_data,
+        store::{adapter::MemoryAdapter, StakeStore},
     };
     use std::{collections::HashMap, sync::Arc};
 
@@ -843,7 +844,7 @@ mod tests {
 
         offset_epoch(
             &mut multi_signer,
-            SIGNER_EPOCH_RECORDING_OFFSET - SIGNER_EPOCH_RETRIEVAL_OFFSET,
+            Epoch::SIGNER_RECORDING_OFFSET as i64 - Epoch::SIGNER_RETRIEVAL_OFFSET,
         )
         .await;
 
@@ -879,7 +880,7 @@ mod tests {
 
         offset_epoch(
             &mut multi_signer,
-            SIGNER_EPOCH_RECORDING_OFFSET - SIGNER_EPOCH_RETRIEVAL_OFFSET,
+            Epoch::SIGNER_RECORDING_OFFSET as i64 - Epoch::SIGNER_RETRIEVAL_OFFSET,
         )
         .await;
 
@@ -944,7 +945,7 @@ mod tests {
 
         offset_epoch(
             &mut multi_signer,
-            SIGNER_EPOCH_RECORDING_OFFSET - SIGNER_EPOCH_RETRIEVAL_OFFSET,
+            Epoch::SIGNER_RECORDING_OFFSET as i64 - Epoch::SIGNER_RETRIEVAL_OFFSET,
         )
         .await;
         // We have to update the current message AFTER we reached the epoch for

mithril-common/src/entities/epoch.rs

@@ -1,7 +1,3 @@
-use crate::{
-    NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET, SIGNER_EPOCH_RECORDING_OFFSET,
-    SIGNER_EPOCH_RETRIEVAL_OFFSET,
-};
 use serde::{Deserialize, Serialize};
 use std::{
     fmt::{Display, Formatter},
@@ -16,9 +12,19 @@ use thiserror::Error;
 pub struct Epoch(pub u64);
 
 impl Epoch {
+    /// The epoch offset used for signers stake distribution and verification keys retrieval.
+    pub const SIGNER_RETRIEVAL_OFFSET: i64 = -1;
+
+    /// The epoch offset used to retrieve the signers stake distribution and verification keys that's
+    /// currently being signed so it can be used in the next epoch.
+    pub const NEXT_SIGNER_RETRIEVAL_OFFSET: u64 = 0;
+
+    /// The epoch offset used for signers stake distribution and verification keys recording.
+    pub const SIGNER_RECORDING_OFFSET: u64 = 1;
+
     /// Computes a new Epoch by applying an epoch offset.
     ///
-    /// Will fails if the computed epoch is negative.
+    /// Will fail if the computed epoch is negative.
     pub fn offset_by(&self, epoch_offset: i64) -> Result<Self, EpochError> {
         let epoch_new = self.0 as i64 + epoch_offset;
         if epoch_new < 0 {
@@ -27,19 +33,19 @@ impl Epoch {
         Ok(Epoch(epoch_new as u64))
     }
 
-    /// Apply the [SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
+    /// Apply the [Self::SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
     pub fn offset_to_signer_retrieval_epoch(&self) -> Result<Self, EpochError> {
-        self.offset_by(SIGNER_EPOCH_RETRIEVAL_OFFSET)
+        self.offset_by(Self::SIGNER_RETRIEVAL_OFFSET)
     }
 
-    /// Apply the [NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
+    /// Apply the [Self::NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
     pub fn offset_to_next_signer_retrieval_epoch(&self) -> Self {
-        *self + NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET
+        *self + Self::NEXT_SIGNER_RETRIEVAL_OFFSET
     }
 
-    /// Apply the [SIGNER_EPOCH_RECORDING_OFFSET] to this epoch
+    /// Apply the [Self::SIGNER_EPOCH_RECORDING_OFFSET] to this epoch
     pub fn offset_to_recording_epoch(&self) -> Self {
-        *self + SIGNER_EPOCH_RECORDING_OFFSET
+        *self + Self::SIGNER_RECORDING_OFFSET
     }
 }
 
@@ -59,22 +65,6 @@ impl Add<u64> for Epoch {
     }
 }
 
-impl Add<i32> for Epoch {
-    type Output = Self;
-
-    fn add(self, rhs: i32) -> Self::Output {
-        Self(self.0 + rhs as u64)
-    }
-}
-
-impl Add<i64> for Epoch {
-    type Output = Self;
-
-    fn add(self, rhs: i64) -> Self::Output {
-        Self(self.0 + rhs as u64)
-    }
-}
-
 impl AddAssign for Epoch {
     fn add_assign(&mut self, rhs: Self) {
         *self = self.add(rhs);
@@ -87,18 +77,6 @@ impl AddAssign<u64> for Epoch {
     }
 }
 
-impl AddAssign<i32> for Epoch {
-    fn add_assign(&mut self, rhs: i32) {
-        *self = self.add(rhs);
-    }
-}
-
-impl AddAssign<i64> for Epoch {
-    fn add_assign(&mut self, rhs: i64) {
-        *self = self.add(rhs);
-    }
-}
-
 impl Sub for Epoch {
     type Output = Self;
 
@@ -115,22 +93,6 @@ impl Sub<u64> for Epoch {
     }
 }
 
-impl Sub<i32> for Epoch {
-    type Output = Self;
-
-    fn sub(self, rhs: i32) -> Self::Output {
-        Self(self.0 - rhs as u64)
-    }
-}
-
-impl Sub<i64> for Epoch {
-    type Output = Self;
-
-    fn sub(self, rhs: i64) -> Self::Output {
-        Self(self.0 - rhs as u64)
-    }
-}
-
 impl SubAssign for Epoch {
     fn sub_assign(&mut self, rhs: Self) {
         *self = self.sub(rhs);
@@ -143,18 +105,6 @@ impl SubAssign<u64> for Epoch {
     }
 }
 
-impl SubAssign<i32> for Epoch {
-    fn sub_assign(&mut self, rhs: i32) {
-        *self = self.sub(rhs);
-    }
-}
-
-impl SubAssign<i64> for Epoch {
-    fn sub_assign(&mut self, rhs: i64) {
-        *self = self.sub(rhs);
-    }
-}
-
 impl PartialEq<u64> for Epoch {
     fn eq(&self, other: &u64) -> bool {
         self.0.eq(other)
@@ -189,8 +139,6 @@ mod tests {
     fn test_add() {
         assert_eq!(Epoch(4), Epoch(1) + Epoch(3));
         assert_eq!(Epoch(4), Epoch(1) + 3_u64);
-        assert_eq!(Epoch(4), Epoch(1) + 3_i32);
-        assert_eq!(Epoch(4), Epoch(1) + 3_i64);
 
         let mut epoch = Epoch(1);
         epoch += Epoch(3);
@@ -199,22 +147,12 @@ mod tests {
         let mut epoch = Epoch(1);
         epoch += 3_u64;
         assert_eq!(Epoch(4), epoch);
-
-        let mut epoch = Epoch(1);
-        epoch += 3_i32;
-        assert_eq!(Epoch(4), epoch);
-
-        let mut epoch = Epoch(1);
-        epoch += 3_i64;
-        assert_eq!(Epoch(4), epoch);
     }
 
     #[test]
     fn test_sub() {
         assert_eq!(Epoch(8), Epoch(14) - Epoch(6));
         assert_eq!(Epoch(8), Epoch(14) - 6_u64);
-        assert_eq!(Epoch(8), Epoch(14) - 6_i32);
-        assert_eq!(Epoch(8), Epoch(14) - 6_i64);
 
         let mut epoch = Epoch(14);
         epoch -= Epoch(6);
@@ -223,13 +161,5 @@ mod tests {
         let mut epoch = Epoch(14);
         epoch -= 6_u64;
         assert_eq!(Epoch(8), epoch);
-
-        let mut epoch = Epoch(14);
-        epoch -= 6_i32;
-        assert_eq!(Epoch(8), epoch);
-
-        let mut epoch = Epoch(14);
-        epoch -= 6_i64;
-        assert_eq!(Epoch(8), epoch);
     }
 }

mithril-common/src/lib.rs

@@ -27,17 +27,6 @@ pub mod store;
 pub use beacon_provider::{BeaconProvider, BeaconProviderError, BeaconProviderImpl};
 pub use entities::{CardanoNetwork, MagicId};
 
-// TODO: Investigate as why signers can't sign until epoch 3 (in the e2e) when set to -1
-/// The epoch offset used for signers stake distribution and verification keys retrieval.
-pub const SIGNER_EPOCH_RETRIEVAL_OFFSET: i64 = -1;
-
-/// The epoch offset used to retrieve the signers stake distribution and verification keys that's
-/// currently being signed so it can be used in the next epoch.
-pub const NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET: i64 = 0;
-
-/// The epoch offset used for signers stake distribution and verification keys recording.
-pub const SIGNER_EPOCH_RECORDING_OFFSET: i64 = 1;
-
 /// Mithril API protocol version
 /// this is the same as the one in openapi.yml file.
 /// If you want to update this version to reflect changes in the protocol,