Skip to content

[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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
tnull merged 1 commit into from
Mar 4, 2026
Merged

[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
payment_preimage: Option<PaymentPreimage>,
/// The total fee which was spent at intermediate hops in this payment.
fee_paid_msat: Option<u64>,
/// The BOLT12 invoice that was paid.
///
/// This is useful for proof of payment. A third party can verify that the payment was made
/// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
///
/// Will be `None` for non-BOLT12 payments.
///
/// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
/// async payments) do not support proof of payment as the payment hash is not derived
/// from a preimage known only to the recipient.
bolt12_invoice: Option<PaidBolt12Invoice>,
},
/// A sent payment has failed.
PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
(1, fee_paid_msat, option),
(3, payment_id, option),
(5, payment_preimage, option),
(7, bolt12_invoice, option),
},
(1, PaymentFailed) => {
(0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
payment_preimage,
payment_hash,
fee_paid_msat,
bolt12_invoice,
..
} => {
let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
payment_hash,
payment_preimage: Some(payment_preimage),
fee_paid_msat,
bolt12_invoice: bolt12_invoice.map(Into::into),
};

match self.event_queue.add_event(event).await {
Expand Down
103 changes: 98 additions & 5 deletions src/ffi/types.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
VssHeaderProvider as VssClientHeaderProvider,
VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
/// The amount for a successful payment of the invoice, if specified.
pub fn amount(&self) -> Option<OfferAmount> {
self.inner.amount().map(|amount| amount.into())
}
}

impl From<LdkStaticInvoice> for StaticInvoice {
fn from(invoice: LdkStaticInvoice) -> Self {
StaticInvoice { inner: invoice }
}
}

impl Deref for StaticInvoice {
type Target = LdkStaticInvoice;
fn deref(&self) -> &Self::Target {
&self.inner
}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
fn as_ref(&self) -> &LdkStaticInvoice {
self.deref()
}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
/// The BOLT12 invoice, allowing the user to perform proof of payment.
Bolt12(Arc<Bolt12Invoice>),
/// The static invoice, used in async payments, where the user cannot perform proof of
/// payment.
Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
fn from(ldk: LdkPaidBolt12Invoice) -> Self {
match ldk {
LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
},
LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
},
}
}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
fn from(wrapper: PaidBolt12Invoice) -> Self {
match wrapper {
PaidBolt12Invoice::Bolt12(invoice) => {
LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
},
PaidBolt12Invoice::Static(invoice) => {
LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
},
}
}
}

impl Writeable for PaidBolt12Invoice {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
// TODO: Find way to avoid cloning invoice data.
let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
ldk_type.write(w)
}
}

impl Readable for PaidBolt12Invoice {
fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
let ldk_type = LdkPaidBolt12Invoice::read(r)?;
Ok(ldk_type.into())
}
}

uniffi::custom_type!(OfferId, String, {
remote,
try_lift: |val| {
Expand Down
12 changes: 11 additions & 1 deletion tests/common/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
});
assert_eq!(inbound_payments_b.len(), 1);

expect_event!(node_a, PaymentSuccessful);
// Verify bolt12_invoice is None for BOLT11 payments
match node_a.next_event_async().await {
ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
println!("{} got event {:?}", node_a.node_id(), e);
assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
node_a.event_handled().unwrap();
},
ref e => {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
},
}
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down
14 changes: 13 additions & 1 deletion tests/integration_tests_rust.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
.send(&offer, expected_quantity, expected_payer_note.clone(), None)
.unwrap();

expect_payment_successful_event!(node_a, Some(payment_id), None);
let event = node_a.next_event_async().await;
match event {
ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
println!("{} got event {:?}", node_a.node_id(), e);
assert_eq!(*evt_id, Some(payment_id));
assert!(
bolt12_invoice.is_some(),
"bolt12_invoice should be present for BOLT12 payments"
);
node_a.event_handled().unwrap();
},
ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
}
let node_a_payments =
node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
assert_eq!(node_a_payments.len(), 1);
Expand Down
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" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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('^' + ".*" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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('^' + ".*" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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('^' + ".*" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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('^' + ".*" + '
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
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); }
})();
})();
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment by vincenzopalazzo · Pull Request #733 · lightningdevkit/ldk-node · GitHub
Skip to content
[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment#733

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

tnull
merged 1 commit into

from

Mar 4, 2026
 Merged


[RFC] event: expose BOLT12 invoice in PaymentSuccessful for proof of payment
#733
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 18 additions & 0 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@ use bitcoin::blockdata::locktime::absolute::LockTime;
use bitcoin::secp256k1::PublicKey;
use bitcoin::{Amount, OutPoint};
use lightning::events::bump_transaction::BumpTransactionEvent;
#[cfg(not(feature = "uniffi"))]
use lightning::events::PaidBolt12Invoice;
use lightning::events::{
	ClosureReason, Event as LdkEvent, FundingInfo, PaymentFailureReason, PaymentPurpose,
	ReplayEvent,
Expand All@@ -37,6 +39,8 @@ use crate::config::{may_announce_channel, Config};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::fee_estimator::ConfirmationTarget;
#[cfg(feature = "uniffi")]
use crate::ffi::PaidBolt12Invoice;
use crate::io::{
	EVENT_QUEUE_PERSISTENCE_KEY, EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
	EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
Expand DownExpand Up@@ -79,6 +83,17 @@ pub enum Event {
 payment_preimage: Option<PaymentPreimage>,
 /// The total fee which was spent at intermediate hops in this payment.
 fee_paid_msat: Option<u64>,
 /// The BOLT12 invoice that was paid.
 ///
 /// This is useful for proof of payment. A third party can verify that the payment was made
 /// by checking that the `payment_hash` in the invoice matches `sha256(payment_preimage)`.
 ///
 /// Will be `None` for non-BOLT12 payments.
 ///
 /// Note that static invoices (indicated by [`PaidBolt12Invoice::StaticInvoice`], used for
 /// async payments) do not support proof of payment as the payment hash is not derived
 /// from a preimage known only to the recipient.
 bolt12_invoice: Option<PaidBolt12Invoice>,
	},
	/// A sent payment has failed.
	PaymentFailed {
Expand DownExpand Up@@ -268,6 +283,7 @@ impl_writeable_tlv_based_enum!(Event,
 (1, fee_paid_msat, option),
 (3, payment_id, option),
 (5, payment_preimage, option),
 (7, bolt12_invoice, option),
	},
	(1, PaymentFailed) => {
 (0, payment_hash, option),
Expand DownExpand Up@@ -1028,6 +1044,7 @@ where
 payment_preimage,
 payment_hash,
 fee_paid_msat,
 bolt12_invoice,
 ..
 } => {
 let payment_id = if let Some(id) = payment_id {
Expand DownExpand Up@@ -1073,6 +1090,7 @@ where
 payment_hash,
 payment_preimage: Some(payment_preimage),
 fee_paid_msat,
 bolt12_invoice: bolt12_invoice.map(Into::into),
 };

 match self.event_queue.add_event(event).await {
Expand Down

103 changes: 98 additions & 5 deletions
src/ffi/types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
//
// Make sure to add any re-exported items that need to be used in uniffi below.

use std::collections::HashMap;
use std::convert::TryInto;
use std::ops::Deref;
use std::str::FromStr;
Expand All@@ -22,17 +23,20 @@ use bitcoin::hashes::Hash;
use bitcoin::secp256k1::PublicKey;
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, ScriptBuf, Txid};
pub use lightning::chain::channelmonitor::BalanceSource;
use lightning::events::PaidBolt12Invoice as LdkPaidBolt12Invoice;
pub use lightning::events::{ClosureReason, PaymentFailureReason};
use lightning::ln::channelmanager::PaymentId;
use lightning::ln::msgs::DecodeError;
pub use lightning::ln::types::ChannelId;
use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
pub use lightning::offers::offer::OfferId;
use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
use lightning::offers::refund::Refund as LdkRefund;
use lightning::offers::static_invoice::StaticInvoice as LdkStaticInvoice;
use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;
pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
pub use lightning::routing::router::RouteParametersConfig;
use lightning::util::ser::Writeable;
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
Expand All@@ -41,10 +45,10 @@ pub use lightning_liquidity::lsps1::msgs::{
};
pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
pub use lightning_types::string::UntrustedString;
use std::collections::HashMap;

use vss_client::headers::VssHeaderProvider as VssClientHeaderProvider;
use vss_client::headers::VssHeaderProviderError as VssClientHeaderProviderError;
use vss_client::headers::{
	VssHeaderProvider as VssClientHeaderProvider,
	VssHeaderProviderError as VssClientHeaderProviderError,
};

/// Errors around providing headers for each VSS request.
#[derive(Debug, uniffi::Error)]
Expand DownExpand Up@@ -775,6 +779,95 @@ impl AsRef<LdkBolt12Invoice> for Bolt12Invoice {
	}
}

/// A static invoice used for async payments.
///
/// Static invoices are a special type of BOLT12 invoice where proof of payment is not possible,
/// as the payment hash is not derived from a preimage known only to the recipient.
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Object)]
pub struct StaticInvoice {
	pub(crate) inner: LdkStaticInvoice,
}

#[uniffi::export]
impl StaticInvoice {
	/// The amount for a successful payment of the invoice, if specified.
	pub fn amount(&self) -> Option<OfferAmount> {
 self.inner.amount().map(|amount| amount.into())
	}
}

impl From<LdkStaticInvoice> for StaticInvoice {
	fn from(invoice: LdkStaticInvoice) -> Self {
 StaticInvoice { inner: invoice }
	}
}

impl Deref for StaticInvoice {
	type Target = LdkStaticInvoice;
	fn deref(&self) -> &Self::Target {
 &self.inner
	}
}

impl AsRef<LdkStaticInvoice> for StaticInvoice {
	fn as_ref(&self) -> &LdkStaticInvoice {
 self.deref()
	}
}

/// The BOLT12 invoice that was paid, surfaced in [`Event::PaymentSuccessful`].
///
/// [`Event::PaymentSuccessful`]: crate::Event::PaymentSuccessful
#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
pub enum PaidBolt12Invoice {
	/// The BOLT12 invoice, allowing the user to perform proof of payment.
	Bolt12(Arc<Bolt12Invoice>),
	/// The static invoice, used in async payments, where the user cannot perform proof of
	/// payment.
	Static(Arc<StaticInvoice>),
}

impl From<LdkPaidBolt12Invoice> for PaidBolt12Invoice {
	fn from(ldk: LdkPaidBolt12Invoice) -> Self {
 match ldk {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice) => {
 PaidBolt12Invoice::Bolt12(Arc::new(Bolt12Invoice::from(invoice)))
 },
 LdkPaidBolt12Invoice::StaticInvoice(invoice) => {
 PaidBolt12Invoice::Static(Arc::new(StaticInvoice::from(invoice)))
 },
 }
	}
}

impl From<PaidBolt12Invoice> for LdkPaidBolt12Invoice {
	fn from(wrapper: PaidBolt12Invoice) -> Self {
 match wrapper {
 PaidBolt12Invoice::Bolt12(invoice) => {
 LdkPaidBolt12Invoice::Bolt12Invoice(invoice.inner.clone())
 },
 PaidBolt12Invoice::Static(invoice) => {
 LdkPaidBolt12Invoice::StaticInvoice(invoice.inner.clone())
 },
 }
	}
}

impl Writeable for PaidBolt12Invoice {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), lightning::io::Error> {
 // TODO: Find way to avoid cloning invoice data.
 let ldk_type: LdkPaidBolt12Invoice = self.clone().into();
 ldk_type.write(w)
	}
}

