-
Notifications
You must be signed in to change notification settings - Fork 419
Deprecate pay_for_offer_from_human_readable_name
#4083
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.
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
Deprecate pay_for_offer_from_human_readable_name
#4083
Conversation
👋 Thanks for assigning @tnull as a reviewer! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, thanks!
👋 The first review has been submitted! Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer. |
While its cool to have a super trivial API to initiate payment to a `HumanReadableName`, most wallets ultimately support multiple payment instruction formats (eg on-chain) or multiple HRN resolution schemes (eg LN-Address). Thus, we generally don't expect this API to get a lot of use. Meanwhile, we've now ended up with both a `ChannelManager::pay_for_offer_from_hrn` and `ChannelManager::pay_for_ofer_from_human_readable_name`, which is incredibly confusing. Here, we deprecate `pay_for_offer_from_human_readable_name`, pushing folks to the `bitcoin-payment-instructions` crate instead. Because it has outbound payment states associated with it it may be some time before we can fully remove all the pieces of it, sadly.
ab4e768
to
cface29
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4083 +/- ##
==========================================
- Coverage 88.60% 88.60% -0.01%
==========================================
Files 176 176
Lines 132086 132086
Branches 132086 132086
==========================================
- Hits 117041 117040 -1
+ Misses 12376 12372 -4
- Partials 2669 2674 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CI failure seems unrelated: #4085 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, simple enough
While its cool to have a super trivial API to initiate payment to a
HumanReadableName
, most wallets ultimately support multiple payment instruction formats (eg on-chain) or multiple HRN resolution schemes (eg LN-Address). Thus, we generally don't expect this API to get a lot of use.Meanwhile, we've now ended up with both a
ChannelManager::pay_for_offer_from_hrn
andChannelManager::pay_for_ofer_from_human_readable_name
, which is incredibly confusing.Here, we deprecate
pay_for_offer_from_human_readable_name
, pushing folks to thebitcoin-payment-instructions
crate instead. Because it has outbound payment states associated with it it may be some time before we can fully remove all the pieces of it, sadly.