invoices: amp invoices bugfix. #9459

ziggie1984 · 2025-01-30T00:35:51Z

This PR makes sure that HTLCs in the accepted state will be canceled back if the invoice expires.

However as soon as a sub AMP invoice is settled we do not allow expiring the invoice anyways so canceling the invoice call will fail because we have a check for HTLC which are in the settled state and will return an error, never closing the invoice. This has the positive side-effect that all HTLCs in the accepted state will be cancelled via the invoiceEventLoop. However we should definitly fix this behaviour for AMP invoices and also close them, hence not accepting any new payment to it.

coderabbitai · 2025-01-30T00:35:58Z

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.

yyforyongyu · 2025-01-30T02:50:35Z

why is this in 0.18.5?

saubyk · 2025-01-30T05:05:10Z

why is this in 0.18.5?

my bad. tagged for 0.19 now

guggero · 2025-01-30T07:45:05Z

No, 0.18.5 is correct, we'll want it in there as it's an important bug fix. Going to re-tag.

channeldb/invoices.go

docs/release-notes/release-notes-0.19.0.md

ziggie1984 · 2025-01-30T16:13:59Z

This PR lead to the following feature request: #9463

guggero

Looks good to me. Left a question, since I'm missing a lot of context.

channeldb/invoices.go

guggero · 2025-01-30T20:09:48Z

channeldb/invoices.go

