Skip to main content

FlashbotsClient

Struct FlashbotsClient 

Source
pub struct FlashbotsClient { /* private fields */ }
Expand description

Main client for interacting with Flashbots relay

Implementations§

Source§

impl FlashbotsClient

Source

pub fn new(config: FlashbotsClientConfig) -> Self

Creates a new Flashbots client with custom configuration

Source

pub fn new_mainnet() -> Self

Creates a new client configured for Mainnet

Source

pub fn new_sepolia() -> Self

Creates a new client configured for Sepolia testnet

Source

pub fn with_max_retries(self, max_retries: u32) -> Self

Sets maximum retry attempts for operations

Source

pub fn with_timeout(self, timeout_seconds: u64) -> Self

Sets request timeout in seconds

Source

pub async fn send_bundle( &self, bundle: Bundle, ) -> FlashbotsResult<SendBundleResponse>

Sends a bundle to Flashbots relay

§Example
use flashbots_rs::{FlashbotsClient, Bundle};

let client = FlashbotsClient::new_mainnet();
let bundle = Bundle::default(); // Your bundle construction
let response = client.send_bundle(bundle).await?;
println!("Bundle sent with hash: {:?}", response.bundle_hash);
Source

pub async fn send_bundle_with_retry( &self, bundle: Bundle, ) -> FlashbotsResult<SendBundleResponse>

Sends a bundle with automatic retry logic

Source

pub async fn simulate_bundle( &self, simulation: SimulateBundleRequest, ) -> FlashbotsResult<SimulateBundleResponse>

Simulates bundle execution without submitting to the network

§Example
use flashbots_rs::{FlashbotsClient, SimulateBundleRequest};

let client = FlashbotsClient::new_mainnet();
let simulation = SimulateBundleRequest::default(); // Your simulation parameters
let result = client.simulate_bundle(simulation).await?;
println!("Simulation success: {}, Gas used: {}", result.success, result.gas_used);
Source

pub async fn simulate_bundle_with_retry( &self, simulation: SimulateBundleRequest, ) -> FlashbotsResult<SimulateBundleResponse>

Simulates bundle with automatic retry logic

Source

pub async fn get_bundle_stats( &self, bundle_hash: H256, block_number: U64, ) -> FlashbotsResult<BundleStats>

Gets bundle statistics for a specific block

Source

pub async fn get_bundle_receipt( &self, bundle_hash: H256, ) -> FlashbotsResult<BundleReceipt>

Gets bundle receipt by hash

Source

pub async fn get_user_stats( &self, address: Address, block_number: U64, ) -> FlashbotsResult<UserStats>

Gets user statistics for a specific address and block

Source

pub async fn get_health(&self) -> FlashbotsResult<bool>

Checks relay health status

§Example
use flashbots_rs::FlashbotsClient;

let client = FlashbotsClient::new_mainnet();
let is_healthy = client.get_health().await?;
println!("Relay is healthy: {}", is_healthy);
Source

pub async fn get_bundle_price( &self, block_number: U64, ) -> FlashbotsResult<BundlePriceResponse>

Gets bundle price for a specific block

Source

pub async fn wait_for_bundle_inclusion( &self, bundle_hash: H256, timeout_blocks: u64, ) -> FlashbotsResult<Option<BundleReceipt>>

Waits for bundle to be included in a block

§Example
use flashbots_rs::FlashbotsClient;
use ethers::types::H256;

let client = FlashbotsClient::new_mainnet();
let bundle_hash = H256::zero(); // Your actual bundle hash
let receipt = client.wait_for_bundle_inclusion(bundle_hash, 10).await?;
match receipt {
    Some(receipt) => println!("Bundle included: {:?}", receipt),
    None => println!("Bundle not included within timeout"),
}
Source

pub async fn send_and_wait_for_bundle( &self, bundle: Bundle, timeout_blocks: u64, ) -> FlashbotsResult<Option<BundleReceipt>>

Sends bundle and waits for inclusion

§Example
use flashbots_rs::{FlashbotsClient, Bundle};

let client = FlashbotsClient::new_mainnet();
let bundle = Bundle::default(); // Your bundle construction
let receipt = client.send_and_wait_for_bundle(bundle, 10).await?;
match receipt {
    Some(receipt) => println!("Bundle successfully included: {:?}", receipt),
    None => println!("Bundle not included within timeout"),
}
Source

pub async fn simulate_and_send_bundle( &self, bundle: Bundle, simulation_params: SimulateBundleRequest, ) -> FlashbotsResult<Option<SendBundleResponse>>

Simulates bundle and sends it if simulation is successful

Source

pub async fn send_bundles( &self, bundles: Vec<Bundle>, ) -> FlashbotsResult<Vec<FlashbotsResult<SendBundleResponse>>>

Sends multiple bundles in sequence

Source

pub fn config(&self) -> &FlashbotsClientConfig

Returns current client configuration

Source

pub fn with_config(&self, config: FlashbotsClientConfig) -> Self

Creates a new client instance with different configuration

Source

pub async fn send_raw_bundle( &self, raw_bundle: Value, ) -> FlashbotsResult<SendBundleResponse>

Send the raw transaction packet (low-level API)

Source

pub async fn cancel_bundles( &self, bundle_hashes: Vec<H256>, ) -> FlashbotsResult<CancelBundlesResponse>

Cancel submitted transaction package

§Example
let client = FlashbotsClient::new_mainnet();
let bundle_hashes = vec![H256::zero()]; // Transaction package hash
let result = client.cancel_bundles(bundle_hashes).await?;
println!("Cancel result: {}", result.success);
Source

pub async fn get_bundle_by_hash( &self, bundle_hash: H256, ) -> FlashbotsResult<BundleByHashResponse>

Retrieve transaction package details and receipts using transaction package hash.

Source

pub async fn get_block( &self, block_number: U64, ) -> FlashbotsResult<BlockResponse>

Get detailed information of a specified block

§Example
let client = FlashbotsClient::new_mainnet();
let block_number = U64::from(17000000u64);
let block_info = client.get_block(block_number).await?;
println!("Block miner: {:?}", block_info.miner);
Source

pub async fn get_latest_block(&self) -> FlashbotsResult<BlockResponse>

Get the latest block information

Source

pub async fn get_user_status( &self, address: Address, ) -> FlashbotsResult<UserStatus>

Obtain user status information (without relying on specific blocks)

§Example
let client = FlashbotsClient::new_mainnet();
let address = Address::zero(); // real address
let user_status = client.get_user_status(address).await?;
println!("User reputation: {:?}", user_status.reputation);
Source

pub async fn get_gas_price(&self) -> FlashbotsResult<GasPriceResponse>

Get recommended gas prices

§Example
let client = FlashbotsClient::new_mainnet();
let gas_prices = client.get_gas_price().await?;
println!("Fast gas price: {}", gas_prices.fast_gas_price);
Source

pub async fn get_supported_endpoints(&self) -> FlashbotsResult<Vec<String>>

Get the list of API endpoints supported by the repeater.

Source

pub async fn get_relay_info(&self) -> FlashbotsResult<RelayInfo>

Get repeater information

§Example
use flashbots_rs::FlashbotsClient;

let client = FlashbotsClient::new_mainnet();
let relay_info = client.get_relay_info().await?;
println!("Relay: {} v{}", relay_info.name, relay_info.version);
Source

pub async fn get_bundle_receipts( &self, bundle_hashes: Vec<H256>, ) -> FlashbotsResult<Vec<BundleReceipt>>

Batch Transaction Package Receipts

Source

pub async fn check_bundle_inclusions( &self, bundle_hashes: Vec<H256>, ) -> FlashbotsResult<Vec<(H256, bool)>>

Check if multiple transaction packages have been included.

Source

pub async fn send_bundle_and_get_receipt( &self, bundle: Bundle, timeout_blocks: u64, ) -> FlashbotsResult<BundleReceipt>

Send transaction package and get receipt (simplified version)

Source

pub async fn validate_bundle(&self, bundle: &Bundle) -> FlashbotsResult<bool>

Verify transaction package format

Source

pub async fn get_relay_stats(&self) -> FlashbotsResult<Value>

Obtain repeater performance statistics

Source

pub async fn get_builder_info(&self) -> FlashbotsResult<Value>

Get Builder Information

Source

pub async fn simulate_bundles( &self, simulations: Vec<SimulateBundleRequest>, ) -> FlashbotsResult<Vec<FlashbotsResult<SimulateBundleResponse>>>

Batch simulated trading package

Source

pub async fn send_and_cancel_bundle( &self, bundle: Bundle, ) -> FlashbotsResult<bool>

Send the transaction package and cancel it immediately (for testing purposes).

Source

pub async fn get_network_info(&self) -> FlashbotsResult<Value>

Get network information

Source

pub async fn is_blacklisted(&self, address: Address) -> FlashbotsResult<bool>

Check if the address is blacklisted.

Source

pub async fn get_version(&self) -> FlashbotsResult<String>

Get repeater version

Source§

impl FlashbotsClient

Source

pub fn new_production() -> Self

Creates a production-ready client (Mainnet, high retry count)

Source

pub fn new_development() -> Self

Creates a development client (testnet, fast failure)

Trait Implementations§

Source§

impl Clone for FlashbotsClient

Source§

fn clone(&self) -> FlashbotsClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlashbotsClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more