Struct SpamFilter 

pub struct SpamFilter { /* private fields */ }

Spam filter implementation

Implementations

impl SpamFilter

pub fn new() -> Self

Create a new spam filter with default configuration

pub fn with_config(config: SpamFilterConfig) -> Self

Create a new spam filter with custom configuration

pub fn with_preset(preset: SpamFilterPreset) -> Self

Create a new spam filter with a preset configuration

Presets provide easy-to-use configurations for common use cases:

• Disabled: No spam filtering
• Conservative: Lenient filtering, minimal false positives
• Moderate: Balanced filtering (default)
• Aggressive: Strong filtering, may have false positives

pub fn is_spam(&self, tx: &Transaction) -> SpamFilterResult

Check if a transaction is spam (without witness data)

This is the backward-compatible method. For better detection, use is_spam_with_witness.

pub fn is_spam_with_witness( &self, tx: &Transaction, witnesses: Option<&[Witness]>, utxo_set: Option<&UtxoSet>, ) -> SpamFilterResult

Check if a transaction is spam (with optional witness data and UTXO set)

Witness data is required for detecting Taproot/SegWit-based Ordinals. UTXO set is optional but improves fee rate calculation accuracy. If witness data is not provided, detection will be less accurate.

pub fn filter_transaction(&self, tx: &Transaction) -> Option<Transaction>

Filter a transaction based on spam detection

Returns Some(tx) if transaction should be included (not spam), or None if transaction should be filtered (spam).

pub fn filter_block( &self, transactions: &[Transaction], ) -> (Vec<Transaction>, SpamSummary)

Filter transactions from a block (without witness data)

Returns filtered transactions (non-spam only) and summary of filtered spam.

Important: This function filters entire transactions. For UTXO commitment processing, use process_filtered_block in initial_sync.rs which correctly handles spam transactions by removing spent inputs while filtering outputs.

This function is primarily used for:

• Bandwidth estimation (calculating filtered size)
• Statistics and reporting
• Network message filtering (where entire transactions can be dropped)

Do not use this for UTXO tree updates - it will cause UTXO set inconsistency when spam transactions spend non-spam inputs.

pub fn filter_block_with_witness( &self, transactions: &[Transaction], witnesses: Option<&[Vec<Witness>]>, ) -> (Vec<Transaction>, SpamSummary)

Filter transactions from a block (with optional witness data)

Returns filtered transactions (non-spam only) and summary of filtered spam. Witness data improves detection accuracy for SegWit/Taproot-based spam.

Important: This function filters entire transactions. For UTXO commitment processing, use process_filtered_block in initial_sync.rs which correctly handles spam transactions by removing spent inputs while filtering outputs.

This function is primarily used for:

• Bandwidth estimation (calculating filtered size)
• Statistics and reporting
• Network message filtering (where entire transactions can be dropped)

Do not use this for UTXO tree updates - it will cause UTXO set inconsistency when spam transactions spend non-spam inputs.

Trait Implementations

impl Clone for SpamFilter

fn clone(&self) -> SpamFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SpamFilter

fn default() -> Self

Returns the “default value” for a type.