Skip to content

Add BOLT12 support to LSPS2 flow#817

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

Closed
tnull wants to merge 8 commits into from
Closed

Add BOLT12 support to LSPS2 flow #817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e5a714c
DROPME: Bump Rust Lightning to unmerged LSPS2 APIs
tnull Jun 9, 2026
f5afd7b
f - Point LDK Node at updated LSPS2 LDK
tnull Jun 17, 2026
d79e9a6
f - Handle updated onion intercept event shape
tnull Jun 17, 2026
9b63b78
Support LSPS2 metadata in BOLT12 payment context
tnull Jun 9, 2026
12f2811
Receive BOLT12 payments through LSPS2 JIT channels
tnull Jun 9, 2026
e7c158c
f - Wait on async offer readiness future
tnull Jun 17, 2026
c5f518a
Cover LSPS2 BOLT12 JIT payments
tnull Jun 9, 2026
8d1efeb
f - Update LSPS2 BOLT12 tests for multi-LSP
tnull Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
24 changes: 17 additions & 7 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
PeerManager, PendingPaymentStore,
GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
}

let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
let router = Arc::new(DefaultRouter::new(
let inner_router = DefaultRouter::new(
Arc::clone(&network_graph),
Arc::clone(&logger),
Arc::clone(&keys_manager),
Arc::clone(&scorer),
scoring_fee_params,
);
let inner_message_router =
InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
inner_router,
Arc::clone(&keys_manager),
LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
));

let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
}
}

let message_router =
Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

// Initialize the ChannelManager
let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
Arc::clone(&keys_manager),
Arc::clone(&logger),
Arc::clone(&channel_manager),
message_router,
Arc::clone(&message_router),
Arc::clone(&channel_manager),
Arc::clone(&channel_manager),
Arc::clone(&om_resolver),
IgnoringMessageHandler {},
false,
))
} else {
Arc::new(OnionMessenger::new(
Arc::clone(&keys_manager),
Arc::clone(&keys_manager),
Arc::clone(&logger),
Arc::clone(&channel_manager),
message_router,
Arc::clone(&message_router),
Arc::clone(&channel_manager),
Arc::clone(&channel_manager),
Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
output_sweeper,
peer_manager,
onion_messenger,
message_router,
connection_manager,
keys_manager,
network_graph,
Expand Down
6 changes: 3 additions & 3 deletions src/data_store.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::impl_ser_tlv_based;
use lightning::util::test_utils::TestLogger;

use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
hex_utils::to_string(&self.id)
}
}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

struct TestObjectUpdate {
id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
}
}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
(0, id, required),
(2, data, required),
});
Expand Down
95 changes: 77 additions & 18 deletions src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
(1, channel_id, required),
(3, user_channel_id, option),
(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
(0, PaymentSuccessful) => {
(0, payment_hash, required),
(1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
}
}

fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
fn lsps2_max_total_opening_fee_msat_from_metadata(
metadata: PaymentMetadata, amount_msat: u64,
) -> Option<u64> {
let lsps2_parameters = metadata.lsps2_parameters?;
lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
})
}

fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
}

fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
) -> Option<u64> {
let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
}

pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
match event {
LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
.and_then(|metadata| {
Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
}),
PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
payment_context.payment_metadata.as_ref(),
amount_msat,
)
},
_ => None,
};

let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
log_info!(
self.logger,
"Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
"Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
hex_utils::to_string(&payment_hash.0),
counterparty_skimmed_fee_msat,
);
Expand All@@ -828,18 +848,24 @@ where
match &info.kind {
PaymentKind::Bolt11 { .. } => {
let update = PaymentDetailsUpdate {
counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
counterparty_skimmed_fee_msat: Some(Some(
counterparty_skimmed_fee_msat,
)),
..PaymentDetailsUpdate::new(payment_id)
};
match self.payment_store.update(update).await {
Ok(_) => (),
Err(e) => {
log_error!(self.logger, "Failed to access payment store: {}", e);
log_error!(
self.logger,
"Failed to access payment store: {}",
e
);
return Err(ReplayEvent());
},
};
},
_ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
_ => {},
}
}
}
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

