Remove obsolete config flags stream-limit & stream-timeout

[m-Peter]

Closes: #716

Description

---

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

• Documentation

  • Expanded README with comprehensive EVM Gateway details
  • Added sections on endpoints, JSON-RPC API, debugging, contributing, and licensing

• Configuration

  • Removed stream timeout and stream limit configurations
  • Simplified command-line and service setup options for event streaming

• Refactor

  • Streamlined configuration handling in multiple files
  • Removed unused streaming-related parameters

[coderabbitai]

Walkthrough

The pull request focuses on removing unused configuration flags related to streaming in the EVM Gateway, specifically stream-timeout and stream-limit. The changes involve removing these flags and associated configuration fields from multiple files including cmd/run/cmd.go, config/config.go, and tests/helpers.go. Additionally, the README.md has been extensively updated with comprehensive documentation about the EVM Gateway, including new sections on endpoints, JSON-RPC API, debugging, contributing, and licensing.

Changes

File	Change Summary
README.md	Added comprehensive sections on EVM Gateway, including endpoints, JSON-RPC API, debugging, contributing, and licensing
cmd/run/cmd.go	Removed streamTimeout variable and stream-timeout flag
config/config.go	Removed StreamLimit and StreamTimeout fields from Config struct
tests/helpers.go	Removed StreamTimeout and StreamLimit configuration parameters

Assessment against linked issues

Objective	Addressed	Explanation
Investigate unused flags --stream-limit and --stream-timeout [#716]	✅

Possibly related PRs

• Add request limits for JSON-RPC batch calls #277: This PR introduces new sections related to JSON-RPC APIs, which aligns with the new JSON-RPC API section added in the main PR's README.md, enhancing documentation for developers interacting with the EVM Gateway.
• Fix flaky E2E eth_streaming_test JS test #289: The modifications in the eth_streaming_test.js file involve streaming functionalities, which may relate to the expanded Debugging section in the main PR that provides instructions for profiling and debugging, relevant for testing streaming behavior.

Suggested labels

Improvement, EVM

Poem

🐰 Hop, hop, through the gateway's code,
Streaming flags, we now unload!
Cleaner config, simpler design,
EVM's path now brightly shines! 🌟
A rabbit's leap of clean refine! 🚀

---

📜 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 606297c and 40d58f4.

📒 Files selected for processing (4)

• README.md (0 hunks)
• cmd/run/cmd.go (0 hunks)
• config/config.go (0 hunks)
• tests/helpers.go (0 hunks)

💤 Files with no reviewable changes (4)

• tests/helpers.go
• README.md
• cmd/run/cmd.go
• config/config.go

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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