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!
161 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
162 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
163 FundingGenerationReady {
164 /// The random channel_id we picked which you'll need to pass into
165 /// ChannelManager::funding_transaction_generated.
166 temporary_channel_id: [u8; 32],
167 /// The value, in satoshis, that the output should have.
168 channel_value_satoshis: u64,
169 /// The script which should be used in the transaction output.
170 output_script: Script,
171 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
172 /// an inbound channel.
174 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
175 user_channel_id: u64,
177 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
178 /// [`ChannelManager::claim_funds`] to get it....
179 /// Note that if the preimage is not known, you should call
180 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
181 /// network congestion.
182 /// If you fail to call either [`ChannelManager::claim_funds`] or
183 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
184 /// automatically failed.
186 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
187 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
189 /// The hash for which the preimage should be handed to the ChannelManager.
190 payment_hash: PaymentHash,
191 /// The value, in thousandths of a satoshi, that this payment is for.
193 /// Information for claiming this received payment, based on whether the purpose of the
194 /// payment is to pay an invoice or to send a spontaneous payment.
195 purpose: PaymentPurpose,
197 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
198 /// and we got back the payment preimage for it).
200 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
201 /// event. In this situation, you SHOULD treat this payment as having succeeded.
203 /// The id returned by [`ChannelManager::send_payment`] and used with
204 /// [`ChannelManager::retry_payment`].
206 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
207 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
208 payment_id: Option<PaymentId>,
209 /// The preimage to the hash given to ChannelManager::send_payment.
210 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
211 /// store it somehow!
212 payment_preimage: PaymentPreimage,
213 /// The hash that was given to [`ChannelManager::send_payment`].
215 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
216 payment_hash: PaymentHash,
217 /// The total fee which was spent at intermediate hops in this payment, across all paths.
219 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
220 /// overpayment to the recipient node.
222 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
223 /// overstate the amount paid, though this is unlikely.
225 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
226 fee_paid_msat: Option<u64>,
228 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
229 /// something. You may wish to retry with a different route.
231 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
232 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
234 /// [`all_paths_failed`]: Self::all_paths_failed
236 /// The id returned by [`ChannelManager::send_payment`] and used with
237 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
239 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
240 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
241 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
242 payment_id: Option<PaymentId>,
243 /// The hash that was given to [`ChannelManager::send_payment`].
245 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
246 payment_hash: PaymentHash,
247 /// Indicates the payment was rejected for some reason by the recipient. This implies that
248 /// the payment has failed, not just the route in question. If this is not set, you may
249 /// retry the payment via a different route.
250 rejected_by_dest: bool,
251 /// Any failure information conveyed via the Onion return packet by a node along the failed
254 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
255 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
257 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
258 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
259 network_update: Option<NetworkUpdate>,
260 /// For both single-path and multi-path payments, this is set if all paths of the payment have
261 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
262 /// larger MPP payment were still in flight when this event was generated.
264 /// Note that if you are retrying individual MPP parts, using this value to determine if a
265 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
266 /// being processed, you may retry in response to a first failure, with a second failure
267 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
268 /// you will see `all_paths_failed` set even though the retry of the first failure still
269 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
271 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
272 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
274 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
276 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
277 all_paths_failed: bool,
278 /// The payment path that failed.
280 /// The channel responsible for the failed payment path.
282 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
283 /// retried. May be `None` for older [`Event`] serializations.
284 short_channel_id: Option<u64>,
285 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
287 /// See [`find_route`] for details.
289 /// [`Route`]: crate::routing::router::Route
290 /// [`find_route`]: crate::routing::router::find_route
291 retry: Option<RouteParameters>,
293 error_code: Option<u16>,
295 error_data: Option<Vec<u8>>,
297 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
298 /// provide failure information for each MPP part in the payment.
300 /// This event is provided once there are no further pending HTLCs for the payment and the
301 /// payment is no longer retryable, either due to a several-block timeout or because
302 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
304 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
306 /// The id returned by [`ChannelManager::send_payment`] and used with
307 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
309 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
310 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
311 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
312 payment_id: PaymentId,
313 /// The hash that was given to [`ChannelManager::send_payment`].
315 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
316 payment_hash: PaymentHash,
318 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
319 /// a time in the future.
321 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
322 PendingHTLCsForwardable {
323 /// The minimum amount of time that should be waited prior to calling
324 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
325 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
326 /// now + 5*time_forwardable).
327 time_forwardable: Duration,
329 /// Used to indicate that an output which you should know how to spend was confirmed on chain
330 /// and is now spendable.
331 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
332 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
333 /// somewhere and spend them when you create on-chain transactions.
335 /// The outputs which you should store as spendable by you.
336 outputs: Vec<SpendableOutputDescriptor>,
338 /// This event is generated when a payment has been successfully forwarded through us and a
339 /// forwarding fee earned.
341 /// The fee, in milli-satoshis, which was earned as a result of the payment.
343 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
344 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
345 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
346 /// claimed the full value in millisatoshis from the source. In this case,
347 /// `claim_from_onchain_tx` will be set.
349 /// If the channel which sent us the payment has been force-closed, we will claim the funds
350 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
351 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
352 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
354 fee_earned_msat: Option<u64>,
355 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
357 claim_from_onchain_tx: bool,
359 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
361 /// The channel_id of the channel which has been closed. Note that on-chain transactions
362 /// resolving the channel are likely still awaiting confirmation.
363 channel_id: [u8; 32],
364 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
365 /// an inbound channel. This will always be zero for objects serialized with LDK versions
366 /// prior to 0.0.102.
368 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
369 user_channel_id: u64,
370 /// The reason the channel was closed.
371 reason: ClosureReason
373 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
374 /// inputs for another purpose.
376 /// The channel_id of the channel which has been closed.
377 channel_id: [u8; 32],
378 /// The full transaction received from the user
379 transaction: Transaction
381 /// Indicates that a path for an outbound payment was successful.
383 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
384 /// [`Event::PaymentSent`] for obtaining the payment preimage.
385 PaymentPathSuccessful {
386 /// The id returned by [`ChannelManager::send_payment`] and used with
387 /// [`ChannelManager::retry_payment`].
389 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
390 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
391 payment_id: PaymentId,
392 /// The hash that was given to [`ChannelManager::send_payment`].
394 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
395 payment_hash: Option<PaymentHash>,
396 /// The payment path that was successful.
398 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
403 impl Writeable for Event {
404 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
406 &Event::FundingGenerationReady { .. } => {
408 // We never write out FundingGenerationReady events as, upon disconnection, peers
409 // drop any channels which have not yet exchanged funding_signed.
411 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
413 let mut payment_secret = None;
414 let payment_preimage;
416 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
417 payment_secret = Some(secret);
418 payment_preimage = *preimage;
420 PaymentPurpose::SpontaneousPayment(preimage) => {
421 payment_preimage = Some(*preimage);
424 write_tlv_fields!(writer, {
425 (0, payment_hash, required),
426 (2, payment_secret, option),
428 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
429 (8, payment_preimage, option),
432 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
434 write_tlv_fields!(writer, {
435 (0, payment_preimage, required),
436 (1, payment_hash, required),
437 (3, payment_id, option),
438 (5, fee_paid_msat, option),
441 &Event::PaymentPathFailed {
442 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
443 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
451 error_code.write(writer)?;
453 error_data.write(writer)?;
454 write_tlv_fields!(writer, {
455 (0, payment_hash, required),
456 (1, network_update, option),
457 (2, rejected_by_dest, required),
458 (3, all_paths_failed, required),
460 (7, short_channel_id, option),
462 (11, payment_id, option),
465 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
467 // Note that we now ignore these on the read end as we'll re-generate them in
468 // ChannelManager, we write them here only for backwards compatibility.
470 &Event::SpendableOutputs { ref outputs } => {
472 write_tlv_fields!(writer, {
473 (0, VecWriteWrapper(outputs), required),
476 &Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
478 write_tlv_fields!(writer, {
479 (0, fee_earned_msat, option),
480 (2, claim_from_onchain_tx, required),
483 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
485 write_tlv_fields!(writer, {
486 (0, channel_id, required),
487 (1, user_channel_id, required),
488 (2, reason, required)
491 &Event::DiscardFunding { ref channel_id, ref transaction } => {
493 write_tlv_fields!(writer, {
494 (0, channel_id, required),
495 (2, transaction, required)
498 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
500 write_tlv_fields!(writer, {
501 (0, payment_id, required),
502 (2, payment_hash, option),
506 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
508 write_tlv_fields!(writer, {
509 (0, payment_id, required),
510 (2, payment_hash, required),
513 // Note that, going forward, all new events must only write data inside of
514 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
515 // data via `write_tlv_fields`.
520 impl MaybeReadable for Event {
521 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
522 match Readable::read(reader)? {
523 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
524 // unlike all other events, thus we return immediately here.
528 let mut payment_hash = PaymentHash([0; 32]);
529 let mut payment_preimage = None;
530 let mut payment_secret = None;
532 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
533 read_tlv_fields!(reader, {
534 (0, payment_hash, required),
535 (2, payment_secret, option),
537 (6, _user_payment_id, option),
538 (8, payment_preimage, option),
540 let purpose = match payment_secret {
541 Some(secret) => PaymentPurpose::InvoicePayment {
543 payment_secret: secret
545 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
546 None => return Err(msgs::DecodeError::InvalidValue),
548 Ok(Some(Event::PaymentReceived {
558 let mut payment_preimage = PaymentPreimage([0; 32]);
559 let mut payment_hash = None;
560 let mut payment_id = None;
561 let mut fee_paid_msat = None;
562 read_tlv_fields!(reader, {
563 (0, payment_preimage, required),
564 (1, payment_hash, option),
565 (3, payment_id, option),
566 (5, fee_paid_msat, option),
568 if payment_hash.is_none() {
569 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
571 Ok(Some(Event::PaymentSent {
574 payment_hash: payment_hash.unwrap(),
583 let error_code = Readable::read(reader)?;
585 let error_data = Readable::read(reader)?;
586 let mut payment_hash = PaymentHash([0; 32]);
587 let mut rejected_by_dest = false;
588 let mut network_update = None;
589 let mut all_paths_failed = Some(true);
590 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
591 let mut short_channel_id = None;
592 let mut retry = None;
593 let mut payment_id = None;
594 read_tlv_fields!(reader, {
595 (0, payment_hash, required),
596 (1, network_update, ignorable),
597 (2, rejected_by_dest, required),
598 (3, all_paths_failed, option),
600 (7, short_channel_id, option),
602 (11, payment_id, option),
604 Ok(Some(Event::PaymentPathFailed {
609 all_paths_failed: all_paths_failed.unwrap(),
624 let mut outputs = VecReadWrapper(Vec::new());
625 read_tlv_fields!(reader, {
626 (0, outputs, required),
628 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
634 let mut fee_earned_msat = None;
635 let mut claim_from_onchain_tx = false;
636 read_tlv_fields!(reader, {
637 (0, fee_earned_msat, option),
638 (2, claim_from_onchain_tx, required),
640 Ok(Some(Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx }))
646 let mut channel_id = [0; 32];
647 let mut reason = None;
648 let mut user_channel_id_opt = None;
649 read_tlv_fields!(reader, {
650 (0, channel_id, required),
651 (1, user_channel_id_opt, option),
652 (2, reason, ignorable),
654 if reason.is_none() { return Ok(None); }
655 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
656 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
662 let mut channel_id = [0; 32];
663 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
664 read_tlv_fields!(reader, {
665 (0, channel_id, required),
666 (2, transaction, required),
668 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
674 let mut payment_id = PaymentId([0; 32]);
675 let mut payment_hash = None;
676 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
677 read_tlv_fields!(reader, {
678 (0, payment_id, required),
679 (2, payment_hash, option),
682 Ok(Some(Event::PaymentPathSuccessful {
692 let mut payment_hash = PaymentHash([0; 32]);
693 let mut payment_id = PaymentId([0; 32]);
694 read_tlv_fields!(reader, {
695 (0, payment_id, required),
696 (2, payment_hash, required),
698 Ok(Some(Event::PaymentFailed {
705 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
706 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
709 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
710 // which prefixes the whole thing with a length BigSize. Because the event is
711 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
712 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
713 // exactly the number of bytes specified, ignoring them entirely.
714 let tlv_len: BigSize = Readable::read(reader)?;
715 FixedLengthReader::new(reader, tlv_len.0)
716 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
719 _ => Err(msgs::DecodeError::InvalidValue)
724 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
725 /// broadcast to most peers).
726 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
727 #[derive(Clone, Debug)]
728 pub enum MessageSendEvent {
729 /// Used to indicate that we've accepted a channel open and should send the accept_channel
730 /// message provided to the given peer.
732 /// The node_id of the node which should receive this message
734 /// The message which should be sent.
735 msg: msgs::AcceptChannel,
737 /// Used to indicate that we've initiated a channel open and should send the open_channel
738 /// message provided to the given peer.
740 /// The node_id of the node which should receive this message
742 /// The message which should be sent.
743 msg: msgs::OpenChannel,
745 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
747 /// The node_id of the node which should receive this message
749 /// The message which should be sent.
750 msg: msgs::FundingCreated,
752 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
754 /// The node_id of the node which should receive this message
756 /// The message which should be sent.
757 msg: msgs::FundingSigned,
759 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
761 /// The node_id of the node which should receive these message(s)
763 /// The funding_locked message which should be sent.
764 msg: msgs::FundingLocked,
766 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
767 SendAnnouncementSignatures {
768 /// The node_id of the node which should receive these message(s)
770 /// The announcement_signatures message which should be sent.
771 msg: msgs::AnnouncementSignatures,
773 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
774 /// message should be sent to the peer with the given node_id.
776 /// The node_id of the node which should receive these message(s)
778 /// The update messages which should be sent. ALL messages in the struct should be sent!
779 updates: msgs::CommitmentUpdate,
781 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
783 /// The node_id of the node which should receive this message
785 /// The message which should be sent.
786 msg: msgs::RevokeAndACK,
788 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
790 /// The node_id of the node which should receive this message
792 /// The message which should be sent.
793 msg: msgs::ClosingSigned,
795 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
797 /// The node_id of the node which should receive this message
799 /// The message which should be sent.
802 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
803 SendChannelReestablish {
804 /// The node_id of the node which should receive this message
806 /// The message which should be sent.
807 msg: msgs::ChannelReestablish,
809 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
810 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
812 /// Note that after doing so, you very likely (unless you did so very recently) want to call
813 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
814 /// This ensures that any nodes which see our channel_announcement also have a relevant
815 /// node_announcement, including relevant feature flags which may be important for routing
816 /// through or to us.
817 BroadcastChannelAnnouncement {
818 /// The channel_announcement which should be sent.
819 msg: msgs::ChannelAnnouncement,
820 /// The followup channel_update which should be sent.
821 update_msg: msgs::ChannelUpdate,
823 /// Used to indicate that a node_announcement should be broadcast to all peers.
824 BroadcastNodeAnnouncement {
825 /// The node_announcement which should be sent.
826 msg: msgs::NodeAnnouncement,
828 /// Used to indicate that a channel_update should be broadcast to all peers.
829 BroadcastChannelUpdate {
830 /// The channel_update which should be sent.
831 msg: msgs::ChannelUpdate,
833 /// Used to indicate that a channel_update should be sent to a single peer.
834 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
835 /// private channel and we shouldn't be informing all of our peers of channel parameters.
837 /// The node_id of the node which should receive this message
839 /// The channel_update which should be sent.
840 msg: msgs::ChannelUpdate,
842 /// Broadcast an error downstream to be handled
844 /// The node_id of the node which should receive this message
846 /// The action which should be taken.
847 action: msgs::ErrorAction
849 /// Query a peer for channels with funding transaction UTXOs in a block range.
850 SendChannelRangeQuery {
851 /// The node_id of this message recipient
853 /// The query_channel_range which should be sent.
854 msg: msgs::QueryChannelRange,
856 /// Request routing gossip messages from a peer for a list of channels identified by
857 /// their short_channel_ids.
859 /// The node_id of this message recipient
861 /// The query_short_channel_ids which should be sent.
862 msg: msgs::QueryShortChannelIds,
864 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
865 /// emitted during processing of the query.
866 SendReplyChannelRange {
867 /// The node_id of this message recipient
869 /// The reply_channel_range which should be sent.
870 msg: msgs::ReplyChannelRange,
874 /// A trait indicating an object may generate message send events
875 pub trait MessageSendEventsProvider {
876 /// Gets the list of pending events which were generated by previous actions, clearing the list
878 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
881 /// A trait indicating an object may generate events.
883 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
887 /// See [`process_pending_events`] for requirements around event processing.
889 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
890 /// event since the last invocation. The handler must either act upon the event immediately
891 /// or preserve it for later handling.
893 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
894 /// consult the provider's documentation on the implication of processing events and how a handler
895 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
896 /// [`ChainMonitor::process_pending_events`]).
898 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
901 /// [`process_pending_events`]: Self::process_pending_events
902 /// [`handle_event`]: EventHandler::handle_event
903 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
904 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
905 pub trait EventsProvider {
906 /// Processes any events generated since the last call using the given event handler.
908 /// Subsequent calls must only process new events. However, handlers must be capable of handling
909 /// duplicate events across process restarts. This may occur if the provider was recovered from
910 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
911 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
914 /// A trait implemented for objects handling events from [`EventsProvider`].
915 pub trait EventHandler {
916 /// Handles the given [`Event`].
918 /// See [`EventsProvider`] for details that must be considered when implementing this method.
919 fn handle_event(&self, event: &Event);
922 impl<F> EventHandler for F where F: Fn(&Event) {
923 fn handle_event(&self, event: &Event) {
928 impl<T: EventHandler> EventHandler for Arc<T> {
929 fn handle_event(&self, event: &Event) {
930 self.deref().handle_event(event)