Support batching multiple RPC requests #187

franciszekjob · 2024-04-25T08:43:28Z

Describe your changes

Suport batching multiple RPC requests

add StarknetRequest and StarknetBatchRequest structs
add StarknetProvider.batchRequests() accepting both list and variadic parameters
add JsonRpcParams enum and extension
add batch-related tests

Linked issues

Closes #186, #145

Breaking changes

This issue contains breaking changes

StarknetAccount
- executeV1(...) async throws -> StarknetInvokeTransactionResponse -> executeV1(...) -> StarknetRequest<StarknetInvokeTransactionResponse>
- executeV3(...) async throws -> StarknetInvokeTransactionResponse -> executeV3(...) -> StarknetRequest<StarknetInvokeTransactionResponse>
- executeV1(...) async throws -> StarknetInvokeTransactionResponse -> executeV1(...) -> StarknetRequest<StarknetInvokeTransactionResponse>
- executeV3(...) async throws -> StarknetInvokeTransactionResponse -> executeV3(...) -> StarknetRequest<StarknetInvokeTransactionResponse>
- estimateFeeV1(...) async throws -> StarknetFeeEstimate -> estimateFeeV1(...) -> StarknetRequest<[StarknetFeeEstimate]>
- estimateFeeV3(...) async throws -> StarknetFeeEstimate -> estimateFeeV3(...) -> StarknetRequest<[StarknetFeeEstimate]>
- estimateDeployAccountFeeV1(...) async throws -> StarknetFeeEstimate -> estimateDeployAccountFeeV1(...) -> StarknetRequest<[StarknetFeeEstimate]>
- estimateDeployAccountFeeV3(...) async throws -> StarknetFeeEstimate -> estimateDeployAccountFeeV3(...) -> StarknetRequest<[StarknetFeeEstimate]>
- getNonce() async throws -> Felt -> getNonce()-> StarknetRequest<Felt>
StarknetProvider
- specVersion() async throws -> String -> specVersion() -> StarknetRequest<String>
- callContract(...) async throws -> [Felt] -> callContract(...) -> StarknetRequest<[Felt]>
- estimateMessageFee(...) async throws -> StarknetFeeEstimate -> estimateMessageFee(...) -> StarknetRequest<StarknetFeeEstimate>
- getNonce() async throws -> Felt -> getNonce() -> StarknetRequest<Felt>
- addInvokeTransaction(...) async throws -> StarknetInvokeTransactionResponse -> addInvokeTransaction(...) -> StarknetRequest<StarknetInvokeTransactionResponse>
- add addDeployAccountTransaction(...) async throws -> StarknetDeployAccountResponse -> addDeployAccountTransaction(...) -> StarknetRequest<StarknetDeployAccountResponse>
- getClassHashAt(...) async throws -> Felt -> getClassHashAt(...) -> StarknetRequest<Felt>
- getBlockNumber() async throws -> UInt64 -> getBlockNumber() -> StarknetRequest<UInt64>
- getBlockHashAndNumber() async throws -> StarknetBlockHashAndNumber -> getBlockHashAndNumber() -> StarknetRequest<StarknetBlockHashAndNumber>
- getEvents(...) async throws -> StarknetGetEventsResponse -> getEvents(...) -> StarknetRequest<StarknetGetEventsResponse>
- getTransactionBy(...) async throws -> any StarknetTransaction -> getTransactionBy(...) -> StarknetRequest<StarknetTransaction>
- getTransactionReceiptBy(...) async throws -> any StarknetTransactionReceipt -> getTransactionReceiptBy(...) -> StarknetRequest<StarknetTransactionReceipt>
- getTransactionStatusBy(...) async throws -> StarknetGetTransactionStatusResponse -> getTransactionStatusBy(...) async throws -> StarknetRequest<StarknetGetTransactionStatusResponse>
- getChainId() async throws -> StarknetChainId -> getChainId() -> StarknetRequest<StarknetChainId>
- simulateTransactions(...) async throws -> [StarknetSimulatedTransaction] -> simulateTransactions(...) -> StarknetRequest<[StarknetSimulatedTransaction]>

…wift into feat/186-batch-multiple-rpc-requests

franciszekjob · 2024-05-10T13:31:15Z

Tests/StarknetTests/Providers/ProviderTests.swift


        XCTAssertEqual(simulations2.count, 2)
        XCTAssertTrue(simulations2[0].transactionTrace is StarknetInvokeTransactionTrace)
        XCTAssertTrue(simulations2[1].transactionTrace is StarknetDeployAccountTransactionTrace)
    }
