Skip to content

Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkczyz merged 5 commits into from
Oct 14, 2025
Merged

Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow #3964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2a5f168
Refactor: Convert fields function to macro
shaavan Jul 25, 2025
eeb5d24
Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>
shaavan Jul 25, 2025
6851001
Introduce specific InvoiceBuilders in OffersMessageFlow
shaavan Jul 26, 2025
d2dd871
Refactor: Introduce `get_payment_info` closure for invoice creation
shaavan Jul 26, 2025
6e197de
rustfmt: Remove skip from request_refund_payment
shaavan Aug 23, 2025
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
137 changes: 90 additions & 47 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
};
let payment_purpose_context =
PaymentContext::Bolt12Offer(Bolt12OfferContext {
offer_id: verified_invreq.offer_id,
offer_id: verified_invreq.offer_id(),
invoice_request: verified_invreq.fields(),
});
let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
///
/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
#[rustfmt::skip]
pub fn request_refund_payment(
&self, refund: &Refund
&self, refund: &Refund,
) -> Result<Bolt12Invoice, Bolt12SemanticError> {
let secp_ctx = &self.secp_ctx;

let amount_msats = refund.amount_msats();
let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
let entropy = &*self.entropy_source;

let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
Ok((payment_hash, payment_secret)) => {
let entropy = &*self.entropy_source;
let builder = self.flow.create_invoice_builder_from_refund(
&self.router, entropy, refund, payment_hash,
payment_secret, self.list_usable_channels()
)?;

let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
let builder = self.flow.create_invoice_builder_from_refund(
&self.router,
entropy,
refund,
self.list_usable_channels(),
|amount_msats, relative_expiry| {
self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
.map_err(|()| Bolt12SemanticError::InvalidAmount)
},
)?;

self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

Ok(invoice)
},
Err(()) => Err(Bolt12SemanticError::InvalidAmount),
}
self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
Ok(invoice)
}

/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
Err(_) => return None,
};

let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
&invoice_request.inner
) {
Ok(amount_msats) => amount_msats,
Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
let get_payment_info = |amount_msats, relative_expiry| {
self.create_inbound_payment(
Some(amount_msats),
relative_expiry,
None
).map_err(|_| Bolt12SemanticError::InvalidAmount)
};

let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
let (payment_hash, payment_secret) = match self.create_inbound_payment(
Some(amount_msats), relative_expiry, None
) {
Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
Err(()) => {
let error = Bolt12SemanticError::InvalidAmount;
return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
let (result, context) = match invoice_request {
InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
&self.router,
&*self.entropy_source,
&request,
self.list_usable_channels(),
get_payment_info,
);

match result {
Ok((builder, context)) => {
let res = builder
.build_and_sign(&self.secp_ctx)
.map_err(InvoiceError::from);

(res, context)
},
Err(error) => {
return Some((
OffersMessage::InvoiceError(InvoiceError::from(error)),
responder.respond(),
));
},
}
},
};
InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
&self.router,
&*self.entropy_source,
&request,
self.list_usable_channels(),
get_payment_info,
);

let entropy = &*self.entropy_source;
let (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 result {
Ok((builder, context)) => {
let res = builder
.build()
.map_err(InvoiceError::from)
.and_then(|invoice| {
#[cfg(c_bindings)]
let mut invoice = invoice;
invoice
.sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
.map_err(InvoiceError::from)
});
(res, context)
},
Err(error) => {
return Some((
OffersMessage::InvoiceError(InvoiceError::from(error)),
responder.respond(),
));
},
}
}
};

match context {
Some(context) => Some((response, responder.respond_with_reply_path(context))),
None => Some((response, responder.respond()))
}
Some(match result {
Ok(invoice) => (
OffersMessage::Invoice(invoice),
responder.respond_with_reply_path(context),
),
Err(error) => (
OffersMessage::InvoiceError(error),
responder.respond(),
),
})
},
OffersMessage::Invoice(invoice) => {
let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down
20 changes: 14 additions & 6 deletions lightning/src/ln/offers_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
let secp_ctx = Secp256k1::new();

let created_at = alice.node.duration_since_epoch();
let invoice = invoice_request
.verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
.features_unchecked(Bolt12InvoiceFeatures::unknown())
.build_and_sign(&secp_ctx).unwrap();
let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.
.verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

let invoice = match verified_invoice_request {
InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
.features_unchecked(Bolt12InvoiceFeatures::unknown())
.build_and_sign(&secp_ctx).unwrap()
},
InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
panic!("Expected invoice request with keys");
},
};

