fix: backport mainnet hotfix to Bitcoin TSS keysign failure

[ws4charlie]

Description

Schedule Bitcoin TSS keysign on configured interval in chain parameter. Based on what we observed on mainnet, signing Bitcoin outbound on every ZetaChain block could desync the signers.

The original hotfix: #3505

How Has This Been Tested?

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

Summary by CodeRabbit

• New Features
  • Introduced a scheduled Bitcoin key signing mechanism to limit excessive processing.
  • Updated confirmation management to support multiple counts.
  • Added a new command tool feature and expanded blockchain chain information.
• Bug Fixes
  • Resolved timing issues affecting outbound transaction processing and related tests.
• Refactor
  • Improved the organization of Bitcoin transaction handling for enhanced performance and reliability.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changelog has been updated to document new features, fixes, and refactoring. Notably, a scheduling mechanism has been introduced for the Bitcoin TSS keysign to prevent spam, and the confirmation_count field has been replaced with ConfirmationParams. Additional features such as the track-cctx command and Sui chain info have been added, alongside fixes for E2E test failures. The Bitcoin chain client code now computes a scheduling interval and conditionally triggers outbound processing based on this interval.

Changes

File(s)	Change Summary
changelog.md	Updated with new features and fixes: added scheduling for Bitcoin TSS keysign, introduction of ConfirmationParams (replacing confirmation_count), addition of the track-cctx command and Sui chain info, and bug fixes for E2E test failures (nil ConfirmationParams for Solana and TON), along with refactoring for code organization.
zetaclient/chains/bitcoin/bitcoin.go	Introduced a new variable scheduleInterval in the scheduleCCTX method; modified the control flow to conditionally call TryProcessOutbound based on an interval check using the nonce and zetaHeight modulo the scheduleInterval.

Sequence Diagram(s)

sequenceDiagram
    participant Obs as Observer
    participant BC as BitcoinChain
    Obs->>BC: Call scheduleCCTX()
    BC->>BC: Derive scheduleInterval from outbound chain parameters
    BC->>BC: Evaluate condition (nonce mod scheduleInterval == zetaHeight mod scheduleInterval)
    alt Condition met
        BC->>BC: Invoke TryProcessOutbound()
    else Condition not met
        BC-->>BC: Skip processing
    end

Loading

Possibly related PRs

• fix: add non-nil confirmation params in solana/ton E2E test to avoid chain param update error #3501: Relates to the deprecation of confirmation_count in favor of ConfirmationParams to address E2E test failures.
• refactor(zetaclient): extract base observer and base signer from BTC #3394: Directly connected to modifications in the scheduleCCTX method for scheduling Bitcoin TSS keysign.
• fix(zetaclient): use chain name in metrics #3484: Involves changes related to introducing the scheduleInterval variable in the scheduling logic.

Suggested labels

bug, TSS_MIGRATION_TESTS, PERFORMANCE_TESTS

Suggested reviewers

• gartnera
• skosito
• lumtis

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[github-actions]

!!!WARNING!!!
nosec detected in the following files: zetaclient/chains/bitcoin/bitcoin.go

Be very careful about using #nosec in code. It can be a quick way to suppress security warnings and move forward with development, it should be employed with caution. Suppressing warnings with #nosec can hide potentially serious vulnerabilities. Only use #nosec when you're absolutely certain that the security issue is either a false positive or has been mitigated in another way.

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
Broad #nosec annotations should be avoided, as they can hide other vulnerabilities. The CI will block you from merging this PR until you remove #nosec annotations that do not target specific rules.

Pay extra attention to the way #nosec is being used in the files listed above.

[codecov]

Codecov Report

Attention: Patch coverage is 18.18182% with 9 lines in your changes missing coverage. Please review.

Project coverage is 65.42%. Comparing base (e34fdb4) to head (acac512).
Report is 1 commits behind head on develop.

Files with missing lines	Patch %	Lines
zetaclient/chains/bitcoin/bitcoin.go	18.18%	9 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3509      +/-   ##
===========================================
- Coverage    65.42%   65.42%   -0.01%     
===========================================
  Files          442      442              
  Lines        30527    30531       +4     
===========================================
+ Hits         19972    19974       +2     
- Misses        9700     9702       +2     
  Partials       855      855              

Files with missing lines	Coverage Δ
zetaclient/chains/bitcoin/bitcoin.go	51.33% <18.18%> (-0.04%)	⬇️

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e34fdb4 and acac512.

📒 Files selected for processing (2)

• changelog.md (1 hunks)
• zetaclient/chains/bitcoin/bitcoin.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.go`: Review the Go code, point out issues relative to ...

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

• zetaclient/chains/bitcoin/bitcoin.go

🪛 GitHub Check: codecov/patch

zetaclient/chains/bitcoin/bitcoin.go

[warning] 184-192: zetaclient/chains/bitcoin/bitcoin.go#L184-L192
Added lines #L184 - L192 were not covered by tests

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: start-e2e-test / e2e
• GitHub Check: build-and-test

🔇 Additional comments (2)

zetaclient/chains/bitcoin/bitcoin.go (1)

136-137: LGTM: Clear variable declaration with security comment.

The scheduleInterval variable is properly derived from chain parameters with a security comment to indicate it's always positive.

changelog.md (1)

18-18: LGTM: Clear and concise changelog entry.

The changelog entry accurately describes the change and its purpose.