Change Bolt11Invoice payment_hash function return type#4293

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
TheBlueMatt merged 1 commit into from
Jan 25, 2026
Merged

Change Bolt11Invoice payment_hash function return type #4293

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
9 changes: 5 additions & 4 deletions lightning-invoice/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
}

/// Returns the hash to which we will receive the preimage on completion of the payment
pub fn payment_hash(&self) -> &sha256::Hash {
&self.signed_invoice.payment_hash().expect("checked by constructor").0
pub fn payment_hash(&self) -> PaymentHash {

@TheBlueMattTheBlueMattJan 6, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.

@psychemistpsychemistJan 7, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@TheBlueMatt on it

let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
PaymentHash(hash.to_byte_array())
}

/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
sha256::Hash::from_slice(&[3; 32][..]).unwrap()
))
);
assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down
14 changes: 7 additions & 7 deletions lightning-liquidity/tests/lsps2_integration_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
.node
.pay_for_bolt11_invoice(
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
PaymentId(invoice.payment_hash().0),
None,
Default::default(),
Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
.node
.pay_for_bolt11_invoice(
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
PaymentId(invoice.payment_hash().0),
None,
Default::default(),
Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
*requested_next_hop_scid,
*intercept_id,
*expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
invoice.payment_hash(),
)
.unwrap();
},
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
.node
.pay_for_bolt11_invoice(
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
PaymentId(invoice.payment_hash().0),
None,
Default::default(),
Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
*requested_next_hop_scid,
*intercept_id,
*expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
invoice.payment_hash(),
)
.unwrap();
},
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
match &client_events[0] {
Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
assert_eq!(*payment_hash, invoice.payment_hash());
},
_ => panic!("Unexpected failure_type: {:?}", failure_type),
},
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
.node
.pay_for_bolt11_invoice(
&invoice,
PaymentId(invoice.payment_hash().to_byte_array()),
PaymentId(invoice.payment_hash().0),
None,
Default::default(),
Retry::Attempts(3),
Expand Down
8 changes: 4 additions & 4 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down
9 changes: 4 additions & 5 deletions lightning/src/ln/invoice_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
use crate::util::test_utils;
use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hashes::{sha256, Hash};
use bitcoin::hashes::Hash;
use bitcoin::network::Network;
use core::time::Duration;
use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
invoice.description(),
Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
);
assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
assert_eq!(invoice.payment_hash(), payment_hash);
}

#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
Duration::from_secs(genesis_timestamp),
)
.unwrap();
let (payment_hash, payment_secret) =
(PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
let payment_preimage = if user_generated_pmt_hash {
user_payment_preimage
} else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
invoice.amount_milli_satoshis().unwrap(),
);

let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
let payment_hash = invoice.payment_hash();
let id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/outbound_payment.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
IH: Fn() -> InFlightHtlcs,
SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
{
let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
let payment_hash = invoice.payment_hash();

let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
(Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Change Bolt11Invoice payment_hash function return type#4293

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

TheBlueMatt
merged 1 commit into

from

Jan 25, 2026
 Merged


Change Bolt11Invoice payment_hash function return type
#4293
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


9 changes: 5 additions & 4 deletions
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,7 +54,7 @@ use core::time::Duration;
use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};

#[doc(no_inline)]
pub use lightning_types::payment::PaymentSecret;
pub use lightning_types::payment::{PaymentHash, PaymentSecret};
#[doc(no_inline)]
pub use lightning_types::routing::{RouteHint, RouteHintHop, RoutingFees};
use lightning_types::string::UntrustedString;
Expand DownExpand Up@@ -1460,8 +1460,9 @@ impl Bolt11Invoice {
	}

	/// Returns the hash to which we will receive the preimage on completion of the payment
	pub fn payment_hash(&self) -> &sha256::Hash {
 &self.signed_invoice.payment_hash().expect("checked by constructor").0
	pub fn payment_hash(&self) -> PaymentHash {
@TheBlueMattTheBlueMattJan 6, 2026

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Please change the field on the raw invoices as well and in TaggedField.
@psychemistpsychemistJan 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@TheBlueMatt on it
 let hash = self.signed_invoice.payment_hash().expect("checked by constructor").0;
 PaymentHash(hash.to_byte_array())
	}

	/// Return the description or a hash of it for longer ones
Expand DownExpand Up@@ -2339,7 +2340,7 @@ mod test {
 sha256::Hash::from_slice(&[3; 32][..]).unwrap()
 ))
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21; 32][..]).unwrap());
 assert_eq!(invoice.payment_hash(), PaymentHash([21; 32]));
 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));

 let mut expected_features = Bolt11InvoiceFeatures::empty();
Expand Down

14 changes: 7 additions & 7 deletions
lightning-liquidity/tests/lsps2_integration_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1211,7 +1211,7 @@ fn client_trusts_lsp_end_to_end_test() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1684,7 +1684,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1714,7 +1714,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1875,7 +1875,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand DownExpand Up@@ -1905,7 +1905,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
 *requested_next_hop_scid,
 *intercept_id,
 *expected_outbound_amount_msat,
PaymentHash(invoice.payment_hash().to_byte_array()),
 invoice.payment_hash(),
 )
 .unwrap();
 },
Expand DownExpand Up@@ -1984,7 +1984,7 @@ fn htlc_timeout_before_client_claim_results_in_handling_failed() {
	match &client_events[0] {
 Event::HTLCHandlingFailed { failure_type, .. } => match failure_type {
 lightning::events::HTLCHandlingFailureType::Receive { payment_hash } => {
 assert_eq!(*payment_hash, PaymentHash(invoice.payment_hash().to_byte_array()));
 assert_eq!(*payment_hash, invoice.payment_hash());
 },
 _ => panic!("Unexpected failure_type: {:?}", failure_type),
 },
Expand DownExpand Up@@ -2212,7 +2212,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
 .node
 .pay_for_bolt11_invoice(
 &invoice,
 PaymentId(invoice.payment_hash().to_byte_array()),
 PaymentId(invoice.payment_hash().0),
 None,
 Default::default(),
 Retry::Attempts(3),
Expand Down

8 changes: 4 additions & 4 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2230,23 +2230,23 @@ where
/// match event {
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claiming payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
/// println!("Unknown payment hash: {}", payment_hash);
/// },
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
/// assert_ne!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_ne!(payment_hash, invoice.payment_hash());
/// println!("Claiming spontaneous payment {}", payment_hash);
/// channel_manager.claim_funds(payment_preimage);
/// },
/// // ...
/// # _ => {},
/// },
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
/// assert_eq!(payment_hash.0, invoice.payment_hash().as_ref());
/// assert_eq!(payment_hash, invoice.payment_hash());
/// println!("Claimed {} msats", amount_msat);
/// },
/// // ...
Expand All@@ -2271,7 +2271,7 @@ where
/// # ) {
/// # let channel_manager = channel_manager.get_cm();
/// # let payment_id = PaymentId([42; 32]);
/// # let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
/// # let payment_hash = invoice.payment_hash();
/// match channel_manager.pay_for_bolt11_invoice(
/// invoice, payment_id, None, route_params_config, retry
/// ) {
Expand Down

9 changes: 4 additions & 5 deletions
lightning/src/ln/invoice_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -627,7 +627,7 @@ mod test {
	use crate::util::dyn_signer::{DynKeysInterface, DynPhantomKeysInterface};
	use crate::util::test_utils;
	use bitcoin::hashes::sha256::Hash as Sha256;
	use bitcoin::hashes::{sha256, Hash};
	use bitcoin::hashes::Hash;
	use bitcoin::network::Network;
	use core::time::Duration;
	use lightning_invoice::{
Expand DownExpand Up@@ -829,7 +829,7 @@ mod test {
 invoice.description(),
 Bolt11InvoiceDescriptionRef::Direct(&Description::new("test".to_string()).unwrap())
 );
 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&payment_hash.0[..]).unwrap());
 assert_eq!(invoice.payment_hash(), payment_hash);
	}

	#[cfg(not(feature = "std"))]
Expand DownExpand Up@@ -1257,8 +1257,7 @@ mod test {
 Duration::from_secs(genesis_timestamp),
 )
 .unwrap();
 let (payment_hash, payment_secret) =
 (PaymentHash(invoice.payment_hash().to_byte_array()), *invoice.payment_secret());
 let (payment_hash, payment_secret) = (invoice.payment_hash(), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
 user_payment_preimage
 } else {
Expand DownExpand Up@@ -1290,7 +1289,7 @@ mod test {
 invoice.amount_milli_satoshis().unwrap(),
 );

 let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 let payment_hash = invoice.payment_hash();
 let id = PaymentId(payment_hash.0);
 let onion = RecipientOnionFields::secret_only(*invoice.payment_secret());
 nodes[0].node.send_payment(payment_hash, onion, id, params, Retry::Attempts(0)).unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ where
 IH: Fn() -> InFlightHtlcs,
 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
	{
 let payment_hash = PaymentHash((*invoice.payment_hash()).to_byte_array());
 let payment_hash = invoice.payment_hash();

 let amount = match (invoice.amount_milli_satoshis(), amount_msats) {
 (Some(amt), None) | (None, Some(amt)) => amt,
Expand Down
Loading