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

Update supported endpoints section in README #202

Merged

Conversation

m-Peter
Copy link
Collaborator

@m-Peter m-Peter commented Apr 11, 2024

Description

The following JSON-RPC endpoints are now supported:

  • eth_newFilter
  • eth_uninstallFilter
  • eth_getFilterChanges
  • eth_newBlockFilter
  • eth_newPendingTransactionFilter

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

  • New Features
    • Introduced new JSON-RPC methods for enhanced blockchain interaction capabilities.
  • Documentation
    • Updated the list of supported methods, removing duplicates for clarity.

@m-Peter m-Peter added Documentation Improvements or additions to documentation EVM labels Apr 11, 2024
@m-Peter m-Peter self-assigned this Apr 11, 2024
Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Walkthrough

The update enhances the JSON-RPC interface by introducing five new methods related to Ethereum filters and block transactions, improving functionality and user interaction. It also cleans up the documentation by removing redundant entries, streamlining the list of supported methods.

Changes

File Changed Summary of Changes
README.md Added new JSON-RPC methods (eth_newFilter, eth_uninstallFilter, eth_getFilterChanges, eth_newBlockFilter, eth_newPendingTransactionFilter) and removed duplicate method entries

🐇✨
Oh hoppy day, new methods lay,
In the code where bytes do play.
Filters fresh and blocks anew,
Bugs in rows, we bid adieu.
Let our digital garden grow,
With every commit, our joy we show! 🌱🎉


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between df4fa6d and ed17960.
Files selected for processing (1)
  • README.md (2 hunks)
Additional comments not posted (1)
README.md (1)

177-181: The addition of new JSON-RPC methods is correctly implemented and well-documented.


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.

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.
  • 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.

@m-Peter m-Peter requested a review from franklywatson April 11, 2024 17:07
@franklywatson franklywatson merged commit 2e053fd into onflow:main Apr 11, 2024
1 check passed
@m-Peter m-Peter deleted the update-supported-endpoints-section branch April 11, 2024 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation EVM
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants