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::key::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 `PeerManager` informed us that we've disconnected from the peer. We close channels
104 /// if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
105 /// peer again in the future or if the peer disconnected before we finished negotiating
106 /// the channel open. The first case may be caused by incompatible features which our
107 /// counterparty, or we, require.
108 //TODO: split between PeerUnconnectable/PeerDisconnected ?
110 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
111 /// the ChannelManager deserialized.
112 OutdatedChannelManager
115 impl core::fmt::Display for ClosureReason {
116 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
117 f.write_str("Channel closed because ")?;
119 ClosureReason::CounterpartyForceClosed { peer_msg } => {
120 f.write_str("counterparty force-closed with message ")?;
121 f.write_str(&peer_msg)
123 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
124 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
125 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
126 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
127 ClosureReason::ProcessingError { err } => {
128 f.write_str("of an exception: ")?;
131 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
132 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
137 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
138 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
139 (1, FundingTimedOut) => {},
140 (2, HolderForceClosed) => {},
141 (6, CommitmentTxConfirmed) => {},
142 (4, CooperativeClosure) => {},
143 (8, ProcessingError) => { (1, err, required) },
144 (10, DisconnectedPeer) => {},
145 (12, OutdatedChannelManager) => {},
148 /// An Event which you should probably take some action in response to.
150 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
151 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
152 /// written as it makes no sense to respond to it after reconnecting to peers).
153 #[derive(Clone, Debug)]
155 /// Used to indicate that the client should generate a funding transaction with the given
156 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
157 /// Generated in [`ChannelManager`] message handling.
158 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
159 /// counterparty can steal your funds!
161 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
162 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
163 FundingGenerationReady {
164 /// The random channel_id we picked which you'll need to pass into
165 /// ChannelManager::funding_transaction_generated.
166 temporary_channel_id: [u8; 32],
167 /// The value, in satoshis, that the output should have.
168 channel_value_satoshis: u64,
169 /// The script which should be used in the transaction output.
170 output_script: Script,
171 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
172 /// an inbound channel.
174 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
175 user_channel_id: u64,
177 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
178 /// [`ChannelManager::claim_funds`] to get it....
179 /// Note that if the preimage is not known, you should call
180 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
181 /// network congestion.
182 /// If you fail to call either [`ChannelManager::claim_funds`] or
183 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
184 /// automatically failed.
187 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
188 /// `PaymentReceived` events may be generated for the same payment.
190 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
191 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
193 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
194 /// not stop you from registering duplicate payment hashes for inbound payments.
195 payment_hash: PaymentHash,
196 /// The value, in thousandths of a satoshi, that this payment is for.
198 /// Information for claiming this received payment, based on whether the purpose of the
199 /// payment is to pay an invoice or to send a spontaneous payment.
200 purpose: PaymentPurpose,
202 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
203 /// and we got back the payment preimage for it).
205 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
206 /// event. In this situation, you SHOULD treat this payment as having succeeded.
208 /// The id returned by [`ChannelManager::send_payment`] and used with
209 /// [`ChannelManager::retry_payment`].
211 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
212 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
213 payment_id: Option<PaymentId>,
214 /// The preimage to the hash given to ChannelManager::send_payment.
215 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
216 /// store it somehow!
217 payment_preimage: PaymentPreimage,
218 /// The hash that was given to [`ChannelManager::send_payment`].
220 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
221 payment_hash: PaymentHash,
222 /// The total fee which was spent at intermediate hops in this payment, across all paths.
224 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
225 /// overpayment to the recipient node.
227 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
228 /// overstate the amount paid, though this is unlikely.
230 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
231 fee_paid_msat: Option<u64>,
233 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
234 /// something. You may wish to retry with a different route.
236 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
237 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
239 /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
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: Option<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,
252 /// Indicates the payment was rejected for some reason by the recipient. This implies that
253 /// the payment has failed, not just the route in question. If this is not set, you may
254 /// retry the payment via a different route.
255 rejected_by_dest: bool,
256 /// Any failure information conveyed via the Onion return packet by a node along the failed
259 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
260 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
262 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
263 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
264 network_update: Option<NetworkUpdate>,
265 /// For both single-path and multi-path payments, this is set if all paths of the payment have
266 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
267 /// larger MPP payment were still in flight when this event was generated.
269 /// Note that if you are retrying individual MPP parts, using this value to determine if a
270 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
271 /// being processed, you may retry in response to a first failure, with a second failure
272 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
273 /// you will see `all_paths_failed` set even though the retry of the first failure still
274 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
276 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
277 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
279 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
281 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
282 all_paths_failed: bool,
283 /// The payment path that failed.
285 /// The channel responsible for the failed payment path.
287 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
288 /// retried. May be `None` for older [`Event`] serializations.
289 short_channel_id: Option<u64>,
290 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
292 /// See [`find_route`] for details.
294 /// [`Route`]: crate::routing::router::Route
295 /// [`find_route`]: crate::routing::router::find_route
296 retry: Option<RouteParameters>,
298 error_code: Option<u16>,
300 error_data: Option<Vec<u8>>,
302 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
303 /// provide failure information for each MPP part in the payment.
305 /// This event is provided once there are no further pending HTLCs for the payment and the
306 /// payment is no longer retryable, either due to a several-block timeout or because
307 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
309 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
311 /// The id returned by [`ChannelManager::send_payment`] and used with
312 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
314 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
315 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
316 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
317 payment_id: PaymentId,
318 /// The hash that was given to [`ChannelManager::send_payment`].
320 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
321 payment_hash: PaymentHash,
323 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
324 /// a time in the future.
326 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
327 PendingHTLCsForwardable {
328 /// The minimum amount of time that should be waited prior to calling
329 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
330 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
331 /// now + 5*time_forwardable).
332 time_forwardable: Duration,
334 /// Used to indicate that an output which you should know how to spend was confirmed on chain
335 /// and is now spendable.
336 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
337 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
338 /// somewhere and spend them when you create on-chain transactions.
340 /// The outputs which you should store as spendable by you.
341 outputs: Vec<SpendableOutputDescriptor>,
343 /// This event is generated when a payment has been successfully forwarded through us and a
344 /// forwarding fee earned.
346 /// The incoming channel between the previous node and us. This is only `None` for events
347 /// generated or serialized by versions prior to 0.0.107.
348 prev_channel_id: Option<[u8; 32]>,
349 /// The outgoing channel between the next node and us. This is only `None` for events
350 /// generated or serialized by versions prior to 0.0.107.
351 next_channel_id: Option<[u8; 32]>,
352 /// The fee, in milli-satoshis, which was earned as a result of the payment.
354 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
355 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
356 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
357 /// claimed the full value in millisatoshis from the source. In this case,
358 /// `claim_from_onchain_tx` will be set.
360 /// If the channel which sent us the payment has been force-closed, we will claim the funds
361 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
362 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
363 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
365 fee_earned_msat: Option<u64>,
366 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
368 claim_from_onchain_tx: bool,
370 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
372 /// The channel_id of the channel which has been closed. Note that on-chain transactions
373 /// resolving the channel are likely still awaiting confirmation.
374 channel_id: [u8; 32],
375 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
376 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
377 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
378 /// `user_channel_id` will be 0 for an inbound channel.
379 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
381 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
382 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
383 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
384 user_channel_id: u64,
385 /// The reason the channel was closed.
386 reason: ClosureReason
388 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
389 /// inputs for another purpose.
391 /// The channel_id of the channel which has been closed.
392 channel_id: [u8; 32],
393 /// The full transaction received from the user
394 transaction: Transaction
396 /// Indicates that a path for an outbound payment was successful.
398 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
399 /// [`Event::PaymentSent`] for obtaining the payment preimage.
400 PaymentPathSuccessful {
401 /// The id returned by [`ChannelManager::send_payment`] and used with
402 /// [`ChannelManager::retry_payment`].
404 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
405 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
406 payment_id: PaymentId,
407 /// The hash that was given to [`ChannelManager::send_payment`].
409 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
410 payment_hash: Option<PaymentHash>,
411 /// The payment path that was successful.
413 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
416 /// Indicates a request to open a new channel by a peer.
418 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
419 /// request, call [`ChannelManager::force_close_channel`].
421 /// The event is only triggered when a new open channel request is received and the
422 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
424 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
425 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
426 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
428 /// The temporary channel ID of the channel requested to be opened.
430 /// When responding to the request, the `temporary_channel_id` should be passed
431 /// back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
432 /// or to [`ChannelManager::force_close_channel`] to reject.
434 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
435 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
436 temporary_channel_id: [u8; 32],
437 /// The node_id of the counterparty requesting to open the channel.
438 counterparty_node_id: PublicKey,
439 /// The channel value of the requested channel.
440 funding_satoshis: u64,
441 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
443 /// The features that this channel will operate with. If you reject the channel, a
444 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
447 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
448 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
451 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
452 channel_type: ChannelTypeFeatures,
456 impl Writeable for Event {
457 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
459 &Event::FundingGenerationReady { .. } => {
461 // We never write out FundingGenerationReady events as, upon disconnection, peers
462 // drop any channels which have not yet exchanged funding_signed.
464 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
466 let mut payment_secret = None;
467 let payment_preimage;
469 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
470 payment_secret = Some(secret);
471 payment_preimage = *preimage;
473 PaymentPurpose::SpontaneousPayment(preimage) => {
474 payment_preimage = Some(*preimage);
477 write_tlv_fields!(writer, {
478 (0, payment_hash, required),
479 (2, payment_secret, option),
481 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
482 (8, payment_preimage, option),
485 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
487 write_tlv_fields!(writer, {
488 (0, payment_preimage, required),
489 (1, payment_hash, required),
490 (3, payment_id, option),
491 (5, fee_paid_msat, option),
494 &Event::PaymentPathFailed {
495 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
496 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
504 error_code.write(writer)?;
506 error_data.write(writer)?;
507 write_tlv_fields!(writer, {
508 (0, payment_hash, required),
509 (1, network_update, option),
510 (2, rejected_by_dest, required),
511 (3, all_paths_failed, required),
513 (7, short_channel_id, option),
515 (11, payment_id, option),
518 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
520 // Note that we now ignore these on the read end as we'll re-generate them in
521 // ChannelManager, we write them here only for backwards compatibility.
523 &Event::SpendableOutputs { ref outputs } => {
525 write_tlv_fields!(writer, {
526 (0, VecWriteWrapper(outputs), required),
529 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
531 write_tlv_fields!(writer, {
532 (0, fee_earned_msat, option),
533 (1, prev_channel_id, option),
534 (2, claim_from_onchain_tx, required),
535 (3, next_channel_id, option),
538 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
540 write_tlv_fields!(writer, {
541 (0, channel_id, required),
542 (1, user_channel_id, required),
543 (2, reason, required)
546 &Event::DiscardFunding { ref channel_id, ref transaction } => {
548 write_tlv_fields!(writer, {
549 (0, channel_id, required),
550 (2, transaction, required)
553 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
555 write_tlv_fields!(writer, {
556 (0, payment_id, required),
557 (2, payment_hash, option),
561 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
563 write_tlv_fields!(writer, {
564 (0, payment_id, required),
565 (2, payment_hash, required),
568 &Event::OpenChannelRequest { .. } => {
570 // We never write the OpenChannelRequest events as, upon disconnection, peers
571 // drop any channels which have not yet exchanged funding_signed.
573 // Note that, going forward, all new events must only write data inside of
574 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
575 // data via `write_tlv_fields`.
580 impl MaybeReadable for Event {
581 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
582 match Readable::read(reader)? {
583 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
584 // unlike all other events, thus we return immediately here.
588 let mut payment_hash = PaymentHash([0; 32]);
589 let mut payment_preimage = None;
590 let mut payment_secret = None;
592 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
593 read_tlv_fields!(reader, {
594 (0, payment_hash, required),
595 (2, payment_secret, option),
597 (6, _user_payment_id, option),
598 (8, payment_preimage, option),
600 let purpose = match payment_secret {
601 Some(secret) => PaymentPurpose::InvoicePayment {
603 payment_secret: secret
605 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
606 None => return Err(msgs::DecodeError::InvalidValue),
608 Ok(Some(Event::PaymentReceived {
618 let mut payment_preimage = PaymentPreimage([0; 32]);
619 let mut payment_hash = None;
620 let mut payment_id = None;
621 let mut fee_paid_msat = None;
622 read_tlv_fields!(reader, {
623 (0, payment_preimage, required),
624 (1, payment_hash, option),
625 (3, payment_id, option),
626 (5, fee_paid_msat, option),
628 if payment_hash.is_none() {
629 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
631 Ok(Some(Event::PaymentSent {
634 payment_hash: payment_hash.unwrap(),
643 let error_code = Readable::read(reader)?;
645 let error_data = Readable::read(reader)?;
646 let mut payment_hash = PaymentHash([0; 32]);
647 let mut rejected_by_dest = false;
648 let mut network_update = None;
649 let mut all_paths_failed = Some(true);
650 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
651 let mut short_channel_id = None;
652 let mut retry = None;
653 let mut payment_id = None;
654 read_tlv_fields!(reader, {
655 (0, payment_hash, required),
656 (1, network_update, ignorable),
657 (2, rejected_by_dest, required),
658 (3, all_paths_failed, option),
660 (7, short_channel_id, option),
662 (11, payment_id, option),
664 Ok(Some(Event::PaymentPathFailed {
669 all_paths_failed: all_paths_failed.unwrap(),
684 let mut outputs = VecReadWrapper(Vec::new());
685 read_tlv_fields!(reader, {
686 (0, outputs, required),
688 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
694 let mut fee_earned_msat = None;
695 let mut prev_channel_id = None;
696 let mut claim_from_onchain_tx = false;
697 let mut next_channel_id = None;
698 read_tlv_fields!(reader, {
699 (0, fee_earned_msat, option),
700 (1, prev_channel_id, option),
701 (2, claim_from_onchain_tx, required),
702 (3, next_channel_id, option),
704 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
710 let mut channel_id = [0; 32];
711 let mut reason = None;
712 let mut user_channel_id_opt = None;
713 read_tlv_fields!(reader, {
714 (0, channel_id, required),
715 (1, user_channel_id_opt, option),
716 (2, reason, ignorable),
718 if reason.is_none() { return Ok(None); }
719 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
720 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
726 let mut channel_id = [0; 32];
727 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
728 read_tlv_fields!(reader, {
729 (0, channel_id, required),
730 (2, transaction, required),
732 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
738 let mut payment_id = PaymentId([0; 32]);
739 let mut payment_hash = None;
740 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
741 read_tlv_fields!(reader, {
742 (0, payment_id, required),
743 (2, payment_hash, option),
746 Ok(Some(Event::PaymentPathSuccessful {
756 let mut payment_hash = PaymentHash([0; 32]);
757 let mut payment_id = PaymentId([0; 32]);
758 read_tlv_fields!(reader, {
759 (0, payment_id, required),
760 (2, payment_hash, required),
762 Ok(Some(Event::PaymentFailed {
770 // Value 17 is used for `Event::OpenChannelRequest`.
773 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
774 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
777 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
778 // which prefixes the whole thing with a length BigSize. Because the event is
779 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
780 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
781 // exactly the number of bytes specified, ignoring them entirely.
782 let tlv_len: BigSize = Readable::read(reader)?;
783 FixedLengthReader::new(reader, tlv_len.0)
784 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
787 _ => Err(msgs::DecodeError::InvalidValue)
792 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
793 /// broadcast to most peers).
794 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
795 #[derive(Clone, Debug)]
796 pub enum MessageSendEvent {
797 /// Used to indicate that we've accepted a channel open and should send the accept_channel
798 /// message provided to the given peer.
800 /// The node_id of the node which should receive this message
802 /// The message which should be sent.
803 msg: msgs::AcceptChannel,
805 /// Used to indicate that we've initiated a channel open and should send the open_channel
806 /// message provided to the given peer.
808 /// The node_id of the node which should receive this message
810 /// The message which should be sent.
811 msg: msgs::OpenChannel,
813 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
815 /// The node_id of the node which should receive this message
817 /// The message which should be sent.
818 msg: msgs::FundingCreated,
820 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
822 /// The node_id of the node which should receive this message
824 /// The message which should be sent.
825 msg: msgs::FundingSigned,
827 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
829 /// The node_id of the node which should receive these message(s)
831 /// The funding_locked message which should be sent.
832 msg: msgs::FundingLocked,
834 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
835 SendAnnouncementSignatures {
836 /// The node_id of the node which should receive these message(s)
838 /// The announcement_signatures message which should be sent.
839 msg: msgs::AnnouncementSignatures,
841 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
842 /// message should be sent to the peer with the given node_id.
844 /// The node_id of the node which should receive these message(s)
846 /// The update messages which should be sent. ALL messages in the struct should be sent!
847 updates: msgs::CommitmentUpdate,
849 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
851 /// The node_id of the node which should receive this message
853 /// The message which should be sent.
854 msg: msgs::RevokeAndACK,
856 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
858 /// The node_id of the node which should receive this message
860 /// The message which should be sent.
861 msg: msgs::ClosingSigned,
863 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
865 /// The node_id of the node which should receive this message
867 /// The message which should be sent.
870 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
871 SendChannelReestablish {
872 /// The node_id of the node which should receive this message
874 /// The message which should be sent.
875 msg: msgs::ChannelReestablish,
877 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
878 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
880 /// Note that after doing so, you very likely (unless you did so very recently) want to call
881 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
882 /// This ensures that any nodes which see our channel_announcement also have a relevant
883 /// node_announcement, including relevant feature flags which may be important for routing
884 /// through or to us.
885 BroadcastChannelAnnouncement {
886 /// The channel_announcement which should be sent.
887 msg: msgs::ChannelAnnouncement,
888 /// The followup channel_update which should be sent.
889 update_msg: msgs::ChannelUpdate,
891 /// Used to indicate that a node_announcement should be broadcast to all peers.
892 BroadcastNodeAnnouncement {
893 /// The node_announcement which should be sent.
894 msg: msgs::NodeAnnouncement,
896 /// Used to indicate that a channel_update should be broadcast to all peers.
897 BroadcastChannelUpdate {
898 /// The channel_update which should be sent.
899 msg: msgs::ChannelUpdate,
901 /// Used to indicate that a channel_update should be sent to a single peer.
902 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
903 /// private channel and we shouldn't be informing all of our peers of channel parameters.
905 /// The node_id of the node which should receive this message
907 /// The channel_update which should be sent.
908 msg: msgs::ChannelUpdate,
910 /// Broadcast an error downstream to be handled
912 /// The node_id of the node which should receive this message
914 /// The action which should be taken.
915 action: msgs::ErrorAction
917 /// Query a peer for channels with funding transaction UTXOs in a block range.
918 SendChannelRangeQuery {
919 /// The node_id of this message recipient
921 /// The query_channel_range which should be sent.
922 msg: msgs::QueryChannelRange,
924 /// Request routing gossip messages from a peer for a list of channels identified by
925 /// their short_channel_ids.
927 /// The node_id of this message recipient
929 /// The query_short_channel_ids which should be sent.
930 msg: msgs::QueryShortChannelIds,
932 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
933 /// emitted during processing of the query.
934 SendReplyChannelRange {
935 /// The node_id of this message recipient
937 /// The reply_channel_range which should be sent.
938 msg: msgs::ReplyChannelRange,
940 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
941 /// enable receiving gossip messages from the peer.
942 SendGossipTimestampFilter {
943 /// The node_id of this message recipient
945 /// The gossip_timestamp_filter which should be sent.
946 msg: msgs::GossipTimestampFilter,
950 /// A trait indicating an object may generate message send events
951 pub trait MessageSendEventsProvider {
952 /// Gets the list of pending events which were generated by previous actions, clearing the list
954 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
957 /// A trait indicating an object may generate events.
959 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
963 /// See [`process_pending_events`] for requirements around event processing.
965 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
966 /// event since the last invocation. The handler must either act upon the event immediately
967 /// or preserve it for later handling.
969 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
970 /// consult the provider's documentation on the implication of processing events and how a handler
971 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
972 /// [`ChainMonitor::process_pending_events`]).
974 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
977 /// [`process_pending_events`]: Self::process_pending_events
978 /// [`handle_event`]: EventHandler::handle_event
979 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
980 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
981 pub trait EventsProvider {
982 /// Processes any events generated since the last call using the given event handler.
984 /// Subsequent calls must only process new events. However, handlers must be capable of handling
985 /// duplicate events across process restarts. This may occur if the provider was recovered from
986 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
987 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
990 /// A trait implemented for objects handling events from [`EventsProvider`].
991 pub trait EventHandler {
992 /// Handles the given [`Event`].
994 /// See [`EventsProvider`] for details that must be considered when implementing this method.
995 fn handle_event(&self, event: &Event);
998 impl<F> EventHandler for F where F: Fn(&Event) {
999 fn handle_event(&self, event: &Event) {
1004 impl<T: EventHandler> EventHandler for Arc<T> {
1005 fn handle_event(&self, event: &Event) {
1006 self.deref().handle_event(event)