feat(rust/catalyst-types): CatalystId proper comparison functionality (#597)

* disable PartialEq and Eq traits for CatalystId

* wip

* add `eq_with_userinfo` and `eq_with_rolekey` with tests

* wip

* fix

* fix spelling

* fix clippy

Author: Mr-Leshiy

rust/catalyst-types/Cargo.toml

@@ -39,3 +39,4 @@ ed25519-dalek = { version = "2.1.1", features = ["rand_core"] }
 proptest = { version = "1.6.0", features = ["attr-macro"] }
 rand = "0.8.5"
 serde_json = "1"
+test-case = "3.3.1"

rust/catalyst-types/src/catalyst_id/mod.rs

@@ -9,6 +9,7 @@ pub mod role_index;
 
 use std::{
     fmt::{Display, Formatter},
+    hash::Hash,
     str::FromStr,
     sync::Arc,
 };
@@ -42,7 +43,7 @@ pub struct CatalystId {
 }
 
 /// A Catalyst ID data intended to be wrapper in `Arc`.
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone)]
 struct CatalystIdInner {
     /// Username
     username: Option<String>,
@@ -535,6 +536,50 @@ impl CatalystId {
             .without_encryption()
             .as_id()
     }
+
+    /// Comparisons of `CatalystId` based on original `PartialEq` plus including
+    /// `username` and `nonce` fields.
+    #[must_use]
+    pub fn eq_with_userinfo(
+        &self,
+        other: &Self,
+    ) -> bool {
+        self.eq(other) && self.username().eq(&other.username()) && self.nonce().eq(&other.nonce())
+    }
+
+    /// Comparisons of `CatalystId` based on `CatalystId::eq_with_userinfo` plus including
+    /// `role` and `rotation` fields.
+    #[must_use]
+    pub fn eq_with_role(
+        &self,
+        other: &Self,
+    ) -> bool {
+        self.eq_with_userinfo(other) && self.role_and_rotation().eq(&other.role_and_rotation())
+    }
+}
+
+impl PartialEq for CatalystIdInner {
+    fn eq(
+        &self,
+        other: &Self,
+    ) -> bool {
+        self.network.eq(&other.network)
+            && self.subnet.eq(&other.subnet)
+            && self.role0_pk.eq(&other.role0_pk)
+    }
+}
+
+impl Eq for CatalystIdInner {}
+
+impl Hash for CatalystIdInner {
+    fn hash<H: std::hash::Hasher>(
+        &self,
+        state: &mut H,
+    ) {
+        self.network.hash(state);
+        self.subnet.hash(state);
+        self.role0_pk.hash(state);
+    }
 }
 
 impl FromStr for CatalystId {
@@ -743,6 +788,7 @@ mod tests {
     use chrono::{DateTime, Utc};
     use ed25519_dalek::SigningKey;
     use rand::rngs::OsRng;
+    use test_case::test_case;
 
     use super::CatalystId;
 
@@ -796,7 +842,46 @@ mod tests {
         let uri_id = test_uri.parse::<CatalystId>().unwrap();
         let short_id = expected_id.parse::<CatalystId>().unwrap();
 
-        assert_eq!(uri_id.as_short_id(), short_id);
+        assert_eq!(uri_id.as_short_id().inner, short_id.inner);
+    }
+
+    #[test_case(0, 1, true, false, false; "base vs user")]
+    #[test_case(0, 2, true, false, false; "base vs user_nonce")]
+    #[test_case(0, 3, true, false, false; "base vs nonce")]
+    #[test_case(0, 4, true, true, true; "base vs base_duplicate")]
+    #[test_case(7, 8, true, true, false; "midnight_0_1 vs midnight_2_1")]
+    #[test_case(0, 5, false, false, false; "cardano vs preprod")]
+    #[test_case(5, 6, false, false, false; "preprod vs preview")]
+    #[test_case(6, 7, false, false, false; "preview vs midnight")]
+    #[test_case(1, 2, true, false, false; "user vs user_nonce")]
+    #[test_case(2, 3, true, false, false; "user_nonce vs nonce")]
+    #[test_case(8, 8, true, true, true; "identical self comparison")]
+    #[allow(clippy::indexing_slicing, clippy::similar_names)]
+    fn test_all_comparisons(
+        idx_a: usize,
+        idx_b: usize,
+        expected_eq: bool,
+        expected_userinfo: bool,
+        expected_role: bool,
+    ) {
+        let id_a = CATALYST_ID_TEST_VECTOR[idx_a]
+            .parse::<CatalystId>()
+            .unwrap();
+        let id_b = CATALYST_ID_TEST_VECTOR[idx_b]
+            .parse::<CatalystId>()
+            .unwrap();
+
+        assert_eq!(id_a == id_b, expected_eq, "PartialEq failed");
+        assert_eq!(
+            id_a.eq_with_userinfo(&id_b),
+            expected_userinfo,
+            "eq_with_userinfo failed"
+        );
+        assert_eq!(
+            id_a.eq_with_role(&id_b),
+            expected_role,
+            "eq_with_role failed"
+        );
     }
 
     #[ignore = "Test to be fixed and re-enabled"]