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::network_graph::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. [`NetGraphMsgHandler`] is capable of doing this.
342 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
343 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
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 channel with the given `channel_id` is in the process of closure.
435 /// The channel_id of the channel which has been closed. Note that on-chain transactions
436 /// resolving the channel are likely still awaiting confirmation.
437 channel_id: [u8; 32],
438 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
439 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
440 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
441 /// `user_channel_id` will be 0 for an inbound channel.
442 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
444 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
445 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
446 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
447 user_channel_id: u64,
448 /// The reason the channel was closed.
449 reason: ClosureReason
451 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
452 /// inputs for another purpose.
454 /// The channel_id of the channel which has been closed.
455 channel_id: [u8; 32],
456 /// The full transaction received from the user
457 transaction: Transaction
459 /// Indicates a request to open a new channel by a peer.
461 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
462 /// request, call [`ChannelManager::force_close_channel`].
464 /// The event is only triggered when a new open channel request is received and the
465 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
467 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
468 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
469 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
471 /// The temporary channel ID of the channel requested to be opened.
473 /// When responding to the request, the `temporary_channel_id` should be passed
474 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
475 /// or through [`ChannelManager::force_close_channel`] to reject.
477 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
478 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
479 temporary_channel_id: [u8; 32],
480 /// The node_id of the counterparty requesting to open the channel.
482 /// When responding to the request, the `counterparty_node_id` should be passed
483 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
484 /// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
487 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
488 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
489 counterparty_node_id: PublicKey,
490 /// The channel value of the requested channel.
491 funding_satoshis: u64,
492 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
494 /// The features that this channel will operate with. If you reject the channel, a
495 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
498 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
499 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
502 /// Also note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
503 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
506 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
507 channel_type: ChannelTypeFeatures,
511 impl Writeable for Event {
512 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
514 &Event::FundingGenerationReady { .. } => {
516 // We never write out FundingGenerationReady events as, upon disconnection, peers
517 // drop any channels which have not yet exchanged funding_signed.
519 &Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose } => {
521 let mut payment_secret = None;
522 let payment_preimage;
524 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
525 payment_secret = Some(secret);
526 payment_preimage = *preimage;
528 PaymentPurpose::SpontaneousPayment(preimage) => {
529 payment_preimage = Some(*preimage);
532 write_tlv_fields!(writer, {
533 (0, payment_hash, required),
534 (2, payment_secret, option),
535 (4, amount_msat, required),
536 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
537 (8, payment_preimage, option),
540 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
542 write_tlv_fields!(writer, {
543 (0, payment_preimage, required),
544 (1, payment_hash, required),
545 (3, payment_id, option),
546 (5, fee_paid_msat, option),
549 &Event::PaymentPathFailed {
550 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
551 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
559 error_code.write(writer)?;
561 error_data.write(writer)?;
562 write_tlv_fields!(writer, {
563 (0, payment_hash, required),
564 (1, network_update, option),
565 (2, rejected_by_dest, required),
566 (3, all_paths_failed, required),
568 (7, short_channel_id, option),
570 (11, payment_id, option),
573 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
575 // Note that we now ignore these on the read end as we'll re-generate them in
576 // ChannelManager, we write them here only for backwards compatibility.
578 &Event::SpendableOutputs { ref outputs } => {
580 write_tlv_fields!(writer, {
581 (0, VecWriteWrapper(outputs), required),
584 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
586 write_tlv_fields!(writer, {
587 (0, fee_earned_msat, option),
588 (1, prev_channel_id, option),
589 (2, claim_from_onchain_tx, required),
590 (3, next_channel_id, option),
593 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
595 write_tlv_fields!(writer, {
596 (0, channel_id, required),
597 (1, user_channel_id, required),
598 (2, reason, required)
601 &Event::DiscardFunding { ref channel_id, ref transaction } => {
603 write_tlv_fields!(writer, {
604 (0, channel_id, required),
605 (2, transaction, required)
608 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
610 write_tlv_fields!(writer, {
611 (0, payment_id, required),
612 (2, payment_hash, option),
616 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
618 write_tlv_fields!(writer, {
619 (0, payment_id, required),
620 (2, payment_hash, required),
623 &Event::OpenChannelRequest { .. } => {
625 // We never write the OpenChannelRequest events as, upon disconnection, peers
626 // drop any channels which have not yet exchanged funding_signed.
628 &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose } => {
630 write_tlv_fields!(writer, {
631 (0, payment_hash, required),
632 (2, purpose, required),
633 (4, amount_msat, required),
636 // Note that, going forward, all new events must only write data inside of
637 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
638 // data via `write_tlv_fields`.
643 impl MaybeReadable for Event {
644 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
645 match Readable::read(reader)? {
646 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
647 // unlike all other events, thus we return immediately here.
651 let mut payment_hash = PaymentHash([0; 32]);
652 let mut payment_preimage = None;
653 let mut payment_secret = None;
654 let mut amount_msat = 0;
655 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
656 read_tlv_fields!(reader, {
657 (0, payment_hash, required),
658 (2, payment_secret, option),
659 (4, amount_msat, required),
660 (6, _user_payment_id, option),
661 (8, payment_preimage, option),
663 let purpose = match payment_secret {
664 Some(secret) => PaymentPurpose::InvoicePayment {
666 payment_secret: secret
668 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
669 None => return Err(msgs::DecodeError::InvalidValue),
671 Ok(Some(Event::PaymentReceived {
681 let mut payment_preimage = PaymentPreimage([0; 32]);
682 let mut payment_hash = None;
683 let mut payment_id = None;
684 let mut fee_paid_msat = None;
685 read_tlv_fields!(reader, {
686 (0, payment_preimage, required),
687 (1, payment_hash, option),
688 (3, payment_id, option),
689 (5, fee_paid_msat, option),
691 if payment_hash.is_none() {
692 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
694 Ok(Some(Event::PaymentSent {
697 payment_hash: payment_hash.unwrap(),
706 let error_code = Readable::read(reader)?;
708 let error_data = Readable::read(reader)?;
709 let mut payment_hash = PaymentHash([0; 32]);
710 let mut rejected_by_dest = false;
711 let mut network_update = None;
712 let mut all_paths_failed = Some(true);
713 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
714 let mut short_channel_id = None;
715 let mut retry = None;
716 let mut payment_id = None;
717 read_tlv_fields!(reader, {
718 (0, payment_hash, required),
719 (1, network_update, ignorable),
720 (2, rejected_by_dest, required),
721 (3, all_paths_failed, option),
723 (7, short_channel_id, option),
725 (11, payment_id, option),
727 Ok(Some(Event::PaymentPathFailed {
732 all_paths_failed: all_paths_failed.unwrap(),
747 let mut outputs = VecReadWrapper(Vec::new());
748 read_tlv_fields!(reader, {
749 (0, outputs, required),
751 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
757 let mut fee_earned_msat = None;
758 let mut prev_channel_id = None;
759 let mut claim_from_onchain_tx = false;
760 let mut next_channel_id = None;
761 read_tlv_fields!(reader, {
762 (0, fee_earned_msat, option),
763 (1, prev_channel_id, option),
764 (2, claim_from_onchain_tx, required),
765 (3, next_channel_id, option),
767 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
773 let mut channel_id = [0; 32];
774 let mut reason = None;
775 let mut user_channel_id_opt = None;
776 read_tlv_fields!(reader, {
777 (0, channel_id, required),
778 (1, user_channel_id_opt, option),
779 (2, reason, ignorable),
781 if reason.is_none() { return Ok(None); }
782 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
783 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
789 let mut channel_id = [0; 32];
790 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
791 read_tlv_fields!(reader, {
792 (0, channel_id, required),
793 (2, transaction, required),
795 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
801 let mut payment_id = PaymentId([0; 32]);
802 let mut payment_hash = None;
803 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
804 read_tlv_fields!(reader, {
805 (0, payment_id, required),
806 (2, payment_hash, option),
809 Ok(Some(Event::PaymentPathSuccessful {
819 let mut payment_hash = PaymentHash([0; 32]);
820 let mut payment_id = PaymentId([0; 32]);
821 read_tlv_fields!(reader, {
822 (0, payment_id, required),
823 (2, payment_hash, required),
825 Ok(Some(Event::PaymentFailed {
833 // Value 17 is used for `Event::OpenChannelRequest`.
838 let mut payment_hash = PaymentHash([0; 32]);
839 let mut purpose = None;
840 let mut amount_msat = 0;
841 read_tlv_fields!(reader, {
842 (0, payment_hash, required),
843 (2, purpose, ignorable),
844 (4, amount_msat, required),
846 if purpose.is_none() { return Ok(None); }
847 Ok(Some(Event::PaymentClaimed {
849 purpose: purpose.unwrap(),
855 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
856 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
859 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
860 // which prefixes the whole thing with a length BigSize. Because the event is
861 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
862 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
863 // exactly the number of bytes specified, ignoring them entirely.
864 let tlv_len: BigSize = Readable::read(reader)?;
865 FixedLengthReader::new(reader, tlv_len.0)
866 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
869 _ => Err(msgs::DecodeError::InvalidValue)
874 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
875 /// broadcast to most peers).
876 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
877 #[derive(Clone, Debug)]
878 pub enum MessageSendEvent {
879 /// Used to indicate that we've accepted a channel open and should send the accept_channel
880 /// message provided to the given peer.
882 /// The node_id of the node which should receive this message
884 /// The message which should be sent.
885 msg: msgs::AcceptChannel,
887 /// Used to indicate that we've initiated a channel open and should send the open_channel
888 /// message provided to the given peer.
890 /// The node_id of the node which should receive this message
892 /// The message which should be sent.
893 msg: msgs::OpenChannel,
895 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
897 /// The node_id of the node which should receive this message
899 /// The message which should be sent.
900 msg: msgs::FundingCreated,
902 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
904 /// The node_id of the node which should receive this message
906 /// The message which should be sent.
907 msg: msgs::FundingSigned,
909 /// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
911 /// The node_id of the node which should receive these message(s)
913 /// The channel_ready message which should be sent.
914 msg: msgs::ChannelReady,
916 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
917 SendAnnouncementSignatures {
918 /// The node_id of the node which should receive these message(s)
920 /// The announcement_signatures message which should be sent.
921 msg: msgs::AnnouncementSignatures,
923 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
924 /// message should be sent to the peer with the given node_id.
926 /// The node_id of the node which should receive these message(s)
928 /// The update messages which should be sent. ALL messages in the struct should be sent!
929 updates: msgs::CommitmentUpdate,
931 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
933 /// The node_id of the node which should receive this message
935 /// The message which should be sent.
936 msg: msgs::RevokeAndACK,
938 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
940 /// The node_id of the node which should receive this message
942 /// The message which should be sent.
943 msg: msgs::ClosingSigned,
945 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
947 /// The node_id of the node which should receive this message
949 /// The message which should be sent.
952 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
953 SendChannelReestablish {
954 /// The node_id of the node which should receive this message
956 /// The message which should be sent.
957 msg: msgs::ChannelReestablish,
959 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
960 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
962 /// Note that after doing so, you very likely (unless you did so very recently) want to call
963 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
964 /// This ensures that any nodes which see our channel_announcement also have a relevant
965 /// node_announcement, including relevant feature flags which may be important for routing
966 /// through or to us.
967 BroadcastChannelAnnouncement {
968 /// The channel_announcement which should be sent.
969 msg: msgs::ChannelAnnouncement,
970 /// The followup channel_update which should be sent.
971 update_msg: msgs::ChannelUpdate,
973 /// Used to indicate that a node_announcement should be broadcast to all peers.
974 BroadcastNodeAnnouncement {
975 /// The node_announcement which should be sent.
976 msg: msgs::NodeAnnouncement,
978 /// Used to indicate that a channel_update should be broadcast to all peers.
979 BroadcastChannelUpdate {
980 /// The channel_update which should be sent.
981 msg: msgs::ChannelUpdate,
983 /// Used to indicate that a channel_update should be sent to a single peer.
984 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
985 /// private channel and we shouldn't be informing all of our peers of channel parameters.
987 /// The node_id of the node which should receive this message
989 /// The channel_update which should be sent.
990 msg: msgs::ChannelUpdate,
992 /// Broadcast an error downstream to be handled
994 /// The node_id of the node which should receive this message
996 /// The action which should be taken.
997 action: msgs::ErrorAction
999 /// Query a peer for channels with funding transaction UTXOs in a block range.
1000 SendChannelRangeQuery {
1001 /// The node_id of this message recipient
1003 /// The query_channel_range which should be sent.
1004 msg: msgs::QueryChannelRange,
1006 /// Request routing gossip messages from a peer for a list of channels identified by
1007 /// their short_channel_ids.
1009 /// The node_id of this message recipient
1011 /// The query_short_channel_ids which should be sent.
1012 msg: msgs::QueryShortChannelIds,
1014 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1015 /// emitted during processing of the query.
1016 SendReplyChannelRange {
1017 /// The node_id of this message recipient
1019 /// The reply_channel_range which should be sent.
1020 msg: msgs::ReplyChannelRange,
1022 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1023 /// enable receiving gossip messages from the peer.
1024 SendGossipTimestampFilter {
1025 /// The node_id of this message recipient
1027 /// The gossip_timestamp_filter which should be sent.
1028 msg: msgs::GossipTimestampFilter,
1032 /// A trait indicating an object may generate message send events
1033 pub trait MessageSendEventsProvider {
1034 /// Gets the list of pending events which were generated by previous actions, clearing the list
1036 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1039 /// A trait indicating an object may generate events.
1041 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1045 /// See [`process_pending_events`] for requirements around event processing.
1047 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1048 /// event since the last invocation. The handler must either act upon the event immediately
1049 /// or preserve it for later handling.
1051 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1052 /// consult the provider's documentation on the implication of processing events and how a handler
1053 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1054 /// [`ChainMonitor::process_pending_events`]).
1056 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1059 /// [`process_pending_events`]: Self::process_pending_events
1060 /// [`handle_event`]: EventHandler::handle_event
1061 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1062 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1063 pub trait EventsProvider {
1064 /// Processes any events generated since the last call using the given event handler.
1066 /// Subsequent calls must only process new events. However, handlers must be capable of handling
1067 /// duplicate events across process restarts. This may occur if the provider was recovered from
1068 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
1069 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1072 /// A trait implemented for objects handling events from [`EventsProvider`].
1073 pub trait EventHandler {
1074 /// Handles the given [`Event`].
1076 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1077 fn handle_event(&self, event: &Event);
1080 impl<F> EventHandler for F where F: Fn(&Event) {
1081 fn handle_event(&self, event: &Event) {
1086 impl<T: EventHandler> EventHandler for Arc<T> {
1087 fn handle_event(&self, event: &Event) {
1088 self.deref().handle_event(event)