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 #[derive(Clone, Debug, PartialEq)]
70 /// The reason the channel was closed. See individual variants more details.
71 pub enum ClosureReason {
72 /// Closure generated from receiving a peer error message.
74 /// Our counterparty may have broadcasted their latest commitment state, and we have
76 CounterpartyForceClosed {
77 /// The error which the peer sent us.
79 /// The string should be sanitized before it is used (e.g emitted to logs
80 /// or printed to stdout). Otherwise, a well crafted error message may exploit
81 /// a security vulnerability in the terminal emulator or the logging subsystem.
84 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
86 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
88 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
89 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
90 //TODO: split between CounterpartyInitiated/LocallyInitiated
92 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
93 /// commitment transaction came from our counterparty, but it may also have come from
94 /// a copy of our own `ChannelMonitor`.
95 CommitmentTxConfirmed,
96 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
98 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
100 /// A developer-readable error message which we generated.
103 /// The peer disconnected prior to funding completing. In this case the spec mandates that we
104 /// forget the channel entirely - we can attempt again if the peer reconnects.
106 /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
107 /// peer because of mutual incompatibility between us and our channel counterparty.
109 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
110 /// the ChannelManager deserialized.
111 OutdatedChannelManager
114 impl core::fmt::Display for ClosureReason {
115 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
116 f.write_str("Channel closed because ")?;
118 ClosureReason::CounterpartyForceClosed { peer_msg } => {
119 f.write_str("counterparty force-closed with message ")?;
120 f.write_str(&peer_msg)
122 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
123 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
124 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
125 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
126 ClosureReason::ProcessingError { err } => {
127 f.write_str("of an exception: ")?;
130 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
131 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
136 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
137 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
138 (1, FundingTimedOut) => {},
139 (2, HolderForceClosed) => {},
140 (6, CommitmentTxConfirmed) => {},
141 (4, CooperativeClosure) => {},
142 (8, ProcessingError) => { (1, err, required) },
143 (10, DisconnectedPeer) => {},
144 (12, OutdatedChannelManager) => {},
147 /// An Event which you should probably take some action in response to.
149 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
150 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
151 /// written as it makes no sense to respond to it after reconnecting to peers).
152 #[derive(Clone, Debug)]
154 /// Used to indicate that the client should generate a funding transaction with the given
155 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
156 /// Generated in [`ChannelManager`] message handling.
157 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
158 /// counterparty can steal your funds!
160 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
161 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
162 FundingGenerationReady {
163 /// The random channel_id we picked which you'll need to pass into
164 /// ChannelManager::funding_transaction_generated.
165 temporary_channel_id: [u8; 32],
166 /// The value, in satoshis, that the output should have.
167 channel_value_satoshis: u64,
168 /// The script which should be used in the transaction output.
169 output_script: Script,
170 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
171 /// an inbound channel.
173 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
174 user_channel_id: u64,
176 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
177 /// [`ChannelManager::claim_funds`] to get it....
178 /// Note that if the preimage is not known, you should call
179 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
180 /// network congestion.
181 /// If you fail to call either [`ChannelManager::claim_funds`] or
182 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
183 /// automatically failed.
186 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
187 /// `PaymentReceived` events may be generated for the same payment.
189 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
190 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
192 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
193 /// not stop you from registering duplicate payment hashes for inbound payments.
194 payment_hash: PaymentHash,
195 /// The value, in thousandths of a satoshi, that this payment is for.
197 /// Information for claiming this received payment, based on whether the purpose of the
198 /// payment is to pay an invoice or to send a spontaneous payment.
199 purpose: PaymentPurpose,
201 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
202 /// and we got back the payment preimage for it).
204 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
205 /// event. In this situation, you SHOULD treat this payment as having succeeded.
207 /// The id returned by [`ChannelManager::send_payment`] and used with
208 /// [`ChannelManager::retry_payment`].
210 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
211 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
212 payment_id: Option<PaymentId>,
213 /// The preimage to the hash given to ChannelManager::send_payment.
214 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
215 /// store it somehow!
216 payment_preimage: PaymentPreimage,
217 /// The hash that was given to [`ChannelManager::send_payment`].
219 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
220 payment_hash: PaymentHash,
221 /// The total fee which was spent at intermediate hops in this payment, across all paths.
223 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
224 /// overpayment to the recipient node.
226 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
227 /// overstate the amount paid, though this is unlikely.
229 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
230 fee_paid_msat: Option<u64>,
232 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
233 /// provide failure information for each MPP part in the payment.
235 /// This event is provided once there are no further pending HTLCs for the payment and the
236 /// payment is no longer retryable, either due to a several-block timeout or because
237 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
239 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
241 /// The id returned by [`ChannelManager::send_payment`] and used with
242 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
244 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
245 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
246 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
247 payment_id: PaymentId,
248 /// The hash that was given to [`ChannelManager::send_payment`].
250 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
251 payment_hash: PaymentHash,
253 /// Indicates that a path for an outbound payment was successful.
255 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
256 /// [`Event::PaymentSent`] for obtaining the payment preimage.
257 PaymentPathSuccessful {
258 /// The id returned by [`ChannelManager::send_payment`] and used with
259 /// [`ChannelManager::retry_payment`].
261 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
262 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
263 payment_id: PaymentId,
264 /// The hash that was given to [`ChannelManager::send_payment`].
266 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
267 payment_hash: Option<PaymentHash>,
268 /// The payment path that was successful.
270 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
273 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
274 /// something. You may wish to retry with a different route.
276 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
277 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
279 /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
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: Option<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,
292 /// Indicates the payment was rejected for some reason by the recipient. This implies that
293 /// the payment has failed, not just the route in question. If this is not set, you may
294 /// retry the payment via a different route.
295 rejected_by_dest: bool,
296 /// Any failure information conveyed via the Onion return packet by a node along the failed
299 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
300 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
302 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
303 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
304 network_update: Option<NetworkUpdate>,
305 /// For both single-path and multi-path payments, this is set if all paths of the payment have
306 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
307 /// larger MPP payment were still in flight when this event was generated.
309 /// Note that if you are retrying individual MPP parts, using this value to determine if a
310 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
311 /// being processed, you may retry in response to a first failure, with a second failure
312 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
313 /// you will see `all_paths_failed` set even though the retry of the first failure still
314 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
316 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
317 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
319 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
321 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
322 all_paths_failed: bool,
323 /// The payment path that failed.
325 /// The channel responsible for the failed payment path.
327 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
328 /// retried. May be `None` for older [`Event`] serializations.
329 short_channel_id: Option<u64>,
330 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
332 /// See [`find_route`] for details.
334 /// [`Route`]: crate::routing::router::Route
335 /// [`find_route`]: crate::routing::router::find_route
336 retry: Option<RouteParameters>,
338 error_code: Option<u16>,
340 error_data: Option<Vec<u8>>,
342 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
343 /// a time in the future.
345 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
346 PendingHTLCsForwardable {
347 /// The minimum amount of time that should be waited prior to calling
348 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
349 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
350 /// now + 5*time_forwardable).
351 time_forwardable: Duration,
353 /// Used to indicate that an output which you should know how to spend was confirmed on chain
354 /// and is now spendable.
355 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
356 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
357 /// somewhere and spend them when you create on-chain transactions.
359 /// The outputs which you should store as spendable by you.
360 outputs: Vec<SpendableOutputDescriptor>,
362 /// This event is generated when a payment has been successfully forwarded through us and a
363 /// forwarding fee earned.
365 /// The incoming channel between the previous node and us. This is only `None` for events
366 /// generated or serialized by versions prior to 0.0.107.
367 prev_channel_id: Option<[u8; 32]>,
368 /// The outgoing channel between the next node and us. This is only `None` for events
369 /// generated or serialized by versions prior to 0.0.107.
370 next_channel_id: Option<[u8; 32]>,
371 /// The fee, in milli-satoshis, which was earned as a result of the payment.
373 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
374 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
375 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
376 /// claimed the full value in millisatoshis from the source. In this case,
377 /// `claim_from_onchain_tx` will be set.
379 /// If the channel which sent us the payment has been force-closed, we will claim the funds
380 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
381 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
382 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
384 fee_earned_msat: Option<u64>,
385 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
387 claim_from_onchain_tx: bool,
389 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
391 /// The channel_id of the channel which has been closed. Note that on-chain transactions
392 /// resolving the channel are likely still awaiting confirmation.
393 channel_id: [u8; 32],
394 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
395 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
396 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
397 /// `user_channel_id` will be 0 for an inbound channel.
398 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
400 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
401 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
402 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
403 user_channel_id: u64,
404 /// The reason the channel was closed.
405 reason: ClosureReason
407 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
408 /// inputs for another purpose.
410 /// The channel_id of the channel which has been closed.
411 channel_id: [u8; 32],
412 /// The full transaction received from the user
413 transaction: Transaction
415 /// Indicates a request to open a new channel by a peer.
417 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
418 /// request, call [`ChannelManager::force_close_channel`].
420 /// The event is only triggered when a new open channel request is received and the
421 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
423 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
424 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
425 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
427 /// The temporary channel ID of the channel requested to be opened.
429 /// When responding to the request, the `temporary_channel_id` should be passed
430 /// back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
431 /// or to [`ChannelManager::force_close_channel`] to reject.
433 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
434 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
435 temporary_channel_id: [u8; 32],
436 /// The node_id of the counterparty requesting to open the channel.
437 counterparty_node_id: PublicKey,
438 /// The channel value of the requested channel.
439 funding_satoshis: u64,
440 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
442 /// The features that this channel will operate with. If you reject the channel, a
443 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
446 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
447 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
450 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
451 channel_type: ChannelTypeFeatures,
455 impl Writeable for Event {
456 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
458 &Event::FundingGenerationReady { .. } => {
460 // We never write out FundingGenerationReady events as, upon disconnection, peers
461 // drop any channels which have not yet exchanged funding_signed.
463 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
465 let mut payment_secret = None;
466 let payment_preimage;
468 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
469 payment_secret = Some(secret);
470 payment_preimage = *preimage;
472 PaymentPurpose::SpontaneousPayment(preimage) => {
473 payment_preimage = Some(*preimage);
476 write_tlv_fields!(writer, {
477 (0, payment_hash, required),
478 (2, payment_secret, option),
480 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
481 (8, payment_preimage, option),
484 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
486 write_tlv_fields!(writer, {
487 (0, payment_preimage, required),
488 (1, payment_hash, required),
489 (3, payment_id, option),
490 (5, fee_paid_msat, option),
493 &Event::PaymentPathFailed {
494 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
495 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
503 error_code.write(writer)?;
505 error_data.write(writer)?;
506 write_tlv_fields!(writer, {
507 (0, payment_hash, required),
508 (1, network_update, option),
509 (2, rejected_by_dest, required),
510 (3, all_paths_failed, required),
512 (7, short_channel_id, option),
514 (11, payment_id, option),
517 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
519 // Note that we now ignore these on the read end as we'll re-generate them in
520 // ChannelManager, we write them here only for backwards compatibility.
522 &Event::SpendableOutputs { ref outputs } => {
524 write_tlv_fields!(writer, {
525 (0, VecWriteWrapper(outputs), required),
528 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
530 write_tlv_fields!(writer, {
531 (0, fee_earned_msat, option),
532 (1, prev_channel_id, option),
533 (2, claim_from_onchain_tx, required),
534 (3, next_channel_id, option),
537 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
539 write_tlv_fields!(writer, {
540 (0, channel_id, required),
541 (1, user_channel_id, required),
542 (2, reason, required)
545 &Event::DiscardFunding { ref channel_id, ref transaction } => {
547 write_tlv_fields!(writer, {
548 (0, channel_id, required),
549 (2, transaction, required)
552 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
554 write_tlv_fields!(writer, {
555 (0, payment_id, required),
556 (2, payment_hash, option),
560 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
562 write_tlv_fields!(writer, {
563 (0, payment_id, required),
564 (2, payment_hash, required),
567 &Event::OpenChannelRequest { .. } => {
569 // We never write the OpenChannelRequest events as, upon disconnection, peers
570 // drop any channels which have not yet exchanged funding_signed.
572 // Note that, going forward, all new events must only write data inside of
573 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
574 // data via `write_tlv_fields`.
579 impl MaybeReadable for Event {
580 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
581 match Readable::read(reader)? {
582 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
583 // unlike all other events, thus we return immediately here.
587 let mut payment_hash = PaymentHash([0; 32]);
588 let mut payment_preimage = None;
589 let mut payment_secret = None;
591 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
592 read_tlv_fields!(reader, {
593 (0, payment_hash, required),
594 (2, payment_secret, option),
596 (6, _user_payment_id, option),
597 (8, payment_preimage, option),
599 let purpose = match payment_secret {
600 Some(secret) => PaymentPurpose::InvoicePayment {
602 payment_secret: secret
604 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
605 None => return Err(msgs::DecodeError::InvalidValue),
607 Ok(Some(Event::PaymentReceived {
617 let mut payment_preimage = PaymentPreimage([0; 32]);
618 let mut payment_hash = None;
619 let mut payment_id = None;
620 let mut fee_paid_msat = None;
621 read_tlv_fields!(reader, {
622 (0, payment_preimage, required),
623 (1, payment_hash, option),
624 (3, payment_id, option),
625 (5, fee_paid_msat, option),
627 if payment_hash.is_none() {
628 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
630 Ok(Some(Event::PaymentSent {
633 payment_hash: payment_hash.unwrap(),
642 let error_code = Readable::read(reader)?;
644 let error_data = Readable::read(reader)?;
645 let mut payment_hash = PaymentHash([0; 32]);
646 let mut rejected_by_dest = false;
647 let mut network_update = None;
648 let mut all_paths_failed = Some(true);
649 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
650 let mut short_channel_id = None;
651 let mut retry = None;
652 let mut payment_id = None;
653 read_tlv_fields!(reader, {
654 (0, payment_hash, required),
655 (1, network_update, ignorable),
656 (2, rejected_by_dest, required),
657 (3, all_paths_failed, option),
659 (7, short_channel_id, option),
661 (11, payment_id, option),
663 Ok(Some(Event::PaymentPathFailed {
668 all_paths_failed: all_paths_failed.unwrap(),
683 let mut outputs = VecReadWrapper(Vec::new());
684 read_tlv_fields!(reader, {
685 (0, outputs, required),
687 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
693 let mut fee_earned_msat = None;
694 let mut prev_channel_id = None;
695 let mut claim_from_onchain_tx = false;
696 let mut next_channel_id = None;
697 read_tlv_fields!(reader, {
698 (0, fee_earned_msat, option),
699 (1, prev_channel_id, option),
700 (2, claim_from_onchain_tx, required),
701 (3, next_channel_id, option),
703 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
709 let mut channel_id = [0; 32];
710 let mut reason = None;
711 let mut user_channel_id_opt = None;
712 read_tlv_fields!(reader, {
713 (0, channel_id, required),
714 (1, user_channel_id_opt, option),
715 (2, reason, ignorable),
717 if reason.is_none() { return Ok(None); }
718 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
719 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
725 let mut channel_id = [0; 32];
726 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
727 read_tlv_fields!(reader, {
728 (0, channel_id, required),
729 (2, transaction, required),
731 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
737 let mut payment_id = PaymentId([0; 32]);
738 let mut payment_hash = None;
739 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
740 read_tlv_fields!(reader, {
741 (0, payment_id, required),
742 (2, payment_hash, option),
745 Ok(Some(Event::PaymentPathSuccessful {
755 let mut payment_hash = PaymentHash([0; 32]);
756 let mut payment_id = PaymentId([0; 32]);
757 read_tlv_fields!(reader, {
758 (0, payment_id, required),
759 (2, payment_hash, required),
761 Ok(Some(Event::PaymentFailed {
769 // Value 17 is used for `Event::OpenChannelRequest`.
772 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
773 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
776 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
777 // which prefixes the whole thing with a length BigSize. Because the event is
778 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
779 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
780 // exactly the number of bytes specified, ignoring them entirely.
781 let tlv_len: BigSize = Readable::read(reader)?;
782 FixedLengthReader::new(reader, tlv_len.0)
783 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
786 _ => Err(msgs::DecodeError::InvalidValue)
791 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
792 /// broadcast to most peers).
793 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
794 #[derive(Clone, Debug)]
795 pub enum MessageSendEvent {
796 /// Used to indicate that we've accepted a channel open and should send the accept_channel
797 /// message provided to the given peer.
799 /// The node_id of the node which should receive this message
801 /// The message which should be sent.
802 msg: msgs::AcceptChannel,
804 /// Used to indicate that we've initiated a channel open and should send the open_channel
805 /// message provided to the given peer.
807 /// The node_id of the node which should receive this message
809 /// The message which should be sent.
810 msg: msgs::OpenChannel,
812 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
814 /// The node_id of the node which should receive this message
816 /// The message which should be sent.
817 msg: msgs::FundingCreated,
819 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
821 /// The node_id of the node which should receive this message
823 /// The message which should be sent.
824 msg: msgs::FundingSigned,
826 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
828 /// The node_id of the node which should receive these message(s)
830 /// The funding_locked message which should be sent.
831 msg: msgs::FundingLocked,
833 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
834 SendAnnouncementSignatures {
835 /// The node_id of the node which should receive these message(s)
837 /// The announcement_signatures message which should be sent.
838 msg: msgs::AnnouncementSignatures,
840 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
841 /// message should be sent to the peer with the given node_id.
843 /// The node_id of the node which should receive these message(s)
845 /// The update messages which should be sent. ALL messages in the struct should be sent!
846 updates: msgs::CommitmentUpdate,
848 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
850 /// The node_id of the node which should receive this message
852 /// The message which should be sent.
853 msg: msgs::RevokeAndACK,
855 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
857 /// The node_id of the node which should receive this message
859 /// The message which should be sent.
860 msg: msgs::ClosingSigned,
862 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
864 /// The node_id of the node which should receive this message
866 /// The message which should be sent.
869 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
870 SendChannelReestablish {
871 /// The node_id of the node which should receive this message
873 /// The message which should be sent.
874 msg: msgs::ChannelReestablish,
876 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
877 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
879 /// Note that after doing so, you very likely (unless you did so very recently) want to call
880 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
881 /// This ensures that any nodes which see our channel_announcement also have a relevant
882 /// node_announcement, including relevant feature flags which may be important for routing
883 /// through or to us.
884 BroadcastChannelAnnouncement {
885 /// The channel_announcement which should be sent.
886 msg: msgs::ChannelAnnouncement,
887 /// The followup channel_update which should be sent.
888 update_msg: msgs::ChannelUpdate,
890 /// Used to indicate that a node_announcement should be broadcast to all peers.
891 BroadcastNodeAnnouncement {
892 /// The node_announcement which should be sent.
893 msg: msgs::NodeAnnouncement,
895 /// Used to indicate that a channel_update should be broadcast to all peers.
896 BroadcastChannelUpdate {
897 /// The channel_update which should be sent.
898 msg: msgs::ChannelUpdate,
900 /// Used to indicate that a channel_update should be sent to a single peer.
901 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
902 /// private channel and we shouldn't be informing all of our peers of channel parameters.
904 /// The node_id of the node which should receive this message
906 /// The channel_update which should be sent.
907 msg: msgs::ChannelUpdate,
909 /// Broadcast an error downstream to be handled
911 /// The node_id of the node which should receive this message
913 /// The action which should be taken.
914 action: msgs::ErrorAction
916 /// Query a peer for channels with funding transaction UTXOs in a block range.
917 SendChannelRangeQuery {
918 /// The node_id of this message recipient
920 /// The query_channel_range which should be sent.
921 msg: msgs::QueryChannelRange,
923 /// Request routing gossip messages from a peer for a list of channels identified by
924 /// their short_channel_ids.
926 /// The node_id of this message recipient
928 /// The query_short_channel_ids which should be sent.
929 msg: msgs::QueryShortChannelIds,
931 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
932 /// emitted during processing of the query.
933 SendReplyChannelRange {
934 /// The node_id of this message recipient
936 /// The reply_channel_range which should be sent.
937 msg: msgs::ReplyChannelRange,
939 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
940 /// enable receiving gossip messages from the peer.
941 SendGossipTimestampFilter {
942 /// The node_id of this message recipient
944 /// The gossip_timestamp_filter which should be sent.
945 msg: msgs::GossipTimestampFilter,
949 /// A trait indicating an object may generate message send events
950 pub trait MessageSendEventsProvider {
951 /// Gets the list of pending events which were generated by previous actions, clearing the list
953 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
956 /// A trait indicating an object may generate events.
958 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
962 /// See [`process_pending_events`] for requirements around event processing.
964 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
965 /// event since the last invocation. The handler must either act upon the event immediately
966 /// or preserve it for later handling.
968 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
969 /// consult the provider's documentation on the implication of processing events and how a handler
970 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
971 /// [`ChainMonitor::process_pending_events`]).
973 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
976 /// [`process_pending_events`]: Self::process_pending_events
977 /// [`handle_event`]: EventHandler::handle_event
978 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
979 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
980 pub trait EventsProvider {
981 /// Processes any events generated since the last call using the given event handler.
983 /// Subsequent calls must only process new events. However, handlers must be capable of handling
984 /// duplicate events across process restarts. This may occur if the provider was recovered from
985 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
986 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
989 /// A trait implemented for objects handling events from [`EventsProvider`].
990 pub trait EventHandler {
991 /// Handles the given [`Event`].
993 /// See [`EventsProvider`] for details that must be considered when implementing this method.
994 fn handle_event(&self, event: &Event);
997 impl<F> EventHandler for F where F: Fn(&Event) {
998 fn handle_event(&self, event: &Event) {
1003 impl<T: EventHandler> EventHandler for Arc<T> {
1004 fn handle_event(&self, event: &Event) {
1005 self.deref().handle_event(event)