Skip to content
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

refactored payment_parameters_from_zero_amount_invoice to amount-less #2979

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactored payment_parameters_from_zero_amount_invoice to amount-less #2979

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions lightning-invoice/src/payment.rs
View file
Open in desktop
Expand Up @@ -17,7 +17,7 @@ use lightning::ln::channelmanager::RecipientOnionFields;
use lightning::routing::router::{PaymentParameters, RouteParameters};

/// Builds the necessary parameters to pay or pre-flight probe the given zero-amount
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Builds the necessary parameters to pay or pre-flight probe the given zero-amount
/// Builds the necessary parameters to pay or pre-flight probe the given

and then wrap so lines are 100chars.

/// [`Bolt11Invoice`] using [`ChannelManager::send_payment`] or
/// amountless (sometimes referred to as zero-amount) [`Bolt11Invoice`] using [`ChannelManager::send_payment`] or
Copy link
Collaborator

Choose a reason for hiding this comment

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

This now reads "zero-amount amountless (sometimes referred to as zero-amount)"

/// [`ChannelManager::send_preflight_probes`].
///
/// Prior to paying, you must ensure that the [`Bolt11Invoice::payment_hash`] is unique and the
Expand All @@ -28,7 +28,7 @@ use lightning::routing::router::{PaymentParameters, RouteParameters};
///
/// [`ChannelManager::send_payment`]: lightning::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::send_preflight_probes`]: lightning::ln::channelmanager::ChannelManager::send_preflight_probes
pub fn payment_parameters_from_zero_amount_invoice(invoice: &Bolt11Invoice, amount_msat: u64)
pub fn payment_parameters_from_amountless_invoice(invoice: &Bolt11Invoice, amount_msat: u64)
-> Result<(PaymentHash, RecipientOnionFields, RouteParameters), ()> {
if invoice.amount_milli_satoshis().is_some() {
Err(())
Expand All @@ -44,7 +44,7 @@ pub fn payment_parameters_from_zero_amount_invoice(invoice: &Bolt11Invoice, amou
/// same [`PaymentHash`] has never been paid before.
///
/// Will always succeed unless the invoice has no amount specified, in which case
/// [`payment_parameters_from_zero_amount_invoice`] should be used.
/// [`payment_parameters_from_amountless_invoice`] should be used.
///
/// [`ChannelManager::send_payment`]: lightning::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::send_preflight_probes`]: lightning::ln::channelmanager::ChannelManager::send_preflight_probes
Expand Down Expand Up @@ -120,7 +120,7 @@ mod tests {
})
.unwrap();

assert!(payment_parameters_from_zero_amount_invoice(&invoice, 42).is_err());
assert!(payment_parameters_from_amountless_invoice(&invoice, 42).is_err());

let (hash, onion, params) = payment_parameters_from_invoice(&invoice).unwrap();
assert_eq!(&hash.0[..], &payment_hash[..]);
Expand Down Expand Up @@ -154,7 +154,7 @@ mod tests {

assert!(payment_parameters_from_invoice(&invoice).is_err());

let (hash, onion, params) = payment_parameters_from_zero_amount_invoice(&invoice, 42).unwrap();
let (hash, onion, params) = payment_parameters_from_amountless_invoice(&invoice, 42).unwrap();
assert_eq!(&hash.0[..], &payment_hash[..]);
assert_eq!(onion.payment_secret, Some(PaymentSecret([0; 32])));
assert_eq!(params.final_value_msat, 42);
Expand Down