.github/workflows/rust-ci.yml

@@ -5,10 +5,9 @@ on:
   push:
     branches: [main]
   pull_request:
-
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  rust-base:
-    uses: init4tech/actions/.github/workflows/rust-base.yml@main
+  rust-library-base:
+    uses: init4tech/actions/.github/workflows/rust-library-base.yml@main

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to Trevm
+
+:balloon: Thanks for your help improving the project! We are so happy to have
+you!
+
+## Conduct
+
+This repo adheres to the [Rust Code of Conduct][coc]. This describes
+the _minimum_ behavior expected from all contributors. Failure to maintain civil
+behavior will result in a ban.
+
+[coc]: https://www.rust-lang.org/policies/code-of-conduct
+
+## Pull Requests
+
+Before making a large change, it is usually a good idea to first open an issue
+describing the change to solicit feedback and guidance. This will increase the
+likelihood of the PR getting merged.
+
+When opening a PR **please select the "Allow Edits From Maintainers" option**.
+We maintain code quality and style standards, and require commit signing. This
+option allows us to make small changes to your PR to bring it in line with
+these standards. It helps us get your PR in faster, and with less work from you.
+
+## Development Basics
+
+Before submitting a PR we recommend you run the following commands to ensure
+your code is properly formatted and passes all tests:
+
+```sh
+cargo +nightly fmt --all
+cargo clippy --all-features
+cargo test --all-features
+cargo test --no-default-features
+```
+
+### Contributions Related to Spelling, Grammar, and other trivial changes
+
+At this time, we will not be accepting contributions that only fix spelling or
+grammatical errors in documentation, code or
+elsewhere.

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "trevm"
-version = "0.17.0"
-rust-version = "1.82.0"
+version = "0.20.10"
+rust-version = "1.83.0"
 edition = "2021"
 authors = ["init4"]
 homepage = "https://github.com/init4tech/trevm"
@@ -27,27 +27,23 @@ option-if-let-else = "warn"
 redundant-clone = "warn"
 
 [dependencies]
-alloy-rlp = { version = "0.3.10", default-features = false, features = ["std"]}
+alloy = { version = "0.12.6", default-features = false, features = ["consensus", "rpc-types-mev", "eips", "k256", "std", "rlp", "sol-types"] }
 
-alloy-primitives = { version = "0.8.11", default-features = false, features = ["std"]}
-alloy-sol-types = { version = "0.8.11", default-features = false, features = ["std"]}
-
-alloy = { version = "=0.7.3", default-features = false, features = ["consensus", "rpc-types-mev", "eips", "k256", "std"] }
-
-revm = { version = "18.0.0", default-features = false, features = ["std"] }
-
-zenith-types = { version = "0.11" }
+revm = { version = "20.0.0", default-features = false }
 
 dashmap = { version = "6.1.0", optional = true }
+tracing = { version = "0.1.41", optional = true}
+thiserror = "2.0.11"
 
 [dev-dependencies]