impl Readable for PaidBolt12Invoice {
	fn read<R: lightning::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 let ldk_type = LdkPaidBolt12Invoice::read(r)?;
 Ok(ldk_type.into())
	}
}

uniffi::custom_type!(OfferId, String, {
	remote,
	try_lift: |val| {
Expand Down

12 changes: 11 additions & 1 deletion
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -953,7 +953,17 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
	});
	assert_eq!(inbound_payments_b.len(), 1);

	expect_event!(node_a, PaymentSuccessful);
	// Verify bolt12_invoice is None for BOLT11 payments
	match node_a.next_event_async().await {
 ref e @ Event::PaymentSuccessful { ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert!(bolt12_invoice.is_none(), "bolt12_invoice should be None for BOLT11 payments");
 node_a.event_handled().unwrap();
 },
 ref e => {
 panic!("{} got unexpected event!: {:?}", std::stringify!(node_a), e);
 },
	}
	expect_event!(node_b, PaymentReceived);
	assert_eq!(node_a.payment(&payment_id).unwrap().status, PaymentStatus::Succeeded);
	assert_eq!(node_a.payment(&payment_id).unwrap().direction, PaymentDirection::Outbound);
Expand Down

14 changes: 13 additions & 1 deletion
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1089,7 +1089,19 @@ async fn simple_bolt12_send_receive() {
 .send(&offer, expected_quantity, expected_payer_note.clone(), None)
 .unwrap();

	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let event = node_a.next_event_async().await;
	match event {
 ref e @ Event::PaymentSuccessful { payment_id: ref evt_id, ref bolt12_invoice, .. } => {
 println!("{} got event {:?}", node_a.node_id(), e);
 assert_eq!(*evt_id, Some(payment_id));
 assert!(
 bolt12_invoice.is_some(),
 "bolt12_invoice should be present for BOLT12 payments"
 );
 node_a.event_handled().unwrap();
 },
 ref e => panic!("{} got unexpected event!: {:?}", "node_a", e),
	}
	let node_a_payments =
 node_a.list_payments_with_filter(|p| matches!(p.kind, PaymentKind::Bolt12Offer { .. }));
	assert_eq!(node_a_payments.len(), 1);
Expand Down
Loading