mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 23:08:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3397 from vincenzopalazzo/macros/amount-less-refactoring

Browse source 
[RFC] rename pay_parameters for no amount invoice
This commit is contained in:
Matt Corallo 2024-11-07 22:13:57 +00:00 • committed by GitHub
commit 5718baaed9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lightning/src/ln/bolt11_payment.rs
View file

@ -16,9 +16,9 @@ use crate::ln::channelmanager::RecipientOnionFields;
use crate::routing::router::{PaymentParameters, RouteParameters};
use crate::types::payment::PaymentHash;
/// Builds the necessary parameters to pay or pre-flight probe the given zero-amount
/// [`Bolt11Invoice`] using [`ChannelManager::send_payment`] or
/// [`ChannelManager::send_preflight_probes`].
/// Builds the necessary parameters to pay or pre-flight probe the given variable-amount
/// (also known as 'zero-amount') [`Bolt11Invoice`] using
/// [`ChannelManager::send_payment`] or [`ChannelManager::send_preflight_probes`].
///
/// Prior to paying, you must ensure that the [`Bolt11Invoice::payment_hash`] is unique and the
/// same [`PaymentHash`] has never been paid before.
@ -28,7 +28,7 @@ use crate::types::payment::PaymentHash;
///
/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::send_preflight_probes`]: crate::ln::channelmanager::ChannelManager::send_preflight_probes
pub fn payment_parameters_from_zero_amount_invoice(
pub fn payment_parameters_from_variable_amount_invoice(
invoice: &Bolt11Invoice, amount_msat: u64,
) -> Result<(PaymentHash, RecipientOnionFields, RouteParameters), ()> {
if invoice.amount_milli_satoshis().is_some() {
@ -45,7 +45,7 @@ pub fn payment_parameters_from_zero_amount_invoice(
/// 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_variable_amount_invoice`] should be used.
///
/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::send_preflight_probes`]: crate::ln::channelmanager::ChannelManager::send_preflight_probes
@ -112,7 +112,7 @@ mod tests {
.build_signed(|hash| secp_ctx.sign_ecdsa_recoverable(hash, &private_key))
.unwrap();
assert!(payment_parameters_from_zero_amount_invoice(&invoice, 42).is_err());
assert!(payment_parameters_from_variable_amount_invoice(&invoice, 42).is_err());
let (hash, onion, params) = payment_parameters_from_invoice(&invoice).unwrap();
assert_eq!(&hash.0[..], &payment_hash[..]);
@ -146,7 +146,7 @@ mod tests {
assert!(payment_parameters_from_invoice(&invoice).is_err());
let (hash, onion, params) =
payment_parameters_from_zero_amount_invoice(&invoice, 42).unwrap();
payment_parameters_from_variable_amount_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);