-alloy-rlp = { version = "0.3", default-features = false }
-revm = { version = "18.0.0", features = [
-    "test-utils",
+revm = { version = "20.0.0", features = [
     "serde-json",
     "std",
     "alloydb",
 ] }
+trevm = { path = ".", features = ["test-utils"] }
+
+alloy = { version = "0.12.6", features = ["providers"]}
 
 # misc
 eyre = "0.6"
@@ -57,17 +53,23 @@ tokio = { version = "1.39", features = ["macros", "rt-multi-thread"] }
 
 [features]
 default = [
+    "call",
     "concurrent-db",
+    "estimate_gas",
     "revm/std",
     "revm/c-kzg",
     "revm/blst",
     "revm/portable",
     "revm/secp256k1",
 ]
 
+call = ["optional_eip3607", "optional_no_base_fee"]
+
 concurrent-db = ["dep:dashmap"]
 
-test-utils = ["revm/test-utils", "revm/std", "revm/serde-json", "revm/alloydb"]
+estimate_gas = ["optional_eip3607", "optional_no_base_fee", "dep:tracing"]
+
+test-utils = ["revm/std", "revm/serde-json", "revm/alloydb"]
 
 secp256k1 = ["revm/secp256k1"]
 c-kzg = ["revm/c-kzg"]
@@ -80,23 +82,17 @@ dev = [
     "optional_balance_check",
     "optional_block_gas_limit",
     "optional_eip3607",
-    "optional_gas_refund",
     "optional_no_base_fee",
-    "optional_beneficiary_reward",
 ]
 
 memory_limit = ["revm/memory_limit"]
 optional_balance_check = ["revm/optional_balance_check"]
-optional_beneficiary_reward = ["revm/optional_beneficiary_reward"]
 optional_block_gas_limit = ["revm/optional_block_gas_limit"]
 optional_eip3607 = ["revm/optional_eip3607"]
-optional_gas_refund = ["revm/optional_gas_refund"]
 optional_no_base_fee = ["revm/optional_no_base_fee"]
 full_env_cfg = [
     "optional_balance_check",
     "optional_block_gas_limit",
     "optional_eip3607",
-    "optional_gas_refund",
     "optional_no_base_fee",
-    "optional_beneficiary_reward",
 ]

README.md

@@ -28,6 +28,21 @@ Trevm is useful for:
 - searchers
 - any other transaction simulation usecase
 
+## Note on Trevm Versioning
+
+Trevm generally uses [semantic versioning](https://semver.org/). While pre-1.0,
+we also strive to indicate the MAJOR version of revm in the MINOR version of
+trevm. For example, trevm `0.19.x` SHOULD BE compatible with revm `19.x.x`. In
+general, we will try to maintain compatibility with the latest revm version,
+and will not backport trevm fixes to older trevm or revm versions. It is
+generally not advised to use old revm versions, as the EVM is a living spec.
+
+In order to maintain this relationship (that trevm MINOR == revm MAJOR) we will
+sometimes make breaking changes in patch versions. This is technically semver
+compliant pre-1.0, but will cause build breakage downstream for users of those
+features. We will take care to document breaking changes in patch releases
+via github release notes.
+
 ## Limitations
 
 Trevm is a work in progress and is not feature complete. In particular, trevm

examples/basic_transact.rs

@@ -1,12 +1,14 @@
 //! Simple TREVM example that demonstrates how to execute a transaction on a contract.
 //! It simply loads the contract bytecode and executes a transaction.
 
+use revm::context::TransactTo;
 use trevm::{
     revm::{
-        inspector_handle_register,
-        inspectors::TracerEip3155,
-        primitives::{hex, AccountInfo, Address, Bytecode, TransactTo, U256},
-        EvmBuilder, InMemoryDB,
+        bytecode::Bytecode,
+        database::InMemoryDB,
+        inspector::inspectors::TracerEip3155,
+        primitives::{hex, Address, U256},
+        state::AccountInfo,
     },
     trevm_aliases, NoopBlock, NoopCfg, TrevmBuilder, Tx,
 };
@@ -27,18 +29,18 @@ const CALLER_ADDR: Address = Address::with_last_byte(1);
 struct SampleTx;
 
 impl Tx for SampleTx {
-    fn fill_tx_env(&self, tx_env: &mut revm::primitives::TxEnv) {
+    fn fill_tx_env(&self, tx_env: &mut revm::context::TxEnv) {
         tx_env.caller = CALLER_ADDR;
-        tx_env.transact_to = TransactTo::Call(CONTRACT_ADDR);
+        tx_env.kind = TransactTo::Call(CONTRACT_ADDR);
         tx_env.data = hex::decode(PROGRAM_INPUT).unwrap().into();
     }
 }
 
 // Produce aliases for the Trevm type
 trevm_aliases!(TracerEip3155, InMemoryDB);
 
-fn main() {
-    let mut db = revm::InMemoryDB::default();
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let mut db = revm::database::InMemoryDB::default();
 
     let bytecode = Bytecode::new_raw(hex::decode(CONTRACT_BYTECODE).unwrap().into());
     let acc_info = AccountInfo::new(U256::ZERO, 1, bytecode.hash_slow(), bytecode);
@@ -47,18 +49,19 @@ fn main() {
     db.insert_contract(&mut acc_info.clone());
     db.insert_account_info(CONTRACT_ADDR, acc_info);
 
-    let evm = EvmBuilder::default()
+    let insp = TracerEip3155::new(Box::new(std::io::stdout()));
+
+    let trevm = TrevmBuilder::new()
         .with_db(db)
-        .with_external_context(TracerEip3155::new(Box::new(std::io::stdout())))
-        .append_handler_register(inspector_handle_register)
-        .build_trevm()
+        .with_insp(insp)
+        .build_trevm()?
         .fill_cfg(&NoopCfg)
         .fill_block(&NoopBlock);
 
-    let account = evm.read_account_ref(CONTRACT_ADDR).unwrap();
+    let account = trevm.read_account_ref(CONTRACT_ADDR).unwrap();
     println!("account: {account:?}");
 
-    let evm = evm.fill_tx(&SampleTx).run();
+    let evm = trevm.fill_tx(&SampleTx).run();
 
     match evm {
         Ok(res) => {
@@ -69,4 +72,6 @@ fn main() {
             println!("Execution error: {e:?}");
         }
     };
+
+    Ok(())
 }

examples/fork_ref_transact.rs.bak → examples/fork_ref_transact.rs

@@ -3,14 +3,16 @@
 
 //! This example is currently disabled while waiting for revm @ 14.0.4
 
-use alloy::{eips::BlockId, providers::ProviderBuilder};
-use alloy_primitives::{address, Address, TxKind, U256};
-use alloy_sol_types::{sol, SolCall};
+use alloy::{
+    eips::BlockId,
+    primitives::{address, Address, TxKind, U256},
+    providers::ProviderBuilder,
+    sol,
+    sol_types::SolCall,
+};
+use revm::{context::TxEnv, database::WrapDatabaseAsync};
 use trevm::{
-    revm::{
-        db::{AlloyDB, CacheDB},
-        Evm,
-    },
+    revm::database::{AlloyDB, CacheDB},
     NoopBlock, NoopCfg, TrevmBuilder, Tx,
 };
 
@@ -22,10 +24,10 @@ sol! {
 struct GetReservesFiller;
 
 impl Tx for GetReservesFiller {
-    fn fill_tx_env(&self, tx_env: &mut revm::primitives::TxEnv) {
+    fn fill_tx_env(&self, tx_env: &mut TxEnv) {
         tx_env.caller = Address::with_last_byte(0);
         // ETH/USDT pair on Uniswap V2
-        tx_env.transact_to = TxKind::Call(POOL_ADDRESS);
+        tx_env.kind = TxKind::Call(POOL_ADDRESS);
         // calldata formed via alloy's abi encoder
         tx_env.data = getReservesCall::new(()).abi_encode().into();
         // transaction value in wei
@@ -55,15 +57,15 @@ async fn main() -> eyre::Result<()> {
     // =========================================================== //
 
     // initialize new AlloyDB
-    let alloydb = AlloyDB::new(client, BlockId::default()).unwrap();
+    let alloydb = WrapDatabaseAsync::new(AlloyDB::new(client, BlockId::default())).unwrap();
 
     // initialise empty in-memory-db
     let cache_db = CacheDB::new(alloydb);
 
     // initialise an empty (default) EVM
-    let evm = Evm::builder()
+    let evm = TrevmBuilder::new()
         .with_db(cache_db)
-        .build_trevm()
+        .build_trevm()?
         .fill_cfg(&NoopCfg)
         .fill_block(&NoopBlock)
         .fill_tx(&GetReservesFiller)

src/builder.rs

@@ -0,0 +1,63 @@
+use crate::{evm::Trevm, helpers::Ctx, states::EvmNeedsCfg};
+use revm::{
+    database::in_memory_db::InMemoryDB, inspector::NoOpInspector, primitives::hardfork::SpecId,
+    Database, Inspector, MainBuilder,
+};
+
+/// Error that can occur when building a Trevm instance.
+#[derive(Debug, Clone, thiserror::Error)]
+#[non_exhaustive]
+pub enum TrevmBuilderError {
+    /// Database not set.
+    #[error("Database not set")]
+    DatabaseNotSet,
+}
+
+/// A builder for [`Trevm`] that allows configuring the EVM.
+#[derive(Debug, Clone)]
+pub struct TrevmBuilder<Db, Insp> {
+    pub(crate) db: Option<Db>,
+    pub(crate) insp: Insp,
+    pub(crate) spec: SpecId,
+}
+
+impl TrevmBuilder<InMemoryDB, NoOpInspector> {
+    /// Create a new builder with the default database and inspector.
+    #[allow(clippy::new_without_default)] // default would make bad devex :(
+    pub const fn new() -> Self {
+        Self { db: None, insp: NoOpInspector, spec: SpecId::PRAGUE }
+    }
+}
+
+impl<Db, Insp> TrevmBuilder<Db, Insp> {
+    /// Set the database for the EVM.
+    pub fn with_db<Odb>(self, db: Odb) -> TrevmBuilder<Odb, Insp>
+    where
+        Db: Database,
+    {
+        TrevmBuilder { db: Some(db), insp: self.insp, spec: self.spec }
+    }
+
+    /// Set the inspector for the EVM.
+    pub fn with_insp<OInsp>(self, insp: OInsp) -> TrevmBuilder<Db, OInsp> {
+        TrevmBuilder { db: self.db, insp, spec: self.spec }
+    }
+
+    /// Set the spec id for the EVM.
+    pub const fn with_spec_id(mut self, spec: SpecId) -> Self {
+        self.spec = spec;
+        self
+    }
+
+    /// Build the Trevm instance.
+    pub fn build_trevm(self) -> Result<EvmNeedsCfg<Db, Insp>, TrevmBuilderError>
+    where
+        Db: Database,
+        Insp: Inspector<Ctx<Db>>,
+    {
+        let db = self.db.ok_or(TrevmBuilderError::DatabaseNotSet)?;
+        let ctx = Ctx::new(db, self.spec);
+        let evm = ctx.build_mainnet_with_inspector(self.insp);
+        Ok(Trevm::from(evm))
+    }
+}