') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); Bolt12 Assessor and Fiat Currency Support for Offers by shaavan · Pull Request #3525 · lightningdevkit/rust-lightning · GitHub
Skip to content

Bolt12 Assessor and Fiat Currency Support for Offers - #3525

Closed
shaavan wants to merge 26 commits into
lightningdevkit:mainfrom
shaavan:currency
Closed

Bolt12 Assessor and Fiat Currency Support for Offers#3525
shaavan wants to merge 26 commits into
lightningdevkit:mainfrom
shaavan:currency

Conversation

@shaavan

@shaavanshaavan commented Jan 11, 2025

Copy link
Copy Markdown
Member

Builds on #3412

This PR introduces an Assessor for Bolt12Messages and adds the ability to support fiat currencies for offer amounts.

Bolt12Assessor

  1. The Bolt12Assessor trait provides the ability to process received offer messages and analyze them to determine whether they should be responded to.
  2. This trait allows users to implement their custom logic to decide whether to accept and respond appropriately to received offer messages (e.g., InvoiceRequest or Bolt12Invoice).

Currency Support

  1. Bolt12CurrencyAssessor enables users to implement support for their chosen currency by defining the correct conversion rate from fiat to millisatoshis.
  2. Once implemented, this functionality allows users to:
    • Scan and pay offers denominated in fiat.
    • Handle received InvoiceRequests for their own offers denominated in fiat.

@shaavan
Introduce message_received in Offer/OnionMessageHandler
4174d39
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.
@shaavan
Move message_received out of ChannelMessageHandler
c2f2e08
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
Remove async BOLT12 handling support
8961789
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`.
@shaavan
Introduce OffersMessageFlow
fc9060c
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.
@shaavan
Introduce OffersMessageCommons Trait and Implementation
8dfaacd
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.
@shaavan
f: Move initiate_async_payments to commons
8bca807
@shaavan
Refactor OffersMessageHandler Implementation to OffersMessageFlow
7abead8
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.
@shaavan
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.
@shaavan
Move create_offer_builder to OffersMessageFlow
14b1c17
@shaavan
Move create_refund_builder to OffersMessageFlow
344eb4c
@shaavan
Move pay_for_offer to OffersMessageFlow
6eabb74
@shaavan
Move request_refund_payment to OffersMessageFlow
6ab36b6
@shaavan
f: Remove spurious _persistence_guard check
80a59d6
- The _persistence_guard here was not serving any purpose, and hence can
be removed in this refactoring.
@shaavan
Move pay_for_offer_human_readable to OffersMessageFlow
d59e522
@shaavan
Move DNSResolverMessageHandler impl to OffersMessageFlow
53a7713
@shaavan
Move create_blinded_path_using_absolute_expiry to flow.rs
b01b656
@shaavan
Introduce create_blinded_paths in flow.rs
309e72c
1. This allow removing an extra function from commons, simplifying the
flow trait.
@shaavan
Move pending_offers_message to flows.rs
d6ee2da
@shaavan
Move pending_dns_onion_messages to flow.rs
bfab3f9
@shaavan
Move verify_bolt12_invoice to flow.rs
10b25f4
@shaavan
Introduce Bolt12ResponseError
54d39eb
Introduce a new category of Bolt12 errors that contains the error
generated while trying to generate response to Bolt12 messages.
@shaavan
Introduce currency struct
530b77a
@shaavan
Introduce Bolt12Assessor & Bolt12CurrencyAssessor
a853920
The new trait allow taking the invoice_request, and access it.
For now this allows accessing, that it contains the correct amount or if
not then getting the right amount from the offer.
@shaavan
Introduce DefaultBolt12Assessor
2a07530
This implements the default behavior for Bolt12Assessor &
Bolt12CurrencyAssessor
@shaavan
Introduce calculate_offer_amount
4dde160
@shaavan
Introduce Bolt12Assessor as parameter for OffersMessageFlow
1d74782
Parametised OffersMessageFlow over Bolt12Assessor &
Bolt12CurrencyAssessor trait
@shaavanshaavan mentioned this pull request Jan 11, 2025
Closed
@shaavanshaavan mentioned this pull request Jan 25, 2025
Closed
@jkczyzjkczyz mentioned this pull request Feb 25, 2025
Closed
2 tasks
@shaavan
shaavan marked this pull request as draft April 4, 2025 12:37
@shaavanshaavan closed this May 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shaavan