Skip to content

Commit

Permalink
Update EVM tool documentation (#1260)
Browse files Browse the repository at this point in the history
* Update EVM tool documentation

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

* update code-validate

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

* document code-validate

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

* add t8n options

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

---------

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
  • Loading branch information
alexandratran authored Feb 24, 2023
1 parent 7267554 commit 23ed278
Show file tree
Hide file tree
Showing 2 changed files with 198 additions and 83 deletions.
23 changes: 10 additions & 13 deletions docs/public-networks/how-to/troubleshoot/evm-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,28 +54,25 @@ docker run -rm <docker options> hyperledger/besu-evmtool:develop <evmtool option

## EVM tool run options

The first mode of the EVM tool runs an arbitrary EVM and is invoked without an extra command. [Command
line options](../../reference/evm-tool.md) specify the code and other contextual information.
The first mode of the EVM tool runs an arbitrary EVM and is invoked without an extra command.
[Command line options](../../reference/evm-tool.md) specify the code and other contextual information.

The EVM tool also has a [`state-test` subcommand](../../reference/evm-tool.md#state-test-options)
that allows the [Ethereum state tests](https://github.com/ethereum/tests/tree/develop/GeneralStateTests) to be evaluated.
Most of the options from EVM execution do not apply.
that allows [Ethereum state tests](https://github.com/ethereum/tests/tree/develop/GeneralStateTests)
to be evaluated, and a [`code-validate` subcommand](../../reference/evm-tool.md#eof-code-validation)
that allows [Ethereum object formatted (EOF)](https://eips.ethereum.org/EIPS/eip-3540) code to be validated.
Most of the options from EVM execution don't apply.

=== "Syntax"
=== "`state-test`"

```bash
evm state-test <state-test> --nomemory
```

=== "CLI example"
=== "`code-validate`"

```bash
evm state-test stExample/add11.json --nomemory
evm code-validate --file <file>
```
=== "Docker example"

```bash
docker run --rm -v ${PWD}:/opt/referencetests hyperledger/besu-evmtool:develop state-test /opt/referencetests/GeneralStateTests/stExample/add11.json
```

The [EVM tool reference](../../reference/evm-tool.md) provides more information on both modes.
The [EVM tool reference](../../reference/evm-tool.md) provides more information on these modes.
Loading

0 comments on commit 23ed278

Please sign in to comment.