self.bump_tx_event_handler.handle_event(&bte).await;
},
LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
if let Some(om_mailbox) = self.om_mailbox.as_ref() {
om_mailbox.onion_message_intercepted(peer_node_id, message);
} else {
LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
if let Some(om_mailbox) = self.om_mailbox.as_ref() {
om_mailbox.onion_message_intercepted(peer_node_id, message);
} else {
log_trace!(
self.logger,
"Onion message intercepted, but no onion message mailbox available"
);
}
},
lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
log_trace!(
self.logger,
"Onion message intercepted, but no onion message mailbox available"
"Onion message intercepted for unknown SCID {}, ignoring",
scid
);
}
},
},
LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
max_total_opening_fee_msat: Some(42_000),
max_proportional_opening_fee_ppm_msat: None,
}),
lsps2_bolt12_invoice_parameters: None,
};

assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
);
}

#[test]
fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
let metadata = PaymentMetadata {
lsps2_parameters: Some(LSPS2Parameters {
max_total_opening_fee_msat: None,
max_proportional_opening_fee_ppm_msat: Some(10_000),
}),
lsps2_bolt12_invoice_parameters: None,
}
.encode_as_bolt12_payment_metadata();

assert_eq!(
EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
Some(&metadata),
100_000
),
Some(1_000)
);
}

#[test]
fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
let empty_metadata =
PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
.encode();
let metadata_without_fee_limit = PaymentMetadata {
lsps2_parameters: Some(LSPS2Parameters {
max_total_opening_fee_msat: None,
max_proportional_opening_fee_ppm_msat: None,
}),
lsps2_bolt12_invoice_parameters: None,
}
.encode();

Expand Down
4 changes: 2 additions & 2 deletions src/io/vss_store.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
(0, V0) => {},
(1, V1) => {},
);
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" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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('^' + ".*" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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('^' + ".*" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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('^' + ".*" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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('^' + ".*" + '
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
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); }
})();
})();
Add BOLT12 support to LSPS2 flow by tnull · Pull Request #817 · lightningdevkit/ldk-node · GitHub
Skip to content
Add BOLT12 support to LSPS2 flow#817

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

 Closed

tnull
wants to merge
8
commits into

from

 Closed


Add BOLT12 support to LSPS2 flow
#817
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
e5a714c

DROPME: Bump Rust Lightning to unmerged LSPS2 APIs


tnull Jun 9, 2026
f5afd7b

f - Point LDK Node at updated LSPS2 LDK


tnull Jun 17, 2026
d79e9a6

f - Handle updated onion intercept event shape


tnull Jun 17, 2026
9b63b78

Support LSPS2 metadata in BOLT12 payment context


tnull Jun 9, 2026
12f2811

Receive BOLT12 payments through LSPS2 JIT channels


tnull Jun 9, 2026
e7c158c

f - Wait on async offer readiness future


tnull Jun 17, 2026
c5f518a

Cover LSPS2 BOLT12 JIT payments


tnull Jun 9, 2026
8d1efeb

f - Update LSPS2 BOLT12 tests for multi-LSP


