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

execute v1 with custom signature #270

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

piotr-stec
Copy link
Collaborator

@piotr-stec piotr-stec commented Jan 31, 2025

Summary by CodeRabbit

  • New Features
    • Added support for sending transactions with custom signatures in both V1 and V3 execution implementations
    • Introduced methods to prepare and send transactions using user-defined signatures
    • Enabled more flexible transaction signing across different account execution types

Copy link

coderabbitai bot commented Jan 31, 2025

Walkthrough

The pull request introduces new asynchronous methods send_with_custom_signature and get_invoke_request_with_custom_signature for ExecutionV1, ExecutionV3, PreparedExecutionV1, and PreparedExecutionV3 implementations. These methods enable sending transactions with custom signatures, providing more flexibility in transaction signing. The changes maintain the existing transaction preparation and sending logic while allowing users to provide their own signatures for transactions.

Changes

File Changes
openrpc-testgen/src/utils/v7/accounts/account/execution.rs - Added send_with_custom_signature method for ExecutionV1, PreparedExecutionV1, ExecutionV3, and PreparedExecutionV3
- Added get_invoke_request_with_custom_signature method for the same implementations

Possibly related PRs

Suggested reviewers

  • Uacias

Poem

🐰 Signatures dance, custom and free,
Transactions leap with newfound glee,
Rust code weaves a flexible spell,
Where signatures can now rebel!
A rabbit's code, both swift and bright ✨


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.

@neotheprogramist neotheprogramist merged commit 0741ae5 into main Jan 31, 2025
4 checks passed
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 256b794 and 686bfe8.

📒 Files selected for processing (1)
  • openrpc-testgen/src/utils/v7/accounts/account/execution.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run cargo_clippy - rust stable
  • GitHub Check: Build project - rust stable
🔇 Additional comments (3)
openrpc-testgen/src/utils/v7/accounts/account/execution.rs (3)

203-211: LGTM! Implementation follows existing patterns.

The method correctly delegates to the prepared execution while maintaining proper error handling.


841-852: LGTM! Clean and focused implementation.

The method correctly constructs the transaction request with the custom signature while maintaining all other transaction parameters.


802-816: Verify signature validation requirements.

While the implementation is correct, consider whether any validation of the custom signature is required before broadcasting the transaction.

Run this script to check for signature validation patterns in the codebase:

Comment on lines +203 to +211
pub async fn send_with_custom_signature(
&self,
signature: Vec<Felt>,
) -> Result<AddInvokeTransactionResult<Felt>, AccountError<A::SignError>> {
self.prepare()
.await?
.send_with_custom_signature(signature)
.await
}
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Add documentation for custom signature methods.

Consider adding documentation comments to explain:

  • The purpose of custom signature methods
  • Any requirements or validation for custom signatures
  • Security implications of using custom signatures

Example documentation:

+    /// Sends the transaction with a custom signature instead of using the account's signing mechanism.
+    /// 
+    /// # Arguments
+    /// * `signature` - The custom signature to use for the transaction
+    /// 
+    /// # Security Considerations
+    /// Ensure the custom signature is valid and authorized for this transaction.
     pub async fn send_with_custom_signature(

Also applies to: 802-816, 841-852

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