+
+    func testBatchGetTransactionByHash() async throws {


Do we need to include more calls in this test?

There should be a test for incorrect responses order. Imho it should be placed in a separate class eg. JsonRpcResponseTests as it focuses on the responses parsing mechanism.

Wdyt? @DelevoXDG

I think that can be enough

Yes, should add such test to JsonRpcResponseTests

I've added test for incorrect responses order
Also getOrderedRpcResults() is now a separate internal function. It doesn't affect StarknetBatchRequest, but simplifies creating test for incorrect order.

…wift into feat/186-batch-multiple-rpc-requests

franciszekjob · 2024-05-16T14:20:30Z

Tests/StarknetTests/Accounts/AccountTest.swift

-        let nonce = try await account.getNonce()
-        let feeEstimate = try await account.estimateFeeV1(call: call, nonce: nonce)
+        let nonce = try await account.getNonce().send()
+        let feeEstimate = try await account.estimateFeeV1(call: call, nonce: nonce).send()[0]


The change of estimate fee return type resulted in having to access element [0] every time we use this metod. Unfortunately there isn't any other way, because first we need to send the request and the access its result.

franciszekjob · 2024-05-16T14:21:41Z

Tests/StarknetTests/Providers/ProviderTests.swift

@@ -30,16 +31,17 @@ final class ProviderTests: XCTestCase {
        }

        provider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)
+        batchProvider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)


Nit: could the variable name be improved?

I think we might wanna add batch to the StarknetProviderProtocol, WDYT?

Yup, I added it to the protocol 👍

If that's the case, can we just go ahead and use provider instead of batchProvider?

franciszekjob · 2024-05-16T14:24:42Z

Tests/StarknetTests/Providers/ProviderTests.swift

+        do {
+            let _ = try transactionsResponse[1].get().transaction.hash
+            XCTFail("Fetching transaction with nonexistent hash should fail")
+        } catch let error as StarknetProviderError {
+            switch error {
+            case let .jsonRpcError(_, message, _):
+                XCTAssertEqual(message, "Transaction hash not found", "Unexpected error message received")
+            default:
+                XCTFail("Expected JsonRpcError but received \(error)")
+            }
+        } catch {
+            XCTFail("Error was not a StarknetProviderError. Received error type: \(type(of: error))")
+        }


I don't really like the fact that there is double nesting here, maybe there's other way to access jsonRpcError message?

I understand the concern, but afaik we can't have some kind of property that is shared amongst all enums, enums in swift just work differently. So we'll have to stick to what's possible here 😅

franciszekjob · 2024-05-16T14:26:11Z

All requested changes have been addressed, I've also added few remarks about newly applied changes.

DelevoXDG · 2024-06-03T11:28:10Z

