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;
18 use ln::channelmanager::PaymentId;
19 use ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
21 use ln::msgs::DecodeError;
22 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
23 use routing::network_graph::NetworkUpdate;
24 use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
25 use routing::router::{RouteHop, RouteParameters};
27 use bitcoin::Transaction;
28 use bitcoin::blockdata::script::Script;
29 use bitcoin::hashes::Hash;
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::secp256k1::key::PublicKey;
35 use core::time::Duration;
39 /// Some information provided on receipt of payment depends on whether the payment received is a
40 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
41 #[derive(Clone, Debug)]
42 pub enum PaymentPurpose {
43 /// Information for receiving a payment that we generated an invoice for.
45 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
46 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
47 /// [`ChannelManager::claim_funds`].
49 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
50 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
51 payment_preimage: Option<PaymentPreimage>,
52 /// The "payment secret". This authenticates the sender to the recipient, preventing a
53 /// number of deanonymization attacks during the routing process.
54 /// It is provided here for your reference, however its accuracy is enforced directly by
55 /// [`ChannelManager`] using the values you previously provided to
56 /// [`ChannelManager::create_inbound_payment`] or
57 /// [`ChannelManager::create_inbound_payment_for_hash`].
59 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
60 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
61 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
62 payment_secret: PaymentSecret,
64 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
65 /// (the payee) providing a preimage.
66 SpontaneousPayment(PaymentPreimage),
69 #[derive(Clone, Debug, PartialEq)]
70 /// The reason the channel was closed. See individual variants more details.
71 pub enum ClosureReason {
72 /// Closure generated from receiving a peer error message.
74 /// Our counterparty may have broadcasted their latest commitment state, and we have
76 CounterpartyForceClosed {
77 /// The error which the peer sent us.
79 /// The string should be sanitized before it is used (e.g emitted to logs
80 /// or printed to stdout). Otherwise, a well crafted error message may exploit
81 /// a security vulnerability in the terminal emulator or the logging subsystem.
84 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
86 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
88 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
89 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
90 //TODO: split between CounterpartyInitiated/LocallyInitiated
92 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
93 /// commitment transaction came from our counterparty, but it may also have come from
94 /// a copy of our own `ChannelMonitor`.
95 CommitmentTxConfirmed,
96 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
98 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
100 /// A developer-readable error message which we generated.
103 /// The `PeerManager` informed us that we've disconnected from the peer. We close channels
104 /// if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
105 /// peer again in the future or if the peer disconnected before we finished negotiating
106 /// the channel open. The first case may be caused by incompatible features which our
107 /// counterparty, or we, require.
108 //TODO: split between PeerUnconnectable/PeerDisconnected ?
110 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
111 /// the ChannelManager deserialized.
112 OutdatedChannelManager
115 impl core::fmt::Display for ClosureReason {
116 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
117 f.write_str("Channel closed because ")?;
119 ClosureReason::CounterpartyForceClosed { peer_msg } => {
120 f.write_str("counterparty force-closed with message ")?;
121 f.write_str(&peer_msg)
123 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
124 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
125 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
126 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
127 ClosureReason::ProcessingError { err } => {
128 f.write_str("of an exception: ")?;
131 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
132 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
137 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
138 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
139 (1, FundingTimedOut) => {},
140 (2, HolderForceClosed) => {},
141 (6, CommitmentTxConfirmed) => {},
142 (4, CooperativeClosure) => {},
143 (8, ProcessingError) => { (1, err, required) },
144 (10, DisconnectedPeer) => {},
145 (12, OutdatedChannelManager) => {},
148 /// An Event which you should probably take some action in response to.
150 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
151 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
152 /// written as it makes no sense to respond to it after reconnecting to peers).
153 #[derive(Clone, Debug)]
155 /// Used to indicate that the client should generate a funding transaction with the given
156 /// parameters and then call ChannelManager::funding_transaction_generated.
157 /// Generated in ChannelManager message handling.
158 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
159 /// counterparty can steal your funds!
160 FundingGenerationReady {
161 /// The random channel_id we picked which you'll need to pass into
162 /// ChannelManager::funding_transaction_generated.
163 temporary_channel_id: [u8; 32],
164 /// The value, in satoshis, that the output should have.
165 channel_value_satoshis: u64,
166 /// The script which should be used in the transaction output.
167 output_script: Script,
168 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
169 /// an inbound channel.
171 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
172 user_channel_id: u64,
174 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
175 /// [`ChannelManager::claim_funds`] to get it....
176 /// Note that if the preimage is not known, you should call
177 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
178 /// network congestion.
179 /// If you fail to call either [`ChannelManager::claim_funds`] or
180 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
181 /// automatically failed.
183 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
184 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
186 /// The hash for which the preimage should be handed to the ChannelManager.
187 payment_hash: PaymentHash,
188 /// The value, in thousandths of a satoshi, that this payment is for.
190 /// Information for claiming this received payment, based on whether the purpose of the
191 /// payment is to pay an invoice or to send a spontaneous payment.
192 purpose: PaymentPurpose,
194 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
195 /// and we got back the payment preimage for it).
197 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
198 /// event. In this situation, you SHOULD treat this payment as having succeeded.
200 /// The id returned by [`ChannelManager::send_payment`] and used with
201 /// [`ChannelManager::retry_payment`].
203 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
204 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
205 payment_id: Option<PaymentId>,
206 /// The preimage to the hash given to ChannelManager::send_payment.
207 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
208 /// store it somehow!
209 payment_preimage: PaymentPreimage,
210 /// The hash which was given to [`ChannelManager::send_payment`].
212 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
213 payment_hash: PaymentHash,
214 /// The total fee which was spent at intermediate hops in this payment, across all paths.
216 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
217 /// overpayment to the recipient node.
219 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
220 /// overstate the amount paid, though this is unlikely.
222 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
223 fee_paid_msat: Option<u64>,
225 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
226 /// something. You may wish to retry with a different route.
228 /// The id returned by [`ChannelManager::send_payment`] and used with
229 /// [`ChannelManager::retry_payment`].
231 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
232 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
233 payment_id: Option<PaymentId>,
234 /// The hash which was given to ChannelManager::send_payment.
235 payment_hash: PaymentHash,
236 /// Indicates the payment was rejected for some reason by the recipient. This implies that
237 /// the payment has failed, not just the route in question. If this is not set, you may
238 /// retry the payment via a different route.
239 rejected_by_dest: bool,
240 /// Any failure information conveyed via the Onion return packet by a node along the failed
243 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
244 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
246 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
247 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
248 network_update: Option<NetworkUpdate>,
249 /// For both single-path and multi-path payments, this is set if all paths of the payment have
250 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
251 /// larger MPP payment were still in flight when this event was generated.
252 all_paths_failed: bool,
253 /// The payment path that failed.
255 /// The channel responsible for the failed payment path.
257 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
258 /// retried. May be `None` for older [`Event`] serializations.
259 short_channel_id: Option<u64>,
260 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
262 /// See [`find_route`] for details.
264 /// [`Route`]: crate::routing::router::Route
265 /// [`find_route`]: crate::routing::router::find_route
266 retry: Option<RouteParameters>,
268 error_code: Option<u16>,
270 error_data: Option<Vec<u8>>,
272 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
273 /// time in the future.
274 PendingHTLCsForwardable {
275 /// The minimum amount of time that should be waited prior to calling
276 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
277 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
278 /// now + 5*time_forwardable).
279 time_forwardable: Duration,
281 /// Used to indicate that an output which you should know how to spend was confirmed on chain
282 /// and is now spendable.
283 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
284 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
285 /// somewhere and spend them when you create on-chain transactions.
287 /// The outputs which you should store as spendable by you.
288 outputs: Vec<SpendableOutputDescriptor>,
290 /// This event is generated when a payment has been successfully forwarded through us and a
291 /// forwarding fee earned.
293 /// The fee, in milli-satoshis, which was earned as a result of the payment.
295 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
296 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
297 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
298 /// claimed the full value in millisatoshis from the source. In this case,
299 /// `claim_from_onchain_tx` will be set.
301 /// If the channel which sent us the payment has been force-closed, we will claim the funds
302 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
303 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
304 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
306 fee_earned_msat: Option<u64>,
307 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
309 claim_from_onchain_tx: bool,
311 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
313 /// The channel_id of the channel which has been closed. Note that on-chain transactions
314 /// resolving the channel are likely still awaiting confirmation.
315 channel_id: [u8; 32],
316 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
317 /// an inbound channel. This will always be zero for objects serialized with LDK versions
318 /// prior to 0.0.102.
320 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
321 user_channel_id: u64,
322 /// The reason the channel was closed.
323 reason: ClosureReason
325 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
326 /// inputs for another purpose.
328 /// The channel_id of the channel which has been closed.
329 channel_id: [u8; 32],
330 /// The full transaction received from the user
331 transaction: Transaction
335 impl Writeable for Event {
336 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
338 &Event::FundingGenerationReady { .. } => {
340 // We never write out FundingGenerationReady events as, upon disconnection, peers
341 // drop any channels which have not yet exchanged funding_signed.
343 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
345 let mut payment_secret = None;
346 let payment_preimage;
348 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
349 payment_secret = Some(secret);
350 payment_preimage = *preimage;
352 PaymentPurpose::SpontaneousPayment(preimage) => {
353 payment_preimage = Some(*preimage);
356 write_tlv_fields!(writer, {
357 (0, payment_hash, required),
358 (2, payment_secret, option),
360 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
361 (8, payment_preimage, option),
364 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
366 write_tlv_fields!(writer, {
367 (0, payment_preimage, required),
368 (1, payment_hash, required),
369 (3, payment_id, option),
370 (5, fee_paid_msat, option),
373 &Event::PaymentPathFailed {
374 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
375 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
383 error_code.write(writer)?;
385 error_data.write(writer)?;
386 write_tlv_fields!(writer, {
387 (0, payment_hash, required),
388 (1, network_update, option),
389 (2, rejected_by_dest, required),
390 (3, all_paths_failed, required),
392 (7, short_channel_id, option),
394 (11, payment_id, option),
397 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
399 // Note that we now ignore these on the read end as we'll re-generate them in
400 // ChannelManager, we write them here only for backwards compatibility.
402 &Event::SpendableOutputs { ref outputs } => {
404 write_tlv_fields!(writer, {
405 (0, VecWriteWrapper(outputs), required),
408 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
410 write_tlv_fields!(writer, {
411 (0, fee_earned_msat, option),
412 (2, claim_from_onchain_tx, required),
415 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
417 write_tlv_fields!(writer, {
418 (0, channel_id, required),
419 (1, user_channel_id, required),
420 (2, reason, required)
423 &Event::DiscardFunding { ref channel_id, ref transaction } => {
425 write_tlv_fields!(writer, {
426 (0, channel_id, required),
427 (2, transaction, required)
430 // Note that, going forward, all new events must only write data inside of
431 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
432 // data via `write_tlv_fields`.
437 impl MaybeReadable for Event {
438 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
439 match Readable::read(reader)? {
440 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
441 // unlike all other events, thus we return immediately here.
445 let mut payment_hash = PaymentHash([0; 32]);
446 let mut payment_preimage = None;
447 let mut payment_secret = None;
449 let mut _user_payment_id = None; // For compatibility with 0.0.103 and earlier
450 read_tlv_fields!(reader, {
451 (0, payment_hash, required),
452 (2, payment_secret, option),
454 (6, _user_payment_id, option),
455 (8, payment_preimage, option),
457 let purpose = match payment_secret {
458 Some(secret) => PaymentPurpose::InvoicePayment {
460 payment_secret: secret
462 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
463 None => return Err(msgs::DecodeError::InvalidValue),
465 Ok(Some(Event::PaymentReceived {
475 let mut payment_preimage = PaymentPreimage([0; 32]);
476 let mut payment_hash = None;
477 let mut payment_id = None;
478 let mut fee_paid_msat = None;
479 read_tlv_fields!(reader, {
480 (0, payment_preimage, required),
481 (1, payment_hash, option),
482 (3, payment_id, option),
483 (5, fee_paid_msat, option),
485 if payment_hash.is_none() {
486 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
488 Ok(Some(Event::PaymentSent {
491 payment_hash: payment_hash.unwrap(),
500 let error_code = Readable::read(reader)?;
502 let error_data = Readable::read(reader)?;
503 let mut payment_hash = PaymentHash([0; 32]);
504 let mut rejected_by_dest = false;
505 let mut network_update = None;
506 let mut all_paths_failed = Some(true);
507 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
508 let mut short_channel_id = None;
509 let mut retry = None;
510 let mut payment_id = None;
511 read_tlv_fields!(reader, {
512 (0, payment_hash, required),
513 (1, network_update, ignorable),
514 (2, rejected_by_dest, required),
515 (3, all_paths_failed, option),
517 (7, short_channel_id, option),
519 (11, payment_id, option),
521 Ok(Some(Event::PaymentPathFailed {
526 all_paths_failed: all_paths_failed.unwrap(),
541 let mut outputs = VecReadWrapper(Vec::new());
542 read_tlv_fields!(reader, {
543 (0, outputs, required),
545 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
551 let mut fee_earned_msat = None;
552 let mut claim_from_onchain_tx = false;
553 read_tlv_fields!(reader, {
554 (0, fee_earned_msat, option),
555 (2, claim_from_onchain_tx, required),
557 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
563 let mut channel_id = [0; 32];
564 let mut reason = None;
565 let mut user_channel_id_opt = None;
566 read_tlv_fields!(reader, {
567 (0, channel_id, required),
568 (1, user_channel_id_opt, option),
569 (2, reason, ignorable),
571 if reason.is_none() { return Ok(None); }
572 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
573 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
579 let mut channel_id = [0; 32];
580 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
581 read_tlv_fields!(reader, {
582 (0, channel_id, required),
583 (2, transaction, required),
585 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
589 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
590 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
593 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
594 // which prefixes the whole thing with a length BigSize. Because the event is
595 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
596 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
597 // exactly the number of bytes specified, ignoring them entirely.
598 let tlv_len: BigSize = Readable::read(reader)?;
599 FixedLengthReader::new(reader, tlv_len.0)
600 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
603 _ => Err(msgs::DecodeError::InvalidValue)
608 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
609 /// broadcast to most peers).
610 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
611 #[derive(Clone, Debug)]
612 pub enum MessageSendEvent {
613 /// Used to indicate that we've accepted a channel open and should send the accept_channel
614 /// message provided to the given peer.
616 /// The node_id of the node which should receive this message
618 /// The message which should be sent.
619 msg: msgs::AcceptChannel,
621 /// Used to indicate that we've initiated a channel open and should send the open_channel
622 /// message provided to the given peer.
624 /// The node_id of the node which should receive this message
626 /// The message which should be sent.
627 msg: msgs::OpenChannel,
629 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
631 /// The node_id of the node which should receive this message
633 /// The message which should be sent.
634 msg: msgs::FundingCreated,
636 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
638 /// The node_id of the node which should receive this message
640 /// The message which should be sent.
641 msg: msgs::FundingSigned,
643 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
645 /// The node_id of the node which should receive these message(s)
647 /// The funding_locked message which should be sent.
648 msg: msgs::FundingLocked,
650 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
651 SendAnnouncementSignatures {
652 /// The node_id of the node which should receive these message(s)
654 /// The announcement_signatures message which should be sent.
655 msg: msgs::AnnouncementSignatures,
657 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
658 /// message should be sent to the peer with the given node_id.
660 /// The node_id of the node which should receive these message(s)
662 /// The update messages which should be sent. ALL messages in the struct should be sent!
663 updates: msgs::CommitmentUpdate,
665 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
667 /// The node_id of the node which should receive this message
669 /// The message which should be sent.
670 msg: msgs::RevokeAndACK,
672 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
674 /// The node_id of the node which should receive this message
676 /// The message which should be sent.
677 msg: msgs::ClosingSigned,
679 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
681 /// The node_id of the node which should receive this message
683 /// The message which should be sent.
686 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
687 SendChannelReestablish {
688 /// The node_id of the node which should receive this message
690 /// The message which should be sent.
691 msg: msgs::ChannelReestablish,
693 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
694 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
696 /// Note that after doing so, you very likely (unless you did so very recently) want to call
697 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
698 /// This ensures that any nodes which see our channel_announcement also have a relevant
699 /// node_announcement, including relevant feature flags which may be important for routing
700 /// through or to us.
701 BroadcastChannelAnnouncement {
702 /// The channel_announcement which should be sent.
703 msg: msgs::ChannelAnnouncement,
704 /// The followup channel_update which should be sent.
705 update_msg: msgs::ChannelUpdate,
707 /// Used to indicate that a node_announcement should be broadcast to all peers.
708 BroadcastNodeAnnouncement {
709 /// The node_announcement which should be sent.
710 msg: msgs::NodeAnnouncement,
712 /// Used to indicate that a channel_update should be broadcast to all peers.
713 BroadcastChannelUpdate {
714 /// The channel_update which should be sent.
715 msg: msgs::ChannelUpdate,
717 /// Used to indicate that a channel_update should be sent to a single peer.
718 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
719 /// private channel and we shouldn't be informing all of our peers of channel parameters.
721 /// The node_id of the node which should receive this message
723 /// The channel_update which should be sent.
724 msg: msgs::ChannelUpdate,
726 /// Broadcast an error downstream to be handled
728 /// The node_id of the node which should receive this message
730 /// The action which should be taken.
731 action: msgs::ErrorAction
733 /// Query a peer for channels with funding transaction UTXOs in a block range.
734 SendChannelRangeQuery {
735 /// The node_id of this message recipient
737 /// The query_channel_range which should be sent.
738 msg: msgs::QueryChannelRange,
740 /// Request routing gossip messages from a peer for a list of channels identified by
741 /// their short_channel_ids.
743 /// The node_id of this message recipient
745 /// The query_short_channel_ids which should be sent.
746 msg: msgs::QueryShortChannelIds,
748 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
749 /// emitted during processing of the query.
750 SendReplyChannelRange {
751 /// The node_id of this message recipient
753 /// The reply_channel_range which should be sent.
754 msg: msgs::ReplyChannelRange,
758 /// A trait indicating an object may generate message send events
759 pub trait MessageSendEventsProvider {
760 /// Gets the list of pending events which were generated by previous actions, clearing the list
762 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
765 /// A trait indicating an object may generate events.
767 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
771 /// See [`process_pending_events`] for requirements around event processing.
773 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
774 /// event since the last invocation. The handler must either act upon the event immediately
775 /// or preserve it for later handling.
777 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
778 /// consult the provider's documentation on the implication of processing events and how a handler
779 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
780 /// [`ChainMonitor::process_pending_events`]).
782 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
785 /// [`process_pending_events`]: Self::process_pending_events
786 /// [`handle_event`]: EventHandler::handle_event
787 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
788 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
789 pub trait EventsProvider {
790 /// Processes any events generated since the last call using the given event handler.
792 /// Subsequent calls must only process new events. However, handlers must be capable of handling
793 /// duplicate events across process restarts. This may occur if the provider was recovered from
794 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
795 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
798 /// A trait implemented for objects handling events from [`EventsProvider`].
799 pub trait EventHandler {
800 /// Handles the given [`Event`].
802 /// See [`EventsProvider`] for details that must be considered when implementing this method.
803 fn handle_event(&self, event: &Event);
806 impl<F> EventHandler for F where F: Fn(&Event) {
807 fn handle_event(&self, event: &Event) {
812 impl<T: EventHandler> EventHandler for Arc<T> {
813 fn handle_event(&self, event: &Event) {
814 self.deref().handle_event(event)