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, 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
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 chain::transaction::OutPoint;
18 use bitcoin::blockdata::script::Script;
20 use secp256k1::key::PublicKey;
22 use std::time::Instant;
24 /// An Event which you should probably take some action in response to.
26 // Events a user will probably have to handle
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
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
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, you must call ChannelManager::fail_htlc_backwards
54 /// to free up resources for this HTLC.
56 /// The hash for which the preimage should be handed to the ChannelManager.
57 payment_hash: [u8; 32],
58 /// The value, in thousandths of a satoshi, that this payment is for.
61 /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
62 /// and we got back the payment preimage for it).
63 /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
64 /// deduplicate them by payment_preimage (which MUST be unique)!
66 /// The preimage to the hash given to ChannelManager::send_payment.
67 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
69 payment_preimage: [u8; 32],
71 /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
72 /// something. You may wish to retry with a different route.
73 /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
74 /// deduplicate them by payment_hash (which MUST be unique)!
76 /// The hash which was given to ChannelManager::send_payment.
77 payment_hash: [u8; 32],
79 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
80 /// time in the future.
81 PendingHTLCsForwardable {
82 /// The earliest time at which process_pending_htlc_forwards should be called.
83 time_forwardable: Instant,
86 // Events indicating the network loop should send a message to a peer:
87 // TODO: Move these into a separate struct and make a top-level enum
88 /// Used to indicate that we've initialted a channel open and should send the open_channel
89 /// message provided to the given peer.
91 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
93 /// The node_id of the node which should receive this message
95 /// The message which should be sent.
96 msg: msgs::OpenChannel,
98 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
100 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
102 /// The node_id of the node which should receive this message
104 /// The message which should be sent.
105 msg: msgs::FundingCreated,
107 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
109 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
111 /// The node_id of the node which should receive these message(s)
113 /// The funding_locked message which should be sent.
114 msg: msgs::FundingLocked,
115 /// An optional additional announcement_signatures message which should be sent.
116 announcement_sigs: Option<msgs::AnnouncementSignatures>,
118 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
119 /// message should be sent to the peer with the given node_id.
121 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
123 /// The node_id of the node which should receive these message(s)
125 /// The update messages which should be sent. ALL messages in the struct should be sent!
126 updates: msgs::CommitmentUpdate,
128 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
130 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
132 /// The node_id of the node which should receive this message
134 /// The message which should be sent.
137 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
138 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
140 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
141 BroadcastChannelAnnouncement {
142 /// The channel_announcement which should be sent.
143 msg: msgs::ChannelAnnouncement,
144 /// The followup channel_update which should be sent.
145 update_msg: msgs::ChannelUpdate,
147 /// Used to indicate that a channel_update should be broadcast to all peers.
149 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
150 BroadcastChannelUpdate {
151 /// The channel_update which should be sent.
152 msg: msgs::ChannelUpdate,
156 /// Broadcast an error downstream to be handled
158 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
160 /// The node_id of the node which should receive this message
162 /// The action which should be taken.
163 action: Option<msgs::ErrorAction>
167 /// A trait indicating an object may generate events
168 pub trait EventsProvider {
169 /// Gets the list of pending events which were generated by previous actions, clearing the list
171 fn get_and_clear_pending_events(&self) -> Vec<Event>;