signet-sim 0.19.0

Signet simulation utilities.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

#[cfg(doc)]
use crate::SimCache;
use crate::SimItem;
use alloy::primitives::U256;
use signet_types::{AggregateFills, AggregateOrders};
use trevm::revm::database::Cache;

/// A simulation outcome that includes the score, gas used, and a cache of
/// state changes.
#[derive(Debug, Clone)]
pub struct SimOutcomeWithCache {
    /// The key for the item in the [`SimCache`].
    pub cache_rank: u128,

    /// The score of the simulation, a [`U256`] value that represents the
    /// increase in the beneficiary's balance.
    pub score: U256,

    /// The total amount of gas used by the simulation.
    pub gas_used: u64,

    /// The total amount of host gas used by the simulation.
    pub host_gas_used: u64,

    /// The result of the simulation, a [`Cache`] containing state changes that
    /// can be applied.
    pub rollup_cache: Cache,

    /// The result of the bundle host simulation a [`Cache`] containing state
    /// changes that can be applied.
    pub host_cache: Cache,

    /// The aggregate fills after simulation.
    pub bundle_fills: AggregateFills,

    /// The aggregate orders after simulation.
    pub bundle_orders: AggregateOrders,
}

/// An item after simulation, containing the score and gas used.
#[derive(Debug, Clone)]
pub struct SimulatedItem {
    /// The score of the simulation, a [`U256`] value that represents the
    /// increase in the beneficiary's balance.
    pub score: U256,

    /// The total amount of gas used by the simulation.
    pub gas_used: u64,

    /// The total amount of host gas used by the simulation.
    pub host_gas_used: u64,

    /// The transaction or bundle that was simulated.
    pub item: SimItem,
}