Refactor unified_qr.rs to use bitcoin-payment-instructions by chuksys · Pull Request #666 · lightningdevkit/ldk-node

chuksys · 2025-10-16T13:59:32Z

This PR is a continuation of #607 which was closed mistakenly when the develop base branch was deleted.

This PR introduces a unified.rs module (which is a refactor of the unified_qr.rs module) - this refactor allows us to use this module as a single API for sending payments to BIP 21/321 URIs as well as BIP 353 HRNs, creating a simpler interface for users.

https://github.com/rust-bitcoin/bitcoin-payment-instructions is used to parse BIP 21/321 URIs as well as the BIP 353 HRNs.

Changes

The unified_qr.rs module has been renamed to unified.rs.
The UnifiedQrPayment struct has been renamed to UnifiedPayment.
The QRPaymentResult enum has been renamed to UnifiedPaymentResult.
The send method in unified.rs now supports sending to both BIP 21/321 URIs as well as BIP 353 HRNs.
The integration tests for the module have been updated accordingly.

This PR closes#521 and #435

ldk-reviews-bot · 2025-10-16T13:59:35Z

👋 Thanks for assigning @tnull as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

ldk-reviews-bot · 2025-10-18T14:10:17Z

🔔 1st Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-10-20T14:10:53Z

🔔 2nd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-10-22T14:11:33Z

🔔 3rd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-10-25T00:00:21Z

🔔 4th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-10-27T00:01:03Z

🔔 5th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-10-29T00:01:49Z

🔔 6th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

tnull

This needs a rebase by now, sorry!

tnull · 2025-11-03T13:51:13Z

This need a rebase now.

tnull

Alright, now that we published v0.7.0-rc.0 and branched off release/0.7 we should ready to move forward with this as soon as bitcoin-payment-instructions supporting the new LDK version is released.

To this end, please rebase this PR and clean up the commit history. In particular, please avoid line wrapping for the first line in the commit description and also clearly describe the what, how and why for each change in the commit descriptions. Please refer to https://cbea.ms/git-commit/ for guidance on how to write good commit messages.

tnull · 2025-11-19T12:09:40Z

-pub use crate::payment::QrPaymentResult;
+pub use crate::payment::UnifiedPaymentResult;
+
+pub use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;


I don't think we want to expose the LdkHumanReadableName variant, this is just an internal type alias, no?

tnull · 2025-11-19T12:10:07Z

+}
+
+impl HumanReadableName {
+	pub fn into_inner(&self) -> LdkHumanReadableName {


This shouldn't be pub, and I think we can simply inline this into impl From<HumanReadableName> for LdkHumanReadableName?

tnull · 2025-11-19T12:10:35Z

+ self.inner.clone()
+	}
+
+	pub fn from_encoded(encoded: &str) -> Result<Self, Error> {


Please provide docs on all public methods. Feel free to copy them over from the LDK counterpart.

tnull · 2025-11-19T12:15:51Z

 	pub fn send_using_amount(
 &self, offer: &Offer, amount_msat: u64, quantity: Option<u64>, payer_note: Option<String>,
- route_parameters: Option<RouteParametersConfig>,
+ route_parameters: Option<RouteParametersConfig>, hrn: Option<HumanReadableName>,


I don't think we should change the public API here. Please create a pub(crate) send_using_amount_inner method that you can use here and that is simply used with None for the hrn parameter here in send_using_amount.

tnull · 2025-11-19T12:18:33Z

+ },
+ };
+
+ if let Some(PaymentMethod::LightningBolt12(offer)) =


Why not simply use a match instead of if let Some(..) = .. matches!`?

Seems this wasn't addressed?

chuksys · 2025-11-25T18:20:44Z

Just pushed some changes. Currently fixing the issue that's making CI fail.

chuksys · 2025-11-30T02:36:12Z

Currently fixing the issue that's making CI fail.

Fixed the issue. Current CI failure seems to be unrelated.

ldk-reviews-bot · 2025-12-02T02:36:35Z

🔔 1st Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-04T02:37:35Z

🔔 2nd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-06T02:38:04Z

🔔 3rd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-10T02:39:48Z

🔔 5th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-13T00:00:38Z

🔔 6th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-15T00:00:54Z

🔔 7th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

tnull

I think this is finally unblocked. Please rebase and update the bitcoin-payment-instructions dependency.

tnull · 2025-12-15T08:52:59Z


 vss-client = { package = "vss-client-ng", version = "0.4" }
 prost = { version = "0.11.6", default-features = false}
+#bitcoin-payment-instructions = { version = "0.5" }


bitcoin-payment-instructions v0.6 has been released last week, please bump the dependency here and remove your fork.

tnull · 2025-12-15T08:54:29Z

+//! [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
 //! [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 //! [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
+use crate::error::Error;


All these import reordering changes seem unrelated. Please drop them.

tnull · 2025-12-15T08:55:43Z

+//! Holds a payment handler allowing to create [BIP 21] URIs with on-chain, [BOLT 11], and [BOLT 12] payment
 //! options.
 //!
+//! Also allows to send payments using these URIs as well as [BIP 353] HRNs.


This sentence has a double 'also'/'as well as'. Should it just say 'Also allows to pay to [BIP 353] human readable names'?

This seems still unaddressed. Please spell out 'human readable names'.

tnull · 2025-12-15T08:55:59Z

-/// Should be retrieved by calling [`Node::unified_qr_payment`]
+/// Should be retrieved by calling [`Node::unified_payment`]
+///
+/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.


Same here, see comment above.

tnull · 2025-12-15T08:56:17Z

 let uri: bip21::Uri<NetworkUnchecked, Extras> =
 uri_str.parse().map_err(|_| Error::InvalidUri)?;

+ let _resolver = &self.hrn_resolver;


This seems unused?

tnull · 2025-12-15T08:57:19Z


 use bitcoin::secp256k1::PublicKey;
 use bitcoin::OutPoint;
+use bitcoin_payment_instructions::onion_message_resolver::LDKOnionMessageDNSSECHrnResolver;


nit: Please maintain the import grouping here.

tnull · 2025-12-15T08:59:38Z

+ },
+ };
+
+ if let Some(PaymentMethod::LightningBolt12(offer)) =


Seems this wasn't addressed?

ldk-reviews-bot · 2025-12-20T11:08:31Z

🔔 1st Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-22T11:09:11Z

🔔 2nd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-24T11:10:00Z

🔔 3rd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-27T00:00:53Z

🔔 4th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-29T00:01:25Z

🔔 5th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2025-12-31T00:02:24Z

🔔 6th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2026-01-03T00:00:26Z

🔔 7th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

ldk-reviews-bot · 2026-01-05T00:01:16Z

🔔 8th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

tnull

Generally looks good, but it seems some changes were squashed into entirely unrelated commits. Please either rewrite the commit history, or, as a last resort, just squash all in one commit to get this ready to be merged.

tnull · 2026-01-05T11:49:14Z

+//! Holds a payment handler allowing to create [BIP 21] URIs with on-chain, [BOLT 11], and [BOLT 12] payment
 //! options.
 //!
+//! Also allows to send payments using these URIs as well as [BIP 353] HRNs.


This seems still unaddressed. Please spell out 'human readable names'.

tnull

There are still a few changes happening in the wrong/follow-up commits. Mind just squashing all into one so we can land this? I'll then address some of my outstanding minor comments myself in a quick follow-up PR if you don't mind.

tnull · 2026-01-06T08:09:25Z

+//! Holds a payment handler allowing to create [BIP 21] URIs with on-chain, [BOLT 11], and [BOLT 12] payment
 //! options.
 //!
+//! It also supports sending payments to these URIs as well as to [BIP 353] Human-Readable Names.


I'm confused: this was updated, but (here and elsewhere) still has the redundant "also .. to these URIs as well as" parts in it? The new changes also happen in the wrong (i.e., following commits).

tnull · 2026-01-06T08:14:23Z

-pub use crate::payment::QrPaymentResult;
+pub use crate::payment::UnifiedPaymentResult;
+
+pub use lightning::onion_message::dns_resolution::HumanReadableName as LdkHumanReadableName;


This still first exposes this as pub, only to change it again in a follow-up commit.

tnull · 2026-01-06T08:16:52Z


 #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
-async fn unified_qr_send_receive() {
+async fn unified_send_receive_qr_uri() {


Not quite sure if that test name is much of an improvement? Do we even still want to refer to QR codes here if we otherwise stopped doing so?

tnull · 2026-01-06T08:18:15Z

 	}
 }
-
-/// Represents the result of a payment made using a [BIP 21] QR code.


Not sure why this was dropped entirely instead of adjusting it to reflect the new role?

Refactor the unified_qr.rs module into unified.rs to provide a single API for sending payments to BIP 21/321 URIs and BIP 353 HRNs. This change simplifies the user interface by leveraging the bitcoin-payment-instructions library for parsing. Key changes: - Rename UnifiedQrPayment to UnifiedPayment. - Rename QRPaymentResult to UnifiedPaymentResult. - Update the send method to support both URIs and HRNs. - Update integration tests to match the new unified flow.

chuksys · 2026-01-06T09:40:28Z

There are still a few changes happening in the wrong/follow-up commits. Mind just squashing all into one so we can land this? I'll then address some of my outstanding minor comments myself in a quick follow-up PR if you don't mind.

Done! I've squashed the history into a single clean commit and updated the commit message to reflect the final state of the refactor. Ready for another look/merge.

CI failure seems unrelated

…ns-follow-up Minor follow-ups to #666

ldk-reviews-bot requested a review from tnull October 16, 2025 14:09

chuksys mentioned this pull request Oct 21, 2025
BOLT 12 / BIP 353 reez/Monday#205
Open

tnull reviewed Oct 30, 2025
View reviewed changes

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 2 times, most recently from 1e7d616 to 3e30347Compare November 2, 2025 22:28

tnull mentioned this pull request Nov 3, 2025
Add support for resolving BIP 353 Human-Readable Names #630
Merged

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 2 times, most recently from a8ed274 to 4abb530Compare November 15, 2025 12:29

tnull reviewed Nov 19, 2025
View reviewed changes

tnull added this to the 0.8 milestone Nov 19, 2025

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 2 times, most recently from ac99cf6 to ed451bbCompare November 25, 2025 17:37

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 3 times, most recently from 9afbd37 to 71d7ef6Compare November 30, 2025 02:09

chuksys requested a review from tnull November 30, 2025 02:36

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch from 71d7ef6 to 4265a63Compare December 3, 2025 13:13

tnull reviewed Dec 15, 2025
View reviewed changes

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 3 times, most recently from 4c098ca to 60b938bCompare December 16, 2025 13:12

chuksys requested a review from tnull December 18, 2025 11:08

tnull reviewed Jan 5, 2026
View reviewed changes

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch 2 times, most recently from 6afa631 to b12347fCompare January 5, 2026 20:36

chuksys requested a review from tnull January 5, 2026 22:29

tnull reviewed Jan 6, 2026
View reviewed changes

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch from b12347f to ab230d6Compare January 6, 2026 09:17

chuksys force-pushed the refactor/adopt-bitcoin-payment-instructions branch from ab230d6 to d47958aCompare January 6, 2026 09:20

chuksys requested a review from tnull January 6, 2026 09:41

tnull approved these changes Jan 6, 2026
View reviewed changes

tnull merged commit 690d1f4 into lightningdevkit:mainJan 6, 2026
17 of 19 checks passed

tnull mentioned this pull request Jan 6, 2026
Minor follow-ups to #666 #740
Merged

tnull added a commit that referenced this pull request Jan 9, 2026
Merge pull request#740from tnull/2026-01-bitcoin-payment-instructio…
1f51948
…ns-follow-up Minor follow-ups to #666

Uh oh!

Conversation

chuksys commented Oct 16, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ldk-reviews-bot commented Oct 16, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ldk-reviews-bot commented Oct 18, 2025

Uh oh!

ldk-reviews-bot commented Oct 20, 2025

Uh oh!

ldk-reviews-bot commented Oct 22, 2025

Uh oh!

ldk-reviews-bot commented Oct 25, 2025

Uh oh!

ldk-reviews-bot commented Oct 27, 2025

Uh oh!

ldk-reviews-bot commented Oct 29, 2025

Uh oh!

tnull left a comment

Choose a reason for hiding this comment

Uh oh!

tnull commented Nov 3, 2025

Uh oh!

tnull left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chuksys commented Nov 25, 2025

Uh oh!

chuksys commented Nov 30, 2025

Uh oh!

ldk-reviews-bot commented Dec 2, 2025

Uh oh!

ldk-reviews-bot commented Dec 4, 2025

Uh oh!

ldk-reviews-bot commented Dec 6, 2025

Uh oh!

ldk-reviews-bot commented Dec 10, 2025

Uh oh!

ldk-reviews-bot commented Dec 13, 2025

Uh oh!

ldk-reviews-bot commented Dec 15, 2025

Uh oh!

tnull left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ldk-reviews-bot commented Dec 20, 2025

Uh oh!

ldk-reviews-bot commented Dec 22, 2025

Uh oh!

ldk-reviews-bot commented Dec 24, 2025

chuksys commented Oct 16, 2025•
edited
Loading

ldk-reviews-bot commented Oct 16, 2025•
edited
Loading

tnull left a comment •
edited
Loading