Sources/Starknet/Accounts/StarknetAccount.swift

        }

        if let paramsResourceBounds = params.resourceBounds {
            resourceBounds = paramsResourceBounds
        } else {
-            let feeEstimate = try await estimateFeeV3(calls: calls, nonce: nonce)
+            let feeEstimate = try await estimateFeeV3(calls: calls, nonce: nonce).send()[0]


Are you sure getting the first estimate is a valid approach?

It has been discussed in previous thread
#187 (comment)

Sources/Starknet/Accounts/StarknetAccount.swift

Sources/Starknet/Network/HttpNetworkProvider.swift

DelevoXDG · 2024-06-03T11:41:35Z

Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift

+public typealias EmptySequence = [String]
+public struct EmptyParams: Encodable {}


It could be theoretically achieved, if we decrease params' level of abstraction.

Can we do that? I think it would considerably simplify the codebase (no unnecessary generis, no public param structs), but if that's too much effort it can be done in a separate PR.

Sources/Starknet/Providers/StarknetProvider/StarknetProvider.swift

…ation()`

….com/software-mansion/starknet.swift into feat/186-batch-multiple-rpc-requests

DelevoXDG

Mostly ok, few minor comments to be addressed before merging

Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift

Sources/Starknet/Providers/StarknetProvider/StarknetProvider.swift

DelevoXDG · 2024-06-11T15:27:11Z

Tests/StarknetTests/Providers/ProviderTests.swift

+        do {
+            let _ = try transactionsResponse[1].get().transaction.hash
+            XCTFail("Fetching transaction with nonexistent hash should fail")
+        } catch let error as StarknetProviderError {
+            switch error {
+            case let .jsonRpcError(_, message, _):
+                XCTAssertEqual(message, "Transaction hash not found", "Unexpected error message received")
+            default:
+                XCTFail("Expected JsonRpcError but received \(error)")
+            }
+        } catch {
+            XCTFail("Error was not a StarknetProviderError. Received error type: \(type(of: error))")
+        }


I understand the concern, but afaik we can't have some kind of property that is shared amongst all enums, enums in swift just work differently. So we'll have to stick to what's possible here 😅

Sources/Starknet/Network/StarknetRequest.swift

Sources/Starknet/Network/StarknetBatchRequest.swift

DelevoXDG · 2024-06-11T15:35:52Z

Sources/Starknet/Network/StarknetBatchRequest.swift

+    }
+}
+
+func getOrderedRpcResults<U: Decodable>(rpcResponses: [JsonRpcResponse<U>], count: Int) -> [Result<U, StarknetProviderError>] {


Nit:

We can rename this to prepareOrderedRpcResults or orderRpcResults.

Also, I think we can just inline this.

I renamed it to orderRpcResults. It wasn't inlined on purpose - thanks to keeping it in separate function, ordering can be tested in testBatchResponseWithIncorrectOrder

DelevoXDG · 2024-06-11T15:56:50Z

Tests/StarknetTests/Providers/ProviderTests.swift

@@ -30,16 +31,17 @@ final class ProviderTests: XCTestCase {
        }

        provider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)
+        batchProvider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)


I think we might wanna add batch to the StarknetProviderProtocol, WDYT?

Sources/Starknet/Providers/StarknetProvider/StarknetProvider.swift

Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift

Co-authored-by: Maksim Zdobnikau <43750648+DelevoXDG@users.noreply.github.com>

….com/software-mansion/starknet.swift into feat/186-batch-multiple-rpc-requests

Co-authored-by: Maksim Zdobnikau <43750648+DelevoXDG@users.noreply.github.com>

…tion`

DelevoXDG

LGTM overall, can be merged after addressing the comments

Sources/Starknet/Network/StarknetBatchRequest.swift

DelevoXDG · 2024-06-12T11:52:57Z

Tests/StarknetTests/Providers/ProviderTests.swift

@@ -30,16 +31,17 @@ final class ProviderTests: XCTestCase {
        }

        provider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)
+        batchProvider = makeStarknetProvider(url: Self.devnetClient.rpcUrl)


If that's the case, can we just go ahead and use provider instead of batchProvider?

franciszekjob added 20 commits April 25, 2024 04:06

Add possibility ofid modification in JsonRpcPayload

d020773

Merge branch 'main' of https://github.com/software-mansion/starknet.s…

9f82f76

…wift into feat/186-batch-multiple-rpc-requests

Refactor sending rpc request for specVersion

b598af7

Format

b6b9a40

Add generic type of params in HttpRequest and buildRequest

3801260

Refactor method signatures to return HttpRequest

a1d84d2

Remove makeRequest and update methods to use buildRequest

b53eef0

Change access levels of request param types

5be5ad4

Update usage of StarknetProvider endpoints in tests

2af15e7

Format

53879fc

MoveHttpRequest. Add HttpBatchRequest and Request

0adb281

Add batchRequests method

f9df81b

Add testBatchGetTransactionByHash test

b00296b

Update testBatchGetTransactionByHash

a2739d2

Rename request files

f681f58

Remove batchRequests from StarknetProviderProtocol

00a123f

Order responses ordering

d0b66f0

Add batchRequests with variadic param requests

bfb3b25

Fix wrong variable name

871aefc

Update testBatchGetTransactionByHash test

1a74d7b

franciszekjob commented May 10, 2024

View reviewed changes

franciszekjob requested a review from DelevoXDG May 10, 2024 13:53

franciszekjob added 8 commits May 10, 2024 16:26

Merge branch 'main' of https://github.com/software-mansion/starknet.s…

33071cf

…wift into feat/186-batch-multiple-rpc-requests

Wrap values returned from batchRequests in Result

2fd5b3b

Add different transactions to testBatchGetTransactionByHash

1beafcb

Format

697d340

Add incrementing id in json rpc requests

af2b884

Refactor batchRequests

56f9916

Use variadic params in testBatchGetTransactionByHash

c6554a4

Refactor send in BatchRequest

917e8c9

Add separate provider for batching request tests

d96c19f

franciszekjob commented May 16, 2024

View reviewed changes

franciszekjob requested a review from DelevoXDG May 16, 2024 14:26

franciszekjob and others added 2 commits May 20, 2024 12:47

Update doc comments

3e261bc

Merge branch 'main' into feat/186-batch-multiple-rpc-requests

48b7fe9

DelevoXDG reviewed Jun 3, 2024

