multi: fix `lnwallet.ErrDoubleSpend` #8887

yyforyongyu · 2024-07-02T18:53:51Z

This PR fixes the matching errors used in lnwallet.ErrDoubleSpend, a misuse of error found in the rebroadcaster's broadcastErrorMapper, and updates the btcd version to fix another error str mismatch among different versions.

Depends on,

Add err match in the package chain btcsuite/btcwallet#937

coderabbitai · 2024-07-02T18:53:56Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

llm-review

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

morehouse · 2024-07-02T23:14:10Z

lnwallet/btcwallet/btcwallet.go

@@ -1202,7 +1202,8 @@ func mapRpcclientError(err error) error {
 	switch {
 	// If the wallet reports a double spend, convert it to our internal
 	// ErrDoubleSpend and return.
-	case errors.Is(err, rpcclient.ErrMempoolConflict),


Why is ErrMempoolConflict handling removed?

I think we only get this error when,

try to fee bump a tx when it doesn't signal RBF

try to spend the same output in a different tx

Either way it shouldn't ever happen in ln. However I decided to not change it now to focus on fixing the error matching issue.

morehouse · 2024-07-02T23:15:22Z

go.mod

+replace github.com/btcsuite/btcd => github.com/yyforyongyu/btcd v0.21.0-beta.0.20240702184211-31cf2383abd1
+
+replace github.com/btcsuite/btcwallet => github.com/yyforyongyu/btcwallet v0.16.11-0.20240702184603-cf50b410fcb1


I don't think we want to replace btcsuite with your fork.

Roasbeef · 2024-07-03T00:36:23Z

Did some git archeology to put together the series of changes that led to these issues, I think I understand what went wrong here, and how we can improve the state of things to avoid issues like this in the future: btcsuite/btcd#2209 (review).

yyforyongyu · 2024-07-03T15:45:48Z

~~Will do a local test like this one once the approach is ACKed, and update the release notes.~~

bhandras

Looks good, pending btcd PR. I just have a question regarding double spend mapping.

bhandras · 2024-07-04T17:11:25Z

config_builder.go

@@ -1475,27 +1478,27 @@ func parseHeaderStateAssertion(state string) (*headerfs.FilterHeader, error) {
 // the neutrino BroadcastError which allows the Rebroadcaster which currently
 // resides in the neutrino package to use all of its functionalities.
 func broadcastErrorMapper(err error) error {
-	returnErr := rpcclient.MapRPCErr(err)
+	var returnErr error


Why not map the error here like before?

To use the method MapRPCErr we need to access the chain backend, which cannot be used here. Instead, we pass the already mapped error to broadcastErrorMapper, and access the method via cs.MapRPCErr above.

bhandras · 2024-07-04T17:14:52Z

lnwallet/btcwallet/btcwallet.go

-		errors.Is(err, chain.ErrMissingInputs):
+		errors.Is(err, chain.ErrMissingInputs),
+		errors.Is(err, chain.ErrTxAlreadyKnown),
+		errors.Is(err, chain.ErrTxAlreadyConfirmed):


Not sure if I'd consider ErrTxAlreadyConfirmed as double spend. Is there a reason to do so?

So during startup, we may rebroadcast our force close tx that can cause this error, which matches the issue voltage has. I think previously we also considered this as ErrDoubleSpend here.

Maybe add a comment here why we classify a already confirmed tx as doublespend ?

tbh I don't think it should be considered as a double spend - we are doing it to keep the existing behavior. IMO it's better to check whether the to-be-published tx already exists in the blockchain or in the mempool before broadcasting it during startup. Or even better, understand why it's broadcast again as I believe there are some internal state updates once a tx is published, but it looks like that state was not persisted.

bhandras

LGTM 🎉

ziggie1984

LGTM, thanks for your work 🙏

NOTE: No need to backport this because its only in LND 18

ziggie1984 · 2024-07-05T09:56:24Z

lnwallet/btcwallet/btcwallet.go

@@ -1202,15 +1202,15 @@ func mapRpcclientError(err error) error {
 	switch {
 	// If the wallet reports a double spend, convert it to our internal


Comment of this function still references the rpcclient pkg.

cool updated.

ziggie1984 · 2024-07-05T10:06:25Z

lnwallet/btcwallet/btcwallet.go

-		errors.Is(err, chain.ErrMissingInputs):
+		errors.Is(err, chain.ErrMissingInputs),
+		errors.Is(err, chain.ErrTxAlreadyKnown),
+		errors.Is(err, chain.ErrTxAlreadyConfirmed):


Maybe add a comment here why we classify a already confirmed tx as doublespend ?

These errors are now defined in `btcwallet/chain` instead of `btcd/rpcclient`.

yyforyongyu added this to the v0.18.2 milestone Jul 2, 2024

yyforyongyu self-assigned this Jul 2, 2024

morehouse reviewed Jul 2, 2024

View reviewed changes

yyforyongyu force-pushed the fix-err-match branch 3 times, most recently from 860e68b to 9bb63f5 Compare July 3, 2024 15:44

yyforyongyu force-pushed the fix-err-match branch 2 times, most recently from bf50c4f to 99a9eff Compare July 4, 2024 05:44

saubyk requested a review from bhandras July 4, 2024 15:23

yyforyongyu requested a review from morehouse July 4, 2024 15:23

saubyk requested a review from ziggie1984 July 4, 2024 15:36

bhandras reviewed Jul 4, 2024

View reviewed changes

yyforyongyu force-pushed the fix-err-match branch from c288c3d to 5085760 Compare July 4, 2024 17:54

bhandras approved these changes Jul 4, 2024

View reviewed changes

ziggie1984 approved these changes Jul 5, 2024

View reviewed changes

yyforyongyu added 6 commits July 6, 2024 13:55

gomod: update btcwallet to include RPC errors

1d40c55

multi: use chain.MapRPCErr instead of rpcclient.MapRPCErr

e0a506a

multi: update RPC error import path

ddf46f4

These errors are now defined in `btcwallet/chain` instead of `btcd/rpcclient`.

lnwallet: fix ErrDoubleSpend

8f4bcd0

docs: update release notes

26a365e

docs: add release notes for 0.18.3

e27a656

yyforyongyu force-pushed the fix-err-match branch from 5085760 to e27a656 Compare July 6, 2024 06:02

yyforyongyu merged commit 3526f82 into lightningnetwork:master Jul 8, 2024
28 of 33 checks passed

yyforyongyu deleted the fix-err-match branch July 8, 2024 06:09

ellemouton mentioned this pull request Jul 8, 2024

build: create v0.18.2-beta release branch #8901

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

multi: fix `lnwallet.ErrDoubleSpend` #8887

multi: fix `lnwallet.ErrDoubleSpend` #8887

yyforyongyu commented Jul 2, 2024 •

edited

Loading

coderabbitai bot commented Jul 2, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

morehouse Jul 2, 2024

yyforyongyu Jul 3, 2024

morehouse Jul 2, 2024

yyforyongyu Jul 3, 2024

Roasbeef commented Jul 3, 2024

yyforyongyu commented Jul 3, 2024 •

edited

Loading

bhandras left a comment

bhandras Jul 4, 2024

yyforyongyu Jul 4, 2024

bhandras Jul 4, 2024

yyforyongyu Jul 4, 2024

ziggie1984 Jul 5, 2024

yyforyongyu Jul 6, 2024

bhandras left a comment

ziggie1984 left a comment •

edited

Loading

ziggie1984 Jul 5, 2024

yyforyongyu Jul 6, 2024

ziggie1984 Jul 5, 2024

		replace github.com/btcsuite/btcd => github.com/yyforyongyu/btcd v0.21.0-beta.0.20240702184211-31cf2383abd1

		replace github.com/btcsuite/btcwallet => github.com/yyforyongyu/btcwallet v0.16.11-0.20240702184603-cf50b410fcb1

		@@ -1202,15 +1202,15 @@ func mapRpcclientError(err error) error {
		switch {
		// If the wallet reports a double spend, convert it to our internal

multi: fix lnwallet.ErrDoubleSpend #8887

multi: fix lnwallet.ErrDoubleSpend #8887

Conversation

yyforyongyu commented Jul 2, 2024 • edited Loading

coderabbitai bot commented Jul 2, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Roasbeef commented Jul 3, 2024

yyforyongyu commented Jul 3, 2024 • edited Loading

bhandras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhandras left a comment

Choose a reason for hiding this comment

ziggie1984 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

multi: fix `lnwallet.ErrDoubleSpend` #8887

multi: fix `lnwallet.ErrDoubleSpend` #8887

yyforyongyu commented Jul 2, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

yyforyongyu commented Jul 3, 2024 •

edited

Loading

ziggie1984 left a comment •

edited

Loading