Skip to content

Commit 0972b33

Browse files
shaavanshaavan
committed
Move request_refund_payment to flow.rs
Move request_refund_payment documentation to flow.rs
1 parent 734b58f commit 0972b33

File tree

3 files changed

+192
-169
lines changed

3 files changed

+192
-169
lines changed

‎lightning/src/ln/channelmanager.rs‎

Lines changed: 5 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ use crate::events::FundingInfo;
3636
use crate::blinded_path::message::{AsyncPaymentsContext, MessageContext, OffersContext};
3737
use crate::blinded_path::NodeIdLookUp;
3838
use crate::blinded_path::message::{BlindedMessagePath, MessageForwardNode};
39-
use crate::blinded_path::payment::{BlindedPaymentPath, Bolt12RefundContext, PaymentConstraints, PaymentContext, ReceiveTlvs};
39+
use crate::blinded_path::payment::{BlindedPaymentPath, PaymentConstraints, PaymentContext, ReceiveTlvs};
4040
use crate::chain;
4141
use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
4242
use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
@@ -65,11 +65,10 @@ use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
6565
use crate::ln::outbound_payment;
6666
use crate::ln::outbound_payment::{OutboundPayments, PendingOutboundPayment, RetryableInvoiceRequest, SendAlongPathArgs, StaleExpiration};
6767
use crate::ln::wire::Encode;
68-
use crate::offers::invoice::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, DerivedSigningPubkey, InvoiceBuilder};
68+
use crate::offers::invoice::Bolt12Invoice;
6969
use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestBuilder};
7070
use crate::offers::nonce::Nonce;
7171
use crate::offers::parse::Bolt12SemanticError;
72-
use crate::offers::refund::Refund;
7372
use crate::offers::signer;
7473
#[cfg(async_payments)]
7574
use crate::offers::static_invoice::StaticInvoice;
@@ -1994,56 +1993,6 @@ where
19941993
/// # }
19951994
/// ```
19961995
///
1997-
/// ## BOLT 12 Offers
1998-
///
1999-
/// ## BOLT 12 Refunds
2000-
///
2001-
/// Use [`request_refund_payment`] to send a [`Bolt12Invoice`] for receiving the refund. Similar to
2002-
/// *creating* an [`Offer`], this is stateless as it represents an inbound payment.
2003-
///
2004-
/// ```
2005-
/// # use lightning::events::{Event, EventsProvider, PaymentPurpose};
2006-
/// # use lightning::ln::channelmanager::{AChannelManager, OffersMessageCommons};
2007-
/// # use lightning::offers::refund::Refund;
2008-
/// #
2009-
/// # fn example<T: AChannelManager>(channel_manager: T, refund: &Refund) {
2010-
/// # let channel_manager = channel_manager.get_cm();
2011-
/// let known_payment_hash = match channel_manager.request_refund_payment(refund) {
2012-
/// Ok(invoice) => {
2013-
/// let payment_hash = invoice.payment_hash();
2014-
/// println!("Requesting refund payment {}", payment_hash);
2015-
/// payment_hash
2016-
/// },
2017-
/// Err(e) => panic!("Unable to request payment for refund: {:?}", e),
2018-
/// };
2019-
///
2020-
/// // On the event processing thread
2021-
/// channel_manager.process_pending_events(&|event| {
2022-
/// match event {
2023-
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
2024-
/// PaymentPurpose::Bolt12RefundPayment { payment_preimage: Some(payment_preimage), .. } => {
2025-
/// assert_eq!(payment_hash, known_payment_hash);
2026-
/// println!("Claiming payment {}", payment_hash);
2027-
/// channel_manager.claim_funds(payment_preimage);
2028-
/// },
2029-
/// PaymentPurpose::Bolt12RefundPayment { payment_preimage: None, .. } => {
2030-
/// println!("Unknown payment hash: {}", payment_hash);
2031-
/// },
2032-
/// // ...
2033-
/// # _ => {},
2034-
/// },
2035-
/// Event::PaymentClaimed { payment_hash, amount_msat, .. } => {
2036-
/// assert_eq!(payment_hash, known_payment_hash);
2037-
/// println!("Claimed {} msats", amount_msat);
2038-
/// },
2039-
/// // ...
2040-
/// # _ => {},
2041-
/// }
2042-
/// Ok(())
2043-
/// });
2044-
/// # }
2045-
/// ```
2046-
///
20471996
/// # Persistence
20481997
///
20491998
/// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
@@ -2636,6 +2585,7 @@ const MAX_NO_CHANNEL_PEERS: usize = 250;
26362585
/// become invalid over time as channels are closed. Thus, they are only suitable for short-term use.
26372586
///
26382587
/// [`Offer`]: crate::offers::offer
2588+
/// [`Refund`]: crate::offers::refund
26392589
pub const MAX_SHORT_LIVED_RELATIVE_EXPIRY: Duration = Duration::from_secs(60 * 60 * 24);
26402590

