pub struct BundleRequest { /* private fields */ }
Expand description
A bundle that can be submitted to a Flashbots relay.
The bundle can include your own transactions and transactions from the mempool.
Additionally, this bundle can be simulated through a relay if simulation
parameters are provided using BundleRequest::set_simulation_block
and
BundleRequest::set_simulation_timestamp
.
Please note that some parameters are required, and submitting a bundle without them will get it rejected pre-flight. The required parameters include:
- At least one transaction (
BundleRequest::push_transaction
) - A target block (
BundleRequest::set_block
)
Implementations§
Source§impl BundleRequest
impl BundleRequest
Sourcepub fn push_transaction<T: Into<BundleTransaction>>(self, tx: T) -> Self
pub fn push_transaction<T: Into<BundleTransaction>>(self, tx: T) -> Self
Adds a transaction to the bundle request.
Transactions added to the bundle can either be novel transactions, i.e. transactions that you have crafted, or they can be from one of the mempool APIs.
Sourcepub fn add_transaction<T: Into<BundleTransaction>>(&mut self, tx: T)
pub fn add_transaction<T: Into<BundleTransaction>>(&mut self, tx: T)
Adds a transaction to the bundle request.
This function takes a mutable reference to self
and adds the specified
transaction to the transactions
vector. The added transaction can either
be a novel transaction that you have crafted, or it can be from one of the
mempool APIs.
Sourcepub fn push_revertible_transaction<T: Into<BundleTransaction>>(
self,
tx: T,
) -> Self
pub fn push_revertible_transaction<T: Into<BundleTransaction>>( self, tx: T, ) -> Self
Adds a revertible transaction to the bundle request.
This differs from BundleRequest::push_transaction
in that the bundle will still be
considered valid if the transaction reverts.
Sourcepub fn add_revertible_transaction<T: Into<BundleTransaction>>(&mut self, tx: T)
pub fn add_revertible_transaction<T: Into<BundleTransaction>>(&mut self, tx: T)
Adds a revertible transaction to the bundle request.
This function takes a mutable reference to self
and adds the specified
revertible transaction to the transactions
vector. The added transaction can either
be a novel transaction that you have crafted, or it can be from one of the
mempool APIs. Unlike the push_transaction
method, the bundle will still be considered
valid even if the added transaction reverts.
Sourcepub fn transactions(&self) -> &Vec<BundleTransaction>
pub fn transactions(&self) -> &Vec<BundleTransaction>
Get a reference to the transactions currently in the bundle request.
Sourcepub fn transaction_hashes(&self) -> Vec<TxHash>
pub fn transaction_hashes(&self) -> Vec<TxHash>
Get a list of transaction hashes in the bundle request.
Sourcepub fn set_uuid(self, uuid: Uuid) -> Self
pub fn set_uuid(self, uuid: Uuid) -> Self
Set the replacement uuid of the bundle. This is used for bundle replacements or cancellations using eth_cancelBundle
Sourcepub fn simulation_block(&self) -> Option<U64>
pub fn simulation_block(&self) -> Option<U64>
Get the block that determines the state for bundle simulation (if any).
See eth_callBundle
in the Flashbots documentation
for more information on bundle simulations.
Sourcepub fn set_simulation_block(self, block: U64) -> Self
pub fn set_simulation_block(self, block: U64) -> Self
Set the block that determines the state for bundle simulation.
Sourcepub fn simulation_timestamp(&self) -> Option<u64>
pub fn simulation_timestamp(&self) -> Option<u64>
Get the UNIX timestamp used for bundle simulation (if any).
See eth_callBundle
in the Flashbots documentation
for more information on bundle simulations.
Sourcepub fn set_simulation_timestamp(self, timestamp: u64) -> Self
pub fn set_simulation_timestamp(self, timestamp: u64) -> Self
Set the UNIX timestamp used for bundle simulation.
Sourcepub fn simulation_basefee(&self) -> Option<u64>
pub fn simulation_basefee(&self) -> Option<u64>
Get the base gas fee for bundle simulation (if any).
See eth_callBundle
in the Flashbots documentation
for more information on bundle simulations.
Sourcepub fn set_simulation_basefee(self, basefee: u64) -> Self
pub fn set_simulation_basefee(self, basefee: u64) -> Self
Set the base gas fee for bundle simulation (if any). Optional: will default to a value chosen by the node if not specified.
Sourcepub fn min_timestamp(&self) -> Option<u64>
pub fn min_timestamp(&self) -> Option<u64>
Get the minimum timestamp for which this bundle is valid (if any), in seconds since the UNIX epoch.
Sourcepub fn set_min_timestamp(self, timestamp: u64) -> Self
pub fn set_min_timestamp(self, timestamp: u64) -> Self
Set the minimum timestamp for which this bundle is valid (if any), in seconds since the UNIX epoch.
Sourcepub fn max_timestamp(&self) -> Option<u64>
pub fn max_timestamp(&self) -> Option<u64>
Get the maximum timestamp for which this bundle is valid (if any), in seconds since the UNIX epoch.
Sourcepub fn set_max_timestamp(self, timestamp: u64) -> Self
pub fn set_max_timestamp(self, timestamp: u64) -> Self
Set the maximum timestamp for which this bundle is valid (if any), in seconds since the UNIX epoch.
Trait Implementations§
Source§impl Clone for BundleRequest
impl Clone for BundleRequest
Source§fn clone(&self) -> BundleRequest
fn clone(&self) -> BundleRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BundleRequest
impl Debug for BundleRequest
Source§impl Default for BundleRequest
impl Default for BundleRequest
Source§fn default() -> BundleRequest
fn default() -> BundleRequest
Auto Trait Implementations§
impl Freeze for BundleRequest
impl RefUnwindSafe for BundleRequest
impl Send for BundleRequest
impl Sync for BundleRequest
impl Unpin for BundleRequest
impl UnwindSafe for BundleRequest
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.