foundry_evm_core/opts.rs
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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
use super::fork::environment;
use crate::{constants::DEFAULT_CREATE2_DEPLOYER, fork::CreateFork};
use alloy_primitives::{Address, B256, U256};
use alloy_provider::{network::AnyRpcBlock, Provider};
use eyre::WrapErr;
use foundry_common::{provider::ProviderBuilder, ALCHEMY_FREE_TIER_CUPS};
use foundry_config::{Chain, Config, GasLimit};
use revm::primitives::{BlockEnv, CfgEnv, TxEnv};
use serde::{Deserialize, Serialize};
use std::fmt::Write;
use url::Url;
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct EvmOpts {
/// The EVM environment configuration.
#[serde(flatten)]
pub env: Env,
/// Fetch state over a remote instead of starting from empty state.
#[serde(rename = "eth_rpc_url")]
pub fork_url: Option<String>,
/// Pins the block number for the state fork.
pub fork_block_number: Option<u64>,
/// The number of retries.
pub fork_retries: Option<u32>,
/// Initial retry backoff.
pub fork_retry_backoff: Option<u64>,
/// Headers to use with `fork_url`
pub fork_headers: Option<Vec<String>>,
/// The available compute units per second.
///
/// See also <https://docs.alchemy.com/reference/compute-units#what-are-cups-compute-units-per-second>
pub compute_units_per_second: Option<u64>,
/// Disables RPC rate limiting entirely.
pub no_rpc_rate_limit: bool,
/// Disables storage caching entirely.
pub no_storage_caching: bool,
/// The initial balance of each deployed test contract.
pub initial_balance: U256,
/// The address which will be executing all tests.
pub sender: Address,
/// Enables the FFI cheatcode.
pub ffi: bool,
/// Use the create 2 factory in all cases including tests and non-broadcasting scripts.
pub always_use_create_2_factory: bool,
/// Verbosity mode of EVM output as number of occurrences.
pub verbosity: u8,
/// The memory limit per EVM execution in bytes.
/// If this limit is exceeded, a `MemoryLimitOOG` result is thrown.
pub memory_limit: u64,
/// Whether to enable isolation of calls.
pub isolate: bool,
/// Whether to disable block gas limit checks.
pub disable_block_gas_limit: bool,
/// whether to enable Odyssey features.
pub odyssey: bool,
/// The CREATE2 deployer's address.
pub create2_deployer: Address,
}
impl Default for EvmOpts {
fn default() -> Self {
Self {
env: Env::default(),
fork_url: None,
fork_block_number: None,
fork_retries: None,
fork_retry_backoff: None,
fork_headers: None,
compute_units_per_second: None,
no_rpc_rate_limit: false,
no_storage_caching: false,
initial_balance: U256::default(),
sender: Address::default(),
ffi: false,
always_use_create_2_factory: false,
verbosity: 0,
memory_limit: 0,
isolate: false,
disable_block_gas_limit: false,
odyssey: false,
create2_deployer: DEFAULT_CREATE2_DEPLOYER,
}
}
}
impl EvmOpts {
/// Configures a new `revm::Env`
///
/// If a `fork_url` is set, it gets configured with settings fetched from the endpoint (chain
/// id, )
pub async fn evm_env(&self) -> eyre::Result<revm::primitives::Env> {
if let Some(ref fork_url) = self.fork_url {
Ok(self.fork_evm_env(fork_url).await?.0)
} else {
Ok(self.local_evm_env())
}
}
/// Returns the `revm::Env` that is configured with settings retrieved from the endpoint.
/// And the block that was used to configure the environment.
pub async fn fork_evm_env(
&self,
fork_url: &str,
) -> eyre::Result<(revm::primitives::Env, AnyRpcBlock)> {
let provider = ProviderBuilder::new(fork_url)
.compute_units_per_second(self.get_compute_units_per_second())
.build()?;
environment(
&provider,
self.memory_limit,
self.env.gas_price.map(|v| v as u128),
self.env.chain_id,
self.fork_block_number,
self.sender,
self.disable_block_gas_limit,
)
.await
.wrap_err_with(|| {
let mut msg = "Could not instantiate forked environment".to_string();
if let Ok(url) = Url::parse(fork_url) {
if let Some(provider) = url.host() {
write!(msg, " with provider {provider}").unwrap();
}
}
msg
})
}
/// Returns the `revm::Env` configured with only local settings
pub fn local_evm_env(&self) -> revm::primitives::Env {
let mut cfg = CfgEnv::default();
cfg.chain_id = self.env.chain_id.unwrap_or(foundry_common::DEV_CHAIN_ID);
cfg.limit_contract_code_size = self.env.code_size_limit.or(Some(usize::MAX));
cfg.memory_limit = self.memory_limit;
// EIP-3607 rejects transactions from senders with deployed code.
// If EIP-3607 is enabled it can cause issues during fuzz/invariant tests if the
// caller is a contract. So we disable the check by default.
cfg.disable_eip3607 = true;
cfg.disable_block_gas_limit = self.disable_block_gas_limit;
revm::primitives::Env {
block: BlockEnv {
number: U256::from(self.env.block_number),
coinbase: self.env.block_coinbase,
timestamp: U256::from(self.env.block_timestamp),
difficulty: U256::from(self.env.block_difficulty),
prevrandao: Some(self.env.block_prevrandao),
basefee: U256::from(self.env.block_base_fee_per_gas),
gas_limit: U256::from(self.gas_limit()),
..Default::default()
},
cfg,
tx: TxEnv {
gas_price: U256::from(self.env.gas_price.unwrap_or_default()),
gas_limit: self.gas_limit(),
caller: self.sender,
..Default::default()
},
}
}
/// Helper function that returns the [CreateFork] to use, if any.
///
/// storage caching for the [CreateFork] will be enabled if
/// - `fork_url` is present
/// - `fork_block_number` is present
/// - `StorageCachingConfig` allows the `fork_url` + chain ID pair
/// - storage is allowed (`no_storage_caching = false`)
///
/// If all these criteria are met, then storage caching is enabled and storage info will be
/// written to `<Config::foundry_cache_dir()>/<str(chainid)>/<block>/storage.json`.
///
/// for `mainnet` and `--fork-block-number 14435000` on mac the corresponding storage cache will
/// be at `~/.foundry/cache/mainnet/14435000/storage.json`.
pub fn get_fork(&self, config: &Config, env: revm::primitives::Env) -> Option<CreateFork> {
let url = self.fork_url.clone()?;
let enable_caching = config.enable_caching(&url, env.cfg.chain_id);
Some(CreateFork { url, enable_caching, env, evm_opts: self.clone() })
}
/// Returns the gas limit to use
pub fn gas_limit(&self) -> u64 {
self.env.block_gas_limit.unwrap_or(self.env.gas_limit).0
}
/// Returns the configured chain id, which will be
/// - the value of `chain_id` if set
/// - mainnet if `fork_url` contains "mainnet"
/// - the chain if `fork_url` is set and the endpoints returned its chain id successfully
/// - mainnet otherwise
pub async fn get_chain_id(&self) -> u64 {
if let Some(id) = self.env.chain_id {
return id;
}
self.get_remote_chain_id().await.unwrap_or(Chain::mainnet()).id()
}
/// Returns the available compute units per second, which will be
/// - u64::MAX, if `no_rpc_rate_limit` if set (as rate limiting is disabled)
/// - the assigned compute units, if `compute_units_per_second` is set
/// - ALCHEMY_FREE_TIER_CUPS (330) otherwise
pub fn get_compute_units_per_second(&self) -> u64 {
if self.no_rpc_rate_limit {
u64::MAX
} else if let Some(cups) = self.compute_units_per_second {
return cups;
} else {
ALCHEMY_FREE_TIER_CUPS
}
}
/// Returns the chain ID from the RPC, if any.
pub async fn get_remote_chain_id(&self) -> Option<Chain> {
if let Some(ref url) = self.fork_url {
trace!(?url, "retrieving chain via eth_chainId");
let provider = ProviderBuilder::new(url.as_str())
.compute_units_per_second(self.get_compute_units_per_second())
.build()
.ok()
.unwrap_or_else(|| panic!("Failed to establish provider to {url}"));
if let Ok(id) = provider.get_chain_id().await {
return Some(Chain::from(id));
}
// Provider URLs could be of the format `{CHAIN_IDENTIFIER}-mainnet`
// (e.g. Alchemy `opt-mainnet`, `arb-mainnet`), fallback to this method only
// if we're not able to retrieve chain id from `RetryProvider`.
if url.contains("mainnet") {
trace!(?url, "auto detected mainnet chain");
return Some(Chain::mainnet());
}
}
None
}
}
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct Env {
/// The block gas limit.
pub gas_limit: GasLimit,
/// The `CHAINID` opcode value.
pub chain_id: Option<u64>,
/// the tx.gasprice value during EVM execution
///
/// This is an Option, so we can determine in fork mode whether to use the config's gas price
/// (if set by user) or the remote client's gas price.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub gas_price: Option<u64>,
/// the base fee in a block
pub block_base_fee_per_gas: u64,
/// the tx.origin value during EVM execution
pub tx_origin: Address,
/// the block.coinbase value during EVM execution
pub block_coinbase: Address,
/// the block.timestamp value during EVM execution
pub block_timestamp: u64,
/// the block.number value during EVM execution"
pub block_number: u64,
/// the block.difficulty value during EVM execution
pub block_difficulty: u64,
/// Previous block beacon chain random value. Before merge this field is used for mix_hash
pub block_prevrandao: B256,
/// the block.gaslimit value during EVM execution
#[serde(default, skip_serializing_if = "Option::is_none")]
pub block_gas_limit: Option<GasLimit>,
/// EIP-170: Contract code size limit in bytes. Useful to increase this because of tests.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub code_size_limit: Option<usize>,
}