fix: allow processing v2 inbound trackers for gateway calls initiated by smart contracts #3226

lumtis · 2024-11-27T14:53:16Z

Description

Add the gateway address check at the log level to allow processing tracker event from smart contract inbound
Complete inbound tracker test with smart contract calling gateway
Add a small fix in crosschain to prevent hiding the smart contract error in case of revert

Can be tested following same instructions as in #3176

e2e          | 🏃test v2 deposit through contract
e2e          | 🍾v2 deposit through contract observed
e2e          | 🏃test v2 deposit and call through contract
e2e          | 🍾v2 deposit and call through contract observed
e2e          | 🏃test v2 call through contract
e2e          | 🍾v2 call through contract observed

Summary by CodeRabbit

Release Notes

New Features
- Enhanced contract deployment with the addition of a gateway address parameter for the Test DApp V2.
- Introduced new functions for gateway operations, allowing deposits and calls through the Gateway EVM.
- Improved inbound transaction processing with versioned handling for better error management.
Bug Fixes
- Streamlined error handling in various methods to improve clarity and consistency.
Tests
- Expanded test cases for deposit processing to ensure comprehensive coverage of scenarios involving contract calls and message handling.

coderabbitai · 2024-11-27T14:53:23Z

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

This pull request introduces several modifications across multiple files primarily focused on enhancing the deployment and functionality of the TestDAppV2 contract and its associated tests. Key changes include the addition of a gateway address parameter in various function signatures, improvements in error handling, and the introduction of new methods for contract interactions. The updates also refine the processing logic for inbound transactions, ensuring better handling of errors and statuses.

Changes

File	Change Summary
`e2e/e2etests/test_deploy_contract.go`	Updated `deployZEVMTestDApp` and `deployEVMTestDApp` functions to include `r.GatewayEVMAddr` as a parameter.
`e2e/e2etests/test_inbound_trackers.go`	Enhanced `TestInboundTrackers` with new test cases for deposits and calls through contracts, including value setting and error checks.
`e2e/runner/balances.go`	Added a check for non-nil `SolanaClient` in `GetAccountBalances` method to prevent nil pointer dereference errors.
`e2e/runner/v2_setup_evm.go`	Modified `SetupEVMV2` to include `r.GatewayEVMAddr` in `DeployTestDAppV2` function call.
`e2e/runner/v2_setup_zeta.go`	Updated `SetZEVMContractsV2` to pass `r.GatewayEVMAddr` in `DeployTestDAppV2`.
`pkg/contracts/testdappv2/TestDAppV2.abi`	Added `gateway_` parameter to constructor and introduced new functions for gateway interactions.
`pkg/contracts/testdappv2/TestDAppV2.go`	Updated constructor and added new methods for gateway functionality.
`pkg/contracts/testdappv2/TestDAppV2.json`	Updated ABI to include new constructor parameter and functions.
`pkg/contracts/testdappv2/TestDAppV2.sol`	Added `RevertOptions` struct and `IGatewayEVM` interface, updated constructor, and introduced new functions for gateway interactions.
`x/crosschain/keeper/cctx_orchestrator_validate_outbound.go`	Streamlined error handling in `ValidateOutboundZEVM` and updated methods for processing outbound transactions.
`x/crosschain/types/status.go`	Modified `UpdateStatusAndErrorMessages` to check for non-empty error messages before updating, and added `AbortRefunded` method.
`x/fungible/keeper/v2_deposits_test.go`	Updated `deployTestDAppV2` function signature to include `sample.EthAddress()` and enhanced test coverage for deposit scenarios.
`zetaclient/chains/evm/observer/inbound.go`	Improved error handling in `ProcessInboundTrackers` and updated log processing logic.
`zetaclient/chains/evm/observer/v2_inbound_tracker.go`	Updated `ProcessInboundTrackerV2` to include `gatewayAddr` parameter and standardized error handling.

Assessment against linked issues

