From: Matt Corallo <git@bluematt.me>
Date: Tue, 16 Oct 2018 03:04:59 +0000 (-0400)
Subject: Add documentation about PaymentSent/Failed event duplication bug
X-Git-Tag: v0.0.12~294^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=refs%2Fheads%2F2018-10-reconnect-fixes;p=rust-lightning

Add documentation about PaymentSent/Failed event duplication bug
---

diff --git a/src/util/events.rs b/src/util/events.rs
index 22721729b..a317f0766 100644
--- a/src/util/events.rs
+++ b/src/util/events.rs
@@ -60,6 +60,8 @@ pub enum Event {
 	},
 	/// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
 	/// and we got back the payment preimage for it).
+	/// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
+	/// deduplicate them by payment_preimage (which MUST be unique)!
 	PaymentSent {
 		/// 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
@@ -68,6 +70,8 @@ pub enum Event {
 	},
 	/// Indicates an outbound payment we made failed. Probably some intermediary node dropped
 	/// something. You may wish to retry with a different route.
+	/// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
+	/// deduplicate them by payment_hash (which MUST be unique)!
 	PaymentFailed {
 		/// The hash which was given to ChannelManager::send_payment.
 		payment_hash: [u8; 32],