Skip to main content

TradeSimulator

Struct TradeSimulator 

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

Simulates settlement execution to estimate gas costs and detect reverts.

Wraps a reqwest::Client targeting a JSON-RPC endpoint and the canonical GPv2Settlement contract on a specific chain.

§Example

use cow_chains::SupportedChainId;
use cow_settlement::simulator::TradeSimulator;

let sim = TradeSimulator::new("https://rpc.sepolia.org", SupportedChainId::Sepolia);

Implementations§

Source§

impl TradeSimulator

Source

pub fn new( rpc_url: impl Into<String>, chain: SupportedChainId, ) -> TradeSimulator

Create a new trade simulator for the given chain.

Uses the canonical GPv2Settlement contract address for chain.

§Arguments
§Returns

A new TradeSimulator configured for the specified chain.

Source

pub const fn settlement_address(&self) -> Address

Return the settlement contract address this simulator targets.

§Returns

The settlement contract Address.

Source

pub fn rpc_url(&self) -> &str

Return the RPC URL this simulator is configured to use.

§Returns

A reference to the RPC URL string.

Source

pub async fn estimate_gas(&self, calldata: &[u8]) -> Result<u64, CowError>

Estimate the gas cost of executing calldata against the settlement contract.

Sends an eth_estimateGas JSON-RPC request with the provided calldata targeting the settlement contract.

§Arguments
  • calldata - The ABI-encoded calldata to estimate gas for.
§Returns

The estimated gas as u64.

§Errors

Returns CowError::Rpc if the RPC request fails or the node returns an error (e.g., the transaction would revert).

Source

pub async fn simulate( &self, calldata: &[u8], ) -> Result<SimulationResult, CowError>

Simulate executing calldata against the settlement contract via eth_call.

Unlike estimate_gas, this method does not fail on reverts — instead it returns a SimulationResult indicating whether the call succeeded or reverted.

§Arguments
  • calldata - The ABI-encoded calldata to simulate.
§Returns

A SimulationResult with success status, gas estimate, and return data.

§Errors

Returns CowError::Rpc only on transport-level failures (HTTP errors). Execution reverts are captured in the returned SimulationResult.

Source

pub async fn estimate_settlement( &self, encoder: &SettlementEncoder, ) -> Result<u64, CowError>

Convenience method: encode a settlement and estimate its gas cost.

Combines SettlementEncoder::encode_settlement with estimate_gas.

§Arguments
§Returns

The estimated gas as u64.

§Errors

Returns CowError::Rpc if the RPC request fails or the settlement would revert.

Trait Implementations§

Source§

impl Clone for TradeSimulator

Source§

fn clone(&self) -> TradeSimulator

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TradeSimulator

Source§

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

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> 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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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> MaybeSendSync for T
where T: Send + Sync + ?Sized,