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

refactor(katana): use the exact same UDC class as Starknet #2949

Merged
merged 2 commits into from
Jan 24, 2025
Merged

Conversation

kariy
Copy link
Member

@kariy kariy commented Jan 24, 2025

The UDC class that is currently being used hash a class hash of 0x035e13e8852c6fc49a9d87f9448079f69d6dae1795fe64e8a737eab8fd24dcb0 while the one that Starknet is officially using has the class hash of 0x07b3e05f48f0c69e4a65ce5e076a66271a527aff2c34ce1083ec6e1526997a69.

The updated UDC class is exactly the same as the one used by Starknet therefore will result in the same class hash when it is computed. It is not an issue currently because we're hardcoding the class hash ourselves when it is inserted in the genesis. But we're moving away from allowing hardcoded class hash to maintain correctness.

The reason why we want to use the same version is to maintain compatibility and predictability across libs.


This doesn't introduce any breaking changes as the hardcoded class hash is the correct one for the new class.

Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

Ohayo, sensei! The pull request focuses on refactoring the universal_deployer.cairo contract file. The changes are primarily cosmetic, involving reformatting of function signatures and event emissions in the Universal Deployer Contract. The core functionality remains unchanged, with improvements aimed at enhancing code readability. The version comment has been updated, and the formatting of parameters has been streamlined to provide a cleaner, more consistent code structure.

Changes

File Change Summary
crates/katana/contracts/legacy/universal_deployer.cairo - Updated version comment from v0.6.1 to v0.5.1
- Reformatted ContractDeployed event parameters
- Restructured deployContract function signature for improved readability

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 8c484fd and 525dc4b.

📒 Files selected for processing (1)
  • crates/katana/contracts/legacy/universal_deployer.cairo (3 hunks)
🔇 Additional comments (5)
crates/katana/contracts/legacy/universal_deployer.cairo (5)

2-2: Ohayo, sensei! Confirm that the version reference is valid.
Switching from v0.6.1 to v0.5.1 may inadvertently introduce compatibility issues if the rest of the code still depends on v0.6.1 features.

Please confirm that all references to OpenZeppelin’s Cairo contracts have been updated accordingly throughout the codebase.


19-19: Ohayo, sensei! This parameter layout update is clean.
No functional changes are introduced in this event definition, and the updated layout appears consistent with standard formatting.


24-28: Ohayo, sensei! The updated function signature block is well-structured.
Moving each built-in pointer to its own line makes them more visible. This enhances the overall readability of the function declaration.


29-33: Ohayo, sensei! The parameter reformat boosts clarity.
Listing the parameters in separate lines improves maintainability, especially when the function signature evolves.


68-68: Ohayo, sensei! The final parameter mapping in the event emission is correct.
It cleanly mirrors the function’s inputs and ensures consistent tracking of salt in the logs.


🪧 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 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.86%. Comparing base (8c484fd) to head (525dc4b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2949   +/-   ##
=======================================
  Coverage   55.86%   55.86%           
=======================================
  Files         447      447           
  Lines       57859    57859           
=======================================
  Hits        32323    32323           
  Misses      25536    25536           

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

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.

1 participant