BOLT 12 Offers message flow #2039

jkczyz · 2023-02-16T15:56:30Z

Define the BOLT 12 message flow in ChannelManager's OffersMessageHandler implementation.

An invoice_request message results in responding with an invoice message if it can be verified that the request is for a valid offer.
An invoice is paid if it can be verified to have originated from a sent invoice_request or a refund.
An invoice_error is sent in some failure cases.

Further, adds a utility for constructing a Bolt12Invoice for a Refund that can be used with ChannelManager.

Based on #2578

valentinewallace · 2023-03-18T02:44:11Z

Mind rebasing this? 🙏

jkczyz · 2023-03-20T14:44:57Z

Mind rebasing this? 🙏

Rebased and included recent changes from #1989.

lightning/src/onion_message/offers.rs

lightning/src/onion_message/blinded_path.rs

codecov-commenter · 2023-06-24T00:13:57Z

Codecov Report

Attention: 229 lines in your changes are missing coverage. Please review.

Comparison is base (62fd36d) 88.93% compared to head (fe90448) 88.76%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2039      +/-   ##
==========================================
- Coverage   88.93%   88.76%   -0.17%     
==========================================
  Files         112      112              
  Lines       87850    88258     +408     
  Branches    87850    88258     +408     
==========================================
+ Hits        78129    78346     +217     
- Misses       7473     7667     +194     
+ Partials     2248     2245       -3

Files	Coverage Δ
lightning/src/blinded_path/mod.rs	`70.14% <100.00%> (ø)`
lightning/src/blinded_path/payment.rs	`82.09% <ø> (ø)`
lightning/src/events/mod.rs	`33.11% <ø> (+0.78%)`	⬆️
lightning/src/ln/blinded_payment_tests.rs	`100.00% <100.00%> (ø)`
lightning/src/ln/functional_tests.rs	`97.31% <100.00%> (+0.08%)`	⬆️
lightning/src/ln/msgs.rs	`77.16% <ø> (ø)`
lightning/src/ln/onion_route_tests.rs	`97.56% <100.00%> (ø)`
lightning/src/ln/payment_tests.rs	`98.20% <100.00%> (+0.02%)`	⬆️
lightning/src/ln/peer_handler.rs	`58.54% <ø> (-0.06%)`	⬇️
lightning/src/ln/priv_short_conf_tests.rs	`97.46% <100.00%> (ø)`
... and 11 more

... and 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

TheBlueMatt

Needs rebase now 🎉.

Sadly, I think we should cfg-gate (or non-pub) the new pub methods here just in case at least one-hop blinded path receive doesn't manage to land.

lightning/src/ln/channelmanager.rs

jkczyz

Rebased

lightning/src/ln/channelmanager.rs

jkczyz · 2023-10-19T21:01:38Z

Oh, also had to trivially update DefaultMessageRouter, since it would always fail.

lightning/src/ln/channelmanager.rs

TheBlueMatt · 2023-10-20T14:47:25Z

Looks like this needs rebase now.

Upcoming commits will add utilities for sending an InvoiceRequest for an Offer and an Invoice for a Refund. These messages need to be enqueued so that they can be released in ChannelManager's implementation of OffersMessageHandler to OnionMessenger for sending. These messages do not need to be serialized as they must be resent upon restart.

Pending outbound payments use an absolute expiry to determine when they are considered stale and should be fail. In `no-std`, this may result in long timeouts as the highest seen block time is used. Instead, allow for expiration based on timer ticks. This will be use in an upcoming commit for invoice request expiration.

Add a utility to ChannelManager for sending an InvoiceRequest for an Offer such that derived keys are used for the payer id. This allows for stateless verification of any Invoice messages before it is paid. Also tracks future payments using the given PaymentId such that the corresponding Invoice is paid only once.

Add a utility to ChannelManager for creating a Bolt12Invoice for a Refund such that the ChannelManager can recognize the PaymentHash and reconstruct the PaymentPreimage from the PaymentSecret, the latter of which is contained in a BlindedPath within the invoice.

Building an invoice will fail if the underlying offer or refund has already expired. The check was skipped in no-std since there is no system clock. However, the invoice creation time can be used instead. This prevents responding to an invoice request if the offer has already expired.

Define the BOLT 12 message flow in ChannelManager's OffersMessageHandler implementation. - An invoice_request message results in responding with an invoice message if it can be verified that the request is for a valid offer. - An invoice is paid if it can be verified to have originated from a sent invoice_request or a refund. - An invoice_error is sent in some failure cases. - Initial messages enqueued for sending are released to OnionMessenger

This reverts commit c7219e4.

DefaultMessageRouter always fails. Update it so that it can route to a directly connected peer. This is needed for an Offers minimum viable product.

jkczyz · 2023-10-20T14:52:50Z

Rebased

TheBlueMatt

In a followup, I'd like to see the default max_total_routing_fee_msat in send_payment_for_bolt12_invoice not be None, but the default set in RouteParameters::from_payment_params_and_value. Users should have to opt out of a fee ceiling (by setting a max of infinite) rather than opt-in to one (by setting one), I think. We can also drop the allow(unused) on send_payment_for_bolt12_invoice.

A few other nits here but nothing worth fixing in this PR.

TheBlueMatt · 2023-10-20T15:25:35Z

lightning/src/ln/payment_tests.rs

