Skip to content

WIP: Add BOLT12 payer proof support #845

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

Draft
vincenzopalazzo wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

WIP: Add BOLT12 payer proof support #845

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
34a81a9
feat: persist paid BOLT12 invoices in payment details
vincenzopalazzo Mar 26, 2026
eb7c1a8
feat: add BOLT12 payer proof support
vincenzopalazzo Mar 26, 2026
6455eee
refactor: use payment_nonce from PaymentSent for payer proofs
vincenzopalazzo Mar 26, 2026
dc6012f
fix: resolve CI failures for BOLT12 payer proof FFI build
vincenzopalazzo Apr 2, 2026
a0641a2
Update BOLT12 payer proof API for upstream LDK PR #4297
vincenzopalazzo Apr 2, 2026
5f40753
ci: trigger re-run for flaky async_payment test
vincenzopalazzo Apr 2, 2026
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
5 changes: 4 additions & 1 deletion src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ where
offer_id,
payer_note,
quantity,
bolt12_invoice: None,
};

let payment = PaymentDetails::new(
Expand Down Expand Up @@ -1073,12 +1074,14 @@ where
debug_assert!(false, "payment_id should always be set.");
return Ok(());
};
let bolt12_invoice = bolt12_invoice.map(Into::into);

let update = PaymentDetailsUpdate {
hash: Some(Some(payment_hash)),
preimage: Some(Some(payment_preimage)),
fee_paid_msat: Some(fee_paid_msat),
status: Some(PaymentStatus::Succeeded),
bolt12_invoice: Some(bolt12_invoice.clone()),
..PaymentDetailsUpdate::new(payment_id)
};

Expand Down Expand Up @@ -1110,7 +1113,7 @@ where
payment_hash,
payment_preimage: Some(payment_preimage),
fee_paid_msat,
bolt12_invoice: bolt12_invoice.map(Into::into),
bolt12_invoice,
};

