Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to cadence 1.0 #62

Merged
merged 5 commits into from
Aug 9, 2024
Merged

Upgrade to cadence 1.0 #62

merged 5 commits into from
Aug 9, 2024

Conversation

janezpodhostnik
Copy link
Owner

@janezpodhostnik janezpodhostnik commented May 19, 2024

Summary by CodeRabbit

  • New Features

    • Updated access control for various contracts and functions to access(all) to ensure broader visibility and access.
    • Modified transaction functions to accept references to Account instead of AuthAccount.
    • Introduced new InclusiveRange class for enhanced functionality related to ranges.
  • Improvements

    • Enhanced the create_account_template and other account-related templates for better account management.
    • Added a new argument to the verifyAccountSignaturesTemplate function for improved security and functionality.
    • Updated dependencies in the project configuration for better performance and compatibility.

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 91.54930% with 12 lines in your changes missing coverage. Please review.

Project coverage is 84.79%. Comparing base (a41d66b) to head (99c5610).

Files Patch % Lines
flow_py_sdk/cadence/kinds.py 91.34% 9 Missing ⚠️
flow_py_sdk/cadence/types.py 89.65% 0 Missing and 3 partials ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #62      +/-   ##
==========================================
- Coverage   84.83%   84.79%   -0.05%     
==========================================
  Files          29       29              
  Lines        1807     1927     +120     
  Branches       94      102       +8     
==========================================
+ Hits         1533     1634     +101     
- Misses        261      277      +16     
- Partials       13       16       +3     
Flag Coverage Δ
unittests 84.79% <91.54%> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

coderabbitai bot commented May 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates across several Python example files primarily involve modifying access control keywords from pub to access(all), enhancing the visibility and accessibility of contracts, functions, and structures. Additionally, significant changes were made to account references and transaction preparation logic, transitioning from AuthAccount to Account. Updates to the flow_py_sdk templates reflect these modifications, promoting a more unified and flexible structure.

Changes

File Change Summary
examples/account_examples.py Updated access modifiers from pub to access(all), and changed function logic from addition to multiplication.
examples/events_examples.py Modified access control from pub to access(all) for the contract and its functions.
examples/scripts_examples.py Changed access control keywords from pub to access(all) for functions and structures.
examples/transactions_examples.py, flow_py_sdk/templates.py Updated prepare function to accept Account references instead of AuthAccount and adjusted template functions to use auth with &Account.

🐰 In fields of code where changes bloom,
Access widened, dispelling gloom.
Functions, structs, and contracts too,
Now more open, bright, and true.
Accounts with ease now intertwine,
In a dance of logic, pure and fine.
Celebrate the shift, a coder's delight,
With rabbits hopping in code's bright light. 🌟


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@janezpodhostnik
Copy link
Owner Author

@coderabbitai review

Copy link

coderabbitai bot commented May 19, 2024

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (2)
examples/events_examples.py (1)

Line range hint 25-25: Remove the unused variable events to clean up the code.

- events = await client.get_events_for_height_range(
-     type="flow.AccountCreated",
-     start_height=latest_block.height - 1,
-     end_height=latest_block.height,
- )
examples/transactions_examples.py (1)

Line range hint 28-28: Remove the unused variable transaction to clean up the code.

- transaction = Tx(
-     code="""transaction(){prepare(){log("OK")}}""",
-     reference_block_id=latest_block.id,
-     payer=account_address,
-     proposal_key=ProposalKey(
-         key_address=account_address,
-         key_id=0,
-         key_sequence_number=proposer.keys[0].sequence_number,
-     ),
- ).with_envelope_signature(
-     account_address,
-     0,
-     new_signer,
- )
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between a41d66b and a442a8a.
Files selected for processing (5)
  • examples/account_examples.py (4 hunks)
  • examples/events_examples.py (1 hunks)
  • examples/scripts_examples.py (4 hunks)
  • examples/transactions_examples.py (1 hunks)
  • flow_py_sdk/templates.py (4 hunks)
Additional Context Used
Ruff (2)
examples/events_examples.py (1)

25-25: Local variable events is assigned to but never used

examples/transactions_examples.py (1)

28-28: Local variable transaction is assigned to but never used

Additional comments not posted (13)
flow_py_sdk/templates.py (5)

38-39: Updated prepare function signature to use auth(BorrowValue) &Account aligns with Cadence 1.0 access control changes.


68-69: Updated prepare function signature in updateAccountContractTemplate to use auth(UpdateContract) &Account is consistent with Cadence 1.0 access control changes.


76-76: Updated prepare function signature in addAccountContractTemplate to use auth(AddContract) &Account is consistent with Cadence 1.0 access control changes.


84-84: Updated prepare function signature in removeAccountContractTemplate to use auth(RemoveContract) &Account is consistent with Cadence 1.0 access control changes.


Line range hint 92-138: The addition of domainSeparationTag: "FLOW-V0.0-user" in verifyAccountSignaturesTemplate enhances security and aligns with Cadence 1.0 features.

examples/scripts_examples.py (3)

21-21: Updated access control to access(all) in ExecuteScriptExample aligns with Cadence 1.0 changes.


57-57: Updated access control to access(all) in ExecuteScriptWithArgumentExample aligns with Cadence 1.0 changes.


Line range hint 86-98: Updated access control to access(all) in User struct and main function in ExecuteComplexScriptWithArgumentExample aligns with Cadence 1.0 changes.

examples/events_examples.py (1)

82-85: Updated access control to access(all) in EventDemo contract, Add event, and add function in EmitEventFromContractExample aligns with Cadence 1.0 changes.

examples/transactions_examples.py (1)

208-208: Updated prepare function signature to use &Account in SubmitMultiSignedTransactionExample aligns with Cadence 1.0 changes.

examples/account_examples.py (3)

83-84: Updated access control to access(all) in DeployContract aligns with Cadence 1.0 changes.


144-145: Updated access control to access(all) and changed function logic from addition to multiplication in UpdateContract aligns with Cadence 1.0 changes.

Also applies to: 193-194


244-245: Updated access control to access(all) in RemoveContract aligns with Cadence 1.0 changes.

@janezpodhostnik janezpodhostnik marked this pull request as ready for review August 9, 2024 15:28
@janezpodhostnik janezpodhostnik merged commit 7958270 into master Aug 9, 2024
4 of 5 checks passed
@janezpodhostnik janezpodhostnik deleted the janez/cadence-1.0 branch August 9, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants