Support RPC 0.8.0 #530

franciszekjob · 2024-10-22T08:12:58Z

Describe your changes

Support RPC 0.8.0.

starknet_getStorageProof
- Add StorageProof, GlobalRoots, ContractsProof, ContractLeafData, NodeHashToNodeMappingItem, BinaryNode, EdgeNode, ContractStorageKey data classes
- Add getStorageProof method in Provider and JsonRpcProvider
starknet_getMessagesStatus
- Add MessageStatusList, MessageStatus data classes
- Add getMessagesStatus method in Provider and JsonRpcProvider
Adapt execution resources to new receipt
- Account, StandardAccount:
  - signDeployAccountV3 and executeV3 have now resourceBounds param instead of l1ResourceBounds
- InvokeParamsV3, DeclareParamsV3, DeployAccountParamsV3:
  - Change l1ResourceBounds param to resourceBounds in constructor
- EstimateFeeResponse :
  - rename gasConsumed to l1GasConsumed
  - rename gasPrice to l1GasPrice
  - rename dataGasPrice to l1DataGasPrice
  - rename dataGasConsumed to l1DataGasConsumed
  - add l2GasConsumed, l2GasPrice fields
- Remove ComputationResources and update ExecutionResources
- Add InnerCallExecutionResources
- Remove constructor accepting only l1Gas in ResourceBoundsMapping
- Rename computationResources to executionResources in FunctionInvocation and change its type to InnerCallExecutionResources instead of ComputationResources
Add failureReason to GetTransactionStatusResponse

Linked issues

Closes #519

Breaking changes

This issue contains breaking changes
Not compatible with JSON-RPC 0.7.0 spec
Use resourceBounds instead of l1ResourceBounds param
ComputationResources has been removed; ExecutionResources and EstimateFeeResponse have been updated

…ructured-error-trace

