test: add-ton-tss-migration

[kingpinXD]

Description

Closes #4473

How Has This Been Tested?

• Tested CCTX in localnet
• Tested in development environment
• Go unit tests
• Go integration tests
• Tested via GitHub Actions

---

Note

Adds TON to TSS migration e2e flow and implements TON gateway admin ops to update TSS and reset seqno, wiring them into the migration process.

• Tests / E2E:
  • Include TON in TSS migration tests (Makefile E2E_ARGS and docker profiles; pass testTON to triggerTSSMigration).
• TON Contracts / Client:
  • Add gateway admin messages UpdateTSS (OpUpdateTSS) and ResetSeqno (OpResetSeqno) with encoders in pkg/contracts/ton.
  • Expose Gateway.SendUpdateTSS and Gateway.SendResetSeqno to send these ops.
  • Implement runner.E2ERunner.UpdateTSSAddressTON to update TON gateway TSS and reset seqno during migration.
• Changelog:
  • Note addition of TON to TSS migration tests.

^{Written by Cursor Bugbot for commit 2e3a6f3. Configure here.}

Summary by CodeRabbit

• New Features

  • Added new TON gateway operations for updating TSS addresses and resetting sequence numbers.

• Tests

  • Enhanced end-to-end test infrastructure with expanded support for TON blockchain testing scenarios, including TSS migration validation workflows.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

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 extends the local TSS migration test framework to include TON gateway support. Changes enable TON-specific TSS address updates during migration testing by adding new gateway contract operations, E2E runner methods, and test orchestration logic, alongside corresponding test configuration adjustments.

Changes

Cohort / File(s)	Summary
Test Infrastructure Makefile, changelog.md	Updated test targets (start-tss-migration-add-observer, start-tss-migration-remove-observer, start-solana-test) with extended E2E_ARGS (--test-ton, --skip-regular, --test-solana) and docker-compose profiles; added changelog entry for PR #4491 documenting TON TSS migration test additions.
Local E2E Test Orchestration cmd/zetae2e/local/local.go, cmd/zetae2e/local/tss_migration.go	Extended triggerTSSMigration function signature with testTon bool parameter; added conditional logic to invoke TON TSS address updates when testTon flag is enabled during migration flow.
E2E Runner TON Setup e2e/runner/setup_ton.go	Introduced UpdateTSSAddressTON method that orchestrates TON gateway TSS address updates and seqno resets, including deployer resolution, message sequencing (fetch seqno, publish update_tss, wait for confirmation, reset seqno), and block synchronization.
TON Gateway Contract Operations pkg/contracts/ton/gateway_msg.go, pkg/contracts/ton/gateway_send.go	Added operation codes (OpUpdateTSS=202, OpResetSeqno=206), serializable message types (UpdateTSS, ResetSeqno with AsBody methods), and corresponding Gateway methods (SendUpdateTSS, SendResetSeqno) for admin operations.

Sequence Diagram

sequenceDiagram
    participant Test as Test Orchestration
    participant Runner as E2ERunner
    participant TONGateway as TON Gateway Contract
    participant TONFaucet as TON Faucet/Deployer
    participant TONNet as TON Blockchain

    Test->>Runner: UpdateTSSAddressTON(gatewayID, faucetURL)
    Runner->>TONFaucet: Validate client & resolve gateway account
    TONFaucet-->>Runner: Gateway account ID
    Runner->>TONFaucet: Get deployer seqno
    TONFaucet-->>Runner: Current seqno

    Note over Runner,TONGateway: Phase 1: Update TSS Address
    Runner->>TONGateway: SendUpdateTSS(newTSSAddress)
    TONGateway->>TONNet: Publish update_tss message
    TONNet-->>Runner: Transaction confirmation

    Runner->>TONNet: Wait for blocks
    TONNet-->>Runner: Blocks confirmed
    
    Runner->>TONFaucet: Get deployer new seqno
    TONFaucet-->>Runner: Updated seqno

    Note over Runner,TONGateway: Phase 2: Reset Seqno
    Runner->>TONGateway: SendResetSeqno(newSeqno)
    TONGateway->>TONNet: Publish reset_seqno message
    TONNet-->>Runner: Transaction confirmation

    Runner->>TONNet: Wait for blocks
    TONNet-->>Runner: Blocks confirmed
    
    Runner-->>Test: Migration complete

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–25 minutes

Key areas requiring attention:

