eth-prototype 1.1.0__py3-none-any.whl → 1.1.2__py3-none-any.whl

{eth_prototype-1.1.0.dist-info → eth_prototype-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eth-prototype
-Version: 1.1.0
+Version: 1.1.2
 Summary: Prototype Ethereum Smart Contracts in Python
 Home-page: https://github.com/gnarvaja/eth-prototype
 Author: Guillermo M. Narvaja

eth_prototype-1.1.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+ethproto/__init__.py,sha256=YWkAFysBp4tZjLWWB2FFmp5yG23pUYhQvgQW9b3soXs,579
+ethproto/aa_bundler.py,sha256=wWUa-uqTvDKUI7ewxfCQzUsVxIPhu7N-kSHu-_aXtJ4,10495
+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=0lm-h-3QpoKK54HvQ66hm_fbaVRy6QFuzedTks3FeFA,21245
+ethproto/wadray.py,sha256=JBsu5KcyU9k70bDK03T2IY6qPVFO30WbYPhwrAHdXao,8262
+ethproto/wrappers.py,sha256=9qDwRDOXw3wquzvGfIsub-VPWm98GBWP7dHLFOUPWzg,17307
+eth_prototype-1.1.2.dist-info/AUTHORS.rst,sha256=Ui-05yYXtDZxna6o1yNcfdm8Jt68UIDQ01osiLxlYlU,95
+eth_prototype-1.1.2.dist-info/LICENSE.txt,sha256=U_Q6_nDYDwZPIuhttHi37hXZ2qU2-HlV2geo9hzHXFw,1087
+eth_prototype-1.1.2.dist-info/METADATA,sha256=Iao560GckmPsEsXAtt1Cm8wEZwElZvzucStqIiTGP9k,2482
+eth_prototype-1.1.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+eth_prototype-1.1.2.dist-info/top_level.txt,sha256=Dl0X7m6N1hxeo4JpGpSNqWC2gtsN0731g-DL1J0mpjc,9
+eth_prototype-1.1.2.dist-info/RECORD,,

{eth_prototype-1.1.0.dist-info → eth_prototype-1.1.2.dist-info}/WHEEL

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

ethproto/aa_bundler.py

@@ -1,15 +1,18 @@
 import random
-from warnings import warn
+from collections import defaultdict
 from enum import Enum
-import requests
+from threading import local
+from warnings import warn
+
 from environs import Env
 from eth_abi import encode
 from eth_account import Account
 from eth_account.messages import encode_defunct
 from hexbytes import HexBytes
 from web3 import Web3
-from .contracts import RevertError
+from web3.constants import ADDRESS_ZERO
 
+from .contracts import RevertError
 
 env = Env()
 
@@ -17,6 +20,10 @@ AA_BUNDLER_SENDER = env.str("AA_BUNDLER_SENDER", None)
 AA_BUNDLER_ENTRYPOINT = env.str("AA_BUNDLER_ENTRYPOINT", "0x0000000071727De22E5E9d8BAf0edAc6f37da032")
 AA_BUNDLER_EXECUTOR_PK = env.str("AA_BUNDLER_EXECUTOR_PK", None)
 AA_BUNDLER_PROVIDER = env.str("AA_BUNDLER_PROVIDER", "alchemy")
+AA_BUNDLER_GAS_LIMIT_FACTOR = env.float("AA_BUNDLER_GAS_LIMIT_FACTOR", 1)
+AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR = env.float("AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR", 1)
+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)
 
 NonceMode = Enum(
     "NonceMode",
@@ -46,8 +53,8 @@ GET_NONCE_ABI = [
     }
 ]
 
-NONCE_CACHE = {}
-RANDOM_NONCE_KEY = None
+NONCE_CACHE = defaultdict(lambda: 0)
+RANDOM_NONCE_KEY = local()
 
 
 def pack_two(a, b):
