evm-fork-cache 0.2.1

Forked EVM state cache, snapshots, overlays, and simulation utilities for EVM search
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! Protocol-neutral cold-start sync for [`EvmCache`](crate::cache::EvmCache).
//!
//! Cold start declares rounds of authoritative slot work — verify, probe,
//! probe_roots, accounts, discover — and drives a bounded multi-round loop via
//! a pure [`ColdStartPlanner`]. Every verify and probe slot yields a per-slot
//! [`SlotOutcome`] distinguishing a genuine on-chain zero ([`SlotFetch::Zero`])
//! from a fetch failure ([`SlotFetch::FetchFailed`]) — closing the "archive-miss"
//! gap where a transient fetch failure was indistinguishable from absence.
//!
//! The module is gated behind the `reactive` feature. The per-slot
//! [`SlotOutcome`] / [`SlotFetch`] surface lives ungated in
//! [`crate::freshness`] and is re-exported here for consumer ergonomics.
//!
//! # Design
//!
//! - The driver performs every fetch and call; planners are pure and IO-free,
//!   handed only a [`StateView`](crate::events::StateView) and a
//!   [`ColdStartResults`].
//! - Verify-phase changes are injected via the dual-layer
//!   [`inject_storage_batch_fresh`](crate::cache::EvmCache::inject_storage_batch_fresh)
//!   and are visible to the next `on_results` through the state view.
//! - A run can be pinned to a block hash via [`ColdStartPin::Hash`]; with
//!   `require_canonical: true`, a reorged hash makes the run fail fast. This is
//!   the cold-start reorg defense by design.
//!
//! # Runtime requirement
//!
//! Like the rest of the crate's RPC seams, cold-start fetching drives async work
//! synchronously and must run on a **multi-thread** tokio runtime.
//!
//! # Example
//!
//! A planner that authoritatively warms a fixed working set of slots in one round.
//! (See `examples/cold_start.rs` for the runnable discover-then-verify version.)
//!
//! ```
//! use alloy_primitives::{Address, U256};
//! use evm_fork_cache::cache::EvmCache;
//! use evm_fork_cache::events::StateView;
//! use evm_fork_cache::{
//!     ColdStartConfig, ColdStartError, ColdStartPlan, ColdStartPlanner, ColdStartResults,
//!     ColdStartStep,
//! };
//!
//! struct WarmSlots {
//!     slots: Vec<(Address, U256)>,
//! }
//!
//! impl ColdStartPlanner for WarmSlots {
//!     fn initial_plan(&mut self, _state: &dyn StateView) -> ColdStartPlan {
//!         // Round 1: re-fetch these slots authoritatively and inject the fresh values.
//!         ColdStartPlan { verify: self.slots.clone(), ..Default::default() }
//!     }
//!     fn on_results(&mut self, _r: &ColdStartResults, _s: &dyn StateView) -> ColdStartStep {
//!         ColdStartStep::Done
//!     }
//! }
//!
//! // `run_cold_start` needs a live cache on a multi-thread runtime; this helper
//! // shows the call shape (it is never invoked, so the doctest needs no runtime).
//! # fn warm(cache: &mut EvmCache, slots: Vec<(Address, U256)>) -> Result<(), ColdStartError> {
//! let mut planner = WarmSlots { slots };
//! let report = cache.run_cold_start(&mut planner, ColdStartConfig::default())?;
//! assert_eq!(report.rounds, 1);
//! # Ok(())
//! # }
//! ```

mod config;
mod driver;
mod error;
mod plan;
mod planner;
mod results;
pub mod roots;

pub use config::{ColdStartConfig, ColdStartPin, ColdStartRoundSummary, ColdStartRunReport};
pub use error::ColdStartError;
pub use plan::{ColdStartCall, ColdStartPlan};
pub use planner::{ColdStartPlanner, ColdStartStep};
pub use results::{ColdStartCallResult, ColdStartResults, RoundOutcome};
pub use roots::{RootBaseline, RootBaselinePlanner, RootProbeOutcome};

// The per-slot fetch surface is ungated in `freshness`; re-export so
// `evm_fork_cache::cold_start::SlotFetch` resolves for consumers.
pub use crate::freshness::{SlotFetch, SlotOutcome};