-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update execution-specs t8n installation help
- Loading branch information
1 parent
d600341
commit f908c4a
Showing
1 changed file
with
33 additions
and
5 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 |
---|---|---|
|
@@ -23,17 +23,45 @@ class ExecutionSpecsTransitionTool(GethTransitionTool): | |
The behavior of this tool is almost identical to go-ethereum's `evm t8n` command. | ||
note: How to use the `ethereum-spec-evm` tool: | ||
note: Using the latest version of the `ethereum-spec-evm` tool: | ||
As the `ethereum` package provided by `execution-specs` is a requirement of | ||
`execution-spec-tests`, the `ethereum-spec-evm` is already installed in the | ||
virtual environment where `execution-spec-tests` is installed | ||
(via `pip install -e .`). Therefore, the `ethereum-spec-evm` transition tool | ||
can be used to fill tests via: | ||
```console | ||
fill --evm-bin=ethereum-spec-evm | ||
``` | ||
To ensure you're using the latest version of `ethereum-spec-evm` you can run: | ||
``` | ||
pip install --force-reinstall -e . | ||
``` | ||
or | ||
``` | ||
pip install --force-reinstall -e .[docs,lint,tests] | ||
``` | ||
as appropriate. | ||
note: Using a specific version of the `ethereum-spec-evm` tool: | ||
1. Create a virtual environment and activate it: | ||
``` | ||
python -m venv venv | ||
source venv/bin/activate | ||
python -m venv venv-execution-specs | ||
source venv-execution-specs/bin/activate | ||
``` | ||
2. Clone the ethereum/execution-specs repository and change working directory to it: | ||
2. Clone the ethereum/execution-specs repository, change working directory to it and | ||
retrieve the desired version of the repository: | ||
``` | ||
git clone [email protected]:ethereum/execution-specs.git | ||
cd execution-specs | ||
git checkout <version> | ||
``` | ||
3. Install the packages provided by the repository: | ||
``` | ||
|
@@ -55,7 +83,7 @@ class ExecutionSpecsTransitionTool(GethTransitionTool): | |
``` | ||
6. Run the tests, specifying the `ethereum-spec-evm` command as the transition tool: | ||
``` | ||
fill --evm-bin=ethereum-spec-evm | ||
fill --evm-bin=path/to/venv-execution-specs/ethereum-spec-evm | ||
``` | ||
""" | ||
|
||
|