test(e2e): add gateway upgrade in upgrade test

[lumtis]

Description

• Update upgrade reference to use v20
• Add a function in the E2E upgrade test workflow to upgrade the gateways to the latest used version in the dependency.
• Small change to use ERC20Custody v2 contract by default in chain setup, this logic will be cleaned up in the future in Remove all usage of V2 terminology in the codebase and refactor to consolidate all logic with v1 #2627 to remove all usage of the v1 contracts

Checking the change

If you comment out the following line

node/cmd/zetae2e/local/local.go

Line 417 in 30d60d1

deployerRunner.UpgradeGateways()

and run upgrade test, it will fail because the gateway will use the wrong interface with ZetaClient

Closes: #2921 #2926

Summary by CodeRabbit

• New Features

  • Introduced support for stateful precompiled contracts and enhancements to staking precompiled contracts.
  • Added command-line flag to upgrade gateways during ZEVM and EVM setup.
  • New functionality for upgrading Ethereum-based gateway contracts.

• Bug Fixes

  • Resolved issues with outbound transaction processing on EVM chains and TSS keygen voting process.

• Documentation

  • Updated changelog to reflect recent updates and improvements.

• Tests

  • Enhanced testing coverage with new end-to-end tests for stateful precompiled contracts and Bitcoin deposits.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request primarily focus on enhancing the upgrade process for the Zeta Chain node, including updates to the Docker build system, versioning, and end-to-end testing capabilities. Key modifications include adjusting version references in the Makefile, adding new methods for upgrading gateway contracts, and introducing command-line flags for test configurations. The changelog has been updated to reflect significant new features, refactoring, and fixes, ensuring comprehensive documentation of the changes.

Changes

File Path	Change Summary
Makefile	Updated OLD_VERSION in the zetanode-upgrade target from release/v19 to release/v20 and from v19.1.1 to v20.0.2.
changelog.md	Added entries for new features, refactoring, testing improvements, and fixes related to the Zeta Chain node.
cmd/zetae2e/local/local.go	Introduced a new command-line flag flagUpgradeGateways to allow gateway upgrades during local end-to-end tests.
contrib/localnet/orchestrator/start-zetae2e.sh	Added --test-v2 and --upgrade-gateways flags for the zetae2e command to enhance upgrade testing scenarios.
e2e/runner/v2_gateway.go	Created a new file with methods for upgrading GatewayEVM and GatewayZEVM, including transaction receipt verification.

Assessment against linked issues

