Better events for corks and contract call observation

[cbrit]

Summary by CodeRabbit

• New Features

  • Introduced a new event type, EventTypeContractCallTxCompleted, to enhance event tracking for contract call transactions.
  • Added event emission for contract call executions, providing more visibility into transaction handling.

• Bug Fixes

  • No bug fixes were included in this release.

• Documentation

  • No documentation updates were made.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes made in this pull request involve modifications to two files within the gravity module. In the contract_call.go file, a new event emission is added to the contractCallExecuted method, which includes a new import for the fmt package. The events.go file sees the introduction of a new constant, EventTypeContractCallTxCompleted, which is used to represent a specific event related to contract call transactions. Overall, these changes enhance the event handling capabilities of the module without altering existing transaction handling logic.

Changes

File Path	Change Summary
module/x/gravity/keeper/contract_call.go	Added import for fmt package; introduced event emission in contractCallExecuted method with attributes for invalidationScope and invalidationNonce.
module/x/gravity/types/events.go	Added new constant EventTypeContractCallTxCompleted with value "contract_call_tx_completed".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Contract
    participant Keeper

    User->>Keeper: Execute Contract Call
    Keeper->>Contract: Process Call
    Contract-->>Keeper: Call Result
    Keeper->>Keeper: Emit Event(EventTypeContractCallTxCompleted)
    Keeper->>User: Return Result

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

module/x/gravity/types/events.go (1)

12-12: LGTM! Consider adding documentation.

The new constant follows the established naming patterns and integrates well with existing event types. However, it would be helpful to add a comment describing the purpose and context of when this event is emitted.

Add documentation above the constant:

+	// EventTypeContractCallExecuted represents an event emitted when a contract call is successfully executed
 	EventTypeContractCallExecuted     = "contract_call_executed"

module/x/gravity/keeper/contract_call.go (1)

70-74: LGTM: Event emission is well-structured

The event emission is correctly placed after the contract call completion and includes essential tracking information.

Consider these optional improvements:

 ctx.EventManager().EmitEvent(sdk.NewEvent(
   types.EventTypeContractCallExecuted,
   sdk.NewAttribute(types.AttributeKeyContractCallInvalidationScope, hex.EncodeToString(invalidationScope)),
-  sdk.NewAttribute(types.AttributeKeyContractCallInvalidationNonce, fmt.Sprint(invalidationNonce)),
+  sdk.NewAttribute(types.AttributeKeyContractCallInvalidationNonce, strconv.FormatUint(invalidationNonce, 10)),
+  sdk.NewAttribute(types.AttributeKeyContractAddress, completedCallTx.ContractAddress),
 ))

This would:

1. Use more explicit number formatting with strconv.FormatUint
2. Add contract address for better observability

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 198cad6 and d44d535.

📒 Files selected for processing (2)

• module/x/gravity/keeper/contract_call.go (2 hunks)
• module/x/gravity/types/events.go (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

module/x/gravity/keeper/contract_call.go (1)

6-6: LGTM: Import addition is appropriate

The fmt import is correctly placed within the standard library imports group and is necessary for the new event attribute formatting.