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
18 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
19 use chain::keysinterface::SpendableOutputDescriptor;
20 use util::ser::{Writeable, Writer, MaybeReadable, Readable};
22 use bitcoin::blockdata::script::Script;
24 use bitcoin::secp256k1::key::PublicKey;
27 use core::time::Duration;
30 /// An Event which you should probably take some action in response to.
32 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
33 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
34 /// written as it makes no sense to respond to it after reconnecting to peers).
35 #[derive(Clone, Debug)]
37 /// Used to indicate that the client should generate a funding transaction with the given
38 /// parameters and then call ChannelManager::funding_transaction_generated.
39 /// Generated in ChannelManager message handling.
40 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
41 /// counterparty can steal your funds!
42 FundingGenerationReady {
43 /// The random channel_id we picked which you'll need to pass into
44 /// ChannelManager::funding_transaction_generated.
45 temporary_channel_id: [u8; 32],
46 /// The value, in satoshis, that the output should have.
47 channel_value_satoshis: u64,
48 /// The script which should be used in the transaction output.
49 output_script: Script,
50 /// The value passed in to ChannelManager::create_channel
53 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
54 /// ChannelManager::claim_funds to get it....
55 /// Note that if the preimage is not known or the amount paid is incorrect, you should call
56 /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
57 /// network congestion.
58 /// The amount paid should be considered 'incorrect' when it is less than or more than twice
59 /// the amount expected.
60 /// If you fail to call either ChannelManager::claim_funds or
61 /// ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
62 /// automatically failed.
64 /// The hash for which the preimage should be handed to the ChannelManager.
65 payment_hash: PaymentHash,
66 /// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
67 /// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
68 /// [`ChannelManager::claim_funds`].
70 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
71 /// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
72 payment_preimage: Option<PaymentPreimage>,
73 /// The "payment secret". This authenticates the sender to the recipient, preventing a
74 /// number of deanonymization attacks during the routing process.
75 /// It is provided here for your reference, however its accuracy is enforced directly by
76 /// [`ChannelManager`] using the values you previously provided to
77 /// [`ChannelManager::create_inbound_payment`] or
78 /// [`ChannelManager::create_inbound_payment_for_hash`].
80 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
81 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
82 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
83 payment_secret: PaymentSecret,
84 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
85 /// compare this to the expected value before accepting the payment (as otherwise you are
86 /// providing proof-of-payment for less than the value you expected!).
88 /// This is the `user_payment_id` which was provided to
89 /// [`ChannelManager::create_inbound_payment_for_hash`] or
90 /// [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
91 /// simply copied here. It may be used to correlate PaymentReceived events with invoice
92 /// metadata stored elsewhere.
94 /// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
95 /// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
98 /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
99 /// and we got back the payment preimage for it).
101 /// The preimage to the hash given to ChannelManager::send_payment.
102 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
103 /// store it somehow!
104 payment_preimage: PaymentPreimage,
106 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
107 /// something. You may wish to retry with a different route.
109 /// The hash which was given to ChannelManager::send_payment.
110 payment_hash: PaymentHash,
111 /// Indicates the payment was rejected for some reason by the recipient. This implies that
112 /// the payment has failed, not just the route in question. If this is not set, you may
113 /// retry the payment via a different route.
114 rejected_by_dest: bool,
116 error_code: Option<u16>,
118 error_data: Option<Vec<u8>>,
120 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
121 /// time in the future.
122 PendingHTLCsForwardable {
123 /// The minimum amount of time that should be waited prior to calling
124 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
125 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
126 /// now + 5*time_forwardable).
127 time_forwardable: Duration,
129 /// Used to indicate that an output was generated on-chain which you should know how to spend.
130 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
131 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
132 /// somewhere and spend them when you create on-chain transactions.
134 /// The outputs which you should store as spendable by you.
135 outputs: Vec<SpendableOutputDescriptor>,
139 impl Writeable for Event {
140 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
142 &Event::FundingGenerationReady { .. } => {
144 // We never write out FundingGenerationReady events as, upon disconnection, peers
145 // drop any channels which have not yet exchanged funding_signed.
147 &Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, ref amt, ref user_payment_id } => {
149 payment_hash.write(writer)?;
150 payment_preimage.write(writer)?;
151 payment_secret.write(writer)?;
153 user_payment_id.write(writer)?;
155 &Event::PaymentSent { ref payment_preimage } => {
157 payment_preimage.write(writer)?;
159 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest,
166 payment_hash.write(writer)?;
167 rejected_by_dest.write(writer)?;
169 error_code.write(writer)?;
171 error_data.write(writer)?;
173 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
175 // We don't write the time_fordwardable out at all, as we presume when the user
176 // deserializes us at least that much time has elapsed.
178 &Event::SpendableOutputs { ref outputs } => {
180 (outputs.len() as u64).write(writer)?;
181 for output in outputs.iter() {
182 output.write(writer)?;
189 impl MaybeReadable for Event {
190 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
191 match Readable::read(reader)? {
193 1u8 => Ok(Some(Event::PaymentReceived {
194 payment_hash: Readable::read(reader)?,
195 payment_preimage: Readable::read(reader)?,
196 payment_secret: Readable::read(reader)?,
197 amt: Readable::read(reader)?,
198 user_payment_id: Readable::read(reader)?,
200 2u8 => Ok(Some(Event::PaymentSent {
201 payment_preimage: Readable::read(reader)?,
203 3u8 => Ok(Some(Event::PaymentFailed {
204 payment_hash: Readable::read(reader)?,
205 rejected_by_dest: Readable::read(reader)?,
207 error_code: Readable::read(reader)?,
209 error_data: Readable::read(reader)?,
211 4u8 => Ok(Some(Event::PendingHTLCsForwardable {
212 time_forwardable: Duration::from_secs(0)
215 let outputs_len: u64 = Readable::read(reader)?;
216 let mut outputs = Vec::new();
217 for _ in 0..outputs_len {
218 outputs.push(Readable::read(reader)?);
220 Ok(Some(Event::SpendableOutputs { outputs }))
222 _ => Err(msgs::DecodeError::InvalidValue)
227 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
228 /// broadcast to most peers).
229 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
230 #[derive(Clone, Debug)]
231 pub enum MessageSendEvent {
232 /// Used to indicate that we've accepted a channel open and should send the accept_channel
233 /// message provided to the given peer.
235 /// The node_id of the node which should receive this message
237 /// The message which should be sent.
238 msg: msgs::AcceptChannel,
240 /// Used to indicate that we've initiated a channel open and should send the open_channel
241 /// message provided to the given peer.
243 /// The node_id of the node which should receive this message
245 /// The message which should be sent.
246 msg: msgs::OpenChannel,
248 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
250 /// The node_id of the node which should receive this message
252 /// The message which should be sent.
253 msg: msgs::FundingCreated,
255 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
257 /// The node_id of the node which should receive this message
259 /// The message which should be sent.
260 msg: msgs::FundingSigned,
262 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
264 /// The node_id of the node which should receive these message(s)
266 /// The funding_locked message which should be sent.
267 msg: msgs::FundingLocked,
269 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
270 SendAnnouncementSignatures {
271 /// The node_id of the node which should receive these message(s)
273 /// The announcement_signatures message which should be sent.
274 msg: msgs::AnnouncementSignatures,
276 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
277 /// message should be sent to the peer with the given node_id.
279 /// The node_id of the node which should receive these message(s)
281 /// The update messages which should be sent. ALL messages in the struct should be sent!
282 updates: msgs::CommitmentUpdate,
284 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
286 /// The node_id of the node which should receive this message
288 /// The message which should be sent.
289 msg: msgs::RevokeAndACK,
291 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
293 /// The node_id of the node which should receive this message
295 /// The message which should be sent.
296 msg: msgs::ClosingSigned,
298 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
300 /// The node_id of the node which should receive this message
302 /// The message which should be sent.
305 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
306 SendChannelReestablish {
307 /// The node_id of the node which should receive this message
309 /// The message which should be sent.
310 msg: msgs::ChannelReestablish,
312 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
313 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
315 /// Note that after doing so, you very likely (unless you did so very recently) want to call
316 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
317 /// This ensures that any nodes which see our channel_announcement also have a relevant
318 /// node_announcement, including relevant feature flags which may be important for routing
319 /// through or to us.
320 BroadcastChannelAnnouncement {
321 /// The channel_announcement which should be sent.
322 msg: msgs::ChannelAnnouncement,
323 /// The followup channel_update which should be sent.
324 update_msg: msgs::ChannelUpdate,
326 /// Used to indicate that a node_announcement should be broadcast to all peers.
327 BroadcastNodeAnnouncement {
328 /// The node_announcement which should be sent.
329 msg: msgs::NodeAnnouncement,
331 /// Used to indicate that a channel_update should be broadcast to all peers.
332 BroadcastChannelUpdate {
333 /// The channel_update which should be sent.
334 msg: msgs::ChannelUpdate,
336 /// Broadcast an error downstream to be handled
338 /// The node_id of the node which should receive this message
340 /// The action which should be taken.
341 action: msgs::ErrorAction
343 /// When a payment fails we may receive updates back from the hop where it failed. In such
344 /// cases this event is generated so that we can inform the network graph of this information.
345 PaymentFailureNetworkUpdate {
346 /// The channel/node update which should be sent to NetGraphMsgHandler
347 update: msgs::HTLCFailChannelUpdate,
349 /// Query a peer for channels with funding transaction UTXOs in a block range.
350 SendChannelRangeQuery {
351 /// The node_id of this message recipient
353 /// The query_channel_range which should be sent.
354 msg: msgs::QueryChannelRange,
356 /// Request routing gossip messages from a peer for a list of channels identified by
357 /// their short_channel_ids.
359 /// The node_id of this message recipient
361 /// The query_short_channel_ids which should be sent.
362 msg: msgs::QueryShortChannelIds,
364 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
365 /// emitted during processing of the query.
366 SendReplyChannelRange {
367 /// The node_id of this message recipient
369 /// The reply_channel_range which should be sent.
370 msg: msgs::ReplyChannelRange,
374 /// A trait indicating an object may generate message send events
375 pub trait MessageSendEventsProvider {
376 /// Gets the list of pending events which were generated by previous actions, clearing the list
378 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
381 /// A trait indicating an object may generate events.
383 /// Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
387 /// See [`process_pending_events`] for requirements around event processing.
389 /// When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
390 /// event since the last invocation. The handler must either act upon the event immediately
391 /// or preserve it for later handling.
393 /// Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
394 /// consult the provider's documentation on the implication of processing events and how a handler
395 /// may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
396 /// [`ChainMonitor::process_pending_events`]).
398 /// (C-not implementable) As there is likely no reason for a user to implement this trait on their
401 /// [`process_pending_events`]: Self::process_pending_events
402 /// [`handle_event`]: EventHandler::handle_event
403 /// [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
404 /// [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
405 pub trait EventsProvider {
406 /// Processes any events generated since the last call using the given event handler.
408 /// Subsequent calls must only process new events. However, handlers must be capable of handling
409 /// duplicate events across process restarts. This may occur if the provider was recovered from
410 /// an old state (i.e., it hadn't been successfully persisted after processing pending events).
411 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;
414 /// A trait implemented for objects handling events from [`EventsProvider`].
415 pub trait EventHandler {
416 /// Handles the given [`Event`].
418 /// See [`EventsProvider`] for details that must be considered when implementing this method.
419 fn handle_event(&self, event: Event);
422 impl<F> EventHandler for F where F: Fn(Event) {
423 fn handle_event(&self, event: Event) {