Docs

Author: Stuart Reed

docs/web3.contract.rst

@@ -1178,6 +1178,17 @@ Utils
           '_debatingPeriod': 604800,
           '_newCurator': True})
 
+.. py:module:: web3.contract.utils
+
+.. py:method:: utils.get_event_data(abi_codec, event_abi log_entry)
+
+    Get decoded event data from a log entry using an event ABI.
+
+.. py:method:: utils.get_function_info(fn_name, abi_codec, contract_abi, fn_abi, args, kwargs)
+
+    Get function signature and information from a contract ABI given a name, contract ABI, function ABI, and arguments.
+
+
 ContractCaller
 --------------
 

web3/contract/utils.py

@@ -291,6 +291,10 @@ def get_function_info(
     args: Optional[Sequence[Any]] = None,
     kwargs: Optional[Any] = None,
 ) -> Tuple[ABIFunction, HexStr, Tuple[Any, ...]]:
+    """
+    Given a function name, contract ABI, function ABI, and function arguments
+    return the contract function ABI, selector and arguments
+    """
     return _get_function_info(fn_name, abi_codec, contract_abi, fn_abi, args, kwargs)
 
 
@@ -300,6 +304,10 @@ def get_event_data(
     event_abi: ABIEvent,
     log_entry: LogReceipt,
 ) -> EventData:
+    """
+    Given an event ABI and a log entry for that event, return the decoded
+    event data
+    """
     return _get_event_data(abi_codec, event_abi, log_entry)