onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

Examples use-cases - execute Cadence script #90

Closed lealobanov closed 1 month ago

lealobanov commented 1 month ago

Description


For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@lealobanov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 30 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between d3edb757807efe4dea43c0d19cf7b3044dc21db3 and d3ad3b4619ebc7d5343787020634d816d5869983.

Walkthrough

The changes introduce enhancements to the Java and Kotlin implementations for executing Cadence scripts on the Flow blockchain. New utility functions for script loading are added, user management and basic arithmetic operations are expanded, and comprehensive unit tests are included to validate the execution processes. A method is removed to streamline script management, indicating a refactor in how scripts are handled.

Changes

File Path Change Summary
common/src/main/resources/cadence/...execute_complex_script_example.cdc
common/src/main/resources/cadence/...execute_simple_script_example.cdc
New structs and functions for user management and simple arithmetic operations in Cadence scripts introduced, including a User struct for user data and a function to add an integer.
java-example/src/main/java/...ExamplesUtils.java Introduces utility methods for loading scripts from the classpath, enhancing dynamic script loading capabilities.
java-example/src/main/java/...executeScript/...ExecuteScriptAccessAPIConnector.java Implements a connector class for executing Cadence scripts, managing responses, and parsing user data.
java-example/src/test/java/...executeScript/...ExecuteScriptAccessAPIConnectorTest.java Contains unit tests for validating the functionality of the script execution connector, ensuring correctness in both simple and complex script execution paths.
kotlin-example/src/main/kotlin/...AccessAPIConnector.kt Adds an import for script loading utility and removes the loadScript method, indicating a refactor in script management.
kotlin-example/src/main/kotlin/...ExamplesUtils.kt Introduces utility functions for script loading similar to the Java counterpart, aiding in script execution.
kotlin-example/src/main/kotlin/...executeScript/...ExecuteScriptAccessAPIConnector.kt Implements a Kotlin connector for executing Cadence scripts, similar to the Java version, with structured response handling.
kotlin-example/src/test/kotlin/...executeScript/...ExecuteScriptAccessAPIConnectorTest.kt Provides unit tests for the Kotlin connector class, validating that both simple and complex scripts execute as expected with proper response parsing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlowAccessApi
    participant ExecuteScriptAccessAPIConnector

    User->>ExecuteScriptAccessAPIConnector: executeSimpleScript()
    ExecuteScriptAccessAPIConnector->>FlowAccessApi: Load and execute script with parameter
    FlowAccessApi-->>ExecuteScriptAccessAPIConnector: Return FlowScriptResponse
    ExecuteScriptAccessAPIConnector-->>User: Return result

    User->>ExecuteScriptAccessAPIConnector: executeComplexScript()
    ExecuteScriptAccessAPIConnector->>FlowAccessApi: Load and execute script with parameter
    FlowAccessApi-->>ExecuteScriptAccessAPIConnector: Return FlowScriptResponse
    ExecuteScriptAccessAPIConnector-->>User: Return User data

Poem

🐇 In fields of code where rabbits play,
New scripts and functions hop their way.
With users to manage and tests to run,
Our blockchain journey has just begun!
Let’s dance with data, swift and bright,
In Cadence we trust, everything feels right! 🌟


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 Configuration 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 1 month ago

SDK Examples Unit Test Results

14 files  14 suites   3m 12s :stopwatch: 37 tests 37 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit d3ad3b46.

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

github-actions[bot] commented 1 month ago

Unit Test Results

  53 files  ±0    53 suites  ±0   23s :stopwatch: ±0s 310 tests ±0  310 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit d788cb12. ± Comparison against base commit d788cb12.

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

github-actions[bot] commented 1 month ago

Common Integration Test Results

1 files  1 suites   7s :stopwatch: 1 tests 1 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit d3ad3b46.

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

github-actions[bot] commented 1 month ago

Integration Test Results

  5 files  ±0    5 suites  ±0   2m 29s :stopwatch: ±0s 29 tests ±0  29 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit d788cb12. ± Comparison against base commit d788cb12.

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