Objective	Addressed	Explanation
Allow adding inbound tracker for v2 inbounds created through smart contracts (#3209)	✅
Remove the `tx.To == gateway` check and check if the event is emitted by the gateway (#3209)	❌	The changes do not explicitly remove the `tx.To == gateway` check.

Possibly related PRs

test(e2e): update testdapp contract in deploy test #3042: Updates deployment tests to utilize the new TestDAppV2 contract, directly related to changes in deployment functions.
fix: avoid endless tx rescan when the inbound vote message is invalid #3184: Addresses handling of inbound vote messages, relevant to transaction processing and error handling modifications.
fix: support tracker processing for v2 inbounds #3179: Supports v2 inbound processing, related to the updates in deployment functions for the new contract version.
fix: blocked gateway cctx for high-gas deposit #3106: Focuses on preventing blocked CCTX during high-gas deposits, aligning with deployment function changes involving transaction management.
test(e2e): add e2e test for v2 deposit and call with swap #3188: Introduces an e2e test for v2 deposit and call with swap, directly related to changes in deployment functions.

Suggested labels

breaking:proto, chain:solana, chain:bitcoin

Suggested reviewers

fbac
kingpinXD
swift1337
ws4charlie
skosito

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.

codecov · 2024-11-27T14:59:56Z

Codecov Report

Attention: Patch coverage is 2.98507% with 65 lines in your changes missing coverage. Please review.

Project coverage is 61.74%. Comparing base (08ff881) to head (2991225).
Report is 11 commits behind head on develop.

Files with missing lines	Patch %	Lines
pkg/contracts/testdappv2/TestDAppV2.go	0.00%	34 Missing ⚠️
zetaclient/chains/evm/observer/inbound.go	0.00%	24 Missing ⚠️
...taclient/chains/evm/observer/v2_inbound_tracker.go	0.00%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3226      +/-   ##
===========================================
- Coverage    62.00%   61.74%   -0.26%     
===========================================
  Files          428      431       +3     
  Lines        30469    30772     +303     
===========================================
+ Hits         18891    19001     +110     
- Misses       10738    10914     +176     
- Partials       840      857      +17

Files with missing lines	Coverage Δ
...hain/keeper/cctx_orchestrator_validate_outbound.go	`70.83% <100.00%> (ø)`
x/crosschain/types/status.go	`95.38% <100.00%> (ø)`
...taclient/chains/evm/observer/v2_inbound_tracker.go	`0.00% <0.00%> (ø)`
zetaclient/chains/evm/observer/inbound.go	`34.55% <0.00%> (+0.16%)`	⬆️
pkg/contracts/testdappv2/TestDAppV2.go	`0.00% <0.00%> (ø)`

... and 17 files with indirect coverage changes

coderabbitai

Actionable comments posted: 9

🧹 Outside diff range and nitpick comments (15)

x/crosschain/types/status.go (1)
Line range hint 7-10: Add documentation and enhance status message.

Consider adding documentation to clarify the purpose and usage of this method. Additionally, the status message could be more informative by including relevant context.
+// AbortRefunded marks the transaction as aborted with a refund processed.
+// This should be called when [specify conditions for calling this method].
 func (m *Status) AbortRefunded() {
 	m.IsAbortRefunded = true
-	m.StatusMessage = "CCTX aborted and Refunded"
+	m.StatusMessage = "Cross-chain transaction aborted and funds refunded to sender"
 }
zetaclient/chains/evm/observer/v2_inbound_tracker.go (1)
Line range hint 19-93: Consider enhancing error handling with typed errors

Given the complexity of processing different types of events (deposit, deposit-and-call, call), consider introducing typed errors for better error handling and debugging:
type InboundTrackerError struct {
    Type    string // "deposit", "deposit-and-call", "call"
    TxHash  string
    Reason  string
}

func (e *InboundTrackerError) Error() string {
    return fmt.Sprintf("failed to process %s event for tx %s: %s", e.Type, e.TxHash, e.Reason)
}
This would provide more context about which event processing failed and why, improving debuggability.
e2e/runner/v2_setup_zeta.go (1)
68-73: Document the purpose of the boolean parameter

The hardcoded true parameter lacks context. Consider adding a comment explaining its purpose or using a named constant to improve code readability.
+// isZetaChain parameter set to true as this is deploying on the ZETA chain
 testDAppV2Addr, txTestDAppV2, _, err := testdappv2.DeployTestDAppV2(
   r.ZEVMAuth,
   r.ZEVMClient,
   true,
   r.GatewayEVMAddr,
 )
e2e/e2etests/test_inbound_trackers.go (2)
Line range hint 13-16: Consider improving test setup documentation.

The comment about disabling inbound observation is crucial but references a specific line number that may become outdated. Consider replacing the line reference with a more maintainable approach.
- // IMPORTANT: the test requires inbound observation to be disabled, the following line should be uncommented:
- // https://github.com/zeta-chain/node/blob/9dcb42729653e033f5ba60a77dc37e5e19b092ad/zetaclient/chains/evm/observer/inbound.go#L210
+ // IMPORTANT: This test requires inbound observation to be disabled in zetaclient/chains/evm/observer/inbound.go
+ // Search for the line containing "disable inbound observation for e2e tests" and uncomment it.
88-91: Consider encapsulating value management in a helper function.

The pattern of setting and resetting the transaction value appears multiple times. Consider extracting this into a helper function for better maintainability.
+func withValue(r *runner.E2ERunner, value *big.Int, fn func() error) error {
+    previousValue := r.EVMAuth.Value
+    r.EVMAuth.Value = value
+    defer func() { r.EVMAuth.Value = previousValue }()
+    return fn()
+}
Usage example:
err := withValue(r, amount, func() error {
    tx, err := r.TestDAppV2EVM.GatewayDeposit(r.EVMAuth, r.EVMAddress())
    if err != nil {
        return err
    }
    addTrackerAndWaitForCCTX(coin.CoinType_Gas, tx.Hash().Hex())
    return nil
})
require.NoError(r, err)
Also applies to: 106-107
x/fungible/keeper/v2_deposits_test.go (1)
Line range hint 109-251: Consider enhancing test coverage and structure.

While the current test cases are comprehensive for happy paths, consider these improvements:

Add error scenarios:

Invalid gateway address

Failed contract calls

Insufficient balance cases

Consider refactoring to table-driven tests for better maintainability.

Example refactor:
func TestKeeper_ProcessV2Deposit(t *testing.T) {
    tests := []struct {
        name          string
        setupFn       func(t *testing.T) (k *Keeper, ctx sdk.Context, ...)
        input         ProcessV2DepositInput
        expectErr     bool
        assertionFn   func(t *testing.T, result ProcessV2DepositResult)
    }{
        {
            name: "should process no-call deposit",
            // ... test case details
        },
        // ... more test cases
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            // ... test implementation
        })
    }
}
e2e/runner/balances.go (1)
101-101: LGTM! Consider enhancing error handling consistency.

The addition of the r.SolanaClient != nil check is a good defensive programming practice that prevents potential nil pointer dereferences.

Consider wrapping the Solana-specific error messages for consistency with the rest of the codebase:
-			return AccountBalances{}, err
+			return AccountBalances{}, errors.Wrap(err, "failed to get Solana balance")
-			return AccountBalances{}, err
+			return AccountBalances{}, errors.Wrap(err, "failed to get SPL token balance")
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (2)
243-243: Consider maintaining revert messages for debugging

The removal of the revert message might make debugging more challenging in production environments. Consider maintaining a meaningful revert message or adding debug logs to help trace issues.
-		cctx.SetReverted("", "")
+		cctx.SetReverted("", "outbound transaction reverted")
Line range hint 1-424: Well-structured error handling and documentation

The error handling patterns and function documentation are comprehensive. However, there's a TODO comment referencing issue #2627 about consolidating logic. Consider creating a follow-up task to address this technical debt.
pkg/contracts/testdappv2/TestDAppV2.sol (3)
4-10: Add documentation to RevertOptions struct fields

To enhance code readability and maintainability, consider adding NatSpec comments to each field within the RevertOptions struct. This will provide clarity on the purpose and usage of each parameter.

Apply this diff to include documentation:
 struct RevertOptions {
+    /// @notice Address to receive revert callbacks
     address revertAddress;
+    /// @notice Flag indicating whether to call on revert
     bool callOnRevert;
+    /// @notice Address to abort the transaction
     address abortAddress;
+    /// @notice Message to include upon revert
     bytes revertMessage;
+    /// @notice Gas limit allocated for the on-revert call
     uint256 onRevertGasLimit;
 }
