eth-prototype 1.3.1__tar.gz → 1.3.3__tar.gz

{eth_prototype-1.3.1 → eth_prototype-1.3.3}/PKG-INFO

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

{eth_prototype-1.3.1 → eth_prototype-1.3.3}/src/eth_prototype.egg-info/PKG-INFO

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

{eth_prototype-1.3.1 → eth_prototype-1.3.3}/src/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
 
@@ -29,6 +29,9 @@ 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)
+AA_BUNDLER_MAX_FEE_PER_GAS = env.int("AA_BUNDLER_MAX_FEE_PER_GAS", 200000000000)  # 200 gwei
+
+AA_BUNDLER_STATE_OVERRIDES = env.json("AA_BUNDLER_STATE_OVERRIDES", default={})
 
 NonceMode = Enum(
     "NonceMode",
@@ -68,6 +71,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 +301,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):
@@ -317,7 +330,9 @@ class Bundler:
         gas_limit_factor: float = AA_BUNDLER_GAS_LIMIT_FACTOR,
         priority_gas_price_factor: float = AA_BUNDLER_PRIORITY_GAS_PRICE_FACTOR,
         base_gas_price_factor: float = AA_BUNDLER_BASE_GAS_PRICE_FACTOR,
+        max_fee_per_gas: int = AA_BUNDLER_MAX_FEE_PER_GAS,
         executor_pk: HexBytes = AA_BUNDLER_EXECUTOR_PK,
+        overrides: StateOverride = AA_BUNDLER_STATE_OVERRIDES,
     ):
         self.w3 = w3
         self.bundler = Web3(Web3.HTTPProvider(bundler_url), middleware=[])
@@ -330,13 +345,18 @@ class Bundler:
         self.priority_gas_price_factor = priority_gas_price_factor
         self.base_gas_price_factor = base_gas_price_factor
         self.executor_pk = executor_pk
+        self.max_fee_per_gas = max_fee_per_gas
+
+        # 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"base_gas_price_factor={self.base_gas_price_factor})"
+            f"base_gas_price_factor={self.base_gas_price_factor}, max_fee_per_gas={self.max_fee_per_gas})"
         )
 
     def get_nonce_and_key(self, tx: Tx, fetch=False):
@@ -364,10 +384,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,10 +407,17 @@ 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()
+        max_fee_per_gas = min(max_priority_fee_per_gas + self.get_base_fee(), self.max_fee_per_gas)
+
+        return GasPrice(max_priority_fee_per_gas=max_priority_fee_per_gas, max_fee_per_gas=max_fee_per_gas)
 
+    def generic_gas_price(self):
+        base_fee = self.get_base_fee()
+        priority_fee = self.w3.eth.max_priority_fee
+        max_priority_fee_per_gas = int(priority_fee * self.priority_gas_price_factor)
+        max_fee_per_gas = min(max_priority_fee_per_gas + base_fee, self.max_fee_per_gas)
         return GasPrice(max_priority_fee_per_gas=max_priority_fee_per_gas, max_fee_per_gas=max_fee_per_gas)
 
     def build_user_operation(self, tx: Tx, retry_nonce=None) -> UserOperation:
@@ -404,16 +432,15 @@ class Bundler:
 
         if self.bundler_type == "alchemy":
             gas_price = self.alchemy_gas_price()
-            user_operation = user_operation.add_gas_price(gas_price)
 
         elif self.bundler_type == "generic":
-            # At the moment generic just prices the gas at 0
-            pass
+            gas_price = self.generic_gas_price()
 
         else:
             warn(f"Unknown bundler_type: {self.bundler_type}")
+            gas_price = GasPrice(0, 0)
 
-        return user_operation
+        return user_operation.add_gas_price(gas_price)
 
     def send_transaction(self, tx: Tx, retry_nonce=None):
         user_operation = self.build_user_operation(tx, retry_nonce).sign(
@@ -424,7 +451,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"]}

{eth_prototype-1.3.1 → eth_prototype-1.3.3}/tests/cassettes/test_aa_bundler/test_build_user_operation.yaml

@@ -23,7 +23,7 @@ interactions:
         [{"sender": "0xE8B412158c205B0F605e0FC09dCdA27d3F140FE9", "nonce": "0xae85c374ae0606ed34d0ee009a9ca43a757a8a46a324510000000000000000",
         "callData": "0xb61d27f60000000000000000000000002791bca1f2de4661ed88a30c99a7a9449aa84174000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000044095ea7b30000000000000000000000007ace242f32208d836a2245df957c08547059bf45ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000",
         "signature": "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"},
-        "0x0000000071727De22E5E9d8BAf0edAc6f37da032"], "id": 0}'
+        "0x0000000071727De22E5E9d8BAf0edAc6f37da032", {}], "id": 0}'
       headers:
         Content-Length:
           - "885"

{eth_prototype-1.3.1 → eth_prototype-1.3.3}/tests/test_aa_bundler.py

@@ -182,7 +182,8 @@ def test_send_transaction():
 
     def make_request(method, params):
         if method == "eth_estimateUserOperationGas":
-            assert len(params) == 2
+            assert len(params) == 3
+            assert params[2] == {}
             assert params[1] == ENTRYPOINT
             assert params[0] == {
                 "sender": "0xE8B412158c205B0F605e0FC09dCdA27d3F140FE9",