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

Use default tx expiration from flow-go #734

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Conversation

peterargue
Copy link
Contributor

@peterargue peterargue commented Jan 27, 2025

Closes: #???

Description

Update's the key management logic to use the transaction expiration from flow-go (600 blocks)


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

  • Chores
    • Updated account key block expiration to use Flow SDK's default transaction expiry
    • Added import for Flow SDK package

Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request modifies the services/requester/key_store.go file by updating the accountKeyBlockExpiration constant to use flow.DefaultTransactionExpiry instead of a hardcoded value of 1_000. This change involves adding an import for the Flow SDK's flow package and replacing the static expiration value with a dynamic, SDK-defined transaction expiry value. The modification suggests an alignment with the Flow blockchain's standard transaction expiration mechanism.

Changes

File Change Summary
services/requester/key_store.go - Added import for github.com/onflow/flow-go/model/flow
- Updated accountKeyBlockExpiration constant from 1_000 to flow.DefaultTransactionExpiry

Possibly related PRs

  • Update flow-go #612: Updates the version of the flow-go dependency, directly related to the package import and constant change

Suggested labels

Improvement, EVM

Suggested reviewers

  • zhangchiqing

Poem

🐰 A rabbit's tale of keys and flow,
Where constants dance and boundaries grow,
From hardcoded walls to dynamic might,
SDK's wisdom shines ever so bright!
Expiry redefined, a blockchain's delight! 🔑✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47aae3e and 9d68812.

📒 Files selected for processing (1)
  • services/requester/key_store.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test
🔇 Additional comments (2)
services/requester/key_store.go (2)

9-9: LGTM! Clean import addition.

The import is necessary for accessing the DefaultTransactionExpiry constant and follows Go conventions.


14-14: Verify the impact of reduced key expiration time.

The change from a hardcoded 1000 blocks to flow.DefaultTransactionExpiry (600 blocks) means keys will be unlocked earlier. While this aligns better with flow-go's defaults, please verify:

  1. That dependent systems can handle the reduced expiration time
  2. Whether this change requires documentation updates
  3. If this should be mentioned in the changelog

Let's verify the DefaultTransactionExpiry value and its usage:

✅ Verification successful

Change to use Flow SDK's default transaction expiry is safe.

The modification to use flow.DefaultTransactionExpiry only affects the internal key unlocking logic in the key store. No other components in the codebase depend on this value, and using the SDK's standard value improves maintainability and consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the DefaultTransactionExpiry value and its usage in flow-go

# Check the DefaultTransactionExpiry value in flow-go
rg -A 1 "DefaultTransactionExpiry.*=.*600" 

# Look for any configuration overrides of this value
rg -A 5 "DefaultTransactionExpiry.*=|TransactionExpiry.*="

# Check for any documentation mentioning transaction expiry
fd -e md -e txt | xargs rg -i "transaction.*expiry|key.*expiry"

Length of output: 171


Script:

#!/bin/bash
# Find the flow package import and transaction expiry usage
rg -g '*.go' "\"github.com/onflow.*flow.*\"" -A 3

# Find any transaction expiry related constants or configurations
rg -g '*.go' -i "transaction.*expiry|key.*expiry"

# Find usage of accountKeyBlockExpiration
rg -g '*.go' "accountKeyBlockExpiration"

Length of output: 37889

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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.

Copy link
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@peterargue peterargue merged commit e250f39 into main Jan 27, 2025
2 checks passed
@peterargue peterargue deleted the petera/update-tx-expiration branch January 27, 2025 20:25
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