onflow / flow-jvm-sdk

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

Examples use-case - create account #91

Closed lealobanov closed 1 month ago

lealobanov commented 1 month ago

Description

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes involve modifying the AccessAPIConnector class to enhance method visibility by changing several methods from private to public. A new utility class, ExamplesUtils, has been introduced for script loading. Additionally, the CreateAccountExample class has been added to facilitate account creation on the Flow blockchain. Test classes have been updated, with significant removals of methods, and a new test class has been created to ensure alignment with the updated code structure.

Changes

File(s) Change Summary
java-example/src/main/java/.../AccessAPIConnector.java, kotlin-example/src/main/kotlin/.../AccessAPIConnector.kt Method access levels adjusted from private to public for several methods, including getLatestBlockID and waitForSeal. The getAccountCreatedAddress method has been removed, indicating a redesign in account management and transaction handling.
java-example/src/main/java/.../ExamplesUtils.java A new utility class has been introduced with static methods for loading scripts, specifically loadScriptContent, which no longer declares a FileNotFoundException.
java-example/src/main/java/.../createAccount/CreateAccountExample.java A new class for account creation that encapsulates the necessary API interactions and transaction handling logic.
java-example/src/test/java/.../AccessAPIConnectorTest.java Significant removals of private methods and test logic indicate a shift in the testing strategy for account creation and token transfers, with the canCreateAnAccount test largely stripped of its original logic.
java-example/src/test/java/.../createAccount/CreateAccountExampleTest.java A new test class created to validate account creation and balance retrieval, utilizing JUnit 5 and designed to run in a Flow emulator environment.
java-example/src/test/java/.../sendTransaction/SendTransactionExampleTest.java A new test class introduced to validate sending transactions with methods for simple and complex transaction scenarios.
common/src/main/resources/cadence/.../greeting_script.cdc, common/src/main/resources/cadence/.../simple_transaction.cdc New Cadence transaction scripts defined for greeting and simple transactions, establishing basic transaction structures.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CreateAccountExample
    participant FlowAccessApi

    User->>CreateAccountExample: createAccount(payerAddress, publicKey)
    CreateAccountExample->>FlowAccessApi: Send transaction to create account
    FlowAccessApi-->>CreateAccountExample: Transaction result
    CreateAccountExample-->>User: Return new account address

🐰 In the meadow, changes hop,
The code now dances, no need to stop.
With functions bright and tests anew,
We celebrate the work that’s due!
A script, a call, all in line,
Thank you, coders, for the shine! 🌟


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

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 0e929578. ± Comparison against base commit 0e929578.

: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 0e929578. ± Comparison against base commit 0e929578.

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

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

18 files  18 suites   3m 32s :stopwatch: 41 tests 41 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit d4b5c81d.

: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 d4b5c81d.

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