26412591
/// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
@@ -9569,7 +9519,7 @@ where
95699519
/// Sending multiple requests increases the chances of successful delivery in case some
95709520
/// paths are unavailable. However, only one invoice for a given [`PaymentId`] will be paid,
95719521
/// even if multiple invoices are received.
9572-
const OFFERS_MESSAGE_REQUEST_LIMIT: usize = 10;
9522+
pub const OFFERS_MESSAGE_REQUEST_LIMIT: usize = 10;
95739523

95749524
impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, MR: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, MR, L>
95759525
where
@@ -9656,106 +9606,6 @@ where
96569606
})
96579607
}
96589608

9659-
/// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
9660-
/// message.
9661-
///
9662-
/// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
9663-
/// [`BlindedPaymentPath`] containing the [`PaymentSecret`] needed to reconstruct the
9664-
/// corresponding [`PaymentPreimage`]. It is returned purely for informational purposes.
9665-
///
9666-
/// # Limitations
9667-
///
9668-
/// Requires a direct connection to an introduction node in [`Refund::paths`] or to
9669-
/// [`Refund::payer_signing_pubkey`], if empty. This request is best effort; an invoice will be
9670-
/// sent to each node meeting the aforementioned criteria, but there's no guarantee that they
9671-
/// will be received and no retries will be made.
9672-
///
9673-
/// # Errors
9674-
///
9675-
/// Errors if:
9676-
/// - the refund is for an unsupported chain, or
9677-
/// - the parameterized [`Router`] is unable to create a blinded payment path or reply path for
9678-
/// the invoice.
9679-
///
9680-
/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
9681-
pub fn request_refund_payment(
9682-
&self, refund: &Refund
9683-
) -> Result<Bolt12Invoice, Bolt12SemanticError> {
9684-
let expanded_key = &self.inbound_payment_key;
9685-
let entropy = &*self.entropy_source;
9686-
let secp_ctx = &self.secp_ctx;
9687-
9688-
let amount_msats = refund.amount_msats();
9689-
let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9690-
9691-
if refund.chain() != self.chain_hash {
9692-
return Err(Bolt12SemanticError::UnsupportedChain);
9693-
}
9694-
9695-
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
9696-
9697-
match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
9698-
Ok((payment_hash, payment_secret)) => {
9699-
let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
9700-
let payment_paths = self.create_blinded_payment_paths(
9701-
amount_msats, payment_secret, payment_context
9702-
)
9703-
.map_err(|_| Bolt12SemanticError::MissingPaths)?;
9704-
9705-
#[cfg(feature = "std")]
9706-
let builder = refund.respond_using_derived_keys(
9707-
payment_paths, payment_hash, expanded_key, entropy
9708-
)?;
9709-
#[cfg(not(feature = "std"))]
9710-
let created_at = Duration::from_secs(
9711-
self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9712-
);
9713-
#[cfg(not(feature = "std"))]
9714-
let builder = refund.respond_using_derived_keys_no_std(
9715-
payment_paths, payment_hash, created_at, expanded_key, entropy
9716-
)?;
9717-
let builder: InvoiceBuilder<DerivedSigningPubkey> = builder.into();
9718-
let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
9719-
9720-
let nonce = Nonce::from_entropy_source(entropy);
9721-
let hmac = payment_hash.hmac_for_offer_payment(nonce, expanded_key);
9722-
let context = MessageContext::Offers(OffersContext::InboundPayment {
9723-
payment_hash: invoice.payment_hash(), nonce, hmac
9724-
});
9725-
let reply_paths = self.create_blinded_paths(context)
9726-
.map_err(|_| Bolt12SemanticError::MissingPaths)?;
9727-
9728-
let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
9729-
if refund.paths().is_empty() {
9730-
for reply_path in reply_paths {
9731-
let instructions = MessageSendInstructions::WithSpecifiedReplyPath {
9732-
destination: Destination::Node(refund.payer_signing_pubkey()),
9733-
reply_path,
9734-
};
9735-
let message = OffersMessage::Invoice(invoice.clone());
9736-
pending_offers_messages.push((message, instructions));
9737-
}
9738-
} else {
9739-
reply_paths
9740-
.iter()
9741-
.flat_map(|reply_path| refund.paths().iter().map(move |path| (path, reply_path)))
9742-
.take(OFFERS_MESSAGE_REQUEST_LIMIT)
9743-
.for_each(|(path, reply_path)| {
9744-
let instructions = MessageSendInstructions::WithSpecifiedReplyPath {
9745-
destination: Destination::BlindedPath(path.clone()),
9746-
reply_path: reply_path.clone(),
9747-
};
9748-
let message = OffersMessage::Invoice(invoice.clone());
9749-
pending_offers_messages.push((message, instructions));
9750-
});
9751-
}
9752-
9753-
Ok(invoice)
9754-
},
9755-
Err(()) => Err(Bolt12SemanticError::InvalidAmount),
9756-
}
9757-
}
9758-
97599609
/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
97609610
/// resolver(s) at `dns_resolvers` which resolve names according to bLIP 32.
97619611
///
@@ -12202,6 +12052,7 @@ where
1220212052
/// [`Refund`]s, and any reply paths.
1220312053
///
1220412054
/// [`Offer`]: crate::offers::offer
12055+
/// [`Refund`]: crate::offers::refund
1220512056
pub message_router: MR,
1220612057
/// The Logger for use in the ChannelManager and which may be used to log information during
1220712058
/// deserialization.

