eth-prototype 1.3.0b2__py3-none-any.whl → 1.3.2__py3-none-any.whl

{eth_prototype-1.3.0b2.dist-info → eth_prototype-1.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: eth-prototype
-Version: 1.3.0b2
+Version: 1.3.2
 Summary: Prototype Ethereum Smart Contracts in Python
 Home-page: https://github.com/gnarvaja/eth-prototype
 Author: Guillermo M. Narvaja
@@ -35,6 +35,7 @@ Requires-Dist: pytest-mock; extra == "testing"
 Requires-Dist: pytest-recording; extra == "testing"
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: web3[tester]==7.*; extra == "testing"
+Dynamic: license-file
 
 # eth-prototype
 

eth_prototype-1.3.2.dist-info/RECORD

@@ -0,0 +1,18 @@
+eth_prototype-1.3.2.dist-info/licenses/AUTHORS.rst,sha256=Ui-05yYXtDZxna6o1yNcfdm8Jt68UIDQ01osiLxlYlU,95
+eth_prototype-1.3.2.dist-info/licenses/LICENSE.txt,sha256=U_Q6_nDYDwZPIuhttHi37hXZ2qU2-HlV2geo9hzHXFw,1087
+ethproto/__init__.py,sha256=YWkAFysBp4tZjLWWB2FFmp5yG23pUYhQvgQW9b3soXs,579
+ethproto/aa_bundler.py,sha256=yl-kgLtjIi4ratPquD0B71QtA29SNAwOiIOXNLvxCOk,16780
+ethproto/build_artifacts.py,sha256=whIXEqnh5f89UYu4Cb3KDigGV7juUCbDnfZkg-SYMKA,9878
+ethproto/contracts.py,sha256=rNVbCK1hURy7lWKhzSdXgVWo3wx9O_Ghk-6PfgOsRNk,18662
+ethproto/defender_relay.py,sha256=05A8TfRZwiBhCpo924Pf9CjfKSir2Wvgg1p_asFxJbw,1777
+ethproto/w3wrappers.py,sha256=aA5yQ25d01s8gtWkGSxSEZlVRdq6JM1ceS3cfvSj4uM,22614
+ethproto/wadray.py,sha256=JBsu5KcyU9k70bDK03T2IY6qPVFO30WbYPhwrAHdXao,8262
+ethproto/wrappers.py,sha256=Mj2sgZmcLVmqsnNab6PqIXtNMMPyRVvUj2_8ButEd4w,17304
+ethproto/test_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ethproto/test_utils/factories.py,sha256=G8DnUDG_yThRxMTCkymzcjm9lR_ni0_ZmTsb3sEfIdI,1805
+ethproto/test_utils/hardhat.py,sha256=HzTqIznu6zVd_-doL96ftFJ235ktDCQen1QDQbNuwfM,2361
+ethproto/test_utils/vcr_utils.py,sha256=1FH2sgJlElSjWkJLuO3C7E2J-4HKyFvjAqkCnGRZJyk,797
+eth_prototype-1.3.2.dist-info/METADATA,sha256=vkIpd-qbMF_GtzUe4TW2_rwV9ypTQqxDW3V9uDhtIR8,2650
+eth_prototype-1.3.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+eth_prototype-1.3.2.dist-info/top_level.txt,sha256=Dl0X7m6N1hxeo4JpGpSNqWC2gtsN0731g-DL1J0mpjc,9
+eth_prototype-1.3.2.dist-info/RECORD,,

{eth_prototype-1.3.0b2.dist-info → eth_prototype-1.3.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ethproto/aa_bundler.py

@@ -14,7 +14,7 @@ from eth_utils import add_0x_prefix, function_signature_to_4byte_selector
 from hexbytes import HexBytes
 from web3 import Web3
 from web3.constants import ADDRESS_ZERO
-from web3.types import TxParams
+from web3.types import StateOverride, TxParams
 
 from .contracts import RevertError
 
@@ -30,6 +30,8 @@ AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR = env.float("AA_BUNDLER_PRIORITY_GAS_PRICE_
 AA_BUNDLER_BASE_GAS_PRICE_FACTOR = env.float("AA_BUNDLER_BASE_GAS_PRICE_FACTOR", 1)
 AA_BUNDLER_VERIFICATION_GAS_FACTOR = env.float("AA_BUNDLER_VERIFICATION_GAS_FACTOR", 1)
 
+AA_BUNDLER_STATE_OVERRIDES = env.json("AA_BUNDLER_STATE_OVERRIDES", default={})
+
 NonceMode = Enum(
     "NonceMode",
     [
@@ -41,7 +43,7 @@ NonceMode = Enum(
     ],
 )
 
-AA_BUNDLER_NONCE_MODE = env.enum("AA_BUNDLER_NONCE_MODE", default="FIXED_KEY_LOCAL_NONCE", type=NonceMode)
+AA_BUNDLER_NONCE_MODE = env.enum("AA_BUNDLER_NONCE_MODE", default="FIXED_KEY_LOCAL_NONCE", enum=NonceMode)
 AA_BUNDLER_NONCE_KEY = env.int("AA_BUNDLER_NONCE_KEY", 0)
 AA_BUNDLER_MAX_GETNONCE_RETRIES = env.int("AA_BUNDLER_MAX_GETNONCE_RETRIES", 3)
 
@@ -68,6 +70,16 @@ DUMMY_SIGNATURE = HexBytes(
 )
 
 
+class BundlerRevertError(RevertError):
+    """Bundler specific revert error"""
+
+    def __init__(self, message, userop=None, response=None):
+        super().__init__(message)
+        self.message = message
+        self.userop = userop
+        self.response = response
+
+
 @dataclass(frozen=True)
 class UserOpEstimation:
     """eth_estimateUserOperationGas response"""
@@ -288,11 +300,11 @@ def check_nonce_error(resp, retry_nonce):
     if "AA25" in resp["error"]["message"] and AA_BUNDLER_MAX_GETNONCE_RETRIES > 0:
         # Retry fetching the nonce
         if retry_nonce == AA_BUNDLER_MAX_GETNONCE_RETRIES:
-            raise RevertError(resp["error"]["message"])
+            raise BundlerRevertError(resp["error"]["message"], response=resp)
         warn(f'{resp["error"]["message"]} error, I will retry fetching the nonce')
         return (retry_nonce or 0) + 1
     else:
-        raise RevertError(resp["error"]["message"])
+        raise BundlerRevertError(resp["error"]["message"], response=resp)
 
 
 def get_sender(tx):
@@ -318,6 +330,7 @@ class Bundler:
         priority_gas_price_factor: float = AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR,
         base_gas_price_factor: float = AA_BUNDLER_BASE_GAS_PRICE_FACTOR,
         executor_pk: HexBytes = AA_BUNDLER_EXECUTOR_PK,
+        overrides: StateOverride = AA_BUNDLER_STATE_OVERRIDES,
     ):
         self.w3 = w3
         self.bundler = Web3(Web3.HTTPProvider(bundler_url), middleware=[])
@@ -331,11 +344,15 @@ class Bundler:
         self.base_gas_price_factor = base_gas_price_factor
         self.executor_pk = executor_pk
 
+        # stateOverrideSet mapping to use when calling eth_estimateUserOperationGas
+        # https://docs.alchemy.com/reference/eth-estimateuseroperationgas
+        self.overrides = overrides
+
     def __str__(self):
         return (
-            f"Bundler(type={self.bundler_type}, entrypoint={self.entrypoint}, nonce_mode={self.nonce_mode}"
-            f"fixed_nonce_key={self.fixed_nonce_key}, verification_gas_factor={self.verification_gas_factor},"
-            f"gas_limit_factor={self.gas_limit_factor}, priority_gas_price_factor={self.priority_gas_price_factor},"
+            f"Bundler(type={self.bundler_type}, entrypoint={self.entrypoint}, nonce_mode={self.nonce_mode}, "
+            f"fixed_nonce_key={self.fixed_nonce_key}, verification_gas_factor={self.verification_gas_factor}, "
+            f"gas_limit_factor={self.gas_limit_factor}, priority_gas_price_factor={self.priority_gas_price_factor}, "
             f"base_gas_price_factor={self.base_gas_price_factor})"
         )
 
@@ -364,10 +381,11 @@ class Bundler:
 
     def estimate_user_operation_gas(self, user_operation: UserOperation) -> UserOpEstimation:
         resp = self.bundler.provider.make_request(
-            "eth_estimateUserOperationGas", [user_operation.as_reduced_dict(), self.entrypoint]
+            "eth_estimateUserOperationGas",
+            [user_operation.as_reduced_dict(), self.entrypoint, self.overrides],
         )
         if "error" in resp:
-            raise RevertError(resp["error"]["message"])
+            raise BundlerRevertError(resp["error"]["message"], user_operation, resp)
 
         paymaster_verification_gas_limit = resp["result"].get("paymasterVerificationGasLimit", "0x00")
         return UserOpEstimation(
@@ -386,7 +404,7 @@ class Bundler:
     def alchemy_gas_price(self):
         resp = self.bundler.provider.make_request("rundler_maxPriorityFeePerGas", [])
         if "error" in resp:
-            raise RevertError(resp["error"]["message"])
+            raise BundlerRevertError(resp["error"]["message"], response=resp)
         max_priority_fee_per_gas = int(int(resp["result"], 16) * self.priority_gas_price_factor)
         max_fee_per_gas = max_priority_fee_per_gas + self.get_base_fee()
 
@@ -424,7 +442,14 @@ class Bundler:
             "eth_sendUserOperation", [user_operation.as_dict(), self.entrypoint]
         )
         if "error" in resp:
-            next_nonce = check_nonce_error(resp, retry_nonce)
+            try:
+                next_nonce = check_nonce_error(resp, retry_nonce)
+            except BundlerRevertError as e:
+                raise BundlerRevertError(
+                    e.message,
+                    userop=user_operation,
+                    response=e.response,
+                )
             return self.send_transaction(tx, retry_nonce=next_nonce)
 
         return {"userOpHash": resp["result"]}

ethproto/build_artifacts.py

@@ -6,10 +6,14 @@ import os.path
 import re
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Union, Tuple
+from typing import Tuple, Union
 
 LIBRARY_PLACEHOLDER_MATCHER = re.compile(r"__\$[0-9a-f]{34}\$__")
 
+CONTRACT_REF_MATCHER = re.compile(r"^(?:(?P<package>.*)/)?(?P<contract>[^@]+)(?:@(?P<version>.+))?$")
+
+VERSION_MATCHER = re.compile(r"^\d+\.\d+\.\d+$")
+
 
 @dataclass
 class Artifact:
@@ -94,6 +98,7 @@ class ArtifactLibrary:
         self.lookup_paths = [Path(p).absolute() for p in paths]
         self._fullpath_cache = {}
         self._name_cache = {}
+        self._ref_cache = None
 
     def get_artifact(self, contract: str) -> Artifact:
         """Returns a build artifact by full contract path
@@ -139,3 +144,115 @@ class ArtifactLibrary:
                 raise FileNotFoundError(f"Could not find artifact for {contract_name} on {self.lookup_paths}")
 
         return self._name_cache[contract_name]
+
+    def _load_ref_cache(self):
+        self._ref_cache = {}
+        for path in self.lookup_paths:
+            path = Path(path)
+            json_files = path.rglob("*.json")
+
+            for json_file in json_files:
+                # Skip build-info and debug files
+                if json_file.parent.stem == "build-info" or json_file.stem.endswith(".dbg"):
+                    continue
+
+                parts = json_file.parts[len(path.parts) - 1 :]
+
+                # Find the first parent named either "build" or "artifacts"
+                try:
+                    build_idx = next(i for i, part in enumerate(parts) if part in ("build", "artifacts"))
+                except StopIteration:
+                    continue
+
+                if build_idx == 0:
+                    # Our lookup path is already a build directory, we're probably looking at a hardhat build output
+                    version = "local"
+                else:
+                    # If we have a version number right before the build directory, we're probably looking at a
+                    # verifiable binaries directory
+                    version = parts[build_idx - 1]
+                    if not VERSION_MATCHER.match(version):
+                        version = "local"
+
+                if version == "local":
+                    # For hardhat output dir, package is everything up to "contracts"
+                    try:
+                        package = "/".join(parts[build_idx + 1 : parts.index("contracts")])
+                    except ValueError:
+                        # There are exceptions, like @openzeppelin/contracts-upgradeable
+                        # For those the package is everythin up to the contract directory
+                        package = "/".join(parts[build_idx + 1 : -2])
+
+                else:
+                    # For verifiable binaries dir, package is everything up to version
+                    package = "/".join(parts[1 : build_idx - 1])
+
+                if json_file.stem not in self._ref_cache:
+                    self._ref_cache[json_file.stem] = []
+                self._ref_cache[json_file.stem].append(
+                    {
+                        "path": json_file,
+                        "package": package,
+                        "version": version,
+                    }
+                )
+
+    def _find_ref(self, contract_ref: str):
+        if self._ref_cache is None:
+            self._load_ref_cache()
+
+        ref_match = CONTRACT_REF_MATCHER.match(contract_ref)
+        if not ref_match:
+            raise ValueError(f"Invalid contract reference: {contract_ref}")
+
+        contract = ref_match.group("contract")
+        if contract not in self._ref_cache:
+            return None
+
+        ref = self._ref_cache[contract]
+
+        package = ref_match.group("package")
+        if package:
+            ref = [r for r in ref if r["package"] == package]
+
+        version = ref_match.group("version")
+        if version:
+            ref = [r for r in ref if r["version"] == version]
+
+        if not ref:
+            return None
+
+        # Sort by version ascending, forcing local to be last
+        ref = sorted(
+            ref,
+            key=lambda x: (
+                x["version"] == "local",
+                tuple(map(int, x["version"].split("."))) if x["version"] != "local" else None,
+            ),
+        )[-1]
+
+        return ref
+
+    def get_artifact_by_ref(self, contract_ref: str) -> Artifact:
+        """Returns a build artifact by looking for a matching contract reference.
+
+        This is compatible with the verifiable binaries structure.
+
+        Accepts the following kind of references:
+
+        - <ContractClass>
+        - <ContractClass>@<version>
+        - <package>/<ContractClass>
+        - <package>/<ContractClass>@<version>
+
+        If version is not specified it uses the latest version available.
+
+        Calling with contract_ref <ContractClass>@local is the same as calling get_artifact_by_name(<ContractClass>).
+        """
+        ref = self._find_ref(contract_ref)
+
+        if ref is None:
+            raise FileNotFoundError(f"Could not find artifact for {contract_ref} on {self.lookup_paths}")
+
+        with open(ref["path"]) as f:
+            return Artifact(**json.load(f))

ethproto/w3wrappers.py

@@ -5,9 +5,10 @@ from typing import Iterator, List, Union
 from environs import Env
 from eth_account.account import Account, LocalAccount
 from eth_account.signers.base import BaseAccount
-from eth_utils.abi import event_abi_to_log_topic
+from eth_utils import add_0x_prefix, event_abi_to_log_topic
 from hexbytes import HexBytes
 from web3.contract import Contract
+from web3.contract.contract import ContractEvent
 from web3.exceptions import ContractLogicError, ExtraDataLengthError
 from web3.middleware import ExtraDataToPOAMiddleware
 
@@ -437,7 +438,7 @@ class W3Provider(BaseProvider):
         self.tx_kwargs = tx_kwargs or {}
 
     def get_contract_def(self, eth_contract):
-        return self.artifact_library.get_artifact_by_name(eth_contract)
+        return self.artifact_library.get_artifact_by_ref(eth_contract)
 
     def get_contract_factory(self, eth_contract):
         contract_def = self.get_contract_def(eth_contract)
@@ -448,7 +449,9 @@ class W3Provider(BaseProvider):
         kwargs["from"] = from_
         return self.construct(factory, init_params, kwargs)
 
-    def get_events(self, eth_wrapper, event_name, filter_kwargs={}):
+    def get_events(
+        self, eth_wrapper, event_names: Union[list[Union[str, ContractEvent]], str], filter_kwargs=None
+    ):
         """Returns a list of events given a filter, like this:
 
         >>> provider.get_events(currencywrapper, "Transfer", dict(from_block=0))
@@ -468,12 +471,36 @@ class W3Provider(BaseProvider):
             'blockNumber': 23
         })]
         """
-        contract = eth_wrapper.contract
-        event = getattr(contract.events, event_name)
-        if "from_block" not in filter_kwargs:
-            filter_kwargs["from_block"] = self.get_first_block(eth_wrapper)
-        event_filter = event.create_filter(**filter_kwargs)
-        return event_filter.get_all_entries()
+        if filter_kwargs is None:
+            filter_kwargs = {}
+
+        if isinstance(event_names, (str, ContractEvent)):
+            # Backwards compatibility, if we don't get a list we're getting a single event name/ref
+            event_names = [event_names]
+
+        topics = {}
+
+        for name in event_names:
+            if isinstance(name, str):
+                # We got a plain event name, let's get the event from the contract
+                event: ContractEvent = getattr(eth_wrapper.contract.events, name)
+            else:
+                # Assume we already got an event reference
+                event: ContractEvent = name
+
+            topics[event.topic] = event
+
+        filter_params = {
+            "fromBlock": filter_kwargs.get("from_block", self.get_first_block(eth_wrapper)),
+            "toBlock": filter_kwargs.get("to_block", "latest"),
+            "address": eth_wrapper.contract.address,
+            "topics": [list(topics.keys())],
+        }
+
+        logs = self.w3.eth.get_logs(filter_params)
+
+        parsed_events = [topics[add_0x_prefix(log["topics"][0].hex())].process_log(log) for log in logs]
+        return parsed_events
 
     def init_eth_wrapper(self, eth_wrapper, owner, init_params, kwargs):
         eth_wrapper.owner = self.address_book.get_account(owner)

eth_prototype-1.3.0b2.dist-info/RECORD

@@ -1,18 +0,0 @@
-ethproto/__init__.py,sha256=YWkAFysBp4tZjLWWB2FFmp5yG23pUYhQvgQW9b3soXs,579
-ethproto/aa_bundler.py,sha256=HupCu7fRCwlE556WXDqytRU5GEFLdBoFYzjpqDHBtE4,15789
-ethproto/build_artifacts.py,sha256=xwCd5hJUHP82IA-y3sSfX6fV15kjCGtV19RxNRcoor0,5441
-ethproto/contracts.py,sha256=rNVbCK1hURy7lWKhzSdXgVWo3wx9O_Ghk-6PfgOsRNk,18662
-ethproto/defender_relay.py,sha256=05A8TfRZwiBhCpo924Pf9CjfKSir2Wvgg1p_asFxJbw,1777
-ethproto/w3wrappers.py,sha256=lmyfJLhQmPYrclmbzzsthH2cShlQb6LwavKq30jqxFE,21651
-ethproto/wadray.py,sha256=JBsu5KcyU9k70bDK03T2IY6qPVFO30WbYPhwrAHdXao,8262
-ethproto/wrappers.py,sha256=Mj2sgZmcLVmqsnNab6PqIXtNMMPyRVvUj2_8ButEd4w,17304
-ethproto/test_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ethproto/test_utils/factories.py,sha256=G8DnUDG_yThRxMTCkymzcjm9lR_ni0_ZmTsb3sEfIdI,1805
-ethproto/test_utils/hardhat.py,sha256=HzTqIznu6zVd_-doL96ftFJ235ktDCQen1QDQbNuwfM,2361
-ethproto/test_utils/vcr_utils.py,sha256=1FH2sgJlElSjWkJLuO3C7E2J-4HKyFvjAqkCnGRZJyk,797
-eth_prototype-1.3.0b2.dist-info/AUTHORS.rst,sha256=Ui-05yYXtDZxna6o1yNcfdm8Jt68UIDQ01osiLxlYlU,95
-eth_prototype-1.3.0b2.dist-info/LICENSE.txt,sha256=U_Q6_nDYDwZPIuhttHi37hXZ2qU2-HlV2geo9hzHXFw,1087
-eth_prototype-1.3.0b2.dist-info/METADATA,sha256=VGLInjZc46w_OraflEsO2vG9yXmA_crJL0DVP5dFLvM,2630
-eth_prototype-1.3.0b2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-eth_prototype-1.3.0b2.dist-info/top_level.txt,sha256=Dl0X7m6N1hxeo4JpGpSNqWC2gtsN0731g-DL1J0mpjc,9
-eth_prototype-1.3.0b2.dist-info/RECORD,,