Trait ObserverPlugin 

pub trait ObserverPlugin:
    Send
    + Sync
    + 'static {
    // Provided methods
    fn name(&self) -> &'static str { ... }
    fn wants_raw_packet(&self) -> bool { ... }
    fn on_raw_packet<'life0, 'async_trait>(
        &'life0 self,
        _event: RawPacketEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_shred(&self) -> bool { ... }
    fn on_shred<'life0, 'async_trait>(
        &'life0 self,
        _event: ShredEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_dataset(&self) -> bool { ... }
    fn on_dataset<'life0, 'async_trait>(
        &'life0 self,
        _event: DatasetEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_transaction(&self) -> bool { ... }
    fn accepts_transaction(&self, _event: &TransactionEvent) -> bool { ... }
    fn accepts_transaction_ref(&self, event: TransactionEventRef<'_>) -> bool { ... }
    fn transaction_interest(
        &self,
        event: &TransactionEvent,
    ) -> TransactionInterest { ... }
    fn transaction_interest_ref(
        &self,
        event: TransactionEventRef<'_>,
    ) -> TransactionInterest { ... }
    fn on_transaction<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _event: &'life1 TransactionEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_transaction_with_interest<'life0, 'life1, 'async_trait>(
        &'life0 self,
        event: &'life1 TransactionEvent,
        _interest: TransactionInterest,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn wants_account_touch(&self) -> bool { ... }
    fn accepts_account_touch_ref(
        &self,
        _event: AccountTouchEventRef<'_>,
    ) -> bool { ... }
    fn on_account_touch<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _event: &'life1 AccountTouchEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn wants_slot_status(&self) -> bool { ... }
    fn on_slot_status<'life0, 'async_trait>(
        &'life0 self,
        _event: SlotStatusEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_reorg(&self) -> bool { ... }
    fn on_reorg<'life0, 'async_trait>(
        &'life0 self,
        _event: ReorgEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_recent_blockhash(&self) -> bool { ... }
    fn on_recent_blockhash<'life0, 'async_trait>(
        &'life0 self,
        _event: ObservedRecentBlockhashEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_cluster_topology(&self) -> bool { ... }
    fn on_cluster_topology<'life0, 'async_trait>(
        &'life0 self,
        _event: ClusterTopologyEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn wants_leader_schedule(&self) -> bool { ... }
    fn on_leader_schedule<'life0, 'async_trait>(
        &'life0 self,
        _event: LeaderScheduleEvent,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
}

Extension point for SOF runtime event hooks.

Plugins are executed asynchronously by the plugin host worker, decoupled from ingest hot paths. Keep callbacks lightweight and use bounded work queues for any expensive downstream processing.

Provided Methods

fn name(&self) -> &'static str

Stable plugin identifier used in startup logs and diagnostics.

By default this uses core::any::type_name so simple plugins can skip boilerplate.

fn wants_raw_packet(&self) -> bool

Returns true when this plugin wants raw-packet callbacks.

fn on_raw_packet<'life0, 'async_trait>( &'life0 self, _event: RawPacketEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called for every UDP packet before shred parsing.

fn wants_shred(&self) -> bool

Returns true when this plugin wants parsed shred callbacks.

fn on_shred<'life0, 'async_trait>( &'life0 self, _event: ShredEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called for every packet that produced a valid parsed shred header.

fn wants_dataset(&self) -> bool

Returns true when this plugin wants reconstructed dataset callbacks.

fn on_dataset<'life0, 'async_trait>( &'life0 self, _event: DatasetEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called when a contiguous shred dataset is reconstructed.

fn wants_transaction(&self) -> bool

Returns true when this plugin wants decoded transaction callbacks.

fn accepts_transaction(&self, _event: &TransactionEvent) -> bool

Returns true when this plugin wants a specific decoded transaction callback.

This synchronous prefilter runs on the hot path before queueing the transaction hook. Use it to reject irrelevant transactions cheaply.

fn accepts_transaction_ref(&self, event: TransactionEventRef<'_>) -> bool

Borrowed transaction prefilter used on the dataset hot path.

Override this to avoid constructing an owned TransactionEvent for transactions that will be ignored anyway.

Plugins that only need borrowed fields should prefer this hook over Self::accepts_transaction.

fn transaction_interest(&self, event: &TransactionEvent) -> TransactionInterest

Returns transaction-interest priority for one decoded transaction callback.

The default preserves the historical API: accepted transactions are treated as critical and rejected transactions are ignored.

fn transaction_interest_ref( &self, event: TransactionEventRef<'_>, ) -> TransactionInterest

Borrowed transaction-interest classifier used on the dataset hot path.

Override this when classification can run directly on borrowed message data without first allocating an owned TransactionEvent.

Priority-sensitive plugins should implement this hook directly so the dataset hot path can classify traffic without allocating.

fn on_transaction<'life0, 'life1, 'async_trait>( &'life0 self, _event: &'life1 TransactionEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called for each decoded transaction emitted from a dataset.

fn on_transaction_with_interest<'life0, 'life1, 'async_trait>( &'life0 self, event: &'life1 TransactionEvent, _interest: TransactionInterest, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called for each accepted decoded transaction with the already-computed routing lane.

Implement this when the plugin wants to avoid recomputing the same synchronous routing/classification work inside Self::on_transaction.

fn wants_account_touch(&self) -> bool

Returns true when this plugin wants account-touch callbacks.

fn accepts_account_touch_ref(&self, _event: AccountTouchEventRef<'_>) -> bool

Borrowed account-touch prefilter used on the dataset hot path.

Override this to reject irrelevant account-touch callbacks before the runtime allocates owned account-key vectors.

fn on_account_touch<'life0, 'life1, 'async_trait>( &'life0 self, _event: &'life1 AccountTouchEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called for each decoded transaction’s static touched-account set.

fn wants_slot_status(&self) -> bool

Returns true when this plugin wants slot-status callbacks.

fn on_slot_status<'life0, 'async_trait>( &'life0 self, _event: SlotStatusEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called when local slot status transitions (processed/confirmed/finalized/orphaned).

fn wants_reorg(&self) -> bool

Returns true when this plugin wants reorg callbacks.

fn on_reorg<'life0, 'async_trait>( &'life0 self, _event: ReorgEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called when local canonical tip switches to a different branch.

fn wants_recent_blockhash(&self) -> bool

Returns true when this plugin wants recent-blockhash callbacks.

fn on_recent_blockhash<'life0, 'async_trait>( &'life0 self, _event: ObservedRecentBlockhashEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called when a newer observed recent blockhash is detected.

fn wants_cluster_topology(&self) -> bool

Returns true when this plugin wants cluster-topology callbacks.

fn on_cluster_topology<'life0, 'async_trait>( &'life0 self, _event: ClusterTopologyEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called on low-frequency cluster topology diffs/snapshots (gossip-bootstrap mode).

fn wants_leader_schedule(&self) -> bool

Returns true when this plugin wants leader-schedule callbacks.

fn on_leader_schedule<'life0, 'async_trait>( &'life0 self, _event: LeaderScheduleEvent, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called on event-driven leader-schedule diffs/snapshots.

Implementors