revm_primitives/
lib.rs

1//! # revm-primitives
2//!
3//! Core primitive types and constants for the Ethereum Virtual Machine (EVM) implementation.
4//!
5//! This crate provides:
6//! - EVM constants and limits (gas, stack, code size)
7//! - Ethereum hard fork management and version control
8//! - EIP-specific constants and configuration values
9//! - Cross-platform synchronization primitives
10//! - Type aliases for common EVM concepts (storage keys/values)
11//! - Re-exports of alloy primitive types for convenience
12#![cfg_attr(not(test), warn(unused_crate_dependencies))]
13#![cfg_attr(not(feature = "std"), no_std)]
14
15#[cfg(not(feature = "std"))]
16extern crate alloc as std;
17
18pub mod constants;
19pub mod eip170;
20pub mod eip3860;
21pub mod eip4844;
22pub mod eip7702;
23pub mod eip7708;
24pub mod eip7823;
25pub mod eip7825;
26pub mod eip7907;
27pub mod eip7954;
28pub mod eip8037;
29pub mod hardfork;
30pub mod hints_util;
31mod once_lock;
32
33pub use constants::*;
34pub use once_lock::OnceLock;
35
36// Reexport alloy primitives.
37
38pub use alloy_primitives::{
39    self, address, b256, bytes, fixed_bytes, hex, hex_literal, keccak256,
40    map::{
41        self, hash_map, hash_set, indexmap, AddressIndexMap, AddressMap, AddressSet, B256Map,
42        HashMap, HashSet, IndexMap, U256Map,
43    },
44    ruint, uint, Address, Bytes, FixedBytes, Log, LogData, TxKind, B256, I128, I256, U128, U256,
45};
46
47/// Type alias for EVM storage keys (256-bit unsigned integers).
48/// Used to identify storage slots within smart contract storage.
49pub type StorageKey = U256;
50
51/// Type alias for EVM storage values (256-bit unsigned integers).
52/// Used to store data values in smart contract storage slots.
53pub type StorageValue = U256;
54
55/// Type alias for a map with storage keys (U256) as keys.
56pub type StorageKeyMap<V> = U256Map<V>;
57
58/// Optimize short address access.
59pub const SHORT_ADDRESS_CAP: usize = 300;
60
61/// Returns the short address from Address.
62///
63/// Short address is considered address that has 18 leading zeros
64/// and last two bytes are less than [`SHORT_ADDRESS_CAP`].
65#[inline]
66pub fn short_address(address: &Address) -> Option<usize> {
67    let (zeros, value) = address.split_at(18);
68    if zeros.iter().all(|b| *b == 0) {
69        let short_address = u16::from_be_bytes([value[0], value[1]]) as usize;
70        if short_address < SHORT_ADDRESS_CAP {
71            return Some(short_address);
72        }
73    }
74    None
75}
76
77/// 1 ether = 10^18 wei
78pub const ONE_ETHER: u128 = 1_000_000_000_000_000_000;
79
80/// 1 gwei = 10^9 wei
81pub const ONE_GWEI: u128 = 1_000_000_000;
revm_primitives/lib.rs

revm_primitives/
lib.rs
