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(starknet_provider): add missing JSON RPC error code 41 #481

Merged

Conversation

ptisserand
Copy link
Collaborator

@ptisserand ptisserand commented Mar 4, 2025

  • JSON RPC error code 41 (TRANSACTION_EXECUTION_ERROR) was missing

JSON RPC spec

Summary by CodeRabbit

  • New Features
    • Enhanced error handling by introducing a dedicated indicator for transaction execution failures. This improvement provides clearer feedback when a transaction issue occurs, helping to diagnose and resolve problems more effectively.

Copy link

docs-page bot commented Mar 4, 2025

To view this pull requests documentation preview, visit the following URL:

docs.page/focustree/starknet.dart~481

Documentation is deployed and generated using docs.page.

Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Walkthrough

The changes introduce a new enumeration value, TRANSACTION_EXECUTION_ERROR with a corresponding JSON value of 41, to the JSON RPC API error handling within the provider package. The update spans both the enum definition and its generated mapping file without altering any existing values.

Changes

File(s) Summary
packages/starknet_provider/lib/src/model/json_rpc_api_error.dart
packages/starknet_provider/lib/src/model/json_rpc_api_error.g.dart
Added a new enum value TRANSACTION_EXECUTION_ERROR with JSON value 41 to enhance error handling for transaction execution failures.

Poem

I'm just a bunny, hopping through code with glee,
Adding new errors to set the transaction worries free.
With each new line, my heart jumps with delight,
Coding under the moon and stars so bright.
Hop on, fellow coders, let's soar to new heights! 🐇✨


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/starknet_provider/lib/src/model/json_rpc_api_error.dart (1)

51-52: The addition of TRANSACTION_EXECUTION_ERROR enum value is appropriate.

This change correctly implements the missing JSON RPC error code 41 for transaction execution errors as specified in the PR objectives. The placement after code 40 (CONTRACT_ERROR) and before code 50 (INVALID_CONTRACT_CLASS) maintains the numerical ordering of the enum values.

Consider adding a source comment similar to other enum values for consistency and documentation purposes. For example:

  @JsonValue(41)
- TRANSACTION_EXECUTION_ERROR,
+ TRANSACTION_EXECUTION_ERROR, // from JSON-RPC API spec
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fab8cd5 and fabe084.

📒 Files selected for processing (2)
  • packages/starknet_provider/lib/src/model/json_rpc_api_error.dart (1 hunks)
  • packages/starknet_provider/lib/src/model/json_rpc_api_error.g.dart (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test-integration
  • GitHub Check: lint
  • GitHub Check: analyze
🔇 Additional comments (1)
packages/starknet_provider/lib/src/model/json_rpc_api_error.g.dart (1)

39-39: Addition of TRANSACTION_EXECUTION_ERROR code looks good.

The implementation correctly adds the new error code to the generated map with the value 41, maintaining the numerical ordering of the error codes in the map.

@ptisserand ptisserand merged commit 947dde3 into focustree:main Mar 4, 2025
10 checks passed
@ptisserand ptisserand deleted the fix/add-missing-JSON-RPC-error-41 branch March 4, 2025 18:30
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