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::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
19 use chain::transaction::OutPoint;
20 use chain::keysinterface::SpendableOutputDescriptor;
21 use util::ser::{Writeable, Writer, MaybeReadable, Readable};
23 use bitcoin::blockdata::script::Script;
25 use bitcoin::secp256k1::key::PublicKey;
27 use std::time::Duration;
29 /// An Event which you should probably take some action in response to.
31 /// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
32 /// them directly as they don't round-trip exactly (for example FundingGenerationReady is never
33 /// written as it makes no sense to respond to it after reconnecting to peers).
34 #[derive(Clone, Debug)]
36 /// Used to indicate that the client should generate a funding transaction with the given
37 /// parameters and then call ChannelManager::funding_transaction_generated.
38 /// Generated in ChannelManager message handling.
39 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
40 /// counterparty can steal your funds!
41 FundingGenerationReady {
42 /// The random channel_id we picked which you'll need to pass into
43 /// ChannelManager::funding_transaction_generated.
44 temporary_channel_id: [u8; 32],
45 /// The value, in satoshis, that the output should have.
46 channel_value_satoshis: u64,
47 /// The script which should be used in the transaction output.
48 output_script: Script,
49 /// The value passed in to ChannelManager::create_channel
52 /// Used to indicate that the client may now broadcast the funding transaction it created for a
53 /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
54 /// trivially stealing all funds in the funding transaction!
55 FundingBroadcastSafe {
56 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
57 /// now safe to broadcast.
58 funding_txo: OutPoint,
59 /// The value passed in to ChannelManager::create_channel
62 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
63 /// ChannelManager::claim_funds to get it....
64 /// Note that if the preimage is not known or the amount paid is incorrect, you should call
65 /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
66 /// network congestion.
67 /// The amount paid should be considered 'incorrect' when it is less than or more than twice
68 /// the amount expected.
69 /// If you fail to call either ChannelManager::claim_funds or
70 /// ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
71 /// automatically failed.
73 /// The hash for which the preimage should be handed to the ChannelManager.
74 payment_hash: PaymentHash,
75 /// The "payment secret". This authenticates the sender to the recipient, preventing a
76 /// number of deanonymization attacks during the routing process.
77 /// As nodes upgrade, the invoices you provide should likely migrate to setting the
78 /// payment_secret feature to required, at which point you should fail_backwards any HTLCs
79 /// which have a None here.
80 /// Until then, however, values of None should be ignored, and only incorrect Some values
81 /// should result in an HTLC fail_backwards.
82 /// Note that, in any case, this value must be passed as-is to any fail or claim calls as
83 /// the HTLC index includes this value.
84 payment_secret: Option<PaymentSecret>,
85 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
86 /// compare this to the expected value before accepting the payment (as otherwise you are
87 /// providing proof-of-payment for less than the value you expected!).
90 /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
91 /// and we got back the payment preimage for it).
92 /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
93 /// deduplicate them by payment_preimage (which MUST be unique)!
95 /// The preimage to the hash given to ChannelManager::send_payment.
96 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
98 payment_preimage: PaymentPreimage,
100 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
101 /// something. You may wish to retry with a different route.
102 /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
103 /// deduplicate them by payment_hash (which MUST be unique)!
105 /// The hash which was given to ChannelManager::send_payment.
106 payment_hash: PaymentHash,
107 /// Indicates the payment was rejected for some reason by the recipient. This implies that
108 /// the payment has failed, not just the route in question. If this is not set, you may
109 /// retry the payment via a different route.
111 /// Note that if the destination node returned garbage which we were unable to
112 /// understand, this will *not* be set, indicating that retrying the payment over
113 /// another path is unlikely to solve the issue.
114 rejected_by_dest: bool,
115 /// Indicates the payment was rejected by the first hop in the route. This may be useful to
116 /// detect when an otherwise-trusted peer rejected a payment.
118 /// Note that this is not set if we reject the payment ourselves (e.g. because our
119 /// connection to the next-hop peer was closed).
120 rejected_by_first_hop: bool,
122 error_code: Option<u16>,
124 error_data: Option<Vec<u8>>,
126 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
127 /// time in the future.
128 PendingHTLCsForwardable {
129 /// The minimum amount of time that should be waited prior to calling
130 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
131 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
132 /// now + 5*time_forwardable).
133 time_forwardable: Duration,
135 /// Used to indicate that an output was generated on-chain which you should know how to spend.
136 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
137 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
138 /// somewhere and spend them when you create on-chain transactions.
140 /// The outputs which you should store as spendable by you.
141 outputs: Vec<SpendableOutputDescriptor>,
145 impl Writeable for Event {
146 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
148 &Event::FundingGenerationReady { .. } => {
150 // We never write out FundingGenerationReady events as, upon disconnection, peers
151 // drop any channels which have not yet exchanged funding_signed.
153 &Event::FundingBroadcastSafe { ref funding_txo, ref user_channel_id } => {
155 funding_txo.write(writer)?;
156 user_channel_id.write(writer)?;
158 &Event::PaymentReceived { ref payment_hash, ref payment_secret, ref amt } => {
160 payment_hash.write(writer)?;
161 payment_secret.write(writer)?;
164 &Event::PaymentSent { ref payment_preimage } => {
166 payment_preimage.write(writer)?;
168 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref rejected_by_first_hop,
175 payment_hash.write(writer)?;
176 rejected_by_dest.write(writer)?;
177 rejected_by_first_hop.write(writer)?;
179 error_code.write(writer)?;
181 error_data.write(writer)?;
183 &Event::PendingHTLCsForwardable { time_forwardable: _ } => {
185 // We don't write the time_fordwardable out at all, as we presume when the user
186 // deserializes us at least that much time has elapsed.
188 &Event::SpendableOutputs { ref outputs } => {
190 (outputs.len() as u64).write(writer)?;
191 for output in outputs.iter() {
192 output.write(writer)?;
199 impl MaybeReadable for Event {
200 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Option<Self>, msgs::DecodeError> {
201 match Readable::read(reader)? {
203 1u8 => Ok(Some(Event::FundingBroadcastSafe {
204 funding_txo: Readable::read(reader)?,
205 user_channel_id: Readable::read(reader)?,
207 2u8 => Ok(Some(Event::PaymentReceived {
208 payment_hash: Readable::read(reader)?,
209 payment_secret: Readable::read(reader)?,
210 amt: Readable::read(reader)?,
212 3u8 => Ok(Some(Event::PaymentSent {
213 payment_preimage: Readable::read(reader)?,
215 4u8 => Ok(Some(Event::PaymentFailed {
216 payment_hash: Readable::read(reader)?,
217 rejected_by_dest: Readable::read(reader)?,
218 rejected_by_first_hop: Readable::read(reader)?,
220 error_code: Readable::read(reader)?,
222 error_data: Readable::read(reader)?,
224 5u8 => Ok(Some(Event::PendingHTLCsForwardable {
225 time_forwardable: Duration::from_secs(0)
228 let outputs_len: u64 = Readable::read(reader)?;
229 let mut outputs = Vec::new();
230 for _ in 0..outputs_len {
231 outputs.push(Readable::read(reader)?);
233 Ok(Some(Event::SpendableOutputs { outputs }))
235 _ => Err(msgs::DecodeError::InvalidValue)
240 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
241 /// broadcast to most peers).
242 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
243 #[derive(Clone, Debug)]
244 pub enum MessageSendEvent {
245 /// Used to indicate that we've accepted a channel open and should send the accept_channel
246 /// message provided to the given peer.
248 /// The node_id of the node which should receive this message
250 /// The message which should be sent.
251 msg: msgs::AcceptChannel,
253 /// Used to indicate that we've initiated a channel open and should send the open_channel
254 /// message provided to the given peer.
256 /// The node_id of the node which should receive this message
258 /// The message which should be sent.
259 msg: msgs::OpenChannel,
261 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
263 /// The node_id of the node which should receive this message
265 /// The message which should be sent.
266 msg: msgs::FundingCreated,
268 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
270 /// The node_id of the node which should receive this message
272 /// The message which should be sent.
273 msg: msgs::FundingSigned,
275 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
277 /// The node_id of the node which should receive these message(s)
279 /// The funding_locked message which should be sent.
280 msg: msgs::FundingLocked,
282 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
283 SendAnnouncementSignatures {
284 /// The node_id of the node which should receive these message(s)
286 /// The announcement_signatures message which should be sent.
287 msg: msgs::AnnouncementSignatures,
289 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
290 /// message should be sent to the peer with the given node_id.
292 /// The node_id of the node which should receive these message(s)
294 /// The update messages which should be sent. ALL messages in the struct should be sent!
295 updates: msgs::CommitmentUpdate,
297 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
299 /// The node_id of the node which should receive this message
301 /// The message which should be sent.
302 msg: msgs::RevokeAndACK,
304 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
306 /// The node_id of the node which should receive this message
308 /// The message which should be sent.
309 msg: msgs::ClosingSigned,
311 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
313 /// The node_id of the node which should receive this message
315 /// The message which should be sent.
318 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
319 SendChannelReestablish {
320 /// The node_id of the node which should receive this message
322 /// The message which should be sent.
323 msg: msgs::ChannelReestablish,
325 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
326 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
328 /// Note that after doing so, you very likely (unless you did so very recently) want to call
329 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
330 /// This ensures that any nodes which see our channel_announcement also have a relevant
331 /// node_announcement, including relevant feature flags which may be important for routing
332 /// through or to us.
333 BroadcastChannelAnnouncement {
334 /// The channel_announcement which should be sent.
335 msg: msgs::ChannelAnnouncement,
336 /// The followup channel_update which should be sent.
337 update_msg: msgs::ChannelUpdate,
339 /// Used to indicate that a node_announcement should be broadcast to all peers.
340 BroadcastNodeAnnouncement {
341 /// The node_announcement which should be sent.
342 msg: msgs::NodeAnnouncement,
344 /// Used to indicate that a channel_update should be broadcast to all peers.
345 BroadcastChannelUpdate {
346 /// The channel_update which should be sent.
347 msg: msgs::ChannelUpdate,
349 /// Broadcast an error downstream to be handled
351 /// The node_id of the node which should receive this message
353 /// The action which should be taken.
354 action: msgs::ErrorAction
356 /// When a payment fails we may receive updates back from the hop where it failed. In such
357 /// cases this event is generated so that we can inform the network graph of this information.
358 PaymentFailureNetworkUpdate {
359 /// The channel/node update which should be sent to NetGraphMsgHandler
360 update: msgs::HTLCFailChannelUpdate,
362 /// Query a peer for channels with funding transaction UTXOs in a block range.
363 SendChannelRangeQuery {
364 /// The node_id of this message recipient
366 /// The query_channel_range which should be sent.
367 msg: msgs::QueryChannelRange,
369 /// Request routing gossip messages from a peer for a list of channels identified by
370 /// their short_channel_ids.
372 /// The node_id of this message recipient
374 /// The query_short_channel_ids which should be sent.
375 msg: msgs::QueryShortChannelIds,
377 /// Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
378 /// emitted during processing of the query.
379 SendReplyChannelRange {
380 /// The node_id of this message recipient
382 /// The reply_channel_range which should be sent.
383 msg: msgs::ReplyChannelRange,
387 /// A trait indicating an object may generate message send events
388 pub trait MessageSendEventsProvider {
389 /// Gets the list of pending events which were generated by previous actions, clearing the list
391 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
394 /// A trait indicating an object may generate events
395 pub trait EventsProvider {
396 /// Gets the list of pending events which were generated by previous actions, clearing the list
398 fn get_and_clear_pending_events(&self) -> Vec<Event>;