sweeper: rename `Failed` to `Fatal` and minor refactor by yyforyongyu · Pull Request #9446 · lightningnetwork/lnd

yyforyongyu · 2025-01-26T02:01:35Z

Check-picked some commits from the final sweeper fix.

This is a pure refactoring PR to make a following fix easier to implement, the changes are,

rename Failed to Fatal for clarity.
shorten method signatures.
rename storeRecord to updateRecord for clarity.

coderabbitai · 2025-01-26T02:01:42Z

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

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.

ellemouton

refactor LGTM! (small rebase artefact nit)

ellemouton · 2025-01-28T16:13:38Z

+	req *BumpRequest, f FeeFunction) {
+
+	// Register the record.
+	t.records.Store(requestID, &monitorRecord{


should we comment somewhere that this should be the only call-site of t.records.Store?

So there's one other location right now:

lnd/sweep/fee_bumper.go

Lines 427 to 441 in 0ac5bfa

// storeInitialRecord initializes a monitor record and saves it in the map.

func (t *TxPublisher) storeInitialRecord(req *BumpRequest) (

uint64, *monitorRecord) {

// Increase the request counter.

//

// NOTE: this is the only place where we increase the counter.

requestID := t.requestCounter.Add(1)

// Register the record.

record := &monitorRecord{req: req}

t.records.Store(requestID, record)

return requestID, record

}

As is, it's used for initial storage (no fee function set, etc). It's also where the requestID is allocated for the first time.

yeah we do have two places - one for initializing the record, the other is used to update.

Roasbeef

LGTM 🐯

Roasbeef · 2025-02-03T23:47:24Z

 			// The tx is valid, store it.
-			t.storeRecord(
-				requestID, sweepCtx.tx, req, f, sweepCtx.fee,
-				sweepCtx.outpointToTxIndex,


Nice simplification (roll in fields already part of sweepCtx).

Roasbeef · 2025-02-03T23:51:38Z

+	req *BumpRequest, f FeeFunction) {
+
+	// Register the record.
+	t.records.Store(requestID, &monitorRecord{


So there's one other location right now:

lnd/sweep/fee_bumper.go

Lines 427 to 441 in 0ac5bfa

// storeInitialRecord initializes a monitor record and saves it in the map.

func (t *TxPublisher) storeInitialRecord(req *BumpRequest) (

uint64, *monitorRecord) {

// Increase the request counter.

//

// NOTE: this is the only place where we increase the counter.

requestID := t.requestCounter.Add(1)

// Register the record.

record := &monitorRecord{req: req}

t.records.Store(requestID, record)

return requestID, record

}

As is, it's used for initial storage (no fee function set, etc). It's also where the requestID is allocated for the first time.

Roasbeef · 2025-02-03T23:56:39Z

-
-	// spendNotifiers is a map of spend notifiers registered for all the
-	// inputs.
-	spendNotifiers map[wire.OutPoint]*chainntnfs.SpendEvent


Added in an earlier commit, and removed here.

Roasbeef · 2025-02-03T23:56:56Z

-	req *BumpRequest, f FeeFunction) {
+// updateRecord updates the given record's tx and fee, and saves it in the
+// records map.
+func (t *TxPublisher) updateRecord(r *monitorRecord,


solid change 👍

This commit renames `Failed` to `Fatal` as it sounds too close to `PublishFailed`. We also wanna emphasize that inputs in this state won't be retried.

This commit shortens the function signature of `storeRecord`, also makes sure we don't call `t.records.Store` directly but always using `storeRecord` instead so it's easier to trace the record creation.

This way we can greatly simplify the method signatures, also paving the upcoming changes where we wanna make it clear when updating the monitorRecord, we only touch a portion of it.

To make it clear we are only updating fields, which will be handy for the following commit where we start tracking for spending notifications.

yyforyongyu added utxo sweeping refactoring size/micro small bug fix or feature, less than 15 mins of review, less than 250 labels Jan 26, 2025

yyforyongyu added this to the v0.19.0 milestone Jan 26, 2025

This was referenced Jan 26, 2025

sweep: start tracking input spending status in the fee bumper #9447

Merged

sweep: properly handle failed sweeping txns #9448

Merged

yyforyongyu force-pushed the yy-prepare-fee-replace branch from e8cb0c7 to a738e7f Compare January 27, 2025 09:51

morehouse reviewed Jan 27, 2025

View reviewed changes

Comment thread sweep/fee_bumper.go Outdated

ellemouton approved these changes Jan 28, 2025

View reviewed changes

Roasbeef approved these changes Feb 3, 2025

View reviewed changes

yyforyongyu added 5 commits February 5, 2025 19:48

sweep: rename Failed to Fatal

c68b8e8

This commit renames `Failed` to `Fatal` as it sounds too close to `PublishFailed`. We also wanna emphasize that inputs in this state won't be retried.

sweep: shorten storeRecord method signature

bde5124

This commit shortens the function signature of `storeRecord`, also makes sure we don't call `t.records.Store` directly but always using `storeRecord` instead so it's easier to trace the record creation.

sweep: add requestID to monitorRecord

7eea7a7

This way we can greatly simplify the method signatures, also paving the upcoming changes where we wanna make it clear when updating the monitorRecord, we only touch a portion of it.

sweep: refactor storeRecord to updateRecord

e5f39dd

To make it clear we are only updating fields, which will be handy for the following commit where we start tracking for spending notifications.

docs: update release notes

b98542b

yyforyongyu force-pushed the yy-prepare-fee-replace branch from a738e7f to b98542b Compare February 5, 2025 11:51

yyforyongyu merged commit bac699d into lightningnetwork:master Feb 5, 2025

yyforyongyu deleted the yy-prepare-fee-replace branch February 5, 2025 15:08

	// storeInitialRecord initializes a monitor record and saves it in the map.
	func (t TxPublisher) storeInitialRecord(req BumpRequest) (
	uint64, *monitorRecord) {

	// Increase the request counter.
	//
	// NOTE: this is the only place where we increase the counter.
	requestID := t.requestCounter.Add(1)

	// Register the record.
	record := &monitorRecord{req: req}
	t.records.Store(requestID, record)

	return requestID, record
	}

Conversation

yyforyongyu commented Jan 26, 2025

Uh oh!

coderabbitai Bot commented Jan 26, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ellemouton Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

Roasbeef Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

yyforyongyu Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Roasbeef left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Roasbeef Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

Roasbeef Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

Roasbeef Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

Roasbeef Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CodeRabbit Configuration File (`.coderabbit.yaml`)