feat(btc): implement new btc rpc package #3349

swift1337 · 2025-01-13T19:26:48Z

This PR implements Bitcoin client in Go-"native" way

It leverages existing btcsuite types, but removes all redundant features such as websockets or backward compatibility with old BTC versions that are not used anymore
It ensures ctx for each call
The over-complicated chan-based design is replaced with a simple "stateless" request-response approach
It also fixed a significant drawback of the original RPC: lack of ctx might block execution indefinitely & block other routines (see this and this)

Implement BTC Client
Port methods from zetaclient/chains/bitcoin/rpc
Implement prometheus metrics
Port live tests
Replace usage zetaclient/chains/bitcoin/rpc & interfaces.BTCRPCClient with the new client
Fix unit tests
Fix e2e tests

One of examples

Before

// zetaclient/chains/bitcoin/rpc.go
func GetTxResultByHash(
	rpcClient interfaces.BTCRPCClient,
	txID string,
) (*chainhash.Hash, *btcjson.GetTransactionResult, error) {
	hash, err := chainhash.NewHashFromStr(txID)
	if err != nil {
		return nil, nil, errors.Wrapf(err, "GetTxResultByHash: error NewHashFromStr: %s", txID)
	}

	// The Bitcoin node has to be configured to watch TSS address
	txResult, err := rpcClient.GetTransaction(hash)
	if err != nil {
		return nil, nil, errors.Wrapf(err, "GetTxResultByHash: error GetTransaction %s", hash.String())
	}
	return hash, txResult, nil
}

After

tx, err := btcClient.GetTransaction(ctx, txHash)

// or

tx, err := btcClient.GetTransactionByStr(ctx, "my-string-hash")

coderabbitai · 2025-01-13T19:26:56Z

Important

Review skipped

Draft detected.

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

🪧 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 · 2025-01-13T19:27:10Z

!!!WARNING!!!
nosec detected in the following files: zetaclient/chains/bitcoin/client/client_test.go, zetaclient/chains/bitcoin/client/helpers.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 · 2025-01-13T19:33:18Z

Codecov Report

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

Project coverage is 61.56%. Comparing base (8ce300b) to head (2375ca9).
Report is 3 commits behind head on develop.

Files with missing lines	Patch %	Lines
zetaclient/chains/bitcoin/client/commands.go	0.00%	194 Missing ⚠️
zetaclient/chains/bitcoin/client/client.go	0.00%	135 Missing ⚠️
zetaclient/chains/bitcoin/client/helpers.go	0.00%	117 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3349      +/-   ##
===========================================
- Coverage    62.43%   61.56%   -0.88%     
===========================================
  Files          449      452       +3     
  Lines        31710    32152     +442     
===========================================
- Hits         19799    19795       -4     
- Misses       11024    11470     +446     
  Partials       887      887

Files with missing lines	Coverage Δ
zetaclient/metrics/metrics.go	`69.64% <ø> (ø)`
zetaclient/chains/bitcoin/client/helpers.go	`0.00% <0.00%> (ø)`
zetaclient/chains/bitcoin/client/client.go	`0.00% <0.00%> (ø)`
zetaclient/chains/bitcoin/client/commands.go	`0.00% <0.00%> (ø)`

... and 1 file with indirect coverage changes

gartnera

Generally LGTM.

If you directly copy pasted something from btcd please make sure to notate the original license on the file.

gartnera · 2025-01-14T16:57:49Z

zetaclient/chains/bitcoin/client/client.go

+	res, err := c.client.Do(req)
+	if err != nil {
+		return rawResponse{}, errors.Wrap(err, "unable to send the request")
+	}


I think there should be a response code is 200 check here too?

swift1337 added 2 commits January 13, 2025 19:28

Implement BTC client

2d5a733

Port helpers from btc rpc/rpc.go

b1e472d

swift1337 self-assigned this Jan 13, 2025

github-actions bot added the nosec label Jan 13, 2025

swift1337 added chain:bitcoin Bitcoin chain related improvement and removed nosec labels Jan 13, 2025

Add prom metrics

c6a8a68

github-actions bot added the nosec label Jan 14, 2025

Add prom metrics [2]

2375ca9

gartnera reviewed Jan 14, 2025

View reviewed changes

swift1337 added 2 commits January 14, 2025 21:58

Port rpc_live_test

dc5bd2d

Drop RPC package

26e231c

swift1337 mentioned this pull request Jan 14, 2025

feat: support for Bitcoin RBF (Replace-By-Fee) and CPFP (Child-Pays-for-Parent) #3306

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(btc): implement new btc rpc package #3349

feat(btc): implement new btc rpc package #3349

swift1337 commented Jan 13, 2025 •

edited

Loading

coderabbitai bot commented Jan 13, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Jan 13, 2025 •

edited

Loading

codecov bot commented Jan 13, 2025 •

edited

Loading

gartnera left a comment

gartnera Jan 14, 2025

feat(btc): implement new btc rpc package #3349

Are you sure you want to change the base?

feat(btc): implement new btc rpc package #3349

Conversation

swift1337 commented Jan 13, 2025 • edited Loading

One of examples

coderabbitai bot commented Jan 13, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Jan 13, 2025 • edited Loading

codecov bot commented Jan 13, 2025 • edited Loading

Codecov Report

gartnera left a comment

Choose a reason for hiding this comment

gartnera Jan 14, 2025

Choose a reason for hiding this comment

swift1337 commented Jan 13, 2025 •

edited

Loading

github-actions bot commented Jan 13, 2025 •

edited

Loading

codecov bot commented Jan 13, 2025 •

edited

Loading