f s/OptionalOfferPaymentInfo/OptionalOfferPaymentParams/g

TheBlueMatt · TheBlueMatt · commit 37b04b18a1e2 · 2025-07-07T14:26:03.000Z
diff --git a/lightning-dns-resolver/src/lib.rs b/lightning-dns-resolver/src/lib.rs
@@ -162,7 +162,7 @@ mod test {
 	use lightning::blinded_path::message::{BlindedMessagePath, MessageContext};
 	use lightning::blinded_path::NodeIdLookUp;
 	use lightning::events::{Event, PaymentPurpose};
-	use lightning::ln::channelmanager::{OptionalOfferPaymentInfo, PaymentId};
+	use lightning::ln::channelmanager::{OptionalOfferPaymentParams, PaymentId};
 	use lightning::ln::functional_test_utils::*;
 	use lightning::ln::msgs::{
 		BaseMessageHandler, ChannelMessageHandler, Init, OnionMessageHandler,
@@ -375,7 +375,7 @@ mod test {
 		let proof_override = &nodes[0].node.testing_dnssec_proof_offer_resolution_override;
 		proof_override.lock().unwrap().insert(name.clone(), offer);
 		let amt = 42_000;
-		let mut opts = OptionalOfferPaymentInfo::default();
+		let mut opts = OptionalOfferPaymentParams::default();
 		opts.payer_note = payer_note.clone();
 		nodes[0]
 			.node
diff --git a/lightning/src/ln/async_payments_tests.rs b/lightning/src/ln/async_payments_tests.rs
@@ -13,7 +13,7 @@ use crate::blinded_path::payment::{AsyncBolt12OfferContext, BlindedPaymentTlvs};
 use crate::chain::channelmonitor::{HTLC_FAIL_BACK_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
 use crate::events::{Event, HTLCHandlingFailureType, PaidBolt12Invoice, PaymentFailureReason};
 use crate::ln::blinded_payment_tests::{fail_blinded_htlc_backwards, get_blinded_route_parameters};
-use crate::ln::channelmanager::{OptionalOfferPaymentInfo, PaymentId, RecipientOnionFields};
+use crate::ln::channelmanager::{OptionalOfferPaymentParams, PaymentId, RecipientOnionFields};
 use crate::ln::functional_test_utils::*;
 use crate::ln::msgs;
 use crate::ln::msgs::{
@@ -1075,7 +1075,7 @@ fn expired_static_invoice_payment_path() {
 	let (offer, static_invoice) = create_static_invoice(&nodes[1], &nodes[2], None, &secp_ctx);
 	let amt_msat = 5000;
 	let payment_id = PaymentId([1; 32]);
-	let mut params: OptionalOfferPaymentInfo = Default::default();
+	let mut params: OptionalOfferPaymentParams = Default::default();
 	params.retry_strategy = Retry::Attempts(0);
 	nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, params).unwrap();
 	let release_held_htlc_om =
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
@@ -695,7 +695,7 @@ impl Readable for InterceptId {
 /// .
 ///
 /// These fields will often not need to be set, and the provided [`Self::default`] can be used.
-pub struct OptionalOfferPaymentInfo {
+pub struct OptionalOfferPaymentParams {
 	/// A note which is communicated to the recipient about this payment via
 	/// [`InvoiceRequest::payer_note`].
 	pub payer_note: Option<String>,
@@ -710,7 +710,7 @@ pub struct OptionalOfferPaymentInfo {
 	pub retry_strategy: Retry,
 }
 
-impl Default for OptionalOfferPaymentInfo {
+impl Default for OptionalOfferPaymentParams {
 	fn default() -> Self {
 		Self {
 			payer_note: None,
@@ -11208,7 +11208,7 @@ where
 	/// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
 	pub fn pay_for_offer(
 		&self, offer: &Offer, amount_msats: Option<u64>, payment_id: PaymentId,
-		optional_info: OptionalOfferPaymentInfo,
+		optional_params: OptionalOfferPaymentParams,
 	) -> Result<(), Bolt12SemanticError> {
 		let create_pending_payment_fn = |invoice_request: &InvoiceRequest, nonce| {
 			let expiration = StaleExpiration::TimerTicks(1);
@@ -11221,8 +11221,8 @@ where
 				.add_new_awaiting_invoice(
 					payment_id,
 					expiration,
-					optional_info.retry_strategy,
-					optional_info.route_params_config,
+					optional_params.retry_strategy,
+					optional_params.route_params_config,
 					Some(retryable_invoice_request),
 				)
 				.map_err(|_| Bolt12SemanticError::DuplicatePaymentId)
@@ -11232,7 +11232,7 @@ where
 			offer,
 			if offer.expects_quantity() { Some(1) } else { None },
 			amount_msats,
-			optional_info.payer_note,
+			optional_params.payer_note,
 			payment_id,
 			None,
 			create_pending_payment_fn,
@@ -11256,7 +11256,7 @@ where
 	/// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
 	pub fn pay_for_offer_with_quantity(
 		&self, offer: &Offer, amount_msats: Option<u64>, payment_id: PaymentId,
-		optional_info: OptionalOfferPaymentInfo, quantity: u64,
+		optional_params: OptionalOfferPaymentParams, quantity: u64,
 	) -> Result<(), Bolt12SemanticError> {
 		let create_pending_payment_fn = |invoice_request: &InvoiceRequest, nonce| {
 			let expiration = StaleExpiration::TimerTicks(1);
@@ -11269,8 +11269,8 @@ where
 				.add_new_awaiting_invoice(
 					payment_id,
 					expiration,
-					optional_info.retry_strategy,
-					optional_info.route_params_config,
+					optional_params.retry_strategy,
+					optional_params.route_params_config,
 					Some(retryable_invoice_request),
 				)
 				.map_err(|_| Bolt12SemanticError::DuplicatePaymentId)
@@ -11280,7 +11280,7 @@ where
 			offer,
 			Some(quantity),
 			amount_msats,
-			optional_info.payer_note,
+			optional_params.payer_note,
 			payment_id,
 			None,
 			create_pending_payment_fn,
@@ -11427,7 +11427,7 @@ where
 	#[cfg(feature = "dnssec")]
 	pub fn pay_for_offer_from_human_readable_name(
 		&self, name: HumanReadableName, amount_msats: u64, payment_id: PaymentId,
-		optional_info: OptionalOfferPaymentInfo, dns_resolvers: Vec<Destination>,
+		optional_params: OptionalOfferPaymentParams, dns_resolvers: Vec<Destination>,
 	) -> Result<(), ()> {
 		let (onion_message, context) =
 			self.flow.hrn_resolver.resolve_name(payment_id, name, &*self.entropy_source)?;
@@ -11436,10 +11436,10 @@ where
 		self.pending_outbound_payments.add_new_awaiting_offer(
 			payment_id,
 			expiration,
-			optional_info.retry_strategy,
-			optional_info.route_params_config,
+			optional_params.retry_strategy,
+			optional_params.route_params_config,
 			amount_msats,
-			optional_info.payer_note,
+			optional_params.payer_note,
 		)?;
 
 		self.flow
diff --git a/lightning/src/ln/max_payment_path_len_tests.rs b/lightning/src/ln/max_payment_path_len_tests.rs
@@ -17,7 +17,7 @@ use crate::blinded_path::payment::{
 use crate::blinded_path::BlindedHop;
 use crate::events::Event;
 use crate::ln::blinded_payment_tests::get_blinded_route_parameters;
-use crate::ln::channelmanager::{OptionalOfferPaymentInfo, PaymentId};
+use crate::ln::channelmanager::{OptionalOfferPaymentParams, PaymentId};
 use crate::ln::functional_test_utils::*;
 use crate::ln::msgs;
 use crate::ln::msgs::{BaseMessageHandler, OnionMessageHandler};
@@ -521,7 +521,7 @@ fn bolt12_invoice_too_large_blinded_paths() {
 	let payment_id = PaymentId([1; 32]);
 	nodes[0]
 		.node
-		.pay_for_offer(&offer, Some(5000), payment_id, OptionalOfferPaymentInfo::default())
+		.pay_for_offer(&offer, Some(5000), payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	let invreq_om = nodes[0]
 		.onion_messenger
diff --git a/lightning/src/ln/offers_tests.rs b/lightning/src/ln/offers_tests.rs
@@ -50,7 +50,7 @@ use crate::blinded_path::message::BlindedMessagePath;
 use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentContext};
 use crate::blinded_path::message::OffersContext;
 use crate::events::{ClosureReason, Event, HTLCHandlingFailureType, PaidBolt12Invoice, PaymentFailureReason, PaymentPurpose};
-use crate::ln::channelmanager::{Bolt12PaymentError, OptionalOfferPaymentInfo, MAX_SHORT_LIVED_RELATIVE_EXPIRY, PaymentId, RecentPaymentDetails, RecipientOnionFields, Retry, self};
+use crate::ln::channelmanager::{Bolt12PaymentError, OptionalOfferPaymentParams, MAX_SHORT_LIVED_RELATIVE_EXPIRY, PaymentId, RecentPaymentDetails, RecipientOnionFields, Retry, self};
 use crate::types::features::Bolt12InvoiceFeatures;
 use crate::ln::functional_test_utils::*;
 use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnouncement, OnionMessage, OnionMessageHandler, RoutingMessageHandler, SocketAddress, UnsignedGossipMessage, UnsignedNodeAnnouncement};
@@ -543,7 +543,7 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
 	}
 
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -712,7 +712,7 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
 	}
 
 	let payment_id = PaymentId([1; 32]);
-	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
@@ -833,7 +833,7 @@ fn pays_for_offer_without_blinded_paths() {
 	assert!(offer.paths().is_empty());
 
 	let payment_id = PaymentId([1; 32]);
-	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
@@ -960,7 +960,7 @@ fn send_invoice_requests_with_distinct_reply_path() {
 	}
 
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 	connect_peers(david, bob);
@@ -1094,7 +1094,7 @@ fn creates_and_pays_for_offer_with_retry() {
 		assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(alice_id));
 	}
 	let payment_id = PaymentId([1; 32]);
-	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let _lost_onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
@@ -1166,7 +1166,7 @@ fn pays_bolt12_invoice_asynchronously() {
 		.build().unwrap();
 
 	let payment_id = PaymentId([1; 32]);
-	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
@@ -1263,7 +1263,7 @@ fn creates_offer_with_blinded_path_using_unannounced_introduction_node() {
 	}
 
 	let payment_id = PaymentId([1; 32]);
-	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
@@ -1404,7 +1404,7 @@ fn fails_authentication_when_handling_invoice_request() {
 
 	// Send the invoice request directly to Alice instead of using a blinded path.
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -1430,7 +1430,7 @@ fn fails_authentication_when_handling_invoice_request() {
 
 	// Send the invoice request to Alice using an invalid blinded path.
 	let payment_id = PaymentId([2; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -1507,7 +1507,7 @@ fn fails_authentication_when_handling_invoice_for_offer() {
 
 	// Initiate an invoice request, but abandon tracking it.
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	david.node.abandon_payment(payment_id);
 	get_event!(david, Event::PaymentFailed);
@@ -1524,7 +1524,7 @@ fn fails_authentication_when_handling_invoice_for_offer() {
 	};
 
 	let payment_id = PaymentId([2; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -1708,7 +1708,7 @@ fn fails_creating_or_paying_for_offer_without_connected_peers() {
 
 	let payment_id = PaymentId([1; 32]);
 
-	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()) {
+	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()) {
 		Ok(_) => panic!("Expected error"),
 		Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
 	}
@@ -1721,7 +1721,7 @@ fn fails_creating_or_paying_for_offer_without_connected_peers() {
 
 	assert!(
 		david.node.pay_for_offer(
-			&offer, None, payment_id, OptionalOfferPaymentInfo::default()
+			&offer, None, payment_id, OptionalOfferPaymentParams::default()
 		).is_ok()
 	);
 
@@ -1812,7 +1812,7 @@ fn fails_creating_invoice_request_for_unsupported_chain() {
 		.build().unwrap();
 
 	let payment_id = PaymentId([1; 32]);
-	match bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()) {
+	match bob.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()) {
 		Ok(_) => panic!("Expected error"),
 		Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
 	}
@@ -1871,7 +1871,7 @@ fn fails_creating_invoice_request_without_blinded_reply_path() {
 
 	let payment_id = PaymentId([1; 32]);
 
-	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()) {
+	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()) {
 		Ok(_) => panic!("Expected error"),
 		Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
 	}
@@ -1906,12 +1906,12 @@ fn fails_creating_invoice_request_with_duplicate_payment_id() {
 	let payment_id = PaymentId([1; 32]);
 	assert!(
 		david.node.pay_for_offer(
-			&offer, None, payment_id, OptionalOfferPaymentInfo::default()
+			&offer, None, payment_id, OptionalOfferPaymentParams::default()
 		).is_ok()
 	);
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
-	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()) {
+	match david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()) {
 		Ok(_) => panic!("Expected error"),
 		Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
 	}
@@ -1990,7 +1990,7 @@ fn fails_sending_invoice_without_blinded_payment_paths_for_offer() {
 		.build().unwrap();
 
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 
 	connect_peers(david, bob);
@@ -2199,7 +2199,7 @@ fn fails_paying_invoice_with_unknown_required_features() {
 		.build().unwrap();
 
 	let payment_id = PaymentId([1; 32]);
-	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default())
+	david.node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default())
 		.unwrap();
 
 	connect_peers(david, bob);
@@ -2276,7 +2276,7 @@ fn rejects_keysend_to_non_static_invoice_path() {
 	let offer = nodes[1].node.create_offer_builder(None).unwrap().build().unwrap();
 	let amt_msat = 5000;
 	let payment_id = PaymentId([1; 32]);
-	nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	nodes[0].node.pay_for_offer(&offer, Some(amt_msat), payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	let invreq_om = nodes[0].onion_messenger.next_onion_message_for_peer(nodes[1].node.get_our_node_id()).unwrap();
 	nodes[1].onion_messenger.handle_onion_message(nodes[0].node.get_our_node_id(), &invreq_om);
 	let invoice_om = nodes[1].onion_messenger.next_onion_message_for_peer(nodes[0].node.get_our_node_id()).unwrap();
@@ -2361,7 +2361,7 @@ fn no_double_pay_with_stale_channelmanager() {
 	assert!(offer.paths().is_empty());
 
 	let payment_id = PaymentId([1; 32]);
-	nodes[0].node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentInfo::default()).unwrap();
+	nodes[0].node.pay_for_offer(&offer, None, payment_id, OptionalOfferPaymentParams::default()).unwrap();
 	expect_recent_payment!(nodes[0], RecentPaymentDetails::AwaitingInvoice, payment_id);
 
 	let invreq_om = nodes[0].onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
