web3 6.20.2__py3-none-any.whl → 7.0.0__py3-none-any.whl

web3/contract/contract.py

@@ -13,10 +13,13 @@ from typing import (
 )
 
 from eth_typing import (
+    ABI,
     ChecksumAddress,
 )
 from eth_utils import (
     combomethod,
+    get_abi_input_names,
+    get_all_function_abis,
 )
 from eth_utils.toolz import (
     partial,
@@ -27,9 +30,12 @@ from hexbytes import (
 
 from web3._utils.abi import (
     fallback_func_abi_exists,
-    filter_by_type,
     receive_func_abi_exists,
 )
+from web3._utils.abi_element_identifiers import (
+    FallbackFn,
+    ReceiveFn,
+)
 from web3._utils.compat import (
     Self,
 )
@@ -46,10 +52,6 @@ from web3._utils.events import (
 from web3._utils.filters import (
     LogFilter,
 )
-from web3._utils.function_identifiers import (
-    FallbackFn,
-    ReceiveFn,
-)
 from web3._utils.normalizers import (
     normalize_abi,
     normalize_address,
@@ -81,18 +83,17 @@ from web3.exceptions import (
     ABIFunctionNotFound,
     NoABIFound,
     NoABIFunctionsFound,
+    Web3AttributeError,
+    Web3TypeError,
     Web3ValidationError,
+    Web3ValueError,
 )
 from web3.types import (
-    ABI,
     BlockIdentifier,
-    CallOverride,
     EventData,
+    StateOverride,
     TxParams,
 )
-from web3.utils import (
-    get_abi_input_names,
-)
 
 if TYPE_CHECKING:
     from ens import ENS  # noqa: F401
@@ -107,11 +108,12 @@ class ContractEvent(BaseContractEvent):
     def get_logs(
         self,
         argument_filters: Optional[Dict[str, Any]] = None,
-        fromBlock: Optional[BlockIdentifier] = None,
-        toBlock: Optional[BlockIdentifier] = None,
+        from_block: Optional[BlockIdentifier] = None,
+        to_block: Optional[BlockIdentifier] = None,
         block_hash: Optional[HexBytes] = None,
     ) -> Iterable[EventData]:
-        """Get events for this contract instance using eth_getLogs API.
+        """
+        Get events for this contract instance using eth_getLogs API.
 
         This is a stateless method, as opposed to create_filter.
         It can be safely called against nodes which do not provide
@@ -127,10 +129,10 @@ class ContractEvent(BaseContractEvent):
 
         .. code-block:: python
 
-            from = max(mycontract.web3.eth.block_number - 10, 1)
-            to = mycontract.web3.eth.block_number
+            from = max(my_contract.web3.eth.block_number - 10, 1)
+            to = my_contract.web3.eth.block_number
 
-            events = mycontract.events.Transfer.get_logs(fromBlock=from, toBlock=to)
+            events = my_contract.events.Transfer.get_logs(from_block=from, to_block=to)
 
             for e in events:
                 print(e["args"]["from"],
@@ -156,14 +158,14 @@ class ContractEvent(BaseContractEvent):
                 ...
             )
 
-        See also: :func:`web3.middleware.filter.local_filter_middleware`.
+        See also: :func:`web3.middleware.filter.LocalFilterMiddleware`.
 
         :param argument_filters: Filter by argument values. Indexed arguments are
           filtered by the node while non-indexed arguments are filtered by the library.
-        :param fromBlock: block number or "latest", defaults to "latest"
-        :param toBlock: block number or "latest". Defaults to "latest"
+        :param from_block: block number or "latest", defaults to "latest"
+        :param to_block: block number or "latest". Defaults to "latest"
         :param block_hash: block hash. block_hash cannot be set at the
-          same time as fromBlock or toBlock
+          same time as ``from_block`` or ``to_block``
         :yield: Tuple of :class:`AttributeDict` instances
         """
         event_abi = self._get_event_abi()
@@ -178,7 +180,7 @@ class ContractEvent(BaseContractEvent):
                 )
 
         _filter_params = self._get_event_filter_params(
-            event_abi, argument_filters, fromBlock, toBlock, block_hash
+            event_abi, argument_filters, from_block, to_block, block_hash
         )
         # call JSON-RPC API
         logs = self.w3.eth.get_logs(_filter_params)
@@ -192,15 +194,17 @@ class ContractEvent(BaseContractEvent):
             all_event_logs,
             argument_filters,
         )
-        return filtered_logs
+        sorted_logs = sorted(filtered_logs, key=lambda e: e["logIndex"])
+        sorted_logs = sorted(sorted_logs, key=lambda e: e["blockNumber"])
+        return sorted_logs
 
     @combomethod
     def create_filter(
         self,
         *,  # PEP 3102
         argument_filters: Optional[Dict[str, Any]] = None,
-        fromBlock: Optional[BlockIdentifier] = None,
-        toBlock: BlockIdentifier = "latest",
+        from_block: Optional[BlockIdentifier] = None,
+        to_block: BlockIdentifier = "latest",
         address: Optional[ChecksumAddress] = None,
         topics: Optional[Sequence[Any]] = None,
     ) -> LogFilter:
@@ -210,8 +214,8 @@ class ContractEvent(BaseContractEvent):
         filter_builder = EventFilterBuilder(self._get_event_abi(), self.w3.codec)
         self._set_up_filter_builder(
             argument_filters,
-            fromBlock,
-            toBlock,
+            from_block,
+            to_block,
             address,
             topics,
             filter_builder,
@@ -268,7 +272,7 @@ class ContractFunction(BaseContractFunction):
         self,
         transaction: Optional[TxParams] = None,
         block_identifier: BlockIdentifier = None,
-        state_override: Optional[CallOverride] = None,
+        state_override: Optional[StateOverride] = None,
         ccip_read_enabled: Optional[bool] = None,
     ) -> Any:
         """
@@ -306,7 +310,7 @@ class ContractFunction(BaseContractFunction):
             self.w3,
             self.address,
             self._return_data_normalizers,
-            self.function_identifier,
+            self.abi_element_identifier,
             call_transaction,
             block_id,
             self.contract_abi,
@@ -323,7 +327,7 @@ class ContractFunction(BaseContractFunction):
         return transact_with_contract_function(
             self.address,
             self.w3,
-            self.function_identifier,
+            self.abi_element_identifier,
             setup_transaction,
             self.contract_abi,
             self.abi,
@@ -335,13 +339,13 @@ class ContractFunction(BaseContractFunction):
         self,
         transaction: Optional[TxParams] = None,
         block_identifier: Optional[BlockIdentifier] = None,
-        state_override: Optional[CallOverride] = None,
+        state_override: Optional[StateOverride] = None,
     ) -> int:
         setup_transaction = self._estimate_gas(transaction)
         return estimate_gas_for_function(
             self.address,
             self.w3,
-            self.function_identifier,
+            self.abi_element_identifier,
             setup_transaction,
             self.contract_abi,
             self.abi,
@@ -356,7 +360,7 @@ class ContractFunction(BaseContractFunction):
         return build_transaction_for_function(
             self.address,
             self.w3,
-            self.function_identifier,
+            self.abi_element_identifier,
             built_transaction,
             self.contract_abi,
             self.abi,
@@ -376,7 +380,7 @@ class ContractFunction(BaseContractFunction):
                 w3=w3,
                 contract_abi=abi,
                 address=address,
-                function_identifier=FallbackFn,
+                abi_element_identifier=FallbackFn,
             )()
         return cast(ContractFunction, NonExistentFallbackFunction())
 
@@ -392,7 +396,7 @@ class ContractFunction(BaseContractFunction):
                 w3=w3,
                 contract_abi=abi,
                 address=address,
-                function_identifier=ReceiveFn,
+                abi_element_identifier=ReceiveFn,
             )()
         return cast(ContractFunction, NonExistentReceiveFunction())
 
@@ -436,11 +440,13 @@ class Contract(BaseContract):
     events: ContractEvents = None
 
     def __init__(self, address: Optional[ChecksumAddress] = None) -> None:
-        """Create a new smart contract proxy object.
-        :param address: Contract address as 0x hex string"""
+        """
+        Create a new smart contract proxy object.
+        :param address: Contract address as 0x hex string
+        """
         _w3 = self.w3
         if _w3 is None:
-            raise AttributeError(
+            raise Web3AttributeError(
                 "The `Contract` class has not been initialized.  Please use the "
                 "`web3.contract` interface to create your contract class."
             )
@@ -449,7 +455,7 @@ class Contract(BaseContract):
             self.address = normalize_address(cast("ENS", _w3.ens), address)
 
         if not self.address:
-            raise TypeError(
+            raise Web3TypeError(
                 "The address argument is required to instantiate a contract."
             )
 
@@ -526,7 +532,7 @@ class Contract(BaseContract):
         :return: a contract constructor object
         """
         if cls.bytecode is None:
-            raise ValueError(
+            raise Web3ValueError(
                 "Cannot call constructor on a contract that does not have "
                 "'bytecode' associated with it"
             )
@@ -575,23 +581,23 @@ class ContractCaller(BaseContractCaller):
             if transaction is None:
                 transaction = {}
 
-            self._functions = filter_by_type("function", self.abi)
+            self._functions = get_all_function_abis(self.abi)
+
             for func in self._functions:
                 fn = ContractFunction.factory(
                     func["name"],
                     w3=w3,
                     contract_abi=self.abi,
                     address=self.address,
-                    function_identifier=func["name"],
+                    abi_element_identifier=func["name"],
                     decode_tuples=decode_tuples,
                 )
 
-                block_id = parse_block_identifier(w3, block_identifier)
                 caller_method = partial(
                     self.call_function,
                     fn,
                     transaction=transaction,
-                    block_identifier=block_id,
+                    block_identifier=block_identifier,
                     ccip_read_enabled=ccip_read_enabled,
                 )