Support RPC 0.8.0 #1510

franciszekjob · 2024-10-29T00:29:45Z

Addresses #1498

Introduced changes

Support RPC 0.8.0.

starknet_getStorageProof
- Add StorageProofResponse, GlobalRoots, ContractsProof, ContractLeafData, NodeHashToNodeMappingItem, BinaryNode, EdgeNode, ContractStorageKeys data classes
- Add get_storage_proof method in FullNodeClient and Client
starknet_getMessagesStatus
- Add MessageStatus data class
- Add get_messages_status method in FullNodeClient and Client
Adapt execution resources to new receipt
- Change l1_resource_bounds param to resource_bounds in tx-related methods and classes constructors
- EstimatedFee:
  - rename gas_consumed to l1_gas_consumed
  - rename gas_price to l1_gas_price
  - rename data_gas_price to l1_data_gas_price
  - rename data_gas_consumed to l1_data_gas_consumed
  - add l2_gas_consumed, l2_gas_price fields
- Remove ComputationResources and update ExecutionResources
- Rename DataResources to InnerCallExecutionResources
- Rename computation_resources to execution_resources in FunctionInvocation and change its type to InnerCallExecutionResources instead of ComputationResources
Add failure_reason to TransactionStatusResponse
starknet_getCompiledCasm
- Support starknet_getCompiledCasm #1514
WebSockets
- TODO: addressed in incoming PR

This PR contains breaking changes
Not compatible with JSON-RPC 0.7.0 spec
Use resource_bounds instead of l1_resource_bounds param
ComputationResources has been removed; ExecutionResources and StarknetFeeEstimate have been updated