@@ -64,6 +71,10 @@ def _to_uint(x):
     raise RuntimeError(f"Invalid int value {x}")
 
 
+def apply_factor(x, factor):
+    return int(_to_uint(x) * factor)
+
+
 def pack_user_operation(user_operation):
     # https://github.com/eth-infinitism/account-abstraction/blob/develop/contracts/interfaces/PackedUserOperation.sol
     return {
@@ -129,10 +140,9 @@ def fetch_nonce(w3, account, entry_point, nonce_key):
 
 
 def get_random_nonce_key():
-    global RANDOM_NONCE_KEY
-    if RANDOM_NONCE_KEY is None:
-        RANDOM_NONCE_KEY = random.randint(1, 2**192 - 1)
-    return RANDOM_NONCE_KEY
+    if getattr(RANDOM_NONCE_KEY, "key", None) is None:
+        RANDOM_NONCE_KEY.key = random.randint(1, 2**192 - 1)
+    return RANDOM_NONCE_KEY.key
 
 
 def get_nonce_and_key(w3, tx, nonce_mode, entry_point=AA_BUNDLER_ENTRYPOINT, fetch=False):
@@ -147,31 +157,45 @@ def get_nonce_and_key(w3, tx, nonce_mode, entry_point=AA_BUNDLER_ENTRYPOINT, fet
 
     if nonce is None:
         if fetch or nonce_mode == NonceMode.FIXED_KEY_FETCH_ALWAYS:
-            nonce = fetch_nonce(w3, tx.get("from", AA_BUNDLER_SENDER), entry_point, nonce_key)
-        elif nonce_key not in NONCE_CACHE:
-            nonce = 0
+            nonce = fetch_nonce(w3, get_sender(tx), entry_point, nonce_key)
         else:
             nonce = NONCE_CACHE[nonce_key]
     return nonce_key, nonce
 
 
-def handle_response_error(resp, w3, tx, retry_nonce):
+def consume_nonce(nonce_key, nonce):
+    NONCE_CACHE[nonce_key] = max(NONCE_CACHE[nonce_key], nonce + 1)
+
+
+def check_nonce_error(resp, retry_nonce):
+    """Returns the next nonce if resp contains a nonce error and retries weren't exhausted
+    Raises RevertError otherwise
+    """
     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"])
         warn(f'{resp["error"]["message"]} error, I will retry fetching the nonce')
-        return send_transaction(w3, tx, retry_nonce=(retry_nonce or 0) + 1)
+        return (retry_nonce or 0) + 1
     else:
         raise RevertError(resp["error"]["message"])
 
 
 def get_base_fee(w3):
     blk = w3.eth.get_block("latest")
-    return blk["baseFeePerGas"]
+    return int(_to_uint(blk["baseFeePerGas"]) * AA_BUNDLER_BASE_GAS_PRICE_FACTOR)
 
 
-def send_transaction(w3, tx, retry_nonce=None):
+def get_sender(tx):
+    if "from" not in tx or tx["from"] == ADDRESS_ZERO:
+        if AA_BUNDLER_SENDER is None:
+            raise RuntimeError("Must define AA_BUNDLER_SENDER or send 'from' in the TX")
+        return AA_BUNDLER_SENDER
+    else:
+        return tx["from"]
+
+
+def build_user_operation(w3, tx, retry_nonce=None):
     nonce_key, nonce = get_nonce_and_key(
         w3, tx, AA_BUNDLER_NONCE_MODE, entry_point=AA_BUNDLER_ENTRYPOINT, fetch=retry_nonce is not None
     )
@@ -185,7 +209,7 @@ def send_transaction(w3, tx, retry_nonce=None):
         "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"
     )
     user_operation = {
-        "sender": tx.get("from", AA_BUNDLER_SENDER),
+        "sender": get_sender(tx),
         "nonce": hex(make_nonce(nonce_key, nonce)),
         "callData": call_data,
         "signature": dummy_signature,
@@ -196,39 +220,63 @@ def send_transaction(w3, tx, retry_nonce=None):
             "eth_estimateUserOperationGas", [user_operation, AA_BUNDLER_ENTRYPOINT]
         )
         if "error" in resp:
-            return handle_response_error(resp, w3, tx, retry_nonce)
+            next_nonce = check_nonce_error(resp, retry_nonce)
+            return build_user_operation(w3, tx, retry_nonce=next_nonce)
 
         user_operation.update(resp["result"])
 
         resp = w3.provider.make_request("rundler_maxPriorityFeePerGas", [])
         if "error" in resp:
             raise RevertError(resp["error"]["message"])
-        max_priority_fee_per_gas = resp["result"]
-        user_operation["maxPriorityFeePerGas"] = max_priority_fee_per_gas
-        user_operation["maxFeePerGas"] = hex(_to_uint(max_priority_fee_per_gas) + _to_uint(get_base_fee(w3)))
-    elif AA_BUNDLER_PROVIDER == "gelato":
-        user_operation.update(
-            {
-                "preVerificationGas": "0x00",
-                "callGasLimit": "0x00",
-                "verificationGasLimit": "0x00",
-                "maxFeePerGas": "0x00",
-                "maxPriorityFeePerGas": "0x00",
-            }
+        user_operation["maxPriorityFeePerGas"] = resp["result"]
+        user_operation["maxFeePerGas"] = hex(int(resp["result"], 16) + get_base_fee(w3))
+
+    elif AA_BUNDLER_PROVIDER == "generic":
+        resp = w3.provider.make_request(
+            "eth_estimateUserOperationGas", [user_operation, AA_BUNDLER_ENTRYPOINT]
         )
-    user_operation["signature"] = sign_user_operation(
-        AA_BUNDLER_EXECUTOR_PK, user_operation, tx["chainId"], AA_BUNDLER_ENTRYPOINT
+        if "error" in resp:
+            next_nonce = check_nonce_error(resp, retry_nonce)
+            return build_user_operation(w3, tx, retry_nonce=next_nonce)
+
+        user_operation.update(resp["result"])
+
+    else:
+        warn(f"Unknown AA_BUNDLER_PROVIDER: {AA_BUNDLER_PROVIDER}")
+
+    # Apply increase factors
+    user_operation["verificationGasLimit"] = hex(
+        apply_factor(user_operation["verificationGasLimit"], AA_BUNDLER_VERIFICATION_GAS_FACTOR)
     )
+    if "maxPriorityFeePerGas" in user_operation:
+        user_operation["maxPriorityFeePerGas"] = hex(
+            apply_factor(user_operation["maxPriorityFeePerGas"], AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR)
+        )
+    if "callGasLimit" in user_operation:
+        user_operation["callGasLimit"] = hex(
+            apply_factor(user_operation["callGasLimit"], AA_BUNDLER_GAS_LIMIT_FACTOR)
+        )
+
     # Remove paymaster related fields
     user_operation.pop("paymaster", None)
     user_operation.pop("paymasterData", None)
     user_operation.pop("paymasterVerificationGasLimit", None)
     user_operation.pop("paymasterPostOpGasLimit", None)
 
+    # Consume the nonce, even if the userop may fail later
+    consume_nonce(nonce_key, nonce)
+
+    return user_operation
+
+
+def send_transaction(w3, tx, retry_nonce=None):
+    user_operation = build_user_operation(w3, tx, retry_nonce)
+    user_operation["signature"] = sign_user_operation(
+        AA_BUNDLER_EXECUTOR_PK, user_operation, tx["chainId"], AA_BUNDLER_ENTRYPOINT
+    )
     resp = w3.provider.make_request("eth_sendUserOperation", [user_operation, AA_BUNDLER_ENTRYPOINT])
     if "error" in resp:
-        return handle_response_error(resp, w3, tx, retry_nonce)
+        next_nonce = check_nonce_error(resp, retry_nonce)
+        return send_transaction(w3, tx, retry_nonce=next_nonce)
 
-    # Store nonce in the cache, so next time uses a new nonce
-    NONCE_CACHE[nonce_key] = nonce + 1
-    return resp["result"]
+    return {"userOpHash": resp["result"]}

ethproto/w3wrappers.py

@@ -375,6 +375,8 @@ class W3ETHCall(ETHCall):
     def normalize_receipt(self, wrapper, receipt):
         if W3_TRANSACT_MODE == "defender-async":
             return receipt  # Don't do anything because the receipt is just a dict of not-yet-mined tx
+        elif W3_TRANSACT_MODE == "aa-bundler-async":
+            return receipt  # Don't do anything because the receipt is just a dict of {"userOpHash": "..."}
         return ReceiptWrapper(receipt, wrapper.contract)
 
     def _handle_exception(self, err):
@@ -442,7 +444,7 @@ class W3Provider(BaseProvider):
     def get_events(self, eth_wrapper, event_name, filter_kwargs={}):
         """Returns a list of events given a filter, like this:
 
-        >>> provider.get_events(currencywrapper, "Transfer", dict(fromBlock=0))
+        >>> provider.get_events(currencywrapper, "Transfer", dict(from_block=0))
         [AttributeDict({
             'args': AttributeDict(
                 {'from': '0x0000000000000000000000000000000000000000',
@@ -461,8 +463,8 @@ class W3Provider(BaseProvider):
         """
         contract = eth_wrapper.contract
         event = getattr(contract.events, event_name)
-        if "fromBlock" not in filter_kwargs:
-            filter_kwargs["fromBlock"] = self.get_first_block(eth_wrapper)
+        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()
 
@@ -488,7 +490,7 @@ class W3Provider(BaseProvider):
             constructor_params, init_params = init_params
             real_contract = self.construct(eth_contract, constructor_params, {"from": eth_wrapper.owner})
             ERC1967Proxy = self.get_contract_factory("ERC1967Proxy")
-            init_data = eth_contract.encodeABI(fn_name="initialize", args=init_params)
+            init_data = eth_contract.encode_abi(abi_element_identifier="initialize", args=init_params)
             proxy_contract = self.construct(
                 ERC1967Proxy,
                 (real_contract.address, init_data),

eth_prototype-1.1.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-ethproto/__init__.py,sha256=YWkAFysBp4tZjLWWB2FFmp5yG23pUYhQvgQW9b3soXs,579
-ethproto/aa_bundler.py,sha256=34yXgQw_vV81Wmf9cFxcLTxLUb1jzCrBE7XOw5RIjtI,8652
-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=UbSuaB5_TYF4kiGNwIzvPPE7f0A6soZ7gc5jd180mVM,21065
-ethproto/wadray.py,sha256=JBsu5KcyU9k70bDK03T2IY6qPVFO30WbYPhwrAHdXao,8262
-ethproto/wrappers.py,sha256=9qDwRDOXw3wquzvGfIsub-VPWm98GBWP7dHLFOUPWzg,17307
-eth_prototype-1.1.0.dist-info/AUTHORS.rst,sha256=Ui-05yYXtDZxna6o1yNcfdm8Jt68UIDQ01osiLxlYlU,95
-eth_prototype-1.1.0.dist-info/LICENSE.txt,sha256=U_Q6_nDYDwZPIuhttHi37hXZ2qU2-HlV2geo9hzHXFw,1087
-eth_prototype-1.1.0.dist-info/METADATA,sha256=uOJw45vu6Xwc3uzJ1IfWV0RW1i2ST_ZHJ775Uwbi7zk,2482
-eth_prototype-1.1.0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-eth_prototype-1.1.0.dist-info/top_level.txt,sha256=Dl0X7m6N1hxeo4JpGpSNqWC2gtsN0731g-DL1J0mpjc,9
-eth_prototype-1.1.0.dist-info/RECORD,,