feat(cat-gateway): impl Query for Cip36ForVoteKeyInsert

Author: saibatizoku

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

@@ -1,14 +1,14 @@
 //! Insert CIP36 Registration Query
 
-use std::sync::Arc;
+use std::{fmt, sync::Arc};
 
 use cardano_blockchain_types::{Cip36, Slot, TxnIndex, VotingPubKey};
 use scylla::{SerializeRow, Session};
 use tracing::error;
 
 use crate::{
     db::{
-        index::queries::{PreparedQueries, SizedBatch},
+        index::queries::{PreparedQueries, Query, QueryKind, SizedBatch},
         types::{DbSlot, DbTxnIndex},
     },
     settings::cassandra_db,
@@ -20,7 +20,7 @@ const INSERT_CIP36_REGISTRATION_FOR_VOTE_KEY_QUERY: &str =
 
 /// Insert CIP-36 Registration Invalid Query Parameters
 #[derive(SerializeRow, Debug)]
-pub(crate) struct Params {
+pub(crate) struct Cip36ForVoteKeyInsert {
     /// Voting Public Key
     vote_key: Vec<u8>,
     /// Full Stake Address (not hashed, 32 byte ED25519 Public key).
@@ -33,12 +33,29 @@ pub(crate) struct Params {
     valid: bool,
 }
 
-impl Params {
+impl Query for Cip36ForVoteKeyInsert {
+    /// 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::Display for Cip36ForVoteKeyInsert {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{INSERT_CIP36_REGISTRATION_FOR_VOTE_KEY_QUERY}")
+    }
+}
+
+impl Cip36ForVoteKeyInsert {
     /// Create a new Insert Query.
     pub fn new(
         vote_key: &VotingPubKey, slot_no: Slot, txn_index: TxnIndex, cip36: &Cip36, valid: bool,
     ) -> Self {
-        Params {
+        Cip36ForVoteKeyInsert {
             vote_key: vote_key
                 .voting_pk()
                 .map(|k| k.to_bytes().to_vec())

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

@@ -26,7 +26,7 @@ pub(crate) struct Cip36InsertQuery {
     /// Stake Registration Data captured during indexing.
     invalid: Vec<insert_cip36_invalid::Cip36InvalidInsert>,
     /// Stake Registration Data captured during indexing.
-    for_vote_key: Vec<insert_cip36_for_vote_key::Params>,
+    for_vote_key: Vec<insert_cip36_for_vote_key::Cip36ForVoteKeyInsert>,
     /// Stake Registration Data captured during indexing.
     stake_regs: Vec<certs::StakeRegistrationInsertQuery>,
 }
@@ -50,7 +50,7 @@ impl Cip36InsertQuery {
         let insert_cip36_invalid_batch =
             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;
+            insert_cip36_for_vote_key::Cip36ForVoteKeyInsert::prepare_batch(session, cfg).await;
         // Its a hack of inserting `stake_regs` during the indexing CIP 36 registrations.
         // Its done because some of the CIP 36 registrations contains some stake addresses which
         // are not actually some how registered using cardano certs.
@@ -86,7 +86,7 @@ impl Cip36InsertQuery {
                     voting_key, slot_no, index, &cip36,
                 ));
                 self.for_vote_key
-                    .push(insert_cip36_for_vote_key::Params::new(
+                    .push(insert_cip36_for_vote_key::Cip36ForVoteKeyInsert::new(
                         voting_key, slot_no, index, &cip36, true,
                     ));
                 self.stake_regs
@@ -120,10 +120,11 @@ impl Cip36InsertQuery {
                                     index,
                                     &cip36,
                                 ));
-                            self.for_vote_key
-                                .push(insert_cip36_for_vote_key::Params::new(
+                            self.for_vote_key.push(
+                                insert_cip36_for_vote_key::Cip36ForVoteKeyInsert::new(
                                     voting_key, slot_no, index, &cip36, false,
-                                ));
+                                ),
+                            );
                         }
                     }
 

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

@@ -49,7 +49,10 @@ use crate::{
     db::index::{
         block::{
             certs::StakeRegistrationInsertQuery,
-            cip36::{insert_cip36::Cip36Insert, insert_cip36_invalid::Cip36InvalidInsert},
+            cip36::{
+                insert_cip36::Cip36Insert, insert_cip36_for_vote_key::Cip36ForVoteKeyInsert,
+                insert_cip36_invalid::Cip36InvalidInsert,
+            },
         },
         queries::rbac::{
             get_catalyst_id_from_stake_address, get_catalyst_id_from_transaction_id,
@@ -246,7 +249,8 @@ async fn prepare_queries(
         TxoUnstakedAssetInsert,
         StakeRegistrationInsertQuery,
         Cip36Insert,
-        Cip36InvalidInsert
+        Cip36InvalidInsert,
+        Cip36ForVoteKeyInsert
     );
     Ok(queries)
 }

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

@@ -321,14 +321,14 @@ async fn test_cip36_registration_for_vote_key() {
 
     // data
     let data = vec![
-        cip36::insert_cip36_for_vote_key::Params::new(
+        cip36::insert_cip36_for_vote_key::Cip36ForVoteKeyInsert::new(
             &voting_pub_key(0),
             0.into(),
             0.into(),
             &test_utils::cip_36_1(),
             false,
         ),
-        cip36::insert_cip36_for_vote_key::Params::new(
+        cip36::insert_cip36_for_vote_key::Cip36ForVoteKeyInsert::new(
             &voting_pub_key(1),
             1.into(),
             1.into(),