Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', '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('^' + ".*" + ' [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, '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" + ' [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, '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('^' + ".*" + ' [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, '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); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); [RFC] events: add `InvoiceSent` event for BOLT12 payee by vincenzopalazzo · Pull Request #3853 · lightningdevkit/rust-lightning · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -968,6 +968,32 @@ pub enum Event {
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
responder: Option<Responder>,
},
/// Indicates a [`Bolt12Invoice`] was created and sent in response to an [`InvoiceRequest`] or
/// a [`Refund`].
///
/// This event will only be generated if [`UserConfig::notify_bolt12_invoice_sent`] is set.
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created.
///
/// # Failure Behavior and Persistence
/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`Refund`]: crate::offers::refund::Refund
/// [`UserConfig::notify_bolt12_invoice_sent`]: crate::util::config::UserConfig::notify_bolt12_invoice_sent
InvoiceSent {
/// The invoice that was created and sent.
invoice: Bolt12Invoice,
/// The context of the [`BlindedMessagePath`] used to receive the original request.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
context: Option<OffersContext>,
/// The payment hash for the invoice.
payment_hash: PaymentHash,
/// The payment secret for the invoice.
payment_secret: PaymentSecret,
},
/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
/// and we got back the payment preimage for it).
///
Expand DownExpand Up@@ -1980,6 +2006,15 @@ impl Writeable for Event {
(6, responder, option),
});
},
&Event::InvoiceSent { ref invoice, ref context, ref payment_hash, ref payment_secret } => {
42u8.write(writer)?;
write_tlv_fields!(writer, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
},
&Event::FundingTxBroadcastSafe {
ref channel_id,
ref user_channel_id,
Expand DownExpand Up@@ -2539,6 +2574,23 @@ impl MaybeReadable for Event {
};
f()
},
42u8 => {
let mut f = || {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, invoice, required),
(2, context, option),
(4, payment_hash, required),
(6, payment_secret, required),
});
Ok(Some(Event::InvoiceSent {
invoice: invoice.0.unwrap(),
context,
payment_hash: payment_hash.0.unwrap(),
payment_secret: payment_secret.0.unwrap(),
}))
};
f()
},
43u8 => {
let mut channel_id = RequiredWrapper(None);
let mut user_channel_id = RequiredWrapper(None);
Expand Down
21 changes: 17 additions & 4 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -12864,7 +12864,7 @@ where
None => return None,
};

let invoice_request = match self.flow.verify_invoice_request(invoice_request, context) {
let invoice_request = match self.flow.verify_invoice_request(invoice_request, context.clone()) {
Ok(invoice_request) => invoice_request,
Err(_) => return None,
};
Expand All@@ -12888,13 +12888,26 @@ where
};

let entropy = &*self.entropy_source;
let (response, context) = self.flow.create_response_for_invoice_request(
let (response, response_context) = self.flow.create_response_for_invoice_request(
&self.node_signer, &self.router, entropy, invoice_request, amount_msats,
payment_hash, payment_secret, self.list_usable_channels()
);

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
// Generate InvoiceSent event if configured to do so
if self.default_configuration.notify_bolt12_invoice_sent {
if let OffersMessage::Invoice(ref invoice) = response {
let event = Event::InvoiceSent {
invoice: invoice.clone(),
context: context.clone(),
payment_hash,
payment_secret,
};
self.pending_events.lock().unwrap().push_back((event, None));
}
}

match response_context {
Some(resp_context) => Some((response, responder.respond_with_reply_path(resp_context))),
None => Some((response, responder.respond()))
}
},
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/offers_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1186,7 +1186,7 @@ fn pays_bolt12_invoice_asynchronously() {
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

// Re-process the same onion message to ensure idempotency —
// Re-process the same onion message to ensure idempotency —
// we should not generate a duplicate `InvoiceReceived` event.
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);

Expand Down
17 changes: 17 additions & 0 deletions lightning/src/util/config.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -919,6 +919,21 @@ pub struct UserConfig {
/// [`ChannelManager::send_payment_for_bolt12_invoice`]: crate::ln::channelmanager::ChannelManager::send_payment_for_bolt12_invoice
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
pub manually_handle_bolt12_invoices: bool,
/// If this is set to `true`, the user will receive [`Event::InvoiceSent`] events when a
/// BOLT12 invoice is created and sent to a payer.
///
/// This provides symmetrical functionality to [`Event::InvoiceReceived`] but for the payee side,
/// allowing nodes to track and access invoices they have created. This can be useful for
/// accounting, proof of invoice creation, or debugging purposes.
///
/// When set to `true`, [`Event::InvoiceSent`] will be generated whenever a BOLT12 invoice
/// is successfully created and sent in response to an invoice request.
///
/// Default value: `false`
///
/// [`Event::InvoiceSent`]: crate::events::Event::InvoiceSent
/// [`Event::InvoiceReceived`]: crate::events::Event::InvoiceReceived
pub notify_bolt12_invoice_sent: bool,
/// If this is set to `true`, dual-funded channels will be enabled.
///
/// Default value: `false`
Expand All@@ -936,6 +951,7 @@ impl Default for UserConfig {
manually_accept_inbound_channels: false,
accept_intercept_htlcs: false,
manually_handle_bolt12_invoices: false,
notify_bolt12_invoice_sent: false,
enable_dual_funded_channels: false,
}
}
Expand All@@ -956,6 +972,7 @@ impl Readable for UserConfig {
manually_accept_inbound_channels: Readable::read(reader)?,
accept_intercept_htlcs: Readable::read(reader)?,
manually_handle_bolt12_invoices: Readable::read(reader)?,
notify_bolt12_invoice_sent: Readable::read(reader)?,
enable_dual_funded_channels: Readable::read(reader)?,
})
}
Expand Down