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

feat(accounts): Add Query to simulate a UserOperation #18979

Merged
merged 1 commit into from
Jan 9, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Jan 8, 2024

Description

SimulateUserOperation can be used by Bundlers to simulate the outcome of the execution of a UserOp.

The rationale for not using SimulateTX is to give granularity over the operation itself.

If we were to simulate a TX the bundler would most likely receive a response with more information pertaining the execution of the TX and not the operation itself. This also removes burden from the state machine to execute a full tx when only the op is needed.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@testinginprod testinginprod requested a review from a team as a code owner January 8, 2024 20:34
Copy link
Contributor

coderabbitai bot commented Jan 8, 2024

Walkthrough

The recent modifications involve enhancing the Cosmos blockchain's account system by introducing account abstraction capabilities. A new RPC method, SimulateUserOperation, has been added to the Query service for simulating user operations. Accompanying this are new request and response message types and a test case for ensuring the simulation's correctness, including gas usage and error handling. The queryServer struct now supports this simulation with appropriate gas limit settings.

Changes

File(s) Change Summary
proto/cosmos/accounts/v1/query.proto Introduced import of account_abstraction.proto and added SimulateUserOperation RPC method with new message types for request and response.
tests/e2e/accounts/.../account_abstraction_test.go Added a test case for simulating user operations, checking gas usage and error handling.
x/accounts/query_server.go Updated queryServer struct with gas limit constants and implemented SimulateUserOperation method.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

github-actions bot commented Jan 8, 2024

@testinginprod your pull request is missing a changelog!

@testinginprod testinginprod mentioned this pull request Jan 8, 2024
44 tasks
@tac0turtle
Copy link
Member

how come this is needed over the global simulation method?

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

explained the need in a call. Can you update the pr description so readers know the reason for this feature @testinginprod

@testinginprod testinginprod added this pull request to the merge queue Jan 9, 2024
Merged via the queue into main with commit f431a50 Jan 9, 2024
63 of 64 checks passed
@testinginprod testinginprod deleted the tip/aa/simulate_op branch January 9, 2024 14:04
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
Co-authored-by: unknown unknown <unknown@unknown>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants