Document when `PaymentPathSuccessful::payment_hash` is filled in.
authorMatt Corallo <git@bluematt.me>
Fri, 5 May 2023 03:33:54 +0000 (03:33 +0000)
committerMatt Corallo <git@bluematt.me>
Fri, 5 May 2023 03:33:54 +0000 (03:33 +0000)
commite1394f3ea04816ee5cf7d155702581363328dfb5
tree4543d03c8ddd426691eeac637598a3c24a33ec1d
parente94647ca4ebc63be4a8164804d08cf37e4655d6c
Document when `PaymentPathSuccessful::payment_hash` is filled in.

The `payment_hash` field in `PaymentPathSuccessful` is always
`Some` as long as the pening payment tracker has a `payment_hash`,
which is true for all `Pending` payments as well as all `Fulfilled`
payments starting with the commit which added
`PaymentPathSuccessful` -
3b5c370b404e2f5a8f3c35093b97406f149a9340c177c05252574083d68df0da.
lightning/src/events/mod.rs
lightning/src/ln/outbound_payment.rs