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,
63 /// This is the `user_payment_id` which was provided to
64 /// [`ChannelManager::create_inbound_payment_for_hash`] or
65 /// [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
66 /// simply copied here. It may be used to correlate PaymentReceived events with invoice
67 /// metadata stored elsewhere.
69 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
70 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
73 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
74 /// (the payee) providing a preimage.
75 SpontaneousPayment(PaymentPreimage),
78 #[derive(Clone, Debug, PartialEq)]
79 /// The reason the channel was closed. See individual variants more details.
80 pub enum ClosureReason {
81 /// Closure generated from receiving a peer error message.
83 /// Our counterparty may have broadcasted their latest commitment state, and we have
85 CounterpartyForceClosed {
86 /// The error which the peer sent us.
88 /// The string should be sanitized before it is used (e.g emitted to logs
89 /// or printed to stdout). Otherwise, a well crafted error message may exploit
90 /// a security vulnerability in the terminal emulator or the logging subsystem.
93 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
95 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
97 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
98 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
99 //TODO: split between CounterpartyInitiated/LocallyInitiated
101 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
102 /// commitment transaction came from our counterparty, but it may also have come from
103 /// a copy of our own `ChannelMonitor`.
104 CommitmentTxConfirmed,
105 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
107 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
109 /// A developer-readable error message which we generated.
112 /// The `PeerManager` informed us that we've disconnected from the peer. We close channels
113 /// if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
114 /// peer again in the future or if the peer disconnected before we finished negotiating
115 /// the channel open. The first case may be caused by incompatible features which our
116 /// counterparty, or we, require.
117 //TODO: split between PeerUnconnectable/PeerDisconnected ?
119 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
120 /// the ChannelManager deserialized.
121 OutdatedChannelManager
124 impl core::fmt::Display for ClosureReason {
125 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
126 f.write_str("Channel closed because ")?;
128 ClosureReason::CounterpartyForceClosed { peer_msg } => {
129 f.write_str("counterparty force-closed with message ")?;
130 f.write_str(&peer_msg)
132 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
133 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
134 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
135 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
136 ClosureReason::ProcessingError { err } => {
137 f.write_str("of an exception: ")?;
140 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
141 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
146 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
147 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
148 (1, FundingTimedOut) => {},
149 (2, HolderForceClosed) => {},
150 (6, CommitmentTxConfirmed) => {},
151 (4, CooperativeClosure) => {},
152 (8, ProcessingError) => { (1, err, required) },
153 (10, DisconnectedPeer) => {},
154 (12, OutdatedChannelManager) => {},
157 /// An Event which you should probably take some action in response to.
159 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
160 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
161 /// written as it makes no sense to respond to it after reconnecting to peers).
162 #[derive(Clone, Debug)]
164 /// Used to indicate that the client should generate a funding transaction with the given
165 /// parameters and then call ChannelManager::funding_transaction_generated.
166 /// Generated in ChannelManager message handling.
167 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
168 /// counterparty can steal your funds!
169 FundingGenerationReady {
170 /// The random channel_id we picked which you'll need to pass into
171 /// ChannelManager::funding_transaction_generated.
172 temporary_channel_id: [u8; 32],
173 /// The value, in satoshis, that the output should have.
174 channel_value_satoshis: u64,
175 /// The script which should be used in the transaction output.
176 output_script: Script,
177 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
178 /// an inbound channel.
180 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
181 user_channel_id: u64,
183 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
184 /// [`ChannelManager::claim_funds`] to get it....
185 /// Note that if the preimage is not known, you should call
186 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
187 /// network congestion.
188 /// If you fail to call either [`ChannelManager::claim_funds`] or
189 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
190 /// automatically failed.
192 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
193 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
195 /// The hash for which the preimage should be handed to the ChannelManager.
196 payment_hash: PaymentHash,
197 /// The value, in thousandths of a satoshi, that this payment is for.
199 /// Information for claiming this received payment, based on whether the purpose of the
200 /// payment is to pay an invoice or to send a spontaneous payment.
201 purpose: PaymentPurpose,
203 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
204 /// and we got back the payment preimage for it).
206 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
207 /// event. In this situation, you SHOULD treat this payment as having succeeded.
209 /// The id returned by [`ChannelManager::send_payment`] and used with
210 /// [`ChannelManager::retry_payment`].
212 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
213 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
214 payment_id: Option<PaymentId>,
215 /// The preimage to the hash given to ChannelManager::send_payment.
216 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
217 /// store it somehow!
218 payment_preimage: PaymentPreimage,
219 /// The hash which was given to [`ChannelManager::send_payment`].
221 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
222 payment_hash: PaymentHash,
223 /// The total fee which was spent at intermediate hops in this payment, across all paths.
225 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
226 /// overpayment to the recipient node.
228 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
229 /// overstate the amount paid, though this is unlikely.
231 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
232 fee_paid_msat: Option<u64>,
234 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
235 /// something. You may wish to retry with a different route.
237 /// The id returned by [`ChannelManager::send_payment`] and used with
238 /// [`ChannelManager::retry_payment`].
240 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
241 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
242 payment_id: Option<PaymentId>,
243 /// The hash which was given to ChannelManager::send_payment.
244 payment_hash: PaymentHash,
245 /// Indicates the payment was rejected for some reason by the recipient. This implies that
246 /// the payment has failed, not just the route in question. If this is not set, you may
247 /// retry the payment via a different route.
248 rejected_by_dest: bool,
249 /// Any failure information conveyed via the Onion return packet by a node along the failed
252 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
253 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
255 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
256 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
257 network_update: Option<NetworkUpdate>,
258 /// For both single-path and multi-path payments, this is set if all paths of the payment have
259 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
260 /// larger MPP payment were still in flight when this event was generated.
261 all_paths_failed: bool,
262 /// The payment path that failed.
264 /// The channel responsible for the failed payment path.
266 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
267 /// retried. May be `None` for older [`Event`] serializations.
268 short_channel_id: Option<u64>,
269 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
271 /// See [`find_route`] for details.
273 /// [`Route`]: crate::routing::router::Route
274 /// [`find_route`]: crate::routing::router::find_route
275 retry: Option<RouteParameters>,
277 error_code: Option<u16>,
279 error_data: Option<Vec<u8>>,
281 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
282 /// time in the future.
283 PendingHTLCsForwardable {
284 /// The minimum amount of time that should be waited prior to calling
285 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
286 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
287 /// now + 5*time_forwardable).
288 time_forwardable: Duration,
290 /// Used to indicate that an output which you should know how to spend was confirmed on chain
291 /// and is now spendable.
292 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
293 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
294 /// somewhere and spend them when you create on-chain transactions.
296 /// The outputs which you should store as spendable by you.
297 outputs: Vec<SpendableOutputDescriptor>,
299 /// This event is generated when a payment has been successfully forwarded through us and a
300 /// forwarding fee earned.
302 /// The fee, in milli-satoshis, which was earned as a result of the payment.
304 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
305 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
306 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
307 /// claimed the full value in millisatoshis from the source. In this case,
308 /// `claim_from_onchain_tx` will be set.
310 /// If the channel which sent us the payment has been force-closed, we will claim the funds
311 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
312 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
313 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
315 fee_earned_msat: Option<u64>,
316 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
318 claim_from_onchain_tx: bool,
320 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
322 /// The channel_id of the channel which has been closed. Note that on-chain transactions
323 /// resolving the channel are likely still awaiting confirmation.
324 channel_id: [u8; 32],
325 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
326 /// an inbound channel. This will always be zero for objects serialized with LDK versions
327 /// prior to 0.0.102.
329 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
330 user_channel_id: u64,
331 /// The reason the channel was closed.
332 reason: ClosureReason
334 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
335 /// inputs for another purpose.
337 /// The channel_id of the channel which has been closed.
338 channel_id: [u8; 32],
339 /// The full transaction received from the user
340 transaction: Transaction
344 impl Writeable for Event {
345 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
347 &Event::FundingGenerationReady { .. } => {
349 // We never write out FundingGenerationReady events as, upon disconnection, peers
350 // drop any channels which have not yet exchanged funding_signed.
352 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
354 let mut payment_secret = None;
355 let mut user_payment_id = None;
356 let payment_preimage;
358 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret, user_payment_id: id } => {
359 payment_secret = Some(secret);
360 payment_preimage = *preimage;
361 user_payment_id = Some(id);
363 PaymentPurpose::SpontaneousPayment(preimage) => {
364 payment_preimage = Some(*preimage);
367 write_tlv_fields!(writer, {
368 (0, payment_hash, required),
369 (2, payment_secret, option),
371 (6, user_payment_id, option),
372 (8, payment_preimage, option),
375 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
377 write_tlv_fields!(writer, {
378 (0, payment_preimage, required),
379 (1, payment_hash, required),
380 (3, payment_id, option),
381 (5, fee_paid_msat, option),
384 &Event::PaymentPathFailed {
385 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
386 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
394 error_code.write(writer)?;
396 error_data.write(writer)?;
397 write_tlv_fields!(writer, {
398 (0, payment_hash, required),
399 (1, network_update, option),
400 (2, rejected_by_dest, required),
401 (3, all_paths_failed, required),
403 (7, short_channel_id, option),
405 (11, payment_id, option),
408 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
410 // Note that we now ignore these on the read end as we'll re-generate them in
411 // ChannelManager, we write them here only for backwards compatibility.
413 &Event::SpendableOutputs { ref outputs } => {
415 write_tlv_fields!(writer, {
416 (0, VecWriteWrapper(outputs), required),
419 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
421 write_tlv_fields!(writer, {
422 (0, fee_earned_msat, option),
423 (2, claim_from_onchain_tx, required),
426 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
428 write_tlv_fields!(writer, {
429 (0, channel_id, required),
430 (1, user_channel_id, required),
431 (2, reason, required)
434 &Event::DiscardFunding { ref channel_id, ref transaction } => {
436 write_tlv_fields!(writer, {
437 (0, channel_id, required),
438 (2, transaction, required)
441 // Note that, going forward, all new events must only write data inside of
442 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
443 // data via `write_tlv_fields`.
448 impl MaybeReadable for Event {
449 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
450 match Readable::read(reader)? {
451 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
452 // unlike all other events, thus we return immediately here.
456 let mut payment_hash = PaymentHash([0; 32]);
457 let mut payment_preimage = None;
458 let mut payment_secret = None;
460 let mut user_payment_id = None;
461 read_tlv_fields!(reader, {
462 (0, payment_hash, required),
463 (2, payment_secret, option),
465 (6, user_payment_id, option),
466 (8, payment_preimage, option),
468 let purpose = match payment_secret {
469 Some(secret) => PaymentPurpose::InvoicePayment {
471 payment_secret: secret,
472 user_payment_id: if let Some(id) = user_payment_id {
474 } else { return Err(msgs::DecodeError::InvalidValue) }
476 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
477 None => return Err(msgs::DecodeError::InvalidValue),
479 Ok(Some(Event::PaymentReceived {
489 let mut payment_preimage = PaymentPreimage([0; 32]);
490 let mut payment_hash = None;
491 let mut payment_id = None;
492 let mut fee_paid_msat = None;
493 read_tlv_fields!(reader, {
494 (0, payment_preimage, required),
495 (1, payment_hash, option),
496 (3, payment_id, option),
497 (5, fee_paid_msat, option),
499 if payment_hash.is_none() {
500 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
502 Ok(Some(Event::PaymentSent {
505 payment_hash: payment_hash.unwrap(),
514 let error_code = Readable::read(reader)?;
516 let error_data = Readable::read(reader)?;
517 let mut payment_hash = PaymentHash([0; 32]);
518 let mut rejected_by_dest = false;
519 let mut network_update = None;
520 let mut all_paths_failed = Some(true);
521 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
522 let mut short_channel_id = None;
523 let mut retry = None;
524 let mut payment_id = None;
525 read_tlv_fields!(reader, {
526 (0, payment_hash, required),
527 (1, network_update, ignorable),
528 (2, rejected_by_dest, required),
529 (3, all_paths_failed, option),
531 (7, short_channel_id, option),
533 (11, payment_id, option),
535 Ok(Some(Event::PaymentPathFailed {
540 all_paths_failed: all_paths_failed.unwrap(),
555 let mut outputs = VecReadWrapper(Vec::new());
556 read_tlv_fields!(reader, {
557 (0, outputs, required),
559 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
565 let mut fee_earned_msat = None;
566 let mut claim_from_onchain_tx = false;
567 read_tlv_fields!(reader, {
568 (0, fee_earned_msat, option),
569 (2, claim_from_onchain_tx, required),
571 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
577 let mut channel_id = [0; 32];
578 let mut reason = None;
579 let mut user_channel_id_opt = None;
580 read_tlv_fields!(reader, {
581 (0, channel_id, required),
582 (1, user_channel_id_opt, option),
583 (2, reason, ignorable),
585 if reason.is_none() { return Ok(None); }
586 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
587 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
593 let mut channel_id = [0; 32];
594 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
595 read_tlv_fields!(reader, {
596 (0, channel_id, required),
597 (2, transaction, required),
599 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
603 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
604 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
607 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
608 // which prefixes the whole thing with a length BigSize. Because the event is
609 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
610 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
611 // exactly the number of bytes specified, ignoring them entirely.
612 let tlv_len: BigSize = Readable::read(reader)?;
613 FixedLengthReader::new(reader, tlv_len.0)
614 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
617 _ => Err(msgs::DecodeError::InvalidValue)
622 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
623 /// broadcast to most peers).
624 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
625 #[derive(Clone, Debug)]
626 pub enum MessageSendEvent {
627 /// Used to indicate that we've accepted a channel open and should send the accept_channel
628 /// message provided to the given peer.
630 /// The node_id of the node which should receive this message
632 /// The message which should be sent.
633 msg: msgs::AcceptChannel,
635 /// Used to indicate that we've initiated a channel open and should send the open_channel
636 /// message provided to the given peer.
638 /// The node_id of the node which should receive this message
640 /// The message which should be sent.
641 msg: msgs::OpenChannel,
643 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
645 /// The node_id of the node which should receive this message
647 /// The message which should be sent.
648 msg: msgs::FundingCreated,
650 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
652 /// The node_id of the node which should receive this message
654 /// The message which should be sent.
655 msg: msgs::FundingSigned,
657 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
659 /// The node_id of the node which should receive these message(s)
661 /// The funding_locked message which should be sent.
662 msg: msgs::FundingLocked,
664 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
665 SendAnnouncementSignatures {
666 /// The node_id of the node which should receive these message(s)
668 /// The announcement_signatures message which should be sent.
669 msg: msgs::AnnouncementSignatures,
671 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
672 /// message should be sent to the peer with the given node_id.
674 /// The node_id of the node which should receive these message(s)
676 /// The update messages which should be sent. ALL messages in the struct should be sent!
677 updates: msgs::CommitmentUpdate,
679 /// Used to indicate that a revoke_and_ack 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.
684 msg: msgs::RevokeAndACK,
686 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
688 /// The node_id of the node which should receive this message
690 /// The message which should be sent.
691 msg: msgs::ClosingSigned,
693 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
695 /// The node_id of the node which should receive this message
697 /// The message which should be sent.
700 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
701 SendChannelReestablish {
702 /// The node_id of the node which should receive this message
704 /// The message which should be sent.
705 msg: msgs::ChannelReestablish,
707 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
708 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
710 /// Note that after doing so, you very likely (unless you did so very recently) want to call
711 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
712 /// This ensures that any nodes which see our channel_announcement also have a relevant
713 /// node_announcement, including relevant feature flags which may be important for routing
714 /// through or to us.
715 BroadcastChannelAnnouncement {
716 /// The channel_announcement which should be sent.
717 msg: msgs::ChannelAnnouncement,
718 /// The followup channel_update which should be sent.
719 update_msg: msgs::ChannelUpdate,
721 /// Used to indicate that a node_announcement should be broadcast to all peers.
722 BroadcastNodeAnnouncement {
723 /// The node_announcement which should be sent.
724 msg: msgs::NodeAnnouncement,
726 /// Used to indicate that a channel_update should be broadcast to all peers.
727 BroadcastChannelUpdate {
728 /// The channel_update which should be sent.
729 msg: msgs::ChannelUpdate,
731 /// Used to indicate that a channel_update should be sent to a single peer.
732 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
733 /// private channel and we shouldn't be informing all of our peers of channel parameters.
735 /// The node_id of the node which should receive this message
737 /// The channel_update which should be sent.
738 msg: msgs::ChannelUpdate,
740 /// Broadcast an error downstream to be handled
742 /// The node_id of the node which should receive this message
744 /// The action which should be taken.
745 action: msgs::ErrorAction
747 /// Query a peer for channels with funding transaction UTXOs in a block range.
748 SendChannelRangeQuery {
749 /// The node_id of this message recipient
751 /// The query_channel_range which should be sent.
752 msg: msgs::QueryChannelRange,
754 /// Request routing gossip messages from a peer for a list of channels identified by
755 /// their short_channel_ids.
757 /// The node_id of this message recipient
759 /// The query_short_channel_ids which should be sent.
760 msg: msgs::QueryShortChannelIds,
762 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
763 /// emitted during processing of the query.
764 SendReplyChannelRange {
765 /// The node_id of this message recipient
767 /// The reply_channel_range which should be sent.
768 msg: msgs::ReplyChannelRange,
772 /// A trait indicating an object may generate message send events
773 pub trait MessageSendEventsProvider {
774 /// Gets the list of pending events which were generated by previous actions, clearing the list
776 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
779 /// A trait indicating an object may generate events.
781 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
785 /// See [`process_pending_events`] for requirements around event processing.
787 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
788 /// event since the last invocation. The handler must either act upon the event immediately
789 /// or preserve it for later handling.
791 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
792 /// consult the provider's documentation on the implication of processing events and how a handler
793 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
794 /// [`ChainMonitor::process_pending_events`]).
796 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
799 /// [`process_pending_events`]: Self::process_pending_events
800 /// [`handle_event`]: EventHandler::handle_event
801 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
802 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
803 pub trait EventsProvider {
804 /// Processes any events generated since the last call using the given event handler.
806 /// Subsequent calls must only process new events. However, handlers must be capable of handling
807 /// duplicate events across process restarts. This may occur if the provider was recovered from
808 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
809 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
812 /// A trait implemented for objects handling events from [`EventsProvider`].
813 pub trait EventHandler {
814 /// Handles the given [`Event`].
816 /// See [`EventsProvider`] for details that must be considered when implementing this method.
817 fn handle_event(&self, event: &Event);
820 impl<F> EventHandler for F where F: Fn(&Event) {
821 fn handle_event(&self, event: &Event) {
826 impl<T: EventHandler> EventHandler for Arc<T> {
827 fn handle_event(&self, event: &Event) {
828 self.deref().handle_event(event)