apollo_mempool: add validate tx api

Author: lev-starkware

crates/apollo_mempool/src/communication.rs

@@ -11,7 +11,12 @@ use apollo_mempool_types::communication::{
     MempoolResponse,
 };
 use apollo_mempool_types::errors::MempoolError;
-use apollo_mempool_types::mempool_types::{CommitBlockArgs, MempoolResult, MempoolSnapshot};
+use apollo_mempool_types::mempool_types::{
+    CommitBlockArgs,
+    MempoolResult,
+    MempoolSnapshot,
+    ValidationArgs,
+};
 use apollo_network_types::network_types::BroadcastedMessageMetadata;
 use apollo_time::time::DefaultClock;
 use async_trait::async_trait;
@@ -104,6 +109,11 @@ impl MempoolCommunicationWrapper {
         Ok(())
     }
 
+    fn validate_tx(&mut self, args: ValidationArgs) -> MempoolResult<()> {
+        self.mempool.validate_tx(args)?;
+        Ok(())
+    }
+
     fn commit_block(&mut self, args: CommitBlockArgs) -> MempoolResult<()> {
         self.mempool.commit_block(args);
         Ok(())
@@ -136,6 +146,9 @@ impl ComponentRequestHandler<MempoolRequest, MempoolResponse> for MempoolCommuni
         // Update the dynamic config before handling the request.
         self.update_dynamic_config().await;
         match request {
+            MempoolRequest::ValidateTransaction(args) => {
+                MempoolResponse::ValidateTransaction(self.validate_tx(args))
+            }
             MempoolRequest::AddTransaction(args) => {
                 MempoolResponse::AddTransaction(self.add_tx(args).await)
             }

crates/apollo_mempool/src/mempool.rs

@@ -10,6 +10,7 @@ use apollo_mempool_types::mempool_types::{
     MempoolResult,
     MempoolSnapshot,
     MempoolStateSnapshot,
+    ValidationArgs,
 };
 use apollo_time::time::{Clock, DateTime};
 use indexmap::IndexSet;
@@ -335,6 +336,12 @@ impl Mempool {
             .collect())
     }
 
+    /// Perform validation of an incoming transaction.
+    pub fn validate_tx(&mut self, _args: ValidationArgs) -> MempoolResult<()> {
+        // TODO(Lev): Implement validation of an incoming transaction.
+        Ok(())
+    }
+
     /// Adds a new transaction to the mempool.
     #[instrument(
         skip(self, args),

crates/apollo_mempool_types/src/communication.rs

@@ -22,7 +22,7 @@ use strum_macros::{AsRefStr, EnumDiscriminants, EnumIter, IntoStaticStr};
 use thiserror::Error;
 
 use crate::errors::MempoolError;
-use crate::mempool_types::{AddTransactionArgs, CommitBlockArgs, MempoolSnapshot};
+use crate::mempool_types::{AddTransactionArgs, CommitBlockArgs, MempoolSnapshot, ValidationArgs};
 
 pub type LocalMempoolClient = LocalComponentClient<MempoolRequest, MempoolResponse>;
 pub type RemoteMempoolClient = RemoteComponentClient<MempoolRequest, MempoolResponse>;
@@ -45,6 +45,7 @@ pub trait MempoolClient: Send + Sync {
     // TODO(AlonH): Add Option<BroadcastedMessageMetadata> as an argument for add_transaction
     // TODO(AlonH): Rename tx to transaction
     async fn add_tx(&self, args: AddTransactionArgsWrapper) -> MempoolClientResult<()>;
+    async fn validate_tx(&self, args: ValidationArgs) -> MempoolClientResult<()>;
     async fn commit_block(&self, args: CommitBlockArgs) -> MempoolClientResult<()>;
     async fn get_txs(&self, n_txs: usize) -> MempoolClientResult<Vec<InternalRpcTransaction>>;
     async fn account_tx_in_pool_or_recent_block(
@@ -63,6 +64,7 @@ pub trait MempoolClient: Send + Sync {
 )]
 pub enum MempoolRequest {
     AddTransaction(AddTransactionArgsWrapper),
+    ValidateTransaction(ValidationArgs),
     CommitBlock(CommitBlockArgs),
     GetTransactions(usize),
     AccountTxInPoolOrRecentBlock(ContractAddress),
@@ -79,6 +81,7 @@ impl PrioritizedRequest for MempoolRequest {
                 RequestPriority::High
             }
             MempoolRequest::AddTransaction(_)
+            | MempoolRequest::ValidateTransaction(_)
             | MempoolRequest::AccountTxInPoolOrRecentBlock(_)
             | MempoolRequest::UpdateGasPrice(_)
             | MempoolRequest::GetMempoolSnapshot() => RequestPriority::Normal,
@@ -89,6 +92,7 @@ impl PrioritizedRequest for MempoolRequest {
 #[derive(Clone, Serialize, Deserialize, AsRefStr)]
 pub enum MempoolResponse {
     AddTransaction(MempoolResult<()>),
+    ValidateTransaction(MempoolResult<()>),
     CommitBlock(MempoolResult<()>),
     GetTransactions(MempoolResult<Vec<InternalRpcTransaction>>),
     AccountTxInPoolOrRecentBlock(MempoolResult<bool>),
@@ -121,6 +125,17 @@ where
         )
     }
 
+    async fn validate_tx(&self, args: ValidationArgs) -> MempoolClientResult<()> {
+        let request = MempoolRequest::ValidateTransaction(args);
+        handle_all_response_variants!(
+            MempoolResponse,
+            ValidateTransaction,
+            MempoolClientError,
+            MempoolError,
+            Direct
+        )
+    }
+
     async fn commit_block(&self, args: CommitBlockArgs) -> MempoolClientResult<()> {
         let request = MempoolRequest::CommitBlock(args);
         handle_all_response_variants!(

crates/apollo_mempool_types/src/mempool_types.rs

@@ -7,6 +7,7 @@ use serde::{Deserialize, Serialize};
 use starknet_api::block::GasPrice;
 use starknet_api::core::{ContractAddress, Nonce};
 use starknet_api::rpc_transaction::InternalRpcTransaction;
+use starknet_api::transaction::fields::Tip;
 use starknet_api::transaction::TransactionHash;
 use strum::VariantNames;
 
@@ -39,6 +40,16 @@ impl AddTransactionArgs {
     }
 }
 
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct ValidationArgs {
+    pub address: ContractAddress,
+    pub account_nonce: Nonce,
+    pub tx_hash: TransactionHash,
+    pub tx_nonce: Nonce,
+    pub tip: Tip,
+    pub max_l2_gas_price: GasPrice,
+}
+
 #[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
 pub struct CommitBlockArgs {
     pub address_to_nonce: HashMap<ContractAddress, Nonce>,