Struct sui_sdk::apis::EventApi

pub struct EventApi { /* private fields */ }

Event API provides the functionality to fetch, query, or subscribe to events on the Sui network.

Implementations

impl EventApi

pub async fn subscribe_event( &self, filter: EventFilter, ) -> SuiRpcResult<impl Stream<Item = SuiRpcResult<SuiEvent>>>

Return a stream of events, or an error upon failure.

Subscription is only possible via WebSockets. For a list of possible event filters, see [EventFilter].

Examples

use futures::StreamExt;
use std::str::FromStr;
use sui_json_rpc_types::EventFilter;
use sui_sdk::SuiClientBuilder;
use sui_types::base_types::SuiAddress;
#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .ws_url("wss://rpc.mainnet.sui.io:443")
        .build("https://fullnode.mainnet.sui.io:443")
        .await?;
    let mut subscribe_all = sui
        .event_api()
        .subscribe_event(EventFilter::All([]))
        .await?;
    loop {
        println!("{:?}", subscribe_all.next().await);
    }
    Ok(())
}

pub async fn get_events( &self, digest: TransactionDigest, ) -> SuiRpcResult<Vec<SuiEvent>>

Return a list of events for the given transaction digest, or an error upon failure.

pub async fn query_events( &self, query: EventFilter, cursor: Option<EventID>, limit: Option<usize>, descending_order: bool, ) -> SuiRpcResult<EventPage>

Return a paginated response with events for the given event filter, or an error upon failure.

The ordering of the events can be set with the descending_order argument. For a list of possible event filters, see [EventFilter].

pub fn get_events_stream( &self, query: EventFilter, cursor: Option<EventID>, descending_order: bool, ) -> impl Stream<Item = SuiEvent> + '_

Return a stream of events for the given event filter.

The ordering of the events can be set with the descending_order argument. For a list of possible event filters, see [EventFilter].

Trait Implementations

impl Clone for EventApi

fn clone(&self) -> EventApi

Returns a copy of the value.

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

Performs copy-assignment from source.