Use ENS exception wrappers for Python exceptions

Author: fselmo

ens/async_ens.py

@@ -46,6 +46,7 @@
 )
 from ens.exceptions import (
     AddressMismatch,
+    ENSValueError,
     ResolverNotFound,
     UnauthorizedError,
     UnownedName,
@@ -64,9 +65,6 @@
     normalize_name,
     raw_name_to_hash,
 )
-from web3.exceptions import (
-    Web3ValueError,
-)
 
 if TYPE_CHECKING:
     from web3.contract.async_contract import (  # noqa: F401
@@ -207,7 +205,7 @@ async def setup_address(
         elif is_binary_address(address):
             address = to_checksum_address(cast(str, address))
         elif not is_checksum_address(address):
-            raise Web3ValueError("You must supply the address in checksum format")
+            raise ENSValueError("You must supply the address in checksum format")
         if await self.address(name) == address:
             return None
         if address is None:
@@ -285,7 +283,7 @@ async def setup_name(
             if is_binary_address(address):
                 address = to_checksum_address(address)
             if not is_checksum_address(address):
-                raise Web3ValueError("You must supply the address in checksum format")
+                raise ENSValueError("You must supply the address in checksum format")
             await self._assert_control(address, name)
             if not resolved:
                 await self.setup_address(name, address, transact=transact)

ens/ens.py

@@ -30,10 +30,6 @@
     HexBytes,
 )
 
-from web3.exceptions import (
-    Web3ValueError,
-)
-
 from . import (
     abis,
 )
@@ -50,6 +46,7 @@
 )
 from .exceptions import (
     AddressMismatch,
+    ENSValueError,
     ResolverNotFound,
     UnauthorizedError,
     UnownedName,
@@ -212,7 +209,7 @@ def setup_address(
         elif is_binary_address(address):
             address = to_checksum_address(cast(str, address))
         elif not is_checksum_address(address):
-            raise Web3ValueError("You must supply the address in checksum format")
+            raise ENSValueError("You must supply the address in checksum format")
         if self.address(name) == address:
             return None
         if address is None:
@@ -288,7 +285,7 @@ def setup_name(
             if is_binary_address(address):
                 address = to_checksum_address(address)
             if not is_checksum_address(address):
-                raise Web3ValueError("You must supply the address in checksum format")
+                raise ENSValueError("You must supply the address in checksum format")
             self._assert_control(address, name)
             if not resolved:
                 self.setup_address(name, address, transact=transact)

ens/exceptions.py

@@ -12,6 +12,24 @@ class ENSException(Exception):
     pass
 
 
+class ENSValueError(ENSException, ValueError):
+    """
+    An ENS exception wrapper for `ValueError`, for better control over
+    exception handling.
+    """
+
+    pass
+
+
+class ENSTypeError(ENSException, TypeError):
+    """
+    An ENS exception wrapper for `TypeError`, for better control over
+    exception handling.
+    """
+
+    pass
+
+
 class AddressMismatch(ENSException):
     """
     In order to set up reverse resolution correctly, the ENS name should first

ens/utils.py

@@ -35,9 +35,9 @@
     HexBytes,
 )
 
-from web3.exceptions import (
-    Web3TypeError,
-    Web3ValueError,
+from ens.exceptions import (
+    ENSTypeError,
+    ENSValueError,
 )
 
 from .constants import (
@@ -204,7 +204,7 @@ def sha3_text(val: Union[str, bytes]) -> HexBytes:
 def label_to_hash(label: str) -> HexBytes:
     label = normalize_name(label)
     if "." in label:
-        raise Web3ValueError(f"Cannot generate hash for label {label!r} with a '.'")
+        raise ENSValueError(f"Cannot generate hash for label {label!r} with a '.'")
     return Web3().keccak(text=label)
 
 
@@ -269,7 +269,7 @@ def assert_signer_in_modifier_kwargs(modifier_kwargs: Any) -> ChecksumAddress:
 
     _modifier_type, modifier_dict = dict(modifier_kwargs).popitem()
     if "from" not in modifier_dict:
-        raise Web3TypeError(ERR_MSG)
+        raise ENSTypeError(ERR_MSG)
 
     return modifier_dict["from"]
 

tests/ens/conftest.py

@@ -28,6 +28,9 @@
     reverse_resolver_bytecode,
     reverse_resolver_bytecode_runtime,
 )
+from ens.exceptions import (
+    ENSTypeError,
+)
 from web3 import (
     AsyncWeb3,
     Web3,
@@ -51,9 +54,6 @@
     AsyncContract,
     Contract,
 )
-from web3.exceptions import (
-    Web3TypeError,
-)
 from web3.providers.eth_tester import (
     AsyncEthereumTesterProvider,
     EthereumTesterProvider,
@@ -64,7 +64,7 @@ def bytes32(val):
     if isinstance(val, int):
         result = Web3.to_bytes(val)
     else:
-        raise Web3TypeError(f"{val!r} could not be converted to bytes")
+        raise ENSTypeError(f"{val!r} could not be converted to bytes")
     if len(result) < 32:
         return result.rjust(32, b"\0")
     else:

tests/ens/test_get_registry.py

@@ -6,12 +6,12 @@
 from ens import (
     ENS,
 )
+from ens.exceptions import (
+    ENSValueError,
+)
 from web3 import (
     Web3,
 )
-from web3.exceptions import (
-    Web3ValueError,
-)
 
 
 def test_resolver_empty(ens):
@@ -42,7 +42,7 @@ def test_reverse_domain(address, expected_reverse, address_conversion_func):
     [
         ("eth", "0x4f5b812789fc606be1b3b16908db13fc7a9adf7ca72641f84d75b47069d3d7f0"),
         ("ETH", "0x4f5b812789fc606be1b3b16908db13fc7a9adf7ca72641f84d75b47069d3d7f0"),
-        ("a.b", Web3ValueError),
+        ("a.b", ENSValueError),
     ],
 )
 def test_labelhash(ens, label, expected_hash):