coderabbitai[bot]
commented
1 month ago Walkthrough
The changes in this pull request involve updates to documentation and code related to retrieving execution data in the Java and Kotlin examples, as well as modifications to the FlowTransactionResult data class and its associated tests. New sections have been added to the README files for both Java and Kotlin examples, detailing how to get execution data and stream events. Additionally, the FlowTransactionResult class has been enhanced with new properties, and related test cases have been updated to reflect these changes.
Changes
| File Path | Change Summary |
|---|---|
java-example/README.md |
Added "Get Execution Data" section with a link to the Java example. Adjusted "Examples summary" table. |
kotlin-example/README.md |
Added "Get Execution Data" and "Streaming Events and Execution Data" sections. |
sdk/src/main/kotlin/org/onflow/flow/sdk/models.kt |
Updated FlowTransactionResult class to include new properties: blockId, blockHeight, transactionId, collectionId, computationUsage. |
sdk/src/test/kotlin/org/onflow/flow/sdk/FlowAccessApiTest.kt |
Renamed blockId to flowId and updated related method calls and object constructions. |
sdk/src/test/kotlin/org/onflow/flow/sdk/models/FlowTransactionResultTest.kt |
Updated FlowTransactionResult instantiation in tests to include new parameters. |
sdk/src/test/kotlin/org/onflow/flow/sdk/impl/AsyncFlowAccessApiImplTest.kt |
Updated FlowTransactionResult instantiation to include new parameters in tests. |
sdk/src/test/kotlin/org/onflow/flow/sdk/impl/FlowAccessApiImplTest.kt |
Updated FlowTransactionResult instantiation and added error handling tests for subscription methods. |
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
Ensure FlowTransactionResult matches protobuf schema (#106) |
✅ |
Possibly related issues
- onflow/flow-jvm-sdk#115: The changes in the PR align with the need to address differences with the Access API as outlined in this issue.
Possibly related PRs
- #55: This PR introduces new methods in the
AsyncFlowAccessApifor retrieving transactions and execution results by block ID, which aligns with the main PR's focus on enhancing documentation related to accessing execution data. - #63: Similar to #55, this PR adds new functions to the
FlowAccessApifor retrieving transactions and execution results by block ID, directly related to the changes in the main PR. - #89: This PR introduces the
GetExecutionDataAccessAPIConnectorclass, which provides functionality for retrieving execution data by block ID, directly related to the main PR's focus on execution data. - #90: This PR introduces the
ExecuteScriptAccessAPIConnector, which includes methods for executing scripts that may involve retrieving execution data, thus connecting to the main PR's theme of enhancing execution data access. - #98: This PR updates the README files for Kotlin and Java examples, which likely includes documentation related to the execution data functionalities introduced in the main PR.
- #99: This PR focuses on updating the main README for the Flow JVM SDK, which may include references to the execution data functionalities discussed in the main PR.
Suggested reviewers
- jribbink
- franklywatson
🐰 In the meadow, where the data flows,
New sections sprout, as knowledge grows.
With examples bright, and tests refined,
We hop along, with clarity aligned.
Fetching execution, oh what a delight,
In the world of code, we take flight! 🌼
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
github-actions[bot]
Closes: #106
Description
Adds the missing fields to
FlowTransactionResult:computationUsageAs well as missing fields which the Go SDK had but the JVM SDK did not:
blockIdblockHeightcollectionIdtransactionIdFor contributor use:
masterbranchFiles changedin the Github PR explorerSummary by CodeRabbit
Release Notes
New Features
Bug Fixes
Documentation