search

zeta-chain / node

ZetaChain’s blockchain node and an observer validator client
https://zetachain.com
MIT License
167 stars 109 forks source link

fix: skip depositor fee calculation on irrelevant transactions #3162

Closed ws4charlie closed 1 week ago

ws4charlie commented 1 week ago

Description

The official fix that replaces https://github.com/zeta-chain/node/pull/3161

How Has This Been Tested?

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
📝 Walkthrough ## Walkthrough The pull request introduces several updates to the ZetaChain project, including new features like the ability to whitelist SPL tokens on Solana and enhancements to SPL deposits and withdrawals. Significant refactoring has occurred, including the removal of the HSM signer and simplification of the zetaclientd configuration. The tests have been expanded to include new scenarios for concurrent operations and error handling. Fixes address various issues, such as emissions registration and transaction handling, thereby improving overall system reliability and user experience. ## Changes | File Path | Change Summary | |-----------------------------------------------|----------------------------------------------------------------------------------------------------| | changelog.md | Updated to include new features, improvements, refactoring, and fixes across various components. | | zetaclient/chains/bitcoin/fee.go | Added `DepositorFeeCalculator` type for flexible Bitcoin depositor fee calculations. | | zetaclient/chains/bitcoin/observer/inbound.go| Updated methods to use `DepositorFeeCalculator` for fee calculations, enhancing modularity. | | zetaclient/chains/bitcoin/observer/inbound_test.go | Introduced `mockDepositFeeCalculator` for testing fee calculations, enhancing test flexibility. | | zetaclient/chains/bitcoin/observer/witness.go| Modified `GetBtcEventWithWitness` to use `DepositorFeeCalculator` for fee calculation. | | zetaclient/chains/bitcoin/observer/witness_test.go | Added tests for error scenarios and updated existing tests to utilize the mock fee calculator. | ## Possibly related PRs - **#2751**: Adds an RPC status check for the Solana chain, relevant to the updates on integrating SPL deposits and withdrawals. - **#2957**: Focuses on parsing Bitcoin deposit memos with inscriptions, aligning with improvements in deposit functionalities. - **#3142**: Implements a mechanism to abort CCTX on detecting a dust amount, directly related to handling transaction errors. - **#3149**: Enhances handling of dust amounts in revert outbound transactions for Bitcoin and Solana, closely related to transaction handling improvements. ## Suggested labels `chain:bitcoin`, `no-changelog`, `SOLANA_TESTS` ## Suggested reviewers - fbac - kingpinXD - skosito - brewmaster012 - lumtis - swift1337

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 84.21053% with 3 lines in your changes missing coverage. Please review.

Project coverage is 62.67%. Comparing base (6fb64ca) to head (72d32e1). Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
zetaclient/chains/bitcoin/observer/inbound.go 80.00% 3 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/zeta-chain/node/pull/3162/graphs/tree.svg?width=650&height=150&src=pr&token=JABAIMO8MP&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain)](https://app.codecov.io/gh/zeta-chain/node/pull/3162?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain) ```diff @@ Coverage Diff @@ ## develop #3162 +/- ## =========================================== + Coverage 62.64% 62.67% +0.03% =========================================== Files 424 424 Lines 30124 30128 +4 =========================================== + Hits 18872 18884 +12 + Misses 10410 10402 -8 Partials 842 842 ``` | [Files with missing lines](https://app.codecov.io/gh/zeta-chain/node/pull/3162?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain) | Coverage Δ | | |---|---|---| | [zetaclient/chains/bitcoin/fee.go](https://app.codecov.io/gh/zeta-chain/node/pull/3162?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbitcoin%2Ffee.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYml0Y29pbi9mZWUuZ28=) | `39.02% <ø> (ø)` | | | [zetaclient/chains/bitcoin/observer/witness.go](https://app.codecov.io/gh/zeta-chain/node/pull/3162?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbitcoin%2Fobserver%2Fwitness.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYml0Y29pbi9vYnNlcnZlci93aXRuZXNzLmdv) | `70.08% <100.00%> (+1.05%)` | :arrow_up: | | [zetaclient/chains/bitcoin/observer/inbound.go](https://app.codecov.io/gh/zeta-chain/node/pull/3162?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbitcoin%2Fobserver%2Finbound.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYml0Y29pbi9vYnNlcnZlci9pbmJvdW5kLmdv) | `32.05% <80.00%> (+2.35%)` | :arrow_up: |