tnull Jun 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 13 additions & 13 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,16 +183,16 @@ harness = false
#vss-client-ng = { path = "../vss-client" }
#vss-client-ng = { git = "https://github.com/lightningdevkit/vss-client", branch = "main" }
#
#[patch."https://github.com/lightningdevkit/rust-lightning"]
#lightning = { path = "../rust-lightning/lightning" }
#lightning-types = { path = "../rust-lightning/lightning-types" }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
#lightning-net-tokio = { path = "../rust-lightning/lightning-net-tokio" }
#lightning-persister = { path = "../rust-lightning/lightning-persister" }
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor" }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-block-sync = { path = "../rust-lightning/lightning-block-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync" }
#lightning-liquidity = { path = "../rust-lightning/lightning-liquidity" }
#lightning-macros = { path = "../rust-lightning/lightning-macros" }
#lightning-dns-resolver = { path = "../rust-lightning/lightning-dns-resolver" }
[patch."https://github.com/lightningdevkit/rust-lightning"]
lightning = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-types = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-invoice = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-net-tokio = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-persister = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-background-processor = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-rapid-gossip-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-block-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-transaction-sync = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-liquidity = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-macros = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }
lightning-dns-resolver = { git = "https://github.com/tnull/rust-lightning", rev = "abdecc2b9ebe42b940b8404d4f024f42e265eb6f" }

