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 `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`].
167 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
168 temporary_channel_id: [u8; 32],
169 /// The counterparty's node_id, which you'll need to pass back into
170 /// [`ChannelManager::funding_transaction_generated`].
172 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
173 counterparty_node_id: PublicKey,
174 /// The value, in satoshis, that the output should have.
175 channel_value_satoshis: u64,
176 /// The script which should be used in the transaction output.
177 output_script: Script,
178 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
179 /// an inbound channel.
181 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
182 user_channel_id: u64,
184 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
185 /// [`ChannelManager::claim_funds`] to get it....
186 /// Note that if the preimage is not known, you should call
187 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
188 /// network congestion.
189 /// If you fail to call either [`ChannelManager::claim_funds`] or
190 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
191 /// automatically failed.
194 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
195 /// `PaymentReceived` events may be generated for the same payment.
197 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
198 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
200 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
201 /// not stop you from registering duplicate payment hashes for inbound payments.
202 payment_hash: PaymentHash,
203 /// The value, in thousandths of a satoshi, that this payment is for.
205 /// Information for claiming this received payment, based on whether the purpose of the
206 /// payment is to pay an invoice or to send a spontaneous payment.
207 purpose: PaymentPurpose,
209 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
210 /// and we got back the payment preimage for it).
212 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
213 /// event. In this situation, you SHOULD treat this payment as having succeeded.
215 /// The id returned by [`ChannelManager::send_payment`] and used with
216 /// [`ChannelManager::retry_payment`].
218 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
219 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
220 payment_id: Option<PaymentId>,
221 /// The preimage to the hash given to ChannelManager::send_payment.
222 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
223 /// store it somehow!
224 payment_preimage: PaymentPreimage,
225 /// The hash that was given to [`ChannelManager::send_payment`].
227 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
228 payment_hash: PaymentHash,
229 /// The total fee which was spent at intermediate hops in this payment, across all paths.
231 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
232 /// overpayment to the recipient node.
234 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
235 /// overstate the amount paid, though this is unlikely.
237 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
238 fee_paid_msat: Option<u64>,
240 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
241 /// provide failure information for each MPP part in the payment.
243 /// This event is provided once there are no further pending HTLCs for the payment and the
244 /// payment is no longer retryable, either due to a several-block timeout or because
245 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
247 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
249 /// The id returned by [`ChannelManager::send_payment`] and used with
250 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
252 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
253 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
254 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
255 payment_id: PaymentId,
256 /// The hash that was given to [`ChannelManager::send_payment`].
258 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
259 payment_hash: PaymentHash,
261 /// Indicates that a path for an outbound payment was successful.
263 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
264 /// [`Event::PaymentSent`] for obtaining the payment preimage.
265 PaymentPathSuccessful {
266 /// The id returned by [`ChannelManager::send_payment`] and used with
267 /// [`ChannelManager::retry_payment`].
269 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
270 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
271 payment_id: PaymentId,
272 /// The hash that was given to [`ChannelManager::send_payment`].
274 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
275 payment_hash: Option<PaymentHash>,
276 /// The payment path that was successful.
278 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
281 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
282 /// something. You may wish to retry with a different route.
284 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
285 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
287 /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
289 /// The id returned by [`ChannelManager::send_payment`] and used with
290 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
292 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
293 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
294 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
295 payment_id: Option<PaymentId>,
296 /// The hash that was given to [`ChannelManager::send_payment`].
298 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
299 payment_hash: PaymentHash,
300 /// Indicates the payment was rejected for some reason by the recipient. This implies that
301 /// the payment has failed, not just the route in question. If this is not set, you may
302 /// retry the payment via a different route.
303 rejected_by_dest: bool,
304 /// Any failure information conveyed via the Onion return packet by a node along the failed
307 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
308 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
310 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
311 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
312 network_update: Option<NetworkUpdate>,
313 /// For both single-path and multi-path payments, this is set if all paths of the payment have
314 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
315 /// larger MPP payment were still in flight when this event was generated.
317 /// Note that if you are retrying individual MPP parts, using this value to determine if a
318 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
319 /// being processed, you may retry in response to a first failure, with a second failure
320 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
321 /// you will see `all_paths_failed` set even though the retry of the first failure still
322 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
324 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
325 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
327 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
329 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
330 all_paths_failed: bool,
331 /// The payment path that failed.
333 /// The channel responsible for the failed payment path.
335 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
336 /// retried. May be `None` for older [`Event`] serializations.
337 short_channel_id: Option<u64>,
338 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
340 /// See [`find_route`] for details.
342 /// [`Route`]: crate::routing::router::Route
343 /// [`find_route`]: crate::routing::router::find_route
344 retry: Option<RouteParameters>,
346 error_code: Option<u16>,
348 error_data: Option<Vec<u8>>,
350 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
351 /// a time in the future.
353 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
354 PendingHTLCsForwardable {
355 /// The minimum amount of time that should be waited prior to calling
356 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
357 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
358 /// now + 5*time_forwardable).
359 time_forwardable: Duration,
361 /// Used to indicate that an output which you should know how to spend was confirmed on chain
362 /// and is now spendable.
363 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
364 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
365 /// somewhere and spend them when you create on-chain transactions.
367 /// The outputs which you should store as spendable by you.
368 outputs: Vec<SpendableOutputDescriptor>,
370 /// This event is generated when a payment has been successfully forwarded through us and a
371 /// forwarding fee earned.
373 /// The channel between the source node and us. Optional because versions prior to 0.0.107
374 /// do not serialize this field.
375 source_channel_id: Option<[u8; 32]>,
376 /// The fee, in milli-satoshis, which was earned as a result of the payment.
378 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
379 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
380 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
381 /// claimed the full value in millisatoshis from the source. In this case,
382 /// `claim_from_onchain_tx` will be set.
384 /// If the channel which sent us the payment has been force-closed, we will claim the funds
385 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
386 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
387 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
389 fee_earned_msat: Option<u64>,
390 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
392 claim_from_onchain_tx: bool,
394 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
396 /// The channel_id of the channel which has been closed. Note that on-chain transactions
397 /// resolving the channel are likely still awaiting confirmation.
398 channel_id: [u8; 32],
399 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
400 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
401 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
402 /// `user_channel_id` will be 0 for an inbound channel.
403 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
405 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
406 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
407 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
408 user_channel_id: u64,
409 /// The reason the channel was closed.
410 reason: ClosureReason
412 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
413 /// inputs for another purpose.
415 /// The channel_id of the channel which has been closed.
416 channel_id: [u8; 32],
417 /// The full transaction received from the user
418 transaction: Transaction
420 /// Indicates a request to open a new channel by a peer.
422 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
423 /// request, call [`ChannelManager::force_close_channel`].
425 /// The event is only triggered when a new open channel request is received and the
426 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
428 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
429 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
430 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
432 /// The temporary channel ID of the channel requested to be opened.
434 /// When responding to the request, the `temporary_channel_id` should be passed
435 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
436 /// or through [`ChannelManager::force_close_channel`] to reject.
438 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
439 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
440 temporary_channel_id: [u8; 32],
441 /// The node_id of the counterparty requesting to open the channel.
443 /// When responding to the request, the `counterparty_node_id` should be passed
444 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
445 /// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
448 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
449 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
450 counterparty_node_id: PublicKey,
451 /// The channel value of the requested channel.
452 funding_satoshis: u64,
453 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
455 /// The features that this channel will operate with. If you reject the channel, a
456 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
459 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
460 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
463 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
464 channel_type: ChannelTypeFeatures,
468 impl Writeable for Event {
469 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
471 &Event::FundingGenerationReady { .. } => {
473 // We never write out FundingGenerationReady events as, upon disconnection, peers
474 // drop any channels which have not yet exchanged funding_signed.
476 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
478 let mut payment_secret = None;
479 let payment_preimage;
481 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
482 payment_secret = Some(secret);
483 payment_preimage = *preimage;
485 PaymentPurpose::SpontaneousPayment(preimage) => {
486 payment_preimage = Some(*preimage);
489 write_tlv_fields!(writer, {
490 (0, payment_hash, required),
491 (2, payment_secret, option),
493 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
494 (8, payment_preimage, option),
497 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
499 write_tlv_fields!(writer, {
500 (0, payment_preimage, required),
501 (1, payment_hash, required),
502 (3, payment_id, option),
503 (5, fee_paid_msat, option),
506 &Event::PaymentPathFailed {
507 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
508 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
516 error_code.write(writer)?;
518 error_data.write(writer)?;
519 write_tlv_fields!(writer, {
520 (0, payment_hash, required),
521 (1, network_update, option),
522 (2, rejected_by_dest, required),
523 (3, all_paths_failed, required),
525 (7, short_channel_id, option),
527 (11, payment_id, option),
530 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
532 // Note that we now ignore these on the read end as we'll re-generate them in
533 // ChannelManager, we write them here only for backwards compatibility.
535 &Event::SpendableOutputs { ref outputs } => {
537 write_tlv_fields!(writer, {
538 (0, VecWriteWrapper(outputs), required),
541 &Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
543 write_tlv_fields!(writer, {
544 (0, fee_earned_msat, option),
545 (1, source_channel_id, option),
546 (2, claim_from_onchain_tx, required),
549 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
551 write_tlv_fields!(writer, {
552 (0, channel_id, required),
553 (1, user_channel_id, required),
554 (2, reason, required)
557 &Event::DiscardFunding { ref channel_id, ref transaction } => {
559 write_tlv_fields!(writer, {
560 (0, channel_id, required),
561 (2, transaction, required)
564 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
566 write_tlv_fields!(writer, {
567 (0, payment_id, required),
568 (2, payment_hash, option),
572 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
574 write_tlv_fields!(writer, {
575 (0, payment_id, required),
576 (2, payment_hash, required),
579 &Event::OpenChannelRequest { .. } => {
581 // We never write the OpenChannelRequest events as, upon disconnection, peers
582 // drop any channels which have not yet exchanged funding_signed.
584 // Note that, going forward, all new events must only write data inside of
585 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
586 // data via `write_tlv_fields`.
591 impl MaybeReadable for Event {
592 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
593 match Readable::read(reader)? {
594 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
595 // unlike all other events, thus we return immediately here.
599 let mut payment_hash = PaymentHash([0; 32]);
600 let mut payment_preimage = None;
601 let mut payment_secret = None;
603 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
604 read_tlv_fields!(reader, {
605 (0, payment_hash, required),
606 (2, payment_secret, option),
608 (6, _user_payment_id, option),
609 (8, payment_preimage, option),
611 let purpose = match payment_secret {
612 Some(secret) => PaymentPurpose::InvoicePayment {
614 payment_secret: secret
616 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
617 None => return Err(msgs::DecodeError::InvalidValue),
619 Ok(Some(Event::PaymentReceived {
629 let mut payment_preimage = PaymentPreimage([0; 32]);
630 let mut payment_hash = None;
631 let mut payment_id = None;
632 let mut fee_paid_msat = None;
633 read_tlv_fields!(reader, {
634 (0, payment_preimage, required),
635 (1, payment_hash, option),
636 (3, payment_id, option),
637 (5, fee_paid_msat, option),
639 if payment_hash.is_none() {
640 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
642 Ok(Some(Event::PaymentSent {
645 payment_hash: payment_hash.unwrap(),
654 let error_code = Readable::read(reader)?;
656 let error_data = Readable::read(reader)?;
657 let mut payment_hash = PaymentHash([0; 32]);
658 let mut rejected_by_dest = false;
659 let mut network_update = None;
660 let mut all_paths_failed = Some(true);
661 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
662 let mut short_channel_id = None;
663 let mut retry = None;
664 let mut payment_id = None;
665 read_tlv_fields!(reader, {
666 (0, payment_hash, required),
667 (1, network_update, ignorable),
668 (2, rejected_by_dest, required),
669 (3, all_paths_failed, option),
671 (7, short_channel_id, option),
673 (11, payment_id, option),
675 Ok(Some(Event::PaymentPathFailed {
680 all_paths_failed: all_paths_failed.unwrap(),
695 let mut outputs = VecReadWrapper(Vec::new());
696 read_tlv_fields!(reader, {
697 (0, outputs, required),
699 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
705 let mut fee_earned_msat = None;
706 let mut source_channel_id = None;
707 let mut claim_from_onchain_tx = false;
708 read_tlv_fields!(reader, {
709 (0, fee_earned_msat, option),
710 (1, source_channel_id, option),
711 (2, claim_from_onchain_tx, required),
713 Ok(Some(Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx }))
719 let mut channel_id = [0; 32];
720 let mut reason = None;
721 let mut user_channel_id_opt = None;
722 read_tlv_fields!(reader, {
723 (0, channel_id, required),
724 (1, user_channel_id_opt, option),
725 (2, reason, ignorable),
727 if reason.is_none() { return Ok(None); }
728 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
729 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
735 let mut channel_id = [0; 32];
736 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
737 read_tlv_fields!(reader, {
738 (0, channel_id, required),
739 (2, transaction, required),
741 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
747 let mut payment_id = PaymentId([0; 32]);
748 let mut payment_hash = None;
749 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
750 read_tlv_fields!(reader, {
751 (0, payment_id, required),
752 (2, payment_hash, option),
755 Ok(Some(Event::PaymentPathSuccessful {
765 let mut payment_hash = PaymentHash([0; 32]);
766 let mut payment_id = PaymentId([0; 32]);
767 read_tlv_fields!(reader, {
768 (0, payment_id, required),
769 (2, payment_hash, required),
771 Ok(Some(Event::PaymentFailed {
779 // Value 17 is used for `Event::OpenChannelRequest`.
782 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
783 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
786 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
787 // which prefixes the whole thing with a length BigSize. Because the event is
788 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
789 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
790 // exactly the number of bytes specified, ignoring them entirely.
791 let tlv_len: BigSize = Readable::read(reader)?;
792 FixedLengthReader::new(reader, tlv_len.0)
793 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
796 _ => Err(msgs::DecodeError::InvalidValue)
801 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
802 /// broadcast to most peers).
803 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
804 #[derive(Clone, Debug)]
805 pub enum MessageSendEvent {
806 /// Used to indicate that we've accepted a channel open and should send the accept_channel
807 /// message provided to the given peer.
809 /// The node_id of the node which should receive this message
811 /// The message which should be sent.
812 msg: msgs::AcceptChannel,
814 /// Used to indicate that we've initiated a channel open and should send the open_channel
815 /// message provided to the given peer.
817 /// The node_id of the node which should receive this message
819 /// The message which should be sent.
820 msg: msgs::OpenChannel,
822 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
824 /// The node_id of the node which should receive this message
826 /// The message which should be sent.
827 msg: msgs::FundingCreated,
829 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
831 /// The node_id of the node which should receive this message
833 /// The message which should be sent.
834 msg: msgs::FundingSigned,
836 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
838 /// The node_id of the node which should receive these message(s)
840 /// The funding_locked message which should be sent.
841 msg: msgs::FundingLocked,
843 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
844 SendAnnouncementSignatures {
845 /// The node_id of the node which should receive these message(s)
847 /// The announcement_signatures message which should be sent.
848 msg: msgs::AnnouncementSignatures,
850 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
851 /// message should be sent to the peer with the given node_id.
853 /// The node_id of the node which should receive these message(s)
855 /// The update messages which should be sent. ALL messages in the struct should be sent!
856 updates: msgs::CommitmentUpdate,
858 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
860 /// The node_id of the node which should receive this message
862 /// The message which should be sent.
863 msg: msgs::RevokeAndACK,
865 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
867 /// The node_id of the node which should receive this message
869 /// The message which should be sent.
870 msg: msgs::ClosingSigned,
872 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
874 /// The node_id of the node which should receive this message
876 /// The message which should be sent.
879 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
880 SendChannelReestablish {
881 /// The node_id of the node which should receive this message
883 /// The message which should be sent.
884 msg: msgs::ChannelReestablish,
886 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
887 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
889 /// Note that after doing so, you very likely (unless you did so very recently) want to call
890 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
891 /// This ensures that any nodes which see our channel_announcement also have a relevant
892 /// node_announcement, including relevant feature flags which may be important for routing
893 /// through or to us.
894 BroadcastChannelAnnouncement {
895 /// The channel_announcement which should be sent.
896 msg: msgs::ChannelAnnouncement,
897 /// The followup channel_update which should be sent.
898 update_msg: msgs::ChannelUpdate,
900 /// Used to indicate that a node_announcement should be broadcast to all peers.
901 BroadcastNodeAnnouncement {
902 /// The node_announcement which should be sent.
903 msg: msgs::NodeAnnouncement,
905 /// Used to indicate that a channel_update should be broadcast to all peers.
906 BroadcastChannelUpdate {
907 /// The channel_update which should be sent.
908 msg: msgs::ChannelUpdate,
910 /// Used to indicate that a channel_update should be sent to a single peer.
911 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
912 /// private channel and we shouldn't be informing all of our peers of channel parameters.
914 /// The node_id of the node which should receive this message
916 /// The channel_update which should be sent.
917 msg: msgs::ChannelUpdate,
919 /// Broadcast an error downstream to be handled
921 /// The node_id of the node which should receive this message
923 /// The action which should be taken.
924 action: msgs::ErrorAction
926 /// Query a peer for channels with funding transaction UTXOs in a block range.
927 SendChannelRangeQuery {
928 /// The node_id of this message recipient
930 /// The query_channel_range which should be sent.
931 msg: msgs::QueryChannelRange,
933 /// Request routing gossip messages from a peer for a list of channels identified by
934 /// their short_channel_ids.
936 /// The node_id of this message recipient
938 /// The query_short_channel_ids which should be sent.
939 msg: msgs::QueryShortChannelIds,
941 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
942 /// emitted during processing of the query.
943 SendReplyChannelRange {
944 /// The node_id of this message recipient
946 /// The reply_channel_range which should be sent.
947 msg: msgs::ReplyChannelRange,
949 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
950 /// enable receiving gossip messages from the peer.
951 SendGossipTimestampFilter {
952 /// The node_id of this message recipient
954 /// The gossip_timestamp_filter which should be sent.
955 msg: msgs::GossipTimestampFilter,
959 /// A trait indicating an object may generate message send events
960 pub trait MessageSendEventsProvider {
961 /// Gets the list of pending events which were generated by previous actions, clearing the list
963 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
966 /// A trait indicating an object may generate events.
968 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
972 /// See [`process_pending_events`] for requirements around event processing.
974 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
975 /// event since the last invocation. The handler must either act upon the event immediately
976 /// or preserve it for later handling.
978 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
979 /// consult the provider's documentation on the implication of processing events and how a handler
980 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
981 /// [`ChainMonitor::process_pending_events`]).
983 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
986 /// [`process_pending_events`]: Self::process_pending_events
987 /// [`handle_event`]: EventHandler::handle_event
988 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
989 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
990 pub trait EventsProvider {
991 /// Processes any events generated since the last call using the given event handler.
993 /// Subsequent calls must only process new events. However, handlers must be capable of handling
994 /// duplicate events across process restarts. This may occur if the provider was recovered from
995 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
996 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
999 /// A trait implemented for objects handling events from [`EventsProvider`].
1000 pub trait EventHandler {
1001 /// Handles the given [`Event`].
1003 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1004 fn handle_event(&self, event: &Event);
1007 impl<F> EventHandler for F where F: Fn(&Event) {
1008 fn handle_event(&self, event: &Event) {
1013 impl<T: EventHandler> EventHandler for Arc<T> {
1014 fn handle_event(&self, event: &Event) {
1015 self.deref().handle_event(event)