wip(cat-gateway): implement query trait for batched queries

Author: saibatizoku

catalyst-gateway/bin/src/db/index/block/certs.rs

@@ -11,13 +11,12 @@ use tracing::error;
 use crate::{
     db::{
         index::{
-            queries::{
-                FallibleQueryTasks, PreparedQueries, PreparedQuery, Query, QueryKind, SizedBatch,
-            },
+            queries::{FallibleQueryTasks, PreparedQueries, PreparedQuery, SizedBatch},
             session::CassandraSession,
         },
         types::{DbPublicKey, DbSlot, DbStakeAddress, DbTxnIndex},
     },
+    impl_query_batch,
     settings::cassandra_db,
 };
 
@@ -44,17 +43,6 @@ pub(crate) struct StakeRegistrationInsertQuery {
     pool_delegation: MaybeUnset<Vec<u8>>,
 }
 
-impl Query for StakeRegistrationInsertQuery {
-    /// Prepare Batch of Insert TXI Index Data Queries
-    async fn prepare_query(
-        session: &Arc<Session>, cfg: &cassandra_db::EnvVars,
-    ) -> anyhow::Result<QueryKind> {
-        StakeRegistrationInsertQuery::prepare_batch(session, cfg)
-            .await
-            .map(QueryKind::Batch)
-    }
-}
-
 impl fmt::Debug for StakeRegistrationInsertQuery {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let stake_public_key = hex::encode(self.stake_public_key.as_ref());
@@ -92,11 +80,10 @@ impl fmt::Debug for StakeRegistrationInsertQuery {
 /// Insert stake registration
 const INSERT_STAKE_REGISTRATION_QUERY: &str = include_str!("./cql/insert_stake_registration.cql");
 
-impl fmt::Display for StakeRegistrationInsertQuery {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{INSERT_STAKE_REGISTRATION_QUERY}")
-    }
-}
+impl_query_batch!(
+    StakeRegistrationInsertQuery,
+    INSERT_STAKE_REGISTRATION_QUERY
+);
 
 impl StakeRegistrationInsertQuery {
     /// Create a new Insert Query.

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

@@ -8,9 +8,10 @@ use tracing::error;
 
 use crate::{
     db::{
-        index::queries::{PreparedQueries, Query, QueryKind, SizedBatch},
+        index::queries::{PreparedQueries, SizedBatch},
         types::{DbSlot, DbTxnIndex},
     },
+    impl_query_batch,
     settings::cassandra_db,
 };
 
@@ -40,16 +41,7 @@ pub(crate) struct Cip36Insert {
     cip36: bool,
 }
 
-impl Query for Cip36Insert {
-    /// 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_query_batch!(Cip36Insert, INSERT_CIP36_REGISTRATION_QUERY);
 
 impl fmt::Debug for Cip36Insert {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -71,12 +63,6 @@ impl fmt::Debug for Cip36Insert {
     }
 }
 
-impl fmt::Display for Cip36Insert {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{INSERT_CIP36_REGISTRATION_QUERY}")
-    }
-}
-
 impl Cip36Insert {
     /// Create a new Insert Query.
     pub fn new(vote_key: &VotingPubKey, slot_no: Slot, txn_index: TxnIndex, cip36: &Cip36) -> Self {

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

@@ -1,16 +1,17 @@
 //! Insert CIP36 Registration Query
 
-use std::{fmt, sync::Arc};
+use std::sync::Arc;
 
 use cardano_blockchain_types::{Cip36, Slot, TxnIndex, VotingPubKey};
 use scylla::{SerializeRow, Session};
 use tracing::error;
 
 use crate::{
     db::{
-        index::queries::{PreparedQueries, Query, QueryKind, SizedBatch},
+        index::queries::{PreparedQueries, SizedBatch},
         types::{DbSlot, DbTxnIndex},
     },
+    impl_query_batch,
     settings::cassandra_db,
 };
 
@@ -33,22 +34,10 @@ pub(crate) struct Cip36ForVoteKeyInsert {
     valid: bool,
 }
 
-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_query_batch!(
+    Cip36ForVoteKeyInsert,
+    INSERT_CIP36_REGISTRATION_FOR_VOTE_KEY_QUERY
+);
 
 impl Cip36ForVoteKeyInsert {
     /// Create a new Insert Query.

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

@@ -9,9 +9,10 @@ use tracing::error;
 
 use crate::{
     db::{
-        index::queries::{PreparedQueries, Query, QueryKind, SizedBatch},
+        index::queries::{PreparedQueries, SizedBatch},
         types::{DbSlot, DbTxnIndex},
     },
+    impl_query_batch,
     settings::cassandra_db,
 };
 
@@ -46,16 +47,7 @@ pub(crate) struct Cip36InvalidInsert {
     problem_report: String,
 }
 
-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_query_batch!(Cip36InvalidInsert, INSERT_CIP36_REGISTRATION_INVALID_QUERY);
 
 impl fmt::Debug for Cip36InvalidInsert {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -79,12 +71,6 @@ impl fmt::Debug for Cip36InvalidInsert {
     }
 }
 
-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(

catalyst-gateway/bin/src/db/index/block/rbac509/insert_catalyst_id_for_stake_address.rs

@@ -12,6 +12,7 @@ use crate::{
         index::queries::{PreparedQueries, SizedBatch},
         types::{DbCatalystId, DbSlot, DbStakeAddress},
     },
+    impl_query_batch,
     settings::cassandra_db::EnvVars,
 };
 
@@ -20,7 +21,7 @@ const QUERY: &str = include_str!("cql/insert_catalyst_id_for_stake_address.cql")
 
 /// Insert Catalyst ID For Stake Address Query Parameters
 #[derive(SerializeRow)]
-pub(crate) struct Params {
+pub(crate) struct CatalystIdForStakeAddressInsert {
     /// A stake address.
     stake_address: DbStakeAddress,
     /// A Catalyst short identifier.
@@ -29,20 +30,22 @@ pub(crate) struct Params {
     slot_no: DbSlot,
 }
 
-impl Debug for Params {
+impl_query_batch!(CatalystIdForStakeAddressInsert, QUERY);
+
+impl Debug for CatalystIdForStakeAddressInsert {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        f.debug_struct("Params")
+        f.debug_struct("CatalystIdForStakeAddressInsert")
             .field("stake_address", &self.stake_address)
             .field("catalyst_id", &self.catalyst_id)
             .field("slot_no", &self.slot_no)
             .finish()
     }
 }
 
-impl Params {
+impl CatalystIdForStakeAddressInsert {
     /// Create a new record for this transaction.
     pub(crate) fn new(stake_address: StakeAddress, slot_no: Slot, catalyst_id: CatalystId) -> Self {
-        Params {
+        CatalystIdForStakeAddressInsert {
             stake_address: stake_address.into(),
             catalyst_id: catalyst_id.into(),
             slot_no: slot_no.into(),

catalyst-gateway/bin/src/db/index/block/rbac509/insert_catalyst_id_for_txn_id.rs

@@ -12,6 +12,7 @@ use crate::{
         index::queries::{PreparedQueries, SizedBatch},
         types::{DbCatalystId, DbTransactionId},
     },
+    impl_query_batch,
     settings::cassandra_db::EnvVars,
 };
 
@@ -20,26 +21,28 @@ const QUERY: &str = include_str!("cql/insert_catalyst_id_for_txn_id.cql");
 
 /// Insert Catalyst ID For Transaction ID Query Parameters
 #[derive(SerializeRow)]
-pub(crate) struct Params {
+pub(crate) struct CatalystIdForTxnIdInsert {
     /// A transaction hash.
     txn_id: DbTransactionId,
     /// A Catalyst short identifier.
     catalyst_id: DbCatalystId,
 }
 
-impl Debug for Params {
+impl_query_batch!(CatalystIdForTxnIdInsert, QUERY);
+
+impl Debug for CatalystIdForTxnIdInsert {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        f.debug_struct("Params")
+        f.debug_struct("CatalystIdForTxnIdInsert")
             .field("txn_id", &self.txn_id)
             .field("catalyst_id", &self.catalyst_id)
             .finish()
     }
 }
 
-impl Params {
+impl CatalystIdForTxnIdInsert {
     /// Creates a new record for this transaction.
     pub(crate) fn new(catalyst_id: CatalystId, txn_id: TransactionId) -> Self {
-        Params {
+        CatalystIdForTxnIdInsert {
             txn_id: txn_id.into(),
             catalyst_id: catalyst_id.into(),
         }

catalyst-gateway/bin/src/db/index/block/rbac509/insert_rbac509.rs

@@ -1,6 +1,6 @@
 //! Insert RBAC 509 Registration Query.
 
-use std::{fmt::Debug, sync::Arc};
+use std::{fmt, sync::Arc};
 
 use cardano_blockchain_types::{Slot, TransactionId, TxnIndex};
 use catalyst_types::{catalyst_id::CatalystId, uuid::UuidV4};
@@ -12,6 +12,7 @@ use crate::{
         index::queries::{PreparedQueries, SizedBatch},
         types::{DbCatalystId, DbSlot, DbTransactionId, DbTxnIndex, DbUuidV4},
     },
+    impl_query_batch,
     settings::cassandra_db::EnvVars,
 };
 
@@ -20,7 +21,7 @@ const QUERY: &str = include_str!("cql/insert_rbac509.cql");
 
 /// Insert RBAC Registration Query Parameters
 #[derive(SerializeRow)]
-pub(crate) struct Params {
+pub(crate) struct Rbac509Insert {
     /// A Catalyst short identifier.
     catalyst_id: DbCatalystId,
     /// A transaction hash
@@ -35,13 +36,15 @@ pub(crate) struct Params {
     purpose: DbUuidV4,
 }
 
-impl Debug for Params {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl_query_batch!(Rbac509Insert, QUERY);
+
+impl fmt::Debug for Rbac509Insert {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let prv_txn_id = match self.prv_txn_id {
             MaybeUnset::Unset => "UNSET".to_owned(),
             MaybeUnset::Set(ref v) => format!("{v:?}"),
         };
-        f.debug_struct("Params")
+        f.debug_struct("Rbac509Insert")
             .field("catalyst_id", &self.catalyst_id)
             .field("txn_id", &self.txn_id)
             .field("slot_no", &self.slot_no)
@@ -52,7 +55,7 @@ impl Debug for Params {
     }
 }
 
-impl Params {
+impl Rbac509Insert {
     /// Create a new record for this transaction.
     pub(crate) fn new(
         catalyst_id: CatalystId, txn_id: TransactionId, slot_no: Slot, txn_index: TxnIndex,

catalyst-gateway/bin/src/db/index/block/rbac509/insert_rbac509_invalid.rs

@@ -1,6 +1,6 @@
 //! Insert invalid RBAC 509 Registration Query.
 
-use std::{fmt::Debug, sync::Arc};
+use std::{fmt, sync::Arc};
 
 use cardano_blockchain_types::{Slot, TransactionId, TxnIndex};
 use catalyst_types::{catalyst_id::CatalystId, problem_report::ProblemReport, uuid::UuidV4};
@@ -12,6 +12,7 @@ use crate::{
         index::queries::{PreparedQueries, SizedBatch},
         types::{DbCatalystId, DbSlot, DbTransactionId, DbTxnIndex, DbUuidV4},
     },
+    impl_query_batch,
     settings::cassandra_db::EnvVars,
 };
 
@@ -20,7 +21,7 @@ const QUERY: &str = include_str!("cql/insert_rbac509_invalid.cql");
 
 /// Insert an invalid RBAC registration query parameters.
 #[derive(SerializeRow)]
-pub(crate) struct Params {
+pub(crate) struct Rbac509InvalidInsert {
     /// A Catalyst short identifier.
     catalyst_id: DbCatalystId,
     /// A transaction hash of this registration.
@@ -37,7 +38,9 @@ pub(crate) struct Params {
     problem_report: String,
 }
 
-impl Params {
+impl_query_batch!(Rbac509InvalidInsert, QUERY);
+
+impl Rbac509InvalidInsert {
     /// Create a new record for this transaction.
     pub(crate) fn new(
         catalyst_id: CatalystId, txn_id: TransactionId, slot_no: Slot, txn_index: TxnIndex,
@@ -81,8 +84,8 @@ impl Params {
     }
 }
 
-impl Debug for Params {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl fmt::Debug for Rbac509InvalidInsert {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let prv_txn_id = match self.prv_txn_id {
             MaybeUnset::Unset => "UNSET".to_owned(),
             MaybeUnset::Set(v) => format!("{v}"),
@@ -91,7 +94,7 @@ impl Debug for Params {
             MaybeUnset::Unset => "UNSET".to_owned(),
             MaybeUnset::Set(v) => format!("{}", UuidV4::from(v)),
         };
-        f.debug_struct("Params")
+        f.debug_struct("Rbac509InvalidInsert")
             .field("catalyst_id", &self.catalyst_id)
             .field("txn_id", &self.txn_id)
             .field("slot_no", &self.slot_no)