fix(crosschain): set sender for ERC20 whitelist admin CCTX inbound

[lumtis]

Description

A change in the CCTX workflow made CCTX fail at the outbound confirmation if the sender in the inbound is not set.

This value was not set for whitelist ERC20 CCTX and the change was not tested because the admin test testing the ERC20 whitelist was disabled (part of chain migration test)

• Set value for inbound sender based on message sender
• Add a dedicated E2E test for ERC20 whitelist

Summary by CodeRabbit

• New Features

  • Introduced a new test case for whitelisting ERC20 tokens, enhancing end-to-end testing coverage.
  • Added a comprehensive test function to validate ERC20 token whitelisting on a new EVM chain.

• Improvements

  • Updated the transaction handling to accurately capture the sender's information during whitelisting requests, improving traceability.

• Bug Fixes

  • Enhanced test routines to ensure proper validation of the ERC20 token whitelisting functionality.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce enhancements to the end-to-end testing framework for an Ethereum-based application, primarily focusing on the whitelisting of ERC20 tokens. A new test case is created to validate this functionality, and modifications are made to ensure the sender's information is accurately captured in transaction requests. These updates are designed to improve testing coverage, ensure robust functionality, and enhance traceability within the system's transaction processes.

Changes

Files	Change Summary
cmd/zetae2e/local/local.go	Added e2etests.TestWhitelistERC20Name argument to adminTestRoutine for improved testing of ERC20 token whitelisting functionality.
e2e/e2etests/e2etests.go	Introduced constant TestWhitelistERC20Name and created a new end-to-end test case TestWhitelistERC20 to validate ERC20 token whitelisting.
e2e/e2etests/test_whitelist_erc20.go	Added TestWhitelistERC20 function to deploy an ERC20 token, validate whitelisting, and test interactions with the ZetaChain ecosystem, ensuring comprehensive coverage.
x/crosschain/keeper/msg_server_whitelist_erc20.go	Updated WhitelistERC20 function to set Sender to msg.Creator instead of an empty string for improved traceability of the transaction origin.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Admin
    participant E2ETestRunner
    participant ERC20Contract
    participant MsgServer
    
    User->>Admin: Request ERC20 Token Whitelisting
    Admin->>E2ETestRunner: Trigger TestWhitelistERC20
    E2ETestRunner->>ERC20Contract: Deploy new ERC20 Token
    ERC20Contract-->>E2ETestRunner: Confirmation of Deployment
    E2ETestRunner->>MsgServer: Whitelist ERC20 Token
    MsgServer-->>E2ETestRunner: Confirm Whitelisting
    E2ETestRunner-->>Admin: Test Complete

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.55%. Comparing base (b4251e1) to head (38d8aec).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2631   +/-   ##
========================================
  Coverage    70.55%   70.55%           
========================================
  Files          335      335           
  Lines        18345    18345           
========================================
  Hits         12943    12943           
  Misses        4821     4821           
  Partials       581      581           

Files	Coverage Δ
x/crosschain/keeper/msg_server_whitelist_erc20.go	76.25% <100.00%> (ø)

[coderabbitai]

Actionable comments posted: 3

Outside diff range, codebase verification and nitpick comments (2)

e2e/e2etests/test_whitelist_erc20.go (2)

27-29: Add comment to explain waiting for ERC20 transaction receipt.

Adding a comment will improve code readability and maintainability.

-  receipt := utils.MustWaitForTxReceipt(r.Ctx, r.EVMClient, txERC20, r.Logger, r.ReceiptTimeout)
+  // Wait for the ERC20 transaction to be mined
+  receipt := utils.MustWaitForTxReceipt(r.Ctx, r.EVMClient, txERC20, r.Logger, r.ReceiptTimeout)

---

97-99: Add comment to explain approving gas token.

Adding a comment will improve code readability and maintainability.

-  tx, err := r.ETHZRC20.Approve(r.ZEVMAuth, r.ERC20ZRC20Addr, big.NewInt(1e18))
+  // Approve 1 unit of the gas token to cover the gas fee
+  tx, err := r.ETHZRC20.Approve(r.ZEVMAuth, r.ERC20ZRC20Addr, big.NewInt(1e18))

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b4251e1 and 38d8aec.

Files selected for processing (4)

• cmd/zetae2e/local/local.go (1 hunks)
• e2e/e2etests/e2etests.go (2 hunks)
• e2e/e2etests/test_whitelist_erc20.go (1 hunks)
• x/crosschain/keeper/msg_server_whitelist_erc20.go (1 hunks)

Additional context used

Path-based instructions (4)

e2e/e2etests/test_whitelist_erc20.go (1)

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

x/crosschain/keeper/msg_server_whitelist_erc20.go (1)

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

cmd/zetae2e/local/local.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.

Additional comments not posted (4)

x/crosschain/keeper/msg_server_whitelist_erc20.go (1)

152-152: LGTM! Setting the sender improves traceability.

The change to set the Sender field in the InboundParams struct enhances traceability and accountability.

cmd/zetae2e/local/local.go (1)

295-295: LGTM! Including the new test case enhances test coverage.

The addition of the e2etests.TestWhitelistERC20Name argument to the adminTestRoutine improves the robustness of the testing suite.

e2e/e2etests/e2etests.go (2)

103-103: LGTM!

The constant TestWhitelistERC20Name is well-defined and follows the existing naming conventions.

---

525-530: LGTM!

The new end-to-end test case for whitelisting a new ERC20 token is well-structured and follows the existing pattern. The description is clear, and the argument definition array is appropriately empty.