Struct EthFilter 

pub struct EthFilter<Eth: EthApiTypes> { /* private fields */ }

Eth filter RPC implementation.

This type handles eth_ rpc requests related to filters (eth_getLogs).

Implementations

impl<Eth> EthFilter<Eth>

where Eth: EthApiTypes + 'static,

pub fn new(eth_api: Eth, config: EthFilterConfig, task_spawner: Runtime) -> Self

Creates a new, shareable instance.

This uses the given pool to get notified about new transactions, the provider to interact with the blockchain, the cache to fetch cacheable data, like the logs.

See also EthFilterConfig.

This also spawns a task that periodically clears stale filters.

Create a new instance with EthApi

use reth_evm_ethereum::EthEvmConfig;
use reth_network_api::noop::NoopNetwork;
use reth_provider::noop::NoopProvider;
use reth_rpc::{EthApi, EthFilter};
use reth_tasks::Runtime;
use reth_transaction_pool::noop::NoopTransactionPool;
let eth_api = EthApi::builder(
    NoopProvider::default(),
    NoopTransactionPool::default(),
    NoopNetwork::default(),
    EthEvmConfig::mainnet(),
)
.build();
let filter = EthFilter::new(eth_api, Default::default(), Runtime::test());

pub fn active_filters( &self, ) -> &ActiveFilters<RpcTransaction<Eth::NetworkTypes>>

Returns all currently active filters

pub async fn clear_stale_filters(&self, now: Instant)

Clears all filters that have not been polled for longer than the configured stale_filter_ttl at the given instant.

impl<Eth> EthFilter<Eth>

where Eth: FullEthApiTypes<Provider: BlockReader + BlockIdReader> + LoadReceipt + EthBlocks,

pub async fn filter_changes( &self, id: FilterId, ) -> Result<FilterChanges<RpcTransaction<Eth::NetworkTypes>, RpcLog<Eth::NetworkTypes>>, EthFilterError>

Returns all the filter changes for the given id, if any

pub async fn filter_logs( &self, id: FilterId, ) -> Result<Vec<RpcLog<Eth::NetworkTypes>>, EthFilterError>

Returns an array of all logs matching filter with given id.

Returns an error if no matching log filter exists.

Handler for eth_getFilterLogs

Trait Implementations

impl<Eth> Clone for EthFilter<Eth>

where Eth: EthApiTypes,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Eth> Debug for EthFilter<Eth>

where Eth: EthApiTypes,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Eth> EngineEthFilter<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Log> for EthFilter<Eth>

where Eth: FullEthApiTypes + RpcNodeCoreExt<Provider: BlockIdReader> + LoadReceipt + EthBlocks,

fn logs( &self, filter: Filter, limits: QueryLimits, ) -> impl Future<Output = RpcResult<Vec<RpcLog<Eth::NetworkTypes>>>> + Send

Returns logs matching given filter object, no query limits

impl<Eth> EthFilterApiServer<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Log> for EthFilter<Eth>

where Eth: FullEthApiTypes + LoadReceipt + EthBlocks,

async fn new_filter(&self, filter: Filter) -> RpcResult<FilterId>

Handler for eth_newFilter

async fn new_block_filter(&self) -> RpcResult<FilterId>

Handler for eth_newBlockFilter

async fn new_pending_transaction_filter( &self, kind: Option<PendingTransactionFilterKind>, ) -> RpcResult<FilterId>

Handler for eth_newPendingTransactionFilter

async fn filter_changes( &self, id: FilterId, ) -> RpcResult<FilterChanges<RpcTransaction<Eth::NetworkTypes>, RpcLog<Eth::NetworkTypes>>>

Handler for eth_getFilterChanges

async fn filter_logs( &self, id: FilterId, ) -> RpcResult<Vec<RpcLog<Eth::NetworkTypes>>>

Returns an array of all logs matching filter with given id.

Returns an error if no matching log filter exists.

Handler for eth_getFilterLogs

async fn uninstall_filter(&self, id: FilterId) -> RpcResult<bool>

Handler for eth_uninstallFilter

async fn logs( &self, filter: Filter, ) -> RpcResult<Vec<RpcLog<Eth::NetworkTypes>>>

Returns logs matching given filter object.

Handler for eth_getLogs

fn into_rpc(self) -> RpcModule<Self>

where T: Send + Sync + 'static + Clone + Serialize, L: Send + Sync + 'static + Clone + Serialize,

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes