Make sure all methods got ported to the new layout

Author: kclowes

web3/contract/async_contract.py

@@ -58,6 +58,7 @@
     async_estimate_gas_for_function,
     async_transact_with_contract_function,
     find_functions_by_identifier,
+    get_function_by_identifier,
 )
 from web3.types import (  # noqa: F401
     ABI,
@@ -191,6 +192,12 @@ def find_functions_by_identifier(
             contract_abi, w3, address, callable_check, AsyncContractFunction
         )
 
+    @combomethod
+    def get_function_by_identifier(
+        cls, fns: Sequence[BaseContractFunction], identifier: str
+    ) -> BaseContractFunction:
+        return get_function_by_identifier(fns, identifier)
+
 
 class AsyncContractConstructor(BaseContractConstructor):
     @combomethod

web3/contract/base_contract.py

@@ -99,7 +99,7 @@
     NoABIEventsFound,
     NoABIFound,
     NoABIFunctionsFound,
-    ValidationError,
+    Web3ValidationError,
 )
 from web3.logs import (
     DISCARD,
@@ -218,7 +218,7 @@ def callable_check(fn_abi: ABIFunction) -> bool:
         fns = self.find_functions_by_identifier(
             self.abi, self.w3, self.address, callable_check
         )
-        return get_function_by_identifier(fns, "signature")
+        return self.get_function_by_identifier(fns, "signature")
 
     @combomethod
     def find_functions_by_name(self, fn_name: str) -> "BaseContractFunction":
@@ -232,7 +232,7 @@ def callable_check(fn_abi: ABIFunction) -> bool:
     @combomethod
     def get_function_by_name(self, fn_name: str) -> "BaseContractFunction":
         fns = self.find_functions_by_name(fn_name)
-        return get_function_by_identifier(fns, "name")
+        return self.get_function_by_identifier(fns, "name")
 
     @combomethod
     def get_function_by_selector(
@@ -246,7 +246,7 @@ def callable_check(fn_abi: ABIFunction) -> bool:
         fns = self.find_functions_by_identifier(
             self.abi, self.w3, self.address, callable_check
         )
-        return get_function_by_identifier(fns, "selector")
+        return self.get_function_by_identifier(fns, "selector")
 
     @combomethod
     def decode_function_input(
@@ -279,7 +279,7 @@ def callable_check(fn_abi: ABIFunction) -> bool:
     @combomethod
     def get_function_by_args(self, *args: Any) -> "BaseContractFunction":
         fns = self.find_functions_by_args(*args)
-        return get_function_by_identifier(fns, "args")
+        return self.get_function_by_identifier(fns, "args")
 
     #
     # Private Helpers
@@ -364,6 +364,14 @@ def find_functions_by_identifier(
             "This method should be implemented in the inherited class"
         )
 
+    @combomethod
+    def get_function_by_identifier(
+        cls, fns: Sequence["BaseContractFunction"], identifier: str
+    ) -> "BaseContractFunction":
+        raise NotImplementedError(
+            "This method should be implemented in the inherited class"
+        )
+
     @staticmethod
     def get_fallback_function(
         abi: ABI,
@@ -947,7 +955,7 @@ def _get_event_filter_params(
         blkhash_set = blockHash is not None
         blknum_set = fromBlock is not None or toBlock is not None
         if blkhash_set and blknum_set:
-            raise ValidationError(
+            raise Web3ValidationError(
                 "blockHash cannot be set at the same time as fromBlock or toBlock"
             )
 
@@ -972,6 +980,26 @@ def _get_event_filter_params(
     def factory(cls, class_name: str, **kwargs: Any) -> PropertyCheckingFactory:
         return PropertyCheckingFactory(class_name, (cls,), kwargs)
 
+    @staticmethod
+    def check_for_forbidden_api_filter_arguments(
+        event_abi: ABIEvent, _filters: Dict[str, Any]
+    ) -> None:
+        name_indexed_inputs = {_input["name"]: _input for _input in event_abi["inputs"]}
+
+        for filter_name, filter_value in _filters.items():
+            _input = name_indexed_inputs[filter_name]
+            if is_array_type(_input["type"]):
+                raise TypeError(
+                    "createFilter no longer supports array type filter arguments. "
+                    "see the build_filter method for filtering array type filters."
+                )
+            if is_list_like(filter_value) and is_dynamic_sized_type(_input["type"]):
+                raise TypeError(
+                    "createFilter no longer supports setting filter argument options "
+                    "for dynamic sized types. See the build_filter method for setting "
+                    "filters with the match_any method."
+                )
+
     @combomethod
     def _set_up_filter_builder(
         self,
@@ -994,7 +1022,7 @@ def _set_up_filter_builder(
 
         event_abi = self._get_event_abi()
 
-        check_for_forbidden_api_filter_arguments(event_abi, _filters)
+        self.check_for_forbidden_api_filter_arguments(event_abi, _filters)
 
         _, event_filter_params = construct_event_filter_params(
             self._get_event_abi(),
@@ -1137,35 +1165,3 @@ def call_function(
             block_identifier=block_identifier,
             ccip_read_enabled=ccip_read_enabled,
         )
-
-
-def check_for_forbidden_api_filter_arguments(
-    event_abi: ABIEvent, _filters: Dict[str, Any]
-) -> None:
-    name_indexed_inputs = {_input["name"]: _input for _input in event_abi["inputs"]}
-
-    for filter_name, filter_value in _filters.items():
-        _input = name_indexed_inputs[filter_name]
-        if is_array_type(_input["type"]):
-            raise TypeError(
-                "createFilter no longer supports array type filter arguments. "
-                "see the build_filter method for filtering array type filters."
-            )
-        if is_list_like(filter_value) and is_dynamic_sized_type(_input["type"]):
-            raise TypeError(
-                "createFilter no longer supports setting filter argument options for "
-                "dynamic sized types. See the build_filter method for setting "
-                "filters with the match_any method."
-            )
-
-
-def get_function_by_identifier(
-    fns: Sequence[BaseContractFunction], identifier: str
-) -> BaseContractFunction:
-    if len(fns) > 1:
-        raise ValueError(
-            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}")
-    return fns[0]

web3/contract/contract.py

@@ -57,6 +57,7 @@
     call_contract_function,
     estimate_gas_for_function,
     find_functions_by_identifier,
+    get_function_by_identifier,
     transact_with_contract_function,
 )
 from web3.types import (  # noqa: F401
@@ -312,6 +313,12 @@ def find_functions_by_identifier(
             contract_abi, w3, address, callable_check, ContractFunction
         )
 
+    @combomethod
+    def get_function_by_identifier(
+        cls, fns: Sequence[BaseContractFunction], identifier: str
+    ) -> BaseContractFunction:
+        return get_function_by_identifier(fns, identifier)
+
 
 class ContractConstructor(BaseContractConstructor):
     @combomethod

web3/contract/utils.py

@@ -5,6 +5,7 @@
     Callable,
     List,
     Optional,
+    Sequence,
     Tuple,
     Type,
 )
@@ -246,6 +247,18 @@ def find_functions_by_identifier(
     ]
 
 
+def get_function_by_identifier(
+    fns: Sequence[BaseContractFunction], identifier: str
+) -> BaseContractFunction:
+    if len(fns) > 1:
+        raise ValueError(
+            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}")
+    return fns[0]
+
+
 # --- async --- #