web3 7.0.0b3__py3-none-any.whl → 7.0.0b4__py3-none-any.whl

web3/contract/utils.py

@@ -43,6 +43,7 @@ from web3._utils.transactions import (
 )
 from web3.exceptions import (
     BadFunctionCallOutput,
+    Web3ValueError,
 )
 from web3.types import (
     ABI,
@@ -185,7 +186,8 @@ def estimate_gas_for_function(
     *args: Any,
     **kwargs: Any,
 ) -> int:
-    """Estimates gas cost a function call would take.
+    """
+    Estimates gas cost a function call would take.
 
     Don't call this directly, instead use :meth:`Contract.estimate_gas`
     on your contract instance.
@@ -214,7 +216,8 @@ def build_transaction_for_function(
     *args: Any,
     **kwargs: Any,
 ) -> TxParams:
-    """Builds a dictionary with the fields required to make the given transaction
+    """
+    Builds a dictionary with the fields required to make the given transaction
 
     Don't call this directly, instead use :meth:`Contract.build_transaction`
     on your contract instance.
@@ -261,11 +264,11 @@ def get_function_by_identifier(
     fns: Sequence[TContractFn], identifier: str
 ) -> TContractFn:
     if len(fns) > 1:
-        raise ValueError(
+        raise Web3ValueError(
             f"Found multiple functions with matching {identifier}. " f"Found: {fns!r}"
         )
     elif len(fns) == 0:
-        raise ValueError(f"Could not find any function with matching {identifier}")
+        raise Web3ValueError(f"Could not find any function with matching {identifier}")
     return fns[0]
 
 
@@ -394,7 +397,8 @@ async def async_estimate_gas_for_function(
     *args: Any,
     **kwargs: Any,
 ) -> int:
-    """Estimates gas cost a function call would take.
+    """
+    Estimates gas cost a function call would take.
 
     Don't call this directly, instead use :meth:`Contract.estimate_gas`
     on your contract instance.
@@ -425,7 +429,8 @@ async def async_build_transaction_for_function(
     *args: Any,
     **kwargs: Any,
 ) -> TxParams:
-    """Builds a dictionary with the fields required to make the given transaction
+    """
+    Builds a dictionary with the fields required to make the given transaction
 
     Don't call this directly, instead use :meth:`Contract.build_transaction`
     on your contract instance.

web3/datastructures.py

@@ -28,6 +28,11 @@ from eth_utils import (
 from web3._utils.formatters import (
     recursive_map,
 )
+from web3.exceptions import (
+    Web3AssertionError,
+    Web3TypeError,
+    Web3ValueError,
+)
 
 # Hashable must be immutable:
 # "the implementation of hashable collections requires that a
@@ -85,7 +90,10 @@ class ReadableAttributeDict(Mapping[TKey, TValue]):
 
     @classmethod
     def recursive(cls, value: TValue) -> "ReadableAttributeDict[TKey, TValue]":
-        return recursive_map(cls._apply_if_mapping, value)
+        return cast(
+            "ReadableAttributeDict[TKey, TValue]",
+            recursive_map(cls._apply_if_mapping, value),
+        )
 
 
 class MutableAttributeDict(
@@ -100,19 +108,21 @@ class MutableAttributeDict(
 
 class AttributeDict(ReadableAttributeDict[TKey, TValue], Hashable):
     """
-    This provides superficial immutability, someone could hack around it
+    Provides superficial immutability, someone could hack around it
     """
 
     def __setattr__(self, attr: str, val: TValue) -> None:
         if attr == "__dict__":
             super().__setattr__(attr, val)
         else:
-            raise TypeError(
+            raise Web3TypeError(
                 "This data is immutable -- create a copy instead of modifying"
             )
 
     def __delattr__(self, key: str) -> None:
-        raise TypeError("This data is immutable -- create a copy instead of modifying")
+        raise Web3TypeError(
+            "This data is immutable -- create a copy instead of modifying"
+        )
 
     def __hash__(self) -> int:
         return hash(tuple(sorted(tupleize_lists_nested(self).items())))
@@ -143,7 +153,7 @@ def tupleize_lists_nested(d: Mapping[TKey, TValue]) -> AttributeDict[TKey, TValu
         elif isinstance(v, Mapping):
             ret[k] = tupleize_lists_nested(v)
         elif not isinstance(v, Hashable):
-            raise TypeError(f"Found unhashable type '{type(v).__name__}': {v}")
+            raise Web3TypeError(f"Found unhashable type '{type(v).__name__}': {v}")
         else:
             ret[k] = v
     return AttributeDict(ret)
@@ -176,9 +186,9 @@ class NamedElementOnion(Mapping[TKey, TValue]):
 
         if name in self._queue:
             if name is element:
-                raise ValueError("You can't add the same un-named instance twice")
+                raise Web3ValueError("You can't add the same un-named instance twice")
             else:
-                raise ValueError(
+                raise Web3ValueError(
                     "You can't add the same name again, use replace instead"
                 )
 
@@ -195,7 +205,7 @@ class NamedElementOnion(Mapping[TKey, TValue]):
         to calling :meth:`add` .
         """
         if not is_integer(layer):
-            raise TypeError("The layer for insertion must be an int.")
+            raise Web3TypeError("The layer for insertion must be an int.")
         elif layer != 0 and layer != len(self._queue):
             raise NotImplementedError(
                 f"You can only insert to the beginning or end of a {type(self)}, "
@@ -215,7 +225,7 @@ class NamedElementOnion(Mapping[TKey, TValue]):
         elif layer == len(self._queue):
             return
         else:
-            raise AssertionError(
+            raise Web3AssertionError(
                 "Impossible to reach: earlier validation raises an error"
             )
 
@@ -226,7 +236,7 @@ class NamedElementOnion(Mapping[TKey, TValue]):
         old_name = self._repr_if_not_hashable(old)
 
         if old_name not in self._queue:
-            raise ValueError(
+            raise Web3ValueError(
                 "You can't replace unless one already exists, use add instead"
             )
 
@@ -248,7 +258,7 @@ class NamedElementOnion(Mapping[TKey, TValue]):
     def remove(self, old: TKey) -> None:
         old_name = self._repr_if_not_hashable(old)
         if old_name not in self._queue:
-            raise ValueError("You can only remove something that has been added")
+            raise Web3ValueError("You can only remove something that has been added")
         del self._queue[old_name]
 
     @property
@@ -310,7 +320,7 @@ class NamedElementOnion(Mapping[TKey, TValue]):
 
     def as_tuple_of_middleware(self) -> Tuple[TValue, ...]:
         """
-        This helps with type hinting since we return `Iterator[TKey]` type, though it's
+        Helps with type hinting since we return `Iterator[TKey]` type, though it's
         actually a `Iterator[TValue]` type, for the `__iter__()` method. This is in
         order to satisfy the `Mapping` interface.
         """

web3/eth/async_eth.py

@@ -63,6 +63,7 @@ from web3.exceptions import (
     TooManyRequests,
     TransactionIndexingInProgress,
     TransactionNotFound,
+    Web3ValueError,
 )
 from web3.method import (
     Method,
@@ -107,9 +108,9 @@ class AsyncEth(BaseEth):
 
     is_async = True
 
-    _default_contract_factory: Type[Union[AsyncContract, AsyncContractCaller]] = (
-        AsyncContract
-    )
+    _default_contract_factory: Type[
+        Union[AsyncContract, AsyncContractCaller]
+    ] = AsyncContract
 
     # eth_accounts
 
@@ -196,7 +197,8 @@ class AsyncEth(BaseEth):
         except (ValueError, MethodUnavailable):
             warnings.warn(
                 "There was an issue with the method eth_maxPriorityFeePerGas. "
-                "Calculating using eth_feeHistory."
+                "Calculating using eth_feeHistory.",
+                stacklevel=2,
             )
             return await async_fee_history_priority_fee(self)
 
@@ -283,7 +285,7 @@ class AsyncEth(BaseEth):
         max_redirects = self.w3.provider.ccip_read_max_redirects
 
         if not max_redirects or max_redirects < 4:
-            raise ValueError(
+            raise Web3ValueError(
                 "ccip_read_max_redirects property on provider must be at least 4."
             )
 
@@ -391,15 +393,15 @@ class AsyncEth(BaseEth):
     # eth_getBlockTransactionCountByHash
     # eth_getBlockTransactionCountByNumber
 
-    get_block_transaction_count: Method[Callable[[BlockIdentifier], Awaitable[int]]] = (
-        Method(
-            method_choice_depends_on_args=select_method_for_block_identifier(
-                if_predefined=RPC.eth_getBlockTransactionCountByNumber,
-                if_hash=RPC.eth_getBlockTransactionCountByHash,
-                if_number=RPC.eth_getBlockTransactionCountByNumber,
-            ),
-            mungers=[default_root_munger],
-        )
+    get_block_transaction_count: Method[
+        Callable[[BlockIdentifier], Awaitable[int]]
+    ] = Method(
+        method_choice_depends_on_args=select_method_for_block_identifier(
+            if_predefined=RPC.eth_getBlockTransactionCountByNumber,
+            if_hash=RPC.eth_getBlockTransactionCountByHash,
+            if_number=RPC.eth_getBlockTransactionCountByNumber,
+        ),
+        mungers=[default_root_munger],
     )
 
     # eth_sendTransaction
@@ -426,15 +428,15 @@ class AsyncEth(BaseEth):
     # eth_getBlockByHash
     # eth_getBlockByNumber
 
-    _get_block: Method[Callable[[BlockIdentifier, bool], Awaitable[BlockData]]] = (
-        Method(
-            method_choice_depends_on_args=select_method_for_block_identifier(
-                if_predefined=RPC.eth_getBlockByNumber,
-                if_hash=RPC.eth_getBlockByHash,
-                if_number=RPC.eth_getBlockByNumber,
-            ),
-            mungers=[BaseEth.get_block_munger],
-        )
+    _get_block: Method[
+        Callable[[BlockIdentifier, bool], Awaitable[BlockData]]
+    ] = Method(
+        method_choice_depends_on_args=select_method_for_block_identifier(
+            if_predefined=RPC.eth_getBlockByNumber,
+            if_hash=RPC.eth_getBlockByHash,
+            if_number=RPC.eth_getBlockByNumber,
+        ),
+        mungers=[BaseEth.get_block_munger],
     )
 
     async def get_block(
@@ -681,9 +683,9 @@ class AsyncEth(BaseEth):
 
     # eth_getFilterChanges, eth_getFilterLogs, eth_uninstallFilter
 
-    _get_filter_changes: Method[Callable[[HexStr], Awaitable[List[LogReceipt]]]] = (
-        Method(RPC.eth_getFilterChanges, mungers=[default_root_munger])
-    )
+    _get_filter_changes: Method[
+        Callable[[HexStr], Awaitable[List[LogReceipt]]]
+    ] = Method(RPC.eth_getFilterChanges, mungers=[default_root_munger])
 
     async def get_filter_changes(self, filter_id: HexStr) -> List[LogReceipt]:
         return await self._get_filter_changes(filter_id)
@@ -761,12 +763,15 @@ class AsyncEth(BaseEth):
     # -- contract methods -- #
 
     @overload
-    def contract(self, address: None = None, **kwargs: Any) -> Type[AsyncContract]: ...
+    # mypy error: Overloaded function signatures 1 and 2 overlap with incompatible return types  # noqa: E501
+    def contract(self, address: None = None, **kwargs: Any) -> Type[AsyncContract]:  # type: ignore[misc]  # noqa: E501
+        ...
 
     @overload
     def contract(
         self, address: Union[Address, ChecksumAddress, ENS], **kwargs: Any
-    ) -> AsyncContract: ...
+    ) -> AsyncContract:
+        ...
 
     def contract(
         self,

web3/eth/base_eth.py

@@ -30,6 +30,10 @@ from web3._utils.empty import (
 from web3._utils.encoding import (
     to_hex,
 )
+from web3.exceptions import (
+    Web3TypeError,
+    Web3ValueError,
+)
 from web3.module import (
     Module,
 )
@@ -194,7 +198,7 @@ class BaseEth(Module):
         filter_id: Optional[HexStr] = None,
     ) -> Union[List[FilterParams], List[HexStr], List[str]]:
         if filter_id and filter_params:
-            raise TypeError(
+            raise Web3TypeError(
                 "Ambiguous invocation: provide either a `filter_params` or a "
                 "`filter_id` argument. Both were supplied."
             )
@@ -204,14 +208,14 @@ class BaseEth(Module):
             if filter_params in {"latest", "pending"}:
                 return [filter_params]
             else:
-                raise ValueError(
+                raise Web3ValueError(
                     "The filter API only accepts the values of `pending` or "
                     "`latest` for string based filters"
                 )
         elif filter_id and not filter_params:
             return [filter_id]
         else:
-            raise TypeError(
+            raise Web3TypeError(
                 "Must provide either filter_params as a string or "
                 "a valid filter object, or a filter_id as a string "
                 "or hex."

web3/eth/eth.py

@@ -63,6 +63,7 @@ from web3.exceptions import (
     TooManyRequests,
     TransactionIndexingInProgress,
     TransactionNotFound,
+    Web3ValueError,
 )
 from web3.method import (
     Method,
@@ -189,7 +190,8 @@ class Eth(BaseEth):
         except (ValueError, MethodUnavailable):
             warnings.warn(
                 "There was an issue with the method eth_maxPriorityFeePerGas. "
-                "Calculating using eth_feeHistory."
+                "Calculating using eth_feeHistory.",
+                stacklevel=2,
             )
             return fee_history_priority_fee(self)
 
@@ -271,7 +273,7 @@ class Eth(BaseEth):
         max_redirects = self.w3.provider.ccip_read_max_redirects
 
         if not max_redirects or max_redirects < 4:
-            raise ValueError(
+            raise Web3ValueError(
                 "ccip_read_max_redirects property on provider must be at least 4."
             )
 
@@ -631,15 +633,15 @@ class Eth(BaseEth):
 
     # eth_newFilter, eth_newBlockFilter, eth_newPendingTransactionFilter
 
-    filter: Method[Callable[[Optional[Union[str, FilterParams, HexStr]]], Filter]] = (
-        Method(
-            method_choice_depends_on_args=select_filter_method(
-                if_new_block_filter=RPC.eth_newBlockFilter,
-                if_new_pending_transaction_filter=RPC.eth_newPendingTransactionFilter,
-                if_new_filter=RPC.eth_newFilter,
-            ),
-            mungers=[BaseEth.filter_munger],
-        )
+    filter: Method[
+        Callable[[Optional[Union[str, FilterParams, HexStr]]], Filter]
+    ] = Method(
+        method_choice_depends_on_args=select_filter_method(
+            if_new_block_filter=RPC.eth_newBlockFilter,
+            if_new_pending_transaction_filter=RPC.eth_newPendingTransactionFilter,
+            if_new_filter=RPC.eth_newFilter,
+        ),
+        mungers=[BaseEth.filter_munger],
     )
 
     # eth_getFilterChanges, eth_getFilterLogs, eth_uninstallFilter
@@ -677,12 +679,15 @@ class Eth(BaseEth):
     )
 
     @overload
-    def contract(self, address: None = None, **kwargs: Any) -> Type[Contract]: ...
+    # type error: Overloaded function signatures 1 and 2 overlap with incompatible return types  # noqa: E501
+    def contract(self, address: None = None, **kwargs: Any) -> Type[Contract]:  # type: ignore[misc]  # noqa: E501
+        ...
 
     @overload
     def contract(
         self, address: Union[Address, ChecksumAddress, ENS], **kwargs: Any
-    ) -> Contract: ...
+    ) -> Contract:
+        ...
 
     def contract(
         self,

web3/exceptions.py

@@ -41,6 +41,34 @@ class Web3Exception(Exception):
         self.user_message = user_message
 
 
+class Web3AssertionError(Web3Exception, AssertionError):
+    """
+    A web3.py exception wrapper for `AssertionError`, for better control over
+    exception handling.
+    """
+
+
+class Web3ValueError(Web3Exception, ValueError):
+    """
+    A web3.py exception wrapper for `ValueError`, for better control over
+    exception handling.
+    """
+
+
+class Web3AttributeError(Web3Exception, AttributeError):
+    """
+    A web3.py exception wrapper for `AttributeError`, for better control over
+    exception handling.
+    """
+
+
+class Web3TypeError(Web3Exception, TypeError):
+    """
+    A web3.py exception wrapper for `TypeError`, for better control over
+    exception handling.
+    """
+
+
 class BadFunctionCallOutput(Web3Exception):
     """
     We failed to decode ABI output.
@@ -48,24 +76,18 @@ class BadFunctionCallOutput(Web3Exception):
     Most likely ABI mismatch.
     """
 
-    pass
-
 
 class BlockNumberOutofRange(Web3Exception):
     """
     block_identifier passed does not match known block.
     """
 
-    pass
-
 
 class ProviderConnectionError(Web3Exception):
     """
     Raised when unable to connect to a provider
     """
 
-    pass
-
 
 class CannotHandleRequest(Web3Exception):
     """
@@ -73,16 +95,12 @@ class CannotHandleRequest(Web3Exception):
     that the manager should proceed to the next provider.
     """
 
-    pass
-
 
 class TooManyRequests(Web3Exception):
     """
     Raised by a provider to signal that too many requests have been made consecutively.
     """
 
-    pass
-
 
 class MultipleFailedRequests(Web3Exception):
     """
@@ -90,16 +108,12 @@ class MultipleFailedRequests(Web3Exception):
     (or similar) data have failed.
     """
 
-    pass
-
 
 class InvalidAddress(Web3Exception):
     """
     The supplied address does not have a valid checksum, as defined in EIP-55
     """
 
-    pass
-
 
 class NameNotFound(Web3Exception):
     """
@@ -107,8 +121,6 @@ class NameNotFound(Web3Exception):
     does not resolve to an address.
     """
 
-    pass
-
 
 class StaleBlockchain(Web3Exception):
     """
@@ -138,8 +150,6 @@ class MismatchedABI(Web3Exception):
     attempt is made to access a function/event that does not exist in the ABI.
     """
 
-    pass
-
 
 class ABIEventFunctionNotFound(AttributeError, MismatchedABI):
     """
@@ -147,8 +157,6 @@ class ABIEventFunctionNotFound(AttributeError, MismatchedABI):
     that does not exist in the ABI.
     """
 
-    pass
-
 
 class ABIFunctionNotFound(AttributeError, MismatchedABI):
     """
@@ -156,56 +164,43 @@ class ABIFunctionNotFound(AttributeError, MismatchedABI):
     that does not exist in the ABI.
     """
 
-    pass
-
 
 class FallbackNotFound(Web3Exception):
     """
     Raised when fallback function doesn't exist in contract.
     """
 
-    pass
-
 
-class Web3ValidationError(Web3Exception, ValidationError):
+# type ignored because subclassing ValidationError which has type Any
+class Web3ValidationError(Web3Exception, ValidationError):  # type: ignore[misc]
     """
     Raised when a supplied value is invalid.
     """
 
-    pass
-
 
 class ExtraDataLengthError(Web3ValidationError):
     """
     Raised when an RPC call returns >32 bytes of extraData.
     """
 
-    pass
-
 
 class NoABIFunctionsFound(Web3Exception):
     """
     Raised when an ABI is present, but doesn't contain any functions.
     """
 
-    pass
-
 
 class NoABIFound(Web3Exception):
     """
     Raised when no ABI is present.
     """
 
-    pass
-
 
 class NoABIEventsFound(Web3Exception):
     """
     Raised when an ABI doesn't contain any events.
     """
 
-    pass
-
 
 class InsufficientData(Web3Exception):
     """
@@ -213,8 +208,6 @@ class InsufficientData(Web3Exception):
     complete a calculation
     """
 
-    pass
-
 
 class TimeExhausted(Web3Exception):
     """
@@ -222,16 +215,12 @@ class TimeExhausted(Web3Exception):
     result within a specified timeout.
     """
 
-    pass
-
 
 class TransactionNotFound(Web3Exception):
     """
     Raised when a tx hash used to lookup a tx in a jsonrpc call cannot be found.
     """
 
-    pass
-
 
 class TransactionIndexingInProgress(Web3Exception):
     """
@@ -239,40 +228,30 @@ class TransactionIndexingInProgress(Web3Exception):
     still being in progress.
     """
 
-    pass
-
 
 class BlockNotFound(Web3Exception):
     """
     Raised when the block id used to lookup a block in a jsonrpc call cannot be found.
     """
 
-    pass
-
 
 class InfuraProjectIdNotFound(Web3Exception):
     """
     Raised when there is no Infura Project Id set.
     """
 
-    pass
-
 
 class LogTopicError(Web3Exception):
     """
     Raised when the number of log topics is mismatched.
     """
 
-    pass
-
 
 class InvalidEventABI(Web3Exception):
     """
     Raised when the event ABI is invalid.
     """
 
-    pass
-
 
 class ContractLogicError(Web3Exception):
     """
@@ -294,16 +273,12 @@ class ContractCustomError(ContractLogicError):
     Raised on a contract revert custom error
     """
 
-    pass
-
 
 class ContractPanicError(ContractLogicError):
     """
     Raised when a contract reverts with Panic, as of Solidity 0.8.0
     """
 
-    pass
-
 
 class OffchainLookup(ContractLogicError):
     """
@@ -341,12 +316,8 @@ class BadResponseFormat(Web3Exception):
     Raised when a JSON-RPC response comes back in an unexpected format
     """
 
-    pass
-
 
 class MethodUnavailable(Web3Exception):
     """
     Raised when the method is not available on the node
     """
-
-    pass

web3/gas_strategies/time_based.py

@@ -84,8 +84,7 @@ def _get_raw_miner_data(
     latest = w3.eth.get_block("latest", full_transactions=True)
 
     for transaction in latest["transactions"]:
-        # type ignored b/c actual transaction is TxData not HexBytes
-        yield (latest["miner"], latest["hash"], transaction["gasPrice"])  # type: ignore
+        yield (latest["miner"], latest["hash"], transaction["gasPrice"])
 
     block = latest
 
@@ -97,8 +96,7 @@ def _get_raw_miner_data(
         # block numbers to make caching the data easier to implement.
         block = w3.eth.get_block(block["parentHash"], full_transactions=True)
         for transaction in block["transactions"]:
-            # type ignored b/c actual transaction is TxData not HexBytes
-            yield (block["miner"], block["hash"], transaction["gasPrice"])  # type: ignore  # noqa: E501
+            yield (block["miner"], block["hash"], transaction["gasPrice"])
 
 
 def _aggregate_miner_data(