Skip to content

Fix starknet_getCompiledCasm#713

Merged
FabijanC merged 3 commits intostarknet-0.13.4from
fix-get-compiled-casm
Mar 6, 2025
Merged

Fix starknet_getCompiledCasm#713
FabijanC merged 3 commits intostarknet-0.13.4from
fix-get-compiled-casm

Conversation

@FabijanC
Copy link
Copy Markdown
Contributor

@FabijanC FabijanC commented Mar 5, 2025 •
edited by coderabbitai Bot
Loading

Usage related changes

Development related changes

  • There was also an issue in the tests were block_id was unnecessarily specified, although not mentioned in the specs.
  • Simplify test names.
  • Serialize class hash Felt by relying on its implementation.

Checklist:

  • Checked out the contribution guidelines
  • Applied formatting - ./scripts/format.sh
  • No linter errors - ./scripts/clippy_check.sh
  • No unused dependencies - ./scripts/check_unused_deps.sh
  • No spelling errors - ./scripts/check_spelling.sh
  • Performed code self-review
  • Rebased to the latest commit of the target branch (or merged it into my branch)
    • Once you make the PR reviewable, please avoid force-pushing
  • Updated the docs if needed - ./website/README.md
  • Linked the issues resolvable by this PR - linking info
  • Updated the tests if needed; all passing - execution info
    • All that are expected to pass are passing.

Summary by CodeRabbit

  • Bug Fixes
    • Compiled contract responses now exclude unnecessary metadata, providing a cleaner and more consistent output.
    • The underlying API has been simplified by reducing redundant parameters, ensuring more straightforward interactions.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 5, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes modify the compilation flow for Sierra contract classes. In the core function, the result from compiling a Sierra contract is first stored in a mutable variable, then its pythonic_hints field is cleared (set to None) before returning the object. In parallel, the integration tests are updated by renaming functions for clarity and simplifying calls by removing the block_id parameter. Additionally, error handling in the JSON RPC response now explicitly checks for the presence of pythonic_hints.

Changes

File(s) Change Summary
crates/.../get_class_impls.rs Modified get_compiled_casm_impl(): stores compilation result in a mutable variable, explicitly clears pythonic_hints before returning, and preserves existing error handling for Cairo0 contracts.
tests/.../test_get_class.rs Renamed test functions for clarity; removed the block_id parameter from calls to get_compiled_casm; updated JSON RPC call payload; added stricter error checking that panics if pythonic_hints is present in the response.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant GetCasm as get_compiled_casm_impl()
    participant Compiler as compile_sierra_contract()
    
    Caller->>GetCasm: Call get_compiled_casm_impl(sierra_contract_class)
    GetCasm->>Compiler: compile_sierra_contract(sierra_contract_class)
    Compiler-->>GetCasm: return compiled_casm
    GetCasm->>GetCasm: Set pythonic_hints = None
    GetCasm-->>Caller: Return modified casm
Loading 
sequenceDiagram
    participant Test as Integration Test
    participant CasmFunc as get_compiled_casm()
    participant Server as JSON RPC Endpoint
    
    Test->>CasmFunc: Call get_compiled_casm(class_hash)
    CasmFunc->>Server: Send request { class_hash }
    Server-->>CasmFunc: Return response (compiled casm, optional pythonic_hints)
    CasmFunc->>CasmFunc: Validate response (panic if pythonic_hints exists)
    CasmFunc-->>Test: Return compiled casm
Loading

Suggested reviewers

  • marioiordanov

Poem

I hopped through code with leaps so bright,
Clearing hints that hid in plain sight.
Lines of tests now simpler and light,
With renamed paths guiding day and night.
I'm a rabbit coder, bounding with delight! 🐇

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

@FabijanC
Copy link
Copy Markdown
Contributor Author

FabijanC commented Mar 5, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 5, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@FabijanC FabijanC requested a review from marioiordanov March 5, 2025 09:40
@FabijanC FabijanC merged commit c657668 into starknet-0.13.4 Mar 6, 2025
@FabijanC FabijanC deleted the fix-get-compiled-casm branch March 6, 2025 10:26
@FabijanC FabijanC mentioned this pull request Mar 6, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@marioiordanov marioiordanov marioiordanov approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@FabijanC @marioiordanov