‎lightning/src/ln/offers_tests.rs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ fn creates_and_pays_for_refund_using_two_hop_blinded_path() {
655655
expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
656656

657657
let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
658-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
658+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
659659

660660
connect_peers(alice, charlie);
661661

@@ -784,7 +784,7 @@ fn creates_and_pays_for_refund_using_one_hop_blinded_path() {
784784
expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
785785

786786
let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
787-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
787+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
788788

789789
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
790790
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);
@@ -889,7 +889,7 @@ fn pays_for_refund_without_blinded_paths() {
889889
expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
890890

891891
let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
892-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
892+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
893893

894894
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
895895
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);
@@ -1044,7 +1044,7 @@ fn send_invoice_for_refund_with_distinct_reply_path() {
10441044
}
10451045
expect_recent_payment!(alice, RecentPaymentDetails::AwaitingInvoice, payment_id);
10461046

1047-
let _expected_invoice = david.node.request_refund_payment(&refund).unwrap();
1047+
let _expected_invoice = david.offers_handler.request_refund_payment(&refund).unwrap();
10481048

10491049
connect_peers(david, bob);
10501050

@@ -1324,7 +1324,7 @@ fn creates_refund_with_blinded_path_using_unannounced_introduction_node() {
13241324
}
13251325
expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
13261326

1327-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
1327+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
13281328

13291329
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
13301330

@@ -1608,7 +1608,7 @@ fn fails_authentication_when_handling_invoice_for_refund() {
16081608
expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
16091609

16101610
// Send the invoice directly to David instead of using a blinded path.
1611-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
1611+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
16121612

16131613
connect_peers(david, alice);
16141614
match &mut alice.node.pending_offers_messages.lock().unwrap().first_mut().unwrap().1 {
@@ -1640,7 +1640,7 @@ fn fails_authentication_when_handling_invoice_for_refund() {
16401640
assert_eq!(path.introduction_node(), &IntroductionNode::NodeId(charlie_id));
16411641
}
16421642

1643-
let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
1643+
let expected_invoice = alice.offers_handler.request_refund_payment(&refund).unwrap();
16441644

16451645
match &mut alice.node.pending_offers_messages.lock().unwrap().first_mut().unwrap().1 {
16461646
MessageSendInstructions::WithSpecifiedReplyPath { destination, .. } =>
@@ -1773,7 +1773,7 @@ fn fails_creating_refund_or_sending_invoice_without_connected_peers() {
17731773
.unwrap()
17741774
.build().unwrap();
17751775

1776-
match alice.node.request_refund_payment(&refund) {
1776+
match alice.offers_handler.request_refund_payment(&refund) {
17771777
Ok(_) => panic!("Expected error"),
17781778
Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
17791779
}
@@ -1782,7 +1782,7 @@ fn fails_creating_refund_or_sending_invoice_without_connected_peers() {
17821782
args.send_channel_ready = (true, true);
17831783
reconnect_nodes(args);
17841784

1785-
assert!(alice.node.request_refund_payment(&refund).is_ok());
1785+
assert!(alice.offers_handler.request_refund_payment(&refund).is_ok());
17861786
}
17871787

17881788
/// Fails creating an invoice request when the offer contains an unsupported chain.
@@ -1832,7 +1832,7 @@ fn fails_sending_invoice_with_unsupported_chain_for_refund() {
18321832
.chain(Network::Signet)
18331833
.build().unwrap();
18341834

1835-
match alice.node.request_refund_payment(&refund) {
1835+
match alice.offers_handler.request_refund_payment(&refund) {
18361836
Ok(_) => panic!("Expected error"),
18371837
Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
18381838
}
@@ -2055,7 +2055,7 @@ fn fails_sending_invoice_without_blinded_payment_paths_for_refund() {
20552055
.unwrap()
20562056
.build().unwrap();
20572057

2058-
match alice.node.request_refund_payment(&refund) {
2058+
match alice.offers_handler.request_refund_payment(&refund) {
20592059
Ok(_) => panic!("Expected error"),
20602060
Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
20612061
}
@@ -2106,7 +2106,7 @@ fn fails_paying_invoice_more_than_once() {
21062106
expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
21072107

21082108
// Alice sends the first invoice
2109-
alice.node.request_refund_payment(&refund).unwrap();
2109+
alice.offers_handler.request_refund_payment(&refund).unwrap();
21102110

21112111
connect_peers(alice, charlie);
21122112

@@ -2126,7 +2126,7 @@ fn fails_paying_invoice_more_than_once() {
21262126
disconnect_peers(alice, &[charlie]);
21272127

21282128
// Alice sends the second invoice
2129-
alice.node.request_refund_payment(&refund).unwrap();
2129+
alice.offers_handler.request_refund_payment(&refund).unwrap();
21302130

21312131
connect_peers(alice, charlie);
21322132
connect_peers(david, bob);

0 commit comments

Comments
 (0)