X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Futil%2Fevents.rs;h=de9dd4286f92c07cea79416cca92119c274bafa9;hb=78939a7e0374d6343576ba1440b7d708158ac611;hp=6d3ac33d12f7bce48c681109cd99670c328295a9;hpb=7a8bec750df613085d195375aee30924af6d0c6c;p=rust-lightning diff --git a/src/util/events.rs b/src/util/events.rs index 6d3ac33d..de9dd428 100644 --- a/src/util/events.rs +++ b/src/util/events.rs @@ -54,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: PaymentHash, - /// The value, in thousandths of a satoshi, that this payment is for. + /// 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