Struct alloy_contract::Event

pub struct Event<T, P, E, N = Ethereum> {
    pub provider: P,
    pub filter: Filter,
    /* private fields */
}

Helper for managing the event filter before querying or streaming its logs

Fields

provider: P

The provider to use for querying or streaming logs.

filter: Filter

The filter to use for querying or streaming logs.

Implementations

impl<T: Transport + Clone, P: Provider<T, N>, E: SolEvent, N: Network> Event<T, P, E, N>

pub const fn new(provider: P, filter: Filter) -> Self

Creates a new event with the provided provider and filter.

pub async fn query(&self) -> Result<Vec<(E, Log)>, Error>

Queries the blockchain for the selected filter and returns a vector of matching event logs.

pub async fn query_raw(&self) -> TransportResult<Vec<Log>>

Queries the blockchain for the selected filter and returns a vector of matching event logs, without decoding them.

pub async fn watch(&self) -> TransportResult<EventPoller<T, E>>

Watches for events that match the filter.

Returns a stream of decoded events and raw logs.

pub fn select(self, filter: impl Into<FilterBlockOption>) -> Self

Sets the inner filter object

See Filter::select.

pub fn from_block<B: Into<BlockNumberOrTag>>(self, block: B) -> Self

Sets the from block number

pub fn to_block<B: Into<BlockNumberOrTag>>(self, block: B) -> Self

Sets the to block number

pub fn is_pending_block_filter(&self) -> bool

Return true if filter configured to match pending block.

This means that both from_block and to_block are set to the pending tag.

pub fn at_block_hash<A: Into<B256>>(self, hash: A) -> Self

Pins the block hash for the filter

pub fn address<A: Into<ValueOrArray<Address>>>(self, address: A) -> Self

Sets the address to query with this filter.

See Filter::address.

pub fn event(self, event_name: &str) -> Self

Given the event signature in string form, it hashes it and adds it to the topics to monitor

pub fn events(self, events: impl IntoIterator<Item = impl AsRef<[u8]>>) -> Self

Hashes all event signatures and sets them as array to event_signature(topic0)

pub fn event_signature<TO: Into<Topic>>(self, topic: TO) -> Self

Sets event_signature(topic0) (the event name for non-anonymous events)

pub fn topic1<TO: Into<Topic>>(self, topic: TO) -> Self

Sets the 1st indexed topic

pub fn topic2<TO: Into<Topic>>(self, topic: TO) -> Self

Sets the 2nd indexed topic

pub fn topic3<TO: Into<Topic>>(self, topic: TO) -> Self

Sets the 3rd indexed topic

impl<T, P: Clone, E, N> Event<T, &P, E, N>

pub fn with_cloned_provider(self) -> Event<T, P, E, N>

Clones the provider and returns a new event with the cloned provider.

Trait Implementations

impl<T, P: Debug, E, N> Debug for Event<T, P, E, N>

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

Formats the value using the given formatter.