search

onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 10 forks source link

Block endpoints with many transactions fail with rate limit error #548

Closed m-Peter closed 2 months ago

m-Peter commented 2 months ago

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

Description

To avoid this, instead of re-using the eth_getTransactionByHash method directly, we extract its logic to a helper function, avoiding the possibility of rate-limit errors for blocks with many transactions.

For contributor use:

Summary by CodeRabbit

These changes enhance the overall efficiency and maintainability of the blockchain API, leading to a smoother user experience.

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces changes to the BlockChainAPI methods, focusing on transaction and block data retrieval. It replaces direct calls to GetTransactionByHash with a new method, prepareTransactionResponse, enhancing code structure. The prepareBlockResponse method has also been simplified by removing the context parameter. These modifications aim to improve code readability and maintainability by centralizing transaction handling and reducing redundancy.

Changes

File Change Summary
api/api.go - Added prepareTransactionResponse method.
- Modified prepareBlockResponse to remove context parameter.

Assessment against linked issues

Objective Addressed Explanation
Block endpoints with many transactions fail with rate limit error (#547) ✅

Possibly related PRs

Poem

🐰 In the blockchain's dance, we tidy up,
With methods refined, we fill the cup.
Transactions flow, no more a mess,
Simplified calls, we surely impress!
Hopping along, our code shines bright,
A clearer path, oh what a delight! 🌟

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 016588a62594777c815a34a0b643538c7b324ef9 and 2baf0469f5b9f8ad8b055b85744fb6ceabf05c64.
Files selected for processing (1) * api/api.go (7 hunks)
Additional comments not posted (4)
api/api.go (4)
Line range hint `278-288`: **LGTM!** The changes to `GetTransactionByBlockHashAndIndex` look good. Extracting the transaction retrieval and response preparation logic into `b.prepareTransactionResponse` improves code readability and maintainability. --- Line range hint `326-332`: **LGTM!** The changes to `GetTransactionByBlockNumberAndIndex` look good. Extracting the transaction retrieval and response preparation logic into `b.prepareTransactionResponse` improves code readability and maintainability. --- Line range hint `935-950`: **LGTM!** The changes to `fetchBlockTransactions` look good. Using `b.prepareTransactionResponse` to prepare each transaction response improves code readability and maintainability. --- `953-967`: **LGTM!** The new `prepareTransactionResponse` function looks good. Extracting the transaction retrieval and response preparation logic into a separate function reduces code duplication and improves readability.
--- 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 , 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 generate interesting stats about this repository and render them as a table.` -- `@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 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](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.