X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Futil%2Fevents.rs;h=e4bed8f2e35494be576688f1119b6538d183de09;hb=e2a9ed7265680cc821f29860264c7f4d53e044b9;hp=a113217943f9d268cea2cc3e8cf8a3056b3f6be6;hpb=af89de3d86356285b863bc3c4309b2853c981c96;p=rust-lightning

diff --git a/src/util/events.rs b/src/util/events.rs
index a1132179..e4bed8f2 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;
 
@@ -20,7 +21,7 @@ use bitcoin::blockdata::script::Script;
 
 use secp256k1::key::PublicKey;
 
-use std::time::Instant;
+use std::time::Duration;
 
 /// An Event which you should probably take some action in response to.
 pub enum Event {
@@ -53,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
@@ -71,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.
@@ -79,17 +81,19 @@ 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.
 	PendingHTLCsForwardable {
-		/// The earliest time at which process_pending_htlc_forwards should be called.
-		time_forwardable: Instant,
+		/// The amount of time that should be waited prior to calling process_pending_htlc_forwards
+		time_forwardable: Duration,
 	},
 	/// Used to indicate that an output was generated on-chain which you should know how to spend.
 	/// Such an output will *not* ever be spent by rust-lightning, so you need to store them