feat(cat-gateway): impl Query for Cip36InvalidInsert

Author: saibatizoku

catalyst-gateway/bin/src/db/index/block/cip36/insert_cip36_invalid.rs

@@ -1,6 +1,6 @@
 //! Insert CIP36 Registration Query (Invalid Records)
 
-use std::{fmt::Debug, sync::Arc};
+use std::{fmt, sync::Arc};
 
 use cardano_blockchain_types::{Cip36, Slot, TxnIndex, VotingPubKey};
 use pallas::ledger::addresses::Address;
@@ -9,7 +9,7 @@ use tracing::error;
 
 use crate::{
     db::{
-        index::queries::{PreparedQueries, SizedBatch},
+        index::queries::{PreparedQueries, Query, QueryKind, SizedBatch},
         types::{DbSlot, DbTxnIndex},
     },
     settings::cassandra_db,
@@ -21,7 +21,7 @@ const INSERT_CIP36_REGISTRATION_INVALID_QUERY: &str =
 
 /// Insert CIP-36 Registration Invalid Query Parameters
 #[derive(SerializeRow, Clone)]
-pub(crate) struct Params {
+pub(crate) struct Cip36InvalidInsert {
     /// Full Stake Address (not hashed, 32 byte ED25519 Public key).
     stake_public_key: Vec<u8>,
     /// Slot Number the cert is in.
@@ -46,13 +46,24 @@ pub(crate) struct Params {
     problem_report: String,
 }
 
-impl Debug for Params {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl Query for Cip36InvalidInsert {
+    /// Prepare Batch of Insert TXI Index Data Queries
+    async fn prepare_query(
+        session: &Arc<Session>, cfg: &cassandra_db::EnvVars,
+    ) -> anyhow::Result<QueryKind> {
+        Self::prepare_batch(session, cfg)
+            .await
+            .map(QueryKind::Batch)
+    }
+}
+
+impl fmt::Debug for Cip36InvalidInsert {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let cip36 = match self.cip36 {
             MaybeUnset::Unset => "UNSET",
             MaybeUnset::Set(v) => &format!("{v:?}"),
         };
-        f.debug_struct("Params")
+        f.debug_struct("Cip36InvalidInsert")
             .field("stake_public_key", &self.stake_public_key)
             .field("slot_no", &self.slot_no)
             .field("txn_index", &self.txn_index)
@@ -68,7 +79,13 @@ impl Debug for Params {
     }
 }
 
-impl Params {
+impl fmt::Display for Cip36InvalidInsert {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{INSERT_CIP36_REGISTRATION_INVALID_QUERY}")
+    }
+}
+
+impl Cip36InvalidInsert {
     /// Create a new Insert Query.
     pub fn new(
         vote_key: Option<&VotingPubKey>, slot_no: Slot, txn_index: TxnIndex, cip36: &Cip36,
@@ -89,7 +106,7 @@ impl Params {
             String::new()
         });
 
-        Params {
+        Cip36InvalidInsert {
             stake_public_key,
             slot_no: slot_no.into(),
             txn_index: txn_index.into(),

catalyst-gateway/bin/src/db/index/block/cip36/mod.rs

@@ -24,7 +24,7 @@ pub(crate) struct Cip36InsertQuery {
     /// Stake Registration Data captured during indexing.
     registrations: Vec<insert_cip36::Cip36Insert>,
     /// Stake Registration Data captured during indexing.
-    invalid: Vec<insert_cip36_invalid::Params>,
+    invalid: Vec<insert_cip36_invalid::Cip36InvalidInsert>,
     /// Stake Registration Data captured during indexing.
     for_vote_key: Vec<insert_cip36_for_vote_key::Params>,
     /// Stake Registration Data captured during indexing.
@@ -48,7 +48,7 @@ impl Cip36InsertQuery {
     ) -> anyhow::Result<(SizedBatch, SizedBatch, SizedBatch)> {
         let insert_cip36_batch = insert_cip36::Cip36Insert::prepare_batch(session, cfg).await;
         let insert_cip36_invalid_batch =
-            insert_cip36_invalid::Params::prepare_batch(session, cfg).await;
+            insert_cip36_invalid::Cip36InvalidInsert::prepare_batch(session, cfg).await;
         let insert_cip36_for_vote_key_addr_batch =
             insert_cip36_for_vote_key::Params::prepare_batch(session, cfg).await;
         // Its a hack of inserting `stake_regs` during the indexing CIP 36 registrations.
@@ -107,17 +107,19 @@ impl Cip36InsertQuery {
                 // Cannot index an invalid CIP36, if there is no stake public key.
                 if let Some(stake_pk) = cip36.stake_pk() {
                     if cip36.voting_pks().is_empty() {
-                        self.invalid.push(insert_cip36_invalid::Params::new(
-                            None, slot_no, index, &cip36,
-                        ));
+                        self.invalid
+                            .push(insert_cip36_invalid::Cip36InvalidInsert::new(
+                                None, slot_no, index, &cip36,
+                            ));
                     } else {
                         for voting_key in cip36.voting_pks() {
-                            self.invalid.push(insert_cip36_invalid::Params::new(
-                                Some(voting_key),
-                                slot_no,
-                                index,
-                                &cip36,
-                            ));
+                            self.invalid
+                                .push(insert_cip36_invalid::Cip36InvalidInsert::new(
+                                    Some(voting_key),
+                                    slot_no,
+                                    index,
+                                    &cip36,
+                                ));
                             self.for_vote_key
                                 .push(insert_cip36_for_vote_key::Params::new(
                                     voting_key, slot_no, index, &cip36, false,

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

@@ -47,7 +47,10 @@ use super::block::{
 };
 use crate::{
     db::index::{
-        block::{certs::StakeRegistrationInsertQuery, cip36::insert_cip36::Cip36Insert},
+        block::{
+            certs::StakeRegistrationInsertQuery,
+            cip36::{insert_cip36::Cip36Insert, insert_cip36_invalid::Cip36InvalidInsert},
+        },
         queries::rbac::{
             get_catalyst_id_from_stake_address, get_catalyst_id_from_transaction_id,
             get_rbac_invalid_registrations, get_rbac_registrations,
@@ -242,7 +245,8 @@ async fn prepare_queries(
         TxoUnstakedInsert,
         TxoUnstakedAssetInsert,
         StakeRegistrationInsertQuery,
-        Cip36Insert
+        Cip36Insert,
+        Cip36InvalidInsert
     );
     Ok(queries)
 }

catalyst-gateway/bin/src/db/index/tests/scylla_purge.rs

@@ -392,13 +392,13 @@ async fn test_cip36_registration_invalid() {
 
     // data
     let data = vec![
-        cip36::insert_cip36_invalid::Params::new(
+        cip36::insert_cip36_invalid::Cip36InvalidInsert::new(
             Some(&voting_pub_key(0)),
             0.into(),
             0.into(),
             &test_utils::cip_36_1(),
         ),
-        cip36::insert_cip36_invalid::Params::new(
+        cip36::insert_cip36_invalid::Cip36InvalidInsert::new(
             Some(&voting_pub_key(1)),
             1.into(),
             1.into(),