Change PaymentPathFailed's optional network update to a Failure enum
[rust-lightning] / pending_changelog / 2043.txt
1 ## API Updates
2 - `Event::PaymentPathFailed::network_update` has been replaced by a new `Failure` enum, which may
3         contain the `network_update` within it. See `Event::PaymentPathFailed::failure` and `Failure` docs
4         for more
5 - `Event::PaymentPathFailed::all_paths_failed` has been removed, as we've dropped support for manual
6         payment retries.
7
8 ## Backwards Compatibility
9 - If downgrading from 0.0.114 to a previous version, `Event::PaymentPathFailed::network_update` will
10         always be `None`.
11 - If downgrading from 0.0.114 to a previous version, `Event::PaymentPathFailed::all_paths_failed`
12         will always be set to `false`. Users who wish to support downgrading and currently rely on the
13         field should should first migrate to always calling `ChannelManager::abandon_payment` and awaiting
14         `PaymentFailed` events before retrying (see the field docs for more info on this approach:
15         <https://docs.rs/lightning/0.0.113/lightning/util/events/enum.Event.html#variant.PaymentPathFailed.field.all_paths_failed>),
16         and then migrate to 0.0.114.