feat/pydantic: Use Pydantic library for types

[marioevz]

🗒️ Description

Simplify code by using Pydantic library.

Affected Files Description

src/ethereum_test_tools/common/base_types.py

A pydantic schema was defined as ToStringSchema which all base types inherit in order to be properly serializable.

src/ethereum_test_tools/common/types.py

The following types have been transformed into pydantic base models:

• Storage
• Account
• Alloc
• Withdrawal
• Environment
• Transaction
• AccessList

Types Storage and Alloc were defined as RootModel types due to the nature of them containing non-fixed keys in their dictionaries.

Type generics were used to simplify the creation of inherited types where the only change was the number encoding, such as WithdrawalGeneric, EnvironmentGeneric and TransactionGeneric, which have been used to create FixtureWithdrawal, FixtureEnvironment, and FixtureTransaction, respectively.

Many type methods have been refactored into cached properties, such as the transaction's RLP, in order to reduce the number of times this same value has to be computed.

Models TransactionReceipt, RejectedTransaction, Result, TransitionToolOutput, are types that are used to parse the responses from the transition tool.

src/ethereum_test_tools/spec/state/types.py, src/ethereum_test_tools/spec/state/state_test.py

State test types and its fixture types have been refactored to use pydantic models.

src/ethereum_test_tools/spec/blockchain/types.py

Blockchain test types and its fixture types have been refactored to use pydantic models.

TODOs

There is still room for improvement but this can be left for to subsequent PRs:

• Properly define type schemas (Add examples) and try to use pydantic primitive types to speed up the test generation.
• Refactor the types into a different library to be able to reuse common types in the evm_transition_tool library.

🔗 Related Issues

None

✅ Checklist

• All: Set appropriate labels for the changes.
• All: Considered squashing commits to improve commit history.
• All: Added an entry to CHANGELOG.md.
• All: Considered updating the online docs in the ./docs/ directory.
• Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
• Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
• Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

[marioevz]

1100+ less lines of code overall.

[danceratopz]

I love it. The code is much more readable. The removal of all the json_encoder defs in types.py is such a joy.

The suggestions below are mainly a few additions to docstrings/comments.