Skip to content

Add custom TLV support across Bolt11 and Bolt12 payer flows #4263

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

Open
shaavan wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add custom TLV support across Bolt11 and Bolt12 payer flows #4263

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
2ea54b8
Introduce custom TLVs in `pay_for_bolt11_invoice`
shaavan Dec 5, 2025
ce467a4
Expand test to cover Bolt11 custom TLVs
shaavan Dec 6, 2025
7ce7d5e
Add custom TLV support to `PendingOutboundPayment` for Bolt12 flows
shaavan Dec 4, 2025
5c505d4
Introduce `custom_tlvs` field in payer-facing functions
shaavan Dec 5, 2025
ef6edec
Introduce Bolt12 custom TLVs test
shaavan Dec 6, 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
4 changes: 4 additions & 0 deletions lightning-liquidity/tests/lsps2_integration_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1221,6 +1221,7 @@ fn client_trusts_lsp_end_to_end_test() {
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
None,
vec![],
Default::default(),
Retry::Attempts(3),
)
Expand Down Expand Up @@ -1694,6 +1695,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
None,
vec![],
Default::default(),
Retry::Attempts(3),
)
Expand Down Expand Up @@ -1885,6 +1887,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
None,
vec![],
Default::default(),
Retry::Attempts(3),
)
Expand Down Expand Up @@ -2222,6 +2225,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
None,
vec![],
Default::default(),
Retry::Attempts(3),
)
Expand Down
82 changes: 65 additions & 17 deletions lightning/src/ln/async_payments_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,10 @@ fn build_async_offer_and_init_payment(

let offer = recipient.node.get_async_receive_offer().unwrap();
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

// Forward invreq to server, pass static invoice back
let (peer_id, invreq_om) = extract_invoice_request_om(sender, &[sender_lsp, invoice_server]);
Expand Down Expand Up @@ -705,7 +708,10 @@ fn static_invoice_unknown_required_features() {
// unknown required features.
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

// Don't forward the invreq since the invoice was created outside of the normal flow, instead
// manually construct the response.
Expand Down Expand Up @@ -777,7 +783,10 @@ fn ignore_unexpected_static_invoice() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let invreq_om = nodes[0]
.onion_messenger
Expand Down Expand Up @@ -906,7 +915,10 @@ fn ignore_duplicate_invoice() {
let offer = async_recipient.node.get_async_receive_offer().unwrap();
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let sender_node_id = sender.node.get_our_node_id();
let always_online_node_id = always_online_node.node.get_our_node_id();
Expand Down Expand Up @@ -1004,7 +1016,10 @@ fn ignore_duplicate_invoice() {

// Now handle case where the sender pays regular invoice and ignores static invoice.
let payment_id = PaymentId([2; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let invreq_om =
sender.onion_messenger.next_onion_message_for_peer(always_online_node_id).unwrap();
Expand Down Expand Up @@ -1110,7 +1125,10 @@ fn async_receive_flow_success() {
let offer = nodes[2].node.get_async_receive_offer().unwrap();
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();
let release_held_htlc_om = pass_async_payments_oms(
static_invoice.clone(),
&nodes[0],
Expand Down Expand Up @@ -1170,7 +1188,10 @@ fn expired_static_invoice_fail() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let invreq_om = nodes[0]
.onion_messenger
Expand Down Expand Up @@ -1253,7 +1274,10 @@ fn timeout_unreleased_payment() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let invreq_om =
sender.onion_messenger.next_onion_message_for_peer(server.node.get_our_node_id()).unwrap();
Expand Down Expand Up @@ -1347,7 +1371,10 @@ fn async_receive_mpp() {

let amt_msat = 15_000_000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();
let release_held_htlc_om_3_0 = pass_async_payments_oms(
static_invoice,
&nodes[0],
Expand Down Expand Up @@ -1445,7 +1472,10 @@ fn amount_doesnt_match_invreq() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();
let release_held_htlc_om_3_0 = pass_async_payments_oms(
static_invoice,
&nodes[0],
Expand Down Expand Up @@ -1688,7 +1718,10 @@ fn invalid_async_receive_with_retry<F1, F2>(
let static_invoice = invoice_flow_res.invoice;
let offer = nodes[2].node.get_async_receive_offer().unwrap();

nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();
let release_held_htlc_om_2_0 = pass_async_payments_oms(
static_invoice,
&nodes[0],
Expand Down Expand Up @@ -1782,7 +1815,10 @@ fn expired_static_invoice_message_path() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
nodes[0]
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

// While the invoice is unexpired, respond with release_held_htlc.
let (held_htlc_available_om, _release_held_htlc_om) = pass_async_payments_oms(
Expand Down Expand Up @@ -1897,7 +1933,7 @@ fn expired_static_invoice_payment_path() {
let payment_id = PaymentId([1; 32]);
let mut params: OptionalOfferPaymentParams = Default::default();
params.retry_strategy = Retry::Attempts(0);
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, params).unwrap();
nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], params).unwrap();
let release_held_htlc_om = pass_async_payments_oms(
static_invoice,
&nodes[0],
Expand Down Expand Up @@ -2341,7 +2377,10 @@ fn refresh_static_invoices_for_used_offers() {
let offer = recipient.node.get_async_receive_offer().unwrap();
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let release_held_htlc_om = pass_async_payments_oms(
updated_invoice.clone(),
Expand Down Expand Up @@ -2673,7 +2712,10 @@ fn invoice_server_is_not_channel_peer() {
let offer = recipient.node.get_async_receive_offer().unwrap();
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

// Do the held_htlc_available --> release_held_htlc dance.
let release_held_htlc_om = pass_async_payments_oms(
Expand Down Expand Up @@ -2735,7 +2777,10 @@ fn invoice_request_forwarded_to_async_recipient() {
let offer = async_recipient.node.get_async_receive_offer().unwrap();
let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

let sender_node_id = sender.node.get_our_node_id();

Expand Down Expand Up @@ -2836,7 +2881,10 @@ fn async_payment_e2e() {

let amt_msat = 5000;
let payment_id = PaymentId([1; 32]);
sender.node.pay_for_offer(&offer, Some(amt_msat), payment_id, Default::default()).unwrap();
sender
.node
.pay_for_offer(&offer, Some(amt_msat), payment_id, vec![], Default::default())
.unwrap();

// Forward invreq to server, pass static invoice back, check that htlc was locked in/monitor was
// added
Expand Down
4 changes: 4 additions & 0 deletions lightning/src/ln/bolt11_payment_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ fn payment_metadata_end_to_end_for_invoice_with_amount() {
&invoice,
PaymentId(payment_hash.0),
Some(100),
vec![],
RouteParametersConfig::default(),
Retry::Attempts(0),
) {
Expand All @@ -68,6 +69,7 @@ fn payment_metadata_end_to_end_for_invoice_with_amount() {
&invoice,
PaymentId(payment_hash.0),
None,
vec![],
RouteParametersConfig::default(),
Retry::Attempts(0),
)
Expand Down Expand Up @@ -123,6 +125,7 @@ fn payment_metadata_end_to_end_for_invoice_with_no_amount() {
&invoice,
PaymentId(payment_hash.0),
None,
vec![],
RouteParametersConfig::default(),
Retry::Attempts(0),
) {
Expand All @@ -136,6 +139,7 @@ fn payment_metadata_end_to_end_for_invoice_with_no_amount() {
&invoice,
PaymentId(payment_hash.0),
Some(50_000),
vec![],
RouteParametersConfig::default(),
Retry::Attempts(0),
)
Expand Down
Loading
Loading