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: add rpc intercept to opsimulator #54

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Conversation

tremarkley
Copy link
Contributor

@tremarkley tremarkley commented Jul 17, 2024

Closes #17

Creates a handler in opsimulator that intercepts JSON RPC requests and checks which method is being called. This sets us up to be able to add special handing for interop transactions when the eth_sendRawTransaction method is called.

This does not handle batch transactions, we will need to update the handler to support them: #55

Summary by CodeRabbit

  • New Features

    • Added support for handling JSON-RPC requests in the simulator.
  • Future Enhancements

    • Introduced a placeholder for future interoperation validation logic.

Copy link
Contributor

coderabbitai bot commented Jul 17, 2024

Walkthrough

Walkthrough

The changes introduce the capability for the OpSimulator to handle JSON-RPC requests. A new type JSONRPCRequest and a handler function have been added, which processes incoming HTTP requests, checks the method, and forwards them using a Reverse Proxy. This implementation includes the interception of the eth_sendRawTransaction RPC call, as well as a placeholder for future invariant checking logic.

Changes

File Change Summary
opsimulator/opsimulator.go Added JSONRPCRequest struct, handler function to process JSON-RPC requests, and placeholder function checkInteropInvariants

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant OpSimulator
    participant ReverseProxy
    Note over Client,ReverseProxy: HTTP Request Flow
    Client->>OpSimulator: HTTP Request (JSON-RPC)
    OpSimulator->>OpSimulator: Parse JSON-RPC Request
    OpSimulator->>OpSimulator: Check Method (e.g., eth_sendRawTransaction)
    OpSimulator->>ReverseProxy: Forward Request
    ReverseProxy-->>OpSimulator: Response
    OpSimulator-->>Client: HTTP Response
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Intercept eth_sendRawTransaction (#17)

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.

@tremarkley
Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @tremarkley and the rest of your teammates on Graphite Graphite

@tremarkley tremarkley force-pushed the harry/rpc_intercept branch from 62a4821 to 3a77209 Compare July 17, 2024 22:07
@tremarkley tremarkley changed the title feat: refactor opsimulator to intercept rpcs feat: add rpc intercept to opsimulator Jul 17, 2024
@tremarkley tremarkley changed the title feat: add rpc intercept to opsimulator feat: add rpc intercept to opsimulator Jul 17, 2024
@tremarkley tremarkley marked this pull request as ready for review July 17, 2024 22:09
@tremarkley tremarkley requested a review from a team as a code owner July 17, 2024 22:09
@jakim929
Copy link
Contributor

wdyt about using https://github.com/ethereum/go-ethereum/blob/v1.13.15/rpc/handler.go?

otherwise we have to write our own logic to handle batches, formatting errors, etc.

Copy link
Contributor

@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

Outside diff range, codebase verification and nitpick comments (1)
opsimulator/opsimulator.go (1)

129-131: Placeholder function is defined correctly!

The checkInteropInvariants function is a placeholder for future logic. Consider adding a TODO comment to indicate future work.

+// TODO: Implement the logic for checking interop transaction invariants.
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 65b029d and 3a77209.

Files selected for processing (1)
  • opsimulator/opsimulator.go (4 hunks)
Additional comments not posted (1)
opsimulator/opsimulator.go (1)

42-47: Struct definition looks good!

The JSONRPCRequest struct is well-defined with appropriate JSON tags.

opsimulator/opsimulator.go Outdated Show resolved Hide resolved
@tremarkley tremarkley force-pushed the harry/rpc_intercept branch from 3a77209 to d6b37ff Compare July 17, 2024 23:22
Copy link
Contributor

@jakim929 jakim929 left a comment

Choose a reason for hiding this comment

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

looks good! ignore my comment below, I think we can add more robust json-rpc handling (with batching) later

one nit

opsimulator/opsimulator.go Show resolved Hide resolved
@tremarkley tremarkley force-pushed the harry/rpc_intercept branch from d6b37ff to aa215f0 Compare July 17, 2024 23:24
@tremarkley tremarkley force-pushed the harry/rpc_intercept branch from aa215f0 to 5969786 Compare July 17, 2024 23:25
Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a77209 and 5969786.

Files selected for processing (1)
  • opsimulator/opsimulator.go (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • opsimulator/opsimulator.go

@tremarkley tremarkley merged commit 0c0a8d6 into main Jul 17, 2024
3 checks passed
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.

op-simulator: intercept eth_sendRawTransaction
2 participants