1 //! Events are returned from various bits in the library which indicate some action must be taken
4 //! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
5 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
8 //! Note that many events are handled for you by PeerHandler, so in the common design of having a
9 //! PeerManager which marshalls messages to ChannelManager and Router you only need to call
10 //! process_events on the PeerHandler and then get_and_clear_pending_events and handle the events
11 //! that bubble up to the surface. If, however, you do not have a PeerHandler managing a
12 //! ChannelManager you need to handle all of the events which may be generated.
13 //TODO: We need better separation of event types ^
16 use ln::channelmanager::{PaymentPreimage, PaymentHash};
17 use chain::transaction::OutPoint;
18 use chain::keysinterface::SpendableOutputDescriptor;
20 use bitcoin::blockdata::script::Script;
22 use secp256k1::key::PublicKey;
24 use std::time::Duration;
26 /// An Event which you should probably take some action in response to.
28 /// Used to indicate that the client should generate a funding transaction with the given
29 /// parameters and then call ChannelManager::funding_transaction_generated.
30 /// Generated in ChannelManager message handling.
31 /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
32 /// counterparty can steal your funds!
33 FundingGenerationReady {
34 /// The random channel_id we picked which you'll need to pass into
35 /// ChannelManager::funding_transaction_generated.
36 temporary_channel_id: [u8; 32],
37 /// The value, in satoshis, that the output should have.
38 channel_value_satoshis: u64,
39 /// The script which should be used in the transaction output.
40 output_script: Script,
41 /// The value passed in to ChannelManager::create_channel
44 /// Used to indicate that the client may now broadcast the funding transaction it created for a
45 /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
46 /// trivially stealing all funds in the funding transaction!
47 FundingBroadcastSafe {
48 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
49 /// now safe to broadcast.
50 funding_txo: OutPoint,
51 /// The value passed in to ChannelManager::create_channel
54 /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
55 /// ChannelManager::claim_funds to get it....
56 /// Note that if the preimage is not known or the amount paid is incorrect, you must call
57 /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC.
58 /// The amount paid should be considered 'incorrect' when it is less than or more than twice
59 /// the amount expected.
61 /// The hash for which the preimage should be handed to the ChannelManager.
62 payment_hash: PaymentHash,
63 /// The "payment secret". This authenticates the sender to the recipient, preventing a
64 /// number of deanonymization attacks during the routing process.
65 /// As nodes upgrade, the invoices you provide should likely migrate to setting the
66 /// var_onion_optin feature to required, at which point you should fail_backwards any HTLCs
67 /// which have a None here.
68 /// Until then, however, values of None should be ignored, and only incorrect Some values
69 /// should result in an HTLC fail_backwards.
70 /// Note that, in any case, this value must be passed as-is to any fail or claim calls as
71 /// the HTLC index includes this value.
72 payment_secret: Option<[u8; 32]>,
73 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
74 /// compare this to the expected value before accepting the payment (as otherwise you are
75 /// providing proof-of-payment for less than the value you expected!).
78 /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
79 /// and we got back the payment preimage for it).
80 /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
81 /// deduplicate them by payment_preimage (which MUST be unique)!
83 /// The preimage to the hash given to ChannelManager::send_payment.
84 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
86 payment_preimage: PaymentPreimage,
88 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
89 /// something. You may wish to retry with a different route.
90 /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
91 /// deduplicate them by payment_hash (which MUST be unique)!
93 /// The hash which was given to ChannelManager::send_payment.
94 payment_hash: PaymentHash,
95 /// Indicates the payment was rejected for some reason by the recipient. This implies that
96 /// the payment has failed, not just the route in question. If this is not set, you may
97 /// retry the payment via a different route.
98 rejected_by_dest: bool,
100 error_code: Option<u16>,
102 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
103 /// time in the future.
104 PendingHTLCsForwardable {
105 /// The minimum amount of time that should be waited prior to calling
106 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
107 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
108 /// now + 5*time_forwardable).
109 time_forwardable: Duration,
111 /// Used to indicate that an output was generated on-chain which you should know how to spend.
112 /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
113 /// counterparty spending them due to some kind of timeout. Thus, you need to store them
114 /// somewhere and spend them when you create on-chain transactions.
116 /// The outputs which you should store as spendable by you.
117 outputs: Vec<SpendableOutputDescriptor>,
121 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
122 /// broadcast to most peers).
123 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
125 pub enum MessageSendEvent {
126 /// Used to indicate that we've accepted a channel open and should send the accept_channel
127 /// message provided to the given peer.
129 /// The node_id of the node which should receive this message
131 /// The message which should be sent.
132 msg: msgs::AcceptChannel,
134 /// Used to indicate that we've initiated a channel open and should send the open_channel
135 /// message provided to the given peer.
137 /// The node_id of the node which should receive this message
139 /// The message which should be sent.
140 msg: msgs::OpenChannel,
142 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
144 /// The node_id of the node which should receive this message
146 /// The message which should be sent.
147 msg: msgs::FundingCreated,
149 /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
151 /// The node_id of the node which should receive this message
153 /// The message which should be sent.
154 msg: msgs::FundingSigned,
156 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
158 /// The node_id of the node which should receive these message(s)
160 /// The funding_locked message which should be sent.
161 msg: msgs::FundingLocked,
163 /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
164 SendAnnouncementSignatures {
165 /// The node_id of the node which should receive these message(s)
167 /// The announcement_signatures message which should be sent.
168 msg: msgs::AnnouncementSignatures,
170 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
171 /// message should be sent to the peer with the given node_id.
173 /// The node_id of the node which should receive these message(s)
175 /// The update messages which should be sent. ALL messages in the struct should be sent!
176 updates: msgs::CommitmentUpdate,
178 /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
180 /// The node_id of the node which should receive this message
182 /// The message which should be sent.
183 msg: msgs::RevokeAndACK,
185 /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
187 /// The node_id of the node which should receive this message
189 /// The message which should be sent.
190 msg: msgs::ClosingSigned,
192 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
194 /// The node_id of the node which should receive this message
196 /// The message which should be sent.
199 /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
200 SendChannelReestablish {
201 /// The node_id of the node which should receive this message
203 /// The message which should be sent.
204 msg: msgs::ChannelReestablish,
206 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
207 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
209 /// Note that after doing so, you very likely (unless you did so very recently) want to call
210 /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
211 BroadcastChannelAnnouncement {
212 /// The channel_announcement which should be sent.
213 msg: msgs::ChannelAnnouncement,
214 /// The followup channel_update which should be sent.
215 update_msg: msgs::ChannelUpdate,
217 /// Used to indicate that a node_announcement should be broadcast to all peers.
218 BroadcastNodeAnnouncement {
219 /// The node_announcement which should be sent.
220 msg: msgs::NodeAnnouncement,
222 /// Used to indicate that a channel_update should be broadcast to all peers.
223 BroadcastChannelUpdate {
224 /// The channel_update which should be sent.
225 msg: msgs::ChannelUpdate,
227 /// Broadcast an error downstream to be handled
229 /// The node_id of the node which should receive this message
231 /// The action which should be taken.
232 action: msgs::ErrorAction
234 /// When a payment fails we may receive updates back from the hop where it failed. In such
235 /// cases this event is generated so that we can inform the router of this information.
236 PaymentFailureNetworkUpdate {
237 /// The channel/node update which should be sent to router
238 update: msgs::HTLCFailChannelUpdate,
242 /// A trait indicating an object may generate message send events
243 pub trait MessageSendEventsProvider {
244 /// Gets the list of pending events which were generated by previous actions, clearing the list
246 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
249 /// A trait indicating an object may generate events
250 pub trait EventsProvider {
251 /// Gets the list of pending events which were generated by previous actions, clearing the list
253 fn get_and_clear_pending_events(&self) -> Vec<Event>;