Extend and more properly define typing for BlockIdentifier

eth_typing/evm.py

@@ -4,13 +4,18 @@
     Union,
 )
 
+from typing_extensions import (
+    Literal,
+)
+
 from .encoding import (
     HexStr,
 )
 
 Hash32 = NewType("Hash32", bytes)
 BlockNumber = NewType("BlockNumber", int)
-BlockIdentifier = Union[BlockNumber, Hash32]
+BlockParams = Literal["latest", "earliest", "pending", "safe", "finalized"]
+BlockIdentifier = Union[BlockParams, BlockNumber, Hash32, HexStr, int]
 
 Address = NewType("Address", bytes)
 HexAddress = NewType("HexAddress", HexStr)

newsfragments/47.feature.rst

@@ -0,0 +1 @@
+Borrowing from the typing in web3.py, open up ``BlockIdentifier`` to include ``BlockParams`` (e.g. "latest", "finalized", etc..) as well as other valid values.

setup.py

@@ -57,6 +57,10 @@
     author_email="snakecharmers@ethereum.org",
     url="https://github.com/ethereum/eth-typing",
     include_package_data=True,
+    install_requires=[
+        # remove typing_extensions after python_requires>=3.8
+        "typing-extensions>=4.0.1",
+    ],
     python_requires=">=3.7.2, <4",
     extras_require=extras_require,
     py_modules=["eth_typing"],