feat(cat-gateway): Update RBAC endpoint to include information about stake addresses (#3374)

* Extend chain info with stake addresses

* Stake address info

* wip

* Remove unused implementation, add TODO notes, bump api version

* Try add property

* Fix openapi lints

---------

Co-authored-by: Mr-Leshiy <[email protected]>

Author: stanislav-tkach

catalyst-gateway/bin/src/rbac/get_chain.rs

@@ -131,7 +131,7 @@ pub async fn apply_regs(
     for reg in regs {
         if !reg.removed_stake_addresses.is_empty() {
             // TODO: This should be handled as a part of the
-            // https://github.com/input-output-hk/catalyst-voices/issues/2599 task.
+            // https://github.com/input-output-hk/catalyst-voices/issues/3464 task.
             continue;
         }
         let reg = cip509(network, reg.slot_no.into(), reg.txn_index.into()).await?;

catalyst-gateway/bin/src/service/api/cardano/rbac/registrations_get/v2/mod.rs

@@ -15,5 +15,7 @@ mod registration_chain;
 mod response;
 mod role_data;
 mod role_list;
+mod stake_address_info;
+mod stake_address_info_list;
 
 pub use self::{endpoint::endpoint_v2, response::AllResponsesV2};

catalyst-gateway/bin/src/service/api/cardano/rbac/registrations_get/v2/registration_chain.rs

@@ -8,7 +8,10 @@ use crate::{
         api::cardano::rbac::registrations_get::{
             invalid_registration_list::InvalidRegistrationList,
             purpose_list::PurposeList,
-            v2::{role_data::RbacRoleData, role_list::RbacRoleList},
+            v2::{
+                role_data::RbacRoleData, role_list::RbacRoleList,
+                stake_address_info_list::StakeAddressInfoList,
+            },
         },
         common::types::{
             cardano::{catalyst_id::CatalystId, transaction_id::TxnId},
@@ -40,6 +43,9 @@ pub struct RbacRegistrationChainV2 {
     /// A list of invalid registrations.
     #[oai(skip_serializing_if_is_empty)]
     invalid: InvalidRegistrationList,
+    /// A list of stake addresses of the chain.
+    #[oai(skip_serializing_if_is_empty)]
+    stake_addresses: StakeAddressInfoList,
 }
 
 impl Example for RbacRegistrationChainV2 {
@@ -51,6 +57,7 @@ impl Example for RbacRegistrationChainV2 {
             last_volatile_txn: Some(TxnId::example()),
             roles: RbacRoleList::example(),
             invalid: InvalidRegistrationList::example(),
+            stake_addresses: StakeAddressInfoList::example(),
         }
     }
 }
@@ -70,6 +77,9 @@ impl RbacRegistrationChainV2 {
         let mut last_volatile_txn = None;
         let mut purpose = Vec::new().into();
         let mut roles = Vec::new().into();
+        // TODO: This list needs to be updated as a part of the
+        // https://github.com/input-output-hk/catalyst-voices/issues/3464 task.
+        let stake_addresses = Vec::new().into();
         if let Some(info) = info {
             last_persistent_txn = info.last_persistent_txn.map(Into::into);
             last_volatile_txn = info.last_volatile_txn.map(Into::into);
@@ -91,6 +101,7 @@ impl RbacRegistrationChainV2 {
             purpose,
             roles,
             invalid,
+            stake_addresses,
         }))
     }
 }

catalyst-gateway/bin/src/service/api/cardano/rbac/registrations_get/v2/stake_address_info.rs

@@ -0,0 +1,31 @@
+//! An information about stake address used in a RBAC registration chain.
+
+use poem_openapi::types::Example;
+use poem_openapi_derive::Object;
+
+use crate::service::common::types::cardano::{
+    cip19_stake_address::Cip19StakeAddress, slot_no::SlotNo,
+};
+
+/// An information about stake address used in a RBAC registration chain.
+#[derive(Object, Debug, Clone)]
+#[oai(example)]
+pub struct RbacStakeAddressInfo {
+    /// A stake address.
+    stake: Cip19StakeAddress,
+    /// A slot number when the registration chain started to use the stake address.
+    active_from: SlotNo,
+    /// A slot number when the registration chain stopped to use the stake address.
+    #[oai(skip_serializing_if_is_empty)]
+    inactive_from: Option<SlotNo>,
+}
+
+impl Example for RbacStakeAddressInfo {
+    fn example() -> Self {
+        Self {
+            stake: Cip19StakeAddress::example(),
+            active_from: SlotNo::example(),
+            inactive_from: Some(SlotNo::example()),
+        }
+    }
+}

catalyst-gateway/bin/src/service/api/cardano/rbac/registrations_get/v2/stake_address_info_list.rs

@@ -0,0 +1,30 @@
+//! A list of `StakeAddressInfo`.
+
+use poem_openapi::{
+    registry::MetaSchema,
+    types::{Example, ToJSON},
+};
+
+use crate::service::{
+    api::cardano::rbac::registrations_get::v2::stake_address_info::RbacStakeAddressInfo,
+    common::types::array_types::impl_array_types,
+};
+
+impl_array_types!(
+    /// A list of `StakeAddressInfo`.
+    StakeAddressInfoList,
+    RbacStakeAddressInfo,
+    Some(MetaSchema {
+        example: Self::example().to_json(),
+        min_items: Some(1),
+        max_items: Some(10000),
+        items: Some(Box::new(RbacStakeAddressInfo::schema_ref())),
+        ..MetaSchema::ANY
+    })
+);
+
+impl Example for StakeAddressInfoList {
+    fn example() -> Self {
+        Self(vec![RbacStakeAddressInfo::example()])
+    }
+}

catalyst-gateway/bin/src/service/api/mod.rs

@@ -23,7 +23,7 @@ pub(crate) mod health;
 const API_TITLE: &str = "Catalyst Gateway";
 
 /// The version of the API
-const API_VERSION: &str = "0.4.0";
+const API_VERSION: &str = "0.5.0";
 
 /// Get the contact details for inquiring about the API
 fn get_api_contact() -> ContactObject {