Skip to content

Commit

Permalink
fix(docs): update library reference
Browse files Browse the repository at this point in the history
  • Loading branch information
marioevz committed Jul 16, 2024
1 parent 26cf408 commit be706d0
Show file tree
Hide file tree
Showing 11 changed files with 42 additions and 8 deletions.
8 changes: 6 additions & 2 deletions docs/consuming_tests/exceptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ the exceptions.

## `TransactionException`

::: ethereum_test_tools.TransactionException
::: ethereum_test_exceptions.TransactionException

## `BlockException`

::: ethereum_test_tools.BlockException
::: ethereum_test_exceptions.BlockException

## `EOFException`

::: ethereum_test_exceptions.EOFException
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_base_types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test Base Types package

::: ethereum_test_base_types
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_exceptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test Exceptions package

::: ethereum_test_exceptions
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_fixtures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test Fixtures package

::: ethereum_test_fixtures
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_specs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test Specs package

::: ethereum_test_specs
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test Types package

::: ethereum_test_types
3 changes: 3 additions & 0 deletions docs/library/ethereum_test_vm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Test VM package

::: ethereum_test_vm
10 changes: 8 additions & 2 deletions docs/library/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

Execution spec tests consists of several packages that implement helper classes and tools that enable and simplify test case implementation. This section contains their reference documentation:

- [`evm_transition_tool`](./evm_transition_tool.md) - a wrapper for the transition (`t8n`) tool.
- [`ethereum_test_tools`](./ethereum_test_tools.md) - provides primitives and helpers to test Ethereum execution clients.
- [`ethereum_test_base_types`](./ethereum_test_base_types.md) - provides the basic types on top of which other testing libraries are built.
- [`ethereum_test_exceptions`](./ethereum_test_exceptions.md) - provides definitions for exceptions used in all tests.
- [`ethereum_test_fixtures`](./ethereum_test_fixtures.md) - provides definitions of all test fixture types that are produced in this repository and can be consumed by clients.
- [`ethereum_test_forks`](./ethereum_test_forks.md) - provides definitions for supported forks used in tests.
- [`ethereum_test_specs`](./ethereum_test_specs.md) - provides definitions for all spec types used to define test cases, and generate different kinds of test fixtures.
- [`ethereum_test_tools`](./ethereum_test_tools.md) - provides primitives and helpers to test Ethereum execution clients.
- [`ethereum_test_types`](./ethereum_test_types.md) - provides Ethereum types built on top of the base types which are used to define test cases and interact with other libraries.
- [`ethereum_test_vm`](./ethereum_test_vm.md) - provides definitions for the Ethereum Virtual Machine (EVM) as used to define bytecode in test cases.
- [`evm_transition_tool`](./evm_transition_tool.md) - a wrapper for the transition (`t8n`) tool.
- [`pytest_plugins`](./pytest_plugins/index.md) - contains pytest customizations that provide additional functionality for generating test fixtures.
10 changes: 8 additions & 2 deletions docs/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@
* [Enabling Precommit Checks](dev/precommit.md)
* [Changelog](CHANGELOG.md)
* [Library Reference](library/index.md)
* [EVM Transition Tool Package](library/evm_transition_tool.md)
* [Ethereum Test Tools Package](library/ethereum_test_tools.md)
* [Ethereum Test Base Types Package](library/ethereum_test_base_types.md)
* [Ethereum Test Exceptions Package](library/ethereum_test_exceptions.md)
* [Ethereum Test Fixtures Package](library/ethereum_test_fixtures.md)
* [Ethereum Test Forks Package](library/ethereum_test_forks.md)
* [Ethereum Test Specs Package](library/ethereum_test_specs.md)
* [Ethereum Test Tools Package](library/ethereum_test_tools.md)
* [Ethereum Test Types Package](library/ethereum_test_types.md)
* [Ethereum Test VM Package](library/ethereum_test_vm.md)
* [EVM Transition Tool Package](library/evm_transition_tool.md)
* [Pytest Plugins](library/pytest_plugins/index.md)
2 changes: 1 addition & 1 deletion docs/writing_tests/exception_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Exception tests are a special type of test which verify that an invalid transact

## Creating an Exception Test

To test for an exception, the test can use either of the following types from `ethereum_test_tools` library:
To test for an exception, the test can use either of the following types from `ethereum_test_exceptions` library:

1. [`TransactionException`](../consuming_tests/exceptions.md#transactionexception): To be added to the `error` field of the `Transaction` object, and to the `exception` field of the `Block` object that includes the transaction; this exception type is used when a transaction is invalid, and therefore when included in a block, the block is expected to be invalid too. This is different from valid transactions where an exception during EVM execution is expected (e.g. a revert, or out-of-gas), which can be included in valid blocks.

Expand Down
2 changes: 1 addition & 1 deletion docs/writing_tests/writing_a_new_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Within the `post` dictionary object, an account address can be:
The `Account` object is used to specify the properties of an account to be
verified in the post state.

The python representation can be found in [src/ethereum_test_tools/common/types.py](https://github.com/ethereum/execution-spec-tests/blob/main/src/ethereum_test_tools/common/types.py).
The python representation can be found in [src/ethereum_test_types/types.py](https://github.com/ethereum/execution-spec-tests/blob/main/src/ethereum_test_types/types.py).

It can verify the following properties of an account:

Expand Down

0 comments on commit be706d0

Please sign in to comment.