Skip to content

Commit 74764cd

Browse files
authored
docs(levm): mention solidity compiler dependency for levm benchmark tool (#2906)
**Motivation** Following the `rev_comparison` levm bench tool's README to run the tool results in an error as the solidity compiler is not installed. This is not mentioned as a dependency, so this PR updates the README to mention that solidity compiler is required to use the tool and how to install it. <!-- Why does this pull request exist? What are its goals? --> **Description** * Mention solidity compiler dependency + how to install it on levm's `rev_comparison` benchmark tool README <!-- A clear and concise general description of the changes this PR introduces --> <!-- Link to issues: Resolves #111, Resolves #222 --> Closes #issue_number
1 parent 06d4695 commit 74764cd

File tree

1 file changed

+10
-0
lines changed
  • crates/vm/levm/bench/revm_comparison

1 file changed

+10
-0
lines changed

crates/vm/levm/bench/revm_comparison/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,20 @@
22
This README explains how to run benchmarks to compare the performance of `levm` and `revm` when running different contracts. The benchmarking tool used to gather performance metrics is [hyperfine](https://github.com/sharkdp/hyperfine), and the obtained results will be included for reference.
33

44
To run the benchmarks (from `levm`'s root):
5+
56
```bash
67
make revm-comparison
78
```
89

10+
Note that first you will need to install the solidity compiler
11+
On mac you can use homebrew:
12+
13+
```bash
14+
brew install solidity
15+
```
16+
17+
For other installation methods check out the [official solidity installation guide](https://docs.soliditylang.org/en/latest/installing-solidity.html)
18+
919
## Factorial
1020
This program computes the nth factorial number, with n passed via calldata. We chose 1000 as n and ran the program on a loop 100,000 times.
1121

0 commit comments

Comments
 (0)