• Seqno sequencing logic in UpdateTSSAddressTON: Verify correct fetch-publish-wait-confirm-refetch pattern for both update_tss and reset_seqno operations to ensure proper state transitions.
• Error handling propagation: Confirm AsBody() errors are wrapped with context and propagated correctly through SendUpdateTSS and SendResetSeqno.
• Test parameter plumbing: Validate testTon flag flows correctly from Makefile through local.go to tss_migration.go and integration with UpdateTSSAddressTON invocation.
• Operation code uniqueness: Verify OpUpdateTSS (202) and OpResetSeqno (206) do not conflict with existing gateway operation codes.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'test: add-ton-tss-migration' is specific and directly relates to the main changes: adding TON to the TSS migration e2e test suite.
Description check	✅ Passed	The PR description adequately covers the scope: links the related issue, outlines testing categories, and provides a comprehensive summary of changes across four component areas (Tests/E2E, TON Contracts/Client, and Changelog).
Linked Issues check	✅ Passed	The changeset fulfills issue #4473 requirements: integrates TON into the local TSS migration test via Makefile configuration, implements UpdateTSSAddressTON to update TON gateway TSS, and adds necessary gateway admin operations.
Out of Scope Changes check	✅ Passed	All modifications align with issue #4473 scope: Makefile changes enable TON testing, function signature updates support the testTON parameter, and gateway admin operations (UpdateTSS, ResetSeqno) directly support the TON TSS migration workflow.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

pkg/contracts/ton/gateway_msg.go (1)

28-32: New TON admin opcodes and bodies follow existing patterns; confirm FC alignment

The UpdateTSS and ResetSeqno structs and their AsBody methods mirror the existing encoding style (op code, query ID, payload) and reuse ErrCollect, which keeps serialization consistent. Two minor points:

• Please double‑check that OpUpdateTSS = 202 and OpResetSeqno = 206 and their payload layouts exactly match the gateway.fc contract; any drift there will be subtle but breaking.
• For readability, you may want to reorder the outbound op constants so they appear in numeric order (e.g., 200, 202, 205, 206).

Also applies to: 60-93

e2e/runner/setup_ton.go (1)

10-15: TON TSS address update and seqno reset flow looks correct; consider minor reuse/logging tweaks

UpdateTSSAddressTON validates the TON client and faucet config, derives the gateway ID from the explicit gatewayAccountID or r.TONGateway, then:

• Builds a deployer, reads its seqno, and sends update_tss with a reasonable gas amount and combined send flags.
• Waits for the next seqno and a few blocks, logs the new TSS, then sends reset_seqno and again waits for confirmation and blocks.

This sequencing is appropriate for an admin op and matches the rest of the TON E2E tooling. Two optional polish points:

• There is some duplication with SetupTON around fetching the faucet config and constructing the deployer; a small helper could reduce drift over time.
• Emitting a log with the resolved gwIDStr (gateway account ID) before sending the admin messages would make debugging misconfigured TON gateways easier.

Also applies to: 172-221

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0740cdc and 2e3a6f3.

📒 Files selected for processing (7)

• Makefile (1 hunks)
• changelog.md (1 hunks)
• cmd/zetae2e/local/local.go (1 hunks)
• cmd/zetae2e/local/tss_migration.go (2 hunks)
• e2e/runner/setup_ton.go (2 hunks)
• pkg/contracts/ton/gateway_msg.go (2 hunks)
• pkg/contracts/ton/gateway_send.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.go

⚙️ CodeRabbit configuration file

Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

Files:

• cmd/zetae2e/local/tss_migration.go
• cmd/zetae2e/local/local.go
• pkg/contracts/ton/gateway_send.go
• pkg/contracts/ton/gateway_msg.go
• e2e/runner/setup_ton.go

🧠 Learnings (4)

📚 Learning: 2025-09-15T13:42:17.594Z

Learnt from: lumtis
Repo: zeta-chain/node PR: 4199
File: zetaclient/chains/evm/signer/signer_admin.go:25-26
Timestamp: 2025-09-15T13:42:17.594Z
Learning: In PR 4199, the CLI references to CmdMigrateTssFunds in x/crosschain/client/cli/ files are intentionally not updated as they are out of scope for this specific refactor focused on removing ERC20 custody messages.

Applied to files:

• cmd/zetae2e/local/tss_migration.go
• cmd/zetae2e/local/local.go

📚 Learning: 2025-08-06T01:54:04.100Z

Learnt from: kingpinXD
Repo: zeta-chain/node PR: 4064
File: cmd/zetae2e/local/solana.go:0-0
Timestamp: 2025-08-06T01:54:04.100Z
Learning: The `CheckSolanaTSSBalance()` method in e2e/runner has been refactored to not return an error. Instead, it uses internal assertions (require statements) to fail the test immediately if balance checks fail. This is part of a broader refactoring pattern in the E2E runner where balance check methods were changed from error-returning to assertion-based approaches.

