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],
78 /// Indicates the payment was rejected for some reason by the recipient. This implies that
79 /// the payment has failed, not just the route in question. If this is not set, you may
80 /// retry the payment via a different route.
81 rejected_by_dest: bool,
83 /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
84 /// time in the future.
85 PendingHTLCsForwardable {
86 /// The earliest time at which process_pending_htlc_forwards should be called.
87 time_forwardable: Instant,
90 // Events indicating the network loop should send a message to a peer:
91 // TODO: Move these into a separate struct and make a top-level enum
92 /// Used to indicate that we've initialted a channel open and should send the open_channel
93 /// message provided to the given peer.
95 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
97 /// The node_id of the node which should receive this message
99 /// The message which should be sent.
100 msg: msgs::OpenChannel,
102 /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
104 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
106 /// The node_id of the node which should receive this message
108 /// The message which should be sent.
109 msg: msgs::FundingCreated,
111 /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
113 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
115 /// The node_id of the node which should receive these message(s)
117 /// The funding_locked message which should be sent.
118 msg: msgs::FundingLocked,
119 /// An optional additional announcement_signatures message which should be sent.
120 announcement_sigs: Option<msgs::AnnouncementSignatures>,
122 /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
123 /// message should be sent to the peer with the given node_id.
125 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
127 /// The node_id of the node which should receive these message(s)
129 /// The update messages which should be sent. ALL messages in the struct should be sent!
130 updates: msgs::CommitmentUpdate,
132 /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
134 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
136 /// The node_id of the node which should receive this message
138 /// The message which should be sent.
141 /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
142 /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
144 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
145 BroadcastChannelAnnouncement {
146 /// The channel_announcement which should be sent.
147 msg: msgs::ChannelAnnouncement,
148 /// The followup channel_update which should be sent.
149 update_msg: msgs::ChannelUpdate,
151 /// Used to indicate that a channel_update should be broadcast to all peers.
153 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
154 BroadcastChannelUpdate {
155 /// The channel_update which should be sent.
156 msg: msgs::ChannelUpdate,
160 /// Broadcast an error downstream to be handled
162 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
164 /// The node_id of the node which should receive this message
166 /// The action which should be taken.
167 action: Option<msgs::ErrorAction>
169 /// When a payment fails we may receive updates back from the hop where it failed. In such
170 /// cases this event is generated so that we can inform the router of this information.
172 /// This event is handled by PeerManager::process_events if you are using a PeerManager.
173 PaymentFailureNetworkUpdate {
174 /// The channel/node update which should be sent to router
175 update: msgs::HTLCFailChannelUpdate,
179 /// A trait indicating an object may generate events
180 pub trait EventsProvider {
181 /// Gets the list of pending events which were generated by previous actions, clearing the list
183 fn get_and_clear_pending_events(&self) -> Vec<Event>;