X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Futil%2Fevents.rs;h=8f8e7a52c3c8968facd6ad92aec0ab6808004327;hb=f0bcb7dba0360f04afacfff63ec2598d39bddc5f;hp=d7312cd9129b1cadd92c82bd09f2e5233f558d53;hpb=e382a7b4b3e5f3e59a9300b9d8a4d8bff06366fe;p=rust-lightning

diff --git a/src/util/events.rs b/src/util/events.rs
index d7312cd9..8f8e7a52 100644
--- a/src/util/events.rs
+++ b/src/util/events.rs
@@ -1,7 +1,7 @@
 //! Events are returned from various bits in the library which indicate some action must be taken
 //! by the client.
 //!
-//! Because we don't have a built-in runtime, its up to the client to call events at a time in the
+//! Because we don't have a built-in runtime, it's up to the client to call events at a time in the
 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
 //! few other things.
 //!
@@ -13,6 +13,7 @@
 //TODO: We need better separation of event types ^
 
 use ln::msgs;
+use ln::channelmanager::{PaymentPreimage, PaymentHash};
 use chain::transaction::OutPoint;
 use chain::keysinterface::SpendableOutputDescriptor;
 
@@ -27,6 +28,8 @@ pub enum Event {
 	/// Used to indicate that the client should generate a funding transaction with the given
 	/// parameters and then call ChannelManager::funding_transaction_generated.
 	/// Generated in ChannelManager message handling.
+	/// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
+	/// counterparty can steal your funds!
 	FundingGenerationReady {
 		/// The random channel_id we picked which you'll need to pass into
 		/// ChannelManager::funding_transaction_generated.
@@ -51,14 +54,15 @@ pub enum Event {
 	/// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
 	/// ChannelManager::claim_funds to get it....
 	/// Note that if the preimage is not known or the amount paid is incorrect, you must call
-	/// ChannelManager::fail_htlc_backwards with PaymentFailReason::PreimageUnknown or
-	/// PaymentFailReason::AmountMismatch, respectively, to free up resources for this HTLC.
+	/// ChannelManager::fail_htlc_backwards to free up resources for this HTLC.
 	/// The amount paid should be considered 'incorrect' when it is less than or more than twice
 	/// the amount expected.
 	PaymentReceived {
 		/// The hash for which the preimage should be handed to the ChannelManager.
-		payment_hash: [u8; 32],
-		/// The value, in thousandths of a satoshi, that this payment is for.
+		payment_hash: PaymentHash,
+		/// The value, in thousandths of a satoshi, that this payment is for. Note that you must
+		/// compare this to the expected value before accepting the payment (as otherwise you are
+		/// providing proof-of-payment for less than the value you expected!).
 		amt: u64,
 	},
 	/// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
@@ -69,7 +73,7 @@ pub enum Event {
 		/// The preimage to the hash given to ChannelManager::send_payment.
 		/// Note that this serves as a payment receipt, if you wish to have such a thing, you must
 		/// store it somehow!
-		payment_preimage: [u8; 32],
+		payment_preimage: PaymentPreimage,
 	},
 	/// Indicates an outbound payment we made failed. Probably some intermediary node dropped
 	/// something. You may wish to retry with a different route.
@@ -77,11 +81,13 @@ pub enum Event {
 	/// deduplicate them by payment_hash (which MUST be unique)!
 	PaymentFailed {
 		/// The hash which was given to ChannelManager::send_payment.
-		payment_hash: [u8; 32],
+		payment_hash: PaymentHash,
 		/// Indicates the payment was rejected for some reason by the recipient. This implies that
 		/// the payment has failed, not just the route in question. If this is not set, you may
 		/// retry the payment via a different route.
 		rejected_by_dest: bool,
+#[cfg(test)]
+		error_code: Option<u16>,
 	},
 	/// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
 	/// time in the future.
@@ -101,6 +107,7 @@ pub enum Event {
 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
 /// broadcast to most peers).
 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
+#[derive(Clone)]
 pub enum MessageSendEvent {
 	/// Used to indicate that we've accepted a channel open and should send the accept_channel
 	/// message provided to the given peer.
@@ -161,6 +168,13 @@ pub enum MessageSendEvent {
 		/// The message which should be sent.
 		msg: msgs::RevokeAndACK,
 	},
+	/// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
+	SendClosingSigned {
+		/// The node_id of the node which should receive this message
+		node_id: PublicKey,
+		/// The message which should be sent.
+		msg: msgs::ClosingSigned,
+	},
 	/// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 	SendShutdown {
 		/// The node_id of the node which should receive this message
@@ -168,6 +182,13 @@ pub enum MessageSendEvent {
 		/// The message which should be sent.
 		msg: msgs::Shutdown,
 	},
+	/// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
+	SendChannelReestablish {
+		/// The node_id of the node which should receive this message
+		node_id: PublicKey,
+		/// The message which should be sent.
+		msg: msgs::ChannelReestablish,
+	},
 	/// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 	/// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 	BroadcastChannelAnnouncement {