Restore auto estimation in tests (#1590) [skip ci]

* Remove todos; Restore multiplier params

* Remove changes related with amount multipliers params

* Fix linting

* Add `InnerCallExecutionResources`; Fix tests

* Update migration guide

* Update field types in `EstimatedFeeSchema`

Author: franciszekjob

docs/migration_guide.rst

@@ -1,6 +1,17 @@
 Migration guide
 ===============
 
+**********************
+0.26.1 Migration guide
+**********************
+
+0.26.1 Bugfixes
+---------------
+
+.. py:currentmodule:: starknet_py.net.client_models
+
+1. In :class:`FunctionInvocation`, ``execution_resources`` field is now of type :class:`InnerCallExecutionResources`.
+
 **********************
 0.26.0 Migration guide
 **********************

starknet_py/net/client_models.py

@@ -419,6 +419,16 @@ class TransactionFinalityStatus(Enum):
     ACCEPTED_ON_L1 = "ACCEPTED_ON_L1"
 
 
+@dataclass
+class InnerCallExecutionResources:
+    """
+    Dataclass representing the resource consumed by an inner call (does not account for state diffs).
+    """
+
+    l1_gas: int
+    l2_gas: int
+
+
 @dataclass
 class ExecutionResources:
     """
@@ -1023,7 +1033,7 @@ class FunctionInvocation:
     calls: List["FunctionInvocation"]
     events: List[OrderedEvent]
     messages: List[OrderedMessage]
-    execution_resources: ExecutionResources
+    execution_resources: InnerCallExecutionResources
     is_reverted: bool
 
 

starknet_py/net/schemas/rpc/general.py

@@ -1,10 +1,23 @@
 from marshmallow import fields, post_load
 
-from starknet_py.net.client_models import EstimatedFee, ExecutionResources
-from starknet_py.net.schemas.common import Felt, PriceUnitField
+from starknet_py.net.client_models import (
+    EstimatedFee,
+    ExecutionResources,
+    InnerCallExecutionResources,
+)
+from starknet_py.net.schemas.common import PriceUnitField, Uint64, Uint128
 from starknet_py.utils.schema import Schema
 
 
+class InnerCallExecutionResourcesSchema(Schema):
+    l1_gas = fields.Integer(data_key="l1_gas", required=True)
+    l2_gas = fields.Integer(data_key="l2_gas", required=True)
+
+    @post_load
+    def make_dataclass(self, data, **kwargs) -> InnerCallExecutionResources:
+        return InnerCallExecutionResources(**data)
+
+
 class ExecutionResourcesSchema(Schema):
     l1_gas = fields.Integer(data_key="l1_gas", required=True)
     l1_data_gas = fields.Integer(data_key="l1_data_gas", required=True)
@@ -16,13 +29,13 @@ def make_dataclass(self, data, **kwargs) -> ExecutionResources:
 
 
 class EstimatedFeeSchema(Schema):
-    l1_gas_consumed = Felt(data_key="l1_gas_consumed", required=True)
-    l1_gas_price = Felt(data_key="l1_gas_price", required=True)
-    l2_gas_consumed = Felt(data_key="l2_gas_consumed", required=True)
-    l2_gas_price = Felt(data_key="l2_gas_price", required=True)
-    l1_data_gas_consumed = Felt(data_key="l1_data_gas_consumed", required=True)
-    l1_data_gas_price = Felt(data_key="l1_data_gas_price", required=True)
-    overall_fee = Felt(data_key="overall_fee", required=True)
+    l1_gas_consumed = Uint64(data_key="l1_gas_consumed", required=True)
+    l1_gas_price = Uint128(data_key="l1_gas_price", required=True)
+    l2_gas_consumed = Uint64(data_key="l2_gas_consumed", required=True)
+    l2_gas_price = Uint128(data_key="l2_gas_price", required=True)
+    l1_data_gas_consumed = Uint64(data_key="l1_data_gas_consumed", required=True)
+    l1_data_gas_price = Uint128(data_key="l1_data_gas_price", required=True)
+    overall_fee = Uint128(data_key="overall_fee", required=True)
     unit = PriceUnitField(data_key="unit", required=True)
 
     @post_load

starknet_py/net/schemas/rpc/trace_api.py

@@ -18,6 +18,7 @@
 from starknet_py.net.schemas.rpc.general import (
     EstimatedFeeSchema,
     ExecutionResourcesSchema,
+    InnerCallExecutionResourcesSchema,
 )
 from starknet_py.utils.schema import Schema
 
@@ -67,7 +68,7 @@ class FunctionInvocationSchema(Schema):
         fields.Nested(OrderedMessageSchema()), data_key="messages", required=True
     )
     execution_resources = fields.Nested(
-        ExecutionResourcesSchema(),
+        InnerCallExecutionResourcesSchema(),
         data_key="execution_resources",
         required=True,
     )

starknet_py/tests/e2e/account/account_test.py

@@ -235,7 +235,6 @@ async def test_sign_invoke_v3(account, calls):
 
 
 @pytest.mark.asyncio
-@pytest.mark.skip("TODO(#1558)")
 async def test_sign_invoke_v3_auto_estimate(account, map_contract):
     signed_tx = await account.sign_invoke_v3(
         Call(map_contract.address, get_selector_from_name("put"), [3, 4]),
@@ -249,9 +248,12 @@ async def test_sign_invoke_v3_auto_estimate(account, map_contract):
     assert len(signed_tx.signature) == 2
 
     assert isinstance(signed_tx.resource_bounds, ResourceBoundsMapping)
-    assert signed_tx.resource_bounds.l1_gas.max_amount > 0
+    assert signed_tx.resource_bounds.l1_gas.max_amount >= 0
     assert signed_tx.resource_bounds.l1_gas.max_price_per_unit > 0
-    assert signed_tx.resource_bounds.l2_gas == ResourceBounds.init_with_zeros()
+    assert signed_tx.resource_bounds.l2_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l2_gas.max_price_per_unit > 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_price_per_unit > 0
 
 
 @pytest.mark.asyncio
@@ -278,7 +280,6 @@ async def test_sign_declare_v3(
 
 
 @pytest.mark.asyncio
-@pytest.mark.skip("TODO(#1558)")
 async def test_sign_declare_v3_auto_estimate(
     account, sierra_minimal_compiled_contract_and_class_hash
 ):
@@ -298,9 +299,12 @@ async def test_sign_declare_v3_auto_estimate(
     assert len(signed_tx.signature) == 2
 
     assert isinstance(signed_tx.resource_bounds, ResourceBoundsMapping)
-    assert signed_tx.resource_bounds.l1_gas.max_amount > 0
+    assert signed_tx.resource_bounds.l1_gas.max_amount >= 0
     assert signed_tx.resource_bounds.l1_gas.max_price_per_unit > 0
-    assert signed_tx.resource_bounds.l2_gas == ResourceBounds.init_with_zeros()
+    assert signed_tx.resource_bounds.l2_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l2_gas.max_price_per_unit > 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_price_per_unit > 0
 
 
 @pytest.mark.asyncio
@@ -328,7 +332,6 @@ async def test_sign_deploy_account_v3(account):
 
 
 @pytest.mark.asyncio
-@pytest.mark.skip("TODO(#1558)")
 async def test_sign_deploy_account_v3_auto_estimate(
     account, account_with_validate_deploy_class_hash
 ):
@@ -346,9 +349,12 @@ async def test_sign_deploy_account_v3_auto_estimate(
     assert len(signed_tx.signature) == 2
 
     assert isinstance(signed_tx.resource_bounds, ResourceBoundsMapping)
-    assert signed_tx.resource_bounds.l1_gas.max_amount > 0
+    assert signed_tx.resource_bounds.l1_gas.max_amount >= 0
     assert signed_tx.resource_bounds.l1_gas.max_price_per_unit > 0
-    assert signed_tx.resource_bounds.l2_gas == ResourceBounds.init_with_zeros()
+    assert signed_tx.resource_bounds.l2_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l2_gas.max_price_per_unit > 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_amount >= 0
+    assert signed_tx.resource_bounds.l1_data_gas.max_price_per_unit > 0
 
 
 @pytest.mark.asyncio

starknet_py/tests/e2e/cairo1v2_test.py

@@ -21,15 +21,11 @@ async def declare_deploy_hello2(account) -> Tuple[DeclareResult, DeployResult]:
         account=account,
         compiled_contract=contract["sierra"],
         compiled_contract_casm=contract["casm"],
-        # TODO(#1558): Use auto estimation
-        resource_bounds=MAX_RESOURCE_BOUNDS,
+        auto_estimate=True,
     )
     await declare_result.wait_for_acceptance()
 
-    deploy_result = await declare_result.deploy_v3(
-        # TODO(#1558): Use auto estimation
-        resource_bounds=MAX_RESOURCE_BOUNDS,
-    )
+    deploy_result = await declare_result.deploy_v3(auto_estimate=True)
     await deploy_result.wait_for_acceptance()
 
     return declare_result, deploy_result
@@ -49,13 +45,11 @@ async def test_deploy_cairo2(contract):
 
 @pytest.mark.asyncio
 async def test_cairo2_interaction(contract):
-    # TODO(#1558): Use auto estimation
     invoke_res = await contract.functions["increase_balance"].invoke_v3(
-        amount=100, resource_bounds=MAX_RESOURCE_BOUNDS
+        amount=100, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
 
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["increase_balance"].invoke_v3(
         amount=100, resource_bounds=MAX_RESOURCE_BOUNDS
     )
@@ -67,9 +61,8 @@ async def test_cairo2_interaction(contract):
 
 @pytest.mark.asyncio
 async def test_cairo2_interaction2(contract):
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["increase_balance_u8"].invoke_v3(
-        255, resource_bounds=MAX_RESOURCE_BOUNDS
+        255, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
 
@@ -97,9 +90,8 @@ async def test_cairo2_u256(contract):
 
 @pytest.mark.asyncio
 async def test_cairo2_contract_address(contract):
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["set_ca"].invoke_v3(
-        address=contract.account.address, resource_bounds=MAX_RESOURCE_BOUNDS
+        address=contract.account.address, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
 
@@ -109,29 +101,26 @@ async def test_cairo2_contract_address(contract):
 
 @pytest.mark.asyncio
 async def test_cairo2_interaction3(contract):
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["increase_balance"].invoke_v3(
-        100, resource_bounds=MAX_RESOURCE_BOUNDS
+        100, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
     (balance,) = await contract.functions["get_balance"].call()
     key = get_storage_var_address("balance")
     storage = await contract.client.get_storage_at(contract.address, key)
     assert storage == balance
 
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["set_ca"].invoke_v3(
-        contract.account.address, resource_bounds=MAX_RESOURCE_BOUNDS
+        contract.account.address, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
     (ca,) = await contract.functions["get_ca"].call()  # pylint: disable=invalid-name
     key = get_storage_var_address("ca")
     storage = await contract.client.get_storage_at(contract.address, key)
     assert storage == ca
 
-    # TODO (#1558): Use auto estimation
     invoke_res = await contract.functions["set_status"].invoke_v3(
-        True, resource_bounds=MAX_RESOURCE_BOUNDS
+        True, auto_estimate=True
     )
     await invoke_res.wait_for_acceptance()
     (status,) = await contract.functions["get_status"].call()
@@ -144,8 +133,7 @@ async def test_cairo2_interaction3(contract):
             "address": contract.account.address,
             "is_claimed": True,
         },
-        # TODO (#1558): Use auto estimation
-        resource_bounds=MAX_RESOURCE_BOUNDS,
+        auto_estimate=True,
     )
     await invoke_res.wait_for_acceptance()
     (user1,) = await contract.functions["get_user1"].call()
@@ -178,10 +166,7 @@ async def test_cairo2_echo_struct(contract):
 
 @pytest.mark.asyncio
 async def test_cairo2_echo_complex_struct(contract):
-    # TODO (#1558): Use auto estimation
-    invoke_result = await contract.functions["set_bet"].invoke_v3(
-        resource_bounds=MAX_RESOURCE_BOUNDS
-    )
+    invoke_result = await contract.functions["set_bet"].invoke_v3(auto_estimate=True)
     await invoke_result.wait_for_acceptance()
 
     (bet,) = await contract.functions["get_bet"].call(1)