From 11149d295e195fcdb480fe33e72c8c5c72cf900c Mon Sep 17 00:00:00 2001
From: greged93 <82421016+greged93@users.noreply.github.com>
Date: Thu, 24 Oct 2024 15:13:05 +0200
Subject: [PATCH] feat(payload builder): transaction pool filter (#10542)

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
---
 Cargo.lock                               |  2 +-
 crates/transaction-pool/src/pool/best.rs |  2 +-
 crates/transaction-pool/src/traits.rs    | 30 ++++++++++++++++++++++++
 3 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 3449e381f9..c3003c991f 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -11913,4 +11913,4 @@ checksum = "38ff0f21cfee8f97d94cef41359e0c89aa6113028ab0291aa8ca0038995a95aa"
 dependencies = [
  "cc",
  "pkg-config",
-]
+]
\ No newline at end of file
diff --git a/crates/transaction-pool/src/pool/best.rs b/crates/transaction-pool/src/pool/best.rs
index 52f25a9db8..77cd35d8a6 100644
--- a/crates/transaction-pool/src/pool/best.rs
+++ b/crates/transaction-pool/src/pool/best.rs
@@ -208,7 +208,7 @@ pub struct BestTransactionFilter<I, P> {
 
 impl<I, P> BestTransactionFilter<I, P> {
     /// Create a new [`BestTransactionFilter`] with the given predicate.
-    pub(crate) const fn new(best: I, predicate: P) -> Self {
+    pub const fn new(best: I, predicate: P) -> Self {
         Self { best, predicate }
     }
 }
diff --git a/crates/transaction-pool/src/traits.rs b/crates/transaction-pool/src/traits.rs
index 00cda8e1cb..eb9d35ad56 100644
--- a/crates/transaction-pool/src/traits.rs
+++ b/crates/transaction-pool/src/traits.rs
@@ -814,6 +814,36 @@ impl<T> BestTransactions for std::iter::Empty<T> {
     fn set_skip_blobs(&mut self, _skip_blobs: bool) {}
 }
 
+/// A filter that allows to check if a transaction satisfies a set of conditions
+pub trait TransactionFilter {
+    /// The type of the transaction to check.
+    type Transaction;
+
+    /// Returns true if the transaction satisfies the conditions.
+    fn is_valid(&self, transaction: &Self::Transaction) -> bool;
+}
+
+/// A no-op implementation of [`TransactionFilter`] which
+/// marks all transactions as valid.
+#[derive(Debug, Clone)]
+pub struct NoopTransactionFilter<T>(std::marker::PhantomData<T>);
+
+// We can't derive Default because this forces T to be
+// Default as well, which isn't necessary.
+impl<T> Default for NoopTransactionFilter<T> {
+    fn default() -> Self {
+        Self(std::marker::PhantomData)
+    }
+}
+
+impl<T> TransactionFilter for NoopTransactionFilter<T> {
+    type Transaction = T;
+
+    fn is_valid(&self, _transaction: &Self::Transaction) -> bool {
+        true
+    }
+}
+
 /// A Helper type that bundles the best transactions attributes together.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub struct BestTransactionsAttributes {