fix(cardano-blockchain-types): visibility, cip36 constructor

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

Author: bkioshn

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

@@ -21,10 +21,7 @@ pub use auxdata::{
     scripts::{Script, ScriptArray, ScriptType, TransactionScripts},
 };
 pub use fork::Fork;
-pub use metadata::cip36::{
-    key_registration::Cip36KeyRegistration, registration_witness::Cip36RegistrationWitness,
-    voting_pk::VotingPubKey, Cip36, Cip36Validation,
-};
+pub use metadata::cip36::{voting_pk::VotingPubKey, Cip36};
 pub use multi_era_block_data::MultiEraBlock;
 pub use network::Network;
 pub use point::Point;

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

@@ -28,7 +28,7 @@ use super::voting_pk::VotingPubKey;
 /// ```
 #[allow(clippy::module_name_repetitions)]
 #[derive(Clone, Default, Debug)]
-pub struct Cip36KeyRegistration {
+pub(crate) struct Cip36KeyRegistration {
     /// Is this CIP36 or CIP15 format.
     pub is_cip36: Option<bool>,
     /// Voting public keys (called Delegations in the CIP-36 Spec).
@@ -55,7 +55,7 @@ pub struct Cip36KeyRegistration {
 /// Enum of CIP36 registration (61284) with its associated unsigned integer key.
 #[derive(FromRepr, Debug, PartialEq)]
 #[repr(u16)]
-pub enum Cip36KeyRegistrationKeys {
+enum Cip36KeyRegistrationKeys {
     /// Voting key.
     VotingKey = 1,
     /// Stake public key.
@@ -224,10 +224,7 @@ fn decode_voting_key(
                     };
 
                     // Since there is 1 voting key, all the weight goes to this key = 1.
-                    voting_keys.push(VotingPubKey {
-                        voting_pk: vk,
-                        weight: 1,
-                    });
+                    voting_keys.push(VotingPubKey::new(vk, 1));
                 },
                 // CIP36 type registration (multiple voting keys).
                 // ```cddl
@@ -279,10 +276,7 @@ fn decode_voting_key(
                             },
                         };
 
-                        voting_keys.push(VotingPubKey {
-                            voting_pk: vk,
-                            weight,
-                        });
+                        voting_keys.push(VotingPubKey::new(vk, weight));
                     }
                 },
 

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

@@ -30,7 +30,7 @@ pub struct Cip36 {
 /// Validation value for CIP-36.
 #[allow(clippy::struct_excessive_bools, clippy::module_name_repetitions)]
 #[derive(Clone, Default, Debug)]
-pub struct Cip36Validation {
+pub(crate) struct Cip36Validation {
     /// Is the signature valid? (signature in 61285)
     pub is_valid_signature: bool,
     /// Is the payment address on the correct network?
@@ -58,7 +58,7 @@ impl Cip36 {
     /// or if the CIP-36 key registration or registration witness metadata cannot be
     /// decoded.
     pub fn new(
-        aux_data: &TransactionAuxData, is_catalyst_strict: bool, slot: Slot,
+        aux_data: &TransactionAuxData, is_catalyst_strict: bool, slot: Slot, network: Network,
     ) -> anyhow::Result<Self> {
         let Some(k61284) = aux_data.metadata(MetadatumLabel::CIP036_REGISTRATION) else {
             bail!("CIP-36 key registration metadata not found")
@@ -94,11 +94,25 @@ impl Cip36 {
                 },
             };
 
-        Ok(Self {
+        let cip36 = Self {
             key_registration,
             registration_witness,
             is_catalyst_strict,
-        })
+        };
+
+        let mut validation_report = Vec::new();
+        // If the code reach here, then the CIP36 decoding is successful.
+        let validation = cip36.validate(network, k61284, &mut validation_report);
+
+        if validation.is_valid_signature
+            && validation.is_valid_payment_address_network
+            && validation.is_valid_voting_keys
+            && validation.is_valid_purpose
+        {
+            Ok(cip36)
+        } else {
+            bail!("CIP-36 validation failed: {validation:?}, Reports: {validation_report:?}")
+        }
     }
 
     /// Get the `is_cip36` flag from the registration.
@@ -144,6 +158,12 @@ impl Cip36 {
         self.key_registration.raw_nonce
     }
 
+    /// Is the payment address in the registration payable?
+    #[must_use]
+    pub fn is_payable(&self) -> bool {
+        self.key_registration.is_payable
+    }
+
     /// Get the signature from the registration witness.
     #[must_use]
     pub fn signature(&self) -> Option<ed25519_dalek::Signature> {
@@ -172,7 +192,7 @@ impl Cip36 {
     /// * `network` - The blockchain network.
     /// * `metadata` - The metadata value to be validated.
     /// * `validation_report` - Validation report to store the validation result.
-    pub fn validate(
+    fn validate(
         &self, network: Network, metadata: &MetadatumValue, validation_report: &mut Vec<String>,
     ) -> Cip36Validation {
         let is_valid_signature = validate_signature(self, metadata, validation_report);

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

@@ -15,7 +15,7 @@ use minicbor::{decode, Decode, Decoder};
 /// ```
 #[allow(clippy::module_name_repetitions)]
 #[derive(Clone, Default, Debug)]
-pub struct Cip36RegistrationWitness {
+pub(crate) struct Cip36RegistrationWitness {
     /// Signature of the registration data.
     pub signature: Option<ed25519_dalek::Signature>,
 }

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

@@ -149,10 +149,10 @@ mod tests {
     #[test]
     fn test_validate_voting_keys() {
         let mut cip36 = create_empty_cip36(true);
-        cip36.key_registration.voting_pks.push(VotingPubKey {
-            voting_pk: Some(VerifyingKey::default()),
-            weight: 1,
-        });
+        cip36
+            .key_registration
+            .voting_pks
+            .push(VotingPubKey::new(Some(VerifyingKey::default()), 1));
         let mut report = Vec::new();
 
         let valid = validate_voting_keys(&cip36, &mut report);
@@ -164,14 +164,14 @@ mod tests {
     #[test]
     fn test_validate_invalid_voting_keys() {
         let mut cip36 = create_empty_cip36(true);
-        cip36.key_registration.voting_pks.push(VotingPubKey {
-            voting_pk: Some(VerifyingKey::default()),
-            weight: 1,
-        });
-        cip36.key_registration.voting_pks.push(VotingPubKey {
-            voting_pk: Some(VerifyingKey::default()),
-            weight: 1,
-        });
+        cip36
+            .key_registration
+            .voting_pks
+            .push(VotingPubKey::new(Some(VerifyingKey::default()), 1));
+        cip36
+            .key_registration
+            .voting_pks
+            .push(VotingPubKey::new(Some(VerifyingKey::default()), 1));
         let mut report = Vec::new();
 
         let valid = validate_voting_keys(&cip36, &mut report);

rust/cardano-blockchain-types/src/metadata/cip36/voting_pk.rs

@@ -6,7 +6,27 @@ use ed25519_dalek::VerifyingKey;
 #[derive(Clone, Debug)]
 pub struct VotingPubKey {
     /// Voting public key.
-    pub voting_pk: Option<VerifyingKey>,
+    voting_pk: Option<VerifyingKey>,
     /// Voting key associated weight.
-    pub weight: u32,
+    weight: u32,
+}
+
+impl VotingPubKey {
+    /// Create a new voting public key.
+    #[must_use]
+    pub fn new(voting_pk: Option<VerifyingKey>, weight: u32) -> Self {
+        Self { voting_pk, weight }
+    }
+
+    /// Get the voting public key.
+    #[must_use]
+    pub fn voting_pk(&self) -> Option<&VerifyingKey> {
+        self.voting_pk.as_ref()
+    }
+
+    /// Get the voting key weight.
+    #[must_use]
+    pub fn weight(&self) -> u32 {
+        self.weight
+    }
 }