chore: refactor (#24)

* chore: refactor

* chore: `black .`

* fix(test): install pytest in gh workflow

* chore: update lockfile

* fix(test): dont use pytest asyncio plugin

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.github/workflows/pytest.yaml

@@ -57,4 +57,4 @@ jobs:
           PYTEST_NETWORK: mainnet
           ETHERSCAN_TOKEN: ${{ secrets.ETHERSCAN_TOKEN  }}
         run: |
-          poetry run pytest --asyncio-task-timeout=3600
+          poetry run pytest

evmspec/__init__.py

@@ -1,7 +1,11 @@
-from evmspec import block, header, log, trace, transaction
-from evmspec.header import ErigonBlockHeader
-from evmspec.receipt import FullTransactionReceipt, TransactionReceipt
-from evmspec.trace import FilterTrace
+from evmspec import block, structs, trace, transaction
+from evmspec.structs import (
+    ErigonBlockHeader,
+    FilterTrace,
+    FullTransactionReceipt,
+    TransactionReceipt,
+    header,
+)
 from evmspec.transaction import (
     TransactionRLP,
     TransactionLegacy,
@@ -15,11 +19,11 @@
     # modules
     "block",
     "header",
-    "log",
     "receipt",
     "trace",
     "transaction",
     # structs
+    "structs",
     # - header
     "ErigonBlockHeader",
     # - receipt

evmspec/block.py

@@ -7,17 +7,7 @@
 from msgspec import UNSET, Raw, ValidationError, field, json
 
 from evmspec._ids import IntId
-from evmspec.data import (
-    Address,
-    BlockHash,
-    BlockNumber,
-    Nonce,
-    TransactionHash,
-    UnixTimestamp,
-    Wei,
-    uint,
-    _decode_hook,
-)
+from evmspec.data import *
 from evmspec.transaction import Transaction, TransactionRLP
 
 

evmspec/data/__init__.py

@@ -0,0 +1,26 @@
+from evmspec.data import uints
+from evmspec.data.main import (
+    Address,
+    BlockHash,
+    BlockNumber,
+    HexBytes32,
+    Nonce,
+    TransactionHash,
+    UnixTimestamp,
+    Wei,
+    uint,
+    _decode_hook,
+)
+
+__all__ = [
+    "Address",
+    "uint",
+    "Wei",
+    "HexBytes32",
+    "TransactionHash",
+    "BlockNumber",
+    "BlockHash",
+    "uints",
+    "UnixTimestamp",
+    "Nonce",
+]

evmspec/data.py → evmspec/data/main.py

@@ -11,8 +11,8 @@
 from typing_extensions import Self
 
 if TYPE_CHECKING:
-    from evmspec.log import Log
-    from evmspec.receipt import TransactionReceipt
+    from evmspec.structs.log import Log
+    from evmspec.structs.receipt import TransactionReceipt
 
 _T = TypeVar("_T")
 """A generic type variable."""

evmspec/uints.py → evmspec/data/uints.py

@@ -1,8 +1,18 @@
+"""
+This module provides classes to decode and represent unsigned integer 
+types of any byte size, ensuring values adhere to defined minimum and maximum constraints.
+
+Note:
+    While only a few specific classes like :class:`uint8`, :class:`uint64`,
+    :class:`uint128`, and :class:`uint256` are explicitly defined,
+    other classes are dynamically generated for byte sizes from 2 to 31, excluding those already defined.
+"""
+
 import sys
 
 from hexbytes import HexBytes
 
-from evmspec.data import uint
+from evmspec.data.main import uint
 
 
 class _UintData(uint):
@@ -12,11 +22,6 @@ class _UintData(uint):
     This class provides a framework to define unsigned integer types of any byte size,
     ensuring values adhere to defined minimum and maximum constraints.
 
-    Note:
-        While only a few specific classes like :class:`uint8`, :class:`uint64`,
-        :class:`uint128`, and :class:`uint256` are explicitly defined,
-        other classes are dynamically generated for byte sizes from 2 to 31, excluding those already defined.
-
     See Also:
         :class:`uint8`, :class:`uint64`, :class:`uint128`, :class:`uint256`
     """

evmspec/structs/__init__.py

@@ -0,0 +1,20 @@
+from evmspec.structs.header import ErigonBlockHeader
+from evmspec.structs.receipt import FullTransactionReceipt, TransactionReceipt
+from evmspec.structs.trace import FilterTrace
+
+__all__ = [
+    # - header
+    "ErigonBlockHeader",
+    # - receipt
+    "FullTransactionReceipt",
+    "TransactionReceipt",
+    # - trace
+    "FilterTrace",
+    # - transaction
+    "Transaction",
+    "AnyTransaction",
+    "TransactionRLP",
+    "TransactionLegacy",
+    "Transaction2930",
+    "Transaction1559",
+]

evmspec/header.py → evmspec/structs/header.py

@@ -1,6 +1,7 @@
 from hexbytes import HexBytes
 
 from dictstruct import LazyDictStruct
+
 from evmspec.data import Address, UnixTimestamp, uint
 
 

evmspec/log.py → evmspec/structs/log.py

@@ -3,7 +3,6 @@
 from dictstruct import LazyDictStruct
 from hexbytes import HexBytes
 
-from evmspec import uints
 from evmspec._ids import LogIndex, TransactionIndex
 from evmspec.data import (
     Address,
@@ -12,6 +11,7 @@
     HexBytes32,
     TransactionHash,
     uint,
+    uints,
 )
 
 _ADDRESS_TOPIC_PREFIX = HexBytes("0") * 12

evmspec/receipt.py → evmspec/structs/receipt.py

@@ -9,7 +9,7 @@
 
 from evmspec._ids import TransactionIndex
 from evmspec.data import Address, BlockNumber, TransactionHash, Wei, uint, _decode_hook
-from evmspec.log import Log
+from evmspec.structs.log import Log
 
 
 class FeeStats(DictStruct, frozen=True, forbid_unknown_fields=True):  # type: ignore [call-arg]

evmspec/transaction.py

@@ -6,16 +6,7 @@
 from msgspec import UNSET, Raw, field, json
 
 from evmspec._ids import ChainId, TransactionIndex
-from evmspec.data import (
-    Address,
-    BlockHash,
-    BlockNumber,
-    HexBytes32,
-    Nonce,
-    TransactionHash,
-    Wei,
-    uint,
-)
+from evmspec.data import *
 
 
 class AccessListEntry(LazyDictStruct, frozen=True, forbid_unknown_fields=True):  # type: ignore [call-arg]

pyproject.toml

@@ -21,6 +21,7 @@ sphinx = "*"
 sphinx-rtd-theme = "*"
 mypy = "*"
 types-cachetools = "*"
+pytest = "*"
 
 [tool.mypy]
 ignore_missing_imports = true