1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Events are returned from various bits in the library which indicate some action must be taken
13 //! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
14 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
17 use chain::keysinterface::SpendableOutputDescriptor;
19 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
20 use routing::network_graph::NetworkUpdate;
21 use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
23 use bitcoin::blockdata::script::Script;
25 use bitcoin::secp256k1::key::PublicKey;
29 use core::time::Duration;
32 /// Some information provided on receipt of payment depends on whether the payment received is a
33 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
34 #[derive(Clone, Debug)]
35 pub enum PaymentPurpose {
36 /// Information for receiving a payment that we generated an invoice for.
38 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
39 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
40 /// [`ChannelManager::claim_funds`].
42 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
43 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
44 payment_preimage: Option<PaymentPreimage>,
45 /// The "payment secret". This authenticates the sender to the recipient, preventing a
46 /// number of deanonymization attacks during the routing process.
47 /// It is provided here for your reference, however its accuracy is enforced directly by
48 /// [`ChannelManager`] using the values you previously provided to
49 /// [`ChannelManager::create_inbound_payment`] or
50 /// [`ChannelManager::create_inbound_payment_for_hash`].
52 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
53 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
54 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
55 payment_secret: PaymentSecret,
56 /// This is the `user_payment_id` which was provided to
57 /// [`ChannelManager::create_inbound_payment_for_hash`] or
58 /// [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
59 /// simply copied here. It may be used to correlate PaymentReceived events with invoice
60 /// metadata stored elsewhere.
62 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
63 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
66 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
67 /// (the payee) providing a preimage.
68 SpontaneousPayment(PaymentPreimage),
71 /// An Event which you should probably take some action in response to.
73 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
74 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
75 /// written as it makes no sense to respond to it after reconnecting to peers).
76 #[derive(Clone, Debug)]
78 /// Used to indicate that the client should generate a funding transaction with the given
79 /// parameters and then call ChannelManager::funding_transaction_generated.
80 /// Generated in ChannelManager message handling.
81 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
82 /// counterparty can steal your funds!
83 FundingGenerationReady {
84 /// The random channel_id we picked which you'll need to pass into
85 /// ChannelManager::funding_transaction_generated.
86 temporary_channel_id: [u8; 32],
87 /// The value, in satoshis, that the output should have.
88 channel_value_satoshis: u64,
89 /// The script which should be used in the transaction output.
90 output_script: Script,
91 /// The value passed in to ChannelManager::create_channel
94 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
95 /// ChannelManager::claim_funds to get it....
96 /// Note that if the preimage is not known or the amount paid is incorrect, you should call
97 /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
98 /// network congestion.
99 /// The amount paid should be considered 'incorrect' when it is less than or more than twice
100 /// the amount expected.
101 /// If you fail to call either ChannelManager::claim_funds or
102 /// ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
103 /// automatically failed.
105 /// The hash for which the preimage should be handed to the ChannelManager.
106 payment_hash: PaymentHash,
107 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
108 /// compare this to the expected value before accepting the payment (as otherwise you are
109 /// providing proof-of-payment for less than the value you expected!).
111 /// Information for claiming this received payment, based on whether the purpose of the
112 /// payment is to pay an invoice or to send a spontaneous payment.
113 purpose: PaymentPurpose,
115 /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
116 /// and we got back the payment preimage for it).
118 /// The preimage to the hash given to ChannelManager::send_payment.
119 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
120 /// store it somehow!
121 payment_preimage: PaymentPreimage,
123 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
124 /// something. You may wish to retry with a different route.
126 /// The hash which was given to ChannelManager::send_payment.
127 payment_hash: PaymentHash,
128 /// Indicates the payment was rejected for some reason by the recipient. This implies that
129 /// the payment has failed, not just the route in question. If this is not set, you may
130 /// retry the payment via a different route.
131 rejected_by_dest: bool,
132 /// Any failure information conveyed via the Onion return packet by a node along the failed
133 /// payment route. Should be applied to the [`NetworkGraph`] so that routing decisions can
134 /// take into account the update.
136 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
137 network_update: Option<NetworkUpdate>,
139 error_code: Option<u16>,
141 error_data: Option<Vec<u8>>,
143 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
144 /// time in the future.
145 PendingHTLCsForwardable {
146 /// The minimum amount of time that should be waited prior to calling
147 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
148 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
149 /// now + 5*time_forwardable).
150 time_forwardable: Duration,
152 /// Used to indicate that an output which you should know how to spend was confirmed on chain
153 /// and is now spendable.
154 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
155 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
156 /// somewhere and spend them when you create on-chain transactions.
158 /// The outputs which you should store as spendable by you.
159 outputs: Vec<SpendableOutputDescriptor>,
161 /// This event is generated when a payment has been successfully forwarded through us and a
162 /// forwarding fee earned.
164 /// The fee, in milli-satoshis, which was earned as a result of the payment.
166 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
167 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
168 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
169 /// claimed the full value in millisatoshis from the source. In this case,
170 /// `claim_from_onchain_tx` will be set.
172 /// If the channel which sent us the payment has been force-closed, we will claim the funds
173 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
174 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
175 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
177 fee_earned_msat: Option<u64>,
178 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
180 claim_from_onchain_tx: bool,
184 impl Writeable for Event {
185 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
187 &Event::FundingGenerationReady { .. } => {
189 // We never write out FundingGenerationReady events as, upon disconnection, peers
190 // drop any channels which have not yet exchanged funding_signed.
192 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
194 let mut payment_secret = None;
195 let mut user_payment_id = None;
196 let payment_preimage;
198 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret, user_payment_id: id } => {
199 payment_secret = Some(secret);
200 payment_preimage = *preimage;
201 user_payment_id = Some(id);
203 PaymentPurpose::SpontaneousPayment(preimage) => {
204 payment_preimage = Some(*preimage);
207 write_tlv_fields!(writer, {
208 (0, payment_hash, required),
209 (2, payment_secret, option),
211 (6, user_payment_id, option),
212 (8, payment_preimage, option),
215 &Event::PaymentSent { ref payment_preimage } => {
217 write_tlv_fields!(writer, {
218 (0, payment_preimage, required),
221 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update,
229 error_code.write(writer)?;
231 error_data.write(writer)?;
232 write_tlv_fields!(writer, {
233 (0, payment_hash, required),
234 (1, network_update, option),
235 (2, rejected_by_dest, required),
238 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
240 write_tlv_fields!(writer, {});
241 // We don't write the time_fordwardable out at all, as we presume when the user
242 // deserializes us at least that much time has elapsed.
244 &Event::SpendableOutputs { ref outputs } => {
246 write_tlv_fields!(writer, {
247 (0, VecWriteWrapper(outputs), required),
250 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
252 write_tlv_fields!(writer, {
253 (0, fee_earned_msat, option),
254 (2, claim_from_onchain_tx, required),
261 impl MaybeReadable for Event {
262 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
263 match Readable::read(reader)? {
267 let mut payment_hash = PaymentHash([0; 32]);
268 let mut payment_preimage = None;
269 let mut payment_secret = None;
271 let mut user_payment_id = None;
272 read_tlv_fields!(reader, {
273 (0, payment_hash, required),
274 (2, payment_secret, option),
276 (6, user_payment_id, option),
277 (8, payment_preimage, option),
279 let purpose = match payment_secret {
280 Some(secret) => PaymentPurpose::InvoicePayment {
282 payment_secret: secret,
283 user_payment_id: if let Some(id) = user_payment_id {
285 } else { return Err(msgs::DecodeError::InvalidValue) }
287 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
288 None => return Err(msgs::DecodeError::InvalidValue),
290 Ok(Some(Event::PaymentReceived {
300 let mut payment_preimage = PaymentPreimage([0; 32]);
301 read_tlv_fields!(reader, {
302 (0, payment_preimage, required),
304 Ok(Some(Event::PaymentSent {
313 let error_code = Readable::read(reader)?;
315 let error_data = Readable::read(reader)?;
316 let mut payment_hash = PaymentHash([0; 32]);
317 let mut rejected_by_dest = false;
318 let mut network_update = None;
319 read_tlv_fields!(reader, {
320 (0, payment_hash, required),
321 (1, network_update, ignorable),
322 (2, rejected_by_dest, required),
324 Ok(Some(Event::PaymentFailed {
338 read_tlv_fields!(reader, {});
339 Ok(Some(Event::PendingHTLCsForwardable {
340 time_forwardable: Duration::from_secs(0)
347 let mut outputs = VecReadWrapper(Vec::new());
348 read_tlv_fields!(reader, {
349 (0, outputs, required),
351 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
357 let mut fee_earned_msat = None;
358 let mut claim_from_onchain_tx = false;
359 read_tlv_fields!(reader, {
360 (0, fee_earned_msat, option),
361 (2, claim_from_onchain_tx, required),
363 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
367 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
368 x if x % 2 == 1 => Ok(None),
369 _ => Err(msgs::DecodeError::InvalidValue)
374 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
375 /// broadcast to most peers).
376 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
377 #[derive(Clone, Debug)]
378 pub enum MessageSendEvent {
379 /// Used to indicate that we've accepted a channel open and should send the accept_channel
380 /// message provided to the given peer.
382 /// The node_id of the node which should receive this message
384 /// The message which should be sent.
385 msg: msgs::AcceptChannel,
387 /// Used to indicate that we've initiated a channel open and should send the open_channel
388 /// message provided to the given peer.
390 /// The node_id of the node which should receive this message
392 /// The message which should be sent.
393 msg: msgs::OpenChannel,
395 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
397 /// The node_id of the node which should receive this message
399 /// The message which should be sent.
400 msg: msgs::FundingCreated,
402 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
404 /// The node_id of the node which should receive this message
406 /// The message which should be sent.
407 msg: msgs::FundingSigned,
409 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
411 /// The node_id of the node which should receive these message(s)
413 /// The funding_locked message which should be sent.
414 msg: msgs::FundingLocked,
416 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
417 SendAnnouncementSignatures {
418 /// The node_id of the node which should receive these message(s)
420 /// The announcement_signatures message which should be sent.
421 msg: msgs::AnnouncementSignatures,
423 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
424 /// message should be sent to the peer with the given node_id.
426 /// The node_id of the node which should receive these message(s)
428 /// The update messages which should be sent. ALL messages in the struct should be sent!
429 updates: msgs::CommitmentUpdate,
431 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
433 /// The node_id of the node which should receive this message
435 /// The message which should be sent.
436 msg: msgs::RevokeAndACK,
438 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
440 /// The node_id of the node which should receive this message
442 /// The message which should be sent.
443 msg: msgs::ClosingSigned,
445 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
447 /// The node_id of the node which should receive this message
449 /// The message which should be sent.
452 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
453 SendChannelReestablish {
454 /// The node_id of the node which should receive this message
456 /// The message which should be sent.
457 msg: msgs::ChannelReestablish,
459 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
460 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
462 /// Note that after doing so, you very likely (unless you did so very recently) want to call
463 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
464 /// This ensures that any nodes which see our channel_announcement also have a relevant
465 /// node_announcement, including relevant feature flags which may be important for routing
466 /// through or to us.
467 BroadcastChannelAnnouncement {
468 /// The channel_announcement which should be sent.
469 msg: msgs::ChannelAnnouncement,
470 /// The followup channel_update which should be sent.
471 update_msg: msgs::ChannelUpdate,
473 /// Used to indicate that a node_announcement should be broadcast to all peers.
474 BroadcastNodeAnnouncement {
475 /// The node_announcement which should be sent.
476 msg: msgs::NodeAnnouncement,
478 /// Used to indicate that a channel_update should be broadcast to all peers.
479 BroadcastChannelUpdate {
480 /// The channel_update which should be sent.
481 msg: msgs::ChannelUpdate,
483 /// Used to indicate that a channel_update should be sent to a single peer.
484 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
485 /// private channel and we shouldn't be informing all of our peers of channel parameters.
487 /// The node_id of the node which should receive this message
489 /// The channel_update which should be sent.
490 msg: msgs::ChannelUpdate,
492 /// Broadcast an error downstream to be handled
494 /// The node_id of the node which should receive this message
496 /// The action which should be taken.
497 action: msgs::ErrorAction
499 /// Query a peer for channels with funding transaction UTXOs in a block range.
500 SendChannelRangeQuery {
501 /// The node_id of this message recipient
503 /// The query_channel_range which should be sent.
504 msg: msgs::QueryChannelRange,
506 /// Request routing gossip messages from a peer for a list of channels identified by
507 /// their short_channel_ids.
509 /// The node_id of this message recipient
511 /// The query_short_channel_ids which should be sent.
512 msg: msgs::QueryShortChannelIds,
514 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
515 /// emitted during processing of the query.
516 SendReplyChannelRange {
517 /// The node_id of this message recipient
519 /// The reply_channel_range which should be sent.
520 msg: msgs::ReplyChannelRange,
524 /// A trait indicating an object may generate message send events
525 pub trait MessageSendEventsProvider {
526 /// Gets the list of pending events which were generated by previous actions, clearing the list
528 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
531 /// A trait indicating an object may generate events.
533 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
537 /// See [`process_pending_events`] for requirements around event processing.
539 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
540 /// event since the last invocation. The handler must either act upon the event immediately
541 /// or preserve it for later handling.
543 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
544 /// consult the provider's documentation on the implication of processing events and how a handler
545 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
546 /// [`ChainMonitor::process_pending_events`]).
548 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
551 /// [`process_pending_events`]: Self::process_pending_events
552 /// [`handle_event`]: EventHandler::handle_event
553 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
554 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
555 pub trait EventsProvider {
556 /// Processes any events generated since the last call using the given event handler.
558 /// Subsequent calls must only process new events. However, handlers must be capable of handling
559 /// duplicate events across process restarts. This may occur if the provider was recovered from
560 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
561 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
564 /// A trait implemented for objects handling events from [`EventsProvider`].
565 pub trait EventHandler {
566 /// Handles the given [`Event`].
568 /// See [`EventsProvider`] for details that must be considered when implementing this method.
569 fn handle_event(&self, event: &Event);
572 impl<F> EventHandler for F where F: Fn(&Event) {
573 fn handle_event(&self, event: &Event) {