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 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
368 /// retried. May be `None` for older [`Event`] serializations.
369 short_channel_id: Option<u64>,
370 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
372 /// See [`find_route`] for details.
374 /// [`Route`]: crate::routing::router::Route
375 /// [`find_route`]: crate::routing::router::find_route
376 retry: Option<RouteParameters>,
378 error_code: Option<u16>,
380 error_data: Option<Vec<u8>>,
382 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
383 /// a time in the future.
385 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
386 PendingHTLCsForwardable {
387 /// The minimum amount of time that should be waited prior to calling
388 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
389 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
390 /// now + 5*time_forwardable).
391 time_forwardable: Duration,
393 /// Used to indicate that an output which you should know how to spend was confirmed on chain
394 /// and is now spendable.
395 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
396 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
397 /// somewhere and spend them when you create on-chain transactions.
399 /// The outputs which you should store as spendable by you.
400 outputs: Vec<SpendableOutputDescriptor>,
402 /// This event is generated when a payment has been successfully forwarded through us and a
403 /// forwarding fee earned.
405 /// The incoming channel between the previous node and us. This is only `None` for events
406 /// generated or serialized by versions prior to 0.0.107.
407 prev_channel_id: Option<[u8; 32]>,
408 /// The outgoing channel between the next node and us. This is only `None` for events
409 /// generated or serialized by versions prior to 0.0.107.
410 next_channel_id: Option<[u8; 32]>,
411 /// The fee, in milli-satoshis, which was earned as a result of the payment.
413 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
414 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
415 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
416 /// claimed the full value in millisatoshis from the source. In this case,
417 /// `claim_from_onchain_tx` will be set.
419 /// If the channel which sent us the payment has been force-closed, we will claim the funds
420 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
421 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
422 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
424 fee_earned_msat: Option<u64>,
425 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
427 claim_from_onchain_tx: bool,
429 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
431 /// The channel_id of the channel which has been closed. Note that on-chain transactions
432 /// resolving the channel are likely still awaiting confirmation.
433 channel_id: [u8; 32],
434 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
435 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
436 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
437 /// `user_channel_id` will be 0 for an inbound channel.
438 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
440 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
441 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
442 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
443 user_channel_id: u64,
444 /// The reason the channel was closed.
445 reason: ClosureReason
447 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
448 /// inputs for another purpose.
450 /// The channel_id of the channel which has been closed.
451 channel_id: [u8; 32],
452 /// The full transaction received from the user
453 transaction: Transaction
455 /// Indicates a request to open a new channel by a peer.
457 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
458 /// request, call [`ChannelManager::force_close_channel`].
460 /// The event is only triggered when a new open channel request is received and the
461 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
463 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
464 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
465 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
467 /// The temporary channel ID of the channel requested to be opened.
469 /// When responding to the request, the `temporary_channel_id` should be passed
470 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
471 /// or through [`ChannelManager::force_close_channel`] to reject.
473 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
474 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
475 temporary_channel_id: [u8; 32],
476 /// The node_id of the counterparty requesting to open the channel.
478 /// When responding to the request, the `counterparty_node_id` should be passed
479 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
480 /// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
483 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
484 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
485 counterparty_node_id: PublicKey,
486 /// The channel value of the requested channel.
487 funding_satoshis: u64,
488 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
490 /// The features that this channel will operate with. If you reject the channel, a
491 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
494 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
495 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
498 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
499 channel_type: ChannelTypeFeatures,
503 impl Writeable for Event {
504 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
506 &Event::FundingGenerationReady { .. } => {
508 // We never write out FundingGenerationReady events as, upon disconnection, peers
509 // drop any channels which have not yet exchanged funding_signed.
511 &Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose } => {
513 let mut payment_secret = None;
514 let payment_preimage;
516 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
517 payment_secret = Some(secret);
518 payment_preimage = *preimage;
520 PaymentPurpose::SpontaneousPayment(preimage) => {
521 payment_preimage = Some(*preimage);
524 write_tlv_fields!(writer, {
525 (0, payment_hash, required),
526 (2, payment_secret, option),
527 (4, amount_msat, required),
528 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
529 (8, payment_preimage, option),
532 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
534 write_tlv_fields!(writer, {
535 (0, payment_preimage, required),
536 (1, payment_hash, required),
537 (3, payment_id, option),
538 (5, fee_paid_msat, option),
541 &Event::PaymentPathFailed {
542 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
543 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
551 error_code.write(writer)?;
553 error_data.write(writer)?;
554 write_tlv_fields!(writer, {
555 (0, payment_hash, required),
556 (1, network_update, option),
557 (2, rejected_by_dest, required),
558 (3, all_paths_failed, required),
560 (7, short_channel_id, option),
562 (11, payment_id, option),
565 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
567 // Note that we now ignore these on the read end as we'll re-generate them in
568 // ChannelManager, we write them here only for backwards compatibility.
570 &Event::SpendableOutputs { ref outputs } => {
572 write_tlv_fields!(writer, {
573 (0, VecWriteWrapper(outputs), required),
576 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
578 write_tlv_fields!(writer, {
579 (0, fee_earned_msat, option),
580 (1, prev_channel_id, option),
581 (2, claim_from_onchain_tx, required),
582 (3, next_channel_id, option),
585 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
587 write_tlv_fields!(writer, {
588 (0, channel_id, required),
589 (1, user_channel_id, required),
590 (2, reason, required)
593 &Event::DiscardFunding { ref channel_id, ref transaction } => {
595 write_tlv_fields!(writer, {
596 (0, channel_id, required),
597 (2, transaction, required)
600 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
602 write_tlv_fields!(writer, {
603 (0, payment_id, required),
604 (2, payment_hash, option),
608 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
610 write_tlv_fields!(writer, {
611 (0, payment_id, required),
612 (2, payment_hash, required),
615 &Event::OpenChannelRequest { .. } => {
617 // We never write the OpenChannelRequest events as, upon disconnection, peers
618 // drop any channels which have not yet exchanged funding_signed.
620 &Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose } => {
622 write_tlv_fields!(writer, {
623 (0, payment_hash, required),
624 (2, purpose, required),
625 (4, amount_msat, required),
628 // Note that, going forward, all new events must only write data inside of
629 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
630 // data via `write_tlv_fields`.
635 impl MaybeReadable for Event {
636 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
637 match Readable::read(reader)? {
638 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
639 // unlike all other events, thus we return immediately here.
643 let mut payment_hash = PaymentHash([0; 32]);
644 let mut payment_preimage = None;
645 let mut payment_secret = None;
646 let mut amount_msat = 0;
647 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
648 read_tlv_fields!(reader, {
649 (0, payment_hash, required),
650 (2, payment_secret, option),
651 (4, amount_msat, required),
652 (6, _user_payment_id, option),
653 (8, payment_preimage, option),
655 let purpose = match payment_secret {
656 Some(secret) => PaymentPurpose::InvoicePayment {
658 payment_secret: secret
660 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
661 None => return Err(msgs::DecodeError::InvalidValue),
663 Ok(Some(Event::PaymentReceived {
673 let mut payment_preimage = PaymentPreimage([0; 32]);
674 let mut payment_hash = None;
675 let mut payment_id = None;
676 let mut fee_paid_msat = None;
677 read_tlv_fields!(reader, {
678 (0, payment_preimage, required),
679 (1, payment_hash, option),
680 (3, payment_id, option),
681 (5, fee_paid_msat, option),
683 if payment_hash.is_none() {
684 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
686 Ok(Some(Event::PaymentSent {
689 payment_hash: payment_hash.unwrap(),
698 let error_code = Readable::read(reader)?;
700 let error_data = Readable::read(reader)?;
701 let mut payment_hash = PaymentHash([0; 32]);
702 let mut rejected_by_dest = false;
703 let mut network_update = None;
704 let mut all_paths_failed = Some(true);
705 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
706 let mut short_channel_id = None;
707 let mut retry = None;
708 let mut payment_id = None;
709 read_tlv_fields!(reader, {
710 (0, payment_hash, required),
711 (1, network_update, ignorable),
712 (2, rejected_by_dest, required),
713 (3, all_paths_failed, option),
715 (7, short_channel_id, option),
717 (11, payment_id, option),
719 Ok(Some(Event::PaymentPathFailed {
724 all_paths_failed: all_paths_failed.unwrap(),
739 let mut outputs = VecReadWrapper(Vec::new());
740 read_tlv_fields!(reader, {
741 (0, outputs, required),
743 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
749 let mut fee_earned_msat = None;
750 let mut prev_channel_id = None;
751 let mut claim_from_onchain_tx = false;
752 let mut next_channel_id = None;
753 read_tlv_fields!(reader, {
754 (0, fee_earned_msat, option),
755 (1, prev_channel_id, option),
756 (2, claim_from_onchain_tx, required),
757 (3, next_channel_id, option),
759 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
765 let mut channel_id = [0; 32];
766 let mut reason = None;
767 let mut user_channel_id_opt = None;
768 read_tlv_fields!(reader, {
769 (0, channel_id, required),
770 (1, user_channel_id_opt, option),
771 (2, reason, ignorable),
773 if reason.is_none() { return Ok(None); }
774 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
775 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
781 let mut channel_id = [0; 32];
782 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
783 read_tlv_fields!(reader, {
784 (0, channel_id, required),
785 (2, transaction, required),
787 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
793 let mut payment_id = PaymentId([0; 32]);
794 let mut payment_hash = None;
795 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
796 read_tlv_fields!(reader, {
797 (0, payment_id, required),
798 (2, payment_hash, option),
801 Ok(Some(Event::PaymentPathSuccessful {
811 let mut payment_hash = PaymentHash([0; 32]);
812 let mut payment_id = PaymentId([0; 32]);
813 read_tlv_fields!(reader, {
814 (0, payment_id, required),
815 (2, payment_hash, required),
817 Ok(Some(Event::PaymentFailed {
825 // Value 17 is used for `Event::OpenChannelRequest`.
830 let mut payment_hash = PaymentHash([0; 32]);
831 let mut purpose = None;
832 let mut amount_msat = 0;
833 read_tlv_fields!(reader, {
834 (0, payment_hash, required),
835 (2, purpose, ignorable),
836 (4, amount_msat, required),
838 if purpose.is_none() { return Ok(None); }
839 Ok(Some(Event::PaymentClaimed {
841 purpose: purpose.unwrap(),
847 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
848 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
851 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
852 // which prefixes the whole thing with a length BigSize. Because the event is
853 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
854 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
855 // exactly the number of bytes specified, ignoring them entirely.
856 let tlv_len: BigSize = Readable::read(reader)?;
857 FixedLengthReader::new(reader, tlv_len.0)
858 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
861 _ => Err(msgs::DecodeError::InvalidValue)
866 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
867 /// broadcast to most peers).
868 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
869 #[derive(Clone, Debug)]
870 pub enum MessageSendEvent {
871 /// Used to indicate that we've accepted a channel open and should send the accept_channel
872 /// message provided to the given peer.
874 /// The node_id of the node which should receive this message
876 /// The message which should be sent.
877 msg: msgs::AcceptChannel,
879 /// Used to indicate that we've initiated a channel open and should send the open_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::OpenChannel,
887 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
889 /// The node_id of the node which should receive this message
891 /// The message which should be sent.
892 msg: msgs::FundingCreated,
894 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
896 /// The node_id of the node which should receive this message
898 /// The message which should be sent.
899 msg: msgs::FundingSigned,
901 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
903 /// The node_id of the node which should receive these message(s)
905 /// The funding_locked message which should be sent.
906 msg: msgs::FundingLocked,
908 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
909 SendAnnouncementSignatures {
910 /// The node_id of the node which should receive these message(s)
912 /// The announcement_signatures message which should be sent.
913 msg: msgs::AnnouncementSignatures,
915 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
916 /// message should be sent to the peer with the given node_id.
918 /// The node_id of the node which should receive these message(s)
920 /// The update messages which should be sent. ALL messages in the struct should be sent!
921 updates: msgs::CommitmentUpdate,
923 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
925 /// The node_id of the node which should receive this message
927 /// The message which should be sent.
928 msg: msgs::RevokeAndACK,
930 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
932 /// The node_id of the node which should receive this message
934 /// The message which should be sent.
935 msg: msgs::ClosingSigned,
937 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
939 /// The node_id of the node which should receive this message
941 /// The message which should be sent.
944 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
945 SendChannelReestablish {
946 /// The node_id of the node which should receive this message
948 /// The message which should be sent.
949 msg: msgs::ChannelReestablish,
951 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
952 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
954 /// Note that after doing so, you very likely (unless you did so very recently) want to call
955 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
956 /// This ensures that any nodes which see our channel_announcement also have a relevant
957 /// node_announcement, including relevant feature flags which may be important for routing
958 /// through or to us.
959 BroadcastChannelAnnouncement {
960 /// The channel_announcement which should be sent.
961 msg: msgs::ChannelAnnouncement,
962 /// The followup channel_update which should be sent.
963 update_msg: msgs::ChannelUpdate,
965 /// Used to indicate that a node_announcement should be broadcast to all peers.
966 BroadcastNodeAnnouncement {
967 /// The node_announcement which should be sent.
968 msg: msgs::NodeAnnouncement,
970 /// Used to indicate that a channel_update should be broadcast to all peers.
971 BroadcastChannelUpdate {
972 /// The channel_update which should be sent.
973 msg: msgs::ChannelUpdate,
975 /// Used to indicate that a channel_update should be sent to a single peer.
976 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
977 /// private channel and we shouldn't be informing all of our peers of channel parameters.
979 /// The node_id of the node which should receive this message
981 /// The channel_update which should be sent.
982 msg: msgs::ChannelUpdate,
984 /// Broadcast an error downstream to be handled
986 /// The node_id of the node which should receive this message
988 /// The action which should be taken.
989 action: msgs::ErrorAction
991 /// Query a peer for channels with funding transaction UTXOs in a block range.
992 SendChannelRangeQuery {
993 /// The node_id of this message recipient
995 /// The query_channel_range which should be sent.
996 msg: msgs::QueryChannelRange,
998 /// Request routing gossip messages from a peer for a list of channels identified by
999 /// their short_channel_ids.
1001 /// The node_id of this message recipient
1003 /// The query_short_channel_ids which should be sent.
1004 msg: msgs::QueryShortChannelIds,
1006 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
1007 /// emitted during processing of the query.
1008 SendReplyChannelRange {
1009 /// The node_id of this message recipient
1011 /// The reply_channel_range which should be sent.
1012 msg: msgs::ReplyChannelRange,
1014 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
1015 /// enable receiving gossip messages from the peer.
1016 SendGossipTimestampFilter {
1017 /// The node_id of this message recipient
1019 /// The gossip_timestamp_filter which should be sent.
1020 msg: msgs::GossipTimestampFilter,
1024 /// A trait indicating an object may generate message send events
1025 pub trait MessageSendEventsProvider {
1026 /// Gets the list of pending events which were generated by previous actions, clearing the list
1028 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
1031 /// A trait indicating an object may generate events.
1033 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
1037 /// See [`process_pending_events`] for requirements around event processing.
1039 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
1040 /// event since the last invocation. The handler must either act upon the event immediately
1041 /// or preserve it for later handling.
1043 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
1044 /// consult the provider's documentation on the implication of processing events and how a handler
1045 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
1046 /// [`ChainMonitor::process_pending_events`]).
1048 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
1051 /// [`process_pending_events`]: Self::process_pending_events
1052 /// [`handle_event`]: EventHandler::handle_event
1053 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
1054 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
1055 pub trait EventsProvider {
1056 /// Processes any events generated since the last call using the given event handler.
1058 /// Subsequent calls must only process new events. However, handlers must be capable of handling
1059 /// duplicate events across process restarts. This may occur if the provider was recovered from
1060 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
1061 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1064 /// A trait implemented for objects handling events from [`EventsProvider`].
1065 pub trait EventHandler {
1066 /// Handles the given [`Event`].
1068 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1069 fn handle_event(&self, event: &Event);
1072 impl<F> EventHandler for F where F: Fn(&Event) {
1073 fn handle_event(&self, event: &Event) {
1078 impl<T: EventHandler> EventHandler for Arc<T> {
1079 fn handle_event(&self, event: &Event) {
1080 self.deref().handle_event(event)