fix(crosschain): add support to perform withdraws in ZetaChain onRevert call
#3348
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis pull request introduces enhancements to ZetaChain's cross-chain transaction handling, specifically focusing on withdrawal capabilities during the Changes
Sequence DiagramsequenceDiagram
participant Sender
participant ZetaChain
participant Gateway
participant ZRC20Token
Sender->>ZetaChain: Initiate Cross-Chain Transaction
ZetaChain->>Gateway: Process Transaction
alt Transaction Requires Revert
Gateway->>ZRC20Token: Check Withdrawal Conditions
ZRC20Token-->>Gateway: Withdrawal Approval
Gateway->>Sender: Execute Withdrawal
end
Possibly related PRs
Suggested Labels
Suggested Reviewers
The modifications represent a methodical approach to expanding ZetaChain's cross-chain transaction resilience, with particular emphasis on robust withdrawal mechanisms during transaction reversals. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
!!!WARNING!!! Be very careful about using Only suppress a single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the #nosec annotation, e.g: /* #nosec G401 */ or //#nosec G201 G202 G203 Pay extra attention to the way |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #3348 +/- ##
===========================================
+ Coverage 63.23% 63.38% +0.15%
===========================================
Files 436 436
Lines 30645 30674 +29
===========================================
+ Hits 19378 19444 +66
+ Misses 10432 10394 -38
- Partials 835 836 +1
|
lumtis
changed the title
crosschain): add support to perform withdraws in ZetaChain onRevert call
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (14)
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (2)
357-359: Maintain consistent context managementThe temporary context
tmpCtxand the correspondingcommitfunction should be declared immediately before their usage to enhance readability and maintain code consistency.Apply this diff to adjust the declaration:
- // use a temporary context to not commit any state change in case of error - tmpCtx, commit := ctx.CacheContext() - // process the revert on ZEVM + // use a temporary context to avoid committing state changes in case of error + tmpCtx, commit := ctx.CacheContext()
421-422: Provide detailed error messages for unexpected statusesThe default case in the switch statement returns a generic error message. Enhancing this message with more context can aid in debugging.
Apply this diff to improve the error message:
- return fmt.Errorf("unexpected cctx status %s", cctx.CctxStatus.Status) + return fmt.Errorf("processFailedOutboundV2: unexpected CCTX status %s", cctx.CctxStatus.Status)x/fungible/keeper/v2_deposits.go (1)
87-87: Clarify error messages for unsupported coin typesThe error message for unsupported
coinTypecould be more informative. Including the actualcoinTypevalue helps in quickly identifying the issue.Apply this diff to enhance the error message:
- return nil, errors.New("ZETA asset is currently unsupported for revert with V2 protocol contracts") + return nil, fmt.Errorf("ProcessV2RevertDeposit: coinType %s (ZETA asset) is unsupported for revert with V2 protocol contracts", coinType)🧰 Tools
🪛 GitHub Check: codecov/patch
[warning] 87-87: x/fungible/keeper/v2_deposits.go#L87
Added line #L87 was not covered by testsx/crosschain/types/expected_keepers.go (1)
164-164: Update function comments to match signature changesThe comment for the
ProcessV2RevertDepositmethod should be updated to reflect the new return type. This maintains accurate documentation and aids in code comprehension.Update the function comment to include the return of
(*evmtypes.MsgEthereumTxResponse, error).// ProcessV2RevertDeposit handles a revert deposit from an inbound tx with protocol version 2 + // Returns (*evmtypes.MsgEthereumTxResponse, error) ProcessV2RevertDeposit(testutil/keeper/crosschain.go (2)
311-319: Remove unused parameter documentation.The commented parameter documentation is not being used and should be removed to avoid confusion.
- // ctx types.Context - // inboundSender string - // amount *big.Int - // chainID int64 - // coinType coin.CoinType - // asset string - // revertAddress common.Address - // callOnRevert bool - // revertMessage []byte
320-332: Consider using specific matchers instead of mock.Anything.Using
mock.Anythingfor all parameters makes the mock too permissive. Consider using specific matchers for type safety and better test coverage:m.On( "ProcessV2RevertDeposit", - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, - mock.Anything, + mock.AnythingOfType("types.Context"), + mock.AnythingOfType("string"), + mock.AnythingOfType("*big.Int"), + mock.AnythingOfType("int64"), + mock.AnythingOfType("coin.CoinType"), + mock.AnythingOfType("string"), + mock.AnythingOfType("common.Address"), + mock.AnythingOfType("bool"), + mock.AnythingOfType("[]uint8"), ).Return(retEVMTxResponse, retErr).Once()x/crosschain/keeper/cctx_orchestrator_validate_outbound_test.go (5)
5-11: Consider grouping imports by standard library, external, and internal packages.The imports could be better organized for readability.
import ( + // Standard library "encoding/base64" "errors" + "math/big" + "testing" + + // External packages "github.com/ethereum/go-ethereum/core/vm" evmtypes "github.com/zeta-chain/ethermint/x/evm/types" - "math/big" - "testing" - cosmoserror "cosmossdk.io/errors"
63-84: Enhance test case description and error handling.The test case could be more descriptive and avoid magic strings in error assertions.
func TestKeeper_ValidateFailedOutboundV2(t *testing.T) { - t.Run("fail if can't fetch ZetaChain chain ID", func(t *testing.T) { + t.Run("should fail when ZetaChain chain ID cannot be parsed from context", func(t *testing.T) { // arrange k, ctx, _, _ := keepertest.CrosschainKeeper(t) cctx := sample.CrossChainTx(t, "test") cctx.ProtocolContractVersion = types.ProtocolContractVersion_V2 cctx.CctxStatus.Status = types.CctxStatus_PendingOutbound ctx = ctx.WithChainID("invalid") // act err := k.ValidateOutboundObservers( ctx, cctx, observertypes.BallotStatus_BallotFinalized_FailureObservation, sample.String(), ) // assert require.Error(t, err) - require.Contains(t, err.Error(), "failed to get ZetaChain chainID") + const expectedError = "failed to get ZetaChain chainID" + require.Contains(t, err.Error(), expectedError) })
146-147: Consider extracting error variable.The error variable could be extracted for better reusability and consistency.
- revertErr := vm.ErrExecutionReverted + const revertErr = vm.ErrExecutionReverted keepertest.MockProcessV2RevertDeposit(fungibleMock, nil, revertErr)
378-378: Consider using error constants.Define error constants for better maintainability and reusability.
- errorFailedZETARevertAndCallContract := cosmoserror.New("test", 999, "failed ZETARevertAndCallContract") + const ( + errCodeZETARevertAndCallContract = 999 + errMsgZETARevertAndCallContract = "failed ZETARevertAndCallContract" + ) + errorFailedZETARevertAndCallContract := cosmoserror.New("test", errCodeZETARevertAndCallContract, errMsgZETARevertAndCallContract)
63-63: Add test function documentation.Consider adding documentation to describe the test function's purpose and the scenarios it covers.
+// TestKeeper_ValidateFailedOutboundV2 tests the validation of failed outbound transactions +// for protocol contract version 2. It covers various failure scenarios including: +// - Chain ID validation +// - Source chain validation +// - Revert outbound handling +// - Transaction processing errors func TestKeeper_ValidateFailedOutboundV2(t *testing.T) {pkg/contracts/testdappv2/TestDAppV2.sol (2)
179-179: Clarify error message for mismatched fee tokensThe error message in the
requirestatement may confuse developers by suggesting that the ZRC20 token is not a gas token. Since the check is verifying that the fee token matches the asset being withdrawn, the error message should reflect the actual issue.Apply this diff to improve the error message:
- require(feeToken == revertContext.asset, "zrc20 is not gas token"); + require(feeToken == revertContext.asset, "Fee token does not match the asset being withdrawn");
245-247: Optimize string comparison inisWithdrawMessagefunctionUsing
keccak256withabi.encodePackedis unnecessary when comparing static strings. Comparing the hashes of the messages directly simplifies the function and reduces gas usage.Simplify the
isWithdrawMessagefunction:-function isWithdrawMessage(bytes memory message) internal pure returns (bool) { - return keccak256(message) == keccak256(abi.encodePacked("withdraw")); +function isWithdrawMessage(bytes memory message) internal pure returns (bool) { + bytes32 withdrawHash = keccak256("withdraw"); + return keccak256(message) == withdrawHash; }This change caches the hash of the static string
"withdraw", reducing repetitive computations.e2e/e2etests/test_eth_withdraw_and_call_revert_with_withdraw.go (1)
14-49: Ensure error handling for critical operationsThe test function lacks explicit error handling for critical operations, such as transactions and context retrieval. Adding checks for possible errors enhances test reliability and debuggability.
Consider adding error checks after critical operations:
// perform the withdraw tx, err := r.ETHWithdrawAndArbitraryCall( r.TestDAppV2EVMAddr, amount, r.EncodeGasCall("revert"), gatewayzevm.RevertOptions{ RevertAddress: r.TestDAppV2ZEVMAddr, CallOnRevert: true, RevertMessage: []byte("withdraw"), // call withdraw in the onRevert hook OnRevertGasLimit: big.NewInt(0), }, ) require.NoError(r, err, "Failed to perform ETH withdrawal and arbitrary call") // wait for the cctx to be mined cctxRevert, err := utils.WaitCctxMinedByInboundHash(r.Ctx, tx.Hash().Hex(), r.CctxClient, r.Logger, r.CctxTimeout) require.NoError(r, err, "Failed to wait for cctx to be mined")This ensures that any failures are caught and reported appropriately during testing.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pkg/contracts/testdappv2/TestDAppV2.binis excluded by!**/*.bin
📒 Files selected for processing (13)
changelog.md(1 hunks)cmd/zetae2e/local/evm.go(1 hunks)e2e/e2etests/e2etests.go(2 hunks)e2e/e2etests/test_eth_withdraw_and_call_revert_with_withdraw.go(1 hunks)pkg/contracts/testdappv2/TestDAppV2.go(1 hunks)pkg/contracts/testdappv2/TestDAppV2.json(1 hunks)pkg/contracts/testdappv2/TestDAppV2.sol(4 hunks)testutil/keeper/crosschain.go(1 hunks)testutil/keeper/mocks/crosschain/fungible.go(1 hunks)x/crosschain/keeper/cctx_orchestrator_validate_outbound.go(3 hunks)x/crosschain/keeper/cctx_orchestrator_validate_outbound_test.go(3 hunks)x/crosschain/types/expected_keepers.go(1 hunks)x/fungible/keeper/v2_deposits.go(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- pkg/contracts/testdappv2/TestDAppV2.json
👮 Files not reviewed due to content moderation or server errors (3)
- e2e/e2etests/e2etests.go
- pkg/contracts/testdappv2/TestDAppV2.go
- changelog.md
🧰 Additional context used
📓 Path-based instructions (10)
cmd/zetae2e/local/evm.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
testutil/keeper/crosschain.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
x/fungible/keeper/v2_deposits.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
e2e/e2etests/test_eth_withdraw_and_call_revert_with_withdraw.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
e2e/e2etests/e2etests.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
testutil/keeper/mocks/crosschain/fungible.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
x/crosschain/keeper/cctx_orchestrator_validate_outbound_test.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
x/crosschain/types/expected_keepers.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
pkg/contracts/testdappv2/TestDAppV2.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
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/fungible/keeper/v2_deposits.go
[warning] 62-62: x/fungible/keeper/v2_deposits.go#L62
Added line #L62 was not covered by tests
[warning] 72-72: x/fungible/keeper/v2_deposits.go#L72
Added line #L72 was not covered by tests
[warning] 80-81: x/fungible/keeper/v2_deposits.go#L80-L81
Added lines #L80 - L81 were not covered by tests
[warning] 84-84: x/fungible/keeper/v2_deposits.go#L84
Added line #L84 was not covered by tests
[warning] 87-87: x/fungible/keeper/v2_deposits.go#L87
Added line #L87 was not covered by tests
[warning] 91-91: x/fungible/keeper/v2_deposits.go#L91
Added line #L91 was not covered by tests
[warning] 99-99: x/fungible/keeper/v2_deposits.go#L99
Added line #L99 was not covered by tests
[warning] 102-103: x/fungible/keeper/v2_deposits.go#L102-L103
Added lines #L102 - L103 were not covered by tests
[warning] 107-107: x/fungible/keeper/v2_deposits.go#L107
Added line #L107 was not covered by tests
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go
[warning] 386-390: x/crosschain/keeper/cctx_orchestrator_validate_outbound.go#L386-L390
Added lines #L386 - L390 were not covered by tests
[warning] 393-399: x/crosschain/keeper/cctx_orchestrator_validate_outbound.go#L393-L399
Added lines #L393 - L399 were not covered by tests
🔇 Additional comments (3)
x/fungible/keeper/v2_deposits.go (1)
Line range hint
62-72: Ensure safe handling of nil responsesWhen
k.getAndCheckZRC20returns an error, the function rightly returnsnilfor the response. However, it's crucial to ensure that all callers ofProcessV2RevertDeposithandle the possibility of anilresponse to prevent nil pointer dereferences.Please verify that all invocations of
ProcessV2RevertDepositproperly handle anilresponse in case of an error. This ensures robustness against potential nil pointer exceptions.🧰 Tools
🪛 GitHub Check: codecov/patch
[warning] 62-62: x/fungible/keeper/v2_deposits.go#L62
Added line #L62 was not covered by teststestutil/keeper/mocks/crosschain/fungible.go (1)
422-448: LGTM!The implementation correctly handles the return values and follows mockery's best practices for type assertions and error handling.
cmd/zetae2e/local/evm.go (1)
62-62: Confirm the inclusion of the new test enhances coverageThe addition of
TestETHWithdrawAndCallRevertWithWithdrawNameto the revert cases for the gas token workflow appropriately expands test coverage for ETH withdrawals during reverts. Ensure that this test is correctly integrated and does not interfere with existing test sequences.
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Description
Add the processLogs call after performing revert call to support new CCTX creating during
onRevertcallAdd same logic as in ef4c1d4 by using a temporary context to not commit EVM changes if logic in log parsing fails
Add a test that experiments the workflow of creating new withdraw during a revert call on ZetaChain
Summary by CodeRabbit
Release Notes
New Features
onRevertcall in ZetaChainTesting
Improvements
Documentation