View reviewed changes

franciszekjob and others added 5 commits June 3, 2024 15:09

Rename getHttpRequestConfiguration() to `prepareHttpRequestConfigur…

3e8c6d3

…ation()`

Merge branch 'feat/186-batch-multiple-rpc-requests' of https://github…

3438030

….com/software-mansion/starknet.swift into feat/186-batch-multiple-rpc-requests

Add HttpNetworkProvider.encodePayload()

ed32ad6

Add EncodableParams

f7d6f9a

Merge branch 'main' into feat/186-batch-multiple-rpc-requests

0f74e6c

franciszekjob requested a review from DelevoXDG June 4, 2024 09:22

franciszekjob added 4 commits June 6, 2024 00:24

Update doc comment; Add emptyRequestList error

7f8749e

Remove public from encode() methods

fbc89d9

Restore EstimateMessageFeeParams as public

35ae6a2

Rename specVersion() to getSpecVersion()

64c9742

DelevoXDG reviewed Jun 11, 2024

View reviewed changes

franciszekjob and others added 6 commits June 11, 2024 19:29

Update Sources/Starknet/Network/StarknetRequest.swift

50f4ad7

Co-authored-by: Maksim Zdobnikau <43750648+DelevoXDG@users.noreply.github.com>

Update Sources/Starknet/Network/StarknetBatchRequest.swift

cb8cff3

Co-authored-by: Maksim Zdobnikau <43750648+DelevoXDG@users.noreply.github.com>

Minor naming changes

161731a

Merge branch 'feat/186-batch-multiple-rpc-requests' of https://github…

a5ddd1e

….com/software-mansion/starknet.swift into feat/186-batch-multiple-rpc-requests

Update Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift

4ea34f7

Co-authored-by: Maksim Zdobnikau <43750648+DelevoXDG@users.noreply.github.com>

Update JsonRpcParams cases naming; Remove `wrappedExecutableTransac…

5cfd536

…tion`

franciszekjob mentioned this pull request Jun 11, 2024

Disallow batching for some methods #201

Open

Move request batching methods to StarknetProviderProtocol

94c718d

DelevoXDG approved these changes Jun 12, 2024

View reviewed changes

Refactor orderRpcResults; Remove batchProvider

f5c82d4

franciszekjob merged commit a5c820a into main Jun 12, 2024
1 check passed

franciszekjob deleted the feat/186-batch-multiple-rpc-requests branch June 12, 2024 15:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support batching multiple RPC requests #187

Support batching multiple RPC requests #187

franciszekjob commented Apr 25, 2024 •

edited

Loading

franciszekjob May 10, 2024 •

edited

Loading

DelevoXDG May 15, 2024

franciszekjob May 16, 2024 •

edited

Loading

franciszekjob May 16, 2024

franciszekjob May 16, 2024 •

edited

Loading

DelevoXDG Jun 11, 2024

franciszekjob Jun 12, 2024

DelevoXDG Jun 12, 2024

franciszekjob May 16, 2024 •

edited

Loading

DelevoXDG Jun 11, 2024

franciszekjob commented May 16, 2024 •

edited

Loading

DelevoXDG Jun 3, 2024

franciszekjob Jun 3, 2024 •

edited

Loading

DelevoXDG Jun 3, 2024

DelevoXDG left a comment

DelevoXDG Jun 11, 2024

DelevoXDG Jun 11, 2024

franciszekjob Jun 11, 2024 •

edited

Loading

DelevoXDG Jun 11, 2024

DelevoXDG left a comment

DelevoXDG Jun 12, 2024

		public typealias EmptySequence = [String]
		public struct EmptyParams: Encodable {}

Support batching multiple RPC requests #187

Support batching multiple RPC requests #187

Conversation

franciszekjob commented Apr 25, 2024 • edited Loading

Describe your changes

Linked issues

Breaking changes

franciszekjob May 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob May 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob May 16, 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

franciszekjob May 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob commented May 16, 2024 • edited Loading

Choose a reason for hiding this comment

franciszekjob Jun 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

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

franciszekjob Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DelevoXDG left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franciszekjob commented Apr 25, 2024 •

edited

Loading

franciszekjob May 10, 2024 •

edited

Loading

franciszekjob May 16, 2024 •

edited

Loading

franciszekjob May 16, 2024 •

edited

Loading

franciszekjob May 16, 2024 •

edited

Loading

franciszekjob commented May 16, 2024 •

edited

Loading

franciszekjob Jun 3, 2024 •

edited

Loading

franciszekjob Jun 11, 2024 •

edited

Loading