Introduce OffersMessageFlow #3412

shaavan · 2024-11-18T18:26:44Z

This PR introduces a new data structure to separate the functions and fields related to Offers Message from ChannelManager.

The change ensures a clear separation of responsibilities for BOLT12 messages, improving modularity and maintainability.

TODO:

Refine commit messages
Add detailed documentation

shaavan · 2024-11-19T14:18:02Z

Updated from pr3412.01 to pr3412.02 (diff):

Changes:

Fix ci
Update commit messages

jkczyz

FYI, I reviewed this offline with @shaavan. So there will be some changes to the OffersMessageFlow trait parameterization to keep ChannelManager specifics from leaking.

jkczyz · 2024-11-19T17:04:44Z

lightning/src/ln/channelmanager.rs

-			return Err(Bolt12SemanticError::UnsupportedChain);
-		}
-
-		let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);


@TheBlueMatt Do you know why we need the PersistenceNotifierGuard here? This code sends an invoice for a refund (i.e., an inbound payment). IIUC, we don't persist pending_offers_messages, so it seems we don't need it.

shaavan · 2024-11-29T12:41:32Z

Updated from pr3412.02 to pr3412.03 (diff):

Addressed @jkczyz comments:

Changes:

Update & Expand Documentation.
Move dnssec code in flow.rs
Simplified OffersMessageFlow trait parametrisation.
Move OffersMessageFlow only function from offersmessagecommons to flow.rs

shaavan · 2024-11-30T16:02:02Z

Updated from pr3412.03 to pr3412.04 (diff):

Changes:

Rebase on main.
Fix CI.

shaavan · 2024-12-06T12:49:59Z

Updated from pr3412.04 to pr3412.05 (diff):

Addressed @jkczyz's (offline) comments.

Changes:

Moved the OffersMessageCommons trait definition to flow.rs, as it is a more logical location for its definition.
Temporarily removed async Bolt12 message support, with the reasoning documented in the corresponding commit message.
Introduced network_pubkey and extended_key fields in OffersMessageFlow to streamline the overall refactoring by reducing code movement.

shaavan · 2024-12-06T16:01:03Z

Updated from pr3412.05 to pr3412.06 (diff):

Changes:

Rebase on main to resolve merge conflicts
Fix CI

codecov · 2024-12-06T16:09:33Z

Codecov Report

Attention: Patch coverage is 88.71795% with 88 lines in your changes missing coverage. Please review.

Project coverage is 89.78%. Comparing base (641e40f) to head (189b2aa).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/offers/flow.rs	86.03%	66 Missing and 15 partials ⚠️
lightning/src/ln/channelmanager.rs	96.66%	3 Missing ⚠️
lightning/src/ln/offers_tests.rs	96.66%	3 Missing ⚠️
lightning/src/onion_message/offers.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3412      +/-   ##
==========================================
+ Coverage   89.72%   89.78%   +0.05%     
==========================================
  Files         130      131       +1     
  Lines      107614   108190     +576     
  Branches   107614   108190     +576     
==========================================
+ Hits        96559    97137     +578     
+ Misses       8660     8659       -1     
+ Partials     2395     2394       -1

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

lightning/src/offers/flow.rs

shaavan · 2024-12-11T13:24:33Z

Updated from pr3412.06 to pr3412.07 (diff):
Addressed @TheBlueMatt comment

Changes:

Corrected code for cfg[(async_payments)]
Remove stale todo. reference
Fix CI

shaavan · 2024-12-12T06:15:56Z

Updated from pr3412.07 to pr3412.08 (diff):

Changes:

Rebase on main, to resolve merge conflicts.

shaavan · 2024-12-12T16:56:16Z

Updated from pr3412.08 to pr3412.09 (diff):

Changes:

Introduce create_blinded_paths in flow.rs
This allows removing additional function from OffersMessageCommons trait, and hence simplifying it.

To decouple offers and onion message-related code from `ChannelManager`, this commit introduces the `message_received` function in `Offer/OnionMessageHandler`. Currently, the function focuses on handling the retry logic for `InvoiceRequest` messages. Moving this responsibility ensures a cleaner separation of concerns and sets the foundation for managing offers/onion messages directly within the appropriate handler.

Since `ChannelMessageHandler`'s `message_received` function was solely used for handling invoice request retries. This function has been removed from `ChannelMessageHandler`, and the relevant code has been migrated to `OffersMessageHandler`'s `message_received`. This ensures invoice request retries are now handled in the appropriate context.

shaavan · 2024-12-16T14:29:35Z

Updated from pr3412.09 to pr3412.10 (diff):

Changes:

Rebase on main to resolve merge conflicts.

This commit temporarily removes support for async BOLT12 message handling to enable a smoother transition in the upcoming refactor. The current implementation of async handling is abrupt, as it requires delving into the synchronous case and generating an event mid-flow based on the `manual_handling` flag. This approach adds unnecessary complexity and coupling. A later commit will introduce a new struct, `OffersMessageFlow`, designed to handle and create offer messages. This new struct will support async handling in a more structured way by allowing users to implement a parameterized trait for asynchronous message handling. Removing the existing async support now ensures a cleaner and more seamless migration of offer-related code from `ChannelManager` to `OffersMessageFlow`.

This commit introduces a new struct, `OffersMessageFlow`, to extract all offers message-related code out of `ChannelManager`. By moving this logic into a dedicated struct, it creates a foundation for separating responsibilities and sets up a base for further code restructuring in subsequent commits.

A new trait, `OffersMessageCommons`, is introduced to encapsulate functions that are commonly used by both BOLT12-related functionality and other parts of `ChannelManager`. This enables a clean transition of BOLT12 code to `OffersMessageFlow` by moving shared functions into the new trait, ensuring they remain accessible to both `ChannelManager` and the refactored BOLT12 code.

This commit introduces the `OffersMessageHandler` implementation for `OffersMessageFlow`, enabling direct access to offer-specific functionality through `OffersMessageFlow`. With `OffersMessageFlow` now serving as the source of `OffersMessageHandler` implementation, the implementation in `ChannelManager` is no longer needed and has been safely removed.

- This commit introduces a new struct, `AnOffersMessageFlow`, which generically implements `OffersMessageFlow`. - In subsequent commits, this struct will be utilized for documentation purposes.

- The _persistence_guard here was not serving any purpose, and hence can be removed in this refactoring.

1. This allow removing an extra function from commons, simplifying the flow trait.

shaavan · 2024-12-17T14:23:18Z

Updated from pr3412.10 to pr3412.11 (diff):

Changes:

Remove redundant send_payment_for_bolt12_invoice function.
Revert mistakenly added accept_mpp_keysend

shaavan force-pushed the offersmessageflow branch from 0972b33 to e038951 Compare November 19, 2024 14:17

jkczyz self-requested a review November 19, 2024 15:36

jkczyz reviewed Nov 19, 2024

View reviewed changes

shaavan force-pushed the offersmessageflow branch from e038951 to e1c3863 Compare November 29, 2024 12:41

shaavan force-pushed the offersmessageflow branch from e1c3863 to d5c244a Compare November 30, 2024 16:01

shaavan force-pushed the offersmessageflow branch from d5c244a to c07e7f6 Compare December 6, 2024 12:49

shaavan force-pushed the offersmessageflow branch 2 times, most recently from 4911f9f to 9d0c511 Compare December 6, 2024 16:00

shaavan commented Dec 9, 2024

View reviewed changes

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

shaavan force-pushed the offersmessageflow branch from 9d0c511 to b3c54ee Compare December 11, 2024 13:24

shaavan force-pushed the offersmessageflow branch from b3c54ee to 3ba8ba5 Compare December 12, 2024 06:15

shaavan force-pushed the offersmessageflow branch from 3ba8ba5 to 189b2aa Compare December 12, 2024 16:56

shaavan mentioned this pull request Dec 13, 2024

Enable Creation of Offers and Refunds Without Blinded Path #3246

Open

shaavan added 2 commits December 16, 2024 19:03

shaavan force-pushed the offersmessageflow branch from 189b2aa to 4818efe Compare December 16, 2024 14:29

shaavan added 4 commits December 17, 2024 19:33

f: Move initiate_async_payments to commons

8bca807

shaavan added 14 commits December 17, 2024 19:44

Introduce AnOffersMessageFlow

4f277a9

- This commit introduces a new struct, `AnOffersMessageFlow`, which generically implements `OffersMessageFlow`. - In subsequent commits, this struct will be utilized for documentation purposes.

Move create_offer_builder to OffersMessageFlow

14b1c17

Move create_refund_builder to OffersMessageFlow

344eb4c

Move pay_for_offer to OffersMessageFlow

6eabb74

Move request_refund_payment to OffersMessageFlow

6ab36b6

f: Remove spurious _persistence_guard check

80a59d6

- The _persistence_guard here was not serving any purpose, and hence can be removed in this refactoring.

Move pay_for_offer_human_readable to OffersMessageFlow

d59e522

Move DNSResolverMessageHandler impl to OffersMessageFlow

53a7713

Move create_blinded_path_using_absolute_expiry to flow.rs

b01b656

Introduce create_blinded_paths in flow.rs

309e72c

1. This allow removing an extra function from commons, simplifying the flow trait.

Move pending_offers_message to flows.rs

d6ee2da

Move pending_dns_onion_messages to flow.rs

bfab3f9

Move verify_bolt12_invoice to flow.rs

10b25f4

shaavan force-pushed the offersmessageflow branch from 4818efe to 10b25f4 Compare December 17, 2024 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce OffersMessageFlow #3412

Introduce OffersMessageFlow #3412

shaavan commented Nov 18, 2024 •

edited

Loading

shaavan commented Nov 19, 2024

jkczyz left a comment

jkczyz Nov 19, 2024

shaavan commented Nov 29, 2024 •

edited

Loading

shaavan commented Nov 30, 2024

shaavan commented Dec 6, 2024

shaavan commented Dec 6, 2024

codecov bot commented Dec 6, 2024 •

edited

Loading

shaavan commented Dec 11, 2024

shaavan commented Dec 12, 2024

shaavan commented Dec 12, 2024

shaavan commented Dec 16, 2024

shaavan commented Dec 17, 2024

Introduce OffersMessageFlow #3412

Are you sure you want to change the base?

Introduce OffersMessageFlow #3412

Conversation

shaavan commented Nov 18, 2024 • edited Loading

TODO:

shaavan commented Nov 19, 2024

jkczyz left a comment

Choose a reason for hiding this comment

jkczyz Nov 19, 2024

Choose a reason for hiding this comment

shaavan commented Nov 29, 2024 • edited Loading

shaavan commented Nov 30, 2024

shaavan commented Dec 6, 2024

Changes:

shaavan commented Dec 6, 2024

codecov bot commented Dec 6, 2024 • edited Loading

Codecov Report

shaavan commented Dec 11, 2024

shaavan commented Dec 12, 2024

shaavan commented Dec 12, 2024

shaavan commented Dec 16, 2024

shaavan commented Dec 17, 2024

shaavan commented Nov 18, 2024 •

edited

Loading

shaavan commented Nov 29, 2024 •

edited

Loading

codecov bot commented Dec 6, 2024 •

edited

Loading