// Enqueue an onion message containing the new invoice.
let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading
, '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" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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('^' + ".*" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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('^' + ".*" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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('^' + ".*" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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('^' + ".*" + '
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading

, '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); }
})();
})();
Introduce Stronger Typing for `VerifiedInvoiceRequest` and Refactor Invoice Building Flow by shaavan · Pull Request #3964 · lightningdevkit/rust-lightning · GitHub
Skip to content
Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow#3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jkczyz
merged 5 commits into

from

Oct 14, 2025
 Merged


Introduce Stronger Typing for VerifiedInvoiceRequest and Refactor Invoice Building Flow
#3964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2a5f168

Refactor: Convert fields function to macro


shaavan Jul 25, 2025
eeb5d24

Introduce VerifiedInvoiceRequest<S: SigningPubkeyStrategy>


shaavan Jul 25, 2025
6851001

Introduce specific InvoiceBuilders in OffersMessageFlow


shaavan Jul 26, 2025
d2dd871

Refactor: Introduce `get_payment_info` closure for invoice creation


shaavan Jul 26, 2025
6e197de

rustfmt: Remove skip from request_refund_payment


shaavan Aug 23, 2025

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


137 changes: 90 additions & 47 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,11 +92,9 @@ use crate::ln::outbound_payment::{
use crate::ln::types::ChannelId;
use crate::offers::async_receive_offer_cache::AsyncReceiveOfferCache;
use crate::offers::flow::{HeldHtlcReplyPath, InvreqResponseInstructions, OffersMessageFlow};
use crate::offers::invoice::{
	Bolt12Invoice, DerivedSigningPubkey, InvoiceBuilder, DEFAULT_RELATIVE_EXPIRY,
};
use crate::offers::invoice::{Bolt12Invoice, UnsignedBolt12Invoice};
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::InvoiceRequest;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::offer::{Offer, OfferFromHrn};
use crate::offers::parse::Bolt12SemanticError;
Expand DownExpand Up@@ -7735,7 +7733,7 @@ where
 };
 let payment_purpose_context =
 PaymentContext::Bolt12Offer(Bolt12OfferContext {
 offer_id: verified_invreq.offer_id,
 offer_id: verified_invreq.offer_id(),
 invoice_request: verified_invreq.fields(),
 });
 let from_parts_res = events::PaymentPurpose::from_parts(
Expand DownExpand Up@@ -12730,33 +12728,29 @@ where
	///
	/// [`BlindedPaymentPath`]: crate::blinded_path::payment::BlindedPaymentPath
	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
	#[rustfmt::skip]
	pub fn request_refund_payment(
 &self, refund: &Refund
 &self, refund: &Refund,
	) -> Result<Bolt12Invoice, Bolt12SemanticError> {
 let secp_ctx = &self.secp_ctx;

 let amount_msats = refund.amount_msats();
 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let entropy = &*self.entropy_source;

 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);

 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
 Ok((payment_hash, payment_secret)) => {
 let entropy = &*self.entropy_source;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router, entropy, refund, payment_hash,
 payment_secret, self.list_usable_channels()
 )?;

 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
 let builder = self.flow.create_invoice_builder_from_refund(
 &self.router,
 entropy,
 refund,
 self.list_usable_channels(),
 |amount_msats, relative_expiry| {
 self.create_inbound_payment(Some(amount_msats), relative_expiry, None)
 .map_err(|()| Bolt12SemanticError::InvalidAmount)
 },
 )?;

 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;

 Ok(invoice)
 },
 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
 }
 self.flow.enqueue_invoice(invoice.clone(), refund, self.get_peers_for_blinded_path())?;
 Ok(invoice)
	}

	/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
