fix(cardano-blockchain-types): fix linter

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

Author: bkioshn

rust/cardano-blockchain-types/src/cip36/key_registration.rs

@@ -2,8 +2,10 @@
 //!
 //! Catalyst registration data
 //!
-//! https://cips.cardano.org/cip/CIP-36
-//! https://github.com/cardano-foundation/CIPs/blob/master/CIP-0036/schema.cddl
+//! <https://cips.cardano.org/cip/CIP-36>
+//! <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0036/schema.cddl>
+
+use std::collections::HashSet;
 
 use ed25519_dalek::VerifyingKey;
 use minicbor::{decode, Decode, Decoder};
@@ -24,6 +26,7 @@ use crate::utils::decode_helper::{decode_array_len, decode_bytes, decode_helper,
 ///     ? 5 : $voting_purpose .default 0
 //   }
 /// ```
+#[allow(clippy::module_name_repetitions)]
 #[derive(Clone, Default)]
 pub struct Cip36KeyRegistration {
     /// Is this CIP36 or CIP15 format.
@@ -91,7 +94,7 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
             if let Some(key) = Cip36KeyRegistrationKeys::from_repr(key) {
                 match key {
                     Cip36KeyRegistrationKeys::VotingKey => {
-                        if !found_keys.insert(key) {
+                        if !found_keys.insert(key as u16) {
                             return Err(decode::Error::message(
                                 "Duplicate key in CIP36 Key Registration voting key",
                             ));
@@ -101,7 +104,7 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
                         cip36_key_registration.voting_pks = voting_keys;
                     },
                     Cip36KeyRegistrationKeys::StakePk => {
-                        if !found_keys.insert(key) {
+                        if !found_keys.insert(key as u16) {
                             return Err(decode::Error::message(
                                 "Duplicate key in CIP36 Key Registration stake public key",
                             ));
@@ -110,7 +113,7 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
                         cip36_key_registration.stake_pk = stake_pk;
                     },
                     Cip36KeyRegistrationKeys::PaymentAddr => {
-                        if !found_keys.insert(key) {
+                        if !found_keys.insert(key as u16) {
                             return Err(decode::Error::message(
                                 "Duplicate key in CIP36 Key Registration payment address",
                             ));
@@ -120,7 +123,7 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
                         cip36_key_registration.is_payable = !shelley_addr.payment().is_script();
                     },
                     Cip36KeyRegistrationKeys::Nonce => {
-                        if !found_keys.insert(key) {
+                        if !found_keys.insert(key as u16) {
                             return Err(decode::Error::message(
                                 "Duplicate key in CIP36 Key Registration nonce",
                             ));
@@ -129,7 +132,7 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
                         cip36_key_registration.raw_nonce = raw_nonce;
                     },
                     Cip36KeyRegistrationKeys::Purpose => {
-                        if !found_keys.insert(key) {
+                        if !found_keys.insert(key as u16) {
                             return Err(decode::Error::message(
                                 "Duplicate key in CIP36 Key Registration purpose",
                             ));
@@ -148,8 +151,8 @@ impl Decode<'_, ()> for Cip36KeyRegistration {
 ///
 /// # Returns
 ///
-/// A tuple containing a boolean value, true if it is CIP36 format, false if it is CIP15 format
-/// and a vector of voting public keys.
+/// A tuple containing a boolean value, true if it is CIP36 format, false if it is CIP15
+/// format and a vector of voting public keys.
 fn decode_voting_key(d: &mut Decoder) -> Result<(bool, Vec<VotingPubKey>), decode::Error> {
     let mut voting_keys = Vec::new();
     let mut is_cip36 = false;
@@ -162,7 +165,7 @@ fn decode_voting_key(d: &mut Decoder) -> Result<(bool, Vec<VotingPubKey>), decod
         // ```
         minicbor::data::Type::Bytes => {
             let pub_key = decode_bytes(d, "CIP36 Key Registration voting key, single voting key")?;
-            let vk = voting_pk_vec_to_verifying_key(pub_key).map_err(|e| {
+            let vk = voting_pk_vec_to_verifying_key(&pub_key).map_err(|e| {
                 decode::Error::message(format!(
                     "CIP36 Key Registration voting key, singe voting key, {e}"
                 ))
@@ -203,7 +206,7 @@ fn decode_voting_key(d: &mut Decoder) -> Result<(bool, Vec<VotingPubKey>), decod
                     &mut (),
                 )?;
 
-                let vk = voting_pk_vec_to_verifying_key(pub_key).map_err(|e| {
+                let vk = voting_pk_vec_to_verifying_key(&pub_key).map_err(|e| {
                     decode::Error::message(format!(
                         "CIP36 Key Registration voting key, multiple voting keys, {e}"
                     ))
@@ -216,19 +219,18 @@ fn decode_voting_key(d: &mut Decoder) -> Result<(bool, Vec<VotingPubKey>), decod
             }
         },
         _ => {
-            return Err(decode::Error::message(format!(
-                "Invalid datatype for CIP36 Key Registration voting key"
-            )))
+            return Err(decode::Error::message(
+                "Invalid datatype for CIP36 Key Registration voting key",
+            ))
         },
     }
     Ok((is_cip36, voting_keys))
 }
 
-/// Helper function for converting `Vec<u8>` to `VerifyingKey`.
-fn voting_pk_vec_to_verifying_key(pub_key: Vec<u8>) -> anyhow::Result<VerifyingKey> {
+/// Helper function for converting `&[u8]` to `VerifyingKey`.
+fn voting_pk_vec_to_verifying_key(pub_key: &[u8]) -> anyhow::Result<VerifyingKey> {
     VerifyingKey::from_bytes(
         pub_key
-            .as_slice()
             .try_into()
             .map_err(|_| anyhow::anyhow!("Invalid verifying key length"))?,
     )
@@ -248,7 +250,7 @@ fn voting_pk_vec_to_verifying_key(pub_key: Vec<u8>) -> anyhow::Result<VerifyingK
 /// The stake public key as a `VerifyingKey`.
 fn decode_stake_pk(d: &mut Decoder) -> Result<VerifyingKey, decode::Error> {
     let pub_key = decode_bytes(d, "CIP36 Key Registration stake public key")?;
-    voting_pk_vec_to_verifying_key(pub_key).map_err(|e| {
+    voting_pk_vec_to_verifying_key(&pub_key).map_err(|e| {
         decode::Error::message(format!("CIP36 Key Registration stake public key, {e}"))
     })
 }

rust/cardano-blockchain-types/src/cip36/mod.rs

@@ -23,7 +23,8 @@ pub struct Cip36 {
     pub is_catalyst_strict: bool,
 }
 
-/// CIP36 Validation Report
+/// Validation value for CIP-36.
+#[allow(clippy::struct_excessive_bools, clippy::module_name_repetitions)]
 #[derive(Clone, Default)]
 pub struct Cip36Validation {
     /// Is the signature valid? (signature in 61285)
@@ -37,56 +38,90 @@ pub struct Cip36Validation {
 }
 
 impl Cip36 {
+    /// Get the `is_cip36` flag from the registration.
+    /// True if it is CIP-36 format, false if CIP-15 format.
+    #[must_use]
     pub fn is_cip36(&self) -> Option<bool> {
         self.key_registration.is_cip36
     }
 
+    /// Get the voting public keys from the registration.
+    #[must_use]
     pub fn voting_pks(&self) -> Vec<VotingPubKey> {
         self.key_registration.voting_pks.clone()
     }
 
+    /// Get the stake public key from the registration.
+    #[must_use]
     pub fn stake_pk(&self) -> VerifyingKey {
-        self.key_registration.stake_pk.clone()
+        self.key_registration.stake_pk
     }
 
+    /// Get the payment address from the registration.
+    #[must_use]
     pub fn payment_address(&self) -> Option<ShelleyAddress> {
         self.key_registration.payment_addr.clone()
     }
 
+    /// Get the nonce from the registration.
+    #[must_use]
     pub fn nonce(&self) -> u64 {
         self.key_registration.nonce
     }
 
+    /// Get the purpose from the registration.
+    #[must_use]
     pub fn purpose(&self) -> u64 {
         self.key_registration.purpose
     }
 
+    /// Get the raw nonce from the registration.
+    #[must_use]
     pub fn raw_nonce(&self) -> u64 {
         self.key_registration.raw_nonce
     }
 
+    /// Get the signature from the registration witness.
+    #[must_use]
     pub fn signature(&self) -> Option<ed25519_dalek::Signature> {
-        self.registration_witness.signature.clone()
+        self.registration_witness.signature
     }
+
+    /// Get the Catalyst strict flag.
+    #[must_use]
     pub fn is_strict_catalyst(&self) -> bool {
         self.is_catalyst_strict
     }
 
+    /// Validation for CIP-36
+    /// The validation include the following:
+    /// * Signature validation of the registration witness 61285 against the stake public
+    ///   key in key registration 61284.
+    /// * Payment address network validation against the network. The given network should
+    ///   match the network tag within the payment address.
+    /// * Purpose validation, the purpose should be 0 for Catalyst (when
+    ///   `is_strict_catalyst` is true).
+    /// * Voting keys validation, Catalyst supports only a single voting key per
+    ///   registration when `is_strict_catalyst` is true.
+    ///
+    /// # Parameters
+    /// * `network` - The blockchain network.
+    /// * `metadata` - The metadata value to be validated.
+    /// * `validation_report` - Validation report to store the validation result.
     pub fn validate(
         &self, network: Network, metadata: &MetadatumValue, validation_report: &mut Vec<String>,
     ) -> Cip36Validation {
         let is_valid_signature = validate_signature(self, metadata, validation_report);
         let is_valid_payment_address_network =
-            validate_payment_address_network(&self, network, validation_report)
-                .unwrap_or_default();
-        let is_valid_purpose = validation::validate_purpose(self, validation_report);
+            validate_payment_address_network(self, network, validation_report).unwrap_or_default();
         let is_valid_voting_keys = validate_voting_keys(self, validation_report);
+        let is_valid_purpose = validation::validate_purpose(self, validation_report);
 
         Cip36Validation {
             is_valid_signature,
             is_valid_payment_address_network,
-            is_valid_purpose,
             is_valid_voting_keys,
+            is_valid_purpose,
         }
     }
 }

rust/cardano-blockchain-types/src/cip36/registration_witness.rs

@@ -1,7 +1,7 @@
 //! CIP36 registration witness 61285
 //!
-//! https://cips.cardano.org/cip/CIP-36
-//! https://github.com/cardano-foundation/CIPs/blob/master/CIP-0036/schema.cddl
+//! <https://cips.cardano.org/cip/CIP-36>
+//! <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0036/schema.cddl>
 
 use minicbor::{decode, Decode, Decoder};
 
@@ -14,6 +14,7 @@ use crate::utils::decode_helper::{decode_bytes, decode_helper, decode_map_len};
 ///     1 : $stake_witness
 /// }
 /// ```
+#[allow(clippy::module_name_repetitions)]
 #[derive(Clone, Default)]
 pub struct Cip36RegistrationWitness {
     /// Signature of the registration data.

rust/cardano-blockchain-types/src/cip36/validation.rs

@@ -1,3 +1,5 @@
+//! Validation function for CIP-36
+
 use super::Cip36;
 use crate::{MetadatumValue, Network};
 
@@ -22,20 +24,16 @@ pub(crate) fn validate_signature(
         .update(metadata.as_ref())
         .finalize();
 
-    let sig = match cip36.signature() {
-        Some(sig) => sig,
-        None => {
-            validation_report.push(format!("Validate CIP36 Signature, signature is invalid"));
-            return false;
-        },
+    let Some(sig) = cip36.signature() else {
+        validation_report.push("Validate CIP36 Signature, signature is invalid".to_string());
+        return false;
     };
 
-    match cip36.stake_pk().verify_strict(hash.as_bytes(), &sig) {
-        Ok(_) => true,
-        Err(_) => {
-            validation_report.push(format!("Validate CIP36 Signature, cannot verify signature"));
-            false
-        },
+    if let Ok(()) = cip36.stake_pk().verify_strict(hash.as_bytes(), &sig) {
+        true
+    } else {
+        validation_report.push("Validate CIP36 Signature, cannot verify signature".to_string());
+        false
     }
 }
 
@@ -57,7 +55,7 @@ pub(crate) fn validate_payment_address_network(
 
         Some(valid)
     } else {
-        return None;
+        None
     }
 }
 

rust/cardano-blockchain-types/src/lib.rs

@@ -1,6 +1,7 @@
 //! Catalyst Enhanced `MultiEraBlock` Structures
 
 mod auxdata;
+mod cip36;
 pub mod conversion;
 mod fork;
 pub mod hashes;
@@ -10,7 +11,6 @@ mod point;
 mod slot;
 mod txn_index;
 mod txn_witness;
-mod cip36;
 pub mod utils;
 
 pub use auxdata::{