]> git.bitcoin.ninja Git - rust-lightning/blob - src/util/events.rs
Merge pull request #235 from TheBlueMatt/2018-10-229-redux
[rust-lightning] / src / util / events.rs
1 //! Events are returned from various bits in the library which indicate some action must be taken
2 //! by the client.
3 //!
4 //! Because we don't have a built-in runtime, its 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
6 //! few other things.
7 //!
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 ^
14
15 use ln::msgs;
16 use chain::transaction::OutPoint;
17 use chain::keysinterface::SpendableOutputDescriptor;
18
19 use bitcoin::blockdata::script::Script;
20
21 use secp256k1::key::PublicKey;
22
23 use std::time::Instant;
24
25 /// An Event which you should probably take some action in response to.
26 pub enum Event {
27         /// Used to indicate that the client should generate a funding transaction with the given
28         /// parameters and then call ChannelManager::funding_transaction_generated.
29         /// Generated in ChannelManager message handling.
30         FundingGenerationReady {
31                 /// The random channel_id we picked which you'll need to pass into
32                 /// ChannelManager::funding_transaction_generated.
33                 temporary_channel_id: [u8; 32],
34                 /// The value, in satoshis, that the output should have.
35                 channel_value_satoshis: u64,
36                 /// The script which should be used in the transaction output.
37                 output_script: Script,
38                 /// The value passed in to ChannelManager::create_channel
39                 user_channel_id: u64,
40         },
41         /// Used to indicate that the client may now broadcast the funding transaction it created for a
42         /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
43         /// trivially stealing all funds in the funding transaction!
44         FundingBroadcastSafe {
45                 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
46                 /// now safe to broadcast.
47                 funding_txo: OutPoint,
48                 /// The value passed in to ChannelManager::create_channel
49                 user_channel_id: u64,
50         },
51         /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
52         /// ChannelManager::claim_funds to get it....
53         /// Note that if the preimage is not known or the amount paid is incorrect, you must call
54         /// ChannelManager::fail_htlc_backwards with PaymentFailReason::PreimageUnknown or
55         /// PaymentFailReason::AmountMismatch, respectively, to free up resources for this HTLC.
56         /// The amount paid should be considered 'incorrect' when it is less than or more than twice
57         /// the amount expected.
58         PaymentReceived {
59                 /// The hash for which the preimage should be handed to the ChannelManager.
60                 payment_hash: [u8; 32],
61                 /// The value, in thousandths of a satoshi, that this payment is for.
62                 amt: u64,
63         },
64         /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
65         /// and we got back the payment preimage for it).
66         /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
67         /// deduplicate them by payment_preimage (which MUST be unique)!
68         PaymentSent {
69                 /// The preimage to the hash given to ChannelManager::send_payment.
70                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
71                 /// store it somehow!
72                 payment_preimage: [u8; 32],
73         },
74         /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
75         /// something. You may wish to retry with a different route.
76         /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
77         /// deduplicate them by payment_hash (which MUST be unique)!
78         PaymentFailed {
79                 /// The hash which was given to ChannelManager::send_payment.
80                 payment_hash: [u8; 32],
81                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
82                 /// the payment has failed, not just the route in question. If this is not set, you may
83                 /// retry the payment via a different route.
84                 rejected_by_dest: bool,
85         },
86         /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
87         /// time in the future.
88         PendingHTLCsForwardable {
89                 /// The earliest time at which process_pending_htlc_forwards should be called.
90                 time_forwardable: Instant,
91         },
92         /// Used to indicate that an output was generated on-chain which you should know how to spend.
93         /// Such an output will *not* ever be spent by rust-lightning, so you need to store them
94         /// somewhere and spend them when you create on-chain spends.
95         SpendableOutputs {
96                 /// The outputs which you should store as spendable by you.
97                 outputs: Vec<SpendableOutputDescriptor>,
98         },
99 }
100
101 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
102 /// broadcast to most peers).
103 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
104 pub enum MessageSendEvent {
105         /// Used to indicate that we've accepted a channel open and should send the accept_channel
106         /// message provided to the given peer.
107         SendAcceptChannel {
108                 /// The node_id of the node which should receive this message
109                 node_id: PublicKey,
110                 /// The message which should be sent.
111                 msg: msgs::AcceptChannel,
112         },
113         /// Used to indicate that we've initiated a channel open and should send the open_channel
114         /// message provided to the given peer.
115         SendOpenChannel {
116                 /// The node_id of the node which should receive this message
117                 node_id: PublicKey,
118                 /// The message which should be sent.
119                 msg: msgs::OpenChannel,
120         },
121         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
122         SendFundingCreated {
123                 /// The node_id of the node which should receive this message
124                 node_id: PublicKey,
125                 /// The message which should be sent.
126                 msg: msgs::FundingCreated,
127         },
128         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
129         SendFundingSigned {
130                 /// The node_id of the node which should receive this message
131                 node_id: PublicKey,
132                 /// The message which should be sent.
133                 msg: msgs::FundingSigned,
134         },
135         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
136         SendFundingLocked {
137                 /// The node_id of the node which should receive these message(s)
138                 node_id: PublicKey,
139                 /// The funding_locked message which should be sent.
140                 msg: msgs::FundingLocked,
141         },
142         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
143         SendAnnouncementSignatures {
144                 /// The node_id of the node which should receive these message(s)
145                 node_id: PublicKey,
146                 /// The announcement_signatures message which should be sent.
147                 msg: msgs::AnnouncementSignatures,
148         },
149         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
150         /// message should be sent to the peer with the given node_id.
151         UpdateHTLCs {
152                 /// The node_id of the node which should receive these message(s)
153                 node_id: PublicKey,
154                 /// The update messages which should be sent. ALL messages in the struct should be sent!
155                 updates: msgs::CommitmentUpdate,
156         },
157         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
158         SendRevokeAndACK {
159                 /// The node_id of the node which should receive this message
160                 node_id: PublicKey,
161                 /// The message which should be sent.
162                 msg: msgs::RevokeAndACK,
163         },
164         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
165         SendClosingSigned {
166                 /// The node_id of the node which should receive this message
167                 node_id: PublicKey,
168                 /// The message which should be sent.
169                 msg: msgs::ClosingSigned,
170         },
171         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
172         SendShutdown {
173                 /// The node_id of the node which should receive this message
174                 node_id: PublicKey,
175                 /// The message which should be sent.
176                 msg: msgs::Shutdown,
177         },
178         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
179         SendChannelReestablish {
180                 /// The node_id of the node which should receive this message
181                 node_id: PublicKey,
182                 /// The message which should be sent.
183                 msg: msgs::ChannelReestablish,
184         },
185         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
186         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
187         BroadcastChannelAnnouncement {
188                 /// The channel_announcement which should be sent.
189                 msg: msgs::ChannelAnnouncement,
190                 /// The followup channel_update which should be sent.
191                 update_msg: msgs::ChannelUpdate,
192         },
193         /// Used to indicate that a channel_update should be broadcast to all peers.
194         BroadcastChannelUpdate {
195                 /// The channel_update which should be sent.
196                 msg: msgs::ChannelUpdate,
197         },
198         /// Broadcast an error downstream to be handled
199         HandleError {
200                 /// The node_id of the node which should receive this message
201                 node_id: PublicKey,
202                 /// The action which should be taken.
203                 action: Option<msgs::ErrorAction>
204         },
205         /// When a payment fails we may receive updates back from the hop where it failed. In such
206         /// cases this event is generated so that we can inform the router of this information.
207         PaymentFailureNetworkUpdate {
208                 /// The channel/node update which should be sent to router
209                 update: msgs::HTLCFailChannelUpdate,
210         }
211 }
212
213 /// A trait indicating an object may generate message send events
214 pub trait MessageSendEventsProvider {
215         /// Gets the list of pending events which were generated by previous actions, clearing the list
216         /// in the process.
217         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
218 }
219
220 /// A trait indicating an object may generate events
221 pub trait EventsProvider {
222         /// Gets the list of pending events which were generated by previous actions, clearing the list
223         /// in the process.
224         fn get_and_clear_pending_events(&self) -> Vec<Event>;
225 }