revm_context/
cfg.rs

1//! This module contains [`CfgEnv`] and implements [`Cfg`] trait for it.
2pub use context_interface::Cfg;
3
4use primitives::{eip170, eip3860, eip7825, hardfork::SpecId};
5/// EVM configuration
6#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
7#[derive(Clone, Debug, Eq, PartialEq)]
8#[non_exhaustive]
9pub struct CfgEnv<SPEC = SpecId> {
10    /// Chain ID of the EVM. Used in CHAINID opcode and transaction's chain ID check.
11    ///
12    /// Chain ID is introduced EIP-155.
13    pub chain_id: u64,
14
15    /// Whether to check the transaction's chain ID.
16    ///
17    /// If set to `false`, the transaction's chain ID check will be skipped.
18    pub tx_chain_id_check: bool,
19
20    /// Specification for EVM represent the hardfork
21    pub spec: SPEC,
22    /// Contract code size limit override.
23    ///
24    /// If None, the limit will be determined by the SpecId (EIP-170 or EIP-7907) at runtime.
25    /// If Some, this specific limit will be used regardless of SpecId.
26    ///
27    /// Useful to increase this because of tests.
28    pub limit_contract_code_size: Option<usize>,
29    /// Contract initcode size limit override.
30    ///
31    /// If None, the limit will check if `limit_contract_code_size` is set.
32    /// If it is set, it will double it for a limit.
33    /// If it is not set, the limit will be determined by the SpecId (EIP-170 or EIP-7907) at runtime.
34    ///
35    /// Useful to increase this because of tests.
36    pub limit_contract_initcode_size: Option<usize>,
37    /// Skips the nonce validation against the account's nonce
38    pub disable_nonce_check: bool,
39    /// Blob max count. EIP-7840 Add blob schedule to EL config files.
40    ///
41    /// If this config is not set, the check for max blobs will be skipped.
42    pub max_blobs_per_tx: Option<u64>,
43    /// Blob base fee update fraction. EIP-4844 Blob base fee update fraction.
44    ///
45    /// If this config is not set, the blob base fee update fraction will be set to the default value.
46    /// See also [CfgEnv::blob_base_fee_update_fraction].
47    ///
48    /// Default values for Cancun is [`primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_CANCUN`]
49    /// and for Prague is [`primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_PRAGUE`].
50    pub blob_base_fee_update_fraction: Option<u64>,
51    /// Configures the gas limit cap for the transaction.
52    ///
53    /// If `None`, default value defined by spec will be used.
54    ///
55    /// Introduced in Osaka in [EIP-7825: Transaction Gas Limit Cap](https://eips.ethereum.org/EIPS/eip-7825)
56    /// with initials cap of 30M.
57    pub tx_gas_limit_cap: Option<u64>,
58    /// A hard memory limit in bytes beyond which
59    /// [OutOfGasError::Memory][context_interface::result::OutOfGasError::Memory] cannot be resized.
60    ///
61    /// In cases where the gas limit may be extraordinarily high, it is recommended to set this to
62    /// a sane value to prevent memory allocation panics.
63    ///
64    /// Defaults to `2^32 - 1` bytes per EIP-1985.
65    #[cfg(feature = "memory_limit")]
66    pub memory_limit: u64,
67    /// Skip balance checks if `true`
68    ///
69    /// Adds transaction cost to balance to ensure execution doesn't fail.
70    ///
71    /// By default, it is set to `false`.
72    #[cfg(feature = "optional_balance_check")]
73    pub disable_balance_check: bool,
74    /// There are use cases where it's allowed to provide a gas limit that's higher than a block's gas limit.
75    ///
76    /// To that end, you can disable the block gas limit validation.
77    ///
78    /// By default, it is set to `false`.
79    #[cfg(feature = "optional_block_gas_limit")]
80    pub disable_block_gas_limit: bool,
81    /// EIP-3607 rejects transactions from senders with deployed code
82    ///
83    /// In development, it can be desirable to simulate calls from contracts, which this setting allows.
84    ///
85    /// By default, it is set to `false`.
86    #[cfg(feature = "optional_eip3607")]
87    pub disable_eip3607: bool,
88    /// Disables base fee checks for EIP-1559 transactions
89    ///
90    /// This is useful for testing method calls with zero gas price.
91    ///
92    /// By default, it is set to `false`.
93    #[cfg(feature = "optional_no_base_fee")]
94    pub disable_base_fee: bool,
95    /// Disables "max fee must be less than or equal to max priority fee" check for EIP-1559 transactions.
96    /// This is useful because some chains (e.g. Arbitrum) do not enforce this check.
97    /// By default, it is set to `false`.
98    #[cfg(feature = "optional_priority_fee_check")]
99    pub disable_priority_fee_check: bool,
100}
101
102impl CfgEnv {
103    /// Creates new `CfgEnv` with default values.
104    pub fn new() -> Self {
105        Self::default()
106    }
107}
108
109impl<SPEC: Into<SpecId> + Copy> CfgEnv<SPEC> {
110    /// Returns the blob base fee update fraction from [CfgEnv::blob_base_fee_update_fraction].
111    ///
112    /// If this field is not set, return the default value for the spec.
113    ///
114    /// Default values for Cancun is [`primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_CANCUN`]
115    /// and for Prague is [`primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_PRAGUE`].
116    pub fn blob_base_fee_update_fraction(&mut self) -> u64 {
117        self.blob_base_fee_update_fraction.unwrap_or_else(|| {
118            let spec: SpecId = self.spec.into();
119            if spec.is_enabled_in(SpecId::PRAGUE) {
120                primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_PRAGUE
121            } else {
122                primitives::eip4844::BLOB_BASE_FEE_UPDATE_FRACTION_CANCUN
123            }
124        })
125    }
126}
127
128impl<SPEC> CfgEnv<SPEC> {
129    /// Create new `CfgEnv` with default values and specified spec.
130    pub fn new_with_spec(spec: SPEC) -> Self {
131        Self {
132            chain_id: 1,
133            tx_chain_id_check: false,
134            limit_contract_code_size: None,
135            limit_contract_initcode_size: None,
136            spec,
137            disable_nonce_check: false,
138            max_blobs_per_tx: None,
139            tx_gas_limit_cap: None,
140            blob_base_fee_update_fraction: None,
141            #[cfg(feature = "memory_limit")]
142            memory_limit: (1 << 32) - 1,
143            #[cfg(feature = "optional_balance_check")]
144            disable_balance_check: false,
145            #[cfg(feature = "optional_block_gas_limit")]
146            disable_block_gas_limit: false,
147            #[cfg(feature = "optional_eip3607")]
148            disable_eip3607: false,
149            #[cfg(feature = "optional_no_base_fee")]
150            disable_base_fee: false,
151            #[cfg(feature = "optional_priority_fee_check")]
152            disable_priority_fee_check: false,
153        }
154    }
155
156    /// Consumes `self` and returns a new `CfgEnv` with the specified chain ID.
157    pub fn with_chain_id(mut self, chain_id: u64) -> Self {
158        self.chain_id = chain_id;
159        self
160    }
161
162    /// Enables the transaction's chain ID check.
163    pub fn enable_tx_chain_id_check(mut self) -> Self {
164        self.tx_chain_id_check = true;
165        self
166    }
167
168    /// Disables the transaction's chain ID check.
169    pub fn disable_tx_chain_id_check(mut self) -> Self {
170        self.tx_chain_id_check = false;
171        self
172    }
173
174    /// Consumes `self` and returns a new `CfgEnv` with the specified spec.
175    pub fn with_spec<OSPEC: Into<SpecId>>(self, spec: OSPEC) -> CfgEnv<OSPEC> {
176        CfgEnv {
177            chain_id: self.chain_id,
178            tx_chain_id_check: self.tx_chain_id_check,
179            limit_contract_code_size: self.limit_contract_code_size,
180            limit_contract_initcode_size: self.limit_contract_initcode_size,
181            spec,
182            disable_nonce_check: self.disable_nonce_check,
183            tx_gas_limit_cap: self.tx_gas_limit_cap,
184            max_blobs_per_tx: self.max_blobs_per_tx,
185            blob_base_fee_update_fraction: self.blob_base_fee_update_fraction,
186            #[cfg(feature = "memory_limit")]
187            memory_limit: self.memory_limit,
188            #[cfg(feature = "optional_balance_check")]
189            disable_balance_check: self.disable_balance_check,
190            #[cfg(feature = "optional_block_gas_limit")]
191            disable_block_gas_limit: self.disable_block_gas_limit,
192            #[cfg(feature = "optional_eip3607")]
193            disable_eip3607: self.disable_eip3607,
194            #[cfg(feature = "optional_no_base_fee")]
195            disable_base_fee: self.disable_base_fee,
196            #[cfg(feature = "optional_priority_fee_check")]
197            disable_priority_fee_check: self.disable_priority_fee_check,
198        }
199    }
200
201    /// Sets the blob target
202    pub fn with_max_blobs_per_tx(mut self, max_blobs_per_tx: u64) -> Self {
203        self.set_max_blobs_per_tx(max_blobs_per_tx);
204        self
205    }
206
207    /// Sets the blob target
208    pub fn set_max_blobs_per_tx(&mut self, max_blobs_per_tx: u64) {
209        self.max_blobs_per_tx = Some(max_blobs_per_tx);
210    }
211
212    /// Clears the blob target and max count over hardforks.
213    pub fn clear_max_blobs_per_tx(&mut self) {
214        self.max_blobs_per_tx = None;
215    }
216
217    /// Sets the disable priority fee check flag.
218    #[cfg(feature = "optional_priority_fee_check")]
219    pub fn with_disable_priority_fee_check(mut self, disable: bool) -> Self {
220        self.disable_priority_fee_check = disable;
221        self
222    }
223}
224
225impl<SPEC: Into<SpecId> + Copy> Cfg for CfgEnv<SPEC> {
226    type Spec = SPEC;
227
228    #[inline]
229    fn chain_id(&self) -> u64 {
230        self.chain_id
231    }
232
233    #[inline]
234    fn spec(&self) -> Self::Spec {
235        self.spec
236    }
237
238    #[inline]
239    fn tx_chain_id_check(&self) -> bool {
240        self.tx_chain_id_check
241    }
242
243    #[inline]
244    fn tx_gas_limit_cap(&self) -> u64 {
245        self.tx_gas_limit_cap
246            .unwrap_or(if self.spec.into().is_enabled_in(SpecId::OSAKA) {
247                eip7825::TX_GAS_LIMIT_CAP
248            } else {
249                u64::MAX
250            })
251    }
252
253    #[inline]
254    fn max_blobs_per_tx(&self) -> Option<u64> {
255        self.max_blobs_per_tx
256    }
257
258    fn max_code_size(&self) -> usize {
259        self.limit_contract_code_size
260            .unwrap_or(eip170::MAX_CODE_SIZE)
261    }
262
263    fn max_initcode_size(&self) -> usize {
264        self.limit_contract_initcode_size
265            .or_else(|| {
266                self.limit_contract_code_size
267                    .map(|size| size.saturating_mul(2))
268            })
269            .unwrap_or(eip3860::MAX_INITCODE_SIZE)
270    }
271
272    fn is_eip3607_disabled(&self) -> bool {
273        cfg_if::cfg_if! {
274            if #[cfg(feature = "optional_eip3607")] {
275                self.disable_eip3607
276            } else {
277                false
278            }
279        }
280    }
281
282    fn is_balance_check_disabled(&self) -> bool {
283        cfg_if::cfg_if! {
284            if #[cfg(feature = "optional_balance_check")] {
285                self.disable_balance_check
286            } else {
287                false
288            }
289        }
290    }
291
292    /// Returns `true` if the block gas limit is disabled.
293    fn is_block_gas_limit_disabled(&self) -> bool {
294        cfg_if::cfg_if! {
295            if #[cfg(feature = "optional_block_gas_limit")] {
296                self.disable_block_gas_limit
297            } else {
298                false
299            }
300        }
301    }
302
303    fn is_nonce_check_disabled(&self) -> bool {
304        self.disable_nonce_check
305    }
306
307    fn is_base_fee_check_disabled(&self) -> bool {
308        cfg_if::cfg_if! {
309            if #[cfg(feature = "optional_no_base_fee")] {
310                self.disable_base_fee
311            } else {
312                false
313            }
314        }
315    }
316
317    fn is_priority_fee_check_disabled(&self) -> bool {
318        cfg_if::cfg_if! {
319            if #[cfg(feature = "optional_priority_fee_check")] {
320                self.disable_priority_fee_check
321            } else {
322                false
323            }
324        }
325    }
326}
327
328impl<SPEC: Default> Default for CfgEnv<SPEC> {
329    fn default() -> Self {
330        Self::new_with_spec(SPEC::default())
331    }
332}
333
334#[cfg(test)]
335mod test {
336    use super::*;
337
338    #[test]
339    fn blob_max_and_target_count() {
340        let cfg: CfgEnv = Default::default();
341        assert_eq!(cfg.max_blobs_per_tx(), None);
342    }
343}
revm_context/cfg.rs

revm_context/
cfg.rs
