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(crosschain): do not check zetachain sender for failed revert outbound #3166

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Nov 15, 2024

Description

If status is CctxStatus_PendingRevert when processing a failed outbound then the sender chain will not be ZetaChain but the chain that initiated the inbound

Closes: #3165

Summary by CodeRabbit

  • Bug Fixes

    • Improved sender chain validation for outbound transactions to ensure it occurs before processing, enhancing clarity and reliability.
  • Refactor

    • Reorganized code for better flow and consistency in error handling related to sender chain validation.

@lumtis lumtis added no-changelog Skip changelog CI check V2_TESTS Run make start-v2-test labels Nov 15, 2024
Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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
📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve the processFailedOutboundV2 method within the cctx_orchestrator_validate_outbound.go file. The sender chain check for ZetaChain has been moved to the beginning of the types.CctxStatus_PendingOutbound case. This reordering ensures that the validation of the sender chain occurs prior to processing any related transactions, thereby enhancing the clarity of the control flow. The error handling associated with this check has also been updated for consistency, while the overall functionality remains unchanged.

Changes

File Path Change Summary
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go Moved sender chain check for ZetaChain to the beginning of the PendingOutbound case; updated error handling for consistency.

Assessment against linked issues

Objective Addressed Explanation
Remove sender chain check in processFailedOutboundV2 (#3165) The check was relocated rather than removed, which does not fulfill the issue's requirement.

Possibly related PRs

Suggested labels

breaking:cli, zetacore, CONSENSUS_BREAKING_ACK

Suggested reviewers

  • fbac
  • kingpinXD
  • swift1337
  • skosito
  • brewmaster012

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 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 Nov 15, 2024

Codecov Report

Attention: Patch coverage is 0% with 12 lines in your changes missing coverage. Please review.

Project coverage is 62.85%. Comparing base (3c22fbb) to head (340bc98).
Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
...hain/keeper/cctx_orchestrator_validate_outbound.go 0.00% 12 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3166   +/-   ##
========================================
  Coverage    62.84%   62.85%           
========================================
  Files          424      424           
  Lines        30140    30138    -2     
========================================
  Hits         18942    18942           
+ Misses       10360    10358    -2     
  Partials       838      838           
Files with missing lines Coverage Δ
...hain/keeper/cctx_orchestrator_validate_outbound.go 70.83% <0.00%> (+0.58%) ⬆️

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

🧹 Outside diff range and nitpick comments (1)
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (1)

332-341: Improve error handling consistency

The error handling in this block uses different styles (errors.Wrap vs fmt.Errorf). Consider standardizing the error handling approach.

Consider this improvement:

-		if err != nil {
-			return errors.Wrap(err, "failed to get ZetaChain chainID")
-		}
-		if cctx.InboundParams.SenderChainId != zetaChain.ChainId {
-			return fmt.Errorf(
-				"sender chain for withdraw cctx is not ZetaChain expected %d got %d",
-				zetaChain.ChainId,
-				cctx.InboundParams.SenderChainId,
-			)
-		}
+		if err != nil {
+			return errors.Wrap(err, "failed to get ZetaChain chainID")
+		}
+		if cctx.InboundParams.SenderChainId != zetaChain.ChainId {
+			return errors.Errorf(
+				"sender chain for withdraw cctx is not ZetaChain (expected: %d, got: %d)",
+				zetaChain.ChainId,
+				cctx.InboundParams.SenderChainId,
+			)
+		}
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 330-341: x/crosschain/keeper/cctx_orchestrator_validate_outbound.go#L330-L341
Added lines #L330 - L341 were not covered by tests

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3c22fbb and 1cd6f59.

📒 Files selected for processing (1)
  • x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

🪛 GitHub Check: codecov/patch
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go

[warning] 330-341: x/crosschain/keeper/cctx_orchestrator_validate_outbound.go#L330-L341
Added lines #L330 - L341 were not covered by tests

🔇 Additional comments (1)
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (1)

330-341: ⚠️ Potential issue

Verify alignment with PR objectives regarding ZetaChain sender check

The PR objectives state that we should not check the ZetaChain sender for failed revert outbound transactions. However, this code block implements a ZetaChain sender check. If this check is specifically for withdraw transactions (as suggested by the error message), this should be clearly documented in the code comments.

Let's verify the intended behavior:

Consider:

  1. Adding a comment explaining why this check is necessary for withdraw transactions
  2. Adding test coverage for this validation logic
  3. Clarifying if this check should be skipped for revert transactions as per PR objectives

Would you like assistance in generating the test cases?

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 330-341: x/crosschain/keeper/cctx_orchestrator_validate_outbound.go#L330-L341
Added lines #L330 - L341 were not covered by tests

@lumtis lumtis added this pull request to the merge queue Nov 15, 2024
Merged via the queue into develop with commit 470ba7d Nov 15, 2024
40 of 41 checks passed
@lumtis lumtis deleted the fix/invalid-zetachain-outbound-checl branch November 15, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check V2_TESTS Run make start-v2-test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove sender chain check in processFailedOutboundV2
4 participants