chore: return success object

Author: apskhem

rust/rbac-registration/src/cardano/cip509/cip509.rs

@@ -15,15 +15,13 @@ use cardano_blockchain_types::{
     pallas_traverse::MultiEraTx,
     MetadatumLabel, MultiEraBlock, TxnIndex,
 };
-use cardano_chain_follower::StakeAddress;
 use catalyst_types::{
     catalyst_id::{role_index::RoleId, CatalystId},
     cbor_utils::{report_duplicated_key, report_missing_keys},
     problem_report::ProblemReport,
     uuid::UuidV4,
 };
 use cbork_utils::decode_helper::{decode_bytes, decode_helper, decode_map_len};
-use ed25519_dalek::VerifyingKey;
 use minicbor::{
     decode::{self},
     Decode, Decoder,
@@ -84,15 +82,6 @@ pub struct Cip509 {
     ///
     /// This field is only present in role 0 registrations.
     catalyst_id: Option<CatalystId>,
-    /// A list of stake addresses that were added to the chain.
-    stake_addresses: HashSet<StakeAddress>,
-    /// A list of role public keys used in this registration.
-    public_keys: HashSet<VerifyingKey>,
-    /// A list of updates to other chains containing Catalyst IDs and removed stake
-    /// addresses.
-    ///
-    /// A new RBAC registration can take ownership of stake addresses of other chains.
-    modified_chains: Vec<(CatalystId, HashSet<StakeAddress>)>,
     /// Raw aux data associated with the transaction that CIP509 is attached to,
     raw_aux_data: Vec<u8>,
     /// A report potentially containing all the issues occurred during `Cip509` decoding
@@ -219,23 +208,6 @@ impl Cip509 {
         result
     }
 
-    /// Updates and replaces information once it being processed by calling either
-    /// `update_chain` or `start_new_chain`.
-    #[must_use]
-    pub(crate) fn put_validation_result(
-        self,
-        stake_addresses: HashSet<StakeAddress>,
-        public_keys: HashSet<VerifyingKey>,
-        modified_chains: Vec<(CatalystId, HashSet<StakeAddress>)>,
-    ) -> Self {
-        Self {
-            stake_addresses,
-            public_keys,
-            modified_chains,
-            ..self
-        }
-    }
-
     /// Returns all role numbers present in this `Cip509` instance.
     #[must_use]
     pub fn all_roles(&self) -> Vec<RoleId> {
@@ -303,24 +275,6 @@ impl Cip509 {
         self.catalyst_id.as_ref()
     }
 
-    /// Returns stake addresses processed from either `update_chain` or `start_new_chain`.
-    #[must_use]
-    pub fn stake_addresses(&self) -> &HashSet<StakeAddress> {
-        &self.stake_addresses
-    }
-
-    /// Returns public keys processed from either `update_chain` or `start_new_chain`.
-    #[must_use]
-    pub fn public_keys(&self) -> &HashSet<VerifyingKey> {
-        &self.public_keys
-    }
-
-    /// Returns modified chains from either `update_chain` or `start_new_chain`.
-    #[must_use]
-    pub fn modified_chains(&self) -> &Vec<(CatalystId, HashSet<StakeAddress>)> {
-        &self.modified_chains
-    }
-
     /// Returns a list of addresses extracted from certificate URIs of a specific role.
     #[must_use]
     pub fn certificate_addresses(
@@ -495,9 +449,6 @@ impl Decode<'_, DecodeContext<'_, '_>> for Cip509 {
             txn_hash,
             origin: decode_context.origin.clone(),
             catalyst_id: None,
-            stake_addresses: HashSet::new(),
-            public_keys: HashSet::new(),
-            modified_chains: Vec::new(),
             raw_aux_data: Vec::new(),
             report: decode_context.report.clone(),
         })

rust/rbac-registration/src/registration/cardano/validation.rs

@@ -18,7 +18,7 @@ use crate::{
 };
 
 /// A return value of the `validate_rbac_registration` method.
-pub type RbacValidationResult = Result<(RegistrationChain, Cip509), RbacValidationError>;
+pub type RbacValidationResult = Result<RbacValidationSuccess, RbacValidationError>;
 
 /// An error returned from the `validate_rbac_registration` method.
 #[allow(clippy::large_enum_variant)]
@@ -53,6 +53,21 @@ impl From<anyhow::Error> for RbacValidationError {
     }
 }
 
+/// Represents the result yielded by `update_chain` or `start_new_chain` upon successful execution.
+pub struct RbacValidationSuccess {
+    /// A list of stake addresses that were added to the chain.
+    pub stake_addresses: HashSet<StakeAddress>,
+    /// A list of role public keys used in this registration.
+    pub public_keys: HashSet<VerifyingKey>,
+    /// A list of updates to other chains containing Catalyst IDs and removed stake
+    /// addresses.
+    ///
+    /// A new RBAC registration can take ownership of stake addresses of other chains.
+    pub modified_chains: Vec<(CatalystId, HashSet<StakeAddress>)>,
+    /// An updated registration chain.
+    pub chain: RegistrationChain,
+}
+
 /// Attempts to update an existing RBAC registration chain
 /// with a new CIP-509 registration, validating address and key usage consistency.
 ///
@@ -134,16 +149,14 @@ where
         });
     }
 
-    Ok((
-        new_chain,
-        reg.put_validation_result(
-            stake_addresses,
-            public_keys,
-            // Only new chains can take ownership of stake addresses of existing chains, so in this
-            // case other chains aren't affected.
-            Vec::new(),
-        ),
-    ))
+    Ok(RbacValidationSuccess {
+        stake_addresses,
+        public_keys,
+        // Only new chains can take ownership of stake addresses of existing chains, so in this
+        // case other chains aren't affected.
+        modified_chains: Vec::new(),
+        chain: new_chain,
+    })
 }
 
 /// Attempts to initialize a new RBAC registration chain
@@ -246,14 +259,12 @@ where
         });
     }
 
-    Ok((
-        new_chain,
-        reg.put_validation_result(
-            new_addresses,
-            public_keys,
-            updated_chains.into_iter().collect(),
-        ),
-    ))
+    Ok(RbacValidationSuccess {
+        stake_addresses: new_addresses,
+        public_keys,
+        modified_chains: updated_chains.into_iter().collect(),
+        chain: new_chain,
+    })
 }
 
 /// Validates that none of the signing keys in a given RBAC registration chain