get_event_data, get_function_info utilities available via public API

Author: Stuart Reed

tests/core/contracts/test_contract_function_info.py

@@ -0,0 +1,57 @@
+import pytest
+
+from web3.contract.utils import (
+    get_function_info,
+)
+
+
+def get_contract_fn_abi(fn_name, args, kwargs, contract_abi):
+    fn_abis_with_name = [abi for abi in contract_abi if abi["name"] == fn_name]
+
+    # match function by args
+    if len(args) > 0:
+        for abi in fn_abis_with_name:
+            if len(abi["inputs"]) == len(args):
+                return abi
+
+    # match function by kwargs
+    if len(kwargs.keys()) > 0:
+        for abi in fn_abis_with_name:
+            inputs = [input["name"] for input in abi["inputs"]]
+            if set(inputs) == kwargs.keys():
+                return abi
+
+    return fn_abis_with_name[0]
+
+
+@pytest.mark.parametrize(
+    "fn_name,args,kwargs,fn_selector,fn_arguments",
+    [
+        ("add", (1, 2), {}, "0xa5f3c23b", (1, 2)),
+        ("counter", (), {}, "0x61bc221a", ()),
+        ("incrementCounter", (), {}, "0x5b34b966", ()),
+        ("incrementCounter", (), {"amount": 1}, "0x6abbb3b4", (1,)),
+        ("incrementCounter", (1,), {}, "0x6abbb3b4", (1,)),
+        ("multiply7", (100,), {}, "0xdcf537b1", (100,)),
+        ("return13", (), {}, "0x16216f39", ()),
+    ],
+)
+def test_get_function_info_for_math_contract(
+    w3, math_contract_abi, fn_name, args, kwargs, fn_selector, fn_arguments
+):
+    fn_info_abi, fn_info_selector, fn_info_arguments = get_function_info(
+        # fn_info = get_function_info(
+        fn_name,
+        w3.codec,
+        contract_abi=math_contract_abi,
+        args=args,
+        kwargs=kwargs,
+    )
+
+    # Identify abi for fn_name from math_contract_abi
+    fn_abi = get_contract_fn_abi(fn_name, args, kwargs, math_contract_abi)
+
+    assert fn_info_abi == fn_abi
+    assert fn_info_selector == fn_selector
+    assert len(fn_info_arguments) == len(fn_arguments)
+    assert fn_info_arguments == fn_arguments

tests/core/contracts/test_extracting_event_data.py

@@ -8,7 +8,7 @@
     dissoc,
 )
 
-from web3._utils.events import (
+from web3.contract.utils import (
     get_event_data,
 )
 from web3.exceptions import (

tests/core/contracts/test_extracting_event_data_old.py

@@ -4,7 +4,7 @@
     is_same_address,
 )
 
-from web3._utils.events import (
+from web3.contract.utils import (
     get_event_data,
 )
 

web3/contract/async_contract.py

@@ -45,7 +45,6 @@
 )
 from web3._utils.events import (
     AsyncEventFilterBuilder,
-    get_event_data,
 )
 from web3._utils.filters import (
     AsyncLogFilter,
@@ -76,6 +75,7 @@
     async_estimate_gas_for_function,
     async_transact_with_contract_function,
     find_functions_by_identifier,
+    get_event_data,
     get_function_by_identifier,
 )
 from web3.exceptions import (

web3/contract/base_contract.py

@@ -65,7 +65,6 @@
 from web3._utils.events import (
     AsyncEventFilterBuilder,
     EventFilterBuilder,
-    get_event_data,
     is_dynamic_sized_type,
 )
 from web3._utils.filters import (
@@ -78,6 +77,9 @@
 from web3._utils.normalizers import (
     BASE_RETURN_NORMALIZERS,
 )
+from web3.contract.utils import (
+    get_event_data,
+)
 from web3.datastructures import (
     AttributeDict,
     MutableAttributeDict,

web3/contract/contract.py

@@ -41,7 +41,6 @@
 )
 from web3._utils.events import (
     EventFilterBuilder,
-    get_event_data,
 )
 from web3._utils.filters import (
     LogFilter,
@@ -74,6 +73,7 @@
     call_contract_function,
     estimate_gas_for_function,
     find_functions_by_identifier,
+    get_event_data,
     get_function_by_identifier,
     transact_with_contract_function,
 )

web3/contract/utils.py

@@ -11,11 +11,18 @@
     Union,
 )
 
+from eth_abi.codec import (
+    ABICodec,
+)
 from eth_abi.exceptions import (
     DecodingError,
 )
 from eth_typing import (
     ChecksumAddress,
+    HexStr,
+)
+from eth_utils.toolz import (
+    curry,
 )
 from hexbytes import (
     HexBytes,
@@ -33,8 +40,12 @@
 )
 from web3._utils.contracts import (
     find_matching_fn_abi,
+    get_function_info as _get_function_info,
     prepare_transaction,
 )
+from web3._utils.events import (
+    get_event_data as _get_event_data,
+)
 from web3._utils.normalizers import (
     BASE_RETURN_NORMALIZERS,
 )
@@ -46,9 +57,12 @@
 )
 from web3.types import (
     ABI,
+    ABIEvent,
     ABIFunction,
     BlockIdentifier,
+    EventData,
     FunctionIdentifier,
+    LogReceipt,
     StateOverride,
     TContractFn,
     TxParams,
@@ -269,6 +283,26 @@ def get_function_by_identifier(
     return fns[0]
 
 
+def get_function_info(
+    fn_name: str,
+    abi_codec: ABICodec,
+    contract_abi: Optional[ABI] = None,
+    fn_abi: Optional[ABIFunction] = None,
+    args: Optional[Sequence[Any]] = None,
+    kwargs: Optional[Any] = None,
+) -> Tuple[ABIFunction, HexStr, Tuple[Any, ...]]:
+    return _get_function_info(fn_name, abi_codec, contract_abi, fn_abi, args, kwargs)
+
+
+@curry
+def get_event_data(
+    abi_codec: ABICodec,
+    event_abi: ABIEvent,
+    log_entry: LogReceipt,
+) -> EventData:
+    return _get_event_data(abi_codec, event_abi, log_entry)
+
+
 # --- async --- #