…matedFeeSchema`

franciszekjob · 2024-10-30T10:46:14Z

docs/migration_guide.rst

+- Starknet - `0.13.3 <https://docs.starknet.io/documentation/starknet_versions/version_notes/#version0.13.3>`_
+- RPC - `0.8.0 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.8.0>`_
+
+TODO (#1498): List changes


note: Migration guide will be updated once we confirm that all introduced changes are correct.

franciszekjob · 2024-10-30T12:27:59Z

note: Tests will be addressed later, once devnet fully implements RPC 0.8.0.

starknet_py/net/client.py

ddoktorski · 2024-10-31T15:29:52Z

starknet_py/net/client_models.py

@@ -381,42 +381,22 @@ class TransactionFinalityStatus(Enum):


 @dataclass
-class DataResources:
+class InnerCallExecutionResources:


Do we actually need this class?

Yes, I updated it in this commit 😅 , execution_resources in FunctionInvocation should be of type InnerCallExecutionResources (ref to spec).

I see, but it should have properties l1_gas and l2_gas, not l1_data_gas

ddoktorski · 2024-10-31T15:36:56Z

starknet_py/net/client_models.py

+        Calculates L1 max amount as `l1_max_amount` = `overall_fee` / `l1_gas_price`, unless `l1_gas_price` is 0,
+        then L1 max amount is 0. Calculates `l1_max_price_per_unit` as `l1_max_price_per_unit` = `l1_gas_price`.

-        Then multiplies `max_amount` by `amount_multiplier` and `max_price_per_unit` by `unit_price_multiplier`.
+        Calculates L2 max amount as `l2_max_amount` = `overall_fee` / `l2_gas_price`, unless `l2_gas_price` is 0,
+        then L2 max amount is 0. Calculates `l2_max_price_per_unit` as `l2_max_price_per_unit` = `l2_gas_price`.
+
+        Then multiplies L1 max amount and L2 max amount by `amount_multiplier` and `l1_max_price_per_unit`
+        and `l2_max_price_per_unit` by `unit_price_multiplier`.


It looks we no longer need to use this hacky method, as we now have all the necessary fields in EstimatedFee.

I've also added todo for decreasing amount and unit price multipliers.

starknet_py/net/client_models.py

ddoktorski · 2024-10-31T15:57:21Z

starknet_py/contract.py

@@ -231,7 +237,7 @@ async def deploy_v3(
        unique: bool = True,
        constructor_args: Optional[Union[List, Dict]] = None,
        nonce: Optional[int] = None,
-        l1_resource_bounds: Optional[ResourceBounds] = None,
+        resource_bounds: Optional[ResourceBoundsMapping] = None,


Maybe having 2 parameters l1_resource_bounds and l2_resource_bounds would be more convenient?

Tbh I don't think it's good to pass all fields of data class separately.
Maybe we can set l1_gas and l2_gas as optional in ResourceBoundsMapping (if not passed they will be zero)?

Let's leave a parameter only for ResourceBoundsMapping as it is now, but please add a method in ResourceBoundsMapping that allows to specify only l1_gas and sets the rest of the fields to 0

starknet_py/tests/e2e/account/account_test.py

… `FunctionInvocation`

ddoktorski

Please re-request once there are tests added

ddoktorski · 2024-12-05T20:10:27Z

starknet_py/net/client_models.py

    overall_fee: int
    unit: PriceUnit

+    # TODO (#1498): Decrease multipliers
    def to_resource_bounds(
        self, amount_multiplier=1.5, unit_price_multiplier=1.5
    ) -> ResourceBoundsMapping:


ResourceBoundsMapping needs to be updated to include l1_data_gas

ddoktorski · 2024-12-05T20:13:05Z

starknet_py/contract.py

@@ -231,7 +237,7 @@ async def deploy_v3(
        unique: bool = True,
        constructor_args: Optional[Union[List, Dict]] = None,
        nonce: Optional[int] = None,
-        l1_resource_bounds: Optional[ResourceBounds] = None,
+        resource_bounds: Optional[ResourceBoundsMapping] = None,


Let's leave a parameter only for ResourceBoundsMapping as it is now, but please add a method in ResourceBoundsMapping that allows to specify only l1_gas and sets the rest of the fields to 0

ddoktorski · 2024-12-05T20:13:31Z

starknet_py/contract.py

@@ -244,7 +250,7 @@ async def deploy_v3(
        :param unique: Determines if the contract should be salted with the account address.
        :param constructor_args: a ``list`` or ``dict`` of arguments for the constructor.
        :param nonce: Nonce of the transaction with call to deployer.
-        :param l1_resource_bounds: Max amount and max price per unit of L1 gas (in Fri) used when executing
+        :param resource_bounds: Max amount and max price per unit of L1 and L2 gas (in Fri) used when executing


This description needs to be updated in all places (perhaps in the docs as well)

ddoktorski · 2024-12-05T20:21:04Z

starknet_py/net/client_models.py

@@ -381,42 +381,22 @@ class TransactionFinalityStatus(Enum):


 @dataclass
-class DataResources:
+class InnerCallExecutionResources:


I see, but it should have properties l1_gas and l2_gas, not l1_data_gas

ddoktorski · 2024-12-05T20:22:03Z

starknet_py/net/client_models.py

+            max_amount=int(self.l1_gas_consumed * amount_multiplier),
+            max_price_per_unit=int(self.l1_gas_price * unit_price_multiplier),
+        )
+


l1_data_gas is missing

ddoktorski · 2024-12-05T20:30:27Z

starknet_py/net/client_models.py

+@dataclass
+class MessageStatus:
+    transaction_hash: int
+    finality_status: TransactionFinalityStatus


https://github.com/starkware-libs/starknet-specs/blob/v0.8.0/api/starknet_api_openrpc.json#L279

Suggested change

finality_status: TransactionFinalityStatus

finality_status: TransactionStatus

ddoktorski · 2024-12-05T20:31:51Z

starknet_py/net/schemas/rpc/transactions.py

+
+class MessageStatusSchema(Schema):
+    transaction_hash = NumberAsHex(data_key="transaction_hash", required=True)
+    finality_status = FinalityStatusField(data_key="finality_status", required=True)


Suggested change

finality_status = FinalityStatusField(data_key="finality_status", required=True)

finality_status = StatusField(data_key="finality_status", required=True)

ddoktorski · 2024-12-05T20:36:15Z

starknet_py/tests/e2e/tests_on_networks/client_test.py

+    assert estimated_message.l1_gas_price > 0
+    assert estimated_message.l1_gas_consumed > 0
+    assert estimated_message.l2_gas_price > 0
+    assert estimated_message.l2_gas_consumed > 0
+    assert estimated_message.l1_data_gas_price > 0
+    assert estimated_message.l1_data_gas_consumed >= 0


nit:

Suggested change

assert estimated_message.l1_gas_price > 0

assert estimated_message.l1_gas_consumed > 0

assert estimated_message.l2_gas_price > 0

assert estimated_message.l2_gas_consumed > 0

assert estimated_message.l1_data_gas_price > 0

assert estimated_message.l1_data_gas_consumed >= 0

assert all(

getattr(estimated_message, field.name) > 0

for field in dataclasses.fields(EstimatedFee)

)

franciszekjob added 5 commits October 28, 2024 22:46

Support starknet_getStorageProof

931f4cd

Support failure reason in transaction status

f1f5d50

Support starknet_getMessagesStatus

3fe3460

Adapt execution resources

ecf4f06

Change l1_resource_bounds to resource_bounds

5d15915

github-actions bot assigned franciszekjob Oct 29, 2024

franciszekjob changed the title ~~Franciszekjob/1498 rpc 0.8.0~~ Support RPC 0.8.0 Oct 29, 2024

franciszekjob added 8 commits October 29, 2024 10:32

Rename DataResources to InnerCallExecutionResources; Update `Esti…

f0a5bfd

…matedFeeSchema`

Add todo in migration guide

b8dc86a

Format

ddea26e

Update resource bounds in test_invoke

19036e4

Make block_id required in get_storage_proof

e832c30

Update docstring in to_resource_bounds

b182eff

Minor fix in StorageProofResponse

e82c017

Update rousurce_bounds param in docs

bb2d82e

franciszekjob commented Oct 30, 2024

View reviewed changes

franciszekjob added 2 commits October 30, 2024 12:36

Add missing make_dataclass in schemas

9621f36

Refactor MerkleNodeSchema

e6e7c53

franciszekjob requested a review from ddoktorski October 30, 2024 11:43

Remove unused import

3b7ffe2

ddoktorski reviewed Oct 31, 2024

View reviewed changes

franciszekjob added 3 commits November 1, 2024 18:21

Update execution_resources type to InnerCallExecutionResources in…

6e11803

… `FunctionInvocation`

Use MAX_RESOURCE_BOUNDS

76e789c

Refactor EstimatedFee.to_resource_bounds()

bae1f49

franciszekjob requested a review from ddoktorski November 5, 2024 13:07

franciszekjob added 2 commits November 8, 2024 12:53

Fix resource_bounds params name

bd9d693

Add default values in get_storage_proof()

b8748e0

NikitaMishin mentioned this pull request Nov 26, 2024

ValidationError: {'l2_gas_price': ['Unknown field.']} #1529

Closed

1 task

ddoktorski reviewed Dec 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support RPC 0.8.0 #1510

Support RPC 0.8.0 #1510

franciszekjob commented Oct 29, 2024 •

edited

Loading

franciszekjob Oct 30, 2024 •

edited

Loading

franciszekjob commented Oct 30, 2024 •

edited

Loading

ddoktorski Oct 31, 2024

franciszekjob Nov 1, 2024 •

edited

Loading

ddoktorski Dec 5, 2024

ddoktorski Oct 31, 2024

franciszekjob Nov 4, 2024

ddoktorski Oct 31, 2024

franciszekjob Oct 31, 2024 •

edited

Loading

ddoktorski Dec 5, 2024

ddoktorski left a comment

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

ddoktorski Dec 5, 2024

	finality_status: TransactionFinalityStatus
	finality_status: TransactionStatus

	finality_status = FinalityStatusField(data_key="finality_status", required=True)
	finality_status = StatusField(data_key="finality_status", required=True)

Support RPC 0.8.0 #1510

Are you sure you want to change the base?

Support RPC 0.8.0 #1510

Conversation

franciszekjob commented Oct 29, 2024 • edited Loading

Introduced changes

Support RPC 0.8.0.

franciszekjob Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

franciszekjob commented Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

franciszekjob Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ddoktorski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob commented Oct 29, 2024 •

edited

Loading

franciszekjob Oct 30, 2024 •

edited

Loading

franciszekjob commented Oct 30, 2024 •

edited

Loading

franciszekjob Nov 1, 2024 •

edited

Loading

franciszekjob Oct 31, 2024 •

edited

Loading