Expand DownExpand Up@@ -14875,34 +14869,83 @@ where
 Err(_) => return None,
 };

 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
 &invoice_request.inner
 ) {
 Ok(amount_msats) => amount_msats,
 Err(error) => return Some((OffersMessage::InvoiceError(error.into()), responder.respond())),
 let get_payment_info = |amount_msats, relative_expiry| {
 self.create_inbound_payment(
 Some(amount_msats),
 relative_expiry,
 None
 ).map_err(|_| Bolt12SemanticError::InvalidAmount)
 };

 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
 let (payment_hash, payment_secret) = match self.create_inbound_payment(
 Some(amount_msats), relative_expiry, None
 ) {
 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
 Err(()) => {
 let error = Bolt12SemanticError::InvalidAmount;
 return Some((OffersMessage::InvoiceError(error.into()), responder.respond()));
 let (result, context) = match invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_with_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 match result {
 Ok((builder, context)) => {
 let res = builder
 .build_and_sign(&self.secp_ctx)
 .map_err(InvoiceError::from);

 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 },
 };
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(request) => {
 let result = self.flow.create_invoice_builder_from_invoice_request_without_keys(
 &self.router,
 &*self.entropy_source,
 &request,
 self.list_usable_channels(),
 get_payment_info,
 );

 let entropy = &*self.entropy_source;
 let (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 result {
 Ok((builder, context)) => {
 let res = builder
 .build()
 .map_err(InvoiceError::from)
 .and_then(|invoice| {
 #[cfg(c_bindings)]
 let mut invoice = invoice;
 invoice
 .sign(|invoice: &UnsignedBolt12Invoice| self.node_signer.sign_bolt12_invoice(invoice))
 .map_err(InvoiceError::from)
 });
 (res, context)
 },
 Err(error) => {
 return Some((
 OffersMessage::InvoiceError(InvoiceError::from(error)),
 responder.respond(),
 ));
 },
 }
 }
 };

 match context {
 Some(context) => Some((response, responder.respond_with_reply_path(context))),
 None => Some((response, responder.respond()))
 }
 Some(match result {
 Ok(invoice) => (
 OffersMessage::Invoice(invoice),
 responder.respond_with_reply_path(context),
 ),
 Err(error) => (
 OffersMessage::InvoiceError(error),
 responder.respond(),
 ),
 })
 },
 OffersMessage::Invoice(invoice) => {
 let payment_id = match self.flow.verify_bolt12_invoice(&invoice, context.as_ref()) {
Expand Down

20 changes: 14 additions & 6 deletions
lightning/src/ln/offers_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnou
use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
use crate::offers::invoice::Bolt12Invoice;
use crate::offers::invoice_error::InvoiceError;
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestVerifiedFromOffer};
use crate::offers::nonce::Nonce;
use crate::offers::parse::Bolt12SemanticError;
use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageSendInstructions, NodeIdMessageRouter, NullMessageRouter, PeeledOnion, PADDED_PATH_LENGTH};
Expand DownExpand Up@@ -2326,11 +2326,19 @@ fn fails_paying_invoice_with_unknown_required_features() {
	let secp_ctx = Secp256k1::new();

	let created_at = alice.node.duration_since_epoch();
	let invoice = invoice_request
 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap()
 .respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap();
	let verified_invoice_request = invoice_request
Comment thread
shaavan marked this conversation as resolved.

 .verify_using_recipient_data(nonce, &expanded_key, &secp_ctx).unwrap();

	let invoice = match verified_invoice_request {
 InvoiceRequestVerifiedFromOffer::DerivedKeys(request) => {
 request.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at).unwrap()
 .features_unchecked(Bolt12InvoiceFeatures::unknown())
 .build_and_sign(&secp_ctx).unwrap()
 },
 InvoiceRequestVerifiedFromOffer::ExplicitKeys(_) => {
 panic!("Expected invoice request with keys");
 },
	};

	// Enqueue an onion message containing the new invoice.
	let instructions = MessageSendInstructions::WithoutReplyPath {
Expand Down
Loading
Loading