feat(cat-gateway): cardano/rbac/registrations endpoint API definition.

catalyst-gateway/bin/src/db/index/queries/mod.rs

@@ -100,6 +100,7 @@ pub(crate) enum PreparedSelectQuery {
     /// Get Catalyst ID by stake address.
     CatalystIdByStakeAddress,
     /// Get RBAC registrations by Catalyst ID.
+    #[allow(dead_code)]
     RbacRegistrationsByCatalystId,
     /// Get invalid RBAC registrations by Catalyst ID.
     RbacInvalidRegistrationsByCatalystId,

catalyst-gateway/bin/src/db/index/queries/rbac/get_rbac_registrations.rs

@@ -21,6 +21,7 @@ const QUERY: &str = include_str!("../cql/get_rbac_registrations_catalyst_id.cql"
 
 /// Get registrations by Catalyst ID query params.
 #[derive(SerializeRow)]
+#[allow(dead_code)]
 pub(crate) struct QueryParams {
     /// A Catalyst ID.
     pub catalyst_id: DbCatalystId,
@@ -53,6 +54,7 @@ impl Query {
     }
 
     /// Executes a get registrations by Catalyst ID query.
+    #[allow(dead_code)]
     pub(crate) async fn execute(
         session: &CassandraSession, params: QueryParams,
     ) -> anyhow::Result<TypedRowStream<Query>> {

catalyst-gateway/bin/src/service/api/cardano/cip36/endpoint.rs

@@ -1,6 +1,5 @@
 //! Implementation of the GET `/cardano/cip36` endpoint
 
-use poem::http::HeaderMap;
 use tracing::error;
 
 use self::cardano::query::stake_or_voter::StakeAddressOrPublicKey;
@@ -21,7 +20,7 @@ use crate::{
 pub(crate) async fn cip36_registrations(
     lookup: Option<cardano::query::stake_or_voter::StakeOrVoter>, asat: Option<SlotNo>,
     _page: common::types::generic::query::pagination::Page,
-    _limit: common::types::generic::query::pagination::Limit, _headers: &HeaderMap,
+    _limit: common::types::generic::query::pagination::Limit,
 ) -> AllRegistration {
     let Some(session) = CassandraSession::get(true) else {
         error!("Failed to acquire db session");

catalyst-gateway/bin/src/service/api/cardano/cip36/filter.rs

@@ -15,18 +15,21 @@ use super::{
         AllRegistration, Cip36Details, Cip36Registration, Cip36RegistrationList,
         Cip36RegistrationsForVotingPublicKey,
     },
-    Ed25519HexEncodedPublicKey, SlotNo,
+    SlotNo,
 };
-use crate::db::index::{
-    queries::registrations::{
-        get_all_invalids::{GetAllInvalidRegistrationsParams, GetAllInvalidRegistrationsQuery},
-        get_all_registrations::{GetAllRegistrationsParams, GetAllRegistrationsQuery},
-        get_from_stake_addr::{GetRegistrationParams, GetRegistrationQuery},
-        get_from_stake_address::{GetStakeAddrParams, GetStakeAddrQuery},
-        get_from_vote_key::{GetStakeAddrFromVoteKeyParams, GetStakeAddrFromVoteKeyQuery},
-        get_invalid::{GetInvalidRegistrationParams, GetInvalidRegistrationQuery},
+use crate::{
+    db::index::{
+        queries::registrations::{
+            get_all_invalids::{GetAllInvalidRegistrationsParams, GetAllInvalidRegistrationsQuery},
+            get_all_registrations::{GetAllRegistrationsParams, GetAllRegistrationsQuery},
+            get_from_stake_addr::{GetRegistrationParams, GetRegistrationQuery},
+            get_from_stake_address::{GetStakeAddrParams, GetStakeAddrQuery},
+            get_from_vote_key::{GetStakeAddrFromVoteKeyParams, GetStakeAddrFromVoteKeyQuery},
+            get_invalid::{GetInvalidRegistrationParams, GetInvalidRegistrationQuery},
+        },
+        session::CassandraSession,
     },
-    session::CassandraSession,
+    service::common::types::generic::ed25519_public_key::Ed25519HexEncodedPublicKey,
 };
 
 /// Get registration given a stake key hash, it can be time specific based on asat param,

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

@@ -1,13 +1,12 @@
 //! CIP36 Registration Endpoints
 
-use poem::http::HeaderMap;
 use poem_openapi::{param::Query, payload::Json, OpenApi};
 use response::Cip36RegistrationUnprocessableContent;
 
-use self::{cardano::slot_no::SlotNo, common::auth::none::NoAuthorization};
-use super::Ed25519HexEncodedPublicKey;
+use self::cardano::slot_no::SlotNo;
 use crate::service::common::{
     self,
+    auth::none_or_api_key::NoneOrApiKey,
     tags::ApiTags,
     types::cardano::{self},
 };
@@ -48,16 +47,13 @@ impl Api {
         asat: Query<Option<cardano::query::AsAt>>,
         page: Query<Option<common::types::generic::query::pagination::Page>>,
         limit: Query<Option<common::types::generic::query::pagination::Limit>>,
-        /// Headers, used if the query is requesting ALL to determine if the secret API
-        /// Key is also defined.
-        headers: &HeaderMap,
-        _auth: NoAuthorization,
+        api_key: NoneOrApiKey,
     ) -> response::AllRegistration {
         // Special validation for the `lookup` parameter.
         // If the parameter is ALL, BUT we do not have a valid API Key, just report the parameter
         // is invalid.
         if let Some(lookup) = lookup.0.clone() {
-            if lookup.is_all(headers).is_err() {
+            if lookup.is_all() && matches!(api_key, NoneOrApiKey::None(_)) {
                 return response::Cip36Registration::UnprocessableContent(Json(
                     Cip36RegistrationUnprocessableContent::new(
                         "Invalid Stake Address or Voter key",
@@ -72,7 +68,6 @@ impl Api {
             SlotNo::into_option(asat.0),
             page.0.unwrap_or_default(),
             limit.0.unwrap_or_default(),
-            headers,
         )
         .await
     }

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

@@ -1,83 +1,9 @@
 //! Cardano API endpoints
-use poem_openapi::{param::Path, OpenApi};
-
-use crate::service::common::{
-    auth::none_or_rbac::NoneOrRBAC,
-    objects::cardano::hash::Hash128,
-    tags::ApiTags,
-    types::{
-        cardano::{catalyst_id::CatalystId, cip19_stake_address::Cip19StakeAddress},
-        generic::ed25519_public_key::Ed25519HexEncodedPublicKey,
-    },
-};
 
 pub(crate) mod cip36;
-mod rbac;
+pub(crate) mod rbac;
 // mod registration_get;
 pub(crate) mod staking;
 
-/// Cardano Follower API Endpoints
-pub(crate) struct Api;
-
-#[OpenApi(tag = "ApiTags::Cardano")]
-impl Api {
-    // TODO: "Chain root" was replaced by "Catalyst ID", so this endpoint needs to be updated
-    // or removed.
-    #[oai(
-        path = "/draft/rbac/chain_root/:stake_address",
-        method = "get",
-        operation_id = "rbacChainRootGet"
-    )]
-    /// Get RBAC chain root
-    ///
-    /// This endpoint returns the RBAC certificate chain root for a given stake address.
-    async fn rbac_chain_root_get(
-        &self,
-        /// Stake address to get the chain root for.
-        Path(stake_address): Path<Cip19StakeAddress>,
-        /// No Authorization required, but Token permitted.
-        _auth: NoneOrRBAC,
-    ) -> rbac::chain_root_get::AllResponses {
-        rbac::chain_root_get::endpoint(stake_address).await
-    }
-
-    #[oai(
-        path = "/draft/rbac/registrations/:catalyst_id",
-        method = "get",
-        operation_id = "rbacRegistrations"
-    )]
-    /// Get registrations by Catalyst short ID.
-    ///
-    /// This endpoint returns RBAC registrations for the given Catalyst short identifier.
-    async fn rbac_registrations_get(
-        &self,
-        /// A Catalyst short ID to get the registrations for.
-        Path(catalyst_id): Path<CatalystId>,
-        /// No Authorization required, but Token permitted.
-        _auth: NoneOrRBAC,
-    ) -> rbac::registrations_get::AllResponses {
-        rbac::registrations_get::endpoint(catalyst_id.into()).await
-    }
-
-    // TODO: "Chain root" was replaced by "Catalyst ID", so this endpoint needs to be updated
-    // or removed.
-    #[oai(
-        path = "/draft/rbac/role0_chain_root/:role0_key",
-        method = "get",
-        operation_id = "rbacRole0KeyChainRoot"
-    )]
-    /// Get RBAC chain root for a given role0 key.
-    ///
-    /// This endpoint returns the RBAC certificate chain root for a given role 0 key.
-    async fn rbac_role0_key_chain_root(
-        &self, /// Role0 key to get the chain root for.
-        Path(role0_key): Path<Hash128>,
-        /// No Authorization required, but Token permitted.
-        _auth: NoneOrRBAC,
-    ) -> rbac::role0_chain_root_get::AllResponses {
-        rbac::role0_chain_root_get::endpoint(role0_key.to_string()).await
-    }
-}
-
-/// Cardano API Endpoints
-pub(crate) type CardanoApi = (Api, staking::Api, cip36::Api);
+/// All Cardano API Endpoints
+pub(crate) type CardanoApi = (rbac::Api, staking::Api, cip36::Api);

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

@@ -1,5 +1,56 @@
 //! RBAC endpoints.
 
-pub(crate) mod chain_root_get;
-pub(crate) mod registrations_get;
-pub(crate) mod role0_chain_root_get;
+use poem_openapi::{param::Query, payload::Json, OpenApi};
+
+use crate::service::common::{
+    auth::{none_or_api_key::NoneOrApiKey, none_or_rbac::NoneOrRBAC},
+    tags::ApiTags,
+    types::cardano::query::stake_or_voter::StakeOrVoter,
+};
+
+mod rbac_registration;
+mod registrations_get;
+mod unprocessable_content;
+
+/// Cardano RBAC API Endpoints
+pub(crate) struct Api;
+
+#[OpenApi(tag = "ApiTags::Cardano")]
+impl Api {
+    #[oai(
+        path = "/draft/rbac/registrations/:catalyst_id",
+        method = "get",
+        operation_id = "rbacRegistrations"
+    )]
+    /// Get RBAC registrations
+    ///
+    /// This endpoint returns RBAC registrations by provided auth Catalyst Id credentials
+    /// or by the `lookup` argument if provided.
+    async fn rbac_registrations_get(
+        &self,
+        /// Stake address to get the RBACE registration for.
+        Query(lookup): Query<Option<StakeOrVoter>>,
+        /// A flag which enalbes returning all corresponded Cip509 registrations
+        Query(detailed): Query<Option<bool>>,
+        /// No Authorization required, but Token permitted.
+        _auth: NoneOrRBAC,
+        /// No Authorization required, but Api Key permitted.
+        api_key: NoneOrApiKey,
+    ) -> registrations_get::AllResponses {
+        // Special validation for the `lookup` parameter.
+        // If the parameter is ALL, BUT we do not have a valid API Key, just report the parameter
+        // is invalid.
+        if let Some(lookup) = lookup.clone() {
+            if lookup.is_all() && matches!(api_key, NoneOrApiKey::None(_)) {
+                return registrations_get::Responses::UnprocessableContent(Json(
+                    unprocessable_content::RbacUnprocessableContent::new(
+                        "Invalid Stake Address or Voter key",
+                    ),
+                ))
+                .into();
+            }
+        }
+        let detailed = detailed.unwrap_or_default();
+        registrations_get::endpoint(lookup, detailed).await
+    }
+}

catalyst-gateway/bin/src/service/api/cardano/rbac/rbac_registration.rs

@@ -0,0 +1,49 @@
+//! Bad Rbac registration response object.
+
+use poem_openapi::{types::Example, Object};
+
+use crate::service::common::types::cardano::catalyst_id::CatalystId;
+
+/// RBAC Registrations, contains a latest valid and invalid registration data.
+#[derive(Object)]
+#[oai(example = true)]
+pub(crate) struct RbacRegistrations {
+    /// User's catalyst id
+    catalyst_id: CatalystId,
+    /// Latest valid RBAC registration
+    #[oai(skip_serializing_if_is_none)]
+    finalised: Option<RbacRegistration>,
+    /// Latest invalid RBAC registration
+    #[oai(skip_serializing_if_is_none)]
+    volatile: Option<RbacRegistration>,
+}
+
+impl Example for RbacRegistrations {
+    fn example() -> Self {
+        Self {
+            catalyst_id: CatalystId::example(),
+            finalised: Some(RbacRegistration::example()),
+            volatile: Some(RbacRegistration::example()),
+        }
+    }
+}
+
+/// Single RBAC Registrations.
+#[derive(Object)]
+#[oai(example = true)]
+pub(crate) struct RbacRegistration {
+    /// Registration chain
+    chain: serde_json::Value,
+    /// All Cip509 registrations which formed a current registration chain
+    #[oai(skip_serializing_if_is_empty)]
+    details: Vec<serde_json::Value>,
+}
+
+impl Example for RbacRegistration {
+    fn example() -> Self {
+        Self {
+            chain: serde_json::Value::Null,
+            details: vec![],
+        }
+    }
+}