…pping`

franciszekjob · 2024-10-23T07:15:40Z

lib/src/main/kotlin/com/swmansion/starknet/provider/Provider.kt

+    /**
+     * Get merkle paths in one of the state tries.
+     *
+     * Get merkle paths in one of the state tries: global state, classes, individual contract.
+     *
+     * @param classHashes list of class hashes for which we want to prove membership
+     * @param contractAddresses list of contract addresses for which we want to prove membership
+     * @param contractsStorageKeys list of contract address and storage keys pairs
+     *
+     * @throws RequestFailedException
+     */
+    fun getStorageProof(classHashes: List<Felt>? = null, contractAddresses: List<Felt>? = null, contractsStorageKeys: List<ContractStorageKey>? = null): Request<StorageProof>
+


note: It's a bit exceptional situation, due to the fact that creating overloads would cause a conflict, e.g. for

fun getStorageProof(classHashes: List<Felt>, contractsStorageKeys: List<ContractStorageKey>): Request<StorageProof>

and

fun getStorageProof(contractAddresses: List<Felt>, contractsStorageKeys: List<ContractStorageKey>): Request<StorageProof>

(compiler won't know which method to use, contractAddresses and classHashes are of the same type). So unfortunately we need to add default values here.

franciszekjob · 2024-10-23T11:22:47Z

note: This PR is still wip.

Tests will be addressed once devnet is not a blocker anymore.
Full description about included changes will be added later.

DelevoXDG · 2024-10-23T23:37:39Z

lib/src/main/kotlin/com/swmansion/starknet/account/Account.kt

        l1ResourceBounds: ResourceBounds,
+        l2ResourceBounds: ResourceBounds,


I wonder if we should just go ahead and accept ResourceBoundsMapping in all of these methods?

Previously, there was no reason to do so. Now, my rationale is:

It would simplify the signature

These methods will probably be often used with the same values, so might as well reduce boilerplate

When estimating fee prior to executing transactions, we can right away run EstimateFeeResponse.toResourceBounds and pass the result, transforming this:

val resourceBounds = estimateFee.values.first().toResourceBounds() executeV3(calls, resourceBounds.l1Gas, resourceBounds.l2Gas)

to more intuitive:

val resourceBounds = estimateFee.values.first().toResourceBounds() executeV3(calls, resourceBounds)

that doesn't require any knowledge of l1 or l2 gas to execute txs with auto estimated fees

Definitely, makes sense. Refactored.

I just don't fully like the fact that now the param of type ResourceBoundsMapping is named resourceBounds 😆 , but looks like it's because of this, so we can leave it.

I just don't fully like the fact that now the param of type ResourceBoundsMapping is named resourceBounds 😆 , but looks like it's because of this, so we can leave it.

That was the idea, but also the fact that resourceBoundsMapping doesn't seem like a good argument name from UX point of view.

I think such naming convention also makes sense in this particular case:

ResourceBounds - l1ResourceBounds, l2ResourceBounds

ResourceBoundsMapping - resourceBounds

lib/src/main/kotlin/com/swmansion/starknet/data/types/Payloads.kt

lib/src/main/kotlin/com/swmansion/starknet/data/types/Responses.kt

DelevoXDG · 2024-10-24T00:09:47Z

lib/src/main/kotlin/com/swmansion/starknet/data/types/SimulatedTransaction.kt

@@ -65,7 +65,7 @@ data class FunctionInvocation(
    val messages: List<OrderedMessageL2ToL1>,

    @SerialName("execution_resources")
-    val computationResources: ComputationResources,
+    val computationResources: ExecutionResources,


In the spec this still points to non-existent COMPUTATION_RESOURCES:
https://github.com/starkware-libs/starknet-specs/blob/647caa00c0223e1daab1b2f3acc4e613ba2138aa/api/starknet_trace_api_openrpc.json#L448

Probably something we should clarify

Here it points correctly (to EXECUTION_RESOURCES)

The name's also changed to Execution resources there.

I wonder if we should keep try to keep the old name to avoid breaking change, or do it earlier than later, since the spec is expected to introduce some breaking changes anyways?

lib/src/main/kotlin/com/swmansion/starknet/data/types/TransactionReceipt.kt

lib/src/main/kotlin/com/swmansion/starknet/provider/Provider.kt

DelevoXDG · 2024-10-24T00:23:14Z

lib/src/main/kotlin/com/swmansion/starknet/data/types/Payloads.kt

+    @SerialName("block_id")
+    val blockId: BlockId,


I don't think BlockId is needed:
https://github.com/starkware-libs/starknet-specs/blob/647caa00c0223e1daab1b2f3acc4e613ba2138aa/api/starknet_api_openrpc.json#L910

It is, please look here.

Got it, was just checking out the changes from the tag, not branch 😅

lib/src/main/kotlin/com/swmansion/starknet/data/types/Responses.kt

…s.kt Co-authored-by: Maksim Zdobnikau <[email protected]>

Co-authored-by: Maksim Zdobnikau <[email protected]>

…ion/starknet-jvm into feat/519-rpc-0.8.0

franciszekjob · 2024-10-24T14:26:22Z

Please check out spec on v0.8.0 branch while reviewing. Unfortunately, there were some changes so the listed PRs may not be fully up to date.

DelevoXDG

I like where this is going 👍🏻 Waiting for the tests

DelevoXDG · 2024-10-25T16:13:22Z

lib/src/main/kotlin/com/swmansion/starknet/account/StandardAccount.kt

+            resourceBounds = ResourceBoundsMapping(
+                ResourceBounds.ZERO,
+                ResourceBounds.ZERO,
+            ),


Nit:

Should we introduce ResourceBoundsMapping.ZERO? 🤔

I was also thinking about this, should be handy 👍 .

DelevoXDG · 2024-10-25T16:14:21Z

lib/src/main/kotlin/com/swmansion/starknet/data/types/Payloads.kt

+    @SerialName("block_id")
+    val blockId: BlockId,


Got it, was just checking out the changes from the tag, not branch 😅

DelevoXDG · 2024-10-25T16:22:53Z

lib/src/main/kotlin/com/swmansion/starknet/data/types/Responses.kt

+    @SerialName("node")
+    val node: MerkleNode,
+) {
+    @Serializable
+    sealed interface MerkleNode


Are you sure that works?

Seems to me like some custom serializer is needed for node 🤔

lib/src/test/kotlin/starknet/account/StandardAccountTest.kt

franciszekjob added 16 commits October 20, 2024 22:39

Adapt execution resources in data classes and methods

6ff3a2f

Update tests

4c2014d

Add failure reason to transaction receipt

625aa24

Add JSON RPC error data classes

b0005b6

Add contract execution error

4587b9d

Add failureReason to GetTransactionStatusResponse

5a96c51

Merge branch 'feat/519-2-transaction-status-error' into feat/519-3-st…

3c95565

…ructured-error-trace

Fix linting

d547cb7

Add getMessagesStatus in providers

25fdf9b

Add todos for getMessagesStatus tests

74658de

Add getStorageProof in Provider

84f7dc5

Add GetStorageProofPayload

5b81467

Add StorageProof, MerkleNode, ChildrenHashes, `NodeHashToNodeMa…

07a1f6f