Applied to files:

• cmd/zetae2e/local/tss_migration.go
• cmd/zetae2e/local/local.go
• Makefile
• e2e/runner/setup_ton.go

📚 Learning: 2024-11-06T21:11:34.420Z

Learnt from: gartnera
Repo: zeta-chain/node PR: 3105
File: cmd/zetae2e/local/bitcoin.go:8-8
Timestamp: 2024-11-06T21:11:34.420Z
Learning: In the `e2e` codebase, it's acceptable to use `github.com/stretchr/testify/require` outside of test files.

Applied to files:

• e2e/runner/setup_ton.go

📚 Learning: 2025-01-14T03:37:18.430Z

Learnt from: ws4charlie
Repo: zeta-chain/node PR: 3306
File: pkg/math/integer_test.go:0-0
Timestamp: 2025-01-14T03:37:18.430Z
Learning: Use big.Int for handling large number calculations and edge cases to avoid integer overflow issues.

Applied to files:

• e2e/runner/setup_ton.go

🧬 Code graph analysis (4)

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

e2e/config/config.go (3)

• Contracts (129-135)
• TON (146-148)
• RPCs (106-118)

pkg/contracts/ton/gateway_send.go (2)

pkg/contracts/ton/gateway.go (1)

• Gateway (25-27)

pkg/contracts/ton/gateway_msg.go (2)

• UpdateTSS (62-64)
• ResetSeqno (79-81)

pkg/contracts/ton/gateway_msg.go (2)

pkg/contracts/ton/tlb.go (1)

• ErrCollect (68-76)

testutil/sample/sample.go (1)

• Bytes (61-63)

e2e/runner/setup_ton.go (4)

e2e/runner/runner.go (1)

• E2ERunner (88-224)

e2e/runner/ton/faucet.go (1)

• GetFaucet (22-40)

e2e/runner/ton/deployer.go (1)

• NewDeployer (23-46)

pkg/contracts/ton/gateway_send.go (2)

• SendFlagSeparateFees (37-37)
• SendFlagIgnoreErrors (38-38)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: Cursor Bugbot
• GitHub Check: test-sim-nondeterminism / sim
• GitHub Check: test-sim-import-export / sim
• GitHub Check: test-sim-fullappsimulation / sim
• GitHub Check: test-sim-after-import / sim
• GitHub Check: build-zetanode
• GitHub Check: lint
• GitHub Check: gosec
• GitHub Check: build-and-test
• GitHub Check: analyze (go)
• GitHub Check: build

🔇 Additional comments (5)

changelog.md (1)

31-31: Changelog entry correctly categorized under Unreleased Tests

The new entry for PR 4491 is consistent with existing formatting and placement.

pkg/contracts/ton/gateway_send.go (1)

96-130: New TON gateway admin send helpers are consistent and correctly reuse send

SendUpdateTSS and SendResetSeqno construct their bodies via the typed message structs and delegate to gw.send, matching the existing deposit/call pattern and keeping error wrapping localized. Amount and send mode are left to the caller, which fits the current design.

Makefile (1)

364-375: TSS migration targets now correctly include TON tests and services

Extending E2E_ARGS with --test-solana --test-sui --test-ton and adding the ton profile to docker compose ensures the local TSS migration flows exercise TON alongside Solana and Sui, without changing existing semantics for other chains.

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

670-679: Wiring TON flag into TSS migration is correct and consistent

Passing testTON into triggerTSSMigration for both add/remove‑observer flows ensures TON TSS updates only run when TON tests are enabled, matching the existing pattern for Solana and Sui while keeping behavior unchanged for other configurations.

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

67-129: TON TSS update is cleanly integrated into the migration flow

Extending triggerTSSMigration with testTon and, when true, calling UpdateTSSAddressTON with conf.Contracts.TON.GatewayAccountID and conf.RPCs.TONFaucet integrates TON into the existing post‑migration contract update sequence alongside ConnectorNative, ERC20Custody, Gateway, Solana, and Sui, without affecting callers that do not enable TON.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.70%. Comparing base (8bf300f) to head (5ed0b10).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4491   +/-   ##
========================================
  Coverage    64.70%   64.70%           
========================================
  Files          475      475           
  Lines        28926    28926           
========================================
  Hits         18716    18716           
  Misses        9183     9183           
  Partials      1027     1027           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.