12-22: Include NatSpec comments for IGatewayEVM interface methods

Adding documentation to the interface methods will improve comprehension for developers implementing or interacting with the IGatewayEVM. This practice promotes better understanding of the expected behaviors and parameters.

Apply this diff to enhance the interface:
 interface IGatewayEVM {
+    /// @notice Deposits assets to a receiver address with revert options
     function deposit(address receiver, RevertOptions calldata revertOptions) external payable;
+    /// @notice Deposits assets and calls a function on the receiver with provided payload and revert options
     function depositAndCall(
         address receiver,
         bytes calldata payload,
         RevertOptions calldata revertOptions
     )
     external
     payable;
+    /// @notice Calls a function on the receiver with provided payload and revert options
     function call(address receiver, bytes calldata payload, RevertOptions calldata revertOptions) external;
 }
38-39: Ensure consistent ordering of state variable declarations

For improved code readability, consider grouping related state variables together. Place the gateway address declaration adjacent to isZetaChain to maintain logical grouping of immutable public variables.

Apply this diff to reorder the declarations:
 contract TestDAppV2 {
     // used to simulate gas consumption
     uint256[] private storageArray;

     string public constant NO_MESSAGE_CALL = "called with no message";

     // define if the chain is ZetaChain
     bool immutable public isZetaChain;
+    // address of the gateway
+    address immutable public gateway;

-    // address of the gateway
-    address immutable public gateway;
zetaclient/chains/evm/observer/inbound.go (2)

148-152: Elevate log level for critical error scenarios

The error logged when failing to get the gateway contract is at the Debug level. This might obscure critical issues during processing. Consider logging this error at a higher level, such as Warn or Error, to ensure it receives appropriate attention in production environments.

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 148-148: zetaclient/chains/evm/observer/inbound.go#L148
Added line #L148 was not covered by tests

165-178: Enhance test coverage for new inbound processing logic

The newly implemented code for processing v1 inbound trackers lacks unit tests, as indicated by static analysis tools. To ensure robustness and prevent regressions, consider adding unit tests for each coin type handled in the switch statement.

As per previous learnings, test coverage for ObserveInbound functions is planned to be improved in future refactors. Would you like assistance in creating unit tests for these code paths or opening a GitHub issue to track this task?

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 165-178: zetaclient/chains/evm/observer/inbound.go#L165-L178
Added lines #L165 - L178 were not covered by tests

pkg/contracts/testdappv2/TestDAppV2.go (1)

Line range hint 67-76: Ensure documentation for the new gateway_ parameter

The DeployTestDAppV2 function now includes an additional parameter gateway_ common.Address. Please add documentation or comments explaining the purpose and usage of this parameter to enhance code readability and maintainability.

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 67-67: pkg/contracts/testdappv2/TestDAppV2.go#L67
Added line #L67 was 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 08ff881 and c35c086.

⛔ Files ignored due to path filters (1)

pkg/contracts/testdappv2/TestDAppV2.bin is excluded by !**/*.bin

📒 Files selected for processing (14)

e2e/e2etests/test_deploy_contract.go (2 hunks)
e2e/e2etests/test_inbound_trackers.go (1 hunks)
e2e/runner/balances.go (1 hunks)
e2e/runner/v2_setup_evm.go (1 hunks)
e2e/runner/v2_setup_zeta.go (1 hunks)
pkg/contracts/testdappv2/TestDAppV2.abi (2 hunks)
pkg/contracts/testdappv2/TestDAppV2.go (5 hunks)
pkg/contracts/testdappv2/TestDAppV2.json (3 hunks)
pkg/contracts/testdappv2/TestDAppV2.sol (4 hunks)
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go (1 hunks)
x/crosschain/types/status.go (1 hunks)
x/fungible/keeper/v2_deposits_test.go (2 hunks)
zetaclient/chains/evm/observer/inbound.go (1 hunks)
zetaclient/chains/evm/observer/v2_inbound_tracker.go (3 hunks)

🧰 Additional context used

📓 Path-based instructions (11)

e2e/e2etests/test_deploy_contract.go (1)