Struct OrderDetector 

pub struct OrderDetector { /* private fields */ }

Inspector used to detect Signet Orders and inform the builder of the fill requirements.

This inspector is intended to be used with trevm. The EVM driver should

• call OrderDetector::take_aggregates to get the aggregate orders and fills produced by that transaction.
• ensure that net fills are sufficient to cover the order inputs via AggregateFills::checked_remove_ru_tx_events.
• reject transactions which are not sufficiently filled.

The SignetDriver has an example of this in the check_fills_and_accept function.

The OrderDetector allows an inner inspector to be used as well. This is useful for tracers and other tools that need to inspect the EVM state.

Implementations

impl OrderDetector

pub fn new(contracts: HashSet<Address>, chain_id: u64, fills_only: bool) -> Self

Create a new OrderDetector with the given contracts addresses, chain_id, and fills_only flag.

pub fn for_rollup(constants: SignetSystemConstants) -> OrderDetector

Create a new OrderDetector for the rollup environment. This detector will detect both orders and fills.

pub fn for_host(constants: SignetSystemConstants) -> OrderDetector

Create a new OrderDetector for the host environment. This detector will only detect fills.

pub fn is_contract(&self, address: Address) -> bool

Get the address of the orders contract.

pub const fn chain_id(&self) -> u64

Get the chain ID.

pub fn take(&mut self) -> (FramedOrders, FramedFilleds)

Take the orders from the inspector, clearing it.

pub fn take_aggregates(&mut self) -> (AggregateFills, AggregateOrders)

Take the orders from the inspector, clearing it, and convert them to aggregate orders.

pub fn into_parts(self) -> (FramedOrders, FramedFilleds)

Take the inner inspector and the framed events.

pub const fn orders(&self) -> &FramedOrders

Get a reference to the framed RollupOrders::Order events.

pub const fn filleds(&self) -> &FramedFilleds

Get a reference to the framed RollupOrders::Filled events.

Trait Implementations

impl Clone for OrderDetector

fn clone(&self) -> OrderDetector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderDetector

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

Formats the value using the given formatter.

impl<Db, Int> Inspector<Context<BlockEnv, TxEnv, CfgEnv, Db>, Int> for OrderDetector

where Db: Database, Int: InterpreterTypes,

fn log( &mut self, _interp: &mut Interpreter<Int>, _context: &mut Ctx<Db>, log: Log, )

Called when a log is emitted.

fn call( &mut self, _context: &mut Ctx<Db>, _inputs: &mut CallInputs, ) -> Option<CallOutcome>

Called whenever a call to a contract is about to start.

fn call_end( &mut self, _context: &mut Ctx<Db>, _inputs: &CallInputs, outcome: &mut CallOutcome, )

Called when a call to a contract has concluded.

fn create( &mut self, _context: &mut Ctx<Db>, _inputs: &mut CreateInputs, ) -> Option<CreateOutcome>

Called when a contract is about to be created.

fn create_end( &mut self, _context: &mut Ctx<Db>, _inputs: &CreateInputs, outcome: &mut CreateOutcome, )

Called when a contract has been created.

fn selfdestruct(&mut self, _contract: Address, _target: Address, _value: U256)

Called when a contract has been self-destructed with funds transferred to target.

fn initialize_interp( &mut self, interp: &mut Interpreter<INTR>, context: &mut CTX, )

Called before the interpreter is initialized.

fn step(&mut self, interp: &mut Interpreter<INTR>, context: &mut CTX)

Called on each step of the interpreter.

fn step_end(&mut self, interp: &mut Interpreter<INTR>, context: &mut CTX)

Called after step when the instruction has been executed.

impl PartialEq for OrderDetector

fn eq(&self, other: &OrderDetector) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Db, Int> SignetInspector<Context<BlockEnv, TxEnv, CfgEnv, Db>, Int> for OrderDetector

where Int: InterpreterTypes, Db: Database,

fn as_detector(&self) -> &OrderDetector

Get a reference to the inner OrderDetector.

fn as_mut_detector(&mut self) -> &mut OrderDetector

Get a mutable reference to the inner OrderDetector.

impl Eq for OrderDetector

impl StructuralPartialEq for OrderDetector