Struct EventClient 

pub struct EventClient { /* private fields */ }

The client for SSE.

This is a simple wrapper around reqwest::Client that provides subscription function for SSE.

Implementations

impl EventClient

pub fn new(client: Client) -> EventClient

Create a new client with the given reqwest client.

use mev_share_sse::EventClient;
let client = EventClient::new(reqwest::Client::new());

pub fn with_max_retries(self, max_retries: u64) -> EventClient

Set the maximum number of retries.

pub fn set_max_retries(&mut self, max_retries: u64)

Set the maximum number of retries.

pub async fn subscribe<T>( &self, endpoint: &str, ) -> Result<EventStream<T>, Error>

where T: DeserializeOwned,

Subscribe to the MEV-share SSE endpoint.

This connects to the endpoint and returns a stream of T items.

See EventClient::events for a more convenient way to subscribe to Event streams.

pub async fn subscribe_with_query<T, S>( &self, endpoint: &str, query: S, ) -> Result<EventStream<T>, Error>

where T: DeserializeOwned, S: Serialize,

Subscribe to the MEV-share SSE endpoint with additional query params.

This connects to the endpoint and returns a stream of T items.

See EventClient::events for a more convenient way to subscribe to Event streams.

pub async fn events(&self, endpoint: &str) -> Result<EventStream<Event>, Error>

Subscribe to a a stream of Events.

This is a convenience function for EventClient::subscribe.

Example

use futures_util::StreamExt;
use mev_share_sse::EventClient;
  let client = EventClient::default();
  let mut stream = client.events("https://mev-share.flashbots.net").await.unwrap();
  while let Some(event) = stream.next().await {
   dbg!(&event);
  }

pub async fn event_history( &self, endpoint: &str, params: EventHistoryParams, ) -> Result<Vec<EventHistory>, Error>

Gets past events that were broadcast via the SSE event stream.

Such as https://mev-share.flashbots.net/api/v1/history.

Example

use mev_share_sse::EventClient;
use mev_share_sse::EventHistoryParams;
  let client = EventClient::default();
  let params = EventHistoryParams::default();
  let history = client.event_history("https://mev-share.flashbots.net/api/v1/history", params).await.unwrap();
  dbg!(&history);

pub async fn event_history_info( &self, endpoint: &str, ) -> Result<EventHistoryInfo, Error>

Gets information about the event history endpoint

Such as https://mev-share.flashbots.net/api/v1/history/info.

Example

use mev_share_sse::EventClient;
  let client = EventClient::default();
  let info = client.event_history_info("https://mev-share.flashbots.net/api/v1/history/info").await.unwrap();
  dbg!(&info);

Trait Implementations

impl Clone for EventClient

fn clone(&self) -> EventClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventClient

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

Formats the value using the given formatter.

impl Default for EventClient

fn default() -> EventClient

Returns the “default value” for a type.