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 that 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 that was given to [`ChannelManager::send_payment`].
236 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
237 payment_hash: PaymentHash,
238 /// Indicates the payment was rejected for some reason by the recipient. This implies that
239 /// the payment has failed, not just the route in question. If this is not set, you may
240 /// retry the payment via a different route.
241 rejected_by_dest: bool,
242 /// Any failure information conveyed via the Onion return packet by a node along the failed
245 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
246 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
248 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
249 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
250 network_update: Option<NetworkUpdate>,
251 /// For both single-path and multi-path payments, this is set if all paths of the payment have
252 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
253 /// larger MPP payment were still in flight when this event was generated.
254 all_paths_failed: bool,
255 /// The payment path that failed.
257 /// The channel responsible for the failed payment path.
259 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
260 /// retried. May be `None` for older [`Event`] serializations.
261 short_channel_id: Option<u64>,
262 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
264 /// See [`find_route`] for details.
266 /// [`Route`]: crate::routing::router::Route
267 /// [`find_route`]: crate::routing::router::find_route
268 retry: Option<RouteParameters>,
270 error_code: Option<u16>,
272 error_data: Option<Vec<u8>>,
274 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
275 /// time in the future.
276 PendingHTLCsForwardable {
277 /// The minimum amount of time that should be waited prior to calling
278 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
279 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
280 /// now + 5*time_forwardable).
281 time_forwardable: Duration,
283 /// Used to indicate that an output which you should know how to spend was confirmed on chain
284 /// and is now spendable.
285 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
286 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
287 /// somewhere and spend them when you create on-chain transactions.
289 /// The outputs which you should store as spendable by you.
290 outputs: Vec<SpendableOutputDescriptor>,
292 /// This event is generated when a payment has been successfully forwarded through us and a
293 /// forwarding fee earned.
295 /// The fee, in milli-satoshis, which was earned as a result of the payment.
297 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
298 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
299 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
300 /// claimed the full value in millisatoshis from the source. In this case,
301 /// `claim_from_onchain_tx` will be set.
303 /// If the channel which sent us the payment has been force-closed, we will claim the funds
304 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
305 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
306 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
308 fee_earned_msat: Option<u64>,
309 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
311 claim_from_onchain_tx: bool,
313 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
315 /// The channel_id of the channel which has been closed. Note that on-chain transactions
316 /// resolving the channel are likely still awaiting confirmation.
317 channel_id: [u8; 32],
318 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
319 /// an inbound channel. This will always be zero for objects serialized with LDK versions
320 /// prior to 0.0.102.
322 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
323 user_channel_id: u64,
324 /// The reason the channel was closed.
325 reason: ClosureReason
327 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
328 /// inputs for another purpose.
330 /// The channel_id of the channel which has been closed.
331 channel_id: [u8; 32],
332 /// The full transaction received from the user
333 transaction: Transaction
335 /// Indicates that a path for an outbound payment was successful.
337 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
338 /// [`Event::PaymentSent`] for obtaining the payment preimage.
339 PaymentPathSuccessful {
340 /// The id returned by [`ChannelManager::send_payment`] and used with
341 /// [`ChannelManager::retry_payment`].
343 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
344 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
345 payment_id: PaymentId,
346 /// The hash that was given to [`ChannelManager::send_payment`].
348 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
349 payment_hash: Option<PaymentHash>,
350 /// The payment path that was successful.
352 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
357 impl Writeable for Event {
358 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
360 &Event::FundingGenerationReady { .. } => {
362 // We never write out FundingGenerationReady events as, upon disconnection, peers
363 // drop any channels which have not yet exchanged funding_signed.
365 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
367 let mut payment_secret = None;
368 let payment_preimage;
370 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
371 payment_secret = Some(secret);
372 payment_preimage = *preimage;
374 PaymentPurpose::SpontaneousPayment(preimage) => {
375 payment_preimage = Some(*preimage);
378 write_tlv_fields!(writer, {
379 (0, payment_hash, required),
380 (2, payment_secret, option),
382 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
383 (8, payment_preimage, option),
386 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
388 write_tlv_fields!(writer, {
389 (0, payment_preimage, required),
390 (1, payment_hash, required),
391 (3, payment_id, option),
392 (5, fee_paid_msat, option),
395 &Event::PaymentPathFailed {
396 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
397 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
405 error_code.write(writer)?;
407 error_data.write(writer)?;
408 write_tlv_fields!(writer, {
409 (0, payment_hash, required),
410 (1, network_update, option),
411 (2, rejected_by_dest, required),
412 (3, all_paths_failed, required),
414 (7, short_channel_id, option),
416 (11, payment_id, option),
419 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
421 // Note that we now ignore these on the read end as we'll re-generate them in
422 // ChannelManager, we write them here only for backwards compatibility.
424 &Event::SpendableOutputs { ref outputs } => {
426 write_tlv_fields!(writer, {
427 (0, VecWriteWrapper(outputs), required),
430 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
432 write_tlv_fields!(writer, {
433 (0, fee_earned_msat, option),
434 (2, claim_from_onchain_tx, required),
437 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
439 write_tlv_fields!(writer, {
440 (0, channel_id, required),
441 (1, user_channel_id, required),
442 (2, reason, required)
445 &Event::DiscardFunding { ref channel_id, ref transaction } => {
447 write_tlv_fields!(writer, {
448 (0, channel_id, required),
449 (2, transaction, required)
452 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
454 write_tlv_fields!(writer, {
455 (0, payment_id, required),
456 (2, payment_hash, option),
460 // Note that, going forward, all new events must only write data inside of
461 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
462 // data via `write_tlv_fields`.
467 impl MaybeReadable for Event {
468 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
469 match Readable::read(reader)? {
470 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
471 // unlike all other events, thus we return immediately here.
475 let mut payment_hash = PaymentHash([0; 32]);
476 let mut payment_preimage = None;
477 let mut payment_secret = None;
479 let mut _user_payment_id = None; // For compatibility with 0.0.103 and earlier
480 read_tlv_fields!(reader, {
481 (0, payment_hash, required),
482 (2, payment_secret, option),
484 (6, _user_payment_id, option),
485 (8, payment_preimage, option),
487 let purpose = match payment_secret {
488 Some(secret) => PaymentPurpose::InvoicePayment {
490 payment_secret: secret
492 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
493 None => return Err(msgs::DecodeError::InvalidValue),
495 Ok(Some(Event::PaymentReceived {
505 let mut payment_preimage = PaymentPreimage([0; 32]);
506 let mut payment_hash = None;
507 let mut payment_id = None;
508 let mut fee_paid_msat = None;
509 read_tlv_fields!(reader, {
510 (0, payment_preimage, required),
511 (1, payment_hash, option),
512 (3, payment_id, option),
513 (5, fee_paid_msat, option),
515 if payment_hash.is_none() {
516 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
518 Ok(Some(Event::PaymentSent {
521 payment_hash: payment_hash.unwrap(),
530 let error_code = Readable::read(reader)?;
532 let error_data = Readable::read(reader)?;
533 let mut payment_hash = PaymentHash([0; 32]);
534 let mut rejected_by_dest = false;
535 let mut network_update = None;
536 let mut all_paths_failed = Some(true);
537 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
538 let mut short_channel_id = None;
539 let mut retry = None;
540 let mut payment_id = None;
541 read_tlv_fields!(reader, {
542 (0, payment_hash, required),
543 (1, network_update, ignorable),
544 (2, rejected_by_dest, required),
545 (3, all_paths_failed, option),
547 (7, short_channel_id, option),
549 (11, payment_id, option),
551 Ok(Some(Event::PaymentPathFailed {
556 all_paths_failed: all_paths_failed.unwrap(),
571 let mut outputs = VecReadWrapper(Vec::new());
572 read_tlv_fields!(reader, {
573 (0, outputs, required),
575 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
581 let mut fee_earned_msat = None;
582 let mut claim_from_onchain_tx = false;
583 read_tlv_fields!(reader, {
584 (0, fee_earned_msat, option),
585 (2, claim_from_onchain_tx, required),
587 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
593 let mut channel_id = [0; 32];
594 let mut reason = None;
595 let mut user_channel_id_opt = None;
596 read_tlv_fields!(reader, {
597 (0, channel_id, required),
598 (1, user_channel_id_opt, option),
599 (2, reason, ignorable),
601 if reason.is_none() { return Ok(None); }
602 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
603 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
609 let mut channel_id = [0; 32];
610 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
611 read_tlv_fields!(reader, {
612 (0, channel_id, required),
613 (2, transaction, required),
615 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
621 let mut payment_id = PaymentId([0; 32]);
622 let mut payment_hash = None;
623 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
624 read_tlv_fields!(reader, {
625 (0, payment_id, required),
626 (2, payment_hash, option),
629 Ok(Some(Event::PaymentPathSuccessful {
637 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
638 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
641 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
642 // which prefixes the whole thing with a length BigSize. Because the event is
643 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
644 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
645 // exactly the number of bytes specified, ignoring them entirely.
646 let tlv_len: BigSize = Readable::read(reader)?;
647 FixedLengthReader::new(reader, tlv_len.0)
648 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
651 _ => Err(msgs::DecodeError::InvalidValue)
656 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
657 /// broadcast to most peers).
658 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
659 #[derive(Clone, Debug)]
660 pub enum MessageSendEvent {
661 /// Used to indicate that we've accepted a channel open and should send the accept_channel
662 /// message provided to the given peer.
664 /// The node_id of the node which should receive this message
666 /// The message which should be sent.
667 msg: msgs::AcceptChannel,
669 /// Used to indicate that we've initiated a channel open and should send the open_channel
670 /// message provided to the given peer.
672 /// The node_id of the node which should receive this message
674 /// The message which should be sent.
675 msg: msgs::OpenChannel,
677 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
679 /// The node_id of the node which should receive this message
681 /// The message which should be sent.
682 msg: msgs::FundingCreated,
684 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
686 /// The node_id of the node which should receive this message
688 /// The message which should be sent.
689 msg: msgs::FundingSigned,
691 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
693 /// The node_id of the node which should receive these message(s)
695 /// The funding_locked message which should be sent.
696 msg: msgs::FundingLocked,
698 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
699 SendAnnouncementSignatures {
700 /// The node_id of the node which should receive these message(s)
702 /// The announcement_signatures message which should be sent.
703 msg: msgs::AnnouncementSignatures,
705 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
706 /// message should be sent to the peer with the given node_id.
708 /// The node_id of the node which should receive these message(s)
710 /// The update messages which should be sent. ALL messages in the struct should be sent!
711 updates: msgs::CommitmentUpdate,
713 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
715 /// The node_id of the node which should receive this message
717 /// The message which should be sent.
718 msg: msgs::RevokeAndACK,
720 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
722 /// The node_id of the node which should receive this message
724 /// The message which should be sent.
725 msg: msgs::ClosingSigned,
727 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
729 /// The node_id of the node which should receive this message
731 /// The message which should be sent.
734 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
735 SendChannelReestablish {
736 /// The node_id of the node which should receive this message
738 /// The message which should be sent.
739 msg: msgs::ChannelReestablish,
741 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
742 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
744 /// Note that after doing so, you very likely (unless you did so very recently) want to call
745 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
746 /// This ensures that any nodes which see our channel_announcement also have a relevant
747 /// node_announcement, including relevant feature flags which may be important for routing
748 /// through or to us.
749 BroadcastChannelAnnouncement {
750 /// The channel_announcement which should be sent.
751 msg: msgs::ChannelAnnouncement,
752 /// The followup channel_update which should be sent.
753 update_msg: msgs::ChannelUpdate,
755 /// Used to indicate that a node_announcement should be broadcast to all peers.
756 BroadcastNodeAnnouncement {
757 /// The node_announcement which should be sent.
758 msg: msgs::NodeAnnouncement,
760 /// Used to indicate that a channel_update should be broadcast to all peers.
761 BroadcastChannelUpdate {
762 /// The channel_update which should be sent.
763 msg: msgs::ChannelUpdate,
765 /// Used to indicate that a channel_update should be sent to a single peer.
766 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
767 /// private channel and we shouldn't be informing all of our peers of channel parameters.
769 /// The node_id of the node which should receive this message
771 /// The channel_update which should be sent.
772 msg: msgs::ChannelUpdate,
774 /// Broadcast an error downstream to be handled
776 /// The node_id of the node which should receive this message
778 /// The action which should be taken.
779 action: msgs::ErrorAction
781 /// Query a peer for channels with funding transaction UTXOs in a block range.
782 SendChannelRangeQuery {
783 /// The node_id of this message recipient
785 /// The query_channel_range which should be sent.
786 msg: msgs::QueryChannelRange,
788 /// Request routing gossip messages from a peer for a list of channels identified by
789 /// their short_channel_ids.
791 /// The node_id of this message recipient
793 /// The query_short_channel_ids which should be sent.
794 msg: msgs::QueryShortChannelIds,
796 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
797 /// emitted during processing of the query.
798 SendReplyChannelRange {
799 /// The node_id of this message recipient
801 /// The reply_channel_range which should be sent.
802 msg: msgs::ReplyChannelRange,
806 /// A trait indicating an object may generate message send events
807 pub trait MessageSendEventsProvider {
808 /// Gets the list of pending events which were generated by previous actions, clearing the list
810 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
813 /// A trait indicating an object may generate events.
815 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
819 /// See [`process_pending_events`] for requirements around event processing.
821 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
822 /// event since the last invocation. The handler must either act upon the event immediately
823 /// or preserve it for later handling.
825 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
826 /// consult the provider's documentation on the implication of processing events and how a handler
827 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
828 /// [`ChainMonitor::process_pending_events`]).
830 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
833 /// [`process_pending_events`]: Self::process_pending_events
834 /// [`handle_event`]: EventHandler::handle_event
835 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
836 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
837 pub trait EventsProvider {
838 /// Processes any events generated since the last call using the given event handler.
840 /// Subsequent calls must only process new events. However, handlers must be capable of handling
841 /// duplicate events across process restarts. This may occur if the provider was recovered from
842 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
843 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
846 /// A trait implemented for objects handling events from [`EventsProvider`].
847 pub trait EventHandler {
848 /// Handles the given [`Event`].
850 /// See [`EventsProvider`] for details that must be considered when implementing this method.
851 fn handle_event(&self, event: &Event);
854 impl<F> EventHandler for F where F: Fn(&Event) {
855 fn handle_event(&self, event: &Event) {
860 impl<T: EventHandler> EventHandler for Arc<T> {
861 fn handle_event(&self, event: &Event) {
862 self.deref().handle_event(event)