search

zeta-chain / node

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

refactor: remove btc deposit fee v1 and improve unit tests #2899

Closed ws4charlie closed 4 days ago

ws4charlie commented 1 week ago

Description

Closes: https://github.com/zeta-chain/node/issues/2766

How Has This Been Tested?

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!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 The pull request introduces several significant changes across multiple files, primarily focusing on the simplification and refactoring of Bitcoin transaction handling. Key modifications include the removal of the `depositorFee` variable, the introduction of new methods for block confirmation, and a complete overhaul of the `CalcDepositorFee` function. Additionally, a new data structure, `BTCInboundEvent`, is implemented for better organization of incoming transaction data, while test files are updated for improved clarity and maintainability. ## Changes | Files | Change Summary | |----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `e2e/runner/bitcoin.go` | Removed `depositorFee` variable from `SendToTSSFromDeployerWithMemo` function, affecting transaction processing. | | `zetaclient/chains/base/observer.go` | Added `IsBlockConfirmed` method to `Observer` struct to check block confirmation status. | | `zetaclient/chains/bitcoin/fee.go` | Refactored `CalcDepositorFee` to `CalcDepositorFeeV2`, changing input parameters from block to transaction results. | | `zetaclient/chains/bitcoin/observer/inbound.go` | Introduced `BTCInboundEvent` struct for incoming Bitcoin transactions and updated related functions to utilize this new structure. | | `zetaclient/chains/bitcoin/observer/inbound_test.go` | Removed `createRPCClientAndLoadTx` and replaced it with `testrpc.CreateBTCRPCAndLoadTx`, updating tests accordingly. | | `zetaclient/chains/bitcoin/observer/observer.go` | Removed `BTCInboundEvent` struct and `GetSenderAddressByVin` function, indicating a refactor in transaction handling. | | `zetaclient/chains/bitcoin/observer/observer_test.go` | Updated mock client usage to improve test clarity and maintainability. | | `zetaclient/chains/bitcoin/observer/outbound_test.go` | Modified `MockBTCObserverMainnet` to use a more versatile mock client for better testing fidelity. | | `zetaclient/chains/bitcoin/observer/witness.go` | Added `DepositorFee` field to `BTCInboundEvent` struct to enhance transaction data representation. | | `zetaclient/chains/bitcoin/rpc/rpc_live_test.go` | Removed a floating-point parameter and renamed `LiveTest_CalcDepositorFeeV2` to `LiveTest_CalcDepositorFee`. | | `zetaclient/testdata/btc/...` | Added new JSON file representing a Bitcoin transaction structure. | | `zetaclient/testutils/mocks/btc_rpc.go` | Overhauled mock implementation for `BTCRPCClient`, enhancing functionality and usability in tests. | | `zetaclient/testutils/testrpc/rpc_btc.go` | Introduced `CreateBTCRPCAndLoadTx` function for loading raw Bitcoin transactions into a mock RPC client for testing. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Observer participant BTCInboundEvent participant TransactionHandler Observer->>TransactionHandler: ObserveInbound() TransactionHandler->>BTCInboundEvent: Create new event TransactionHandler->>Observer: Return BTCInboundEvent ``` ## Assessment against linked issues | Objective | Addressed | Explanation | |---------------------------------------------------------------------------|-----------|------------------------------------------------| | Clean up the usage of `CalcDepositorFeeV1` once upgrade height reached (2766) | ✅ | | ## Possibly related issues - **#2495**: The introduction of `BTCInboundEvent` suggests a potential opportunity to unify it with the newly introduced `InboundEvent` struct for consistency across the codebase. ## Possibly related PRs - **#2750**: This PR's refactoring of `CalcDepositorFee` relates closely to the changes made in this PR regarding fee handling. - **#2751**: The modifications to the `Observer` struct in this PR align with the changes made to transaction processing in the current PR. - **#2895**: The end-to-end test for Bitcoin deposits is directly relevant to the functionality being modified in this PR. ## Suggested labels `breaking:cli`, `no-changelog`, `UPGRADE_TESTS`

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://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) 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 69.73684% with 23 lines in your changes missing coverage. Please review.

Project coverage is 67.27%. Comparing base (d14b200) to head (49f3fef). Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
zetaclient/chains/bitcoin/observer/inbound.go 46.51% 23 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/zeta-chain/node/pull/2899/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/2899?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 #2899 +/- ## =========================================== + Coverage 67.20% 67.27% +0.06% =========================================== Files 380 380 Lines 21170 21175 +5 =========================================== + Hits 14227 14245 +18 + Misses 6276 6264 -12 + Partials 667 666 -1 ``` | [Files with missing lines](https://app.codecov.io/gh/zeta-chain/node/pull/2899?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/base/observer.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbase%2Fobserver.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYmFzZS9vYnNlcnZlci5nbw==) | `87.19% <100.00%> (+0.25%)` | :arrow_up: | | [zetaclient/chains/bitcoin/fee.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?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=) | `41.52% <ø> (+3.54%)` | :arrow_up: | | [zetaclient/chains/bitcoin/observer/observer.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbitcoin%2Fobserver%2Fobserver.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYml0Y29pbi9vYnNlcnZlci9vYnNlcnZlci5nbw==) | `32.63% <ø> (-5.68%)` | :arrow_down: | | [zetaclient/chains/bitcoin/observer/witness.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?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) | `71.73% <100.00%> (+0.95%)` | :arrow_up: | | [zetaclient/chains/bitcoin/tx\_script.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?src=pr&el=tree&filepath=zetaclient%2Fchains%2Fbitcoin%2Ftx_script.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC9jaGFpbnMvYml0Y29pbi90eF9zY3JpcHQuZ28=) | `90.12% <100.00%> (+1.00%)` | :arrow_up: | | [zetaclient/testutils/testdata.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?src=pr&el=tree&filepath=zetaclient%2Ftestutils%2Ftestdata.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zeta-chain#diff-emV0YWNsaWVudC90ZXN0dXRpbHMvdGVzdGRhdGEuZ28=) | `87.41% <100.00%> (+0.45%)` | :arrow_up: | | [zetaclient/chains/bitcoin/observer/inbound.go](https://app.codecov.io/gh/zeta-chain/node/pull/2899?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) | `18.11% <46.51%> (+3.98%)` | :arrow_up: |
github-actions[bot] commented 1 week ago

!!!WARNING!!! nosec detected in the following files: zetaclient/chains/bitcoin/observer/inbound.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.