← Watch feed
Remove now-redundant PaymentParameters params
Public commit record
68/100 · Adequate
What the developer wrote
Authored by Valentine Wallace
Remove now-redundant PaymentParameters params
In the last commit, we made Route::route_params required instead of an Option.
After this change, we can modify a few methods that took a Route in addition to
a separate PaymentParameters argument, since the pay params can always be
retrieved from the Route now.
✓ Descriptive subject✓ Names a concrete action or component✓ Provides detailed explanatory context
What changed, and why it matters
This is a routine internal code cleanup in the Lightning Dev Kit's payment-sending logic. It removes a now-unnecessary duplicate argument from a few private functions because the same information is already stored inside the Route object. There is no user-facing change and no security fix.
Recommended action
No action required. Treat as normal refactoring.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit refactors OutboundPayments methods (create_pending_payment, add_new_pending_payment, and their callers) to drop the separate Option
Changed components
lightning/src/ln/outbound_payment.rsInspect captured patch +11 / −12
diff --git a/lightning/src/ln/outbound_payment.rs b/lightning/src/ln/outbound_payment.rs
index 6bbe43e..105ee35 100644
--- a/lightning/src/ln/outbound_payment.rs
+++ b/lightning/src/ln/outbound_payment.rs
@@ -1203,14 +1203,13 @@ impl OutboundPayments {
},
};
- let payment_params = Some(route_params.payment_params.clone());
let mut outbounds = self.pending_outbound_payments.lock().unwrap();
let onion_session_privs = match outbounds.entry(payment_id) {
hash_map::Entry::Occupied(entry) => match entry.get() {
PendingOutboundPayment::InvoiceReceived { .. } => {
let (retryable_payment, onion_session_privs) = Self::create_pending_payment(
payment_hash, recipient_onion.clone(), keysend_preimage, None, Some(bolt12_invoice.clone()), &route,
- Some(retry_strategy), payment_params, entropy_source, best_block_height,
+ Some(retry_strategy), entropy_source, best_block_height,
);
*entry.into_mut() = retryable_payment;
onion_session_privs
@@ -1221,7 +1220,7 @@ impl OutboundPayments {
} else { unreachable!() };
let (retryable_payment, onion_session_privs) = Self::create_pending_payment(
payment_hash, recipient_onion.clone(), keysend_preimage, Some(invreq), Some(bolt12_invoice.clone()), &route,
- Some(retry_strategy), payment_params, entropy_source, best_block_height
+ Some(retry_strategy), entropy_source, best_block_height
);
outbounds.insert(payment_id, retryable_payment);
onion_session_privs
@@ -1617,7 +1616,7 @@ impl OutboundPayments {
let onion_session_privs = self.add_new_pending_payment(payment_hash,
recipient_onion.clone(), payment_id, keysend_preimage, &route, Some(retry_strategy),
- Some(route_params.payment_params.clone()), entropy_source, best_block_height, None)
+ entropy_source, best_block_height, None)
.map_err(|_| {
log_error!(logger, "Payment with id {} is already pending. New payment had payment hash {}",
payment_id, payment_hash);
@@ -1940,7 +1939,7 @@ impl OutboundPayments {
let recipient_onion_fields =
RecipientOnionFields::secret_only(payment_secret, route.get_total_amount());
let onion_session_privs = self.add_new_pending_payment(payment_hash,
- recipient_onion_fields.clone(), payment_id, None, &route, None, None,
+ recipient_onion_fields.clone(), payment_id, None, &route, None,
entropy_source, best_block_height, None
).map_err(|e| {
debug_assert!(matches!(e, PaymentSendFailure::DuplicatePayment));
@@ -1996,14 +1995,14 @@ impl OutboundPayments {
&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
- self.add_new_pending_payment(payment_hash, recipient_onion, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height, None)
+ self.add_new_pending_payment(payment_hash, recipient_onion, payment_id, None, route, retry_strategy, entropy_source, best_block_height, None)
}
#[rustfmt::skip]
pub(super) fn add_new_pending_payment<ES: EntropySource>(
&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
- payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32,
+ entropy_source: &ES, best_block_height: u32,
bolt12_invoice: Option<PaidBolt12Invoice>
) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
@@ -2012,7 +2011,7 @@ impl OutboundPayments {
hash_map::Entry::Vacant(entry) => {
let (payment, onion_session_privs) = Self::create_pending_payment(
payment_hash, recipient_onion, keysend_preimage, None, bolt12_invoice, route, retry_strategy,
- payment_params, entropy_source, best_block_height
+ entropy_source, best_block_height
);
entry.insert(payment);
Ok(onion_session_privs)
@@ -2025,7 +2024,7 @@ impl OutboundPayments {
payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
keysend_preimage: Option<PaymentPreimage>, invoice_request: Option<InvoiceRequest>,
bolt12_invoice: Option<PaidBolt12Invoice>, route: &Route, retry_strategy: Option<Retry>,
- payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
+ entropy_source: &ES, best_block_height: u32
) -> (PendingOutboundPayment, Vec<[u8; 32]>) {
let mut onion_session_privs = Vec::with_capacity(route.paths.len());
for _ in 0..route.paths.len() {
@@ -2035,7 +2034,7 @@ impl OutboundPayments {
let mut payment = PendingOutboundPayment::Retryable {
retry_strategy,
attempts: PaymentAttempts::new(),
- payment_params,
+ payment_params: Some(route.route_params.payment_params.clone()),
session_privs: new_hash_set(),
pending_amt_msat: 0,
pending_fee_msat: Some(0),
@@ -2965,7 +2964,7 @@ mod tests {
if on_retry {
outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(0),
PaymentId([0; 32]), None, &Route { paths: vec![], route_params: expired_route_params.clone() },
- Some(Retry::Attempts(1)), Some(expired_route_params.payment_params.clone()),
+ Some(Retry::Attempts(1)),
&&keys_manager, 0, None).unwrap();
outbound_payments.find_route_and_send_payment(
PaymentHash([0; 32]), PaymentId([0; 32]), expired_route_params, &&router, vec![],
@@ -3011,7 +3010,7 @@ mod tests {
if on_retry {
outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(0),
PaymentId([0; 32]), None, &Route { paths: vec![], route_params: route_params.clone() },
- Some(Retry::Attempts(1)), Some(route_params.payment_params.clone()),
+ Some(Retry::Attempts(1)),
&&keys_manager, 0, None).unwrap();
outbound_payments.find_route_and_send_payment(
PaymentHash([0; 32]), PaymentId([0; 32]), route_params, &&router, vec![],
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.