1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Events are returned from various bits in the library which indicate some action must be taken
13 //! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
14 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
17 use chain::keysinterface::SpendableOutputDescriptor;
18 use ln::channelmanager::PaymentId;
19 use ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
20 use ln::features::ChannelTypeFeatures;
22 use ln::msgs::DecodeError;
23 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
24 use routing::gossip::NetworkUpdate;
25 use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
26 use routing::router::{RouteHop, RouteParameters};
28 use bitcoin::Transaction;
29 use bitcoin::blockdata::script::Script;
30 use bitcoin::hashes::Hash;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::secp256k1::PublicKey;
35 use core::time::Duration;
39 /// Some information provided on receipt of payment depends on whether the payment received is a
40 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
41 #[derive(Clone, Debug)]
42 pub enum PaymentPurpose {
43 /// Information for receiving a payment that we generated an invoice for.
45 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
46 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
47 /// [`ChannelManager::claim_funds`].
49 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
50 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
51 payment_preimage: Option<PaymentPreimage>,
52 /// The "payment secret". This authenticates the sender to the recipient, preventing a
53 /// number of deanonymization attacks during the routing process.
54 /// It is provided here for your reference, however its accuracy is enforced directly by
55 /// [`ChannelManager`] using the values you previously provided to
56 /// [`ChannelManager::create_inbound_payment`] or
57 /// [`ChannelManager::create_inbound_payment_for_hash`].
59 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
60 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
61 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
62 payment_secret: PaymentSecret,
64 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
65 /// (the payee) providing a preimage.
66 SpontaneousPayment(PaymentPreimage),
69 impl_writeable_tlv_based_enum!(PaymentPurpose,
70 (0, InvoicePayment) => {
71 (0, payment_preimage, option),
72 (2, payment_secret, required),
74 (2, SpontaneousPayment)
77 #[derive(Clone, Debug, PartialEq)]
78 /// The reason the channel was closed. See individual variants more details.
79 pub enum ClosureReason {
80 /// Closure generated from receiving a peer error message.
82 /// Our counterparty may have broadcasted their latest commitment state, and we have
84 CounterpartyForceClosed {
85 /// The error which the peer sent us.
87 /// The string should be sanitized before it is used (e.g emitted to logs
88 /// or printed to stdout). Otherwise, a well crafted error message may exploit
89 /// a security vulnerability in the terminal emulator or the logging subsystem.
92 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
94 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
96 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
97 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
98 //TODO: split between CounterpartyInitiated/LocallyInitiated
100 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
101 /// commitment transaction came from our counterparty, but it may also have come from
102 /// a copy of our own `ChannelMonitor`.
103 CommitmentTxConfirmed,
104 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
106 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
108 /// A developer-readable error message which we generated.
111 /// The peer disconnected prior to funding completing. In this case the spec mandates that we
112 /// forget the channel entirely - we can attempt again if the peer reconnects.
114 /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
115 /// peer because of mutual incompatibility between us and our channel counterparty.
117 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
118 /// the ChannelManager deserialized.
119 OutdatedChannelManager
122 impl core::fmt::Display for ClosureReason {
123 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
124 f.write_str("Channel closed because ")?;
126 ClosureReason::CounterpartyForceClosed { peer_msg } => {
127 f.write_str("counterparty force-closed with message ")?;
128 f.write_str(&peer_msg)
130 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
131 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
132 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
133 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
134 ClosureReason::ProcessingError { err } => {
135 f.write_str("of an exception: ")?;
138 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
139 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
144 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
145 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
146 (1, FundingTimedOut) => {},
147 (2, HolderForceClosed) => {},
148 (6, CommitmentTxConfirmed) => {},
149 (4, CooperativeClosure) => {},
150 (8, ProcessingError) => { (1, err, required) },
151 (10, DisconnectedPeer) => {},
152 (12, OutdatedChannelManager) => {},
155 /// An Event which you should probably take some action in response to.
157 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
158 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
159 /// written as it makes no sense to respond to it after reconnecting to peers).
160 #[derive(Clone, Debug)]
162 /// Used to indicate that the client should generate a funding transaction with the given
163 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
164 /// Generated in [`ChannelManager`] message handling.
165 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
166 /// counterparty can steal your funds!
168 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
169 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
170 FundingGenerationReady {
171 /// The random channel_id we picked which you'll need to pass into
172 /// [`ChannelManager::funding_transaction_generated`].
174 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
175 temporary_channel_id: [u8; 32],
176 /// The counterparty's node_id, which you'll need to pass back into
177 /// [`ChannelManager::funding_transaction_generated`].
179 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
180 counterparty_node_id: PublicKey,
181 /// The value, in satoshis, that the output should have.
182 channel_value_satoshis: u64,
183 /// The script which should be used in the transaction output.
184 output_script: Script,
185 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
186 /// an inbound channel.
188 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
189 user_channel_id: u64,
191 /// Indicates we've received (an offer of) money! Just gotta dig out that payment preimage and
192 /// feed it to [`ChannelManager::claim_funds`] to get it....
194 /// Note that if the preimage is not known, you should call
195 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
196 /// network congestion.
197 /// If you fail to call either [`ChannelManager::claim_funds`] or
198 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
199 /// automatically failed.
202 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
203 /// `PaymentReceived` events may be generated for the same payment.
205 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
206 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
208 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
209 /// not stop you from registering duplicate payment hashes for inbound payments.
210 payment_hash: PaymentHash,
211 /// The value, in thousandths of a satoshi, that this payment is for.
213 /// Information for claiming this received payment, based on whether the purpose of the
214 /// payment is to pay an invoice or to send a spontaneous payment.
215 purpose: PaymentPurpose,
217 /// Indicates a payment has been claimed and we've received money!
219 /// This most likely occurs when [`ChannelManager::claim_funds`] has been called in response
220 /// to an [`Event::PaymentReceived`]. However, if we previously crashed during a
221 /// [`ChannelManager::claim_funds`] call you may see this event without a corresponding
222 /// [`Event::PaymentReceived`] event.
225 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
226 /// `PaymentReceived` events may be generated for the same payment. If you then call
227 /// [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentReceived`] you may get
228 /// multiple `PaymentClaimed` events.
230 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
232 /// The payment hash of the claimed payment. Note that LDK will not stop you from
233 /// registering duplicate payment hashes for inbound payments.
234 payment_hash: PaymentHash,
235 /// The value, in thousandths of a satoshi, that this payment is for.
237 /// The purpose of this claimed payment, i.e. whether the payment was for an invoice or a
238 /// spontaneous payment.
239 purpose: PaymentPurpose,
241 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
242 /// and we got back the payment preimage for it).
244 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
245 /// event. In this situation, you SHOULD treat this payment as having succeeded.
247 /// The id returned by [`ChannelManager::send_payment`] and used with
248 /// [`ChannelManager::retry_payment`].
250 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
251 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
252 payment_id: Option<PaymentId>,
253 /// The preimage to the hash given to ChannelManager::send_payment.
254 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
255 /// store it somehow!
256 payment_preimage: PaymentPreimage,
257 /// The hash that was given to [`ChannelManager::send_payment`].
259 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
260 payment_hash: PaymentHash,
261 /// The total fee which was spent at intermediate hops in this payment, across all paths.
263 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
264 /// overpayment to the recipient node.
266 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
267 /// overstate the amount paid, though this is unlikely.
269 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
270 fee_paid_msat: Option<u64>,
272 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
273 /// provide failure information for each MPP part in the payment.
275 /// This event is provided once there are no further pending HTLCs for the payment and the
276 /// payment is no longer retryable, either due to a several-block timeout or because
277 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
279 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
281 /// The id returned by [`ChannelManager::send_payment`] and used with
282 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
284 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
285 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
286 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
287 payment_id: PaymentId,
288 /// The hash that was given to [`ChannelManager::send_payment`].
290 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
291 payment_hash: PaymentHash,
293 /// Indicates that a path for an outbound payment was successful.
295 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
296 /// [`Event::PaymentSent`] for obtaining the payment preimage.
297 PaymentPathSuccessful {
298 /// The id returned by [`ChannelManager::send_payment`] and used with
299 /// [`ChannelManager::retry_payment`].
301 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
302 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
303 payment_id: PaymentId,
304 /// The hash that was given to [`ChannelManager::send_payment`].
306 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
307 payment_hash: Option<PaymentHash>,
308 /// The payment path that was successful.
310 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
313 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
314 /// something. You may wish to retry with a different route.
316 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
317 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
319 /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
321 /// The id returned by [`ChannelManager::send_payment`] and used with
322 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
324 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
325 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
326 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
327 payment_id: Option<PaymentId>,
328 /// The hash that was given to [`ChannelManager::send_payment`].
330 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
331 payment_hash: PaymentHash,
332 /// Indicates the payment was rejected for some reason by the recipient. This implies that
333 /// the payment has failed, not just the route in question. If this is not set, you may
334 /// retry the payment via a different route.
335 rejected_by_dest: bool,
336 /// Any failure information conveyed via the Onion return packet by a node along the failed
339 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
340 /// account the update. [`P2PGossipSync`] is capable of doing this.
342 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
343 /// [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
344 network_update: Option<NetworkUpdate>,
345 /// For both single-path and multi-path payments, this is set if all paths of the payment have
346 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
347 /// larger MPP payment were still in flight when this event was generated.
349 /// Note that if you are retrying individual MPP parts, using this value to determine if a
350 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
351 /// being processed, you may retry in response to a first failure, with a second failure
352 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
353 /// you will see `all_paths_failed` set even though the retry of the first failure still
354 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
356 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
357 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
359 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
361 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
362 all_paths_failed: bool,
363 /// The payment path that failed.
365 /// The channel responsible for the failed payment path.
367 /// Note that for route hints or for the first hop in a path this may be an SCID alias and
368 /// may not refer to a channel in the public network graph. These aliases may also collide
369 /// with channels in the public network graph.
371 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
372 /// retried. May be `None` for older [`Event`] serializations.
373 short_channel_id: Option<u64>,
374 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
376 /// See [`find_route`] for details.
378 /// [`Route`]: crate::routing::router::Route
379 /// [`find_route`]: crate::routing::router::find_route
380 retry: Option<RouteParameters>,
382 error_code: Option<u16>,
384 error_data: Option<Vec<u8>>,
386 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
387 /// a time in the future.
389 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
390 PendingHTLCsForwardable {
391 /// The minimum amount of time that should be waited prior to calling
392 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
393 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
394 /// now + 5*time_forwardable).
395 time_forwardable: Duration,
397 /// Used to indicate that an output which you should know how to spend was confirmed on chain
398 /// and is now spendable.
399 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
400 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
401 /// somewhere and spend them when you create on-chain transactions.
403 /// The outputs which you should store as spendable by you.
404 outputs: Vec<SpendableOutputDescriptor>,
406 /// This event is generated when a payment has been successfully forwarded through us and a
407 /// forwarding fee earned.
409 /// The incoming channel between the previous node and us. This is only `None` for events
410 /// generated or serialized by versions prior to 0.0.107.
411 prev_channel_id: Option<[u8; 32]>,
412 /// The outgoing channel between the next node and us. This is only `None` for events
413 /// generated or serialized by versions prior to 0.0.107.
414 next_channel_id: Option<[u8; 32]>,
415 /// The fee, in milli-satoshis, which was earned as a result of the payment.
417 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
418 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
419 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
420 /// claimed the full value in millisatoshis from the source. In this case,
421 /// `claim_from_onchain_tx` will be set.
423 /// If the channel which sent us the payment has been force-closed, we will claim the funds
424 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
425 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
426 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
428 fee_earned_msat: Option<u64>,
429 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
431 claim_from_onchain_tx: bool,
433 /// Used to indicate that a previously opened channel with the given `channel_id` is in the
434 /// process of closure.
436 /// The channel_id of the channel which has been closed. Note that on-chain transactions
437 /// resolving the channel are likely still awaiting confirmation.
438 channel_id: [u8; 32],
439 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
440 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
441 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
442 /// `user_channel_id` will be 0 for an inbound channel.
443 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
445 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
446 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
447 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
448 user_channel_id: u64,
449 /// The reason the channel was closed.
450 reason: ClosureReason
452 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
453 /// inputs for another purpose.
455 /// The channel_id of the channel which has been closed.
456 channel_id: [u8; 32],
457 /// The full transaction received from the user
458 transaction: Transaction
460 /// Indicates a request to open a new channel by a peer.
462 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
463 /// request, call [`ChannelManager::force_close_channel`].
465 /// The event is only triggered when a new open channel request is received and the
466 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
468 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
469 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
470 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
472 /// The temporary channel ID of the channel requested to be opened.
474 /// When responding to the request, the `temporary_channel_id` should be passed
475 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
476 /// or through [`ChannelManager::force_close_channel`] to reject.
478 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
479 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
480 temporary_channel_id: [u8; 32],
481 /// The node_id of the counterparty requesting to open the channel.
483 /// When responding to the request, the `counterparty_node_id` should be passed
484 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
485 /// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
488 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
489 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
490 counterparty_node_id: PublicKey,
491 /// The channel value of the requested channel.
492 funding_satoshis: u64,
493 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
495 /// The features that this channel will operate with. If you reject the channel, a
496 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
499 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
500 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
503 /// Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
504 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
505 /// 0.0.107. Channels setting this type also need to get manually accepted via
506 /// [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`],
507 /// or will be rejected otherwise.
509 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
510 channel_type: ChannelTypeFeatures,
514 impl Writeable for Event {
515 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
517 &Event::FundingGenerationReady { .. } => {
519 // We never write out FundingGenerationReady events as, upon disconnection, peers
520 // drop any channels which have not yet exchanged funding_signed.
522 &Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose } => {
524 let mut payment_secret = None;
525 let payment_preimage;
527 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
528 payment_secret = Some(secret);
529 payment_preimage = *preimage;
531 PaymentPurpose::SpontaneousPayment(preimage) => {
532 payment_preimage = Some(*preimage);
535 write_tlv_fields!(writer, {
536 (0, payment_hash, required),
537 (2, payment_secret, option),
538 (4, amount_msat, required),
539 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
540 (8, payment_preimage, option),
543 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
545 write_tlv_fields!(writer, {
546 (0, payment_preimage, required),
547 (1, payment_hash, required),
548 (3, payment_id, option),
549 (5, fee_paid_msat, option),
552 &Event::PaymentPathFailed {
553 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
554 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
562 error_code.write(writer)?;
564 error_data.write(writer)?;
565 write_tlv_fields!(writer, {
566 (0, payment_hash, required),
567 (1, network_update, option),
568 (2, rejected_by_dest, required),
569 (3, all_paths_failed, required),
571 (7, short_channel_id, option),
573 (11, payment_id, option),
576 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
578 // Note that we now ignore these on the read end as we'll re-generate them in
579 // ChannelManager, we write them here only for backwards compatibility.
581 &Event::SpendableOutputs { ref outputs } => {
583 write_tlv_fields!(writer, {
584 (0, VecWriteWrapper(outputs), required),
587 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
589 write_tlv_fields!(writer, {
590 (0, fee_earned_msat, option),
591 (1, prev_channel_id, option),
592 (2, claim_from_onchain_tx, required),
593 (3, next_channel_id, option),
596 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
598 write_tlv_fields!(writer, {
599 (0, channel_id, required),
600 (1, user_channel_id, required),
601 (2, reason, required)
604 &Event::DiscardFunding { ref channel_id, ref transaction } => {
606 write_tlv_fields!(writer, {
607 (0, channel_id, required),
608 (2, transaction, required)
611 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
613 write_tlv_fields!(writer, {
614 (0, payment_id, required),
615 (2, payment_hash, option),
619 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
621 write_tlv_fields!(writer, {
622 (0, payment_id, required),
623 (2, payment_hash, required),
626 &Event::OpenChannelRequest { .. } => {
628 // We never write the OpenChannelRequest events as, upon disconnection, peers
629 // drop any channels which have not yet exchanged funding_signed.
631 &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose } => {
633 write_tlv_fields!(writer, {
634 (0, payment_hash, required),
635 (2, purpose, required),
636 (4, amount_msat, required),
639 // Note that, going forward, all new events must only write data inside of
640 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
641 // data via `write_tlv_fields`.
646 impl MaybeReadable for Event {
647 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
648 match Readable::read(reader)? {
649 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
650 // unlike all other events, thus we return immediately here.
654 let mut payment_hash = PaymentHash([0; 32]);
655 let mut payment_preimage = None;
656 let mut payment_secret = None;
657 let mut amount_msat = 0;
658 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
659 read_tlv_fields!(reader, {
660 (0, payment_hash, required),
661 (2, payment_secret, option),
662 (4, amount_msat, required),
663 (6, _user_payment_id, option),
664 (8, payment_preimage, option),
666 let purpose = match payment_secret {
667 Some(secret) => PaymentPurpose::InvoicePayment {
669 payment_secret: secret
671 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
672 None => return Err(msgs::DecodeError::InvalidValue),
674 Ok(Some(Event::PaymentReceived {
684 let mut payment_preimage = PaymentPreimage([0; 32]);
685 let mut payment_hash = None;
686 let mut payment_id = None;
687 let mut fee_paid_msat = None;
688 read_tlv_fields!(reader, {
689 (0, payment_preimage, required),
690 (1, payment_hash, option),
691 (3, payment_id, option),
692 (5, fee_paid_msat, option),
694 if payment_hash.is_none() {
695 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
697 Ok(Some(Event::PaymentSent {
700 payment_hash: payment_hash.unwrap(),
709 let error_code = Readable::read(reader)?;
711 let error_data = Readable::read(reader)?;
712 let mut payment_hash = PaymentHash([0; 32]);
713 let mut rejected_by_dest = false;
714 let mut network_update = None;
715 let mut all_paths_failed = Some(true);
716 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
717 let mut short_channel_id = None;
718 let mut retry = None;
719 let mut payment_id = None;
720 read_tlv_fields!(reader, {
721 (0, payment_hash, required),
722 (1, network_update, ignorable),
723 (2, rejected_by_dest, required),
724 (3, all_paths_failed, option),
726 (7, short_channel_id, option),
728 (11, payment_id, option),
730 Ok(Some(Event::PaymentPathFailed {
735 all_paths_failed: all_paths_failed.unwrap(),
750 let mut outputs = VecReadWrapper(Vec::new());
751 read_tlv_fields!(reader, {
752 (0, outputs, required),
754 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
760 let mut fee_earned_msat = None;
761 let mut prev_channel_id = None;
762 let mut claim_from_onchain_tx = false;
763 let mut next_channel_id = None;
764 read_tlv_fields!(reader, {
765 (0, fee_earned_msat, option),
766 (1, prev_channel_id, option),
767 (2, claim_from_onchain_tx, required),
768 (3, next_channel_id, option),
770 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
776 let mut channel_id = [0; 32];
777 let mut reason = None;
778 let mut user_channel_id_opt = None;
779 read_tlv_fields!(reader, {
780 (0, channel_id, required),
781 (1, user_channel_id_opt, option),
782 (2, reason, ignorable),
784 if reason.is_none() { return Ok(None); }
785 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
786 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
792 let mut channel_id = [0; 32];
793 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
794 read_tlv_fields!(reader, {
795 (0, channel_id, required),
796 (2, transaction, required),
798 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
804 let mut payment_id = PaymentId([0; 32]);
805 let mut payment_hash = None;
806 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
807 read_tlv_fields!(reader, {
808 (0, payment_id, required),
809 (2, payment_hash, option),
812 Ok(Some(Event::PaymentPathSuccessful {
822 let mut payment_hash = PaymentHash([0; 32]);
823 let mut payment_id = PaymentId([0; 32]);
824 read_tlv_fields!(reader, {
825 (0, payment_id, required),
826 (2, payment_hash, required),
828 Ok(Some(Event::PaymentFailed {
836 // Value 17 is used for `Event::OpenChannelRequest`.
841 let mut payment_hash = PaymentHash([0; 32]);
842 let mut purpose = None;
843 let mut amount_msat = 0;
844 read_tlv_fields!(reader, {
845 (0, payment_hash, required),
846 (2, purpose, ignorable),
847 (4, amount_msat, required),
849 if purpose.is_none() { return Ok(None); }
850 Ok(Some(Event::PaymentClaimed {
852 purpose: purpose.unwrap(),
858 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
859 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
862 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
863 // which prefixes the whole thing with a length BigSize. Because the event is
864 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
865 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
866 // exactly the number of bytes specified, ignoring them entirely.
867 let tlv_len: BigSize = Readable::read(reader)?;
868 FixedLengthReader::new(reader, tlv_len.0)
869 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
872 _ => Err(msgs::DecodeError::InvalidValue)
877 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
878 /// broadcast to most peers).
879 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
880 #[derive(Clone, Debug)]
881 pub enum MessageSendEvent {
882 /// Used to indicate that we've accepted a channel open and should send the accept_channel
883 /// message provided to the given peer.
885 /// The node_id of the node which should receive this message
887 /// The message which should be sent.
888 msg: msgs::AcceptChannel,
890 /// Used to indicate that we've initiated a channel open and should send the open_channel
891 /// message provided to the given peer.
893 /// The node_id of the node which should receive this message
895 /// The message which should be sent.
896 msg: msgs::OpenChannel,
898 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
900 /// The node_id of the node which should receive this message
902 /// The message which should be sent.
903 msg: msgs::FundingCreated,
905 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
907 /// The node_id of the node which should receive this message
909 /// The message which should be sent.
910 msg: msgs::FundingSigned,
912 /// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
914 /// The node_id of the node which should receive these message(s)
916 /// The channel_ready message which should be sent.
917 msg: msgs::ChannelReady,
919 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
920 SendAnnouncementSignatures {
921 /// The node_id of the node which should receive these message(s)
923 /// The announcement_signatures message which should be sent.
924 msg: msgs::AnnouncementSignatures,
926 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
927 /// message should be sent to the peer with the given node_id.
929 /// The node_id of the node which should receive these message(s)
931 /// The update messages which should be sent. ALL messages in the struct should be sent!
932 updates: msgs::CommitmentUpdate,
934 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
936 /// The node_id of the node which should receive this message
938 /// The message which should be sent.
939 msg: msgs::RevokeAndACK,
941 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
943 /// The node_id of the node which should receive this message
945 /// The message which should be sent.
946 msg: msgs::ClosingSigned,
948 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
950 /// The node_id of the node which should receive this message
952 /// The message which should be sent.
955 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
956 SendChannelReestablish {
957 /// The node_id of the node which should receive this message
959 /// The message which should be sent.
960 msg: msgs::ChannelReestablish,
962 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
963 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
965 /// Note that after doing so, you very likely (unless you did so very recently) want to call
966 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
967 /// This ensures that any nodes which see our channel_announcement also have a relevant
968 /// node_announcement, including relevant feature flags which may be important for routing
969 /// through or to us.
970 BroadcastChannelAnnouncement {
971 /// The channel_announcement which should be sent.
972 msg: msgs::ChannelAnnouncement,
973 /// The followup channel_update which should be sent.
974 update_msg: msgs::ChannelUpdate,
976 /// Used to indicate that a node_announcement should be broadcast to all peers.
977 BroadcastNodeAnnouncement {
978 /// The node_announcement which should be sent.
979 msg: msgs::NodeAnnouncement,
981 /// Used to indicate that a channel_update should be broadcast to all peers.
982 BroadcastChannelUpdate {
983 /// The channel_update which should be sent.
984 msg: msgs::ChannelUpdate,
986 /// Used to indicate that a channel_update should be sent to a single peer.
987 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
988 /// private channel and we shouldn't be informing all of our peers of channel parameters.
990 /// The node_id of the node which should receive this message
992 /// The channel_update which should be sent.
993 msg: msgs::ChannelUpdate,
995 /// Broadcast an error downstream to be handled
997 /// The node_id of the node which should receive this message
999 /// The action which should be taken.
1000 action: msgs::ErrorAction
1002 /// Query a peer for channels with funding transaction UTXOs in a block range.
1003 SendChannelRangeQuery {
1004 /// The node_id of this message recipient
1006 /// The query_channel_range which should be sent.
1007 msg: msgs::QueryChannelRange,
1009 /// Request routing gossip messages from a peer for a list of channels identified by
1010 /// their short_channel_ids.
1012 /// The node_id of this message recipient
1014 /// The query_short_channel_ids which should be sent.
1015 msg: msgs::QueryShortChannelIds,
1017 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1018 /// emitted during processing of the query.
1019 SendReplyChannelRange {
1020 /// The node_id of this message recipient
1022 /// The reply_channel_range which should be sent.
1023 msg: msgs::ReplyChannelRange,
1025 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1026 /// enable receiving gossip messages from the peer.
1027 SendGossipTimestampFilter {
1028 /// The node_id of this message recipient
1030 /// The gossip_timestamp_filter which should be sent.
1031 msg: msgs::GossipTimestampFilter,
1035 /// A trait indicating an object may generate message send events
1036 pub trait MessageSendEventsProvider {
1037 /// Gets the list of pending events which were generated by previous actions, clearing the list
1039 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1042 /// A trait indicating an object may generate events.
1044 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1048 /// See [`process_pending_events`] for requirements around event processing.
1050 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1051 /// event since the last invocation. The handler must either act upon the event immediately
1052 /// or preserve it for later handling.
1054 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1055 /// consult the provider's documentation on the implication of processing events and how a handler
1056 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1057 /// [`ChainMonitor::process_pending_events`]).
1059 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1062 /// [`process_pending_events`]: Self::process_pending_events
1063 /// [`handle_event`]: EventHandler::handle_event
1064 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1065 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1066 pub trait EventsProvider {
1067 /// Processes any events generated since the last call using the given event handler.
1069 /// Subsequent calls must only process new events. However, handlers must be capable of handling
1070 /// duplicate events across process restarts. This may occur if the provider was recovered from
1071 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
1072 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1075 /// A trait implemented for objects handling events from [`EventsProvider`].
1076 pub trait EventHandler {
1077 /// Handles the given [`Event`].
1079 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1080 fn handle_event(&self, event: &Event);
1083 impl<F> EventHandler for F where F: Fn(&Event) {
1084 fn handle_event(&self, event: &Event) {
1089 impl<T: EventHandler> EventHandler for Arc<T> {
1090 fn handle_event(&self, event: &Event) {
1091 self.deref().handle_event(event)