Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluealloy/revm

Rust implementation of the Ethereum Virtual Machine.
https://github.com/bluealloy/revm

blockchain contributor-friendly ethereum evm revm rust

Last synced: 2 days ago
JSON representation

Rust implementation of the Ethereum Virtual Machine.

Awesome Lists containing this project

README 

        
# revm



[![CI](https://github.com/bluealloy/revm/actions/workflows/ci.yml/badge.svg)][gh-ci]

[![License](https://img.shields.io/badge/License-MIT-orange.svg)][mit-license]

[![Chat][tg-badge]][tg-url]



[mit-license]: https://opensource.org/license/mit/

[gh-ci]: https://github.com/bluealloy/revm/actions/workflows/ci.yml

[tg-url]: https://t.me/+Ig4WDWOzikA3MzA0

[tg-badge]: https://img.shields.io/badge/chat-telegram-blue



**Rust Ethereum Virtual Machine**



![](./assets/logo/revm-banner.png)



Revm is an EVM written in Rust that is focused on **speed** and **simplicity**.

It has a fast and flexible implementation with a simple interface and embedded Host.

It passes all `ethereum/tests` test suites.



Here is a list of guiding principles that Revm follows.



* **EVM compatibility and stability** - this goes without saying but it is nice to put it here. In the blockchain industry, stability is the most desired attribute of any system.

* **Speed** - is one of the most important things and most decisions are made to complement this.

* **Simplicity** - simplification of internals so that it can be easily understood and extended, and interface that can be easily used or integrated into other projects.

* **interfacing** - `[no_std]` so that it can be used as wasm lib and integrate with JavaScript and cpp binding if needed.



# Project



Structure:



* crates

  * revm -> main EVM library.

  * revm-primitives -> Primitive data types.

  * revm-interpreter -> Execution loop with instructions

  * revm-precompile -> EVM precompiles

* bins:

  * revme: cli binary, used for running state test jsons



This project tends to use the newest rust version, so if you're encountering a build error try running `rustup update` first.



There were some big efforts on optimization of revm:



* Optimizing interpreter loop: https://github.com/bluealloy/revm/issues/7

* Introducing Bytecode format (and better bytecode analysis): https://github.com/bluealloy/revm/issues/121

* Unification of instruction signatures: https://github.com/bluealloy/revm/pull/283



# Building from source



```shell

git clone https://github.com/bluealloy/revm.git

cd revm

cargo build --release

```



**_Note:_** `clang` is required for building revm with `c-kzg` or `secp256k1` feature flags as they depend on `C` libraries. If you don't have it installed, you can install it with `apt install clang`.



# Running eth tests



go to `cd bins/revme/`



Download eth tests from (this will take some time): `git clone https://github.com/ethereum/tests`



run tests with command: `cargo run --release -- statetest tests/GeneralStateTests/ tests/LegacyTests/Constantinople/GeneralStateTests`



`GeneralStateTests` contains all tests related to EVM.



## Running benchmarks



Benches can be found in [`crates/revm/benches`](./crates/revm/benches).



Currently, available benches include the following.

- *analysis*

- *snailtracer*

- *transfer*



To run the `snailtracer` bench, execute the `cargo bench` subcommand below.



```shell

cargo bench --package revm --profile release -- snailtracer

```



Using [flamegraph][flamegraph], you can create a visualization breaking down the runtime of various

sections of the bench execution - a flame graph. Executing the `cargo flamegraph` subcommand requires

installing [flamegraph][flamegraph] by running `cargo install flamegraph`.



```shell

cargo flamegraph --root --freq 4000 --min-width 0.001 --package revm --bench bench -- snailtracer

```



This command will produce a flamegraph image output to `flamegraph.svg`.

Flamegraph also requires sudo mode to run (hence the `--root` cli arg) and will prompt you for your password if not in sudo mode already.



[flamegraph]: https://docs.rs/crate/flamegraph/0.1.6



## Running Examples



```shell

# Run database reference example

cargo run -p example-database-ref



# Run contract deployment example

cargo run -p example-contract-deployment



# Query Uniswap V2 pool reserves

cargo run -p example-uniswap-get-reserves



# Execute USDC swap on Uniswap V2

cargo run -p example-uniswap-v2-usdc-swap



# Generate block traces 

cargo run -p example-block-traces



# Run database reference example

cargo run -p example-database-ref

```



All examples can be found in the `examples/` directory. Each example demonstrates different aspects of revm:

- `block_traces`: Generating execution traces for entire blocks

- `contract_deployment`: Deploying and interacting with smart contracts

- `database_ref`: Using database references for state access

- `uniswap_get_reserves`: Reading state from Uniswap contracts

- `uniswap_v2_usdc_swap`: Executing swaps on Uniswap V2



# Used by:



* [Foundry](https://github.com/foundry-rs/foundry) is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.

* [Helios](https://github.com/a16z/helios) is a fully trustless, efficient, and portable Ethereum light client written in Rust.

* [Reth](https://github.com/paradigmxyz/reth) Modular, contributor-friendly and blazing-fast implementation of the Ethereum protocol

* [Arbiter](https://github.com/primitivefinance/arbiter) is a framework for stateful Ethereum smart-contract simulation

* [Zeth](https://github.com/risc0/zeth) is an open-source ZK block prover for Ethereum built on the RISC Zero zkVM.

* [VERBS](https://github.com/simtopia/verbs) an open-source Ethereum agent-based modelling and simulation library with a Python API.

* [Hardhat](https://github.com/NomicFoundation/hardhat) is a development environment to compile, deploy, test, and debug your Ethereum software.

* [Trin](https://github.com/ethereum/trin) is Portal Network client. An execution and consensus layer Ethereum light client written in Rust. Portal Network client's provide complete, provable, and distributed execution archival access.

* [Simular](https://github.com/simular-fi/simular/) is a Python smart-contract API with a fast, embedded, Ethereum Virtual Machine.

* [rbuilder](https://github.com/flashbots/rbuilder) is a state of the art Ethereum MEV-Boost block builder written in Rust and designed to work with Reth.

* ...



(If you want to add project to the list, ping me or open the PR)



# Documentation



The book can be found at github page here: https://bluealloy.github.io/revm/



The documentation (alas needs some love) can be found here: https://bluealloy.github.io/revm/docs/



To serve the mdbook documentation in a local environment, ensure you have mdbook installed (if not install it with cargo) and then run:



```shell

mdbook serve documentation

```



# Contact



There is public telegram group: https://t.me/+Ig4WDWOzikA3MzA0



Or if you want to contact me directly, here is my email: [email protected] and telegram: https://t.me/draganrakita