fix: skip deposit fee calculation if transaction doesn't involve TSS address

[ws4charlie]

Description

Zetaclient lagged behind by 80K~140K blocks in the Bitcoin Testnet3 transaction scanning. I found that the FilterAndParseIncomingTx was a time consuming call in my local simulation against Testnet3.

The root cause of the low performance is the invocation to CalcDepositorFee (it calls Bitcoin RPCs) inside the FilterAndParseIncomingTx, and it is invoked on each of the tx in the block.

Solution: Moving the CalcDepositorFee call to downstream code such that the calculation is only performed on the transactions that involve TSS address.

The fix was tested in my live test that simulates the block scanning process against Bitcoin Testnet3.

No changelog needed as I (@gartnera) will update the changelog before v22.1.0 release.

How Has This Been Tested?

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

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)

• develop

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.

---

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.

[gartnera]

Please target develop first and I'll pull it in to #3152 ?

I don't think just commenting out all the tests is acceptable right?

[ws4charlie]

Please target develop first and I'll pull it in to #3152 ?

I don't think just commenting out all the tests is acceptable right?

Understood. The CalcDepositorFee calls RPCs lively to get transaction fee. The old version takes the depositorFee as an argument so the unit tests were easy. To bring the unit tests back, I'll create an official refactor PR to develop branch.

I can try creating a official fix with refactor pointing to develop branch. But it would take some time, hopefully get a PR by today.

[gartnera]

Please target develop first and I'll pull it in to #3152 ?
I don't think just commenting out all the tests is acceptable right?

Understood. The CalcDepositorFee calls RPCs lively to get transaction fee. The old version takes the depositorFee as an argument so the unit tests were easy. To bring the unit tests back, I'll create an official refactor PR to develop branch.

I can try creating a official fix with refactor pointing to develop branch. But it would take some time, hopefully get a PR by today.

@ws4charlie A potential easy way to make this work quickly is take a parameter depositorFee func() (float64, error) to GetBtcEvent which would allow you to set a static fee in unit tests but still call the rpc in the live environment if/when needed.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 18 lines in your changes missing coverage. Please review.

Project coverage is 63.94%. Comparing base (f92effb) to head (9f9cb03).

Files with missing lines	Patch %	Lines
zetaclient/chains/bitcoin/observer/inbound.go	0.00%	14 Missing ⚠️
zetaclient/chains/bitcoin/observer/witness.go	0.00%	4 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff               @@
##           release/v22    #3161      +/-   ##
===============================================
- Coverage        64.40%   63.94%   -0.46%     
===============================================
  Files              412      412              
  Lines            28998    29001       +3     
===============================================
- Hits             18676    18546     -130     
- Misses            9534     9673     +139     
+ Partials           788      782       -6     

Files with missing lines	Coverage Δ
zetaclient/chains/bitcoin/observer/witness.go	11.11% <0.00%> (-57.92%)	⬇️
zetaclient/chains/bitcoin/observer/inbound.go	13.27% <0.00%> (-16.44%)	⬇️

... and 2 files with indirect coverage changes

[ws4charlie]

replaced by #3162