feat: submit reward must be successful on exocore chain

[adu-web3]

Description

To follow our design principal, we should assume that submitReward must be successful

Summary by CodeRabbit

• New Features

  • Enhanced error handling for reward submissions in the ExocoreGateway contract.

• Bug Fixes

  • Improved integrity of reward operations by preventing unexpected failures during submissions.

[coderabbitai]

Walkthrough

The changes in the pull request focus on the ExocoreGateway contract located in src/core/ExocoreGateway.sol. A new line was added to the handleRewardOperation function to enhance error handling during reward submissions. This line includes a revert statement that triggers an error if the reward submission fails, ensuring the contract's integrity. Other aspects of the contract's structure and functionality remain unchanged, preserving its existing capabilities related to interchain messaging and token transfers.

Changes

File Path	Change Summary
src/core/ExocoreGateway.sol	Added a revert statement in handleRewardOperation to check for successful reward submissions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExocoreGateway
    User->>ExocoreGateway: Submit Reward
    ExocoreGateway->>ExocoreGateway: Check Reward Submission
    alt Successful Submission
        ExocoreGateway-->>User: Reward Processed
    else Failed Submission
        ExocoreGateway-->>User: Revert Submission
    end

Loading

🐇 "In the garden where rewards bloom,
A check was added to avoid the gloom.
If the path is clear, the prize will flow,
But if it falters, 'Revert!' will show.
Hopping along, we keep things bright,
With every change, we hop with delight!" 🌼

---

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:

• 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 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 or @coderabbitai title 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 (1)

src/core/ExocoreGateway.sol (1)

417-419: Approved: Error handling for reward submission aligns with PR objective.

The added error handling ensures that reward submissions must be successful, which aligns with the PR objective. This change enhances the contract's integrity by preventing unexpected failures during reward submissions.

However, consider the following suggestions:

1. Use a more specific error message for reward submission failures. The current message DepositRequestShouldNotFail might be confusing in the context of reward submission.

2. Consider implementing similar error handling for other critical operations in the contract to maintain consistency and robustness.

Consider updating the error message to be more specific:

-            revert Errors.DepositRequestShouldNotFail(srcChainId, lzNonce);
+            revert Errors.RewardSubmissionShouldNotFail(srcChainId, lzNonce);

Don't forget to add the corresponding error message in the Errors library.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 09197a8 and e234bf2.

📒 Files selected for processing (1)

• src/core/ExocoreGateway.sol (1 hunks)

🧰 Additional context used