match self.event_queue.add_event(event).await {
Expand Down
7 changes: 7 additions & 0 deletions src/payment/bolt12.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use std::sync::{Arc, RwLock};
use std::time::{Duration, SystemTime, UNIX_EPOCH};

use lightning::blinded_path::message::BlindedMessagePath;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
use lightning::ln::channelmanager::{OptionalOfferPaymentParams, PaymentId};
use lightning::ln::outbound_payment::Retry;
use lightning::offers::offer::{Amount, Offer as LdkOffer, OfferFromHrn, Quantity};
Expand Down Expand Up @@ -154,6 +155,7 @@ impl Bolt12Payment {
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
bolt12_invoice: None,
};
let payment = PaymentDetails::new(
payment_id,
Expand All @@ -179,6 +181,7 @@ impl Bolt12Payment {
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
bolt12_invoice: None,
};
let payment = PaymentDetails::new(
payment_id,
Expand Down Expand Up @@ -314,6 +317,7 @@ impl Bolt12Payment {
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
bolt12_invoice: None,
};
let payment = PaymentDetails::new(
payment_id,
Expand All @@ -339,6 +343,7 @@ impl Bolt12Payment {
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
bolt12_invoice: None,
};
let payment = PaymentDetails::new(
payment_id,
Expand Down Expand Up @@ -444,6 +449,7 @@ impl Bolt12Payment {
secret: None,
payer_note: refund.payer_note().map(|note| UntrustedString(note.0.to_string())),
quantity: refund.quantity(),
bolt12_invoice: Some(LdkPaidBolt12Invoice::Bolt12Invoice(invoice.clone()).into()),
};

let payment = PaymentDetails::new(
Expand Down Expand Up @@ -514,6 +520,7 @@ impl Bolt12Payment {
secret: None,
payer_note: payer_note.map(|note| UntrustedString(note)),
quantity,
bolt12_invoice: None,
};
let payment = PaymentDetails::new(
payment_id,
Expand Down
51 changes: 42 additions & 9 deletions src/payment/store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
use std::time::{Duration, SystemTime, UNIX_EPOCH};

use bitcoin::{BlockHash, Txid};
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
use lightning::offers::offer::OfferId;
Expand All @@ -20,6 +22,8 @@ use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning_types::string::UntrustedString;

use crate::data_store::{StorableObject, StorableObjectId, StorableObjectUpdate};
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::hex_utils;

/// Represents a payment.
Expand Down Expand Up @@ -267,6 +271,18 @@ impl StorableObject for PaymentDetails {
update_if_necessary!(self.fee_paid_msat, fee_paid_msat_opt);
}

if let Some(ref bolt12_invoice_opt) = update.bolt12_invoice {
match self.kind {
PaymentKind::Bolt12Offer { ref mut bolt12_invoice, .. } => {
update_if_necessary!(*bolt12_invoice, bolt12_invoice_opt.clone());
},
PaymentKind::Bolt12Refund { ref mut bolt12_invoice, .. } => {
update_if_necessary!(*bolt12_invoice, bolt12_invoice_opt.clone());
},
_ => {},
}
}

if let Some(skimmed_fee_msat) = update.counterparty_skimmed_fee_msat {
match self.kind {
PaymentKind::Bolt11Jit { ref mut counterparty_skimmed_fee_msat, .. } => {
Expand Down Expand Up @@ -428,6 +444,8 @@ pub enum PaymentKind {
///
/// This will always be `None` for payments serialized with version `v0.3.0`.
quantity: Option<u64>,
/// The BOLT12 invoice associated with the payment, once available.
bolt12_invoice: Option<PaidBolt12Invoice>,
},
/// A [BOLT 12] 'refund' payment, i.e., a payment for a [`Refund`].
///
Expand All @@ -448,6 +466,8 @@ pub enum PaymentKind {
///
/// This will always be `None` for payments serialized with version `v0.3.0`.
quantity: Option<u64>,
/// The BOLT12 invoice associated with the payment, once available.
bolt12_invoice: Option<PaidBolt12Invoice>,
},
/// A spontaneous ("keysend") payment.
Spontaneous {
Expand Down Expand Up @@ -482,6 +502,7 @@ impl_writeable_tlv_based_enum!(PaymentKind,
(3, quantity, option),
(4, secret, option),
(6, offer_id, required),
(8, bolt12_invoice, option),
Copy link
Copy Markdown
Collaborator

@tnull tnull Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned elsewhere, we probably don't want to do this, at least not before we can use #811

},
(8, Spontaneous) => {
(0, hash, required),
Expand All @@ -493,6 +514,7 @@ impl_writeable_tlv_based_enum!(PaymentKind,
(2, preimage, option),
(3, quantity, option),
(4, secret, option),
(6, bolt12_invoice, option),
}
);

Expand Down Expand Up @@ -555,6 +577,7 @@ pub(crate) struct PaymentDetailsUpdate {
pub direction: Option<PaymentDirection>,
pub status: Option<PaymentStatus>,
pub confirmation_status: Option<ConfirmationStatus>,
pub bolt12_invoice: Option<Option<PaidBolt12Invoice>>,
pub txid: Option<Txid>,
}

Expand All @@ -571,30 +594,39 @@ impl PaymentDetailsUpdate {
direction: None,
status: None,
confirmation_status: None,
bolt12_invoice: None,
txid: None,
}
}
}

impl From<&PaymentDetails> for PaymentDetailsUpdate {
fn from(value: &PaymentDetails) -> Self {
let (hash, preimage, secret) = match value.kind {
PaymentKind::Bolt11 { hash, preimage, secret, .. } => (Some(hash), preimage, secret),
PaymentKind::Bolt11Jit { hash, preimage, secret, .. } => (Some(hash), preimage, secret),
PaymentKind::Bolt12Offer { hash, preimage, secret, .. } => (hash, preimage, secret),
PaymentKind::Bolt12Refund { hash, preimage, secret, .. } => (hash, preimage, secret),
PaymentKind::Spontaneous { hash, preimage, .. } => (Some(hash), preimage, None),
_ => (None, None, None),
let (hash, preimage, secret, bolt12_invoice) = match &value.kind {
PaymentKind::Bolt11 { hash, preimage, secret, .. } => {
(Some(*hash), *preimage, *secret, None)
},
PaymentKind::Bolt11Jit { hash, preimage, secret, .. } => {
(Some(*hash), *preimage, *secret, None)
},
PaymentKind::Bolt12Offer { hash, preimage, secret, bolt12_invoice, .. } => {
(*hash, *preimage, *secret, Some(bolt12_invoice.clone()))
},
PaymentKind::Bolt12Refund { hash, preimage, secret, bolt12_invoice, .. } => {
(*hash, *preimage, *secret, Some(bolt12_invoice.clone()))
},
PaymentKind::Spontaneous { hash, preimage, .. } => (Some(*hash), *preimage, None, None),
_ => (None, None, None, None),
};

let (confirmation_status, txid) = match &value.kind {
PaymentKind::Onchain { status, txid, .. } => (Some(*status), Some(*txid)),
_ => (None, None),
};

let counterparty_skimmed_fee_msat = match value.kind {
let counterparty_skimmed_fee_msat = match &value.kind {
PaymentKind::Bolt11Jit { counterparty_skimmed_fee_msat, .. } => {
Some(counterparty_skimmed_fee_msat)
Some(*counterparty_skimmed_fee_msat)
},
_ => None,
};
Expand All @@ -610,6 +642,7 @@ impl From<&PaymentDetails> for PaymentDetailsUpdate {
direction: Some(value.direction),
status: Some(value.status),
confirmation_status,
bolt12_invoice,
txid,
}
}
Expand Down
8 changes: 7 additions & 1 deletion tests/integration_tests_rust.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1115,12 +1115,14 @@ async fn simple_bolt12_send_receive() {
offer_id,
quantity: ref qty,
payer_note: ref note,
bolt12_invoice: ref invoice,
} => {
assert!(hash.is_some());
assert!(preimage.is_some());
assert_eq!(offer_id, offer.id());
assert_eq!(&expected_quantity, qty);
assert_eq!(expected_payer_note.unwrap(), note.clone().unwrap().0);
assert!(invoice.is_some());
// TODO: We should eventually set and assert the secret sender-side, too, but the BOLT12
// API currently doesn't allow to do that.
},
Expand Down Expand Up @@ -1182,12 +1184,14 @@ async fn simple_bolt12_send_receive() {
offer_id,
quantity: ref qty,
payer_note: ref note,
bolt12_invoice: ref invoice,
} => {
assert!(hash.is_some());
assert!(preimage.is_some());
assert_eq!(offer_id, offer.id());
assert_eq!(&expected_quantity, qty);
assert_eq!(expected_payer_note.unwrap(), note.clone().unwrap().0);
assert!(invoice.is_some());
// TODO: We should eventually set and assert the secret sender-side, too, but the BOLT12
// API currently doesn't allow to do that.
hash.unwrap()
Expand Down Expand Up @@ -1255,11 +1259,13 @@ async fn simple_bolt12_send_receive() {
secret: _,
quantity: ref qty,
payer_note: ref note,
bolt12_invoice: ref invoice,
} => {
assert!(hash.is_some());
assert!(preimage.is_some());
assert_eq!(&expected_quantity, qty);
assert_eq!(expected_payer_note.unwrap(), note.clone().unwrap().0)
assert_eq!(expected_payer_note.unwrap(), note.clone().unwrap().0);
assert!(invoice.is_some());
// TODO: We should eventually set and assert the secret sender-side, too, but the BOLT12
// API currently doesn't allow to do that.
},
Expand Down