Update `eth_syncing` endpoint to return `false` when the Gateway has caught up syncing all EVM blocks

[m-Peter]

Closes: https://github.com/onflow/flow-evm-gateway/issues/376

Description

As per the JSON-RPC API Specification, when the current indexed block and the highest network block are equal, eth_syncing should return false, instead of the syncing status object.

---

For contributor use:

• [x] Targeted PR against master branch
• [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• [x] Code follows the standards mentioned here.
• [x] Updated relevant documentation
• [x] Re-reviewed Files changed in the Github PR explorer
• [x] Added appropriate labels

Summary by CodeRabbit

• New Features

  • Enhanced API for improved context management in the syncing process, allowing for more efficient operation and early termination when already synchronized.
  • Introduced a new end-to-end test for verifying the synchronization status of the Ethereum node, improving test coverage.
  • New test suite created to validate Ethereum node syncing behavior during transaction loads.

• Bug Fixes

  • Simplified syncing status tests to focus on binary state verification, improving clarity and reducing complexity.

[coderabbitai[bot]]

Walkthrough

The modifications enhance the synchronization status handling in the Ethereum API by optimizing context management and introducing an early return mechanism in the Syncing method. Additionally, the test suite expands its coverage to validate synchronization scenarios more effectively, ensuring that the API adheres to the specifications outlined in the linked issues.

Changes

Files	Change Summary
api/api.go	Updated Syncing method to use provided context and added condition to return false if currentBlock equals highestBlock.
tests/e2e_web3js_test.go	Added a new test case for retrieving syncing status, enhancing coverage of Web3 functionality.
tests/web3js/eth_non_interactive_test.js	Simplified syncing status test to assert only if the node is syncing, removing detailed block comparisons.
tests/web3js/eth_syncing_status_test.js	Introduced to verify Ethereum node synchronization status through transactions, ensuring expected behavior under load.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Blockchain

    Client->>API: Call eth_syncing()
    API->>Blockchain: Get latest EVM height with context
    Blockchain-->>API: Latest height data
    API->>API: Check if currentBlock == highestBlock
    alt Syncing Required
        API-->>Client: Return syncing info
    else No Syncing
        API-->>Client: Return false
    end

Assessment against linked issues

Objective	Addressed	Explanation
Update eth_syncing call to match JSON-RPC API specification (376)	✅
Return false when currentBlock equals highestBlock	✅

🐰 In the land where data streams flow,
A rabbit hops where the blocks brightly glow.
With context in hand, syncing's now swift,
No more delays, just a seamless uplift!
In tests, we dance, checking status with glee,
Ethereum's pulse is as smooth as can be! 🐇✨

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.