Examples use-cases - transaction signing

lealobanov commented 1 month ago

Description

Transaction signing examples:

Single Party, single signature
Single Party, multi-sig
Multi-party
Multi party, 2 authorizers
Multi party, multi-sig

This PR also includes some minor refactoring on the examples tests

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 functionality to add a public key to an account's key set for enhanced account management.
- Added a framework for creating and managing non-fungible tokens (NFTs) with unique identifiers and special characteristics.
- Implemented methods for deploying smart contracts on the Flow blockchain, streamlining the deployment process.
- Enhanced transaction handling with new utility methods for improved error management and transaction result processing.
Bug Fixes
- Improved clarity and organization in test cases, ensuring better readability and maintainability.
Tests
- Added comprehensive unit tests for adding keys to accounts and deploying contracts, ensuring robustness in functionality.

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce new functionalities for adding public keys to accounts and enhance the transaction signing process within the Flow blockchain framework. New classes and methods are added for managing non-fungible tokens (NFTs) and deploying contracts. Additionally, unit tests are implemented to validate these functionalities, while existing methods are refactored for improved clarity and maintainability.

Changes

Files	Change Summary
`common/src/main/resources/cadence/add_key.cdc`, `common/src/main/resources/cadence/simple_transaction_2_authorizers.cdc`, `common/src/main/resources/cadence/test_utils_create_account.cdc`	New transaction definitions for adding keys and managing authorizers, with enhancements to account creation logic.
`common/src/main/resources/cadence/great_token.cdc`	New contract for creating and managing non-fungible tokens (NFTs) with associated minting logic.
`java-example/src/main/java/org/onflow/examples/java/AccessAPIConnector.java`, `java-example/src/main/java/org/onflow/examples/java/ExamplesUtils.java`	Refactored access methods and centralized script loading for better maintainability.
`java-example/src/main/java/org/onflow/examples/java/addKey/AddAccountKeyExample.java`, `java-example/src/main/java/org/onflow/examples/java/deployContract/DeployContractExample.java`	New classes for adding account keys and deploying contracts, encapsulating transaction logic.
`java-example/src/test/java/org/onflow/examples/java/addKey/AddAccountKeyExampleTest.java`, `java-example/src/test/java/org/onflow/examples/java/deployContract/DeployContractExampleTest.java`	New unit tests to validate functionalities for adding keys and deploying contracts.
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/AccessAPIConnector.kt`, `kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/addKey/AddAccountKeyExample.kt`, `kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/deployContract/DeployContractExample.kt`	New Kotlin classes for managing access and deploying contracts, enhancing the interaction with the Flow blockchain.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/addKey/AddAccountKeyExampleTest.kt`, `kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/deployContract/DeployContractExampleTest.kt`	New test suites to validate the functionalities for adding keys and deploying contracts in Kotlin.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlowBlockchain
    participant AddAccountKeyExample

    User->>AddAccountKeyExample: Request to add key
    AddAccountKeyExample->>FlowBlockchain: Construct transaction
    FlowBlockchain-->>AddAccountKeyExample: Transaction constructed
    AddAccountKeyExample->>FlowBlockchain: Sign transaction with private key
    FlowBlockchain-->>AddAccountKeyExample: Transaction signed
    AddAccountKeyExample->>User: Return transaction result

🐰 "In the meadow where bunnies play,
New transactions hop in every way!
With keys and signs, they dance around,
In Flow's embrace, joy can be found.
Hooray for changes, let’s all cheer,
For a brighter blockchain year!" 🐇✨

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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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

22 files 22 suites 4m 44s :stopwatch: 55 tests 55 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 6cef9e0f.

: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 52724b03. ± Comparison against base commit 52724b03.

: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 6cef9e0f.

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

github-actions[bot] commented 1 month ago

Integration Test Results

  6 files ±0   6 suites ±0 2m 34s :stopwatch: ±0s 30 tests ±0 30 :heavy_check_mark: ±0 0 :zzz: ±0 0 :x: ±0

Results for commit 52724b03. ± Comparison against base commit 52724b03.

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

onflow / flow-jvm-sdk