+	let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
+	let route = get_route(
+		&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
+		nodes[0].logger, &scorer, &(), &random_seed_bytes


nit: Please leave the Default::default in place.

TheBlueMatt · 2023-10-20T15:42:00Z

lightning/src/offers/invoice_error.rs


+impl InvoiceError {
+	/// Creates an [`InvoiceError`] with the given message.
+	pub fn from_str(s: &str) -> Self {


Should just take the String - in one call we format!() create a String, then pass by reference here, and end up cloning it.

valentinewallace

FWIW, I have a basic functional test for the invreq flow passing 🎉

jkczyz mentioned this pull request Feb 16, 2023

Stateless BOLT 12 message verification #1989

Merged

jkczyz force-pushed the 2023-02-offer-flow branch 2 times, most recently from 07a2742 to 6ab6525 Compare February 23, 2023 17:07

jkczyz force-pushed the 2023-02-offer-flow branch 2 times, most recently from 840d4a5 to f167b0b Compare March 2, 2023 18:27

jkczyz force-pushed the 2023-02-offer-flow branch from f167b0b to 7f67ee5 Compare March 20, 2023 14:44

valentinewallace reviewed Mar 20, 2023

View reviewed changes

lightning/src/onion_message/offers.rs Outdated Show resolved Hide resolved

valentinewallace reviewed Mar 22, 2023

View reviewed changes

lightning/src/onion_message/blinded_path.rs Outdated Show resolved Hide resolved

jkczyz mentioned this pull request May 10, 2023

BOLT12 Offers Tracking Issue #1970

Open

60 tasks

jkczyz force-pushed the 2023-02-offer-flow branch from 7f67ee5 to ebc0436 Compare May 15, 2023 03:35

jkczyz mentioned this pull request May 15, 2023

BOLT 12 Offers message handling support #2294

Merged

jkczyz force-pushed the 2023-02-offer-flow branch from ebc0436 to 45181c9 Compare May 15, 2023 20:07

jkczyz force-pushed the 2023-02-offer-flow branch from 45181c9 to e3fec6e Compare June 23, 2023 21:45

jkczyz force-pushed the 2023-02-offer-flow branch from e3fec6e to f962dfb Compare July 28, 2023 21:06

jkczyz mentioned this pull request Jul 28, 2023

BOLT 12 Invoice payments #2371

Merged

jkczyz force-pushed the 2023-02-offer-flow branch from f962dfb to 05d2755 Compare August 2, 2023 00:41

valentinewallace mentioned this pull request Aug 11, 2023

Support signing BOLT 12 messages in NodeSigner #2432

Merged

jkczyz force-pushed the 2023-02-offer-flow branch 2 times, most recently from acb28b9 to 082f6e9 Compare August 23, 2023 22:24

jkczyz added this to the 0.0.117 milestone Aug 31, 2023

jkczyz force-pushed the 2023-02-offer-flow branch from 082f6e9 to 736fe4a Compare September 6, 2023 15:03

TheBlueMatt reviewed Sep 8, 2023

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

jkczyz force-pushed the 2023-02-offer-flow branch from 736fe4a to 37c2492 Compare September 11, 2023 03:53

jkczyz commented Sep 11, 2023

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

jkczyz force-pushed the 2023-02-offer-flow branch 2 times, most recently from 4aa8fa1 to 3395bce Compare September 14, 2023 22:30

jkczyz mentioned this pull request Sep 14, 2023

BOLT 12 Offers utilities #2578

Merged

valentinewallace reviewed Oct 19, 2023

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

jkczyz force-pushed the 2023-02-offer-flow branch 2 times, most recently from 9658805 to a06cea3 Compare October 20, 2023 01:33

jkczyz added 19 commits October 20, 2023 09:49

Expand docs on failing expired outbound payments

bc0203d

Qualify BOLT11 ChannelManager invoice_features

1d85efe

BOLT12 invoice_feature methods for ChannelManager

6f6e086

Grammar fix in docs

8954280

Use ChannelManager as OffersMessageHandler

0e41d80

Revert "Config-guard Event::InvoiceRequestFailed"

2840252

This reverts commit c7219e4.

Document InvoiceRequestFailed in ChannelManager

5a0b111

Organize create_refund and pay_for_offer docs

3fd9fc6

Add privacy section to pay_for_offer docs

681f898

Onion message routing to immediate peers.

a841e6b

DefaultMessageRouter always fails. Update it so that it can route to a directly connected peer. This is needed for an Offers minimum viable product.

Expand request_refund_payment docs for limitations

6d2ffdd

Fix build warnings

6a97f64

Fix PaymentConstraints::max_cltv_expiry docs

fe90448

jkczyz force-pushed the 2023-02-offer-flow branch from a06cea3 to fe90448 Compare October 20, 2023 14:52

TheBlueMatt approved these changes Oct 20, 2023

View reviewed changes

valentinewallace approved these changes Oct 20, 2023

View reviewed changes

TheBlueMatt merged commit 10b8f4c into lightningdevkit:main Oct 20, 2023

BOLT 12 Offers message flow #2039

BOLT 12 Offers message flow #2039

Uh oh!

Conversation

jkczyz commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

valentinewallace commented Mar 18, 2023

Uh oh!

jkczyz commented Mar 20, 2023

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jun 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jkczyz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jkczyz commented Oct 19, 2023

Uh oh!

Uh oh!

TheBlueMatt commented Oct 20, 2023

Uh oh!

jkczyz commented Oct 20, 2023

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

TheBlueMatt Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

TheBlueMatt Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

valentinewallace left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jkczyz commented Feb 16, 2023 •

edited

Loading

codecov-commenter commented Jun 24, 2023 •

edited

Loading