24 changes: 17 additions & 7 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ use lightning::util::persist::{
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
use lightning_dns_resolver::OMDomainResolver;
use lightning_liquidity::lsps2::router::LSPS2BOLT12Router;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
Expand DownExpand Up@@ -73,13 +74,14 @@ use crate::lnurl_auth::LnurlAuth;
use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::payment::LdkNodeLSPS2Bolt12PaymentMetadataDecoder;
use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
	GossipSync, Graph, HRNResolver, KeysManager, MessageRouter, OnionMessenger, PaymentStore,
	PeerManager, PendingPaymentStore,
	GossipSync, Graph, HRNResolver, InnerMessageRouter, KeysManager, MessageRouter, OnionMessenger,
PaymentStore, PeerManager, PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand DownExpand Up@@ -1762,12 +1764,19 @@ fn build_with_store_internal(
	}

	let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
	let router = Arc::new(DefaultRouter::new(
	let inner_router = DefaultRouter::new(
 Arc::clone(&network_graph),
 Arc::clone(&logger),
 Arc::clone(&keys_manager),
 Arc::clone(&scorer),
 scoring_fee_params,
	);
	let inner_message_router =
 InnerMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager));
	let router = Arc::new(LSPS2BOLT12Router::new_with_payment_metadata_decoder(
 inner_router,
 Arc::clone(&keys_manager),
 LdkNodeLSPS2Bolt12PaymentMetadataDecoder,
	));

	let mut user_config = default_user_config(&config);
Expand All@@ -1791,8 +1800,7 @@ fn build_with_store_internal(
 }
	}

	let message_router =
 Arc::new(MessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager)));
	let message_router: Arc<MessageRouter> = Arc::new(inner_message_router);

	// Initialize the ChannelManager
	let channel_manager = {
Expand DownExpand Up@@ -1911,19 +1919,20 @@ fn build_with_store_internal(
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
 IgnoringMessageHandler {},
 false,
 ))
 } else {
 Arc::new(OnionMessenger::new(
 Arc::clone(&keys_manager),
 Arc::clone(&keys_manager),
 Arc::clone(&logger),
 Arc::clone(&channel_manager),
 message_router,
Arc::clone(&message_router),
 Arc::clone(&channel_manager),
 Arc::clone(&channel_manager),
 Arc::clone(&om_resolver),
Expand DownExpand Up@@ -2137,6 +2146,7 @@ fn build_with_store_internal(
 output_sweeper,
 peer_manager,
 onion_messenger,
 message_router,
 connection_manager,
 keys_manager,
 network_graph,
Expand Down

6 changes: 3 additions & 3 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,7 @@ where

#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::impl_ser_tlv_based;
	use lightning::util::test_utils::TestLogger;

	use super::*;
Expand All@@ -236,7 +236,7 @@ mod tests {
 hex_utils::to_string(&self.id)
 }
	}
impl_writeable_tlv_based!(TestObjectId, { (0, id, required) });
impl_ser_tlv_based!(TestObjectId, { (0, id, required) });

	struct TestObjectUpdate {
 id: TestObjectId,
Expand DownExpand Up@@ -276,7 +276,7 @@ mod tests {
 }
	}

impl_writeable_tlv_based!(TestObject, {
impl_ser_tlv_based!(TestObject, {
 (0, id, required),
 (2, data, required),
	});
Expand Down

95 changes: 77 additions & 18 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::collections::{BTreeMap, VecDeque};
use std::ops::Deref;
use std::sync::{Arc, Mutex};

Expand All@@ -29,7 +29,7 @@ use lightning::util::config::{ChannelConfigOverrides, ChannelConfigUpdate};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning::{impl_ser_tlv_based, impl_ser_tlv_based_enum};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

Expand All@@ -50,7 +50,7 @@ use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
use crate::payment::store::{
	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
};
use crate::payment::PaymentMetadata;
use crate::payment::{PaymentMetadata, LDK_NODE_BOLT12_PAYMENT_METADATA_KEY};
use crate::runtime::Runtime;
use crate::types::{
	CustomTlvRecord, DynStore, KeysManager, OnionMessenger, PaymentStore, Sweeper, Wallet,
Expand DownExpand Up@@ -78,7 +78,7 @@ pub struct HTLCLocator {
	pub node_id: Option<PublicKey>,
}

impl_writeable_tlv_based!(HTLCLocator, {
impl_ser_tlv_based!(HTLCLocator, {
	(1, channel_id, required),
	(3, user_channel_id, option),
	(5, node_id, option),
Expand DownExpand Up@@ -294,7 +294,7 @@ pub enum Event {
	},
}

impl_writeable_tlv_based_enum!(Event,
impl_ser_tlv_based_enum!(Event,
	(0, PaymentSuccessful) => {
 (0, payment_hash, required),
 (1, fee_paid_msat, option),
Expand DownExpand Up@@ -600,8 +600,9 @@ where
 }
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
	fn lsps2_max_total_opening_fee_msat_from_metadata(
 metadata: PaymentMetadata, amount_msat: u64,
	) -> Option<u64> {
 let lsps2_parameters = metadata.lsps2_parameters?;
 lsps2_parameters.max_total_opening_fee_msat.or_else(|| {
 lsps2_parameters.max_proportional_opening_fee_ppm_msat.and_then(|max_prop_fee| {
Expand All@@ -611,6 +612,19 @@ where
 })
	}

	fn lsps2_max_total_opening_fee_msat(payment_metadata: &[u8], amount_msat: u64) -> Option<u64> {
 let metadata = PaymentMetadata::read(&mut &payment_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	fn lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_metadata: Option<&BTreeMap<u64, Vec<u8>>>, amount_msat: u64,
	) -> Option<u64> {
 let encoded_metadata = payment_metadata?.get(&LDK_NODE_BOLT12_PAYMENT_METADATA_KEY)?;
 let metadata = PaymentMetadata::read(&mut &encoded_metadata[..]).ok()?;
 Self::lsps2_max_total_opening_fee_msat_from_metadata(metadata, amount_msat)
	}

	pub async fn handle_event(&self, event: LdkEvent) -> Result<(), ReplayEvent> {
 match event {
 LdkEvent::FundingGenerationReady {
Expand DownExpand Up@@ -798,13 +812,19 @@ where
 .and_then(|metadata| {
 Self::lsps2_max_total_opening_fee_msat(metadata, amount_msat)
 }),
 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
 Self::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 payment_context.payment_metadata.as_ref(),
 amount_msat,
 )
 },
 _ => None,
 };

 let Some(max_total_opening_fee_msat) = max_total_opening_fee_msat else {
 log_info!(
 self.logger,
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid BOLT11 LSPS2 payment metadata",
 "Refusing inbound payment with hash {} as the counterparty withheld {}msat without valid LSPS2 payment metadata",
 hex_utils::to_string(&payment_hash.0),
 counterparty_skimmed_fee_msat,
 );
Expand All@@ -828,18 +848,24 @@ where
 match &info.kind {
 PaymentKind::Bolt11 { .. } => {
 let update = PaymentDetailsUpdate {
 counterparty_skimmed_fee_msat: Some(Some(counterparty_skimmed_fee_msat)),
 counterparty_skimmed_fee_msat: Some(Some(
 counterparty_skimmed_fee_msat,
 )),
 ..PaymentDetailsUpdate::new(payment_id)
 };
 match self.payment_store.update(update).await {
 Ok(_) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to access payment store: {}", e);
 log_error!(
 self.logger,
 "Failed to access payment store: {}",
 e
 );
 return Err(ReplayEvent());
 },
 };
 },
 _ => debug_assert!(false, "We only expect the counterparty to get away with withholding fees for BOLT11 payments."),
 _ => {},
 }
 }
 }
Expand DownExpand Up@@ -1725,15 +1751,24 @@ where

 self.bump_tx_event_handler.handle_event(&bte).await;
 },
 LdkEvent::OnionMessageIntercepted { peer_node_id, message } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 LdkEvent::OnionMessageIntercepted { next_hop, message, .. } => match next_hop {
 lightning::blinded_path::message::NextMessageHop::NodeId(peer_node_id) => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
 om_mailbox.onion_message_intercepted(peer_node_id, message);
 } else {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 );
 }
 },
 lightning::blinded_path::message::NextMessageHop::ShortChannelId(scid) => {
 log_trace!(
 self.logger,
 "Onion message intercepted, but no onion message mailbox available"
 "Onion message intercepted for unknown SCID {}, ignoring",
 scid
 );
 }
 },
 },
 LdkEvent::OnionMessagePeerConnected { peer_node_id } => {
 if let Some(om_mailbox) = self.om_mailbox.as_ref() {
Expand DownExpand Up@@ -1928,6 +1963,7 @@ mod tests {
 max_total_opening_fee_msat: Some(42_000),
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 };

 assert_eq!(
Expand All@@ -1939,14 +1975,37 @@ mod tests {
 );
	}

	#[test]
	fn lsps2_bolt12_payment_metadata_decodes_total_fee_limit() {
 let metadata = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: Some(10_000),
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode_as_bolt12_payment_metadata();

 assert_eq!(
 EventHandler::<Arc<TestLogger>>::lsps2_max_total_opening_fee_msat_from_bolt12_metadata(
 Some(&metadata),
 100_000
 ),
 Some(1_000)
 );
	}

	#[test]
	fn lsps2_payment_metadata_missing_or_malformed_limit_is_rejected() {
 let empty_metadata = PaymentMetadata { lsps2_parameters: None }.encode();
 let empty_metadata =
 PaymentMetadata { lsps2_parameters: None, lsps2_bolt12_invoice_parameters: None }
 .encode();
 let metadata_without_fee_limit = PaymentMetadata {
 lsps2_parameters: Some(LSPS2Parameters {
 max_total_opening_fee_msat: None,
 max_proportional_opening_fee_ppm_msat: None,
 }),
 lsps2_bolt12_invoice_parameters: None,
 }
 .encode();

Expand Down

4 changes: 2 additions & 2 deletions
src/io/vss_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use bitcoin::bip32::{ChildNumber, Xpriv};
use bitcoin::hashes::{sha256, Hash, HashEngine, Hmac, HmacEngine};
use bitcoin::key::Secp256k1;
use bitcoin::Network;
use lightning::impl_writeable_tlv_based_enum;
use lightning::impl_ser_tlv_based_enum;
use lightning::io::{self, Error, ErrorKind};
use lightning::sign::{EntropySource as LdkEntropySource, RandomBytes};
use lightning::util::persist::KVStore;
Expand DownExpand Up@@ -65,7 +65,7 @@ enum VssSchemaVersion {
	V1,
}

impl_writeable_tlv_based_enum!(VssSchemaVersion,
impl_ser_tlv_based_enum!(VssSchemaVersion,
	(0, V0) => {},
	(1, V1) => {},
);
Expand Down
Loading