@@ -823,18 +823,29 @@ pub enum Event {
823
823
addresses : Vec < msgs:: SocketAddress > ,
824
824
} ,
825
825
826
- /// Event triggered when manual handling is enabled, and an invoice request is received.
826
+ /// Event triggered when manual handling is enabled and an invoice request is received.
827
+ ///
828
+ /// Indicates that an [`InvoiceRequest`] for an [`Offer`] created by us has been received.
829
+ ///
830
+ /// This event will only be generated if [`UserConfig::manually_handle_bolt12_messages`] is set.
831
+ /// Use [`ChannelManager::send_invoice_request_response`] to respond with an appropriate
832
+ /// response to the received invoice request. Use [`ChannelManager::reject_invoice_request`] to
833
+ /// reject the invoice request and respond with an [`InvoiceError`]. See the docs for further details.
834
+ ///
835
+ /// [`Offer`]: crate::offers::offer::Offer
836
+ /// [`UserConfig::manually_handle_bolt12_messages`]: crate::util::config::UserConfig::manually_handle_bolt12_messages
837
+ /// [`ChannelManager::send_invoice_request_response`]: crate::ln::channelmanager::ChannelManager::send_invoice_request_response
838
+ /// [`ChannelManager::reject_invoice_request`]: crate::ln::channelmanager::ChannelManager::reject_invoice_request
839
+ /// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
827
840
InvoiceRequestReceived {
828
- /// The invoice request to pay .
841
+ /// The received invoice request to respond to .
829
842
invoice_request : InvoiceRequest ,
830
843
/// The context of the [`BlindedMessagePath`] used to send the invoice request.
831
844
///
832
845
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
833
846
context : Option < OffersContext > ,
834
847
/// A responder for replying with an [`InvoiceError`] if needed.
835
848
///
836
- /// `None` if the invoice wasn't sent with a reply path.
837
- ///
838
849
/// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
839
850
responder : Responder ,
840
851
} ,
0 commit comments