1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Events are returned from various bits in the library which indicate some action must be taken
13 //! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
14 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
17 use chain::keysinterface::SpendableOutputDescriptor;
18 use ln::channelmanager::PaymentId;
19 use ln::channel::FUNDING_CONF_DEADLINE_BLOCKS;
20 use ln::features::ChannelTypeFeatures;
22 use ln::msgs::DecodeError;
23 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
24 use routing::network_graph::NetworkUpdate;
25 use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
26 use routing::router::{RouteHop, RouteParameters};
28 use bitcoin::Transaction;
29 use bitcoin::blockdata::script::Script;
30 use bitcoin::hashes::Hash;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::secp256k1::PublicKey;
35 use core::time::Duration;
39 /// Some information provided on receipt of payment depends on whether the payment received is a
40 /// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
41 #[derive(Clone, Debug)]
42 pub enum PaymentPurpose {
43 /// Information for receiving a payment that we generated an invoice for.
45 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
46 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
47 /// [`ChannelManager::claim_funds`].
49 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
50 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
51 payment_preimage: Option<PaymentPreimage>,
52 /// The "payment secret". This authenticates the sender to the recipient, preventing a
53 /// number of deanonymization attacks during the routing process.
54 /// It is provided here for your reference, however its accuracy is enforced directly by
55 /// [`ChannelManager`] using the values you previously provided to
56 /// [`ChannelManager::create_inbound_payment`] or
57 /// [`ChannelManager::create_inbound_payment_for_hash`].
59 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
60 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
61 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
62 payment_secret: PaymentSecret,
64 /// Because this is a spontaneous payment, the payer generated their own preimage rather than us
65 /// (the payee) providing a preimage.
66 SpontaneousPayment(PaymentPreimage),
69 #[derive(Clone, Debug, PartialEq)]
70 /// The reason the channel was closed. See individual variants more details.
71 pub enum ClosureReason {
72 /// Closure generated from receiving a peer error message.
74 /// Our counterparty may have broadcasted their latest commitment state, and we have
76 CounterpartyForceClosed {
77 /// The error which the peer sent us.
79 /// The string should be sanitized before it is used (e.g emitted to logs
80 /// or printed to stdout). Otherwise, a well crafted error message may exploit
81 /// a security vulnerability in the terminal emulator or the logging subsystem.
84 /// Closure generated from [`ChannelManager::force_close_channel`], called by the user.
86 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
88 /// The channel was closed after negotiating a cooperative close and we've now broadcasted
89 /// the cooperative close transaction. Note the shutdown may have been initiated by us.
90 //TODO: split between CounterpartyInitiated/LocallyInitiated
92 /// A commitment transaction was confirmed on chain, closing the channel. Most likely this
93 /// commitment transaction came from our counterparty, but it may also have come from
94 /// a copy of our own `ChannelMonitor`.
95 CommitmentTxConfirmed,
96 /// The funding transaction failed to confirm in a timely manner on an inbound channel.
98 /// Closure generated from processing an event, likely a HTLC forward/relay/reception.
100 /// A developer-readable error message which we generated.
103 /// The peer disconnected prior to funding completing. In this case the spec mandates that we
104 /// forget the channel entirely - we can attempt again if the peer reconnects.
106 /// In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the
107 /// peer because of mutual incompatibility between us and our channel counterparty.
109 /// Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
110 /// the ChannelManager deserialized.
111 OutdatedChannelManager
114 impl core::fmt::Display for ClosureReason {
115 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
116 f.write_str("Channel closed because ")?;
118 ClosureReason::CounterpartyForceClosed { peer_msg } => {
119 f.write_str("counterparty force-closed with message ")?;
120 f.write_str(&peer_msg)
122 ClosureReason::HolderForceClosed => f.write_str("user manually force-closed the channel"),
123 ClosureReason::CooperativeClosure => f.write_str("the channel was cooperatively closed"),
124 ClosureReason::CommitmentTxConfirmed => f.write_str("commitment or closing transaction was confirmed on chain."),
125 ClosureReason::FundingTimedOut => write!(f, "funding transaction failed to confirm within {} blocks", FUNDING_CONF_DEADLINE_BLOCKS),
126 ClosureReason::ProcessingError { err } => {
127 f.write_str("of an exception: ")?;
130 ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
131 ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
136 impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
137 (0, CounterpartyForceClosed) => { (1, peer_msg, required) },
138 (1, FundingTimedOut) => {},
139 (2, HolderForceClosed) => {},
140 (6, CommitmentTxConfirmed) => {},
141 (4, CooperativeClosure) => {},
142 (8, ProcessingError) => { (1, err, required) },
143 (10, DisconnectedPeer) => {},
144 (12, OutdatedChannelManager) => {},
147 /// An Event which you should probably take some action in response to.
149 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
150 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
151 /// written as it makes no sense to respond to it after reconnecting to peers).
152 #[derive(Clone, Debug)]
154 /// Used to indicate that the client should generate a funding transaction with the given
155 /// parameters and then call [`ChannelManager::funding_transaction_generated`].
156 /// Generated in [`ChannelManager`] message handling.
157 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
158 /// counterparty can steal your funds!
160 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
161 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
162 FundingGenerationReady {
163 /// The random channel_id we picked which you'll need to pass into
164 /// [`ChannelManager::funding_transaction_generated`].
166 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
167 temporary_channel_id: [u8; 32],
168 /// The counterparty's node_id, which you'll need to pass back into
169 /// [`ChannelManager::funding_transaction_generated`].
171 /// [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
172 counterparty_node_id: PublicKey,
173 /// The value, in satoshis, that the output should have.
174 channel_value_satoshis: u64,
175 /// The script which should be used in the transaction output.
176 output_script: Script,
177 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
178 /// an inbound channel.
180 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
181 user_channel_id: u64,
183 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
184 /// [`ChannelManager::claim_funds`] to get it....
185 /// Note that if the preimage is not known, you should call
186 /// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
187 /// network congestion.
188 /// If you fail to call either [`ChannelManager::claim_funds`] or
189 /// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
190 /// automatically failed.
193 /// LDK will not stop an inbound payment from being paid multiple times, so multiple
194 /// `PaymentReceived` events may be generated for the same payment.
196 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
197 /// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
199 /// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
200 /// not stop you from registering duplicate payment hashes for inbound payments.
201 payment_hash: PaymentHash,
202 /// The value, in thousandths of a satoshi, that this payment is for.
204 /// Information for claiming this received payment, based on whether the purpose of the
205 /// payment is to pay an invoice or to send a spontaneous payment.
206 purpose: PaymentPurpose,
208 /// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
209 /// and we got back the payment preimage for it).
211 /// Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
212 /// event. In this situation, you SHOULD treat this payment as having succeeded.
214 /// The id returned by [`ChannelManager::send_payment`] and used with
215 /// [`ChannelManager::retry_payment`].
217 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
218 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
219 payment_id: Option<PaymentId>,
220 /// The preimage to the hash given to ChannelManager::send_payment.
221 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
222 /// store it somehow!
223 payment_preimage: PaymentPreimage,
224 /// The hash that was given to [`ChannelManager::send_payment`].
226 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
227 payment_hash: PaymentHash,
228 /// The total fee which was spent at intermediate hops in this payment, across all paths.
230 /// Note that, like [`Route::get_total_fees`] this does *not* include any potential
231 /// overpayment to the recipient node.
233 /// If the recipient or an intermediate node misbehaves and gives us free money, this may
234 /// overstate the amount paid, though this is unlikely.
236 /// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
237 fee_paid_msat: Option<u64>,
239 /// Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
240 /// provide failure information for each MPP part in the payment.
242 /// This event is provided once there are no further pending HTLCs for the payment and the
243 /// payment is no longer retryable, either due to a several-block timeout or because
244 /// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
246 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
248 /// The id returned by [`ChannelManager::send_payment`] and used with
249 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
251 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
252 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
253 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
254 payment_id: PaymentId,
255 /// The hash that was given to [`ChannelManager::send_payment`].
257 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
258 payment_hash: PaymentHash,
260 /// Indicates that a path for an outbound payment was successful.
262 /// Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
263 /// [`Event::PaymentSent`] for obtaining the payment preimage.
264 PaymentPathSuccessful {
265 /// The id returned by [`ChannelManager::send_payment`] and used with
266 /// [`ChannelManager::retry_payment`].
268 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
269 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
270 payment_id: PaymentId,
271 /// The hash that was given to [`ChannelManager::send_payment`].
273 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
274 payment_hash: Option<PaymentHash>,
275 /// The payment path that was successful.
277 /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
280 /// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
281 /// something. You may wish to retry with a different route.
283 /// Note that this does *not* indicate that all paths for an MPP payment have failed, see
284 /// [`Event::PaymentFailed`] and [`all_paths_failed`].
286 /// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
288 /// The id returned by [`ChannelManager::send_payment`] and used with
289 /// [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
291 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
292 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
293 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
294 payment_id: Option<PaymentId>,
295 /// The hash that was given to [`ChannelManager::send_payment`].
297 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
298 payment_hash: PaymentHash,
299 /// Indicates the payment was rejected for some reason by the recipient. This implies that
300 /// the payment has failed, not just the route in question. If this is not set, you may
301 /// retry the payment via a different route.
302 rejected_by_dest: bool,
303 /// Any failure information conveyed via the Onion return packet by a node along the failed
306 /// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
307 /// account the update. [`NetGraphMsgHandler`] is capable of doing this.
309 /// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
310 /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
311 network_update: Option<NetworkUpdate>,
312 /// For both single-path and multi-path payments, this is set if all paths of the payment have
313 /// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
314 /// larger MPP payment were still in flight when this event was generated.
316 /// Note that if you are retrying individual MPP parts, using this value to determine if a
317 /// payment has fully failed is race-y. Because multiple failures can happen prior to events
318 /// being processed, you may retry in response to a first failure, with a second failure
319 /// (with `all_paths_failed` set) still pending. Then, when the second failure is processed
320 /// you will see `all_paths_failed` set even though the retry of the first failure still
321 /// has an associated in-flight HTLC. See (1) for an example of such a failure.
323 /// If you wish to retry individual MPP parts and learn when a payment has failed, you must
324 /// call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
326 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
328 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
329 all_paths_failed: bool,
330 /// The payment path that failed.
332 /// The channel responsible for the failed payment path.
334 /// If this is `Some`, then the corresponding channel should be avoided when the payment is
335 /// retried. May be `None` for older [`Event`] serializations.
336 short_channel_id: Option<u64>,
337 /// Parameters needed to compute a new [`Route`] when retrying the failed payment path.
339 /// See [`find_route`] for details.
341 /// [`Route`]: crate::routing::router::Route
342 /// [`find_route`]: crate::routing::router::find_route
343 retry: Option<RouteParameters>,
345 error_code: Option<u16>,
347 error_data: Option<Vec<u8>>,
349 /// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
350 /// a time in the future.
352 /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
353 PendingHTLCsForwardable {
354 /// The minimum amount of time that should be waited prior to calling
355 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
356 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
357 /// now + 5*time_forwardable).
358 time_forwardable: Duration,
360 /// Used to indicate that an output which you should know how to spend was confirmed on chain
361 /// and is now spendable.
362 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
363 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
364 /// somewhere and spend them when you create on-chain transactions.
366 /// The outputs which you should store as spendable by you.
367 outputs: Vec<SpendableOutputDescriptor>,
369 /// This event is generated when a payment has been successfully forwarded through us and a
370 /// forwarding fee earned.
372 /// The incoming channel between the previous node and us. This is only `None` for events
373 /// generated or serialized by versions prior to 0.0.107.
374 prev_channel_id: Option<[u8; 32]>,
375 /// The outgoing channel between the next node and us. This is only `None` for events
376 /// generated or serialized by versions prior to 0.0.107.
377 next_channel_id: Option<[u8; 32]>,
378 /// The fee, in milli-satoshis, which was earned as a result of the payment.
380 /// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
381 /// was pending, the amount the next hop claimed will have been rounded down to the nearest
382 /// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
383 /// claimed the full value in millisatoshis from the source. In this case,
384 /// `claim_from_onchain_tx` will be set.
386 /// If the channel which sent us the payment has been force-closed, we will claim the funds
387 /// via an on-chain transaction. In that case we do not yet know the on-chain transaction
388 /// fees which we will spend and will instead set this to `None`. It is possible duplicate
389 /// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
391 fee_earned_msat: Option<u64>,
392 /// If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
394 claim_from_onchain_tx: bool,
396 /// Used to indicate that a channel with the given `channel_id` is in the process of closure.
398 /// The channel_id of the channel which has been closed. Note that on-chain transactions
399 /// resolving the channel are likely still awaiting confirmation.
400 channel_id: [u8; 32],
401 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
402 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
403 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
404 /// `user_channel_id` will be 0 for an inbound channel.
405 /// This will always be zero for objects serialized with LDK versions prior to 0.0.102.
407 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
408 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
409 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
410 user_channel_id: u64,
411 /// The reason the channel was closed.
412 reason: ClosureReason
414 /// Used to indicate to the user that they can abandon the funding transaction and recycle the
415 /// inputs for another purpose.
417 /// The channel_id of the channel which has been closed.
418 channel_id: [u8; 32],
419 /// The full transaction received from the user
420 transaction: Transaction
422 /// Indicates a request to open a new channel by a peer.
424 /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
425 /// request, call [`ChannelManager::force_close_channel`].
427 /// The event is only triggered when a new open channel request is received and the
428 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
430 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
431 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
432 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
434 /// The temporary channel ID of the channel requested to be opened.
436 /// When responding to the request, the `temporary_channel_id` should be passed
437 /// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
438 /// or through [`ChannelManager::force_close_channel`] to reject.
440 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
441 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
442 temporary_channel_id: [u8; 32],
443 /// The node_id of the counterparty requesting to open the channel.
445 /// When responding to the request, the `counterparty_node_id` should be passed
446 /// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
447 /// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
450 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
451 /// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
452 counterparty_node_id: PublicKey,
453 /// The channel value of the requested channel.
454 funding_satoshis: u64,
455 /// Our starting balance in the channel if the request is accepted, in milli-satoshi.
457 /// The features that this channel will operate with. If you reject the channel, a
458 /// well-behaved counterparty may automatically re-attempt the channel with a new set of
461 /// Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
462 /// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
465 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
466 channel_type: ChannelTypeFeatures,
470 impl Writeable for Event {
471 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
473 &Event::FundingGenerationReady { .. } => {
475 // We never write out FundingGenerationReady events as, upon disconnection, peers
476 // drop any channels which have not yet exchanged funding_signed.
478 &Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
480 let mut payment_secret = None;
481 let payment_preimage;
483 PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
484 payment_secret = Some(secret);
485 payment_preimage = *preimage;
487 PaymentPurpose::SpontaneousPayment(preimage) => {
488 payment_preimage = Some(*preimage);
491 write_tlv_fields!(writer, {
492 (0, payment_hash, required),
493 (2, payment_secret, option),
495 (6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
496 (8, payment_preimage, option),
499 &Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
501 write_tlv_fields!(writer, {
502 (0, payment_preimage, required),
503 (1, payment_hash, required),
504 (3, payment_id, option),
505 (5, fee_paid_msat, option),
508 &Event::PaymentPathFailed {
509 ref payment_id, ref payment_hash, ref rejected_by_dest, ref network_update,
510 ref all_paths_failed, ref path, ref short_channel_id, ref retry,
518 error_code.write(writer)?;
520 error_data.write(writer)?;
521 write_tlv_fields!(writer, {
522 (0, payment_hash, required),
523 (1, network_update, option),
524 (2, rejected_by_dest, required),
525 (3, all_paths_failed, required),
527 (7, short_channel_id, option),
529 (11, payment_id, option),
532 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
534 // Note that we now ignore these on the read end as we'll re-generate them in
535 // ChannelManager, we write them here only for backwards compatibility.
537 &Event::SpendableOutputs { ref outputs } => {
539 write_tlv_fields!(writer, {
540 (0, VecWriteWrapper(outputs), required),
543 &Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
545 write_tlv_fields!(writer, {
546 (0, fee_earned_msat, option),
547 (1, prev_channel_id, option),
548 (2, claim_from_onchain_tx, required),
549 (3, next_channel_id, option),
552 &Event::ChannelClosed { ref channel_id, ref user_channel_id, ref reason } => {
554 write_tlv_fields!(writer, {
555 (0, channel_id, required),
556 (1, user_channel_id, required),
557 (2, reason, required)
560 &Event::DiscardFunding { ref channel_id, ref transaction } => {
562 write_tlv_fields!(writer, {
563 (0, channel_id, required),
564 (2, transaction, required)
567 &Event::PaymentPathSuccessful { ref payment_id, ref payment_hash, ref path } => {
569 write_tlv_fields!(writer, {
570 (0, payment_id, required),
571 (2, payment_hash, option),
575 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
577 write_tlv_fields!(writer, {
578 (0, payment_id, required),
579 (2, payment_hash, required),
582 &Event::OpenChannelRequest { .. } => {
584 // We never write the OpenChannelRequest events as, upon disconnection, peers
585 // drop any channels which have not yet exchanged funding_signed.
587 // Note that, going forward, all new events must only write data inside of
588 // `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
589 // data via `write_tlv_fields`.
594 impl MaybeReadable for Event {
595 fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
596 match Readable::read(reader)? {
597 // Note that we do not write a length-prefixed TLV for FundingGenerationReady events,
598 // unlike all other events, thus we return immediately here.
602 let mut payment_hash = PaymentHash([0; 32]);
603 let mut payment_preimage = None;
604 let mut payment_secret = None;
606 let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
607 read_tlv_fields!(reader, {
608 (0, payment_hash, required),
609 (2, payment_secret, option),
611 (6, _user_payment_id, option),
612 (8, payment_preimage, option),
614 let purpose = match payment_secret {
615 Some(secret) => PaymentPurpose::InvoicePayment {
617 payment_secret: secret
619 None if payment_preimage.is_some() => PaymentPurpose::SpontaneousPayment(payment_preimage.unwrap()),
620 None => return Err(msgs::DecodeError::InvalidValue),
622 Ok(Some(Event::PaymentReceived {
632 let mut payment_preimage = PaymentPreimage([0; 32]);
633 let mut payment_hash = None;
634 let mut payment_id = None;
635 let mut fee_paid_msat = None;
636 read_tlv_fields!(reader, {
637 (0, payment_preimage, required),
638 (1, payment_hash, option),
639 (3, payment_id, option),
640 (5, fee_paid_msat, option),
642 if payment_hash.is_none() {
643 payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()));
645 Ok(Some(Event::PaymentSent {
648 payment_hash: payment_hash.unwrap(),
657 let error_code = Readable::read(reader)?;
659 let error_data = Readable::read(reader)?;
660 let mut payment_hash = PaymentHash([0; 32]);
661 let mut rejected_by_dest = false;
662 let mut network_update = None;
663 let mut all_paths_failed = Some(true);
664 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
665 let mut short_channel_id = None;
666 let mut retry = None;
667 let mut payment_id = None;
668 read_tlv_fields!(reader, {
669 (0, payment_hash, required),
670 (1, network_update, ignorable),
671 (2, rejected_by_dest, required),
672 (3, all_paths_failed, option),
674 (7, short_channel_id, option),
676 (11, payment_id, option),
678 Ok(Some(Event::PaymentPathFailed {
683 all_paths_failed: all_paths_failed.unwrap(),
698 let mut outputs = VecReadWrapper(Vec::new());
699 read_tlv_fields!(reader, {
700 (0, outputs, required),
702 Ok(Some(Event::SpendableOutputs { outputs: outputs.0 }))
708 let mut fee_earned_msat = None;
709 let mut prev_channel_id = None;
710 let mut claim_from_onchain_tx = false;
711 let mut next_channel_id = None;
712 read_tlv_fields!(reader, {
713 (0, fee_earned_msat, option),
714 (1, prev_channel_id, option),
715 (2, claim_from_onchain_tx, required),
716 (3, next_channel_id, option),
718 Ok(Some(Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id }))
724 let mut channel_id = [0; 32];
725 let mut reason = None;
726 let mut user_channel_id_opt = None;
727 read_tlv_fields!(reader, {
728 (0, channel_id, required),
729 (1, user_channel_id_opt, option),
730 (2, reason, ignorable),
732 if reason.is_none() { return Ok(None); }
733 let user_channel_id = if let Some(id) = user_channel_id_opt { id } else { 0 };
734 Ok(Some(Event::ChannelClosed { channel_id, user_channel_id, reason: reason.unwrap() }))
740 let mut channel_id = [0; 32];
741 let mut transaction = Transaction{ version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
742 read_tlv_fields!(reader, {
743 (0, channel_id, required),
744 (2, transaction, required),
746 Ok(Some(Event::DiscardFunding { channel_id, transaction } ))
752 let mut payment_id = PaymentId([0; 32]);
753 let mut payment_hash = None;
754 let mut path: Option<Vec<RouteHop>> = Some(vec![]);
755 read_tlv_fields!(reader, {
756 (0, payment_id, required),
757 (2, payment_hash, option),
760 Ok(Some(Event::PaymentPathSuccessful {
770 let mut payment_hash = PaymentHash([0; 32]);
771 let mut payment_id = PaymentId([0; 32]);
772 read_tlv_fields!(reader, {
773 (0, payment_id, required),
774 (2, payment_hash, required),
776 Ok(Some(Event::PaymentFailed {
784 // Value 17 is used for `Event::OpenChannelRequest`.
787 // Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
788 // Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
791 // If the event is of unknown type, assume it was written with `write_tlv_fields`,
792 // which prefixes the whole thing with a length BigSize. Because the event is
793 // odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
794 // fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
795 // exactly the number of bytes specified, ignoring them entirely.
796 let tlv_len: BigSize = Readable::read(reader)?;
797 FixedLengthReader::new(reader, tlv_len.0)
798 .eat_remaining().map_err(|_| msgs::DecodeError::ShortRead)?;
801 _ => Err(msgs::DecodeError::InvalidValue)
806 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
807 /// broadcast to most peers).
808 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
809 #[derive(Clone, Debug)]
810 pub enum MessageSendEvent {
811 /// Used to indicate that we've accepted a channel open and should send the accept_channel
812 /// message provided to the given peer.
814 /// The node_id of the node which should receive this message
816 /// The message which should be sent.
817 msg: msgs::AcceptChannel,
819 /// Used to indicate that we've initiated a channel open and should send the open_channel
820 /// message provided to the given peer.
822 /// The node_id of the node which should receive this message
824 /// The message which should be sent.
825 msg: msgs::OpenChannel,
827 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
829 /// The node_id of the node which should receive this message
831 /// The message which should be sent.
832 msg: msgs::FundingCreated,
834 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
836 /// The node_id of the node which should receive this message
838 /// The message which should be sent.
839 msg: msgs::FundingSigned,
841 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
843 /// The node_id of the node which should receive these message(s)
845 /// The funding_locked message which should be sent.
846 msg: msgs::FundingLocked,
848 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
849 SendAnnouncementSignatures {
850 /// The node_id of the node which should receive these message(s)
852 /// The announcement_signatures message which should be sent.
853 msg: msgs::AnnouncementSignatures,
855 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
856 /// message should be sent to the peer with the given node_id.
858 /// The node_id of the node which should receive these message(s)
860 /// The update messages which should be sent. ALL messages in the struct should be sent!
861 updates: msgs::CommitmentUpdate,
863 /// Used to indicate that a revoke_and_ack 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.
868 msg: msgs::RevokeAndACK,
870 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
872 /// The node_id of the node which should receive this message
874 /// The message which should be sent.
875 msg: msgs::ClosingSigned,
877 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
879 /// The node_id of the node which should receive this message
881 /// The message which should be sent.
884 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
885 SendChannelReestablish {
886 /// The node_id of the node which should receive this message
888 /// The message which should be sent.
889 msg: msgs::ChannelReestablish,
891 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
892 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
894 /// Note that after doing so, you very likely (unless you did so very recently) want to call
895 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
896 /// This ensures that any nodes which see our channel_announcement also have a relevant
897 /// node_announcement, including relevant feature flags which may be important for routing
898 /// through or to us.
899 BroadcastChannelAnnouncement {
900 /// The channel_announcement which should be sent.
901 msg: msgs::ChannelAnnouncement,
902 /// The followup channel_update which should be sent.
903 update_msg: msgs::ChannelUpdate,
905 /// Used to indicate that a node_announcement should be broadcast to all peers.
906 BroadcastNodeAnnouncement {
907 /// The node_announcement which should be sent.
908 msg: msgs::NodeAnnouncement,
910 /// Used to indicate that a channel_update should be broadcast to all peers.
911 BroadcastChannelUpdate {
912 /// The channel_update which should be sent.
913 msg: msgs::ChannelUpdate,
915 /// Used to indicate that a channel_update should be sent to a single peer.
916 /// In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
917 /// private channel and we shouldn't be informing all of our peers of channel parameters.
919 /// The node_id of the node which should receive this message
921 /// The channel_update which should be sent.
922 msg: msgs::ChannelUpdate,
924 /// Broadcast an error downstream to be handled
926 /// The node_id of the node which should receive this message
928 /// The action which should be taken.
929 action: msgs::ErrorAction
931 /// Query a peer for channels with funding transaction UTXOs in a block range.
932 SendChannelRangeQuery {
933 /// The node_id of this message recipient
935 /// The query_channel_range which should be sent.
936 msg: msgs::QueryChannelRange,
938 /// Request routing gossip messages from a peer for a list of channels identified by
939 /// their short_channel_ids.
941 /// The node_id of this message recipient
943 /// The query_short_channel_ids which should be sent.
944 msg: msgs::QueryShortChannelIds,
946 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
947 /// emitted during processing of the query.
948 SendReplyChannelRange {
949 /// The node_id of this message recipient
951 /// The reply_channel_range which should be sent.
952 msg: msgs::ReplyChannelRange,
954 /// Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
955 /// enable receiving gossip messages from the peer.
956 SendGossipTimestampFilter {
957 /// The node_id of this message recipient
959 /// The gossip_timestamp_filter which should be sent.
960 msg: msgs::GossipTimestampFilter,
964 /// A trait indicating an object may generate message send events
965 pub trait MessageSendEventsProvider {
966 /// Gets the list of pending events which were generated by previous actions, clearing the list
968 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
971 /// A trait indicating an object may generate events.
973 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
977 /// See [`process_pending_events`] for requirements around event processing.
979 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
980 /// event since the last invocation. The handler must either act upon the event immediately
981 /// or preserve it for later handling.
983 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
984 /// consult the provider's documentation on the implication of processing events and how a handler
985 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
986 /// [`ChainMonitor::process_pending_events`]).
988 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
991 /// [`process_pending_events`]: Self::process_pending_events
992 /// [`handle_event`]: EventHandler::handle_event
993 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
994 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
995 pub trait EventsProvider {
996 /// Processes any events generated since the last call using the given event handler.
998 /// Subsequent calls must only process new events. However, handlers must be capable of handling
999 /// duplicate events across process restarts. This may occur if the provider was recovered from
1000 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
1001 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
1004 /// A trait implemented for objects handling events from [`EventsProvider`].
1005 pub trait EventHandler {
1006 /// Handles the given [`Event`].
1008 /// See [`EventsProvider`] for details that must be considered when implementing this method.
1009 fn handle_event(&self, event: &Event);
1012 impl<F> EventHandler for F where F: Fn(&Event) {
1013 fn handle_event(&self, event: &Event) {
1018 impl<T: EventHandler> EventHandler for Arc<T> {
1019 fn handle_event(&self, event: &Event) {
1020 self.deref().handle_event(event)