web3 6.20.2__py3-none-any.whl → 7.0.0__py3-none-any.whl

web3/types.py

@@ -5,10 +5,13 @@ from typing import (
     Coroutine,
     Dict,
     List,
+    Literal,
     NewType,
     Optional,
     Sequence,
+    Tuple,
     Type,
+    TypedDict,
     TypeVar,
     Union,
 )
@@ -24,17 +27,12 @@ from hexbytes import (
     HexBytes,
 )
 
-from web3._utils.compat import (
-    Literal,
-    NotRequired,
-    TypedDict,
-)
-from web3._utils.function_identifiers import (
+from web3._utils.abi_element_identifiers import (
     FallbackFn,
     ReceiveFn,
 )
-from web3.datastructures import (
-    NamedElementOnion,
+from web3._utils.compat import (
+    NotRequired,
 )
 
 if TYPE_CHECKING:
@@ -46,15 +44,16 @@ if TYPE_CHECKING:
     )
 
 
-TReturn = TypeVar("TReturn")
+TFunc = TypeVar("TFunc", bound=Callable[..., Any])
 TParams = TypeVar("TParams")
+TReturn = TypeVar("TReturn")
 TValue = TypeVar("TValue")
 
 BlockParams = Literal["latest", "earliest", "pending", "safe", "finalized"]
 BlockIdentifier = Union[BlockParams, BlockNumber, Hash32, HexStr, HexBytes, int]
 LatestBlockParam = Literal["latest"]
 
-FunctionIdentifier = Union[str, Type[FallbackFn], Type[ReceiveFn]]
+ABIElementIdentifier = Union[str, Type[FallbackFn], Type[ReceiveFn]]
 
 # bytes, hexbytes, or hexstr representing a 32 byte hash
 _Hash32 = Union[Hash32, HexBytes, HexStr]
@@ -76,72 +75,6 @@ class AccessListEntry(TypedDict):
 AccessList = NewType("AccessList", Sequence[AccessListEntry])
 
 
-# todo: move these to eth_typing once web3 is type hinted
-class ABIEventParams(TypedDict, total=False):
-    indexed: bool
-    name: str
-    type: str
-
-
-class ABIEvent(TypedDict, total=False):
-    anonymous: bool
-    inputs: Sequence["ABIEventParams"]
-    name: str
-    type: Literal["event"]
-
-
-class ABIFunctionComponents(TypedDict, total=False):
-    components: Sequence["ABIFunctionComponents"]
-    name: str
-    type: str
-
-
-class ABIFunctionParams(TypedDict, total=False):
-    components: Sequence["ABIFunctionComponents"]
-    name: str
-    type: str
-
-
-class ABIFunction(TypedDict, total=False):
-    constant: bool
-    inputs: Sequence["ABIFunctionParams"]
-    name: str
-    outputs: Sequence["ABIFunctionParams"]
-    payable: bool
-    stateMutability: Literal["pure", "view", "nonpayable", "payable"]
-    type: Literal["function", "constructor", "fallback", "receive"]
-
-
-class ABIComponent(TypedDict):
-    """
-    TypedDict representing an `ABIElement` component.
-    """
-
-    name: str
-    """Name of the component."""
-    type: str
-    """Type of the component."""
-    components: NotRequired[Sequence["ABIComponent"]]
-    """List of nested `ABI` components for ABI types."""
-
-
-class ABIError(TypedDict):
-    """
-    TypedDict representing the `ABI` for an error.
-    """
-
-    type: Literal["error"]
-    """Type of the error."""
-    name: str
-    """Name of the error."""
-    inputs: NotRequired[Sequence["ABIComponent"]]
-    """Error input components."""
-
-
-ABIElement = Union[ABIFunction, ABIEvent, ABIError]
-ABI = Sequence[Union[ABIFunction, ABIEvent]]
-
-
 class EventData(TypedDict):
     address: ChecksumAddress
     args: Dict[str, Any]
@@ -217,15 +150,11 @@ TxParams = TypedDict(
 )
 
 
-WithdrawalData = TypedDict(
-    "WithdrawalData",
-    {
-        "index": int,
-        "validator_index": int,
-        "address": ChecksumAddress,
-        "amount": Gwei,
-    },
-)
+class WithdrawalData(TypedDict):
+    index: int
+    validator_index: int
+    address: ChecksumAddress
+    amount: Gwei
 
 
 class BlockData(TypedDict, total=False):
@@ -256,7 +185,7 @@ class BlockData(TypedDict, total=False):
     blobGasUsed: int
     excessBlobGas: int
 
-    # geth_poa_middleware replaces extraData w/ proofOfAuthorityData
+    # ExtraDataToPOAMiddleware replaces extraData w/ proofOfAuthorityData
     proofOfAuthorityData: HexBytes
 
 
@@ -328,7 +257,7 @@ RPCId = Optional[Union[int, str]]
 
 
 class RPCResponse(TypedDict, total=False):
-    error: Union[RPCError, str]
+    error: RPCError
     id: RPCId
     jsonrpc: Literal["2.0"]
     result: Any
@@ -350,15 +279,12 @@ class CreateAccessListResponse(TypedDict):
     gasUsed: int
 
 
-Middleware = Callable[[Callable[[RPCEndpoint, Any], RPCResponse], "Web3"], Any]
-AsyncMiddlewareCoroutine = Callable[
-    [RPCEndpoint, Any], Coroutine[Any, Any, RPCResponse]
-]
-AsyncMiddleware = Callable[
-    [Callable[[RPCEndpoint, Any], RPCResponse], "AsyncWeb3"], Any
+MakeRequestFn = Callable[[RPCEndpoint, Any], RPCResponse]
+MakeBatchRequestFn = Callable[[List[Tuple[RPCEndpoint, Any]]], List[RPCResponse]]
+AsyncMakeRequestFn = Callable[[RPCEndpoint, Any], Coroutine[Any, Any, RPCResponse]]
+AsyncMakeBatchRequestFn = Callable[
+    [List[Tuple[RPCEndpoint, Any]]], Coroutine[Any, Any, List[RPCResponse]]
 ]
-MiddlewareOnion = NamedElementOnion[str, Middleware]
-AsyncMiddlewareOnion = NamedElementOnion[str, AsyncMiddleware]
 
 
 class FormattersDict(TypedDict, total=False):
@@ -382,20 +308,15 @@ class FeeHistory(TypedDict):
     reward: List[List[Wei]]
 
 
-CallOverrideParams = TypedDict(
-    "CallOverrideParams",
-    {
-        "balance": Optional[Wei],
-        "nonce": Optional[int],
-        "code": Optional[Union[bytes, HexStr]],
-        "state": Optional[Dict[HexStr, HexStr]],
-        "stateDiff": Optional[Dict[HexStr, HexStr]],
-    },
-    total=False,
-)
+class StateOverrideParams(TypedDict, total=False):
+    balance: Optional[Wei]
+    nonce: Optional[int]
+    code: Optional[Union[bytes, HexStr]]
+    state: Optional[Dict[HexStr, HexStr]]
+    stateDiff: Optional[Dict[HexStr, HexStr]]
 
 
-CallOverride = Dict[ChecksumAddress, CallOverrideParams]
+StateOverride = Dict[ChecksumAddress, StateOverrideParams]
 
 
 GasPriceStrategy = Union[
@@ -425,6 +346,8 @@ TxReceipt = TypedDict(
     },
 )
 
+BlockReceipts = List[TxReceipt]
+
 
 class SignedTx(TypedDict, total=False):
     raw: bytes

web3/utils/__init__.py

@@ -3,17 +3,70 @@ NOTE: This is a public utility module. Any changes to these utility methods woul
 classify as breaking changes.
 """
 
-from .abi import (  # NOQA
+from eth_utils.abi import (
+    abi_to_signature,
+    collapse_if_tuple,
+    event_abi_to_log_topic,
+    event_signature_to_log_topic,
+    filter_abi_by_name,
+    filter_abi_by_type,
+    function_abi_to_4byte_selector,
+    function_signature_to_4byte_selector,
     get_abi_input_names,
+    get_abi_input_types,
     get_abi_output_names,
+    get_abi_output_types,
+    get_aligned_abi_inputs,
+    get_all_event_abis,
+    get_all_function_abis,
+    get_normalized_abi_inputs,
+)
+from .abi import (  # NOQA
+    check_if_arguments_can_be_encoded,
+    get_abi_element_info,
+    get_abi_element,
+    get_event_abi,
+    get_event_log_topics,
+    log_topic_to_bytes,
 )
-from .address import get_create_address  # NOQA
-from .async_exception_handling import (  # NOQA
+from .address import (
+    get_create_address,
+)
+from .async_exception_handling import (
     async_handle_offchain_lookup,
 )
-from .caching import (  # NOQA
+from .caching import (
     SimpleCache,
 )
-from .exception_handling import (  # NOQA
+from .exception_handling import (
     handle_offchain_lookup,
 )
+
+__all__ = [
+    "abi_to_signature",
+    "collapse_if_tuple",
+    "event_abi_to_log_topic",
+    "event_signature_to_log_topic",
+    "filter_abi_by_name",
+    "filter_abi_by_type",
+    "function_abi_to_4byte_selector",
+    "function_signature_to_4byte_selector",
+    "get_abi_input_names",
+    "get_abi_input_types",
+    "get_abi_output_names",
+    "get_abi_output_types",
+    "get_aligned_abi_inputs",
+    "get_all_event_abis",
+    "get_all_function_abis",
+    "get_normalized_abi_inputs",
+    "check_if_arguments_can_be_encoded",
+    "get_abi_element_info",
+    "get_abi_element",
+    "get_event_abi",
+    "get_event_log_topics",
+    "log_topic_to_bytes",
+    "get_create_address",
+    "async_handle_offchain_lookup",
+    "SimpleCache",
+    "handle_offchain_lookup",
+]