refactor(katana-pool): enable ordering using BTreeSet

[kariy]

Summary by CodeRabbit

• New Features

  • Enhanced transaction ordering mechanism for improved prioritization based on tip values.
  • Introduced new data structures for more efficient transaction management within the pool.

• Bug Fixes

  • Adjusted comparison logic for transaction priorities to ensure consistent ordering.

• Documentation

  • Updated unit tests for both FIFO and tip-based ordering to validate new functionality.

• Chores

  • Removed obsolete test functions reflecting a shift in testing strategy.

[coderabbitai]

Walkthrough

Ohayo, sensei! The recent changes involve updates to the Cargo.toml file, specifically adjusting the configuration for the katana-executor dependency. Significant modifications were made to the transaction ordering logic in ordering.rs, including the introduction of a new Tip struct. The internal structure of the transaction pool was also revamped for improved efficiency, and the ordering logic for transactions was refined to ensure consistent behavior when priorities are equal.

Changes

File	Change Summary
Cargo.toml	Removed default-features = false from katana-executor dependency, enabling default features.
crates/katana/pool/src/ordering.rs	Updated transaction ordering logic; renamed Tip<T> to TipOrdering<T>, introduced new Tip struct, and added unit tests for FIFO and tip-based ordering.
crates/katana/pool/src/pool.rs	Changed transactions field type from Vec to RwLock<BTreeSet>, updated insertion method, and derived PartialEq and Eq for PoolTx.
crates/katana/pool/src/tx.rs	Modified Ord implementation for PendingTx to ensure consistent ordering when priorities are equal.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f9d8f0 and b55405d.

Files selected for processing (2)

• crates/katana/pool/src/ordering.rs (2 hunks)
• crates/katana/pool/src/tx.rs (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• crates/katana/pool/src/tx.rs

Additional comments not posted (6)

crates/katana/pool/src/ordering.rs (6)

56-56: LGTM!

The reversal of the cmp method in the Ord implementation for TxSubmissionNonce ensures that lower nonce values have higher priority, which is a logical approach for transaction ordering.

---

79-79: LGTM!

The introduction of the TipOrdering struct to encapsulate a PhantomData<T> is a good approach to encapsulate the ordering logic.

---

81-81: LGTM!

The new method is a standard approach to initialize the TipOrdering struct.

---

88-88: LGTM!

The introduction of the Tip struct to hold a u64 value is a good approach to encapsulate the tip value.

---

90-94: LGTM!

The cmp method in the Ord implementation for Tip ensures that higher tip values have higher priority, which is a logical approach for transaction ordering based on tips.

---

110-115: LGTM!

The PoolOrd implementation for TipOrdering<T> has been updated to return a Tip instance instead of a u64 for the priority value, reflecting the new ordering strategy based on the Tip struct.

---

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

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]

Codecov Report

Attention: Patch coverage is 92.40506% with 6 lines in your changes missing coverage. Please review.

Project coverage is 67.84%. Comparing base (fea03f4) to head (b55405d).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/katana/pool/src/ordering.rs	92.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2370      +/-   ##
==========================================
+ Coverage   67.63%   67.84%   +0.21%     
==========================================
  Files         359      359              
  Lines       46977    46958      -19     
==========================================
+ Hits        31775    31861      +86     
+ Misses      15202    15097     -105     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.