…pping`

Add ContractStorageKey

12138c6

Refactor getStorageProof

06a8fd9

Add getStorageProof test with todo

31f798c

franciszekjob changed the title ~~Feat/519 rpc 0.8.0~~ Support RPC 0.8.0 Oct 22, 2024

franciszekjob added 5 commits October 22, 2024 15:56

Fix linting

0842ce5

Remove error-related changes

c77b48b

Add missing params in KDoc

6683874

Update tests

ddea038

Rename todo; Fix getMessagesStatus name

a1358d9

franciszekjob commented Oct 23, 2024

View reviewed changes

Rename todos

74f35a2

franciszekjob requested review from DelevoXDG and THenry14 October 23, 2024 11:22

franciszekjob and others added 3 commits October 23, 2024 15:29

Merge branch 'main' into feat/519-rpc-0.8.0

ff8e36a

Fix NodeHashToNodeMapping

13d81ad

Fix linting

9097231

Fix transaction hash calculator tests

475a7f7

DelevoXDG reviewed Oct 24, 2024

View reviewed changes

franciszekjob and others added 9 commits October 24, 2024 11:55

Update lib/src/main/kotlin/com/swmansion/starknet/data/types/Response…

9a55b18

…s.kt Co-authored-by: Maksim Zdobnikau <[email protected]>

Update lib/src/main/kotlin/com/swmansion/starknet/data/types/Payloads.kt

836a456

Co-authored-by: Maksim Zdobnikau <[email protected]>

Fix GetMessagesStatusResponse

b734973

Merge branch 'feat/519-rpc-0.8.0' of https://github.com/software-mans…

c6b4806

…ion/starknet-jvm into feat/519-rpc-0.8.0

Add MessageStatusList data class and serializer

2725046

Fix linting

18ad358

Change return type of getStorageProof to HttpRequest<StorageProof>

54d4402

Refactor NodeHashToNodeMappingItem; Add BinaryNode and EdgeNode

8688732

Fix linting

797911f

franciszekjob added 4 commits October 24, 2024 16:33

Remove unnecessarily added failure reason from tx receipt

11d2eaa

Refactor passing resource bounds

6614380

Fix linting

303317f

Update DeclareParamsV3 and InvokeParamsV3 constructor params

a183504

franciszekjob requested a review from DelevoXDG October 24, 2024 15:37

franciszekjob added 11 commits October 24, 2024 17:41

Fix resource bounds params in StandardAccount

635c6a6

Fix linting

a380e39

Add fixes for resource bounds

3af0e5c

Fix linting

63b8bd8

Rename computationResources to executionResources`

1e6190b

Update mock jsons in tests

a8722bb

Add InnerCallExecutionResources

5688593

Add DataResources sealed class

8f3061f

Fix linting

96dbac3

Rename DataResources to Resources

25fe29c

Restore JvmName annotation in Resources.kt

2b1c478

DelevoXDG reviewed Oct 25, 2024

View reviewed changes

Remove unnecessary formatting changes

8215452

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support RPC 0.8.0 #530

Support RPC 0.8.0 #530

franciszekjob commented Oct 22, 2024 •

edited

Loading

franciszekjob Oct 23, 2024

franciszekjob commented Oct 23, 2024 •

edited

Loading

DelevoXDG Oct 23, 2024

franciszekjob Oct 24, 2024 •

edited

Loading

DelevoXDG Oct 25, 2024

DelevoXDG Oct 24, 2024

franciszekjob Oct 24, 2024 •

edited

Loading

DelevoXDG Oct 25, 2024

DelevoXDG Oct 24, 2024

franciszekjob Oct 24, 2024 •

edited

Loading

DelevoXDG Oct 25, 2024

franciszekjob commented Oct 24, 2024 •

edited

Loading

DelevoXDG left a comment

DelevoXDG Oct 25, 2024

franciszekjob Oct 25, 2024

DelevoXDG Oct 25, 2024

DelevoXDG Oct 25, 2024

		l1ResourceBounds: ResourceBounds,
		l2ResourceBounds: ResourceBounds,

Support RPC 0.8.0 #530

Are you sure you want to change the base?

Support RPC 0.8.0 #530

Conversation

franciszekjob commented Oct 22, 2024 • edited Loading

Describe your changes

Support RPC 0.8.0.

Linked issues

Breaking changes

Choose a reason for hiding this comment

franciszekjob commented Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

franciszekjob Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob commented Oct 24, 2024 • edited Loading

DelevoXDG 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

franciszekjob commented Oct 22, 2024 •

edited

Loading

franciszekjob commented Oct 23, 2024 •

edited

Loading

franciszekjob Oct 24, 2024 •

edited

Loading

franciszekjob Oct 24, 2024 •

edited

Loading

franciszekjob Oct 24, 2024 •

edited

Loading

franciszekjob commented Oct 24, 2024 •

edited

Loading