Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(katana): separate deprecated declared class #2903

Merged
merged 4 commits into from
Jan 14, 2025
Merged

Conversation

kariy
Copy link
Member

@kariy kariy commented Jan 14, 2025

Currently, we're including both legacy and non-legacy into the same map in the StateUpdates struct, while instead the legacy should be put into a different map ie deprecated_declared_classes.

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced management of legacy and deprecated class declarations.
    • Improved tracking of class hashes in state updates.
  • Bug Fixes

    • Updated state update mechanisms to better handle legacy class management.
  • Refactor

    • Restructured class declaration and state update processes.
    • Improved data structure management for class tracking.
    • Adjusted test framework to validate state updates for declared and deprecated classes.

Copy link

coderabbitai bot commented Jan 14, 2025

Walkthrough

Ohayo, sensei! This pull request focuses on refining the handling of deprecated declared classes across multiple components of the Katana project. The changes introduce a more nuanced approach to managing class declarations, specifically distinguishing between active and deprecated classes. The modifications span several key files in the executor, primitives, RPC types, and storage provider modules, implementing a consistent strategy for tracking legacy classes using BTreeSet and updating state update mechanisms accordingly.

Changes

File Change Summary
crates/katana/executor/src/.../utils.rs - Added BTreeSet import
- Modified state_update_from_cached_state to handle deprecated declared classes
- Introduced deprecated_declared_classes tracking
crates/katana/primitives/src/chain_spec.rs - Removed DEFAULT_LEGACY_UDC_COMPILED_CLASS_HASH constant
- Updated UDC class handling to use deprecated_declared_classes
crates/katana/rpc/rpc-types/src/state_update.rs - Added deprecated_declared_classes as Vec<ClassHash>
- Modified StateDiff struct initialization
crates/katana/storage/provider/src/providers/db/mod.rs - Added BTreeSet import
- Updated state_update function to handle declared and deprecated classes
- Modified class declaration retrieval logic

Possibly related PRs

Suggested reviewers

  • glihm

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99d7867 and 77fb02a.

📒 Files selected for processing (1)
  • crates/katana/rpc/rpc/tests/starknet.rs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/katana/rpc/rpc/tests/starknet.rs

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

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.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.05%. Comparing base (a5377ac) to head (77fb02a).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2903      +/-   ##
==========================================
+ Coverage   55.84%   56.05%   +0.20%     
==========================================
  Files         449      449              
  Lines       57730    57861     +131     
==========================================
+ Hits        32242    32434     +192     
+ Misses      25488    25427      -61     

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

@kariy kariy merged commit 1ca1257 into main Jan 14, 2025
15 checks passed
@kariy kariy deleted the katana/state-update branch January 14, 2025 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants