Skip to content

Refactor unified_qr.rs to use bitcoin-payment-instructions #666

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

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Refactor unified_qr.rs to use bitcoin-payment-instructions #666

wants to merge 9 commits into from
+302 −125

Conversation

chuksys
Copy link

@chuksys chuksys commented Oct 16, 2025 •
edited
Loading

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

@chuksys
Rename unified_qr to unified
b16c311 
This rename reflects that this module is a unified payment interface for both QR code payments and HRN payments passed in as a string without scanning a QR code
@chuksys
rename UnifiedQRPayment to UnifiedPayment, rename QRPaymentResult to …
7b56717 
…UnifiedPaymentResult

These renamings are necessary to reflect the expanded responsibilities for this module.
@chuksys
add bitcoin-payment-instructions to cargo.toml
6dd41e2
@chuksys
Add hrn_resolver to Node and pass into UnifiedPayment
7a41664 
This commit adds a HRN Resolver to the Node struct which will be useful for resolving HRNs when making BIP 353 payments. It also passes the HRN Resolver into UnifiedPayment.
@chuksys
Refactor unified.rs to support sending to BIP 21 URIs as well as BIP …
2489eae 
…353 HRNs
@chuksys
Fix typo in unified_payment send test and improve test name.
72454ad
@chuksys
Switch to explicit imports in unified.rs mod tests
ed2afda
@chuksys
Use the pay_for_offer_from_hrn method from LDK upstream
2c8c06b 
This commit ensures that when using the unified API to send to a HRN, we use pay_for_offer_from_hrn
@chuksys
Fix formatting issues after rebase
a6dab4e
@ldk-reviews-bot
Copy link

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

I've assigned @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 ldk-reviews-bot requested a review from tnull October 16, 2025 14:09
@ldk-reviews-bot
Copy link

🔔 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tnull tnull Awaiting requested review from tnull

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Switch to use bitcoin-payment-instructions

2 participants

@chuksys @ldk-reviews-bot