Access api methods - aggregate changes into main branch

lealobanov commented 4 months ago

Description

Pulls in changes from https://github.com/onflow/flow-jvm-sdk/pull/61 to main

For contributor use:

[ ] Targeted PR against master branch
[ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[ ] Code follows the standards mentioned here.
[ ] Updated relevant documentation
[ ] Re-reviewed Files changed in the Github PR explorer
[ ] Added appropriate labels

Summary by CodeRabbit

New Features
- Introduced methods for retrieving transactions, transaction results, and execution results by block ID in the Flow Access API.
- Added new data classes (FlowChunk, FlowServiceEvent, FlowExecutionResult) for detailed execution result handling.
Tests
- Implemented comprehensive test cases for new transaction and execution result retrieval methods by block ID.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent update to the Flow SDK introduces new methods for retrieving transactions, transaction results, and execution results by block ID. Both synchronous and asynchronous versions of these methods have been added to their respective interfaces and implementations. Additionally, new data models for handling execution results, service events, and data chunks have been introduced. Comprehensive tests have been included to validate these new functionalities, ensuring robustness and reliability.

Changes

Files	Change Summary
`src/main/kotlin/org/onflow/flow/sdk/AsyncFlowAccessApi.kt`	Added asynchronous methods for retrieving transactions, transaction results, and execution results by block ID.
`src/main/kotlin/org/onflow/flow/sdk/FlowAccessApi.kt`	Added synchronous methods for retrieving transactions, transaction results, and execution results by block ID.
`src/main/kotlin/org/onflow/flow/sdk/impl/...`	Implemented new methods in `AsyncFlowAccessApiImpl` and `FlowAccessApiImpl` for retrieving data by block ID.
`src/main/kotlin/org/onflow/flow/sdk/models.kt`	Added new data classes `FlowChunk`, `FlowServiceEvent`, and `FlowExecutionResult` with conversion and comparison methods.
`src/test/kotlin/org/onflow/flow/sdk/...`	Added and updated test cases for the new methods to ensure coverage for transactions, results retrieval by block ID, and handling of various scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AsyncFlowAccessApi
    participant FlowAccessApiImpl
    participant FlowBlockchain

    Note over Client,AsyncFlowAccessApi: Asynchronous API call to get transactions by block ID

    Client->>AsyncFlowAccessApi: getTransactionsByBlockId(blockId)
    AsyncFlowAccessApi->>FlowAccessApiImpl: getTransactionsByBlockId(blockId)
    FlowAccessApiImpl->>FlowBlockchain: fetchTransactions(blockId)
    FlowBlockchain->>FlowAccessApiImpl: List<FlowTransaction>
    FlowAccessApiImpl->>AsyncFlowAccessApi: List<FlowTransaction>
    AsyncFlowAccessApi->>Client: CompletableFuture<List<FlowTransaction>>

    Note over Client,FlowAccessApiImpl: Synchronous API call to get execution result by block ID

    Client->>FlowAccessApiImpl: getExecutionResultByBlockId(blockId)
    FlowAccessApiImpl->>FlowBlockchain: fetchExecutionResult(blockId)
    FlowBlockchain->>FlowAccessApiImpl: FlowExecutionResult
    FlowAccessApiImpl->>Client: FlowExecutionResult

Poem

In the world of Flow, data streams anew,
Transactions and results by block ID, in full view.
Asynchronous calls, so swift and bright,
Ensure our blockchain flows just right.
Chunks and events, neatly in place,
Our tests ensure there's not a trace misplaced.
🐇🔍✨

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?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 4 months ago

Unit Test Results

0 files ±0 0 suites ±0 0s :stopwatch: ±0s 0 tests ±0 0 :heavy_check_mark: ±0 0 :zzz: ±0 0 :x: ±0

Results for commit 26af3e0a. ± Comparison against base commit 26af3e0a.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 4 months ago

Integration Test Results

0 files ±0 0 suites ±0 0s :stopwatch: ±0s 0 tests ±0 0 :heavy_check_mark: ±0 0 :zzz: ±0 0 :x: ±0

Results for commit 26af3e0a. ± Comparison against base commit 26af3e0a.

onflow / flow-jvm-sdk