Skip to content

Support passing preimage for spontaneous payments#549

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tnull merged 1 commit into from
Aug 13, 2025
Merged

Support passing preimage for spontaneous payments #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
[Throws=NodeError]
PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
[Throws=NodeError]
PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.
PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
[Throws=NodeError]
void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down
26 changes: 22 additions & 4 deletions src/payment/spontaneous.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
pub fn send(
&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
) -> Result<PaymentId, Error> {
self.send_inner(amount_msat, node_id, sending_parameters, None)
self.send_inner(amount_msat, node_id, sending_parameters, None, None)
}

/// Send a spontaneous payment including a list of custom TLVs.
pub fn send_with_custom_tlvs(
&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
custom_tlvs: Vec<CustomTlvRecord>,
) -> Result<PaymentId, Error> {
self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
}

/// Send a spontaneous payment with custom preimage
pub fn send_with_preimage(
&self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
sending_parameters: Option<SendingParameters>,
) -> Result<PaymentId, Error> {
self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
}

/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
pub fn send_with_preimage_and_custom_tlvs(
&self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
) -> Result<PaymentId, Error> {
self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
}

fn send_inner(
&self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
custom_tlvs: Option<Vec<CustomTlvRecord>>,
custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
) -> Result<PaymentId, Error> {
let rt_lock = self.runtime.read().unwrap();
if rt_lock.is_none() {
return Err(Error::NotRunning);
}

let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
let payment_preimage = preimage
.unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

let payment_hash = PaymentHash::from(payment_preimage);
let payment_id = PaymentId(payment_hash.0);

Expand Down
72 changes: 70 additions & 2 deletions tests/integration_tests_rust.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
SendingParameters,
ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
validate_log_entry(entry);
}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
let chain_source = TestChainSource::Esplora(&electrsd);
let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

let address_a = node_a.onchain_payment().new_address().unwrap();
let premine_sat = 1_000_000;
premine_and_distribute_funds(
&bitcoind.client,
&electrsd.client,
vec![address_a],
Amount::from_sat(premine_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
open_channel(&node_a, &node_b, 500_000, true, &electrsd);
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
expect_channel_ready_event!(node_a, node_b.node_id());
expect_channel_ready_event!(node_b, node_a.node_id());

let seed = b"test_payment_preimage";
let bytes: Sha256Hash = Sha256Hash::hash(seed);
let custom_bytes = bytes.to_byte_array();
let custom_preimage = PaymentPreimage(custom_bytes);

let amount_msat = 100_000;
let payment_id = node_a
.spontaneous_payment()
.send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
.unwrap();

// check payment status and verify stored preimage
expect_payment_successful_event!(node_a, Some(payment_id), None);
let details: PaymentDetails =
node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
assert_eq!(details.status, PaymentStatus::Succeeded);
if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
assert_eq!(pi.0, custom_bytes);
} else {
panic!("Expected a spontaneous PaymentKind with a preimage");
}

// Verify receiver side (node_b)
expect_payment_received_event!(node_b, amount_msat);
let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
p.direction == PaymentDirection::Inbound
&& matches!(p.kind, PaymentKind::Spontaneous { .. })
});

assert_eq!(receiver_payments.len(), 1);
let receiver_details = &receiver_payments[0];
assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
assert_eq!(receiver_details.amount_msat, Some(amount_msat));
assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

// Verify receiver also has the same preimage
if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
assert_eq!(pi.0, custom_bytes);
} else {
panic!("Expected receiver to have spontaneous PaymentKind with preimage");
}
}
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" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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('^' + ".*" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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('^' + ".*" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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('^' + ".*" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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('^' + ".*" + '
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
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); }
})();
})();
Support passing preimage for spontaneous payments by aagbotemi · Pull Request #549 · lightningdevkit/ldk-node · GitHub
Skip to content
Support passing preimage for spontaneous payments#549

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Aug 13, 2025
 Merged


Support passing preimage for spontaneous payments
#549
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,6 +213,10 @@ interface SpontaneousPayment {
	[Throws=NodeError]
	PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, SendingParameters? sending_parameters, sequence<CustomTlvRecord> custom_tlvs);
	[Throws=NodeError]
	PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
Comment thread
tnull marked this conversation as resolved.

	PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, SendingParameters? sending_parameters);
	[Throws=NodeError]
	void send_probes(u64 amount_msat, PublicKey node_id);
};

Expand Down

26 changes: 22 additions & 4 deletions
src/payment/spontaneous.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,27 +57,45 @@ impl SpontaneousPayment {
	pub fn send(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None)
 self.send_inner(amount_msat, node_id, sending_parameters, None, None)
	}

	/// Send a spontaneous payment including a list of custom TLVs.
	pub fn send_with_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Vec<CustomTlvRecord>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs))
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), None)
	}

	/// Send a spontaneous payment with custom preimage
	pub fn send_with_preimage(
 &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage,
 sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, None, Some(preimage))
	}

	/// Send a spontaneous payment with custom preimage including a list of custom TLVs.
	pub fn send_with_preimage_and_custom_tlvs(
 &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>,
 preimage: PaymentPreimage, sending_parameters: Option<SendingParameters>,
	) -> Result<PaymentId, Error> {
 self.send_inner(amount_msat, node_id, sending_parameters, Some(custom_tlvs), Some(preimage))
	}

	fn send_inner(
 &self, amount_msat: u64, node_id: PublicKey, sending_parameters: Option<SendingParameters>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>,
 custom_tlvs: Option<Vec<CustomTlvRecord>>, preimage: Option<PaymentPreimage>,
	) -> Result<PaymentId, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
 return Err(Error::NotRunning);
 }

 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_preimage = preimage
 .unwrap_or_else(|| PaymentPreimage(self.keys_manager.get_secure_random_bytes()));

 let payment_hash = PaymentHash::from(payment_preimage);
 let payment_id = PaymentId(payment_hash.0);

Expand Down

72 changes: 70 additions & 2 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,8 +19,8 @@ use common::{
use ldk_node::config::EsploraSyncConfig;
use ldk_node::liquidity::LSPS2ServiceConfig;
use ldk_node::payment::{
	ConfirmationStatus, PaymentDirection, PaymentKind, PaymentStatus, QrPaymentResult,
	SendingParameters,
	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
QrPaymentResult, SendingParameters,
};
use ldk_node::{Builder, Event, NodeError};

Expand All@@ -29,8 +29,10 @@ use lightning::routing::gossip::{NodeAlias, NodeId};
use lightning::util::persist::KVStore;

use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_types::payment::PaymentPreimage;

use bitcoin::address::NetworkUnchecked;
use bitcoin::hashes::sha256::Hash as Sha256Hash;
use bitcoin::hashes::Hash;
use bitcoin::Address;
use bitcoin::Amount;
Expand DownExpand Up@@ -1389,3 +1391,69 @@ fn facade_logging() {
 validate_log_entry(entry);
	}
}

#[test]
fn spontaneous_send_with_custom_preimage() {
	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
	let chain_source = TestChainSource::Esplora(&electrsd);
	let (node_a, node_b) = setup_two_nodes(&chain_source, false, true, false);

	let address_a = node_a.onchain_payment().new_address().unwrap();
	let premine_sat = 1_000_000;
	premine_and_distribute_funds(
 &bitcoind.client,
 &electrsd.client,
 vec![address_a],
 Amount::from_sat(premine_sat),
	);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	open_channel(&node_a, &node_b, 500_000, true, &electrsd);
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	node_a.sync_wallets().unwrap();
	node_b.sync_wallets().unwrap();
	expect_channel_ready_event!(node_a, node_b.node_id());
	expect_channel_ready_event!(node_b, node_a.node_id());

	let seed = b"test_payment_preimage";
	let bytes: Sha256Hash = Sha256Hash::hash(seed);
	let custom_bytes = bytes.to_byte_array();
	let custom_preimage = PaymentPreimage(custom_bytes);

	let amount_msat = 100_000;
	let payment_id = node_a
 .spontaneous_payment()
 .send_with_preimage(amount_msat, node_b.node_id(), custom_preimage, None)
 .unwrap();

	// check payment status and verify stored preimage
	expect_payment_successful_event!(node_a, Some(payment_id), None);
	let details: PaymentDetails =
 node_a.list_payments_with_filter(|p| p.id == payment_id).first().unwrap().clone();
	assert_eq!(details.status, PaymentStatus::Succeeded);
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected a spontaneous PaymentKind with a preimage");
	}

	// Verify receiver side (node_b)
	expect_payment_received_event!(node_b, amount_msat);
	let receiver_payments: Vec<PaymentDetails> = node_b.list_payments_with_filter(|p| {
 p.direction == PaymentDirection::Inbound
 && matches!(p.kind, PaymentKind::Spontaneous { .. })
	});

	assert_eq!(receiver_payments.len(), 1);
	let receiver_details = &receiver_payments[0];
	assert_eq!(receiver_details.status, PaymentStatus::Succeeded);
	assert_eq!(receiver_details.amount_msat, Some(amount_msat));
	assert_eq!(receiver_details.direction, PaymentDirection::Inbound);

	// Verify receiver also has the same preimage
	if let PaymentKind::Spontaneous { preimage: Some(pi), .. } = &receiver_details.kind {
 assert_eq!(pi.0, custom_bytes);
	} else {
 panic!("Expected receiver to have spontaneous PaymentKind with preimage");
	}
}
Loading