feat: tx queue for unordered txs requests #48

beer-1 · 2024-08-20T10:13:23Z

Description

Foundry script is sending txs in unordered, to handle these request we keep tx queue.

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title, you can find examples of the prefixes below:

confirmed ! in the type prefix if API or client breaking change
targeted the correct branch
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Introduced dynamic cache size configuration for the EVM indexer, enhancing flexibility and performance.
- Added transaction queuing capabilities to the JSON-RPC backend, improving transaction management.
- New error handling structure for JSON-RPC errors, enhancing robustness and clarity.
- Enhanced configurability for transaction management in the JSON-RPC server with new constants for queue capacity and TTL.
Bug Fixes
- Improved error handling in the JSON-RPC startup process to prevent invalid backend instances.
Style
- Minor formatting changes for better code organization and readability.
Chores
- Added new constants and flags for better configuration management related to EVM and JSON-RPC.

coderabbitai · 2024-08-20T10:13:34Z

Warning

Rate limit exceeded

@beer-1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 50 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a4d23d2 and 7a47fb4.

Walkthrough

The recent changes enhance the configuration and error handling of the EVM and JSON-RPC backend, improving transaction management and cache flexibility. Notable adjustments include dynamic cache size determination in the EVM indexer, the introduction of a transaction queue in the JSON-RPC backend, and enhanced error handling throughout. These updates collectively improve the robustness and configurability of the system, allowing for better resource management and operational performance.

Changes

Files	Change Summary
`indexer/indexer.go`	Modified `NewEVMIndexer` to dynamically configure cache size based on `evmKeeper`, improving flexibility.
`indexer/store.go`	Added a blank line between import statements for better readability.
`jsonrpc/backend/backend.go`	Updated `JSONRPCBackend` struct to include transaction queue and mutex, with an error-returning constructor.
`jsonrpc/backend/errors.go`	Introduced `InternalError` type for improved error handling in JSON-RPC, including methods for message formatting and codes.
`jsonrpc/backend/tx.go`	Enhanced `SendTx` method with mutex lock for thread safety and improved transaction handling logic.
`jsonrpc/config/config.go`	Added constants and fields for transaction management configuration, improving control over transaction handling in JSON-RPC.
`jsonrpc/jsonrpc.go`	Updated `StartJSONRPC` function to handle errors when creating the backend instance.
`x/evm/config/config.go`	Introduced `DefaultIndexerCacheSize` and a new command-line flag for configuring indexer cache size.
`x/evm/keeper/keeper.go`	Added `Config` method to `Keeper` struct for accessing EVM configuration settings.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Backend
    participant CacheStore
    participant Keeper

    User->>Backend: Send transaction
    Backend->>CacheStore: Lock access
    CacheStore->>Backend: Validate and queue transaction
    Backend->>Keeper: Retrieve configuration
    Keeper-->>Backend: Return EVM configuration
    Backend-->>User: Confirm transaction status

🐰 In the garden of code, we dance and play,
With tweaks and changes that brighten the day.
From caches dynamic to handling errors right,
Our software hops forward, a wondrous sight!
So let’s cheer for the builders, both clever and kind,
For improving our world, with changes designed! 🌼✨

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.

codecov · 2024-08-20T10:29:00Z

Codecov Report

Attention: Patch coverage is 0.87719% with 113 lines in your changes missing coverage. Please review.

Project coverage is 26.35%. Comparing base (a4d23d2) to head (7a47fb4).
Report is 1 commits behind head on main.

Files	Patch %	Lines
jsonrpc/backend/tx.go	0.00%	45 Missing ⚠️
jsonrpc/backend/backend.go	0.00%	24 Missing ⚠️
jsonrpc/config/config.go	0.00%	22 Missing ⚠️
jsonrpc/backend/errors.go	0.00%	7 Missing ⚠️
indexer/indexer.go	0.00%	5 Missing ⚠️
jsonrpc/jsonrpc.go	0.00%	5 Missing ⚠️
x/evm/config/config.go	25.00%	3 Missing ⚠️
x/evm/keeper/keeper.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #48      +/-   ##
==========================================
- Coverage   26.53%   26.35%   -0.19%     
==========================================
  Files         111      111              
  Lines       11770    11855      +85     
==========================================
+ Hits         3123     3124       +1     
- Misses       8202     8286      +84     
  Partials      445      445

Files	Coverage Δ
indexer/store.go	`69.23% <ø> (ø)`
x/evm/keeper/keeper.go	`68.53% <0.00%> (-1.58%)`	⬇️
x/evm/config/config.go	`38.46% <25.00%> (-1.54%)`	⬇️
indexer/indexer.go	`0.00% <0.00%> (ø)`
jsonrpc/jsonrpc.go	`0.00% <0.00%> (ø)`
jsonrpc/backend/errors.go	`0.00% <0.00%> (ø)`
jsonrpc/config/config.go	`0.00% <0.00%> (ø)`
jsonrpc/backend/backend.go	`0.00% <0.00%> (ø)`
jsonrpc/backend/tx.go	`0.00% <0.00%> (ø)`

Vritra4

LGTM

beer-1 added 8 commits August 20, 2024 16:32

use local logger

e0e667c

update bin files

f09ef49

impl tx queue in jsonrpc backend

d41330a

Merge branch 'main' of https://github.com/initia-labs/minievm

346de4d

Merge branch 'main' into feat/tx-queue

1a64990

hold lock for SendTx

d287bc4

fix to broadcast queued txs properly

625d487

print logs

3d35518

beer-1 requested a review from a team as a code owner August 20, 2024 10:13

beer-1 self-assigned this Aug 20, 2024

beer-1 added 2 commits August 20, 2024 19:14

remove comment

623cc4e

use colon

7a47fb4

Vritra4 approved these changes Aug 20, 2024

View reviewed changes

Vritra4 merged commit efcca2e into main Aug 20, 2024
7 of 8 checks passed

Vritra4 deleted the feat/tx-queue branch August 20, 2024 10:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: tx queue for unordered txs requests #48

feat: tx queue for unordered txs requests #48

beer-1 commented Aug 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Aug 20, 2024 •

edited

Loading

Vritra4 left a comment

feat: tx queue for unordered txs requests #48

feat: tx queue for unordered txs requests #48

Conversation

beer-1 commented Aug 20, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Aug 20, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Aug 20, 2024 • edited Loading

Codecov Report

Vritra4 left a comment

Choose a reason for hiding this comment

beer-1 commented Aug 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Aug 20, 2024 •

edited

Loading