git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/events.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! Events are returned from various bits in the library which indicate some action must be taken
  11 //! by the client.
  12 //!
  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
  15 //! few other things.
  16
  17 use crate::chain::keysinterface::SpendableOutputDescriptor;
  18 #[cfg(anchors)]
  19 use crate::ln::chan_utils::HTLCOutputInCommitment;
  20 use crate::ln::channelmanager::{InterceptId, PaymentId};
  21 use crate::ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
  22 use crate::ln::features::ChannelTypeFeatures;
  23 use crate::ln::msgs;
  24 use crate::ln::msgs::DecodeError;
  25 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  26 use crate::routing::gossip::NetworkUpdate;
  27 use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, WithoutLength, OptionDeserWrapper};
  28 use crate::routing::router::{RouteHop, RouteParameters};
  29
  30 use bitcoin::{PackedLockTime, Transaction};
  31 #[cfg(anchors)]
  32 use bitcoin::OutPoint;
  33 use bitcoin::blockdata::script::Script;
  34 use bitcoin::hashes::Hash;
  35 use bitcoin::hashes::sha256::Hash as Sha256;
  36 use bitcoin::secp256k1::PublicKey;
  37 use crate::io;
  38 use crate::prelude::*;
  39 use core::time::Duration;
  40 use core::ops::Deref;
  41 use crate::sync::Arc;
  42
  43 /// Some information provided on receipt of payment depends on whether the payment received is a
  44 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
  45 #[derive(Clone, Debug)]
  46 pub enum PaymentPurpose {
  47         /// Information for receiving a payment that we generated an invoice for.
  48         InvoicePayment {
  49                 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
  50                 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
  51                 /// [`ChannelManager::claim_funds`].
  52                 ///
  53                 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
  54                 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
  55                 payment_preimage: Option<PaymentPreimage>,
  56                 /// The "payment secret". This authenticates the sender to the recipient, preventing a
  57                 /// number of deanonymization attacks during the routing process.
  58                 /// It is provided here for your reference, however its accuracy is enforced directly by
  59                 /// [`ChannelManager`] using the values you previously provided to
  60                 /// [`ChannelManager::create_inbound_payment`] or
  61                 /// [`ChannelManager::create_inbound_payment_for_hash`].
  62                 ///
  63                 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  64                 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
  65                 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
  66                 payment_secret: PaymentSecret,
  67         },
  68         /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
  69         /// (the payee) providing a preimage.
  70         SpontaneousPayment(PaymentPreimage),
  71 }
  72
  73 impl_writeable_tlv_based_enum!(PaymentPurpose,
  74         (0, InvoicePayment) => {
  75                 (0, payment_preimage, option),
  76                 (2, payment_secret, required),
  77         };
  78         (2, SpontaneousPayment)
  79 );
  80
  81 #[derive(Clone, Debug, PartialEq, Eq)]
  82 /// The reason the channel was closed. See individual variants more details.
  83 pub enum ClosureReason {
  84         /// Closure generated from receiving a peer error message.
  85         ///
  86         /// Our counterparty may have broadcasted their latest commitment state, and we have
  87         /// as well.
  88         CounterpartyForceClosed {
  89                 /// The error which the peer sent us.
  90                 ///
  91                 /// The string should be sanitized before it is used (e.g emitted to logs
  92                 /// or printed to stdout). Otherwise, a well crafted error message may exploit
  93                 /// a security vulnerability in the terminal emulator or the logging subsystem.
  94                 peer_msg: String,
  95         },
  96         /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
  97         ///
  98         /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
  99         HolderForceClosed,
 100         /// The channel was closed after negotiating a cooperative close and we've now broadcasted
 101         /// the cooperative close transaction. Note the shutdown may have been initiated by us.
 102         //TODO: split between CounterpartyInitiated/LocallyInitiated
 103         CooperativeClosure,
 104         /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
 105         /// commitment transaction came from our counterparty, but it may also have come from
 106         /// a copy of our own `ChannelMonitor`.
 107         CommitmentTxConfirmed,
 108         /// The funding transaction failed to confirm in a timely manner on an inbound channel.
 109         FundingTimedOut,
 110         /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
 111         ProcessingError {
 112                 /// A developer-readable error message which we generated.
 113                 err: String,
 114         },
 115         /// The peer disconnected prior to funding completing. In this case the spec mandates that we
 116         /// forget the channel entirely - we can attempt again if the peer reconnects.
 117         ///
 118         /// This includes cases where we restarted prior to funding completion, including prior to the
 119         /// initial [`ChannelMonitor`] persistence completing.
 120         ///
 121         /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
 122         /// peer because of mutual incompatibility between us and our channel counterparty.
 123         ///
 124         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
 125         DisconnectedPeer,
 126         /// Closure generated from `ChannelManager::read` if the [`ChannelMonitor`] is newer than
 127         /// the [`ChannelManager`] deserialized.
 128         ///
 129         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
 130         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 131         OutdatedChannelManager
 132 }
 133
 134 impl core::fmt::Display for ClosureReason {
 135         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 136                 f.write_str("Channel closed because ")?;
 137                 match self {
 138                         ClosureReason::CounterpartyForceClosed { peer_msg } => {
 139                                 f.write_str("counterparty force-closed with message ")?;
 140                                 f.write_str(&peer_msg)
 141                         },
 142                         ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
 143                         ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
 144                         ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
 145                         ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
 146                         ClosureReason::ProcessingError { err } => {
 147                                 f.write_str("of an exception: ")?;
 148                                 f.write_str(&err)
 149                         },
 150                         ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
 151                         ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
 152                 }
 153         }
 154 }
 155
 156 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
 157         (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
 158         (1, FundingTimedOut) => {},
 159         (2, HolderForceClosed) => {},
 160         (6, CommitmentTxConfirmed) => {},
 161         (4, CooperativeClosure) => {},
 162         (8, ProcessingError) => { (1, err, required) },
 163         (10, DisconnectedPeer) => {},
 164         (12, OutdatedChannelManager) => {},
 165 );
 166
 167 /// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].
 168 #[derive(Clone, Debug, PartialEq, Eq)]
 169 pub enum HTLCDestination {
 170         /// We tried forwarding to a channel but failed to do so. An example of such an instance is when
 171         /// there is insufficient capacity in our outbound channel.
 172         NextHopChannel {
 173                 /// The `node_id` of the next node. For backwards compatibility, this field is
 174                 /// marked as optional, versions prior to 0.0.110 may not always be able to provide
 175                 /// counterparty node information.
 176                 node_id: Option<PublicKey>,
 177                 /// The outgoing `channel_id` between us and the next node.
 178                 channel_id: [u8; 32],
 179         },
 180         /// Scenario where we are unsure of the next node to forward the HTLC to.
 181         UnknownNextHop {
 182                 /// Short channel id we are requesting to forward an HTLC to.
 183                 requested_forward_scid: u64,
 184         },
 185         /// We couldn't forward to the outgoing scid. An example would be attempting to send a duplicate
 186         /// intercept HTLC.
 187         InvalidForward {
 188                 /// Short channel id we are requesting to forward an HTLC to.
 189                 requested_forward_scid: u64
 190         },
 191         /// Failure scenario where an HTLC may have been forwarded to be intended for us,
 192         /// but is invalid for some reason, so we reject it.
 193         ///
 194         /// Some of the reasons may include:
 195         /// * HTLC Timeouts
 196         /// * Expected MPP amount to claim does not equal HTLC total
 197         /// * Claimable amount does not match expected amount
 198         FailedPayment {
 199                 /// The payment hash of the payment we attempted to process.
 200                 payment_hash: PaymentHash
 201         },
 202 }
 203
 204 impl_writeable_tlv_based_enum_upgradable!(HTLCDestination,
 205         (0, NextHopChannel) => {
 206                 (0, node_id, required),
 207                 (2, channel_id, required),
 208         },
 209         (1, InvalidForward) => {
 210                 (0, requested_forward_scid, required),
 211         },
 212         (2, UnknownNextHop) => {
 213                 (0, requested_forward_scid, required),
 214         },
 215         (4, FailedPayment) => {
 216                 (0, payment_hash, required),
 217         },
 218 );
 219
 220 #[cfg(anchors)]
 221 /// A descriptor used to sign for a commitment transaction's anchor output.
 222 #[derive(Clone, Debug)]
 223 pub struct AnchorDescriptor {
 224         /// A unique identifier used along with `channel_value_satoshis` to re-derive the
 225         /// [`InMemorySigner`] required to sign `input`.
 226         ///
 227         /// [`InMemorySigner`]: crate::chain::keysinterface::InMemorySigner
 228         pub channel_keys_id: [u8; 32],
 229         /// The value in satoshis of the channel we're attempting to spend the anchor output of. This is
 230         /// used along with `channel_keys_id` to re-derive the [`InMemorySigner`] required to sign
 231         /// `input`.
 232         ///
 233         /// [`InMemorySigner`]: crate::chain::keysinterface::InMemorySigner
 234         pub channel_value_satoshis: u64,
 235         /// The transaction input's outpoint corresponding to the commitment transaction's anchor
 236         /// output.
 237         pub outpoint: OutPoint,
 238 }
 239
 240 #[cfg(anchors)]
 241 /// Represents the different types of transactions, originating from LDK, to be bumped.
 242 #[derive(Clone, Debug)]
 243 pub enum BumpTransactionEvent {
 244         /// Indicates that a channel featuring anchor outputs is to be closed by broadcasting the local
 245         /// commitment transaction. Since commitment transactions have a static feerate pre-agreed upon,
 246         /// they may need additional fees to be attached through a child transaction using the popular
 247         /// [Child-Pays-For-Parent](https://bitcoinops.org/en/topics/cpfp) fee bumping technique. This
 248         /// child transaction must include the anchor input described within `anchor_descriptor` along
 249         /// with additional inputs to meet the target feerate. Failure to meet the target feerate
 250         /// decreases the confirmation odds of the transaction package (which includes the commitment
 251         /// and child anchor transactions), possibly resulting in a loss of funds. Once the transaction
 252         /// is constructed, it must be fully signed for and broadcasted by the consumer of the event
 253         /// along with the `commitment_tx` enclosed. Note that the `commitment_tx` must always be
 254         /// broadcast first, as the child anchor transaction depends on it.
 255         ///
 256         /// The consumer should be able to sign for any of the additional inputs included within the
 257         /// child anchor transaction. To sign its anchor input, an [`InMemorySigner`] should be
 258         /// re-derived through [`KeysManager::derive_channel_keys`] with the help of
 259         /// [`AnchorDescriptor::channel_keys_id`] and [`AnchorDescriptor::channel_value_satoshis`].
 260         ///
 261         /// It is possible to receive more than one instance of this event if a valid child anchor
 262         /// transaction is never broadcast or is but not with a sufficient fee to be mined. Care should
 263         /// be taken by the consumer of the event to ensure any future iterations of the child anchor
 264         /// transaction adhere to the [Replace-By-Fee
 265         /// rules](https://github.com/bitcoin/bitcoin/blob/master/doc/policy/mempool-replacements.md)
 266         /// for fee bumps to be accepted into the mempool, and eventually the chain. As the frequency of
 267         /// these events is not user-controlled, users may ignore/drop the event if they are no longer
 268         /// able to commit external confirmed funds to the child anchor transaction.
 269         ///
 270         /// The set of `pending_htlcs` on the commitment transaction to be broadcast can be inspected to
 271         /// determine whether a significant portion of the channel's funds are allocated to HTLCs,
 272         /// enabling users to make their own decisions regarding the importance of the commitment
 273         /// transaction's confirmation. Note that this is not required, but simply exists as an option
 274         /// for users to override LDK's behavior. On commitments with no HTLCs (indicated by those with
 275         /// an empty `pending_htlcs`), confirmation of the commitment transaction can be considered to
 276         /// be not urgent.
 277         ///
 278         /// [`InMemorySigner`]: crate::chain::keysinterface::InMemorySigner
 279         /// [`KeysManager::derive_channel_keys`]: crate::chain::keysinterface::KeysManager::derive_channel_keys
 280         ChannelClose {
 281                 /// The target feerate that the transaction package, which consists of the commitment
 282                 /// transaction and the to-be-crafted child anchor transaction, must meet.
 283                 package_target_feerate_sat_per_1000_weight: u32,
 284                 /// The channel's commitment transaction to bump the fee of. This transaction should be
 285                 /// broadcast along with the anchor transaction constructed as a result of consuming this
 286                 /// event.
 287                 commitment_tx: Transaction,
 288                 /// The absolute fee in satoshis of the commitment transaction. This can be used along the
 289                 /// with weight of the commitment transaction to determine its feerate.
 290                 commitment_tx_fee_satoshis: u64,
 291                 /// The descriptor to sign the anchor input of the anchor transaction constructed as a
 292                 /// result of consuming this event.
 293                 anchor_descriptor: AnchorDescriptor,
 294                 /// The set of pending HTLCs on the commitment transaction that need to be resolved once the
 295                 /// commitment transaction confirms.
 296                 pending_htlcs: Vec<HTLCOutputInCommitment>,
 297         },
 298 }
 299
 300 /// Will be used in [`Event::HTLCIntercepted`] to identify the next hop in the HTLC's path.
 301 /// Currently only used in serialization for the sake of maintaining compatibility. More variants
 302 /// will be added for general-purpose HTLC forward intercepts as well as trampoline forward
 303 /// intercepts in upcoming work.
 304 enum InterceptNextHop {
 305         FakeScid {
 306                 requested_next_hop_scid: u64,
 307         },
 308 }
 309
 310 impl_writeable_tlv_based_enum!(InterceptNextHop,
 311         (0, FakeScid) => {
 312                 (0, requested_next_hop_scid, required),
 313         };
 314 );
 315
 316 /// An Event which you should probably take some action in response to.
 317 ///
 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)]
 322 pub enum Event {
 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!
 328         ///
 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`].
 334                 ///
 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`].
 339                 ///
 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.
 349                 ///
 350                 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
 351                 user_channel_id: u128,
 352         },
 353         /// Indicates we've received (an offer of) money! Just gotta dig out that payment preimage and
 354         /// feed it to [`ChannelManager::claim_funds`] to get it....
 355         ///
 356         /// Note that if the preimage is not known, you should call
 357         /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
 358         /// network congestion.
 359         /// If you fail to call either [`ChannelManager::claim_funds`] or
 360         /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
 361         /// automatically failed.
 362         ///
 363         /// # Note
 364         /// LDK will not stop an inbound payment from being paid multiple times, so multiple
 365         /// `PaymentReceived` events may be generated for the same payment.
 366         ///
 367         /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
 368         /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
 369         PaymentReceived {
 370                 /// The node that received the payment.
 371                 /// This is useful to identify payments which were received via [phantom node payments].
 372                 /// This field will always be filled in when the event was generated by LDK versions
 373                 /// 0.0.113 and above.
 374                 ///
 375                 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
 376                 receiver_node_id: Option<PublicKey>,
 377                 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
 378                 /// not stop you from registering duplicate payment hashes for inbound payments.
 379                 payment_hash: PaymentHash,
 380                 /// The value, in thousandths of a satoshi, that this payment is for.
 381                 amount_msat: u64,
 382                 /// Information for claiming this received payment, based on whether the purpose of the
 383                 /// payment is to pay an invoice or to send a spontaneous payment.
 384                 purpose: PaymentPurpose,
 385                 /// The `channel_id` indicating over which channel we received the payment.
 386                 via_channel_id: Option<[u8; 32]>,
 387                 /// The `user_channel_id` indicating over which channel we received the payment.
 388                 via_user_channel_id: Option<u128>,
 389         },
 390         /// Indicates a payment has been claimed and we've received money!
 391         ///
 392         /// This most likely occurs when [`ChannelManager::claim_funds`] has been called in response
 393         /// to an [`Event::PaymentReceived`]. However, if we previously crashed during a
 394         /// [`ChannelManager::claim_funds`] call you may see this event without a corresponding
 395         /// [`Event::PaymentReceived`] event.
 396         ///
 397         /// # Note
 398         /// LDK will not stop an inbound payment from being paid multiple times, so multiple
 399         /// `PaymentReceived` events may be generated for the same payment. If you then call
 400         /// [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentReceived`] you may get
 401         /// multiple `PaymentClaimed` events.
 402         ///
 403         /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
 404         PaymentClaimed {
 405                 /// The node that received the payment.
 406                 /// This is useful to identify payments which were received via [phantom node payments].
 407                 /// This field will always be filled in when the event was generated by LDK versions
 408                 /// 0.0.113 and above.
 409                 ///
 410                 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
 411                 receiver_node_id: Option<PublicKey>,
 412                 /// The payment hash of the claimed payment. Note that LDK will not stop you from
 413                 /// registering duplicate payment hashes for inbound payments.
 414                 payment_hash: PaymentHash,
 415                 /// The value, in thousandths of a satoshi, that this payment is for.
 416                 amount_msat: u64,
 417                 /// The purpose of this claimed payment, i.e. whether the payment was for an invoice or a
 418                 /// spontaneous payment.
 419                 purpose: PaymentPurpose,
 420         },
 421         /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
 422         /// and we got back the payment preimage for it).
 423         ///
 424         /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
 425         /// event. In this situation, you SHOULD treat this payment as having succeeded.
 426         PaymentSent {
 427                 /// The id returned by [`ChannelManager::send_payment`] and used with
 428                 /// [`ChannelManager::retry_payment`].
 429                 ///
 430                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 431                 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 432                 payment_id: Option<PaymentId>,
 433                 /// The preimage to the hash given to ChannelManager::send_payment.
 434                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
 435                 /// store it somehow!
 436                 payment_preimage: PaymentPreimage,
 437                 /// The hash that was given to [`ChannelManager::send_payment`].
 438                 ///
 439                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 440                 payment_hash: PaymentHash,
 441                 /// The total fee which was spent at intermediate hops in this payment, across all paths.
 442                 ///
 443                 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
 444                 /// overpayment to the recipient node.
 445                 ///
 446                 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
 447                 /// overstate the amount paid, though this is unlikely.
 448                 ///
 449                 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
 450                 fee_paid_msat: Option<u64>,
 451         },
 452         /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
 453         /// provide failure information for each MPP part in the payment.
 454         ///
 455         /// This event is provided once there are no further pending HTLCs for the payment and the
 456         /// payment is no longer retryable due to [`ChannelManager::abandon_payment`] having been
 457         /// called for the corresponding payment.
 458         ///
 459         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 460         PaymentFailed {
 461                 /// The id returned by [`ChannelManager::send_payment`] and used with
 462                 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
 463                 ///
 464                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 465                 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 466                 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 467                 payment_id: PaymentId,
 468                 /// The hash that was given to [`ChannelManager::send_payment`].
 469                 ///
 470                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 471                 payment_hash: PaymentHash,
 472         },
 473         /// Indicates that a path for an outbound payment was successful.
 474         ///
 475         /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
 476         /// [`Event::PaymentSent`] for obtaining the payment preimage.
 477         PaymentPathSuccessful {
 478                 /// The id returned by [`ChannelManager::send_payment`] and used with
 479                 /// [`ChannelManager::retry_payment`].
 480                 ///
 481                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 482                 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 483                 payment_id: PaymentId,
 484                 /// The hash that was given to [`ChannelManager::send_payment`].
 485                 ///
 486                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 487                 payment_hash: Option<PaymentHash>,
 488                 /// The payment path that was successful.
 489                 ///
 490                 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
 491                 path: Vec<RouteHop>,
 492         },
 493         /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
 494         /// something. You may wish to retry with a different route.
 495         ///
 496         /// If you have given up retrying this payment and wish to fail it, you MUST call
 497         /// [`ChannelManager::abandon_payment`] at least once for a given [`PaymentId`] or memory
 498         /// related to payment tracking will leak.
 499         ///
 500         /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
 501         /// [`Event::PaymentFailed`] and [`all_paths_failed`].
 502         ///
 503         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 504         /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
 505         PaymentPathFailed {
 506                 /// The id returned by [`ChannelManager::send_payment`] and used with
 507                 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
 508                 ///
 509                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 510                 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 511                 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 512                 payment_id: Option<PaymentId>,
 513                 /// The hash that was given to [`ChannelManager::send_payment`].
 514                 ///
 515                 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 516                 payment_hash: PaymentHash,
 517                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
 518                 /// the payment has failed, not just the route in question. If this is not set, you may
 519                 /// retry the payment via a different route.
 520                 payment_failed_permanently: bool,
 521                 /// Any failure information conveyed via the Onion return packet by a node along the failed
 522                 /// payment route.
 523                 ///
 524                 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
 525                 /// account the update.
 526                 ///
 527                 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
 528                 network_update: Option<NetworkUpdate>,
 529                 /// For both single-path and multi-path payments, this is set if all paths of the payment have
 530                 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
 531                 /// larger MPP payment were still in flight when this event was generated.
 532                 ///
 533                 /// Note that if you are retrying individual MPP parts, using this value to determine if a
 534                 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
 535                 /// being processed, you may retry in response to a first failure, with a second failure
 536                 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
 537                 /// you will see `all_paths_failed` set even though the retry of the first failure still
 538                 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
 539                 ///
 540                 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
 541                 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
 542                 ///
 543                 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
 544                 ///
 545                 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 546                 all_paths_failed: bool,
 547                 /// The payment path that failed.
 548                 path: Vec<RouteHop>,
 549                 /// The channel responsible for the failed payment path.
 550                 ///
 551                 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
 552                 /// may not refer to a channel in the public network graph. These aliases may also collide
 553                 /// with channels in the public network graph.
 554                 ///
 555                 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
 556                 /// retried. May be `None` for older [`Event`] serializations.
 557                 short_channel_id: Option<u64>,
 558                 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
 559                 ///
 560                 /// See [`find_route`] for details.
 561                 ///
 562                 /// [`Route`]: crate::routing::router::Route
 563                 /// [`find_route`]: crate::routing::router::find_route
 564                 retry: Option<RouteParameters>,
 565 #[cfg(test)]
 566                 error_code: Option<u16>,
 567 #[cfg(test)]
 568                 error_data: Option<Vec<u8>>,
 569         },
 570         /// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
 571         ProbeSuccessful {
 572                 /// The id returned by [`ChannelManager::send_probe`].
 573                 ///
 574                 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 575                 payment_id: PaymentId,
 576                 /// The hash generated by [`ChannelManager::send_probe`].
 577                 ///
 578                 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 579                 payment_hash: PaymentHash,
 580                 /// The payment path that was successful.
 581                 path: Vec<RouteHop>,
 582         },
 583         /// Indicates that a probe payment we sent failed at an intermediary node on the path.
 584         ProbeFailed {
 585                 /// The id returned by [`ChannelManager::send_probe`].
 586                 ///
 587                 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 588                 payment_id: PaymentId,
 589                 /// The hash generated by [`ChannelManager::send_probe`].
 590                 ///
 591                 /// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 592                 payment_hash: PaymentHash,
 593                 /// The payment path that failed.
 594                 path: Vec<RouteHop>,
 595                 /// The channel responsible for the failed probe.
 596                 ///
 597                 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
 598                 /// may not refer to a channel in the public network graph. These aliases may also collide
 599                 /// with channels in the public network graph.
 600                 short_channel_id: Option<u64>,
 601         },
 602         /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
 603         /// a time in the future.
 604         ///
 605         /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
 606         PendingHTLCsForwardable {
 607                 /// The minimum amount of time that should be waited prior to calling
 608                 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
 609                 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
 610                 /// now + 5*time_forwardable).
 611                 time_forwardable: Duration,
 612         },
 613         /// Used to indicate that we've intercepted an HTLC forward. This event will only be generated if
 614         /// you've encoded an intercept scid in the receiver's invoice route hints using
 615         /// [`ChannelManager::get_intercept_scid`].
 616         ///
 617         /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
 618         HTLCIntercepted {
 619                 /// An id to help LDK identify which HTLC is being forwarded or failed.
 620                 intercept_id: InterceptId,
 621                 /// The fake scid that was programmed as the next hop's scid, generated using
 622                 /// [`ChannelManager::get_intercept_scid`].
 623                 ///
 624                 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
 625                 requested_next_hop_scid: u64,
 626                 /// The payment hash used for this HTLC.
 627                 payment_hash: PaymentHash,
 628                 /// How many msats were received on the inbound edge of this HTLC.
 629                 inbound_amount_msat: u64,
 630                 /// How many msats the payer intended to route to the next node. Depending on the reason you are
 631                 /// intercepting this payment, you might take a fee by forwarding less than this amount.
 632                 ///
 633                 /// Note that LDK will NOT check that expected fees were factored into this value. You MUST
 634                 /// check that whatever fee you want has been included here or subtract it as required. Further,
 635                 /// LDK will not stop you from forwarding more than you received.
 636                 expected_outbound_amount_msat: u64,
 637         },
 638         /// Used to indicate that an output which you should know how to spend was confirmed on chain
 639         /// and is now spendable.
 640         /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
 641         /// counterparty spending them due to some kind of timeout. Thus, you need to store them
 642         /// somewhere and spend them when you create on-chain transactions.
 643         SpendableOutputs {
 644                 /// The outputs which you should store as spendable by you.
 645                 outputs: Vec<SpendableOutputDescriptor>,
 646         },
 647         /// This event is generated when a payment has been successfully forwarded through us and a
 648         /// forwarding fee earned.
 649         PaymentForwarded {
 650                 /// The incoming channel between the previous node and us. This is only `None` for events
 651                 /// generated or serialized by versions prior to 0.0.107.
 652                 prev_channel_id: Option<[u8; 32]>,
 653                 /// The outgoing channel between the next node and us. This is only `None` for events
 654                 /// generated or serialized by versions prior to 0.0.107.
 655                 next_channel_id: Option<[u8; 32]>,
 656                 /// The fee, in milli-satoshis, which was earned as a result of the payment.
 657                 ///
 658                 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
 659                 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
 660                 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
 661                 /// claimed the full value in millisatoshis from the source. In this case,
 662                 /// `claim_from_onchain_tx` will be set.
 663                 ///
 664                 /// If the channel which sent us the payment has been force-closed, we will claim the funds
 665                 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
 666                 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
 667                 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
 668                 /// `None`.
 669                 fee_earned_msat: Option<u64>,
 670                 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
 671                 /// transaction.
 672                 claim_from_onchain_tx: bool,
 673         },
 674         /// Used to indicate that a channel with the given `channel_id` is ready to
 675         /// be used. This event is emitted either when the funding transaction has been confirmed
 676         /// on-chain, or, in case of a 0conf channel, when both parties have confirmed the channel
 677         /// establishment.
 678         ChannelReady {
 679                 /// The channel_id of the channel that is ready.
 680                 channel_id: [u8; 32],
 681                 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
 682                 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
 683                 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
 684                 /// `user_channel_id` will be randomized for an inbound channel.
 685                 ///
 686                 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
 687                 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 688                 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
 689                 user_channel_id: u128,
 690                 /// The node_id of the channel counterparty.
 691                 counterparty_node_id: PublicKey,
 692                 /// The features that this channel will operate with.
 693                 channel_type: ChannelTypeFeatures,
 694         },
 695         /// Used to indicate that a previously opened channel with the given `channel_id` is in the
 696         /// process of closure.
 697         ChannelClosed  {
 698                 /// The channel_id of the channel which has been closed. Note that on-chain transactions
 699                 /// resolving the channel are likely still awaiting 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 inbound channels.
 705                 /// This may be zero for inbound channels serialized prior to 0.0.113 and will always be
 706                 /// zero for objects serialized with LDK versions prior to 0.0.102.
 707                 ///
 708                 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
 709                 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 710                 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
 711                 user_channel_id: u128,
 712                 /// The reason the channel was closed.
 713                 reason: ClosureReason
 714         },
 715         /// Used to indicate to the user that they can abandon the funding transaction and recycle the
 716         /// inputs for another purpose.
 717         DiscardFunding {
 718                 /// The channel_id of the channel which has been closed.
 719                 channel_id: [u8; 32],
 720                 /// The full transaction received from the user
 721                 transaction: Transaction
 722         },
 723         /// Indicates a request to open a new channel by a peer.
 724         ///
 725         /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
 726         /// request, call [`ChannelManager::force_close_without_broadcasting_txn`].
 727         ///
 728         /// The event is only triggered when a new open channel request is received and the
 729         /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
 730         ///
 731         /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 732         /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
 733         /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
 734         OpenChannelRequest {
 735                 /// The temporary channel ID of the channel requested to be opened.
 736                 ///
 737                 /// When responding to the request, the `temporary_channel_id` should be passed
 738                 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
 739                 /// or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject.
 740                 ///
 741                 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 742                 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
 743                 temporary_channel_id: [u8; 32],
 744                 /// The node_id of the counterparty requesting to open the channel.
 745                 ///
 746                 /// When responding to the request, the `counterparty_node_id` should be passed
 747                 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
 748                 /// accept the request, or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject the
 749                 /// request.
 750                 ///
 751                 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 752                 /// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
 753                 counterparty_node_id: PublicKey,
 754                 /// The channel value of the requested channel.
 755                 funding_satoshis: u64,
 756                 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
 757                 push_msat: u64,
 758                 /// The features that this channel will operate with. If you reject the channel, a
 759                 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
 760                 /// feature flags.
 761                 ///
 762                 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
 763                 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
 764                 /// 0.0.106.
 765                 ///
 766                 /// Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
 767                 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
 768                 /// 0.0.107. Channels setting this type also need to get manually accepted via
 769                 /// [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`],
 770                 /// or will be rejected otherwise.
 771                 ///
 772                 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 773                 channel_type: ChannelTypeFeatures,
 774         },
 775         /// Indicates that the HTLC was accepted, but could not be processed when or after attempting to
 776         /// forward it.
 777         ///
 778         /// Some scenarios where this event may be sent include:
 779         /// * Insufficient capacity in the outbound channel
 780         /// * While waiting to forward the HTLC, the channel it is meant to be forwarded through closes
 781         /// * When an unknown SCID is requested for forwarding a payment.
 782         /// * Claiming an amount for an MPP payment that exceeds the HTLC total
 783         /// * The HTLC has timed out
 784         ///
 785         /// This event, however, does not get generated if an HTLC fails to meet the forwarding
 786         /// requirements (i.e. insufficient fees paid, or a CLTV that is too soon).
 787         HTLCHandlingFailed {
 788                 /// The channel over which the HTLC was received.
 789                 prev_channel_id: [u8; 32],
 790                 /// Destination of the HTLC that failed to be processed.
 791                 failed_next_destination: HTLCDestination,
 792         },
 793         #[cfg(anchors)]
 794         /// Indicates that a transaction originating from LDK needs to have its fee bumped. This event
 795         /// requires confirmed external funds to be readily available to spend.
 796         ///
 797         /// LDK does not currently generate this event. It is limited to the scope of channels with
 798         /// anchor outputs, which will be introduced in a future release.
 799         BumpTransaction(BumpTransactionEvent),
 800 }
 801
 802 impl Writeable for Event {
 803         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 804                 match self {
 805                         &Event::FundingGenerationReady { .. } => {
 806                                 0u8.write(writer)?;
 807                                 // We never write out FundingGenerationReady events as, upon disconnection, peers
 808                                 // drop any channels which have not yet exchanged funding_signed.
 809                         },
 810                         &Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose, ref receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
 811                                 1u8.write(writer)?;
 812                                 let mut payment_secret = None;
 813                                 let payment_preimage;
 814                                 match &purpose {
 815                                         PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
 816                                                 payment_secret = Some(secret);
 817                                                 payment_preimage = *preimage;
 818                                         },
 819                                         PaymentPurpose::SpontaneousPayment(preimage) => {
 820                                                 payment_preimage = Some(*preimage);
 821                                         }
 822                                 }
 823                                 write_tlv_fields!(writer, {
 824                                         (0, payment_hash, required),
 825                                         (1, receiver_node_id, option),
 826                                         (2, payment_secret, option),
 827                                         (3, via_channel_id, option),
 828                                         (4, amount_msat, required),
 829                                         (5, via_user_channel_id, option),
 830                                         (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
 831                                         (8, payment_preimage, option),
 832                                 });
 833                         },
 834                         &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
 835                                 2u8.write(writer)?;
 836                                 write_tlv_fields!(writer, {
 837                                         (0, payment_preimage, required),
 838                                         (1, payment_hash, required),
 839                                         (3, payment_id, option),
 840                                         (5, fee_paid_msat, option),
 841                                 });
 842                         },
 843                         &Event::PaymentPathFailed {
 844                                 ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update,
 845                                 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
 846                                 #[cfg(test)]
 847                                 ref error_code,
 848                                 #[cfg(test)]
 849                                 ref error_data,
 850                         } => {
 851                                 3u8.write(writer)?;
 852                                 #[cfg(test)]
 853                                 error_code.write(writer)?;
 854                                 #[cfg(test)]
 855                                 error_data.write(writer)?;
 856                                 write_tlv_fields!(writer, {
 857                                         (0, payment_hash, required),
 858                                         (1, network_update, option),
 859                                         (2, payment_failed_permanently, required),
 860                                         (3, all_paths_failed, required),
 861                                         (5, *path, vec_type),
 862                                         (7, short_channel_id, option),
 863                                         (9, retry, option),
 864                                         (11, payment_id, option),
 865                                 });
 866                         },
 867                         &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
 868                                 4u8.write(writer)?;
 869                                 // Note that we now ignore these on the read end as we'll re-generate them in
 870                                 // ChannelManager, we write them here only for backwards compatibility.
 871                         },
 872                         &Event::SpendableOutputs { ref outputs } => {
 873                                 5u8.write(writer)?;
 874                                 write_tlv_fields!(writer, {
 875                                         (0, WithoutLength(outputs), required),
 876                                 });
 877                         },
 878                         &Event::HTLCIntercepted { requested_next_hop_scid, payment_hash, inbound_amount_msat, expected_outbound_amount_msat, intercept_id } => {
 879                                 6u8.write(writer)?;
 880                                 let intercept_scid = InterceptNextHop::FakeScid { requested_next_hop_scid };
 881                                 write_tlv_fields!(writer, {
 882                                         (0, intercept_id, required),
 883                                         (2, intercept_scid, required),
 884                                         (4, payment_hash, required),
 885                                         (6, inbound_amount_msat, required),
 886                                         (8, expected_outbound_amount_msat, required),
 887                                 });
 888                         }
 889                         &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
 890                                 7u8.write(writer)?;
 891                                 write_tlv_fields!(writer, {
 892                                         (0, fee_earned_msat, option),
 893                                         (1, prev_channel_id, option),
 894                                         (2, claim_from_onchain_tx, required),
 895                                         (3, next_channel_id, option),
 896                                 });
 897                         },
 898                         &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
 899                                 9u8.write(writer)?;
 900                                 // `user_channel_id` used to be a single u64 value. In order to remain backwards
 901                                 // compatible with versions prior to 0.0.113, the u128 is serialized as two
 902                                 // separate u64 values.
 903                                 let user_channel_id_low = *user_channel_id as u64;
 904                                 let user_channel_id_high = (*user_channel_id >> 64) as u64;
 905                                 write_tlv_fields!(writer, {
 906                                         (0, channel_id, required),
 907                                         (1, user_channel_id_low, required),
 908                                         (2, reason, required),
 909                                         (3, user_channel_id_high, required),
 910                                 });
 911                         },
 912                         &Event::DiscardFunding { ref channel_id, ref transaction } => {
 913                                 11u8.write(writer)?;
 914                                 write_tlv_fields!(writer, {
 915                                         (0, channel_id, required),
 916                                         (2, transaction, required)
 917                                 })
 918                         },
 919                         &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
 920                                 13u8.write(writer)?;
 921                                 write_tlv_fields!(writer, {
 922                                         (0, payment_id, required),
 923                                         (2, payment_hash, option),
 924                                         (4, *path, vec_type)
 925                                 })
 926                         },
 927                         &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 928                                 15u8.write(writer)?;
 929                                 write_tlv_fields!(writer, {
 930                                         (0, payment_id, required),
 931                                         (2, payment_hash, required),
 932                                 })
 933                         },
 934                         &Event::OpenChannelRequest { .. } => {
 935                                 17u8.write(writer)?;
 936                                 // We never write the OpenChannelRequest events as, upon disconnection, peers
 937                                 // drop any channels which have not yet exchanged funding_signed.
 938                         },
 939                         &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose, ref receiver_node_id } => {
 940                                 19u8.write(writer)?;
 941                                 write_tlv_fields!(writer, {
 942                                         (0, payment_hash, required),
 943                                         (1, receiver_node_id, option),
 944                                         (2, purpose, required),
 945                                         (4, amount_msat, required),
 946                                 });
 947                         },
 948                         &Event::ProbeSuccessful { ref payment_id, ref payment_hash, ref path } => {
 949                                 21u8.write(writer)?;
 950                                 write_tlv_fields!(writer, {
 951                                         (0, payment_id, required),
 952                                         (2, payment_hash, required),
 953                                         (4, *path, vec_type)
 954                                 })
 955                         },
 956                         &Event::ProbeFailed { ref payment_id, ref payment_hash, ref path, ref short_channel_id } => {
 957                                 23u8.write(writer)?;
 958                                 write_tlv_fields!(writer, {
 959                                         (0, payment_id, required),
 960                                         (2, payment_hash, required),
 961                                         (4, *path, vec_type),
 962                                         (6, short_channel_id, option),
 963                                 })
 964                         },
 965                         &Event::HTLCHandlingFailed { ref prev_channel_id, ref failed_next_destination } => {
 966                                 25u8.write(writer)?;
 967                                 write_tlv_fields!(writer, {
 968                                         (0, prev_channel_id, required),
 969                                         (2, failed_next_destination, required),
 970                                 })
 971                         },
 972                         #[cfg(anchors)]
 973                         &Event::BumpTransaction(ref event)=> {
 974                                 27u8.write(writer)?;
 975                                 match event {
 976                                         // We never write the ChannelClose events as they'll be replayed upon restarting
 977                                         // anyway if the commitment transaction remains unconfirmed.
 978                                         BumpTransactionEvent::ChannelClose { .. } => {}
 979                                 }
 980                         }
 981                         &Event::ChannelReady { ref channel_id, ref user_channel_id, ref counterparty_node_id, ref channel_type } => {
 982                                 29u8.write(writer)?;
 983                                 write_tlv_fields!(writer, {
 984                                         (0, channel_id, required),
 985                                         (2, user_channel_id, required),
 986                                         (4, counterparty_node_id, required),
 987                                         (6, channel_type, required),
 988                                 });
 989                         },
 990                         // Note that, going forward, all new events must only write data inside of
 991                         // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
 992                         // data via `write_tlv_fields`.
 993                 }
 994                 Ok(())
 995         }
 996 }
 997 impl MaybeReadable for Event {
 998         fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
 999                 match Readable::read(reader)? {
1000                         // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
1001                         // unlike all other events, thus we return immediately here.
1002                         0u8 => Ok(None),
1003                         1u8 => {
1004                                 let f = || {
1005                                         let mut payment_hash = PaymentHash([0; 32]);
1006                                         let mut payment_preimage = None;
1007                                         let mut payment_secret = None;
1008                                         let mut amount_msat = 0;
1009                                         let mut receiver_node_id = None;
1010                                         let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
1011                                         let mut via_channel_id = None;
1012                                         let mut via_user_channel_id = None;
1013                                         read_tlv_fields!(reader, {
1014                                                 (0, payment_hash, required),
1015                                                 (1, receiver_node_id, option),
1016                                                 (2, payment_secret, option),
1017                                                 (3, via_channel_id, option),
1018                                                 (4, amount_msat, required),
1019                                                 (5, via_user_channel_id, option),
1020                                                 (6, _user_payment_id, option),
1021                                                 (8, payment_preimage, option),
1022                                         });
1023                                         let purpose = match payment_secret {
1024                                                 Some(secret) => PaymentPurpose::InvoicePayment {
1025                                                         payment_preimage,
1026                                                         payment_secret: secret
1027                                                 },
1028                                                 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
1029                                                 None => return Err(msgs::DecodeError::InvalidValue),
1030                                         };
1031                                         Ok(Some(Event::PaymentReceived {
1032                                                 receiver_node_id,
1033                                                 payment_hash,
1034                                                 amount_msat,
1035                                                 purpose,
1036                                                 via_channel_id,
1037                                                 via_user_channel_id,
1038                                         }))
1039                                 };
1040                                 f()
1041                         },
1042                         2u8 => {
1043                                 let f = || {
1044                                         let mut payment_preimage = PaymentPreimage([0; 32]);
1045                                         let mut payment_hash = None;
1046                                         let mut payment_id = None;
1047                                         let mut fee_paid_msat = None;
1048                                         read_tlv_fields!(reader, {
1049                                                 (0, payment_preimage, required),
1050                                                 (1, payment_hash, option),
1051                                                 (3, payment_id, option),
1052                                                 (5, fee_paid_msat, option),
1053                                         });
1054                                         if payment_hash.is_none() {
1055                                                 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
1056                                         }
1057                                         Ok(Some(Event::PaymentSent {
1058                                                 payment_id,
1059                                                 payment_preimage,
1060                                                 payment_hash: payment_hash.unwrap(),
1061                                                 fee_paid_msat,
1062                                         }))
1063                                 };
1064                                 f()
1065                         },
1066                         3u8 => {
1067                                 let f = || {
1068                                         #[cfg(test)]
1069                                         let error_code = Readable::read(reader)?;
1070                                         #[cfg(test)]
1071                                         let error_data = Readable::read(reader)?;
1072                                         let mut payment_hash = PaymentHash([0; 32]);
1073                                         let mut payment_failed_permanently = false;
1074                                         let mut network_update = None;
1075                                         let mut all_paths_failed = Some(true);
1076                                         let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1077                                         let mut short_channel_id = None;
1078                                         let mut retry = None;
1079                                         let mut payment_id = None;
1080                                         read_tlv_fields!(reader, {
1081                                                 (0, payment_hash, required),
1082                                                 (1, network_update, ignorable),
1083                                                 (2, payment_failed_permanently, required),
1084                                                 (3, all_paths_failed, option),
1085                                                 (5, path, vec_type),
1086                                                 (7, short_channel_id, option),
1087                                                 (9, retry, option),
1088                                                 (11, payment_id, option),
1089                                         });
1090                                         Ok(Some(Event::PaymentPathFailed {
1091                                                 payment_id,
1092                                                 payment_hash,
1093                                                 payment_failed_permanently,
1094                                                 network_update,
1095                                                 all_paths_failed: all_paths_failed.unwrap(),
1096                                                 path: path.unwrap(),
1097                                                 short_channel_id,
1098                                                 retry,
1099                                                 #[cfg(test)]
1100                                                 error_code,
1101                                                 #[cfg(test)]
1102                                                 error_data,
1103                                         }))
1104                                 };
1105                                 f()
1106                         },
1107                         4u8 => Ok(None),
1108                         5u8 => {
1109                                 let f = || {
1110                                         let mut outputs = WithoutLength(Vec::new());
1111                                         read_tlv_fields!(reader, {
1112                                                 (0, outputs, required),
1113                                         });
1114                                         Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
1115                                 };
1116                                 f()
1117                         },
1118                         6u8 => {
1119                                 let mut payment_hash = PaymentHash([0; 32]);
1120                                 let mut intercept_id = InterceptId([0; 32]);
1121                                 let mut requested_next_hop_scid = InterceptNextHop::FakeScid { requested_next_hop_scid: 0 };
1122                                 let mut inbound_amount_msat = 0;
1123                                 let mut expected_outbound_amount_msat = 0;
1124                                 read_tlv_fields!(reader, {
1125                                         (0, intercept_id, required),
1126                                         (2, requested_next_hop_scid, required),
1127                                         (4, payment_hash, required),
1128                                         (6, inbound_amount_msat, required),
1129                                         (8, expected_outbound_amount_msat, required),
1130                                 });
1131                                 let next_scid = match requested_next_hop_scid {
1132                                         InterceptNextHop::FakeScid { requested_next_hop_scid: scid } => scid
1133                                 };
1134                                 Ok(Some(Event::HTLCIntercepted {
1135                                         payment_hash,
1136                                         requested_next_hop_scid: next_scid,
1137                                         inbound_amount_msat,
1138                                         expected_outbound_amount_msat,
1139                                         intercept_id,
1140                                 }))
1141                         },
1142                         7u8 => {
1143                                 let f = || {
1144                                         let mut fee_earned_msat = None;
1145                                         let mut prev_channel_id = None;
1146                                         let mut claim_from_onchain_tx = false;
1147                                         let mut next_channel_id = None;
1148                                         read_tlv_fields!(reader, {
1149                                                 (0, fee_earned_msat, option),
1150                                                 (1, prev_channel_id, option),
1151                                                 (2, claim_from_onchain_tx, required),
1152                                                 (3, next_channel_id, option),
1153                                         });
1154                                         Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
1155                                 };
1156                                 f()
1157                         },
1158                         9u8 => {
1159                                 let f = || {
1160                                         let mut channel_id = [0; 32];
1161                                         let mut reason = None;
1162                                         let mut user_channel_id_low_opt: Option<u64> = None;
1163                                         let mut user_channel_id_high_opt: Option<u64> = None;
1164                                         read_tlv_fields!(reader, {
1165                                                 (0, channel_id, required),
1166                                                 (1, user_channel_id_low_opt, option),
1167                                                 (2, reason, ignorable),
1168                                                 (3, user_channel_id_high_opt, option),
1169                                         });
1170                                         if reason.is_none() { return Ok(None); }
1171
1172                                         // `user_channel_id` used to be a single u64 value. In order to remain
1173                                         // backwards compatible with versions prior to 0.0.113, the u128 is serialized
1174                                         // as two separate u64 values.
1175                                         let user_channel_id = (user_channel_id_low_opt.unwrap_or(0) as u128) +
1176                                                 ((user_channel_id_high_opt.unwrap_or(0) as u128) << 64);
1177
1178                                         Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
1179                                 };
1180                                 f()
1181                         },
1182                         11u8 => {
1183                                 let f = || {
1184                                         let mut channel_id = [0; 32];
1185                                         let mut transaction = Transaction{ version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
1186                                         read_tlv_fields!(reader, {
1187                                                 (0, channel_id, required),
1188                                                 (2, transaction, required),
1189                                         });
1190                                         Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
1191                                 };
1192                                 f()
1193                         },
1194                         13u8 => {
1195                                 let f = || {
1196                                         let mut payment_id = PaymentId([0; 32]);
1197                                         let mut payment_hash = None;
1198                                         let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1199                                         read_tlv_fields!(reader, {
1200                                                 (0, payment_id, required),
1201                                                 (2, payment_hash, option),
1202                                                 (4, path, vec_type),
1203                                         });
1204                                         Ok(Some(Event::PaymentPathSuccessful {
1205                                                 payment_id,
1206                                                 payment_hash,
1207                                                 path: path.unwrap(),
1208                                         }))
1209                                 };
1210                                 f()
1211                         },
1212                         15u8 => {
1213                                 let f = || {
1214                                         let mut payment_hash = PaymentHash([0; 32]);
1215                                         let mut payment_id = PaymentId([0; 32]);
1216                                         read_tlv_fields!(reader, {
1217                                                 (0, payment_id, required),
1218                                                 (2, payment_hash, required),
1219                                         });
1220                                         Ok(Some(Event::PaymentFailed {
1221                                                 payment_id,
1222                                                 payment_hash,
1223                                         }))
1224                                 };
1225                                 f()
1226                         },
1227                         17u8 => {
1228                                 // Value 17 is used for `Event::OpenChannelRequest`.
1229                                 Ok(None)
1230                         },
1231                         19u8 => {
1232                                 let f = || {
1233                                         let mut payment_hash = PaymentHash([0; 32]);
1234                                         let mut purpose = None;
1235                                         let mut amount_msat = 0;
1236                                         let mut receiver_node_id = None;
1237                                         read_tlv_fields!(reader, {
1238                                                 (0, payment_hash, required),
1239                                                 (1, receiver_node_id, option),
1240                                                 (2, purpose, ignorable),
1241                                                 (4, amount_msat, required),
1242                                         });
1243                                         if purpose.is_none() { return Ok(None); }
1244                                         Ok(Some(Event::PaymentClaimed {
1245                                                 receiver_node_id,
1246                                                 payment_hash,
1247                                                 purpose: purpose.unwrap(),
1248                                                 amount_msat,
1249                                         }))
1250                                 };
1251                                 f()
1252                         },
1253                         21u8 => {
1254                                 let f = || {
1255                                         let mut payment_id = PaymentId([0; 32]);
1256                                         let mut payment_hash = PaymentHash([0; 32]);
1257                                         let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1258                                         read_tlv_fields!(reader, {
1259                                                 (0, payment_id, required),
1260                                                 (2, payment_hash, required),
1261                                                 (4, path, vec_type),
1262                                         });
1263                                         Ok(Some(Event::ProbeSuccessful {
1264                                                 payment_id,
1265                                                 payment_hash,
1266                                                 path: path.unwrap(),
1267                                         }))
1268                                 };
1269                                 f()
1270                         },
1271                         23u8 => {
1272                                 let f = || {
1273                                         let mut payment_id = PaymentId([0; 32]);
1274                                         let mut payment_hash = PaymentHash([0; 32]);
1275                                         let mut path: Option<Vec<RouteHop>> = Some(vec![]);
1276                                         let mut short_channel_id = None;
1277                                         read_tlv_fields!(reader, {
1278                                                 (0, payment_id, required),
1279                                                 (2, payment_hash, required),
1280                                                 (4, path, vec_type),
1281                                                 (6, short_channel_id, option),
1282                                         });
1283                                         Ok(Some(Event::ProbeFailed {
1284                                                 payment_id,
1285                                                 payment_hash,
1286                                                 path: path.unwrap(),
1287                                                 short_channel_id,
1288                                         }))
1289                                 };
1290                                 f()
1291                         },
1292                         25u8 => {
1293                                 let f = || {
1294                                         let mut prev_channel_id = [0; 32];
1295                                         let mut failed_next_destination_opt = None;
1296                                         read_tlv_fields!(reader, {
1297                                                 (0, prev_channel_id, required),
1298                                                 (2, failed_next_destination_opt, ignorable),
1299                                         });
1300                                         if let Some(failed_next_destination) = failed_next_destination_opt {
1301                                                 Ok(Some(Event::HTLCHandlingFailed {
1302                                                         prev_channel_id,
1303                                                         failed_next_destination,
1304                                                 }))
1305                                         } else {
1306                                                 // If we fail to read a `failed_next_destination` assume it's because
1307                                                 // `MaybeReadable::read` returned `Ok(None)`, though it's also possible we
1308                                                 // were simply missing the field.
1309                                                 Ok(None)
1310                                         }
1311                                 };
1312                                 f()
1313                         },
1314                         27u8 => Ok(None),
1315                         29u8 => {
1316                                 let f = || {
1317                                         let mut channel_id = [0; 32];
1318                                         let mut user_channel_id: u128 = 0;
1319                                         let mut counterparty_node_id = OptionDeserWrapper(None);
1320                                         let mut channel_type = OptionDeserWrapper(None);
1321                                         read_tlv_fields!(reader, {
1322                                                 (0, channel_id, required),
1323                                                 (2, user_channel_id, required),
1324                                                 (4, counterparty_node_id, required),
1325                                                 (6, channel_type, required),
1326                                         });
1327
1328                                         Ok(Some(Event::ChannelReady {
1329                                                 channel_id,
1330                                                 user_channel_id,
1331                                                 counterparty_node_id: counterparty_node_id.0.unwrap(),
1332                                                 channel_type: channel_type.0.unwrap()
1333                                         }))
1334                                 };
1335                                 f()
1336                         },
1337                         // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
1338                         // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
1339                         // reads.
1340                         x if x % 2 == 1 => {
1341                                 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
1342                                 // which prefixes the whole thing with a length BigSize. Because the event is
1343                                 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
1344                                 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
1345                                 // exactly the number of bytes specified, ignoring them entirely.
1346                                 let tlv_len: BigSize = Readable::read(reader)?;
1347                                 FixedLengthReader::new(reader, tlv_len.0)
1348                                         .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
1349                                 Ok(None)
1350                         },
1351                         _ => Err(msgs::DecodeError::InvalidValue)
1352                 }
1353         }
1354 }
1355
1356 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
1357 /// broadcast to most peers).
1358 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
1359 #[derive(Clone, Debug)]
1360 pub enum MessageSendEvent {
1361         /// Used to indicate that we've accepted a channel open and should send the accept_channel
1362         /// message provided to the given peer.
1363         SendAcceptChannel {
1364                 /// The node_id of the node which should receive this message
1365                 node_id: PublicKey,
1366                 /// The message which should be sent.
1367                 msg: msgs::AcceptChannel,
1368         },
1369         /// Used to indicate that we've initiated a channel open and should send the open_channel
1370         /// message provided to the given peer.
1371         SendOpenChannel {
1372                 /// The node_id of the node which should receive this message
1373                 node_id: PublicKey,
1374                 /// The message which should be sent.
1375                 msg: msgs::OpenChannel,
1376         },
1377         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
1378         SendFundingCreated {
1379                 /// The node_id of the node which should receive this message
1380                 node_id: PublicKey,
1381                 /// The message which should be sent.
1382                 msg: msgs::FundingCreated,
1383         },
1384         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
1385         SendFundingSigned {
1386                 /// The node_id of the node which should receive this message
1387                 node_id: PublicKey,
1388                 /// The message which should be sent.
1389                 msg: msgs::FundingSigned,
1390         },
1391         /// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
1392         SendChannelReady {
1393                 /// The node_id of the node which should receive these message(s)
1394                 node_id: PublicKey,
1395                 /// The channel_ready message which should be sent.
1396                 msg: msgs::ChannelReady,
1397         },
1398         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
1399         SendAnnouncementSignatures {
1400                 /// The node_id of the node which should receive these message(s)
1401                 node_id: PublicKey,
1402                 /// The announcement_signatures message which should be sent.
1403                 msg: msgs::AnnouncementSignatures,
1404         },
1405         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
1406         /// message should be sent to the peer with the given node_id.
1407         UpdateHTLCs {
1408                 /// The node_id of the node which should receive these message(s)
1409                 node_id: PublicKey,
1410                 /// The update messages which should be sent. ALL messages in the struct should be sent!
1411                 updates: msgs::CommitmentUpdate,
1412         },
1413         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
1414         SendRevokeAndACK {
1415                 /// The node_id of the node which should receive this message
1416                 node_id: PublicKey,
1417                 /// The message which should be sent.
1418                 msg: msgs::RevokeAndACK,
1419         },
1420         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
1421         SendClosingSigned {
1422                 /// The node_id of the node which should receive this message
1423                 node_id: PublicKey,
1424                 /// The message which should be sent.
1425                 msg: msgs::ClosingSigned,
1426         },
1427         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
1428         SendShutdown {
1429                 /// The node_id of the node which should receive this message
1430                 node_id: PublicKey,
1431                 /// The message which should be sent.
1432                 msg: msgs::Shutdown,
1433         },
1434         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
1435         SendChannelReestablish {
1436                 /// The node_id of the node which should receive this message
1437                 node_id: PublicKey,
1438                 /// The message which should be sent.
1439                 msg: msgs::ChannelReestablish,
1440         },
1441         /// Used to send a channel_announcement and channel_update to a specific peer, likely on
1442         /// initial connection to ensure our peers know about our channels.
1443         SendChannelAnnouncement {
1444                 /// The node_id of the node which should receive this message
1445                 node_id: PublicKey,
1446                 /// The channel_announcement which should be sent.
1447                 msg: msgs::ChannelAnnouncement,
1448                 /// The followup channel_update which should be sent.
1449                 update_msg: msgs::ChannelUpdate,
1450         },
1451         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
1452         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
1453         ///
1454         /// Note that after doing so, you very likely (unless you did so very recently) want to
1455         /// broadcast a node_announcement (e.g. via [`PeerManager::broadcast_node_announcement`]). This
1456         /// ensures that any nodes which see our channel_announcement also have a relevant
1457         /// node_announcement, including relevant feature flags which may be important for routing
1458         /// through or to us.
1459         ///
1460         /// [`PeerManager::broadcast_node_announcement`]: crate::ln::peer_handler::PeerManager::broadcast_node_announcement
1461         BroadcastChannelAnnouncement {
1462                 /// The channel_announcement which should be sent.
1463                 msg: msgs::ChannelAnnouncement,
1464                 /// The followup channel_update which should be sent.
1465                 update_msg: msgs::ChannelUpdate,
1466         },
1467         /// Used to indicate that a channel_update should be broadcast to all peers.
1468         BroadcastChannelUpdate {
1469                 /// The channel_update which should be sent.
1470                 msg: msgs::ChannelUpdate,
1471         },
1472         /// Used to indicate that a channel_update should be sent to a single peer.
1473         /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
1474         /// private channel and we shouldn't be informing all of our peers of channel parameters.
1475         SendChannelUpdate {
1476                 /// The node_id of the node which should receive this message
1477                 node_id: PublicKey,
1478                 /// The channel_update which should be sent.
1479                 msg: msgs::ChannelUpdate,
1480         },
1481         /// Broadcast an error downstream to be handled
1482         HandleError {
1483                 /// The node_id of the node which should receive this message
1484                 node_id: PublicKey,
1485                 /// The action which should be taken.
1486                 action: msgs::ErrorAction
1487         },
1488         /// Query a peer for channels with funding transaction UTXOs in a block range.
1489         SendChannelRangeQuery {
1490                 /// The node_id of this message recipient
1491                 node_id: PublicKey,
1492                 /// The query_channel_range which should be sent.
1493                 msg: msgs::QueryChannelRange,
1494         },
1495         /// Request routing gossip messages from a peer for a list of channels identified by
1496         /// their short_channel_ids.
1497         SendShortIdsQuery {
1498                 /// The node_id of this message recipient
1499                 node_id: PublicKey,
1500                 /// The query_short_channel_ids which should be sent.
1501                 msg: msgs::QueryShortChannelIds,
1502         },
1503         /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1504         /// emitted during processing of the query.
1505         SendReplyChannelRange {
1506                 /// The node_id of this message recipient
1507                 node_id: PublicKey,
1508                 /// The reply_channel_range which should be sent.
1509                 msg: msgs::ReplyChannelRange,
1510         },
1511         /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1512         /// enable receiving gossip messages from the peer.
1513         SendGossipTimestampFilter {
1514                 /// The node_id of this message recipient
1515                 node_id: PublicKey,
1516                 /// The gossip_timestamp_filter which should be sent.
1517                 msg: msgs::GossipTimestampFilter,
1518         },
1519 }
1520
1521 /// A trait indicating an object may generate message send events
1522 pub trait MessageSendEventsProvider {
1523         /// Gets the list of pending events which were generated by previous actions, clearing the list
1524         /// in the process.
1525         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1526 }
1527
1528 /// A trait indicating an object may generate onion messages to send
1529 pub trait OnionMessageProvider {
1530         /// Gets the next pending onion message for the peer with the given node id.
1531         fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<msgs::OnionMessage>;
1532 }
1533
1534 /// A trait indicating an object may generate events.
1535 ///
1536 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1537 ///
1538 /// Implementations of this trait may also feature an async version of event handling, as shown with
1539 /// [`ChannelManager::process_pending_events_async`] and
1540 /// [`ChainMonitor::process_pending_events_async`].
1541 ///
1542 /// # Requirements
1543 ///
1544 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1545 /// event since the last invocation.
1546 ///
1547 /// In order to ensure no [`Event`]s are lost, implementors of this trait will persist [`Event`]s
1548 /// and replay any unhandled events on startup. An [`Event`] is considered handled when
1549 /// [`process_pending_events`] returns, thus handlers MUST fully handle [`Event`]s and persist any
1550 /// relevant changes to disk *before* returning.
1551 ///
1552 /// Further, because an application may crash between an [`Event`] being handled and the
1553 /// implementor of this trait being re-serialized, [`Event`] handling must be idempotent - in
1554 /// effect, [`Event`]s may be replayed.
1555 ///
1556 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1557 /// consult the provider's documentation on the implication of processing events and how a handler
1558 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1559 /// [`ChainMonitor::process_pending_events`]).
1560 ///
1561 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1562 /// own type(s).
1563 ///
1564 /// [`process_pending_events`]: Self::process_pending_events
1565 /// [`handle_event`]: EventHandler::handle_event
1566 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1567 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1568 /// [`ChannelManager::process_pending_events_async`]: crate::ln::channelmanager::ChannelManager::process_pending_events_async
1569 /// [`ChainMonitor::process_pending_events_async`]: crate::chain::chainmonitor::ChainMonitor::process_pending_events_async
1570 pub trait EventsProvider {
1571         /// Processes any events generated since the last call using the given event handler.
1572         ///
1573         /// See the trait-level documentation for requirements.
1574         fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1575 }
1576
1577 /// A trait implemented for objects handling events from [`EventsProvider`].
1578 ///
1579 /// An async variation also exists for implementations of [`EventsProvider`] that support async
1580 /// event handling. The async event handler should satisfy the generic bounds: `F:
1581 /// core::future::Future, H: Fn(Event) -> F`.
1582 pub trait EventHandler {
1583         /// Handles the given [`Event`].
1584         ///
1585         /// See [`EventsProvider`] for details that must be considered when implementing this method.
1586         fn handle_event(&self, event: Event);
1587 }
1588
1589 impl<F> EventHandler for F where F: Fn(Event) {
1590         fn handle_event(&self, event: Event) {
1591                 self(event)
1592         }
1593 }
1594
1595 impl<T: EventHandler> EventHandler for Arc<T> {
1596         fn handle_event(&self, event: Event) {
1597                 self.deref().handle_event(event)
1598         }
1599 }