mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-02-25 07:17:40 +01:00
2037a241f4
This field was previous useful in manual retries for users to know when all paths of a payment have failed and it is safe to retry. Now that we support automatic retries in ChannelManager and no longer support manual retries, the field is no longer useful. For backwards compat, we now always write false for this field. If we didn't do this, previous versions would default this field's value to true, which can be problematic because some clients have relied on the field to indicate when a full payment retry is safe.
11 lines
704 B
Text
11 lines
704 B
Text
## API Updates
|
|
- `Event::PaymentPathFailed::all_paths_failed` has been removed, as we've dropped support for manual
|
|
payment retries.
|
|
|
|
## Backwards Compatibility
|
|
- If downgrading from 0.0.114 to a previous version, `Event::PaymentPathFailed::all_paths_failed`
|
|
will always be set to `false`. Users who wish to support downgrading and currently rely on the
|
|
field should should first migrate to always calling `ChannelManager::abandon_payment` and awaiting
|
|
`PaymentFailed` events before retrying (see the field docs for more info on this approach:
|
|
<https://docs.rs/lightning/0.0.113/lightning/util/events/enum.Event.html#variant.PaymentPathFailed.field.all_paths_failed>),
|
|
and then migrate to 0.0.114.
|