Beat [1/4]: handle sweeper's broadcast error #8893

yyforyongyu · 2024-07-04T12:53:55Z

Depends on #8892.

This PR prepares the incoming blockbeat PRs, the changes are,

BlockEpoch now has the block data instead of the block header. This block data is used in the incoming blockbeat PR to query spending transactions.
Added a new sweeping state, TxError. Inputs resulting in this state will be removed from the sweeper.
check input's CSV and CLTV in the sweeper, and skip sweeping them if not matured.
When calculating the deadline, make sure it's derived from mature height, not current height.

coderabbitai · 2024-07-04T12:54:00Z

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>, 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.

CodeRabbit Configuration 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.

guggero

Very nice! Did a quick drive-by review to load up on context. Not super familiar with the new sweeper system, so best not to count this review at all. I'm mostly interested in the block beat implementation itself (which seems to be part 2 of 3).

chainntnfs/best_block_view_test.go

sweep/sweeper.go

ellemouton

high level pass looks good! I need to spend a bit more time getting familiar with sweeper stuff on the next pass though

chainntnfs/interface.go

ellemouton · 2024-07-16T11:50:23Z

sweep/fee_bumper.go

 		log.Debugf("Removing confirmed monitor record=%v, tx=%v", id,
 			result.Tx.TxHash())

+	case TxError:


nit: the select's comment should probably be updated explaining this third case

cool updated the docs to make it more clear.

ellemouton · 2024-07-16T12:01:28Z

sweep/fee_bumper.go

