From: Yuntai Kyong <yuntai.kyong@gmail.com>
Date: Thu, 25 Oct 2018 22:35:09 +0000 (+0900)
Subject: Comments updated for PaymentReceived
X-Git-Tag: v0.0.12~287^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=bdbb2f077eb1dcf087026c8e7c8025611d401afa;p=rust-lightning

Comments updated for PaymentReceived
---

diff --git a/src/util/events.rs b/src/util/events.rs
index e11e4e82c..ccfe0f8ac 100644
--- a/src/util/events.rs
+++ b/src/util/events.rs
@@ -50,8 +50,11 @@ 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, you must call ChannelManager::fail_htlc_backwards
-	/// to free up resources for this HTLC.
+	/// 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.
+	/// 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],