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