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 pub mod bump_transaction;
19 pub use bump_transaction::BumpTransactionEvent;
21 use crate::sign::SpendableOutputDescriptor;
22 use crate::ln::channelmanager::{InterceptId, PaymentId, RecipientOnionFields};
23 use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
24 use crate::ln::features::ChannelTypeFeatures;
26 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
27 use crate::routing::gossip::NetworkUpdate;
28 use crate::util::errors::APIError;
29 use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
30 use crate::util::string::UntrustedString;
31 use crate::routing::router::{BlindedTail, Path, RouteHop, RouteParameters};
33 use bitcoin::{PackedLockTime, Transaction, OutPoint};
34 use bitcoin::blockdata::script::Script;
35 use bitcoin::hashes::Hash;
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::secp256k1::PublicKey;
39 use crate::prelude::*;
40 use core::time::Duration;
44 /// Some information provided on receipt of payment depends on whether the payment received is a
45 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
46 #[derive(Clone, Debug, PartialEq, Eq)]
47 pub enum PaymentPurpose {
48 /// Information for receiving a payment that we generated an invoice for.
50 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
51 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
52 /// [`ChannelManager::claim_funds`].
54 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
55 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
56 payment_preimage: Option<PaymentPreimage>,
57 /// The "payment secret". This authenticates the sender to the recipient, preventing a
58 /// number of deanonymization attacks during the routing process.
59 /// It is provided here for your reference, however its accuracy is enforced directly by
60 /// [`ChannelManager`] using the values you previously provided to
61 /// [`ChannelManager::create_inbound_payment`] or
62 /// [`ChannelManager::create_inbound_payment_for_hash`].
64 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
65 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
66 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
67 payment_secret: PaymentSecret,
69 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
70 /// (the payee) providing a preimage.
71 SpontaneousPayment(PaymentPreimage),
74 impl_writeable_tlv_based_enum!(PaymentPurpose,
75 (0, InvoicePayment) => {
76 (0, payment_preimage, option),
77 (2, payment_secret, required),
79 (2, SpontaneousPayment)
82 /// When the payment path failure took place and extra details about it. [`PathFailure::OnPath`] may
83 /// contain a [`NetworkUpdate`] that needs to be applied to the [`NetworkGraph`].
85 /// [`NetworkUpdate`]: crate::routing::gossip::NetworkUpdate
86 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
87 #[derive(Clone, Debug, Eq, PartialEq)]
88 pub enum PathFailure {
89 /// We failed to initially send the payment and no HTLC was committed to. Contains the relevant
92 /// The error surfaced from initial send.
95 /// A hop on the path failed to forward our payment.
97 /// If present, this [`NetworkUpdate`] should be applied to the [`NetworkGraph`] so that routing
98 /// decisions can take into account the update.
100 /// [`NetworkUpdate`]: crate::routing::gossip::NetworkUpdate
101 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
102 network_update: Option<NetworkUpdate>,
106 impl_writeable_tlv_based_enum_upgradable!(PathFailure,
108 (0, network_update, upgradable_option),
110 (2, InitialSend) => {
111 (0, err, upgradable_required),
115 #[derive(Clone, Debug, PartialEq, Eq)]
116 /// The reason the channel was closed. See individual variants for more details.
117 pub enum ClosureReason {
118 /// Closure generated from receiving a peer error message.
120 /// Our counterparty may have broadcasted their latest commitment state, and we have
122 CounterpartyForceClosed {
123 /// The error which the peer sent us.
125 /// Be careful about printing the peer_msg, a well-crafted message could exploit
126 /// a security vulnerability in the terminal emulator or the logging subsystem.
127 /// To be safe, use `Display` on `UntrustedString`
129 /// [`UntrustedString`]: crate::util::string::UntrustedString
130 peer_msg: UntrustedString,
132 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
134 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
136 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
137 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
138 //TODO: split between CounterpartyInitiated/LocallyInitiated
140 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
141 /// commitment transaction came from our counterparty, but it may also have come from
142 /// a copy of our own `ChannelMonitor`.
143 CommitmentTxConfirmed,
144 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
146 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
148 /// A developer-readable error message which we generated.
151 /// The peer disconnected prior to funding completing. In this case the spec mandates that we
152 /// forget the channel entirely - we can attempt again if the peer reconnects.
154 /// This includes cases where we restarted prior to funding completion, including prior to the
155 /// initial [`ChannelMonitor`] persistence completing.
157 /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
158 /// peer because of mutual incompatibility between us and our channel counterparty.
160 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
162 /// Closure generated from `ChannelManager::read` if the [`ChannelMonitor`] is newer than
163 /// the [`ChannelManager`] deserialized.
165 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
166 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
167 OutdatedChannelManager,
168 /// The counterparty requested a cooperative close of a channel that had not been funded yet.
169 /// The channel has been immediately closed.
170 CounterpartyCoopClosedUnfundedChannel,
173 impl core::fmt::Display for ClosureReason {
174 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
175 f.write_str("Channel closed because ")?;
177 ClosureReason::CounterpartyForceClosed { peer_msg } => {
178 f.write_fmt(format_args!("counterparty force-closed with message: {}", peer_msg))
180 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
181 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
182 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
183 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
184 ClosureReason::ProcessingError { err } => {
185 f.write_str("of an exception: ")?;
188 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
189 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
190 ClosureReason::CounterpartyCoopClosedUnfundedChannel => f.write_str("the peer requested the unfunded channel be closed"),
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) => {},
204 (13, CounterpartyCoopClosedUnfundedChannel) => {},
207 /// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
208 #[derive(Clone, Debug, PartialEq, Eq)]
209 pub enum HTLCDestination {
210 /// We tried forwarding to a channel but failed to do so. An example of such an instance is when
211 /// there is insufficient capacity in our outbound channel.
213 /// The `node_id` of the next node. For backwards compatibility, this field is
214 /// marked as optional, versions prior to 0.0.110 may not always be able to provide
215 /// counterparty node information.
216 node_id: Option<PublicKey>,
217 /// The outgoing `channel_id` between us and the next node.
218 channel_id: [u8; 32],
220 /// Scenario where we are unsure of the next node to forward the HTLC to.
222 /// Short channel id we are requesting to forward an HTLC to.
223 requested_forward_scid: u64,
225 /// We couldn't forward to the outgoing scid. An example would be attempting to send a duplicate
228 /// Short channel id we are requesting to forward an HTLC to.
229 requested_forward_scid: u64
231 /// Failure scenario where an HTLC may have been forwarded to be intended for us,
232 /// but is invalid for some reason, so we reject it.
234 /// Some of the reasons may include:
236 /// * Excess HTLCs for a payment that we have already fully received, over-paying for the
238 /// * The counterparty node modified the HTLC in transit,
239 /// * A probing attack where an intermediary node is trying to detect if we are the ultimate
240 /// recipient for a payment.
242 /// The payment hash of the payment we attempted to process.
243 payment_hash: PaymentHash
247 impl_writeable_tlv_based_enum_upgradable!(HTLCDestination,
248 (0, NextHopChannel) => {
249 (0, node_id, required),
250 (2, channel_id, required),
252 (1, InvalidForward) => {
253 (0, requested_forward_scid, required),
255 (2, UnknownNextHop) => {
256 (0, requested_forward_scid, required),
258 (4, FailedPayment) => {
259 (0, payment_hash, required),
263 /// Will be used in [`Event::HTLCIntercepted`] to identify the next hop in the HTLC's path.
264 /// Currently only used in serialization for the sake of maintaining compatibility. More variants
265 /// will be added for general-purpose HTLC forward intercepts as well as trampoline forward
266 /// intercepts in upcoming work.
267 enum InterceptNextHop {
269 requested_next_hop_scid: u64,
273 impl_writeable_tlv_based_enum!(InterceptNextHop,
275 (0, requested_next_hop_scid, required),
279 /// The reason the payment failed. Used in [`Event::PaymentFailed`].
280 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
281 pub enum PaymentFailureReason {
282 /// The intended recipient rejected our payment.
284 /// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
286 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
288 /// We exhausted all of our retry attempts while trying to send the payment, or we
289 /// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
290 /// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
291 /// have come before this.
293 /// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
295 /// The payment expired while retrying, based on the provided
296 /// [`PaymentParameters::expiry_time`].
298 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
300 /// We failed to find a route while retrying the payment.
302 /// This error should generally never happen. This likely means that there is a problem with
307 impl_writeable_tlv_based_enum!(PaymentFailureReason,
308 (0, RecipientRejected) => {},
309 (2, UserAbandoned) => {},
310 (4, RetriesExhausted) => {},
311 (6, PaymentExpired) => {},
312 (8, RouteNotFound) => {},
313 (10, UnexpectedError) => {}, ;
316 /// An Event which you should probably take some action in response to.
318 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
319 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
320 /// written as it makes no sense to respond to it after reconnecting to peers).
321 #[derive(Clone, Debug, PartialEq, Eq)]
323 /// Used to indicate that the client should generate a funding transaction with the given
324 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
325 /// Generated in [`ChannelManager`] message handling.
326 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
327 /// counterparty can steal your funds!
329 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
330 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
331 FundingGenerationReady {
332 /// The random channel_id we picked which you'll need to pass into
333 /// [`ChannelManager::funding_transaction_generated`].
335 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
336 temporary_channel_id: [u8; 32],
337 /// The counterparty's node_id, which you'll need to pass back into
338 /// [`ChannelManager::funding_transaction_generated`].
340 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
341 counterparty_node_id: PublicKey,
342 /// The value, in satoshis, that the output should have.
343 channel_value_satoshis: u64,
344 /// The script which should be used in the transaction output.
345 output_script: Script,
346 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or a
347 /// random value for an inbound channel. This may be zero for objects serialized with LDK
348 /// versions prior to 0.0.113.
350 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
351 user_channel_id: u128,
353 /// Indicates that we've been offered a payment and it needs to be claimed via calling
354 /// [`ChannelManager::claim_funds`] with the preimage given in [`PaymentPurpose`].
356 /// Note that if the preimage is not known, you should call
357 /// [`ChannelManager::fail_htlc_backwards`] or [`ChannelManager::fail_htlc_backwards_with_reason`]
358 /// to free up resources for this HTLC and avoid network congestion.
359 /// If you fail to call either [`ChannelManager::claim_funds`], [`ChannelManager::fail_htlc_backwards`],
360 /// or [`ChannelManager::fail_htlc_backwards_with_reason`] within the HTLC's timeout, the HTLC will be
361 /// automatically failed.
364 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
365 /// `PaymentClaimable` events may be generated for the same payment. In such a case it is
366 /// polite (and required in the lightning specification) to fail the payment the second time
367 /// and give the sender their money back rather than accepting double payment.
370 /// This event used to be called `PaymentReceived` in LDK versions 0.0.112 and earlier.
372 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
373 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
374 /// [`ChannelManager::fail_htlc_backwards_with_reason`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards_with_reason
376 /// The node that will receive the payment after it has been claimed.
377 /// This is useful to identify payments received via [phantom nodes].
378 /// This field will always be filled in when the event was generated by LDK versions
379 /// 0.0.113 and above.
381 /// [phantom nodes]: crate::sign::PhantomKeysManager
382 receiver_node_id: Option<PublicKey>,
383 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
384 /// not stop you from registering duplicate payment hashes for inbound payments.
385 payment_hash: PaymentHash,
386 /// The fields in the onion which were received with each HTLC. Only fields which were
387 /// identical in each HTLC involved in the payment will be included here.
389 /// Payments received on LDK versions prior to 0.0.115 will have this field unset.
390 onion_fields: Option<RecipientOnionFields>,
391 /// The value, in thousandths of a satoshi, that this payment is claimable for. May be greater
392 /// than the invoice amount.
394 /// May be less than the invoice amount if [`ChannelConfig::accept_underpaying_htlcs`] is set
395 /// and the previous hop took an extra fee.
398 /// If [`ChannelConfig::accept_underpaying_htlcs`] is set and you claim without verifying this
399 /// field, you may lose money!
401 /// [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
403 /// The value, in thousands of a satoshi, that was skimmed off of this payment as an extra fee
404 /// taken by our channel counterparty.
406 /// Will always be 0 unless [`ChannelConfig::accept_underpaying_htlcs`] is set.
408 /// [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
409 counterparty_skimmed_fee_msat: u64,
410 /// Information for claiming this received payment, based on whether the purpose of the
411 /// payment is to pay an invoice or to send a spontaneous payment.
412 purpose: PaymentPurpose,
413 /// The `channel_id` indicating over which channel we received the payment.
414 via_channel_id: Option<[u8; 32]>,
415 /// The `user_channel_id` indicating over which channel we received the payment.
416 via_user_channel_id: Option<u128>,
417 /// The block height at which this payment will be failed back and will no longer be
418 /// eligible for claiming.
420 /// Prior to this height, a call to [`ChannelManager::claim_funds`] is guaranteed to
421 /// succeed, however you should wait for [`Event::PaymentClaimed`] to be sure.
423 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
424 claim_deadline: Option<u32>,
426 /// Indicates a payment has been claimed and we've received money!
428 /// This most likely occurs when [`ChannelManager::claim_funds`] has been called in response
429 /// to an [`Event::PaymentClaimable`]. However, if we previously crashed during a
430 /// [`ChannelManager::claim_funds`] call you may see this event without a corresponding
431 /// [`Event::PaymentClaimable`] event.
434 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
435 /// `PaymentClaimable` events may be generated for the same payment. If you then call
436 /// [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentClaimable`] you may get
437 /// multiple `PaymentClaimed` events.
439 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
441 /// The node that received the payment.
442 /// This is useful to identify payments which were received via [phantom nodes].
443 /// This field will always be filled in when the event was generated by LDK versions
444 /// 0.0.113 and above.
446 /// [phantom nodes]: crate::sign::PhantomKeysManager
447 receiver_node_id: Option<PublicKey>,
448 /// The payment hash of the claimed payment. Note that LDK will not stop you from
449 /// registering duplicate payment hashes for inbound payments.
450 payment_hash: PaymentHash,
451 /// The value, in thousandths of a satoshi, that this payment is for. May be greater than the
454 /// The purpose of the claimed payment, i.e. whether the payment was for an invoice or a
455 /// spontaneous payment.
456 purpose: PaymentPurpose,
458 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
459 /// and we got back the payment preimage for it).
461 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
462 /// event. In this situation, you SHOULD treat this payment as having succeeded.
464 /// The `payment_id` passed to [`ChannelManager::send_payment`].
466 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
467 payment_id: Option<PaymentId>,
468 /// The preimage to the hash given to ChannelManager::send_payment.
469 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
470 /// store it somehow!
471 payment_preimage: PaymentPreimage,
472 /// The hash that was given to [`ChannelManager::send_payment`].
474 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
475 payment_hash: PaymentHash,
476 /// The total fee which was spent at intermediate hops in this payment, across all paths.
478 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
479 /// overpayment to the recipient node.
481 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
482 /// overstate the amount paid, though this is unlikely.
484 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
485 fee_paid_msat: Option<u64>,
487 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
488 /// provide failure information for each path attempt in the payment, including retries.
490 /// This event is provided once there are no further pending HTLCs for the payment and the
491 /// payment is no longer retryable, due either to the [`Retry`] provided or
492 /// [`ChannelManager::abandon_payment`] having been called for the corresponding payment.
494 /// [`Retry`]: crate::ln::channelmanager::Retry
495 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
497 /// The `payment_id` passed to [`ChannelManager::send_payment`].
499 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
500 payment_id: PaymentId,
501 /// The hash that was given to [`ChannelManager::send_payment`].
503 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
504 payment_hash: PaymentHash,
505 /// The reason the payment failed. This is only `None` for events generated or serialized
506 /// by versions prior to 0.0.115.
507 reason: Option<PaymentFailureReason>,
509 /// Indicates that a path for an outbound payment was successful.
511 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
512 /// [`Event::PaymentSent`] for obtaining the payment preimage.
513 PaymentPathSuccessful {
514 /// The `payment_id` passed to [`ChannelManager::send_payment`].
516 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
517 payment_id: PaymentId,
518 /// The hash that was given to [`ChannelManager::send_payment`].
520 /// This will be `Some` for all payments which completed on LDK 0.0.104 or later.
522 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
523 payment_hash: Option<PaymentHash>,
524 /// The payment path that was successful.
526 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
529 /// Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
532 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
533 /// [`Event::PaymentFailed`].
535 /// See [`ChannelManager::abandon_payment`] for giving up on this payment before its retries have
538 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
540 /// The `payment_id` passed to [`ChannelManager::send_payment`].
542 /// This will be `Some` for all payment paths which failed on LDK 0.0.103 or later.
544 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
545 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
546 payment_id: Option<PaymentId>,
547 /// The hash that was given to [`ChannelManager::send_payment`].
549 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
550 payment_hash: PaymentHash,
551 /// Indicates the payment was rejected for some reason by the recipient. This implies that
552 /// the payment has failed, not just the route in question. If this is not set, the payment may
553 /// be retried via a different route.
554 payment_failed_permanently: bool,
555 /// Extra error details based on the failure type. May contain an update that needs to be
556 /// applied to the [`NetworkGraph`].
558 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
559 failure: PathFailure,
560 /// The payment path that failed.
562 /// The channel responsible for the failed payment path.
564 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
565 /// may not refer to a channel in the public network graph. These aliases may also collide
566 /// with channels in the public network graph.
568 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
569 /// retried. May be `None` for older [`Event`] serializations.
570 short_channel_id: Option<u64>,
572 error_code: Option<u16>,
574 error_data: Option<Vec<u8>>,
576 /// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
578 /// The id returned by [`ChannelManager::send_probe`].
580 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
581 payment_id: PaymentId,
582 /// The hash generated by [`ChannelManager::send_probe`].
584 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
585 payment_hash: PaymentHash,
586 /// The payment path that was successful.
589 /// Indicates that a probe payment we sent failed at an intermediary node on the path.
591 /// The id returned by [`ChannelManager::send_probe`].
593 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
594 payment_id: PaymentId,
595 /// The hash generated by [`ChannelManager::send_probe`].
597 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
598 payment_hash: PaymentHash,
599 /// The payment path that failed.
601 /// The channel responsible for the failed probe.
603 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
604 /// may not refer to a channel in the public network graph. These aliases may also collide
605 /// with channels in the public network graph.
606 short_channel_id: Option<u64>,
608 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
609 /// a time in the future.
611 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
612 PendingHTLCsForwardable {
613 /// The minimum amount of time that should be waited prior to calling
614 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
615 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
616 /// now + 5*time_forwardable).
617 time_forwardable: Duration,
619 /// Used to indicate that we've intercepted an HTLC forward. This event will only be generated if
620 /// you've encoded an intercept scid in the receiver's invoice route hints using
621 /// [`ChannelManager::get_intercept_scid`] and have set [`UserConfig::accept_intercept_htlcs`].
623 /// [`ChannelManager::forward_intercepted_htlc`] or
624 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to this event. See
625 /// their docs for more information.
627 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
628 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
629 /// [`ChannelManager::forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
630 /// [`ChannelManager::fail_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::fail_intercepted_htlc
632 /// An id to help LDK identify which HTLC is being forwarded or failed.
633 intercept_id: InterceptId,
634 /// The fake scid that was programmed as the next hop's scid, generated using
635 /// [`ChannelManager::get_intercept_scid`].
637 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
638 requested_next_hop_scid: u64,
639 /// The payment hash used for this HTLC.
640 payment_hash: PaymentHash,
641 /// How many msats were received on the inbound edge of this HTLC.
642 inbound_amount_msat: u64,
643 /// How many msats the payer intended to route to the next node. Depending on the reason you are
644 /// intercepting this payment, you might take a fee by forwarding less than this amount.
645 /// Forwarding less than this amount may break compatibility with LDK versions prior to 0.0.116.
647 /// Note that LDK will NOT check that expected fees were factored into this value. You MUST
648 /// check that whatever fee you want has been included here or subtract it as required. Further,
649 /// LDK will not stop you from forwarding more than you received.
650 expected_outbound_amount_msat: u64,
652 /// Used to indicate that an output which you should know how to spend was confirmed on chain
653 /// and is now spendable.
654 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
655 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
656 /// somewhere and spend them when you create on-chain transactions.
658 /// The outputs which you should store as spendable by you.
659 outputs: Vec<SpendableOutputDescriptor>,
661 /// This event is generated when a payment has been successfully forwarded through us and a
662 /// forwarding fee earned.
664 /// The incoming channel between the previous node and us. This is only `None` for events
665 /// generated or serialized by versions prior to 0.0.107.
666 prev_channel_id: Option<[u8; 32]>,
667 /// The outgoing channel between the next node and us. This is only `None` for events
668 /// generated or serialized by versions prior to 0.0.107.
669 next_channel_id: Option<[u8; 32]>,
670 /// The fee, in milli-satoshis, which was earned as a result of the payment.
672 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
673 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
674 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
675 /// claimed the full value in millisatoshis from the source. In this case,
676 /// `claim_from_onchain_tx` will be set.
678 /// If the channel which sent us the payment has been force-closed, we will claim the funds
679 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
680 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
681 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
683 fee_earned_msat: Option<u64>,
684 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
686 claim_from_onchain_tx: bool,
687 /// The final amount forwarded, in milli-satoshis, after the fee is deducted.
689 /// The caveat described above the `fee_earned_msat` field applies here as well.
690 outbound_amount_forwarded_msat: Option<u64>,
692 /// Used to indicate that a channel with the given `channel_id` is being opened and pending
693 /// confirmation on-chain.
695 /// This event is emitted when the funding transaction has been signed and is broadcast to the
696 /// network. For 0conf channels it will be immediately followed by the corresponding
697 /// [`Event::ChannelReady`] event.
699 /// The `channel_id` of the channel that is pending confirmation.
700 channel_id: [u8; 32],
701 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
702 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
703 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
704 /// `user_channel_id` will be randomized for an inbound channel.
706 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
707 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
708 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
709 user_channel_id: u128,
710 /// The `temporary_channel_id` this channel used to be known by during channel establishment.
712 /// Will be `None` for channels created prior to LDK version 0.0.115.
713 former_temporary_channel_id: Option<[u8; 32]>,
714 /// The `node_id` of the channel counterparty.
715 counterparty_node_id: PublicKey,
716 /// The outpoint of the channel's funding transaction.
717 funding_txo: OutPoint,
719 /// Used to indicate that a channel with the given `channel_id` is ready to
720 /// be used. This event is emitted either when the funding transaction has been confirmed
721 /// on-chain, or, in case of a 0conf channel, when both parties have confirmed the channel
724 /// The `channel_id` of the channel that is ready.
725 channel_id: [u8; 32],
726 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
727 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
728 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
729 /// `user_channel_id` will be randomized for an inbound channel.
731 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
732 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
733 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
734 user_channel_id: u128,
735 /// The `node_id` of the channel counterparty.
736 counterparty_node_id: PublicKey,
737 /// The features that this channel will operate with.
738 channel_type: ChannelTypeFeatures,
740 /// Used to indicate that a previously opened channel with the given `channel_id` is in the
741 /// process of closure.
743 /// The `channel_id` of the channel which has been closed. Note that on-chain transactions
744 /// resolving the channel are likely still awaiting confirmation.
745 channel_id: [u8; 32],
746 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
747 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
748 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
749 /// `user_channel_id` will be randomized for inbound channels.
750 /// This may be zero for inbound channels serialized prior to 0.0.113 and will always be
751 /// zero for objects serialized with LDK versions prior to 0.0.102.
753 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
754 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
755 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
756 user_channel_id: u128,
757 /// The reason the channel was closed.
758 reason: ClosureReason,
759 /// Counterparty in the closed channel.
761 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
762 counterparty_node_id: Option<PublicKey>,
763 /// Channel capacity of the closing channel (sats).
765 /// This field will be `None` for objects serialized prior to LDK 0.0.117.
766 channel_capacity_sats: Option<u64>,
768 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
769 /// inputs for another purpose.
771 /// The channel_id of the channel which has been closed.
772 channel_id: [u8; 32],
773 /// The full transaction received from the user
774 transaction: Transaction
776 /// Indicates a request to open a new channel by a peer.
778 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
779 /// request, call [`ChannelManager::force_close_without_broadcasting_txn`].
781 /// The event is only triggered when a new open channel request is received and the
782 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
784 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
785 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
786 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
788 /// The temporary channel ID of the channel requested to be opened.
790 /// When responding to the request, the `temporary_channel_id` should be passed
791 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
792 /// or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject.
794 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
795 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
796 temporary_channel_id: [u8; 32],
797 /// The node_id of the counterparty requesting to open the channel.
799 /// When responding to the request, the `counterparty_node_id` should be passed
800 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
801 /// accept the request, or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject the
804 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
805 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
806 counterparty_node_id: PublicKey,
807 /// The channel value of the requested channel.
808 funding_satoshis: u64,
809 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
811 /// The features that this channel will operate with. If you reject the channel, a
812 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
815 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
816 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
819 /// Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
820 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
821 /// 0.0.107. Channels setting this type also need to get manually accepted via
822 /// [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`],
823 /// or will be rejected otherwise.
825 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
826 channel_type: ChannelTypeFeatures,
828 /// Indicates that the HTLC was accepted, but could not be processed when or after attempting to
831 /// Some scenarios where this event may be sent include:
832 /// * Insufficient capacity in the outbound channel
833 /// * While waiting to forward the HTLC, the channel it is meant to be forwarded through closes
834 /// * When an unknown SCID is requested for forwarding a payment.
835 /// * Expected MPP amount has already been reached
836 /// * The HTLC has timed out
838 /// This event, however, does not get generated if an HTLC fails to meet the forwarding
839 /// requirements (i.e. insufficient fees paid, or a CLTV that is too soon).
841 /// The channel over which the HTLC was received.
842 prev_channel_id: [u8; 32],
843 /// Destination of the HTLC that failed to be processed.
844 failed_next_destination: HTLCDestination,
846 /// Indicates that a transaction originating from LDK needs to have its fee bumped. This event
847 /// requires confirmed external funds to be readily available to spend.
849 /// LDK does not currently generate this event unless the
850 /// [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`] config flag is set to true.
851 /// It is limited to the scope of channels with anchor outputs.
853 /// [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`]: crate::util::config::ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx
854 BumpTransaction(BumpTransactionEvent),
857 impl Writeable for Event {
858 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
860 &Event::FundingGenerationReady { .. } => {
862 // We never write out FundingGenerationReady events as, upon disconnection, peers
863 // drop any channels which have not yet exchanged funding_signed.
865 &Event::PaymentClaimable { ref payment_hash, ref amount_msat, counterparty_skimmed_fee_msat,
866 ref purpose, ref receiver_node_id, ref via_channel_id, ref via_user_channel_id,
867 ref claim_deadline, ref onion_fields
870 let mut payment_secret = None;
871 let payment_preimage;
873 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
874 payment_secret = Some(secret);
875 payment_preimage = *preimage;
877 PaymentPurpose::SpontaneousPayment(preimage) => {
878 payment_preimage = Some(*preimage);
881 let skimmed_fee_opt = if counterparty_skimmed_fee_msat == 0 { None }
882 else { Some(counterparty_skimmed_fee_msat) };
883 write_tlv_fields!(writer, {
884 (0, payment_hash, required),
885 (1, receiver_node_id, option),
886 (2, payment_secret, option),
887 (3, via_channel_id, option),
888 (4, amount_msat, required),
889 (5, via_user_channel_id, option),
890 // Type 6 was `user_payment_id` on 0.0.103 and earlier
891 (7, claim_deadline, option),
892 (8, payment_preimage, option),
893 (9, onion_fields, option),
894 (10, skimmed_fee_opt, option),
897 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
899 write_tlv_fields!(writer, {
900 (0, payment_preimage, required),
901 (1, payment_hash, required),
902 (3, payment_id, option),
903 (5, fee_paid_msat, option),
906 &Event::PaymentPathFailed {
907 ref payment_id, ref payment_hash, ref payment_failed_permanently, ref failure,
908 ref path, ref short_channel_id,
916 error_code.write(writer)?;
918 error_data.write(writer)?;
919 write_tlv_fields!(writer, {
920 (0, payment_hash, required),
921 (1, None::<NetworkUpdate>, option), // network_update in LDK versions prior to 0.0.114
922 (2, payment_failed_permanently, required),
923 (3, false, required), // all_paths_failed in LDK versions prior to 0.0.114
924 (4, path.blinded_tail, option),
925 (5, path.hops, required_vec),
926 (7, short_channel_id, option),
927 (9, None::<RouteParameters>, option), // retry in LDK versions prior to 0.0.115
928 (11, payment_id, option),
929 (13, failure, required),
932 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
934 // Note that we now ignore these on the read end as we'll re-generate them in
935 // ChannelManager, we write them here only for backwards compatibility.
937 &Event::SpendableOutputs { ref outputs } => {
939 write_tlv_fields!(writer, {
940 (0, WithoutLength(outputs), required),
943 &Event::HTLCIntercepted { requested_next_hop_scid, payment_hash, inbound_amount_msat, expected_outbound_amount_msat, intercept_id } => {
945 let intercept_scid = InterceptNextHop::FakeScid { requested_next_hop_scid };
946 write_tlv_fields!(writer, {
947 (0, intercept_id, required),
948 (2, intercept_scid, required),
949 (4, payment_hash, required),
950 (6, inbound_amount_msat, required),
951 (8, expected_outbound_amount_msat, required),
954 &Event::PaymentForwarded {
955 fee_earned_msat, prev_channel_id, claim_from_onchain_tx,
956 next_channel_id, outbound_amount_forwarded_msat
959 write_tlv_fields!(writer, {
960 (0, fee_earned_msat, option),
961 (1, prev_channel_id, option),
962 (2, claim_from_onchain_tx, required),
963 (3, next_channel_id, option),
964 (5, outbound_amount_forwarded_msat, option),
967 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason,
968 ref counterparty_node_id, ref channel_capacity_sats
971 // `user_channel_id` used to be a single u64 value. In order to remain backwards
972 // compatible with versions prior to 0.0.113, the u128 is serialized as two
973 // separate u64 values.
974 let user_channel_id_low = *user_channel_id as u64;
975 let user_channel_id_high = (*user_channel_id >> 64) as u64;
976 write_tlv_fields!(writer, {
977 (0, channel_id, required),
978 (1, user_channel_id_low, required),
979 (2, reason, required),
980 (3, user_channel_id_high, required),
981 (5, counterparty_node_id, option),
982 (7, channel_capacity_sats, option),
985 &Event::DiscardFunding { ref channel_id, ref transaction } => {
987 write_tlv_fields!(writer, {
988 (0, channel_id, required),
989 (2, transaction, required)
992 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
994 write_tlv_fields!(writer, {
995 (0, payment_id, required),
996 (2, payment_hash, option),
997 (4, path.hops, required_vec),
998 (6, path.blinded_tail, option),
1001 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
1002 15u8.write(writer)?;
1003 write_tlv_fields!(writer, {
1004 (0, payment_id, required),
1005 (1, reason, option),
1006 (2, payment_hash, required),
1009 &Event::OpenChannelRequest { .. } => {
1010 17u8.write(writer)?;
1011 // We never write the OpenChannelRequest events as, upon disconnection, peers
1012 // drop any channels which have not yet exchanged funding_signed.
1014 &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose, ref receiver_node_id } => {
1015 19u8.write(writer)?;
1016 write_tlv_fields!(writer, {
1017 (0, payment_hash, required),
1018 (1, receiver_node_id, option),
1019 (2, purpose, required),
1020 (4, amount_msat, required),
1023 &Event::ProbeSuccessful { ref payment_id, ref payment_hash, ref path } => {
1024 21u8.write(writer)?;
1025 write_tlv_fields!(writer, {
1026 (0, payment_id, required),
1027 (2, payment_hash, required),
1028 (4, path.hops, required_vec),
1029 (6, path.blinded_tail, option),
1032 &Event::ProbeFailed { ref payment_id, ref payment_hash, ref path, ref short_channel_id } => {
1033 23u8.write(writer)?;
1034 write_tlv_fields!(writer, {
1035 (0, payment_id, required),
1036 (2, payment_hash, required),
1037 (4, path.hops, required_vec),
1038 (6, short_channel_id, option),
1039 (8, path.blinded_tail, option),
1042 &Event::HTLCHandlingFailed { ref prev_channel_id, ref failed_next_destination } => {
1043 25u8.write(writer)?;
1044 write_tlv_fields!(writer, {
1045 (0, prev_channel_id, required),
1046 (2, failed_next_destination, required),
1049 &Event::BumpTransaction(ref event)=> {
1050 27u8.write(writer)?;
1052 // We never write the ChannelClose|HTLCResolution events as they'll be replayed
1053 // upon restarting anyway if they remain unresolved.
1054 BumpTransactionEvent::ChannelClose { .. } => {}
1055 BumpTransactionEvent::HTLCResolution { .. } => {}
1057 write_tlv_fields!(writer, {}); // Write a length field for forwards compat
1059 &Event::ChannelReady { ref channel_id, ref user_channel_id, ref counterparty_node_id, ref channel_type } => {
1060 29u8.write(writer)?;
1061 write_tlv_fields!(writer, {
1062 (0, channel_id, required),
1063 (2, user_channel_id, required),
1064 (4, counterparty_node_id, required),
1065 (6, channel_type, required),
1068 &Event::ChannelPending { ref channel_id, ref user_channel_id, ref former_temporary_channel_id, ref counterparty_node_id, ref funding_txo } => {
1069 31u8.write(writer)?;
1070 write_tlv_fields!(writer, {
1071 (0, channel_id, required),
1072 (2, user_channel_id, required),
1073 (4, former_temporary_channel_id, required),
1074 (6, counterparty_node_id, required),
1075 (8, funding_txo, required),
1078 // Note that, going forward, all new events must only write data inside of
1079 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
1080 // data via `write_tlv_fields`.
1085 impl MaybeReadable for Event {
1086 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
1087 match Readable::read(reader)? {
1088 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
1089 // unlike all other events, thus we return immediately here.
1093 let mut payment_hash = PaymentHash([0; 32]);
1094 let mut payment_preimage = None;
1095 let mut payment_secret = None;
1096 let mut amount_msat = 0;
1097 let mut counterparty_skimmed_fee_msat_opt = None;
1098 let mut receiver_node_id = None;
1099 let mut _user_payment_id = None::<u64>; // Used in 0.0.103 and earlier, no longer written in 0.0.116+.
1100 let mut via_channel_id = None;
1101 let mut claim_deadline = None;
1102 let mut via_user_channel_id = None;
1103 let mut onion_fields = None;
1104 read_tlv_fields!(reader, {
1105 (0, payment_hash, required),
1106 (1, receiver_node_id, option),
1107 (2, payment_secret, option),
1108 (3, via_channel_id, option),
1109 (4, amount_msat, required),
1110 (5, via_user_channel_id, option),
1111 (6, _user_payment_id, option),
1112 (7, claim_deadline, option),
1113 (8, payment_preimage, option),
1114 (9, onion_fields, option),
1115 (10, counterparty_skimmed_fee_msat_opt, option),
1117 let purpose = match payment_secret {
1118 Some(secret) => PaymentPurpose::InvoicePayment {
1120 payment_secret: secret
1122 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
1123 None => return Err(msgs::DecodeError::InvalidValue),
1125 Ok(Some(Event::PaymentClaimable {
1129 counterparty_skimmed_fee_msat: counterparty_skimmed_fee_msat_opt.unwrap_or(0),
1132 via_user_channel_id,
1141 let mut payment_preimage = PaymentPreimage([0; 32]);
1142 let mut payment_hash = None;
1143 let mut payment_id = None;
1144 let mut fee_paid_msat = None;
1145 read_tlv_fields!(reader, {
1146 (0, payment_preimage, required),
1147 (1, payment_hash, option),
1148 (3, payment_id, option),
1149 (5, fee_paid_msat, option),
1151 if payment_hash.is_none() {
1152 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
1154 Ok(Some(Event::PaymentSent {
1157 payment_hash: payment_hash.unwrap(),
1166 let error_code = Readable::read(reader)?;
1168 let error_data = Readable::read(reader)?;
1169 let mut payment_hash = PaymentHash([0; 32]);
1170 let mut payment_failed_permanently = false;
1171 let mut network_update = None;
1172 let mut blinded_tail: Option<BlindedTail> = None;
1173 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1174 let mut short_channel_id = None;
1175 let mut payment_id = None;
1176 let mut failure_opt = None;
1177 read_tlv_fields!(reader, {
1178 (0, payment_hash, required),
1179 (1, network_update, upgradable_option),
1180 (2, payment_failed_permanently, required),
1181 (4, blinded_tail, option),
1182 // Added as a part of LDK 0.0.101 and always filled in since.
1183 // Defaults to an empty Vec, though likely should have been `Option`al.
1184 (5, path, optional_vec),
1185 (7, short_channel_id, option),
1186 (11, payment_id, option),
1187 (13, failure_opt, upgradable_option),
1189 let failure = failure_opt.unwrap_or_else(|| PathFailure::OnPath { network_update });
1190 Ok(Some(Event::PaymentPathFailed {
1193 payment_failed_permanently,
1195 path: Path { hops: path.unwrap(), blinded_tail },
1208 let mut outputs = WithoutLength(Vec::new());
1209 read_tlv_fields!(reader, {
1210 (0, outputs, required),
1212 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
1217 let mut payment_hash = PaymentHash([0; 32]);
1218 let mut intercept_id = InterceptId([0; 32]);
1219 let mut requested_next_hop_scid = InterceptNextHop::FakeScid { requested_next_hop_scid: 0 };
1220 let mut inbound_amount_msat = 0;
1221 let mut expected_outbound_amount_msat = 0;
1222 read_tlv_fields!(reader, {
1223 (0, intercept_id, required),
1224 (2, requested_next_hop_scid, required),
1225 (4, payment_hash, required),
1226 (6, inbound_amount_msat, required),
1227 (8, expected_outbound_amount_msat, required),
1229 let next_scid = match requested_next_hop_scid {
1230 InterceptNextHop::FakeScid { requested_next_hop_scid: scid } => scid
1232 Ok(Some(Event::HTLCIntercepted {
1234 requested_next_hop_scid: next_scid,
1235 inbound_amount_msat,
1236 expected_outbound_amount_msat,
1242 let mut fee_earned_msat = None;
1243 let mut prev_channel_id = None;
1244 let mut claim_from_onchain_tx = false;
1245 let mut next_channel_id = None;
1246 let mut outbound_amount_forwarded_msat = None;
1247 read_tlv_fields!(reader, {
1248 (0, fee_earned_msat, option),
1249 (1, prev_channel_id, option),
1250 (2, claim_from_onchain_tx, required),
1251 (3, next_channel_id, option),
1252 (5, outbound_amount_forwarded_msat, option),
1254 Ok(Some(Event::PaymentForwarded {
1255 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1256 outbound_amount_forwarded_msat
1263 let mut channel_id = [0; 32];
1264 let mut reason = UpgradableRequired(None);
1265 let mut user_channel_id_low_opt: Option<u64> = None;
1266 let mut user_channel_id_high_opt: Option<u64> = None;
1267 let mut counterparty_node_id = None;
1268 let mut channel_capacity_sats = None;
1269 read_tlv_fields!(reader, {
1270 (0, channel_id, required),
1271 (1, user_channel_id_low_opt, option),
1272 (2, reason, upgradable_required),
1273 (3, user_channel_id_high_opt, option),
1274 (5, counterparty_node_id, option),
1275 (7, channel_capacity_sats, option),
1278 // `user_channel_id` used to be a single u64 value. In order to remain
1279 // backwards compatible with versions prior to 0.0.113, the u128 is serialized
1280 // as two separate u64 values.
1281 let user_channel_id = (user_channel_id_low_opt.unwrap_or(0) as u128) +
1282 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);
1284 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: _init_tlv_based_struct_field!(reason, upgradable_required),
1285 counterparty_node_id, channel_capacity_sats }))
1291 let mut channel_id = [0; 32];
1292 let mut transaction = Transaction{ version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
1293 read_tlv_fields!(reader, {
1294 (0, channel_id, required),
1295 (2, transaction, required),
1297 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
1303 _init_and_read_tlv_fields!(reader, {
1304 (0, payment_id, required),
1305 (2, payment_hash, option),
1306 (4, path, required_vec),
1307 (6, blinded_tail, option),
1309 Ok(Some(Event::PaymentPathSuccessful {
1310 payment_id: payment_id.0.unwrap(),
1312 path: Path { hops: path, blinded_tail },
1319 let mut payment_hash = PaymentHash([0; 32]);
1320 let mut payment_id = PaymentId([0; 32]);
1321 let mut reason = None;
1322 read_tlv_fields!(reader, {
1323 (0, payment_id, required),
1324 (1, reason, upgradable_option),
1325 (2, payment_hash, required),
1327 Ok(Some(Event::PaymentFailed {
1336 // Value 17 is used for `Event::OpenChannelRequest`.
1341 let mut payment_hash = PaymentHash([0; 32]);
1342 let mut purpose = UpgradableRequired(None);
1343 let mut amount_msat = 0;
1344 let mut receiver_node_id = None;
1345 read_tlv_fields!(reader, {
1346 (0, payment_hash, required),
1347 (1, receiver_node_id, option),
1348 (2, purpose, upgradable_required),
1349 (4, amount_msat, required),
1351 Ok(Some(Event::PaymentClaimed {
1354 purpose: _init_tlv_based_struct_field!(purpose, upgradable_required),
1362 _init_and_read_tlv_fields!(reader, {
1363 (0, payment_id, required),
1364 (2, payment_hash, required),
1365 (4, path, required_vec),
1366 (6, blinded_tail, option),
1368 Ok(Some(Event::ProbeSuccessful {
1369 payment_id: payment_id.0.unwrap(),
1370 payment_hash: payment_hash.0.unwrap(),
1371 path: Path { hops: path, blinded_tail },
1378 _init_and_read_tlv_fields!(reader, {
1379 (0, payment_id, required),
1380 (2, payment_hash, required),
1381 (4, path, required_vec),
1382 (6, short_channel_id, option),
1383 (8, blinded_tail, option),
1385 Ok(Some(Event::ProbeFailed {
1386 payment_id: payment_id.0.unwrap(),
1387 payment_hash: payment_hash.0.unwrap(),
1388 path: Path { hops: path, blinded_tail },
1396 let mut prev_channel_id = [0; 32];
1397 let mut failed_next_destination_opt = UpgradableRequired(None);
1398 read_tlv_fields!(reader, {
1399 (0, prev_channel_id, required),
1400 (2, failed_next_destination_opt, upgradable_required),
1402 Ok(Some(Event::HTLCHandlingFailed {
1404 failed_next_destination: _init_tlv_based_struct_field!(failed_next_destination_opt, upgradable_required),
1412 let mut channel_id = [0; 32];
1413 let mut user_channel_id: u128 = 0;
1414 let mut counterparty_node_id = RequiredWrapper(None);
1415 let mut channel_type = RequiredWrapper(None);
1416 read_tlv_fields!(reader, {
1417 (0, channel_id, required),
1418 (2, user_channel_id, required),
1419 (4, counterparty_node_id, required),
1420 (6, channel_type, required),
1423 Ok(Some(Event::ChannelReady {
1426 counterparty_node_id: counterparty_node_id.0.unwrap(),
1427 channel_type: channel_type.0.unwrap()
1434 let mut channel_id = [0; 32];
1435 let mut user_channel_id: u128 = 0;
1436 let mut former_temporary_channel_id = None;
1437 let mut counterparty_node_id = RequiredWrapper(None);
1438 let mut funding_txo = RequiredWrapper(None);
1439 read_tlv_fields!(reader, {
1440 (0, channel_id, required),
1441 (2, user_channel_id, required),
1442 (4, former_temporary_channel_id, required),
1443 (6, counterparty_node_id, required),
1444 (8, funding_txo, required),
1447 Ok(Some(Event::ChannelPending {
1450 former_temporary_channel_id,
1451 counterparty_node_id: counterparty_node_id.0.unwrap(),
1452 funding_txo: funding_txo.0.unwrap()
1457 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
1458 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
1460 x if x % 2 == 1 => {
1461 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
1462 // which prefixes the whole thing with a length BigSize. Because the event is
1463 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
1464 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
1465 // exactly the number of bytes specified, ignoring them entirely.
1466 let tlv_len: BigSize = Readable::read(reader)?;
1467 FixedLengthReader::new(reader, tlv_len.0)
1468 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
1471 _ => Err(msgs::DecodeError::InvalidValue)
1476 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
1477 /// broadcast to most peers).
1478 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
1479 #[derive(Clone, Debug)]
1480 pub enum MessageSendEvent {
1481 /// Used to indicate that we've accepted a channel open and should send the accept_channel
1482 /// message provided to the given peer.
1484 /// The node_id of the node which should receive this message
1486 /// The message which should be sent.
1487 msg: msgs::AcceptChannel,
1489 /// Used to indicate that we've accepted a V2 channel open and should send the accept_channel2
1490 /// message provided to the given peer.
1491 SendAcceptChannelV2 {
1492 /// The node_id of the node which should receive this message
1494 /// The message which should be sent.
1495 msg: msgs::AcceptChannelV2,
1497 /// Used to indicate that we've initiated a channel open and should send the open_channel
1498 /// message provided to the given peer.
1500 /// The node_id of the node which should receive this message
1502 /// The message which should be sent.
1503 msg: msgs::OpenChannel,
1505 /// Used to indicate that we've initiated a V2 channel open and should send the open_channel2
1506 /// message provided to the given peer.
1508 /// The node_id of the node which should receive this message
1510 /// The message which should be sent.
1511 msg: msgs::OpenChannelV2,
1513 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
1514 SendFundingCreated {
1515 /// The node_id of the node which should receive this message
1517 /// The message which should be sent.
1518 msg: msgs::FundingCreated,
1520 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
1522 /// The node_id of the node which should receive this message
1524 /// The message which should be sent.
1525 msg: msgs::FundingSigned,
1527 /// Used to indicate that a tx_add_input message should be sent to the peer with the given node_id.
1529 /// The node_id of the node which should receive this message
1531 /// The message which should be sent.
1532 msg: msgs::TxAddInput,
1534 /// Used to indicate that a tx_add_output message should be sent to the peer with the given node_id.
1536 /// The node_id of the node which should receive this message
1538 /// The message which should be sent.
1539 msg: msgs::TxAddOutput,
1541 /// Used to indicate that a tx_remove_input message should be sent to the peer with the given node_id.
1543 /// The node_id of the node which should receive this message
1545 /// The message which should be sent.
1546 msg: msgs::TxRemoveInput,
1548 /// Used to indicate that a tx_remove_output message should be sent to the peer with the given node_id.
1549 SendTxRemoveOutput {
1550 /// The node_id of the node which should receive this message
1552 /// The message which should be sent.
1553 msg: msgs::TxRemoveOutput,
1555 /// Used to indicate that a tx_complete message should be sent to the peer with the given node_id.
1557 /// The node_id of the node which should receive this message
1559 /// The message which should be sent.
1560 msg: msgs::TxComplete,
1562 /// Used to indicate that a tx_signatures message should be sent to the peer with the given node_id.
1564 /// The node_id of the node which should receive this message
1566 /// The message which should be sent.
1567 msg: msgs::TxSignatures,
1569 /// Used to indicate that a tx_init_rbf message should be sent to the peer with the given node_id.
1571 /// The node_id of the node which should receive this message
1573 /// The message which should be sent.
1574 msg: msgs::TxInitRbf,
1576 /// Used to indicate that a tx_ack_rbf message should be sent to the peer with the given node_id.
1578 /// The node_id of the node which should receive this message
1580 /// The message which should be sent.
1581 msg: msgs::TxAckRbf,
1583 /// Used to indicate that a tx_abort message should be sent to the peer with the given node_id.
1585 /// The node_id of the node which should receive this message
1587 /// The message which should be sent.
1588 msg: msgs::TxAddInput,
1590 /// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
1592 /// The node_id of the node which should receive these message(s)
1594 /// The channel_ready message which should be sent.
1595 msg: msgs::ChannelReady,
1597 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
1598 SendAnnouncementSignatures {
1599 /// The node_id of the node which should receive these message(s)
1601 /// The announcement_signatures message which should be sent.
1602 msg: msgs::AnnouncementSignatures,
1604 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
1605 /// message should be sent to the peer with the given node_id.
1607 /// The node_id of the node which should receive these message(s)
1609 /// The update messages which should be sent. ALL messages in the struct should be sent!
1610 updates: msgs::CommitmentUpdate,
1612 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
1614 /// The node_id of the node which should receive this message
1616 /// The message which should be sent.
1617 msg: msgs::RevokeAndACK,
1619 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
1621 /// The node_id of the node which should receive this message
1623 /// The message which should be sent.
1624 msg: msgs::ClosingSigned,
1626 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
1628 /// The node_id of the node which should receive this message
1630 /// The message which should be sent.
1631 msg: msgs::Shutdown,
1633 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
1634 SendChannelReestablish {
1635 /// The node_id of the node which should receive this message
1637 /// The message which should be sent.
1638 msg: msgs::ChannelReestablish,
1640 /// Used to send a channel_announcement and channel_update to a specific peer, likely on
1641 /// initial connection to ensure our peers know about our channels.
1642 SendChannelAnnouncement {
1643 /// The node_id of the node which should receive this message
1645 /// The channel_announcement which should be sent.
1646 msg: msgs::ChannelAnnouncement,
1647 /// The followup channel_update which should be sent.
1648 update_msg: msgs::ChannelUpdate,
1650 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
1651 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
1653 /// Note that after doing so, you very likely (unless you did so very recently) want to
1654 /// broadcast a node_announcement (e.g. via [`PeerManager::broadcast_node_announcement`]). This
1655 /// ensures that any nodes which see our channel_announcement also have a relevant
1656 /// node_announcement, including relevant feature flags which may be important for routing
1657 /// through or to us.
1659 /// [`PeerManager::broadcast_node_announcement`]: crate::ln::peer_handler::PeerManager::broadcast_node_announcement
1660 BroadcastChannelAnnouncement {
1661 /// The channel_announcement which should be sent.
1662 msg: msgs::ChannelAnnouncement,
1663 /// The followup channel_update which should be sent.
1664 update_msg: Option<msgs::ChannelUpdate>,
1666 /// Used to indicate that a channel_update should be broadcast to all peers.
1667 BroadcastChannelUpdate {
1668 /// The channel_update which should be sent.
1669 msg: msgs::ChannelUpdate,
1671 /// Used to indicate that a node_announcement should be broadcast to all peers.
1672 BroadcastNodeAnnouncement {
1673 /// The node_announcement which should be sent.
1674 msg: msgs::NodeAnnouncement,
1676 /// Used to indicate that a channel_update should be sent to a single peer.
1677 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
1678 /// private channel and we shouldn't be informing all of our peers of channel parameters.
1680 /// The node_id of the node which should receive this message
1682 /// The channel_update which should be sent.
1683 msg: msgs::ChannelUpdate,
1685 /// Broadcast an error downstream to be handled
1687 /// The node_id of the node which should receive this message
1689 /// The action which should be taken.
1690 action: msgs::ErrorAction
1692 /// Query a peer for channels with funding transaction UTXOs in a block range.
1693 SendChannelRangeQuery {
1694 /// The node_id of this message recipient
1696 /// The query_channel_range which should be sent.
1697 msg: msgs::QueryChannelRange,
1699 /// Request routing gossip messages from a peer for a list of channels identified by
1700 /// their short_channel_ids.
1702 /// The node_id of this message recipient
1704 /// The query_short_channel_ids which should be sent.
1705 msg: msgs::QueryShortChannelIds,
1707 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1708 /// emitted during processing of the query.
1709 SendReplyChannelRange {
1710 /// The node_id of this message recipient
1712 /// The reply_channel_range which should be sent.
1713 msg: msgs::ReplyChannelRange,
1715 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1716 /// enable receiving gossip messages from the peer.
1717 SendGossipTimestampFilter {
1718 /// The node_id of this message recipient
1720 /// The gossip_timestamp_filter which should be sent.
1721 msg: msgs::GossipTimestampFilter,
1725 /// A trait indicating an object may generate message send events
1726 pub trait MessageSendEventsProvider {
1727 /// Gets the list of pending events which were generated by previous actions, clearing the list
1729 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1732 /// A trait indicating an object may generate onion messages to send
1733 pub trait OnionMessageProvider {
1734 /// Gets the next pending onion message for the peer with the given node id.
1735 fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<msgs::OnionMessage>;
1738 /// A trait indicating an object may generate events.
1740 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1742 /// Implementations of this trait may also feature an async version of event handling, as shown with
1743 /// [`ChannelManager::process_pending_events_async`] and
1744 /// [`ChainMonitor::process_pending_events_async`].
1748 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1749 /// event since the last invocation.
1751 /// In order to ensure no [`Event`]s are lost, implementors of this trait will persist [`Event`]s
1752 /// and replay any unhandled events on startup. An [`Event`] is considered handled when
1753 /// [`process_pending_events`] returns, thus handlers MUST fully handle [`Event`]s and persist any
1754 /// relevant changes to disk *before* returning.
1756 /// Further, because an application may crash between an [`Event`] being handled and the
1757 /// implementor of this trait being re-serialized, [`Event`] handling must be idempotent - in
1758 /// effect, [`Event`]s may be replayed.
1760 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1761 /// consult the provider's documentation on the implication of processing events and how a handler
1762 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1763 /// [`ChainMonitor::process_pending_events`]).
1765 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1768 /// [`process_pending_events`]: Self::process_pending_events
1769 /// [`handle_event`]: EventHandler::handle_event
1770 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1771 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1772 /// [`ChannelManager::process_pending_events_async`]: crate::ln::channelmanager::ChannelManager::process_pending_events_async
1773 /// [`ChainMonitor::process_pending_events_async`]: crate::chain::chainmonitor::ChainMonitor::process_pending_events_async
1774 pub trait EventsProvider {
1775 /// Processes any events generated since the last call using the given event handler.
1777 /// See the trait-level documentation for requirements.
1778 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1781 /// A trait implemented for objects handling events from [`EventsProvider`].
1783 /// An async variation also exists for implementations of [`EventsProvider`] that support async
1784 /// event handling. The async event handler should satisfy the generic bounds: `F:
1785 /// core::future::Future, H: Fn(Event) -> F`.
1786 pub trait EventHandler {
1787 /// Handles the given [`Event`].
1789 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1790 fn handle_event(&self, event: Event);
1793 impl<F> EventHandler for F where F: Fn(Event) {
1794 fn handle_event(&self, event: Event) {
1799 impl<T: EventHandler> EventHandler for Arc<T> {
1800 fn handle_event(&self, event: Event) {
1801 self.deref().handle_event(event)