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
18 pub mod bump_transaction;
21 pub use bump_transaction::BumpTransactionEvent;
23 use crate::sign::SpendableOutputDescriptor;
24 use crate::ln::channelmanager::{InterceptId, PaymentId, RecipientOnionFields};
25 use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
26 use crate::ln::features::ChannelTypeFeatures;
28 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
29 use crate::routing::gossip::NetworkUpdate;
30 use crate::util::errors::APIError;
31 use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
32 use crate::util::string::UntrustedString;
33 use crate::routing::router::{BlindedTail, Path, RouteHop, RouteParameters};
35 use bitcoin::{PackedLockTime, Transaction, OutPoint};
37 use bitcoin::{Txid, TxIn, TxOut, Witness};
38 use bitcoin::blockdata::script::Script;
39 use bitcoin::hashes::Hash;
40 use bitcoin::hashes::sha256::Hash as Sha256;
41 use bitcoin::secp256k1::PublicKey;
43 use crate::prelude::*;
44 use core::time::Duration;
48 /// Some information provided on receipt of payment depends on whether the payment received is a
49 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
50 #[derive(Clone, Debug, PartialEq, Eq)]
51 pub enum PaymentPurpose {
52 /// Information for receiving a payment that we generated an invoice for.
54 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
55 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
56 /// [`ChannelManager::claim_funds`].
58 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
59 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
60 payment_preimage: Option<PaymentPreimage>,
61 /// The "payment secret". This authenticates the sender to the recipient, preventing a
62 /// number of deanonymization attacks during the routing process.
63 /// It is provided here for your reference, however its accuracy is enforced directly by
64 /// [`ChannelManager`] using the values you previously provided to
65 /// [`ChannelManager::create_inbound_payment`] or
66 /// [`ChannelManager::create_inbound_payment_for_hash`].
68 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
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
71 payment_secret: PaymentSecret,
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 impl_writeable_tlv_based_enum!(PaymentPurpose,
79 (0, InvoicePayment) => {
80 (0, payment_preimage, option),
81 (2, payment_secret, required),
83 (2, SpontaneousPayment)
86 /// When the payment path failure took place and extra details about it. [`PathFailure::OnPath`] may
87 /// contain a [`NetworkUpdate`] that needs to be applied to the [`NetworkGraph`].
89 /// [`NetworkUpdate`]: crate::routing::gossip::NetworkUpdate
90 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
91 #[derive(Clone, Debug, Eq, PartialEq)]
92 pub enum PathFailure {
93 /// We failed to initially send the payment and no HTLC was committed to. Contains the relevant
96 /// The error surfaced from initial send.
99 /// A hop on the path failed to forward our payment.
101 /// If present, this [`NetworkUpdate`] should be applied to the [`NetworkGraph`] so that routing
102 /// decisions can take into account the update.
104 /// [`NetworkUpdate`]: crate::routing::gossip::NetworkUpdate
105 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
106 network_update: Option<NetworkUpdate>,
110 impl_writeable_tlv_based_enum_upgradable!(PathFailure,
112 (0, network_update, upgradable_option),
114 (2, InitialSend) => {
115 (0, err, upgradable_required),
119 #[derive(Clone, Debug, PartialEq, Eq)]
120 /// The reason the channel was closed. See individual variants more details.
121 pub enum ClosureReason {
122 /// Closure generated from receiving a peer error message.
124 /// Our counterparty may have broadcasted their latest commitment state, and we have
126 CounterpartyForceClosed {
127 /// The error which the peer sent us.
129 /// Be careful about printing the peer_msg, a well-crafted message could exploit
130 /// a security vulnerability in the terminal emulator or the logging subsystem.
131 /// To be safe, use `Display` on `UntrustedString`
133 /// [`UntrustedString`]: crate::util::string::UntrustedString
134 peer_msg: UntrustedString,
136 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
138 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
140 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
141 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
142 //TODO: split between CounterpartyInitiated/LocallyInitiated
144 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
145 /// commitment transaction came from our counterparty, but it may also have come from
146 /// a copy of our own `ChannelMonitor`.
147 CommitmentTxConfirmed,
148 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
150 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
152 /// A developer-readable error message which we generated.
155 /// The peer disconnected prior to funding completing. In this case the spec mandates that we
156 /// forget the channel entirely - we can attempt again if the peer reconnects.
158 /// This includes cases where we restarted prior to funding completion, including prior to the
159 /// initial [`ChannelMonitor`] persistence completing.
161 /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
162 /// peer because of mutual incompatibility between us and our channel counterparty.
164 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
166 /// Closure generated from `ChannelManager::read` if the [`ChannelMonitor`] is newer than
167 /// the [`ChannelManager`] deserialized.
169 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
170 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
171 OutdatedChannelManager
174 impl core::fmt::Display for ClosureReason {
175 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
176 f.write_str("Channel closed because ")?;
178 ClosureReason::CounterpartyForceClosed { peer_msg } => {
179 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
181 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
182 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
183 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
184 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
185 ClosureReason::ProcessingError { err } => {
186 f.write_str("of an exception: ")?;
189 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
190 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
195 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
196 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
197 (1, FundingTimedOut) => {},
198 (2, HolderForceClosed) => {},
199 (6, CommitmentTxConfirmed) => {},
200 (4, CooperativeClosure) => {},
201 (8, ProcessingError) => { (1, err, required) },
202 (10, DisconnectedPeer) => {},
203 (12, OutdatedChannelManager) => {},
206 /// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
207 #[derive(Clone, Debug, PartialEq, Eq)]
208 pub enum HTLCDestination {
209 /// We tried forwarding to a channel but failed to do so. An example of such an instance is when
210 /// there is insufficient capacity in our outbound channel.
212 /// The `node_id` of the next node. For backwards compatibility, this field is
213 /// marked as optional, versions prior to 0.0.110 may not always be able to provide
214 /// counterparty node information.
215 node_id: Option<PublicKey>,
216 /// The outgoing `channel_id` between us and the next node.
217 channel_id: [u8; 32],
219 /// Scenario where we are unsure of the next node to forward the HTLC to.
221 /// Short channel id we are requesting to forward an HTLC to.
222 requested_forward_scid: u64,
224 /// We couldn't forward to the outgoing scid. An example would be attempting to send a duplicate
227 /// Short channel id we are requesting to forward an HTLC to.
228 requested_forward_scid: u64
230 /// Failure scenario where an HTLC may have been forwarded to be intended for us,
231 /// but is invalid for some reason, so we reject it.
233 /// Some of the reasons may include:
235 /// * Excess HTLCs for a payment that we have already fully received, over-paying for the
237 /// * The counterparty node modified the HTLC in transit,
238 /// * A probing attack where an intermediary node is trying to detect if we are the ultimate
239 /// recipient for a payment.
241 /// The payment hash of the payment we attempted to process.
242 payment_hash: PaymentHash
246 impl_writeable_tlv_based_enum_upgradable!(HTLCDestination,
247 (0, NextHopChannel) => {
248 (0, node_id, required),
249 (2, channel_id, required),
251 (1, InvalidForward) => {
252 (0, requested_forward_scid, required),
254 (2, UnknownNextHop) => {
255 (0, requested_forward_scid, required),
257 (4, FailedPayment) => {
258 (0, payment_hash, required),
262 /// Will be used in [`Event::HTLCIntercepted`] to identify the next hop in the HTLC's path.
263 /// Currently only used in serialization for the sake of maintaining compatibility. More variants
264 /// will be added for general-purpose HTLC forward intercepts as well as trampoline forward
265 /// intercepts in upcoming work.
266 enum InterceptNextHop {
268 requested_next_hop_scid: u64,
272 impl_writeable_tlv_based_enum!(InterceptNextHop,
274 (0, requested_next_hop_scid, required),
278 /// The reason the payment failed. Used in [`Event::PaymentFailed`].
279 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
280 pub enum PaymentFailureReason {
281 /// The intended recipient rejected our payment.
283 /// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
285 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
287 /// We exhausted all of our retry attempts while trying to send the payment, or we
288 /// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
289 /// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
290 /// have come before this.
292 /// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
294 /// The payment expired while retrying, based on the provided
295 /// [`PaymentParameters::expiry_time`].
297 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
299 /// We failed to find a route while retrying the payment.
301 /// This error should generally never happen. This likely means that there is a problem with
306 impl_writeable_tlv_based_enum!(PaymentFailureReason,
307 (0, RecipientRejected) => {},
308 (2, UserAbandoned) => {},
309 (4, RetriesExhausted) => {},
310 (6, PaymentExpired) => {},
311 (8, RouteNotFound) => {},
312 (10, UnexpectedError) => {}, ;
315 /// An Event which you should probably take some action in response to.
317 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
318 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
319 /// written as it makes no sense to respond to it after reconnecting to peers).
320 #[derive(Clone, Debug, PartialEq, Eq)]
322 /// Used to indicate that the client should generate a funding transaction with the given
323 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
324 /// Generated in [`ChannelManager`] message handling.
325 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
326 /// counterparty can steal your funds!
328 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
329 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
330 FundingGenerationReady {
331 /// The random channel_id we picked which you'll need to pass into
332 /// [`ChannelManager::funding_transaction_generated`].
334 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
335 temporary_channel_id: [u8; 32],
336 /// The counterparty's node_id, which you'll need to pass back into
337 /// [`ChannelManager::funding_transaction_generated`].
339 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
340 counterparty_node_id: PublicKey,
341 /// The value, in satoshis, that the output should have.
342 channel_value_satoshis: u64,
343 /// The script which should be used in the transaction output.
344 output_script: Script,
345 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or a
346 /// random value for an inbound channel. This may be zero for objects serialized with LDK
347 /// versions prior to 0.0.113.
349 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
350 user_channel_id: u128,
352 /// Indicates that we've been offered a payment and it needs to be claimed via calling
353 /// [`ChannelManager::claim_funds`] with the preimage given in [`PaymentPurpose`].
355 /// Note that if the preimage is not known, you should call
356 /// [`ChannelManager::fail_htlc_backwards`] or [`ChannelManager::fail_htlc_backwards_with_reason`]
357 /// to free up resources for this HTLC and avoid network congestion.
358 /// If you fail to call either [`ChannelManager::claim_funds`], [`ChannelManager::fail_htlc_backwards`],
359 /// or [`ChannelManager::fail_htlc_backwards_with_reason`] within the HTLC's timeout, the HTLC will be
360 /// automatically failed.
363 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
364 /// `PaymentClaimable` events may be generated for the same payment. In such a case it is
365 /// polite (and required in the lightning specification) to fail the payment the second time
366 /// and give the sender their money back rather than accepting double payment.
369 /// This event used to be called `PaymentReceived` in LDK versions 0.0.112 and earlier.
371 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
372 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
373 /// [`ChannelManager::fail_htlc_backwards_with_reason`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards_with_reason
375 /// The node that will receive the payment after it has been claimed.
376 /// This is useful to identify payments received via [phantom nodes].
377 /// This field will always be filled in when the event was generated by LDK versions
378 /// 0.0.113 and above.
380 /// [phantom nodes]: crate::sign::PhantomKeysManager
381 receiver_node_id: Option<PublicKey>,
382 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
383 /// not stop you from registering duplicate payment hashes for inbound payments.
384 payment_hash: PaymentHash,
385 /// The fields in the onion which were received with each HTLC. Only fields which were
386 /// identical in each HTLC involved in the payment will be included here.
388 /// Payments received on LDK versions prior to 0.0.115 will have this field unset.
389 onion_fields: Option<RecipientOnionFields>,
390 /// The value, in thousandths of a satoshi, that this payment is for.
392 /// Information for claiming this received payment, based on whether the purpose of the
393 /// payment is to pay an invoice or to send a spontaneous payment.
394 purpose: PaymentPurpose,
395 /// The `channel_id` indicating over which channel we received the payment.
396 via_channel_id: Option<[u8; 32]>,
397 /// The `user_channel_id` indicating over which channel we received the payment.
398 via_user_channel_id: Option<u128>,
399 /// The block height at which this payment will be failed back and will no longer be
400 /// eligible for claiming.
402 /// Prior to this height, a call to [`ChannelManager::claim_funds`] is guaranteed to
403 /// succeed, however you should wait for [`Event::PaymentClaimed`] to be sure.
405 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
406 claim_deadline: Option<u32>,
408 /// Indicates a payment has been claimed and we've received money!
410 /// This most likely occurs when [`ChannelManager::claim_funds`] has been called in response
411 /// to an [`Event::PaymentClaimable`]. However, if we previously crashed during a
412 /// [`ChannelManager::claim_funds`] call you may see this event without a corresponding
413 /// [`Event::PaymentClaimable`] event.
416 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
417 /// `PaymentClaimable` events may be generated for the same payment. If you then call
418 /// [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentClaimable`] you may get
419 /// multiple `PaymentClaimed` events.
421 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
423 /// The node that received the payment.
424 /// This is useful to identify payments which were received via [phantom nodes].
425 /// This field will always be filled in when the event was generated by LDK versions
426 /// 0.0.113 and above.
428 /// [phantom nodes]: crate::sign::PhantomKeysManager
429 receiver_node_id: Option<PublicKey>,
430 /// The payment hash of the claimed payment. Note that LDK will not stop you from
431 /// registering duplicate payment hashes for inbound payments.
432 payment_hash: PaymentHash,
433 /// The value, in thousandths of a satoshi, that this payment is for.
435 /// The purpose of the claimed payment, i.e. whether the payment was for an invoice or a
436 /// spontaneous payment.
437 purpose: PaymentPurpose,
439 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
440 /// and we got back the payment preimage for it).
442 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
443 /// event. In this situation, you SHOULD treat this payment as having succeeded.
445 /// The `payment_id` passed to [`ChannelManager::send_payment`].
447 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
448 payment_id: Option<PaymentId>,
449 /// The preimage to the hash given to ChannelManager::send_payment.
450 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
451 /// store it somehow!
452 payment_preimage: PaymentPreimage,
453 /// The hash that was given to [`ChannelManager::send_payment`].
455 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
456 payment_hash: PaymentHash,
457 /// The total fee which was spent at intermediate hops in this payment, across all paths.
459 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
460 /// overpayment to the recipient node.
462 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
463 /// overstate the amount paid, though this is unlikely.
465 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
466 fee_paid_msat: Option<u64>,
468 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
469 /// provide failure information for each path attempt in the payment, including retries.
471 /// This event is provided once there are no further pending HTLCs for the payment and the
472 /// payment is no longer retryable, due either to the [`Retry`] provided or
473 /// [`ChannelManager::abandon_payment`] having been called for the corresponding payment.
475 /// [`Retry`]: crate::ln::channelmanager::Retry
476 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
478 /// The `payment_id` passed to [`ChannelManager::send_payment`].
480 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
481 payment_id: PaymentId,
482 /// The hash that was given to [`ChannelManager::send_payment`].
484 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
485 payment_hash: PaymentHash,
486 /// The reason the payment failed. This is only `None` for events generated or serialized
487 /// by versions prior to 0.0.115.
488 reason: Option<PaymentFailureReason>,
490 /// Indicates that a path for an outbound payment was successful.
492 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
493 /// [`Event::PaymentSent`] for obtaining the payment preimage.
494 PaymentPathSuccessful {
495 /// The `payment_id` passed to [`ChannelManager::send_payment`].
497 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
498 payment_id: PaymentId,
499 /// The hash that was given to [`ChannelManager::send_payment`].
501 /// This will be `Some` for all payments which completed on LDK 0.0.104 or later.
503 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
504 payment_hash: Option<PaymentHash>,
505 /// The payment path that was successful.
507 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
510 /// Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
513 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
514 /// [`Event::PaymentFailed`].
516 /// See [`ChannelManager::abandon_payment`] for giving up on this payment before its retries have
519 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
521 /// The `payment_id` passed to [`ChannelManager::send_payment`].
523 /// This will be `Some` for all payment paths which failed on LDK 0.0.103 or later.
525 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
526 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
527 payment_id: Option<PaymentId>,
528 /// The hash that was given to [`ChannelManager::send_payment`].
530 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
531 payment_hash: PaymentHash,
532 /// Indicates the payment was rejected for some reason by the recipient. This implies that
533 /// the payment has failed, not just the route in question. If this is not set, the payment may
534 /// be retried via a different route.
535 payment_failed_permanently: bool,
536 /// Extra error details based on the failure type. May contain an update that needs to be
537 /// applied to the [`NetworkGraph`].
539 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
540 failure: PathFailure,
541 /// The payment path that failed.
543 /// The channel responsible for the failed payment path.
545 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
546 /// may not refer to a channel in the public network graph. These aliases may also collide
547 /// with channels in the public network graph.
549 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
550 /// retried. May be `None` for older [`Event`] serializations.
551 short_channel_id: Option<u64>,
553 error_code: Option<u16>,
555 error_data: Option<Vec<u8>>,
557 /// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
559 /// The id returned by [`ChannelManager::send_probe`].
561 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
562 payment_id: PaymentId,
563 /// The hash generated by [`ChannelManager::send_probe`].
565 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
566 payment_hash: PaymentHash,
567 /// The payment path that was successful.
570 /// Indicates that a probe payment we sent failed at an intermediary node on the path.
572 /// The id returned by [`ChannelManager::send_probe`].
574 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
575 payment_id: PaymentId,
576 /// The hash generated by [`ChannelManager::send_probe`].
578 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
579 payment_hash: PaymentHash,
580 /// The payment path that failed.
582 /// The channel responsible for the failed probe.
584 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
585 /// may not refer to a channel in the public network graph. These aliases may also collide
586 /// with channels in the public network graph.
587 short_channel_id: Option<u64>,
589 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
590 /// a time in the future.
592 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
593 PendingHTLCsForwardable {
594 /// The minimum amount of time that should be waited prior to calling
595 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
596 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
597 /// now + 5*time_forwardable).
598 time_forwardable: Duration,
600 /// Used to indicate that we've intercepted an HTLC forward. This event will only be generated if
601 /// you've encoded an intercept scid in the receiver's invoice route hints using
602 /// [`ChannelManager::get_intercept_scid`] and have set [`UserConfig::accept_intercept_htlcs`].
604 /// [`ChannelManager::forward_intercepted_htlc`] or
605 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to this event. See
606 /// their docs for more information.
608 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
609 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
610 /// [`ChannelManager::forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
611 /// [`ChannelManager::fail_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::fail_intercepted_htlc
613 /// An id to help LDK identify which HTLC is being forwarded or failed.
614 intercept_id: InterceptId,
615 /// The fake scid that was programmed as the next hop's scid, generated using
616 /// [`ChannelManager::get_intercept_scid`].
618 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
619 requested_next_hop_scid: u64,
620 /// The payment hash used for this HTLC.
621 payment_hash: PaymentHash,
622 /// How many msats were received on the inbound edge of this HTLC.
623 inbound_amount_msat: u64,
624 /// How many msats the payer intended to route to the next node. Depending on the reason you are
625 /// intercepting this payment, you might take a fee by forwarding less than this amount.
626 /// Forwarding less than this amount may break compatibility with LDK versions prior to 0.0.116.
628 /// Note that LDK will NOT check that expected fees were factored into this value. You MUST
629 /// check that whatever fee you want has been included here or subtract it as required. Further,
630 /// LDK will not stop you from forwarding more than you received.
631 expected_outbound_amount_msat: u64,
633 /// Used to indicate that an output which you should know how to spend was confirmed on chain
634 /// and is now spendable.
635 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
636 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
637 /// somewhere and spend them when you create on-chain transactions.
639 /// The outputs which you should store as spendable by you.
640 outputs: Vec<SpendableOutputDescriptor>,
642 /// This event is generated when a payment has been successfully forwarded through us and a
643 /// forwarding fee earned.
645 /// The incoming channel between the previous node and us. This is only `None` for events
646 /// generated or serialized by versions prior to 0.0.107.
647 prev_channel_id: Option<[u8; 32]>,
648 /// The outgoing channel between the next node and us. This is only `None` for events
649 /// generated or serialized by versions prior to 0.0.107.
650 next_channel_id: Option<[u8; 32]>,
651 /// The fee, in milli-satoshis, which was earned as a result of the payment.
653 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
654 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
655 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
656 /// claimed the full value in millisatoshis from the source. In this case,
657 /// `claim_from_onchain_tx` will be set.
659 /// If the channel which sent us the payment has been force-closed, we will claim the funds
660 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
661 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
662 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
664 fee_earned_msat: Option<u64>,
665 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
667 claim_from_onchain_tx: bool,
668 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
670 /// The caveat described above the `fee_earned_msat` field applies here as well.
671 outbound_amount_forwarded_msat: Option<u64>,
673 /// Used to indicate that a channel with the given `channel_id` is being opened and pending
674 /// confirmation on-chain.
676 /// This event is emitted when the funding transaction has been signed and is broadcast to the
677 /// network. For 0conf channels it will be immediately followed by the corresponding
678 /// [`Event::ChannelReady`] event.
680 /// The `channel_id` of the channel that is pending confirmation.
681 channel_id: [u8; 32],
682 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
683 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
684 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
685 /// `user_channel_id` will be randomized for an inbound channel.
687 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
688 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
689 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
690 user_channel_id: u128,
691 /// The `temporary_channel_id` this channel used to be known by during channel establishment.
693 /// Will be `None` for channels created prior to LDK version 0.0.115.
694 former_temporary_channel_id: Option<[u8; 32]>,
695 /// The `node_id` of the channel counterparty.
696 counterparty_node_id: PublicKey,
697 /// The outpoint of the channel's funding transaction.
698 funding_txo: OutPoint,
700 /// Used to indicate that a channel with the given `channel_id` is ready to
701 /// be used. This event is emitted either when the funding transaction has been confirmed
702 /// on-chain, or, in case of a 0conf channel, when both parties have confirmed the channel
705 /// The `channel_id` of the channel that is ready.
706 channel_id: [u8; 32],
707 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
708 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
709 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
710 /// `user_channel_id` will be randomized for an inbound channel.
712 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
713 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
714 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
715 user_channel_id: u128,
716 /// The `node_id` of the channel counterparty.
717 counterparty_node_id: PublicKey,
718 /// The features that this channel will operate with.
719 channel_type: ChannelTypeFeatures,
721 /// Used to indicate that a previously opened channel with the given `channel_id` is in the
722 /// process of closure.
724 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
725 /// resolving the channel are likely still awaiting confirmation.
726 channel_id: [u8; 32],
727 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
728 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
729 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
730 /// `user_channel_id` will be randomized for inbound channels.
731 /// This may be zero for inbound channels serialized prior to 0.0.113 and will always be
732 /// zero for objects serialized with LDK versions prior to 0.0.102.
734 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
735 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
736 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
737 user_channel_id: u128,
738 /// The reason the channel was closed.
739 reason: ClosureReason
741 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
742 /// inputs for another purpose.
744 /// The channel_id of the channel which has been closed.
745 channel_id: [u8; 32],
746 /// The full transaction received from the user
747 transaction: Transaction
749 /// Indicates a request to open a new channel by a peer.
751 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
752 /// request, call [`ChannelManager::force_close_without_broadcasting_txn`].
754 /// The event is only triggered when a new open channel request is received and the
755 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
757 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
758 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
759 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
761 /// The temporary channel ID of the channel requested to be opened.
763 /// When responding to the request, the `temporary_channel_id` should be passed
764 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
765 /// or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject.
767 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
768 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
769 temporary_channel_id: [u8; 32],
770 /// The node_id of the counterparty requesting to open the channel.
772 /// When responding to the request, the `counterparty_node_id` should be passed
773 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
774 /// accept the request, or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject the
777 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
778 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
779 counterparty_node_id: PublicKey,
780 /// The channel value of the requested channel.
781 funding_satoshis: u64,
782 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
784 /// The features that this channel will operate with. If you reject the channel, a
785 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
788 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
789 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
792 /// Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
793 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
794 /// 0.0.107. Channels setting this type also need to get manually accepted via
795 /// [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`],
796 /// or will be rejected otherwise.
798 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
799 channel_type: ChannelTypeFeatures,
801 /// Indicates that the HTLC was accepted, but could not be processed when or after attempting to
804 /// Some scenarios where this event may be sent include:
805 /// * Insufficient capacity in the outbound channel
806 /// * While waiting to forward the HTLC, the channel it is meant to be forwarded through closes
807 /// * When an unknown SCID is requested for forwarding a payment.
808 /// * Expected MPP amount has already been reached
809 /// * The HTLC has timed out
811 /// This event, however, does not get generated if an HTLC fails to meet the forwarding
812 /// requirements (i.e. insufficient fees paid, or a CLTV that is too soon).
814 /// The channel over which the HTLC was received.
815 prev_channel_id: [u8; 32],
816 /// Destination of the HTLC that failed to be processed.
817 failed_next_destination: HTLCDestination,
820 /// Indicates that a transaction originating from LDK needs to have its fee bumped. This event
821 /// requires confirmed external funds to be readily available to spend.
823 /// LDK does not currently generate this event. It is limited to the scope of channels with
824 /// anchor outputs, which will be introduced in a future release.
825 BumpTransaction(BumpTransactionEvent),
828 impl Writeable for Event {
829 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
831 &Event::FundingGenerationReady { .. } => {
833 // We never write out FundingGenerationReady events as, upon disconnection, peers
834 // drop any channels which have not yet exchanged funding_signed.
836 &Event::PaymentClaimable { ref payment_hash, ref amount_msat, ref purpose,
837 ref receiver_node_id, ref via_channel_id, ref via_user_channel_id,
838 ref claim_deadline, ref onion_fields
841 let mut payment_secret = None;
842 let payment_preimage;
844 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
845 payment_secret = Some(secret);
846 payment_preimage = *preimage;
848 PaymentPurpose::SpontaneousPayment(preimage) => {
849 payment_preimage = Some(*preimage);
852 write_tlv_fields!(writer, {
853 (0, payment_hash, required),
854 (1, receiver_node_id, option),
855 (2, payment_secret, option),
856 (3, via_channel_id, option),
857 (4, amount_msat, required),
858 (5, via_user_channel_id, option),
859 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
860 (7, claim_deadline, option),
861 (8, payment_preimage, option),
862 (9, onion_fields, option),
865 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
867 write_tlv_fields!(writer, {
868 (0, payment_preimage, required),
869 (1, payment_hash, required),
870 (3, payment_id, option),
871 (5, fee_paid_msat, option),
874 &Event::PaymentPathFailed {
875 ref payment_id, ref payment_hash, ref payment_failed_permanently, ref failure,
876 ref path, ref short_channel_id,
884 error_code.write(writer)?;
886 error_data.write(writer)?;
887 write_tlv_fields!(writer, {
888 (0, payment_hash, required),
889 (1, None::<NetworkUpdate>, option), // network_update in LDK versions prior to 0.0.114
890 (2, payment_failed_permanently, required),
891 (3, false, required), // all_paths_failed in LDK versions prior to 0.0.114
892 (4, path.blinded_tail, option),
893 (5, path.hops, vec_type),
894 (7, short_channel_id, option),
895 (9, None::<RouteParameters>, option), // retry in LDK versions prior to 0.0.115
896 (11, payment_id, option),
897 (13, failure, required),
900 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
902 // Note that we now ignore these on the read end as we'll re-generate them in
903 // ChannelManager, we write them here only for backwards compatibility.
905 &Event::SpendableOutputs { ref outputs } => {
907 write_tlv_fields!(writer, {
908 (0, WithoutLength(outputs), required),
911 &Event::HTLCIntercepted { requested_next_hop_scid, payment_hash, inbound_amount_msat, expected_outbound_amount_msat, intercept_id } => {
913 let intercept_scid = InterceptNextHop::FakeScid { requested_next_hop_scid };
914 write_tlv_fields!(writer, {
915 (0, intercept_id, required),
916 (2, intercept_scid, required),
917 (4, payment_hash, required),
918 (6, inbound_amount_msat, required),
919 (8, expected_outbound_amount_msat, required),
922 &Event::PaymentForwarded {
923 fee_earned_msat, prev_channel_id, claim_from_onchain_tx,
924 next_channel_id, outbound_amount_forwarded_msat
927 write_tlv_fields!(writer, {
928 (0, fee_earned_msat, option),
929 (1, prev_channel_id, option),
930 (2, claim_from_onchain_tx, required),
931 (3, next_channel_id, option),
932 (5, outbound_amount_forwarded_msat, option),
935 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
937 // `user_channel_id` used to be a single u64 value. In order to remain backwards
938 // compatible with versions prior to 0.0.113, the u128 is serialized as two
939 // separate u64 values.
940 let user_channel_id_low = *user_channel_id as u64;
941 let user_channel_id_high = (*user_channel_id >> 64) as u64;
942 write_tlv_fields!(writer, {
943 (0, channel_id, required),
944 (1, user_channel_id_low, required),
945 (2, reason, required),
946 (3, user_channel_id_high, required),
949 &Event::DiscardFunding { ref channel_id, ref transaction } => {
951 write_tlv_fields!(writer, {
952 (0, channel_id, required),
953 (2, transaction, required)
956 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
958 write_tlv_fields!(writer, {
959 (0, payment_id, required),
960 (2, payment_hash, option),
961 (4, path.hops, vec_type),
962 (6, path.blinded_tail, option),
965 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
967 write_tlv_fields!(writer, {
968 (0, payment_id, required),
970 (2, payment_hash, required),
973 &Event::OpenChannelRequest { .. } => {
975 // We never write the OpenChannelRequest events as, upon disconnection, peers
976 // drop any channels which have not yet exchanged funding_signed.
978 &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose, ref receiver_node_id } => {
980 write_tlv_fields!(writer, {
981 (0, payment_hash, required),
982 (1, receiver_node_id, option),
983 (2, purpose, required),
984 (4, amount_msat, required),
987 &Event::ProbeSuccessful { ref payment_id, ref payment_hash, ref path } => {
989 write_tlv_fields!(writer, {
990 (0, payment_id, required),
991 (2, payment_hash, required),
992 (4, path.hops, vec_type),
993 (6, path.blinded_tail, option),
996 &Event::ProbeFailed { ref payment_id, ref payment_hash, ref path, ref short_channel_id } => {
998 write_tlv_fields!(writer, {
999 (0, payment_id, required),
1000 (2, payment_hash, required),
1001 (4, path.hops, vec_type),
1002 (6, short_channel_id, option),
1003 (8, path.blinded_tail, option),
1006 &Event::HTLCHandlingFailed { ref prev_channel_id, ref failed_next_destination } => {
1007 25u8.write(writer)?;
1008 write_tlv_fields!(writer, {
1009 (0, prev_channel_id, required),
1010 (2, failed_next_destination, required),
1014 &Event::BumpTransaction(ref event)=> {
1015 27u8.write(writer)?;
1017 // We never write the ChannelClose|HTLCResolution events as they'll be replayed
1018 // upon restarting anyway if they remain unresolved.
1019 BumpTransactionEvent::ChannelClose { .. } => {}
1020 BumpTransactionEvent::HTLCResolution { .. } => {}
1022 write_tlv_fields!(writer, {}); // Write a length field for forwards compat
1024 &Event::ChannelReady { ref channel_id, ref user_channel_id, ref counterparty_node_id, ref channel_type } => {
1025 29u8.write(writer)?;
1026 write_tlv_fields!(writer, {
1027 (0, channel_id, required),
1028 (2, user_channel_id, required),
1029 (4, counterparty_node_id, required),
1030 (6, channel_type, required),
1033 &Event::ChannelPending { ref channel_id, ref user_channel_id, ref former_temporary_channel_id, ref counterparty_node_id, ref funding_txo } => {
1034 31u8.write(writer)?;
1035 write_tlv_fields!(writer, {
1036 (0, channel_id, required),
1037 (2, user_channel_id, required),
1038 (4, former_temporary_channel_id, required),
1039 (6, counterparty_node_id, required),
1040 (8, funding_txo, required),
1043 // Note that, going forward, all new events must only write data inside of
1044 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
1045 // data via `write_tlv_fields`.
1050 impl MaybeReadable for Event {
1051 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
1052 match Readable::read(reader)? {
1053 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
1054 // unlike all other events, thus we return immediately here.
1058 let mut payment_hash = PaymentHash([0; 32]);
1059 let mut payment_preimage = None;
1060 let mut payment_secret = None;
1061 let mut amount_msat = 0;
1062 let mut receiver_node_id = None;
1063 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
1064 let mut via_channel_id = None;
1065 let mut claim_deadline = None;
1066 let mut via_user_channel_id = None;
1067 let mut onion_fields = None;
1068 read_tlv_fields!(reader, {
1069 (0, payment_hash, required),
1070 (1, receiver_node_id, option),
1071 (2, payment_secret, option),
1072 (3, via_channel_id, option),
1073 (4, amount_msat, required),
1074 (5, via_user_channel_id, option),
1075 (6, _user_payment_id, option),
1076 (7, claim_deadline, option),
1077 (8, payment_preimage, option),
1078 (9, onion_fields, option),
1080 let purpose = match payment_secret {
1081 Some(secret) => PaymentPurpose::InvoicePayment {
1083 payment_secret: secret
1085 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
1086 None => return Err(msgs::DecodeError::InvalidValue),
1088 Ok(Some(Event::PaymentClaimable {
1094 via_user_channel_id,
1103 let mut payment_preimage = PaymentPreimage([0; 32]);
1104 let mut payment_hash = None;
1105 let mut payment_id = None;
1106 let mut fee_paid_msat = None;
1107 read_tlv_fields!(reader, {
1108 (0, payment_preimage, required),
1109 (1, payment_hash, option),
1110 (3, payment_id, option),
1111 (5, fee_paid_msat, option),
1113 if payment_hash.is_none() {
1114 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
1116 Ok(Some(Event::PaymentSent {
1119 payment_hash: payment_hash.unwrap(),
1128 let error_code = Readable::read(reader)?;
1130 let error_data = Readable::read(reader)?;
1131 let mut payment_hash = PaymentHash([0; 32]);
1132 let mut payment_failed_permanently = false;
1133 let mut network_update = None;
1134 let mut blinded_tail: Option<BlindedTail> = None;
1135 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1136 let mut short_channel_id = None;
1137 let mut payment_id = None;
1138 let mut failure_opt = None;
1139 read_tlv_fields!(reader, {
1140 (0, payment_hash, required),
1141 (1, network_update, upgradable_option),
1142 (2, payment_failed_permanently, required),
1143 (4, blinded_tail, option),
1144 (5, path, vec_type),
1145 (7, short_channel_id, option),
1146 (11, payment_id, option),
1147 (13, failure_opt, upgradable_option),
1149 let failure = failure_opt.unwrap_or_else(|| PathFailure::OnPath { network_update });
1150 Ok(Some(Event::PaymentPathFailed {
1153 payment_failed_permanently,
1155 path: Path { hops: path.unwrap(), blinded_tail },
1168 let mut outputs = WithoutLength(Vec::new());
1169 read_tlv_fields!(reader, {
1170 (0, outputs, required),
1172 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
1177 let mut payment_hash = PaymentHash([0; 32]);
1178 let mut intercept_id = InterceptId([0; 32]);
1179 let mut requested_next_hop_scid = InterceptNextHop::FakeScid { requested_next_hop_scid: 0 };
1180 let mut inbound_amount_msat = 0;
1181 let mut expected_outbound_amount_msat = 0;
1182 read_tlv_fields!(reader, {
1183 (0, intercept_id, required),
1184 (2, requested_next_hop_scid, required),
1185 (4, payment_hash, required),
1186 (6, inbound_amount_msat, required),
1187 (8, expected_outbound_amount_msat, required),
1189 let next_scid = match requested_next_hop_scid {
1190 InterceptNextHop::FakeScid { requested_next_hop_scid: scid } => scid
1192 Ok(Some(Event::HTLCIntercepted {
1194 requested_next_hop_scid: next_scid,
1195 inbound_amount_msat,
1196 expected_outbound_amount_msat,
1202 let mut fee_earned_msat = None;
1203 let mut prev_channel_id = None;
1204 let mut claim_from_onchain_tx = false;
1205 let mut next_channel_id = None;
1206 let mut outbound_amount_forwarded_msat = None;
1207 read_tlv_fields!(reader, {
1208 (0, fee_earned_msat, option),
1209 (1, prev_channel_id, option),
1210 (2, claim_from_onchain_tx, required),
1211 (3, next_channel_id, option),
1212 (5, outbound_amount_forwarded_msat, option),
1214 Ok(Some(Event::PaymentForwarded {
1215 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1216 outbound_amount_forwarded_msat
1223 let mut channel_id = [0; 32];
1224 let mut reason = UpgradableRequired(None);
1225 let mut user_channel_id_low_opt: Option<u64> = None;
1226 let mut user_channel_id_high_opt: Option<u64> = None;
1227 read_tlv_fields!(reader, {
1228 (0, channel_id, required),
1229 (1, user_channel_id_low_opt, option),
1230 (2, reason, upgradable_required),
1231 (3, user_channel_id_high_opt, option),
1234 // `user_channel_id` used to be a single u64 value. In order to remain
1235 // backwards compatible with versions prior to 0.0.113, the u128 is serialized
1236 // as two separate u64 values.
1237 let user_channel_id = (user_channel_id_low_opt.unwrap_or(0) as u128) +
1238 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);
1240 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required) }))
1246 let mut channel_id = [0; 32];
1247 let mut transaction = Transaction{ version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
1248 read_tlv_fields!(reader, {
1249 (0, channel_id, required),
1250 (2, transaction, required),
1252 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
1258 _init_and_read_tlv_fields!(reader, {
1259 (0, payment_id, required),
1260 (2, payment_hash, option),
1261 (4, path, vec_type),
1262 (6, blinded_tail, option),
1264 Ok(Some(Event::PaymentPathSuccessful {
1265 payment_id: payment_id.0.unwrap(),
1267 path: Path { hops: path.unwrap(), blinded_tail },
1274 let mut payment_hash = PaymentHash([0; 32]);
1275 let mut payment_id = PaymentId([0; 32]);
1276 let mut reason = None;
1277 read_tlv_fields!(reader, {
1278 (0, payment_id, required),
1279 (1, reason, upgradable_option),
1280 (2, payment_hash, required),
1282 Ok(Some(Event::PaymentFailed {
1291 // Value 17 is used for `Event::OpenChannelRequest`.
1296 let mut payment_hash = PaymentHash([0; 32]);
1297 let mut purpose = UpgradableRequired(None);
1298 let mut amount_msat = 0;
1299 let mut receiver_node_id = None;
1300 read_tlv_fields!(reader, {
1301 (0, payment_hash, required),
1302 (1, receiver_node_id, option),
1303 (2, purpose, upgradable_required),
1304 (4, amount_msat, required),
1306 Ok(Some(Event::PaymentClaimed {
1309 purpose: _init_tlv_based_struct_field!(purpose, upgradable_required),
1317 _init_and_read_tlv_fields!(reader, {
1318 (0, payment_id, required),
1319 (2, payment_hash, required),
1320 (4, path, vec_type),
1321 (6, blinded_tail, option),
1323 Ok(Some(Event::ProbeSuccessful {
1324 payment_id: payment_id.0.unwrap(),
1325 payment_hash: payment_hash.0.unwrap(),
1326 path: Path { hops: path.unwrap(), blinded_tail },
1333 _init_and_read_tlv_fields!(reader, {
1334 (0, payment_id, required),
1335 (2, payment_hash, required),
1336 (4, path, vec_type),
1337 (6, short_channel_id, option),
1338 (8, blinded_tail, option),
1340 Ok(Some(Event::ProbeFailed {
1341 payment_id: payment_id.0.unwrap(),
1342 payment_hash: payment_hash.0.unwrap(),
1343 path: Path { hops: path.unwrap(), blinded_tail },
1351 let mut prev_channel_id = [0; 32];
1352 let mut failed_next_destination_opt = UpgradableRequired(None);
1353 read_tlv_fields!(reader, {
1354 (0, prev_channel_id, required),
1355 (2, failed_next_destination_opt, upgradable_required),
1357 Ok(Some(Event::HTLCHandlingFailed {
1359 failed_next_destination: _init_tlv_based_struct_field!(failed_next_destination_opt, upgradable_required),
1367 let mut channel_id = [0; 32];
1368 let mut user_channel_id: u128 = 0;
1369 let mut counterparty_node_id = RequiredWrapper(None);
1370 let mut channel_type = RequiredWrapper(None);
1371 read_tlv_fields!(reader, {
1372 (0, channel_id, required),
1373 (2, user_channel_id, required),
1374 (4, counterparty_node_id, required),
1375 (6, channel_type, required),
1378 Ok(Some(Event::ChannelReady {
1381 counterparty_node_id: counterparty_node_id.0.unwrap(),
1382 channel_type: channel_type.0.unwrap()
1389 let mut channel_id = [0; 32];
1390 let mut user_channel_id: u128 = 0;
1391 let mut former_temporary_channel_id = None;
1392 let mut counterparty_node_id = RequiredWrapper(None);
1393 let mut funding_txo = RequiredWrapper(None);
1394 read_tlv_fields!(reader, {
1395 (0, channel_id, required),
1396 (2, user_channel_id, required),
1397 (4, former_temporary_channel_id, required),
1398 (6, counterparty_node_id, required),
1399 (8, funding_txo, required),
1402 Ok(Some(Event::ChannelPending {
1405 former_temporary_channel_id,
1406 counterparty_node_id: counterparty_node_id.0.unwrap(),
1407 funding_txo: funding_txo.0.unwrap()
1412 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
1413 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
1415 x if x % 2 == 1 => {
1416 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
1417 // which prefixes the whole thing with a length BigSize. Because the event is
1418 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
1419 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
1420 // exactly the number of bytes specified, ignoring them entirely.
1421 let tlv_len: BigSize = Readable::read(reader)?;
1422 FixedLengthReader::new(reader, tlv_len.0)
1423 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
1426 _ => Err(msgs::DecodeError::InvalidValue)
1431 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
1432 /// broadcast to most peers).
1433 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
1434 #[derive(Clone, Debug)]
1435 pub enum MessageSendEvent {
1436 /// Used to indicate that we've accepted a channel open and should send the accept_channel
1437 /// message provided to the given peer.
1439 /// The node_id of the node which should receive this message
1441 /// The message which should be sent.
1442 msg: msgs::AcceptChannel,
1444 /// Used to indicate that we've accepted a V2 channel open and should send the accept_channel2
1445 /// message provided to the given peer.
1446 SendAcceptChannelV2 {
1447 /// The node_id of the node which should receive this message
1449 /// The message which should be sent.
1450 msg: msgs::AcceptChannelV2,
1452 /// Used to indicate that we've initiated a channel open and should send the open_channel
1453 /// message provided to the given peer.
1455 /// The node_id of the node which should receive this message
1457 /// The message which should be sent.
1458 msg: msgs::OpenChannel,
1460 /// Used to indicate that we've initiated a V2 channel open and should send the open_channel2
1461 /// message provided to the given peer.
1463 /// The node_id of the node which should receive this message
1465 /// The message which should be sent.
1466 msg: msgs::OpenChannelV2,
1468 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
1469 SendFundingCreated {
1470 /// The node_id of the node which should receive this message
1472 /// The message which should be sent.
1473 msg: msgs::FundingCreated,
1475 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
1477 /// The node_id of the node which should receive this message
1479 /// The message which should be sent.
1480 msg: msgs::FundingSigned,
1482 /// Used to indicate that a tx_add_input message should be sent to the peer with the given node_id.
1484 /// The node_id of the node which should receive this message
1486 /// The message which should be sent.
1487 msg: msgs::TxAddInput,
1489 /// Used to indicate that a tx_add_output message should be sent to the peer with the given node_id.
1491 /// The node_id of the node which should receive this message
1493 /// The message which should be sent.
1494 msg: msgs::TxAddOutput,
1496 /// Used to indicate that a tx_remove_input message should be sent to the peer with the given node_id.
1498 /// The node_id of the node which should receive this message
1500 /// The message which should be sent.
1501 msg: msgs::TxRemoveInput,
1503 /// Used to indicate that a tx_remove_output message should be sent to the peer with the given node_id.
1504 SendTxRemoveOutput {
1505 /// The node_id of the node which should receive this message
1507 /// The message which should be sent.
1508 msg: msgs::TxRemoveOutput,
1510 /// Used to indicate that a tx_complete message should be sent to the peer with the given node_id.
1512 /// The node_id of the node which should receive this message
1514 /// The message which should be sent.
1515 msg: msgs::TxComplete,
1517 /// Used to indicate that a tx_signatures message should be sent to the peer with the given node_id.
1519 /// The node_id of the node which should receive this message
1521 /// The message which should be sent.
1522 msg: msgs::TxSignatures,
1524 /// Used to indicate that a tx_init_rbf message should be sent to the peer with the given node_id.
1526 /// The node_id of the node which should receive this message
1528 /// The message which should be sent.
1529 msg: msgs::TxInitRbf,
1531 /// Used to indicate that a tx_ack_rbf message should be sent to the peer with the given node_id.
1533 /// The node_id of the node which should receive this message
1535 /// The message which should be sent.
1536 msg: msgs::TxAckRbf,
1538 /// Used to indicate that a tx_abort message should be sent to the peer with the given node_id.
1540 /// The node_id of the node which should receive this message
1542 /// The message which should be sent.
1543 msg: msgs::TxAddInput,
1545 /// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
1547 /// The node_id of the node which should receive these message(s)
1549 /// The channel_ready message which should be sent.
1550 msg: msgs::ChannelReady,
1552 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
1553 SendAnnouncementSignatures {
1554 /// The node_id of the node which should receive these message(s)
1556 /// The announcement_signatures message which should be sent.
1557 msg: msgs::AnnouncementSignatures,
1559 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
1560 /// message should be sent to the peer with the given node_id.
1562 /// The node_id of the node which should receive these message(s)
1564 /// The update messages which should be sent. ALL messages in the struct should be sent!
1565 updates: msgs::CommitmentUpdate,
1567 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
1569 /// The node_id of the node which should receive this message
1571 /// The message which should be sent.
1572 msg: msgs::RevokeAndACK,
1574 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
1576 /// The node_id of the node which should receive this message
1578 /// The message which should be sent.
1579 msg: msgs::ClosingSigned,
1581 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
1583 /// The node_id of the node which should receive this message
1585 /// The message which should be sent.
1586 msg: msgs::Shutdown,
1588 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
1589 SendChannelReestablish {
1590 /// The node_id of the node which should receive this message
1592 /// The message which should be sent.
1593 msg: msgs::ChannelReestablish,
1595 /// Used to send a channel_announcement and channel_update to a specific peer, likely on
1596 /// initial connection to ensure our peers know about our channels.
1597 SendChannelAnnouncement {
1598 /// The node_id of the node which should receive this message
1600 /// The channel_announcement which should be sent.
1601 msg: msgs::ChannelAnnouncement,
1602 /// The followup channel_update which should be sent.
1603 update_msg: msgs::ChannelUpdate,
1605 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
1606 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
1608 /// Note that after doing so, you very likely (unless you did so very recently) want to
1609 /// broadcast a node_announcement (e.g. via [`PeerManager::broadcast_node_announcement`]). This
1610 /// ensures that any nodes which see our channel_announcement also have a relevant
1611 /// node_announcement, including relevant feature flags which may be important for routing
1612 /// through or to us.
1614 /// [`PeerManager::broadcast_node_announcement`]: crate::ln::peer_handler::PeerManager::broadcast_node_announcement
1615 BroadcastChannelAnnouncement {
1616 /// The channel_announcement which should be sent.
1617 msg: msgs::ChannelAnnouncement,
1618 /// The followup channel_update which should be sent.
1619 update_msg: Option<msgs::ChannelUpdate>,
1621 /// Used to indicate that a channel_update should be broadcast to all peers.
1622 BroadcastChannelUpdate {
1623 /// The channel_update which should be sent.
1624 msg: msgs::ChannelUpdate,
1626 /// Used to indicate that a node_announcement should be broadcast to all peers.
1627 BroadcastNodeAnnouncement {
1628 /// The node_announcement which should be sent.
1629 msg: msgs::NodeAnnouncement,
1631 /// Used to indicate that a channel_update should be sent to a single peer.
1632 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
1633 /// private channel and we shouldn't be informing all of our peers of channel parameters.
1635 /// The node_id of the node which should receive this message
1637 /// The channel_update which should be sent.
1638 msg: msgs::ChannelUpdate,
1640 /// Broadcast an error downstream to be handled
1642 /// The node_id of the node which should receive this message
1644 /// The action which should be taken.
1645 action: msgs::ErrorAction
1647 /// Query a peer for channels with funding transaction UTXOs in a block range.
1648 SendChannelRangeQuery {
1649 /// The node_id of this message recipient
1651 /// The query_channel_range which should be sent.
1652 msg: msgs::QueryChannelRange,
1654 /// Request routing gossip messages from a peer for a list of channels identified by
1655 /// their short_channel_ids.
1657 /// The node_id of this message recipient
1659 /// The query_short_channel_ids which should be sent.
1660 msg: msgs::QueryShortChannelIds,
1662 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1663 /// emitted during processing of the query.
1664 SendReplyChannelRange {
1665 /// The node_id of this message recipient
1667 /// The reply_channel_range which should be sent.
1668 msg: msgs::ReplyChannelRange,
1670 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1671 /// enable receiving gossip messages from the peer.
1672 SendGossipTimestampFilter {
1673 /// The node_id of this message recipient
1675 /// The gossip_timestamp_filter which should be sent.
1676 msg: msgs::GossipTimestampFilter,
1680 /// A trait indicating an object may generate message send events
1681 pub trait MessageSendEventsProvider {
1682 /// Gets the list of pending events which were generated by previous actions, clearing the list
1684 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1687 /// A trait indicating an object may generate onion messages to send
1688 pub trait OnionMessageProvider {
1689 /// Gets the next pending onion message for the peer with the given node id.
1690 fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<msgs::OnionMessage>;
1693 /// A trait indicating an object may generate events.
1695 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1697 /// Implementations of this trait may also feature an async version of event handling, as shown with
1698 /// [`ChannelManager::process_pending_events_async`] and
1699 /// [`ChainMonitor::process_pending_events_async`].
1703 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1704 /// event since the last invocation.
1706 /// In order to ensure no [`Event`]s are lost, implementors of this trait will persist [`Event`]s
1707 /// and replay any unhandled events on startup. An [`Event`] is considered handled when
1708 /// [`process_pending_events`] returns, thus handlers MUST fully handle [`Event`]s and persist any
1709 /// relevant changes to disk *before* returning.
1711 /// Further, because an application may crash between an [`Event`] being handled and the
1712 /// implementor of this trait being re-serialized, [`Event`] handling must be idempotent - in
1713 /// effect, [`Event`]s may be replayed.
1715 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1716 /// consult the provider's documentation on the implication of processing events and how a handler
1717 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1718 /// [`ChainMonitor::process_pending_events`]).
1720 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1723 /// [`process_pending_events`]: Self::process_pending_events
1724 /// [`handle_event`]: EventHandler::handle_event
1725 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1726 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1727 /// [`ChannelManager::process_pending_events_async`]: crate::ln::channelmanager::ChannelManager::process_pending_events_async
1728 /// [`ChainMonitor::process_pending_events_async`]: crate::chain::chainmonitor::ChainMonitor::process_pending_events_async
1729 pub trait EventsProvider {
1730 /// Processes any events generated since the last call using the given event handler.
1732 /// See the trait-level documentation for requirements.
1733 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1736 /// A trait implemented for objects handling events from [`EventsProvider`].
1738 /// An async variation also exists for implementations of [`EventsProvider`] that support async
1739 /// event handling. The async event handler should satisfy the generic bounds: `F:
1740 /// core::future::Future, H: Fn(Event) -> F`.
1741 pub trait EventHandler {
1742 /// Handles the given [`Event`].
1744 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1745 fn handle_event(&self, event: Event);
1748 impl<F> EventHandler for F where F: Fn(Event) {
1749 fn handle_event(&self, event: Event) {
1754 impl<T: EventHandler> EventHandler for Arc<T> {
1755 fn handle_event(&self, event: Event) {
1756 self.deref().handle_event(event)