@@ -124,6 +124,10 @@ type BumpRequest struct {
 	// StartingFeeRate is an optional parameter that can be used to specify
 	// the initial fee rate to use for the fee function.


may help with review just to say in the commit msg why it will not work with the upcoming change? just cause this commit still does allow immediate broadcast if Immediate is true so it is unclear just looking at this commit why that then would work later?

cool updated!

sweep/fee_bumper.go

sweep/fee_bumper_test.go

ellemouton · 2024-07-16T12:29:10Z

sweep/fee_bumper_test.go

+	inp := createTestInput(1000, input.WitnessKeyHash)
+
+	// Create a testing bump request.
+	req := &BumpRequest{


should we add a test case for when BumpRequest.Immediate is true?

good call, added!

guggero · 2024-07-23T18:13:35Z

Aarrgh.... Sorry, I deleted the base branch before GitHub could re-base it...

guggero · 2024-07-23T18:14:41Z

Testing re-open

guggero

My main question and/or concern is with the first commit, that could have a big negative impact on Neutrino. Not sure how consequential that is for the rest of the series of PRs?

The rest looks good to me 🎉

guggero · 2024-07-24T11:50:25Z

chainntnfs/neutrinonotify/neutrino.go

-	startingHeader, err := n.p2pNode.GetBlockHeader(
-		&startingPoint.Hash,
-	)
+	startingBlock, err := n.p2pNode.GetBlock(startingPoint.Hash)


Hmm, doesn't this change mean that in a Neutrino environment we're suddenly fetching way more blocks (if not all) from our peers instead of just the header that we have anyway?

Maybe we need to find some middle ground where we have a new struct that has the hash, height and header and then fn.Option[Block] that is fn.None for Neutrino. Then when we decide we actually want to fetch the block we do it lazily?

I think it means we will fetch the block once from one of the peers then it will be cached? Will investigate more.

guggero · 2024-07-24T11:54:42Z

sweep/fee_bumper.go

 	t.records.ForEach(visitor)

+	// Handle the initial broadcast.
+	for requestID, r := range initialRecords {
+		rec := r


I don't think this is needed anymore. First, because we're using Go 1.22 and second because the loop variable is passed to a method call, so it's placed on the stack anyway.

Removed - also added a commit to remove other occurrence

morehouse · 2024-07-23T21:23:40Z

chainntnfs/bitcoindnotify/bitcoind.go

@@ -178,7 +178,8 @@ func (b *BitcoindNotifier) startNotifier() error {
 	if err != nil {
 		return err
 	}
-	blockHeader, err := b.chainConn.GetBlockHeader(currentHash)
+
+	block, err := b.GetBlock(currentHash)


What's the difference between b.GetBlock and b.chainConn.GetBlock?

b.GetBlock wraps the b.chainConn.GetBlock inside a cache.

morehouse · 2024-07-23T21:34:22Z

chainntnfs/neutrinonotify/neutrino.go

-	startingHeader, err := n.p2pNode.GetBlockHeader(
-		&startingPoint.Hash,
-	)
+	startingBlock, err := n.p2pNode.GetBlock(startingPoint.Hash)


I think this skips the locking that's normally done in n.GetBlock.

Replaced with n.GetBlock

morehouse · 2024-07-23T21:37:35Z

chainntnfs/neutrinonotify/neutrino.go

+func (n *NeutrinoChainConn) GetBlock(
+	blockHash *chainhash.Hash) (*wire.MsgBlock, error) {
+
+	utilBlock, err := n.p2pNode.GetBlock(*blockHash)


Might also be a locking problem here.

Could you elaborate a bit? Think the lock is only used in NeutrinoNotifier tho

sweep/fee_bumper.go

morehouse · 2024-07-24T20:13:00Z

sweep/fee_bumper.go

+	if req.Immediate {
+		t.handleInitialBroadcast(record, requestID)
+	}


So for the typical case (Immediate: false) we now wait an extra block before broadcasting? We already wait one block for the sweeper to process the transaction, and now this waits another before broadcasting...

We actually save two blocks (worst case) when sweeping inputs now. So this PR is some commits cherry-picked from the final PR so it may not make sense to look at it alone, but the full pic is, suppose a force close happens at block X, contractcourt will process block X, prepare all the necessary resolutions, offer them to the sweeper. Then sweeper processes block X by broadcasting the sweeping txns.

morehouse · 2024-07-24T20:23:12Z

sweep/fee_bumper.go

+		// Create a tx so the caller knows which inputs have failed.
+		sweepTx := wire.NewMsgTx(2)
+		for _, o := range r.req.Inputs {
+			sweepTx.AddTxIn(&wire.TxIn{
+				PreviousOutPoint: o.OutPoint(),
+				Sequence:         o.BlocksToMaturity(),
+			})
+		}


It seems hacky to create a fake tx to tell the caller info it should already know.

updated the flow here - we now no longer need to get the inputs from the tx!

morehouse · 2024-07-24T20:23:50Z

sweep/fee_bumper.go

+			event = TxFailed
+
+		default:
+			event = TxError


In what circumstances would we hit this case?

updated the comments

sweep/sweeper.go

morehouse · 2024-07-24T21:02:58Z

sweep/sweeper.go

@@ -221,6 +221,30 @@ func (p *SweeperInput) terminated() bool {
 	}
 }

+// isMature returns a boolean indicating whether the input has a timelock that
+// has been reached or not. The locktime found is also returned.
+func (p *SweeperInput) isMature(currentHeight uint32) (bool, uint32) {


How do timelocked inputs get to the sweeper? I thought they were only supposed to be offered to the sweeper once timelocks are fulfilled.

yeah it's changed in a later PR.

lightninglabs-deploy · 2024-10-17T19:53:37Z

@ellemouton: review reminder
@yyforyongyu, remember to re-request review from reviewers when ready

ellemouton

@yyforyongyu - am assuming this is not yet ready for another round yeah?

yyforyongyu · 2024-10-21T13:00:52Z

@yyforyongyu - am assuming this is not yet ready for another round yeah?

Thanks for checking in! Nope not yet, will request once ready!

So the block data can be used by subsystems without calling `GetBlock`.

Also updated the loggings. This new state will be used in the following commit.

This prepares the following commit where we now let the fee bumpr decides whether to broadcast immediately or not.

This commit changes how inputs are handled upon receiving a bump result. Previously the inputs are taken from the `BumpResult.Tx`, which is now instead being handled locally as we will remember the input set when sending the bump request, and handle this input set when a result is received.

This commit adds a new method `handleInitialBroadcast` to handle the initial broadcast. Previously we'd broadcast immediately inside `Broadcast`, which soon will not work after the `blockbeat` is implemented as the action to publish is now always triggered by a new block. Meanwhile, we still keep the option to bypass the block trigger so users can broadcast immediately by setting `Immediate` to true.

Previously in `markInputFailed`, we'd remove all inputs under the same group via `removeExclusiveGroup`. This is wrong as when the current sweep fails for this input, it shouldn't affect other inputs.

Also updated `handlePendingSweepsReq` to skip immature inputs so the returned results are the same as those in pre-0.18.0.

yyforyongyu added the utxo sweeping label Jul 4, 2024

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

yyforyongyu mentioned this pull request Jul 4, 2024

Beat [2/4]: implement blockbeat #8894

Open

2 tasks

guggero reviewed Jul 8, 2024

View reviewed changes

chainntnfs/best_block_view_test.go Outdated Show resolved Hide resolved

sweep/sweeper.go Outdated Show resolved Hide resolved

saubyk assigned yyforyongyu Jul 9, 2024

yyforyongyu force-pushed the yy-itest-miner branch 2 times, most recently from 263006e to 4630d4f Compare July 11, 2024 09:39

yyforyongyu force-pushed the yy-prepare-blockbeat branch from a0393a0 to 9d6f8e7 Compare July 11, 2024 09:45

saubyk requested a review from ellemouton July 11, 2024 15:17

saubyk added the P1 MUST be fixed or reviewed label Jul 15, 2024

yyforyongyu force-pushed the yy-itest-miner branch 2 times, most recently from 388981d to adca500 Compare July 15, 2024 18:02

yyforyongyu force-pushed the yy-prepare-blockbeat branch from 9d6f8e7 to 7183080 Compare July 15, 2024 18:04

yyforyongyu force-pushed the yy-itest-miner branch from adca500 to c5e6b49 Compare July 15, 2024 20:54

yyforyongyu force-pushed the yy-prepare-blockbeat branch from 7183080 to 8b95551 Compare July 15, 2024 21:47

ellemouton reviewed Jul 16, 2024

View reviewed changes

yyforyongyu force-pushed the yy-itest-miner branch 4 times, most recently from 1e898e2 to 4548971 Compare July 18, 2024 01:36

yyforyongyu changed the title ~~Beat [1/3]: handle sweeper's broadcast error~~ Beat [1/4]: handle sweeper's broadcast error Jul 18, 2024

yyforyongyu force-pushed the yy-prepare-blockbeat branch from 8b95551 to 9ec032a Compare July 18, 2024 07:27

yyforyongyu requested review from guggero and ellemouton July 18, 2024 07:27

saubyk modified the milestones: v0.18.3, v0.19.0 Jul 18, 2024

yyforyongyu force-pushed the yy-itest-miner branch 2 times, most recently from e0ec893 to 9180762 Compare July 23, 2024 16:49

guggero deleted the branch lightningnetwork:yy-feature-blockbeat July 23, 2024 18:12

guggero closed this Jul 23, 2024

guggero reopened this Jul 23, 2024

yyforyongyu deleted the branch lightningnetwork:yy-feature-blockbeat July 23, 2024 18:14

yyforyongyu closed this Jul 23, 2024

yyforyongyu reopened this Jul 23, 2024

yyforyongyu changed the base branch from yy-itest-miner to master July 23, 2024 18:19

yyforyongyu force-pushed the yy-prepare-blockbeat branch from 9ec032a to 436aece Compare July 23, 2024 18:19

guggero reviewed Jul 24, 2024

View reviewed changes

morehouse reviewed Jul 24, 2024

View reviewed changes

yyforyongyu force-pushed the yy-prepare-blockbeat branch from 436aece to f6c5de6 Compare October 15, 2024 09:16

ellemouton reviewed Oct 21, 2024

View reviewed changes

yyforyongyu added 2 commits October 24, 2024 01:17

chainntnfs+lnd: replace BlockHeader with Block

285acac

So the block data can be used by subsystems without calling `GetBlock`.

sweep: add new state TxError for erroneous sweepings

5456324

Also updated the loggings. This new state will be used in the following commit.

yyforyongyu changed the base branch from master to yy-feature-blockbeat October 25, 2024 07:13

yyforyongyu and others added 9 commits October 25, 2024 15:27

sweep: add new error ErrZeroFeeRateDelta

d117bd8

sweep: add new interface method Immediate

2750840

This prepares the following commit where we now let the fee bumpr decides whether to broadcast immediately or not.

sweep: remove redundant error from Broadcast

1c30efd

sweep: add method handleBumpEventError and fix markInputFailed

5d15ff2

Previously in `markInputFailed`, we'd remove all inputs under the same group via `removeExclusiveGroup`. This is wrong as when the current sweep fails for this input, it shouldn't affect other inputs.

sweep: add method isMature on SweeperInput

5a32643

Also updated `handlePendingSweepsReq` to skip immature inputs so the returned results are the same as those in pre-0.18.0.

sweep: make sure defaultDeadline is derived from the mature height

2ae8330

sweep: remove redundant loopvar assign

0f280d2

yyforyongyu force-pushed the yy-prepare-blockbeat branch from f6c5de6 to 0f280d2 Compare October 25, 2024 10:52

		@@ -124,6 +124,10 @@ type BumpRequest struct {
		// StartingFeeRate is an optional parameter that can be used to specify
		// the initial fee rate to use for the fee function.

Beat [1/4]: handle sweeper's broadcast error #8893

Are you sure you want to change the base?

Beat [1/4]: handle sweeper's broadcast error #8893

Conversation

yyforyongyu commented Jul 4, 2024 • edited Loading

coderabbitai bot commented Jul 4, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

guggero left a comment

Choose a reason for hiding this comment

ellemouton 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

guggero commented Jul 23, 2024

guggero commented Jul 23, 2024

guggero 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

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

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

lightninglabs-deploy commented Oct 17, 2024

ellemouton left a comment

Choose a reason for hiding this comment

yyforyongyu commented Oct 21, 2024

yyforyongyu commented Jul 4, 2024 •

edited

Loading

coderabbitai bot commented Jul 4, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)