Add specific ValidationError for each module that inherits from eth_utils.exceptions.ValidationError

Author: kclowes

docs/contracts.rst

@@ -215,7 +215,7 @@ Each Contract Factory exposes the following methods.
 
 .. py:classmethod:: Contract.constructor(*args, **kwargs).build_transaction(transaction=None)
     :noindex:
-    
+
     Construct the contract deploy transaction bytecode data.
 
     If the contract takes constructor parameters they should be provided as
@@ -435,7 +435,7 @@ and the arguments are ambiguous.
         }
         """
         # fast forward all the steps of compiling and deploying the contract.
-        >>> ambiguous_contract.functions.identity(1, True) # raises ValidationError
+        >>> ambiguous_contract.functions.identity(1, True) # raises Web3ValidationError
 
         >>> identity_func = ambiguous_contract.get_function_by_signature('identity(uint256,bool)')
         >>> identity_func(1, True)
@@ -654,7 +654,7 @@ Taking the following contract code as an example:
     >>> array_contract.functions.setBytes2Value([b'a']).transact()
     Traceback (most recent call last):
        ...
-    ValidationError:
+    Web3ValidationError:
     Could not identify the intended function with name `setBytes2Value`
 
 

ens/exceptions.py

@@ -1,3 +1,6 @@
+from eth_utils.exceptions import (
+    ValidationError,
+)
 import idna
 
 
@@ -110,3 +113,9 @@ class UnderfundedBid(ENSException):
     """
 
     pass
+
+
+class ENSValidationError(ENSException, ValidationError):
+    """
+    Raised if there is a validation error
+    """

ens/utils.py

@@ -24,7 +24,6 @@
     HexStr,
 )
 from eth_utils import (
-    ValidationError,
     is_same_address,
     remove_0x_prefix,
     to_bytes,
@@ -48,6 +47,7 @@
 )
 from ens.exceptions import (
     InvalidName,
+    ENSValidationError,
 )
 
 default = object()
@@ -142,7 +142,9 @@ def ens_encode_name(name: str) -> bytes:
     # raises if len(label) > 255:
     for index, label in enumerate(labels):
         if len(label) > 255:
-            raise ValidationError(f"Label at position {index} too long after encoding.")
+            raise ENSValidationError(
+                f"Label at position {index} too long after encoding."
+            )
 
     # concat label size in bytes to each label:
     dns_prepped_labels = [to_bytes(len(label)) + label for label in labels_as_bytes]

ethpm/exceptions.py

@@ -1,3 +1,8 @@
+from eth_utils.exceptions import (
+    ValidationError,
+)
+
+
 class EthPMException(Exception):
     """
     Base class for all Py-EthPM errors.
@@ -15,7 +20,7 @@ class InsufficientAssetsError(EthPMException):
     pass
 
 
-class EthPMValidationError(EthPMException):
+class EthPMValidationError(EthPMException, ValidationError):
     """
     Raised when something does not pass a validation check.
     """

tests/core/contracts/test_contract_build_transaction.py

@@ -5,7 +5,7 @@
 )
 
 from web3.exceptions import (
-    ValidationError,
+    Web3ValidationError,
 )
 
 
@@ -28,7 +28,7 @@ def test_build_transaction_not_paying_to_nonpayable_function(
 def test_build_transaction_paying_to_nonpayable_function(
     w3, payable_tester_contract, build_transaction
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         build_transaction(
             contract=payable_tester_contract,
             contract_function="doNoValueCall",
@@ -277,7 +277,7 @@ async def test_async_build_transaction_not_paying_to_nonpayable_function(
 async def test_async_build_transaction_paying_to_nonpayable_function(
     async_w3, async_payable_tester_contract, async_build_transaction
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         await async_build_transaction(
             contract=async_payable_tester_contract,
             contract_function="doNoValueCall",

tests/core/contracts/test_contract_call_interface.py

@@ -32,7 +32,7 @@
     NameNotFound,
     NoABIFound,
     NoABIFunctionsFound,
-    ValidationError,
+    Web3ValidationError,
 )
 
 MULTIPLE_FUNCTIONS = json.loads(
@@ -317,7 +317,7 @@ def test_set_strict_byte_array(strict_arrays_contract, call, transact, args, exp
 def test_set_strict_byte_array_with_invalid_args(
     strict_arrays_contract, transact, args
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         transact(
             contract=strict_arrays_contract,
             contract_function="setByteValue",
@@ -644,13 +644,13 @@ def test_no_functions_match_identifier(arrays_contract):
 
 def test_function_1_match_identifier_wrong_number_of_args(arrays_contract):
     regex = message_regex + diagnosis_arg_regex
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         arrays_contract.functions.setBytes32Value().call()
 
 
 def test_function_1_match_identifier_wrong_args_encoding(arrays_contract):
     regex = message_regex + diagnosis_encoding_regex
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         arrays_contract.functions.setBytes32Value("dog").call()
 
 
@@ -665,7 +665,7 @@ def test_function_1_match_identifier_wrong_args_encoding(arrays_contract):
 def test_function_multiple_error_diagnoses(w3, arg1, arg2, diagnosis):
     Contract = w3.eth.contract(abi=MULTIPLE_FUNCTIONS)
     regex = message_regex + diagnosis
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         if arg2:
             Contract.functions.a(arg1, arg2).call()
         else:
@@ -683,7 +683,7 @@ def test_function_wrong_args_for_tuple_collapses_args_in_message(
     address,
     tuple_contract,
 ):
-    with pytest.raises(ValidationError) as e:
+    with pytest.raises(Web3ValidationError) as e:
         tuple_contract.functions.method(
             (1, [2, 3], [(4, [True, [False]], [address])])
         ).call()
@@ -711,7 +711,7 @@ def test_function_wrong_args_for_tuple_collapses_args_in_message(
 def test_function_wrong_args_for_tuple_collapses_kwargs_in_message(
     address, tuple_contract
 ):
-    with pytest.raises(ValidationError) as e:
+    with pytest.raises(Web3ValidationError) as e:
         tuple_contract.functions.method(
             a=(1, [2, 3], [(4, [True, [False]], [address])])  # noqa: E501
         ).call()
@@ -747,7 +747,7 @@ def test_call_not_sending_ether_to_nonpayable_function(payable_tester_contract,
 
 
 def test_call_sending_ether_to_nonpayable_function(payable_tester_contract, call):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         call(
             contract=payable_tester_contract,
             contract_function="doNoValueCall",
@@ -817,7 +817,7 @@ def test_invalid_fixed_value_reflections(
     fixed_reflection_contract, function, value, error
 ):
     contract_func = fixed_reflection_contract.functions[function]
-    with pytest.raises(ValidationError, match=error):
+    with pytest.raises(Web3ValidationError, match=error):
         contract_func(value).call({"gas": 420000})
 
 
@@ -1154,7 +1154,7 @@ async def test_async_set_strict_byte_array(
 async def test_async_set_strict_byte_array_with_invalid_args(
     async_strict_arrays_contract, async_transact, args
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         await async_transact(
             contract=async_strict_arrays_contract,
             contract_function="setByteValue",
@@ -1514,7 +1514,7 @@ async def test_async_function_1_match_identifier_wrong_number_of_args(
     async_arrays_contract,
 ):
     regex = message_regex + diagnosis_arg_regex
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         await async_arrays_contract.functions.setBytes32Value().call()
 
 
@@ -1523,7 +1523,7 @@ async def test_async_function_1_match_identifier_wrong_args_encoding(
     async_arrays_contract,
 ):
     regex = message_regex + diagnosis_encoding_regex
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         await async_arrays_contract.functions.setBytes32Value("dog").call()
 
 
@@ -1539,7 +1539,7 @@ async def test_async_function_1_match_identifier_wrong_args_encoding(
 async def test_async_function_multiple_diagnoses(async_w3, arg1, arg2, diagnosis):
     Contract = async_w3.eth.contract(abi=MULTIPLE_FUNCTIONS)
     regex = message_regex + diagnosis
-    with pytest.raises(ValidationError, match=regex):
+    with pytest.raises(Web3ValidationError, match=regex):
         if arg2:
             await Contract.functions.a(arg1, arg2).call()
         else:
@@ -1574,7 +1574,7 @@ async def test_async_call_not_sending_ether_to_nonpayable_function(
 async def test_async_call_sending_ether_to_nonpayable_function(
     async_payable_tester_contract, async_call
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         await async_call(
             contract=async_payable_tester_contract,
             contract_function="doNoValueCall",
@@ -1648,7 +1648,7 @@ async def test_async_invalid_fixed_value_reflections(
     async_fixed_reflection_contract, function, value, error
 ):
     contract_func = async_fixed_reflection_contract.functions[function]
-    with pytest.raises(ValidationError, match=error):
+    with pytest.raises(Web3ValidationError, match=error):
         await contract_func(value).call({"gas": 420000})
 
 

tests/core/contracts/test_contract_estimate_gas.py

@@ -1,7 +1,7 @@
 import pytest
 
 from web3.exceptions import (
-    ValidationError,
+    Web3ValidationError,
 )
 
 
@@ -63,7 +63,7 @@ def test_estimate_gas_not_sending_ether_to_nonpayable_function(
 def test_estimate_gas_sending_ether_to_nonpayable_function(
     w3, payable_tester_contract, estimate_gas
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         estimate_gas(
             contract=payable_tester_contract,
             contract_function="doNoValueCall",
@@ -169,7 +169,7 @@ async def test_async_estimate_gas_not_sending_ether_to_nonpayable_function(
 async def test_async_estimate_gas_sending_ether_to_nonpayable_function(
     async_w3, async_payable_tester_contract, async_estimate_gas
 ):
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         await async_estimate_gas(
             contract=async_payable_tester_contract,
             contract_function="doNoValueCall",

tests/core/contracts/test_contract_method_abi_encoding.py

@@ -5,7 +5,7 @@
     constants,
 )
 from web3.exceptions import (
-    ValidationError,
+    Web3ValidationError,
 )
 
 ABI_A = json.loads(
@@ -112,7 +112,7 @@ def test_contract_abi_encoding_kwargs(w3):
 )
 def test_contract_abi_encoding_strict_with_error(w3_strict_abi, arguments):
     contract = w3_strict_abi.eth.contract(abi=ABI_C)
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         contract.encodeABI("a", arguments, data=None)
 
 

tests/core/contracts/test_contract_method_to_argument_matching.py

@@ -9,7 +9,7 @@
     ReceiveFn,
 )
 from web3.exceptions import (
-    ValidationError,
+    Web3ValidationError,
 )
 
 SINGLE_FN_NO_ARGS = json.loads(
@@ -137,7 +137,7 @@ def test_finds_receive_function(w3):
 def test_error_when_no_function_name_match(w3):
     Contract = w3.eth.contract(abi=SINGLE_FN_NO_ARGS)
 
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         Contract._find_matching_fn_abi("no_function_name", [1234])
 
 
@@ -176,15 +176,15 @@ def test_finds_function_with_matching_args_deprecation_warning(w3):
 def test_error_when_duplicate_match(w3):
     Contract = w3.eth.contract(abi=MULTIPLE_FUNCTIONS)
 
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         Contract._find_matching_fn_abi("a", [100])
 
 
 @pytest.mark.parametrize("arguments", (["0xf00b47"], [b""], [""], ["00" * 16]))
 def test_strict_errors_if_type_is_wrong(w3_strict_abi, arguments):
     Contract = w3_strict_abi.eth.contract(abi=MULTIPLE_FUNCTIONS)
 
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         Contract._find_matching_fn_abi("a", arguments)
 
 

tests/core/contracts/test_contract_transact_interface.py

@@ -8,7 +8,7 @@
     empty,
 )
 from web3.exceptions import (
-    ValidationError,
+    Web3ValidationError,
 )
 
 
@@ -51,7 +51,7 @@ def test_transact_sending_ether_to_nonpayable_function(
     )
 
     assert initial_value is False
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         txn_hash = transact(
             contract=payable_tester_contract,
             contract_function="doNoValueCall",
@@ -314,7 +314,7 @@ async def test_async_transact_sending_ether_to_nonpayable_function(
     )
 
     assert initial_value is False
-    with pytest.raises(ValidationError):
+    with pytest.raises(Web3ValidationError):
         txn_hash = await async_transact(
             contract=async_payable_tester_contract,
             contract_function="doNoValueCall",