@@ -848,7 +838,23 @@ func (k *kvInvoiceUpdater) Finalize(updateType invpkg.UpdateType) error {
 		return k.storeSettleHodlInvoiceUpdate()

 	case invpkg.CancelInvoiceUpdate:
-		return k.serializeAndStoreInvoice()
+		err := k.serializeAndStoreInvoice()


Couldn't we instead just call k.storeCancelHtlcsUpdate()? Which makes me think why we didn't do that in the first place? Maybe there's a reason? Missing too much context to be sure...

good call, changed it makes absolutely sense to also persist the AMP state. We never changed the AMP related stuff when canceling an invoice, which is acutally the bug this PR is fixing.

invoices/invoiceregistry.go

bhandras · 2025-01-30T14:06:44Z

channeldb/invoices.go

 		invoice, err := fetchInvoice(
-			invoiceNum, invoices, []*invpkg.SetID{&invSetID}, false,
+			invoiceNum, invoices, []*invpkg.SetID{setIDHint}, false,


Note that this changes behavior slightly as previously we'd pass in a pointer to an empty set id if the hint was nil whereas now we pass in the nil which isn't considered the same as an empty set id. PTAL here on how it is used within this package:

lnd/channeldb/invoices.go

Line 1579 in 32cdbb4

if len(setIDs) != 0 && setIDs[0] != nil &&

Yes I know this is a change to the logic however I think it was a bug in the first place, for the UpdateInvoice functionality. Because UpdateInvoice will always update a state. Normally we should always have the setID set for AMP invoices. However now that we cancel also the AMP invoice we need to make sure we consider all HTLCs according all setIDs if we cancel the invoice (in case multiple attempts are in the accepted state across multiple setIDs).

moreover if it is not a AMP invoice in the first place this setting is irrelevant anyways:

We already prevent fetching it for non-AMP invoices here in the kv store:

lnd/channeldb/invoices.go

Lines 1541 to 1543 in f4bf99b

if !invoice.IsAMP() {

return invoice, nil

}

And also in the sql store:

lnd/invoices/sql_store.go

Lines 1556 to 1569 in f4bf99b

if invoice.IsAMP() {

invoiceID := int64(invoice.AddIndex)

ampState, ampHtlcs, err := fetchAmpState(

ctx, db, invoiceID, setID, fetchAmpHtlcs,

)

if err != nil {

return nil, nil, err

}

invoice.AMPState = ampState

invoice.Htlcs = ampHtlcs

return hash, invoice, nil

}

Discussed this offline too. It's probably the best if we remove the HtlcSetBlankModifier altogether as it is not used anywhere.

bhandras · 2025-01-30T14:22:04Z

channeldb/invoices.go

+			return err
+		}
+
+		// If this is an AMP invoice, then we'll actually store the rest


nit: i think this comment could be a bit more descriptive. A reader might be interested in why we're actually updating the amp htlc's in place.

We are calling now k.storeCancelHtlcsUpdate() directly which makes sense since with might have updated the HTLCs after cancelling the invoice

We now cancel all HTLCs of an AMP invoice as soon as it expires. Otherwise because we mark the invoice as cancelled we would not allow accepted HTLCs to be resolved via the invoiceEventLoop.

bhandras

LGTM, nice fix! 🥇

bhandras · 2025-01-31T13:49:24Z

channeldb/invoices.go

 		invoice, err := fetchInvoice(
-			invoiceNum, invoices, []*invpkg.SetID{&invSetID}, false,
+			invoiceNum, invoices, []*invpkg.SetID{setIDHint}, false,


Discussed this offline too. It's probably the best if we remove the HtlcSetBlankModifier altogether as it is not used anywhere.

Roasbeef

LGTM 🏆

ziggie1984 force-pushed the amp-htlc-invoices branch 2 times, most recently from bd6443b to bef999d Compare January 30, 2025 00:49

saubyk assigned ziggie1984 Jan 30, 2025

saubyk added this to the v0.18.5 milestone Jan 30, 2025

saubyk modified the milestones: v0.18.5, v0.19.0 Jan 30, 2025

guggero modified the milestones: v0.19.0, v0.18.5 Jan 30, 2025

guggero mentioned this pull request Jan 30, 2025

release: create branch for v0.18.5-beta.rc1 #9460

Merged

guggero reviewed Jan 30, 2025

View reviewed changes

channeldb/invoices.go Outdated Show resolved Hide resolved

docs/release-notes/release-notes-0.19.0.md Outdated Show resolved Hide resolved

ziggie1984 added bug fix amp invoices labels Jan 30, 2025

ziggie1984 force-pushed the amp-htlc-invoices branch from bef999d to 5bd4e66 Compare January 30, 2025 10:53

ziggie1984 marked this pull request as ready for review January 30, 2025 10:53

ziggie1984 force-pushed the amp-htlc-invoices branch 4 times, most recently from 03df39c to 72fc2e4 Compare January 30, 2025 11:19

bhandras self-requested a review January 30, 2025 11:57

ziggie1984 force-pushed the amp-htlc-invoices branch 2 times, most recently from 817bd45 to 5e120a0 Compare January 30, 2025 15:49

guggero reviewed Jan 30, 2025

View reviewed changes

ziggie1984 force-pushed the amp-htlc-invoices branch 2 times, most recently from 1f689a7 to 8acdba7 Compare January 30, 2025 22:14

bhandras reviewed Jan 31, 2025

View reviewed changes

ziggie1984 added 2 commits January 31, 2025 13:10

invoices+channeldb: Fix AMP invoices behaviour.

118261a

We now cancel all HTLCs of an AMP invoice as soon as it expires. Otherwise because we mark the invoice as cancelled we would not allow accepted HTLCs to be resolved via the invoiceEventLoop.

docs: add release-notes.

715cafa

ziggie1984 force-pushed the amp-htlc-invoices branch from 8acdba7 to 715cafa Compare January 31, 2025 12:10

ziggie1984 requested review from guggero, bhandras and Roasbeef January 31, 2025 12:10

bhandras approved these changes Jan 31, 2025

View reviewed changes

ziggie1984 mentioned this pull request Jan 31, 2025

[feature]: Expiry AMP invoice even though they have settled sub invoices. #9463

Open

guggero approved these changes Jan 31, 2025

View reviewed changes

Roasbeef approved these changes Jan 31, 2025

View reviewed changes

Roasbeef merged commit e403243 into lightningnetwork:master Jan 31, 2025
33 of 35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

invoices: amp invoices bugfix. #9459

invoices: amp invoices bugfix. #9459

ziggie1984 commented Jan 30, 2025 •

edited

Loading

coderabbitai bot commented Jan 30, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

yyforyongyu commented Jan 30, 2025

saubyk commented Jan 30, 2025

guggero commented Jan 30, 2025

ziggie1984 commented Jan 30, 2025

guggero left a comment

guggero Jan 30, 2025

ziggie1984 Jan 30, 2025

bhandras Jan 30, 2025

ziggie1984 Jan 31, 2025

ziggie1984 Jan 31, 2025

bhandras Jan 31, 2025

bhandras Jan 30, 2025

ziggie1984 Jan 31, 2025

bhandras left a comment

bhandras Jan 31, 2025

Roasbeef left a comment

	if invoice.IsAMP() {
	invoiceID := int64(invoice.AddIndex)
	ampState, ampHtlcs, err := fetchAmpState(
	ctx, db, invoiceID, setID, fetchAmpHtlcs,
	)
	if err != nil {
	return nil, nil, err
	}

	invoice.AMPState = ampState
	invoice.Htlcs = ampHtlcs

	return hash, invoice, nil
	}

invoices: amp invoices bugfix. #9459

invoices: amp invoices bugfix. #9459

Conversation

ziggie1984 commented Jan 30, 2025 • edited Loading

coderabbitai bot commented Jan 30, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

yyforyongyu commented Jan 30, 2025

saubyk commented Jan 30, 2025

guggero commented Jan 30, 2025

ziggie1984 commented Jan 30, 2025

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

bhandras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Roasbeef left a comment

Choose a reason for hiding this comment

ziggie1984 commented Jan 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)