feat(cat-gateway): CIP36 Registration queries

.config/dictionaries/project.dic

@@ -7,6 +7,7 @@ adminer
 afinet
 androidx
 anypolicy
+appbar
 appspot
 Arbritrary
 ARGB
@@ -294,4 +295,3 @@ xctestrun
 xcworkspace
 xvfb
 yoroi
-appbar

catalyst-gateway/Earthfile

@@ -16,7 +16,7 @@ COPY_SRC:
 
 # builder : Set up our target toolchains, and copy our files.
 builder:
- DO rust-ci+SETUP
+ DO rust-ci+SETUP --CACHE_VERSION="00002"
 
 # sync-cfg: Synchronize local config with CI version.
 # Must be run by the developer manually.

catalyst-gateway/bin/src/db/index/queries/cql/get_invalid_registration_w_stake_addr.cql

@@ -0,0 +1,9 @@
+SELECT error_report,
+ stake_address,
+ vote_key,
+ payment_address,
+ is_payable,
+ cip36
+FROM cip36_registration_invalid
+WHERE stake_address = :stake_address
+ AND slot_no >= :slot_no 

catalyst-gateway/bin/src/db/index/queries/cql/get_registrations_w_stake_addr.cql

@@ -0,0 +1,10 @@
+SELECT stake_address,
+ nonce,
+ slot_no,
+ txn,
+ vote_key,
+ payment_address,
+ is_payable,
+ cip36
+FROM cip36_registration
+WHERE stake_address = :stake_address

catalyst-gateway/bin/src/db/index/queries/cql/get_stake_addr_w_stake_key_hash.cql

@@ -0,0 +1,3 @@
+SELECT stake_address
+FROM stake_registration
+WHERE stake_hash = :stake_hash;

catalyst-gateway/bin/src/db/index/queries/cql/get_stake_addr_w_vote_key.cql

@@ -0,0 +1,4 @@
+SELECT stake_address
+FROM cip36_registration_for_vote_key
+WHERE vote_key = :vote_key
+ALLOW FILTERING;

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

@@ -2,13 +2,18 @@
 //!
 //! This improves query execution time.
 
+pub(crate) mod registrations;
 pub(crate) mod staked_ada;
 pub(crate) mod sync_status;
 
 use std::{fmt::Debug, sync::Arc};
 
 use anyhow::{bail, Context};
 use crossbeam_skiplist::SkipMap;
