forked from bluealloy/revm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): revme readme update (bluealloy#898)
- Loading branch information
Showing
2 changed files
with
25 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ target | |
.idea | ||
pkg/ | ||
|
||
|
||
tests | ||
bins/revme/temp_folder | ||
bins/revme/tests | ||
ethereumjs-util.js | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,26 @@ | ||
# Rust EVM executor or short REVME | ||
|
||
This is binary crate that executed evm multiple ways. Currently it is used to run ethereum tests: | ||
* statetest: takes path to folder where ethereum statetest json can be found. It recursively searches for all json files and execute them. This is how i run all https://github.com/ethereum/tests to check if revm is compliant. Example `revme statests test/GenericEvmTest/` | ||
`revme` is a binary crate to execute the evm in multiple ways. | ||
|
||
Currently it is mainly used to run ethereum tests with the `statetest` subcommand. | ||
|
||
## State Tests | ||
|
||
`statetest` takes a path to the directory where ethereum statetest json can be found. | ||
It recursively parses all json files in the specified directory and executes them. | ||
|
||
Running all [ethereum tests][et] checks that revm is compliant to the ethereum specs. | ||
|
||
To run [ethereum tests][et] locally, clone the [tests][et] repository and provide the | ||
test directory. Below, we clone the repo and execute the `GeneralStateTests` suite of | ||
tests. | ||
|
||
```shell | ||
git clone https://github.com/ethereum/tests | ||
cargo run -p revme statetest tests/GeneralStateTests | ||
``` | ||
|
||
*Notice, in the [`.gitignore`](../../.gitignore), the `bins/revme/tests` directory | ||
is ignored so it won't be checked into git.* | ||
|
||
[et]: https://github.com/ethereum/tests |