Objective	Addressed	Explanation
Allow adding gateway upgrade instructions during the test (Issue #2921)	✅
Ensure the gateway contract is upgraded when necessary in tests (Issue #2921)	✅

Possibly related PRs

• chore: use v19 binaries in upgrade tests #2689: Updates the Makefile to change the OLD_VERSION for the zetanode component, related to versioning changes.
• chore: sync v20 changelog #2872: Updates the changelog to reflect significant changes in the Zeta Chain protocol, aligning with version updates.
• fix: support multiple runs for precomplies e2e test  #2874: Modifies the start-zetae2e.sh script to enhance the upgrade testing framework, relevant to the changes made.
• test: initialize liquidity cap for newly deployed erc20 in WhiteListERC20 e2e test #2891: Focuses on initializing the liquidity cap for ERC20 tokens, part of the broader context of testing and upgrades.

Suggested labels

UPGRADE_IMPORT_MAINNET_TESTS, ADMIN_TESTS

Suggested reviewers

• skosito
• kingpinXD
• fbac
• brewmaster012
• swift1337
• ws4charlie

---

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 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.

[coderabbitai]

Actionable comments posted: 5

🧹 Outside diff range and nitpick comments (7)

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

415-418: Appropriate implementation of gateway upgrade logic.

The gateway upgrade logic is correctly implemented and guarded by the upgradeGateways flag. To improve clarity and maintainability, consider adding a brief comment explaining the purpose of this upgrade step.

Add a comment to provide context:

 // upgrade gateways
 if upgradeGateways {
+    // Upgrade gateways to the latest version used in dependencies
     deployerRunner.UpgradeGateways()
 }

---

Line range hint 1-518: Summary: Gateway upgrade functionality added, setup process needs further refinement.

The changes introduce gateway upgrade functionality and make progress towards merging v1 and v2 setups. While the implementations are generally sound, there are opportunities for improvement:

1. Unify the v1 and v2 setup processes to reduce complexity and improve maintainability.
2. Update TODO comments with more specific action items and timelines.
3. Consider adding more comprehensive error handling and logging for the new gateway upgrade process.

To improve the overall architecture and maintainability of the E2E testing setup:

1. Create a separate configuration package to manage all flag definitions and their corresponding variables.
2. Implement a unified setup function that handles both v1 and v2 configurations.
3. Consider introducing a more modular approach to test execution, allowing for easier addition and removal of test cases.

These changes will make the codebase more scalable and easier to maintain as the project evolves.

changelog.md (5)

Line range hint 1-39: Version v12.2.4 changes appear appropriate, but consider improving documentation.

The changes in version v12.2.4 address several important fixes and improvements. However, it would be beneficial to provide more context for some of the changes, especially for external contributors or users.

Consider adding brief explanations for the following changes:

1. The reason for the 50% increase in base gas price (line 4).
2. The rationale behind changing the WhitelistERC20 authorization from group1 to group2 (line 5).
3. The purpose of adding the pending outtx hash to the tracker after 10 minutes (line 6).

This additional context would help users and contributors better understand the motivations behind these changes.

---

Line range hint 41-114: Version v12.1.0 introduces significant changes, but some improvements can be made.

The changes in version v12.1.0 include important features, fixes, and refactoring. However, there are a few areas that could be improved for clarity and consistency.

1. In the Features section, the description for item fix: modify emissions to follow fixed rewards per block #1658 (line 52) is vague. Consider providing more details about the modification to emission distribution and its implications.

2. In the Fixes section, the description for item MsgRemoveForeignCoin: rename Name field into ZRC20Address #1650 (line 59) uses asterisks for emphasis, which is inconsistent with the formatting in the rest of the document. Consider using a different method for emphasis, such as backticks for code-like terms.

3. In the Refactoring section, items refactor: Optimize return #1628 and refactor: zetaclient re-organization #1640 (lines 75-76) lack specific details about what was optimized or reorganized. Consider adding brief explanations of the changes and their benefits.

The addition of EVM fee calculation to TSS migration of EVM chains (line 78) seems to be a significant change. Consider adding a brief explanation of how this impacts the system architecture and any potential performance implications.

---

Line range hint 1-385: Overall, the changelog is informative but could benefit from some improvements.

The changelog provides a detailed record of changes across multiple versions, including important features, fixes, and breaking changes. However, there are several areas where it could be enhanced:

1. Consistency: Ensure all entries follow a consistent format, including pull request links and detailed descriptions.
2. Context: Provide more background information for significant changes, especially those that impact system architecture or user interactions.
3. Breaking Changes: Clearly highlight and explain all breaking changes, including migration steps for users.
4. Testing: Include more information about new or updated tests related to significant changes.
5. Performance Impacts: When possible, mention any performance implications of major changes.

Consider reorganizing the changelog to group similar types of changes together within each version (e.g., all breaking changes, all new features, all fixes). This could improve readability and make it easier for users to understand the impact of each release.

Add a brief summary at the beginning of each version's changes, highlighting the most significant updates. This would help users quickly grasp the importance of each release.

By implementing these suggestions, the changelog could become an even more valuable resource for users, contributors, and maintainers of the project.

---

Missing Test Case for Paused zrc20 Deposit Prevention

The test case to verify that deposits to a paused zrc20 are rejected has not been implemented. Please ensure that a comprehensive test case is added to confirm this behavior.

🔗 Analysis chain

Line range hint 241-385: Versions v11.0.0 and v10.1.2 introduce important features and fixes, but some improvements can be made.

These versions include significant changes such as HSM capability for zetaclient hot key, tss funds migration, and various fixes. However, there are areas where documentation and consistency can be improved.

The addition of HSM capability for zetaclient hot key (line 244) is a valuable security enhancement.

1. Some feature descriptions lack detail, such as the "new thread to zetaclient" (lines 245-246). Consider providing more context about the purpose and benefits of these additions.

2. In the Fixes section of v11.0.0, some items lack pull request links (e.g., lines 254-255). For consistency and traceability, consider adding these links.

The addition of Bitcoin block header and merkle proof functionality (line 339) seems to be a significant architectural change. Consider documenting the implications of this change on the system's overall design and any potential performance impacts.

The fix for preventing deposits for paused zrc20 (line 257) is important for system integrity. It would be beneficial to add a test case to verify this behavior:

The fix for the Athens-3 issue regarding Bitcoin outtx inclusion (line 259) lacks details about the specific problem addressed. It's important to provide more information about the issue and how the fix resolves it.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Test: Attempt to deposit to a paused zrc20
# Expected: Deposit should be rejected

# TODO: Implement test case to verify paused zrc20 deposit prevention
echo "Implement test case for paused zrc20 deposit prevention"

Length of output: 120

---

Outdated Query Paths Found in changelog.md

The verification process identified remaining references to old query paths in changelog.md (Lines: 36-42). Please update these paths to the new endpoints to ensure documentation accuracy and prevent potential integration issues.

🔗 Analysis chain

Line range hint 116-239: Version v12.0.0 introduces breaking changes and significant features, but requires careful consideration.

This version includes several breaking changes, new features, and important fixes. The breaking changes, particularly those related to module reorganization and query modifications, need to be clearly communicated to users and may require updates to dependent systems.

The breaking changes related to TSS and chain validation queries (lines 119-126) may impact existing integrations. To ensure a smooth transition, it's crucial to verify that all affected systems are updated accordingly.

The merging of observer params and core params into chain params (lines 134-137) represents a significant architectural change. Consider documenting the rationale behind this decision and any potential impacts on system performance or maintainability.

In the Features section, some items lack pull request links (e.g., lines 245-247). For consistency and traceability, consider adding these links.

The fix for Code4rena issue (line 263) lacks details about the specific problem addressed. It's important to provide more information about the issue and how the fix resolves it.

The addition of pagination to queries iterating over large data sets (lines 279-280) is a good performance improvement.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any remaining references to old query paths
rg -i '/zeta-chain/crosschain/(pendingNonces|chainNonces)'
rg -i '/zeta-chain/observer/(observers_by_chain|all_observer_mappers)'
rg -i '/zeta-chain/observer/(params|get_core_params|get_core_params_by_chain)'

Length of output: 1858

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f789138 and 30d60d1.

📒 Files selected for processing (5)

• Makefile (1 hunks)
• changelog.md (1 hunks)
• cmd/zetae2e/local/local.go (5 hunks)
• contrib/localnet/orchestrator/start-zetae2e.sh (1 hunks)
• e2e/runner/v2_gateway.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

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

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

contrib/localnet/orchestrator/start-zetae2e.sh (1)

Pattern **/*.sh: Review the shell scripts, point out issues relative to security, performance, and maintainability.

e2e/runner/v2_gateway.go (1)

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

🔇 Additional comments (5)

Makefile (2)

302-302: Version update for source build approved.

The update of OLD_VERSION from 'release/v19' to 'release/v20' aligns with the PR objectives to update the upgrade reference to version 20. This change ensures that the correct version is used when building from source.

---

302-307: Changes align with PR objectives and upgrade process.

The updates to the zetanode-upgrade target in the Makefile accurately reflect the intention to upgrade to version 20, as stated in the PR objectives. Both the source build and binary build options have been updated consistently. These changes support the enhancement of the end-to-end (E2E) upgrade testing workflow by ensuring the correct version is used during the upgrade process.

No further changes appear necessary in this file to meet the stated objectives of the PR.

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

49-49: Appropriate addition of new flag constant.

The flagUpgradeGateways constant is well-named and consistent with the existing flag naming convention.

---

87-87: Proper integration of new flag into command.

The flagUpgradeGateways flag is correctly added to the command with a clear and concise description.

---

117-117: Consistent addition of new flag variable.

The upgradeGateways variable is properly initialized from the flag, maintaining consistency with other flag variables.