+use registrations::{
+ get_from_stake_addr::GetRegistrationQuery, get_from_stake_hash::GetStakeAddrQuery,
+ get_from_vote_key::GetStakeAddrFromVoteKeyQuery, get_invalid::GetInvalidRegistrationQuery,
+};
 use scylla::{
  batch::Batch, prepared_statement::PreparedStatement, serialize::row::SerializeRow,
  transport::iterator::RowIterator, QueryResult, Session,
@@ -56,9 +61,17 @@ pub(crate) enum PreparedQuery {
 /// All prepared SELECT query statements (return data).
 pub(crate) enum PreparedSelectQuery {
  /// Get TXO by stake address query.
- GetTxoByStakeAddress,
+ TxoByStakeAddress,
  /// Get TXI by transaction hash query.
- GetTxiByTransactionHash,
+ TxiByTransactionHash,
+ /// Get Registrations
+ RegistrationFromStakeAddr,
+ /// Get invalid Registration
+ InvalidRegistrationsFromStakeAddr,
+ /// Get stake addr from stake hash
+ StakeAddrFromStakeHash,
+ /// Get stake addr from vote key
+ StakeAddrFromVoteKey,
 }
 
 /// All prepared UPSERT query statements (inserts/updates a single value of data).
@@ -94,6 +107,14 @@ pub(crate) struct PreparedQueries {
  txo_by_stake_address_query: PreparedStatement,
  /// Get TXI by transaction hash.
  txi_by_txn_hash_query: PreparedStatement,
+ /// Get registrations
+ registration_from_stake_addr_query: PreparedStatement,
+ /// stake addr from stake hash
+ stake_addr_from_stake_hash_query: PreparedStatement,
+ /// stake addr from vote key
+ stake_addr_from_vote_key_query: PreparedStatement,
+ /// Get invalid registrations
+ invalid_registrations_from_stake_addr_query: PreparedStatement,
  /// Insert Sync Status update.
  sync_status_insert: PreparedStatement,
 }
@@ -120,6 +141,11 @@ impl PreparedQueries {
  UpdateTxoSpentQuery::prepare_batch(session.clone(), cfg).await;
  let txo_by_stake_address_query = GetTxoByStakeAddressQuery::prepare(session.clone()).await;
  let txi_by_txn_hash_query = GetTxiByTxnHashesQuery::prepare(session.clone()).await;
+ let registration_from_stake_addr_query =
+ GetRegistrationQuery::prepare(session.clone()).await;
+ let stake_addr_from_stake_hash = GetStakeAddrQuery::prepare(session.clone()).await;
+ let stake_addr_from_vote_key = GetStakeAddrFromVoteKeyQuery::prepare(session.clone()).await;
+ let invalid_registrations = GetInvalidRegistrationQuery::prepare(session.clone()).await;
  let sync_status_insert = SyncStatusInsertQuery::prepare(session).await;
 
  let (
@@ -148,6 +174,10 @@ impl PreparedQueries {
  txo_spent_update_queries: txo_spent_update_queries?,
  txo_by_stake_address_query: txo_by_stake_address_query?,
  txi_by_txn_hash_query: txi_by_txn_hash_query?,
+ registration_from_stake_addr_query: registration_from_stake_addr_query?,
+ stake_addr_from_stake_hash_query: stake_addr_from_stake_hash?,
+ stake_addr_from_vote_key_query: stake_addr_from_vote_key?,
+ invalid_registrations_from_stake_addr_query: invalid_registrations?,
  sync_status_insert: sync_status_insert?,
  })
  }
@@ -223,8 +253,16 @@ impl PreparedQueries {
  ) -> anyhow::Result<RowIterator>
  where P: SerializeRow {
  let prepared_stmt = match select_query {
- PreparedSelectQuery::GetTxoByStakeAddress => &self.txo_by_stake_address_query,
- PreparedSelectQuery::GetTxiByTransactionHash => &self.txi_by_txn_hash_query,
+ PreparedSelectQuery::TxoByStakeAddress => &self.txo_by_stake_address_query,
+ PreparedSelectQuery::TxiByTransactionHash => &self.txi_by_txn_hash_query,
+ PreparedSelectQuery::RegistrationFromStakeAddr => {
+ &self.registration_from_stake_addr_query
+ },
+ PreparedSelectQuery::StakeAddrFromStakeHash => &self.stake_addr_from_stake_hash_query,
+ PreparedSelectQuery::StakeAddrFromVoteKey => &self.stake_addr_from_vote_key_query,
+ PreparedSelectQuery::InvalidRegistrationsFromStakeAddr => {
+ &self.invalid_registrations_from_stake_addr_query
+ },
  };
 
  session

catalyst-gateway/bin/src/db/index/queries/registrations/get_from_stake_addr.rs

@@ -0,0 +1,94 @@
+//! Get stake addr registrations
+
+use std::sync::Arc;
+
+use scylla::{
+ prepared_statement::PreparedStatement, transport::iterator::TypedRowIterator, SerializeRow,
+ Session,
+};
+use tracing::error;
+
+use crate::db::index::{
+ queries::{PreparedQueries, PreparedSelectQuery},
+ session::CassandraSession,
+};
+
+/// Get registrations from stake addr query.
+const GET_REGISTRATIONS_FROM_STAKE_ADDR_QUERY: &str =
+ include_str!("../cql/get_registrations_w_stake_addr.cql");
+
+/// Get registration
+#[derive(SerializeRow)]
+pub(crate) struct GetRegistrationParams {
+ /// Stake address.
+ pub stake_address: Vec<u8>,
+}
+
+impl GetRegistrationParams {
+ /// Create a new instance of [`GetRegistrationParams`]
+ pub(crate) fn new(stake_addr: Vec<u8>) -> GetRegistrationParams {
+ Self {
+ stake_address: stake_addr,
+ }
+ }
+}
+
+/// Get registration given stake addr or vote key
+#[allow(clippy::expect_used)]
+mod result {
+ use scylla::FromRow;
+
+ /// Get registration query result.
+ #[derive(FromRow)]
+ pub(crate) struct GetRegistrationQuery {
+ /// Full Stake Address (not hashed, 32 byte ED25519 Public key).
+ pub stake_address: Vec<u8>,
+ /// Nonce value after normalization.
+ pub nonce: num_bigint::BigInt,
+ /// Slot Number the cert is in.
+ pub slot_no: num_bigint::BigInt,
+ /// Transaction Index.
+ pub txn: i16,
+ /// Voting Public Key
+ pub vote_key: Vec<u8>,
+ /// Full Payment Address (not hashed, 32 byte ED25519 Public key).
+ pub payment_address: Vec<u8>,
+ /// Is the stake address a script or not.
+ pub is_payable: bool,
+ /// Is the Registration CIP36 format, or CIP15
+ pub cip36: bool,
+ }
+}
+/// Get registration query.
+pub(crate) struct GetRegistrationQuery;
+
+impl GetRegistrationQuery {
+ /// Prepares a get registration query.
+ pub(crate) async fn prepare(session: Arc<Session>) -> anyhow::Result<PreparedStatement> {
+ let get_registrations_query = PreparedQueries::prepare(
+ session,
+ GET_REGISTRATIONS_FROM_STAKE_ADDR_QUERY,
+ scylla::statement::Consistency::All,
+ true,
+ )
+ .await;
+
+ if let Err(ref error) = get_registrations_query {
+ error!(error=%error, "Failed to prepare get registration query.");
+ };
+
+ get_registrations_query
+ }
+
+ /// Executes get registration info for given stake addr query.
+ pub(crate) async fn execute(
+ session: &CassandraSession, params: GetRegistrationParams,
+ ) -> anyhow::Result<TypedRowIterator<result::GetRegistrationQuery>> {
+ let iter = session
+ .execute_iter(PreparedSelectQuery::RegistrationFromStakeAddr, params)
+ .await?
+ .into_typed::<result::GetRegistrationQuery>();
+
+ Ok(iter)
+ }
+}

catalyst-gateway/bin/src/db/index/queries/registrations/get_from_stake_hash.rs

@@ -0,0 +1,78 @@
+//! Get stake addr from stake hash
+
+use std::sync::Arc;
+
+use scylla::{
+ prepared_statement::PreparedStatement, transport::iterator::TypedRowIterator, SerializeRow,
+ Session,
+};
+use tracing::error;
+
+use crate::db::index::{
+ queries::{PreparedQueries, PreparedSelectQuery},
+ session::CassandraSession,
+};
+
+/// Get stake addr from stake hash query string.
+const GET_STAKE_ADDR_FROM_STAKE_HASH: &str =
+ include_str!("../cql/get_stake_addr_w_stake_key_hash.cql");
+
+/// Get stake addr
+#[derive(SerializeRow)]
+pub(crate) struct GetStakeAddrParams {
+ /// Stake hash.
+ pub stake_hash: Vec<u8>,
+}
+
+impl GetStakeAddrParams {
+ /// Create a new instance of [`GetStakeAddrParams`]
+ pub(crate) fn new(stake_hash: Vec<u8>) -> GetStakeAddrParams {
+ Self { stake_hash }
+ }
+}
+
+/// Get stake addr from stake hash query string.
+#[allow(clippy::expect_used)]
+mod result {
+ use scylla::FromRow;
+
+ /// Get stake addr from stake hash query result.
+ #[derive(FromRow)]
+ pub(crate) struct GetStakeAddrQuery {
+ /// Full Stake Address (not hashed, 32 byte ED25519 Public key).
+ pub stake_address: Vec<u8>,
+ }
+}
+/// Get registration query.
+pub(crate) struct GetStakeAddrQuery;
+
+impl GetStakeAddrQuery {
+ /// Prepares a get get stake addr from stake hash query.
+ pub(crate) async fn prepare(session: Arc<Session>) -> anyhow::Result<PreparedStatement> {
+ let get_stake_addr_query = PreparedQueries::prepare(
+ session,
+ GET_STAKE_ADDR_FROM_STAKE_HASH,
+ scylla::statement::Consistency::All,
+ true,
+ )
+ .await;
+
+ if let Err(ref error) = get_stake_addr_query {
+ error!(error=%error, "Failed to prepare get stake addr query.");
+ };
+
+ get_stake_addr_query
+ }
+
+ /// Executes a get txi by transaction hashes query.
+ pub(crate) async fn execute(
+ session: &CassandraSession, params: GetStakeAddrParams,
+ ) -> anyhow::Result<TypedRowIterator<result::GetStakeAddrQuery>> {
+ let iter = session
+ .execute_iter(PreparedSelectQuery::StakeAddrFromStakeHash, params)
+ .await?
+ .into_typed::<result::GetStakeAddrQuery>();
+
+ Ok(iter)
+ }
+}